pkp#10792 Update ORCiD brand guidelines

taslangraham · Jan 21, 2025 · 8a4d04a · 8a4d04a
1 parent 5906fb3
commit 8a4d04a
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 12 deletions.
diff --git a/classes/author/maps/Schema.php b/classes/author/maps/Schema.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file classes/author/maps/Schema.php
  *
@@ -102,6 +103,9 @@ protected function mapByProperties(array $props, Author $item): array
                 case 'hasVerifiedOrcid':
                     $output[$prop] = $item->hasVerifiedOrcid();
                     break;
+                case 'orcidDisplayValue':
+                    $output[$prop] = $item->getOrcidDisplayValue();
+                    break;
                 default:
                     $output[$prop] = $item->getData($prop);
                     break;

diff --git a/classes/identity/Identity.php b/classes/identity/Identity.php
@@ -280,6 +280,19 @@ public function getOrcid()
         return $this->getData('orcid');
     }
 
+    /**
+     * Return the string that should be displayed when showing a user's ORCiD
+     *
+     */
+    public function getOrcidDisplayValue(): ?string
+    {
+        if (!$this->getOrcid()) {
+            return null;
+        }
+
+        return $this->hasVerifiedOrcid() ? $this->getOrcid() : $this->getOrcid() . ' (' . __('orcid.unauthenticated') . ')';
+    }
+
     /**
      * Set ORCID identifier.
      *

diff --git a/classes/orcid/OrcidManager.php b/classes/orcid/OrcidManager.php
@@ -79,6 +79,17 @@ public static function getIcon(): string
         return file_exists($path) ? file_get_contents($path) : '';
     }
 
+    /**
+     * Return a string of the ORCiD unauthenticated SVG icon
+     *
+     */
+    public static function getUnauthenticatedIcon(): string
+    {
+        $path = Core::getBaseDir() . '/' . PKP_LIB_PATH . '/templates/images/orcid_unauthenticated.svg';
+        return file_exists($path) ? file_get_contents($path) : '';
+    }
+
+
     /**
      * Checks if ORCID functionality is enabled. Works at the context-level.
      */

diff --git a/classes/user/form/IdentityForm.php b/classes/user/form/IdentityForm.php
@@ -77,7 +77,9 @@ public function fetch($request, $template = null, $display = false)
                 'orcidOAuthUrl' => OrcidManager::buildOAuthUrl('authorizeOrcid', ['targetOp' => $targetOp]),
                 'orcidClientId' => OrcidManager::getClientId(),
                 'orcidIcon' => OrcidManager::getIcon(),
+                'orcidUnauthenticatedIcon' => OrcidManager::getUnauthenticatedIcon(),
                 'orcidAuthenticated' => $user !== null && $user->hasVerifiedOrcid(),
+                'orcidDisplayValue' => $user->getOrcidDisplayValue(),
             ]);
         } else {
             $templateMgr->assign([

diff --git a/classes/user/maps/Schema.php b/classes/user/maps/Schema.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file classes/user/maps/Schema.php
  *
@@ -187,7 +188,7 @@ protected function mapByProperties(array $props, User $user, array $auxiliaryDat
                     $output[$prop] = [];
                     if ($this->context) {
                         $interests = collect(Repo::userInterest()->getInterestsForUser($user))
-                            ->map(fn($value, $index) => ['id' => $index, 'interest' => $value])
+                            ->map(fn ($value, $index) => ['id' => $index, 'interest' => $value])
                             ->values()
                             ->toArray();
 
@@ -255,6 +256,9 @@ protected function mapByProperties(array $props, User $user, array $auxiliaryDat
                 case 'displayInitials':
                     $output['displayInitials'] = $user->getDisplayInitials();
                     break;
+                case 'orcidDisplayValue':
+                    $output[$prop] = $user->getOrcidDisplayValue();
+                    break;
                 default:
                     $output[$prop] = $user->getData($prop);
                     break;

diff --git a/locale/en/user.po b/locale/en/user.po
@@ -627,6 +627,9 @@ msgstr "See below to request authenticated ORCID iD"
 msgid "orcid.author.unauthenticated"
 msgstr "ORCID iD not authenticated! Please request authentication from the contributor."
 
+msgid "orcid.unauthenticated"
+msgstr "unauthenticated"
+
 msgid "orcid.verify.title"
 msgstr "ORCID Authorization"
 

diff --git a/schemas/author.json b/schemas/author.json
@@ -197,6 +197,13 @@
 		"orcidVerificationRequested": {
 			"type": "boolean",
 			"apiSummary": false
+		},
+		"orcidDisplayValue": {
+			"type": "string",
+			"apiSummary": true,
+			"validation": [
+				"nullable"
+			]
 		}
 	}
 }
diff --git a/schemas/user.json b/schemas/user.json
@@ -342,6 +342,13 @@
 			"description": "The initials that will be displayed for a user.",
 			"type": "string",
 			"apiSummary": true
+		},
+		"orcidDisplayValue": {
+			"type": "string",
+			"apiSummary": true,
+			"validation": [
+				"nullable"
+			]
 		}
 	}
 }
diff --git a/templates/form/orcidProfile.tpl b/templates/form/orcidProfile.tpl
@@ -11,20 +11,25 @@
  *}
 
 {capture name=orcidButton assign=orcidButton}
-    <button id="connect-orcid-button" class="pkp_button" onclick="return openORCID();">
-        {if $orcid && !$orcidAuthenticated }
-            <div class="orcid_button_container">{$orcidIcon}{translate key='orcid.authorise'}</div>
-        {else}
+
+    {if $orcid && !$orcidAuthenticated }
+        <a href="{$orcid}" target="_blank" class='flex gap-2 mb-4'>{$orcidUnauthenticatedIcon}{$orcidDisplayValue}</a>
+        <button id="connect-orcid-button" class="pkp_button" onclick="return openORCID();">
+            {$orcidIcon}{translate key='orcid.authorise'}
+        </button>
+    {else}
+        <button id="connect-orcid-button" class="pkp_button" onclick="return openORCID();">
             <div class="orcid_button_container">{$orcidIcon} {translate key='orcid.connect'}</div>
-        {/if}
-    </button>
-    <a href="{url router="page" page="orcid" op="about"}">{translate key='orcid.about.title'}</a>
+        </button>
+    {/if}
+
+    <a href="{url router="page" page="orcid" op="about"}" onclick="return openORCID();">{translate key='orcid.about.title'}</a>
 {/capture}
 
 
 {capture name=orcidLink assign=orcidLink}
     {if $orcidAuthenticated}
-        <a href="{$orcid}" target="_blank" id='orcid-link'>{$orcidIcon}{$orcid}</a>
+        <a href="{$orcid}" target="_blank" id='orcid-link'>{$orcidIcon}{$orcidDisplayValue}</a>
     {else}
         {$orcidButton}
     {/if}

diff --git a/templates/frontend/pages/editorialHistory.tpl b/templates/frontend/pages/editorialHistory.tpl
@@ -30,7 +30,7 @@
 						</span>
 						<span class="name">
 							{$mastheadUser['user']->getFullName()|escape}
-							{if $mastheadUser['user']->getData('orcid') && $mastheadUser['user']->getData('orcidAccessToken')}
+							{if $mastheadUser['user']->getData('orcid') && $mastheadUser['user']->getData('orcidAccessToken') && $mastheadUser['user']->hasVerifiedOrcid()}
 								<span class="orcid">	
 									<a href="{$mastheadUser['user']->getData('orcid')|escape}" target="_blank" aria-label="{translate key="common.editorialHistory.page.orcidLink" name=$mastheadUser['user']->getFullName()|escape}">
 										{$orcidIcon}

diff --git a/templates/frontend/pages/editorialMasthead.tpl b/templates/frontend/pages/editorialMasthead.tpl
@@ -24,8 +24,8 @@
 						<span class="date_start">{translate key="common.fromUntil" from=$mastheadUser['dateStart'] until=""}</span>
 						<span class="name">
 							{$mastheadUser['user']->getFullName()|escape}
-							{if $mastheadUser['user']->getData('orcid') && $mastheadUser['user']->getData('orcidAccessToken')}
-								<span class="orcid">	
+							{if $mastheadUser['user']->getData('orcid') && $mastheadUser['user']->getData('orcidAccessToken') && $mastheadUser['user']->hasVerifiedOrcid()}
+								<span class="orcid">
 									<a href="{$mastheadUser['user']->getData('orcid')|escape}" target="_blank" aria-label="{translate key="common.editorialHistory.page.orcidLink" name=$mastheadUser['user']->getFullName()|escape}">
 										{$orcidIcon}
 									</a>

diff --git a/templates/images/orcid_unauthenticated.svg b/templates/images/orcid_unauthenticated.svg