/catalog/v2/searchdescription.xml

kiwix · May 13, 2021 · dfa385d · dfa385d
1 parent 14a0b43
commit dfa385d
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 0 deletions.
diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp
@@ -748,6 +748,13 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext
 
   if (url == "root.xml") {
     return handle_catalog_v2_root(request);
+  } else if (url == "searchdescription.xml") {
+    const std::string endpoint_root = normalizeRootUrl(m_root) + "/catalog/v2";
+    return ContentResponse::build(*this,
+        RESOURCE::catalog_v2_searchdescription_xml,
+        kainjow::mustache::object({{"endpoint_root", endpoint_root}}),
+        "application/opensearchdescription+xml"
+    );
   } else if (url == "entries") {
     return handle_catalog_v2_entries(request);
   } else if (url == "categories") {

diff --git a/static/catalog_v2_root.xml b/static/catalog_v2_root.xml
@@ -8,6 +8,9 @@
   <link rel="start"
         href="{{endpoint_root}}/root.xml"
         type="application/atom+xml;profile=opds-catalog;kind=navigation"/>
+  <link rel="search"
+        href="{{endpoint_root}}/searchdescription.xml"
+        type="application/opensearchdescription+xml"/>
   <title>OPDS Catalog Root</title>
   <updated>{{date}}</updated>
 

diff --git a/static/catalog_v2_searchdescription.xml b/static/catalog_v2_searchdescription.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+  <ShortName>Zim catalog search</ShortName>
+  <Description>Search zim files in the catalog.</Description>
+  <Url type="application/atom+xml;profile=opds-catalog;kind=acquisition"
+       xmlns:atom="http://www.w3.org/2005/Atom"
+       xmlns:k="http://kiwix.org/opensearchextension/1.0"
+       indexOffset="0"
+       template="{{endpoint_root}}/entries?q={searchTerms?}&lang={language?}&name={k:name?}&tag={k:tag?}&maxsize={k:maxsize?}&count={count?}&start={startIndex?}"/>
+</OpenSearchDescription>
diff --git a/static/resources_list.txt b/static/resources_list.txt
@@ -35,3 +35,4 @@ opensearchdescription.xml
 catalog_v2_root.xml
 catalog_v2_entries.xml
 catalog_v2_categories.xml
+catalog_v2_searchdescription.xml
diff --git a/test/server.cpp b/test/server.cpp
@@ -916,6 +916,9 @@ TEST_F(LibraryServerTest, catalog_v2_root)
   <link rel="start"
         href="/catalog/v2/root.xml"
         type="application/atom+xml;profile=opds-catalog;kind=navigation"/>
+  <link rel="search"
+        href="/catalog/v2/searchdescription.xml"
+        type="application/opensearchdescription+xml"/>
   <title>OPDS Catalog Root</title>
   <updated>YYYY-MM-DDThh:mm:ssZ</updated>
 
@@ -942,6 +945,24 @@ TEST_F(LibraryServerTest, catalog_v2_root)
   EXPECT_EQ(maskVariableOPDSFeedData(r->body), expected_output);
 }
 
+TEST_F(LibraryServerTest, catalog_v2_searchdescription_xml)
+{
+  const auto r = zfs1_->GET("/catalog/v2/searchdescription.xml");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(r->body,
+    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+    "<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\">\n"
+    "  <ShortName>Zim catalog search</ShortName>\n"
+    "  <Description>Search zim files in the catalog.</Description>\n"
+    "  <Url type=\"application/atom+xml;profile=opds-catalog;kind=acquisition\"\n"
+    "       xmlns:atom=\"http://www.w3.org/2005/Atom\"\n"
+    "       xmlns:k=\"http://kiwix.org/opensearchextension/1.0\"\n"
+    "       indexOffset=\"0\"\n"
+    "       template=\"/catalog/v2/entries?q={searchTerms?}&lang={language?}&name={k:name?}&tag={k:tag?}&maxsize={k:maxsize?}&count={count?}&start={startIndex?}\"/>\n"
+    "</OpenSearchDescription>\n"
+  );
+}
+
 TEST_F(LibraryServerTest, catalog_v2_categories)
 {
   const auto r = zfs1_->GET("/catalog/v2/categories");