fixAdvisorFieldAndUpdateDC.php

#!/usr/bin/env drush

#<?php

/**
 * This script is intended to transform MODS metadata for collection records,
 * specifically changing a single name node "thesis advisor" to a multi-part name
 * node and then regenerating the DC for the record.
 * 
 * Example:
 * 
 * Change this:
 * <name type="personal">
 *   <namePart>Jane Middlename Smith</namePart>
 *   <role>Thesis advisor</role>
 * </name>
 * 
 * Into this:
 * <name type="personal">
 *   <namePart type="given">Jane Middlename</namePart>
 *   <namePart type="family">Smith</namePart>
 *   <role>Thesis advisor</role>
 * </name>
 */

# grab the first user supplied parameter as the name of the collection
$collection = drush_shift();

// show angry message if we didn't get a paramter passed to the script
if (!$collection) {
    drush_print("***Error: please provide the name of the collection as the first argument");
    drush_print("Example: drush php-script regenFITSdata.php islandora:collection_name_here");
    return;
}

# include all php files necessary for Tuque
foreach ( glob("/var/www/drupal/htdocs/sites/all/libraries/tuque/*.php") as $filename) {
	require_once($filename);
}

# repository connection parameters
$url = 'localhost:8080/fedora';
$username = 'fedoraAdmin';
$password = 'fedoraAdmin';

# set up connection and repository variables
$connection = new RepositoryConnection($url, $username, $password);
$api = new FedoraApi($connection);
$repository = new FedoraRepository($api, new SimpleCache());

# query to grab all pdf collection objects from the repository
$sparqlQuery = "SELECT ?s
                FROM <#ri>
                WHERE {
                    ?s <info:fedora/fedora-system:def/relations-external#isMemberOfCollection> 
                    <info:fedora/$collection> .
                }";

# run query
drush_print("\n*****Querying repository for all PDF objects...");
$allPDFObjects = $repository->ri->sparqlQuery($sparqlQuery);
drush_print("\n*****Query complete*****\n");

// main loop for ALL PDF OBJECTS in the collection
$totalNumObjects = count($allPDFObjects);
drush_print("There are $totalNumObjects objects to be processed");

// establish a counter for how many objects we edit
$objectsChanged = 0;

drush_print("\n******Beginning main processing loop*****\n");
for ($counter = 0; $counter < $totalNumObjects; $counter++) {
    
    $theObject = $allPDFObjects[$counter];
    $realCount = $counter + 1;
    drush_print("Processing record $realCount of $totalNumObjects");
    
    //print $theObject['s']['value'];
    $objectPID = $theObject['s']['value'];
    
    # what is the pid you want?
    //$pid = 'islandora:1';
    
    # try to fetch PID from repo
    try {
        //drush_print("Attempting to access $objectPID from repository");
        $object = $repository->getObject($objectPID);
    }
    catch (Exception $e) {
        drush_print("\n\n**********#######  ERROR  #######*********");
        drush_print("***Could not get object $objectPID from repo***\n\n");
        continue;
    }
    
    # grab the MODS data stream
    $modsDS = $object['MODS'];
    
    /****************MODS RECORD**********************/

    $modsDOMDoc = new DOMDocument();
    $modsDOMDoc->preserveWhiteSpace = false;
    $modsDOMDoc->formatOutput = true;
    $modsDOMDoc->loadXML($modsDS->content);
    
    $modsXPath = new DOMXPath($modsDOMDoc);
    $modsXPath->registerNameSpace('mods', 'http://www.loc.gov/mods/v3');
    
    // flag to indicate if datastream reingest and DC regen is needed
    $updateThisRecord = FALSE;
    
    // loop through all <name type="personal"> entries looking for authors
    foreach ($modsXPath->query('//mods:name[@type="personal"]') as $node) {
    
        if (strcasecmp(trim($modsXPath->query('mods:role', $node)->item(0)->nodeValue), "Thesis advisor") == 0) {
            $roleNode = $modsXPath->query('mods:role', $node)->item(0);
            $namePartNode = $modsXPath->query('mods:namePart', $node)->item(0);
            
            // grab full name as single string
//             $fullname = $modsXPath->query('mods:namePart', $node)->item(0)->nodeValue;
            $fullname = $namePartNode->nodeValue;
            
            // break apart pieces
            $fullNameArray = explode(' ', $fullname);
            
            // build given name 
            $givenName = '';
            for ($i = 0; $i < count($fullNameArray)-1; $i++) {
                $givenName .= trim($fullNameArray[$i]) . " ";
            }
            
            $givenName = trim($givenName);
            $familyName = trim($fullNameArray[count($fullNameArray)-1]);
            
//             echo "Thesis advisor is ";
//             echo "$givenName $familyName\n";
            
            // construct new node for given name
            $newNodeGivenName = $modsDOMDoc->createElement('namePart', $givenName);
            $newNodeGivenName->setAttribute('type', 'given');
            
            // construct new node for family name
            $newNodeFamilyName = $modsDOMDoc->createElement('namePart', $familyName);
            $newNodeFamilyName->setAttribute('type', 'family');
            
            // insert new nodes into the DOM document
            $node->insertBefore($newNodeGivenName, $roleNode);
            $node->insertBefore($newNodeFamilyName, $roleNode);
            
            // remove the single name part node
            $mods = $modsDOMDoc->documentElement;
            $namePartNode->parentNode->removeChild($namePartNode);
            
            // set flag to re-ingest the datastream and regen the DC record
            $updateThisRecord = TRUE;
        }
    
    }
    
    if ($updateThisRecord) {
        // write the new updated info back into the datastream
        $modsDS->setContentFromString($modsDOMDoc->saveXML($modsDOMDoc->documentElement));
        
        # ingest edited datastream into the repository
        $object->ingestDatastream($modsDS);
        
        //drush_print("MODS record updated for object pid: $objectPID\n");
        /*************MODS RECORD COMPLETE*****************/
        
        
        /******************DUBLIN CORE ********************/
        //drush_print("Re-generating Dublin Core");
        
        // update the DC based on the MODS record
        $document = new DOMDocument();
        $document->loadXML($modsDS->content);
        $transform = 'mods_to_dc.xsl';
        
        // the magic call
        xml_form_builder_update_dc_datastream($object, $transform, $document);
        
        //drush_print("Dublin core regenerated");
        
        /*************DUBLIN CORE COMPLETE*****************/
        
        // keep track of how many objects we edited
        $objectsChanged++;
        
    }
    else {
        //drush_print("No update necessary");
    }
}
drush_print("Main processing loop complete");
drush_print("$objectsChanged objects were updated");
echo "\n\nAll operations complete\n";