Make kiwix::Server a simple wrapper around kiwix::InternalServer.

`kiwix::Server` is now a simple exposition of a public API on top of the
private `InternalServer`.

.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:
@@ -82,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: |
@@ -95,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

.github/workflows/package.yml

@@ -9,7 +9,6 @@ jobs:
       matrix:
         distro:
           - ubuntu-jammy
-          - ubuntu-impish
           - ubuntu-focal
           - ubuntu-bionic
     steps:
@@ -42,14 +41,6 @@ jobs:
           args: --no-sign
           ppa: ${{ steps.ppa.outputs.ppa }}
 
-      - uses: legoktm/gh-action-build-deb@ubuntu-impish
-        if: matrix.distro == 'ubuntu-impish'
-        name: Build package for ubuntu-impish
-        id: build-ubuntu-impish
-        with:
-          args: --no-sign
-          ppa: ${{ steps.ppa.outputs.ppa }}
-
       - uses: legoktm/gh-action-build-deb@ubuntu-focal
         if: matrix.distro == 'ubuntu-focal'
         name: Build package for ubuntu-focal

README.md

@@ -101,6 +101,33 @@ meson . build -Dwrapper=android -Dwerror=false
 ninja -C build
 ```
 
+Static files compilation
+------------------------
+
+Libkiwix has a few static files 'compiled' within the binary
+code. This is mostly Javascript/HTML/pictures necessary for the HTTP
+daemon.
+
+These static files are available in the `static` directory and are
+compiled by custom Python code available in this repository `scripts`
+directory. This happens automatically at compilation time without any
+additional command to run.
+
+To avoid HTTP caching issues, the URLs (to the static content) are
+appended with a `cacheid` parameter (this is called "cache
+busting"). This `cacheid` value derived from the
+[sha1sum](https://en.wikipedia.org/wiki/Sha1sum) of each targeted
+static file. As a consequence, each time you change a static file, the
+corresponding `cacheid` value will change.
+
+To properly test this feature, this `cacheid` needs to be added
+manually to the automated tests and has to be commited. After
+modifying the needed static file, [run the automated
+tests](#Testing). They will fail, but the inspection of the testing
+log will give you the new `cacheid` value(s). Finally update
+`test/server.cpp` with the appropriate `cacheid` value(s) which have
+changed.
+
 Testing
 -------
 
@@ -124,7 +151,7 @@ where you want to install the libraries. After the installation
 succeeded, you may need to run `ldconfig` (as `root`).
 
 Uninstallation
-------------
+--------------
 
 If you want to uninstall the Kiwix library:
 ```bash
@@ -134,6 +161,55 @@ ninja -C build uninstall
 Like for the installation, you might need to run the command as `root`
 (or using `sudo`).
 
+Custom Index Page
+-----------------
+
+to use custom welcome page mention `customIndexPage` argument in `kiwix::internalServer()` or use `kiwix::server->setCustomIndexTemplate()`.
+(note - while using custom html file please mention all external links as absolute path.)
+
+to create a HTML template with custom JS you need to have a look at various OPDS based endpoints as mentioned [here](https://wiki.kiwix.org/wiki/OPDS) to load books.
+
+To use JS provided by kiwix-serve you can use the following template to start with ->
+
+```
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <title><-- Custom Tittle --></title>
+    <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>
+  </head>
+  <body>
+  </body>
+</html>
+```
+
+- To get books listed using `index.js` add - `<div class="book__list"></div>` under body tag.
+- To get number of books listed add - `<h3 class="kiwixHomeBody__results"></h3>` under body tag.
+- To add language select box add - `<select id="languageFilter"></select>` under body tag.
+- To add language select box add - `<select id="categoryFilter"></select>` under body tag.
+- To add search box for books use following form -
+    ```
+        <form id='kiwixSearchForm'>
+        <input type="text" name="q" placeholder="Search" id="searchFilter" class='kiwixSearch filter'>
+        <input type="submit" class="kiwixButton" value="Search"/>
+        </form>
+    ```
+
+
+If you compile manually Libmicrohttpd, you might need to compile it
+without GNU TLS, a bug here will empeach further compilation
+otherwise.
+
+If the compilation still fails, you might need to get a more recent
+version of a dependency than the one packaged by your Linux
+distribution. Try then with a source tarball distributed by the
+problematic upstream project or even directly from the source code
+repository.
+
 Troubleshooting
 ---------------
 
@@ -156,63 +232,6 @@ cp ninja ../bin
 cd ..
 ```
 
-Custom Index Page
------------------
-
-to use custom welcome page mention `customIndexPage` argument in `kiwix::internalServer()` or use `kiwix::server->setCustomIndexTemplate()`.
-(note - while using custom html file please mention all external links as absolute path.)
-
-to create a HTML template with custom JS you need to have a look at various OPDS based endpoints as mentioned [here](https://wiki.kiwix.org/wiki/OPDS) to load books.
-
-To use JS provided by kiwix-serve you can use the following template to start with ->
-
-```
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <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>
-  </head>
-  <body>
-  </body>
-</html>
-```
-
-- To get books listed using `index.js` add - `<div class="book__list"></div>` under body tag.
-- To get number of books listed add - `<h3 class="kiwixHomeBody__results"></h3>` under body tag.
-- To add language select box add - `<select id="languageFilter"></select>` under body tag.
-- To add language select box add - `<select id="categoryFilter"></select>` under body tag.
-- To add search box for books use following form -
-    ```
-        <form id='kiwixSearchForm'>
-        <input type="text" name="q" placeholder="Search" id="searchFilter" class='kiwixSearch filter'>
-        <input type="submit" class="searchButton" value="Search"/>
-        </form>
-    ```
-
-
-If you compile manually Libmicrohttpd, you might need to compile it
-without GNU TLS, a bug here will empeach further compilation
-otherwise.
-
-If the compilation still fails, you might need to get a more recent
-version of a dependency than the one packaged by your Linux
-distribution. Try then with a source tarball distributed by the
-problematic upstream project or even directly from the source code
-repository.
-
 License
 -------
 

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::

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.

format_code.sh

@@ -1,38 +0,0 @@
-#!/usr/bin/bash
-
-files=(
-"include/library.h"
-"include/common/stringTools.h"
-"include/common/pathTools.h"
-"include/common/otherTools.h"
-"include/common/regexTools.h"
-"include/common/networkTools.h"
-"include/common/archiveTools.h"
-"include/manager.h"
-"include/reader.h"
-"include/kiwix.h"
-"include/xapianSearcher.h"
-"include/searcher.h"
-"src/library.cpp"
-"src/android/kiwix.cpp"
-"src/android/org/kiwix/kiwixlib/JNIKiwixBool.java"
-"src/android/org/kiwix/kiwixlib/JNIKiwix.java"
-"src/android/org/kiwix/kiwixlib/JNIKiwixString.java"
-"src/android/org/kiwix/kiwixlib/JNIKiwixInt.java"
-"src/searcher.cpp"
-"src/common/pathTools.cpp"
-"src/common/regexTools.cpp"
-"src/common/otherTools.cpp"
-"src/common/archiveTools.cpp"
-"src/common/networkTools.cpp"
-"src/common/stringTools.cpp"
-"src/xapianSearcher.cpp"
-"src/manager.cpp"
-"src/reader.cpp"
-)
-
-for i in "${files[@]}"
-do
-  echo $i
-  clang-format -i -style=file $i
-done

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

@@ -223,7 +223,6 @@ class Library
 
   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});

include/manager.h

@@ -22,7 +22,6 @@
 
 #include "book.h"
 #include "library.h"
-#include "reader.h"
 
 #include <string>
 #include <vector>
@@ -38,10 +37,10 @@ namespace kiwix
 class LibraryManipulator
 {
  public: // functions
-  explicit LibraryManipulator(Library* library);
+  explicit LibraryManipulator(std::shared_ptr<Library> library);
   virtual ~LibraryManipulator();
 
-  Library& getLibrary() const { return library; }
+  Library& getLibrary() const { return *library.get(); }
 
   bool addBookToLibrary(const Book& book);
   void addBookmarkToLibrary(const Bookmark& bookmark);
@@ -53,7 +52,7 @@ class LibraryManipulator
   virtual void booksWereRemovedFromLibrary();
 
  private: // data
-  kiwix::Library& library;
+  std::shared_ptr<kiwix::Library> library;
 };
 
 /**
@@ -66,7 +65,7 @@ class Manager
 
  public: // functions
   explicit Manager(LibraryManipulator* manipulator);
-  explicit Manager(Library* library);
+  explicit Manager(std::shared_ptr<Library> library);
 
   /**
    * Read a `library.xml` and add book in the file to the library.

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/name_mapper.h

@@ -50,7 +50,7 @@ class HumanReadableNameMapper : public NameMapper {
     std::map<std::string, std::string> m_nameToId;
 
   public:
-    HumanReadableNameMapper(kiwix::Library& library, bool withAlias);
+    HumanReadableNameMapper(const kiwix::Library& library, bool withAlias);
     virtual ~HumanReadableNameMapper() = default;
     virtual std::string getNameForId(const std::string& id) const;
     virtual std::string getIdForName(const std::string& name) const;
@@ -59,7 +59,7 @@ class HumanReadableNameMapper : public NameMapper {
 class UpdatableNameMapper : public NameMapper {
     typedef std::shared_ptr<NameMapper> NameMapperHandle;
   public:
-    UpdatableNameMapper(Library& library, bool withAlias);
+    UpdatableNameMapper(std::shared_ptr<Library> library, bool withAlias);
 
     virtual std::string getNameForId(const std::string& id) const;
     virtual std::string getIdForName(const std::string& name) const;
@@ -71,7 +71,7 @@ class UpdatableNameMapper : public NameMapper {
 
   private:
     mutable std::mutex mutex;
-    Library& library;
+    std::shared_ptr<Library> library;
     NameMapperHandle nameMapper;
     const bool withAlias;
 };

include/opds_dumper.h

@@ -23,11 +23,11 @@
 #include <time.h>
 #include <sstream>
 #include <string>
+#include <vector>
 
 #include <pugixml.hpp>
 
-#include "library.h"
-#include "reader.h"
+#include "server.h"
 
 using namespace std;
 
@@ -41,8 +41,7 @@ namespace kiwix
 class OPDSDumper
 {
  public:
-  OPDSDumper() = default;
-  OPDSDumper(Library* library);
+  OPDSDumper(Server::Configuration configuration);
   ~OPDSDumper();
 
   /**
@@ -93,13 +92,6 @@ class OPDSDumper
    */
   void setLibraryId(const std::string& id) { this->libraryId = id;}
 
-  /**
-   * Set the root location used when generating url.
-   *
-   * @param rootLocation the root location to use.
-   */
-  void setRootLocation(const std::string& rootLocation) { this->rootLocation = rootLocation; }
-
   /**
    * Set some informations about the search results.
    *
@@ -110,9 +102,8 @@ class OPDSDumper
   void setOpenSearchInfo(int totalResult, int startIndex, int count);
 
  protected:
-  kiwix::Library* library;
+  Server::Configuration m_configuration;
   std::string libraryId;
-  std::string rootLocation;
   int m_totalResults;
   int m_startIndex;
   int m_count;

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.
    *
@@ -58,7 +46,7 @@ class SearchRenderer
    * @param start The start offset used for the srs.
    * @param estimatedResultCount The estimatedResultCount of the whole search
    */
-  SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper,
+  SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<NameMapper> mapper,
                  unsigned int start, unsigned int estimatedResultCount);
 
   /**
@@ -70,7 +58,7 @@ class SearchRenderer
    * @param start The start offset used for the srs.
    * @param estimatedResultCount The estimatedResultCount of the whole search
    */
-  SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper, Library* library,
+  SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<NameMapper> mapper, std::shared_ptr<Library> library,
                  unsigned int start, unsigned int estimatedResultCount);
 
   ~SearchRenderer();
@@ -118,8 +106,8 @@ class SearchRenderer
  protected:
   std::string beautifyInteger(const unsigned int number);
   zim::SearchResultSet m_srs;
-  NameMapper* mp_nameMapper;
-  Library* mp_library;
+  std::shared_ptr<NameMapper> mp_nameMapper;
+  std::shared_ptr<Library> mp_library;
   std::string searchBookQuery;
   std::string searchPattern;
   std::string protocolPrefix;

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(std::shared_ptr<Reader> reader);
-
-
-  std::shared_ptr<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<std::shared_ptr<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

@@ -29,15 +29,81 @@ namespace kiwix
   class NameMapper;
   class InternalServer;
 
+
   class Server {
-     public:
+    public:
+      class Configuration {
+        public:
+          explicit Configuration(std::shared_ptr<Library> library, std::shared_ptr<NameMapper> nameMapper=nullptr);
+
+          Configuration& setRoot(const std::string& root);
+          Configuration& setAddress(const std::string& addr) {
+            m_addr = addr;
+            return *this;
+          }
+
+          Configuration& setPort(int port) {
+            m_port = port;
+            return *this;
+          }
+
+          Configuration& setNbThreads(int threads) {
+            m_nbThreads = threads;
+            return *this;
+          }
+
+          Configuration& setMultiZimSearchLimit(unsigned int limit) {
+            m_multizimSearchLimit = limit;
+            return *this;
+          }
+
+          Configuration& setIpConnectionLimit(int limit) {
+            m_ipConnectionLimit = limit;
+            return *this;
+          }
+
+          Configuration& setVerbose(bool verbose) {
+            m_verbose = verbose;
+            return *this;
+          }
+
+          Configuration& setIndexTemplateString(const std::string& indexTemplateString) {
+            m_indexTemplateString = indexTemplateString;
+            return *this;
+          }
+
+          Configuration& setTaskbar(bool withTaskbar, bool withLibraryButton) {
+            m_withTaskbar = withTaskbar;
+            m_withLibraryButton = withLibraryButton;
+            return *this;
+          }
+
+          Configuration& setBlockExternalLinks(bool blockExternalLinks) {
+            m_blockExternalLinks = blockExternalLinks;
+            return *this;
+          }
+
+          std::shared_ptr<Library> mp_library;
+          std::shared_ptr<NameMapper> mp_nameMapper;
+          std::string m_root = "";
+          std::string m_addr = "";
+          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;
+          bool m_blockExternalLinks = false;
+          int m_ipConnectionLimit = 0;
+       };
+
        /**
         * The default constructor.
         *
         * @param library The library to serve.
         */
-       Server(Library* library, NameMapper* nameMapper=nullptr);
-
+       explicit Server(const Configuration& configuration);
        virtual ~Server();
 
        /**
@@ -50,35 +116,22 @@ namespace kiwix
         */
        void stop();
 
-       void setRoot(const std::string& root);
-       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; }
-       void setTaskbar(bool withTaskbar, bool withLibraryButton)
-        { m_withTaskbar = withTaskbar; m_withLibraryButton = withLibraryButton; }
-       void setBlockExternalLinks(bool blockExternalLinks)
-        { m_blockExternalLinks = blockExternalLinks; }
+       /**
+        * Tell if the server is running or not.
+        */
+       bool isRunning();
+
+       /**
+        * Get the port of the server
+        */
        int getPort();
+
+       /**
+        * Get the ipAddress of the server
+        */
        std::string getAddress();
 
      protected:
-       Library* mp_library;
-       NameMapper* mp_nameMapper;
-       std::string m_root = "";
-       std::string m_addr = "";
-       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;
-       bool m_blockExternalLinks = false;
-       int m_ipConnectionLimit = 0;
        std::unique_ptr<InternalServer> mp_server;
   };
 }

include/version.h

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

scripts/format_code.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/bash
+
+# Compute 'src' path
+SCRIPT_DIR=$(dirname "$0")
+REPO_DIR=$(readlink -f "$SCRIPT_DIR"/..)
+DIRS="src include"
+
+# Apply formating to all *.cpp and *.h files
+cd "$REPO_DIR"
+for FILE in $(find $DIRS -name '*.h' -o -name '*.cpp')
+do
+  echo $FILE
+  clang-format -i -style=file "$FILE"
+done

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"
@@ -278,16 +277,6 @@ 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)
-{
-  auto archive = getArchiveById(id);
-  if(archive) {
-    return std::shared_ptr<Reader>(new Reader(archive, true));
-  } else {
-    return nullptr;
-  }
-}
-
 std::shared_ptr<zim::Archive> Library::getArchiveById(const std::string& id)
 {
   try {
@@ -473,8 +462,13 @@ 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);

src/manager.cpp

@@ -41,8 +41,8 @@ struct NoDelete
 // LibraryManipulator
 ////////////////////////////////////////////////////////////////////////////////
 
-LibraryManipulator::LibraryManipulator(Library* library)
-  : library(*library)
+LibraryManipulator::LibraryManipulator(std::shared_ptr<Library> library)
+  : library(library)
 {}
 
 LibraryManipulator::~LibraryManipulator()
@@ -50,7 +50,7 @@ LibraryManipulator::~LibraryManipulator()
 
 bool LibraryManipulator::addBookToLibrary(const Book& book)
 {
-  const auto ret = library.addBook(book);
+  const auto ret = library->addBook(book);
   if ( ret ) {
     bookWasAddedToLibrary(book);
   }
@@ -59,13 +59,13 @@ bool LibraryManipulator::addBookToLibrary(const Book& book)
 
 void LibraryManipulator::addBookmarkToLibrary(const Bookmark& bookmark)
 {
-  library.addBookmark(bookmark);
+  library->addBookmark(bookmark);
   bookmarkWasAddedToLibrary(bookmark);
 }
 
 uint32_t LibraryManipulator::removeBooksNotUpdatedSince(Library::Revision rev)
 {
-  const auto n = library.removeBooksNotUpdatedSince(rev);
+  const auto n = library->removeBooksNotUpdatedSince(rev);
   if ( n != 0 ) {
     booksWereRemovedFromLibrary();
   }
@@ -95,7 +95,7 @@ Manager::Manager(LibraryManipulator* manipulator):
 {
 }
 
-Manager::Manager(Library* library) :
+Manager::Manager(std::shared_ptr<Library> library) :
   writableLibraryPath(""),
   manipulator(new LibraryManipulator(library))
 {

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',
@@ -48,7 +45,7 @@ config_h = configure_file(output : 'kiwix_config.h',
                input : 'config.h.in')
 install_headers(config_h, subdir:'kiwix')
 
-kiwixlib = library('kiwix',
+libkiwix = library('kiwix',
                    kiwix_sources,
                    include_directories : inc,
                    dependencies : all_deps,

src/name_mapper.cpp

@@ -24,7 +24,7 @@
 
 namespace kiwix {
 
-HumanReadableNameMapper::HumanReadableNameMapper(kiwix::Library& library, bool withAlias) {
+HumanReadableNameMapper::HumanReadableNameMapper(const kiwix::Library& library, bool withAlias) {
   for (auto& bookId: library.filter(kiwix::Filter().local(true).valid(true))) {
     auto& currentBook = library.getBookById(bookId);
     auto bookName = currentBook.getHumanReadableIdFromPath();
@@ -63,7 +63,7 @@ std::string HumanReadableNameMapper::getIdForName(const std::string& name) const
 // UpdatableNameMapper
 ////////////////////////////////////////////////////////////////////////////////
 
-UpdatableNameMapper::UpdatableNameMapper(Library& lib, bool withAlias)
+UpdatableNameMapper::UpdatableNameMapper(std::shared_ptr<Library> lib, bool withAlias)
   : library(lib)
   , withAlias(withAlias)
 {
@@ -72,7 +72,7 @@ UpdatableNameMapper::UpdatableNameMapper(Library& lib, bool withAlias)
 
 void UpdatableNameMapper::update()
 {
-  const auto newNameMapper = new HumanReadableNameMapper(library, withAlias);
+  const auto newNameMapper = new HumanReadableNameMapper(*library, withAlias);
   std::lock_guard<std::mutex> lock(mutex);
   nameMapper.reset(newNameMapper);
 }

src/opds_dumper.cpp

@@ -19,10 +19,11 @@
 
 #include "opds_dumper.h"
 #include "book.h"
+#include "library.h"
+#include "name_mapper.h"
 
-#include "kiwixlib-resources.h"
+#include "libkiwix-resources.h"
 #include <mustache.hpp>
-#include <unicode/locid.h>
 
 #include "tools/stringTools.h"
 #include "tools/otherTools.h"
@@ -31,8 +32,8 @@ namespace kiwix
 {
 
 /* Constructor */
-OPDSDumper::OPDSDumper(Library* library)
-  : library(library)
+OPDSDumper::OPDSDumper(Server::Configuration configuration)
+  : m_configuration(configuration)
 {
 }
 /* Destructor */
@@ -50,6 +51,8 @@ void OPDSDumper::setOpenSearchInfo(int totalResults, int startIndex, int count)
 namespace
 {
 
+const std::string XML_HEADER(R"(<?xml version="1.0" encoding="UTF-8"?>)");
+
 typedef kainjow::mustache::data MustacheData;
 typedef kainjow::mustache::list BooksData;
 typedef kainjow::mustache::list IllustrationInfo;
@@ -70,16 +73,17 @@ IllustrationInfo getBookIllustrationInfo(const Book& book)
     return illustrations;
 }
 
-kainjow::mustache::object getSingleBookData(const Book& book)
+std::string fullEntryXML(const Server::Configuration& configuration, const Book& book)
 {
     const auto bookDate = book.getDate() + "T00:00:00Z";
-    return kainjow::mustache::object{
+    const kainjow::mustache::object data{
+      {"root", configuration.m_root},
       {"id", book.getId()},
       {"name", book.getName()},
       {"title", book.getTitle()},
       {"description", book.getDescription()},
       {"language", book.getLanguage()},
-      {"content_id",  urlEncode(book.getHumanReadableIdFromPath(), true)},
+      {"content_id",  urlEncode(configuration.mp_nameMapper->getNameForId(book.getId()), true)},
       {"updated", bookDate}, // XXX: this should be the entry update datetime
       {"book_date", bookDate},
       {"category", book.getCategory()},
@@ -93,27 +97,33 @@ kainjow::mustache::object getSingleBookData(const Book& book)
       {"size", to_string(book.getSize())},
       {"icons", getBookIllustrationInfo(book)},
     };
+    return render_template(RESOURCE::templates::catalog_v2_entry_xml, data);
 }
 
-std::string getSingleBookEntryXML(const Book& book, bool withXMLHeader, const std::string& rootLocation, const std::string& endpointRoot, bool partial)
+std::string partialEntryXML(const Server::Configuration& configuration, const Book& book)
 {
-  auto data = getSingleBookData(book);
-  data["with_xml_header"] = MustacheData(withXMLHeader);
-  data["dump_partial_entries"] = MustacheData(partial);
-  data["endpoint_root"] = endpointRoot;
-  data["root"] = rootLocation;
-  return render_template(RESOURCE::templates::catalog_v2_entry_xml, data);
+    const auto bookDate = book.getDate() + "T00:00:00Z";
+    const kainjow::mustache::object data{
+      {"root",  configuration.m_root},
+      {"endpoint_root", configuration.m_root + "/catalog/v2"},
+      {"id", book.getId()},
+      {"title", book.getTitle()},
+      {"updated", bookDate}, // XXX: this should be the entry update datetime
+    };
+    const auto xmlTemplate = RESOURCE::templates::catalog_v2_partial_entry_xml;
+    return render_template(xmlTemplate, data);
 }
 
-BooksData getBooksData(const Library* library, const std::vector<std::string>& bookIds, const std::string& rootLocation, const std::string& endpointRoot, bool partial)
+BooksData getBooksData(const Server::Configuration& configuration, const std::vector<std::string>& bookIds, bool partial)
 {
   BooksData booksData;
   for ( const auto& bookId : bookIds ) {
     try {
-      const Book book = library->getBookByIdThreadSafe(bookId);
-      booksData.push_back(kainjow::mustache::object{
-          {"entry", getSingleBookEntryXML(book, false, rootLocation, endpointRoot, partial)}
-      });
+      const Book book = configuration.mp_library->getBookByIdThreadSafe(bookId);
+      const auto entryXML = partial
+                          ? partialEntryXML(configuration, book)
+                          : fullEntryXML(configuration, book);
+      booksData.push_back(kainjow::mustache::object{ {"entry", entryXML} });
     } catch ( const std::out_of_range& ) {
       // the book was removed from the library since its id was obtained
       // ignore it
@@ -163,14 +173,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()});
   }
 }
 
@@ -186,10 +190,10 @@ std::string getLanguageSelfName(const std::string& lang) {
 
 string OPDSDumper::dumpOPDSFeed(const std::vector<std::string>& bookIds, const std::string& query) const
 {
-  const auto booksData = getBooksData(library, bookIds, rootLocation, "", false);
+  const auto booksData = getBooksData(m_configuration, bookIds, false);
   const kainjow::mustache::object template_data{
      {"date", gen_date_str()},
-     {"root", rootLocation},
+     {"root", m_configuration.m_root},
      {"feed_id", gen_uuid(libraryId + "/catalog/search?"+query)},
      {"filter", onlyAsNonEmptyMustacheValue(query)},
      {"totalResults", to_string(m_totalResults)},
@@ -203,8 +207,8 @@ string OPDSDumper::dumpOPDSFeed(const std::vector<std::string>& bookIds, const s
 
 string OPDSDumper::dumpOPDSFeedV2(const std::vector<std::string>& bookIds, const std::string& query, bool partial) const
 {
-  const auto endpointRoot = rootLocation + "/catalog/v2";
-  const auto booksData = getBooksData(library, bookIds, rootLocation, endpointRoot, partial);
+  const auto endpointRoot = m_configuration.m_root + "/catalog/v2";
+  const auto booksData = getBooksData(m_configuration, bookIds, partial);
 
   const char* const endpoint = partial ? "/partial_entries" : "/entries";
   const kainjow::mustache::object template_data{
@@ -225,14 +229,17 @@ string OPDSDumper::dumpOPDSFeedV2(const std::vector<std::string>& bookIds, const
 
 std::string OPDSDumper::dumpOPDSCompleteEntry(const std::string& bookId) const
 {
-  return getSingleBookEntryXML(library->getBookById(bookId), true, rootLocation, "", false);
+  const auto book = m_configuration.mp_library->getBookById(bookId);
+  return XML_HEADER
+         + "\n"
+         + fullEntryXML(m_configuration, book);
 }
 
 std::string OPDSDumper::categoriesOPDSFeed() const
 {
   const auto now = gen_date_str();
   kainjow::mustache::list categoryData;
-  for ( const auto& category : library->getBooksCategories() ) {
+  for ( const auto& category : m_configuration.mp_library->getBooksCategories() ) {
     const auto urlencodedCategoryName = urlEncode(category);
     categoryData.push_back(kainjow::mustache::object{
       {"name", category},
@@ -246,7 +253,7 @@ std::string OPDSDumper::categoriesOPDSFeed() const
              RESOURCE::templates::catalog_v2_categories_xml,
              kainjow::mustache::object{
                {"date", now},
-               {"endpoint_root", rootLocation + "/catalog/v2"},
+               {"endpoint_root", m_configuration.m_root + "/catalog/v2"},
                {"feed_id", gen_uuid(libraryId + "/categories")},
                {"categories", categoryData }
              }
@@ -258,7 +265,7 @@ std::string OPDSDumper::languagesOPDSFeed() const
   const auto now = gen_date_str();
   kainjow::mustache::list languageData;
   std::call_once(fillLanguagesFlag, fillLanguagesMap);
-  for ( const auto& langAndBookCount : library->getBooksLanguagesWithCounts() ) {
+  for ( const auto& langAndBookCount : m_configuration.mp_library->getBooksLanguagesWithCounts() ) {
     const std::string languageCode = langAndBookCount.first;
     const int bookCount = langAndBookCount.second;
     const auto languageSelfName = getLanguageSelfName(languageCode);
@@ -275,7 +282,7 @@ std::string OPDSDumper::languagesOPDSFeed() const
              RESOURCE::templates::catalog_v2_languages_xml,
              kainjow::mustache::object{
                {"date", now},
-               {"endpoint_root", rootLocation + "/catalog/v2"},
+               {"endpoint_root", m_configuration.m_root + "/catalog/v2"},
                {"feed_id", gen_uuid(libraryId + "/languages")},
                {"languages", languageData }
              }

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"
 
@@ -31,29 +29,19 @@
 #include <zim/search.h>
 
 #include <mustache.hpp>
-#include "kiwixlib-resources.h"
+#include "libkiwix-resources.h"
 #include "tools/stringTools.h"
 
 namespace kiwix
 {
 
 /* Constructor */
-SearchRenderer::SearchRenderer(Searcher* searcher, NameMapper* mapper)
-    : SearchRenderer(
-        /* srs */ searcher->getSearchResultSet(),
-        /* mapper */ mapper,
-        /* library */ nullptr,
-        /* start */ searcher->getResultStart(),
-        /* estimatedResultCount */ searcher->getEstimatedResultCount()
-        )
-{}
-
-SearchRenderer::SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper,
+SearchRenderer::SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<NameMapper> mapper,
                       unsigned int start, unsigned int estimatedResultCount)
     : SearchRenderer(srs, mapper, nullptr, start, estimatedResultCount)
 {}
 
-SearchRenderer::SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper, Library* library,
+SearchRenderer::SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<NameMapper> mapper, std::shared_ptr<Library> library,
                       unsigned int start, unsigned int estimatedResultCount)
     : m_srs(srs),
       mp_nameMapper(mapper),
@@ -142,7 +130,7 @@ kainjow::mustache::data buildPagination(
   auto nbPages = lastPage + 1;
 
   auto firstPageGenerated = currentPage > 4 ? currentPage-4 : 0;
-  auto lastPageGenerated = min(currentPage+4, lastPage);
+  auto lastPageGenerated = std::min(currentPage+4, lastPage);
 
   if (nbPages != 1) {
     if (firstPageGenerated!=0) {
@@ -178,13 +166,14 @@ kainjow::mustache::data buildPagination(
 
 std::string SearchRenderer::renderTemplate(const std::string& tmpl_str)
 {
+  const std::string absPathPrefix = protocolPrefix;
   // 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", protocolPrefix + urlEncode(mp_nameMapper->getNameForId(zim_id), true) + "/" + urlEncode(it.getPath()));
+    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());
@@ -200,7 +189,7 @@ std::string SearchRenderer::renderTemplate(const std::string& tmpl_str)
   results.set("count", kiwix::beautifyInteger(estimatedResultCount));
   results.set("hasResults", estimatedResultCount != 0);
   results.set("start", kiwix::beautifyInteger(resultStart));
-  results.set("end", kiwix::beautifyInteger(min(resultStart+pageLength-1, estimatedResultCount)));
+  results.set("end", kiwix::beautifyInteger(std::min(resultStart+pageLength-1, estimatedResultCount)));
 
   // pagination
   auto pagination = buildPagination(
@@ -217,7 +206,7 @@ std::string SearchRenderer::renderTemplate(const std::string& tmpl_str)
 
 
   kainjow::mustache::data allData;
-  allData.set("protocolPrefix", protocolPrefix);
+  allData.set("searchProtocolPrefix", searchProtocolPrefix);
   allData.set("results", results);
   allData.set("pagination", pagination);
   allData.set("query", query);

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(std::shared_ptr<Reader> reader)
-{
-  if (!reader->hasFulltextIndex()) {
-      return false;
-  }
-
-  for ( auto existing_reader : readers ) {
-    if ( existing_reader->getZimArchive()->getUuid() == reader->getZimArchive()->getUuid() )
-      return false;
-  }
-
-  this->readers.push_back(reader);
-  return true;
-}
-
-
-std::shared_ptr<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,53 +24,40 @@
 
 #include <string>
 
+#include <zim/item.h>
 #include "server/internalServer.h"
+#include "tools/otherTools.h"
 
 namespace kiwix {
 
-Server::Server(Library* library, NameMapper* nameMapper) :
+Server::Configuration::Configuration(std::shared_ptr<Library> library, std::shared_ptr<NameMapper> nameMapper) :
   mp_library(library),
-  mp_nameMapper(nameMapper),
-  mp_server(nullptr)
+  mp_nameMapper(nameMapper ? nameMapper : std::make_shared<HumanReadableNameMapper>(*library, true))
+{}
+
+Server::Configuration& Server::Configuration::setRoot(const std::string& root)
+{
+  m_root = normalizeRootUrl(root);
+  return *this;
+}
+
+Server::Server(const Server::Configuration& configuration) :
+  mp_server(new InternalServer(configuration))
 {
 }
 
 Server::~Server() = default;
 
 bool Server::start() {
-  mp_server.reset(new InternalServer(
-    mp_library,
-    mp_nameMapper,
-    m_addr,
-    m_port,
-    m_root,
-    m_nbThreads,
-    m_multizimSearchLimit,
-    m_verbose,
-    m_withTaskbar,
-    m_withLibraryButton,
-    m_blockExternalLinks,
-    m_indexTemplateString,
-    m_ipConnectionLimit));
   return mp_server->start();
 }
 
 void Server::stop() {
-  if (mp_server) {
-    mp_server->stop();
-    mp_server.reset(nullptr);
-  }
+  mp_server->stop();
 }
 
-void Server::setRoot(const std::string& root)
-{
-  m_root = root;
-  if (m_root[0] != '/') {
-    m_root = "/" + m_root;
-  }
-  if (m_root.back() == '/') {
-    m_root.erase(m_root.size() - 1);
-  }
+bool Server::isRunning() {
+  return mp_server->isRunning();
 }
 
 int Server::getPort()

src/server/internalServer.cpp

@@ -51,8 +51,6 @@ 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"
@@ -61,6 +59,7 @@ extern "C" {
 #include <zim/error.h>
 #include <zim/entry.h>
 #include <zim/item.h>
+#include <zim/suggestion.h>
 
 #include <mustache.hpp>
 
@@ -68,7 +67,8 @@ extern "C" {
 #include <string>
 #include <vector>
 #include <chrono>
-#include "kiwixlib-resources.h"
+#include <fstream>
+#include "libkiwix-resources.h"
 
 #ifndef _WIN32
 # include <arpa/inet.h>
@@ -85,16 +85,6 @@ namespace kiwix {
 namespace
 {
 
-inline std::string normalizeRootUrl(std::string rootUrl)
-{
-  while ( !rootUrl.empty() && rootUrl.back() == '/' )
-    rootUrl.pop_back();
-
-  while ( !rootUrl.empty() && rootUrl.front() == '/' )
-    rootUrl = rootUrl.substr(1);
-  return rootUrl.empty() ? rootUrl : "/" + rootUrl;
-}
-
 Filter get_search_filter(const RequestContext& request, const std::string& prefix="")
 {
     auto filter = kiwix::Filter().valid(true).local(true);
@@ -212,6 +202,12 @@ void checkBookNumber(const Library::BookIdSet& bookIds, size_t limit) {
   }
 }
 
+struct CustomizedResourceData
+{
+  std::string mimeType;
+  std::string resourceFilePath;
+};
+
 } // unnamed namespace
 
 std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const RequestContext& request) const
@@ -327,9 +323,6 @@ zim::Query SearchInfo::getZimQuery(bool verbose) const {
   return query;
 }
 
-
-static IdNameMapper defaultNameMapper;
-
 static MHD_Result staticHandlerCallback(void* cls,
                                         struct MHD_Connection* connection,
                                         const char* url,
@@ -339,45 +332,46 @@ 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,
-                               std::string addr,
-                               int port,
-                               std::string root,
-                               int nbThreads,
-                               unsigned int multizimSearchLimit,
-                               bool verbose,
-                               bool withTaskbar,
-                               bool withLibraryButton,
-                               bool blockExternalLinks,
-                               std::string indexTemplateString,
-                               int ipConnectionLimit) :
-  m_addr(addr),
-  m_port(port),
-  m_root(normalizeRootUrl(root)),
-  m_nbThreads(nbThreads),
-  m_multizimSearchLimit(multizimSearchLimit),
-  m_verbose(verbose),
-  m_withTaskbar(withTaskbar),
-  m_withLibraryButton(withLibraryButton),
-  m_blockExternalLinks(blockExternalLinks),
-  m_indexTemplateString(indexTemplateString.empty() ? RESOURCE::templates::index_html : indexTemplateString),
-  m_ipConnectionLimit(ipConnectionLimit),
+
+InternalServer::InternalServer(const Server::Configuration& configuration) :
+  Server::Configuration(configuration),
+  m_indexTemplateString(configuration.m_indexTemplateString.empty() ? RESOURCE::templates::index_html : configuration.m_indexTemplateString),
   mp_daemon(nullptr),
-  mp_library(library),
-  mp_nameMapper(nameMapper ? nameMapper : &defaultNameMapper),
   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)))
+  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;
 #else
   int flags = MHD_USE_POLL_INTERNALLY;
 #endif
-  if (m_verbose.load())
+  if (m_verbose)
     flags |= MHD_USE_DEBUG;
 
   struct sockaddr_in sockAddr;
@@ -421,8 +415,13 @@ bool InternalServer::start() {
 void InternalServer::stop()
 {
   MHD_stop_daemon(mp_daemon);
+  mp_daemon = nullptr;
 }
 
+bool InternalServer::isRunning() const
+{
+  return mp_daemon != nullptr;
+}
 static MHD_Result staticHandlerCallback(void* cls,
                                         struct MHD_Connection* connection,
                                         const char* url,
@@ -452,14 +451,14 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
                                            void** cont_cls)
 {
   auto start_time = std::chrono::steady_clock::now();
-  if (m_verbose.load() ) {
+  if (m_verbose) {
     printf("======================\n");
     printf("Requesting : \n");
     printf("full_url  : %s\n", url);
   }
   RequestContext request(connection, m_root, url, method, version);
 
-  if (m_verbose.load() ) {
+  if (m_verbose) {
     request.print_debug_info();
   }
   /* Unexpected method */
@@ -475,7 +474,7 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
 
   if (response->getReturnCode() == MHD_HTTP_INTERNAL_SERVER_ERROR) {
     printf("========== INTERNAL ERROR !! ============\n");
-    if (!m_verbose.load()) {
+    if (!m_verbose) {
       printf("Requesting : \n");
       printf("full_url : %s\n", url);
       request.print_debug_info();
@@ -488,13 +487,23 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
   auto ret = response->send(request, connection);
   auto end_time = std::chrono::steady_clock::now();
   auto time_span = std::chrono::duration_cast<std::chrono::duration<double>>(end_time - start_time);
-  if (m_verbose.load()) {
+  if (m_verbose) {
     printf("Request time : %fs\n", time_span.count());
     printf("----------------------\n");
   }
   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 {
@@ -507,36 +516,45 @@ 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, "viewer") || isEndpointUrl(url, "skin"))
       return handle_skin(request);
 
-    if (startsWith(request.get_url(), "/catalog/"))
+    if (url == "/viewer_settings.js")
+      return handle_viewer_settings(request);
+
+    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() == "/search/searchdescription.xml") {
-      return ContentResponse::build(
-        *this,
-        RESOURCE::ft_opensearchdescription_xml,
-        get_default_data(),
-        "application/opensearchdescription+xml");
-    }
-
-    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);
+    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 HTTP500Response(*this, request)
@@ -578,53 +596,39 @@ InternalServer::get_matching_if_none_match_etag(const RequestContext& r) const
 
 std::unique_ptr<Response> InternalServer::build_homepage(const RequestContext& request)
 {
-  return ContentResponse::build(*this, m_indexTemplateString, get_default_data(), "text/html; charset=utf-8", true);
+  return ContentResponse::build(*this, m_indexTemplateString, get_default_data(), "text/html; charset=utf-8");
 }
 
 /**
  * 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)
+class InternalServer::LockableSuggestionSearcher : public zim::SuggestionSearcher
 {
-  SuggestionsList_t suggestions;
-  std::shared_ptr<zim::SuggestionSearcher> searcher;
-  searcher = cache.getOrPut(bookId, [=](){ return make_shared<zim::SuggestionSearcher>(*archive); });
+  public:
+    explicit LockableSuggestionSearcher(const zim::Archive& archive)
+      : 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);
+    std::unique_lock<std::mutex> getLock() {
+      return std::unique_lock<std::mutex>(m_mutex);
     }
-  } 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;
-}
+    virtual ~LockableSuggestionSearcher() = default;
+  private:
+    std::mutex m_mutex;
+};
 
 std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& request)
 {
-  if (m_verbose.load()) {
+  if (m_verbose) {
     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 {
@@ -637,8 +641,7 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
 
   if (archive == nullptr) {
     return HTTP404Response(*this, request)
-           + noSuchBookErrorMsg(bookName)
-           + TaskbarInfo(bookName);
+           + noSuchBookErrorMsg(bookName);
   }
 
   const auto queryString = request.get_optional_param("term", std::string());
@@ -648,7 +651,7 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
     count = 10;
   }
 
-  if (m_verbose.load()) {
+  if (m_verbose) {
     printf("Searching suggestions for: \"%s\"\n", queryString.c_str());
   }
 
@@ -657,9 +660,14 @@ 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<LockableSuggestionSearcher>(*archive); }
+  );
+  const auto lock(searcher->getLock());
+  auto search = searcher->suggest(queryString);
+  auto srs = search.getResults(start, count);
+
+  for(auto& suggestion: srs) {
     MustacheData result;
     result.set("label", suggestion.getTitle());
 
@@ -694,13 +702,30 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
   return std::move(response);
 }
 
+std::unique_ptr<Response> InternalServer::handle_viewer_settings(const RequestContext& request)
+{
+  if (m_verbose) {
+    printf("** running handle_viewer_settings\n");
+  }
+
+  const kainjow::mustache::object data{
+    {"enable_toolbar", m_withTaskbar ? "true" : "false" },
+    {"enable_link_blocking", m_blockExternalLinks ? "true" : "false" },
+    {"enable_library_button", m_withLibraryButton ? "true" : "false" }
+  };
+  return ContentResponse::build(*this, RESOURCE::templates::viewer_settings_js, data, "application/javascript; charset=utf-8");
+}
+
 std::unique_ptr<Response> InternalServer::handle_skin(const RequestContext& request)
 {
-  if (m_verbose.load()) {
+  if (m_verbose) {
     printf("** running handle_skin\n");
   }
 
-  auto resourceName = request.get_url().substr(1);
+  const bool isRequestForViewer = request.get_url() == "/viewer";
+  auto resourceName = isRequestForViewer
+                    ? "viewer.html"
+                    : request.get_url().substr(1);
   try {
     auto response = ContentResponse::build(
         *this,
@@ -716,10 +741,22 @@ std::unique_ptr<Response> InternalServer::handle_skin(const RequestContext& requ
 
 std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& request)
 {
-  if (m_verbose.load()) {
+  if (m_verbose) {
     printf("** running handle_search\n");
   }
 
+  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();
@@ -733,7 +770,7 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
     try {
       search = searchCache.getOrPut(searchInfo,
         [=](){
-          return make_shared<zim::Search>(searcher->search(searchInfo.getZimQuery(m_verbose.load())));
+          return make_shared<zim::Search>(searcher->search(searchInfo.getZimQuery(m_verbose)));
         }
       );
     } catch(std::runtime_error& e) {
@@ -745,11 +782,15 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
                                  "404-page-heading",
                                  cssUrl);
       response += nonParameterizedMessage("no-search-results");
+      // XXX: Now this has to be handled by the iframe-based viewer which
+      // XXX: has to resolve if the book selection resulted in a single book.
+      /*
       if(bookIds.size() == 1) {
         auto bookId = *bookIds.begin();
         auto bookName = mp_nameMapper->getNameForId(bookId);
         response += TaskbarInfo(bookName, mp_library->getArchiveById(bookId).get());
       }
+      */
       return response;
     }
 
@@ -775,20 +816,22 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
                             search->getEstimatedMatches());
     renderer.setSearchPattern(searchInfo.pattern);
     renderer.setSearchBookQuery(searchInfo.bookFilterQuery);
-    renderer.setProtocolPrefix(m_root + "/");
+    renderer.setProtocolPrefix(m_root + "/content/");
     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);
+      return ContentResponse::build(*this, renderer.getXml(), "application/rss+xml; charset=utf-8");
     }
     auto response = ContentResponse::build(*this, renderer.getHtml(), "text/html; charset=utf-8");
+    // XXX: Now this has to be handled by the iframe-based viewer which
+    // XXX: has to resolve if the book selection resulted in a single book.
+    /*
     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 Error& e) {
     return HTTP400Response(*this, request)
@@ -799,10 +842,15 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
 
 std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& request)
 {
-  if (m_verbose.load()) {
+  if (m_verbose) {
     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 {
@@ -815,8 +863,7 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
 
   if (archive == nullptr) {
     return HTTP404Response(*this, request)
-           + noSuchBookErrorMsg(bookName)
-           + TaskbarInfo(bookName);
+           + noSuchBookErrorMsg(bookName);
   }
 
   try {
@@ -824,8 +871,7 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
     return build_redirect(bookName, getFinalItem(*archive, entry));
   } catch(zim::EntryNotFound& e) {
     return HTTP404Response(*this, request)
-           + nonParameterizedMessage("random-article-failure")
-           + TaskbarInfo(bookName, archive.get());
+           + nonParameterizedMessage("random-article-failure");
   }
 }
 
@@ -846,9 +892,23 @@ 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) {
+    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()) {
+  if (m_verbose) {
     printf("** running handle_catalog");
   }
 
@@ -877,8 +937,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& r
   }
 
   zim::Uuid uuid;
-  kiwix::OPDSDumper opdsDumper(mp_library);
-  opdsDumper.setRootLocation(m_root);
+  kiwix::OPDSDumper opdsDumper(*this);
   opdsDumper.setLibraryId(m_library_id);
   std::vector<std::string> bookIdsToDump;
   if (url == "root.xml") {
@@ -917,15 +976,6 @@ InternalServer::search_catalog(const RequestContext& request,
 namespace
 {
 
-std::string get_book_name(const RequestContext& request)
-{
-  try {
-    return request.get_url_part(0);
-  } catch (const std::out_of_range& e) {
-    return std::string();
-  }
-}
-
 ParameterizedMessage suggestSearchMsg(const std::string& searchURL, const std::string& pattern)
 {
   return ParameterizedMessage("suggest-search",
@@ -940,7 +990,8 @@ ParameterizedMessage suggestSearchMsg(const std::string& searchURL, const std::s
 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);
 }
 
@@ -948,13 +999,14 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
 {
   const std::string url = request.get_url();
   const std::string pattern = url.substr((url.find_last_of('/'))+1);
-  if (m_verbose.load()) {
+  if (m_verbose) {
     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 {
@@ -966,49 +1018,49 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
     const std::string searchURL = m_root + "/search?pattern=" + kiwix::urlEncode(pattern, true);
     return HTTP404Response(*this, request)
            + urlNotFoundMsg
-           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern))
-           + TaskbarInfo(bookName);
+           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern));
   }
 
-  auto urlStr = request.get_url().substr(bookName.size()+1);
+  auto urlStr = url.substr(prefixLength + bookName.size());
   if (urlStr[0] == '/') {
     urlStr = urlStr.substr(1);
   }
 
   try {
     auto entry = getEntryFromPath(*archive, urlStr);
-    if (entry.isRedirect() || urlStr.empty()) {
-      // If urlStr is empty, we want to mainPage.
-      // We must do a redirection to the real page.
+    if (entry.isRedirect() || urlStr != entry.getPath()) {
+      // In the condition above, the second case (an entry with a different
+      // URL was returned) can occur in the following situations:
+      // 1. urlStr is empty or equal to "/" and the ZIM file doesn't contain
+      //    such an entry, in which case the main entry is returned instead.
+      // 2. The ZIM file uses old namespace scheme, and the resource at urlStr
+      //    is not present but can be found under one of the 'A', 'I', 'J' or
+      //    '-' namespaces, in which case that resource is returned instead.
       return build_redirect(bookName, getFinalItem(*archive, entry));
     }
     auto response = ItemResponse::build(*this, request, entry.getItem());
-    try {
-      dynamic_cast<ContentResponse&>(*response).set_taskbar(bookName, archive.get());
-    } catch (std::bad_cast& e) {}
 
-    if (m_verbose.load()) {
+    if (m_verbose) {
       printf("Found %s\n", entry.getPath().c_str());
       printf("mimeType: %s\n", entry.getItem(true).getMimetype().c_str());
     }
 
     return response;
   } catch(zim::EntryNotFound& e) {
-    if (m_verbose.load())
+    if (m_verbose)
       printf("Failed to find %s\n", urlStr.c_str());
 
     std::string searchURL = m_root + "/search?content=" + bookName + "&pattern=" + kiwix::urlEncode(pattern, true);
     return HTTP404Response(*this, request)
            + urlNotFoundMsg
-           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern))
-           + TaskbarInfo(bookName, archive.get());
+           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern));
   }
 }
 
 
 std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& request)
 {
-  if (m_verbose.load()) {
+  if (m_verbose) {
     printf("** running handle_raw\n");
   }
 
@@ -1049,16 +1101,16 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
   try {
     if (kind == "meta") {
       auto item = archive->getMetadataItem(itemPath);
-      return ItemResponse::build(*this, request, item, /*raw=*/true);
+      return ItemResponse::build(*this, request, item);
     } else {
       auto entry = archive->getEntryByPath(itemPath);
       if (entry.isRedirect()) {
         return build_redirect(bookName, entry.getItem(true));
       }
-      return ItemResponse::build(*this, request, entry.getItem(), /*raw=*/true);
+      return ItemResponse::build(*this, request, entry.getItem());
     }
   } catch (zim::EntryNotFound& e ) {
-    if (m_verbose.load()) {
+    if (m_verbose) {
       printf("Failed to find %s\n", itemPath.c_str());
     }
     return HTTP404Response(*this, request)
@@ -1067,4 +1119,32 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
   }
 }
 
+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) {
+    printf("** running handle_locally_customized_resource\n");
+  }
+
+  const CustomizedResourceData& crd = m_customizedResources->at(request.get_url());
+
+  if (m_verbose) {
+    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);
+}
+
 }

src/server/internalServer.h

@@ -26,7 +26,7 @@ extern "C" {
 }
 
 #include "library.h"
-#include "name_mapper.h"
+#include "server.h"
 
 #include <zim/search.h>
 #include <zim/suggestion.h>
@@ -88,28 +88,12 @@ class SearchInfo {
 
 
 typedef kainjow::mustache::data MustacheData;
-typedef ConcurrentCache<SearchInfo, std::shared_ptr<zim::Search>> SearchCache;
-typedef ConcurrentCache<string, std::shared_ptr<zim::SuggestionSearcher>> SuggestionSearcherCache;
-
-class Entry;
 class OPDSDumper;
 
-class InternalServer {
+class InternalServer : Server::Configuration {
   public:
-    InternalServer(Library* library,
-                   NameMapper* nameMapper,
-                   std::string addr,
-                   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;
+    InternalServer(const Server::Configuration& configuration);
+    virtual ~InternalServer();
 
     MHD_Result handlerCallback(struct MHD_Connection* connection,
                                const char* url,
@@ -120,6 +104,7 @@ class InternalServer {
                                void** cont_cls);
     bool start();
     void stop();
+    bool isRunning() const;
     std::string getAddress() { return m_addr; }
     int getPort() { return m_port; }
 
@@ -127,6 +112,7 @@ class InternalServer {
     std::unique_ptr<Response> handle_request(const RequestContext& request);
     std::unique_ptr<Response> build_redirect(const std::string& bookName, const zim::Item& item) const;
     std::unique_ptr<Response> build_homepage(const RequestContext& request);
+    std::unique_ptr<Response> handle_viewer_settings(const RequestContext& request);
     std::unique_ptr<Response> handle_skin(const RequestContext& request);
     std::unique_ptr<Response> handle_catalog(const RequestContext& request);
     std::unique_ptr<Response> handle_catalog_v2(const RequestContext& request);
@@ -139,9 +125,11 @@ 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::vector<std::string> search_catalog(const RequestContext& request,
                                             kiwix::OPDSDumper& opdsDumper);
@@ -153,32 +141,30 @@ class InternalServer {
     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: // types
+    class LockableSuggestionSearcher;
+    typedef ConcurrentCache<SearchInfo, std::shared_ptr<zim::Search>> SearchCache;
+    typedef ConcurrentCache<std::string, std::shared_ptr<LockableSuggestionSearcher>> SuggestionSearcherCache;
+
   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;
-    bool m_blockExternalLinks;
     std::string m_indexTemplateString;
-    int m_ipConnectionLimit;
     struct MHD_Daemon* mp_daemon;
 
-    Library* mp_library;
-    NameMapper* mp_nameMapper;
-
     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);
+    friend std::unique_ptr<ContentResponse> ContentResponse::build(const InternalServer& server, const std::string& content, const std::string& mimetype);
+    friend std::unique_ptr<Response> ItemResponse::build(const InternalServer& server, const RequestContext& request, const zim::Item& item);
 };
 
 }

src/server/internalServer_catalog_v2.cpp

@@ -24,7 +24,7 @@
 #include "request_context.h"
 #include "response.h"
 #include "tools/otherTools.h"
-#include "kiwixlib-resources.h"
+#include "libkiwix-resources.h"
 
 #include <mustache.hpp>
 
@@ -35,7 +35,7 @@ namespace kiwix {
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext& request)
 {
-  if (m_verbose.load()) {
+  if (m_verbose) {
     printf("** running handle_catalog_v2");
   }
 
@@ -95,8 +95,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_root(const RequestCo
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_entries(const RequestContext& request, bool partial)
 {
-  OPDSDumper opdsDumper(mp_library);
-  opdsDumper.setRootLocation(m_root);
+  OPDSDumper opdsDumper(*this);
   opdsDumper.setLibraryId(m_library_id);
   const auto bookIds = search_catalog(request, opdsDumper);
   const auto opdsFeed = opdsDumper.dumpOPDSFeedV2(bookIds, request.get_query(), partial);
@@ -116,8 +115,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_complete_entry(const
            + urlNotFoundMsg;
   }
 
-  OPDSDumper opdsDumper(mp_library);
-  opdsDumper.setRootLocation(m_root);
+  OPDSDumper opdsDumper(*this);
   opdsDumper.setLibraryId(m_library_id);
   const auto opdsFeed = opdsDumper.dumpOPDSCompleteEntry(entryId);
   return ContentResponse::build(
@@ -129,8 +127,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_complete_entry(const
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_categories(const RequestContext& request)
 {
-  OPDSDumper opdsDumper(mp_library);
-  opdsDumper.setRootLocation(m_root);
+  OPDSDumper opdsDumper(*this);
   opdsDumper.setLibraryId(m_library_id);
   return ContentResponse::build(
              *this,
@@ -141,8 +138,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_categories(const Req
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_languages(const RequestContext& request)
 {
-  OPDSDumper opdsDumper(mp_library);
-  opdsDumper.setRootLocation(m_root);
+  OPDSDumper opdsDumper(*this);
   opdsDumper.setLibraryId(m_library_id);
   return ContentResponse::build(
              *this,
@@ -154,12 +150,15 @@ 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);
+    return ContentResponse::build(
+               *this,
+               illustration->getData(),
+               illustration->mimeType
+    );
   } catch(...) {
     return HTTP404Response(*this, request)
            + urlNotFoundMsg;

src/server/response.cpp

@@ -20,7 +20,7 @@
 #include "response.h"
 #include "request_context.h"
 #include "internalServer.h"
-#include "kiwixlib-resources.h"
+#include "libkiwix-resources.h"
 
 #include "tools/regexTools.h"
 #include "tools/stringTools.h"
@@ -53,18 +53,18 @@ 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) {
@@ -114,7 +114,7 @@ Response::Response(bool verbose)
 
 std::unique_ptr<Response> Response::build(const InternalServer& server)
 {
-  return std::unique_ptr<Response>(new Response(server.m_verbose.load()));
+  return std::unique_ptr<Response>(new Response(server.m_verbose));
 }
 
 std::unique_ptr<Response> Response::build_304(const InternalServer& server, const ETag& etag)
@@ -140,9 +140,6 @@ std::unique_ptr<ContentResponse> ContentResponseBlueprint::generateResponseObjec
 {
   auto r = ContentResponse::build(m_server, m_template, m_data, m_mimeType);
   r->set_code(m_httpStatusCode);
-  if ( m_taskbarInfo ) {
-    r->set_taskbar(m_taskbarInfo->bookName, m_taskbarInfo->archive);
-  }
   return r;
 }
 
@@ -236,29 +233,12 @@ HTTP500Response::HTTP500Response(const InternalServer& server,
 
 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)
-  // ";raw=true" in the MIME-type below disables response decoration
-  // (see ContentResponse::contentDecorationAllowed())
-  const std::string mimeType = "text/html;charset=utf-8;raw=true";
+  const std::string mimeType = "text/html;charset=utf-8";
   auto r = ContentResponse::build(m_server, m_template, m_data, mimeType);
   r->set_code(m_httpStatusCode);
   return r;
 }
 
-ContentResponseBlueprint& ContentResponseBlueprint::operator+(const TaskbarInfo& taskbarInfo)
-{
-  this->m_taskbarInfo.reset(new TaskbarInfo(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);
@@ -307,7 +287,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);
 
@@ -337,52 +317,6 @@ void print_response_info(int retCode, MHD_Response* response)
 }
 
 
-void ContentResponse::introduce_taskbar(const std::string& lang)
-{
-  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,
-    "</head[ \\t]*>",
-    head_content);
-
-  auto taskbar_part = render_template(RESOURCE::templates::taskbar_part_html, data);
-  m_content = appendToFirstOccurence(
-    m_content,
-    "<body[^>]*>",
-    taskbar_part);
-}
-
-
-void ContentResponse::inject_externallinks_blocker()
-{
-  kainjow::mustache::data data;
-  data.set("root", m_root);
-  auto script_tag = render_template(RESOURCE::templates::external_blocker_part_html, data);
-  m_content = prependToFirstOccurence(
-    m_content,
-    "</head[ \\t]*>",
-    script_tag);
-}
-
-void ContentResponse::inject_root_link(){
-  m_content = prependToFirstOccurence(
-    m_content,
-    "</head[ \\t]*>",
-    "<link type=\"root\" href=\"" + m_root + "\">");
-}
-
 bool
 ContentResponse::can_compress(const RequestContext& request) const
 {
@@ -391,16 +325,6 @@ ContentResponse::can_compress(const RequestContext& request) const
       && (m_content.size() > KIWIX_MIN_CONTENT_SIZE_TO_COMPRESS);
 }
 
-bool
-ContentResponse::contentDecorationAllowed() const
-{
-  if (m_raw) {
-    return false;
-  }
-  return (startsWith(m_mimeType, "text/html")
-    && m_mimeType.find(";raw=true") == std::string::npos);
-}
-
 MHD_Response*
 Response::create_mhd_response(const RequestContext& request)
 {
@@ -411,17 +335,6 @@ Response::create_mhd_response(const RequestContext& request)
 MHD_Response*
 ContentResponse::create_mhd_response(const RequestContext& request)
 {
-  if (contentDecorationAllowed()) {
-    inject_root_link();
-
-    if (m_withTaskbar) {
-      introduce_taskbar(request.get_user_language());
-    }
-    if (m_blockExternalLinks) {
-      inject_externallinks_blocker();
-    }
-  }
-
   const bool isCompressed = can_compress(request) && compress(m_content);
 
   MHD_Response* response = MHD_create_response_from_buffer(
@@ -461,24 +374,11 @@ MHD_Result Response::send(const RequestContext& request, MHD_Connection* connect
   return ret;
 }
 
-void ContentResponse::set_taskbar(const std::string& bookName, const zim::Archive* archive)
-{
-  m_bookName = bookName;
-  m_bookTitle = archive ? getArchiveTitle(*archive) : "";
-}
-
-
-ContentResponse::ContentResponse(const std::string& root, bool verbose, bool raw, bool withTaskbar, bool withLibraryButton, bool blockExternalLinks, const std::string& content, const std::string& mimetype) :
+ContentResponse::ContentResponse(const std::string& root, bool verbose, const std::string& content, const std::string& mimetype) :
   Response(verbose),
   m_root(root),
   m_content(content),
-  m_mimeType(mimetype),
-  m_raw(raw),
-  m_withTaskbar(withTaskbar),
-  m_withLibraryButton(withLibraryButton),
-  m_blockExternalLinks(blockExternalLinks),
-  m_bookName(""),
-  m_bookTitle("")
+  m_mimeType(mimetype)
 {
   add_header(MHD_HTTP_HEADER_CONTENT_TYPE, m_mimeType);
 }
@@ -486,17 +386,11 @@ ContentResponse::ContentResponse(const std::string& root, bool verbose, bool raw
 std::unique_ptr<ContentResponse> ContentResponse::build(
   const InternalServer& server,
   const std::string& content,
-  const std::string& mimetype,
-  bool isHomePage,
-  bool raw)
+  const std::string& mimetype)
 {
    return std::unique_ptr<ContentResponse>(new ContentResponse(
         server.m_root,
-        server.m_verbose.load(),
-        raw,
-        server.m_withTaskbar && !isHomePage,
-        server.m_withLibraryButton,
-        server.m_blockExternalLinks,
+        server.m_verbose,
         content,
         mimetype));
 }
@@ -505,11 +399,10 @@ std::unique_ptr<ContentResponse> ContentResponse::build(
   const InternalServer& server,
   const std::string& template_str,
   kainjow::mustache::data data,
-  const std::string& mimetype,
-  bool isHomePage)
+  const std::string& mimetype)
 {
   auto content = render_template(template_str, data);
-  return ContentResponse::build(server, content, mimetype, isHomePage);
+  return ContentResponse::build(server, content, mimetype);
 }
 
 ItemResponse::ItemResponse(bool verbose, const zim::Item& item, const std::string& mimetype, const ByteRange& byterange) :
@@ -522,14 +415,14 @@ ItemResponse::ItemResponse(bool verbose, const zim::Item& item, const std::strin
   add_header(MHD_HTTP_HEADER_CONTENT_TYPE, m_mimeType);
 }
 
-std::unique_ptr<Response> ItemResponse::build(const InternalServer& server, const RequestContext& request, const zim::Item& item, bool raw)
+std::unique_ptr<Response> ItemResponse::build(const InternalServer& server, const RequestContext& request, const zim::Item& item)
 {
   const std::string mimetype = get_mime_type(item);
   auto byteRange = request.get_range().resolve(item.getSize());
   const bool noRange = byteRange.kind() == ByteRange::RESOLVED_FULL_CONTENT;
   if (noRange && is_compressible_mime_type(mimetype)) {
     // Return a contentResponse
-    auto response = ContentResponse::build(server, item.getData(), mimetype, /*isHomePage=*/false, raw);
+    auto response = ContentResponse::build(server, item.getData(), mimetype);
     response->set_cacheable();
     response->m_byteRange = byteRange;
     return std::move(response);
@@ -542,7 +435,7 @@ std::unique_ptr<Response> ItemResponse::build(const InternalServer& server, cons
   }
 
   return std::unique_ptr<Response>(new ItemResponse(
-        server.m_verbose.load(),
+        server.m_verbose,
         item,
         mimetype,
         byteRange));

src/server/response.h

@@ -26,10 +26,11 @@
 
 #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"
 }
@@ -82,60 +83,32 @@ class ContentResponse : public Response {
     ContentResponse(
       const std::string& root,
       bool verbose,
-      bool raw,
-      bool withTaskbar,
-      bool withLibraryButton,
-      bool blockExternalLinks,
       const std::string& content,
       const std::string& mimetype);
+
     static std::unique_ptr<ContentResponse> build(
       const InternalServer& server,
       const std::string& content,
-      const std::string& mimetype,
-      bool isHomePage = false,
-      bool raw = false);
+      const std::string& mimetype);
+
     static std::unique_ptr<ContentResponse> build(
       const InternalServer& server,
       const std::string& template_str,
       kainjow::mustache::data data,
-      const std::string& mimetype,
-      bool isHomePage = false);
-
-    void set_taskbar(const std::string& bookName, const zim::Archive* archive);
+      const std::string& mimetype);
 
   private:
     MHD_Response* create_mhd_response(const RequestContext& request);
 
-    void introduce_taskbar(const std::string& lang);
-    void inject_externallinks_blocker();
-    void inject_root_link();
     bool can_compress(const RequestContext& request) const;
-    bool contentDecorationAllowed() const;
 
 
   private:
     std::string m_root;
     std::string m_content;
     std::string m_mimeType;
-    bool m_raw;
-    bool m_withTaskbar;
-    bool m_withLibraryButton;
-    bool m_blockExternalLinks;
-    std::string m_bookName;
-    std::string m_bookTitle;
  };
 
-struct TaskbarInfo
-{
-  const std::string bookName;
-  const zim::Archive* const archive;
-
-  TaskbarInfo(const std::string& bookName, const zim::Archive* a = nullptr)
-    : bookName(bookName)
-    , archive(a)
-  {}
-};
-
 class ContentResponseBlueprint
 {
 public: // functions
@@ -164,9 +137,6 @@ 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;
@@ -178,7 +148,6 @@ public: //data
   const std::string m_mimeType;
   const std::string m_template;
   kainjow::mustache::data m_data;
-  std::unique_ptr<TaskbarInfo> m_taskbarInfo;
 };
 
 struct HTTPErrorResponse : ContentResponseBlueprint
@@ -190,8 +159,6 @@ struct HTTPErrorResponse : ContentResponseBlueprint
                     const std::string& headingMsgId,
                     const std::string& cssUrl = "");
 
-  using ContentResponseBlueprint::operator+;
-  using ContentResponseBlueprint::operator+=;
   HTTPErrorResponse& operator+(const std::string& msg);
   HTTPErrorResponse& operator+(const ParameterizedMessage& errorDetails);
   HTTPErrorResponse& operator+=(const ParameterizedMessage& errorDetails);
@@ -237,7 +204,7 @@ private: // overrides
 class ItemResponse : public Response {
   public:
     ItemResponse(bool verbose, const zim::Item& item, const std::string& mimetype, const ByteRange& byterange);
-    static std::unique_ptr<Response> build(const InternalServer& server, const RequestContext& request, const zim::Item& item, bool raw = false);
+    static std::unique_ptr<Response> build(const InternalServer& server, const RequestContext& request, const zim::Item& item);
 
   private:
     MHD_Response* create_mhd_response(const RequestContext& request);

src/tools/otherTools.cpp

@@ -370,6 +370,16 @@ std::string kiwix::gen_uuid(const std::string& s)
   return kiwix::to_string(zim::Uuid::generate(s));
 }
 
+std::string kiwix::normalizeRootUrl(std::string rootUrl)
+{
+  while ( !rootUrl.empty() && rootUrl.back() == '/' )
+    rootUrl.pop_back();
+
+  while ( !rootUrl.empty() && rootUrl.front() == '/' )
+    rootUrl = rootUrl.substr(1);
+  return rootUrl.empty() ? rootUrl : "/" + rootUrl;
+}
+
 kainjow::mustache::data kiwix::onlyAsNonEmptyMustacheValue(const std::string& s)
 {
   return s.empty()

src/tools/otherTools.h

@@ -51,6 +51,8 @@ namespace kiwix
   std::string gen_date_str();
   std::string gen_uuid(const std::string& s);
 
+  std::string normalizeRootUrl(std::string rootUrl);
+
   // if s is empty then returns kainjow::mustache::data(false)
   // otherwise kainjow::mustache::data(value)
   kainjow::mustache::data onlyAsNonEmptyMustacheValue(const std::string& s);

src/tools/regexTools.cpp

@@ -75,41 +75,3 @@ std::string replaceRegex(const std::string& content,
   uresult.toUTF8String(tmp);
   return tmp;
 }
-
-std::string appendToFirstOccurence(const std::string& content,
-                                   const std::string& regex,
-                                   const std::string& replacement)
-{
-  ucnv_setDefaultName("UTF-8");
-  icu::UnicodeString ucontent(content.c_str());
-  icu::UnicodeString ureplacement(replacement.c_str());
-  auto matcher = buildMatcher(regex, ucontent);
-  if (matcher->find()) {
-    UErrorCode status = U_ZERO_ERROR;
-    ucontent.insert(matcher->end(status), ureplacement);
-    std::string tmp;
-    ucontent.toUTF8String(tmp);
-    return tmp;
-  }
-
-  return content;
-}
-
-std::string prependToFirstOccurence(const std::string& content,
-                                   const std::string& regex,
-                                   const std::string& replacement)
-{
-  ucnv_setDefaultName("UTF-8");
-  icu::UnicodeString ucontent(content.c_str());
-  icu::UnicodeString ureplacement(replacement.c_str());
-  auto matcher = buildMatcher(regex, ucontent);
-  if (matcher->find()) {
-    UErrorCode status = U_ZERO_ERROR;
-    ucontent.insert(matcher->start(status), ureplacement);
-    std::string tmp;
-    ucontent.toUTF8String(tmp);
-    return tmp;
-  }
-
-  return content;
-}

src/tools/regexTools.h

@@ -26,11 +26,5 @@ bool matchRegex(const std::string& content, const std::string& regex);
 std::string replaceRegex(const std::string& content,
                          const std::string& replacement,
                          const std::string& regex);
-std::string appendToFirstOccurence(const std::string& content,
-                                   const std::string& regex,
-                                   const std::string& replacement);
-std::string prependToFirstOccurence(const std::string& content,
-                                    const std::string& regex,
-                                    const std::string& replacement);
 
 #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();

src/tools/stringTools.h

@@ -21,6 +21,7 @@
 #define KIWIX_STRINGTOOLS_H
 
 #include <unicode/unistr.h>
+#include <unicode/locid.h>
 
 #include <string>
 #include <vector>
@@ -41,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);
 

static/i18n/cs.json

@@ -0,0 +1,31 @@
+{
+	"@metadata": {
+		"authors": [
+			"Spotter"
+		]
+	},
+	"name": "Čeština",
+	"suggest-full-text-search": "obsahující '{{{SEARCH_TERMS}}}'...",
+	"no-such-book": "Žádná taková kniha: {{BOOK_NAME}}",
+	"too-many-books": "Bylo požadováno příliš mnoho knih ({{NB_BOOKS}}), kde je limit {{LIMIT}}",
+	"no-book-found": "Výběrovým kritériím nevyhovuje žádná kniha",
+	"url-not-found": "Požadovaná adresa URL \"{{url}}\" nebyla na tomto serveru nalezena.",
+	"suggest-search": "Proveďte fulltextové vyhledávání <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"random-article-failure": "Jejda! Nepodařilo se vybrat náhodný článek :(",
+	"invalid-raw-data-type": "{{DATATYPE}} není platný požadavek na nezpracovaný obsah.",
+	"no-value-for-arg": "Pro argument {{ARGUMENT}} nebyla zadána žádná hodnota",
+	"no-query": "Nebyl poskytnut žádný dotaz.",
+	"raw-entry-not-found": "Nelze najít položku {{DATATYPE}} {{ENTRY}}",
+	"400-page-title": "Neplatný požadavek",
+	"400-page-heading": "Neplatný požadavek",
+	"404-page-title": "Obsah nenalezen",
+	"404-page-heading": "Nenalezeno",
+	"500-page-title": "Interní chyba serveru",
+	"500-page-heading": "Interní chyba serveru",
+	"fulltext-search-unavailable": "Fulltextové vyhledávání není k dispozici",
+	"no-search-results": "Fulltextový vyhledávač není pro tento obsah dostupný.",
+	"library-button-text": "Přejít na uvítací stránku",
+	"home-button-text": "Přejít na hlavní stránku '{{BOOK_TITLE}}'",
+	"random-page-button-text": "Přejít na náhodně vybranou stránku",
+	"searchbox-tooltip": "Hledat '{{BOOK_TITLE}}'"
+}

static/i18n/it.json

@@ -1,15 +1,27 @@
 {
 	"@metadata": {
 		"authors": [
+			"Albano",
 			"Beta16"
 		]
 	},
 	"name": "italiano",
 	"suggest-full-text-search": "contenente '{{{SEARCH_TERMS}}}'...",
+	"no-such-book": "Nessun libro del genere: {{BOOK_NAME}}",
+	"too-many-books": "Troppi libri richiesti ({{NB_BOOKS}}) dove il limite è {{LIMIT}}",
+	"no-book-found": "Nessun libro corrisponde ai criteri di selezione",
 	"url-not-found": "L'URL richiesto \"{{url}}\" non è stato trovato in questo server.",
+	"suggest-search": "Effettua una ricerca di testo completo per <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"random-article-failure": "Ops! Impossibile selezionare un articolo casuale :(",
+	"no-value-for-arg": "Nessun valore fornito per l'argomento {{ARGUMENT}}",
 	"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}}'"
+	"500-page-title": "Errore interno del server",
+	"500-page-heading": "Errore interno del server",
+	"library-button-text": "Vai alla pagina di benvenuto",
+	"home-button-text": "Vai alla pagina principale di '{{BOOK_TITLE}}'",
+	"random-page-button-text": "Vai a una pagina selezionata casualmente",
+	"searchbox-tooltip": "Cerca '{{BOOK_TITLE}}'"
 }

static/i18n/nqo.json

@@ -0,0 +1,31 @@
+{
+	"@metadata": {
+		"authors": [
+			"Lancine.kounfantoh.fofana"
+		]
+	},
+	"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 ''{{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": "ߟߊ߬ߘߏ߲߬ߣߍ߲ {{ENTRY}} {{DATATYPE}} ߕߍ߫ ߣߊ߬ ߡߊߛߐ߬ߘߐ߲߫ ߠߊ߫",
+	"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/ru.json

@@ -3,15 +3,22 @@
 		"authors": [
 			"Fenixs-ru",
 			"Kareyac",
+			"Okras",
 			"Pacha Tchernof"
 		]
 	},
 	"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 \"{{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": "Не удаётся найти запись {{ENTRY}} типа {{DATATYPE}}",
 	"400-page-title": "Недействительный запрос",
 	"400-page-heading": "Недействительный запрос",
 	"404-page-title": "Содержание не найдено",

static/i18n/sc.json

@@ -7,10 +7,14 @@
 	"name": "Sardu",
 	"suggest-full-text-search": "chi cuntenet '{{{SEARCH_TERMS}}}'...",
 	"no-such-book": "Perunu libru cun custu nùmene: {{BOOK_NAME}}",
+	"too-many-books": "Tropu libros pedidos, {{NB_BOOKS}} cando su lìmite est de {{LIMIT}}",
+	"no-book-found": "Perunu libru currispondet a sos critèrios de seletzione",
 	"url-not-found": "S'URL pedidu \"{{url}}\" non s'est atzapadu in custu serbidore.",
 	"suggest-search": "Faghe una chirca de testu intreu pro <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
 	"random-article-failure": "Oops! Sa seletzione de un'artìculu a casu est fallida :(",
 	"invalid-raw-data-type": "{{DATATYPE}} no est una rechesta vàlida pro cuntenutu puru.",
+	"no-value-for-arg": "Perunu valore frunidu pro s'argumentu {{ARGUMENT}}",
+	"no-query": "Peruna chirca frunida.",
 	"raw-entry-not-found": "Non faghet a atzapare s'elementu {{ENTRY}} de genia {{DATATYPE}}",
 	"400-page-title": "Rechesta non vàlida",
 	"400-page-heading": "Rechesta non vàlida",

static/i18n/sk.json

@@ -7,10 +7,14 @@
 	"name": "slovenčina",
 	"suggest-full-text-search": "obsahuje '{{{SEARCH_TERMS}}}'...",
 	"no-such-book": "Žiadna kniha ako: {{BOOK_NAME}}",
+	"too-many-books": "Príliš veľa požadovaných kníh ({{NB_BOOKS}}), limit je {{LIMIT}}",
+	"no-book-found": "Kritériám výberu nevyhovuje žiadna kniha",
 	"url-not-found": "Požadovaná adresa URL \"{{url}}\" na tomto serveri nebola nájdená.",
 	"suggest-search": "Spustite hľadanie celého textu <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
 	"random-article-failure": "Nepodarilo sa vybrať náhodný článok :(",
 	"invalid-raw-data-type": "{{DATATYPE}} nie je platná požiadavka pre surový obsah.",
+	"no-value-for-arg": "Pre argument {{ARGUMENT}} nebola poskytnutá žiadna hodnota",
+	"no-query": "Nebol poskytnutý žiadny dopyt.",
 	"raw-entry-not-found": "Nepodarilo sa nájsť {{DATATYPE}} položka {{ENTRY}}",
 	"400-page-title": "Neplatná požiadavka",
 	"400-page-heading": "Neplatná požiadavka",

static/i18n/sv.json

@@ -1,11 +1,14 @@
 {
 	"@metadata": {
 		"authors": [
-			"Sabelöga"
+			"Sabelöga",
+			"WikiPhoenix"
 		]
 	},
+	"name": "Svenska",
 	"suggest-full-text-search": "innehåller '{{{SEARCH_TERMS}}}'...",
 	"no-such-book": "Ingen sådan bok: {{BOOK_NAME}}",
+	"too-many-books": "För många böcker begärda ({{NB_BOOKS}}) där gränsen är {{LIMIT}}",
 	"url-not-found": "Den begärda webbadressen \"{{url}}\" hittades inte på denna server.",
 	"suggest-search": "Utför en fulltextsökning för <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
 	"random-article-failure": "Hoppsan! Kunde inte välja en slumpartikel :(",

static/i18n/tr.json

@@ -7,10 +7,14 @@
 	"name": "Türkçe",
 	"suggest-full-text-search": "'{{{SEARCH_TERMS}}}' içeriyor...",
 	"no-such-book": "Böyle bir kitap yok: {{BOOK_NAME}}",
+	"too-many-books": "Sınır {{LIMIT}} olduğunda çok fazla ({{NB_BOOKS}}) kitap istendi",
+	"no-book-found": "Seçim kriterleriyle eşleşen kitap yok",
 	"url-not-found": "İstenen \"{{url}}\" URL'si bu sunucuda bulunamadı.",
 	"suggest-search": "<a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a> için tam metin araması yapın",
 	"random-article-failure": "Hata! Rastgele bir madde seçilemedi :(",
 	"invalid-raw-data-type": "{{DATATYPE}}, ham içerik için geçerli bir istek değil.",
+	"no-value-for-arg": "{{ARGUMENT}} bağımsız değişkeni için değer sağlanmadı",
+	"no-query": "Sorgu sağlanmadı.",
 	"raw-entry-not-found": "{{DATATYPE}} {{ENTRY}} girişi bulunamadı",
 	"400-page-title": "Geçersiz istek",
 	"400-page-heading": "Geçersiz istek",

static/i18n/zh-hans.json

@@ -0,0 +1,16 @@
+{
+	"@metadata": {
+		"authors": [
+			"GuoPC",
+			"StarrySky"
+		]
+	},
+	"name": "英语",
+	"no-query": "未提供查询。",
+	"400-page-title": "无效请求",
+	"400-page-heading": "无效请求",
+	"404-page-heading": "未找到",
+	"500-page-title": "内部服务器错误",
+	"500-page-heading": "内部服务器错误",
+	"library-button-text": "前往欢迎页面"
+}

static/i18n/zh-hant.json

@@ -1,15 +1,32 @@
 {
 	"@metadata": {
 		"authors": [
+			"Kly",
 			"Winston Sung"
 		]
 	},
 	"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「{{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_resources_list.txt

@@ -1,4 +1,5 @@
 i18n/bn.json
+i18n/cs.json
 i18n/en.json
 i18n/fr.json
 i18n/he.json
@@ -8,10 +9,12 @@ i18n/ja.json
 i18n/ko.json
 i18n/ku-latn.json
 i18n/mk.json
+i18n/nqo.json
 i18n/pl.json
 i18n/ru.json
 i18n/sc.json
 i18n/sk.json
 i18n/sv.json
 i18n/tr.json
+i18n/zh-hans.json
 i18n/zh-hant.json

static/meson.build

@@ -15,7 +15,7 @@ preprocessed_resources = custom_target('preprocessed_resource_files',
 
 lib_resources = custom_target('resources',
     input: preprocessed_resources,
-    output: ['kiwixlib-resources.cpp', 'kiwixlib-resources.h'],
+    output: ['libkiwix-resources.cpp', 'libkiwix-resources.h'],
     command:[res_compiler,
              '--cxxfile', '@OUTPUT0@',
              '--hfile', '@OUTPUT1@',

static/resources_list.txt

@@ -1,55 +1,53 @@
-skin/jquery-ui/jquery-ui.structure.min.css
-skin/jquery-ui/jquery-ui.min.js
-skin/jquery-ui/external/jquery/jquery.js
-skin/jquery-ui/images/ui-bg_flat_0_aaaaaa_40x100.png
-skin/jquery-ui/images/ui-bg_flat_75_ffffff_40x100.png
-skin/jquery-ui/images/ui-icons_222222_256x240.png
-skin/jquery-ui/images/ui-bg_glass_55_fbf9ee_1x400.png
-skin/jquery-ui/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-skin/jquery-ui/images/ui-bg_glass_65_ffffff_1x400.png
-skin/jquery-ui/images/ui-icons_2e83ff_256x240.png
-skin/jquery-ui/images/ui-icons_cd0a0a_256x240.png
-skin/jquery-ui/images/ui-icons_888888_256x240.png
-skin/jquery-ui/images/ui-bg_glass_75_e6e6e6_1x400.png
-skin/jquery-ui/images/animated-overlay.gif
-skin/jquery-ui/images/ui-bg_glass_75_dadada_1x400.png
-skin/jquery-ui/images/ui-icons_454545_256x240.png
-skin/jquery-ui/images/ui-bg_glass_95_fef1ec_1x400.png
-skin/jquery-ui/jquery-ui.theme.min.css
-skin/jquery-ui/jquery-ui.min.css
 skin/caret.png
 skin/bittorrent.png
 skin/magnet.png
 skin/download.png
 skin/hash.png
 skin/search-icon.svg
-skin/taskbar.js
 skin/iso6391To3.js
 skin/isotope.pkgd.min.js
 skin/index.js
+skin/autoComplete.min.js
 skin/taskbar.css
 skin/index.css
 skin/fonts/Poppins.ttf
 skin/fonts/Roboto.ttf
-skin/block_external.js
 skin/search_results.css
+skin/blank.html
+skin/viewer.js
+viewer.html
 templates/search_result.html
 templates/search_result.xml
 templates/error.html
 templates/error.xml
 templates/index.html
 templates/suggestion.json
-templates/head_taskbar.html
-templates/taskbar_part.html
-templates/external_blocker_part.html
 templates/captured_external.html
 templates/catalog_entries.xml
 templates/catalog_v2_root.xml
 templates/catalog_v2_entries.xml
 templates/catalog_v2_entry.xml
+templates/catalog_v2_partial_entry.xml
 templates/catalog_v2_categories.xml
 templates/catalog_v2_languages.xml
 templates/url_of_search_results_css
+templates/viewer_settings.js
 opensearchdescription.xml
 ft_opensearchdescription.xml
 catalog_v2_searchdescription.xml
+skin/css/autoComplete.css
+skin/css/images/search.svg
+skin/favicon/android-chrome-192x192.png
+skin/favicon/android-chrome-512x512.png
+skin/favicon/apple-touch-icon.png
+skin/favicon/browserconfig.xml
+skin/favicon/favicon-16x16.png
+skin/favicon/favicon-32x32.png
+skin/favicon/favicon.ico
+skin/favicon/mstile-70x70.png
+skin/favicon/mstile-144x144.png
+skin/favicon/mstile-150x150.png
+skin/favicon/mstile-310x150.png
+skin/favicon/mstile-310x310.png
+skin/favicon/safari-pinned-tab.svg
+skin/favicon/site.webmanifest

static/skin/blank.html

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

static/skin/block_external.js

@@ -1,74 +0,0 @@
-const root = document.querySelector( `link[type='root']` ).getAttribute("href");
-// `block_path` variable used by openzim/warc2zim to detect whether URL blocking is enabled or not
-var block_path = `${root}/catch/external`;
-// called only on external links
-function capture_event(e, target) { target.setAttribute("href", encodeURI(block_path + "?source=" + target.href)); }
-
-// called on all link clicks. filters external and call capture_event
-function on_click_event(e) {
-  var target = findParent("a", e.target);
-  if (target !== null && "href" in target) {
-    var href = target.href;
-    if (window.location.pathname.indexOf(block_path) == 0) // already in catch page
-      return;
-    if (href.indexOf(window.location.origin) == 0)
-      return;
-    if (href.substr(0, 2) == "//")
-      return capture_event(e, target);
-    if (href.substr(0, 5) == "http:")
-      return capture_event(e, target);
-    if (href.substr(0, 6) == "https:")
-      return capture_event(e, target);
-    return;
-  }
-}
-
-// script entrypoint (called on document ready)
-function run() { live('a', 'click', on_click_event); }
-
-// find first parent with tagname
-function findParent(tagname, el) {
-  while (el) {
-    if ((el.nodeName || el.tagName).toLowerCase() === tagname.toLowerCase()) {
-      return el;
-    }
-    el = el.parentNode;
-  }
-  return null;
-}
-
-// matches polyfill
-this.Element && function(ElementPrototype) {
-    ElementPrototype.matches = ElementPrototype.matches ||
-    ElementPrototype.matchesSelector ||
-    ElementPrototype.webkitMatchesSelector ||
-    ElementPrototype.msMatchesSelector ||
-    function(selector) {
-        var node = this, nodes = (node.parentNode || node.document).querySelectorAll(selector), i = -1;
-        while (nodes[++i] && nodes[i] != node);
-        return !!nodes[i];
-    }
-}(Element.prototype);
-
-// helper for enabling IE 8 event bindings
-function addEvent(el, type, handler) {
-    if (el.attachEvent) el.attachEvent('on'+type, handler); else el.addEventListener(type, handler);
-}
-
-// live binding helper using matchesSelector
-function live(selector, event, callback, context) {
-    addEvent(context || document, event, function(e) {
-        var found, el = e.target || e.srcElement;
-        while (el && el.matches && el !== context && !(found = el.matches(selector))) el = el.parentElement;
-        if (found) callback.call(el, e);
-    });
-}
-
-// in case the document is already rendered
-if (document.readyState!='loading') run();
-// modern browsers
-else if (document.addEventListener) document.addEventListener('DOMContentLoaded', run);
-// IE <= 8
-else document.attachEvent('onreadystatechange', function(){
-    if (document.readyState=='complete') run();
-});

static/skin/css/autoComplete.css

@@ -0,0 +1,91 @@
+.autoComplete_wrapper {
+  display: inline-block;
+  position: relative;
+}
+
+.autoComplete_wrapper > input {
+  width: 370px;
+  height: 40px;
+  padding-left: 20px;
+  font-size: 1rem;
+  color: rgba(123, 123, 123, 1);
+  border-radius: 8px;
+  border: 0;
+  outline: none;
+  background-color: #f1f3f4;
+}
+
+.autoComplete_wrapper > input::placeholder {
+  color: rgba(123, 123, 123, 0.5);
+  transition: all 0.3s ease;
+}
+
+.autoComplete_wrapper > ul {
+  position: absolute;
+  max-height: 226px;
+  overflow-y: scroll;
+  top: 100%;
+  left: 0;
+  right: 0;
+  padding: 0;
+  margin: 0.5rem 0 0;
+  border-radius: 0.6rem;
+  background-color: #fff;
+  box-shadow: 0 3px 6px rgba(149, 157, 165, 0.15);
+  border: 1px solid rgba(33, 33, 33, 0.07);
+  z-index: 1000;
+  outline: none;
+}
+
+.autoComplete_wrapper > ul[hidden],
+.autoComplete_wrapper > ul:empty {
+  display: block;
+  opacity: 0;
+  transform: scale(0);
+}
+
+.autoComplete_wrapper > ul > li {
+  margin: 0.3rem;
+  padding: 0.3rem 0.5rem;
+  list-style: none;
+  text-align: left;
+  font-size: 1rem;
+  color: #212121;
+  border-radius: 0.35rem;
+  background-color: rgba(255, 255, 255, 1);
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  transition: all 0.2s ease;
+}
+
+.autoComplete_wrapper > ul > li::selection {
+  color: rgba(#ffffff, 0);
+  background-color: rgba(#ffffff, 0);
+}
+
+.autoComplete_wrapper > ul > li:hover {
+  cursor: pointer;
+  background-color: rgba(123, 123, 123, 0.1);
+}
+
+.autoComplete_wrapper > ul > li mark {
+  background-color: transparent;
+  color: rgba(255, 122, 122, 1);
+  font-weight: bold;
+}
+
+.autoComplete_wrapper > ul > li mark::selection {
+  color: rgba(#ffffff, 0);
+  background-color: rgba(#ffffff, 0);
+}
+
+.autoComplete_wrapper > ul > li[aria-selected="true"] {
+  background-color: rgba(123, 123, 123, 0.1);
+}
+
+@media only screen and (max-width: 600px) {
+  .autoComplete_wrapper > input {
+    width: 18rem;
+  }
+}

static/skin/css/images/search.svg

@@ -0,0 +1,8 @@
+<svg xmlns="http://www.w3.org/2000/svg" focusable="false" x="0px" y="0px" width="30" height="30" viewBox="0 0 171 171" style=" fill:#000000;">
+    <g fill="none" fill-rule="nonzero" stroke="none" stroke-width="1" stroke-linecap="butt" stroke-linejoin="miter" stroke-miterlimit="10" stroke-dasharray="" stroke-dashoffset="0" font-family="none" font-weight="none" font-size="none" text-anchor="none" style="mix-blend-mode: normal">
+        <path d="M0,171.99609v-171.99609h171.99609v171.99609z" fill="none"></path>
+        <g fill="#ff7a7a">
+            <path d="M74.1,17.1c-31.41272,0 -57,25.58728 -57,57c0,31.41272 25.58728,57 57,57c13.6601,0 26.20509,-4.85078 36.03692,-12.90293l34.03301,34.03301c1.42965,1.48907 3.55262,2.08891 5.55014,1.56818c1.99752,-0.52073 3.55746,-2.08067 4.07819,-4.07819c0.52073,-1.99752 -0.0791,-4.12049 -1.56818,-5.55014l-34.03301,-34.03301c8.05215,-9.83182 12.90293,-22.37682 12.90293,-36.03692c0,-31.41272 -25.58728,-57 -57,-57zM74.1,28.5c25.2517,0 45.6,20.3483 45.6,45.6c0,25.2517 -20.3483,45.6 -45.6,45.6c-25.2517,0 -45.6,-20.3483 -45.6,-45.6c0,-25.2517 20.3483,-45.6 45.6,-45.6z"></path>
+        </g>
+    </g>
+</svg>

static/skin/favicon/browserconfig.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square70x70logo src="skin/favicon/mstile-70x70.png"/>
+            <square144x144logo src="skin/favicon/mstile-144x144.png"/>
+            <square150x150logo src="skin/favicon/mstile-150x150.png"/>
+            <square310x150logo src="skin/favicon/mstile-310x150.png"/>
+            <square310x310logo src="skin/favicon/mstile-310x310.png"/>
+            <TileColor>#da532c</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

static/skin/favicon/safari-pinned-tab.svg

@@ -0,0 +1,47 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="700.000000pt" height="700.000000pt" viewBox="0 0 700.000000 700.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.14, written by Peter Selinger 2001-2017
+</metadata>
+<g transform="translate(0.000000,700.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M2130 5897 c-3 -3 -38 -7 -78 -11 -41 -3 -77 -8 -80 -10 -4 -2 -27
+-7 -52 -10 -25 -3 -73 -13 -105 -22 -33 -8 -67 -17 -75 -19 -51 -11 -211 -75
+-305 -120 -93 -45 -289 -163 -305 -184 -3 -3 -27 -24 -55 -46 -108 -86 -238
+-229 -323 -357 -48 -71 -142 -245 -142 -263 0 -4 -6 -21 -14 -38 -21 -46 -51
+-149 -72 -247 -19 -89 -26 -391 -11 -475 3 -22 9 -56 12 -75 46 -278 218 -619
+460 -909 97 -117 141 -182 172 -256 19 -45 85 -251 118 -365 7 -25 35 -119 63
+-210 144 -469 182 -592 184 -607 3 -14 -10 -16 -77 -18 -93 -2 -140 -20 -185
+-71 -28 -33 -57 -110 -46 -122 4 -3 109 -6 234 -7 l227 -1 105 -51 c154 -74
+310 -148 440 -209 63 -30 133 -63 155 -74 25 -12 43 -16 49 -10 6 6 10 39 10
+74 1 56 -3 70 -29 108 -25 36 -49 52 -142 98 -61 30 -114 57 -116 60 -3 3 120
+5 273 5 l278 0 -3 25 c-9 69 -45 119 -110 153 -38 19 -58 20 -345 22 -272 1
+-309 3 -343 19 -48 24 -102 86 -115 134 -5 20 -42 143 -82 272 -40 129 -88
+287 -107 350 -19 63 -46 153 -60 200 -48 157 -30 273 54 357 65 65 153 95 237
+79 45 -9 96 -60 130 -132 20 -41 286 -885 286 -905 0 -2 -37 -5 -83 -5 -130
+-2 -196 -47 -227 -155 -7 -23 -5 -31 8 -37 9 -5 112 -8 227 -7 l210 1 110 -52
+c61 -28 167 -79 237 -112 70 -34 147 -70 172 -82 25 -11 87 -40 138 -65 54
+-26 96 -41 101 -36 19 19 20 100 3 146 -23 59 -63 91 -178 145 -54 25 -98 47
+-98 50 0 3 88 6 196 5 l196 0 60 -80 c208 -276 501 -419 838 -410 381 10 721
+235 881 582 80 174 109 431 69 614 -102 469 -504 798 -976 797 -446 0 -828
+-283 -958 -708 -35 -114 -45 -194 -41 -325 4 -93 10 -141 37 -255 5 -22 -465
+-24 -532 -3 -69 23 -114 78 -144 176 -210 687 -376 1234 -376 1241 0 9 88 51
+155 74 107 37 218 62 350 79 117 15 593 8 705 -11 14 -2 61 -7 105 -11 44 -3
+94 -8 111 -10 160 -20 504 -27 624 -11 240 30 439 120 611 273 102 91 142 113
+207 113 75 0 142 -25 252 -94 334 -208 677 -541 882 -856 46 -71 158 -266 158
+-275 0 -2 15 -36 34 -77 18 -40 41 -95 50 -121 l18 -48 31 19 c50 29 87 90 94
+153 10 95 -33 204 -168 434 -82 140 -272 379 -429 540 -214 220 -385 364 -669
+564 -77 54 -138 100 -136 103 2 2 7 42 11 89 26 336 -200 696 -540 858 -131
+63 -205 82 -346 88 -128 5 -216 -9 -332 -53 l-68 -26 -43 38 c-23 21 -44 40
+-47 44 -22 27 -248 190 -348 252 -133 81 -408 208 -452 208 -9 0 -20 4 -26 9
+-9 9 -189 56 -254 66 -19 3 -60 10 -90 16 -54 10 -421 24 -430 16z m2316
+-1050 c97 -49 163 -150 165 -253 2 -87 -33 -199 -39 -126 -6 72 -105 152 -187
+152 -95 0 -185 -84 -190 -177 -3 -50 14 -104 43 -137 16 -18 16 -19 -13 -12
+-16 4 -51 21 -76 37 -119 76 -167 241 -107 369 27 58 48 84 100 123 81 61 211
+71 304 24z"/>
+</g>
+</svg>

static/skin/favicon/site.webmanifest

@@ -0,0 +1,19 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "android-chrome-512x512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}

static/skin/index.js

@@ -1,5 +1,5 @@
 (function() {
-    const root = $(`link[type='root']`).attr('href');
+    const root = document.querySelector(`link[type='root']`).getAttribute('href');
     const incrementalLoadingParams = {
         start: 0,
         count: viewPortToCount()
@@ -77,6 +77,13 @@
         return queryNode != null ? queryNode.innerHTML : "";
     }
 
+    function generateTagLink(tagValue) {
+        tagValue = tagValue.toLowerCase();
+        const humanFriendlyTagValue = humanFriendlyTitle(tagValue);
+        const tagMessage = `Filter by tag "${humanFriendlyTagValue}"`;
+        return `<span class='tag__link' aria-label='${tagMessage}' title='${tagMessage}' data-tag=${tagValue}>${humanFriendlyTagValue}</span>`
+    }
+
     function generateBookHtml(book, sort = false) {
         const link = book.querySelector('link[type="text/html"]').getAttribute('href');
         let iconUrl;
@@ -91,9 +98,9 @@
         const langCode = getInnerHtml(book, 'language');
         const language = languages[langCode];
         const tags = getInnerHtml(book, 'tags');
-        let tagHtml = tags.split(';').filter(tag => {return !(tag.split(':')[0].startsWith('_'))})
-            .map((tag) => {return tag.charAt(0).toUpperCase() + tag.slice(1)})
-            .join(' | ').replace(/_/g, ' ');
+        const tagList = tags.split(';').filter(tag => {return !(tag.startsWith('_'))});
+        const tagFilterLinks = tagList.map((tagValue) => generateTagLink(tagValue));
+        const tagHtml = tagFilterLinks.join(' | ');
         let downloadLink;
         let zimSize = 0;
         try {
@@ -103,6 +110,9 @@
         } catch {
             downloadLink = '';
         }
+        const bookName = link.split('/').pop();
+        const viewerLink = `${root}/viewer#${bookName}`;
+
         const humanFriendlyZimSize = humanFriendlySize(zimSize);
 
         const divTag = document.createElement('div');
@@ -113,17 +123,21 @@
         }
         const faviconAttr = iconUrl != undefined ? `style="background-image: url('${iconUrl}')"` : '';
         const languageAttr = langCode != '' ? `title="${language}" aria-label="${language}"` : 'style="background-color: transparent"';
-        divTag.innerHTML = `<a class="book__link" href="${link}" data-hover="Preview">
+        divTag.innerHTML = `
             <div class="book__wrapper">
+            <a class="book__link" href="${viewerLink}" data-hover="Preview">
+            <div class="book__link__wrapper">
             <div class="book__icon" ${faviconAttr}></div>
             <div class="book__header">
                 <div id="book__title">${title}</div>
                 ${downloadLink ? `<div class="book__download"><span data-link="${downloadLink}">Download ${humanFriendlyZimSize ? ` - ${humanFriendlyZimSize}</span></div>`: ''}` : ''}
             </div>
             <div class="book__description" title="${description}">${description}</div>
+            </div>
+            </a>
             <div class="book__languageTag" ${languageAttr}>${getLanguageCodeToDisplay(langCode)}</div>
             <div class="book__tags"><div class="book__tags--wrapper">${tagHtml}</div></div>
-            </div></div></a>`;
+            </div></div>`;
         return divTag;
     }
 
@@ -168,12 +182,12 @@
                         <div onclick="closeModal()" class="modal-close-button">
                             <div>
                                 <svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 14 14" fill="none">
-                                    <path fill-rule="evenodd" clip-rule="evenodd" d="M13.7071 1.70711C14.0976 1.31658 14.0976 
+                                    <path fill-rule="evenodd" clip-rule="evenodd" d="M13.7071 1.70711C14.0976 1.31658 14.0976
                                     0.683417 13.7071 0.292893C13.3166 -0.0976311 12.6834 -0.0976311 12.2929 0.292893L7 5.58579L1.70711
                                     0.292893C1.31658 -0.0976311 0.683417 -0.0976311 0.292893 0.292893C-0.0976311 0.683417
                                     -0.0976311 1.31658 0.292893 1.70711L5.58579 7L0.292893 12.2929C-0.0976311 12.6834
                                     -0.0976311 13.3166 0.292893 13.7071C0.683417 14.0976 1.31658 14.0976 1.70711 13.7071L7
-                                    8.41421L12.2929 13.7071C12.6834 14.0976 13.3166 14.0976 13.7071 13.7071C14.0976 13.3166 
+                                    8.41421L12.2929 13.7071C12.6834 14.0976 13.3166 14.0976 13.7071 13.7071C14.0976 13.3166
                                     14.0976 12.6834 13.7071 12.2929L8.41421 7L13.7071 1.70711Z" fill="black" />
                                 </svg>
                             </div>
@@ -192,7 +206,7 @@
                                 <div>Sha256 hash</div>
                             </a>
                         </div>
-                        ${magnetLink ? 
+                        ${magnetLink ?
                         `<div class="modal-regular-download">
                             <a href="${magnetLink}" target="_blank">
                                 <img src="../skin/magnet.png?KIWIXCACHEID" alt="download magnet" />
@@ -267,6 +281,16 @@
         });
     }
 
+    function setNoResultsContent() {
+        const kiwixHomeBody = document.querySelector('.kiwixHomeBody');
+        const divTag = document.createElement('div');
+        divTag.setAttribute('class', 'noResults');
+        divTag.innerHTML = `No result. Would you like to <a href="?lang=">reset filter</a>?`;
+        kiwixHomeBody.append(divTag);
+        kiwixHomeBody.setAttribute('style', 'display: flex; justify-content: center; align-items: center');
+        loader.setAttribute('style', 'position: absolute; top: 50%');
+    }
+
     function checkAndInjectEmptyMessage() {
         const kiwixHomeBody = document.querySelector('.kiwixHomeBody');
         if (!bookOrderMap.size) {
@@ -274,28 +298,7 @@
                 noResultInjected = true;
                 iso.remove(document.getElementsByClassName('book__list')[0].getElementsByTagName('div'));
                 iso.layout();
-                setTimeout(() => {
-                    const divTag = document.createElement('div');
-                    divTag.setAttribute('class', 'noResults');
-                    divTag.innerHTML = `No result. Would you like to <a href="/?lang=">reset filter</a>?`;
-                    kiwixHomeBody.append(divTag);
-                    kiwixHomeBody.setAttribute('style', 'display: flex; justify-content: center; align-items: center');
-                    divTag.getElementsByTagName('a')[0].onclick = (event) => {
-                        event.preventDefault();
-                        window.history.pushState({}, null, `${window.location.href.split('?')[0]}?lang=`);
-                        setCookie(filterCookieName, 'lang=');
-                        resetAndFilter();
-                        document.querySelectorAll('.filter').forEach(filter => {
-                            filter.value = params.get(filter.name) || '';
-                            if (filter.value) {
-                                filter.style = 'background-color: #858585; color: #fff';
-                            } else {
-                                filter.style = 'background-color: #ffffff; color: black';
-                            }
-                        })
-                    };
-                    loader.setAttribute('style', 'position: absolute; top: 50%');
-                }, 300);
+                setTimeout(setNoResultsContent, 300);
             }
             return true;
         } else if (noResultInjected) {
@@ -320,7 +323,7 @@
         const booksToFilter = new Set();
         const booksToDelete = new Set();
         iso.arrange({
-            filter: function (idx, elem) {
+            filter: function (elem) {
                 const id = elem.getAttribute('data-id');
                 const retVal = bookOrderMap.has(id);
                 if (retVal) {
@@ -344,6 +347,7 @@
                 insertModal(downloadButton);
             }
         });
+        refreshTagLinks();
     }
 
     async function resetAndFilter(filterType = '', filterValue = '') {
@@ -355,22 +359,16 @@
         params = new URLSearchParams(window.location.search);
         if (filterType) {
             params.set(filterType, filterValue);
-            window.history.pushState({}, null, `${window.location.href.split('?')[0]}?${params.toString()}`);
+            window.history.pushState({}, null, `?${params.toString()}`);
             setCookie(filterCookieName, params.toString());
         }
-        document.querySelectorAll('.filter').forEach(filter => {
-            if (filter.value) {
-                filter.style = 'background-color: #858585; color: #fff';
-            } else {
-                filter.style = 'background-color: #ffffff; color: black';
-            }
-        });
+        updateFilterColors();
         await loadAndDisplayBooks(true);
     }
 
     window.addEventListener('popstate', async () => {
         await resetAndFilter();
-        document.querySelectorAll('.filter').forEach(filter => {filter.value = params.get(filter.name) || ''});
+        updateVisibleParams();
     });
 
     async function loadSubset() {
@@ -384,6 +382,56 @@
         }
     }
 
+    function updateFilterColors() {
+        document.querySelectorAll('.filter').forEach(filter => {
+            if (filter.value) {
+                filter.style = 'background-color: #858585; color: #fff';
+            } else {
+                filter.style = 'background-color: #ffffff; color: black';
+            }
+        });
+    }
+
+    function addTagElement(tagValue, resetFilter) {
+        const tagElement = document.getElementsByClassName('tagFilterLabel')[0];
+        tagElement.style.display = 'inline-block';
+        const humanFriendlyTagValue = humanFriendlyTitle(tagValue);
+        tagElement.innerHTML = `${humanFriendlyTagValue}`;
+        const tagMessage = `Stop filtering by tag "${humanFriendlyTagValue}"`;
+        tagElement.setAttribute('aria-label', tagMessage);
+        tagElement.setAttribute('title', tagMessage);
+        if (resetFilter)
+            resetAndFilter('tag', tagValue);
+    }
+
+    function refreshTagLinks() {
+        const tagLinks = document.getElementsByClassName('tag__link');
+        [...tagLinks].forEach(elem => {
+            if (!elem.getAttribute('click-listener')) {
+                elem.addEventListener('click', () => addTagElement(elem.dataset.tag, true));
+                elem.setAttribute('click-listener', 'true');
+            }
+        });
+    }
+
+    function removeTagElement(resetFilter) {
+        const tagElement = document.getElementsByClassName('tagFilterLabel')[0];
+        tagElement.style.display = 'none';
+        if (resetFilter)
+            resetAndFilter('tag', '');
+    }
+
+    function updateVisibleParams() {
+        document.querySelectorAll('.filter').forEach(filter => {filter.value = params.get(filter.name) || ''});
+        updateFilterColors();
+        const tagKey = params.get('tag');
+        if (tagKey !== null && tagKey.trim() !== '') {
+            addTagElement(tagKey, false);
+        } else {
+            removeTagElement(false);
+        }
+    }
+
     window.addEventListener('resize', (event) => {
         if (timer) {clearTimeout(timer)}
         timer = setTimeout(() => {
@@ -394,6 +442,12 @@
 
     window.addEventListener('scroll', loadSubset);
 
+    window.addEventListener('keydown', function (event) {
+        if (event.key === "Escape" ) {
+            closeModal();
+        }
+    });
+
     window.onload = async () => {
         iso = new Isotope( '.book__list', {
             itemSelector: '.book',
@@ -404,10 +458,9 @@
                 }
             },
             sortBy: 'weight',
-            layoutMode: 'cellsByRow',
-            cellsByRow: {
-                columnWidth: '.book',
-                rowHeight: '.book'
+            layoutMode: 'masonry',
+            masonry: {
+                fitWidth: true
             }
         });
         footer = document.getElementById('kiwixfooter');
@@ -419,15 +472,16 @@
         document.querySelectorAll('.filter').forEach(filter => {
             filter.addEventListener('change', () => {resetAndFilter(filter.name, filter.value)});
         });
+        const tagElement = document.getElementsByClassName('tagFilterLabel')[0];
+        tagElement.addEventListener('click', () => removeTagElement(true));
         if (filters) {
-            window.history.pushState({}, null, `${window.location.href.split('?')[0]}?${params.toString()}`);
-        }
-        params.forEach((value, key) => {
-            const selectBox = document.getElementsByName(key)[0];
-            if (selectBox) {
-                selectBox.value = value
+            const currentLink = window.location.search;
+            const newLink = `?${params.toString()}`;
+            if (currentLink != newLink) {
+                window.history.pushState({}, null, newLink);
             }
-        });
+        }
+        updateVisibleParams();
         document.getElementById('kiwixSearchForm').onsubmit = (event) => {event.preventDefault()};
         if (!window.location.search) {
             const browserLang = navigator.language.split('-')[0];
@@ -438,13 +492,7 @@
                 langFilter.dispatchEvent(new Event('change'));
             }
         }
-        document.querySelectorAll('.filter').forEach(filter => {
-            if (filter.value) {
-                filter.style = 'background-color: #858585; color: #fff';
-            } else {
-                filter.style = 'background-color: #ffffff; color: black';
-            }
-        });
         setCookie(filterCookieName, params.toString());
     }
 })();
+

static/skin/taskbar.css

@@ -1,14 +1,10 @@
 #kiwixtoolbar {
-    position: fixed;
     padding: .5em;
-    left: 0;
-    right: 0;
-    top: 0;
-    z-index: 100;
-    background-position-y: 0;
     transition: 0.3s;
     width: 100%;
     box-sizing: border-box;
+    background: #e3e3e3;
+    border-bottom: 1px solid #aaa;
 }
 
 #kiwixtoolbar>a {
@@ -100,7 +96,6 @@ label[for="kiwix_button_show_toggle"],
 }
 
 .kiwix #kiwixtoolbar #kiwixsearchform input[type='text'] {
-    position: absolute;
     left: 0;
     box-sizing: border-box !important;
     width: 100%;
@@ -123,22 +118,17 @@ label[for=kiwixsearchbox] {
     vertical-align: middle;
 }
 
-body {
-    padding-top: calc(3em - 5px) !important;
+a.suggest, a.suggest:visited, a.suggest:hover, a.suggest:active {
+    display: block;
+    text-decoration: none;
+    color: inherit;
 }
 
-/* Try to fix buggy stuff in jquery-ui autocomplete */
-#ui-id-1,
-.ui-autocomplete {
-    background: white !important;
-    border: solid 1px grey !important;
+.autoComplete_wrapper > ul {
+    max-height: none !important;
     column-count: 1 !important;
 }
 
-li.ui-state-focus {
-    font-weight: bold;
-}
-
 @media(min-width:420px) {
     .kiwix_button_cont {
         display: inline-block !important;
@@ -155,6 +145,11 @@ li.ui-state-focus {
 
 @media (max-width: 645px) {
 
+    .autoComplete_wrapper > ul {
+        max-height: none !important;
+        column-count: 1 !important;
+    }
+
     #kiwix_button_show_toggle~label~.kiwix_button_cont.searching {
         display: none !important;
     }

static/skin/taskbar.js

@@ -1,97 +0,0 @@
-function htmlDecode(input) {
-    var doc = new DOMParser().parseFromString(input, "text/html");
-    return doc.documentElement.textContent;
-}
-
-const jq = jQuery.noConflict(true);
-jq(document).ready(() => {
-    (function ($) {
-        const root = $( `link[type='root']` ).attr("href");
-
-        const bookName = (window.location.pathname == `${root}/search`)
-               ? (new URLSearchParams(window.location.search)).get('content') 
-               : window.location.pathname.split(`${root}/`)[1].split('/')[0];
-    
-        const userlang = (new URLSearchParams(window.location.search)).get('userlang') || "en";
-        $( "#kiwixsearchbox" ).autocomplete({
-    
-            source: `${root}/suggest?content=${bookName}&userlang=${userlang}`,
-            dataType: "json",
-            cache: false,
-    
-            response: function( event, ui ) {
-                  for(const item of ui.content) {
-                      item.label = htmlDecode(item.label);
-                      item.value = htmlDecode(item.value);
-                      if (item.path) item.path = htmlDecode(item.path);
-                  }
-            },
-    
-            select: function(event, ui) {
-                if (ui.item.kind === 'path') {
-                    window.location.href = `${root}/${bookName}/${encodeURI(ui.item.path)}`;
-                } else {
-                    $( "#kiwixsearchbox" ).val(ui.item.value);
-                    $( "#kiwixsearchform" ).submit();
-                }
-            },
-        }).data( "ui-autocomplete" )._renderItem = function( ul, item ) {
-            return $( "<li>" )
-              .data( "ui-autocomplete-item", item )
-              .append( item.label )
-              .appendTo( ul );
-        };
-    
-        /* cybook hack */
-        if (navigator.userAgent.indexOf("bookeen/cybook") != -1) {
-            $("html").addClass("cybook");
-        }
-    
-        if ($(window).width() < 520) {
-            var didScroll;
-            var lastScrollTop = 0;
-            var delta = 5;
-            // on scroll, let the interval function know the user has scrolled
-            $(window).scroll(function (event) {
-                didScroll = true;
-            });
-            // run hasScrolled() and reset didScroll status
-            setInterval(function () {
-                if (didScroll) {
-                    hasScrolled();
-                    didScroll = false;
-                }
-            }, 250);
-            function hasScrolled() {
-                var st = $(this).scrollTop();
-    
-                // Make sure they scroll more than delta
-                if (Math.abs(lastScrollTop - st) <= delta)
-                    return;
-    
-                // If they scrolled down and are past the navbar, add class .nav-up.
-                // This is necessary so you never see what is "behind" the navbar.
-                if (st > lastScrollTop) {
-                    // Scroll Down
-                    $('#kiwixtoolbar').css({ top: '-100%' });
-                } else {
-                    // Scroll Up
-                    $('#kiwixtoolbar').css({ top: '0' });
-                }
-    
-                lastScrollTop = st;
-            }
-        }
-    
-        $('#kiwixsearchbox').on({
-            focus: function () {
-                $('.kiwix_searchform').addClass('full_width');
-                $('label[for="kiwix_button_show_toggle"], .kiwix_button_cont').addClass('searching');
-            },
-            blur: function () {
-                $('.kiwix_searchform').removeClass('full_width');
-                $('label[for="kiwix_button_show_toggle"], .kiwix_button_cont').removeClass('searching');
-            }
-        });
-    })(jq);
-})

static/skin/viewer.js

@@ -0,0 +1,402 @@
+// Terminology
+//
+// user url: identifier of the page that has to be displayed in the viewer
+//           and that is used as the hash component of the viewer URL. For
+//           book resources the address url is {book}/{resource} .
+//
+// iframe url: the URL to be loaded in the viewer iframe.
+
+function userUrl2IframeUrl(url) {
+  if ( url == '' ) {
+    return blankPageUrl;
+  }
+
+  if ( url.startsWith('search?') ) {
+    return `${root}/${url}`;
+  }
+
+  return `${root}/content/${url}`;
+}
+
+function getBookFromUserUrl(url) {
+  if ( url == '' ) {
+    return null;
+  }
+
+  if ( url.startsWith('search?') ) {
+    const p = new URLSearchParams(url.slice("search?".length));
+    return p.get('books.name') || p.get('content');
+  }
+  return url.split('/')[0];
+}
+
+let currentBook = getBookFromUserUrl(location.hash.slice(1));
+let currentBookTitle = null;
+
+const bookUIGroup = document.getElementById('kiwix_serve_taskbar_book_ui_group');
+const homeButton = document.getElementById('kiwix_serve_taskbar_home_button');
+const contentIframe = document.getElementById('content_iframe');
+
+
+function gotoMainPageOfCurrentBook() {
+  location.hash = currentBook + '/';
+}
+
+function gotoUrl(url) {
+  contentIframe.src = url;
+}
+
+function gotoRandomPage() {
+  gotoUrl(`${root}/random?content=${currentBook}`);
+}
+
+function performSearch() {
+  const searchbox = document.getElementById('kiwixsearchbox');
+  const q = encodeURIComponent(searchbox.value);
+  gotoUrl(`${root}/search?books.name=${currentBook}&pattern=${q}`);
+}
+
+function suggestionsApiURL()
+{
+  return `${root}/suggest?content=${encodeURIComponent(currentBook)}`;
+}
+
+function setCurrentBook(book, title) {
+  currentBook = book;
+  currentBookTitle = title;
+  homeButton.title = `Go to the main page of '${title}'`;
+  homeButton.setAttribute("aria-label", homeButton.title);
+  homeButton.innerHTML = `<button>${title}</button>`;
+  bookUIGroup.style.display = 'inline';
+  updateSearchBoxForBookChange();
+}
+
+function noCurrentBook() {
+  currentBook = null;
+  currentBookTitle = null;
+  bookUIGroup.style.display = 'none';
+  updateSearchBoxForBookChange();
+}
+
+function updateCurrentBookIfNeeded(userUrl) {
+  const book = getBookFromUserUrl(userUrl);
+  if ( currentBook != book ) {
+    updateCurrentBook(book);
+  }
+}
+
+function updateCurrentBook(book) {
+  if ( book == null ) {
+    noCurrentBook();
+  } else {
+    fetch(`./raw/${book}/meta/Title`).then(async (resp) => {
+      if ( resp.ok ) {
+        setCurrentBook(book, await resp.text());
+      } else {
+        noCurrentBook();
+      }
+    }).catch((err) => {
+      console.log("Error fetching book title: " + err);
+      noCurrentBook();
+    });
+  }
+}
+
+function iframeUrl2UserUrl(url, query) {
+  if ( url == blankPageUrl ) {
+    return '';
+  }
+
+  if ( url == `${root}/search` ) {
+    return `search${query}`;
+  }
+
+  url = url.slice(root.length);
+
+  return url.split('/').slice(2).join('/');
+}
+
+function getSearchPattern() {
+  const url = window.location.hash.slice(1);
+  if ( url.startsWith('search?') ) {
+    const p = new URLSearchParams(url.slice("search?".length));
+    return p.get("pattern");
+  }
+  return null;
+}
+
+
+let autoCompleteJS = null;
+
+function closeSuggestions() {
+  if ( autoCompleteJS ) {
+    autoCompleteJS.close();
+  }
+}
+
+function updateSearchBoxForLocationChange() {
+  closeSuggestions();
+  document.getElementById("kiwixsearchbox").value = getSearchPattern();
+}
+
+function updateSearchBoxForBookChange() {
+  const searchbox = document.getElementById('kiwixsearchbox');
+  const kiwixSearchFormWrapper = document.querySelector('.kiwix_searchform');
+  if ( currentBookTitle ) {
+    searchbox.title = `Search '${currentBookTitle}'`;
+    searchbox.placeholder = searchbox.title;
+    searchbox.setAttribute("aria-label", searchbox.title);
+    kiwixSearchFormWrapper.style.display = 'inline';
+  } else {
+    kiwixSearchFormWrapper.style.display = 'none';
+  }
+}
+
+let previousScrollTop = Infinity;
+
+function updateToolbarVisibilityState() {
+  const iframeDoc = contentIframe.contentDocument;
+  const st = iframeDoc.documentElement.scrollTop || iframeDoc.body.scrollTop;
+  if ( Math.abs(previousScrollTop - st) <= 5 )
+      return;
+
+  const kiwixToolBar = document.querySelector('#kiwixtoolbar');
+
+  if (st > previousScrollTop) {
+      kiwixToolBar.style.position = 'fixed';
+      kiwixToolBar.style.top = '-100%';
+  } else {
+      kiwixToolBar.style.position = 'static';
+      kiwixToolBar.style.top = '0';
+  }
+
+  previousScrollTop = st;
+}
+
+function handle_visual_viewport_change() {
+  contentIframe.height = window.visualViewport.height - contentIframe.offsetTop - 4;
+}
+
+function handle_location_hash_change() {
+  const hash = window.location.hash.slice(1);
+  console.log("handle_location_hash_change: " + hash);
+  updateCurrentBookIfNeeded(hash);
+  const iframeContentUrl = userUrl2IframeUrl(hash);
+  if ( iframeContentUrl != contentIframe.contentWindow.location.pathname ) {
+    contentIframe.contentWindow.location.replace(iframeContentUrl);
+  }
+  updateSearchBoxForLocationChange();
+  previousScrollTop = Infinity;
+}
+
+function handle_content_url_change() {
+  const iframeLocation = contentIframe.contentWindow.location;
+  console.log('handle_content_url_change: ' + iframeLocation.href);
+  document.title = contentIframe.contentDocument.title;
+  const iframeContentUrl = iframeLocation.pathname;
+  const iframeContentQuery = iframeLocation.search;
+  const newHash = iframeUrl2UserUrl(iframeContentUrl, iframeContentQuery);
+  const viewerURL = location.origin + location.pathname + location.search;
+  window.location.replace(viewerURL + '#' + newHash);
+  updateCurrentBookIfNeeded(newHash);
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// External link blocking
+////////////////////////////////////////////////////////////////////////////////
+
+function matchingAncestorElement(el, context, selector) {
+  while (el && el.matches && el !== context) {
+    if ( el.matches(selector) )
+      return el;
+    el = el.parentElement;
+  }
+  return null;
+}
+
+const block_path = `${root}/catch/external`;
+
+function blockLink(target) {
+  const encodedHref = encodeURIComponent(target.href);
+  target.setAttribute("href", block_path + "?source=" + encodedHref);
+}
+
+function isExternalUrl(url) {
+  if ( url.startsWith(window.location.origin) )
+    return false;
+
+  return url.startsWith("//")
+      || url.startsWith("http:")
+      || url.startsWith("https:");
+}
+
+function onClickEvent(e) {
+  const iframeDocument = contentIframe.contentDocument;
+  const target = matchingAncestorElement(e.target, iframeDocument, "a");
+  if (target !== null && "href" in target) {
+    if ( isExternalUrl(target.href) ) {
+      target.setAttribute("target", "_top");
+      if ( viewerSettings.linkBlockingEnabled ) {
+        return blockLink(target);
+      }
+    }
+  }
+}
+
+// helper for enabling IE 8 event bindings
+function addEventHandler(el, eventType, handler) {
+  if (el.attachEvent)
+    el.attachEvent('on'+eventType, handler);
+  else
+    el.addEventListener(eventType, handler);
+}
+
+function setupEventHandler(context, selector, eventType, callback) {
+  addEventHandler(context, eventType, function(e) {
+    const eventElement = e.target || e.srcElement;
+    const el = matchingAncestorElement(eventElement, context, selector);
+    if (el)
+      callback.call(el, e);
+  });
+}
+
+// matches polyfill
+this.Element && function(ElementPrototype) {
+    ElementPrototype.matches = ElementPrototype.matches ||
+    ElementPrototype.matchesSelector ||
+    ElementPrototype.webkitMatchesSelector ||
+    ElementPrototype.msMatchesSelector ||
+    function(selector) {
+        var node = this, nodes = (node.parentNode || node.document).querySelectorAll(selector), i = -1;
+        while (nodes[++i] && nodes[i] != node);
+        return !!nodes[i];
+    }
+}(Element.prototype);
+
+function setup_external_link_blocker() {
+  setupEventHandler(contentIframe.contentDocument, 'a', 'click', onClickEvent);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// End of external link blocking
+////////////////////////////////////////////////////////////////////////////////
+
+function on_content_load() {
+  handle_content_url_change();
+  setup_external_link_blocker();
+}
+
+window.onresize = handle_visual_viewport_change;
+window.onhashchange = handle_location_hash_change;
+
+updateCurrentBook(currentBook);
+handle_location_hash_change();
+
+function htmlDecode(input) {
+    var doc = new DOMParser().parseFromString(input, "text/html");
+    return doc.documentElement.textContent;
+}
+
+function setupAutoHidingOfTheToolbar() {
+  setInterval(updateToolbarVisibilityState, 250);
+}
+
+function setupSuggestions() {
+  const kiwixSearchBox = document.querySelector('#kiwixsearchbox');
+  const kiwixSearchFormWrapper = document.querySelector('.kiwix_searchform');
+
+  autoCompleteJS = new autoComplete(
+    {
+      selector: "#kiwixsearchbox",
+      placeHolder: kiwixSearchBox.title,
+      threshold: 1,
+      debounce: 300,
+      data : {
+        src: async (query) => {
+          try {
+            // Fetch Data from external Source
+            const source = await fetch(`${suggestionsApiURL()}&term=${encodeURIComponent(query)}`);
+            const data = await source.json();
+            return data;
+          } catch (error) {
+            return error;
+          }
+        },
+        keys: ['label'],
+      },
+      submit: true,
+      searchEngine: (query, record) => {
+        // We accept all records
+        return true;
+      },
+      resultsList: {
+        noResults: true,
+        // We must display 10 results (requested) + 1 potential link to do a full text search.
+        maxResults: 11,
+      },
+      resultItem: {
+        element: (item, data) => {
+          let searchLink;
+          if (data.value.kind == "path") {
+            searchLink = `${root}/${currentBook}/${htmlDecode(data.value.path)}`;
+          } else {
+            searchLink = `${root}/search?content=${encodeURIComponent(currentBook)}&pattern=${encodeURIComponent(htmlDecode(data.value.value))}`;
+          }
+          item.innerHTML = `<a class="suggest" href="javascript:gotoUrl('${searchLink}')">${htmlDecode(data.value.label)}</a>`;
+        },
+        highlight: "autoComplete_highlight",
+        selected: "autoComplete_selected"
+      }
+    }
+  );
+
+  document.querySelector('#kiwixsearchform').addEventListener('submit', function(event) {
+    closeSuggestions();
+    try {
+      const selectedElem = document.querySelector('.autoComplete_selected > a');
+      if (selectedElem) {
+        event.preventDefault();
+        selectedElem.click();
+      }
+    } catch (err) {}
+  });
+
+  kiwixSearchBox.addEventListener('focus', () => {
+      kiwixSearchFormWrapper.classList.add('full_width');
+      document.querySelector('label[for="kiwix_button_show_toggle"]').classList.add('searching');
+      document.querySelector('.kiwix_button_cont').classList.add('searching');
+  });
+  kiwixSearchBox.addEventListener('blur', () => {
+      kiwixSearchFormWrapper.classList.remove('full_width');
+      document.querySelector('label[for="kiwix_button_show_toggle"]').classList.remove('searching');
+      document.querySelector('.kiwix_button_cont').classList.remove('searching');
+  });
+}
+
+function setupViewer() {
+  // Defer the call of handle_visual_viewport_change() until after the
+  // presence or absence of the taskbar as determined by this function
+  // has been settled.
+  setTimeout(handle_visual_viewport_change, 0);
+
+  const kiwixToolBarWrapper = document.getElementById('kiwixtoolbarwrapper');
+  if ( ! viewerSettings.toolbarEnabled ) {
+    return;
+  }
+
+  kiwixToolBarWrapper.style.display = 'block';
+  if ( ! viewerSettings.libraryButtonEnabled ) {
+    document.getElementById("kiwix_serve_taskbar_library_button").remove();
+  }
+
+  setupSuggestions();
+
+  // cybook hack
+  if (navigator.userAgent.indexOf("bookeen/cybook") != -1) {
+      document.querySelector('html').classList.add('cybook');
+  }
+
+  if (document.body.clientWidth < 520) {
+    setupAutoHidingOfTheToolbar();
+  }
+}

static/templates/catalog_v2_entry.xml

@@ -1,13 +1,8 @@
-{{#with_xml_header}}<?xml version="1.0" encoding="UTF-8"?>
-{{/with_xml_header}}  <entry>
+  <entry>
     <id>urn:uuid:{{id}}</id>
     <title>{{title}}</title>
     <updated>{{updated}}</updated>
-{{#dump_partial_entries}}
-    <link rel="alternate"
-          href="{{endpoint_root}}/entry/{{{id}}}"
-          type="application/atom+xml;type=entry;profile=opds-catalog"/>
-{{/dump_partial_entries}}{{^dump_partial_entries}}    <summary>{{description}}</summary>
+    <summary>{{description}}</summary>
     <language>{{language}}</language>
     <name>{{name}}</name>
     <flavour>{{flavour}}</flavour>
@@ -16,9 +11,9 @@
     <articleCount>{{article_count}}</articleCount>
     <mediaCount>{{media_count}}</mediaCount>
     {{#icons}}<link rel="http://opds-spec.org/image/thumbnail"
-          href="{{root}}/catalog/v2/illustration/{{{content_id}}}/?size={{icon_size}}"
+          href="{{root}}/catalog/v2/illustration/{{{id}}}/?size={{icon_size}}"
           type="{{icon_mimetype}};width={{icon_size}};height={{icon_size}};scale=1"/>
-    {{/icons}}<link type="text/html" href="{{root}}/{{{content_id}}}" />
+    {{/icons}}<link type="text/html" href="{{root}}/content/{{{content_id}}}" />
     <author>
       <name>{{author_name}}</name>
     </author>
@@ -29,5 +24,4 @@
     {{#url}}
     <link rel="http://opds-spec.org/acquisition/open-access" type="application/x-zim" href="{{{url}}}" length="{{{size}}}" />
     {{/url}}
-{{/dump_partial_entries}}
   </entry>