Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.65 KB

README.md

File metadata and controls

93 lines (61 loc) · 3.65 KB

FOXML Utilities

License: GPL v3

Introduction

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

Table of Contents

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 for more details.

Installation

Install as usual, see this for further information.

Other modules of particular interest

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.

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:

Sponsors:

Development/Contribution

If you would like to contribute to this module, please check out github's helpful Contributing to projects documentation and Islandora community's Documention for developers to create an issue or pull request and/or contact discoverygarden.

License

GPLv3