IssueCrossrefXmlFilter.inc.php

<?php
 
import('lib.pkp.plugins.importexport.native.filter.NativeExportFilter');
 
class IssueCrossrefXmlFilter extends NativeExportFilter {
   function __construct($filterGroup) {
      $this->setDisplayName('Crossref XML issue export');
      parent::__construct($filterGroup);
   }
 
   //
   // Implement template methods from PersistableFilter
   //
   function getClassName() {
      return 'plugins.importexport.crossref.filter.IssueCrossrefXmlFilter';
   }
 
   //
   // Implement template methods from Filter
   //
   function &process(&$pubObjects) {
      // Create the XML document
      $doc = new DOMDocument('1.0', 'utf-8');
      $doc->preserveWhiteSpace = false;
      $doc->formatOutput = true;
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
 
      // Create the root node
      $rootNode = $this->createRootNode($doc);
      $doc->appendChild($rootNode);
 
      // Create and appet the 'head' node and all parts inside it
      $rootNode->appendChild($this->createHeadNode($doc));
 
      // Create and append the 'body' node, that contains everything
      $bodyNode = $doc->createElementNS($deployment->getNamespace(), 'body');
      $rootNode->appendChild($bodyNode);
 
      foreach($pubObjects as $pubObject) {
         // pubObject is either Issue or Submission
         $journalNode = $this->createJournalNode($doc, $pubObject);
         $bodyNode->appendChild($journalNode);
      }
      return $doc;
   }
 
   //
   // Issue conversion functions
   //
   function createRootNode($doc) {
      $deployment = $this->getDeployment();
      $rootNode = $doc->createElementNS($deployment->getNamespace(), $deployment->getRootElementName());
      $rootNode->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', $deployment->getXmlSchemaInstance());
      $rootNode->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:jats', $deployment->getJATSNamespace());
      $rootNode->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:ai', $deployment->getAINamespace());
      $rootNode->setAttribute('version', $deployment->getXmlSchemaVersion());
      $rootNode->setAttribute('xsi:schemaLocation', $deployment->getNamespace() . ' ' . $deployment->getSchemaFilename());
      return $rootNode;
   }
 
   function createHeadNode($doc) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
      $plugin = $deployment->getPlugin();
      $headNode = $doc->createElementNS($deployment->getNamespace(), 'head');
      $headNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'doi_batch_id', htmlspecialchars($context->getData('initials', $context->getPrimaryLocale()) . '_' . time(), ENT_COMPAT, 'UTF-8')));
      $headNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'timestamp', time()));
      $depositorNode = $doc->createElementNS($deployment->getNamespace(), 'depositor');
      $depositorName = $plugin->getSetting($context->getId(), 'depositorName');
      if (empty($depositorName)) {
         $depositorName = $context->getData('supportName');
      }
      $depositorEmail = $plugin->getSetting($context->getId(), 'depositorEmail');
      if (empty($depositorEmail)) {
         $depositorEmail = $context->getData('supportEmail');
      }
      $depositorNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'depositor_name', htmlspecialchars($depositorName, ENT_COMPAT, 'UTF-8')));
      $depositorNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'email_address', htmlspecialchars($depositorEmail, ENT_COMPAT, 'UTF-8')));
      $headNode->appendChild($depositorNode);
      $publisherInstitution = $context->getData('publisherInstitution');
      $headNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'registrant', htmlspecialchars($publisherInstitution, ENT_COMPAT, 'UTF-8')));
      return $headNode;
   }
 
   function createJournalNode($doc, $pubObject) {
      $deployment = $this->getDeployment();
      $journalNode = $doc->createElementNS($deployment->getNamespace(), 'journal');
      $journalNode->appendChild($this->createJournalMetadataNode($doc));
      $journalNode->appendChild($this->createJournalIssueNode($doc, $pubObject));
      return $journalNode;
   }
 
   function createJournalMetadataNode($doc) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
 
      $journalMetadataNode = $doc->createElementNS($deployment->getNamespace(), 'journal_metadata');
      // Full title
      $journalTitle = $context->getName($context->getPrimaryLocale());
      // Attempt a fall back, in case the localized name is not set.
      if ($journalTitle == '') {
         $journalTitle = $context->getData('abbreviation', $context->getPrimaryLocale());
      }
      $journalMetadataNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'full_title', htmlspecialchars($journalTitle, ENT_COMPAT, 'UTF-8')));
      /* Abbreviated title - defaulting to initials if no abbreviation found */
      $journalAbbrev = $context->getData('abbreviation', $context->getPrimaryLocale());
      if ( $journalAbbrev == '' ) {
         $journalAbbrev = $context->getData('acronym', $context->getPrimaryLocale());
      }
      $journalMetadataNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'abbrev_title', htmlspecialchars($journalAbbrev, ENT_COMPAT, 'UTF-8')));
      /* Both ISSNs are permitted for CrossRef, so sending whichever one (or both) */
      if ($ISSN = $context->getData('onlineIssn') ) {
         $journalMetadataNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'issn', $ISSN));
         $node->setAttribute('media_type', 'electronic');
      }
      /* Both ISSNs are permitted for CrossRef so sending whichever one (or both) */
      if ($ISSN = $context->getData('printIssn') ) {
         $journalMetadataNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'issn', $ISSN));
         $node->setAttribute('media_type', 'print');
      }
      return $journalMetadataNode;
   }
 
   function createJournalIssueNode($doc, $issue) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
      $deployment->setIssue($issue);
 
      $journalIssueNode = $doc->createElementNS($deployment->getNamespace(), 'journal_issue');
      if ($issue->getDatePublished()) {
         $journalIssueNode->appendChild($this->createPublicationDateNode($doc, $issue->getDatePublished()));
      }
      if ($issue->getVolume() && $issue->getShowVolume()){
         $journalVolumeNode = $doc->createElementNS($deployment->getNamespace(), 'journal_volume');
         $journalVolumeNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'volume', htmlspecialchars($issue->getVolume(), ENT_COMPAT, 'UTF-8')));
         $journalIssueNode->appendChild($journalVolumeNode);
      }
      if ($issue->getNumber() && $issue->getShowNumber()) {
         $journalIssueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'issue', htmlspecialchars($issue->getNumber(), ENT_COMPAT, 'UTF-8')));
      }
      if ($issue->getDatePublished() && $issue->getStoredPubId('doi')) {
         $request = Application::get()->getRequest();
         $journalIssueNode->appendChild($this->createDOIDataNode($doc, $issue->getStoredPubId('doi'), $request->url($context->getPath(), 'issue', 'view', $issue->getBestIssueId($context), null, null, true)));
      }
      return $journalIssueNode;
   }
 
   function createPublicationDateNode($doc, $objectPublicationDate) {
      $deployment = $this->getDeployment();
      $publicationDate = strtotime($objectPublicationDate);
      $publicationDateNode = $doc->createElementNS($deployment->getNamespace(), 'publication_date');
      $publicationDateNode->setAttribute('media_type', 'online');
      if (date('m', $publicationDate)) {
         $publicationDateNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'month', date('m', $publicationDate)));
      }
      if (date('d', $publicationDate)) {
         $publicationDateNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'day', date('d', $publicationDate)));
      }
      $publicationDateNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'year', date('Y', $publicationDate)));
      return $publicationDateNode;
   }
 
   function createDOIDataNode($doc, $doi, $url) {
      $deployment = $this->getDeployment();
      $doiDataNode = $doc->createElementNS($deployment->getNamespace(), 'doi_data');
      $doiDataNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'doi', htmlspecialchars($doi, ENT_COMPAT, 'UTF-8')));
      $doiDataNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'resource', $url));
      return $doiDataNode;
   }
 
}