Take service name in listOfSps from an attribute (#126)

Take service name in listOfSps from an attribute
* New attribute is required in config: 'listOfSps.serviceNameAttr'

Author: vyskocilpavel

CHANGELOG.md

@@ -11,7 +11,9 @@ All notable changes to this project will be documented in this file.
 - Changed the way of getting attribute names for interfaces: through internal attribute names in perun_attributes.php config
 - Return sorted eduPersonEntitlement
 - Don't show previous selection when user show all entries on the discovery page
-- ListOfSps - Don't show the description by default
+- ListOfSps 
+    - Don't show the description by default
+    - Added required attribute 'listOfSps.serviceNameAttr' !!!
 
 ## [v3.9.0]
 #### Added

config-templates/module_perun.php

@@ -144,6 +144,11 @@
      * Specify attribute name for facility attribute proxy identifiers
      */
     'listOfSps.perunProxyIdentifierAttr' => '',
+    
+    /**
+     * Specify attribute name for facility attribute with service name
+     */
+    'listOfSps.serviceNameAttr' => '',
 
     /**
      * Specify attribute name for facility attribute with loginUrL for service

lib/ListOfSps.php

@@ -25,15 +25,13 @@ public static function getClass($attribute)
         }
     }
 
-    public static function printServiceName($service)
+    public static function printServiceName($name, $loginURL = null)
     {
-        if (empty($service['loginURL']['value'])
-        ) {
-            return $service['facility']->getName();
+        if (empty($loginURL)) {
+            return $name;
         }
 
-        return "<a class='customLink' href='" . $service['loginURL']['value'] . "'>" .
-               $service['facility']->getName() . "</a>";
+        return "<a class='customLink' href='" . htmlspecialchars($loginURL) . "'>" . htmlspecialchars($name) . "</a>";
     }
 
     public static function printAttributeValue($attribute, $service, $attr)

templates/listOfSps-tpl.php

@@ -115,7 +115,9 @@
                             continue;
                         }
                         echo '<tr>';
-                        echo '<td>' . ListOfSps::printServiceName($service) . '</td>';
+                        echo '<td>'
+                            . ListOfSps::printServiceName($service['name']['value'], $service['loginURL']['value'] ?? null)
+                            . '</td>';
                         if (array_key_exists($service['facility']->getID(), $samlServices)) {
                             echo '<td>' . $this->t('{perun:listOfSps:saml}') . '</td>';
                         } else {

www/listOfSps.php

@@ -11,6 +11,7 @@
 const ATTRIBUTES_DEFINITIONS = 'listOfSps.attributesDefinitions';
 const SHOW_OIDC_SERVICES = 'listOfSps.showOIDCServices';
 
+const PERUN_SERVICE_NAME_ATTR_NAME = 'listOfSps.serviceNameAttr';
 const PERUN_PROXY_IDENTIFIER_ATTR_NAME = 'listOfSps.perunProxyIdentifierAttr';
 const PERUN_LOGIN_URL_ATTR_NAME = 'listOfSps.loginURLAttr';
 const PERUN_TEST_SP_ATTR_NAME = 'listOfSps.isTestSpAttr';
@@ -62,6 +63,13 @@
     );
 }
 
+$perunServiceNameAttr = $conf->getString(PERUN_SERVICE_NAME_ATTR_NAME, null);
+if (empty($perunServiceNameAttr)) {
+    throw new Exception(
+        'perun:listOfSps: missing mandatory config option \''
+        . PERUN_SERVICE_NAME_ATTR_NAME . '\'.'
+    );
+}
 $perunLoginURLAttr = $conf->getString(PERUN_LOGIN_URL_ATTR_NAME, null);
 $perunTestSpAttr = $conf->getString(PERUN_TEST_SP_ATTR_NAME, null);
 $perunShowOnServiceListAttr
@@ -76,6 +84,7 @@
 $attrNames = [];
 
 array_push($attrNames, $perunSaml2EntityIdAttr);
+array_push($attrNames, $perunServiceNameAttr);
 if (!empty($perunOidcClientIdAttr)) {
     array_push($attrNames, $perunOidcClientIdAttr);
 }
@@ -106,6 +115,7 @@
     if (!empty($facilityAttributes[$perunSaml2EntityIdAttr]['value'])) {
         $samlServices[$facility->getId()] = [
             'facility' => $facility,
+            'name' => $facilityAttributes[$perunServiceNameAttr],
             'loginURL' => $facilityAttributes[$perunLoginURLAttr],
             'showOnServiceList' => $facilityAttributes[$perunShowOnServiceListAttr],
             'facilityAttributes' => $facilityAttributes
@@ -118,6 +128,7 @@
     if ($showOIDCServices && !empty($facilityAttributes[$perunOidcClientIdAttr]['value'])) {
         $oidcServices[$facility->getId()] = [
             'facility' => $facility,
+            'name' => $facilityAttributes[$perunServiceNameAttr],
             'loginURL' => $facilityAttributes[$perunLoginURLAttr],
             'showOnServiceList' => $facilityAttributes[$perunShowOnServiceListAttr],
             'facilityAttributes' => $facilityAttributes
@@ -137,6 +148,7 @@
 $attributesToShow = [];
 foreach ($attrNames as $attrName) {
     if ($attrName !== $perunLoginURLAttr
+        && $attrName !== $perunServiceNameAttr
         && $attrName !== $perunShowOnServiceListAttr
         && $attrName !== $perunTestSpAttr
         && $attrName !== $perunOidcClientIdAttr
@@ -161,7 +173,7 @@
     $json['statistics']['oidcTestServicesCount'] = $statistics['oidcTestServicesCount'];
     foreach ($allServices as $service) {
         $a = [];
-        $a['name'] = $service['facility']->getName();
+        $a['name'] = $service['facilityAttributes'][$perunServiceNameAttr]['value'];
 
         if (array_key_exists($service['facility']->getID(), $samlServices)) {
             $a['authenticationProtocol'] = 'SAML';