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

Changes credential encryption configuration text to make it clearer.

See merge request softwares-pkp/plugins_ojs/OASwitchboard!50

Author: YvesLepidus

OASwitchboardPlugin.inc.php

@@ -26,7 +26,7 @@ public function register($category, $path, $mainContextId = null)
             $message = new Message($this);
             $resources = new Resources($this);
             HookRegistry::register('Publication::publish', [$message, 'sendToOASwitchboard']);
-            HookRegistry::register('Form::config::before', [$message, 'validateRegister']);
+            HookRegistry::register('Form::config::before', [$message, 'validateBeforePublicationEvent']);
             HookRegistry::register('TemplateManager::display', [$resources, 'addWorkflowNotificationsJavaScript']);
             HookRegistry::register('NotificationManager::getNotificationMessage', [$resources, 'addMessageToInformationNotification']);
         }

classes/Message.inc.php

@@ -34,7 +34,7 @@ public function sendToOASwitchboard($hookName, $args)
         }
     }
 
-    public function validateRegister($hookName, $form)
+    public function validateBeforePublicationEvent($hookName, $form)
     {
         if ($form->id !== 'publish' || !empty($form->errors)) {
             return;

classes/settings/OASwitchboardSettingsForm.inc.php

@@ -16,7 +16,7 @@ public function __construct($plugin, $contextId)
         $this->contextId = $contextId;
         $this->addFormValidators();
 
-        $template = APIKeyEncryption::secretConfigExists() ? 'settingsForm.tpl' : 'tokenError.tpl';
+        $template = APIKeyEncryption::secretConfigExists() ? 'settingsForm.tpl' : 'missingSecretConfigWarning.tpl';
         parent::__construct($plugin->getTemplateResource($template));
     }
 

locale/en_US/locale.po

@@ -1,8 +1,13 @@
 msgid "plugins.generic.OASwitchboard.displayName"
 msgstr "OA Switchboard Plugin"
 
-msgid "plugins.generic.OASwitchboard.settings.apiKeyIsEmpty"
-msgstr "Your site administrator must set a secret in the config file ('api_key_secret')."
+msgid "plugins.generic.OASwitchboard.settings.apiKeySecretMissing"
+msgstr "Your OJS is missing a security setting ('api_key_secret'). You may contact your system administrator to set it up in the config file."
+
+msgid "plugins.generic.OASwitchboard.settings.apiKeySecretInfomration"
+msgstr ""
+"The 'api_key_secret' is use to safely store your OA Switchboard credentials.<br>More information on how to set it up can be found in <a href=\"https://forum.pkp.sfu.ca/t/how-to-generate-a-api-key-secret-code-in-ojs-3/72008/\" target=\"_blank\">this PKP Community Forum thread</a>."
+"<br><br>Once it's set up, come back here to enter your credentials."
 
 msgid "plugins.generic.OASwitchboard.settings.issnMissing"
 msgstr "Until an ISSN or eISSN is assigned to the journal, the OA Switchboard plugin will not be able to send messages."

locale/es_ES/locale.po

@@ -1,8 +1,13 @@
 msgid "plugins.generic.OASwitchboard.displayName"
 msgstr "Módulo de OA Switchboard"
 
-msgid "plugins.generic.OASwitchboard.settings.apiKeyIsEmpty"
-msgstr "El administrador de su sitio debe establecer un secreto en el archivo de configuración ('api_key_secret')."
+msgid "plugins.generic.OASwitchboard.settings.apiKeySecretMissing"
+msgstr "A su OJS le falta una configuración de seguridad ('api_key_secret'). Puede ponerse en contacto con su administrador del sistema para configurarlo en el archivo de configuración."
+
+msgid "plugins.generic.OASwitchboard.settings.apiKeySecretInfomration"
+msgstr ""
+"El 'api_key_secret' se utiliza para almacenar de forma segura sus credenciales de OA Switchboard.<br>Más información sobre cómo configurarlo se puede encontrar en este <a href=\"https://forum.pkp.sfu.ca/t/how-to-generate-a-api-key-secret-code-in-ojs-3/72008/\" target=\"_blank\">tema del Foro de la Comunidad PKP</a>."
+"<br><br>Una vez configurado, vuelva aquí para introducir sus credenciales."
 
 msgid "plugins.generic.OASwitchboard.settings.issnMissing"
 msgstr "Hasta que se asigne un ISSN o eISSN a la revista, el módulo de OA Switchboard no podrá enviar mensajes."

locale/pt_BR/locale.po

@@ -1,8 +1,11 @@
 msgid "plugins.generic.OASwitchboard.displayName"
 msgstr "Plugin OA Switchboard"
 
-msgid "plugins.generic.OASwitchboard.settings.apiKeyIsEmpty"
-msgstr "O administrador do seu site deve definir um segredo no arquivo de configuração ('api_key_secret')."
+msgid "plugins.generic.OASwitchboard.settings.apiKeySecretMissing"
+msgstr "Seu OJS está sem uma configuração de segurança ('api_key_secret'). Você pode contactar o administrador do sistema para defini-la no arquivo de configuração."
+
+msgid "plugins.generic.OASwitchboard.settings.apiKeySecretInfomration"
+msgstr "A configuração api_key_secret é usada para armazenar suas credenciais do OA Switchboard com segurança. Mais informações sobre como configurá-la podem ser encontradas <a href=\"https://forum.pkp.sfu.ca/t/how-to-generate-a-api-key-secret-code-in-ojs-3/72008/\" target=\"_blank\">neste tópico do Fórum da Comunidade PKP</a>."
 
 msgid "plugins.generic.OASwitchboard.settings.issnMissing"
 msgstr "Até que um ISSN ou eISSN seja atribuído à revista, o plugin OA Switchboard não poderá enviar mensagens."

templates/missingSecretConfigWarning.tpl

@@ -0,0 +1,13 @@
+{**
+* templates/tokenError.tpl
+*
+* Copyright (c) 2024 Lepidus Tecnologia
+* Distributed under the GNU GPL v3. For full terms see the file LICENSE.
+*
+*}
+<div id="OASwitchboardApiKeyError">
+    <div class="pkpNotification pkpNotification--warning">
+        <p>{translate key="plugins.generic.OASwitchboard.settings.apiKeySecretMissing"}</p>
+        <p>{translate key="plugins.generic.OASwitchboard.settings.apiKeySecretInfomration"}</p>
+    </div>
+</div>

templates/tokenError.tpl

@@ -12,8 +12,8 @@
 <version>
 	<application>OASwitchboard</application>
 	<type>plugins.generic</type>
-	<release>1.1.1.7</release>
-	<date>2024-10-30</date>
+	<release>1.1.1.8</release>
+	<date>2024-11-04</date>
 	<lazy-load>1</lazy-load>
 	<class>OASwitchboardPlugin</class>
 </version>