From 9a00ae4b939c35e787c44cd550d793a96a0026c9 Mon Sep 17 00:00:00 2001
From: Johannes Zorn <46689904+jzorn@users.noreply.github.com>
Date: Sat, 17 May 2025 09:52:26 +0200
Subject: [PATCH] Add opensearch declaration (#1058)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* feat: Add opensearch declaration

* cleanup

---------

Co-authored-by: Johannes Zorn <johannes.zorn@zollsoft.com>
Co-authored-by: Sascha Ißbrücker <sascha.issbruecker@gmail.com>
---
 bookmarks/templates/bookmarks/head.html |  1 +
 bookmarks/templates/opensearch.xml      |  7 +++++++
 bookmarks/tests/test_opensearch_view.py | 25 +++++++++++++++++++++++++
 bookmarks/urls.py                       |  2 ++
 bookmarks/views/__init__.py             |  1 +
 bookmarks/views/opensearch.py           | 18 ++++++++++++++++++
 6 files changed, 54 insertions(+)
 create mode 100644 bookmarks/templates/opensearch.xml
 create mode 100644 bookmarks/tests/test_opensearch_view.py
 create mode 100644 bookmarks/views/opensearch.py

diff --git a/bookmarks/templates/bookmarks/head.html b/bookmarks/templates/bookmarks/head.html
index 1f64e9d..94beb5f 100644
--- a/bookmarks/templates/bookmarks/head.html
+++ b/bookmarks/templates/bookmarks/head.html
@@ -7,6 +7,7 @@
   <link rel="apple-touch-icon" sizes="180x180" href="{% static 'apple-touch-icon.png' %}">
   <link rel="mask-icon" href="{% static 'safari-pinned-tab.svg' %}" color="#5856e0">
   <link rel="manifest" href="{% url 'linkding:manifest' %}">
+  <link rel="search" type="application/opensearchdescription+xml" title="Linkding" href="{% url 'linkding:opensearch' %}"/>
   <meta name="apple-mobile-web-app-capable" content="yes">
   <meta name="viewport" content="width=device-width, initial-scale=1.0, minimal-ui">
   <meta name="description" content="Self-hosted bookmark service">
diff --git a/bookmarks/templates/opensearch.xml b/bookmarks/templates/opensearch.xml
new file mode 100644
index 0000000..850adde
--- /dev/null
+++ b/bookmarks/templates/opensearch.xml
@@ -0,0 +1,7 @@
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+    <ShortName>Linkding</ShortName>
+    <Description>Linkding</Description>
+    <InputEncoding>UTF-8</InputEncoding>
+    <Image width="16" height="16" type="image/x-icon">{{base_url}}static/favicon.ico</Image>
+    <Url type="text/html" template="{{ bookmarks_url }}?client=opensearch&amp;q={searchTerms}"/>
+</OpenSearchDescription>
diff --git a/bookmarks/tests/test_opensearch_view.py b/bookmarks/tests/test_opensearch_view.py
new file mode 100644
index 0000000..3693d06
--- /dev/null
+++ b/bookmarks/tests/test_opensearch_view.py
@@ -0,0 +1,25 @@
+from django.test import TestCase
+from django.urls import reverse
+
+
+class OpenSearchViewTestCase(TestCase):
+
+    def test_opensearch_configuration(self):
+        response = self.client.get(reverse("linkding:opensearch"))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(
+            response["content-type"], "application/opensearchdescription+xml"
+        )
+
+        base_url = "http://testserver"
+        expected_content = f"""
+            <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+                <ShortName>Linkding</ShortName>
+                <Description>Linkding</Description>
+                <InputEncoding>UTF-8</InputEncoding>
+                <Image width="16" height="16" type="image/x-icon">{base_url}/static/favicon.ico</Image>
+                <Url type="text/html" template="{base_url}/bookmarks?client=opensearch&amp;q={{searchTerms}}"/>
+            </OpenSearchDescription>
+        """
+        content = response.content.decode()
+        self.assertXMLEqual(content, expected_content)
diff --git a/bookmarks/urls.py b/bookmarks/urls.py
index 611a73f..be0273a 100644
--- a/bookmarks/urls.py
+++ b/bookmarks/urls.py
@@ -80,6 +80,8 @@ urlpatterns = [
     path("manifest.json", views.manifest, name="manifest"),
     # Custom CSS
     path("custom_css", views.custom_css, name="custom_css"),
+    # OpenSearch
+    path("opensearch.xml", views.opensearch, name="opensearch"),
 ]
 
 # Put all linkding URLs into a linkding namespace
diff --git a/bookmarks/views/__init__.py b/bookmarks/views/__init__.py
index 1fbe567..802057b 100644
--- a/bookmarks/views/__init__.py
+++ b/bookmarks/views/__init__.py
@@ -7,3 +7,4 @@ from .health import health
 from .manifest import manifest
 from .custom_css import custom_css
 from .root import root
+from .opensearch import opensearch
diff --git a/bookmarks/views/opensearch.py b/bookmarks/views/opensearch.py
new file mode 100644
index 0000000..d8b55ae
--- /dev/null
+++ b/bookmarks/views/opensearch.py
@@ -0,0 +1,18 @@
+from django.urls import reverse
+from django.shortcuts import render
+
+
+def opensearch(request):
+    base_url = request.build_absolute_uri(reverse("linkding:root"))
+    bookmarks_url = request.build_absolute_uri(reverse("linkding:bookmarks.index"))
+
+    return render(
+        request,
+        "opensearch.xml",
+        {
+            "base_url": base_url,
+            "bookmarks_url": bookmarks_url,
+        },
+        content_type="application/opensearchdescription+xml",
+        status=200,
+    )