Merge branch 'update_thoth_auth-3_4_0-i1171' into 'stable-3_4_0'

Update Thoth auth to use personal access token

See merge request softwares-pkp/plugins_ojs/thoth-omp-plugin!100

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

@@ -19,7 +19,7 @@ This plugin is compatible with the following PKP applications:
 
 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
 
@@ -41,7 +41,7 @@ This is required to use the API credentials provided, that are stored encrypted
 
 To configure the plugin:
 
-- **E-mail** and **Password**: Enter the credentials for a Thoth account to connect with the API.
+- **Personal access token**: Enter a valid Thoth personal access token to authenticate API requests.
 - **Test Environment**: Check this option if you are using a local instance of the Thoth API for testing purposes.
 
 ![settings](/images/settings.png)

ThothSettingsForm.inc.php

@@ -33,8 +33,7 @@ class ThothSettingsForm extends Form
     private $encryption;
 
     private const SETTINGS = [
-        'email',
-        'password',
+        'token',
         'testEnvironment',
     ];
 
@@ -50,11 +49,10 @@ public function __construct($plugin, $contextId)
         $form = $this;
         $this->addCheck(new FormValidatorCustom(
             $this,
-            'password',
+            'token',
             'required',
             'plugins.generic.thoth.settings.invalidCredentials',
-            function ($password) use ($form) {
-                $email = trim($this->getData('email'));
+            function ($token) use ($form) {
                 $testEnvironment = $this->getData('testEnvironment');
                 $httpConfig = [];
                 if ($testEnvironment) {
@@ -64,7 +62,7 @@ function ($password) use ($form) {
                 $client = new Client($httpConfig);
 
                 try {
-                    $client->login($email, $password);
+                    $client->setToken(trim($token))->me();
                 } catch (QueryException $e) {
                     return false;
                 }
@@ -79,10 +77,10 @@ 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) :
+            if ($setting == 'token') {
+                $token = $this->plugin->getSetting($this->contextId, $setting);
+                $this->_data[$setting] = ($this->encryption->secretConfigExists() && $token) ?
+                    $this->encryption->decryptString($token) :
                     null;
                 continue;
             }
@@ -104,20 +102,20 @@ 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($password)) {
-            $encryptedPassword = $this->encryption->encryptString($password);
-            $this->setData('password', $encryptedPassword);
+        if (!$this->encryption->textIsEncrypted($token)) {
+            $encryptedToken = $this->encryption->encryptString($token);
+            $this->setData('token', $encryptedToken);
         }
     }
 }

classes/container/providers/ThothRepositoryProvider.inc.php

@@ -54,13 +54,11 @@ public function register($container)
             $contextId = Application::get()->getRequest()->getContext()->getId();
 
             $testEnvironment = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'testEnvironment');
-            $email = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'email');
-            $password = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'password') ?? '';
+            $token = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'token') ?? '';
 
             return [
                 'testEnvironment' => $testEnvironment,
-                'email' => $email,
-                'password' => $encryption->decryptString($password)
+                'token' => $token ? $encryption->decryptString($token) : ''
             ];
         });
 
@@ -73,7 +71,7 @@ public function register($container)
             }
 
             $client = new Client($httpConfig);
-            return $client->login($config['email'], $config['password']);
+            return $client->setToken($config['token']);
         });
 
         $container->set('accountRepository', function ($container) {

classes/repositories/ThothAccountRepository.inc.php

@@ -25,7 +25,23 @@ public function __construct($thothClient)
 
     public function getLinkedPublishers()
     {
-        $details = $this->thothClient->accountDetails();
-        return $details['resourceAccess']['linkedPublishers'];
+        $result = $this->thothClient->rawQuery(
+            <<<'GQL'
+            query {
+                me {
+                    publisherContexts {
+                        publisher {
+                            publisherId
+                        }
+                    }
+                }
+            }
+            GQL
+        );
+
+        return array_map(
+            fn ($publisherContext) => $publisherContext['publisher'],
+            $result['me']['publisherContexts'] ?? []
+        );
     }
 }

composer.json

@@ -1,6 +1,6 @@
 {
     "require": {
         "biblys/isbn": "~3.0",
-        "thoth-pub/thoth-client-php": "^1.3"
+        "thoth-pub/thoth-client-php": "^1.4"
     }
 }