https://github.com/mjordan/islandora_identifier_lookup

An Islandora module that lets you get the UUID for an object if you know its PID, and get an object's PID if you know its UUID.
https://github.com/mjordan/islandora_identifier_lookup

Last synced: 29 days ago
JSON representation

An Islandora module that lets you get the UUID for an object if you know its PID, and get an object's PID if you know its UUID.

• Host: GitHub
• URL: https://github.com/mjordan/islandora_identifier_lookup
• Owner: mjordan
• License: gpl-3.0
• Created: 2015-11-14T02:38:24.000Z (about 9 years ago)
• Default Branch: 7.x
• Last Pushed: 2015-11-14T15:35:12.000Z (about 9 years ago)
• Last Synced: 2024-10-08T08:45:01.517Z (about 1 month ago)
• Size: 0 Bytes
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Islandora Identifier Lookup

An Islandora module that lets you get the UUID for an object if you know its PID, and get an object's PID if you know its UUID. Also lets you assign UUIDs to newly ingested objects.

Each object's UUID needs to be stored in a MODS <identifier type="uuid"> element.

## Querying for identifiers

The HTTP interface:

1. given an Islandora object's PID, returns the corresponding UUID that exists in the configurable datastream location.

2. given a UUID, returns the corresponding Islandora object's PID.

If neither the UUID or PID is found, the request returns a 404.

Take as an example an object with PID 'islandora:100' and <identifier type="uuid">9299d87d-752b-4a24-a2b8-816103418bb2</identifier> in its MODS  datastream. `curl "http://localhost:8000/islandora/idlookup/pid/islandora:100"` will yield `9299d87d-752b-4a24-a2b8-816103418bb2`, and `curl "http://localhost:8000/islandora/idlookup/uuid/9299d87d-752b-4a24-a2b8-816103418bb2"` will yield `islandora:100`.

## Rationale

Islandora lets you create PIDs that contain UUIDs. If you use UUID PIDs, you probably don't need this module.

But UUID PIDs make for ugly and long URLs. Also, if you have an Islandora repository that didn't start off with UUID PIDs, you may not want to change your PID pattern now. Plus, you may have been using UUIDs as unique identifiers in another repo platform that you migrated from, and you (wisely) included those UUIDs in your metadata when you migrated to Islandora.

## Adding UUIDs to new objects

The module also provides an option to add an <identifier type="uuid"> element to the MODS datastream of all new objects on ingest, if one is not already present. To do this, the module calls out to the server's `uuidgen` function (the filesystem path to the utility that generates UUIDs is configurable).

Note that this feature is *enabled by default*. If you don't want to add UUIDs to your objects' MODS datastreams, you will need to disable it immediately after enabling this module.

The module does not offer the ability to retroactively add UUIDs to existing MODS datastreams. That would be an awesome feature though.

## Requirements

* [Islandora](https://github.com/Islandora/islandora)

* [Islandora Solr Search](https://github.com/Islandora/islandora_solr_search)

## Installation

Same as any Drupal module.

## Configuration

Go to admin/islandora/tools/idlookup to configure it.

## Wish list

* Provide options for storing the UUID somewhere other than in the MODS datastream.

* Provide a tool to add a UUID to existing objects.

## Maintainer

[Mark Jordan](https://github.com/mjordan)