💄 Clean up display of highlighted search results

Author: noeddl

froide/helper/search/queryset.py

@@ -1,4 +1,7 @@
+import difflib
+import html
 import logging
+import re
 
 from django.utils.safestring import mark_safe
 
@@ -170,10 +173,62 @@ def __iter__(self):
             hit = self._es_map[obj.pk]
             # mark_safe should work because highlight_options
             # has been set with encoder="html"
-            obj.query_highlight = mark_safe(" ".join(self._get_highlight(hit)))
+            obj.query_highlight = mark_safe(
+                html.unescape(" [...] ".join(self._get_highlight(hit)))
+            )
             yield obj
 
     def _get_highlight(self, hit):
         if hasattr(hit.meta, "highlight"):
+            highlighted = set()
+            highlight_count = 0
             for key in hit.meta.highlight:
-                yield from hit.meta.highlight[key]
+                for snippet in hit.meta.highlight[key]:
+                    for s in filter_highlight_snippet(snippet):
+                        if not has_similar_match(s, highlighted):
+                            highlight_count += 1
+                            yield s
+
+                        if highlight_count == 5:
+                            return
+
+                        highlighted.add(s)
+
+
+def filter_highlight_snippet(snippet):
+    """
+    Split a highlight snippet into sections based on whitespace clusters
+    and yield only those sections that contain <em> tags but are not fully
+    enclosed by them.
+    """
+    # Cluster of 2 or more whitespace characters
+    whitespace_cluster = re.compile(r"\s{2,}")
+
+    sections = whitespace_cluster.split(snippet)
+
+    for s in sections:
+        if "<em>" in s and not (s.startswith("<em>") and s.endswith("</em>")):
+            yield s
+
+
+def has_similar_match(word, possibilities, cutoff=0.9):
+    """
+    Return True if `word` is close to any string in `possibilities`
+    with a similarity >= `cutoff`.
+
+    Implementation inspired by difflib.get_close_matches:
+    https://github.com/python/cpython/blob/3.13/Lib/difflib.py#L=666
+    """
+    s = difflib.SequenceMatcher(isjunk=lambda c: c in " \r\n\t")
+    s.set_seq2(word)
+
+    for x in possibilities:
+        s.set_seq1(x)
+        if (
+            s.real_quick_ratio() >= cutoff
+            and s.quick_ratio() >= cutoff
+            and s.ratio() >= cutoff
+        ):
+            return True
+
+    return False

froide/helper/search/views.py

@@ -63,7 +63,11 @@ def get_search(self):
         if not self.has_query:
             s = s.sort(self.default_sort)
         else:
-            s = s.highlight_options(encoder="html").highlight("content")
+            # Retrieve 10 fragments of highlighted text, to be reduced to 5 later on
+            # due to possible duplicates.
+            s = s.highlight_options(encoder="html", number_of_fragments=10).highlight(
+                "content"
+            )
             s = s.sort("_score")
         return s
 

froide/helper/tests/test_search.py

@@ -1,21 +1,48 @@
 from unittest.mock import MagicMock
 
+from django.utils.safestring import SafeString
+
+import pytest
+
 from froide.helper.search.filters import BaseSearchFilterSet
+from froide.helper.search.queryset import ESQuerySetWrapper
+from froide.helper.tests.testdata.search_highlights import search_highlight_tests
 
 
 class DummyModel:
     pass
 
 
 class DummyQS:
-    def __init__(self):
+    def __init__(self, objs=None):
+        self._objs = objs
         self.model = DummyModel()
         self.query = None
 
     def set_query(self, q):
         self.query = q
         return self
 
+    def __iter__(self):
+        return iter(self._objs)
+
+
+class DummyHitMeta:
+    def __init__(self, id, highlight=None):
+        self.id = id
+        self.highlight = highlight or {}
+
+
+class DummyHit:
+    def __init__(self, id, highlight=None):
+        self.meta = DummyHitMeta(id, highlight)
+
+
+class DummyObj:
+    def __init__(self, pk):
+        self.pk = pk
+        self.query_highlight = None
+
 
 class TestBaseSearchFilterSetQueryPreprocessing:
     def test_auto_query_without_query_value(self):
@@ -53,3 +80,35 @@ def test_auto_query_with_custom_query_preprocessor(self, monkeypatch):
 
         assert result.query.query == "processed query"
         mock_preprocessor.prepare_query.assert_called_once_with("original query")
+
+
+@pytest.mark.parametrize(
+    "highlight_list, query_highlight",
+    search_highlight_tests,
+    ids=[x[1][:20] for x in search_highlight_tests],
+)
+def test_es_queryset_wrapper_iter_highlight(highlight_list, query_highlight):
+    """Test that highlights in search results are processed correctly."""
+    obj = DummyObj(1)
+    hit = DummyHit(1, {"field": highlight_list})
+    qs = DummyQS([obj])
+    es_response = [hit]
+
+    wrapper = ESQuerySetWrapper(qs, es_response)
+    result = list(wrapper)
+
+    assert isinstance(result[0].query_highlight, SafeString)
+    assert result[0].query_highlight == query_highlight
+
+
+def test_es_queryset_wrapper_iter_no_highlight():
+    """Test that absence of highlights results in empty string."""
+    obj = DummyObj(2)
+    hit = DummyHit(2)
+    qs = DummyQS([obj])
+    es_response = [hit]
+
+    wrapper = ESQuerySetWrapper(qs, es_response)
+    result = list(wrapper)
+
+    assert result[0].query_highlight == ""

froide/helper/tests/testdata/search_highlights.py

@@ -0,0 +1,105 @@
+# List of test cases to be used in parameterized tests.
+# Each test case is a tuple of (highlight_list, query_highlight) where highlight_list is the list
+# of highlighted strings from Elasticsearch and expected_query_highlight is the expected post-processed
+# string that will be shown to the user.
+search_highlight_tests = [
+    (
+        [
+            "Unterlagen zum &amp;quot;<em>Gender</em>-Verbot&amp;quot;\n\nAlle Unterlagen (interne und externe Korrespondenz, Vermerke",
+            ", Dienstanweisungen etc.) im Zusammenhang mit dem sogenannten &amp;quot;<em>Gender</em>-Verbot&amp;quot; an sächsischen",
+            "Schulen\n\nAnfrage erfolgreich \n\n\n\n\n    \n    Unterlagen zum &amp;quot;<em>Gender</em>-Verbot&amp;quot; [#284078]\n    Antrag",
+            "externe Korrespondenz, Vermerke, Dienstanweisungen etc.) im Zusammenhang mit dem sogenannten &amp;quot;<em>Gender</em>-Verbot",
+        ],
+        (
+            "Unterlagen zum &quot;<em>Gender</em>-Verbot&quot; [...] "
+            ", Dienstanweisungen etc.) im Zusammenhang mit dem sogenannten &quot;<em>Gender</em>-Verbot&quot; an sächsischen [...] "
+            # "Unterlagen zum &quot;<em>Gender</em>-Verbot&quot; [#284078] [...] "
+            "externe Korrespondenz, Vermerke, Dienstanweisungen etc.) im Zusammenhang mit dem sogenannten &quot;<em>Gender</em>-Verbot"
+        ),
+    ),
+    (
+        [
+            "Genderverbot\n\nDie Regelung (Schreiben, Erlass, Weisung) des BMF zur internen Sprachregelung in Bezug aufs <em>Gendern</em>",
+            "zu:\n\nDie Regelung (Schreiben, Erlass, Weisung) des BMF zur internen Sprachregelung in Bezug aufs <em>Gendern</em>",
+        ],
+        "Die Regelung (Schreiben, Erlass, Weisung) des BMF zur internen Sprachregelung in Bezug aufs <em>Gendern</em>",
+    ),
+    (
+        [
+            "SIS II [#279515] # IFG-780&#x2F;005 II#1095\n    Der Bundesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em>",
+            "SIS II [#279515] # IFG-780&#x2F;005 II#1095\n    Der Bundesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em>",
+            "SIS II [#279515] # IFG-780&#x2F;005 II#1095\n    Der Bundesbeauftragte für den Datenschutz und die <em>Informationsfreiheit</em>",
+            "SIS II [#279515] # IFG-780&#x2F;005 II#1095\n    Der Bundesbeauftragte für den Datenschutz und die <em>Informationsfreiheit</em>",
+            "SIS II [#279515] # IFG-780&#x2F;005 II#1095\n    Der Bundesbeauftragte für den Datenschutz und die <em>Informationsfreiheit</em>",
+            "SIS II [#279515] # IFG-780&#x2F;005 II#1095\n    Der Bundesbeauftragte für den Datenschutz und die <em>Informationsfreiheit</em>",
+            "melek-bazgan-bfdi-12-12-2023.pdf\n      \n    \n\n\nDie Bundesbeauftragte für den Datenschutz und die <em>Informationsfreiheit</em>",
+            "Beauftragte für Datenschutz und <em>Informationsfreiheit</em>\n\n\n    Datenschutz\n\n    <em>Informationsfreiheit</em>",
+        ],
+        (
+            "Der Bundesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em> [...] "
+            # "Die Bundesbeauftragte für den Datenschutz und die <em>Informationsfreiheit</em> [...] "
+            "Beauftragte für Datenschutz und <em>Informationsfreiheit</em>"
+            # "<em>Informationsfreiheit</em>"
+        ),
+    ),
+    (
+        [
+            ":&#x2F;&#x2F;fragdenstaat.de&#x2F;hilfe&#x2F;fuer-behoerden&#x2F;\n\n      \n    \n\n    \n    Ihre Beschwerde im Bereich <em>Informationsfreiheit</em>",
+            "Der Landesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em> Rheinland-Pfalz\n\nInternet",
+            "Zeichen:\tfragdenstaat.de # 186145\n\n\n&amp;lt;&amp;lt;E-Mail-Adresse&amp;gt;&amp;gt;\n\n\nIhre Beschwerde im Bereich <em>Informationsfreiheit</em>",
+            "Sie darauf hinweisen, dass die Anrufung des Landesbeauftragten für den Datenschutz und die <em>Informationsfreiheit</em>",
+            "Slfdiprn0220071607220.pdf\n      \n    \n\n    \n    Ihre Beschwerde im Bereich <em>Informationsfreiheit</em>",
+            "Der Landesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em> Rheinland-Pfalz\n\nInternet",
+            "Zeichen:\tfragdenstaat.de # 186145\n\n\n&amp;lt;&amp;lt;E-Mail-Adresse&amp;gt;&amp;gt;\n\n\nIhre Beschwerde im Bereich <em>Informationsfreiheit</em>",
+            "Mit freundlichen Grüßen\n      \n    \n\n    \n    AW: Ihre Beschwerde im Bereich <em>Informationsfreiheit</em> [#186145",
+            "Ihr Antrag auf Informationszugang\n    Der Landesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em>",
+            "Der Widerspruch ist bei dem Landesbeauftragten für den Datenschutz und die <em>Informationsfreiheit</em> Rheinland-Pfalz",
+        ],
+        (
+            "Ihre Beschwerde im Bereich <em>Informationsfreiheit</em> [...] "
+            "Der Landesbeauftragte für den Datenschutz\nund die <em>Informationsfreiheit</em> Rheinland-Pfalz [...] "
+            "Sie darauf hinweisen, dass die Anrufung des Landesbeauftragten für den Datenschutz und die <em>Informationsfreiheit</em> [...] "
+            "AW: Ihre Beschwerde im Bereich <em>Informationsfreiheit</em> [#186145 [...] "
+            "Der Widerspruch ist bei dem Landesbeauftragten für den Datenschutz und die <em>Informationsfreiheit</em> Rheinland-Pfalz"
+        ),
+    ),
+    (
+        [
+            "]\n    HmbTG Antrag auf Übersendung der beim Hamburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>",
+            "Die Prüfung auf Übersendung der beim Hamburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>",
+            "Ihrer Mail vom 02.02.2017 auf Zugang zu der dem Hamburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>",
+            "Hintergrund war Ihr Antrag auf Zugang zu der dem Harnburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>",
+            "Monats nach Bekanntgabe Widerspruch bei dem Harnburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>",
+            "Möglichkeit, Widerspruch zu erheben - den Harnburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>",
+            "hmbfdi-eao.pdf\n      \n    \n\n\nDer Hamburgische Beauftragte für Datenschutz und <em>Informationsfreiheit</em>",
+            "Landesbeauftragte für Datenschutz und <em>Informationsfreiheit</em>\n\n\n    Inneres\n\n    Datenschutz\n\n    <em>Informationsfreiheit</em>",
+        ],
+        (
+            "HmbTG Antrag auf Übersendung der beim Hamburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em> [...] "
+            # "Die Prüfung auf Übersendung der beim Hamburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em> [...] "
+            "Ihrer Mail vom 02.02.2017 auf Zugang zu der dem Hamburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em> [...] "
+            "Hintergrund war Ihr Antrag auf Zugang zu der dem Harnburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em> [...] "
+            "Monats nach Bekanntgabe Widerspruch bei dem Harnburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em> [...] "
+            "Möglichkeit, Widerspruch zu erheben - den Harnburgischen Beauftragten für Datenschutz und <em>Informationsfreiheit</em>"
+            # "Der Hamburgische Beauftragte für Datenschutz und <em>Informationsfreiheit</em> [...] "
+            # "Landesbeauftragte für Datenschutz und <em>Informationsfreiheit</em>"
+        ),
+    ),
+    (
+        [
+            "<em>Schriftverkehr</em> zwischen BMI und AA in Bezug auf Schreiben an Seenotrettungsorganisationen\n\nSämtlichen",
+            "<em>Schriftverkehr</em> zwischen dem BMI und dem AA in Bezug auf das Schreiben des MinDir Weinbrenneran Seenotrettungsorganisationen",
+            "Information nicht vorhanden \n\n\n\n\n    \n    <em>Schriftverkehr</em> zwischen BMI und AA in Bezug auf Schreiben an",
+            "&#x2F;VIG\r\n\r\nSehr geehrte&amp;lt;&amp;lt; Anrede &amp;gt;&amp;gt;\n\r\nbitte senden Sie mir Folgendes zu:\n\nSämtlichen <em>Schriftverkehr</em>",
+            "notwendig wäre, besuchen Sie:\nhttps:&#x2F;&#x2F;fragdenstaat.de&#x2F;hilfe&#x2F;fuer-behoerden&#x2F;\n\n      \n    \n\n    \n    <em>Schriftverkehr</em>",
+            "geehrter Herr Semsrott,\n\n\xa0\n\nin Erledigung Ihres IFG- Antrages teile ich Ihnen mit, dass kein\n<em>Schriftverkehr</em>",
+        ],
+        (
+            "<em>Schriftverkehr</em> zwischen BMI und AA in Bezug auf Schreiben an Seenotrettungsorganisationen [...] "
+            "<em>Schriftverkehr</em> zwischen dem BMI und dem AA in Bezug auf das Schreiben des MinDir Weinbrenneran Seenotrettungsorganisationen [...] "
+            "<em>Schriftverkehr</em> zwischen BMI und AA in Bezug auf Schreiben an [...] "
+            "Sämtlichen <em>Schriftverkehr</em> [...] "
+            "in Erledigung Ihres IFG- Antrages teile ich Ihnen mit, dass kein\n<em>Schriftverkehr</em>"
+        ),
+    ),
+]