Merge pull request #169 from BaranekD/wayf_enhanced_search

feat: WAYF search by localized name and domain

Author: Dominik František Bučík

CHANGELOG.md

@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+#### Changed
+- Improve WAYF searching by localized name and domain
+
 #### Fixed
 - Detailed endpoint format when spaced in EndpointMapToArray 
 - Revert change to INDEX_MIN in EndpointMapToArray

composer.json

@@ -32,6 +32,7 @@
         "ext-curl": "*",
         "ext-json": "*",
         "ext-openssl": "*",
+        "ext-iconv": "*",
         "web-token/jwt-key-mgmt": "^2.2",
         "web-token/jwt-signature": "^2.2",
         "web-token/jwt-signature-algorithm-rsa": "^2.2",

lib/Disco.php

@@ -2,6 +2,7 @@
 
 namespace SimpleSAML\Module\perun;
 
+use Normalizer;
 use SimpleSAML\Module\discopower\PowerIdPDisco;
 use SimpleSAML\Utils\HTTP;
 use SimpleSAML\Error\Exception;
@@ -486,9 +487,11 @@ public static function showEntry(
         array $metadata,
         $favourite = false
     ): string {
+        $searchData = htmlspecialchars(self::constructSearchData($metadata));
         $extra = ($favourite ? ' favourite' : '');
         $href = $t->getContinueUrl($metadata[self::IDP_ENTITY_ID]);
-        $html = '<a class="metaentry' . $extra . ' list-group-item" href="' . $href. '">';
+        $html = '<a class="metaentry' . $extra .
+            ' list-group-item" data-search="' . $searchData . '" href="' . $href. '">';
         $html .= '<strong>' . $t->getTranslatedEntityName($metadata) . '</strong>';
         $html .= '</a>';
 
@@ -773,11 +776,53 @@ public static function getScripts(bool $boxed): string
     {
         $html = '<script type="text/javascript" src="' .
             Module::getModuleUrl('discopower/assets/js/suggest.js') . '"></script>' . PHP_EOL;
+
+        $html .= '<script type="text/javascript" src="' .
+            Module::getModuleUrl('perun/res/js/jquery.livesearch.js') . '"></script>' . PHP_EOL;
+
         $html .= '<script type="text/javascript" src="' .
             Module::getModuleUrl('perun/res/js/disco.js') . '"></script>' . PHP_EOL;
         if ($boxed) {
             $html .= Disco::boxedDesignScript() . PHP_EOL;
         }
         return $html;
     }
+
+    private static function arrayFlatten($array): array
+    {
+        $return = [];
+        if (is_array($array)) {
+            foreach ($array as $key => $value) {
+                if (is_array($value)) {
+                    $return = [ ...$return, ...self::arrayFlatten($value)];
+                } else {
+                    $return = [ ...$return, $value];
+                }
+            }
+        } else {
+            $return = [$array];
+        }
+        return $return;
+    }
+
+    private static function constructSearchData($idpMetadata): string
+    {
+        $res = '';
+        $dataSearchKeys = [];
+        if (!empty($idpMetadata['UIInfo'])) {
+            $idpMetadata = array_merge($idpMetadata, $idpMetadata['UIInfo']);
+        }
+
+        $keys = ['entityid', 'OrganizationName', 'OrganizationDisplayName',
+            'name', 'url', 'OrganizationURL', 'scope', 'DisplayName'];
+
+        foreach ($keys as $key) {
+            if (!empty($idpMetadata[$key])) {
+                $dataSearchKeys = [...$dataSearchKeys, ...self::arrayFlatten($idpMetadata[$key])];
+            }
+        }
+        $res .= (' ' . implode(' ', $dataSearchKeys));
+
+        return strtolower(str_replace('"', '', iconv('UTF-8', 'US-ASCII//TRANSLIT', $res)));
+    }
 }

www/res/js/disco.js

@@ -1,93 +1,63 @@
-let forceShow = false;
-
-function setForceShow(val) {
-    forceShow = val;
-}
-
-$.fn.liveUpdate = function(list) {
-    list = $(list);
-    if (list.length) {
-        var rows = list.children('a'), cache = rows.map(function () {
-            return jQuery(this).text().toLowerCase().normalize('NFD').replace(/[\u0300-\u036f]/g, "");
-        });
-
-        this.keyup(filter).keyup().parents('form').submit(function () {
-            return false;
-        });
-    }
-    return this;
-
-    function filter() {
-        const searchTerm = $.trim($(this).val().toLowerCase().normalize('NFD').replace(/[\u0300-\u036f]/g, ""));
-        const scores = [];
-        rows.hide();
-        showNoEntriesFound(false);
-        if (!searchTerm) {
-            setForceShow(false);
-            return;
-        }
-        cache.each(function (i) {
-            const score = this.score(searchTerm);
-            if (score > 0) {
-                scores.push([score, i]);
-            }
-        });
-        if (scores.length === 0) {
-            showNoEntriesFound(true);
-        } else if (!forceShow && scores.length > 7) {
-            showWarningTooMuchEntries(true, scores.length + 1);
-        } else {
-            $.each(
-                scores.sort(
-                    function(a, b) { return b[0] - a[0];}),
-                function() {$(rows[this[1]]).show();
-                });
-        }
-    }
-};
-
-function showWarningTooMuchEntries(show, cnt = 0) {
+function hideAll () {
+    $("#list").hide();
     $('#no-entries').hide();
-    if (show) {
-        $('#warning-entries').show();
-    } else {
-        $('#warning-entries').hide();
-    }
-    $('#results-cnt').text(cnt);
+    $('#warning-entries').hide();
 }
 
-function showNoEntriesFound(show) {
-    $('#warning-entries').hide();
-    if (show) {
-        $('#no-entries').show();
+$(document).ready(function() {
+    if ($("#last-used-idp-wrap").length > 0) {
+        $("#last-used-idp .metaentry").focus();
     } else {
-        $('#no-entries').hide();
+        $("#entries").show();
     }
-}
 
-$(document).ready(function() {
-    $("#query").liveUpdate("#list");
     $("#showEntries").click(function() {
         $("#last-used-idp-wrap").hide();
         $("#entries").show();
         $("#showEntries").hide();
     });
-    $("#showEntriesFromDropdown").click(function() {
-        $("#dropdown-entries").toggle();
+
+    let forceShow = false
+    $('#query').keyup(function() {
+        const filter = $(this).val().trim().toLowerCase().normalize("NFD").replace(/\p{Diacritic}/gu, "")
+        if (!filter) {
+            hideAll();
+            forceShow = false;
+        } else {
+            let matches = [];
+            $('#list a').each(function () {
+                if ($(this).attr('data-search').indexOf(filter) >= 0) {
+                    matches.push(this);
+                } else {
+                    $(this).hide();
+                }
+            });
+            if (matches.length <= 0) {
+                $('#no-entries').show();
+                $('#warning-entries').hide();
+            } else {
+                $("#list").show();
+                $('#results-cnt').text(matches.length);
+                $('#no-entries').hide();
+                if (matches.length > 10 && !forceShow) {
+                    matches.forEach(m => {
+                        $(m).hide();
+                    });
+                    $('#warning-entries').show();
+                } else {
+                    $('#warning-entries').hide();
+                    matches.forEach(m => {
+                        $(m).show();
+                    });
+                }
+            }
+        }
     });
-    if ($("#last-used-idp-wrap").length > 0) {
-        $("#last-used-idp .metaentry").focus();
-    } else {
-        $("#entries").show();
-    }
-    $('#warning-entries-btn-force-show').click(function() {
-        $('#query').trigger('keyup');
-        showWarningTooMuchEntries(false);
-        showEntries();
+
+    $('#warning-entries-btn-force-show').click(function(event) {
+        event.preventDefault();
+        forceShow = true;
+        $('#warning-entries').hide();
+        $('#query').trigger('keyup').focus();
     });
 });
-
-function showEntries() {
-    setForceShow(true);
-    $('#query').trigger('keyup');
-}