Move HTML generation into template. (#10)

* Move HTML generation into template. Remove dependency on legacy translator functions.

Clean up template a bit and load any entity icons lazily.

Author: thijskh

lib/PowerIdPDisco.php

@@ -309,7 +309,7 @@ public function handleRequest(): void
         $t->data['entityID'] = $this->spEntityId;
         $t->data['defaulttab'] = $this->discoconfig->getValue('defaulttab', 0);
 
-        $idpList = $this->processMetadata($t, $idpList, $preferredIdP);
+        $idpList = $this->processMetadata($t, $idpList);
 
         $t->data['idplist'] = $idpList;
         $t->data['faventry'] = null;
@@ -353,65 +353,22 @@ public function handleRequest(): void
     /**
      * @param \SimpleSAML\XHTML\Template $t
      * @param array $metadata
-     * @param string|null $favourite
      * @return array
      */
-    private function processMetadata(Template $t, array $metadata, ?string $favourite): array
+    private function processMetadata(Template $t, array $metadata): array
     {
         $basequerystring = '?' .
             'entityID=' . urlencode($t->data['entityID']) . '&' .
             'return=' . urlencode($t->data['return']) . '&' .
             'returnIDParam=' . urlencode($t->data['returnIDParam']) . '&idpentityid=';
 
-        $translator = $t->getTranslator();
         $httpUtils = new Utils\HTTP();
         foreach ($metadata as $tab => $idps) {
             foreach ($idps as $entityid => $entity) {
-                $translation = false;
-
-                // Translate name
-                if (isset($entity['UIInfo']['DisplayName'])) {
-                    $displayName = $entity['UIInfo']['DisplayName'];
-
-                    // Should always be an array of language code -> translation
-                    Assert::isArray($displayName);
-
-                    if (!empty($displayName)) {
-                        $translation = $translator->getPreferredTranslation($displayName);
-                    }
-                }
-
-                if (($translation === false) && array_key_exists('name', $entity)) {
-                    if (is_array($entity['name'])) {
-                        $translation = $translator->getPreferredTranslation($entity['name']);
-                    } else {
-                        $translation = $entity['name'];
-                    }
-                }
-
-                if ($translation === false) {
-                    $translation = $entity['entityid'];
-                }
-                $entity['translated'] = $translation;
-
-                // HTML output
-                if ($entity['entityid'] === $favourite) {
-                    $html = '<a class="metaentry favourite" href="' .
-                        $basequerystring . urlencode($entity['entityid']) . '">';
-                } else {
-                    $html = '<a class="metaentry" href="' .
-                        $basequerystring . urlencode($entity['entityid']) . '">';
-                }
-                $html .= $entity['translated'];
+                $entity['actionUrl'] = $basequerystring . urlencode($entity['entityid']);
                 if (array_key_exists('icon', $entity) && $entity['icon'] !== null) {
-                    $iconUrl = $httpUtils->resolveURL($entity['icon']);
-                    $html .= '<img alt="Icon for identity provider" class="entryicon" src="' .
-                        htmlspecialchars($iconUrl) . '" />';
+                    $entity['iconUrl'] = $httpUtils->resolveURL($entity['icon']);
                 }
-                $html .= '</a>';
-                $entity['html'] = $html;
-
-                // Save processed data
                 $metadata[$tab][$entityid] = $entity;
             }
         }

templates/disco.twig

@@ -15,13 +15,13 @@
 {% block content %}
     {% if faventry is not empty %}
     <div class="favourite">{{ '{disco:previous_auth}'|trans }}
-        <strong>{{ faventry.translated|escape('html') }}</strong><br>
+        <strong>{{ faventry|entityDisplayName }}</strong><br>
         <form id="idpselectform" class="pure-form" method="get" action="{{ urlpattern }}">
-            <input type="hidden" name="entityID" value="{{ entityID|escape('html') }}">
-            <input type="hidden" name="return" value="{{ return|escape('html') }}">
-            <input type="hidden" name="returnIDParam" value="{{ returnIDParam|escape('html') }}">
-            <input type="hidden" name="idpentityid" value="{{ faventry.entityid|escape('html') }}">
-            <input type="submit" name="formsubmit" id="favouritesubmit" value="{{ '{disco:login_at}'|trans }} {{ faventry.translated|escape('html') }}" class="pure-button pure-button-primary">
+            <input type="hidden" name="entityID" value="{{ entityID }}">
+            <input type="hidden" name="return" value="{{ return }}">
+            <input type="hidden" name="returnIDParam" value="{{ returnIDParam }}">
+            <input type="hidden" name="idpentityid" value="{{ faventry.entityid }}">
+            <input type="submit" name="formsubmit" id="favouritesubmit" value="{{ '{disco:login_at}'|trans }} {{ faventry|entityDisplayName }}" class="pure-button pure-button-primary">
     </form>
     </div>
     {% endif %}
@@ -42,12 +42,17 @@
           <div class="inlinesearch">
               <p>{{ '{discopower:tabs:incremental_search}'|trans }}</p>
               <form id="idpselectform" method="get">
-                  <input class="inlinesearch" type="text" value="" name="query_{{ tab }}" id="query_{{ tab }}" />
+                  <input class="inlinesearch" type="text" value="" name="query_{{ tab }}" id="query_{{ tab }}">
               </form>
           </div>
           <div class="metalist" id="list_{{ tab }}">
           {% for entityid, entity in idps %}
-              {{ entity.html|raw }}
+              <a class="metaentry{% if entity == faventry %} favourite{% endif %}"
+                  href="{{ entity.actionUrl }}">{{ entity|entityDisplayName }}
+              {% if entity.iconUrl is defined %}
+                    <img alt="Icon for identity provider" class="entryicon" src="{{ entity.iconUrl }}" loading="lazy">
+              {% endif %}
+              </a>
           {% endfor %}
           </div>
           </div>