Add documentation for widget

Added documentation for current widget usage, currently supported arguments, using custom CSS/JS

.github/workflows/ci.yml

@@ -1,13 +1,17 @@
 name: CI
 
-on: [push]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   Macos:
     runs-on: macos-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: Setup python 3.10
         uses: actions/setup-python@v2
         with:
@@ -47,7 +51,6 @@ jobs:
         name:
           - native_static
           - native_dyn
-          - native_dyn_bionic
           - android_arm
           - android_arm64
           - win32_static
@@ -55,31 +58,27 @@ jobs:
         include:
           - name: native_static
             target: native_static
-            image_variant: xenial
+            image_variant: bionic
             lib_postfix: '/x86_64-linux-gnu'
           - name: native_dyn
-            target: native_dyn
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
-          - name: native_dyn_bionic
             target: native_dyn
             image_variant: bionic
             lib_postfix: '/x86_64-linux-gnu'
           - name: android_arm
             target: android_arm
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
+            image_variant: bionic
+            lib_postfix: '/arm-linux-androideabi'
           - name: android_arm64
             target: android_arm64
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
+            image_variant: bionic
+            lib_postfix: '/aarch64-linux-android'
           - name: win32_static
             target: win32_static
-            image_variant: f31
+            image_variant: f35
             lib_postfix: '64'
           - name: win32_dyn
             target: win32_dyn
-            image_variant: f31
+            image_variant: f35
             lib_postfix: '64'
     env:
       HOME: /home/runner
@@ -87,10 +86,6 @@ jobs:
     container:
       image: "kiwix/kiwix-build_ci:${{matrix.image_variant}}-31"
     steps:
-    - name: Extract branch name
-      shell: bash
-      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-      id: extract_branch
     - name: Checkout code
       shell: python
       run: |
@@ -100,7 +95,7 @@ jobs:
           'git', 'clone',
           'https://github.com/${{github.repository}}',
           '--depth=1',
-          '--branch', '${{steps.extract_branch.outputs.branch}}'
+          '--branch', '${{ github.head_ref || github.ref_name }}'
         ]
         check_call(command, cwd=environ['HOME'])
     - name: Install deps
@@ -123,7 +118,7 @@ jobs:
           MESON_OPTION="$MESON_OPTION --cross-file $HOME/BUILD_${{matrix.target}}/meson_cross_file.txt"
         fi
         if [[ "${{matrix.target}}" =~ android_.* ]]; then
-          MESON_OPTION="$MESON_OPTION -Dandroid=true"
+          MESON_OPTION="$MESON_OPTION -Dstatic-linkage=true"
         fi
         cd $HOME/libkiwix
         meson . build ${MESON_OPTION}
@@ -149,6 +144,6 @@ jobs:
         curl https://codecov.io/bash -o codecov.sh
         bash codecov.sh -n "${OS_NAME}_${{matrix.target}}" -Z
         rm codecov.sh
-      if: startsWith(matrix.target, 'native_') && matrix.image_variant == 'xenial'
+      if: startsWith(matrix.target, 'native_')
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

ChangeLog

@@ -1,3 +1,21 @@
+libkiwix 11.0.0
+===============
+
+ * [server] Add support for internationalization (@veloman-yunkan #679)
+ * [server] Use gzip compression instead of deflat (mgautierfr #757)
+ * [server] Version the static resources. This allow better invalidating
+   browser cache when resources are changed (@veloman-yunkan #712)
+ * [server|front] Use integer to query the host for page length (@juuz #772)
+ * [server] Improve multizim search API:
+   - Improvement of the cache system
+   - Better API to select on which books to search in.
+   - SysAdmin is now able to limit the number of book we search in for a multizim search
+ * [server] Introduce a opensearch API for multizim fulltext search
+ * [wrapper] Remove java wrapper
+ * Testing:
+   - Testing of search result pages content (@veloman-yunkan #765)
+   - Better testing structure of xml search result (@veloman-yunkan #780)
+
 libkiwix 10.1.1
 ===============
 

README.md

@@ -8,6 +8,7 @@ GNU/Linux, macOS, Android, iOS, ...).
 [![Release](https://img.shields.io/github/v/tag/kiwix/libkiwix?label=release&sort=semver)](https://download.kiwix.org/release/libkiwix/)
 [![Repositories](https://img.shields.io/repology/repositories/libkiwix?label=repositories)](https://github.com/kiwix/libkiwix/wiki/Repology)
 [![Build Status](https://github.com/kiwix/libkiwix/workflows/CI/badge.svg?query=branch%3Amaster)](https://github.com/kiwix/libkiwix/actions?query=branch%3Amaster)
+[![Doc](https://readthedocs.org/projects/libkiwix/badge/?style=flat)](https://libkiwix.readthedocs.org/en/latest/?badge=latest)
 [![CodeFactor](https://www.codefactor.io/repository/github/kiwix/libkiwix/badge)](https://www.codefactor.io/repository/github/kiwix/libkiwix)
 [![Codecov](https://codecov.io/gh/kiwix/libkiwix/branch/master/graph/badge.svg)](https://codecov.io/gh/kiwix/libkiwix)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
@@ -172,14 +173,6 @@ To use JS provided by kiwix-serve you can use the following template to start wi
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width,initial-scale=1" />
     <title><-- Custom Tittle --></title>
-    <script
-      type="text/javascript"
-      src="{{root}}/skin/jquery-ui/external/jquery/jquery.js"
-    ></script>
-    <script
-      type="text/javascript"
-      src="{{root}}/skin/jquery-ui/jquery-ui.min.js"
-    ></script>
     <script src="{{root}}/skin/isotope.pkgd.min.js" defer></script>
     <script src="{{root}}/skin/iso6391To3.js"></script>
     <script type="text/javascript" src="{{root}}/skin/index.js" defer></script>
@@ -197,7 +190,7 @@ To use JS provided by kiwix-serve you can use the following template to start wi
     ```
         <form id='kiwixSearchForm'>
         <input type="text" name="q" placeholder="Search" id="searchFilter" class='kiwixSearch filter'>
-        <input type="submit" class="searchButton" value="Search"/>
+        <input type="submit" class="kiwixButton" value="Search"/>
         </form>
     ```
 

debian/libkiwix-dev.manpages

@@ -1 +1,2 @@
 usr/share/man/man1/kiwix-compile-resources.1*
+usr/share/man/man1/kiwix-compile-i18n.1*

docs/conf.py

@@ -19,7 +19,7 @@ import os
 
 project = 'libkiwix'
 copyright = '2022, libkiwix-team'
-author = 'libzim-team'
+author = 'libkiwix-team'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to libzim's documentation!
+Welcome to libkiwix's documentation!
 ==================================
 
 .. toctree::
@@ -12,3 +12,4 @@ Welcome to libzim's documentation!
 
    usage
    api/ref_api
+   widget

docs/usage.rst

@@ -7,11 +7,9 @@ Introduction
 libkiwix is written in C++. To use the library, you need the include files of libkiwix have
 to link against libzim.
 
-Errors are handled with exceptions. When something goes wrong, libzim throws an error,
+Errors are handled with exceptions. When something goes wrong, libkiwix throws an error,
 which is always derived from std::exception.
 
 All classes are defined in the namespace kiwix.
 
 libkiwix is a set of tools to manage zim files and provide some common functionnality.
-While libkiwix has some wrappers around libzim classes, they are deprecated and will be removed
-in the future.

docs/widget.rst

@@ -0,0 +1,82 @@
+Kiwix serve widget
+====================
+
+Introduction
+------------
+
+The kiwix-serve widget provides an easy to embed way to show the `kiwix-serve` homepage.
+
+Usage
+-----
+
+To use the widget, simply add an iframe with its `src` attribute set to the `widget` endpoint.
+Example HTML Page ::
+
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+    <title>Widget Test</title>
+    </head>
+    <body>
+    <iframe src="http://192.168.18.8:8080/widget?disabledesc&disablefilter&disabledownload" width=1000 height=1000></iframe>
+    </body>
+    </html>
+
+This creates an iframe with the kiwix-serve homepage contents.
+
+Arguments are explained below.
+
+Possible Arguments
+-------------------
+
+Currently, the following arguments are supported.
+
+disabledesc (value = N/A)
+    Disables the description part of a tile.
+
+disablefilter (value = N/A)
+    Disables the search filters: language, category, tag and search function.
+
+disableclick (value = N/A)
+    Disables clicking the book to open it for reading.
+
+disabledownload (value = N/A)
+    Disables the download button (if avaialable at all) on the tile.
+
+
+Custom CSS and JS
+-----------------
+
+You can add your custom CSS rules and Javascript code to the widget.
+
+To do that, use the following code as template::
+
+    <iframe id="receiver" src="http://192.168.18.8:8080/widget?disabledesc=&disablefilter=&disabledownload=" width="1000" height="1000">
+    <p>Your browser does not support iframes.</p>
+    </iframe>
+
+    <script>
+    window.onload = function() {
+    var receiver = document.getElementById('receiver').contentWindow;
+    function sendMessage() {
+        let msg = {
+        css: `
+        .book__header {
+            color:red;
+        }`,
+        js: `
+        function widgetTest() {
+        console.log("Testing widget");
+        }
+        widgetTest();
+        `
+        }
+        receiver.postMessage(msg, 'http://192.168.18.8:8080/widget');
+    }
+    sendMessage();
+    }
+    </script>
+
+
+The CSS/JS fields are optional, you may send both or only one.
+

include/book.h

@@ -38,7 +38,6 @@ namespace kiwix
 {
 
 class OPDSDumper;
-class Reader;
 
 /**
  * A class to store information about a book (a zim file)
@@ -69,7 +68,6 @@ class Book
   ~Book();
 
   bool update(const Book& other);
-  DEPRECATED void update(const Reader& reader);
   void update(const zim::Archive& archive);
   void updateFromXml(const pugi::xml_node& node, const std::string& baseDir);
   void updateFromOpds(const pugi::xml_node& node, const std::string& urlHost);

include/entry.h

@@ -1,193 +0,0 @@
-/*
- * Copyright 2018-2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_ENTRY_H
-#define KIWIX_ENTRY_H
-
-#include <stdio.h>
-#include <zim/entry.h>
-#include <zim/item.h>
-#include <exception>
-#include <string>
-
-#include "common.h"
-
-using namespace std;
-
-namespace kiwix
-{
-
-
-class NoEntry : public std::exception {};
-
-/**
- * A entry represent an.. entry in a zim file.
- */
-class Entry
-{
-  public:
-    /**
-     * Construct an entry making reference to an zim article.
-     *
-     * @param article a zim::Article object
-     */
-    DEPRECATED Entry(zim::Entry entry) : Entry(entry, true) {};
-    virtual ~Entry() = default;
-
-    /**
-     * Get the path of the entry.
-     *
-     * The path is the "key" of an entry.
-     *
-     * @return the path of the entry.
-     */
-    std::string getPath() const { return entry.getPath(); }
-
-    /**
-     * Get the title of the entry.
-     *
-     * @return the title of the entry.
-     */
-    std::string getTitle() const { return entry.getTitle(); }
-
-    /**
-     * Get the content of the entry.
-     *
-     * The string is a copy of the content.
-     * If you don't want to do a copy, use get_blob.
-     *
-     * @return the content of the entry.
-     */
-    std::string getContent() const { return entry.getItem().getData(); }
-
-    /**
-     * Get the blob of the entry.
-     *
-     * A blob make reference to the content without copying it.
-     *
-     * @param offset The starting offset of the blob.
-     * @return the blob of the entry.
-     */
-    zim::Blob   getBlob(offset_type offset = 0) const { return entry.getItem().getData(offset); }
-
-    /**
-     * Get the blob of the entry.
-     *
-     * A blob make reference to the content without copying it.
-     *
-     * @param offset The starting offset of the blob.
-     * @param size The size of the blob.
-     * @return the blob of the entry.
-     */
-    zim::Blob   getBlob(offset_type offset, size_type size) const { return entry.getItem().getData(offset, size); }
-
-    /**
-     * Get the info for direct access to the content of the entry.
-     *
-     * Some entry (ie binary ones) have their content plain stored
-     * in the zim file. Knowing the offset where the content is stored
-     * an user can directly read the content in the zim file bypassing the
-     * libkiwix/libzim.
-     *
-     * @return A pair specifying where to read the content.
-     *         The string is the real file to read (may be different that .zim
-     *         file if zim is cut).
-     *         The offset is the offset to read in the file.
-     *         Return <"",0> if is not possible to read directly.
-     */
-    zim::Item::DirectAccessInfo getDirectAccessInfo() const { return entry.getItem().getDirectAccessInformation(); }
-
-    /**
-     * Get the size of the entry.
-     *
-     * @return the size of the entry.
-     */
-    size_type   getSize() const;
-
-    /**
-     * Get the mime_type of the entry.
-     *
-     * @return the mime_type of the entry.
-     */
-    std::string getMimetype() const;
-
-
-    /**
-     * Get if the entry is a redirect entry.
-     *
-     * @return True if the entry is a redirect.
-     */
-    bool isRedirect() const;
-
-    /**
-     * Get if the entry is a link target entry.
-     *
-     * @return True if the entry is a link target.
-     */
-    bool isLinkTarget() const;
-
-    /**
-     * Get if the entry is a deleted entry.
-     *
-     * @return True if the entry is a deleted entry.
-     */
-    bool isDeleted() const;
-
-    /**
-     * Get the entry pointed by this entry.
-     *
-     * @return the entry pointed.
-     * @throw NoEntry if the entry is not a redirected entry.
-     */
-    Entry getRedirectEntry() const;
-
-    /**
-     * Get the final entry pointed by this entry.
-     *
-     * Follow the redirection until a "not redirecting" entry is found.
-     * If the entry is not a redirected entry, return the entry itself.
-     *
-     * @return the final entry.
-     */
-    Entry getFinalEntry() const;
-
-    /**
-     * Get the zim entry wrapped by this (kiwix) entry
-     *
-     * @return the zim entry
-     */
-    const zim::Entry& getZimEntry() const { return entry; }
-
-  private:
-    zim::Entry entry;
-
-  private:
-    // Entry is deprecated, so we've marked the constructor as deprecated.
-    // But we still need to construct the entry (in our deprecated code)
-    // To avoid warning because we use deprecated function, we create a second
-    // constructor not deprecated. The `bool marker` is unused, it sole purpose
-    // is to change the signature to have two different constructor.
-    // This one is not deprecated and we must use it in our private code.
-    Entry(zim::Entry entry, bool marker);
-    friend class Reader;
-};
-
-}
-
-#endif // KIWIX_ENTRY_H

include/library.h

@@ -26,6 +26,7 @@
 #include <memory>
 #include <mutex>
 #include <zim/archive.h>
+#include <zim/search.h>
 
 #include "book.h"
 #include "bookmark.h"
@@ -140,53 +141,35 @@ private: // functions
     bool accept(const Book& book) const;
 };
 
-/**
- * This class is not part of the libkiwix API. Its only purpose is
- * to simplify the implementation of the Library's move operations
- * and avoid bugs should new data members be added to Library.
- */
-class LibraryBase
+
+class ZimSearcher : public zim::Searcher
 {
-protected: // types
-  typedef uint64_t LibraryRevision;
+  public:
+    explicit ZimSearcher(zim::Searcher&& searcher)
+      : zim::Searcher(searcher)
+    {}
 
-  struct Entry : Book
-  {
-    LibraryRevision lastUpdatedRevision = 0;
-
-    // May also keep the Archive and Reader pointers here and get
-    // rid of the m_readers and m_archives data members in Library
-  };
-
-protected: // data
-  LibraryRevision m_revision;
-  std::map<std::string, Entry> m_books;
-  std::map<std::string, std::shared_ptr<Reader>> m_readers;
-  std::map<std::string, std::shared_ptr<zim::Archive>> m_archives;
-  std::vector<kiwix::Bookmark> m_bookmarks;
-  class BookDB;
-  std::unique_ptr<BookDB> m_bookDB;
-
-protected: // functions
-  LibraryBase();
-  ~LibraryBase();
-
-  LibraryBase(LibraryBase&& );
-  LibraryBase& operator=(LibraryBase&& );
+    std::unique_lock<std::mutex> getLock() {
+      return std::unique_lock<std::mutex>(m_mutex);
+    }
+    virtual ~ZimSearcher() = default;
+  private:
+    std::mutex m_mutex;
 };
 
 /**
  * A Library store several books.
  */
-class Library : private LibraryBase
+class Library
 {
   // all data fields must be added in LibraryBase
   mutable std::mutex m_mutex;
 
  public:
-  typedef LibraryRevision Revision;
+  typedef uint64_t Revision;
   typedef std::vector<std::string> BookIdCollection;
   typedef std::map<std::string, int> AttributeCounts;
+  typedef std::set<std::string> BookIdSet;
 
  public:
   Library();
@@ -240,8 +223,11 @@ class Library : private LibraryBase
 
   Book getBookByIdThreadSafe(const std::string& id) const;
 
-  DEPRECATED std::shared_ptr<Reader> getReaderById(const std::string& id);
   std::shared_ptr<zim::Archive> getArchiveById(const std::string& id);
+  std::shared_ptr<ZimSearcher> getSearcherById(const std::string& id) {
+    return getSearcherByIds(BookIdSet{id});
+  }
+  std::shared_ptr<ZimSearcher> getSearcherByIds(const BookIdSet& ids);
 
   /**
    * Remove a book from the library.
@@ -351,7 +337,7 @@ class Library : private LibraryBase
    *
    * @return Current revision of the library.
    */
-  LibraryRevision getRevision() const;
+  Revision getRevision() const;
 
   /**
    * Remove books that have not been updated since the specified revision.
@@ -359,20 +345,24 @@ class Library : private LibraryBase
    * @param  rev the library revision to use
    * @return Count of books that were removed by this operation.
    */
-  uint32_t removeBooksNotUpdatedSince(LibraryRevision rev);
+  uint32_t removeBooksNotUpdatedSince(Revision rev);
 
   friend class OPDSDumper;
   friend class libXMLDumper;
 
 private: // types
   typedef const std::string& (Book::*BookStrPropMemFn)() const;
+  struct Impl;
 
 private: // functions
   AttributeCounts getBookAttributeCounts(BookStrPropMemFn p) const;
   std::vector<std::string> getBookPropValueSet(BookStrPropMemFn p) const;
   BookIdCollection filterViaBookDB(const Filter& filter) const;
   void updateBookDB(const Book& book);
-  void dropReader(const std::string& bookId);
+  void dropCache(const std::string& bookId);
+
+private: //data
+  std::unique_ptr<Impl> mp_impl;
 };
 
 }

include/manager.h

@@ -22,7 +22,6 @@
 
 #include "book.h"
 #include "library.h"
-#include "reader.h"
 
 #include <string>
 #include <vector>

include/meson.build

@@ -7,9 +7,6 @@ headers = [
   'libxml_dumper.h',
   'opds_dumper.h',
   'downloader.h',
-  'reader.h',
-  'entry.h',
-  'searcher.h',
   'search_renderer.h',
   'server.h',
   'kiwixserve.h',

include/opds_dumper.h

@@ -27,7 +27,6 @@
 #include <pugixml.hpp>
 
 #include "library.h"
-#include "reader.h"
 
 using namespace std;
 

include/reader.h

@@ -1,506 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_READER_H
-#define KIWIX_READER_H
-
-#include <stdio.h>
-#include <zim/zim.h>
-#include <zim/archive.h>
-#include <exception>
-#include <map>
-#include <sstream>
-#include <string>
-#include "common.h"
-#include "entry.h"
-
-using namespace std;
-
-namespace kiwix
-{
-
-/**
- * The SuggestionItem is a helper class that contains the info about a single
- * suggestion item.
- */
-class SuggestionItem
-{
-  // Functions
-  public:
-    // Create a sugggestion item.
-    explicit SuggestionItem(const std::string& title, const std::string& normalizedTitle,
-                            const std::string& path, const std::string& snippet = "") :
-      title(title),
-      normalizedTitle(normalizedTitle),
-      path(path),
-      snippet(snippet) {}
-
-  public:
-    const std::string& getTitle() const           { return title;}
-    const std::string& getNormalizedTitle() const { return normalizedTitle;}
-    const std::string& getPath() const            { return path;}
-    const std::string& getSnippet() const         { return snippet;}
-
-    bool hasSnippet() const                { return !snippet.empty();}
-
-  // Data
-  private:
-    std::string title;
-    std::string normalizedTitle;
-    std::string path;
-    std::string snippet;
-};
-
-/**
- * The Reader class is the class who allow to get an entry content from a zim
- * file.
- *
- * Reader is now deprecated. Directly use `zim::Archive`.
- */
-
-using SuggestionsList_t = std::vector<SuggestionItem>;
-class Reader
-{
- public:
-  /**
-   * Create a Reader to read a zim file specified by zimFilePath.
-   *
-   * @param zimFilePath The path to the zim file to read.
-   *                    The zim file can be splitted (.zimaa, .zimab, ...).
-   *                    In this case, the file path must still point to the
-   *                    unsplitted path as if the file were not splitted
-   *                    (.zim extesion).
-   */
-  explicit DEPRECATED Reader(const string zimFilePath);
-
-   /**
-   * Create a Reader to read a zim file given by the Archive.
-   *
-   * @param archive The shared pointer to the Archive object.
-   */
-  explicit DEPRECATED Reader(const std::shared_ptr<zim::Archive> archive)
-   : Reader(archive, true) {};
-#ifndef _WIN32
-  explicit DEPRECATED Reader(int fd);
-  DEPRECATED Reader(int fd, zim::offset_type offset, zim::size_type size);
-#endif
-  ~Reader() = default;
-
-  /**
-   * Get the number of "displayable" entries in the zim file.
-   *
-   * @return If the zim file has a /M/Counter metadata, return the number of
-   *         entries with the 'text/html' MIMEtype specified in the metadata.
-   *         Else return the number of entries in the 'A' namespace.
-   */
-  unsigned int getArticleCount() const;
-
-  /**
-   * Get the number of media in the zim file.
-   *
-   * @return If the zim file has a /M/Counter metadata, return the number of
-   *         entries with the 'image/jpeg', 'image/gif' and 'image/png' in
-   *         the metadata.
-   *         Else return the number of entries in the 'I' namespace.
-   */
-  unsigned int getMediaCount() const;
-
-  /**
-   * Get the number of all entries in the zim file.
-   *
-   * @return Return the number of all the entries, whatever their MIMEtype or
-   *         their namespace.
-   */
-  unsigned int getGlobalCount() const;
-
-  /**
-   * Get the path of the zim file.
-   *
-   * @return the path of the zim file as given in the constructor.
-   */
-  string getZimFilePath() const;
-
-  /**
-   * Get the Id of the zim file.
-   *
-   * @return The uuid stored in the zim file.
-   */
-  string getId() const;
-
-  /**
-   * Get a random page.
-   *
-   * @return A random Entry. The entry is picked from all entries in
-   *         the 'A' namespace.
-   *         The main entry is excluded from the potential results.
-   */
-  Entry getRandomPage() const;
-
-  /**
-   * Get the entry of the main page.
-   *
-   * @return Entry of the main page as specified in the zim file.
-   */
-  Entry getMainPage() const;
-
-  /**
-   * Get the content of a metadata.
-   *
-   * @param[in]  name The name of the metadata.
-   * @param[out] value The value will be set to the content of the metadata.
-   * @return True if it was possible to get the content of the metadata.
-   */
-  bool getMetadata(const string& name, string& value) const;
-
-  /**
-   * Get the name of the zim file.
-   *
-   * @return The name of the zim file as specified in the zim metadata.
-   */
-  string getName() const;
-
-  /**
-   * Get the title of the zim file.
-   *
-   * @return The title of zim file as specified in the zim metadata.
-   *         If no title has been set, return a title computed from the
-   *         file path.
-   */
-  string getTitle() const;
-
-  /**
-   * Get the creator of the zim file.
-   *
-   * @return The creator of the zim file as specified in the zim metadata.
-   */
-  string getCreator() const;
-
-  /**
-   * Get the publisher of the zim file.
-   *
-   * @return The publisher of the zim file as specified in the zim metadata.
-   */
-  string getPublisher() const;
-
-  /**
-   * Get the date of the zim file.
-   *
-   * @return The date of the zim file as specified in the zim metadata.
-   */
-  string getDate() const;
-
-  /**
-   * Get the description of the zim file.
-   *
-   * @return The description of the zim file as specified in the zim metadata.
-   *         If no description has been set, return the subtitle.
-   */
-  string getDescription() const;
-
-  /**
-   * Get the long description of the zim file.
-   *
-   * @return The long description of the zim file as specifed in the zim metadata.
-   */
-  string getLongDescription() const;
-
-  /**
-   * Get the language of the zim file.
-   *
-   * @return The language of the zim file as specified in the zim metadata.
-   */
-  string getLanguage() const;
-
-  /**
-   * Get the license of the zim file.
-   *
-   * @return The license of the zim file as specified in the zim metadata.
-   */
-  string getLicense() const;
-
-  /**
-   * Get the tags of the zim file.
-   *
-   * @param original If true, return the original tags as specified in the zim metadata.
-   *                 Else, try to convert it to the new 'normalized' format.
-   * @return The tags of the zim file.
-   */
-  string getTags(bool original=false) const;
-
-  /**
-   * Get the value (as a string) of a specific tag.
-   *
-   * According to https://wiki.openzim.org/wiki/Tags
-   *
-   * @return The value of the specified tag.
-   * @throw  std::out_of_range if the specified tag is not found.
-   */
-  string getTagStr(const std::string& tagName) const;
-
-  /**
-   * Get the boolean value of a specific tag.
-   *
-   * According to https://wiki.openzim.org/wiki/Tags
-   *
-   * @return The boolean value of the specified tag.
-   * @throw  std::out_of_range if the specified tag is not found.
-   *         std::domain_error if the value of the tag cannot be convert to bool.
-   */
-  bool getTagBool(const std::string& tagName) const;
-
-  /**
-   * Get the relations of the zim file.
-   *
-   * @return The relation of the zim file as specified in the zim metadata.
-   */
-  string getRelation() const;
-
-  /**
-   * Get the flavour of the zim file.
-   *
-   * @return The flavour of the zim file as specified in the zim metadata.
-   */
-  string getFlavour() const;
-
-  /**
-   * Get the source of the zim file.
-   *
-   * @return The source of the zim file as specified in the zim metadata.
-   */
-  string getSource() const;
-
-  /**
-   * Get the scraper of the zim file.
-   *
-   * @return The scraper of the zim file as specified in the zim metadata.
-   */
-  string getScraper() const;
-
-  /**
-   * Get the favicon of the zim file.
-   *
-   * @param[out] content The content of the favicon.
-   * @param[out] mimeType The mimeType of the favicon.
-   * @return True if a favicon has been found.
-   */
-  bool getFavicon(string& content, string& mimeType) const;
-
-  /**
-   * Get an entry associated to an path.
-   *
-   * @param path The path of the entry.
-   * @return The entry.
-   * @throw NoEntry If no entry correspond to the path.
-   */
-  Entry getEntryFromPath(const std::string& path) const;
-
-  /**
-   * Get an entry associated to an url encoded path.
-   *
-   * Equivalent to `getEntryFromPath(urlDecode(path));`
-   *
-   * @param path The url encoded path.
-   * @return The entry.
-   * @throw NoEntry If no entry correspond to the path.
-   */
-  Entry getEntryFromEncodedPath(const std::string& path) const;
-
-  /**
-   * Get un entry associated to a title.
-   *
-   * @param title The title.
-   * @return The entry
-   * throw NoEntry If no entry correspond to the url.
-   */
-  Entry getEntryFromTitle(const std::string& title) const;
-
-  /**
-   * Search for entries with title starting with prefix (case sensitive).
-   *
-   * Suggestions are stored in an internal vector and can be retrieved using
-   * `getNextSuggestion` method.
-   * This method is not thread safe and is deprecated. Use :
-   * bool searchSuggestions(const string& prefix,
-   *                        unsigned int suggestionsCount,
-   *                        SuggestionsList_t& results);
-   *
-   * @param prefix The prefix to search.
-   * @param suggestionsCount How many suggestions to search for.
-   * @param reset If true, remove previous suggestions in the internal vector.
-   *              If false, add suggestions to the internal vector
-   *              (until internal vector size is suggestionCount (or no more
-   *               suggestion))
-   * @return True if some suggestions have been added to the internal vector.
-   */
-  DEPRECATED bool searchSuggestions(const string& prefix,
-                         unsigned int suggestionsCount,
-                         const bool reset = true);
-
-  /**
-   * Search for entries with title starting with prefix (case sensitive).
-   *
-   * Suggestions are added to the `result` vector.
-   *
-   * @param prefix The prefix to search.
-   * @param suggestionsCount How many suggestions to search for.
-   * @param result The vector where to store the suggestions.
-   * @return True if some suggestions have been added to the vector.
-   */
-
-  bool searchSuggestions(const string& prefix,
-                         unsigned int suggestionsCount,
-                         SuggestionsList_t& resuls);
-
-  /**
-   * Search for entries for the given prefix.
-   *
-   * If the zim file has a internal fulltext index, the suggestions will be
-   * searched using it.
-   * Else the suggestions will be search using `searchSuggestions` while trying
-   * to be smart about case sensitivity (using `getTitleVariants`).
-   *
-   * In any case, suggestions are stored in an internal vector and can be
-   * retrieved using `getNextSuggestion` method.
-   * The internal vector will be reset.
-   * This method is not thread safe and is deprecated. Use :
-   * bool searchSuggestionsSmart(const string& prefix,
-   *                             unsigned int suggestionsCount,
-   *                             SuggestionsList_t& results);
-   *
-   * @param prefix The prefix to search for.
-   * @param suggestionsCount How many suggestions to search for.
-   */
-  DEPRECATED bool searchSuggestionsSmart(const string& prefix,
-                              unsigned int suggestionsCount);
-
-  /**
-   * Search for entries for the given prefix.
-   *
-   * If the zim file has a internal fulltext index, the suggestions will be
-   * searched using it.
-   * Else the suggestions will be search using `searchSuggestions` while trying
-   * to be smart about case sensitivity (using `getTitleVariants`).
-   *
-   * In any case, suggestions are stored in an internal vector and can be
-   * retrieved using `getNextSuggestion` method.
-   * The internal vector will be reset.
-   *
-   * @param prefix The prefix to search for.
-   * @param suggestionsCount How many suggestions to search for.
-   * @param results The vector where to store the suggestions
-   * @return True if some suggestions have been added to the results.
-   */
-   bool searchSuggestionsSmart(const string& prefix,
-                              unsigned int suggestionsCount,
-                              SuggestionsList_t& results);
-
-
-  /**
-   * Check if the path exists in the zim file.
-   *
-   * @param path the path to check.
-   * @return True if the path exists in the zim file.
-   */
-  bool pathExists(const string& path) const;
-
-  /**
-   * Check if the zim file has a embedded fulltext index.
-   *
-   * @return True if the zim file has a embedded fulltext index
-   *         and is not split (else the fulltext is not accessible).
-   */
-  bool hasFulltextIndex() const;
-
-  /**
-   * Get potential case title variations for a title.
-   *
-   * @param title a title.
-   * @return the list of variantions.
-   */
-  std::vector<std::string> getTitleVariants(const std::string& title) const;
-
-  /**
-   * Get the next suggestion title.
-   *
-   * @param[out] title the title of the suggestion.
-   * @return True if title has been set.
-   */
-  DEPRECATED bool getNextSuggestion(string& title);
-
-  /**
-   * Get the next suggestion title and url.
-   *
-   * @param[out] title the title of the suggestion.
-   * @param[out] url the url of the suggestion.
-   * @return True if title and url have been set.
-   */
-  DEPRECATED bool getNextSuggestion(string& title, string& url);
-
-  /**
-   * Get if we can check zim file integrity (has a checksum).
-   *
-   * @return True if zim file have a checksum.
-   */
-  bool canCheckIntegrity() const;
-
-  /**
-   * Check is zim file is corrupted.
-   *
-   * @return True if zim file is corrupted.
-   */
-  bool isCorrupted() const;
-
-  /**
-   * Return the total size of the zim file.
-   *
-   * If zim file is split, return the sum of all parts' size.
-   *
-   * @return Size of the size file is KiB.
-   */
-  unsigned int getFileSize() const;
-
-  /**
-   * Get the zim file handler.
-   *
-   * @return The libzim file handler.
-   */
-  zim::Archive* getZimArchive() const;
-
- protected:
-  std::shared_ptr<zim::Archive> zimArchive;
-  std::string zimFilePath;
-
-  SuggestionsList_t suggestions;
-  SuggestionsList_t::iterator suggestionsOffset;
-
- private:
-  std::map<const std::string, unsigned int> parseCounterMetadata() const;
-
-  // Reader is deprecated, so we've marked the constructor as deprecated.
-  // But we still need to construct the reader (in our deprecated code)
-  // To avoid warning because we use deprecated function, we create a
-  // constructor not deprecated. The `bool marker` is unused, it sole purpose
-  // is to change the signature to have a different constructor.
-  // This one is not deprecated and we must use it in our private code.
-  Reader(const std::shared_ptr<zim::Archive> archive, bool marker);
-  friend class Library;
-};
-}
-
-#endif

include/search_renderer.h

@@ -27,7 +27,6 @@
 namespace kiwix
 {
 
-class Searcher;
 class NameMapper;
 /**
  * The SearcherRenderer class is used to render a search result to a html page.
@@ -35,17 +34,6 @@ class NameMapper;
 class SearchRenderer
 {
  public:
-  /**
-   * Construct a SearchRenderer from a Searcher.
-   *
-   * This method is now deprecated. Construct the renderer from a
-   * `zim::SearchResultSet`
-   *
-   * @param searcher The `Searcher` to render.
-   * @param mapper The `NameMapper` to use to do the rendering.
-   */
-  DEPRECATED SearchRenderer(Searcher* searcher, NameMapper* mapper);
-
   /**
    * Construct a SearchRenderer from a SearchResultSet.
    *
@@ -75,12 +63,15 @@ class SearchRenderer
 
   ~SearchRenderer();
 
+  /**
+   * Set the search pattern used to do the search
+   */
   void setSearchPattern(const std::string& pattern);
 
   /**
-   * Set the search content id.
+   * Set the querystring used to select books
    */
-  void setSearchContent(const std::string& name);
+  void setSearchBookQuery(const std::string& bookQuery);
 
   /**
    * Set protocol prefix.
@@ -99,17 +90,25 @@ class SearchRenderer
     this->pageLength  = pageLength;
   }
 
+  std::string renderTemplate(const std::string& tmpl_str);
+
   /**
    * Generate the html page with the resutls of the search.
    */
   std::string getHtml();
 
+    /**
+   * Generate the xml page with the resutls of the search.
+   */
+  std::string getXml();
+
+
  protected:
   std::string beautifyInteger(const unsigned int number);
   zim::SearchResultSet m_srs;
   NameMapper* mp_nameMapper;
   Library* mp_library;
-  std::string searchContent;
+  std::string searchBookQuery;
   std::string searchPattern;
   std::string protocolPrefix;
   std::string searchProtocolPrefix;

include/searcher.h

@@ -1,180 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_SEARCHER_H
-#define KIWIX_SEARCHER_H
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <unicode/putil.h>
-#include <algorithm>
-#include <cctype>
-#include <locale>
-#include <string>
-#include <memory>
-#include <vector>
-
-#include <zim/search.h>
-
-using namespace std;
-
-namespace kiwix
-{
-class Reader;
-class Result
-{
- public:
-  virtual ~Result(){};
-  virtual std::string get_url() = 0;
-  virtual std::string get_title() = 0;
-  virtual int get_score() = 0;
-  virtual std::string get_snippet() = 0;
-  virtual std::string get_content() = 0;
-  virtual int get_wordCount() = 0;
-  virtual int get_size() = 0;
-  virtual std::string get_zimId() = 0;
-};
-
-struct SearcherInternal;
-struct SuggestionInternal;
-/**
- * The Searcher class is reponsible to do different kind of search using the
- * fulltext index.
- *
- * The Searcher is now deprecated. Use libzim search feature.
- */
-class Searcher
-{
- public:
-  /**
-   * The default constructor.
-   */
-  DEPRECATED Searcher();
-
-  ~Searcher();
-
-  /**
-   * Add a reader (containing embedded fulltext index) to the search.
-   *
-   * @param reader The Reader for the zim containing the fulltext index.
-   * @return true if the reader has been added.
-   *         false if the reader cannot be added (no embedded fulltext index present)
-   */
-  bool add_reader(Reader* reader);
-
-
-  Reader* get_reader(int index);
-
-  /**
-   * Start a search on the zim associated to the Searcher.
-   *
-   * Search results should be retrived using the getNextResult method.
-   *
-   * @param search The search query.
-   * @param resultStart the start offset of the search results (used for pagination).
-   * @param maxResultCount Maximum results to get from start (used for pagination).
-   * @param verbose print some info on stdout if true.
-   */
-  void search(const std::string& search,
-              unsigned int resultStart,
-              unsigned int maxResultCount,
-              const bool verbose = false);
-
-  /**
-   * Start a geographique search.
-   * The search return result for entry in a disc of center latitude/longitude
-   * and radius distance.
-   *
-   * Search results should be retrived using the getNextResult method.
-   *
-   * @param latitude The latitude of the center point.
-   * @param longitude The longitude of the center point.
-   * @param distance The radius of the disc.
-   * @param resultStart the start offset of the search results (used for pagination).
-   * @param maxResultCount Maximum number of results to get from start (used for pagination).
-   * @param verbose print some info on stdout if true.
-   */
-  void geo_search(float latitude, float longitude, float distance,
-                  unsigned int resultStart,
-                  unsigned int maxResultCount,
-                  const bool verbose = false);
-
-  /**
-   * Start a suggestion search.
-   * The search made depend of the "version" of the embedded index.
-   *  - If the index is newer enough and have a title namespace, the search is
-   *    made in the titles only.
-   *  - Else the search is made on the whole article content.
-   * In any case, the search is made "partial" (as adding '*' at the end of the query)
-   *
-   * @param search The search query.
-   * @param verbose print some info on stdout if true.
-   */
-  void suggestions(std::string& search, const bool verbose = false);
-
-  /**
-   * Get the next result of a started search.
-   * This is the method to use to loop hover the search results.
-   */
-  Result* getNextResult();
-
-  /**
-   * Restart the previous search.
-   * Next call to getNextResult will return the first result.
-   */
-  void restart_search();
-
-  /**
-   * Get a estimation of the result count.
-   */
-  unsigned int getEstimatedResultCount();
-
-  /**
-   * Get a SearchResultSet object for current search
-   */
-  zim::SearchResultSet getSearchResultSet();
-
-  unsigned int getResultStart() { return resultStart; }
-  unsigned int getMaxResultCount() { return maxResultCount; }
-
- protected:
-  std::string beautifyInteger(const unsigned int number);
-  void closeIndex();
-  void searchInIndex(string& search,
-                     const unsigned int resultStart,
-                     const unsigned int maxResultCount,
-                     const bool verbose = false);
-
-  std::vector<Reader*> readers;
-  std::unique_ptr<SearcherInternal> internal;
-  std::unique_ptr<SuggestionInternal> suggestionInternal;
-  std::string searchPattern;
-  unsigned int estimatedResultCount;
-  unsigned int resultStart;
-  unsigned int maxResultCount;
-
- private:
-  void reset();
-
-};
-
-
-}
-
-#endif

include/server.h

@@ -54,6 +54,7 @@ namespace kiwix
        void setAddress(const std::string& addr) { m_addr = addr; }
        void setPort(int port) { m_port = port; }
        void setNbThreads(int threads) { m_nbThreads = threads; }
+       void setMultiZimSearchLimit(unsigned int limit) { m_multizimSearchLimit = limit; }
        void setIpConnectionLimit(int limit) { m_ipConnectionLimit = limit; }
        void setVerbose(bool verbose) { m_verbose = verbose; }
        void setIndexTemplateString(const std::string& indexTemplateString) { m_indexTemplateString = indexTemplateString; }
@@ -63,7 +64,7 @@ namespace kiwix
         { m_blockExternalLinks = blockExternalLinks; }
        int getPort();
        std::string getAddress();
-       
+
      protected:
        Library* mp_library;
        NameMapper* mp_nameMapper;
@@ -72,6 +73,7 @@ namespace kiwix
        std::string m_indexTemplateString = "";
        int m_port = 80;
        int m_nbThreads = 1;
+       unsigned int m_multizimSearchLimit = 0;
        bool m_verbose = false;
        bool m_withTaskbar = true;
        bool m_withLibraryButton = true;

include/version.h

@@ -22,6 +22,7 @@
 
 #include <string>
 #include <vector>
+#include <iostream>
 
 namespace kiwix
 {

meson.build

@@ -1,26 +1,17 @@
 project('libkiwix', 'cpp',
-  version : '10.1.1', # Also change this in android-kiwix-lib-publisher/kiwixLibAndroid/build.gradle
+  version : '11.0.0',
   license : 'GPLv3+',
   default_options : ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
 
 compiler = meson.get_compiler('cpp')
 
-wrapper = get_option('wrapper')
-
-static_deps = wrapper.contains('android') or wrapper.contains('java') or get_option('default_library') == 'static'
-if wrapper.contains('android')
-  extra_libs = ['-llog']
-else
-  extra_libs = []
-endif
-
-if wrapper.contains('java')
-  add_languages('java')
-endif
+static_deps = get_option('static-linkage') or get_option('default_library') == 'static'
 
 # See https://github.com/kiwix/libkiwix/issues/371
 if ['arm', 'mips', 'm68k', 'ppc', 'sh4'].contains(host_machine.cpu_family())
-  extra_libs += '-latomic'
+  extra_libs = ['-latomic']
+else
+  extra_libs = []
 endif
 
 if (compiler.get_id() == 'gcc' and build_machine.system() == 'linux') or host_machine.system() == 'freebsd'

meson_options.txt

@@ -1,4 +1,4 @@
-option('wrapper', type:'array', choices:['java', 'android'], value:[],
-  description: 'The wrapper to generate.')
+option('static-linkage', type : 'boolean', value : false,
+  description : 'Link statically with the dependencies.')
 option('doc', type : 'boolean', value : false,
   description : 'Build the documentations.')

scripts/kiwix-compile-i18n

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+
+'''
+Copyright 2022 Veloman Yunkan <veloman.yunkan@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or any
+later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301, USA.
+'''
+
+import argparse
+import os.path
+import re
+import json
+
+def to_identifier(name):
+    ident = re.sub(r'[^0-9a-zA-Z]', '_', name)
+    if ident[0].isnumeric():
+        return "_"+ident
+    return ident
+
+def lang_code(filename):
+    filename = os.path.basename(filename)
+    lang = to_identifier(os.path.splitext(filename)[0])
+    print(filename, '->', lang)
+    return lang
+
+from string import Template
+
+def expand_cxx_template(t, **kwargs):
+    return Template(t).substitute(**kwargs)
+
+def cxx_string_literal(s):
+    # Taking advantage of the fact the JSON string escape rules match
+    # those of C++
+    return 'u8' + json.dumps(s)
+
+string_table_cxx_template = '''
+const I18nString $TABLE_NAME[] = {
+  $TABLE_ENTRIES
+};
+'''
+
+lang_table_entry_cxx_template = '''
+    {
+        $LANG_STRING_LITERAL,
+        ARRAY_ELEMENT_COUNT($STRING_TABLE_NAME),
+        $STRING_TABLE_NAME
+    }'''
+
+cxxfile_template = '''// This file is automatically generated. Do not modify it.
+
+#include "server/i18n.h"
+
+namespace kiwix {
+namespace i18n {
+
+namespace
+{
+
+$STRING_DATA
+
+} // unnamed namespace
+
+#define ARRAY_ELEMENT_COUNT(a) (sizeof(a)/sizeof(a[0]))
+
+extern const I18nStringTable stringTables[] = {
+  $LANG_TABLE
+};
+
+extern const size_t langCount = $LANG_COUNT;
+
+} // namespace i18n
+} // namespace kiwix
+'''
+
+class Resource:
+    def __init__(self, filename):
+        filename = filename.strip()
+        self.filename = filename
+        self.lang_code = lang_code(filename)
+        with open(filename, 'r', encoding='utf-8') as f:
+            self.data = f.read()
+
+    def get_string_table_name(self):
+        return "string_table_for_" + self.lang_code
+
+    def get_string_table(self):
+        table_entries = ",\n  ".join(self.get_string_table_entries())
+        return expand_cxx_template(string_table_cxx_template,
+                    TABLE_NAME=self.get_string_table_name(),
+                    TABLE_ENTRIES=table_entries)
+
+    def get_string_table_entries(self):
+        d = json.loads(self.data)
+        for k in sorted(d.keys()):
+            if k != "@metadata":
+                key_string = cxx_string_literal(k)
+                value_string = cxx_string_literal(d[k])
+                yield '{ ' + key_string + ', ' + value_string + ' }'
+
+    def get_lang_table_entry(self):
+        return expand_cxx_template(lang_table_entry_cxx_template,
+                LANG_STRING_LITERAL=cxx_string_literal(self.lang_code),
+                STRING_TABLE_NAME=self.get_string_table_name())
+
+
+
+def gen_c_file(resources):
+    string_data = []
+    lang_table = []
+    for r in resources:
+        string_data.append(r.get_string_table())
+        lang_table.append(r.get_lang_table_entry())
+
+    return expand_cxx_template(cxxfile_template,
+                STRING_DATA="\n".join(string_data),
+                LANG_TABLE=",\n  ".join(lang_table),
+                LANG_COUNT=len(resources)
+           )
+
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--cxxfile',
+                        required=True,
+                        help='The Cpp file name to generate')
+    parser.add_argument('i18n_resource_files', nargs='+',
+                        help='The list of resources to compile.')
+    args = parser.parse_args()
+
+    resources = [Resource(filename) for filename in args.i18n_resource_files]
+
+    with open(args.cxxfile, 'w') as f:
+        f.write(gen_c_file(resources))
+

scripts/kiwix-compile-i18n.1

@@ -0,0 +1,18 @@
+.TH KIWIX-COMPILE-I18N "1" "January 2022" "Kiwix" "User Commands"
+.SH NAME
+kiwix-compile-i18n \- helper to compile Kiwix i18n (internationalization) data
+.SH SYNOPSIS
+\fBkiwix\-compile\-i18n\fR [\-h] \-\-cxxfile CXXFILE i18n_resource_files ...\fR
+.SH DESCRIPTION
+.TP
+i18n_resource_files ...
+The list of i18n resources to compile.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show a help message and exit
+.TP
+\fB\-\-cxxfile\fR CXXFILE
+The Cpp file name to generate
+.TP
+.SH AUTHOR
+Veloman Yunkan <veloman.yunkan@gmail.com>

scripts/kiwix-compile-resources

@@ -102,7 +102,7 @@ class Resource:
 
 
 
-master_c_template = """//This file is automaically generated. Do not modify it.
+master_c_template = """//This file is automatically generated. Do not modify it.
 
 #include <stdlib.h>
 #include <fstream>

scripts/kiwix-resources

@@ -0,0 +1,127 @@
+#!/usr/bin/env python3
+
+'''
+Copyright 2022 Veloman Yunkan <veloman.yunkan@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or any
+later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301, USA.
+'''
+
+import argparse
+import hashlib
+import os.path
+import re
+
+def read_resource_file(resource_file_path):
+    with open(resource_file_path, 'r') as f:
+        return [line.strip() for line in f]
+
+def list_resources(resource_file_path):
+    for resource_path in read_resource_file(resource_file_path):
+        print(resource_path)
+
+def compute_resource_revision(resource_path):
+    with open(os.path.join(OUT_DIR, resource_path), 'rb') as f:
+        return hashlib.sha1(f.read()).hexdigest()[:8]
+
+resource_revisions = {}
+
+def get_resource_revision(res):
+    if not res in resource_revisions:
+        preprocess_resource(res)
+        resource_revisions[res] = compute_resource_revision(res)
+    return resource_revisions[res]
+
+RESOURCE_WITH_CACHEID_URL_PATTERN=r'(?P<pre>.*/(?P<resource>skin/[^"?]+)\?)KIWIXCACHEID(?P<post>[^"]*)'
+
+def set_cacheid(resource_matchobj):
+    pre = resource_matchobj.group('pre')
+    resource = resource_matchobj.group('resource')
+    post = resource_matchobj.group('post')
+    cacheid = 'cacheid=' + get_resource_revision(resource)
+    return pre + cacheid + post
+
+def preprocess_text(s):
+    if 'KIWIXCACHEID' in s:
+        s = re.sub(RESOURCE_WITH_CACHEID_URL_PATTERN, set_cacheid, s)
+        assert not 'KIWIXCACHEID' in s
+    return s
+
+def get_preprocessed_resource(srcpath):
+    """Get the transformed content of a resource
+
+    If the resource at srcpath is modified by preprocessing then this function
+    returns the transformed content of the resource. Otherwise it returns None.
+    """
+    try:
+        with open(srcpath, 'r') as resource_file:
+            content = resource_file.read()
+            preprocessed_content = preprocess_text(content)
+        return preprocessed_content if preprocessed_content != content else None
+    except UnicodeDecodeError:
+        # It was a binary resource
+        return None
+
+
+def symlink_resource(src, resource_path):
+    if os.path.exists(resource_path):
+        if os.path.islink(resource_path) and os.readlink(resource_path) == src:
+            return
+        os.remove(resource_path)
+    os.symlink(src, resource_path)
+
+def preprocess_resource(resource_path):
+    print('Preprocessing', resource_path, '...')
+    resource_dir = os.path.dirname(resource_path)
+    if resource_dir != '':
+        os.makedirs(os.path.join(OUT_DIR, resource_dir), exist_ok=True)
+    srcpath = os.path.join(BASE_DIR, resource_path)
+    outpath = os.path.join(OUT_DIR, resource_path)
+    if os.path.exists(outpath):
+        os.remove(outpath)
+    preprocessed_content = get_preprocessed_resource(srcpath)
+    if preprocessed_content is None:
+        symlink_resource(srcpath, outpath)
+    else:
+        with open(outpath, 'w') as target:
+            print(preprocessed_content, end='', file=target)
+
+
+def copy_file(src_path, dst_path):
+    with open(src_path, 'rb') as src:
+        with open(dst_path, 'wb') as dst:
+            dst.write(src.read())
+
+def preprocess_resources(resource_file_path):
+    resource_filename = os.path.basename(resource_file_path)
+    for resource in read_resource_file(resource_file_path):
+        preprocess_resource(resource)
+    copy_file(resource_file_path, os.path.join(OUT_DIR, resource_filename))
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    commands = parser.add_mutually_exclusive_group()
+    commands.add_argument('--list-all', action='store_true')
+    commands.add_argument('--preprocess', action='store_true')
+    parser.add_argument('--outdir')
+    parser.add_argument('resource_file')
+    args = parser.parse_args()
+    BASE_DIR = os.path.dirname(os.path.realpath(args.resource_file))
+    OUT_DIR = args.outdir
+
+    if args.list_all:
+        list_resources(args.resource_file)
+    elif args.preprocess:
+        preprocess_resources(args.resource_file)

scripts/meson.build

@@ -1,6 +1,13 @@
 
+res_manager = find_program('kiwix-resources')
 res_compiler = find_program('kiwix-compile-resources')
 
 install_data(res_compiler.path(), install_dir:get_option('bindir'))
 
 install_man('kiwix-compile-resources.1')
+
+i18n_compiler = find_program('kiwix-compile-i18n')
+
+install_data(i18n_compiler.path(), install_dir:get_option('bindir'))
+
+install_man('kiwix-compile-i18n.1')

src/book.cpp

@@ -18,7 +18,6 @@
  */
 
 #include "book.h"
-#include "reader.h"
 
 #include "tools.h"
 #include "tools/base64.h"
@@ -30,7 +29,7 @@
 #include "tools/archiveTools.h"
 
 #include <zim/archive.h>
-
+#include <zim/item.h>
 #include <pugixml.hpp>
 
 namespace kiwix
@@ -64,11 +63,6 @@ bool Book::update(const kiwix::Book& other)
   return true;
 }
 
-void Book::update(const kiwix::Reader& reader)
-{
-  update(*reader.getZimArchive());
-}
-
 void Book::update(const zim::Archive& archive) {
   m_path = archive.getFilename();
   m_pathValid = true;

src/entry.cpp

@@ -1,73 +0,0 @@
-/*
- * Copyright 2018-2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "reader.h"
-#include <time.h>
-
-namespace kiwix
-{
-
-Entry::Entry(zim::Entry entry, bool _marker)
-  : entry(entry)
-{
-}
-
-size_type Entry::getSize() const
-{
-  if (entry.isRedirect()) {
-    return 0;
-  } else {
-    return entry.getItem().getSize();
-  }
-}
-
-std::string Entry::getMimetype() const
-{
-  return entry.getItem(true).getMimetype();
-}
-
-bool Entry::isRedirect() const
-{
-  return entry.isRedirect();
-}
-
-Entry Entry::getRedirectEntry() const
-{
-  if ( !entry.isRedirect() ) {
-    throw NoEntry();
-  }
-
-  return Entry(entry.getRedirectEntry(), true);
-}
-
-Entry Entry::getFinalEntry() const
-{
-  int loopCounter = 42;
-  auto final_entry = entry;
-  while (final_entry.isRedirect() && loopCounter--) {
-    final_entry = final_entry.getRedirectEntry();
-  }
-  // Prevent infinite loops.
-  if (final_entry.isRedirect()) {
-    throw NoEntry();
-  }
-  return Entry(final_entry, true);
-}
-
-}

src/library.cpp

@@ -19,7 +19,6 @@
 
 #include "library.h"
 #include "book.h"
-#include "reader.h"
 #include "libxml_dumper.h"
 
 #include "tools.h"
@@ -27,10 +26,13 @@
 #include "tools/regexTools.h"
 #include "tools/pathTools.h"
 #include "tools/stringTools.h"
+#include "tools/otherTools.h"
+#include "tools/concurrent_cache.h"
 
 #include <pugixml.hpp>
 #include <algorithm>
 #include <set>
+#include <cmath>
 #include <unicode/locid.h>
 #include <xapian.h>
 
@@ -56,68 +58,129 @@ bool booksReferToTheSameArchive(const Book& book1, const Book& book2)
       && book1.getPath() == book2.getPath();
 }
 
-} // unnamed namespace
-
-class LibraryBase::BookDB : public Xapian::WritableDatabase
+template<typename Key, typename Value>
+class MultiKeyCache: public ConcurrentCache<std::set<Key>, Value>
 {
-public:
-  BookDB() : Xapian::WritableDatabase("", Xapian::DB_BACKEND_INMEMORY) {}
+  public:
+    explicit MultiKeyCache(size_t maxEntries)
+      : ConcurrentCache<std::set<Key>, Value>(maxEntries)
+    {}
+
+    bool drop(const Key& key)
+    {
+      std::unique_lock<std::mutex> l(this->lock_);
+      bool removed = false;
+      for(auto& cache_key: this->impl_.keys()) {
+        if(cache_key.find(key)!=cache_key.end()) {
+          removed |= this->impl_.drop(cache_key);
+        }
+      }
+      return removed;
+    }
 };
 
-LibraryBase::LibraryBase()
-  : m_bookDB(new BookDB)
+} // unnamed namespace
+
+struct Library::Impl
+{
+  struct Entry : Book
+  {
+    Library::Revision lastUpdatedRevision = 0;
+  };
+
+  Library::Revision m_revision;
+  std::map<std::string, Entry> m_books;
+  using ArchiveCache = ConcurrentCache<std::string, std::shared_ptr<zim::Archive>>;
+  std::unique_ptr<ArchiveCache> mp_archiveCache;
+  using SearcherCache = MultiKeyCache<std::string, std::shared_ptr<ZimSearcher>>;
+  std::unique_ptr<SearcherCache> mp_searcherCache;
+  std::vector<kiwix::Bookmark> m_bookmarks;
+  Xapian::WritableDatabase m_bookDB;
+
+  unsigned int getBookCount(const bool localBooks, const bool remoteBooks) const;
+
+  Impl();
+  ~Impl();
+
+  Impl(Impl&& );
+  Impl& operator=(Impl&& );
+};
+
+Library::Impl::Impl()
+  : mp_archiveCache(new ArchiveCache(std::max(getEnvVar<int>("KIWIX_ARCHIVE_CACHE_SIZE", 1), 1))),
+    mp_searcherCache(new SearcherCache(std::max(getEnvVar<int>("KIWIX_SEARCHER_CACHE_SIZE", 1), 1))),
+    m_bookDB("", Xapian::DB_BACKEND_INMEMORY)
 {
 }
 
-LibraryBase::~LibraryBase()
+Library::Impl::~Impl()
 {
 }
 
-LibraryBase::LibraryBase(LibraryBase&& ) = default;
-LibraryBase& LibraryBase::operator=(LibraryBase&& ) = default;
+Library::Impl::Impl(Library::Impl&& ) = default;
+Library::Impl& Library::Impl::operator=(Library::Impl&& ) = default;
+
+unsigned int
+Library::Impl::getBookCount(const bool localBooks, const bool remoteBooks) const
+{
+  unsigned int result = 0;
+  for (auto& pair: m_books) {
+    auto& book = pair.second;
+    if ((!book.getPath().empty() && localBooks)
+        || (!book.getUrl().empty() && remoteBooks)) {
+      result++;
+    }
+  }
+  return result;
+}
 
 /* Constructor */
 Library::Library()
+  : mp_impl(new Library::Impl)
 {
 }
 
 Library::Library(Library&& other)
-  : LibraryBase(std::move(other))
+  : mp_impl(std::move(other.mp_impl))
 {
 }
 
 Library& Library::operator=(Library&& other)
 {
-  LibraryBase::operator=(std::move(other));
+  mp_impl = std::move(other.mp_impl);
   return *this;
 }
 
 /* Destructor */
-Library::~Library()
-{
-}
-
+Library::~Library() = default;
 
 bool Library::addBook(const Book& book)
 {
   std::lock_guard<std::mutex> lock(m_mutex);
-  ++m_revision;
+  ++mp_impl->m_revision;
   /* Try to find it */
   updateBookDB(book);
   try {
-    auto& oldbook = m_books.at(book.getId());
+    auto& oldbook = mp_impl->m_books.at(book.getId());
     if ( ! booksReferToTheSameArchive(oldbook, book) ) {
-      dropReader(book.getId());
+      dropCache(book.getId());
     }
     oldbook.update(book); // XXX: This may have no effect if oldbook is readonly
                           // XXX: Then m_bookDB will become out-of-sync with
                           // XXX: the real contents of the library.
-    oldbook.lastUpdatedRevision = m_revision;
+    oldbook.lastUpdatedRevision = mp_impl->m_revision;
     return false;
   } catch (std::out_of_range&) {
-    Entry& newEntry = m_books[book.getId()];
+    auto& newEntry = mp_impl->m_books[book.getId()];
     static_cast<Book&>(newEntry) = book;
-    newEntry.lastUpdatedRevision = m_revision;
+    newEntry.lastUpdatedRevision = mp_impl->m_revision;
+    size_t new_cache_size = static_cast<size_t>(std::ceil(mp_impl->getBookCount(true, true)*0.1));
+    if (getEnvVar<int>("KIWIX_ARCHIVE_CACHE_SIZE", -1) <= 0) {
+      mp_impl->mp_archiveCache->setMaxSize(new_cache_size);
+    }
+    if (getEnvVar<int>("KIWIX_SEARCHER_CACHE_SIZE", -1) <= 0) {
+      mp_impl->mp_searcherCache->setMaxSize(new_cache_size);
+    }
     return true;
   }
 }
@@ -125,15 +188,15 @@ bool Library::addBook(const Book& book)
 void Library::addBookmark(const Bookmark& bookmark)
 {
   std::lock_guard<std::mutex> lock(m_mutex);
-  m_bookmarks.push_back(bookmark);
+  mp_impl->m_bookmarks.push_back(bookmark);
 }
 
 bool Library::removeBookmark(const std::string& zimId, const std::string& url)
 {
   std::lock_guard<std::mutex> lock(m_mutex);
-  for(auto it=m_bookmarks.begin(); it!=m_bookmarks.end(); it++) {
+  for(auto it=mp_impl->m_bookmarks.begin(); it!=mp_impl->m_bookmarks.end(); it++) {
     if (it->getBookId() == zimId && it->getUrl() == url) {
-      m_bookmarks.erase(it);
+      mp_impl->m_bookmarks.erase(it);
       return true;
     }
   }
@@ -141,32 +204,38 @@ bool Library::removeBookmark(const std::string& zimId, const std::string& url)
 }
 
 
-void Library::dropReader(const std::string& id)
+void Library::dropCache(const std::string& id)
 {
-  m_readers.erase(id);
-  m_archives.erase(id);
+  mp_impl->mp_archiveCache->drop(id);
+  mp_impl->mp_searcherCache->drop(id);
 }
 
 bool Library::removeBookById(const std::string& id)
 {
   std::lock_guard<std::mutex> lock(m_mutex);
-  m_bookDB->delete_document("Q" + id);
-  dropReader(id);
-  return m_books.erase(id) == 1;
+  mp_impl->m_bookDB.delete_document("Q" + id);
+  dropCache(id);
+  // We do not change the cache size here
+  // Most of the time, the book is remove in case of library refresh, it is
+  // often associated with addBook calls (which will properly set the cache size)
+  // Having a too big cache is not a problem here (or it would have been before)
+  // (And setMaxSize doesn't actually reduce the cache size, extra cached items
+  //  will be removed in put or getOrPut).
+  return mp_impl->m_books.erase(id) == 1;
 }
 
 Library::Revision Library::getRevision() const
 {
   std::lock_guard<std::mutex> lock(m_mutex);
-  return m_revision;
+  return mp_impl->m_revision;
 }
 
-uint32_t Library::removeBooksNotUpdatedSince(LibraryRevision libraryRevision)
+uint32_t Library::removeBooksNotUpdatedSince(Revision libraryRevision)
 {
   BookIdCollection booksToRemove;
   {
     std::lock_guard<std::mutex> lock(m_mutex);
-    for ( const auto& entry : m_books) {
+    for ( const auto& entry : mp_impl->m_books) {
       if ( entry.second.lastUpdatedRevision <= libraryRevision ) {
         booksToRemove.push_back(entry.first);
       }
@@ -185,7 +254,7 @@ const Book& Library::getBookById(const std::string& id) const
 {
   // XXX: Doesn't make sense to lock this operation since it cannot
   // XXX: guarantee thread-safety because of its return type
-  return m_books.at(id);
+  return mp_impl->m_books.at(id);
 }
 
 Book Library::getBookByIdThreadSafe(const std::string& id) const
@@ -198,7 +267,7 @@ const Book& Library::getBookByPath(const std::string& path) const
 {
   // XXX: Doesn't make sense to lock this operation since it cannot
   // XXX: guarantee thread-safety because of its return type
-  for(auto& it: m_books) {
+  for(auto& it: mp_impl->m_books) {
     auto& book = it.second;
     if (book.getPath() == path)
       return book;
@@ -208,52 +277,48 @@ const Book& Library::getBookByPath(const std::string& path) const
   throw std::out_of_range(ss.str());
 }
 
-std::shared_ptr<Reader> Library::getReaderById(const std::string& id)
-{
-  try {
-    std::lock_guard<std::mutex> lock(m_mutex);
-    return m_readers.at(id);
-  } catch (std::out_of_range& e) {}
-
-  const auto archive = getArchiveById(id);
-  if ( !archive )
-    return nullptr;
-
-  const shared_ptr<Reader> reader(new Reader(archive, true));
-  std::lock_guard<std::mutex> lock(m_mutex);
-  m_readers[id] = reader;
-  return reader;
-}
-
 std::shared_ptr<zim::Archive> Library::getArchiveById(const std::string& id)
 {
-  std::lock_guard<std::mutex> lock(m_mutex);
   try {
-    return m_archives.at(id);
-  } catch (std::out_of_range& e) {}
-
-  auto book = getBookById(id);
-  if (!book.isPathValid())
+    return mp_impl->mp_archiveCache->getOrPut(id,
+    [&](){
+      auto book = getBookById(id);
+      if (!book.isPathValid()) {
+        throw std::invalid_argument("");
+      }
+      return std::make_shared<zim::Archive>(book.getPath());
+    });
+  } catch (std::invalid_argument&) {
     return nullptr;
+  }
+}
 
-  auto sptr = make_shared<zim::Archive>(book.getPath());
-  m_archives[id] = sptr;
-  return sptr;
+std::shared_ptr<ZimSearcher> Library::getSearcherByIds(const BookIdSet& ids)
+{
+  assert(!ids.empty());
+  try {
+    return mp_impl->mp_searcherCache->getOrPut(ids,
+    [&](){
+      std::vector<zim::Archive> archives;
+      for(auto& id:ids) {
+        auto archive = getArchiveById(id);
+        if(!archive) {
+          throw std::invalid_argument("");
+        }
+        archives.push_back(*archive);
+      }
+      return std::make_shared<ZimSearcher>(zim::Searcher(archives));
+    });
+  } catch (std::invalid_argument&) {
+    return nullptr;
+  }
 }
 
 unsigned int Library::getBookCount(const bool localBooks,
                                    const bool remoteBooks) const
 {
   std::lock_guard<std::mutex> lock(m_mutex);
-  unsigned int result = 0;
-  for (auto& pair: m_books) {
-    auto& book = pair.second;
-    if ((!book.getPath().empty() && localBooks)
-        || (book.getPath().empty() && remoteBooks)) {
-      result++;
-    }
-  }
-  return result;
+  return mp_impl->getBookCount(localBooks, remoteBooks);
 }
 
 bool Library::writeToFile(const std::string& path) const
@@ -284,7 +349,7 @@ Library::AttributeCounts Library::getBookAttributeCounts(BookStrPropMemFn p) con
   std::lock_guard<std::mutex> lock(m_mutex);
   AttributeCounts propValueCounts;
 
-  for (const auto& pair: m_books) {
+  for (const auto& pair: mp_impl->m_books) {
     const auto& book = pair.second;
     if (book.getOrigId().empty()) {
       propValueCounts[(book.*p)()] += 1;
@@ -317,7 +382,7 @@ std::vector<std::string> Library::getBooksCategories() const
   std::lock_guard<std::mutex> lock(m_mutex);
   std::set<std::string> categories;
 
-  for (const auto& pair: m_books) {
+  for (const auto& pair: mp_impl->m_books) {
     const auto& book = pair.second;
     const auto& c = book.getCategory();
     if ( !c.empty() ) {
@@ -341,12 +406,12 @@ std::vector<std::string> Library::getBooksPublishers() const
 const std::vector<kiwix::Bookmark> Library::getBookmarks(bool onlyValidBookmarks) const
 {
   if (!onlyValidBookmarks) {
-    return m_bookmarks;
+    return mp_impl->m_bookmarks;
   }
   std::vector<kiwix::Bookmark> validBookmarks;
   auto booksId = getBooksIds();
   std::lock_guard<std::mutex> lock(m_mutex);
-  for(auto& bookmark:m_bookmarks) {
+  for(auto& bookmark:mp_impl->m_bookmarks) {
     if (std::find(booksId.begin(), booksId.end(), bookmark.getBookId()) != booksId.end()) {
       validBookmarks.push_back(bookmark);
     }
@@ -359,7 +424,7 @@ Library::BookIdCollection Library::getBooksIds() const
   std::lock_guard<std::mutex> lock(m_mutex);
   BookIdCollection bookIds;
 
-  for (auto& pair: m_books) {
+  for (auto& pair: mp_impl->m_books) {
     bookIds.push_back(pair.first);
   }
 
@@ -397,15 +462,20 @@ void Library::updateBookDB(const Book& book)
   indexer.index_text(normalizeText(book.getName()),      1, "XN");
   indexer.index_text(normalizeText(book.getCategory()),  1, "XC");
 
-  for ( const auto& tag : split(normalizeText(book.getTags()), ";") )
+  for ( const auto& tag : split(normalizeText(book.getTags()), ";") ) {
     doc.add_boolean_term("XT" + tag);
+    if ( tag[0] != '_' ) {
+      indexer.increase_termpos();
+      indexer.index_text(tag);
+    }
+  }
 
   const std::string idterm = "Q" + book.getId();
   doc.add_boolean_term(idterm);
 
   doc.set_data(book.getId());
 
-  m_bookDB->replace_document(idterm, doc);
+  mp_impl->m_bookDB.replace_document(idterm, doc);
 }
 
 namespace
@@ -538,9 +608,9 @@ Library::BookIdCollection Library::filterViaBookDB(const Filter& filter) const
   BookIdCollection bookIds;
 
   std::lock_guard<std::mutex> lock(m_mutex);
-  Xapian::Enquire enquire(*m_bookDB);
+  Xapian::Enquire enquire(mp_impl->m_bookDB);
   enquire.set_query(query);
-  const auto results = enquire.get_mset(0, m_books.size());
+  const auto results = enquire.get_mset(0, mp_impl->m_books.size());
   for ( auto it = results.begin(); it != results.end(); ++it  ) {
     bookIds.push_back(it.get_document().get_data());
   }
@@ -554,7 +624,7 @@ Library::BookIdCollection Library::filter(const Filter& filter) const
   const auto preliminaryResult = filterViaBookDB(filter);
   std::lock_guard<std::mutex> lock(m_mutex);
   for(auto id : preliminaryResult) {
-    if(filter.accept(m_books.at(id))) {
+    if(filter.accept(mp_impl->m_books.at(id))) {
       result.push_back(id);
     }
   }

src/meson.build

@@ -6,10 +6,7 @@ kiwix_sources = [
   'libxml_dumper.cpp',
   'opds_dumper.cpp',
   'downloader.cpp',
-  'reader.cpp',
-  'entry.cpp',
   'server.cpp',
-  'searcher.cpp',
   'search_renderer.cpp',
   'subprocess.cpp',
   'aria2.cpp',
@@ -28,10 +25,12 @@ kiwix_sources = [
   'server/response.cpp',
   'server/internalServer.cpp',
   'server/internalServer_catalog_v2.cpp',
+  'server/i18n.cpp',
   'opds_catalog.cpp',
   'version.cpp'
 ]
 kiwix_sources += lib_resources
+kiwix_sources += i18n_resources
 
 if host_machine.system() == 'windows'
   kiwix_sources += 'subprocess_windows.cpp'
@@ -39,15 +38,7 @@ else
   kiwix_sources += 'subprocess_unix.cpp'
 endif
 
-if wrapper.contains('android')
-  install_dir = 'kiwix-lib/jniLibs/' + meson.get_cross_property('android_abi')
-else
-  install_dir = get_option('libdir')
-endif
-
-if wrapper.contains('android') or wrapper.contains('java')
-  subdir('wrapper/java')
-endif
+install_dir = get_option('libdir')
 
 config_h = configure_file(output : 'kiwix_config.h',
                configuration : conf,

src/opds_dumper.cpp

@@ -22,7 +22,6 @@
 
 #include "kiwixlib-resources.h"
 #include <mustache.hpp>
-#include <unicode/locid.h>
 
 #include "tools/stringTools.h"
 #include "tools/otherTools.h"
@@ -163,14 +162,8 @@ std::once_flag fillLanguagesFlag;
 void fillLanguagesMap()
 {
   for (auto icuLangPtr = icu::Locale::getISOLanguages(); *icuLangPtr != NULL; ++icuLangPtr) {
-    auto lang = *icuLangPtr;
-    const icu::Locale locale(lang);
-    icu::UnicodeString ustring;
-    locale.getDisplayLanguage(locale, ustring);
-    std::string displayLanguage;
-    ustring.toUTF8String(displayLanguage);
-    std::string iso3LangCode = locale.getISO3Language();
-    iso639_3.insert({iso3LangCode, displayLanguage});
+    const ICULanguageInfo lang(*icuLangPtr);
+    iso639_3.insert({lang.iso3Code(), lang.selfName()});
   }
 }
 

src/reader.cpp

@@ -1,472 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "reader.h"
-#include <time.h>
-
-#include <zim/search.h>
-#include <zim/suggestion.h>
-#include <zim/item.h>
-#include <zim/error.h>
-
-#include "tools.h"
-#include "tools/stringTools.h"
-#include "tools/otherTools.h"
-#include "tools/archiveTools.h"
-
-namespace kiwix
-{
-/* Constructor */
-Reader::Reader(const string zimFilePath)
-  :  zimArchive(nullptr),
-     zimFilePath(zimFilePath)
-{
-  string tmpZimFilePath = zimFilePath;
-
-  /* Remove potential trailing zimaa */
-  size_t found = tmpZimFilePath.rfind("zimaa");
-  if (found != string::npos && tmpZimFilePath.size() > 5
-      && found == tmpZimFilePath.size() - 5) {
-    tmpZimFilePath.resize(tmpZimFilePath.size() - 2);
-  }
-
-  zimArchive.reset(new zim::Archive(tmpZimFilePath));
-
-  /* initialize random seed: */
-  srand(time(nullptr));
-}
-
-Reader::Reader(const std::shared_ptr<zim::Archive> archive, bool _marker)
-  : zimArchive(archive),
-    zimFilePath(archive->getFilename())
-  {}
-
-#ifndef _WIN32
-Reader::Reader(int fd)
-  :  zimArchive(new zim::Archive(fd)),
-     zimFilePath("")
-{
-  /* initialize random seed: */
-  srand(time(nullptr));
-}
-
-Reader::Reader(int fd, zim::offset_type offset, zim::size_type size)
-  :  zimArchive(new zim::Archive(fd, offset, size)),
-     zimFilePath("")
-{
-  /* initialize random seed: */
-  srand(time(nullptr));
-}
-#endif // #ifndef _WIN32
-
-zim::Archive* Reader::getZimArchive() const
-{
-  return zimArchive.get();
-}
-
-MimeCounterType Reader::parseCounterMetadata() const
-{
-  return kiwix::parseArchiveCounter(*zimArchive);
-}
-
-/* Get the count of articles which can be indexed/displayed */
-unsigned int Reader::getArticleCount() const
-{
-  std::map<const std::string, unsigned int> counterMap
-      = this->parseCounterMetadata();
-  unsigned int counter = 0;
-
-  for(auto &pair:counterMap) {
-    if (startsWith(pair.first, "text/html")) {
-      counter += pair.second;
-    }
-  }
-
-  return counter;
-}
-
-/* Get the count of medias content in the ZIM file */
-unsigned int Reader::getMediaCount() const
-{
-  return kiwix::getArchiveMediaCount(*zimArchive);
-}
-
-/* Get the total of all items of a ZIM file, redirects included */
-unsigned int Reader::getGlobalCount() const
-{
-  return zimArchive->getEntryCount();
-}
-
-/* Return the UID of the ZIM file */
-string Reader::getId() const
-{
-  return kiwix::getArchiveId(*zimArchive);
-}
-
-Entry Reader::getRandomPage() const
-{
-  try {
-    return Entry(zimArchive->getRandomEntry(), true);
-  } catch(...) {
-    throw NoEntry();
-  }
-}
-
-Entry Reader::getMainPage() const
-{
-  return Entry(zimArchive->getMainEntry(), true);
-}
-
-bool Reader::getFavicon(string& content, string& mimeType) const
-{
-  return kiwix::getArchiveFavicon(*zimArchive, 48, content, mimeType);
-}
-
-string Reader::getZimFilePath() const
-{
-  return zimFilePath;
-}
-/* Return a metatag value */
-bool Reader::getMetadata(const string& name, string& value) const
-{
-  try {
-    value = zimArchive->getMetadata(name);
-    return true;
-  } catch(zim::EntryNotFound& e) {
-    return false;
-  }
-}
-
-#define METADATA(NAME) std::string v; getMetadata(NAME, v); return v;
-
-string Reader::getName() const
-{
-  return kiwix::getMetaName(*zimArchive);
-}
-
-string Reader::getTitle() const
-{
-  return kiwix::getArchiveTitle(*zimArchive);
-}
-
-string Reader::getCreator() const
-{
-  return kiwix::getMetaCreator(*zimArchive);
-}
-
-string Reader::getPublisher() const
-{
-  return kiwix::getMetaPublisher(*zimArchive);
-}
-
-string Reader::getDate() const
-{
-  return kiwix::getMetaDate(*zimArchive);
-}
-
-string Reader::getDescription() const
-{
-  return kiwix::getMetaDescription(*zimArchive);
-}
-
-string Reader::getLongDescription() const
-{
-  METADATA("LongDescription")
-}
-
-string Reader::getLanguage() const
-{
-  return kiwix::getMetaLanguage(*zimArchive);
-}
-
-string Reader::getLicense() const
-{
-  METADATA("License")
-}
-
-string Reader::getTags(bool original) const
-{
-  return kiwix::getMetaTags(*zimArchive, original);
-}
-
-
-string Reader::getTagStr(const std::string& tagName) const
-{
-  string tags_str;
-  getMetadata("Tags", tags_str);
-  return getTagValueFromTagList(convertTags(tags_str), tagName);
-}
-
-bool Reader::getTagBool(const std::string& tagName) const
-{
-  return convertStrToBool(getTagStr(tagName));
-}
-
-string Reader::getRelation() const
-{
-  METADATA("Relation")
-}
-
-string Reader::getFlavour() const
-{
-  return kiwix::getMetaFlavour(*zimArchive);
-}
-
-string Reader::getSource() const
-{
-  METADATA("Source")
-}
-
-string Reader::getScraper() const
-{
-  METADATA("Scraper")
-}
-#undef METADATA
-
-Entry Reader::getEntryFromPath(const std::string& path) const
-{
-  try {
-    return Entry(kiwix::getEntryFromPath(*zimArchive, path), true);
-  } catch (zim::EntryNotFound& e) {
-    throw NoEntry();
-  }
-}
-
-Entry Reader::getEntryFromEncodedPath(const std::string& path) const
-{
-  return getEntryFromPath(urlDecode(path, true));
-}
-
-Entry Reader::getEntryFromTitle(const std::string& title) const
-{
-  try {
-    return Entry(zimArchive->getEntryByTitle(title), true);
-  } catch(zim::EntryNotFound& e) {
-    throw NoEntry();
-  }
-}
-
-bool Reader::pathExists(const string& path) const
-{
-  return zimArchive->hasEntryByPath(path);
-}
-
-/* Does the ZIM file has a fulltext index */
-bool Reader::hasFulltextIndex() const
-{
-  return zimArchive->hasFulltextIndex();
-}
-
-/* Search titles by prefix */
-
-bool Reader::searchSuggestions(const string& prefix,
-                               unsigned int suggestionsCount,
-                               const bool reset)
-{
-  /* Reset the suggestions otherwise check if the suggestions number is less
-   * than the suggestionsCount */
-  if (reset) {
-    this->suggestions.clear();
-    this->suggestionsOffset = this->suggestions.begin();
-  } else {
-    if (this->suggestions.size() > suggestionsCount) {
-      return false;
-    }
-  }
-
-  auto ret =  searchSuggestions(prefix, suggestionsCount, this->suggestions);
-
-  /* Set the cursor to the begining */
-  this->suggestionsOffset = this->suggestions.begin();
-
-  return ret;
-}
-
-
-bool Reader::searchSuggestions(const string& prefix,
-                               unsigned int suggestionsCount,
-                               SuggestionsList_t& results)
-{
-  bool retVal = false;
-
-  /* Return if no prefix */
-  if (prefix.size() == 0) {
-    return false;
-  }
-
-  for (auto& entry: zimArchive->findByTitle(prefix)) {
-    if (results.size() >= suggestionsCount) {
-      break;
-    }
-    /* Extract the interesting part of article title & url */
-    std::string normalizedArticleTitle
-        = kiwix::normalize(entry.getTitle());
-
-    // Get the final path.
-    auto item = entry.getItem(true);
-    std::string articleFinalUrl = item.getPath();
-
-    /* Go through all already found suggestions and skip if this
-       article is already in the suggestions list (with an other
-       title) */
-    bool insert = true;
-    std::vector<SuggestionItem>::iterator suggestionItr;
-    for (suggestionItr = results.begin();
-         suggestionItr != results.end();
-         suggestionItr++) {
-      int result = normalizedArticleTitle.compare((*suggestionItr).getNormalizedTitle());
-      if (result == 0 && articleFinalUrl.compare((*suggestionItr).getPath()) == 0) {
-        insert = false;
-        break;
-      } else if (result < 0) {
-        break;
-      }
-    }
-
-    /* Insert if possible */
-    if (insert) {
-      SuggestionItem suggestion(entry.getTitle(), normalizedArticleTitle, articleFinalUrl);
-      results.insert(suggestionItr, suggestion);
-    }
-
-    /* Suggestions where found */
-    retVal = true;
-  }
-
-  return retVal;
-}
-
-std::vector<std::string> Reader::getTitleVariants(
-    const std::string& title) const
-{
-  return kiwix::getTitleVariants(title);
-}
-
-
-bool Reader::searchSuggestionsSmart(const string& prefix,
-                                    unsigned int suggestionsCount)
-{
-  this->suggestions.clear();
-  this->suggestionsOffset = this->suggestions.begin();
-
-  auto ret = searchSuggestionsSmart(prefix, suggestionsCount, this->suggestions);
-
-  this->suggestionsOffset = this->suggestions.begin();
-
-  return ret;
-}
-
-/* Try also a few variations of the prefix to have better results */
-bool Reader::searchSuggestionsSmart(const string& prefix,
-                                    unsigned int suggestionsCount,
-                                    SuggestionsList_t& results)
-{
-  std::vector<std::string> variants = this->getTitleVariants(prefix);
-
-  auto suggestionSearcher = zim::SuggestionSearcher(*zimArchive);
-
-  if (zimArchive->hasTitleIndex()) {
-    auto suggestionSearch = suggestionSearcher.suggest(prefix);
-    const auto suggestions = suggestionSearch.getResults(0, suggestionsCount);
-    for (auto current : suggestions) {
-      SuggestionItem suggestion(current.getTitle(), kiwix::normalize(current.getTitle()),
-                                current.getPath(), current.getSnippet());
-      results.push_back(suggestion);
-    }
-  } else {
-    // Check some of the variants of the prefix
-    for (std::vector<std::string>::iterator variantsItr = variants.begin();
-         variantsItr != variants.end();
-         variantsItr++) {
-      auto suggestionSearch = suggestionSearcher.suggest(*variantsItr);
-      for (auto current : suggestionSearch.getResults(0, suggestionsCount)) {
-        if (results.size() >= suggestionsCount) {
-          break;
-        }
-
-        SuggestionItem suggestion(current.getTitle(), kiwix::normalize(current.getTitle()),
-                                current.getPath(), current.getSnippet());
-        results.push_back(suggestion);
-      }
-    }
-  }
-
-  return results.size() > 0;
-}
-
-/* Get next suggestion */
-bool Reader::getNextSuggestion(string& title)
-{
-  if (this->suggestionsOffset != this->suggestions.end()) {
-    /* title */
-    title = (*(this->suggestionsOffset)).getTitle();
-
-    /* increment the cursor for the next call */
-    this->suggestionsOffset++;
-
-    return true;
-  }
-
-  return false;
-}
-
-bool Reader::getNextSuggestion(string& title, string& url)
-{
-  if (this->suggestionsOffset != this->suggestions.end()) {
-    /* title */
-    title = (*(this->suggestionsOffset)).getTitle();
-    url = (*(this->suggestionsOffset)).getPath();
-
-    /* increment the cursor for the next call */
-    this->suggestionsOffset++;
-
-    return true;
-  }
-
-  return false;
-}
-
-/* Check if the file has as checksum */
-bool Reader::canCheckIntegrity() const
-{
-  return zimArchive->hasChecksum();
-}
-
-/* Return true if corrupted, false otherwise */
-bool Reader::isCorrupted() const
-{
-  try {
-    if (zimArchive->check() == true) {
-      return false;
-    }
-  } catch (exception& e) {
-    cerr << e.what() << endl;
-    return true;
-  }
-
-  return true;
-}
-
-/* Return the file size, works also for splitted files */
-unsigned int Reader::getFileSize() const
-{
-  return kiwix::getArchiveFileSize(*zimArchive);
-}
-
-}

src/search_renderer.cpp

@@ -21,8 +21,6 @@
 #include <cmath>
 
 #include "search_renderer.h"
-#include "searcher.h"
-#include "reader.h"
 #include "library.h"
 #include "name_mapper.h"
 
@@ -38,15 +36,6 @@ namespace kiwix
 {
 
 /* Constructor */
-SearchRenderer::SearchRenderer(Searcher* searcher, NameMapper* mapper)
-    : SearchRenderer(
-        searcher->getSearchResultSet(),
-        mapper,
-        nullptr,
-        searcher->getEstimatedResultCount(),
-        searcher->getResultStart())
-{}
-
 SearchRenderer::SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper,
                       unsigned int start, unsigned int estimatedResultCount)
     : SearchRenderer(srs, mapper, nullptr, start, estimatedResultCount)
@@ -58,7 +47,7 @@ SearchRenderer::SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper, Lib
       mp_nameMapper(mapper),
       mp_library(library),
       protocolPrefix("zim://"),
-      searchProtocolPrefix("search://?"),
+      searchProtocolPrefix("search://"),
       estimatedResultCount(estimatedResultCount),
       resultStart(start)
 {}
@@ -68,12 +57,12 @@ SearchRenderer::~SearchRenderer() = default;
 
 void SearchRenderer::setSearchPattern(const std::string& pattern)
 {
-  this->searchPattern = pattern;
+  searchPattern = pattern;
 }
 
-void SearchRenderer::setSearchContent(const std::string& name)
+void SearchRenderer::setSearchBookQuery(const std::string& bookQuery)
 {
-  this->searchContent = name;
+  searchBookQuery = bookQuery;
 }
 
 void SearchRenderer::setProtocolPrefix(const std::string& prefix)
@@ -86,85 +75,161 @@ void SearchRenderer::setSearchProtocolPrefix(const std::string& prefix)
   this->searchProtocolPrefix = prefix;
 }
 
-std::string SearchRenderer::getHtml()
-{
-  kainjow::mustache::data results{kainjow::mustache::data::type::list};
+std::string extractValueFromQuery(const std::string& query, const std::string& key) {
+  const std::string p = key + "=";
+  const size_t i = query.find(p);
+  if (i == std::string::npos) {
+    return "";
+  }
+  std::string r = query.substr(i + p.size());
+  return r.substr(0, r.find("&"));
+}
 
-  for (auto it = m_srs.begin(); it != m_srs.end(); it++) {
-    kainjow::mustache::data result;
-    result.set("title", it.getTitle());
-    result.set("url", it.getPath());
-    result.set("snippet", it.getSnippet());
-    std::string zim_id(it.getZimId());
-    result.set("resultContentId", mp_nameMapper->getNameForId(zim_id));
-    if (!mp_library) {
-      result.set("bookTitle", kainjow::mustache::data(false));
-    } else {
-      result.set("bookTitle", mp_library->getBookById(zim_id).getTitle());
+kainjow::mustache::data buildQueryData
+(
+  const std::string& searchProtocolPrefix,
+  const std::string& pattern,
+  const std::string& bookQuery
+) {
+  kainjow::mustache::data query;
+  query.set("pattern", kiwix::encodeDiples(pattern));
+  std::ostringstream ss;
+  ss << searchProtocolPrefix << "?pattern=" << urlEncode(pattern, true);
+  ss << "&" << bookQuery;
+  query.set("unpaginatedQuery", ss.str());
+  auto lang = extractValueFromQuery(bookQuery, "books.filter.lang");
+  if(!lang.empty()) {
+    query.set("lang", lang);
+  }
+  return query;
+}
+
+kainjow::mustache::data buildPagination(
+  unsigned int pageLength,
+  unsigned int resultsCount,
+  unsigned int resultsStart
+)
+{
+  assert(pageLength!=0);
+  kainjow::mustache::data pagination;
+  kainjow::mustache::data pages{kainjow::mustache::data::type::list};
+
+  if (resultsCount == 0) {
+    // Easy case
+    pagination.set("itemsPerPage", to_string(pageLength));
+    pagination.set("hasPages", false);
+    pagination.set("pages", pages);
+    return pagination;
+  }
+
+  // First we want to display pages starting at a multiple of `pageLength`
+  // so, let's calculate the start index of the current page.
+  auto currentPage = resultsStart/pageLength;
+  auto lastPage = ((resultsCount-1)/pageLength);
+  auto lastPageStart = lastPage*pageLength;
+  auto nbPages = lastPage + 1;
+
+  auto firstPageGenerated = currentPage > 4 ? currentPage-4 : 0;
+  auto lastPageGenerated = std::min(currentPage+4, lastPage);
+
+  if (nbPages != 1) {
+    if (firstPageGenerated!=0) {
+      kainjow::mustache::data page;
+      page.set("label", "◀");
+      page.set("start", to_string(0));
+      page.set("current", false);
+      pages.push_back(page);
     }
 
+    for (auto i=firstPageGenerated; i<=lastPageGenerated; i++) {
+      kainjow::mustache::data page;
+      page.set("label", to_string(i+1));
+      page.set("start", to_string(i*pageLength));
+      page.set("current", bool(i == currentPage));
+      pages.push_back(page);
+    }
+
+    if (lastPageGenerated!=lastPage) {
+      kainjow::mustache::data page;
+      page.set("label", "▶");
+      page.set("start", to_string(lastPageStart));
+      page.set("current", false);
+      pages.push_back(page);
+    }
+  }
+
+  pagination.set("itemsPerPage", to_string(pageLength));
+  pagination.set("hasPages", firstPageGenerated < lastPageGenerated);
+  pagination.set("pages", pages);
+  return pagination;
+}
+
+std::string SearchRenderer::renderTemplate(const std::string& tmpl_str)
+{
+  const std::string absPathPrefix = protocolPrefix + "content/";
+  // Build the results list
+  kainjow::mustache::data items{kainjow::mustache::data::type::list};
+  for (auto it = m_srs.begin(); it != m_srs.end(); it++) {
+    kainjow::mustache::data result;
+    std::string zim_id(it.getZimId());
+    result.set("title", it.getTitle());
+    result.set("absolutePath", absPathPrefix + urlEncode(mp_nameMapper->getNameForId(zim_id), true) + "/" + urlEncode(it.getPath()));
+    result.set("snippet", it.getSnippet());
+    if (mp_library) {
+      result.set("bookTitle", mp_library->getBookById(zim_id).getTitle());
+    }
     if (it.getWordCount() >= 0) {
       result.set("wordCount", kiwix::beautifyInteger(it.getWordCount()));
     }
 
-    results.push_back(result);
+    items.push_back(result);
   }
+  kainjow::mustache::data results;
+  results.set("items", items);
+  results.set("count", kiwix::beautifyInteger(estimatedResultCount));
+  results.set("hasResults", estimatedResultCount != 0);
+  results.set("start", kiwix::beautifyInteger(resultStart));
+  results.set("end", kiwix::beautifyInteger(std::min(resultStart+pageLength-1, estimatedResultCount)));
 
-  // pages
-  kainjow::mustache::data pages{kainjow::mustache::data::type::list};
+  // pagination
+  auto pagination = buildPagination(
+    pageLength,
+    estimatedResultCount,
+    resultStart
+  );
 
-  auto resultEnd = 0U;
-  auto currentPage = 0U;
-  auto pageStart = 0U;
-  auto pageEnd = 0U;
-  auto lastPageStart = 0U;
-  if (pageLength) {
-    currentPage = resultStart/pageLength;
-    pageStart = currentPage > 4 ? currentPage-4 : 0;
-    pageEnd = currentPage + 5;
-    if (pageEnd > estimatedResultCount / pageLength) {
-      pageEnd = (estimatedResultCount + pageLength - 1) / pageLength;
-    }
-    if (estimatedResultCount > pageLength) {
-      lastPageStart = ((estimatedResultCount-1)/pageLength)*pageLength;
-    }
-  }
+  kainjow::mustache::data query = buildQueryData(
+    searchProtocolPrefix,
+    searchPattern,
+    searchBookQuery
+  );
 
-  resultEnd = resultStart+pageLength; //setting result end
-
-  for (unsigned int i = pageStart; i < pageEnd; i++) {
-    kainjow::mustache::data page;
-    page.set("label", to_string(i + 1));
-    page.set("start", to_string(i * pageLength));
-
-    if (i == currentPage) {
-      page.set("selected", true);
-    }
-    pages.push_back(page);
-  }
-
-  std::string template_str = RESOURCE::templates::search_result_html;
-  kainjow::mustache::mustache tmpl(template_str);
 
   kainjow::mustache::data allData;
+  allData.set("protocolPrefix", protocolPrefix);
   allData.set("results", results);
-  allData.set("pages", pages);
-  allData.set("hasResults", estimatedResultCount != 0);
-  allData.set("hasPages", pageStart != pageEnd);
-  allData.set("count", kiwix::beautifyInteger(estimatedResultCount));
-  allData.set("searchPattern", kiwix::encodeDiples(this->searchPattern));
-  allData.set("searchPatternEncoded", urlEncode(this->searchPattern));
-  allData.set("resultStart", to_string(resultStart + 1));
-  allData.set("resultEnd", to_string(min(resultEnd, estimatedResultCount)));
-  allData.set("pageLength", to_string(pageLength));
-  allData.set("resultLastPageStart", to_string(lastPageStart));
-  allData.set("protocolPrefix", this->protocolPrefix);
-  allData.set("searchProtocolPrefix", this->searchProtocolPrefix);
-  allData.set("contentId", this->searchContent);
+  allData.set("pagination", pagination);
+  allData.set("query", query);
+
+  kainjow::mustache::mustache tmpl(tmpl_str);
 
   std::stringstream ss;
   tmpl.render(allData, [&ss](const std::string& str) { ss << str; });
+  if (!tmpl.is_valid()) {
+    throw std::runtime_error("Error while rendering search results: " + tmpl.error_message());
+  }
   return ss.str();
 }
 
+std::string SearchRenderer::getHtml()
+{
+  return renderTemplate(RESOURCE::templates::search_result_html);
+}
+
+std::string SearchRenderer::getXml()
+{
+  return renderTemplate(RESOURCE::templates::search_result_xml);
+}
+
+
 }

src/searcher.cpp

@@ -1,330 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-
-#include "searcher.h"
-#include "reader.h"
-
-#include <zim/search.h>
-#include <zim/suggestion.h>
-
-#include <mustache.hpp>
-#include <cmath>
-#include "tools/stringTools.h"
-#include "kiwixlib-resources.h"
-
-#define MAX_SEARCH_LEN 140
-
-namespace kiwix
-{
-class _Result : public Result
-{
- public:
-  _Result(zim::SearchResultSet::iterator iterator);
-  _Result(SuggestionItem suggestionItem);
-  virtual ~_Result(){};
-
-  virtual std::string get_url();
-  virtual std::string get_title();
-  virtual int get_score();
-  virtual std::string get_snippet();
-  virtual std::string get_content();
-  virtual int get_wordCount();
-  virtual int get_size();
-  virtual std::string get_zimId();
-
- private:
-  zim::SearchResultSet::iterator iterator;
-  SuggestionItem suggestionItem;
-  bool isSuggestion;
-};
-
-struct SearcherInternal : zim::SearchResultSet {
-  explicit SearcherInternal(const zim::SearchResultSet& srs)
-    : zim::SearchResultSet(srs)
-    , current_iterator(srs.begin())
-  {
-  }
-
-  zim::SearchResultSet::iterator current_iterator;
-};
-
-struct SuggestionInternal : zim::SuggestionResultSet {
-  explicit SuggestionInternal(const zim::SuggestionResultSet& srs)
-    : zim::SuggestionResultSet(srs),
-      currentIterator(srs.begin()) {}
-
-  zim::SuggestionResultSet::iterator currentIterator;
-};
-
-/* Constructor */
-Searcher::Searcher()
-    : searchPattern(""),
-      estimatedResultCount(0),
-      resultStart(0),
-      maxResultCount(0)
-{
-  loadICUExternalTables();
-}
-
-/* Destructor */
-Searcher::~Searcher()
-{
-}
-
-bool Searcher::add_reader(Reader* reader)
-{
-  if (!reader->hasFulltextIndex()) {
-      return false;
-  }
-
-  for ( const Reader* const existing_reader : readers ) {
-    if ( existing_reader->getZimArchive()->getUuid() == reader->getZimArchive()->getUuid() )
-      return false;
-  }
-
-  this->readers.push_back(reader);
-  return true;
-}
-
-
-Reader* Searcher::get_reader(int readerIndex)
-{
-  return readers.at(readerIndex);
-}
-
-/* Search strings in the database */
-void Searcher::search(const std::string& search,
-                      unsigned int resultStart,
-                      unsigned int maxResultCount,
-                      const bool verbose)
-{
-  this->reset();
-
-  if (verbose == true) {
-    cout << "Performing query `" << search << "'" << endl;
-  }
-
-  this->searchPattern = search;
-  this->resultStart = resultStart;
-  this->maxResultCount = maxResultCount;
-  /* Try to find results */
-  if (maxResultCount != 0) {
-    /* Perform the search */
-    string unaccentedSearch = removeAccents(search);
-    std::vector<zim::Archive> archives;
-    for (auto current = this->readers.begin(); current != this->readers.end();
-         current++) {
-      if ( (*current)->hasFulltextIndex() ) {
-          archives.push_back(*(*current)->getZimArchive());
-      }
-    }
-    zim::Searcher searcher(archives);
-    searcher.setVerbose(verbose);
-    zim::Query query;
-    query.setQuery(unaccentedSearch);
-    zim::Search search = searcher.search(query);
-    internal.reset(new SearcherInternal(search.getResults(resultStart, maxResultCount)));
-    this->estimatedResultCount = search.getEstimatedMatches();
-  }
-
-  return;
-}
-
-
-void Searcher::geo_search(float latitude, float longitude, float distance,
-                          unsigned int resultStart,
-                          unsigned int maxResultCount,
-                          const bool verbose)
-{
-  this->reset();
-
-  if (verbose == true) {
-    cout << "Performing geo query `" << distance << "&(" << latitude << ";" << longitude << ")'" << endl;
-  }
-
-  /* Perform the search */
-  std::ostringstream oss;
-  oss << "Articles located less than " << distance << " meters of " << latitude << ";" << longitude;
-  this->searchPattern = oss.str();
-  this->resultStart = resultStart;
-  this->maxResultCount = maxResultCount;
-
-  /* Try to find results */
-  if (maxResultCount == 0) {
-    return;
-  }
-
-  std::vector<zim::Archive> archives;
-  for (auto current = this->readers.begin(); current != this->readers.end();
-       current++) {
-    archives.push_back(*(*current)->getZimArchive());
-  }
-  zim::Searcher searcher(archives);
-  searcher.setVerbose(verbose);
-  zim::Query query;
-  query.setQuery("");
-  query.setGeorange(latitude, longitude, distance);
-  zim::Search search = searcher.search(query);
-  internal.reset(new SearcherInternal(search.getResults(resultStart, maxResultCount)));
-  this->estimatedResultCount = search.getEstimatedMatches();
-}
-
-
-void Searcher::restart_search()
-{
-  if (internal.get()) {
-    internal->current_iterator = internal->begin();
-  }
-}
-
-Result* Searcher::getNextResult()
-{
-  if (internal.get() && internal->current_iterator != internal->end()) {
-    Result* result = new _Result(internal->current_iterator);
-    internal->current_iterator++;
-    return result;
-  } else if (suggestionInternal.get() &&
-             suggestionInternal->currentIterator != suggestionInternal->end()) {
-    SuggestionItem item(
-                        suggestionInternal->currentIterator->getTitle(),
-                        normalize(suggestionInternal->currentIterator->getTitle()),
-                        suggestionInternal->currentIterator->getPath(),
-                        suggestionInternal->currentIterator->getSnippet()
-                      );
-    Result* result = new _Result(item);
-    suggestionInternal->currentIterator++;
-    return result;
-  }
-  return NULL;
-}
-
-/* Reset the results */
-void Searcher::reset()
-{
-  this->estimatedResultCount = 0;
-  this->searchPattern = "";
-  return;
-}
-
-void Searcher::suggestions(std::string& searchPattern, const bool verbose)
-{
-  this->reset();
-
-  if (verbose == true) {
-    cout << "Performing suggestion query `" << searchPattern << "`" << endl;
-  }
-
-  this->searchPattern = searchPattern;
-  this->resultStart = 0;
-  this->maxResultCount = 10;
-  string unaccentedSearch = removeAccents(searchPattern);
-
-  // Multizim suggestion is not supported as of now! taking only one archive
-  zim::Archive archive = *(*this->readers.begin())->getZimArchive();
-  zim::SuggestionSearcher searcher(archive);
-  searcher.setVerbose(verbose);
-  zim::SuggestionSearch search = searcher.suggest(searchPattern);
-  suggestionInternal.reset(new SuggestionInternal(search.getResults(resultStart, maxResultCount)));
-  this->estimatedResultCount = search.getEstimatedMatches();
-}
-
-/* Return the result count estimation */
-unsigned int Searcher::getEstimatedResultCount()
-{
-  return this->estimatedResultCount;
-}
-
-zim::SearchResultSet Searcher::getSearchResultSet()
-{
-  return *(this->internal);
-}
-
-_Result::_Result(zim::SearchResultSet::iterator iterator)
-    : iterator(iterator),
-      suggestionItem("", "", ""),
-      isSuggestion(false)
-{}
-
-_Result::_Result(SuggestionItem item)
-    : iterator(),
-      suggestionItem(item.getTitle(), item.getNormalizedTitle(), item.getPath(), item.getSnippet()),
-      isSuggestion(true)
-{}
-
-std::string _Result::get_url()
-{
-  if (isSuggestion) {
-    return suggestionItem.getPath();
-  }
-  return iterator.getPath();
-}
-std::string _Result::get_title()
-{
-  if (isSuggestion) {
-    return suggestionItem.getTitle();
-  }
-  return iterator.getTitle();
-}
-int _Result::get_score()
-{
-  if (isSuggestion) {
-    return 0;
-  }
-  return iterator.getScore();
-}
-std::string _Result::get_snippet()
-{
-  if (isSuggestion) {
-    return suggestionItem.getSnippet();
-  }
-  return iterator.getSnippet();
-}
-std::string _Result::get_content()
-{
-  if (isSuggestion) return "";
-  return iterator->getItem(true).getData();
-}
-int _Result::get_size()
-{
-  if (isSuggestion) {
-    return 0;
-  }
-  return iterator.getSize();
-}
-int _Result::get_wordCount()
-{
-  if (isSuggestion) {
-    return 0;
-  }
-  return iterator.getWordCount();
-}
-std::string _Result::get_zimId()
-{
-  if (isSuggestion) {
-    return "";
-  }
-  std::ostringstream s;
-  s << iterator.getZimId();
-  return s.str();
-}
-
-
-}

src/server.cpp

@@ -24,6 +24,7 @@
 
 #include <string>
 
+#include <zim/item.h>
 #include "server/internalServer.h"
 
 namespace kiwix {
@@ -45,6 +46,7 @@ bool Server::start() {
     m_port,
     m_root,
     m_nbThreads,
+    m_multizimSearchLimit,
     m_verbose,
     m_withTaskbar,
     m_withLibraryButton,

src/server/i18n.cpp

@@ -0,0 +1,114 @@
+/*
+ * Copyright 2022 Veloman Yunkan <veloman.yunkan@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include "i18n.h"
+
+#include "tools/otherTools.h"
+
+#include <algorithm>
+#include <map>
+
+namespace kiwix
+{
+
+const char* I18nStringTable::get(const std::string& key) const
+{
+  const I18nString* const begin = entries;
+  const I18nString* const end = begin + entryCount;
+  const I18nString* found = std::lower_bound(begin, end, key,
+      [](const I18nString& a, const std::string& k) {
+        return a.key < k;
+  });
+  return (found == end || found->key != key) ? nullptr : found->value;
+}
+
+namespace i18n
+{
+// this data is generated by the i18n resource compiler
+extern const I18nStringTable stringTables[];
+extern const size_t langCount;
+}
+
+namespace
+{
+
+class I18nStringDB
+{
+public: // functions
+  I18nStringDB() {
+    for ( size_t i = 0; i < kiwix::i18n::langCount; ++i ) {
+      const auto& t = kiwix::i18n::stringTables[i];
+      lang2TableMap[t.lang] = &t;
+    }
+    enStrings = lang2TableMap.at("en");
+  };
+
+  std::string get(const std::string& lang, const std::string& key) const {
+    const char* s = getStringsFor(lang)->get(key);
+    if ( s == nullptr ) {
+      s = enStrings->get(key);
+      if ( s == nullptr ) {
+        throw std::runtime_error("Invalid message id");
+      }
+    }
+    return s;
+  }
+
+private: // functions
+  const I18nStringTable* getStringsFor(const std::string& lang) const {
+    try {
+      return lang2TableMap.at(lang);
+    } catch(const std::out_of_range&) {
+      return enStrings;
+    }
+  }
+
+private: // data
+  std::map<std::string, const I18nStringTable*> lang2TableMap;
+  const I18nStringTable* enStrings;
+};
+
+} // unnamed namespace
+
+std::string getTranslatedString(const std::string& lang, const std::string& key)
+{
+  static const I18nStringDB stringDb;
+
+  return stringDb.get(lang, key);
+}
+
+namespace i18n
+{
+
+std::string expandParameterizedString(const std::string& lang,
+                                      const std::string& key,
+                                      const Parameters& params)
+{
+  const std::string tmpl = getTranslatedString(lang, key);
+  return render_template(tmpl, params);
+}
+
+} // namespace i18n
+
+std::string ParameterizedMessage::getText(const std::string& lang) const
+{
+  return i18n::expandParameterizedString(lang, msgId, params);
+}
+
+} // namespace kiwix

src/server/i18n.h

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2022 Veloman Yunkan <veloman.yunkan@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#ifndef KIWIX_SERVER_I18N
+#define KIWIX_SERVER_I18N
+
+#include <string>
+#include <mustache.hpp>
+
+namespace kiwix
+{
+
+struct I18nString {
+  const char* const key;
+  const char* const value;
+};
+
+struct I18nStringTable {
+  const char* const lang;
+  const size_t entryCount;
+  const I18nString* const entries;
+
+  const char* get(const std::string& key) const;
+};
+
+std::string getTranslatedString(const std::string& lang, const std::string& key);
+
+namespace i18n
+{
+
+typedef kainjow::mustache::object Parameters;
+
+std::string expandParameterizedString(const std::string& lang,
+                                      const std::string& key,
+                                      const Parameters& params);
+
+class GetTranslatedString
+{
+public:
+  explicit GetTranslatedString(const std::string& lang) : m_lang(lang) {}
+
+  std::string operator()(const std::string& key) const
+  {
+    return getTranslatedString(m_lang, key);
+  }
+
+  std::string operator()(const std::string& key, const Parameters& params) const
+  {
+    return expandParameterizedString(m_lang, key, params);
+  }
+
+private:
+  const std::string m_lang;
+};
+
+} // namespace i18n
+
+struct ParameterizedMessage
+{
+public: // types
+  typedef kainjow::mustache::object Parameters;
+
+public: // functions
+  ParameterizedMessage(const std::string& msgId, const Parameters& params)
+    : msgId(msgId)
+    , params(params)
+  {}
+
+  std::string getText(const std::string& lang) const;
+
+private: // data
+  const std::string msgId;
+  const Parameters  params;
+};
+
+} // namespace kiwix
+
+#endif // KIWIX_SERVER_I18N

src/server/internalServer.cpp

@@ -51,15 +51,15 @@ extern "C" {
 #include "tools/networkTools.h"
 #include "library.h"
 #include "name_mapper.h"
-#include "entry.h"
-#include "searcher.h"
 #include "search_renderer.h"
 #include "opds_dumper.h"
+#include "i18n.h"
 
 #include <zim/uuid.h>
 #include <zim/error.h>
 #include <zim/entry.h>
 #include <zim/item.h>
+#include <zim/suggestion.h>
 
 #include <mustache.hpp>
 
@@ -67,6 +67,7 @@ extern "C" {
 #include <string>
 #include <vector>
 #include <chrono>
+#include <fstream>
 #include "kiwixlib-resources.h"
 
 #ifndef _WIN32
@@ -77,7 +78,6 @@ extern "C" {
 #include "response.h"
 
 #define MAX_SEARCH_LEN 140
-#define KIWIX_MIN_CONTENT_SIZE_TO_DEFLATE 100
 #define DEFAULT_CACHE_SIZE 2
 
 namespace kiwix {
@@ -95,35 +95,203 @@ inline std::string normalizeRootUrl(std::string rootUrl)
   return rootUrl.empty() ? rootUrl : "/" + rootUrl;
 }
 
-// Returns the value of env var `name` if found, otherwise returns defaultVal
-unsigned int getCacheLength(const char* name, unsigned int defaultVal) {
-  try {
-    const char* envString = std::getenv(name);
-    if (envString == nullptr) {
-      throw std::runtime_error("Environment variable not set");
-    }
-    return extractFromString<unsigned int>(envString);
-  } catch (...) {}
-
-  return defaultVal;
+Filter get_search_filter(const RequestContext& request, const std::string& prefix="")
+{
+    auto filter = kiwix::Filter().valid(true).local(true);
+    try {
+      filter.query(request.get_argument(prefix+"q"));
+    } catch (const std::out_of_range&) {}
+    try {
+      filter.maxSize(request.get_argument<unsigned long>(prefix+"maxsize"));
+    } catch (...) {}
+    try {
+      filter.name(request.get_argument(prefix+"name"));
+    } catch (const std::out_of_range&) {}
+    try {
+      filter.category(request.get_argument(prefix+"category"));
+    } catch (const std::out_of_range&) {}
+    try {
+      filter.lang(request.get_argument(prefix+"lang"));
+    } catch (const std::out_of_range&) {}
+    try {
+      filter.acceptTags(kiwix::split(request.get_argument(prefix+"tag"), ";"));
+    } catch (...) {}
+    try {
+      filter.rejectTags(kiwix::split(request.get_argument(prefix+"notag"), ";"));
+    } catch (...) {}
+    return filter;
 }
+
+template<class T>
+std::vector<T> subrange(const std::vector<T>& v, size_t s, size_t n)
+{
+  const size_t e = std::min(v.size(), s+n);
+  return std::vector<T>(v.begin()+std::min(v.size(), s), v.begin()+e);
+}
+
+std::string renderUrl(const std::string& root, const std::string& urlTemplate)
+{
+  MustacheData data;
+  data.set("root", root);
+  auto url = kainjow::mustache::mustache(urlTemplate).render(data);
+  if ( url.back() == '\n' )
+    url.pop_back();
+  return url;
+}
+
+std::string makeFulltextSearchSuggestion(const std::string& lang, const std::string& queryString)
+{
+  return i18n::expandParameterizedString(lang, "suggest-full-text-search",
+               {
+                  {"SEARCH_TERMS", queryString}
+               }
+         );
+}
+
+ParameterizedMessage noSuchBookErrorMsg(const std::string& bookName)
+{
+  return ParameterizedMessage("no-such-book", { {"BOOK_NAME", bookName} });
+}
+
+ParameterizedMessage invalidRawAccessMsg(const std::string& dt)
+{
+  return ParameterizedMessage("invalid-raw-data-type", { {"DATATYPE", dt} });
+}
+
+ParameterizedMessage noValueForArgMsg(const std::string& argument)
+{
+  return ParameterizedMessage("no-value-for-arg", { {"ARGUMENT", argument} });
+}
+
+ParameterizedMessage rawEntryNotFoundMsg(const std::string& dt, const std::string& entry)
+{
+  return ParameterizedMessage("raw-entry-not-found",
+                              {
+                                {"DATATYPE", dt},
+                                {"ENTRY", entry},
+                              }
+  );
+}
+
+ParameterizedMessage tooManyBooksMsg(size_t nbBooks, size_t limit)
+{
+  return ParameterizedMessage("too-many-books",
+                              {
+                                {"NB_BOOKS", beautifyInteger(nbBooks)},
+                                {"LIMIT", beautifyInteger(limit)},
+                              }
+  );
+}
+
+ParameterizedMessage nonParameterizedMessage(const std::string& msgId)
+{
+  const ParameterizedMessage::Parameters noParams;
+  return ParameterizedMessage(msgId, noParams);
+}
+
+struct Error : public std::runtime_error {
+  explicit Error(const ParameterizedMessage& message)
+    : std::runtime_error("Error while handling request"),
+      _message(message)
+  {}
+
+  const ParameterizedMessage& message() const
+  {
+    return _message;
+  }
+
+  const ParameterizedMessage _message;
+};
+
+void checkBookNumber(const Library::BookIdSet& bookIds, size_t limit) {
+  if (bookIds.empty()) {
+    throw Error(nonParameterizedMessage("no-book-found"));
+  }
+  if (limit > 0 && bookIds.size() > limit) {
+    throw Error(tooManyBooksMsg(bookIds.size(), limit));
+  }
+}
+
+struct CustomizedResourceData
+{
+  std::string mimeType;
+  std::string resourceFilePath;
+};
+
 } // unnamed namespace
 
-SearchInfo::SearchInfo(const std::string& pattern)
-  : pattern(pattern),
-    geoQuery()
-{}
-
-SearchInfo::SearchInfo(const std::string& pattern, GeoQuery geoQuery)
-  : pattern(pattern),
-    geoQuery(geoQuery)
-{}
-
-SearchInfo::SearchInfo(const RequestContext& request)
-  : pattern(request.get_optional_param<std::string>("pattern", "")),
-    geoQuery(),
-    bookName(request.get_optional_param<std::string>("content", ""))
+std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const RequestContext& request) const
 {
+  // Try old API
+  try {
+    auto bookName = request.get_argument("content");
+    try {
+      const auto bookIds = Library::BookIdSet{mp_nameMapper->getIdForName(bookName)};
+      const auto queryString = request.get_query([&](const std::string& key){return key == "content";}, true);
+      return {queryString, bookIds};
+    } catch (const std::out_of_range&) {
+      throw Error(noSuchBookErrorMsg(bookName));
+    }
+  } catch(const std::out_of_range&) {
+    // We've catch the out_of_range of get_argument
+    // continue
+  }
+
+  // Does user directly gives us ids ?
+  try {
+    auto id_vec = request.get_arguments("books.id");
+    if (id_vec.empty()) {
+      throw Error(noValueForArgMsg("books.id"));
+    }
+    for(const auto& bookId: id_vec) {
+      try {
+        // This is a silly way to check that bookId exists
+        mp_nameMapper->getNameForId(bookId);
+      } catch (const std::out_of_range&) {
+        throw Error(noSuchBookErrorMsg(bookId));
+      }
+    }
+    const auto bookIds = Library::BookIdSet(id_vec.begin(), id_vec.end());
+    const auto queryString = request.get_query([&](const std::string& key){return key == "books.id";}, true);
+    return {queryString, bookIds};
+  } catch(const std::out_of_range&) {}
+
+  // Use the names
+  try {
+    auto name_vec = request.get_arguments("books.name");
+    if (name_vec.empty()) {
+      throw Error(noValueForArgMsg("books.name"));
+    }
+    Library::BookIdSet bookIds;
+    for(const auto& bookName: name_vec) {
+      try {
+        bookIds.insert(mp_nameMapper->getIdForName(bookName));
+      } catch(const std::out_of_range&) {
+        throw Error(noSuchBookErrorMsg(bookName));
+      }
+    }
+    const auto queryString = request.get_query([&](const std::string& key){return key == "books.name";}, true);
+    return {queryString, bookIds};
+  } catch(const std::out_of_range&) {}
+
+  // Check for filtering
+  Filter filter = get_search_filter(request, "books.filter.");
+  auto id_vec = mp_library->filter(filter);
+  if (id_vec.empty()) {
+    throw Error(nonParameterizedMessage("no-book-found"));
+  }
+  const auto bookIds = Library::BookIdSet(id_vec.begin(), id_vec.end());
+  const auto queryString = request.get_query([&](const std::string& key){return startsWith(key, "books.filter.");}, true);
+  return {queryString, bookIds};
+}
+
+SearchInfo InternalServer::getSearchInfo(const RequestContext& request) const
+{
+  auto bookIds = selectBooks(request);
+  checkBookNumber(bookIds.second, m_multizimSearchLimit);
+  auto pattern = request.get_optional_param<std::string>("pattern", "");
+  GeoQuery geoQuery;
+
   /* Retrive geo search */
   try {
     auto latitude = request.get_argument<float>("latitude");
@@ -134,10 +302,19 @@ SearchInfo::SearchInfo(const RequestContext& request)
     catch(const std::invalid_argument&) {}
 
   if (!geoQuery && pattern.empty()) {
-    throw std::invalid_argument("No query provided.");
+    throw Error(nonParameterizedMessage("no-query"));
   }
+
+  return SearchInfo(pattern, geoQuery, bookIds.second, bookIds.first);
 }
 
+SearchInfo::SearchInfo(const std::string& pattern, GeoQuery geoQuery, const Library::BookIdSet& bookIds, const std::string& bookFilterQuery)
+  : pattern(pattern),
+    geoQuery(geoQuery),
+    bookIds(bookIds),
+    bookFilterQuery(bookFilterQuery)
+{}
+
 zim::Query SearchInfo::getZimQuery(bool verbose) const {
   zim::Query query;
   if (verbose) {
@@ -156,7 +333,6 @@ zim::Query SearchInfo::getZimQuery(bool verbose) const {
   return query;
 }
 
-
 static IdNameMapper defaultNameMapper;
 
 static MHD_Result staticHandlerCallback(void* cls,
@@ -168,6 +344,27 @@ static MHD_Result staticHandlerCallback(void* cls,
                                         size_t* upload_data_size,
                                         void** cont_cls);
 
+class InternalServer::CustomizedResources : public std::map<std::string, CustomizedResourceData>
+{
+public:
+  CustomizedResources()
+  {
+    const char* fname = ::getenv("KIWIX_SERVE_CUSTOMIZED_RESOURCES");
+    if ( fname )
+    {
+      std::cout << "Populating customized resources" << std::endl;
+      std::ifstream file(fname);
+      std::string url, mimeType, resourceFilePath;
+      while ( file >> url >> mimeType >> resourceFilePath )
+      {
+        std::cout << "Got " << url << " " << mimeType << " " << resourceFilePath << std::endl;
+        (*this)[url] = CustomizedResourceData{mimeType, resourceFilePath};
+      }
+      std::cout << "Done populating customized resources" << std::endl;
+    }
+  }
+};
+
 
 InternalServer::InternalServer(Library* library,
                                NameMapper* nameMapper,
@@ -175,6 +372,7 @@ InternalServer::InternalServer(Library* library,
                                int port,
                                std::string root,
                                int nbThreads,
+                               unsigned int multizimSearchLimit,
                                bool verbose,
                                bool withTaskbar,
                                bool withLibraryButton,
@@ -185,6 +383,7 @@ InternalServer::InternalServer(Library* library,
   m_port(port),
   m_root(normalizeRootUrl(root)),
   m_nbThreads(nbThreads),
+  m_multizimSearchLimit(multizimSearchLimit),
   m_verbose(verbose),
   m_withTaskbar(withTaskbar),
   m_withLibraryButton(withLibraryButton),
@@ -194,11 +393,13 @@ InternalServer::InternalServer(Library* library,
   mp_daemon(nullptr),
   mp_library(library),
   mp_nameMapper(nameMapper ? nameMapper : &defaultNameMapper),
-  searcherCache(getCacheLength("SEARCHER_CACHE_SIZE", std::max((unsigned int) (mp_library->getBookCount(true, true)*0.1), 1U))),
-  searchCache(getCacheLength("SEARCH_CACHE_SIZE", DEFAULT_CACHE_SIZE)),
-  suggestionSearcherCache(getCacheLength("SUGGESTION_SEARCHER_CACHE_SIZE", std::max((unsigned int) (mp_library->getBookCount(true, true)*0.1), 1U)))
+  searchCache(getEnvVar<int>("KIWIX_SEARCH_CACHE_SIZE", DEFAULT_CACHE_SIZE)),
+  suggestionSearcherCache(getEnvVar<int>("KIWIX_SUGGESTION_SEARCHER_CACHE_SIZE", std::max((unsigned int) (mp_library->getBookCount(true, true)*0.1), 1U))),
+  m_customizedResources(new CustomizedResources)
 {}
 
+InternalServer::~InternalServer() = default;
+
 bool InternalServer::start() {
 #ifdef _WIN32
   int flags = MHD_USE_SELECT_INTERNALLY;
@@ -323,11 +524,21 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
   return ret;
 }
 
+namespace
+{
+
+bool isEndpointUrl(const std::string& url, const std::string& endpoint)
+{
+  return startsWith(url, "/" + endpoint + "/") || url == "/" + endpoint;
+};
+
+} // unnamed namespace
+
 std::unique_ptr<Response> InternalServer::handle_request(const RequestContext& request)
 {
   try {
     if (! request.is_valid_url()) {
-      return HTTP404HtmlResponse(*this, request)
+      return HTTP404Response(*this, request)
              + urlNotFoundMsg;
     }
 
@@ -335,35 +546,52 @@ std::unique_ptr<Response> InternalServer::handle_request(const RequestContext& r
     if ( etag )
       return Response::build_304(*this, etag);
 
-    if (startsWith(request.get_url(), "/skin/"))
+    const auto url = request.get_url();
+    if ( isLocallyCustomizedResource(url) )
+      return handle_locally_customized_resource(request);
+
+    if (url == "/" )
+      return build_homepage(request);
+
+    if (isEndpointUrl(url, "skin"))
       return handle_skin(request);
 
-    if (startsWith(request.get_url(), "/catalog/"))
+    if (isEndpointUrl(url, "content"))
+      return handle_content(request);
+
+    if (isEndpointUrl(url, "catalog"))
       return handle_catalog(request);
 
-    if (startsWith(request.get_url(), "/raw/"))
+    if (isEndpointUrl(url, "raw"))
       return handle_raw(request);
 
-    if (request.get_url() == "/search")
+    if (isEndpointUrl(url, "search"))
       return handle_search(request);
 
-    if (request.get_url() == "/suggest")
+    if (isEndpointUrl(url, "suggest"))
      return handle_suggest(request);
 
-    if (request.get_url() == "/random")
+    if (isEndpointUrl(url, "random"))
       return handle_random(request);
 
-    if (request.get_url() == "/catch/external")
-      return handle_captured_external(request);
+    if (isEndpointUrl(url, "catch"))
+      return handle_catch(request);
 
-    return handle_content(request);
+    if (isEndpointUrl(url, "widget"))
+      return handle_widget(request);
+
+    std::string contentUrl = m_root + "/content" + url;
+    const std::string query = request.get_query();
+    if ( ! query.empty() )
+      contentUrl += "?" + query;
+    return Response::build_redirect(*this, contentUrl);
   } catch (std::exception& e) {
     fprintf(stderr, "===== Unhandled error : %s\n", e.what());
-    return HTTP500HtmlResponse(*this, request)
+    return HTTP500Response(*this, request)
          + e.what();
   } catch (...) {
     fprintf(stderr, "===== Unhandled unknown error\n");
-    return HTTP500HtmlResponse(*this, request)
+    return HTTP500Response(*this, request)
          + "Unknown error";
   }
 }
@@ -405,61 +633,17 @@ std::unique_ptr<Response> InternalServer::build_homepage(const RequestContext& r
  * Archive and Zim handlers begin
  **/
 
-SuggestionsList_t getSuggestions(SuggestionSearcherCache& cache, const zim::Archive* const archive,
-                  const std::string& bookId, const std::string& queryString, int start, int suggestionCount)
-{
-  SuggestionsList_t suggestions;
-  std::shared_ptr<zim::SuggestionSearcher> searcher;
-  searcher = cache.getOrPut(bookId, [=](){ return make_shared<zim::SuggestionSearcher>(*archive); });
-
-  if (archive->hasTitleIndex()) {
-    auto search = searcher->suggest(queryString);
-    auto srs = search.getResults(start, suggestionCount);
-
-    for (auto it : srs) {
-      SuggestionItem suggestion(it.getTitle(), kiwix::normalize(it.getTitle()),
-                                it.getPath(), it.getSnippet());
-      suggestions.push_back(suggestion);
-    }
-  } else {
-    // TODO: This case should be handled by libzim
-    std::vector<std::string> variants = getTitleVariants(queryString);
-    int currCount = 0;
-    for (auto it = variants.begin(); it != variants.end() && currCount < suggestionCount; it++) {
-      auto search = searcher->suggest(queryString);
-      auto srs = search.getResults(0, suggestionCount);
-      for (auto it : srs) {
-        SuggestionItem suggestion(it.getTitle(), kiwix::normalize(it.getTitle()),
-                                  it.getPath());
-        suggestions.push_back(suggestion);
-        currCount++;
-      }
-    }
-  }
-  return suggestions;
-}
-
-namespace
-{
-
-std::string noSuchBookErrorMsg(const std::string& bookName)
-{
-  return "No such book: " + bookName;
-}
-
-std::string noSearchResultsMsg()
-{
-  return "The fulltext search engine is not available for this content.";
-}
-
-} // unnamed namespace
-
 std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& request)
 {
   if (m_verbose.load()) {
     printf("** running handle_suggest\n");
   }
 
+  if ( startsWith(request.get_url(), "/suggest/") ) {
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
+  }
+
   std::string bookName, bookId;
   std::shared_ptr<zim::Archive> archive;
   try {
@@ -471,7 +655,7 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
   }
 
   if (archive == nullptr) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + noSuchBookErrorMsg(bookName)
            + TaskbarInfo(bookName);
   }
@@ -492,9 +676,13 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
   bool first = true;
 
   /* Get the suggestions */
-  SuggestionsList_t suggestions = getSuggestions(suggestionSearcherCache, archive.get(),
-                                                  bookId, queryString, start, count);
-  for(auto& suggestion:suggestions) {
+  auto searcher = suggestionSearcherCache.getOrPut(bookId,
+    [=](){ return make_shared<zim::SuggestionSearcher>(*archive); }
+  );
+  auto search = searcher->suggest(queryString);
+  auto srs = search.getResults(start, count);
+
+  for(auto& suggestion: srs) {
     MustacheData result;
     result.set("label", suggestion.getTitle());
 
@@ -514,7 +702,8 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
   /* Propose the fulltext search if possible */
   if (archive->hasFulltextIndex()) {
     MustacheData result;
-    result.set("label", "containing '" + queryString + "'...");
+    const auto lang = request.get_user_language();
+    result.set("label", makeFulltextSearchSuggestion(lang, queryString));
     result.set("value", queryString + " ");
     result.set("kind", "pattern");
     result.set("first", first);
@@ -543,7 +732,7 @@ std::unique_ptr<Response> InternalServer::handle_skin(const RequestContext& requ
     response->set_cacheable();
     return std::move(response);
   } catch (const ResourceNotFound& e) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 }
@@ -554,61 +743,56 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
     printf("** running handle_search\n");
   }
 
-  try {
-    auto searchInfo = SearchInfo(request);
-
-    std::string bookId;
-    std::shared_ptr<zim::Archive> archive;
-    if (!searchInfo.bookName.empty()) {
-      try {
-        bookId = mp_nameMapper->getIdForName(searchInfo.bookName);
-        archive = mp_library->getArchiveById(bookId);
-      } catch (const std::out_of_range&) {
-        throw std::invalid_argument("The requested book doesn't exist.");
-      }
+  if ( startsWith(request.get_url(), "/search/") ) {
+    if (request.get_url() == "/search/searchdescription.xml") {
+      return ContentResponse::build(
+        *this,
+        RESOURCE::ft_opensearchdescription_xml,
+        get_default_data(),
+        "application/opensearchdescription+xml");
     }
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
+  }
 
+  try {
+    auto searchInfo = getSearchInfo(request);
+    auto bookIds = searchInfo.getBookIds();
 
     /* Make the search */
     // Try to get a search from the searchInfo, else build it
+    auto searcher = mp_library->getSearcherByIds(bookIds);
+    auto lock(searcher->getLock());
+
     std::shared_ptr<zim::Search> search;
     try {
       search = searchCache.getOrPut(searchInfo,
         [=](){
-          std::shared_ptr<zim::Searcher> searcher;
-          if (archive) {
-            searcher = searcherCache.getOrPut(bookId, [=](){ return std::make_shared<zim::Searcher>(*archive);});
-          } else {
-            for (auto& bookId: mp_library->filter(kiwix::Filter().local(true).valid(true))) {
-              auto currentArchive = mp_library->getArchiveById(bookId);
-              if (currentArchive) {
-                if (! searcher) {
-                  searcher = std::make_shared<zim::Searcher>(*currentArchive);
-                } else {
-                  searcher->addArchive(*currentArchive);
-                }
-              }
-           }
-          }
           return make_shared<zim::Search>(searcher->search(searchInfo.getZimQuery(m_verbose.load())));
         }
       );
     } catch(std::runtime_error& e) {
       // Searcher->search will throw a runtime error if there is no valid xapian database to do the search.
       // (in case of zim file not containing a index)
-      return HTTPErrorHtmlResponse(*this, request, MHD_HTTP_NOT_FOUND,
-                                   "Fulltext search unavailable",
-                                   "Not Found",
-                                   m_root + "/skin/search_results.css")
-           + noSearchResultsMsg()
-           + TaskbarInfo(searchInfo.bookName, archive.get());
+      const auto cssUrl = renderUrl(m_root, RESOURCE::templates::url_of_search_results_css);
+      HTTPErrorResponse response(*this, request, MHD_HTTP_NOT_FOUND,
+                                 "fulltext-search-unavailable",
+                                 "404-page-heading",
+                                 cssUrl);
+      response += nonParameterizedMessage("no-search-results");
+      if(bookIds.size() == 1) {
+        auto bookId = *bookIds.begin();
+        auto bookName = mp_nameMapper->getNameForId(bookId);
+        response += TaskbarInfo(bookName, mp_library->getArchiveById(bookId).get());
+      }
+      return response;
     }
 
-
-    auto start = 0;
+    auto start = 1;
     try {
       start = request.get_argument<unsigned int>("start");
     } catch (const std::exception&) {}
+    start = max(1, start);
 
     auto pageLength = 25;
     try {
@@ -622,24 +806,29 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
     }
 
     /* Get the results */
-    SearchRenderer renderer(search->getResults(start, pageLength), mp_nameMapper, mp_library, start,
+    SearchRenderer renderer(search->getResults(start-1, pageLength), mp_nameMapper, mp_library, start,
                             search->getEstimatedMatches());
     renderer.setSearchPattern(searchInfo.pattern);
-    renderer.setSearchContent(searchInfo.bookName);
+    renderer.setSearchBookQuery(searchInfo.bookFilterQuery);
     renderer.setProtocolPrefix(m_root + "/");
-    renderer.setSearchProtocolPrefix(m_root + "/search?");
+    renderer.setSearchProtocolPrefix(m_root + "/search");
     renderer.setPageLength(pageLength);
+    if (request.get_requested_format() == "xml") {
+      return ContentResponse::build(*this, renderer.getXml(), "application/rss+xml; charset=utf-8",
+      /*isHomePage =*/false,
+      /*raw =*/true);
+    }
     auto response = ContentResponse::build(*this, renderer.getHtml(), "text/html; charset=utf-8");
-    response->set_taskbar(searchInfo.bookName, archive.get());
+    if(bookIds.size() == 1) {
+      auto bookId = *bookIds.begin();
+      auto bookName = mp_nameMapper->getNameForId(bookId);
+      response->set_taskbar(bookName, mp_library->getArchiveById(bookId).get());
+    }
     return std::move(response);
-  } catch (const std::invalid_argument& e) {
-    return HTTP400HtmlResponse(*this, request)
+  } catch (const Error& e) {
+    return HTTP400Response(*this, request)
       + invalidUrlMsg
-      + std::string(e.what());
-  } catch (const std::exception& e) {
-    std::cerr << e.what() << std::endl;
-    return HTTP500HtmlResponse(*this, request)
-         + e.what();
+      + e.message();
   }
 }
 
@@ -649,6 +838,11 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
     printf("** running handle_random\n");
   }
 
+  if ( startsWith(request.get_url(), "/random/") ) {
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
+  }
+
   std::string bookName;
   std::shared_ptr<zim::Archive> archive;
   try {
@@ -660,7 +854,7 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
   }
 
   if (archive == nullptr) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + noSuchBookErrorMsg(bookName)
            + TaskbarInfo(bookName);
   }
@@ -669,13 +863,17 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
     auto entry = archive->getRandomEntry();
     return build_redirect(bookName, getFinalItem(*archive, entry));
   } catch(zim::EntryNotFound& e) {
-    const std::string error_details = "Oops! Failed to pick a random article :(";
-    return HTTP404HtmlResponse(*this, request)
-           + error_details
+    return HTTP404Response(*this, request)
+           + nonParameterizedMessage("random-article-failure")
            + TaskbarInfo(bookName, archive.get());
   }
 }
 
+std::unique_ptr<Response> InternalServer::handle_widget(const RequestContext& request)
+{
+  return ContentResponse::build(*this, RESOURCE::templates::widget_html, get_default_data(), "text/html; charset=utf-8", true);
+}
+
 std::unique_ptr<Response> InternalServer::handle_captured_external(const RequestContext& request)
 {
   std::string source = "";
@@ -684,7 +882,7 @@ std::unique_ptr<Response> InternalServer::handle_captured_external(const Request
   } catch (const std::out_of_range& e) {}
 
   if (source.empty()) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 
@@ -693,6 +891,20 @@ std::unique_ptr<Response> InternalServer::handle_captured_external(const Request
   return ContentResponse::build(*this, RESOURCE::templates::captured_external_html, data, "text/html; charset=utf-8");
 }
 
+std::unique_ptr<Response> InternalServer::handle_catch(const RequestContext& request)
+{
+  if (m_verbose.load()) {
+    printf("** running handle_catch\n");
+  }
+
+  if ( request.get_url() == "/catch/external" ) {
+    return handle_captured_external(request);
+  }
+
+  return HTTP404Response(*this, request)
+         + urlNotFoundMsg;
+}
+
 std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& request)
 {
   if (m_verbose.load()) {
@@ -705,7 +917,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& r
     host = request.get_header("Host");
     url  = request.get_url_part(1);
   } catch (const std::out_of_range&) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 
@@ -714,7 +926,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& r
   }
 
   if (url != "searchdescription.xml" && url != "root.xml" && url != "search") {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 
@@ -743,45 +955,6 @@ std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& r
   return std::move(response);
 }
 
-namespace
-{
-
-Filter get_search_filter(const RequestContext& request)
-{
-    auto filter = kiwix::Filter().valid(true).local(true);
-    try {
-      filter.query(request.get_argument("q"));
-    } catch (const std::out_of_range&) {}
-    try {
-      filter.maxSize(request.get_argument<unsigned long>("maxsize"));
-    } catch (...) {}
-    try {
-      filter.name(request.get_argument("name"));
-    } catch (const std::out_of_range&) {}
-    try {
-      filter.category(request.get_argument("category"));
-    } catch (const std::out_of_range&) {}
-    try {
-      filter.lang(request.get_argument("lang"));
-    } catch (const std::out_of_range&) {}
-    try {
-      filter.acceptTags(kiwix::split(request.get_argument("tag"), ";"));
-    } catch (...) {}
-    try {
-      filter.rejectTags(kiwix::split(request.get_argument("notag"), ";"));
-    } catch (...) {}
-    return filter;
-}
-
-template<class T>
-std::vector<T> subrange(const std::vector<T>& v, size_t s, size_t n)
-{
-  const size_t e = std::min(v.size(), s+n);
-  return std::vector<T>(v.begin()+std::min(v.size(), s), v.begin()+e);
-}
-
-} // unnamed namespace
-
 std::vector<std::string>
 InternalServer::search_catalog(const RequestContext& request,
                                kiwix::OPDSDumper& opdsDumper)
@@ -803,22 +976,13 @@ InternalServer::search_catalog(const RequestContext& request,
 namespace
 {
 
-std::string get_book_name(const RequestContext& request)
+ParameterizedMessage suggestSearchMsg(const std::string& searchURL, const std::string& pattern)
 {
-  try {
-    return request.get_url_part(0);
-  } catch (const std::out_of_range& e) {
-    return std::string();
-  }
-}
-
-std::string searchSuggestionHTML(const std::string& searchURL, const std::string& pattern)
-{
-  kainjow::mustache::mustache tmpl("Make a full text search for <a href=\"{{{searchURL}}}\">{{pattern}}</a>");
-  MustacheData data;
-  data.set("pattern", pattern);
-  data.set("searchURL", searchURL);
-  return (tmpl.render(data));
+  return ParameterizedMessage("suggest-search",
+                              {
+                                { "PATTERN",    pattern   },
+                                { "SEARCH_URL", searchURL }
+                              });
 }
 
 } // unnamed namespace
@@ -826,7 +990,8 @@ std::string searchSuggestionHTML(const std::string& searchURL, const std::string
 std::unique_ptr<Response>
 InternalServer::build_redirect(const std::string& bookName, const zim::Item& item) const
 {
-  auto redirectUrl = m_root + "/" + bookName + "/" + kiwix::urlEncode(item.getPath());
+  const auto path = kiwix::urlEncode(item.getPath());
+  const auto redirectUrl = m_root + "/content/" + bookName + "/" + path;
   return Response::build_redirect(*this, redirectUrl);
 }
 
@@ -838,9 +1003,10 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
     printf("** running handle_content\n");
   }
 
-  const std::string bookName = get_book_name(request);
-  if (bookName.empty())
-    return build_homepage(request);
+  const std::string contentPrefix = "/content/";
+  const bool isContentPrefixedUrl = startsWith(url, contentPrefix);
+  const size_t prefixLength = isContentPrefixedUrl ? contentPrefix.size() : 1;
+  const std::string bookName = request.get_url_part(isContentPrefixedUrl);
 
   std::shared_ptr<zim::Archive> archive;
   try {
@@ -850,13 +1016,13 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
 
   if (archive == nullptr) {
     const std::string searchURL = m_root + "/search?pattern=" + kiwix::urlEncode(pattern, true);
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg
-           + searchSuggestionHTML(searchURL, kiwix::urlDecode(pattern))
+           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern))
            + TaskbarInfo(bookName);
   }
 
-  auto urlStr = request.get_url().substr(bookName.size()+1);
+  auto urlStr = url.substr(prefixLength + bookName.size());
   if (urlStr[0] == '/') {
     urlStr = urlStr.substr(1);
   }
@@ -884,9 +1050,9 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
       printf("Failed to find %s\n", urlStr.c_str());
 
     std::string searchURL = m_root + "/search?content=" + bookName + "&pattern=" + kiwix::urlEncode(pattern, true);
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg
-           + searchSuggestionHTML(searchURL, kiwix::urlDecode(pattern))
+           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern))
            + TaskbarInfo(bookName, archive.get());
   }
 }
@@ -904,15 +1070,14 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
      bookName = request.get_url_part(1);
      kind = request.get_url_part(2);
   } catch (const std::out_of_range& e) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 
   if (kind != "meta" && kind!= "content") {
-    const std::string error_details = kind + " is not a valid request for raw content.";
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg
-           + error_details;
+           + invalidRawAccessMsg(kind);
   }
 
   std::shared_ptr<zim::Archive> archive;
@@ -922,7 +1087,7 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
   } catch (const std::out_of_range& e) {}
 
   if (archive == nullptr) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg
            + noSuchBookErrorMsg(bookName);
   }
@@ -948,11 +1113,40 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
     if (m_verbose.load()) {
       printf("Failed to find %s\n", itemPath.c_str());
     }
-    const std::string error_details = "Cannot find " + kind + " entry " + itemPath;
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg
-           + error_details;
+           + rawEntryNotFoundMsg(kind, itemPath);
   }
 }
 
+bool InternalServer::isLocallyCustomizedResource(const std::string& url) const
+{
+  return m_customizedResources->find(url) != m_customizedResources->end();
+}
+
+std::unique_ptr<Response> InternalServer::handle_locally_customized_resource(const RequestContext& request)
+{
+  if (m_verbose.load()) {
+    printf("** running handle_locally_customized_resource\n");
+  }
+
+  const CustomizedResourceData& crd = m_customizedResources->at(request.get_url());
+
+  if (m_verbose.load()) {
+    std::cout << "Reading " <<  crd.resourceFilePath << std::endl;
+  }
+  const auto resourceData = getFileContent(crd.resourceFilePath);
+
+  auto byteRange = request.get_range().resolve(resourceData.size());
+  if (byteRange.kind() != ByteRange::RESOLVED_FULL_CONTENT) {
+    return Response::build_416(*this, resourceData.size());
+  }
+
+  return ContentResponse::build(*this,
+                                resourceData,
+                                crd.mimeType,
+                                /*isHomePage=*/false,
+                                /*raw=*/true);
+}
+
 }

src/server/internalServer.h

@@ -68,31 +68,29 @@ struct GeoQuery {
 
 class SearchInfo {
   public:
-    SearchInfo(const std::string& pattern);
-    SearchInfo(const std::string& pattern, GeoQuery geoQuery);
-    SearchInfo(const RequestContext& request);
+    SearchInfo(const std::string& pattern, GeoQuery geoQuery, const Library::BookIdSet& bookIds, const std::string& bookFilterString);
 
     zim::Query getZimQuery(bool verbose) const;
+    const Library::BookIdSet& getBookIds() const { return bookIds; }
 
     friend bool operator<(const SearchInfo& l, const SearchInfo& r)
     {
-        return std::tie(l.bookName, l.pattern, l.geoQuery)
-             < std::tie(r.bookName, r.pattern, r.geoQuery); // keep the same order
+        return std::tie(l.bookIds, l.pattern, l.geoQuery)
+             < std::tie(r.bookIds, r.pattern, r.geoQuery); // keep the same order
     }
 
   public: //data
     std::string pattern;
     GeoQuery geoQuery;
-    std::string bookName;
+    Library::BookIdSet bookIds;
+    std::string bookFilterQuery;
 };
 
 
 typedef kainjow::mustache::data MustacheData;
-typedef ConcurrentCache<string, std::shared_ptr<zim::Searcher>> SearcherCache;
 typedef ConcurrentCache<SearchInfo, std::shared_ptr<zim::Search>> SearchCache;
-typedef ConcurrentCache<string, std::shared_ptr<zim::SuggestionSearcher>> SuggestionSearcherCache;
+typedef ConcurrentCache<std::string, std::shared_ptr<zim::SuggestionSearcher>> SuggestionSearcherCache;
 
-class Entry;
 class OPDSDumper;
 
 class InternalServer {
@@ -103,13 +101,14 @@ class InternalServer {
                    int port,
                    std::string root,
                    int nbThreads,
+                   unsigned int multizimSearchLimit,
                    bool verbose,
                    bool withTaskbar,
                    bool withLibraryButton,
                    bool blockExternalLinks,
                    std::string indexTemplateString,
                    int ipConnectionLimit);
-    virtual ~InternalServer() = default;
+    virtual ~InternalServer();
 
     MHD_Result handlerCallback(struct MHD_Connection* connection,
                                const char* url,
@@ -139,9 +138,12 @@ class InternalServer {
     std::unique_ptr<Response> handle_search(const RequestContext& request);
     std::unique_ptr<Response> handle_suggest(const RequestContext& request);
     std::unique_ptr<Response> handle_random(const RequestContext& request);
+    std::unique_ptr<Response> handle_catch(const RequestContext& request);
     std::unique_ptr<Response> handle_captured_external(const RequestContext& request);
     std::unique_ptr<Response> handle_content(const RequestContext& request);
     std::unique_ptr<Response> handle_raw(const RequestContext& request);
+    std::unique_ptr<Response> handle_locally_customized_resource(const RequestContext& request);
+    std::unique_ptr<Response> handle_widget(const RequestContext& request);
 
     std::vector<std::string> search_catalog(const RequestContext& request,
                                             kiwix::OPDSDumper& opdsDumper);
@@ -150,12 +152,17 @@ class InternalServer {
 
     bool etag_not_needed(const RequestContext& r) const;
     ETag get_matching_if_none_match_etag(const RequestContext& request) const;
+    std::pair<std::string, Library::BookIdSet> selectBooks(const RequestContext& r) const;
+    SearchInfo getSearchInfo(const RequestContext& r) const;
+
+    bool isLocallyCustomizedResource(const std::string& url) const;
 
   private: // data
     std::string m_addr;
     int m_port;
     std::string m_root;
     int m_nbThreads;
+    unsigned int m_multizimSearchLimit;
     std::atomic_bool m_verbose;
     bool m_withTaskbar;
     bool m_withLibraryButton;
@@ -167,13 +174,15 @@ class InternalServer {
     Library* mp_library;
     NameMapper* mp_nameMapper;
 
-    SearcherCache searcherCache;
     SearchCache searchCache;
     SuggestionSearcherCache suggestionSearcherCache;
 
     std::string m_server_id;
     std::string m_library_id;
 
+    class CustomizedResources;
+    std::unique_ptr<CustomizedResources> m_customizedResources;
+
     friend std::unique_ptr<Response> Response::build(const InternalServer& server);
     friend std::unique_ptr<ContentResponse> ContentResponse::build(const InternalServer& server, const std::string& content, const std::string& mimetype, bool isHomePage, bool raw);
     friend std::unique_ptr<Response> ItemResponse::build(const InternalServer& server, const RequestContext& request, const zim::Item& item, bool raw);

src/server/internalServer_catalog_v2.cpp

@@ -43,7 +43,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext
   try {
     url  = request.get_url_part(2);
   } catch (const std::out_of_range&) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 
@@ -70,7 +70,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext
   } else if (url == "illustration") {
     return handle_catalog_v2_illustration(request);
   } else {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 }
@@ -112,7 +112,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_complete_entry(const
   try {
     mp_library->getBookById(entryId);
   } catch (const std::out_of_range&) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 
@@ -154,14 +154,13 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_languages(const Requ
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_illustration(const RequestContext& request)
 {
   try {
-    const auto bookName  = request.get_url_part(3);
-    const auto bookId = mp_nameMapper->getIdForName(bookName);
+    const auto bookId  = request.get_url_part(3);
     auto book = mp_library->getBookByIdThreadSafe(bookId);
     auto size = request.get_argument<unsigned int>("size");
     auto illustration = book.getIllustration(size);
     return ContentResponse::build(*this, illustration->getData(), illustration->mimeType);
   } catch(...) {
-    return HTTP404HtmlResponse(*this, request)
+    return HTTP404Response(*this, request)
            + urlNotFoundMsg;
   }
 }

src/server/request_context.cpp

@@ -75,15 +75,15 @@ RequestContext::RequestContext(struct MHD_Connection* connection,
   method(str2RequestMethod(_method)),
   version(version),
   requestIndex(s_requestIndex++),
-  acceptEncodingDeflate(false),
+  acceptEncodingGzip(false),
   byteRange_()
 {
   MHD_get_connection_values(connection, MHD_HEADER_KIND, &RequestContext::fill_header, this);
   MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND, &RequestContext::fill_argument, this);
 
   try {
-    acceptEncodingDeflate =
-        (get_header(MHD_HTTP_HEADER_ACCEPT_ENCODING).find("deflate") != std::string::npos);
+    acceptEncodingGzip =
+        (get_header(MHD_HTTP_HEADER_ACCEPT_ENCODING).find("gzip") != std::string::npos);
   } catch (const std::out_of_range&) {}
 
   try {
@@ -106,7 +106,7 @@ MHD_Result RequestContext::fill_argument(void *__this, enum MHD_ValueKind kind,
                                          const char *key, const char* value)
 {
   RequestContext *_this = static_cast<RequestContext*>(__this);
-  _this->arguments[key] = value == nullptr ? "" : value;
+  _this->arguments[key].push_back(value == nullptr ? "" : value);
   return MHD_YES;
 }
 
@@ -121,13 +121,19 @@ void RequestContext::print_debug_info() const {
     printf(" - %s : '%s'\n", it->first.c_str(), it->second.c_str());
   }
   printf("arguments :\n");
-  for (auto it=arguments.begin(); it!=arguments.end(); it++) {
-    printf(" - %s : '%s'\n", it->first.c_str(), it->second.c_str());
+  for (auto& pair:arguments) {
+    printf(" - %s :", pair.first.c_str());
+    bool first = true;
+    for (auto& v: pair.second) {
+      printf("%s %s", first?"":",", v.c_str());
+      first = false;
+    }
+    printf("\n");
   }
   printf("Parsed : \n");
   printf("full_url: %s\n", full_url.c_str());
   printf("url   : %s\n", url.c_str());
-  printf("acceptEncodingDeflate : %d\n", acceptEncodingDeflate);
+  printf("acceptEncodingGzip : %d\n", acceptEncodingGzip);
   printf("has_range : %d\n", byteRange_.kind() != ByteRange::NONE);
   printf("is_valid_url : %d\n", is_valid_url());
   printf(".............\n");
@@ -176,21 +182,29 @@ ByteRange RequestContext::get_range() const {
 
 template<>
 std::string RequestContext::get_argument(const std::string& name) const {
-  return arguments.at(name);
+  return arguments.at(name)[0];
 }
 
 std::string RequestContext::get_header(const std::string& name) const {
   return headers.at(lcAll(name));
 }
 
-std::string RequestContext::get_query() const {
-  std::string q;
-  const char* sep = "";
-  for ( const auto& a : arguments ) {
-    q += sep + a.first + '=' + a.second;
-    sep = "&";
-  }
-  return q;
+std::string RequestContext::get_user_language() const
+{
+  try {
+    return get_argument("userlang");
+  } catch(const std::out_of_range&) {}
+
+  try {
+    return get_header("Accept-Language");
+  } catch(const std::out_of_range&) {}
+
+  return "en";
+}
+
+std::string RequestContext::get_requested_format() const
+{
+  return get_optional_param<std::string>("format", "html");
 }
 
 }

src/server/request_context.h

@@ -25,9 +25,11 @@
 #include <string>
 #include <sstream>
 #include <map>
+#include <vector>
 #include <stdexcept>
 
 #include "byte_range.h"
+#include "tools/stringTools.h"
 
 extern "C" {
 #include "microhttpd_wrapper.h"
@@ -68,10 +70,11 @@ class RequestContext {
     std::string get_header(const std::string& name) const;
     template<typename T=std::string>
     T get_argument(const std::string& name) const {
-        std::istringstream stream(arguments.at(name));
-        T v;
-        stream >> v;
-        return v;
+        return extractFromString<T>(get_argument(name));
+    }
+
+    std::vector<std::string> get_arguments(const std::string& name) const {
+      return arguments.at(name);
     }
 
     template<class T>
@@ -88,11 +91,34 @@ class RequestContext {
     std::string get_url() const;
     std::string get_url_part(int part) const;
     std::string get_full_url() const;
-    std::string get_query() const;
+
+    std::string get_query(bool mustEncode = false) const {
+      return get_query([](const std::string& key) {return true;}, mustEncode);
+    }
+
+    template<class F>
+    std::string get_query(F filter, bool mustEncode) const {
+      std::string q;
+      const char* sep = "";
+      auto encode = [=](const std::string& value) { return mustEncode?urlEncode(value, true):value; };
+      for ( const auto& a : arguments ) {
+        if (!filter(a.first)) {
+          continue;
+        }
+        for (const auto& v: a.second) {
+          q += sep + encode(a.first) + '=' + encode(v);
+          sep = "&";
+        }
+      }
+      return q;
+    }
 
     ByteRange get_range() const;
 
-    bool can_compress() const { return acceptEncodingDeflate; }
+    bool can_compress() const { return acceptEncodingGzip; }
+
+    std::string get_user_language() const;
+    std::string get_requested_format() const;
 
   private: // data
     std::string full_url;
@@ -101,11 +127,11 @@ class RequestContext {
     std::string version;
     unsigned long long requestIndex;
 
-    bool acceptEncodingDeflate;
+    bool acceptEncodingGzip;
 
     ByteRange byteRange_;
     std::map<std::string, std::string> headers;
-    std::map<std::string, std::string> arguments;
+    std::map<std::string, std::vector<std::string>> arguments;
 
   private: // functions
     static MHD_Result fill_header(void *, enum MHD_ValueKind, const char*, const char*);

src/server/response.cpp

@@ -31,8 +31,17 @@
 #include <mustache.hpp>
 #include <zlib.h>
 
+#include <array>
 
-#define KIWIX_MIN_CONTENT_SIZE_TO_DEFLATE 100
+// This is somehow a magic value.
+// If this value is too small, we will compress (and lost cpu time) too much
+// content.
+// If this value is too big, we will not compress enough content and send too
+// much data.
+// If we assume that MTU is 1500 Bytes it is useless to compress
+// content smaller as the content will be sent in one packet anyway.
+// 1400 Bytes seems to be a common accepted limit.
+#define KIWIX_MIN_CONTENT_SIZE_TO_COMPRESS 1400
 
 namespace kiwix {
 
@@ -44,20 +53,55 @@ std::string get_mime_type(const zim::Item& item)
 {
   try {
     return item.getMimetype();
-  } catch (exception& e) {
+  } catch (std::exception& e) {
     return "application/octet-stream";
   }
 }
 
 bool is_compressible_mime_type(const std::string& mimeType)
 {
-  return mimeType.find("text/") != string::npos
-      || mimeType.find("application/javascript") != string::npos
-      || mimeType.find("application/atom") != string::npos
-      || mimeType.find("application/opensearchdescription") != string::npos
-      || mimeType.find("application/json") != string::npos;
+  return mimeType.find("text/") != std::string::npos
+      || mimeType.find("application/javascript") != std::string::npos
+      || mimeType.find("application/atom") != std::string::npos
+      || mimeType.find("application/opensearchdescription") != std::string::npos
+      || mimeType.find("application/json") != std::string::npos;
 }
 
+bool compress(std::string &content) {
+  z_stream strm;
+  strm.zalloc = Z_NULL;
+  strm.zfree = Z_NULL;
+  strm.opaque = Z_NULL;
+
+  auto ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
+                          Z_DEFAULT_STRATEGY);
+  if (ret != Z_OK) { return false; }
+
+  strm.avail_in = static_cast<decltype(strm.avail_in)>(content.size());
+  strm.next_in =
+      const_cast<Bytef *>(reinterpret_cast<const Bytef *>(content.data()));
+
+  std::string compressed;
+
+  std::array<char, 16384> buff{};
+  do {
+    strm.avail_out = buff.size();
+    strm.next_out = reinterpret_cast<Bytef *>(buff.data());
+    ret = deflate(&strm, Z_FINISH);
+    assert(ret != Z_STREAM_ERROR);
+    compressed.append(buff.data(), buff.size() - strm.avail_out);
+  } while (strm.avail_out == 0);
+
+  assert(ret == Z_STREAM_END);
+  assert(strm.avail_in == 0);
+
+  content.swap(compressed);
+
+  deflateEnd(&strm);
+  return true;
+}
+
+
 
 } // unnamed namespace
 
@@ -87,6 +131,11 @@ std::unique_ptr<Response> Response::build_304(const InternalServer& server, cons
 const UrlNotFoundMsg urlNotFoundMsg;
 const InvalidUrlMsg invalidUrlMsg;
 
+std::string ContentResponseBlueprint::getMessage(const std::string& msgId) const
+{
+  return getTranslatedString(m_request.get_user_language(), msgId);
+}
+
 std::unique_ptr<ContentResponse> ContentResponseBlueprint::generateResponseObject() const
 {
   auto r = ContentResponse::build(m_server, m_template, m_data, m_mimeType);
@@ -97,61 +146,72 @@ std::unique_ptr<ContentResponse> ContentResponseBlueprint::generateResponseObjec
   return r;
 }
 
-HTTPErrorHtmlResponse::HTTPErrorHtmlResponse(const InternalServer& server,
-                                             const RequestContext& request,
-                                             int httpStatusCode,
-                                             const std::string& pageTitleMsg,
-                                             const std::string& headingMsg,
-                                             const std::string& cssUrl)
+HTTPErrorResponse::HTTPErrorResponse(const InternalServer& server,
+                                     const RequestContext& request,
+                                     int httpStatusCode,
+                                     const std::string& pageTitleMsgId,
+                                     const std::string& headingMsgId,
+                                     const std::string& cssUrl)
   : ContentResponseBlueprint(&server,
                              &request,
                              httpStatusCode,
-                             "text/html; charset=utf-8",
-                             RESOURCE::templates::error_html)
+                             request.get_requested_format() == "html" ? "text/html; charset=utf-8" : "application/xml; charset=utf-8",
+                             request.get_requested_format() == "html" ? RESOURCE::templates::error_html : RESOURCE::templates::error_xml)
 {
   kainjow::mustache::list emptyList;
   this->m_data = kainjow::mustache::object{
                     {"CSS_URL", onlyAsNonEmptyMustacheValue(cssUrl) },
-                    {"PAGE_TITLE",   pageTitleMsg},
-                    {"PAGE_HEADING", headingMsg},
+                    {"PAGE_TITLE",   getMessage(pageTitleMsgId)},
+                    {"PAGE_HEADING", getMessage(headingMsgId)},
                     {"details", emptyList}
   };
 }
 
-HTTP404HtmlResponse::HTTP404HtmlResponse(const InternalServer& server,
-                                             const RequestContext& request)
-  : HTTPErrorHtmlResponse(server,
-                          request,
-                          MHD_HTTP_NOT_FOUND,
-                          "Content not found",
-                          "Not Found")
+HTTP404Response::HTTP404Response(const InternalServer& server,
+                                 const RequestContext& request)
+  : HTTPErrorResponse(server,
+                      request,
+                      MHD_HTTP_NOT_FOUND,
+                      "404-page-title",
+                      "404-page-heading")
 {
 }
 
-HTTPErrorHtmlResponse& HTTP404HtmlResponse::operator+(UrlNotFoundMsg /*unused*/)
+HTTPErrorResponse& HTTP404Response::operator+(UrlNotFoundMsg /*unused*/)
 {
   const std::string requestUrl = m_request.get_full_url();
-  kainjow::mustache::mustache msgTmpl(R"(The requested URL "{{url}}" was not found on this server.)");
-  return *this + msgTmpl.render({"url", requestUrl});
+  return *this + ParameterizedMessage("url-not-found", {{"url", requestUrl}});
 }
 
-HTTPErrorHtmlResponse& HTTPErrorHtmlResponse::operator+(const std::string& msg)
+HTTPErrorResponse& HTTPErrorResponse::operator+(const std::string& msg)
 {
   m_data["details"].push_back({"p", msg});
   return *this;
 }
 
-HTTP400HtmlResponse::HTTP400HtmlResponse(const InternalServer& server,
-                                         const RequestContext& request)
-  : HTTPErrorHtmlResponse(server,
-                          request,
-                          MHD_HTTP_BAD_REQUEST,
-                          "Invalid request",
-                          "Invalid request")
+HTTPErrorResponse& HTTPErrorResponse::operator+(const ParameterizedMessage& details)
+{
+  return *this + details.getText(m_request.get_user_language());
+}
+
+HTTPErrorResponse& HTTPErrorResponse::operator+=(const ParameterizedMessage& details)
+{
+  // operator+() is already a state-modifying operator (akin to operator+=)
+  return *this + details;
+}
+
+
+HTTP400Response::HTTP400Response(const InternalServer& server,
+                                 const RequestContext& request)
+  : HTTPErrorResponse(server,
+                      request,
+                      MHD_HTTP_BAD_REQUEST,
+                      "400-page-title",
+                      "400-page-heading")
 {
 }
 
-HTTPErrorHtmlResponse& HTTP400HtmlResponse::operator+(InvalidUrlMsg /*unused*/)
+HTTPErrorResponse& HTTP400Response::operator+(InvalidUrlMsg /*unused*/)
 {
   std::string requestUrl = m_request.get_full_url();
   const auto query = m_request.get_query();
@@ -162,19 +222,19 @@ HTTPErrorHtmlResponse& HTTP400HtmlResponse::operator+(InvalidUrlMsg /*unused*/)
   return *this + msgTmpl.render({"url", requestUrl});
 }
 
-HTTP500HtmlResponse::HTTP500HtmlResponse(const InternalServer& server,
-                                         const RequestContext& request)
-  : HTTPErrorHtmlResponse(server,
-                          request,
-                          MHD_HTTP_INTERNAL_SERVER_ERROR,
-                          "Internal Server Error",
-                          "Internal Server Error")
+HTTP500Response::HTTP500Response(const InternalServer& server,
+                                 const RequestContext& request)
+  : HTTPErrorResponse(server,
+                      request,
+                      MHD_HTTP_INTERNAL_SERVER_ERROR,
+                      "500-page-title",
+                      "500-page-heading")
 {
   // operator+() is a state-modifying operator (akin to operator+=)
   *this + "An internal server error occured. We are sorry about that :/";
 }
 
-std::unique_ptr<ContentResponse> HTTP500HtmlResponse::generateResponseObject() const
+std::unique_ptr<ContentResponse> HTTP500Response::generateResponseObject() const
 {
   // We want a 500 response to be a minimalistic one (so that the server doesn't
   // have to provide additional resources required for its proper rendering)
@@ -192,6 +252,13 @@ ContentResponseBlueprint& ContentResponseBlueprint::operator+(const TaskbarInfo&
   return *this;
 }
 
+ContentResponseBlueprint& ContentResponseBlueprint::operator+=(const TaskbarInfo& taskbarInfo)
+{
+  // operator+() is already a state-modifying operator (akin to operator+=)
+  return *this + taskbarInfo;
+}
+
+
 std::unique_ptr<Response> Response::build_416(const InternalServer& server, size_t resourceLength)
 {
   auto response = Response::build(server);
@@ -240,7 +307,7 @@ static ssize_t callback_reader_from_item(void* cls,
 {
   RunningResponse* response = static_cast<RunningResponse*>(cls);
 
-  size_t max_size_to_set = min<size_t>(
+  size_t max_size_to_set = std::min<size_t>(
     max,
     response->item.getSize() - pos - response->range_start);
 
@@ -270,14 +337,20 @@ void print_response_info(int retCode, MHD_Response* response)
 }
 
 
-void ContentResponse::introduce_taskbar()
+void ContentResponse::introduce_taskbar(const std::string& lang)
 {
-  kainjow::mustache::data data;
-  data.set("root", m_root);
-  data.set("content", m_bookName);
-  data.set("hascontent", (!m_bookName.empty() && !m_bookTitle.empty()));
-  data.set("title", m_bookTitle);
-  data.set("withlibrarybutton", m_withLibraryButton);
+  i18n::GetTranslatedString t(lang);
+  kainjow::mustache::object data{
+    {"root", m_root},
+    {"content", m_bookName},
+    {"hascontent", (!m_bookName.empty() && !m_bookTitle.empty())},
+    {"title", m_bookTitle},
+    {"withlibrarybutton", m_withLibraryButton},
+    {"LIBRARY_BUTTON_TEXT", t("library-button-text")},
+    {"HOME_BUTTON_TEXT", t("home-button-text", {{"BOOK_TITLE", m_bookTitle}}) },
+    {"RANDOM_PAGE_BUTTON_TEXT", t("random-page-button-text") },
+    {"SEARCHBOX_TOOLTIP", t("searchbox-tooltip", {{"BOOK_TITLE", m_bookTitle}}) },
+  };
   auto head_content = render_template(RESOURCE::templates::head_taskbar_html, data);
   m_content = prependToFirstOccurence(
     m_content,
@@ -315,7 +388,7 @@ ContentResponse::can_compress(const RequestContext& request) const
 {
   return request.can_compress()
       && is_compressible_mime_type(m_mimeType)
-      && (m_content.size() > KIWIX_MIN_CONTENT_SIZE_TO_DEFLATE);
+      && (m_content.size() > KIWIX_MIN_CONTENT_SIZE_TO_COMPRESS);
 }
 
 bool
@@ -342,42 +415,24 @@ ContentResponse::create_mhd_response(const RequestContext& request)
     inject_root_link();
 
     if (m_withTaskbar) {
-      introduce_taskbar();
+      introduce_taskbar(request.get_user_language());
     }
     if (m_blockExternalLinks) {
       inject_externallinks_blocker();
     }
   }
 
-  bool shouldCompress = can_compress(request);
-  if (shouldCompress) {
-    std::vector<Bytef> compr_buffer(compressBound(m_content.size()));
-    uLongf comprLen = compr_buffer.capacity();
-    int err = compress(&compr_buffer[0],
-                       &comprLen,
-                       (const Bytef*)(m_content.data()),
-                       m_content.size());
-    if (err == Z_OK && comprLen > 2 && comprLen < (m_content.size() + 2)) {
-      /* /!\ Internet Explorer has a bug with deflate compression.
-         It can not handle the first two bytes (compression headers)
-         We need to chunk them off (move the content 2bytes)
-         It has no incidence on other browsers
-         See http://www.subbu.org/blog/2008/03/ie7-deflate-or-not and comments */
-      m_content = string((char*)&compr_buffer[2], comprLen - 2);
-      m_etag.set_option(ETag::COMPRESSED_CONTENT);
-    } else {
-      shouldCompress = false;
-    }
-  }
+  const bool isCompressed = can_compress(request) && compress(m_content);
 
   MHD_Response* response = MHD_create_response_from_buffer(
     m_content.size(), const_cast<char*>(m_content.data()), MHD_RESPMEM_MUST_COPY);
 
-  if (shouldCompress) {
+  if (isCompressed) {
+    m_etag.set_option(ETag::COMPRESSED_CONTENT);
     MHD_add_response_header(
         response, MHD_HTTP_HEADER_VARY, "Accept-Encoding");
     MHD_add_response_header(
-        response, MHD_HTTP_HEADER_CONTENT_ENCODING, "deflate");
+        response, MHD_HTTP_HEADER_CONTENT_ENCODING, "gzip");
   }
   return response;
 }

src/server/response.h

@@ -26,8 +26,10 @@
 
 #include <mustache.hpp>
 #include "byte_range.h"
-#include "entry.h"
 #include "etag.h"
+#include "i18n.h"
+
+#include <zim/item.h>
 
 extern "C" {
 #include "microhttpd_wrapper.h"
@@ -105,7 +107,7 @@ class ContentResponse : public Response {
   private:
     MHD_Response* create_mhd_response(const RequestContext& request);
 
-    void introduce_taskbar();
+    void introduce_taskbar(const std::string& lang);
     void inject_externallinks_blocker();
     void inject_root_link();
     bool can_compress(const RequestContext& request) const;
@@ -164,8 +166,10 @@ public: // functions
 
 
   ContentResponseBlueprint& operator+(const TaskbarInfo& taskbarInfo);
+  ContentResponseBlueprint& operator+=(const TaskbarInfo& taskbarInfo);
 
 protected: // functions
+  std::string getMessage(const std::string& msgId) const;
   virtual std::unique_ptr<ContentResponse> generateResponseObject() const;
 
 public: //data
@@ -178,49 +182,52 @@ public: //data
   std::unique_ptr<TaskbarInfo> m_taskbarInfo;
 };
 
-struct HTTPErrorHtmlResponse : ContentResponseBlueprint
+struct HTTPErrorResponse : ContentResponseBlueprint
 {
-  HTTPErrorHtmlResponse(const InternalServer& server,
-                      const RequestContext& request,
-                      int httpStatusCode,
-                      const std::string& pageTitleMsg,
-                      const std::string& headingMsg,
-                      const std::string& cssUrl = "");
+  HTTPErrorResponse(const InternalServer& server,
+                    const RequestContext& request,
+                    int httpStatusCode,
+                    const std::string& pageTitleMsgId,
+                    const std::string& headingMsgId,
+                    const std::string& cssUrl = "");
 
   using ContentResponseBlueprint::operator+;
-  HTTPErrorHtmlResponse& operator+(const std::string& msg);
+  using ContentResponseBlueprint::operator+=;
+  HTTPErrorResponse& operator+(const std::string& msg);
+  HTTPErrorResponse& operator+(const ParameterizedMessage& errorDetails);
+  HTTPErrorResponse& operator+=(const ParameterizedMessage& errorDetails);
 };
 
 class UrlNotFoundMsg {};
 
 extern const UrlNotFoundMsg urlNotFoundMsg;
 
-struct HTTP404HtmlResponse : HTTPErrorHtmlResponse
+struct HTTP404Response : HTTPErrorResponse
 {
-  HTTP404HtmlResponse(const InternalServer& server,
-                      const RequestContext& request);
+  HTTP404Response(const InternalServer& server,
+                  const RequestContext& request);
 
-  using HTTPErrorHtmlResponse::operator+;
-  HTTPErrorHtmlResponse& operator+(UrlNotFoundMsg /*unused*/);
+  using HTTPErrorResponse::operator+;
+  HTTPErrorResponse& operator+(UrlNotFoundMsg /*unused*/);
 };
 
 class InvalidUrlMsg {};
 
 extern const InvalidUrlMsg invalidUrlMsg;
 
-struct HTTP400HtmlResponse : HTTPErrorHtmlResponse
+struct HTTP400Response : HTTPErrorResponse
 {
-  HTTP400HtmlResponse(const InternalServer& server,
-                      const RequestContext& request);
+  HTTP400Response(const InternalServer& server,
+                  const RequestContext& request);
 
-  using HTTPErrorHtmlResponse::operator+;
-  HTTPErrorHtmlResponse& operator+(InvalidUrlMsg /*unused*/);
+  using HTTPErrorResponse::operator+;
+  HTTPErrorResponse& operator+(InvalidUrlMsg /*unused*/);
 };
 
-struct HTTP500HtmlResponse : HTTPErrorHtmlResponse
+struct HTTP500Response : HTTPErrorResponse
 {
-  HTTP500HtmlResponse(const InternalServer& server,
-                      const RequestContext& request);
+  HTTP500Response(const InternalServer& server,
+                  const RequestContext& request);
 
 private: // overrides
   // generateResponseObject() is overriden in order to produce a minimal

src/tools/concurrent_cache.h

@@ -1,3 +1,4 @@
+
 /*
  * Copyright (C) 2021 Matthieu Gautier <mgautier@kymeria.fr>
  * Copyright (C) 2020 Veloman Yunkan
@@ -84,11 +85,123 @@ public: // types
     return impl_.drop(key);
   }
 
-private: // data
+  size_t setMaxSize(size_t new_size) {
+    std::unique_lock<std::mutex> l(lock_);
+    return  impl_.setMaxSize(new_size);
+  }
+
+protected: // data
   Impl impl_;
   std::mutex lock_;
 };
 
+
+/**
+  WeakStore represent a thread safe store (map) of weak ptr.
+  It allows to store weak_ptr from shared_ptr and retrieve shared_ptr from
+  potential non expired weak_ptr.
+  It is not limited in size.
+*/
+template<typename Key, typename Value>
+class WeakStore {
+  private: // types
+    typedef std::weak_ptr<Value> WeakValue;
+
+  public:
+    explicit WeakStore() = default;
+
+    std::shared_ptr<Value> get(const Key& key)
+    {
+      std::lock_guard<std::mutex> l(m_lock);
+      auto it = m_weakMap.find(key);
+      if (it != m_weakMap.end()) {
+        auto shared = it->second.lock();
+        if (shared) {
+          return shared;
+        } else {
+          m_weakMap.erase(it);
+        }
+      }
+      throw std::runtime_error("No weak ptr");
+    }
+
+    void add(const Key& key, std::shared_ptr<Value> shared)
+    {
+      std::lock_guard<std::mutex> l(m_lock);
+      m_weakMap[key] = WeakValue(shared);
+    }
+
+
+  private: //data
+    std::map<Key, WeakValue> m_weakMap;
+    std::mutex m_lock;
+};
+
+template <typename Key, typename RawValue>
+class ConcurrentCache<Key, std::shared_ptr<RawValue>>
+{
+private: // types
+  typedef std::shared_ptr<RawValue> Value;
+  typedef std::shared_future<Value> ValuePlaceholder;
+  typedef lru_cache<Key, ValuePlaceholder> Impl;
+
+public: // types
+  explicit ConcurrentCache(size_t maxEntries)
+    : impl_(maxEntries)
+  {}
+
+  // Gets the entry corresponding to the given key. If the entry is not in the
+  // cache, it is obtained by calling f() (without any arguments) and the
+  // result is put into the cache.
+  //
+  // The cache as a whole is locked only for the duration of accessing
+  // the respective slot. If, in the case of the a cache miss, the generation
+  // of the missing element takes a long time, only attempts to access that
+  // element will block - the rest of the cache remains open to concurrent
+  // access.
+  template<class F>
+  Value getOrPut(const Key& key, F f)
+  {
+    std::promise<Value> valuePromise;
+    std::unique_lock<std::mutex> l(lock_);
+    const auto x = impl_.getOrPut(key, valuePromise.get_future().share());
+    l.unlock();
+    if ( x.miss() ) {
+      // Try to get back the shared_ptr from the weak_ptr first.
+      try {
+        valuePromise.set_value(m_weakStore.get(key));
+      } catch(const std::runtime_error& e) {
+        try {
+          const auto value = f();
+          valuePromise.set_value(value);
+          m_weakStore.add(key, value);
+        } catch (std::exception& e) {
+          drop(key);
+          throw;
+        }
+      }
+    }
+
+    return x.value().get();
+  }
+
+  bool drop(const Key& key)
+  {
+    std::unique_lock<std::mutex> l(lock_);
+    return impl_.drop(key);
+  }
+
+  size_t setMaxSize(size_t new_size) {
+    std::unique_lock<std::mutex> l(lock_);
+    return  impl_.setMaxSize(new_size);
+  }
+
+protected: // data
+  std::mutex lock_;
+  Impl impl_;
+  WeakStore<Key, RawValue> m_weakStore;
+};
+
 } // namespace kiwix
 
 #endif // ZIM_CONCURRENT_CACHE_H

src/tools/lrucache.h

@@ -40,6 +40,7 @@
 
 #include <map>
 #include <list>
+#include <set>
 #include <cstddef>
 #include <stdexcept>
 #include <cassert>
@@ -138,12 +139,26 @@ public: // functions
     return _cache_items_map.size();
   }
 
+  size_t setMaxSize(size_t new_size) {
+    size_t previous = _max_size;
+    _max_size = new_size;
+    return previous;
+  }
+
+  std::set<key_t> keys() const  {
+    std::set<key_t> keys;
+    for(auto& item:_cache_items_map) {
+      keys.insert(item.first);
+    }
+    return keys;
+  }
+
 private: // functions
   void putMissing(const key_t& key, const value_t& value) {
     assert(_cache_items_map.find(key) == _cache_items_map.end());
     _cache_items_list.push_front(key_value_pair_t(key, value));
     _cache_items_map[key] = _cache_items_list.begin();
-    if (_cache_items_map.size() > _max_size) {
+    while (_cache_items_map.size() > _max_size) {
       _cache_items_map.erase(_cache_items_list.back().first);
       _cache_items_list.pop_back();
     }

src/tools/otherTools.h

@@ -23,9 +23,12 @@
 #include <string>
 #include <vector>
 #include <map>
+#include <cstdlib>
 #include <zim/zim.h>
 #include <mustache.hpp>
 
+#include "stringTools.h"
+
 namespace pugi {
   class xml_node;
 }
@@ -53,6 +56,20 @@ namespace kiwix
   kainjow::mustache::data onlyAsNonEmptyMustacheValue(const std::string& s);
 
   std::string render_template(const std::string& template_str, kainjow::mustache::data data);
+
+  template<typename T>
+  T getEnvVar(const char* name, const T& defaultValue)
+  {
+    try {
+      const char* envString = std::getenv(name);
+      if (envString == nullptr) {
+        throw std::runtime_error("Environment variable not set");
+      }
+      return extractFromString<T>(envString);
+    } catch (...) {}
+
+    return defaultValue;
+  }
 }
 
 #endif

src/tools/stringTools.cpp

@@ -49,6 +49,24 @@ void kiwix::loadICUExternalTables()
 #endif
 }
 
+kiwix::ICULanguageInfo::ICULanguageInfo(const std::string& langCode)
+  : locale(langCode.c_str())
+{}
+
+std::string kiwix::ICULanguageInfo::iso3Code() const
+{
+  return locale.getISO3Language();
+}
+
+std::string kiwix::ICULanguageInfo::selfName() const
+{
+  icu::UnicodeString langSelfNameICUString;
+  locale.getDisplayLanguage(locale, langSelfNameICUString);
+  std::string langSelfName;
+  langSelfNameICUString.toUTF8String(langSelfName);
+  return langSelfName;
+}
+
 std::string kiwix::removeAccents(const std::string& text)
 {
   loadICUExternalTables();
@@ -405,3 +423,8 @@ std::vector<std::string> kiwix::getTitleVariants(const std::string& title) {
   variants.push_back(kiwix::toTitle(title));
   return variants;
 }
+
+template<>
+std::string kiwix::extractFromString(const std::string& str) {
+  return str;
+}

src/tools/stringTools.h

@@ -21,10 +21,12 @@
 #define KIWIX_STRINGTOOLS_H
 
 #include <unicode/unistr.h>
+#include <unicode/locid.h>
 
 #include <string>
 #include <vector>
 #include <sstream>
+#include <stdexcept>
 
 namespace kiwix
 {
@@ -40,6 +42,19 @@ std::string encodeDiples(const std::string& str);
 std::string removeAccents(const std::string& text);
 void loadICUExternalTables();
 
+class ICULanguageInfo
+{
+public:
+  explicit ICULanguageInfo(const std::string& langCode);
+
+  std::string iso3Code() const;
+  std::string selfName() const;
+
+private:
+  const icu::Locale locale;
+};
+
+
 std::string urlEncode(const std::string& value, bool encodeReserved = false);
 std::string urlDecode(const std::string& value, bool component = false);
 
@@ -65,9 +80,15 @@ T extractFromString(const std::string& str) {
     std::istringstream iss(str);
     T ret;
     iss >> ret;
+    if(iss.fail() || !iss.eof()) {
+        throw std::invalid_argument("no conversion");
+    }
     return ret;
 }
 
+template<>
+std::string extractFromString(const std::string& str);
+
 bool startsWith(const std::string& base, const std::string& start);
 
 std::vector<std::string> getTitleVariants(const std::string& title);

src/wrapper/java/AndroidManifest.xml

@@ -1,13 +0,0 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-
-  package="kiwix.org.kiwixlib"
->
-
-  <application android:allowBackup="true"
-    android:label="@string/app_name"
-    android:supportsRtl="true"
-  >
-
-  </application>
-
-</manifest>

src/wrapper/java/book.cpp

@@ -1,88 +0,0 @@
-/*
- * Copyright (C) 2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <jni.h>
-#include "org_kiwix_kiwixlib_Book.h"
-
-#include "utils.h"
-#include "book.h"
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_Book_allocate(
-  JNIEnv* env, jobject thisObj)
-{
-  allocate<kiwix::Book>(env, thisObj);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_Book_dispose(JNIEnv* env, jobject thisObj)
-{
-  dispose<kiwix::Book>(env, thisObj);
-}
-
-#define BOOK (getPtr<kiwix::Book>(env, thisObj))
-
-METHOD(void, Book, update__Lorg_kiwix_kiwixlib_Book_2, jobject otherBook)
-{
-  BOOK->update(*getPtr<kiwix::Book>(env, otherBook));
-}
-
-METHOD(void, Book, update__Lorg_kiwix_kiwixlib_JNIKiwixReader_2, jobject reader)
-{
-  BOOK->update(**Handle<kiwix::Reader>::getHandle(env, reader));
-}
-
-#define GETTER(retType, name) JNIEXPORT retType JNICALL \
-Java_org_kiwix_kiwixlib_Book_##name (JNIEnv* env, jobject thisObj) \
-{ \
-  auto cRet = BOOK->name(); \
-  retType ret = c2jni(cRet, env); \
-  return ret; \
-}
-
-GETTER(jstring, getId)
-GETTER(jstring, getPath)
-GETTER(jboolean, isPathValid)
-GETTER(jstring, getTitle)
-GETTER(jstring, getDescription)
-GETTER(jstring, getLanguage)
-GETTER(jstring, getCreator)
-GETTER(jstring, getPublisher)
-GETTER(jstring, getDate)
-GETTER(jstring, getUrl)
-GETTER(jstring, getName)
-GETTER(jstring, getFlavour)
-GETTER(jstring, getCategory)
-GETTER(jstring, getTags)
-GETTER(jlong, getArticleCount)
-GETTER(jlong, getMediaCount)
-GETTER(jlong, getSize)
-GETTER(jstring, getFavicon)
-GETTER(jstring, getFaviconUrl)
-GETTER(jstring, getFaviconMimeType)
-
-METHOD(jstring, Book, getTagStr, jstring tagName) try {
-  auto cRet = BOOK->getTagStr(jni2c(tagName, env));
-  return c2jni(cRet, env);
-} catch(...) {
-  return c2jni<std::string>("", env);
-}
-
-#undef GETTER

src/wrapper/java/filter.cpp

@@ -1,63 +0,0 @@
-/*
- * Copyright (C) 2019-2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <jni.h>
-#include "org_kiwix_kiwixlib_Filter.h"
-
-#include "library.h"
-#include "utils.h"
-
-/* Kiwix Reader JNI functions */
-METHOD0(void, Filter, allocate) {
-  allocate<kiwix::Filter>(env, thisObj);
-}
-
-METHOD0(void, Filter, dispose) {
-  dispose<kiwix::Library>(env, thisObj);
-}
-
-#define FILTER (getPtr<kiwix::Filter>(env, thisObj))
-
-#define FORWARD(name, args_type) \
-METHOD(jobject, Filter, name, args_type value) { \
-  FILTER->name(jni2c(value, env)); \
-  return thisObj; \
-}
-
-#define FORWARDA(name, args_type) \
-METHOD(jobject, Filter, name, jobjectArray value) { \
-  FILTER->name(jni2c<args_type>(value, env)); \
-  return thisObj; \
-}
-
-
-
-FORWARD(local, jboolean)
-FORWARD(remote, jboolean)
-FORWARD(valid, jboolean)
-FORWARDA(acceptTags, jstring)
-FORWARDA(rejectTags, jstring)
-FORWARD(lang, jstring)
-FORWARD(publisher, jstring)
-FORWARD(creator, jstring)
-FORWARD(maxSize, jlong)
-FORWARD(query, jstring)
-
-

src/wrapper/java/kiwixicu.cpp

@@ -1,44 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include <jni.h>
-#include "org_kiwix_kiwixlib_JNIICU.h"
-
-#include <iostream>
-#include <string>
-
-#include "unicode/putil.h"
-
-#include "utils.h"
-
-std::mutex globalLock;
-
-JNIEXPORT void JNICALL Java_org_kiwix_kiwixlib_JNIICU_setDataDirectory(
-    JNIEnv* env, jclass kclass, jstring dirStr)
-{
-  std::string cPath = jni2c(dirStr, env);
-
-  Lock l;
-  try {
-    u_setDataDirectory(cPath.c_str());
-  } catch (...) {
-    std::cerr << "Unable to set data directory " << cPath << std::endl;
-  }
-}

src/wrapper/java/kiwixreader.cpp

@@ -1,561 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <jni.h>
-#include <exception>
-#include "org_kiwix_kiwixlib_JNIKiwixReader.h"
-
-#include "tools/base64.h"
-#include "reader.h"
-#include "utils.h"
-
-/* Kiwix Reader JNI functions */
-JNIEXPORT jlong JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getNativeReader(
-    JNIEnv* env, jobject obj, jstring filename)
-{
-  std::string cPath = jni2c(filename, env);
-
-  LOG("Attempting to create reader with: %s", cPath.c_str());
-  Lock l;
-  try {
-    kiwix::Reader* reader = new kiwix::Reader(cPath);
-    return reinterpret_cast<jlong>(new Handle<kiwix::Reader>(reader));
-  } catch (std::exception& e) {
-    LOG("Error opening ZIM file");
-    LOG(e.what());
-    return 0;
-  }
-}
-
-namespace
-{
-
-int jni2fd(const jobject& fdObj, JNIEnv* env)
-{
-  jclass class_fdesc = env->FindClass("java/io/FileDescriptor");
-  jfieldID field_fd = env->GetFieldID(class_fdesc, "fd", "I");
-  if ( field_fd == NULL )
-  {
-    env->ExceptionClear();
-    // Under Android the (private) 'fd' field of java.io.FileDescriptor has been
-    // renamed to 'descriptor'. See, for example,
-    // https://android.googlesource.com/platform/libcore/+/refs/tags/android-8.1.0_r1/ojluni/src/main/java/java/io/FileDescriptor.java#55
-    field_fd = env->GetFieldID(class_fdesc, "descriptor", "I");
-  }
-  return env->GetIntField(fdObj, field_fd);
-}
-
-} // unnamed namespace
-
-JNIEXPORT jlong JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getNativeReaderByFD(
-    JNIEnv* env, jobject obj, jobject fdObj)
-{
-#ifndef _WIN32
-  int fd = jni2fd(fdObj, env);
-
-  LOG("Attempting to create reader with fd: %d", fd);
-  Lock l;
-  try {
-    kiwix::Reader* reader = new kiwix::Reader(fd);
-    return reinterpret_cast<jlong>(new Handle<kiwix::Reader>(reader));
-  } catch (std::exception& e) {
-    LOG("Error opening ZIM file");
-    LOG(e.what());
-    return 0;
-  }
-#else
-  jclass exception = env->FindClass("java/lang/UnsupportedOperationException");
-  env->ThrowNew(exception, "org.kiwix.kiwixlib.JNIKiwixReader.getNativeReaderByFD() is not supported under Windows");
-  return 0;
-#endif
-}
-
-JNIEXPORT jlong JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getNativeReaderEmbedded(
-    JNIEnv* env, jobject obj, jobject fdObj, jlong offset, jlong size)
-{
-#ifndef _WIN32
-  int fd = jni2fd(fdObj, env);
-
-  LOG("Attempting to create reader with fd: %d", fd);
-  Lock l;
-  try {
-    kiwix::Reader* reader = new kiwix::Reader(fd, offset, size);
-    return reinterpret_cast<jlong>(new Handle<kiwix::Reader>(reader));
-  } catch (std::exception& e) {
-    LOG("Error opening ZIM file");
-    LOG(e.what());
-    return 0;
-  }
-#else
-  jclass exception = env->FindClass("java/lang/UnsupportedOperationException");
-  env->ThrowNew(exception, "org.kiwix.kiwixlib.JNIKiwixReader.getNativeReaderEmbedded() is not supported under Windows");
-  return 0;
-#endif
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_dispose(JNIEnv* env, jobject obj)
-{
-  Handle<kiwix::Reader>::dispose(env, obj);
-}
-
-#define READER (Handle<kiwix::Reader>::getHandle(env, obj))
-
-/* Kiwix library functions */
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getMainPage(JNIEnv* env, jobject obj)
-{
-  jstring url;
-
-  try {
-    std::string cUrl = READER->getMainPage().getPath();
-    url = c2jni(cUrl, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM main page");
-    LOG(e.what());
-    url = NULL;
-  }
-  return url;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getId(JNIEnv* env, jobject obj)
-{
-  jstring id;
-
-  try {
-    std::string cId = READER->getId();
-    id = c2jni(cId, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM id");
-    LOG(e.what());
-    id = NULL;
-  }
-
-  return id;
-}
-
-JNIEXPORT jint JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getFileSize(JNIEnv* env, jobject obj)
-{
-  jint size = 0;
-
-  try {
-    int cSize = READER->getFileSize();
-    size = c2jni(cSize, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM file size");
-    LOG(e.what());
-  }
-
-  return size;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getCreator(JNIEnv* env, jobject obj)
-{
-  jstring creator;
-
-  try {
-    std::string cCreator = READER->getCreator();
-    creator = c2jni(cCreator, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM creator");
-    LOG(e.what());
-    creator = NULL;
-  }
-
-  return creator;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getPublisher(JNIEnv* env, jobject obj)
-{
-  jstring publisher;
-
-  try {
-    std::string cPublisher = READER->getPublisher();
-    publisher = c2jni(cPublisher, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM publish");
-    LOG(e.what());
-    publisher = NULL;
-  }
-  return publisher;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getName(JNIEnv* env, jobject obj)
-{
-  jstring name;
-
-  try {
-    std::string cName = READER->getName();
-    name = c2jni(cName, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM name");
-    LOG(e.what());
-    name = NULL;
-  }
-  return name;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getFavicon(JNIEnv* env, jobject obj)
-{
-  jstring favicon;
-
-  try {
-    std::string cContent;
-    std::string cMime;
-    READER->getFavicon(cContent, cMime);
-    favicon = c2jni(
-        base64_encode(cContent),
-        env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM favicon");
-    LOG(e.what());
-    favicon = NULL;
-  }
-  return favicon;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getDate(JNIEnv* env, jobject obj)
-{
-  jstring date;
-
-  try {
-    std::string cDate = READER->getDate();
-    date = c2jni(cDate, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM date");
-    LOG(e.what());
-    date = NULL;
-  }
-  return date;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getLanguage(JNIEnv* env, jobject obj)
-{
-  jstring language;
-
-  try {
-    std::string cLanguage = READER->getLanguage();
-    language = c2jni(cLanguage, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM language");
-    LOG(e.what());
-    language = NULL;
-  }
-
-  return language;
-}
-
-JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getMimeType(
-    JNIEnv* env, jobject obj, jstring url)
-{
-  jstring mimeType;
-
-  std::string cUrl = jni2c(url, env);
-  try {
-    auto entry = READER->getEntryFromEncodedPath(cUrl);
-    auto cMimeType = entry.getMimetype();
-    mimeType = c2jni(cMimeType, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get mime-type for url: %s", cUrl.c_str());
-    LOG(e.what());
-    mimeType = NULL;
-  }
-  return mimeType;
-}
-
-JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_checkUrl(
-     JNIEnv* env, jobject obj, jstring url)
-{
-  jstring finalUrl;
-  std::string cUrl = jni2c(url, env);
-  try {
-    auto entry = READER->getEntryFromEncodedPath(cUrl);
-    entry = entry.getFinalEntry();
-    finalUrl = c2jni(entry.getPath(), env);
-  } catch (std::exception& e) {
-    finalUrl = c2jni(std::string(), env);
-  }
-  return finalUrl;
-}
-
-JNIEXPORT jbyteArray JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getContent(
-    JNIEnv* env, jobject obj, jobject url, jobject titleObj, jobject mimeTypeObj, jobject sizeObj)
-{
-  /* Default values */
-  setStringObjValue("", titleObj, env);
-  setStringObjValue("", mimeTypeObj, env);
-  setIntObjValue(0, sizeObj, env);
-  jbyteArray data = env->NewByteArray(0);
-
-  /* Retrieve the content */
-  std::string cUrl = getStringObjValue(url, env);
-  unsigned int cSize = 0;
-
-  try {
-    auto entry = READER->getEntryFromEncodedPath(cUrl);
-    bool isRedirect = entry.isRedirect();
-    entry = entry.getFinalEntry();
-    cSize = entry.getSize();
-    setIntObjValue(cSize, sizeObj, env);
-    setStringObjValue(entry.getMimetype(), mimeTypeObj, env);
-    setStringObjValue(entry.getTitle(), titleObj, env);
-    if (isRedirect) {
-      setStringObjValue(entry.getPath(), url, env);
-    } else {
-      data = env->NewByteArray(cSize);
-      env->SetByteArrayRegion(
-          data, 0, cSize, reinterpret_cast<const jbyte*>(entry.getBlob().data()));
-    }
-  } catch (std::exception& e) {
-    LOG("Unable to get content for url: %s", cUrl.c_str());
-    LOG(e.what());
-  }
-
-  return data;
-}
-
-JNIEXPORT jbyteArray JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getContentPart(
-    JNIEnv* env, jobject obj, jstring url, jint offset, jint len, jobject sizeObj)
-{
-  jbyteArray data = env->NewByteArray(0);
-  setIntObjValue(0, sizeObj, env);
-
-  /* Default values */
-  /* Retrieve the content */
-  std::string cUrl = jni2c(url, env);
-  unsigned int cOffset = jni2c(offset, env);
-  unsigned int cLen = jni2c(len, env);
-  try {
-    auto entry = READER->getEntryFromEncodedPath(cUrl);
-    entry = entry.getFinalEntry();
-
-    if (cLen == 0) {
-      setIntObjValue(entry.getSize(), sizeObj, env);
-    } else if (cOffset+cLen < entry.getSize()) {
-      auto blob = entry.getBlob(cOffset, cLen);
-      data = env->NewByteArray(cLen);
-      env->SetByteArrayRegion(
-          data, 0, cLen, reinterpret_cast<const jbyte*>(blob.data()));
-      setIntObjValue(cLen, sizeObj, env);
-    }
-  } catch (std::exception& e) {
-    LOG("Unable to get partial content for url: %s (%u : %u)", cUrl.c_str(), cOffset, cLen);
-    LOG(e.what());
-  }
-  return data;
-}
-
-JNIEXPORT jlong JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getArticleSize(
-    JNIEnv* env, jobject obj, jstring url)
-{
-  std::string cUrl = jni2c(url, env);
-  try {
-    auto entry = READER->getEntryFromEncodedPath(cUrl);
-    entry = entry.getFinalEntry();
-    return c2jni(entry.getSize(), env);
-  } catch(std::exception& e) {
-    LOG("Unable to get size for url : %s", cUrl.c_str());
-    LOG(e.what());
-  }
-  return c2jni(0, env);
-}
-
-JNIEXPORT jobject JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getDirectAccessInformation(
-    JNIEnv* env, jobject obj, jstring url)
-{
-   jclass daiClass = env->FindClass("org/kiwix/kiwixlib/DirectAccessInfo");
-   jmethodID daiInitMethod = env->GetMethodID(daiClass, "<init>", "()V");
-   jobject dai = env->NewObject(daiClass, daiInitMethod);
-   setDaiObjValue("", 0, dai, env);
-
-   std::string cUrl = jni2c(url, env);
-   try {
-    auto entry = READER->getEntryFromEncodedPath(cUrl);
-    entry = entry.getFinalEntry();
-    auto part_info = entry.getDirectAccessInfo();
-    setDaiObjValue(part_info.first, part_info.second, dai, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get direct access info for url: %s", cUrl.c_str());
-    LOG(e.what());
-  }
-  return dai;
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_searchSuggestions(JNIEnv* env,
-                                                         jobject obj,
-                                                         jstring prefix,
-                                                         jint count)
-{
-  jboolean retVal = JNI_FALSE;
-  std::string cPrefix = jni2c(prefix, env);
-  unsigned int cCount = jni2c(count, env);
-
-  try {
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-    if (READER->searchSuggestionsSmart(cPrefix, cCount)) {
-      retVal = JNI_TRUE;
-    }
-#pragma GCC diagnostic pop
-  } catch (std::exception& e) {
-    LOG("Unable to get search results for pattern: %s", cPrefix.c_str());
-    LOG(e.what());
-  }
-
-  return retVal;
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getNextSuggestion(JNIEnv* env,
-                                                         jobject obj,
-                                                         jobject titleObj,
-                                                         jobject urlObj)
-{
-  jboolean retVal = JNI_FALSE;
-  std::string cTitle;
-  std::string cUrl;
-
-  try {
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-    if (READER->getNextSuggestion(cTitle, cUrl)) {
-      setStringObjValue(cTitle, titleObj, env);
-      setStringObjValue(cUrl, urlObj, env);
-      retVal = JNI_TRUE;
-    }
-#pragma GCC diagnostic pop
-  } catch (std::exception& e) {
-    LOG("Unable to get next suggestion");
-    LOG(e.what());
-  }
-
-  return retVal;
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getPageUrlFromTitle(JNIEnv* env,
-                                                           jobject obj,
-                                                           jstring title,
-                                                           jobject urlObj)
-{
-  std::string cTitle = jni2c(title, env);
-
-  try {
-    auto entry = READER->getEntryFromTitle(cTitle);
-    entry = entry.getFinalEntry();
-    setStringObjValue(entry.getPath(), urlObj, env);
-    return JNI_TRUE;
-  } catch (std::exception& e) {
-    LOG("Unable to get url for title %s: ", cTitle.c_str());
-    LOG(e.what());
-  }
-
-  return JNI_FALSE;
-}
-
-JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getTitle(
-    JNIEnv* env, jobject obj)
-{
-  jstring title;
-
-  try {
-    std::string cTitle = READER->getTitle();
-    title = c2jni(cTitle, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get zim title");
-    LOG(e.what());
-    title = NULL;
-  }
-  return title;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getDescription(JNIEnv* env, jobject obj)
-{
-  jstring description;
-
-  try {
-    std::string cDescription = READER->getDescription();
-    description = c2jni(cDescription, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get zim description");
-    LOG(e.what());
-    description = NULL;
-  }
-  return description;
-}
-
-JNIEXPORT jint JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getArticleCount(JNIEnv* env, jobject obj)
-{
-  jint articleCount = 0;
-  try {
-    auto cArticleCount = READER->getArticleCount();
-    articleCount = c2jni(cArticleCount, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get article count.");
-    LOG(e.what());
-  }
-  return articleCount;
-}
-
-JNIEXPORT jint JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixReader_getMediaCount(JNIEnv* env, jobject obj)
-{
-  jint mediaCount = 0;
-  try {
-    auto cMediaCount = READER->getMediaCount();
-    mediaCount = c2jni(cMediaCount, env);
-  } catch (std::exception& e) {
-    LOG("Unable to get media count.");
-    LOG(e.what());
-  }
-  return mediaCount;
-}
-
-
-JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwixReader_getRandomPage(
-    JNIEnv* env, jobject obj, jobject urlObj)
-{
-  jboolean retVal = JNI_FALSE;
-  std::string cUrl;
-
-  try {
-    std::string cUrl = READER->getRandomPage().getPath();
-    setStringObjValue(cUrl, urlObj, env);
-    retVal = JNI_TRUE;
-  } catch (std::exception& e) {
-    LOG("Unable to get random page");
-    LOG(e.what());
-  }
-  return retVal;
-}

src/wrapper/java/kiwixsearcher.cpp

@@ -1,123 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include "org_kiwix_kiwixlib_JNIKiwixSearcher.h"
-#include "org_kiwix_kiwixlib_JNIKiwixSearcher_Result.h"
-
-#include "reader.h"
-#include "searcher.h"
-#include "utils.h"
-
-#define SEARCHER (Handle<kiwix::Searcher>::getHandle(env, obj))
-#define RESULT (Handle<kiwix::Result>::getHandle(env, obj))
-
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_dispose(JNIEnv* env, jobject obj)
-{
-  Handle<kiwix::Searcher>::dispose(env, obj);
-}
-
-/* Kiwix Reader JNI functions */
-JNIEXPORT jlong JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_getNativeHandle(JNIEnv* env,
-                                                          jobject obj)
-{
-  kiwix::Searcher* searcher = new kiwix::Searcher();
-  return reinterpret_cast<jlong>(new Handle<kiwix::Searcher>(searcher));
-}
-
-/* Kiwix library functions */
-JNIEXPORT void JNICALL Java_org_kiwix_kiwixlib_JNIKiwixSearcher_addReader(
-    JNIEnv* env, jobject obj, jobject reader)
-{
-  auto searcher = SEARCHER;
-
-  searcher->add_reader(*(Handle<kiwix::Reader>::getHandle(env, reader)));
-}
-
-JNIEXPORT void JNICALL Java_org_kiwix_kiwixlib_JNIKiwixSearcher_search(
-    JNIEnv* env, jobject obj, jstring query, jint count)
-{
-  std::string cquery = jni2c(query, env);
-  unsigned int ccount = jni2c(count, env);
-
-  SEARCHER->search(cquery, 0, ccount);
-}
-
-JNIEXPORT jobject JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_getNextResult(JNIEnv* env,
-                                                         jobject obj)
-{
-  jobject result = nullptr;
-
-  kiwix::Result* cresult = SEARCHER->getNextResult();
-  if (cresult != nullptr) {
-    jclass resultclass
-        = env->FindClass("org/kiwix/kiwixlib/JNIKiwixSearcher$Result");
-    jmethodID ctor = env->GetMethodID(
-        resultclass, "<init>", "(Lorg/kiwix/kiwixlib/JNIKiwixSearcher;JLorg/kiwix/kiwixlib/JNIKiwixSearcher;)V");
-    result = env->NewObject(resultclass, ctor, obj, reinterpret_cast<jlong>(new Handle<kiwix::Result>(cresult)), obj);
-  }
-  return result;
-}
-
-JNIEXPORT void JNICALL Java_org_kiwix_kiwixlib_JNIKiwixSearcher_00024Result_dispose(
-    JNIEnv* env, jobject obj)
-{
-  Handle<kiwix::Result>::dispose(env, obj);
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_00024Result_getUrl(JNIEnv* env,
-                                                        jobject obj)
-{
-  try {
-    return c2jni(RESULT->get_url(), env);
-  } catch (...) {
-    return nullptr;
-  }
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_00024Result_getTitle(JNIEnv* env,
-                                                          jobject obj)
-{
-  try {
-    return c2jni(RESULT->get_title(), env);
-  } catch (...) {
-    return nullptr;
-  }
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_00024Result_getSnippet(JNIEnv* env,
-                                                            jobject obj)
-{
-  return c2jni(RESULT->get_snippet(), env);
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixSearcher_00024Result_getContent(JNIEnv* env,
-                                                            jobject obj)
-{
-  return c2jni(RESULT->get_content(), env);
-}

src/wrapper/java/kiwixserver.cpp

@@ -1,103 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <jni.h>
-#include "org_kiwix_kiwixlib_JNIKiwixServer.h"
-
-#include "tools/base64.h"
-#include "server.h"
-#include "utils.h"
-
-/* Kiwix Reader JNI functions */
-JNIEXPORT jlong JNICALL Java_org_kiwix_kiwixlib_JNIKiwixServer_getNativeServer(
-    JNIEnv* env, jobject obj, jobject jLibrary)
-{
-  LOG("Attempting to create server");
-  Lock l;
-  try {
-    auto library = getPtr<kiwix::Library>(env, jLibrary);
-    kiwix::Server* server = new kiwix::Server(library);
-    return reinterpret_cast<jlong>(new Handle<kiwix::Server>(server));
-  } catch (std::exception& e) {
-    LOG("Error creating the server");
-    LOG(e.what());
-    return 0;
-  }
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_dispose(JNIEnv* env, jobject obj)
-{
-  Handle<kiwix::Server>::dispose(env, obj);
-}
-
-#define SERVER (Handle<kiwix::Server>::getHandle(env, obj))
-
-/* Kiwix library functions */
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_setRoot(JNIEnv* env, jobject obj, jstring jRoot)
-{
-  std::string root = jni2c(jRoot, env);
-  SERVER->setRoot(root);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_setAddress(JNIEnv* env, jobject obj, jstring jAddress)
-{
-  std::string address = jni2c(jAddress, env);
-  SERVER->setAddress(address);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_setPort(JNIEnv* env, jobject obj, int port)
-{
-  SERVER->setPort(port);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_setNbThreads(JNIEnv* env, jobject obj, int threads)
-{
-  SERVER->setNbThreads(threads);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_setTaskbar(JNIEnv* env, jobject obj, jboolean withTaskbar, jboolean withLibraryButton)
-{
-  SERVER->setTaskbar(withTaskbar, withLibraryButton);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_setBlockExternalLinks(JNIEnv* env, jobject obj, jboolean blockExternalLinks)
-{
-  SERVER->setBlockExternalLinks(blockExternalLinks);
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_start(JNIEnv* env, jobject obj)
-{
-  return SERVER->start();
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_JNIKiwixServer_stop(JNIEnv* env, jobject obj)
-{
-  SERVER->stop();
-}

src/wrapper/java/library.cpp

@@ -1,96 +0,0 @@
-/*
- * Copyright (C) 2019-2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <jni.h>
-#include "org_kiwix_kiwixlib_Library.h"
-
-#include "library.h"
-#include "reader.h"
-#include "utils.h"
-
-/* Kiwix Reader JNI functions */
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_Library_allocate(
-    JNIEnv* env, jobject thisObj)
-{
-  allocate<kiwix::Library>(env, thisObj);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_Library_dispose(JNIEnv* env, jobject thisObj)
-{
-  dispose<kiwix::Library>(env, thisObj);
-}
-
-#define LIBRARY (getPtr<kiwix::Library>(env, thisObj))
-
-/* Kiwix library functions */
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_Library_addBook(
-  JNIEnv* env, jobject thisObj, jstring path)
-{
-  auto cPath = jni2c(path, env);
-
-  try {
-    kiwix::Reader reader(cPath);
-    kiwix::Book book;
-    book.update(reader);
-    return LIBRARY->addBook(book);
-  } catch (std::exception& e) {
-    LOG("Unable to add the book");
-    LOG(e.what()); }
-  return false;
-}
-
-METHOD(jobject, Library, getBookById, jstring id) {
-  auto cId = jni2c(id, env);
-  auto cBook = new kiwix::Book(LIBRARY->getBookById(cId));
-  jclass cls = env->FindClass("org/kiwix/kiwixlib/Book");
-  jmethodID constructorId = env->GetMethodID(cls, "<init>", "()V");
-  jobject book = env->NewObject(cls, constructorId);
-  setPtr(env, book, cBook);
-  return book;
-}
-
-METHOD(jint, Library, getBookCount, jboolean localBooks, jboolean remoteBooks) {
-  return LIBRARY->getBookCount(localBooks, remoteBooks);
-}
-
-METHOD0(jobjectArray, Library, getBooksIds) {
-  return c2jni(LIBRARY->getBooksIds(), env);
-}
-
-METHOD(jobjectArray, Library, filter, jobject filterObj) {
-  auto filter = getPtr<kiwix::Filter>(env, filterObj);
-  return c2jni(LIBRARY->filter(*filter), env);
-}
-
-METHOD0(jobjectArray, Library, getBooksLanguages) {
-  return c2jni(LIBRARY->getBooksLanguages(), env);
-}
-
-METHOD0(jobjectArray, Library, getBooksCreators) {
-  return c2jni(LIBRARY->getBooksCreators(), env);
-}
-
-METHOD0(jobjectArray, Library, getBooksPublisher) {
-  return c2jni(LIBRARY->getBooksPublishers(), env);
-}
-

src/wrapper/java/manager.cpp

@@ -1,131 +0,0 @@
-/*
- * Copyright (C) 2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <jni.h>
-#include "org_kiwix_kiwixlib_Manager.h"
-
-#include "manager.h"
-#include "utils.h"
-
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_Manager_allocate(
-  JNIEnv* env, jobject thisObj, jobject libraryObj)
-{
-  auto lib = getPtr<kiwix::Library>(env, libraryObj);
-  allocate<kiwix::Manager>(env, thisObj, lib);
-}
-
-JNIEXPORT void JNICALL
-Java_org_kiwix_kiwixlib_Manager_dispose(JNIEnv* env, jobject thisObj)
-{
-  dispose<kiwix::Manager>(env, thisObj);
-}
-
-#define MANAGER (getPtr<kiwix::Manager>(env, thisObj))
-
-/* Kiwix manager functions */
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_Manager_readFile(
-  JNIEnv* env, jobject thisObj, jstring path)
-{
-  auto cPath = jni2c(path, env);
-
-  try {
-    return MANAGER->readFile(cPath);
-  } catch (std::exception& e) {
-    LOG("Unable to get readFile");
-    LOG(e.what());
-  }
-  return false;
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_Manager_readXml(
-  JNIEnv* env, jobject thisObj, jstring content, jstring libraryPath)
-{
-  auto cContent = jni2c(content, env);
-  auto cPath = jni2c(libraryPath, env);
-
-  try {
-    return MANAGER->readXml(cContent, false, cPath);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM id");
-    LOG(e.what());
-  }
-
-  return false;
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_Manager_readOpds(
-  JNIEnv* env, jobject thisObj, jstring content, jstring urlHost)
-{
-  auto cContent = jni2c(content, env);
-  auto cUrl = jni2c(urlHost, env);
-
-  try {
-    return MANAGER->readOpds(cContent, cUrl);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM id");
-    LOG(e.what());
-  }
-
-  return false;
-}
-
-JNIEXPORT jboolean JNICALL
-Java_org_kiwix_kiwixlib_Manager_readBookmarkFile(
-  JNIEnv* env, jobject thisObj, jstring path)
-{
-  auto cPath = jni2c(path, env);
-
-  try {
-    return MANAGER->readBookmarkFile(cPath);
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM id");
-    LOG(e.what());
-  }
-
-  return false;
-}
-
-JNIEXPORT jstring JNICALL
-Java_org_kiwix_kiwixlib_Manager_addBookFromPath(
-  JNIEnv* env, jobject thisObj,
-  jstring pathToOpen, jstring pathToSave, jstring url, jboolean checkMetaData)
-{
-  auto cPathToOpen = jni2c(pathToOpen, env);
-  auto cPathToSave = jni2c(pathToSave, env);
-  auto cUrl = jni2c(url, env);
-  jstring id = NULL;
-
-  try {
-    auto cId = MANAGER->addBookFromPathAndGetId(cPathToOpen, cPathToSave, cUrl, checkMetaData);
-    if ( !cId.empty() ) {
-      id = c2jni(cId, env);
-    }
-  } catch (std::exception& e) {
-    LOG("Unable to get ZIM file size");
-    LOG(e.what());
-  }
-
-  return id;
-}

src/wrapper/java/meson.build

@@ -1,55 +0,0 @@
-
-java_sources = files([
-  'org/kiwix/kiwixlib/JNIICU.java',
-  'org/kiwix/kiwixlib/Book.java',
-  'org/kiwix/kiwixlib/JNIKiwixReader.java',
-  'org/kiwix/kiwixlib/Library.java',
-  'org/kiwix/kiwixlib/Manager.java',
-  'org/kiwix/kiwixlib/Filter.java',
-  'org/kiwix/kiwixlib/JNIKiwixSearcher.java',
-  'org/kiwix/kiwixlib/JNIKiwixServer.java',
-  'org/kiwix/kiwixlib/JNIKiwixInt.java',
-  'org/kiwix/kiwixlib/JNIKiwixString.java',
-  'org/kiwix/kiwixlib/JNIKiwixBool.java',
-  'org/kiwix/kiwixlib/JNIKiwixException.java',
-  'org/kiwix/kiwixlib/DirectAccessInfo.java'
-])
-
-kiwix_jni = custom_target('jni',
-  input: java_sources,
-  output: ['org_kiwix_kiwixlib_JNIKiwix.h',
-           'org_kiwix_kiwixlib_Book.h',
-           'org_kiwix_kiwixlib_JNIKiwixReader.h',
-           'org_kiwix_kiwixlib_Library.h',
-           'org_kiwix_kiwixlib_Manager.h',
-           'org_kiwix_kiwixlib_Filter.h',
-           'org_kiwix_kiwixlib_JNIKiwixServer.h',
-           'org_kiwix_kiwixlib_JNIKiwixSearcher.h',
-           'org_kiwix_kiwixlib_JNIKiwixSearcher_Result.h'],
-  command:['javac', '-d', '@OUTDIR@', '-h', '@OUTDIR@', '@INPUT@']
-)
-
-jni_sources = files([
-     'kiwixicu.cpp',
-     'book.cpp',
-     'kiwixreader.cpp',
-     'library.cpp',
-     'manager.cpp',
-     'filter.cpp',
-     'kiwixsearcher.cpp',
-     'kiwixserver.cpp',
-])
-
-kiwix_sources += jni_sources + [kiwix_jni]
-
-if 'java' in wrapper
-  kiwix_jar = jar('kiwixlib', java_sources)
-  #junit_jar = files('org/kiwix/testing/junit-4.13.jar')
-  #test_jar = jar('testing', 'org/kiwix/testing/test.java',
-  #               link_with: [kiwix_jar, junit_jar])
-  #test('javatest', test_jar)
-endif
-
-install_subdir('org', install_dir: 'kiwix-lib/java', exclude_directories: ['kiwix/testing'])
-install_subdir('res', install_dir: 'kiwix-lib')
-install_data('AndroidManifest.xml', install_dir: 'kiwix-lib')

src/wrapper/java/org/kiwix/kiwixlib/Book.java

@@ -1,48 +0,0 @@
-
-package org.kiwix.kiwixlib;
-
-public class Book
-{
-  public Book() { allocate(); }
-
-
-  public native void update(Book book);
-  public native void update(JNIKiwixReader reader);
-
-  @Override
-  protected void finalize() { dispose();  }
-
-  public native String getId();
-  public native String getPath();
-  public native boolean isPathValid();
-  public native String getTitle();
-  public native String getDescription();
-  public native String getLanguage();
-  public native String getCreator();
-  public native String getPublisher();
-  public native String getDate();
-  public native String getUrl();
-  public native String getName();
-  public native String getFlavour();
-  public native String getCategory();
-  public native String getTags();
-  /**
-   * Return the value associated to the tag tagName
-   *
-   * @param tagName the tag name to search for.
-   * @return The value of the tag. If the tag is not found, return empty string.
-   */
-  public native String getTagStr(String tagName);
-
-  public native long getArticleCount();
-  public native long getMediaCount();
-  public native long getSize();
-
-  public native String getFavicon();
-  public native String getFaviconUrl();
-  public native String getFaviconMimeType();
-
-  private native void allocate();
-  private native void dispose();
-  private long nativeHandle;
-}

src/wrapper/java/org/kiwix/kiwixlib/DirectAccessInfo.java

@@ -1,26 +0,0 @@
-/*
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class DirectAccessInfo
-{
-  public String filename;
-  public long offset;
-}

src/wrapper/java/org/kiwix/kiwixlib/Filter.java

@@ -1,44 +0,0 @@
-/*
- * Copyright (C) 2019-2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class Filter
-{
-
-  public native Filter local(boolean accept);
-  public native Filter remote(boolean accept);
-  public native Filter valid(boolean accept);
-  public native Filter acceptTags(String[] tags);
-  public native Filter rejectTags(String[] tags);
-  public native Filter lang(String lang);
-  public native Filter publisher(String publisher);
-  public native Filter creator(String creator);
-  public native Filter maxSize(long size);
-  public native Filter query(String query);
-
-
-  public Filter() { allocate(); }
-
-  @Override
-  protected void finalize() { dispose(); }
-  private native void allocate();
-  private native void dispose();
-  private long nativeHandle;
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIICU.java

@@ -1,26 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class JNIICU
-{
-  static public native void setDataDirectory(String icuDataDir);
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwix.java

@@ -1,36 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-import android.content.Context;
-import com.getkeepsafe.relinker.ReLinker;
-import org.kiwix.kiwixlib.JNIICU;
-
-public class JNIKiwix
-{
-  public JNIKiwix(final Context context){
-    ReLinker.loadLibrary(context, "kiwix");
-  }
-
-  public void setDataDirectory(String icuDataDir) {
-    JNIICU.setDataDirectory(icuDataDir);
-  }
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixBool.java

@@ -1,25 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class JNIKiwixBool
-{
-  public boolean value;
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixException.java

@@ -1,27 +0,0 @@
-/*
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class JNIKiwixException extends Exception
-{
-  public JNIKiwixException(String message) {
-    super(message);
-  }
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixInt.java

@@ -1,25 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class JNIKiwixInt
-{
-  public int value;
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixReader.java

@@ -1,182 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-import org.kiwix.kiwixlib.JNIKiwixException;
-import org.kiwix.kiwixlib.JNIKiwixString;
-import org.kiwix.kiwixlib.JNIKiwixInt;
-import org.kiwix.kiwixlib.JNIKiwixSearcher;
-import org.kiwix.kiwixlib.DirectAccessInfo;
-import java.io.FileDescriptor;
-
-public class JNIKiwixReader
-{
-  public native String getMainPage();
-
-  public native String getTitle();
-
-  public native String getId();
-
-  public native String getLanguage();
-
-  public native String getMimeType(String url);
-
-  /**
-   * Check if a url exists and is a redirect or not.
-   *
-   * Return an empty string if the url doesn't exist in the reader.
-   * Return the url of the "final" entry.
-   * - equal to the input url if the entry is not a redirection.
-   * - different if the url is a redirection (and the webview should redirect to it).
-   */
-  public native String checkUrl(String url);
-
-  /**
-   * Get the content of a article.
-   *
-   * Return a byte array of the content of the article.
-   * Set the title, mimeType to the title and mimeType of the article.
-   * Set the size to the size of the returned array.
-   *
-   * If the entry doesn't exist :
-   *  - return a empty byte array
-   *  - set all arguments (except url) to empty/0.
-   * If the entry exist but is a redirection :
-   *  - return an empty byte array
-   *  - set all arguments (including url) to information of the targeted article.
-   */
-  public native byte[] getContent(JNIKiwixString url,
-                                  JNIKiwixString title,
-                                  JNIKiwixString mimeType,
-                                  JNIKiwixInt size);
-
-  /**
-   * getContentPart.
-   *
-   * Get only a part of the content of the article.
-   * Return a byte array of `len` size starting from offset `offset`.
-   * Set `size` to the number of bytes read
-   * (`len` if everything is ok, 0 in case of error).
-   * If `len` == 0, no bytes are read but `size` is set to the total size of the
-   * article.
-   */
-  public native byte[] getContentPart(String url,
-                                      int offest,
-                                      int len,
-                                      JNIKiwixInt size);
-
-  /**
-   *
-   * Get the size of an article.
-   *
-   * @param   url The url of the article.
-   * @return  The size of the final (redirections are resolved) article (in byte).
-   *          Return 0 if the article is not found.
-   */
-  public native long getArticleSize(String url);
-
-  /**
-   * getDirectAccessInformation.
-   *
-   * Return information giving where the content is located in the zim file.
-   *
-   * Some contents (binary content) are stored uncompressed in the zim file.
-   * Knowing this information, it could be interesting to directly open
-   * the zim file (or zim part) and directly read the content from it (and so
-   * bypassing the libzim).
-   *
-   * Return a `DirectAccessInfo` (filename, offset) where the content is located.
-   *
-   * If the content cannot be directly accessed (content is compressed or zim
-   * file is cut in the middle of the content), the filename is an empty string
-   * and offset is zero.
-   */
-  public native DirectAccessInfo getDirectAccessInformation(String url);
-
-  public native boolean searchSuggestions(String prefix, int count);
-
-  public native boolean getNextSuggestion(JNIKiwixString title, JNIKiwixString url);
-
-  public native boolean getPageUrlFromTitle(String title, JNIKiwixString url);
-
-  public native String getDescription();
-
-  public native String getDate();
-
-  public native String getFavicon();
-
-  public native String getCreator();
-
-  public native String getPublisher();
-
-  public native String getName();
-
-  public native int getFileSize();
-
-  public native int getArticleCount();
-
-  public native int getMediaCount();
-
-  public native boolean getRandomPage(JNIKiwixString url);
-
-  public JNIKiwixSearcher search(String query, int count)
-  {
-    JNIKiwixSearcher searcher = new JNIKiwixSearcher();
-    searcher.addKiwixReader(this);
-    searcher.search(query, count);
-    return searcher;
-  }
-
-  public JNIKiwixReader(String filename) throws JNIKiwixException
-  {
-    nativeHandle = getNativeReader(filename);
-    if (nativeHandle == 0) {
-        throw new JNIKiwixException("Cannot open zimfile "+filename);
-    }
-  }
-
-  public JNIKiwixReader(FileDescriptor fd) throws JNIKiwixException
-  {
-    nativeHandle = getNativeReaderByFD(fd);
-    if (nativeHandle == 0) {
-        throw new JNIKiwixException("Cannot open zimfile by fd "+fd.toString());
-    }
-  }
-
-  public JNIKiwixReader(FileDescriptor fd, long offset, long size)
-      throws JNIKiwixException
-  {
-    nativeHandle = getNativeReaderEmbedded(fd, offset, size);
-    if (nativeHandle == 0) {
-        throw new JNIKiwixException(String.format("Cannot open embedded zimfile (fd=%s, offset=%d, size=%d)", fd, offset, size));
-    }
-  }
-
-  public JNIKiwixReader() {
-
-  }
-  public native void dispose();
-
-  private native long getNativeReader(String filename);
-  private native long getNativeReaderByFD(FileDescriptor fd);
-  private native long getNativeReaderEmbedded(FileDescriptor fd, long offset, long size);
-  private long nativeHandle;
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixSearcher.java

@@ -1,67 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-package org.kiwix.kiwixlib;
-
-import org.kiwix.kiwixlib.JNIKiwixReader;
-import java.util.Vector;
-
-public class JNIKiwixSearcher
-{
-  public class Result
-  {
-    private long nativeHandle;
-    private JNIKiwixSearcher searcher;
-    public Result(long handle, JNIKiwixSearcher _searcher)
-    {
-      nativeHandle = handle;
-      searcher = _searcher;
-    }
-    public native String getUrl();
-    public native String getTitle();
-    public native String getContent();
-    public native String getSnippet();
-    public native void dispose();
-  }
-
-  public JNIKiwixSearcher()
-  {
-    nativeHandle = getNativeHandle();
-    usedReaders = new Vector();
-  }
-  public native void dispose();
-
-  private native long getNativeHandle();
-  private long nativeHandle;
-  private Vector usedReaders;
-
-  public native void addReader(JNIKiwixReader reader);
-  public void addKiwixReader(JNIKiwixReader reader)
-  {
-    addReader(reader);
-    usedReaders.addElement(reader);
-  };
-
-  public native void search(String query, int count);
-
-  public native Result getNextResult();
-  public native boolean hasMoreResult();
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixServer.java

@@ -1,50 +0,0 @@
-/*
- * Copyright (C) 2019 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-import org.kiwix.kiwixlib.JNIKiwixException;
-import org.kiwix.kiwixlib.Library;
-
-public class JNIKiwixServer
-{
-  public native void setRoot(String root);
-
-  public native void setAddress(String address);
-
-  public native void setPort(int port);
-
-  public native void setNbThreads(int nbTreads);
-
-  public native void setTaskbar(boolean withTaskBar, boolean witLibraryButton);
-
-  public native void setBlockExternalLinks(boolean blockExternalLinks);
-
-  public native boolean start();
-
-  public native void stop();
-
-  public JNIKiwixServer(Library library)
-  {
-    nativeHandle = getNativeServer(library);
-  }
-
-  private native long getNativeServer(Library library);
-  private long nativeHandle;
-}

src/wrapper/java/org/kiwix/kiwixlib/JNIKiwixString.java

@@ -1,37 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-public class JNIKiwixString
-{
-  public String value;
-
-  public JNIKiwixString(String value) {
-    this.value = value;
-  }
-
-  public JNIKiwixString() {
-    this("");
-  }
-
-  public String getValue() {
-    return value;
-  }
-}

src/wrapper/java/org/kiwix/kiwixlib/Library.java

@@ -1,49 +0,0 @@
-/*
- * Copyright (C) 2019-2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-import org.kiwix.kiwixlib.Book;
-import org.kiwix.kiwixlib.JNIKiwixException;
-
-public class Library
-{
-  public native boolean addBook(String path) throws JNIKiwixException;
-
-  public native Book getBookById(String id);
-  public native int  getBookCount(boolean localBooks, boolean remoteBooks);
-
-  public native String[] getBooksIds();
-  public native String[] filter(Filter filter);
-
-  public native String[] getBooksLanguages();
-  public native String[] getBooksCreators();
-  public native String[] getBooksPublishers();
-
-  public Library()
-  {
-    allocate();
-  }
-
-  @Override
-  protected void finalize() { dispose(); }
-  private native void allocate();
-  private native void dispose();
-  private long nativeHandle;
-}

src/wrapper/java/org/kiwix/kiwixlib/Manager.java

@@ -1,90 +0,0 @@
-/*
- * Copyright (C) 2020 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-package org.kiwix.kiwixlib;
-
-import org.kiwix.kiwixlib.Library;
-
-public class Manager
-{
-  /**
-   * Read a `library.xml` file and add books in the library.
-   *
-   * @param path The (utf8) path to the `library.xml` file.
-   * @return True if the file has been properly parsed.
-   */
-  public native boolean readFile(String path);
-
-  /**
-   * Load a library content stored in a string (at `library.xml` format).
-   *
-   * @param content The content corresponding of the library xml.
-   * @param libraryPath The library path (used to resolve relative paths)
-   * @return True if the content has been properly parsed.
-   */
-  public native boolean readXml(String content, String libraryPath);
-
-  /**
-   * Load a library content stored in a string (at OPDS stream format)
-   *
-   * @param content the content of the OPDS stream.
-   * @param urlHost the url of the stream (used to resolve relative url)
-   * @return True if the content has been properly parsed.
-   */
-  public native boolean readOpds(String content, String urlHost);
-
-  /**
-   * Load a bookmark file
-   *
-   * @param path The path of the file to read.
-   * @return True if the content has been properly parsed
-   */
-  public native boolean readBookmarkFile(String path);
-
-  /**
-   * Add a book to the library.
-   *
-   * @param pathToOpen    The path of the zim file to add.
-   * @param pathToSave    The path to store in the library in place of
-   *                      pathToOpen.
-   * @param url           The url of the book to store in the library
-   *                      (useful for kiiwix-serve catalog)
-   * @param checkMetaData Tell if we check metadata before adding a book to the
-   *                      library.
-   * @return The id of te book if the book has been added to the library.
-   *         Empty string if not.
-   */
-  public native String addBookFromPath(String pathToOpen,
-                                       String pathToSave,
-                                       String url,
-                                       boolean checkMetaData);
-
-  public Manager(Library library) {
-    allocate(library);
-    _library = library;
-  }
-
-  private Library _library;
-
-  @Override
-  protected void finalize() { dispose(); }
-  private native void allocate(Library library);
-  private native void dispose();
-  private long nativeHandle;
-}

src/wrapper/java/org/kiwix/testing/catalog.xml

@@ -1,19 +0,0 @@
-<feed xmlns="http://www.w3.org/2005/Atom" xmlns:opds="http://opds-spec.org/2010/catalog">
-  <id>00000000-0000-0000-0000-000000000000</id>
-  <entry>
-    <title>Test ZIM file</title>
-    <id>urn:uuid:86c91e51-55bf-8882-464e-072aca37a3e8</id>
-    <icon>/meta?name=favicon&amp;content=small</icon>
-    <updated>2020-11-27:00::00:Z</updated>
-    <language>en</language>
-    <summary>This is a ZIM file used in libzim unit-tests</summary>
-    <tags>unit;test</tags>
-    <link type="text/html" href="/small" />
-    <author>
-      <name>Kiwix</name>
-    </author>
-    <link rel="http://opds-spec.org/acquisition/open-access" type="application/x-zim" href="http://localhost/small.zim" length="78982" />
-    <link rel="http://opds-spec.org/image/thumbnail" type="image/png" href="/meta?name=favicon&amp;content=small" />
-  </entry>
-</feed>
-

src/wrapper/java/org/kiwix/testing/compile_and_run_test.sh

@@ -1,37 +0,0 @@
-#!/usr/bin/bash
-
-# This script compiles and runs the unit test to test the java wrapper.
-# This is not integrated in meson because ... this is not so easy.
-
-die()
-{
-  echo >&2 "!!! ERROR: $*"
-  exit 1
-}
-
-
-KIWIX_LIB_JAR=$1
-if [ -z $KIWIX_LIB_JAR ]
-then
-  die "You must give the path to the kiwixlib.jar as first argument"
-fi
-
-KIWIX_LIB_DIR=$2
-if [ -z $KIWIX_LIB_DIR ]
-then
-  die "You must give the path to directory containing libkiwix.so as second argument"
-fi
-
-KIWIX_LIB_JAR=$(readlink -f "$KIWIX_LIB_JAR")
-KIWIX_LIB_DIR=$(readlink -f "$KIWIX_LIB_DIR")
-TEST_SOURCE_DIR=$(dirname "$(readlink -f $0)")
-
-cd "$TEST_SOURCE_DIR"
-
-javac -g -d . -s . -cp "junit-4.13.jar:$KIWIX_LIB_JAR" test.java \
-  || die "Compilation failed"
-
-java -Djava.library.path="$KIWIX_LIB_DIR" \
-     -cp "junit-4.13.jar:hamcrest-core-1.3.jar:$KIWIX_LIB_JAR:." \
-     org.junit.runner.JUnitCore test \
-  || die "Unit test failed"

src/wrapper/java/org/kiwix/testing/create_test_zimfiles

@@ -1,28 +0,0 @@
-#!/usr/bin/env bash
-
-die()
-{
-  echo >&2 "!!! ERROR: $*"
-  exit 1
-}
-
-cd "$(dirname "$0")"
-rm -f small.zim
-zimwriterfs --withoutFTIndex \
-            -w main.html \
-            -f favicon.png \
-            -l en \
-            -t "Test ZIM file" \
-            -d "N/A" \
-            -c "N/A" \
-            -p "N/A" \
-            small_zimfile_data \
-            small.zim \
-&& echo 'small.zim was successfully created' \
-|| die 'Failed to create small.zim'
-
-printf "BEGINZIM" > small.zim.embedded \
-&& cat small.zim >> small.zim.embedded \
-&& printf "ENDZIM" >> small.zim.embedded \
-&& echo 'small.zim.embedded was successfully created' \
-|| die 'Failed to create small.zim.embedded'

src/wrapper/java/org/kiwix/testing/small_zimfile_data/main.html

@@ -1,11 +0,0 @@
-<html>
-  <head>
-    <meta charset="UTF-8">
-    <title>Test ZIM file</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  </head>
-
-  <body>
-    Test ZIM file
-  </body>
-</html>

src/wrapper/java/org/kiwix/testing/test.java

@@ -1,160 +0,0 @@
-
-import java.io.*;
-import java.util.*;
-import org.junit.Test;
-import static org.junit.Assert.*;
-import org.kiwix.kiwixlib.*;
-
-public class test {
-static {
-  System.loadLibrary("kiwix");
-}
-
-private static byte[] getFileContent(String path)
-throws IOException
-{
-  File file = new File(path);
-  DataInputStream in = new DataInputStream(
-                         new BufferedInputStream(
-                           new FileInputStream(file)));
-  byte[] data = new byte[(int)file.length()];
-  in.read(data);
-  return data;
-}
-
-private static byte[] getFileContentPartial(String path, int offset, int size)
-throws IOException
-{
-  File file = new File(path);
-  DataInputStream in = new DataInputStream(
-                         new BufferedInputStream(
-                           new FileInputStream(file)));
-  byte[] data = new byte[size];
-  in.skipBytes(offset);
-  in.read(data, 0, size);
-  return data;
-}
-
-private static String getTextFileContent(String path)
-throws IOException
-{
-  return new String(getFileContent(path));
-}
-
-@Test
-public void testReader()
-throws JNIKiwixException, IOException
-{
-  JNIKiwixReader reader = new JNIKiwixReader("small.zim");
-  assertEquals("Test ZIM file", reader.getTitle());
-  assertEquals(45, reader.getFileSize()); // The file size is in KiB
-  assertEquals("A/main.html", reader.getMainPage());
-  String s = getTextFileContent("small_zimfile_data/main.html");
-  byte[] c = reader.getContent(new JNIKiwixString("A/main.html"),
-                                new JNIKiwixString(),
-                                new JNIKiwixString(),
-                                new JNIKiwixInt());
-  assertEquals(s, new String(c));
-
-  byte[] faviconData = getFileContent("small_zimfile_data/favicon.png");
-  assertEquals(faviconData.length, reader.getArticleSize("I/favicon.png"));
-  c = reader.getContent(new JNIKiwixString("I/favicon.png"),
-                                new JNIKiwixString(),
-                                new JNIKiwixString(),
-                                new JNIKiwixInt());
-  assertTrue(Arrays.equals(faviconData, c));
-
-  DirectAccessInfo dai = reader.getDirectAccessInformation("I/favicon.png");
-  assertNotEquals("", dai.filename);
-  c = getFileContentPartial(dai.filename, (int)dai.offset, faviconData.length);
-  assertTrue(Arrays.equals(faviconData, c));
-}
-
-@Test
-public void testReaderByFd()
-throws JNIKiwixException, IOException
-{
-  FileInputStream fis = new FileInputStream("small.zim");
-  JNIKiwixReader reader = new JNIKiwixReader(fis.getFD());
-  assertEquals("Test ZIM file", reader.getTitle());
-  assertEquals(45, reader.getFileSize()); // The file size is in KiB
-  assertEquals("A/main.html", reader.getMainPage());
-  String s = getTextFileContent("small_zimfile_data/main.html");
-  byte[] c = reader.getContent(new JNIKiwixString("A/main.html"),
-                                new JNIKiwixString(),
-                                new JNIKiwixString(),
-                                new JNIKiwixInt());
-  assertEquals(s, new String(c));
-
-  byte[] faviconData = getFileContent("small_zimfile_data/favicon.png");
-  assertEquals(faviconData.length, reader.getArticleSize("I/favicon.png"));
-  c = reader.getContent(new JNIKiwixString("I/favicon.png"),
-                                new JNIKiwixString(),
-                                new JNIKiwixString(),
-                                new JNIKiwixInt());
-  assertTrue(Arrays.equals(faviconData, c));
-
-  DirectAccessInfo dai = reader.getDirectAccessInformation("I/favicon.png");
-  assertNotEquals("", dai.filename);
-  c = getFileContentPartial(dai.filename, (int)dai.offset, faviconData.length);
-  assertTrue(Arrays.equals(faviconData, c));
-}
-
-@Test
-public void testReaderWithAnEmbeddedArchive()
-throws JNIKiwixException, IOException
-{
-  File plainArchive = new File("small.zim");
-  FileInputStream fis = new FileInputStream("small.zim.embedded");
-  JNIKiwixReader reader = new JNIKiwixReader(fis.getFD(), 8, plainArchive.length());
-  assertEquals("Test ZIM file", reader.getTitle());
-  assertEquals(45, reader.getFileSize()); // The file size is in KiB
-  assertEquals("A/main.html", reader.getMainPage());
-  String s = getTextFileContent("small_zimfile_data/main.html");
-  byte[] c = reader.getContent(new JNIKiwixString("A/main.html"),
-                                new JNIKiwixString(),
-                                new JNIKiwixString(),
-                                new JNIKiwixInt());
-  assertEquals(s, new String(c));
-
-  byte[] faviconData = getFileContent("small_zimfile_data/favicon.png");
-  assertEquals(faviconData.length, reader.getArticleSize("I/favicon.png"));
-  c = reader.getContent(new JNIKiwixString("I/favicon.png"),
-                                new JNIKiwixString(),
-                                new JNIKiwixString(),
-                                new JNIKiwixInt());
-  assertTrue(Arrays.equals(faviconData, c));
-
-  DirectAccessInfo dai = reader.getDirectAccessInformation("I/favicon.png");
-  assertNotEquals("", dai.filename);
-  c = getFileContentPartial(dai.filename, (int)dai.offset, faviconData.length);
-  assertTrue(Arrays.equals(faviconData, c));
-}
-
-@Test
-public void testLibrary()
-throws IOException
-{
-  Library lib = new Library();
-  Manager manager = new Manager(lib);
-  String content = getTextFileContent("catalog.xml");
-  manager.readOpds(content, "http://localhost");
-  assertEquals(lib.getBookCount(true, true), 1);
-  String[] bookIds = lib.getBooksIds();
-  assertEquals(bookIds.length, 1);
-  Book book = lib.getBookById(bookIds[0]);
-  assertEquals(book.getTitle(), "Test ZIM file");
-  assertEquals(book.getTags(), "unit;test");
-  assertEquals(book.getFaviconUrl(), "http://localhost/meta?name=favicon&content=small");
-  assertEquals(book.getUrl(), "http://localhost/small.zim");
-}
-
-static
-public void main(String[] args) {
-  Library lib = new Library();
-  lib.getBookCount(true, true);
-}
-
-
-
-}

src/wrapper/java/res/values/strings.xml

@@ -1,3 +0,0 @@
-<resources>
-  <string name="app_name">Kiwix Lib</string>
-</resources>

src/wrapper/java/utils.h

@@ -1,259 +0,0 @@
-/*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#ifndef _ANDROID_JNI_UTILS_H
-#define _ANDROID_JNI_UTILS_H
-
-#include <jni.h>
-
-#include <mutex>
-#include <string>
-#include <vector>
-#include <iostream>
-
-#if __ANDROID__
- #include <android/log.h>
- #define LOG(...) __android_log_print(ANDROID_LOG_ERROR, "kiwix", __VA_ARGS__)
-#else
- #define LOG(...)
-#endif
-
-extern std::mutex globalLock;
-
-template<typename T>
-void setPtr(JNIEnv* env, jobject thisObj, T* ptr)
-{
-  jclass thisClass = env->GetObjectClass(thisObj);
-  jfieldID fieldId = env->GetFieldID(thisClass, "nativeHandle", "J");
-  env->SetLongField(thisObj, fieldId, reinterpret_cast<jlong>(ptr));
-}
-
-template<typename T, typename ...Args>
-void allocate(JNIEnv* env, jobject thisObj, Args && ...args)
-{
-  T* ptr = new T(std::forward<Args>(args)...);
-  setPtr(env, thisObj, ptr);
-}
-
-template<typename T>
-T* getPtr(JNIEnv* env, jobject thisObj)
-{
-  jclass thisClass = env->GetObjectClass(thisObj);
-  jfieldID fidNumber = env->GetFieldID(thisClass, "nativeHandle", "J");
-  return reinterpret_cast<T*>(env->GetLongField(thisObj, fidNumber));
-}
-
-template<typename T>
-void dispose(JNIEnv* env, jobject thisObj)
-{
-  delete getPtr<T>(env, thisObj);
-}
-
-#define METHOD0(retType, class, name) \
-JNIEXPORT retType JNICALL Java_org_kiwix_kiwixlib_##class##_##name( \
- JNIEnv* env, jobject thisObj)
-
-#define METHOD(retType, class, name, ...) \
-JNIEXPORT retType JNICALL Java_org_kiwix_kiwixlib_##class##_##name( \
-  JNIEnv* env, jobject thisObj, __VA_ARGS__)
-
-inline jfieldID getHandleField(JNIEnv* env, jobject obj)
-{
-  jclass c = env->GetObjectClass(obj);
-  // J is the type signature for long:
-  return env->GetFieldID(c, "nativeHandle", "J");
-}
-
-inline jobjectArray createArray(JNIEnv* env, size_t length, const std::string& type_sig)
-{
-  jclass c = env->FindClass(type_sig.c_str());
-  return env->NewObjectArray(length, c, NULL);
-}
-
-class Lock : public std::unique_lock<std::mutex>
-{
- public:
-  Lock() : std::unique_lock<std::mutex>(globalLock) { }
-};
-
-template <class T>
-class LockedHandle;
-
-template <class T>
-class Handle
-{
- protected:
-  T* h;
-
- public:
-  Handle(T* h) : h(h){};
-
-  // No destructor. This must and will be handled by dispose method.
-
-  static LockedHandle<T> getHandle(JNIEnv* env, jobject obj)
-  {
-    jlong handle = env->GetLongField(obj, getHandleField(env, obj));
-    return LockedHandle<T>(reinterpret_cast<Handle<T>*>(handle));
-  }
-
-  static void dispose(JNIEnv* env, jobject obj)
-  {
-    auto lHandle = getHandle(env, obj);
-    auto handle = lHandle.h;
-    delete handle->h;
-    delete handle;
-  }
-  friend class LockedHandle<T>;
-};
-
-template <class T>
-struct LockedHandle : public Lock {
-  Handle<T>* h;
-  LockedHandle(Handle<T>* h) : h(h) {}
-  T* operator->() { return h->h; }
-  T* operator*() { return h->h; }
-  operator bool() const { return (h->h != nullptr); }
-  operator T*() const { return h->h; }
-};
-
-template<typename T>
-struct JType { };
-
-template<> struct JType<bool>{ typedef jboolean type_t; };
-template<> struct JType<int>{ typedef jint type_t; };
-template<> struct JType<long>{ typedef jlong type_t; };
-template<> struct JType<uint64_t> { typedef jlong type_t; };
-template<> struct JType<uint32_t> { typedef jlong type_t; };
-template<> struct JType<std::string>{ typedef jstring type_t; };
-template<> struct JType<std::vector<std::string>>{ typedef jobjectArray type_t; };
-
-template<typename T>
-inline typename JType<T>::type_t c2jni(const T& val, JNIEnv* env) {
-  return static_cast<typename JType<T>::type_t>(val);
-}
-
-template<>
-inline jboolean c2jni(const bool& val, JNIEnv* env) { return val ? JNI_TRUE : JNI_FALSE; }
-
-template<>
-inline jstring c2jni(const std::string& val, JNIEnv* env)
-{
-  return env->NewStringUTF(val.c_str());
-}
-
-template<>
-inline jobjectArray c2jni(const std::vector<std::string>& val, JNIEnv* env)
-{
-  auto array = createArray(env, val.size(), "java/lang/String");
-  size_t index = 0;
-  for (auto& elem: val) {
-    auto jElem = c2jni(elem, env);
-    env->SetObjectArrayElement(array, index++, jElem);
-  }
-  return array;
-}
-
-template<typename T, typename U=T>
-struct CType { };
-
-template<> struct CType<jboolean>{ typedef bool type_t; };
-template<> struct CType<jint>{ typedef int type_t; };
-template<> struct CType<jlong>{ typedef long type_t; };
-template<> struct CType<jstring>{ typedef std::string type_t; };
-
-template<typename U>
-struct CType<jobjectArray, U>{ typedef std::vector<typename CType<U>::type_t> type_t; };
-
-/* jni2c type conversion functions */
-template<typename T, typename U=T>
-inline typename CType<T>::type_t jni2c(const T& val, JNIEnv* env) {
-  return static_cast<typename CType<T>::type_t>(val);
-}
-
-template<>
-inline bool jni2c(const jboolean& val, JNIEnv* env) { return val == JNI_TRUE; }
-
-template<>
-inline std::string jni2c(const jstring& val, JNIEnv* env)
-{
-  const char* chars = env->GetStringUTFChars(val, 0);
-  std::string ret(chars);
-  env->ReleaseStringUTFChars(val, chars);
-  return ret;
-}
-
-template<typename U>
-inline typename CType<jobjectArray, U>::type_t jni2c(const jobjectArray& val, JNIEnv* env)
-{
-  jsize length = env->GetArrayLength(val);
-  typename CType<jobjectArray, U>::type_t v(length);
-
-  int i;
-  for (i = 0; i < length; i++) {
-    U obj = (U) env->GetObjectArrayElement(val, i);
-    auto cobj = jni2c<U>(obj, env);
-    v.push_back(cobj);
-  }
-  return v;
-}
-
-/* Method to deal with variable passed by reference */
-inline std::string getStringObjValue(const jobject obj, JNIEnv* env)
-{
-  jclass objClass = env->GetObjectClass(obj);
-  jfieldID objFid = env->GetFieldID(objClass, "value", "Ljava/lang/String;");
-  jstring jstr = (jstring)env->GetObjectField(obj, objFid);
-  return jni2c(jstr, env);
-}
-inline void setStringObjValue(const std::string& value,
-                              const jobject obj,
-                              JNIEnv* env)
-{
-  jclass objClass = env->GetObjectClass(obj);
-  jfieldID objFid = env->GetFieldID(objClass, "value", "Ljava/lang/String;");
-  env->SetObjectField(obj, objFid, c2jni(value, env));
-}
-
-inline void setIntObjValue(const int value, const jobject obj, JNIEnv* env)
-{
-  jclass objClass = env->GetObjectClass(obj);
-  jfieldID objFid = env->GetFieldID(objClass, "value", "I");
-  env->SetIntField(obj, objFid, value);
-}
-
-inline void setBoolObjValue(const bool value, const jobject obj, JNIEnv* env)
-{
-  jclass objClass = env->GetObjectClass(obj);
-  jfieldID objFid = env->GetFieldID(objClass, "value", "Z");
-  env->SetIntField(obj, objFid, c2jni(value, env));
-}
-
-inline void setDaiObjValue(const std::string& filename, const long offset,
-                            const jobject obj, JNIEnv* env)
-{
-  jclass objClass = env->GetObjectClass(obj);
-  jfieldID filenameFid = env->GetFieldID(objClass, "filename", "Ljava/lang/String;");
-  env->SetObjectField(obj, filenameFid, c2jni(filename, env));
-  jfieldID offsetFid = env->GetFieldID(objClass, "offset", "J");
-  env->SetLongField(obj, offsetFid, offset);
-}
-
-#endif // _ANDROID_JNI_UTILS_H

static/ft_opensearchdescription.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+  <ShortName>Fulltext articles search</ShortName>
+  <Description>Search for articles in the Library.</Description>
+  <Url type="application/atom+xml;profile=opds-catalog"
+       xmlns:atom="http://www.w3.org/2005/Atom"
+       xmlns:k="http://kiwix.org/opensearchextension/1.0"
+       indexOffset="0"
+       template="{{root}}/search?format=xml&amp;pattern={searchTerms}&amp;books.filter.lang={language?}&amp;books.name={k:name?}&amp;pageLength={count?}&amp;start={startIndex?}"/>
+</OpenSearchDescription>

static/generate_i18n_resources_list.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+# Copyright (c) 2020 Matthieu Gautier <mgautier@kymeria.fr>
+#
+# This file is part of libkiwix.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from pathlib import Path
+
+script_path = Path(__file__)
+
+resource_file = script_path.parent / "i18n_resources_list.txt"
+translation_dir = script_path.parent / "i18n"
+
+json_files = translation_dir.glob("*.json")
+with open(resource_file, 'w', encoding="utf-8") as f:
+    for json in sorted(translation_dir.glob("*.json")):
+        if json.name == "qqq.json":
+            continue
+        f.write(str(json.relative_to(script_path.parent)) + '\n')

static/i18n/bn.json

@@ -0,0 +1,14 @@
+{
+	"@metadata": {
+		"authors": [
+			"আফতাবুজ্জামান"
+		]
+	},
+	"name": "বাংলা",
+	"404-page-heading": "পাওয়া যায়নি",
+	"500-page-title": "অভ্যন্তরীণ সার্ভার ত্রুটি",
+	"500-page-heading": "অভ্যন্তরীণ সার্ভার ত্রুটি",
+	"library-button-text": "স্বাগত পাতায় চলুন",
+	"home-button-text": "'{{BOOK_TITLE}}'-এর প্রধান পাতায় চলুন",
+	"searchbox-tooltip": "'{{BOOK_TITLE}}' অনুসন্ধান করুন"
+}

static/i18n/en.json

@@ -0,0 +1,30 @@
+{
+	"@metadata": {
+		"authors": [
+		]
+	},
+	"name":"English",
+	"suggest-full-text-search" : "containing '{{{SEARCH_TERMS}}}'..."
+	, "no-such-book" : "No such book: {{BOOK_NAME}}"
+	, "too-many-books" : "Too many books requested ({{NB_BOOKS}}) where limit is {{LIMIT}}"
+	, "no-book-found" : "No book matches selection criteria"
+	, "url-not-found" : "The requested URL \"{{url}}\" was not found on this server."
+	, "suggest-search" : "Make a full text search for <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>"
+	, "random-article-failure" :  "Oops! Failed to pick a random article :("
+	, "invalid-raw-data-type" : "{{DATATYPE}} is not a valid request for raw content."
+	, "no-value-for-arg": "No value provided for argument {{ARGUMENT}}"
+	, "no-query" : "No query provided."
+	, "raw-entry-not-found" : "Cannot find {{DATATYPE}} entry {{ENTRY}}"
+	, "400-page-title" : "Invalid request"
+	, "400-page-heading" : "Invalid request"
+	, "404-page-title" : "Content not found"
+	, "404-page-heading" : "Not Found"
+	, "500-page-title" : "Internal Server Error"
+	, "500-page-heading" : "Internal Server Error"
+	, "fulltext-search-unavailable" : "Fulltext search unavailable"
+	, "no-search-results": "The fulltext search engine is not available for this content."
+	, "library-button-text": "Go to welcome page"
+	, "home-button-text": "Go to the main page of '{{BOOK_TITLE}}'"
+	, "random-page-button-text": "Go to a randomly selected page"
+	, "searchbox-tooltip": "Search '{{BOOK_TITLE}}'"
+}

static/i18n/fr.json

@@ -0,0 +1,33 @@
+{
+	"@metadata": {
+		"authors": [
+			"Gomoko",
+			"Thibaut120094",
+			"Verdy p"
+		]
+	},
+	"name": "français",
+	"suggest-full-text-search": "contenant « {{{SEARCH_TERMS}}} »...",
+	"no-such-book": "Aucun livre avec ce nom : {{BOOK_NAME}}",
+	"too-many-books": "Trop de livres demandés ({{NB_BOOKS}}) alors que la limite est de {{LIMIT}}",
+	"no-book-found": "Aucun livre ne correspond à ces critères de sélection",
+	"url-not-found": "L’URL demandée « {{url}} » est introuvable sur ce serveur.",
+	"suggest-search": "Faire une recherche en texte intégral de « <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a> »",
+	"random-article-failure": "Oups ! Échec de sélection d’un article aléatoire :(",
+	"invalid-raw-data-type": "{{DATATYPE}} n’est pas une requête valide pour du contenu brut.",
+	"no-value-for-arg": "Aucune valeur fournie pour l’argument {{ARGUMENT}}",
+	"no-query": "Aucune requête fournie.",
+	"raw-entry-not-found": "Impossible de trouver l’entrée « {{ENTRY}} » de type « {{DATATYPE}} »",
+	"400-page-title": "Requête non valide",
+	"400-page-heading": "Requête non valide",
+	"404-page-title": "Contenu non trouvé",
+	"404-page-heading": "Non trouvé",
+	"500-page-title": "Erreur interne du serveur",
+	"500-page-heading": "Erreur interne du serveur",
+	"fulltext-search-unavailable": "Recherche en texte intégral non disponible",
+	"no-search-results": "Le moteur de recherche en texte intégral n’est pas disponible pour ce contenu.",
+	"library-button-text": "Aller à la page de bienvenue",
+	"home-button-text": "Aller à la page principale de « {{BOOK_TITLE}} »",
+	"random-page-button-text": "Aller à une page sélectionnée aléatoirement",
+	"searchbox-tooltip": "Rechercher « {{BOOK_TITLE}} »"
+}

static/i18n/he.json

@@ -0,0 +1,31 @@
+{
+	"@metadata": {
+		"authors": [
+			"Amire80"
+		]
+	},
+	"name": "עברית",
+	"suggest-full-text-search": "מכיל '{{{SEARCH_TERMS}}}'...",
+	"no-such-book": "אין ספר כזה: {{BOOK_NAME}}",
+	"too-many-books": "נתבקשו יותר ספרים ({{NB_BOOKS}}) והמגבלה היא {{LIMIT}}",
+	"no-book-found": "אין ספר שמתאים לתנאים שנבחרו",
+	"url-not-found": "הכתובת המבוקשת \"{{url}}\" לא נמצאה בשרת הזה.",
+	"suggest-search": "לעשות חיפוש טקסט מלא עבור <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"random-article-failure": "אוי! לא עבדה בחירת ערך אקראי :(",
+	"invalid-raw-data-type": "{{DATATYPE}} הוא לא בקשה תקינה של תוכן גולמי.",
+	"no-value-for-arg": "לא סופק ערך לארגומנט {{ARGUMENT}}",
+	"no-query": "לא סופקה שאילתה.",
+	"raw-entry-not-found": "לא ניתן למצוא את רשומת ה־{{DATATYPE}} בשם {{ENTRY}}",
+	"400-page-title": "בקשה בלתי־תקינה",
+	"400-page-heading": "בקשה בלתי־תקינה",
+	"404-page-title": "התוכן לא נמצא",
+	"404-page-heading": "לא נמצא",
+	"500-page-title": "שגיאת שרת פנימית",
+	"500-page-heading": "שגיאת שרת פנימית",
+	"fulltext-search-unavailable": "חיפוש בטקסט מלא אינו זמין",
+	"no-search-results": "מנוע החיפוש בטקסט מלא אינו זמין עבור התוכן הזה.",
+	"library-button-text": "מעבר לדף הבית \"ברוך בואך\"",
+	"home-button-text": "מעבר לדף הראשי של \"{{BOOK_TITLE}}\"",
+	"random-page-button-text": "מעבר לדף שנבחר אקראית",
+	"searchbox-tooltip": "חיפוש \"{{BOOK_TITLE}}\""
+}

static/i18n/hy.json

@@ -0,0 +1,16 @@
+{
+	"@metadata": {
+		"authors": []
+	},
+	"name": "Հայերեն",
+	"suggest-full-text-search": "որոնել '{{{SEARCH_TERMS}}}'...",
+	"no-such-book": "Գիրքը բացակայում է՝ {{BOOK_NAME}}",
+	"url-not-found": "Սխալ հասցե՝ {{url}}",
+	"suggest-search": "Որոնել <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"404-page-title": "Սխալ հասցե",
+	"404-page-heading": "Սխալ հասցե",
+	"library-button-text": "Գրադարանի էջ",
+	"home-button-text": "Դեպի '{{BOOK_TITLE}}'֊ի գլխավոր էջը",
+	"random-page-button-text": "Բացել պատահական էջ",
+	"searchbox-tooltip": "Որոնել '{{BOOK_TITLE}}'֊ում"
+}

static/i18n/it.json

@@ -0,0 +1,15 @@
+{
+	"@metadata": {
+		"authors": [
+			"Beta16"
+		]
+	},
+	"name": "italiano",
+	"suggest-full-text-search": "contenente '{{{SEARCH_TERMS}}}'...",
+	"url-not-found": "L'URL richiesto \"{{url}}\" non è stato trovato in questo server.",
+	"400-page-title": "Richiesta non valida",
+	"400-page-heading": "Richiesta non valida",
+	"404-page-title": "Contenuto non trovato",
+	"404-page-heading": "Non trovato",
+	"home-button-text": "Vai alla pagina principale di '{{BOOK_TITLE}}'"
+}

static/i18n/ja.json

@@ -0,0 +1,18 @@
+{
+	"@metadata": {
+		"authors": [
+			"MathXplore"
+		]
+	},
+	"no-query": "クエリを指定していません。",
+	"400-page-title": "無効なリクエストです",
+	"400-page-heading": "無効なリクエストです",
+	"404-page-title": "コンテンツが見つかりませんでした",
+	"404-page-heading": "見つかりません",
+	"500-page-title": "内部サーバーエラー",
+	"500-page-heading": "内部サーバーエラー",
+	"fulltext-search-unavailable": "全文検索は利用できません",
+	"no-search-results": "このコンテンツでは全文検索エンジンが利用できません",
+	"library-button-text": "ウェルカムページに移動",
+	"random-page-button-text": "無作為に選ばれたページに移動する"
+}

static/i18n/ko.json

@@ -0,0 +1,18 @@
+{
+	"@metadata": {
+		"authors": [
+			"Ykhwong"
+		]
+	},
+	"name": "한국어",
+	"suggest-full-text-search": "'{{{SEARCH_TERMS}}}' 포함...",
+	"no-such-book": "해당 책이 없습니다: {{BOOK_NAME}}",
+	"400-page-title": "잘못된 요청",
+	"400-page-heading": "잘못된 요청",
+	"404-page-title": "내용이 없습니다",
+	"404-page-heading": "찾을 수 없음",
+	"500-page-title": "내부 서버 오류",
+	"500-page-heading": "내부 서버 오류",
+	"fulltext-search-unavailable": "전문 검색을 사용할 수 없습니다",
+	"random-page-button-text": "무작위로 선택된 문서로 이동"
+}

static/i18n/ku-latn.json

@@ -0,0 +1,31 @@
+{
+	"@metadata": {
+		"authors": [
+			"Bikarhêner"
+		]
+	},
+	"name": "kurdî",
+	"suggest-full-text-search": "'{{{SEARCH_TERMS}}}' dihewîne...",
+	"no-such-book": "Kitêbeke wisa nîne: {{BOOK_NAME}}",
+	"too-many-books": "Pir zêde kitêb hatiye xwestin ({{NB_BOOKS}}) ku sînor {{LIMIT}} ye",
+	"no-book-found": "Ti kitêbekê ku li krîterên te bê peyda nebû",
+	"url-not-found": "URLya xwestî \"{{url}}\" li ser vê serverê nehate dîtin.",
+	"suggest-search": "Ji bo <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a> lêgerîneke nivîsa temamî pêk bîne",
+	"random-article-failure": "Ha ho! Bi ser neket ku gotareke ketober bibijêre :(",
+	"invalid-raw-data-type": "{{DATATYPE}} ne daxwazeke derbasdar e ji bo naveroka xav.",
+	"no-value-for-arg": "Ti tişt nehatiye diyarkirin ji bo mijara {{ARGUMENT}}",
+	"no-query": "Ti tiştekî xwestî nîne.",
+	"raw-entry-not-found": "Hêmana {{ENTRY}} {{DATATYPE}} peyda nebû",
+	"400-page-title": "Xwesteka nederbasdar",
+	"400-page-heading": "Xwesteka nederbasdar",
+	"404-page-title": "Naverok nehat dîtin",
+	"404-page-heading": "Nehat dîtin",
+	"500-page-title": "Çewtiya Serverê yê Daxilî",
+	"500-page-heading": "Çewtiya Serverê yê Daxilî",
+	"fulltext-search-unavailable": "Lêgerîna Temamê Nivîsê Neberdest e",
+	"no-search-results": "Motora lêgerînê yê temamê metnê ne berdest e ji bo vê naverokê.",
+	"library-button-text": "Here rûpela xêrhatinê",
+	"home-button-text": "Here rûpela destpêkê yê {{BOOK_TITLE}}",
+	"random-page-button-text": "Here rûpeleke ketober bijartî",
+	"searchbox-tooltip": "Li {{BOOK_TITLE}} bigere"
+}

static/i18n/mk.json

@@ -0,0 +1,31 @@
+{
+	"@metadata": {
+		"authors": [
+			"Bjankuloski06"
+		]
+	},
+	"name": "македонски",
+	"suggest-full-text-search": "содржи „{{{SEARCH_TERMS}}}“...",
+	"no-such-book": "Нема книга нарчена {{BOOK_NAME}}",
+	"too-many-books": "Побаравте премногу книги ({{NB_BOOKS}}). Ограничени сте на {{LIMIT}}",
+	"no-book-found": "Ниедна книга не одговара на избраното",
+	"url-not-found": "Не ја пронајдов побараната адреса „{{url}}“ на опслужувачот.",
+	"suggest-search": "Побарајте го <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a> по целиот текст",
+	"random-article-failure": "Упс! Не успеав да изберам случајна статија :(",
+	"invalid-raw-data-type": "{{DATATYPE}} не претставува важечко барање за сирова содржина.",
+	"no-value-for-arg": "Нема укажано вредност за аргументот {{ARGUMENT}}",
+	"no-query": "Не е укажано барање.",
+	"raw-entry-not-found": "Не можам да ја најдам {{DATATYPE}}-ставката {{ENTRY}}",
+	"400-page-title": "Неважечко барање",
+	"400-page-heading": "Неважечко барање",
+	"404-page-title": "Содржината не е најдена",
+	"404-page-heading": "Не е најдено",
+	"500-page-title": "Внатрешна грешка во опслужувачот",
+	"500-page-heading": "Внатрешна грешка во опслужувачот",
+	"fulltext-search-unavailable": "Целотекстното пребарување е недостапно",
+	"no-search-results": "Погонот за целотекстно пребарување не е достапен за оваа содржина.",
+	"library-button-text": "Оди на воведната страница",
+	"home-button-text": "Оди на главната страница на „{{BOOK_TITLE}}“",
+	"random-page-button-text": "Оди на случајно избрана страница",
+	"searchbox-tooltip": "Пребарај го „{{BOOK_TITLE}}“"
+}

static/i18n/pl.json

@@ -0,0 +1,27 @@
+{
+	"@metadata": {
+		"authors": [
+			"Strebski"
+		]
+	},
+	"name": "Polski",
+	"suggest-full-text-search": "zawierający '{{{SEARCH_TERMS}}}'...",
+	"no-such-book": "Brak takiej książki: {{BOOK_NAME}}",
+	"url-not-found": "Żądany adres URL „{{url}}” nie został znaleziony na tym serwerze.",
+	"suggest-search": "Wykonaj wyszukiwanie pełnotekstowe dla <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"random-article-failure": "Ups! Nie udało się wybrać losowego artykułu :(",
+	"invalid-raw-data-type": "{{DATATYPE}} nie jest prawidłowym żądaniem zawartości nieprzetworzonej.",
+	"raw-entry-not-found": "Nie można znaleźć {{DATATYPE}} wpisu {{ENTRY}}",
+	"400-page-title": "Nieprawidłowe żądanie",
+	"400-page-heading": "Nieprawidłowe żądanie",
+	"404-page-title": "Zawartość nie została znaleziona",
+	"404-page-heading": "Nie znaleziono",
+	"500-page-title": "Wewnętrzny błąd serwera",
+	"500-page-heading": "Wewnętrzny błąd serwera",
+	"fulltext-search-unavailable": "Wyszukiwanie pełnotekstowe jest niedostępne",
+	"no-search-results": "Wyszukiwarka pełnotekstowa nie jest dostępna dla tej zawartości.",
+	"library-button-text": "Przejdź do strony powitalnej",
+	"home-button-text": "Przejdź do głównej strony '{{BOOK_TITLE}}'",
+	"random-page-button-text": "Przejdź do losowo wybranej strony",
+	"searchbox-tooltip": "Szukaj '{{BOOK_TITLE}}'"
+}

static/i18n/qqq.json

@@ -0,0 +1,33 @@
+{
+	"@metadata": {
+		"authors": [
+			"Matthieu Gautier",
+			"Veloman Yunkan",
+			"Verdy p"
+		]
+	},
+	"name": "{{Doc-important|Don't write \"English\" in your language!}}\n\n'''Write the name of ''your'' language in its native script.'''\n\nCurrent language to which the string is being translated to.\n\nFor example, write \"français\" when translating to French, or \"Deutsch\" when translating to German.\n\n'''Important:''' Do not use your language’s word for “English”. Use the word that your language uses to refer to itself. If you translate this message to mean “English” in your language, your change will be reverted.",
+	"suggest-full-text-search": "Text appearing in the suggestion list that, when selected, runs a full text search instead of the title search",
+	"no-such-book": "Error text when the requested book is not found in the library",
+	"too-many-books": "Error text when user request more books than the limit set by the administrator",
+	"no-book-found": "Error text when no book matches the selection criteria",
+	"url-not-found": "Error text about wrong URL for an HTTP 404 error",
+	"suggest-search": "Suggest a search when the URL points to a non existing article",
+	"random-article-failure": "Failure of the random article selection procedure",
+	"invalid-raw-data-type": "Invalid DATATYPE was used with the /raw endpoint (/raw/<book>/DATATYPE/...); allowed values are 'meta' and 'content'",
+	"no-value-for-arg": "Error text when no value has been provided for ARGUMENT in the request's query string",
+	"no-query": "Error text when no query has been provided for fulltext search",
+	"raw-entry-not-found": "Entry requested via the /raw endpoint was not found",
+	"400-page-title": "Title of the 400 error page",
+	"400-page-heading": "Heading of the 400 error page",
+	"404-page-title": "Title of the 404 error page",
+	"404-page-heading": "Heading of the 404 error page",
+	"500-page-title": "Title of the 500 error page",
+	"500-page-heading": "Heading of the 500 error page",
+	"fulltext-search-unavailable": "Title of the error page returned when search is attempted in a book without fulltext search database",
+	"no-search-results": "Text of the error page returned when search is attempted in a book without fulltext search database",
+	"library-button-text": "Tooltip of the button leading to the welcome page",
+	"home-button-text": "Tooltip of the button leading to the main page of a book",
+	"random-page-button-text": "Tooltip of the button opening a randomly selected page",
+	"searchbox-tooltip": "Tooltip displayed for the search box"
+}

static/i18n/ru.json

@@ -0,0 +1,27 @@
+{
+	"@metadata": {
+		"authors": [
+			"Fenixs-ru",
+			"Kareyac",
+			"Pacha Tchernof"
+		]
+	},
+	"name": "русский",
+	"suggest-full-text-search": "содержащее '{{{SEARCH_TERMS}}}'...",
+	"no-such-book": "Такой книги нет: {{BOOK_NAME}}",
+	"url-not-found": "Запрошенный URL \"{{url}}\" не найден на этом сервере.",
+	"suggest-search": "Выполните полнотекстовый поиск для <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"random-article-failure": "Ой! Не удалось выбрать случайную статью :(",
+	"400-page-title": "Недействительный запрос",
+	"400-page-heading": "Недействительный запрос",
+	"404-page-title": "Содержание не найдено",
+	"404-page-heading": "Не найдено",
+	"500-page-title": "Внутренняя ошибка сервера",
+	"500-page-heading": "Внутренняя ошибка сервера",
+	"fulltext-search-unavailable": "Полнотекстовый поиск недоступен",
+	"no-search-results": "Полнотекстовая поисковая система недоступна для этого содержания.",
+	"library-button-text": "Перейти на страницу-приветствие",
+	"home-button-text": "Перейти на главную страницу '{{BOOK_TITLE}}'",
+	"random-page-button-text": "Перейти на случайно выбранную страницу",
+	"searchbox-tooltip": "Искать '{{BOOK_TITLE}}'"
+}