CHIEFSOFT\ameye
559 lines
20 KiB
PHP
559 lines
20 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file plugins/pubIds/urn/URNPubIdPlugin.php
|
|
*
|
|
* Copyright (c) 2014-2022 Simon Fraser University
|
|
* Copyright (c) 2003-2022 John Willinsky
|
|
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
|
|
*
|
|
* @class URNPubIdPlugin
|
|
*
|
|
* @brief URN plugin class
|
|
*/
|
|
|
|
namespace APP\plugins\pubIds\urn;
|
|
|
|
use APP\components\forms\publication\PublishForm;
|
|
use APP\core\Application;
|
|
use APP\facades\Repo;
|
|
use APP\issue\Issue;
|
|
use APP\plugins\PubIdPlugin;
|
|
use APP\plugins\pubIds\urn\classes\form\FieldPubIdUrn;
|
|
use APP\plugins\pubIds\urn\classes\form\FieldTextUrn;
|
|
use APP\publication\Publication;
|
|
use APP\template\TemplateManager;
|
|
use PKP\components\forms\FormComponent;
|
|
use PKP\components\forms\publication\PKPPublicationIdentifiersForm;
|
|
use PKP\linkAction\LinkAction;
|
|
use PKP\linkAction\request\RemoteActionConfirmationModal;
|
|
use PKP\plugins\Hook;
|
|
|
|
class URNPubIdPlugin extends PubIdPlugin
|
|
{
|
|
/**
|
|
* @copydoc Plugin::register()
|
|
*
|
|
* @param null|mixed $mainContextId
|
|
*/
|
|
public function register($category, $path, $mainContextId = null)
|
|
{
|
|
$success = parent::register($category, $path, $mainContextId);
|
|
if (Application::isUnderMaintenance()) {
|
|
return $success;
|
|
}
|
|
if ($success && $this->getEnabled($mainContextId)) {
|
|
Hook::add('Publication::validate', [$this, 'validatePublicationUrn']);
|
|
Hook::add('Form::config::before', [$this, 'addPublicationFormFields']);
|
|
Hook::add('Form::config::before', [$this, 'addPublishFormNotice']);
|
|
Hook::add('TemplateManager::display', [$this, 'loadUrnFieldComponent']);
|
|
}
|
|
return $success;
|
|
}
|
|
|
|
//
|
|
// Implement template methods from Plugin.
|
|
//
|
|
/**
|
|
* @copydoc Plugin::getDisplayName()
|
|
*/
|
|
public function getDisplayName()
|
|
{
|
|
return __('plugins.pubIds.urn.displayName');
|
|
}
|
|
|
|
/**
|
|
* @copydoc Plugin::getDescription()
|
|
*/
|
|
public function getDescription()
|
|
{
|
|
return __('plugins.pubIds.urn.description');
|
|
}
|
|
|
|
|
|
//
|
|
// Implement template methods from PubIdPlugin.
|
|
//
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::constructPubId()
|
|
*/
|
|
public 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;
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getPubIdType()
|
|
*/
|
|
public function getPubIdType()
|
|
{
|
|
return 'other::urn';
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getPubIdDisplayType()
|
|
*/
|
|
public function getPubIdDisplayType()
|
|
{
|
|
return 'URN';
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getPubIdFullName()
|
|
*/
|
|
public function getPubIdFullName()
|
|
{
|
|
return 'Uniform Resource Name';
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getResolvingURL()
|
|
*/
|
|
public function getResolvingURL($contextId, $pubId)
|
|
{
|
|
$resolverURL = $this->getSetting($contextId, 'urnResolver');
|
|
return $resolverURL . $pubId;
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getPubIdMetadataFile()
|
|
*/
|
|
public function getPubIdMetadataFile()
|
|
{
|
|
return $this->getTemplateResource('urnSuffixEdit.tpl');
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::addJavaScript()
|
|
*/
|
|
public function addJavaScript($request, $templateMgr)
|
|
{
|
|
$templateMgr->addJavaScript(
|
|
'urnCheckNo',
|
|
"{$request->getBaseUrl()}/{$this->getPluginPath()}/js/checkNumber.js",
|
|
[
|
|
'inline' => false,
|
|
'contexts' => ['publicIdentifiersForm', 'backend'],
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getPubIdAssignFile()
|
|
*/
|
|
public function getPubIdAssignFile()
|
|
{
|
|
return $this->getTemplateResource('urnAssign.tpl');
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::instantiateSettingsForm()
|
|
*/
|
|
public function instantiateSettingsForm($contextId)
|
|
{
|
|
return new classes\form\URNSettingsForm($this, $contextId);
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getFormFieldNames()
|
|
*/
|
|
public function getFormFieldNames()
|
|
{
|
|
return ['urnSuffix'];
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getAssignFormFieldName()
|
|
*/
|
|
public function getAssignFormFieldName()
|
|
{
|
|
return 'assignURN';
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getPrefixFieldName()
|
|
*/
|
|
public function getPrefixFieldName()
|
|
{
|
|
return 'urnPrefix';
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getSuffixFieldName()
|
|
*/
|
|
public function getSuffixFieldName()
|
|
{
|
|
return 'urnSuffix';
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getLinkActions()
|
|
*/
|
|
public function getLinkActions($pubObject)
|
|
{
|
|
$linkActions = [];
|
|
$request = Application::get()->getRequest();
|
|
$userVars = $request->getUserVars();
|
|
$classNameParts = explode('\\', get_class($this)); // Separate namespace info from class name
|
|
$userVars['pubIdPlugIn'] = end($classNameParts);
|
|
// 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 ($pubObject instanceof 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;
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getSuffixPatternsFieldName()
|
|
*/
|
|
public function getSuffixPatternsFieldNames()
|
|
{
|
|
return [
|
|
'Issue' => 'urnIssueSuffixPattern',
|
|
'Publication' => 'urnPublicationSuffixPattern',
|
|
'Representation' => 'urnRepresentationSuffixPattern',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getDAOFieldNames()
|
|
*/
|
|
public function getDAOFieldNames()
|
|
{
|
|
return ['pub-id::other::urn'];
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::isObjectTypeEnabled()
|
|
*/
|
|
public function isObjectTypeEnabled($pubObjectType, $contextId)
|
|
{
|
|
return (bool) $this->getSetting($contextId, "enable{$pubObjectType}URN");
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::isObjectTypeEnabled()
|
|
*/
|
|
public function getNotUniqueErrorMsg()
|
|
{
|
|
return __('plugins.pubIds.urn.editor.urnSuffixCustomIdentifierNotUnique');
|
|
}
|
|
|
|
/**
|
|
* @copydoc PKPPubIdPlugin::getDAOs()
|
|
*/
|
|
public function getDAOs()
|
|
{
|
|
return [
|
|
Repo::issue()->dao,
|
|
Repo::publication()->dao,
|
|
Application::getRepresentationDAO(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Validate a publication's URN against the plugin's settings
|
|
*/
|
|
public function validatePublicationUrn(string $hookName, array $args): void
|
|
{
|
|
$errors = & $args[0];
|
|
$object = $args[1];
|
|
$props = & $args[2];
|
|
|
|
if (empty($props['pub-id::other::urn'])) {
|
|
return;
|
|
}
|
|
|
|
if (is_null($object)) {
|
|
$submission = Repo::submission()->get($props['submissionId']);
|
|
} else {
|
|
$publication = Repo::publication()->get($props['id']);
|
|
$submission = Repo::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;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add URN fields to the publication identifiers form
|
|
*/
|
|
public function addPublicationFormFields(string $hookName, FormComponent $form): void
|
|
{
|
|
if ($form->id !== 'publicationIdentifiers') {
|
|
return;
|
|
}
|
|
/** @var PKPPublicationIdentifiersForm $form */
|
|
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');
|
|
}
|
|
|
|
$appyCheckNumber = $this->getSetting($form->submissionContext->getId(), 'urnCheckNo');
|
|
|
|
if ($appyCheckNumber) {
|
|
// Load the checkNumber.js file that is required for URN fields
|
|
$this->addJavaScript(Application::get()->getRequest(), TemplateManager::getManager(Application::get()->getRequest()));
|
|
}
|
|
// 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'),
|
|
'assignIdLabel' => __('plugins.pubIds.urn.editor.urn.assignUrn'),
|
|
'clearIdLabel' => __('plugins.pubIds.urn.editor.clearObjectsURN'),
|
|
'applyCheckNumber' => $appyCheckNumber,
|
|
];
|
|
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 = Repo::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 FieldPubIdUrn('pub-id::other::urn', $fieldData));
|
|
|
|
// Otherwise add a field for manual entry that includes a button to generate
|
|
// the check number
|
|
} else {
|
|
$form->addField(new FieldTextUrn('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'),
|
|
'urnPrefix' => $prefix,
|
|
'applyCheckNumber' => $appyCheckNumber,
|
|
]));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show URN during final publish step
|
|
*/
|
|
public function addPublishFormNotice(string $hookName, FormComponent $form): void
|
|
{
|
|
if ($form->id !== 'publish' || !empty($form->errors)) {
|
|
return;
|
|
}
|
|
/** @var PublishForm $form */
|
|
$submission = Repo::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
|
|
} elseif (!$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 ($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',
|
|
]));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load the FieldUrn Vue.js component into Vue.js
|
|
*/
|
|
public function loadUrnFieldComponent(string $hookName, array $args): void
|
|
{
|
|
$templateMgr = $args[0];
|
|
$template = $args[1];
|
|
|
|
if ($template !== 'workflow/workflow.tpl') {
|
|
return;
|
|
}
|
|
|
|
$context = Application::get()->getRequest()->getContext();
|
|
$suffixType = $this->getSetting($context->getId(), 'urnSuffix');
|
|
if ($suffixType === 'default' || $suffixType === 'pattern') {
|
|
$templateMgr->addJavaScript(
|
|
'field-pub-id-urn-component',
|
|
Application::get()->getRequest()->getBaseUrl() . '/' . $this->getPluginPath() . '/js/FieldPubIdUrn.js',
|
|
[
|
|
'contexts' => 'backend',
|
|
'priority' => TemplateManager::STYLE_SEQUENCE_LAST,
|
|
]
|
|
);
|
|
} else {
|
|
$templateMgr->addJavaScript(
|
|
'field-text-urn-component',
|
|
Application::get()->getRequest()->getBaseUrl() . '/' . $this->getPluginPath() . '/js/FieldTextUrn.js',
|
|
[
|
|
'contexts' => 'backend',
|
|
'priority' => TemplateManager::STYLE_SEQUENCE_LAST,
|
|
]
|
|
);
|
|
$templateMgr->addStyleSheet(
|
|
'field-text-urn-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' => TemplateManager::STYLE_SEQUENCE_LAST,
|
|
]
|
|
);
|
|
}
|
|
}
|
|
|
|
//
|
|
// Private helper methods
|
|
//
|
|
/**
|
|
* Get the last, check number.
|
|
* Algorithm (s. http://www.persistent-identifier.de/?link=316):
|
|
* every URN character is replaced with a number according to the conversion table,
|
|
* every number is multiplied by it's position/index (beginning with 1),
|
|
* the numbers' sum is calculated,
|
|
* the sum is divided by the last number,
|
|
* the last number of the quotient before the decimal point is the check number.
|
|
*/
|
|
public function _calculateCheckNo($urn)
|
|
{
|
|
$urnLower = strtolower_codesafe($urn);
|
|
|
|
$conversionTable = ['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];
|
|
}
|
|
}
|
|
|
|
if (!PKP_STRICT_MODE) {
|
|
class_alias('\APP\plugins\pubIds\urn\URNPubIdPlugin', '\URNPubIdPlugin');
|
|
}
|