Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/discoverygarden/foxml

Provides migration plugins and utility scripts to facilitate I7 to Modern Islandora migration.
https://github.com/discoverygarden/foxml

drupal drupal-module islandora migration parser

Last synced: about 10 hours ago
JSON representation

Provides migration plugins and utility scripts to facilitate I7 to Modern Islandora migration.

Host: GitHub
URL: https://github.com/discoverygarden/foxml
Owner: discoverygarden
License: gpl-3.0
Created: 2022-02-15T15:32:44.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-12-03T18:12:19.000Z (2 months ago)
Last Synced: 2025-02-04T20:15:31.090Z (11 days ago)
Topics: drupal, drupal-module, islandora, migration, parser
Language: PHP
Homepage:
Size: 557 KB
Stars: 0
Watchers: 6
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # FOXML Utilities

![](https://github.com/discoverygarden/foxml/actions/workflows/auto_lint.yml/badge.svg)

![](https://github.com/discoverygarden/foxml/actions/workflows/auto-semver.yml/badge.svg)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

## Introduction

Provides migration plugins and utility scripts to facilitate I7 to Modern Islandora migration.

## Table of Contents

* [Features](#features)

* [Installation](#installation)

* [Configuration](#configuration)

* [Troubleshooting/Issues](#troubleshootingissues)

* [Maintainers and Sponsors](#maintainers-and-sponsors)

* [Development/Contribution](#developmentcontribution)

* [License](#license)

## Features

### Migrate source plugin `foxml`

Source `foxml` plugin that iterates over an "objectStore" implementation.

### Migrate process plugin `foxml.parse`

Given the path to the foxml, this plugin will parse the contents for migration.

### Utility Scripts

Scripts to analyse and export metadata from an FCREPO3 instance. Refer to the [README](https://github.com/discoverygarden/foxml/blob/main/scripts/README.md) for more details.

## Installation

Install as usual, see

[this](https://www.drupal.org/docs/extending-drupal/installing-modules) for

further information.

### Other modules of particular interest

* [`akubra_adapter`](https://github.com/discoverygarden/akubra_adapter/): Integrates with this module to allow access directly into data stored in an [Akubra](https://wiki.lyrasis.org/display/AKUBRA) file system structure making use of [Fedora 3's Hash-based ID mapping](https://github.com/fcrepo3/fcrepo/blob/37df51b9b857fd12c6ab8269820d406c3c4ad774/fcrepo-server/src/main/java/org/fcrepo/server/storage/lowlevel/akubra/HashPathIdMapper.java#L17-L68)

## Configuration

Configuration to use the

"Archival FOXML" migration:

|Key|Description|Default|

|---|---|---|

|`foxml_archival_object_basepath`|The path to the export of archival FOXML over which to iterate.|`private://exports`|

|`foxml_archival_object_file_pattern`|A regex pattern against which to match files.|`NULL` (none necessary; defaulting to iterate over _ALL_ files)|

## Usage/Examples

## Troubleshooting/Issues

Having problems or solved a problem? Contact

[discoverygarden](http://support.discoverygarden.ca).

### Known Issues:

* `php://filter` use can lead to large memory usage

  * we should probably look at rolling another stream wrapper to wrap up our

    usage of OpenSSL to Base64 decode

* There are some expensive assertions made in the code,

  particularly regarding binary datastream content with digests. Assertions should

  typically be disabled in production environments, so these shouldn't have any

  impact on execution there; however, in development environments, could

  potentially lead to issues, especially with larger datastreams, exacerbated by

  the `php://filter` usage to Base64-decode the contents

  * hesitant to remove the assertions without having any other mechanism to

  * could instead roll some unit tests?

## Maintainers and Sponsors

Current maintainers:

* [discoverygarden](http://www.discoverygarden.ca)

Sponsors:

* [FLVC](https://www.flvc.org)

## Development/Contribution

If you would like to contribute to this module, please check out github's helpful

[Contributing to projects](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) documentation and Islandora community's [Documention for developers](https://islandora.github.io/documentation/contributing/CONTRIBUTING/#github-issues) to create an issue or pull request and/or

contact [discoverygarden](http://support.discoverygarden.ca).

## License

[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt)