URNPubIdPlugin.inc.php

<?php
 
import('classes.plugins.PubIdPlugin');
 
class URNPubIdPlugin extends PubIdPlugin {
 
   public function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return $success;
      if ($success && $this->getEnabled($mainContextId)) {
         HookRegistry::register('Publication::getProperties::summaryProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Publication::getProperties::fullProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Publication::getProperties::values', array($this, 'modifyObjectPropertyValues'));
         HookRegistry::register('Publication::validate', array($this, 'validatePublicationUrn'));
         HookRegistry::register('Galley::getProperties::summaryProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Galley::getProperties::fullProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Galley::getProperties::values', array($this, 'modifyObjectPropertyValues'));
         HookRegistry::register('Issue::getProperties::summaryProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Issue::getProperties::fullProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Issue::getProperties::values', array($this, 'modifyObjectPropertyValues'));
         HookRegistry::register('Form::config::before', array($this, 'addPublicationFormFields'));
         HookRegistry::register('Form::config::before', array($this, 'addPublishFormNotice'));
         HookRegistry::register('TemplateManager::display', array($this, 'loadUrnFieldComponent'));
      }
      return $success;
   }
 
   //
   // Implement template methods from Plugin.
   //
   function getDisplayName() {
      return __('plugins.pubIds.urn.displayName');
   }
 
   function getDescription() {
      return __('plugins.pubIds.urn.description');
   }
 
 
   //
   // Implement template methods from PubIdPlugin.
   //
   function constructPubId($pubIdPrefix, $pubIdSuffix, $contextId) {
      $urn = $pubIdPrefix . $pubIdSuffix;
      $suffixFieldName = $this->getSuffixFieldName();
      $suffixGenerationStrategy = $this->getSetting($contextId, $suffixFieldName);
      // checkNo is already calculated for custom suffixes
      if ($suffixGenerationStrategy != 'customId' && $this->getSetting($contextId, 'urnCheckNo')) {
         $urn .= $this->_calculateCheckNo($urn);
      }
      return $urn;
   }
 
   function getPubIdType() {
      return 'other::urn';
   }
 
   function getPubIdDisplayType() {
      return 'URN';
   }
 
   function getPubIdFullName() {
      return 'Uniform Resource Name';
   }
 
   function getResolvingURL($contextId, $pubId) {
      $resolverURL = $this->getSetting($contextId, 'urnResolver');
      return $resolverURL . $pubId;
   }
 
   function getPubIdMetadataFile() {
      return $this->getTemplateResource('urnSuffixEdit.tpl');
   }
 
   function addJavaScript($request, $templateMgr) {
      $templateMgr->addJavaScript(
         'urnCheckNo',
         $request->getBaseUrl() . DIRECTORY_SEPARATOR . $this->getPluginPath() . DIRECTORY_SEPARATOR . 'js' . DIRECTORY_SEPARATOR . 'checkNumber.js',
         array(
            'inline' => false,
            'contexts' => ['publicIdentifiersForm', 'backend'],
         )
      );
   }
 
   function getPubIdAssignFile() {
      return $this->getTemplateResource('urnAssign.tpl');
   }
 
   function instantiateSettingsForm($contextId) {
      $this->import('classes.form.URNSettingsForm');
      return new URNSettingsForm($this, $contextId);
   }
 
   function getFormFieldNames() {
      return array('urnSuffix');
   }
 
   function getAssignFormFieldName() {
      return 'assignURN';
   }
 
   function getPrefixFieldName() {
      return 'urnPrefix';
   }
 
   function getSuffixFieldName() {
      return 'urnSuffix';
   }
 
   function getLinkActions($pubObject) {
      $linkActions = array();
      import('lib.pkp.classes.linkAction.request.RemoteActionConfirmationModal');
      $request = Application::get()->getRequest();
      $userVars = $request->getUserVars();
      $userVars['pubIdPlugIn'] = get_class($this);
      // Clear object pub id
      $linkActions['clearPubIdLinkActionURN'] = new LinkAction(
         'clearPubId',
         new RemoteActionConfirmationModal(
            $request->getSession(),
            __('plugins.pubIds.urn.editor.clearObjectsURN.confirm'),
            __('common.delete'),
            $request->url(null, null, 'clearPubId', null, $userVars),
            'modal_delete'
         ),
         __('plugins.pubIds.urn.editor.clearObjectsURN'),
         'delete',
         __('plugins.pubIds.urn.editor.clearObjectsURN')
      );
 
      if (is_a($pubObject, 'Issue')) {
         // Clear issue objects pub ids
         $linkActions['clearIssueObjectsPubIdsLinkActionURN'] = new LinkAction(
            'clearObjectsPubIds',
            new RemoteActionConfirmationModal(
               $request->getSession(),
               __('plugins.pubIds.urn.editor.clearIssueObjectsURN.confirm'),
               __('common.delete'),
               $request->url(null, null, 'clearIssueObjectsPubIds', null, $userVars),
               'modal_delete'
            ),
            __('plugins.pubIds.urn.editor.clearIssueObjectsURN'),
            'delete',
            __('plugins.pubIds.urn.editor.clearIssueObjectsURN')
         );
      }
 
      return $linkActions;
   }
 
   function getSuffixPatternsFieldNames() {
      return  array(
         'Issue' => 'urnIssueSuffixPattern',
         'Submission' => 'urnPublicationSuffixPattern',
         'Representation' => 'urnRepresentationSuffixPattern',
      );
   }
 
   function getDAOFieldNames() {
      return array('pub-id::other::urn');
   }
 
   function isObjectTypeEnabled($pubObjectType, $contextId) {
      return (boolean) $this->getSetting($contextId, "enable${pubObjectType}URN");
   }
 
   function getNotUniqueErrorMsg() {
      return __('plugins.pubIds.urn.editor.urnSuffixCustomIdentifierNotUnique');
   }
 
   public function modifyObjectProperties($hookName, $args) {
      $props =& $args[0];
 
      $props[] = 'pub-id::other::urn';
   }
 
   public function modifyObjectPropertyValues($hookName, $args) {
      $values =& $args[0];
      $object = $args[1];
      $props = $args[2];
 
      // URNs are not supported for IssueGalleys
      if (get_class($object) === 'IssueGalley') {
         return;
      }
 
      // URNs are already added to property values for Publications and Galleys
      if (get_class($object) === 'Publication' || get_class($object) === 'ArticleGalley') {
         return;
      }
 
      if (in_array('pub-id::other::urn', $props)) {
         $pubId = $this->getPubId($object);
         $values['pub-id::other::urn'] = $pubId ? $pubId : null;
      }
   }
 
   public function validatePublicationUrn($hookName, $args) {
      $errors =& $args[0];
      $action = $args[1];
      $props =& $args[2];
 
      if (empty($props['pub-id::other::urn'])) {
         return;
      }
 
      if ($action === VALIDATE_ACTION_ADD) {
         $submission = Services::get('submission')->get($props['submissionId']);
      } else {
         $publication = Services::get('publication')->get($props['id']);
         $submission = Services::get('submission')->get($publication->getData('submissionId'));
      }
 
      $contextId = $submission->getData('contextId');
      $urnPrefix = $this->getSetting($contextId, 'urnPrefix');
 
      $urnErrors = [];
      if (strpos($props['pub-id::other::urn'], $urnPrefix) !== 0) {
         $urnErrors[] = __('plugins.pubIds.urn.editor.missingPrefix', ['urnPrefix' => $urnPrefix]);
      }
      if (!$this->checkDuplicate($props['pub-id::other::urn'], 'Publication', $submission->getId(), $contextId)) {
         $urnErrors[] = $this->getNotUniqueErrorMsg();
      }
      if (!empty($urnErrors)) {
         $errors['pub-id::other::urn'] = $urnErrors;
      }
   }
 
   public function addPublicationFormFields($hookName, $form) {
 
      if ($form->id !== 'publicationIdentifiers') {
         return;
      }
 
      if (!$this->getSetting($form->submissionContext->getId(), 'enablePublicationURN')) {
         return;
      }
 
      $prefix = $this->getSetting($form->submissionContext->getId(), 'urnPrefix');
 
      $suffixType = $this->getSetting($form->submissionContext->getId(), 'urnSuffix');
      $pattern = '';
      if ($suffixType === 'default') {
         $pattern = '%j.v%vi%i.%a';
      } elseif ($suffixType === 'pattern') {
         $pattern = $this->getSetting($form->submissionContext->getId(), 'urnPublicationSuffixPattern');
      }
 
      // If a pattern exists, use a DOI-like field to generate the URN
      if ($pattern) {
         $fieldData = [
            'label' => __('plugins.pubIds.urn.displayName'),
            'value' => $form->publication->getData('pub-id::other::urn'),
            'prefix' => $prefix,
            'pattern' => $pattern,
            'contextInitials' => $form->submissionContext->getData('acronym', $form->submissionContext->getData('primaryLocale')) ?? '',
            'submissionId' => $form->publication->getData('submissionId'),
            'assignId' => __('plugins.pubIds.urn.editor.urn.assignUrn'),
            'clearId' => __('plugins.pubIds.urn.editor.clearObjectsURN'),
         ];
         if ($form->publication->getData('pub-id::publisher-id')) {
            $fieldData['publisherId'] = $form->publication->getData('pub-id::publisher-id');
         }
         if ($form->publication->getData('pages')) {
            $fieldData['pages'] = $form->publication->getData('pages');
         }
         if ($form->publication->getData('issueId')) {
            $issue = Services::get('issue')->get($form->publication->getData('issueId'));
            if ($issue) {
               $fieldData['issueNumber'] = $issue->getNumber() ?? '';
               $fieldData['issueVolume'] = $issue->getVolume() ?? '';
               $fieldData['year'] = $issue->getYear() ?? '';
            }
         }
         if ($suffixType === 'default') {
            $fieldData['missingPartsLabel'] = __('plugins.pubIds.urn.editor.missingIssue');
         } else  {
            $fieldData['missingPartsLabel'] = __('plugins.pubIds.urn.editor.missingParts');
         }
         $form->addField(new \PKP\components\forms\FieldPubId('pub-id::other::urn', $fieldData));
 
      // Otherwise add a field for manual entry that includes a button to generate
      // the check number
      } else {
         // Load the checkNumber.js file that is required for this field
         $this->addJavaScript(Application::get()->getRequest(), TemplateManager::getManager(Application::get()->getRequest()));
 
         $this->import('classes.form.FieldUrn');
         $form->addField(new \Plugins\Generic\URN\FieldUrn('pub-id::other::urn', [
            'label' => __('plugins.pubIds.urn.displayName'),
            'description' => __('plugins.pubIds.urn.editor.urn.description', ['prefix' => $prefix]),
            'value' => $form->publication->getData('pub-id::other::urn'),
         ]));
      }
   }
 
   public function addPublishFormNotice($hookName, $form) {
 
      if ($form->id !== 'publish' || !empty($form->errors)) {
         return;
      }
 
      $submission = Services::get('submission')->get($form->publication->getData('submissionId'));
      $publicationUrnEnabled = $this->getSetting($submission->getData('contextId'), 'enablePublicationURN');
      $galleyUrnEnabled = $this->getSetting($submission->getData('contextId'), 'enableRepresentationURN');
      $warningIconHtml = '<span class="fa fa-exclamation-triangle pkpIcon--inline"></span>';
 
      if (!$publicationUrnEnabled && !$galleyUrnEnabled) {
         return;
 
      // Use a simplified view when only assigning to the publication
      } else if (!$galleyUrnEnabled) {
         if ($form->publication->getData('pub-id::other::urn')) {
            $msg = __('plugins.pubIds.urn.editor.preview.publication', ['urn' => $form->publication->getData('pub-id::other::urn')]);
         } else {
            $msg = '<div class="pkpNotification pkpNotification--warning">' . $warningIconHtml . __('plugins.pubIds.urn.editor.preview.publication.none') . '</div>';
         }
         $form->addField(new \PKP\components\forms\FieldHTML('urn', [
            'description' => $msg,
            'groupId' => 'default',
         ]));
         return;
 
      // Show a table if more than one URN is going to be created
      } else {
         $urnTableRows = [];
         if ($publicationUrnEnabled) {
            if ($form->publication->getData('pub-id::other::urn')) {
               $urnTableRows[] = [$form->publication->getData('pub-id::other::urn'), 'Publication'];
            } else {
               $urnTableRows[] = [$warningIconHtml . __('submission.status.unassigned'), 'Publication'];
            }
         }
         if ($galleyUrnEnabled) {
            foreach ((array) $form->publication->getData('galleys') as $galley) {
               if ($galley->getStoredPubId('other::urn')) {
                  $urnTableRows[] = [$galley->getStoredPubId('other::urn'), __('plugins.pubIds.urn.editor.preview.galleys', ['galleyLabel' => $galley->getGalleyLabel()])];
               } else {
                  $urnTableRows[] = [$warningIconHtml . __('submission.status.unassigned'),__('plugins.pubIds.urn.editor.preview.galleys', ['galleyLabel' => $galley->getGalleyLabel()])];
               }
            }
         }
         if (!empty($urnTableRows)) {
            $table = '<table class="pkpTable"><thead><tr>' .
               '<th>' . __('plugins.pubIds.urn.displayName') . '</th>' .
               '<th>' . __('plugins.pubIds.urn.editor.preview.objects') . '</th>' .
               '</tr></thead><tbody>';
            foreach ($urnTableRows as $urnTableRow) {
               $table .= '<tr><td>' . $urnTableRow[0] . '</td><td>' . $urnTableRow[1] . '</td></tr>';
            }
            $table .= '</tbody></table>';
         }
         $form->addField(new \PKP\components\forms\FieldHTML('urn', [
            'description' => $table,
            'groupId' => 'default',
         ]));
      }
   }
 
   public function loadUrnFieldComponent($hookName, $args) {
      $templateMgr = $args[0];
      $template = $args[1];
 
      if ($template !== 'workflow/workflow.tpl') {
         return;
      }
 
      $templateMgr->addJavaScript(
         'urn-field-component',
         Application::get()->getRequest()->getBaseUrl() . '/' . $this->getPluginPath() . '/js/FieldUrn.js',
         [
            'contexts' => 'backend',
            'priority' => STYLE_SEQUENCE_LAST,
         ]
      );
 
      $templateMgr->addStyleSheet(
         'urn-field-component',
         '
            .pkpFormField--urn__input {
               display: inline-block;
            }
 
            .pkpFormField--urn__button {
               margin-left: 0.25rem;
               height: 2.5rem; // Match input height
            }
         ',
         [
            'contexts' => 'backend',
            'inline' => true,
            'priority' => STYLE_SEQUENCE_LAST,
         ]
      );
   }
 
   //
   // Private helper methods
   //
   function _calculateCheckNo($urn) {
       $urnLower = strtolower_codesafe($urn);
 
       $conversionTable = array('9' => '41', '8' => '9', '7' => '8', '6' => '7', '5' => '6', '4' => '5', '3' => '4', '2' => '3', '1' => '2', '0' => '1', 'a' => '18', 'b' => '14', 'c' => '19', 'd' => '15', 'e' => '16', 'f' => '21', 'g' => '22', 'h' => '23', 'i' => '24', 'j' => '25', 'k' => '42', 'l' => '26', 'm' => '27', 'n' => '13', 'o' => '28', 'p' => '29', 'q' => '31', 'r' => '12', 's' => '32', 't' => '33', 'u' => '11', 'v' => '34', 'w' => '35', 'x' => '36', 'y' => '37', 'z' => '38', '-' => '39', ':' => '17', '_' => '43', '/' => '45', '.' => '47', '+' => '49');
 
       $newURN = '';
       for ($i = 0; $i < strlen($urnLower); $i++) {
         $char = $urnLower[$i];
         $newURN .= $conversionTable[$char];
       }
       $sum = 0;
       for ($j = 1; $j <= strlen($newURN); $j++) {
          $sum = $sum + ($newURN[$j-1] * $j);
       }
 
       $lastNumber = $newURN[strlen($newURN)-1];
       $quot = $sum / $lastNumber;
       $quotRound = floor($quot);
       $quotString = (string)$quotRound;
 
       return $quotString[strlen($quotString)-1];
   }
}