Merge pull request #57 from lepidus/stable-3_4_0

Update thoth schema integration (OMP 3.4.0)

Author: thiagolepidus

.gitlab-ci.yml

@@ -3,7 +3,7 @@ variables:
 
 include:
   - project: 'documentacao-e-tarefas/modelosparaintegracaocontinua'
-    ref: main
+    ref: stable-3_4_0
     file:
       - 'templates/groups/pkp_plugin.yml'
       - 'templates/groups/omp/unit_tests.yml'

README.md

@@ -2,7 +2,11 @@
 
 # Thoth OMP Plugin
 
-Enables metadata exchange between OMP and Thoth Open Metadata to facilitate easy transfer and subsequent enhancement of book- and chapter-level data in the free-to-use self-service [Thoth](https://thoth.pub/) metadata platform, enabling OMP users to generate metadata in multiple book-specific formats including ONIX, MARC, KBART, Crossref XML, etc.
+[![Current Version](https://img.shields.io/badge/version-v0.3.0.0-blue)](https://github.com/thoth-pub/thoth-omp-plugin/releases)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-green.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![OMP compatibility](https://img.shields.io/badge/OMP-3.3_%7C_3.4-blue)](https://pkp.sfu.ca/software/omp/)
+
+Integrates [OMP (Open Monograph Press)](https://pkp.sfu.ca/software/omp/) with [Thoth](https://thoth.pub/), an open metadata management platform for books. This plugin enables the registration and synchronization of book- and chapter-level metadata directly from OMP into Thoth, where it can be disseminated in multiple industry-standard formats including ONIX, MARC, KBART, and Crossref XML.
 
 ## Compatibility
 
@@ -17,9 +21,9 @@ This plugin is compatible with the following PKP applications:
 
 1. **api_key_secret**
 
-The OMP instance must have the `api_key_secret` configuration set up, you may contact your system administrator to do that (see [this post](https://forum.pkp.sfu.ca/t/how-to-generate-a-api-key-secret-code-in-ojs-3/72008)).
+The OMP instance must have the `api_key_secret` configuration set up. You may contact your system administrator to do that (see [this post](https://forum.pkp.sfu.ca/t/how-to-generate-a-api-key-secret-code-in-ojs-3/72008)).
 
-This is required to use the API credentials provided, that are stored encrypted in the OMP database.
+This is required to store the Thoth personal access token encrypted in the OMP database.
 
 ## Installation
 
@@ -31,52 +35,59 @@ This is required to use the API credentials provided, that are stored encrypted
 
 ## Usage
 
-### Guidelines
+### Configuration
 
-- Only basic HTML tags are preserved (`<strong>`, `<mark>`, `<em>`, `<i>`, `<u>`, `<sup>`, `<sub>`, `<ul>`, `<ol>` and `<li>`); all others will be removed
-- ISBN must be properly formatted (e.g., 978-3-16-148410-0).
-- To avoid incorrect assignment of affiliations in Thoth, is required the use of the [ROR plugin](https://github.com/withanage/ror) to fill the affiliations in OMP.
+After enabling the plugin, go to the plugin settings and fill in:
 
-### Configuration
+- **Personal access token**: A valid Thoth personal access token used to authenticate API requests.
+- **Custom Thoth API**: Check this option to use a custom Thoth API instead of the official one.
+- **Thoth API URL**: The URL of the custom Thoth API (only required when the custom API option is enabled).
 
-To configure the plugin:
+<img src="/docs/images/plugin_settings.png" alt="Plugin settings form with personal access token, custom API and URL fields" width="700">
 
-- **E-mail** and **Password**: Enter the credentials for a Thoth account to connect with the API.
-- **Test Environment**: Check this option if you are using a local instance of the Thoth API for testing purposes.
+### Registering Monographs
 
-![settings](/images/settings.png)
+#### Unpublished Monographs
 
-### Managing Monographs
+Register metadata in Thoth during the publishing process by selecting the option to register metadata in the publish modal and choosing an imprint.
 
-- **Unpublished Monographs**: Register metadata in Thoth during the publishing process by selecting the option to register metadata in the publish modal and choosing an imprint.
+<img src="/docs/images/register_field.png" alt="Publish modal with Thoth registration option" width="700">
 
-![publish](/images/publish.png)
+#### Published Monographs
 
-- **Published Monographs**: Register metadata for published monographs by using the 'Register' button next to the publication status.
+Register metadata for already-published monographs by using the 'Register' button next to the publication status.
 
-![button](/images/button.png)
-![register](/images/register.png)
+<img src="/docs/images/register_button.png" alt="Register button in the publication workflow" width="700">
+<img src="/docs/images/register_modal.png" alt="Registration modal with imprint selection" width="700">
 
 ### Updating Metadata
 
-To update metadata in Thoth, unpublish the monograph, edit the data, and the changes will be automatically updated in Thoth.
+Once a monograph is registered, metadata updates are **automatic**. Unpublish the monograph, edit the data, and the changes will be synchronized with Thoth upon republication.
+
+It is also possible to manually update the metadata in Thoth by clicking the 'Update Metadata' button next to the publication status.
 
 ### Accessing Thoth Book Records
 
-After metadata is published, a link to the book on Thoth will appear at the top of the publication.
+After metadata is registered, a link to the book on Thoth will appear at the top of the publication workflow.
+
+<img src="/docs/images/view_button.png" alt="View link to the Thoth book record" width="700">
 
-![link](/images/link.png)
+### Bulk Registration
 
-### Bulk register
+On the Thoth management page, you can submit a selection of titles from OMP into Thoth in bulk.
 
-On the Thoth page, you can bulk submit a selection of titles from OMP into Thoth.
+<img src="/docs/images/bulk_register_page.png" alt="Thoth management page with bulk registration" width="700">
+
+### Guidelines
 
-![page](/images/page.png)
+- Only basic HTML tags are preserved in text fields: `<strong>`, `<mark>`, `<em>`, `<i>`, `<u>`, `<sup>`, `<sub>`, `<ul>`, `<ol>`, and `<li>`. All other tags will be stripped.
+- ISBN must be properly formatted as ISBN-13 (e.g., `978-3-16-148410-0`).
+- To avoid incorrect affiliation assignment in Thoth, use the [ROR plugin](https://github.com/withanage/ror) to populate affiliations in OMP.
 
 ## OMP-Thoth Mapping of Data Fields
 
 <details>
-    <summary>Click here to see the data relationship between Thoth and OMP</summary>
+<summary>Click here to see the data relationship between OMP and Thoth</summary>
 
 | OMP               |                    |   | Thoth                  |                     |             |
 | ----------------- | ------------------ | - | ---------------------- | ------------------- | ----------- |

ThothSettingsForm.inc.php

@@ -33,9 +33,9 @@ class ThothSettingsForm extends Form
     private $encryption;
 
     private const SETTINGS = [
-        'email',
-        'password',
-        'testEnvironment',
+        'token',
+        'customThothApi',
+        'customThothApiUrl',
     ];
 
     public function __construct($plugin, $contextId)
@@ -50,21 +50,58 @@ public function __construct($plugin, $contextId)
         $form = $this;
         $this->addCheck(new FormValidatorCustom(
             $this,
-            'password',
+            'customThothApiUrl',
+            'required',
+            'plugins.generic.thoth.settings.customThothApiUrl.required',
+            function ($customThothApiUrl) {
+                if (!$this->getData('customThothApi')) {
+                    return true;
+                }
+                return !empty(trim($customThothApiUrl));
+            }
+        ));
+
+        $this->addCheck(new FormValidatorCustom(
+            $this,
+            'customThothApiUrl',
+            'optional',
+            'plugins.generic.thoth.settings.customThothApiUrl.invalid',
+            function ($customThothApiUrl) {
+                if (!$this->getData('customThothApi') || !trim($customThothApiUrl)) {
+                    return true;
+                }
+                return filter_var(trim($customThothApiUrl), FILTER_VALIDATE_URL) !== false;
+            }
+        ));
+
+        $this->addCheck(new FormValidatorCustom(
+            $this,
+            'customThothApiUrl',
+            'optional',
+            'plugins.generic.thoth.settings.customThothApiUrl.unreachable',
+            function ($customThothApiUrl) {
+                if (!$this->getData('customThothApi')) {
+                    return true;
+                }
+                return $this->validateCustomThothApiUrl(trim($customThothApiUrl));
+            }
+        ));
+
+        $this->addCheck(new FormValidatorCustom(
+            $this,
+            'token',
             'required',
             'plugins.generic.thoth.settings.invalidCredentials',
-            function ($password) use ($form) {
-                $email = trim($this->getData('email'));
-                $testEnvironment = $this->getData('testEnvironment');
+            function ($token) use ($form) {
                 $httpConfig = [];
-                if ($testEnvironment) {
-                    $httpConfig['base_uri'] = 'http://localhost:8000/';
+                if ($this->getData('customThothApi') && $this->getData('customThothApiUrl')) {
+                    $httpConfig['base_uri'] = trim($this->getData('customThothApiUrl'));
                 }
 
                 $client = new Client($httpConfig);
 
                 try {
-                    $client->login($email, $password);
+                    $client->setToken(trim($token))->me();
                 } catch (QueryException $e) {
                     return false;
                 }
@@ -79,11 +116,17 @@ function ($password) use ($form) {
     public function initData()
     {
         foreach (self::SETTINGS as $setting) {
-            if ($setting == 'password') {
-                $password = $this->plugin->getSetting($this->contextId, $setting);
-                $this->_data[$setting] = ($this->encryption->secretConfigExists() && $password) ?
-                    $this->encryption->decryptString($password) :
-                    null;
+            if ($setting == 'token') {
+                $token = $this->plugin->getSetting($this->contextId, $setting);
+                if ($this->encryption->secretConfigExists() && $token) {
+                    try {
+                        $this->_data[$setting] = $this->encryption->decryptString($token);
+                    } catch (Exception $e) {
+                        $this->_data[$setting] = '';
+                    }
+                } else {
+                    $this->_data[$setting] = null;
+                }
                 continue;
             }
             $this->_data[$setting] = $this->plugin->getSetting($this->contextId, $setting);
@@ -104,20 +147,34 @@ public function fetch($request, $template = null, $display = false)
 
     public function execute(...$functionArgs)
     {
-        $this->encryptPassword();
+        $this->encryptToken();
         foreach (self::SETTINGS as $setting) {
             $this->plugin->updateSetting($this->contextId, $setting, trim($this->getData($setting)), 'string');
         }
         parent::execute(...$functionArgs);
     }
 
-    private function encryptPassword()
+    private function encryptToken()
     {
-        $password = $this->getData('password');
+        $token = trim($this->getData('token'));
+
+        if (!$this->encryption->textIsEncrypted($token)) {
+            $encryptedToken = $this->encryption->encryptString($token);
+            $this->setData('token', $encryptedToken);
+        }
+    }
+
+    private function validateCustomThothApiUrl($customThothApiUrl)
+    {
+        if (!$customThothApiUrl) {
+            return false;
+        }
 
-        if (!$this->encryption->textIsEncrypted($password)) {
-            $encryptedPassword = $this->encryption->encryptString($password);
-            $this->setData('password', $encryptedPassword);
+        try {
+            (new Client(['base_uri' => $customThothApiUrl]))->publisherCount();
+            return true;
+        } catch (Exception $e) {
+            return false;
         }
     }
 }

classes/api/ThothEndpoint.inc.php

@@ -104,7 +104,7 @@ public function register($slimRequest, $response, $args)
             $this->handleNotification($request, $submission, true, $disableNotification);
         } catch (QueryException $e) {
             $thothBookService->deleteRegisteredEntry();
-            $this->handleNotification($request, $submission, false, $disableNotification, $e->getMessage());
+            $this->handleNotification($request, $submission, false, $disableNotification, $e);
             $failure['errors'][] = __('plugins.generic.thoth.register.error.log', ['reason' => $e->getMessage()]);
             return $response->withStatus(403)->withJson($failure);
         }

classes/container/providers/ThothRepositoryProvider.inc.php

@@ -29,7 +29,9 @@
 import('plugins.generic.thoth.classes.factories.ThothLocationFactory');
 import('plugins.generic.thoth.classes.factories.ThothPublicationFactory');
 import('plugins.generic.thoth.classes.repositories.ThothAccountRepository');
+import('plugins.generic.thoth.classes.repositories.ThothAbstractRepository');
 import('plugins.generic.thoth.classes.repositories.ThothAffiliationRepository');
+import('plugins.generic.thoth.classes.repositories.ThothBiographyRepository');
 import('plugins.generic.thoth.classes.repositories.ThothBookRepository');
 import('plugins.generic.thoth.classes.repositories.ThothChapterRepository');
 import('plugins.generic.thoth.classes.repositories.ThothContributionRepository');
@@ -41,6 +43,7 @@
 import('plugins.generic.thoth.classes.repositories.ThothPublicationRepository');
 import('plugins.generic.thoth.classes.repositories.ThothReferenceRepository');
 import('plugins.generic.thoth.classes.repositories.ThothSubjectRepository');
+import('plugins.generic.thoth.classes.repositories.ThothTitleRepository');
 import('plugins.generic.thoth.classes.repositories.ThothWorkRelationRepository');
 import('plugins.generic.thoth.classes.repositories.ThothWorkRepository');
 
@@ -53,33 +56,46 @@ public function register($container)
             $pluginSettingsDao = & DAORegistry::getDAO('PluginSettingsDAO');
             $contextId = Application::get()->getRequest()->getContext()->getId();
 
-            $testEnvironment = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'testEnvironment');
-            $email = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'email');
-            $password = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'password') ?? '';
+            $customThothApi = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'customThothApi');
+            $customThothApiUrl = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'customThothApiUrl');
+            $token = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'token') ?? '';
+            $decryptedToken = '';
+
+            if ($token) {
+                try {
+                    $decryptedToken = $encryption->decryptString($token);
+                } catch (Exception $e) {
+                    $decryptedToken = '';
+                }
+            }
 
             return [
-                'testEnvironment' => $testEnvironment,
-                'email' => $email,
-                'password' => $encryption->decryptString($password)
+                'customThothApi' => $customThothApi,
+                'customThothApiUrl' => $customThothApiUrl,
+                'token' => $decryptedToken
             ];
         });
 
         $container->set('client', function ($container) {
             $config = $container->get('config');
 
             $httpConfig = [];
-            if ($config['testEnvironment']) {
-                $httpConfig['base_uri'] = 'http://localhost:8000/';
+            if ($config['customThothApi'] && $config['customThothApiUrl']) {
+                $httpConfig['base_uri'] = trim($config['customThothApiUrl']);
             }
 
             $client = new Client($httpConfig);
-            return $client->login($config['email'], $config['password']);
+            return $client->setToken($config['token']);
         });
 
         $container->set('accountRepository', function ($container) {
             return new ThothAccountRepository($container->get('client'));
         });
 
+        $container->set('abstractRepository', function ($container) {
+            return new ThothAbstractRepository($container->get('client'));
+        });
+
         $container->set('affiliationRepository', function ($container) {
             return new ThothAffiliationRepository($container->get('client'));
         });
@@ -88,6 +104,10 @@ public function register($container)
             return new ThothBookRepository($container->get('client'));
         });
 
+        $container->set('biographyRepository', function ($container) {
+            return new ThothBiographyRepository($container->get('client'));
+        });
+
         $container->set('chapterRepository', function ($container) {
             return new ThothChapterRepository($container->get('client'));
         });
@@ -128,6 +148,10 @@ public function register($container)
             return new ThothSubjectRepository($container->get('client'));
         });
 
+        $container->set('titleRepository', function ($container) {
+            return new ThothTitleRepository($container->get('client'));
+        });
+
         $container->set('workRelationRepository', function ($container) {
             return new ThothWorkRelationRepository($container->get('client'));
         });