IssueMedraXmlFilter.inc.php

<?php
 
import('plugins.importexport.medra.filter.O4DOIXmlFilter');
 
 
class IssueMedraXmlFilter extends O4DOIXmlFilter {
   function __construct($filterGroup) {
      $this->setDisplayName('mEDRA XML issue export');
      parent::__construct($filterGroup);
   }
 
   function isWork($context, $plugin) {
      return $plugin->getSetting($context->getId(), 'exportIssuesAs') == O4DOI_ISSUE_AS_WORK;
   }
 
   //
   // Implement template methods from PersistableFilter
   //
   function getClassName() {
      return 'plugins.importexport.medra.filter.IssueMedraXmlFilter';
   }
 
   //
   // 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();
      $plugin = $deployment->getPlugin();
 
      // Create the root node
      $rootNodename = $this->isWork($context, $plugin) ? 'ONIXDOISerialIssueWorkRegistrationMessage' : 'ONIXDOISerialIssueVersionRegistrationMessage';
      $rootNode = $this->createRootNode($doc, $rootNodename);
      $doc->appendChild($rootNode);
 
      // Create and appet the header node and all parts inside it
      $rootNode->appendChild($this->createHeadNode($doc));
 
      // Create and append the issue nodes
      foreach($pubObjects as $pubObject) {
         $rootNode->appendChild($this->createIssueNode($doc, $pubObject));
      }
      return $doc;
   }
 
   function createIssueNode($doc, $pubObject) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
      $cache = $deployment->getCache();
      $plugin = $deployment->getPlugin();
      $request = Application::get()->getRequest();
      $router = $request->getRouter();
 
      $issueNodeName = $this->isWork($context, $plugin) ? 'DOISerialIssueWork' : 'DOISerialIssueVersion';
      $issueNode = $doc->createElementNS($deployment->getNamespace(), $issueNodeName);
      // Notification type (mandatory)
      $doi = $pubObject->getStoredPubId('doi');
      $registeredDoi = $pubObject->getData('medra::registeredDoi');
      assert(empty($registeredDoi) || $registeredDoi == $doi);
      $notificationType = (empty($registeredDoi) ? O4DOI_NOTIFICATION_TYPE_NEW : O4DOI_NOTIFICATION_TYPE_UPDATE);
      $issueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'NotificationType', $notificationType));
      // DOI (mandatory)
      $issueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'DOI', htmlspecialchars($doi, ENT_COMPAT, 'UTF-8')));
      // DOI URL (mandatory)
      $url = $router->url($request, $context->getPath(), 'issue', 'view', $pubObject->getBestIssueId(), null, null, true);
      if ($plugin->isTestMode($context)) {
         // Change server domain for testing.
         $url = PKPString::regexp_replace('#://[^\s]+/index.php#', '://example.com/index.php', $url);
      }
      $issueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'DOIWebsiteLink', $url));
      // DOI strucural type
      $structuralType = $this->isWork($context, $plugin) ? 'Abstraction' : 'DigitalFixation';
      $issueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'DOIStructuralType', $structuralType));
      // Registrant (mandatory)
      $issueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'RegistrantName', htmlspecialchars($plugin->getSetting($context->getId(), 'registrantName'), ENT_COMPAT, 'UTF-8')));
      // Registration authority (mandatory)
      $issueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'RegistrationAuthority', 'mEDRA'));
      // Work/ProductIdentifier - proprietary ID
      $pubObjectProprietaryId = $context->getId() . '-' . $pubObject->getId();
      $workOrProduct = $this->isWork($context, $plugin) ? 'Work' : 'Product';
      $issueNode->appendChild($this->createIdentifierNode($doc, $workOrProduct, O4DOI_ID_TYPE_PROPRIETARY, $pubObjectProprietaryId));
      // Issue/journal and object locale precedence.
      $journalLocalePrecedence = $objectLocalePrecedence = $this->getObjectLocalePrecedence($context, null, null);
      // Serial Publication (mandatory)
      $issueNode->appendChild($this->createSerialPublicationNode($doc, $journalLocalePrecedence, O4DOI_EPUB_FORMAT_HTML));
      // Journal Issue (mandatory)
      $issueId = $pubObject->getId();
      if (!$cache->isCached('issues', $issueId)) {
         $cache->add($pubObject, null);
      }
      $issueNode->appendChild($this->createJournalIssueNode($doc, $pubObject, $journalLocalePrecedence));
      // Object Description 'OtherText'
      $descriptions = $this->getTranslationsByPrecedence($pubObject->getDescription(null), $objectLocalePrecedence);
      foreach ($descriptions as $locale => $description) {
         $issueNode->appendChild($this->createOtherTextNode($doc, $locale, $description));
      }
 
      // 4) issue (as-work and as-manifestation):
      // related works:
      // - includes articles-as-work
      $submissionsIterator = Services::get('submission')->getMany([
         'contextId' => $pubObject->getJournalId(),
         'issueIds' => $pubObject->getId(),
         'status' => STATUS_PUBLISHED,
      ]);
      $galleyDao = DAORegistry::getDAO('ArticleGalleyDAO'); /* @var $galleyDao ArticleGalleyDAO */
      $relatedGalleys = [];
      foreach ($submissionsIterator as $relatedSubmission) {
         $articleProprietaryId = $context->getId() . '-' . $pubObject->getId() . '-' . $relatedSubmission->getId();
         $relatedSubmissionIds = array(O4DOI_ID_TYPE_PROPRIETARY => $articleProprietaryId);
         $doi = $relatedSubmission->getStoredPubId('doi');
         if (!empty($doi)) $relatedSubmissionIds[O4DOI_ID_TYPE_DOI] = $doi;
         $issueNode->appendChild($this->createRelatedNode($doc, 'Work', O4DOI_RELATION_INCLUDES, $relatedSubmissionIds));
         // related products:
         // - includes articles-as-manifestation
         $galleys = (array) $relatedSubmission->getCurrentPublication()->getData('galleys');
         foreach ($galleys as $galley) {
            $galleyProprietaryId = $context->getId() . '-' . $pubObject->getId() . '-' . $relatedSubmission->getId() . '-g' . $galley->getId();
            $relatedGalleyIds = array(O4DOI_ID_TYPE_PROPRIETARY => $galleyProprietaryId);
            $doi = $galley->getStoredPubId('doi');
            if (!empty($doi)) $relatedGalleyIds[O4DOI_ID_TYPE_DOI] = $doi;
            $issueNode->appendChild($this->createRelatedNode($doc, 'Product', O4DOI_RELATION_INCLUDES, $relatedGalleyIds));
            unset($galley, $relatedGalleyIds);
 
         }
         unset($relatedSubmission, $relatedSubmissionIds);
      }
 
      return $issueNode;
   }
 
   function createJournalIssueNode($doc, $issue, $journalLocalePrecedence) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
      $plugin = $deployment->getPlugin();
 
      $journalIssueNode = parent::createJournalIssueNode($doc, $issue, $journalLocalePrecedence);
 
      // Publication Date
      $datePublished = $issue->getDatePublished();
      if (!empty($datePublished)) {
         $journalIssueNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'PublicationDate', date('Ymd', strtotime($datePublished))));
      }
      // Issue Title (mandatory)
      $localizedTitles = $this->getTranslationsByPrecedence($issue->getTitle(null), $journalLocalePrecedence);
      // Retrieve the first key/value pair...
      foreach($localizedTitles as $locale => $localizedTitle) break;
      if (empty($localizedTitle)) {
         $localizedTitles = $this->getTranslationsByPrecedence($context->getName(null), $journalLocalePrecedence);
         // Retrieve the first key/value pair...
         foreach($localizedTitles as $locale => $localizedTitle) break;
         assert(!empty($localizedTitle));
 
         // Hack to make sure that no untranslated title appears:
         $showTitle = $issue->getShowTitle();
         $issue->setShowTitle(0);
         $localizedTitle = $localizedTitle . ', ' . $issue->getIssueIdentification();
         $issue->setShowTitle($showTitle);
      }
      $journalIssueNode->appendChild($this->createTitleNode($doc, $locale, $localizedTitle, O4DOI_TITLE_TYPE_ISSUE));
 
      // Extent (for issues-as-manifestation only)
      if (!$this->isWork($context, $plugin)) {
         $issueGalleyDao = DAORegistry::getDAO('IssueGalleyDAO'); /* @var $issueGalleyDao IssueGalleyDAO */
         $issueGalleys = $issueGalleyDao->getByIssueId($issue->getId());
         if (!empty($issueGalleys)) {
            foreach($issueGalleys as $issueGalley) {
               $journalIssueNode->appendChild($this->createExtentNode($doc, $issueGalley));
            }
         }
      }
 
      return $journalIssueNode;
   }
 
}