Merge branch 'check_isbn_3_3_0' into 'stable-3_3_0'

Validate ISBN See merge request softwares-pkp/plugins_ojs/thoth-omp-plugin!42
lepidus · Jan 17, 2025 · ccdaf7c · ccdaf7c
2 parents 7631726 + 8532020
commit ccdaf7c
Show file tree

Hide file tree

Showing 16 changed files with 301 additions and 64 deletions.
diff --git a/.github/workflows/generate-package.yml b/.github/workflows/generate-package.yml
@@ -34,6 +34,8 @@ jobs:
           mkdir $PLUGIN_NAME
           shopt -s extglob
           cp -r !($PLUGIN_NAME|.git*|.|..|tests) $PLUGIN_NAME
+          wget -O composer.phar https://getcomposer.org/composer-stable.phar
+          php composer.phar install -d ${PLUGIN_NAME}
           tar -zcvf $PLUGIN_NAME.tar.gz $PLUGIN_NAME
         shell: bash
       - name: Create the release
@@ -47,7 +49,7 @@ jobs:
           draft: false
           prerelease: false
       - name: Upload the package as release asset
-        id: upload-release-asset 
+        id: upload-release-asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+vendor
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -12,3 +12,4 @@ include:
   before_script:
     - rm -rf lib/APIKeyEncryption
     - git submodule update --init --depth 1
+    - composer install
diff --git a/ThothPlugin.inc.php b/ThothPlugin.inc.php
@@ -31,7 +31,7 @@ public function register($category, $path, $mainContextId = null)
         if ($success && $this->getEnabled()) {
             $thothRegister = new ThothRegister($this);
             HookRegistry::register('Schema::get::submission', [$thothRegister, 'addWorkIdToSchema']);
-            HookRegistry::register('Form::config::before', [$thothRegister, 'addImprintField']);
+            HookRegistry::register('Form::config::before', [$thothRegister, 'addThothField']);
             HookRegistry::register('Publication::validatePublish', [$thothRegister, 'validateRegister']);
             HookRegistry::register('TemplateManager::display', [$thothRegister, 'addResources']);
             HookRegistry::register('Publication::publish', [$thothRegister, 'registerOnPublish']);

diff --git a/classes/ThothRegister.inc.php b/classes/ThothRegister.inc.php
@@ -14,6 +14,7 @@
  */
 
 import('plugins.generic.thoth.classes.facades.ThothService');
+import('plugins.generic.thoth.classes.ThothValidator');
 
 class ThothRegister
 {
@@ -35,9 +36,8 @@ public function addWorkIdToSchema($hookName, $args)
         return false;
     }
 
-    public function addImprintField($hookName, $form)
+    public function addThothField($hookName, $form)
     {
-
         if ($form->id !== 'publish' || !empty($form->errors)) {
             return;
         }
@@ -48,48 +48,63 @@ public function addImprintField($hookName, $form)
             return;
         }
 
+        $errors = [];
+
         try {
             $thothClient = $this->plugin->getThothClient($submission->getData('contextId'));
             $publishers = $thothClient->linkedPublishers();
             $imprints = $thothClient->imprints(['publishers' => array_column($publishers, 'publisherId')]);
+        } catch (ThothException $e) {
+            $errors[] = __('plugins.generic.thoth.connectionError');
+            error_log($e->getMessage());
+        }
 
-            $imprintOptions = [];
-            foreach ($imprints as $imprint) {
-                $imprintOptions[] = [
-                    'value' => $imprint['imprintId'],
-                    'label' => $imprint['imprintName']
-                ];
-            }
+        if (empty($errors)) {
+            $errors = ThothValidator::validate($submission);
+        }
 
-            $form->addField(new \PKP\components\forms\FieldOptions('registerConfirmation', [
-                'label' => __('plugins.generic.thoth.register.label'),
-                'options' => [
-                    ['value' => true, 'label' => __('plugins.generic.thoth.register.confirmation')]
-                ],
-                'value' => false,
-                'groupId' => 'default',
-            ]))
-            ->addField(new \PKP\components\forms\FieldSelect('imprint', [
-                'label' => __('plugins.generic.thoth.imprint'),
-                'options' => $imprintOptions,
-                'required' => true,
-                'showWhen' => 'registerConfirmation',
-                'groupId' => 'default',
-                'value' => $imprints[0]['imprintId'] ?? null
-            ]));
-        } catch (ThothException $e) {
-            $warningIconHtml = '<span class="fa fa-exclamation-triangle pkpIcon--inline"></span>';
-            $noticeMsg = __('plugins.generic.thoth.connectionError');
-            $msg = '<div class="pkpNotification pkpNotification--warning">' . $warningIconHtml . $noticeMsg . '</div>';
+        if (!empty($errors)) {
+            $msg = '<div class="pkpNotification pkpNotification--warning">';
+            $msg .= __('plugins.generic.thoth.register.warning');
+            $msg .= '<ul>';
+            foreach ($errors as $error) {
+                $msg .= '<li>' .  $error . '</li>';
+            }
+            $msg .= '</ul></div>';
 
             $form->addField(new \PKP\components\forms\FieldHTML('registerNotice', [
                 'description' => $msg,
                 'groupId' => 'default',
             ]));
 
-            error_log($e->getMessage());
+            return false;
         }
 
+        $imprintOptions = [];
+        foreach ($imprints as $imprint) {
+            $imprintOptions[] = [
+                'value' => $imprint['imprintId'],
+                'label' => $imprint['imprintName']
+            ];
+        }
+
+        $form->addField(new \PKP\components\forms\FieldOptions('registerConfirmation', [
+            'label' => __('plugins.generic.thoth.register.label'),
+            'options' => [
+                ['value' => true, 'label' => __('plugins.generic.thoth.register.confirmation')]
+            ],
+            'value' => false,
+            'groupId' => 'default',
+        ]))
+        ->addField(new \PKP\components\forms\FieldSelect('imprint', [
+            'label' => __('plugins.generic.thoth.imprint'),
+            'options' => $imprintOptions,
+            'required' => true,
+            'showWhen' => 'registerConfirmation',
+            'groupId' => 'default',
+            'value' => $imprints[0]['imprintId'] ?? null
+        ]));
+
         return false;
     }
 

diff --git a/classes/ThothValidator.inc.php b/classes/ThothValidator.inc.php
@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * @file plugins/generic/thoth/classes/ThothValidator.php
+ *
+ * Copyright (c) 2025 Lepidus Tecnologia
+ * Copyright (c) 2025 Thoth
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class ThothValidator
+ * @ingroup plugins_generic_thoth
+ *
+ * @brief Validate submission metadata to Thoth submit
+ */
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+use Biblys\Isbn\Isbn;
+
+import('plugins.generic.thoth.classes.facades.ThothService');
+
+class ThothValidator
+{
+    public static function validate($submission)
+    {
+        $errors = [];
+
+        $publicationFormats = Application::getRepresentationDao()
+            ->getApprovedByPublicationId($submission->getData('currentPublicationId'))
+            ->toArray();
+
+        $publicationFormats = array_filter($publicationFormats, function ($publicationFormat) {
+            return $publicationFormat->getIsAvailable();
+        });
+
+        $errors = array_merge($errors, self::validateIsbn($publicationFormats));
+
+        return $errors;
+    }
+
+    public static function validateIsbn($publicationFormats)
+    {
+        $errors = [];
+        foreach ($publicationFormats as $publicationFormat) {
+            try {
+                $isbn = ThothService::publication()->getIsbnByPublicationFormat($publicationFormat);
+                Isbn::validateAsIsbn13($isbn);
+            } catch (Exception $e) {
+                $errors[] = __('plugins.generic.thoth.validation.isbn', [
+                    'isbn' => $isbn,
+                    'formatName' => $publicationFormat->getLocalizedName()
+                ]);
+            }
+        }
+
+        return $errors;
+    }
+}
diff --git a/classes/components/forms/RegisterForm.inc.php b/classes/components/forms/RegisterForm.inc.php
@@ -39,14 +39,18 @@ public function __construct($action, $imprints, $errors)
                 'pageId' => 'default',
             ]);
 
+            $msg = '<div class="pkpNotification pkpNotification--warning">';
+            $msg .= __('plugins.generic.thoth.register.warning');
+            $msg .= '<ul>';
             foreach ($errors as $error) {
-                $warningIconHtml = '<span class="fa fa-exclamation-triangle pkpIcon--inline"></span>';
-                $msg = '<div class="pkpNotification pkpNotification--warning">' . $warningIconHtml . $error . '</div>';
-                $this->addField(new \PKP\components\forms\FieldHTML('registerNotice', [
-                    'description' => $msg,
-                    'groupId' => 'default',
-                ]));
+                $msg .= '<li>' .  $error . '</li>';
             }
+            $msg .= '</ul></div>';
+
+            $this->addField(new \PKP\components\forms\FieldHTML('registerNotice', [
+                'description' => $msg,
+                'groupId' => 'default',
+            ]));
 
             return;
         }

diff --git a/classes/services/ThothPublicationService.inc.php b/classes/services/ThothPublicationService.inc.php
@@ -169,33 +169,10 @@ public function getIsbnByPublicationFormat($publicationFormat)
         $identificationCodes = $publicationFormat->getIdentificationCodes()->toArray();
         foreach ($identificationCodes as $identificationCode) {
             if ($identificationCode->getCode() == "15" || $identificationCode->getCode() == "24") {
-                $isbn = $identificationCode->getValue();
-                return $this->convertToIsbn13($isbn);
+                return $identificationCode->getValue();
             }
         }
 
         return null;
     }
-
-    private function convertToIsbn13($isbnString)
-    {
-        if (preg_match('/(?=.{17}$)97(?:8|9)([ -])\d{1,5}\1\d{1,7}\1\d{1,6}\1\d$/', $isbnString)) {
-            return $isbnString;
-        }
-
-        $isbnNumber = preg_replace('/\D/', '', $isbnString);
-
-        if (strlen($isbnNumber) != 13) {
-            return $isbnString;
-        }
-
-        return sprintf(
-            '%s-%s-%s-%s-%s',
-            substr($isbnNumber, 0, 3),
-            substr($isbnNumber, 3, 1),
-            substr($isbnNumber, 4, 2),
-            substr($isbnNumber, 6, 6),
-            substr($isbnNumber, 12, 1)
-        );
-    }
 }
diff --git a/composer.json b/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "biblys/isbn": "~3.0"
+    }
+}
diff --git a/composer.lock b/composer.lock
diff --git a/controllers/modal/RegisterHandler.inc.php b/controllers/modal/RegisterHandler.inc.php
@@ -86,6 +86,8 @@ public function register($args, $request)
             $thothClient = $plugin->getThothClient($submissionContext->getId());
             $publishers = $thothClient->linkedPublishers();
             $imprints = $thothClient->imprints(['publishers' => array_column($publishers, 'publisherId')]);
+
+            $errors = array_merge(ThothValidator::validate($this->submission), $errors);
         } catch (ThothException $e) {
             $errors[] = __('plugins.generic.thoth.connectionError');
             error_log($e->getMessage());

diff --git a/locale/en_US/locale.po b/locale/en_US/locale.po
@@ -48,6 +48,12 @@ msgstr "Register"
 msgid "plugins.generic.thoth.register.label"
 msgstr "Thoth registration"
 
+msgid "plugins.generic.thoth.register.warning"
+msgstr "The submission metadata can not be submitted to Thoth because of the following errors:"
+
+msgid "plugins.generic.thoth.validation.isbn"
+msgstr "\"{$isbn}\" of \"{$formatName}\" publication format is not a valid ISBN-13. A valid ISBN-13 must be exactly 17 characters (numbers and hyphens)."
+
 msgid "plugins.generic.thoth.register.confirmation"
 msgstr "Do you want to register in Thoth the metadata related to this submission?"
 

diff --git a/locale/es_ES/locale.po b/locale/es_ES/locale.po
@@ -48,6 +48,12 @@ msgstr "Registrar"
 msgid "plugins.generic.thoth.register.label"
 msgstr "Registro en Thoth"
 
+msgid "plugins.generic.thoth.register.warning"
+msgstr "Los metadatos de envio no pueden ser enviados a Thoth debido a los siguientes errores:"
+
+msgid "plugins.generic.thoth.validation.isbn"
+msgstr "\"{$isbn}\" del formato de publicación \"{$formatName}\" no es un ISBN-13 válido. Un ISBN-13 válido debe tener exactamente 17 caracteres (números y guiones)."
+
 msgid "plugins.generic.thoth.register.confirmation"
 msgstr "¿Desea registrar en Thoth los metadatos relacionados con este envío?"
 

diff --git a/locale/pt_BR/locale.po b/locale/pt_BR/locale.po
@@ -48,6 +48,12 @@ msgstr "Registrar"
 msgid "plugins.generic.thoth.register.label"
 msgstr "Registro em Thoth"
 
+msgid "plugins.generic.thoth.register.warning"
+msgstr "Os metadados da submissão não podem ser enviados para Thoth devido aos seguintes erros:"
+
+msgid "plugins.generic.thoth.validation.isbn"
+msgstr "\"{$isbn}\" do formato de publicação \"{$formatName}\" não é um ISBN-13 válido. Um ISBN-13 válido deve ter exatamente 17 caracteres (números e hífens)."
+
 msgid "plugins.generic.thoth.register.confirmation"
 msgstr "Deseja realmente registrar na Thoth os metadados relacionados a essa submissão?"