Merge pull request #974 from kiwix/multipleCategories

kiwix · Jul 26, 2023 · 09476ed · 09476ed
2 parents 9c91fc7 + d47c4fa
commit 09476ed
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 24 deletions.
diff --git a/include/library.h b/include/library.h
@@ -105,6 +105,12 @@ class Filter {
     Filter& acceptTags(const Tags& tags);
     Filter& rejectTags(const Tags& tags);
 
+    /**
+     *  Set the filter to only accept books in the specified category.
+     *
+     *  Multiple categories can be specified as a comma-separated list (in
+     *  which case a book in any of those categories will match).
+     */
     Filter& category(std::string category);
 
     /**

diff --git a/src/library.cpp b/src/library.cpp
@@ -549,27 +549,32 @@ Xapian::Query nameQuery(const std::string& name)
   return Xapian::Query("XN" + normalizeText(name));
 }
 
-Xapian::Query categoryQuery(const std::string& category)
-{
-  return Xapian::Query("XC" + normalizeText(category));
-}
-
-Xapian::Query langQuery(const std::string& commaSeparatedLanguageList)
+Xapian::Query multipleParamQuery(const std::string& commaSeparatedList, const std::string& prefix)
 {
   Xapian::Query q;
   bool firstIteration = true;
-  for ( const auto& lang : kiwix::split(commaSeparatedLanguageList, ",") ) {
-    const Xapian::Query singleLangQuery("L" + normalizeText(lang));
+  for ( const auto& elem : kiwix::split(commaSeparatedList, ",") ) {
+    const Xapian::Query singleQuery(prefix + normalizeText(elem));
     if ( firstIteration ) {
-      q = singleLangQuery;
+      q = singleQuery;
       firstIteration = false;
     } else {
-      q = Xapian::Query(Xapian::Query::OP_OR, q, singleLangQuery);
+      q = Xapian::Query(Xapian::Query::OP_OR, q, singleQuery);
     }
   }
   return q;
 }
 
+Xapian::Query categoryQuery(const std::string& commaSeparatedCategoryList)
+{
+  return multipleParamQuery(commaSeparatedCategoryList, "XC");
+}
+
+Xapian::Query langQuery(const std::string& commaSeparatedLanguageList)
+{
+  return multipleParamQuery(commaSeparatedLanguageList, "L");
+}
+
 Xapian::Query publisherQuery(const std::string& publisher)
 {
   Xapian::QueryParser queryParser;

diff --git a/test/library_server.cpp b/test/library_server.cpp
@@ -301,20 +301,41 @@ TEST_F(LibraryServerTest, catalog_search_by_tag)
 
 TEST_F(LibraryServerTest, catalog_search_by_category)
 {
-  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/search?category=jazz");
-  EXPECT_EQ(r->status, 200);
-  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
-    OPDS_FEED_TAG
-    "  <id>12345678-90ab-cdef-1234-567890abcdef</id>\n"
-    "  <title>Filtered zims (category=jazz)</title>\n"
-    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
-    "  <totalResults>1</totalResults>\n"
-    "  <startIndex>0</startIndex>\n"
-    "  <itemsPerPage>1</itemsPerPage>\n"
-    CATALOG_LINK_TAGS
-    CHARLES_RAY_CATALOG_ENTRY
-    "</feed>\n"
-  );
+
+  {
+    const auto r = zfs1_->GET("/ROOT%23%3F/catalog/search?category=jazz");
+    EXPECT_EQ(r->status, 200);
+    EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+      OPDS_FEED_TAG
+      "  <id>12345678-90ab-cdef-1234-567890abcdef</id>\n"
+      "  <title>Filtered zims (category=jazz)</title>\n"
+      "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+      "  <totalResults>1</totalResults>\n"
+      "  <startIndex>0</startIndex>\n"
+      "  <itemsPerPage>1</itemsPerPage>\n"
+      CATALOG_LINK_TAGS
+      CHARLES_RAY_CATALOG_ENTRY
+      "</feed>\n"
+    );
+  }
+
+  {
+    const auto r = zfs1_->GET("/ROOT%23%3F/catalog/search?category=jazz,wikipedia");
+    EXPECT_EQ(r->status, 200);
+    EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+      OPDS_FEED_TAG
+      "  <id>12345678-90ab-cdef-1234-567890abcdef</id>\n"
+      "  <title>Filtered zims (category=jazz%2Cwikipedia)</title>\n"
+      "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+      "  <totalResults>2</totalResults>\n"
+      "  <startIndex>0</startIndex>\n"
+      "  <itemsPerPage>2</itemsPerPage>\n"
+      CATALOG_LINK_TAGS
+      RAY_CHARLES_CATALOG_ENTRY
+      CHARLES_RAY_CATALOG_ENTRY
+      "</feed>\n"
+    );
+  }
 }
 
 TEST_F(LibraryServerTest, catalog_search_by_language)
@@ -793,6 +814,40 @@ TEST_F(LibraryServerTest, catalog_v2_entries_filtered_by_language)
   }
 }
 
+TEST_F(LibraryServerTest, catalog_v2_entries_filtered_by_category)
+{
+  {
+    const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?category=jazz");
+    EXPECT_EQ(r->status, 200);
+    EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+      CATALOG_V2_ENTRIES_PREAMBLE("?category=jazz")
+      "  <title>Filtered Entries (category=jazz)</title>\n"
+      "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+      "  <totalResults>1</totalResults>\n"
+      "  <startIndex>0</startIndex>\n"
+      "  <itemsPerPage>1</itemsPerPage>\n"
+      CHARLES_RAY_CATALOG_ENTRY
+      "</feed>\n"
+    );
+  }
+
+  {
+    const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?category=jazz,wikipedia");
+    EXPECT_EQ(r->status, 200);
+    EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+      CATALOG_V2_ENTRIES_PREAMBLE("?category=jazz%2Cwikipedia")
+      "  <title>Filtered Entries (category=jazz%2Cwikipedia)</title>\n"
+      "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+      "  <totalResults>2</totalResults>\n"
+      "  <startIndex>0</startIndex>\n"
+      "  <itemsPerPage>2</itemsPerPage>\n"
+      RAY_CHARLES_CATALOG_ENTRY
+      CHARLES_RAY_CATALOG_ENTRY
+      "</feed>\n"
+    );
+  }
+}
+
 TEST_F(LibraryServerTest, catalog_v2_entries_multiple_filters)
 {
   {