Merge pull request #1152 from kiwix/macos13

removed temp hack

.github/workflows/ci.yml

@@ -38,9 +38,6 @@ jobs:
       - name: Install packages
         run: |
           brew update
-          brew unlink python3
-          # upgrade from python@3.12 to python@3.12.2 fails to overwrite those
-          rm -f /usr/local/bin/2to3 /usr/local/bin/2to3-3.12 /usr/local/bin/idle3 /usr/local/bin/idle3.12 /usr/local/bin/pydoc3 /usr/local/bin/pydoc3.12 /usr/local/bin/python3 /usr/local/bin/python3-config /usr/local/bin/python3.12 /usr/local/bin/python3.12-config
           brew install pkg-config ninja meson
         env:
           HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1

ChangeLog

@@ -1,3 +1,31 @@
+libkiwix 14.0.0
+===============
+
+ * Server:
+  - Support of IPv6 (@veloman-yunkan @aryanA101a #1074 #1093)
+  - Better public IP configuration/detection (@sgourdas #1132)
+  - Fix API errors in catalog searches if Xapian keyword in used (@veloman-yunkan #1137)
+  - Clearly define which Web browsers are supported (@kelson42 @rgaudin @jaifroid @benoit74 #1132)
+  - Improve welcome page download buttons (@veloman-yunkan #1094)
+  - Better handling of external (non-HTTP) links (@veloman-yunkan #1123)
+  - Fix book illustration size on welcome page to 48x48 pixels (@veloman-yunkan #1127)
+  - Remove "Multiple Languages" in language filter (@veloman-yunkan #1098)
+  - Stop transforming tags casing (@kelson42 @veloman-yunkan #1079 #1121)
+  - ZIM file size consistently advertised in MiB (@harsha-mangena #1132)
+  - Few new supported languages in the filter (@kelson42 #1080)
+  - Improve accesskeys (@kelson42 #1075)
+  - Add OpenSearch <link> to head of pages (@kelson42 #1070)
+ * Compilation/Packaging:
+  - Multiple fixes around deb packaging (@kelson42 #1108 #1114 #1135)
+  - Generating of libkiwix.pc via Meson (@veloman-yunkan #1133)
+  - Native Windows CI/CD (@mgautierfr @kelson42 #1113 #1125)
+  - Better check (maximum) libzim version (@kelson42 #1124)
+  - Multiple automated tests improvements (@veloman-yunkan #1068 #1067)
+ * Other:
+  - Deleted supported env. variable `$KIWIX_DATA_DIR` and `kiwix::getDataDirectory()` (@sgourdas #1107)
+  - New string slugification for filenames (@shaopenglin #1105)
+  - Multiple improvements around aria2c download mgmt. (@veloman-yunkan #1097)
+
 libkiwix 13.1.0
 ===============
 

include/common.h

@@ -16,7 +16,7 @@
 
 namespace kiwix {
 
-enum class IpMode { ipv4, ipv6, all };
+enum class IpMode { IPV4, IPV6, ALL, AUTO }; // AUTO: Server decides the protocol
 typedef zim::size_type size_type;
 typedef zim::offset_type offset_type;
 

include/server.h

@@ -22,7 +22,7 @@
 
 #include <string>
 #include <memory>
-#include "common.h"
+#include "tools.h"
 
 namespace kiwix
 {
@@ -52,7 +52,7 @@ namespace kiwix
        void stop();
 
        void setRoot(const std::string& root);
-       void setAddress(const std::string& addr) { m_addr = addr; }
+       void setAddress(const std::string& addr);
        void setPort(int port) { m_port = port; }
        void setNbThreads(int threads) { m_nbThreads = threads; }
        void setMultiZimSearchLimit(unsigned int limit) { m_multizimSearchLimit = limit; }
@@ -64,15 +64,15 @@ namespace kiwix
        void setBlockExternalLinks(bool blockExternalLinks)
         { m_blockExternalLinks = blockExternalLinks; }
        void setIpMode(IpMode mode) { m_ipMode = mode; }
-       int getPort();
-       std::string getAddress();
+       int getPort() const;
+       IpAddress getAddress() const;
        IpMode getIpMode() const;
 
      protected:
        std::shared_ptr<Library> mp_library;
        std::shared_ptr<NameMapper> mp_nameMapper;
        std::string m_root = "";
-       std::string m_addr = "";
+       IpAddress m_addr;
        std::string m_indexTemplateString = "";
        int m_port = 80;
        int m_nbThreads = 1;
@@ -81,7 +81,7 @@ namespace kiwix
        bool m_withTaskbar = true;
        bool m_withLibraryButton = true;
        bool m_blockExternalLinks = false;
-       IpMode m_ipMode = IpMode::ipv4;
+       IpMode m_ipMode = IpMode::AUTO;
        int m_ipConnectionLimit = 0;
        std::unique_ptr<InternalServer> mp_server;
   };

include/tools.h

@@ -24,6 +24,7 @@
 #include <vector>
 #include <map>
 #include <cstdint>
+#include "common.h"
 
 namespace kiwix
 {
@@ -214,9 +215,10 @@ std::map<std::string, IpAddress> getNetworkInterfacesIPv4Or6();
 std::map<std::string, std::string> getNetworkInterfaces();
 
 /** Provides the best IP address
- * This function provides the best IP address from the list given by getNetworkInterfacesIPv4Or6()
+ * This function provides the best IP addresses for both ipv4 and ipv6 protocols,
+ * in an IpAddress struct, based on the list given by getNetworkInterfacesIPv4Or6()
  */
-std::string getBestPublicIp(bool ipv6);
+IpAddress getBestPublicIps();
 
 /** Provides the best IPv4 adddress
  * Equivalent to getBestPublicIp(false). Provided for backward compatibility

src/library.cpp

@@ -645,8 +645,6 @@ Xapian::Query buildXapianQueryFromFilterQuery(const Filter& filter)
   //queryParser.set_stemmer(Xapian::Stem(iso639_3ToXapian(???)));
   //queryParser.set_stemming_strategy(Xapian::QueryParser::STEM_SOME);
   const auto flags = Xapian::QueryParser::FLAG_PHRASE
-                   | Xapian::QueryParser::FLAG_BOOLEAN
-                   | Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE
                    | Xapian::QueryParser::FLAG_LOVEHATE
                    | Xapian::QueryParser::FLAG_WILDCARD
                    | partialQueryFlag;

src/server.cpp

@@ -75,12 +75,26 @@ void Server::setRoot(const std::string& root)
   }
 }
 
-int Server::getPort()
+void Server::setAddress(const std::string& addr)
+{
+  m_addr.addr.clear();
+  m_addr.addr6.clear();
+
+  if (addr.empty()) return;
+
+  if (addr.find(':') != std::string::npos) { // IPv6
+    m_addr.addr6 = (addr[0] == '[') ? addr.substr(1, addr.length() - 2) : addr; // Remove brackets if any
+  } else {
+    m_addr.addr = addr;
+  }
+}
+
+int Server::getPort() const
 {
   return mp_server->getPort();
 }
 
-std::string Server::getAddress()
+IpAddress Server::getAddress() const
 {
   return mp_server->getAddress();
 }

src/server/internalServer.cpp

@@ -85,6 +85,20 @@ namespace kiwix {
 namespace
 {
 
+bool ipAvailable(const std::string addr)
+{
+  auto interfaces = kiwix::getNetworkInterfacesIPv4Or6();
+
+  for (const auto& kv : interfaces) {
+    const auto& interfaceIps = kv.second;
+    if ((interfaceIps.addr == addr) || (interfaceIps.addr6 == addr)) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
 inline std::string normalizeRootUrl(std::string rootUrl)
 {
   while ( !rootUrl.empty() && rootUrl.back() == '/' )
@@ -407,7 +421,7 @@ public:
 
 InternalServer::InternalServer(LibraryPtr library,
                                std::shared_ptr<NameMapper> nameMapper,
-                               std::string addr,
+                               IpAddress addr,
                                int port,
                                std::string root,
                                int nbThreads,
@@ -461,30 +475,44 @@ bool InternalServer::start() {
   sockAddr6.sin6_family = AF_INET6;
   sockAddr6.sin6_port = htons(m_port);
 
-  if (m_addr.empty()) {
-    if (0 != INADDR_ANY) {
-      sockAddr6.sin6_addr = in6addr_any;
-      sockAddr4.sin_addr.s_addr = htonl(INADDR_ANY);
-    }
-    m_addr = kiwix::getBestPublicIp(m_ipMode == IpMode::ipv6 || m_ipMode == IpMode::all);
+  if (m_addr.addr.empty() && m_addr.addr6.empty()) { // No ip address provided
+    if (m_ipMode == IpMode::AUTO) m_ipMode = IpMode::ALL;
+    sockAddr6.sin6_addr = in6addr_any;
+    sockAddr4.sin_addr.s_addr = htonl(INADDR_ANY);
+    IpAddress bestIps = kiwix::getBestPublicIps();
+    if (m_ipMode == IpMode::IPV4 || m_ipMode == IpMode::ALL) m_addr.addr = bestIps.addr;
+    if (m_ipMode == IpMode::IPV6 || m_ipMode == IpMode::ALL) m_addr.addr6 = bestIps.addr6;
   } else {
-    bool ipv6 = inet_pton(AF_INET6, m_addr.c_str(), &(sockAddr6.sin6_addr.s6_addr)) == 1;
-    bool ipv4 = inet_pton(AF_INET, m_addr.c_str(), &(sockAddr4.sin_addr.s_addr)) == 1;
-    if (ipv6){
-       m_ipMode = IpMode::all;
-    } else if (!ipv4) {
-      std::cerr << "Ip address " << m_addr << "  is not a valid ip address" << std::endl;
+    const std::string addr = !m_addr.addr.empty() ? m_addr.addr : m_addr.addr6;
+
+    if (m_ipMode != kiwix::IpMode::AUTO) {
+      std::cerr << "ERROR: When an IP address is provided the IP mode must not be set" << std::endl;
       return false;
     }
+
+    bool validV4 = inet_pton(AF_INET, m_addr.addr.c_str(), &(sockAddr4.sin_addr.s_addr)) == 1;
+    bool validV6 = inet_pton(AF_INET6, m_addr.addr6.c_str(), &(sockAddr6.sin6_addr.s6_addr)) == 1;
+
+    if (!validV4 && !validV6) {
+      std::cerr << "ERROR: invalid IP address: " << addr << std::endl;
+      return false;
+    }
+
+    if (!ipAvailable(addr)) {
+      std::cerr << "ERROR: IP address is not available on this system: " << addr << std::endl;
+      return false;
+    }
+
+    m_ipMode = !m_addr.addr.empty() ? IpMode::IPV4 : IpMode::IPV6;
   }
 
-  if (m_ipMode == IpMode::all) {
+  if (m_ipMode == IpMode::ALL) {
     flags|=MHD_USE_DUAL_STACK;
-  } else if (m_ipMode == IpMode::ipv6) {
+  } else if (m_ipMode == IpMode::IPV6) {
     flags|=MHD_USE_IPv6;
   }
 
-  struct sockaddr* sockaddr = (m_ipMode==IpMode::all || m_ipMode==IpMode::ipv6)
+  struct sockaddr* sockaddr = (m_ipMode==IpMode::ALL || m_ipMode==IpMode::IPV6)
                               ? (struct sockaddr*)&sockAddr6
                               : (struct sockaddr*)&sockAddr4;
 

src/server/internalServer.h

@@ -27,6 +27,7 @@ extern "C" {
 
 #include "library.h"
 #include "name_mapper.h"
+#include "tools.h"
 
 #include <zim/search.h>
 #include <zim/suggestion.h>
@@ -94,7 +95,7 @@ class InternalServer {
   public:
     InternalServer(LibraryPtr library,
                    std::shared_ptr<NameMapper> nameMapper,
-                   std::string addr,
+                   IpAddress addr,
                    int port,
                    std::string root,
                    int nbThreads,
@@ -117,8 +118,8 @@ class InternalServer {
                                void** cont_cls);
     bool start();
     void stop();
-    std::string getAddress() { return m_addr; }
-    int getPort() { return m_port; }
+    IpAddress getAddress() const { return m_addr; }
+    int getPort() const { return m_port; }
     IpMode getIpMode() const { return m_ipMode; }
 
   private: // functions
@@ -166,7 +167,7 @@ class InternalServer {
     typedef ConcurrentCache<std::string, std::shared_ptr<LockableSuggestionSearcher>> SuggestionSearcherCache;
 
   private: // data
-    std::string m_addr;
+    IpAddress m_addr;
     int m_port;
     std::string m_root;                   // URI-encoded
     std::string m_rootPrefixOfDecodedURL; // URI-decoded

src/tools/networkTools.cpp

@@ -19,6 +19,7 @@
  */
 
 #include "tools.h"
+#include "stringTools.h"
 #include <tools/networkTools.h>
 
 #include <stdio.h>
@@ -62,6 +63,12 @@ size_t write_callback_to_iss(char* ptr, size_t size, size_t nmemb, void* userdat
   return nmemb;
 }
 
+void updatePublicIpAddress(IpAddress& publicIpAddr, const IpAddress& interfaceIpAddr)
+{
+  if (publicIpAddr.addr.empty())  publicIpAddr.addr  = interfaceIpAddr.addr;
+  if (publicIpAddr.addr6.empty()) publicIpAddr.addr6 = interfaceIpAddr.addr6;
+}
+
 } // unnamed namespace
 
 std::string download(const std::string& url) {
@@ -85,7 +92,6 @@ std::string download(const std::string& url) {
   return ss.str();
 }
 
-
 namespace
 {
 
@@ -211,40 +217,36 @@ std::map<std::string, std::string> getNetworkInterfaces() {
   return result;
 }
 
-
-std::string getBestPublicIp(bool ipv6) {
-  IpAddress bestPublicIp = IpAddress{"127.0.0.1","::1"};
+IpAddress getBestPublicIps() {
+  IpAddress bestPublicIps;
   std::map<std::string, IpAddress> interfaces = getNetworkInterfacesIPv4Or6();
-
 #ifndef _WIN32
-  const char* const prioritizedNames[] =
-      { "eth0", "eth1", "wlan0", "wlan1", "en0", "en1" };
-  for(auto name: prioritizedNames) {
-    auto it=interfaces.find(name);
-    if(it != interfaces.end() && !(ipv6 && (*it).second.addr6.empty())) {
-      bestPublicIp = (*it).second;
-      break;
+  const char* const prioritizedNames[] = { "eth0", "eth1", "wlan0", "wlan1", "en0", "en1" };
+  for (const auto& name : prioritizedNames) {
+    const auto it = interfaces.find(name);
+    if (it != interfaces.end()) {
+      updatePublicIpAddress(bestPublicIps, it->second);
     }
   }
 #endif
-
-  const char* const prefixes[] = { "192.168", "172.16.", "10.0" };
-  for(auto prefix : prefixes){
-    for(auto& itr : interfaces) {
-      std::string interfaceIp(itr.second.addr);
-      if (interfaceIp.find(prefix) == 0 && !(ipv6 && itr.second.addr6.empty())) {
-        bestPublicIp = itr.second;
-        break;
+  const char* const v4prefixes[] = { "192.168", "172.16", "10.0" };
+  for (const auto& prefix : v4prefixes) {
+    for (const auto& kv : interfaces) {
+      const auto& interfaceIps = kv.second;
+      if (kiwix::startsWith(interfaceIps.addr, prefix)) {
+        updatePublicIpAddress(bestPublicIps, interfaceIps);
       }
     }
   }
-  return ipv6 ? bestPublicIp.addr6 : bestPublicIp.addr;
-}
 
+  updatePublicIpAddress(bestPublicIps, {"127.0.0.1", "::1"});
+
+  return bestPublicIps;
+}
 
 std::string getBestPublicIp()
 {
-  return getBestPublicIp(false);
+  return getBestPublicIps().addr;
 }
 
 } // namespace kiwix

static/skin/i18n/fr.json

@@ -2,6 +2,7 @@
 	"@metadata": {
 		"authors": [
 			"Adriendelucca",
+			"Benoit74",
 			"Gomoko",
 			"Goombiis",
 			"Melimeli",
@@ -61,8 +62,8 @@
 	"torrent-download-link-text": "BitTorrent",
 	"torrent-download-alt-text": "Télécharger via BitTorrent",
 	"library-opds-feed-all-entries": "Flux OPDS de la bibliothèque – Toutes les entrées",
-	"filter-by-tag": "Filtrer par la balise « {{TAG}} »",
-	"stop-filtering-by-tag": "Arrêter le filtrage par la balise « {{TAG}} »",
+	"filter-by-tag": "Filtrer par le tag \"{{{TAG}}}\"",
+	"stop-filtering-by-tag": "Arrêter de filtrer par le tag \"{{{TAG}}}\"",
 	"library-opds-feed-parameterised": "Flux OPDS de la bibliothèque – Entrées correspondant à {{#LANG}} :\n ▪ Langue : {{LANG}} {{/LANG}}{{#CATEGORY}}\n ▪ Catégorie : {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\n ▪ Étiquette : {{TAG}} {{/TAG}}{{#Q}}\n ▪ Requête : {{Q}} {{/Q}}",
 	"welcome-to-kiwix-server": "Bienvenue sur le Serveur Kiwix",
 	"download-links-heading": "Liens de téléchargement pour <b><i>{{BOOK_TITLE}}</i></b>",

static/skin/i18n/he.json

@@ -53,8 +53,8 @@
 	"torrent-download-link-text": "ביטורנט",
 	"torrent-download-alt-text": "הורדה באמצעות ביטורנט",
 	"library-opds-feed-all-entries": "הזנת ספריית OPDS - כל הרשומות",
-	"filter-by-tag": "סינון לפי התג \"{{TAG}}\"",
-	"stop-filtering-by-tag": "להפסיק סינון לפי התג \"{{TAG}}\"",
+	"filter-by-tag": "לסנן לפי התג \"{{{TAG}}}\"",
+	"stop-filtering-by-tag": "להפסיק סינון לפי התג \"{{{TAG}}}\"",
 	"library-opds-feed-parameterised": "הזנת ספריית OPDS - רשומות שתואמות ל{{#LANG}}\nשפה: {{LANG}} {{/LANG}}{{#CATEGORY}}\nקטגוריה: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nתג: {{TAG}} {{/TAG}}{{#Q}}\nשאילתה: {{Q}} {{/Q}}",
 	"welcome-to-kiwix-server": "ברוך בואך לשרת קיוויקס",
 	"download-links-heading": "הורדת קישורים עבור <b><i>{{BOOK_TITLE}}</i></b>",

static/skin/i18n/ia.json

@@ -53,12 +53,22 @@
 	"torrent-download-link-text": "BitTorrent",
 	"torrent-download-alt-text": "Discargar per medio de BitTorrent",
 	"library-opds-feed-all-entries": "Fluxo OPDS del bibliotheca – Tote le entratas",
-	"filter-by-tag": "Filtrar per etiquetta \"{{TAG}}\"",
-	"stop-filtering-by-tag": "Non plus filtrar per etiquetta \"{{TAG}}\"",
+	"filter-by-tag": "Filtrar per etiquetta “{{{TAG}}}”",
+	"stop-filtering-by-tag": "Non plus filtrar per etiquetta “{{{TAG}}}”",
 	"library-opds-feed-parameterised": "Fluxo OPDS del bibliotheca – Entratas correspondente a {{#LANG}}\nLingua {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategoria: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nEtiquetta: {{TAG}} {{/TAG}}{{#Q}}\nConsulta: {{Q}} {{/Q}}",
 	"welcome-to-kiwix-server": "Benvenite al servitor Kiwix",
 	"download-links-heading": "Discargar ligamines pro <b><i>{{BOOK_TITLE}}</i></b>",
 	"download-links-title": "Discargar libro",
 	"preview-book": "Previsualisation",
-	"unknown-error": "Error incognite"
+	"unknown-error": "Error incognite",
+	"book-category.wikibooks": "Wikilibros",
+	"book-category.wikinews": "Wikinovas",
+	"book-category.wikipedia": "Wikipedia",
+	"book-category.wikiquote": "Wikiquote",
+	"book-category.wikisource": "Wikisource",
+	"book-category.wikispecies": "Wikispecies",
+	"book-category.wikiversity": "Wikiversitate",
+	"book-category.wikivoyage": "Wikiviage",
+	"book-category.wiktionary": "Wiktionario",
+	"book-category.other": "Altere"
 }

static/skin/i18n/mk.json

@@ -53,8 +53,8 @@
 	"torrent-download-link-text": "BitTorrent",
 	"torrent-download-alt-text": "Преземи преку BitTorrent",
 	"library-opds-feed-all-entries": "Библиотечен тековник на OPDS — Сите ставки",
-	"filter-by-tag": "Филтрирај по ознаката „{{TAG}}“",
-	"stop-filtering-by-tag": "Запри филтрирање по ознаката „{{TAG}}“",
+	"filter-by-tag": "Филтрирај по ознаката „{{{TAG}}}“",
+	"stop-filtering-by-tag": "Запри филтрирање по ознаката „{{{TAG}}}“",
 	"library-opds-feed-parameterised": "Библиотечен тековник на OPDS — ставки што одговараат на {{#LANG}}\nЈазик: {{LANG}} {{/LANG}}{{#CATEGORY}}\nКатегорија: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nОзнака: {{TAG}} {{/TAG}}{{#Q}}\nБарање: {{Q}} {{/Q}}",
 	"welcome-to-kiwix-server": "Добре дојдовте на Опслужувачот на Кивикс",
 	"download-links-heading": "Врски за преземање на <b><i>{{BOOK_TITLE}}</i></b>",

static/skin/i18n/or.json

@@ -1,7 +1,8 @@
 {
 	"@metadata": {
 		"authors": [
-			"Gouri"
+			"Gouri",
+			"Psubhashish"
 		]
 	},
 	"name": "ଓଡ଼ିଆ",
@@ -10,7 +11,7 @@
 	"too-many-books": "ଅତ୍ୟଧିକ ବହି ଅନୁରୋଧ (${{NB_BOOKS}}) ଯେଉଁଠାରେ ସୀମା ${{LIMIT}} |",
 	"no-book-found": "କୌଣସି ପୁସ୍ତକ ଚଯ଼ନ ମାନଦଣ୍ଡ ସହ ମେଳ ଖାଉନାହିଁ ।",
 	"url-not-found": "ଅନୁରୋଧ କରାଯାଇଥିବା URL \"{{url}}\" ଏହି ସର୍ଭରରେ ମିଳିଲା ନାହିଁ |",
-	"suggest-search": "<a href=\"${{{SEARCH_URL}}}\">${{PATTERN}} for</a> ପାଇଁ ଏକ ସମ୍ପୂର୍ଣ୍ଣ ପାଠ ସନ୍ଧାନ କର |",
+	"suggest-search": "<a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a> ପାଇଁ ପୂରା ପାଠ ଖୋଜନ୍ତୁ |",
 	"random-article-failure": "ଓହୋ! ଏକ ଅନିୟମିତ ପ୍ରବନ୍ଧ ବାଛିବାରେ ବିଫଳ :(",
 	"invalid-raw-data-type": "{{DATATYPE}} କଞ୍ଚା ବିଷୟବସ୍ତୁ ପାଇଁ ଏକ ବ valid ଧ ଅନୁରୋଧ ନୁହେଁ |",
 	"no-value-for-arg": "ଯୁକ୍ତି ପାଇଁ କୌଣସି ମୂଲ୍ଯ଼ ପ୍ରଦାନ କରାଯାଇନାହିଁ ${{ARGUMENT}}",

static/skin/i18n/ru.json

@@ -3,6 +3,7 @@
 		"authors": [
 			"Fenixs-ru",
 			"Kareyac",
+			"Lutece398",
 			"Okras",
 			"Pacha Tchernof",
 			"Razno0",
@@ -58,12 +59,22 @@
 	"torrent-download-link-text": "BitTorrent",
 	"torrent-download-alt-text": "Скачать через BitTorrent",
 	"library-opds-feed-all-entries": "Канал библиотеки OPDS – все записи",
-	"filter-by-tag": "Фильтровать по тегу \"{{TAG}}\"",
-	"stop-filtering-by-tag": "Прекратить фильтрацию по тегу \"{{TAG}}\"",
+	"filter-by-tag": "Фильтровать по тегу \"{{{TAG}}}\"",
+	"stop-filtering-by-tag": "Прекратить фильтрацию по тегу \"{{{TAG}}}\"",
 	"library-opds-feed-parameterised": "Канал OPDS библиотеки – записи, соответствующие {{#LANG}}\nLanguage: {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategory: {{CATEGORY}} {{/CATEGORY}} {{#TAG}}\nTag: {{TAG}} {{/TAG}}{{#Q}}\nЗапрос: {{Q}} {{/Q}}",
 	"welcome-to-kiwix-server": "Добро пожаловать на сервер Kiwix",
 	"download-links-heading": "Ссылки для скачивания <b><i>{{BOOK_TITLE}}</i></b>",
 	"download-links-title": "Скачать книгу",
 	"preview-book": "Предпросмотр",
-	"unknown-error": "Неизвестная ошибка"
+	"unknown-error": "Неизвестная ошибка",
+	"book-category.wikibooks": "Викиучебник",
+	"book-category.wikinews": "Викиновости",
+	"book-category.wikipedia": "Википедия",
+	"book-category.wikiquote": "Викицитатник",
+	"book-category.wikisource": "Викитека",
+	"book-category.wikispecies": "Викивиды",
+	"book-category.wikiversity": "Викиверситет",
+	"book-category.wikivoyage": "Викигид",
+	"book-category.wiktionary": "Викисловарь",
+	"book-category.other": "Другое"
 }

static/skin/i18n/zh-hans.json

@@ -17,7 +17,7 @@
 	"no-book-found": "没有符合搜索要求的图书",
 	"url-not-found": "在此服务器上找不到请求的 URL：{{url}}",
 	"suggest-search": "对<a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>进行全文搜索",
-	"random-article-failure": "抱歉！ 随机条目失败了 (⁠〒⁠﹏⁠〒⁠) 【好生草的表情（】",
+	"random-article-failure": "抱歉！ 随机条目失败了 (⁠〒⁠﹏⁠〒⁠)",
 	"invalid-raw-data-type": "{{DATATYPE}} 对原请求无效。",
 	"invalid-request": "请求的URL无效：{{{url}}}",
 	"no-value-for-arg": "参数{{ARGUMENT}}无值",
@@ -58,8 +58,8 @@
 	"torrent-download-link-text": "BitTorrent",
 	"torrent-download-alt-text": "通过 BitTorrent 下载",
 	"library-opds-feed-all-entries": "图书馆 OPDS Feed - 所有条目",
-	"filter-by-tag": "按标签“{{TAG}}”过滤",
-	"stop-filtering-by-tag": "停止按标签“{{TAG}}”过滤",
+	"filter-by-tag": "按标签“{{{TAG}}}”过滤",
+	"stop-filtering-by-tag": "停止按标签“{{{TAG}}}”过滤",
 	"library-opds-feed-parameterised": "图书馆 OPDS Feed - 匹配的项目 {{#LANG}}\n语言：{{LANG}} {{/LANG}}{{#CATEGORY}}\n分类：{{CATEGORY}} {{/CATEGORY}}{{#TAG}}\n标签：{{TAG}} {{/TAG}}{{#Q}}\n查询：{{Q}} {{/Q}}",
 	"welcome-to-kiwix-server": "欢迎来到 Kiwix 服务器",
 	"download-links-heading": "下载<b><i>{{BOOK_TITLE}}</i></b>的链接",

test/data/library.xml

@@ -4,7 +4,7 @@
         path="./zimfile_raycharles.zim"
         url="https://github.com/kiwix/libkiwix/raw/master/test/data/zimfile_raycharles.zim"
         title="Ray Charles"
-        description="Wikipedia articles about Ray Charles"
+        description="Wikipedia articles about Ray Charles (not all of them but near to what an average newborn may find more than enough)"
         language="eng"
         creator="Wikipedia"
         publisher="Kiwix"
@@ -22,7 +22,7 @@
         path="./zimfile_raycharles_uncategorized.zim"
         url="https://github.com/kiwix/libkiwix/raw/master/test/data/zimfile_raycharles_uncategorized.zim"
         title="Ray (uncategorized) Charles"
-        description="No category is assigned to this library entry."
+        description="No category is assigned to this library entry (neither adj nor xor was considered a good option)"
         language="rus,eng"
         creator="Wikipedia"
         publisher="Kiwix"
@@ -39,7 +39,7 @@
         path="./zimfile&other.zim"
         url="https://github.com/kiwix/libkiwix/raw/master/test/data/zimfile%26other.zim"
         title="Charles, Ray"
-        description="Wikipedia articles about Ray Charles"
+        description="Wikipedia articles about Ray Charles or why and when one should go to library"
         language="fra"
         creator="Wikipedia"
         publisher="Kiwix"

test/library_server.cpp

@@ -103,7 +103,7 @@ std::string maskVariableOPDSFeedData(std::string s)
 #define _CHARLES_RAY_CATALOG_ENTRY(CONTENT_NAME) CATALOG_ENTRY(  \
   "charlesray",   \
   "Charles, Ray", \
-  "Wikipedia articles about Ray Charles", \
+  "Wikipedia articles about Ray Charles or why and when one should go to library", \
   "fra", \
   "wikipedia_fr_ray_charles",\
   "jazz",\
@@ -120,7 +120,7 @@ std::string maskVariableOPDSFeedData(std::string s)
 #define _RAY_CHARLES_CATALOG_ENTRY(CONTENT_NAME) CATALOG_ENTRY(\
   "raycharles",\
   "Ray Charles",\
-  "Wikipedia articles about Ray Charles",\
+  "Wikipedia articles about Ray Charles (not all of them but near to what an average newborn may find more than enough)",\
   "eng",\
   "wikipedia_en_ray_charles",\
   "wikipedia",\
@@ -139,7 +139,7 @@ std::string maskVariableOPDSFeedData(std::string s)
 #define UNCATEGORIZED_RAY_CHARLES_CATALOG_ENTRY CATALOG_ENTRY(\
   "raycharles_uncategorized",\
   "Ray (uncategorized) Charles",\
-  "No category is assigned to this library entry.",\
+  "No category is assigned to this library entry (neither adj nor xor was considered a good option)",\
   "rus,eng",\
   "wikipedia_ru_ray_charles",\
   "",\
@@ -199,8 +199,8 @@ TEST_F(LibraryServerTest, catalog_search_by_phrase)
     "  <startIndex>0</startIndex>\n"
     "  <itemsPerPage>2</itemsPerPage>\n"
     CATALOG_LINK_TAGS
-    RAY_CHARLES_CATALOG_ENTRY
     CHARLES_RAY_CATALOG_ENTRY
+    RAY_CHARLES_CATALOG_ENTRY
     "</feed>\n"
   );
 }
@@ -218,8 +218,8 @@ TEST_F(LibraryServerTest, catalog_search_by_words)
     "  <startIndex>0</startIndex>\n"
     "  <itemsPerPage>3</itemsPerPage>\n"
     CATALOG_LINK_TAGS
-    RAY_CHARLES_CATALOG_ENTRY
     CHARLES_RAY_CATALOG_ENTRY
+    RAY_CHARLES_CATALOG_ENTRY
     UNCATEGORIZED_RAY_CHARLES_CATALOG_ENTRY
     "</feed>\n"
   );
@@ -239,8 +239,8 @@ TEST_F(LibraryServerTest, catalog_prefix_search)
       "  <startIndex>0</startIndex>\n"
       "  <itemsPerPage>2</itemsPerPage>\n"
       CATALOG_LINK_TAGS
-      RAY_CHARLES_CATALOG_ENTRY
       CHARLES_RAY_CATALOG_ENTRY
+      RAY_CHARLES_CATALOG_ENTRY
       "</feed>\n"
     );
   }
@@ -275,8 +275,8 @@ TEST_F(LibraryServerTest, catalog_search_with_word_exclusion)
     "  <startIndex>0</startIndex>\n"
     "  <itemsPerPage>2</itemsPerPage>\n"
     CATALOG_LINK_TAGS
-    RAY_CHARLES_CATALOG_ENTRY
     CHARLES_RAY_CATALOG_ENTRY
+    RAY_CHARLES_CATALOG_ENTRY
     "</feed>\n"
   );
 }
@@ -331,8 +331,8 @@ TEST_F(LibraryServerTest, catalog_search_by_category)
       "  <startIndex>0</startIndex>\n"
       "  <itemsPerPage>2</itemsPerPage>\n"
       CATALOG_LINK_TAGS
-      RAY_CHARLES_CATALOG_ENTRY
       CHARLES_RAY_CATALOG_ENTRY
+      RAY_CHARLES_CATALOG_ENTRY
       "</feed>\n"
     );
   }
@@ -772,10 +772,171 @@ TEST_F(LibraryServerTest, catalog_v2_entries_filtered_by_search_terms)
     "  <totalResults>2</totalResults>\n"
     "  <startIndex>0</startIndex>\n"
     "  <itemsPerPage>2</itemsPerPage>\n"
+    CHARLES_RAY_CATALOG_ENTRY
     RAY_CHARLES_CATALOG_ENTRY
+    "</feed>\n"
+  );
+}
+
+TEST_F(LibraryServerTest, catalog_v2_entries_filtering_special_queries)
+{
+  {
+  // 'or' doesn't act as a Xapian boolean operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=Or");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=Or")
+    "  <title>Filtered Entries (q=Or)</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"
   );
+  }
+
+  {
+  // 'and' doesn't act as a Xapian boolean operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=and");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=and")
+    "  <title>Filtered Entries (q=and)</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"
+  );
+  }
+
+  {
+  // 'not' doesn't act as a Xapian boolean operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=not");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=not")
+    "  <title>Filtered Entries (q=not)</title>\n"
+    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+    "  <totalResults>1</totalResults>\n"
+    "  <startIndex>0</startIndex>\n"
+    "  <itemsPerPage>1</itemsPerPage>\n"
+    RAY_CHARLES_CATALOG_ENTRY
+    "</feed>\n"
+  );
+  }
+
+  {
+  // 'xor' doesn't act as a Xapian boolean operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=xor");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=xor")
+    "  <title>Filtered Entries (q=xor)</title>\n"
+    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+    "  <totalResults>1</totalResults>\n"
+    "  <startIndex>0</startIndex>\n"
+    "  <itemsPerPage>1</itemsPerPage>\n"
+    UNCATEGORIZED_RAY_CHARLES_CATALOG_ENTRY
+    "</feed>\n"
+  );
+  }
+
+  {
+  // 'or' acts as a Xapian boolean operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=wikipedia%20or%20library");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=wikipedia%20or%20library")
+    "  <title>Filtered Entries (q=wikipedia%20or%20library)</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"
+  );
+  }
+
+  {
+  // 'and' acts as a Xapian boolean operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=wikipedia%20and%20articles");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=wikipedia%20and%20articles")
+    "  <title>Filtered Entries (q=wikipedia%20and%20articles)</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"
+  );
+  }
+
+  {
+  // 'near' doesn't act as a Xapian query operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=near");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=near")
+    "  <title>Filtered Entries (q=near)</title>\n"
+    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+    "  <totalResults>1</totalResults>\n"
+    "  <startIndex>0</startIndex>\n"
+    "  <itemsPerPage>1</itemsPerPage>\n"
+    RAY_CHARLES_CATALOG_ENTRY
+    "</feed>\n"
+  );
+  }
+
+  {
+  // 'adj' doesn't act as a Xapian query operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=adj");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=adj")
+    "  <title>Filtered Entries (q=adj)</title>\n"
+    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+    "  <totalResults>1</totalResults>\n"
+    "  <startIndex>0</startIndex>\n"
+    "  <itemsPerPage>1</itemsPerPage>\n"
+    UNCATEGORIZED_RAY_CHARLES_CATALOG_ENTRY
+    "</feed>\n"
+  );
+  }
+
+  {
+  // 'near' doesn't act as a Xapian query operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=charles%20near%20why");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=charles%20near%20why")
+    "  <title>Filtered Entries (q=charles%20near%20why)</title>\n"
+    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+    "  <totalResults>0</totalResults>\n"
+    "  <startIndex>0</startIndex>\n"
+    "  <itemsPerPage>0</itemsPerPage>\n"
+    "</feed>\n"
+  );
+  }
+
+  {
+  // 'adj' doesn't act as a Xapian query operator
+  const auto r = zfs1_->GET("/ROOT%23%3F/catalog/v2/entries?q=charles%20adj%20why");
+  EXPECT_EQ(r->status, 200);
+  EXPECT_EQ(maskVariableOPDSFeedData(r->body),
+    CATALOG_V2_ENTRIES_PREAMBLE("?q=charles%20adj%20why")
+    "  <title>Filtered Entries (q=charles%20adj%20why)</title>\n"
+    "  <updated>YYYY-MM-DDThh:mm:ssZ</updated>\n"
+    "  <totalResults>0</totalResults>\n"
+    "  <startIndex>0</startIndex>\n"
+    "  <itemsPerPage>0</itemsPerPage>\n"
+    "</feed>\n"
+  );
+  }
 }
 
 TEST_F(LibraryServerTest, catalog_v2_entries_filtered_by_language)
@@ -841,8 +1002,8 @@ TEST_F(LibraryServerTest, catalog_v2_entries_filtered_by_category)
       "  <totalResults>2</totalResults>\n"
       "  <startIndex>0</startIndex>\n"
       "  <itemsPerPage>2</itemsPerPage>\n"
-      RAY_CHARLES_CATALOG_ENTRY
       CHARLES_RAY_CATALOG_ENTRY
+      RAY_CHARLES_CATALOG_ENTRY
       "</feed>\n"
     );
   }
@@ -1086,7 +1247,7 @@ TEST_F(LibraryServerTest, no_name_mapper_catalog_v2_individual_entry_access)
   "            <div class=\"book__header\">\n" \
   "                <div id=\"book__title\">Charles, Ray</div>\n" \
   "            </div>\n" \
-  "            <div class=\"book__description\" title=\"Wikipedia articles about Ray Charles\">Wikipedia articles about Ray Charles</div>\n" \
+  "            <div class=\"book__description\" title=\"Wikipedia articles about Ray Charles or why and when one should go to library\">Wikipedia articles about Ray Charles or why and when one should go to library</div>\n" \
   "            </div>\n" \
   "            </a>\n" \
   "            <div class=\"book__meta\">\n" \
@@ -1113,7 +1274,7 @@ TEST_F(LibraryServerTest, no_name_mapper_catalog_v2_individual_entry_access)
   "            <div class=\"book__header\">\n" \
   "                <div id=\"book__title\">Ray Charles</div>\n" \
   "            </div>\n" \
-  "            <div class=\"book__description\" title=\"Wikipedia articles about Ray Charles\">Wikipedia articles about Ray Charles</div>\n" \
+  "            <div class=\"book__description\" title=\"Wikipedia articles about Ray Charles (not all of them but near to what an average newborn may find more than enough)\">Wikipedia articles about Ray Charles (not all of them but near to what an average newborn may find more than enough)</div>\n" \
   "            </div>\n" \
   "            </a>\n" \
   "            <div class=\"book__meta\">\n" \
@@ -1140,7 +1301,7 @@ TEST_F(LibraryServerTest, no_name_mapper_catalog_v2_individual_entry_access)
   "            <div class=\"book__header\">\n" \
   "                <div id=\"book__title\">Ray (uncategorized) Charles</div>\n" \
   "            </div>\n" \
-  "            <div class=\"book__description\" title=\"No category is assigned to this library entry.\">No category is assigned to this library entry.</div>\n" \
+  "            <div class=\"book__description\" title=\"No category is assigned to this library entry (neither adj nor xor was considered a good option)\">No category is assigned to this library entry (neither adj nor xor was considered a good option)</div>\n" \
   "            </div>\n" \
   "            </a>\n" \
   "            <div class=\"book__meta\">\n" \

test/otherTools.cpp

@@ -18,6 +18,7 @@
  */
 
 #include "gtest/gtest.h"
+#include "../include/tools.h"
 #include "../src/tools/otherTools.h"
 #include "zim/suggestion_iterator.h"
 #include "../src/server/i18n_utils.h"
@@ -252,11 +253,8 @@ TEST(networkTools, getNetworkInterfaces)
   }
 }
 
-TEST(networkTools, getBestPublicIp)
+TEST(networkTools, getBestPublicIps)
 {
-  using kiwix::getBestPublicIp;
-
-  std::cout << "getBestPublicIp(true)  " << getBestPublicIp(true)  << std::endl;
-  std::cout << "getBestPublicIp(false) " << getBestPublicIp(false) << std::endl;
-  std::cout << "getBestPublicIp()      " << getBestPublicIp()      << std::endl;
+  std::cout << "getBestPublicIps(): " << "[" << kiwix::getBestPublicIps().addr << ", " << kiwix::getBestPublicIps().addr6 << "]" << std::endl;
+  std::cout << "getBestPublicIp(): " << kiwix::getBestPublicIp() << std::endl;
 }