PubIdPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.PKPPubIdPlugin');
 
abstract class PubIdPlugin extends PKPPubIdPlugin {
 
   function __construct() {
      parent::__construct();
   }
 
 
   //
   // Protected template methods from PKPPlubIdPlugin
   //
   function getPubObjectTypes() {
      $pubObjectTypes = parent::getPubObjectTypes();
      array_push($pubObjectTypes, 'Chapter');
      return $pubObjectTypes;
   }
 
   function getPubId($pubObject) {
      // Get the pub id type
      $pubIdType = $this->getPubIdType();
 
      // If we already have an assigned pub id, use it.
      $storedPubId = $pubObject->getStoredPubId($pubIdType);
      if ($storedPubId) return $storedPubId;
 
      // Determine the type of the publishing object.
      $pubObjectType = $this->getPubObjectType($pubObject);
 
      // Initialize variables for publication objects.
      $submission = ($pubObjectType == 'Submission' ? $pubObject : null);
      $representation = ($pubObjectType == 'Representation' ? $pubObject : null);
      $submissionFile = ($pubObjectType == 'SubmissionFile' ? $pubObject : null);
      $chapter = ($pubObjectType == 'Chapter' ? $pubObject : null);
 
      // Get the context id.
      if ($pubObjectType == 'Submission') {
         $contextId = $pubObject->getContextId();
      } else {
         // Retrieve the submission.
         if (is_a($pubObject, 'Chapter') || is_a($pubObject, 'Representation')) {
            $publication = Services::get('publication')->get($pubObject->getData('publicationId'));
            $submission = Services::get('submission')->get($publication->getData('submissionId'));
         } else {
            assert(is_a($pubObject, 'SubmissionFile'));
            $submission = Services::get('submission')->get($pubObject->getSubmissionId());
         }
         if (!$submission) return null;
         // Now we can identify the context.
         $contextId = $submission->getContextId();
      }
      // Check the context
      $context = $this->getContext($contextId);
      if (!$context) return null;
      $contextId = $context->getId();
 
      // Check whether pub ids are enabled for the given object type.
      $objectTypeEnabled = $this->isObjectTypeEnabled($pubObjectType, $contextId);
      if (!$objectTypeEnabled) return null;
 
      // Retrieve the pub id prefix.
      $pubIdPrefix = $this->getSetting($contextId, $this->getPrefixFieldName());
      if (empty($pubIdPrefix)) return null;
 
      // Generate the pub id suffix.
      $suffixFieldName = $this->getSuffixFieldName();
      $suffixGenerationStrategy = $this->getSetting($contextId, $suffixFieldName);
      switch ($suffixGenerationStrategy) {
         case 'customId':
            $pubIdSuffix = $pubObject->getData($suffixFieldName);
            break;
 
         case 'pattern':
            $suffixPatternsFieldNames = $this->getSuffixPatternsFieldNames();
            $pubIdSuffix = $this->getSetting($contextId, $suffixPatternsFieldNames[$pubObjectType]);
 
            // %p - press initials
            $pubIdSuffix = PKPString::regexp_replace('/%p/', PKPString::strtolower($context->getAcronym($context->getPrimaryLocale())), $pubIdSuffix);
 
            // %x - custom identifier
            if ($pubObject->getStoredPubId('publisher-id')) {
               $pubIdSuffix = PKPString::regexp_replace('/%x/', $pubObject->getStoredPubId('publisher-id'), $pubIdSuffix);
            }
 
            if ($submission) {
               // %m - monograph id
               $pubIdSuffix = PKPString::regexp_replace('/%m/', $submission->getId(), $pubIdSuffix);
            }
 
            if ($chapter) {
               // %c - chapter id
               $pubIdSuffix = PKPString::regexp_replace('/%c/', $chapter->getId(), $pubIdSuffix);
            }
 
            if ($representation) {
               // %f - publication format id
               $pubIdSuffix = PKPString::regexp_replace('/%f/', $representation->getId(), $pubIdSuffix);
            }
 
            if ($submissionFile) {
               // %s - file id
               $pubIdSuffix = PKPString::regexp_replace('/%s/', $submissionFile->getFileId(), $pubIdSuffix);
            }
 
            break;
 
         default:
            $pubIdSuffix = PKPString::strtolower($context->getAcronym($context->getPrimaryLocale()));
 
            if ($submission) {
               $pubIdSuffix .= '.' . $submission->getId();
            }
 
            if ($chapter) {
               $pubIdSuffix .= '.c' . $chapter->getId();
            }
 
            if ($representation) {
               $pubIdSuffix .= '.' . $representation->getId();
            }
 
            if ($submissionFile) {
               $pubIdSuffix .= '.' . $submissionFile->getFileId();
            }
      }
      if (empty($pubIdSuffix)) return null;
 
      // Costruct the pub id from prefix and suffix.
      $pubId = $this->constructPubId($pubIdPrefix, $pubIdSuffix, $contextId);
 
      return $pubId;
   }
 
   function getDAOs() {
      return array_merge(parent::getDAOs(), array('Chapter' => DAORegistry::getDAO('ChapterDAO')));
   }
 
   function checkDuplicate($pubId, $pubObjectType, $excludeId, $contextId) {
      foreach ($this->getPubObjectTypes() as $type) {
         if ($type === 'Chapter') {
            $excludeTypeId = $type === $pubObjectType ? $excludeId : null;
            if (DAORegistry::getDAO('ChapterDAO')->pubIdExists($this->getPubIdType(), $pubId, $excludeTypeId, $contextId)) {
               return false;
            }
         }
      }
 
      return true;
   }
}