Enter uriEncode()

.github/workflows/ci.yml

@@ -7,194 +7,143 @@ on:
   pull_request:
 
 jobs:
-  macOS:
-    strategy:
-      fail-fast: false
-      matrix:
-        target:
-          - macos-aarch64-dyn
-          - macos-x86_64-dyn
-          - ios-arm64-dyn
-          - ios-x86_64-dyn
-        include:
-          - target: macos-aarch64-dyn
-            arch_name: arm64-apple-macos
-            run_test: true
-          - target: macos-x86_64-dyn
-            arch_name: x86_64-apple-darwin
-            run_test: true
-          - target: ios-arm64-dyn
-            arch_name: aarch64-apple-ios
-            run_test: false
-          - target: ios-x86_64-dyn
-            arch_name: x86-apple-ios-simulator
-            run_test: false
-    runs-on: macos-15
-
-    env:
-      HOME: /Users/runner
+  Macos:
+    runs-on: macos-latest
     steps:
-      - name: Retrieve source code
-        uses: actions/checkout@v4
-
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.9'
       - name: Install packages
         run: |
           brew update
-          brew install ninja meson
-
-      - name: Install dependencies
-        uses: kiwix/kiwix-build/actions/dl_deps_archive@main
-        with:
-          target_platform: ${{ matrix.target }}
-
-      - name: Compile
-        env:
-          PKG_CONFIG_PATH: ${{env.HOME}}/BUILD_${{matrix.arch_name}}/INSTALL/lib/pkgconfig
-          CPPFLAGS: -I${{env.HOME}}/BUILD_${{matrix.arch_name}}/INSTALL/include
-          MESON_OPTION: --default-library=shared -Db_coverage=true
-          MESON_CROSSFILE: ${{env.HOME}}/BUILD_${{matrix.arch_name}}/meson_cross_file.txt
+          brew install gcovr pkg-config ninja || brew link --overwrite python
+      - name: Install python modules
+        run: pip3 install meson==0.49.2 pytest
+      - name: Install deps
         shell: bash
         run: |
-          if [ -e $MESON_CROSSFILE ]; then
-            MESON_OPTION="$MESON_OPTION --cross-file $MESON_CROSSFILE -Dstatic-linkage=true"
-          fi
-          meson . build ${MESON_OPTION}
-          ninja -C build
-
-      - name: Test libkiwix
-        if: matrix.run_test
+          ARCHIVE_NAME=deps2_osx_native_dyn_libkiwix.tar.xz
+          wget -O- http://tmp.kiwix.org/ci/${ARCHIVE_NAME} | tar -xJ -C $HOME
+      - name: Compile
+        shell: bash
+        run: |
+          export PKG_CONFIG_PATH=$HOME/BUILD_native_dyn/INSTALL/lib/pkgconfig
+          export CPPFLAGS="-I$HOME/BUILD_native_dyn/INSTALL/include"
+          meson . build --default-library=shared -Db_coverage=true
+          cd build
+          ninja
+      - name: Test
+        shell: bash
+        run: |
+          export LD_LIBRARY_PATH=$HOME/BUILD_native_dyn/INSTALL/lib:$HOME/BUILD_native_dyn/INSTALL/lib64
+          cd build
+          meson test --verbose
         env:
           SKIP_BIG_MEMORY_TEST: 1
-          LD_LIBRARY_PATH: ${{env.HOME}}/BUILD_${{matrix.arch_name}}/INSTALL/lib:${{env.HOME}}/BUILD_${{matrix.arch_name}}/INSTALL/lib64
-        run: meson test -C build --verbose
-
-  Windows:
-    runs-on: windows-2022
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup python 3.10
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.10'
-
-      - name: Install packages
-        run:
-          choco install pkgconfiglite ninja
-
-      - name: Install python modules
-        run: pip3 install meson
-
-      - name: Setup MSVC compiler
-        uses: bus1/cabuild/action/msdevshell@v1
-        with:
-          architecture: x64
-
-      - name: Install dependencies
-        uses: kiwix/kiwix-build/actions/dl_deps_archive@main
-        with:
-          target_platform: win-x86_64-static
-
-      - name: Compile
-        shell: cmd
-        run: |
-          set PKG_CONFIG_PATH=%cd%\BUILD_win-amd64\INSTALL\lib\pkgconfig
-          set CPPFLAGS=-I%cd%\BUILD_win-amd64\INSTALL\include
-          meson.exe setup . build -Dwerror=false --default-library=static --buildtype=release
-          cd build
-          ninja.exe
-
-      - name: Test
-        shell: cmd
-        run: |
-          cd build
-          meson.exe test --verbose
-        env:
-          WAIT_TIME_FACTOR_TEST: 10
 
   Linux:
     strategy:
       fail-fast: false
       matrix:
-        target:
-          - linux-x86_64-static
-          - linux-x86_64-dyn
-          - android-arm
-          - android-arm64
-        image_variant: ['jammy']
+        name:
+          - native_static
+          - native_dyn
+          - android_arm
+          - android_arm64
+          - win32_static
+          - win32_dyn
         include:
-          - target: linux-x86_64-static
+          - name: native_static
+            target: native_static
+            image_variant: bionic
             lib_postfix: '/x86_64-linux-gnu'
-            arch_name: linux-x86_64
-            run_test: true
-            coverage: true
-          - target: linux-x86_64-dyn
+          - name: native_dyn
+            target: native_dyn
+            image_variant: bionic
             lib_postfix: '/x86_64-linux-gnu'
-            arch_name: linux-x86_64
-            run_test: true
-            coverage: true
-          - target: android-arm
+          - name: android_arm
+            target: android_arm
+            image_variant: bionic
             lib_postfix: '/arm-linux-androideabi'
-            arch_name: arm-linux-androideabi
-            run_test: false
-            coverage: false
-          - target: android-arm64
+          - name: android_arm64
+            target: android_arm64
+            image_variant: bionic
             lib_postfix: '/aarch64-linux-android'
-            arch_name: aarch64-linux-android
-            run_test: false
-            coverage: false
+          - name: win32_static
+            target: win32_static
+            image_variant: f35
+            lib_postfix: '64'
+          - name: win32_dyn
+            target: win32_dyn
+            image_variant: f35
+            lib_postfix: '64'
     env:
       HOME: /home/runner
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     container:
-      image: "ghcr.io/kiwix/kiwix-build_ci_${{matrix.image_variant}}:2025-06-07"
+      image: "kiwix/kiwix-build_ci:${{matrix.image_variant}}-31"
     steps:
     - name: Checkout code
-      uses: actions/checkout@v4
-    - name: Install dependencies
-      uses: kiwix/kiwix-build/actions/dl_deps_archive@main
-      with:
-        target_platform: ${{ matrix.target }}
+      shell: python
+      run: |
+        from subprocess import check_call
+        from os import environ
+        command = [
+          'git', 'clone',
+          'https://github.com/${{github.repository}}',
+          '--depth=1',
+          '--branch', '${{ github.head_ref || github.ref_name }}'
+        ]
+        check_call(command, cwd=environ['HOME'])
+    - name: Install deps
+      shell: bash
+      run: |
+        ARCHIVE_NAME=deps2_${OS_NAME}_${{matrix.target}}_libkiwix.tar.xz
+        wget -O- http://tmp.kiwix.org/ci/${ARCHIVE_NAME} | tar -xJ -C /home/runner
     - name: Compile
       shell: bash
       run: |
         meson --version
-        if [[ "${{matrix.target}}" =~ .*-dyn ]]; then
+        if [[ "${{matrix.target}}" =~ .*_dyn ]]; then
           MESON_OPTION="--default-library=shared"
         else
           MESON_OPTION="--default-library=static"
         fi
-        if [ -e "${{env.HOME}}/BUILD_${{matrix.arch_name}}/meson_cross_file.txt" ]; then
-          MESON_OPTION="$MESON_OPTION --cross-file ${{env.HOME}}/BUILD_${{matrix.arch_name}}/meson_cross_file.txt"
-        else
+        if [[ "${{matrix.target}}" =~ native_.* ]]; then
           MESON_OPTION="$MESON_OPTION -Db_coverage=true"
+        else
+          MESON_OPTION="$MESON_OPTION --cross-file $HOME/BUILD_${{matrix.target}}/meson_cross_file.txt"
         fi
-        if [[ "${{matrix.target}}" =~ android-.* ]]; then
+        if [[ "${{matrix.target}}" =~ android_.* ]]; then
           MESON_OPTION="$MESON_OPTION -Dstatic-linkage=true"
         fi
+        cd $HOME/libkiwix
         meson . build ${MESON_OPTION}
         cd build
         ninja
       env:
-        PKG_CONFIG_PATH: "/home/runner/BUILD_${{matrix.arch_name}}/INSTALL/lib/pkgconfig:/home/runner/BUILD_${{matrix.arch_name}}/INSTALL/lib${{matrix.lib_postfix}}/pkgconfig"
-        CPPFLAGS: "-I/home/runner/BUILD_${{matrix.arch_name}}/INSTALL/include"
+        PKG_CONFIG_PATH: "/home/runner/BUILD_${{matrix.target}}/INSTALL/lib/pkgconfig:/home/runner/BUILD_${{matrix.target}}/INSTALL/lib${{matrix.lib_postfix}}/pkgconfig"
+        CPPFLAGS: "-I/home/runner/BUILD_${{matrix.target}}/INSTALL/include"
     - name: Test
-      if: matrix.run_test
+      if: startsWith(matrix.target, 'native_')
       shell: bash
       run: |
-        cd build
+        cd $HOME/libkiwix/build
         meson test --verbose
-        if [[ "${{matrix.coverage}}" = "true" ]]; then
-          ninja coverage
-        fi
+        ninja coverage
       env:
-        LD_LIBRARY_PATH: "/home/runner/BUILD_${{matrix.arch_name}}/INSTALL/lib:/home/runner/BUILD_${{matrix.arch_name}}/INSTALL/lib${{matrix.lib_postfix}}"
+        LD_LIBRARY_PATH: "/home/runner/BUILD_${{matrix.target}}/INSTALL/lib:/home/runner/BUILD_${{matrix.target}}/INSTALL/lib${{matrix.lib_postfix}}"
         SKIP_BIG_MEMORY_TEST: 1
-
     - name: Publish coverage
-      if: matrix.coverage
-      uses: codecov/codecov-action@v3
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
+      shell: bash
+      run: |
+        cd $HOME/libkiwix
+        curl https://codecov.io/bash -o codecov.sh
+        bash codecov.sh -n "${OS_NAME}_${{matrix.target}}" -Z
+        rm codecov.sh
+      if: startsWith(matrix.target, 'native_')
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/package.yml

@@ -1,29 +1,19 @@
 name: Packages
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-  release:
-    types: [published]
+on: [push, pull_request]
 
 jobs:
   build-deb:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         distro:
-#          - debian-unstable
-#          - debian-trixie
-#          - debian-bookworm
-#          - debian-bullseye
-          - ubuntu-noble
+          - ubuntu-kinetic
           - ubuntu-jammy
-
+          - ubuntu-focal
+          - ubuntu-bionic
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v2
 
       # Determine which PPA we should upload to
       - name: PPA
@@ -31,51 +21,23 @@ jobs:
         run: |
           if [[ $REF == refs/tags* ]]
           then
-            echo "ppa=kiwixteam/release" >> $GITHUB_OUTPUT
+            echo "::set-output name=ppa::kiwixteam/release"
           else
-            echo "ppa=kiwixteam/dev" >> $GITHUB_OUTPUT
+            echo "::set-output name=ppa::kiwixteam/dev"
           fi
         env:
           REF: ${{ github.ref }}
 
-      - uses: legoktm/gh-action-auto-dch@main
+      - uses: legoktm/gh-action-auto-dch@master
         with:
           fullname: Kiwix builder
           email: release+launchpad@kiwix.org
           distro: ${{ matrix.distro }}
 
-#      - uses: legoktm/gh-action-build-deb@debian-unstable
-#        if: matrix.distro == 'debian-unstable'
-#        name: Build package for debian-unstable
-#        id: build-debian-unstable
-#        with:
-#          args: --no-sign
-#
-#      - uses: legoktm/gh-action-build-deb@b47978ba8498dc8b8153cc3b5f99a5fc1afa5de1 # pin@debian-trixie
-#        if: matrix.distro == 'debian-trixie'
-#        name: Build package for debian-trixie
-#        id: build-debian-trixie
-#        with:
-#          args: --no-sign
-#
-#      - uses: legoktm/gh-action-build-deb@1f4e86a6bb34aaad388167eaf5eb85d553935336 # pin@debian-bookworm
-#        if: matrix.distro == 'debian-bookworm'
-#        name: Build package for debian-bookworm
-#        id: build-debian-bookworm
-#        with:
-#          args: --no-sign
-#
-#      - uses: legoktm/gh-action-build-deb@084b4263209252ec80a75d2c78a586192c17f18d # pin@debian-bullseye
-#        if: matrix.distro == 'debian-bullseye'
-#        name: Build package for debian-bullseye
-#        id: build-debian-bullseye
-#        with:
-#          args: --no-sign
-
-      - uses: legoktm/gh-action-build-deb@9114a536498b65c40b932209b9833aa942bf108d # pin@ubuntu-noble
-        if: matrix.distro == 'ubuntu-noble'
-        name: Build package for ubuntu-noble
-        id: build-ubuntu-noble
+      - uses: legoktm/gh-action-build-deb@ubuntu-kinetic
+        if: matrix.distro == 'ubuntu-kinetic'
+        name: Build package for ubuntu-kinetic
+        id: build-ubuntu-kinetic
         with:
           args: --no-sign
           ppa: ${{ steps.ppa.outputs.ppa }}
@@ -88,24 +50,42 @@ jobs:
           args: --no-sign
           ppa: ${{ steps.ppa.outputs.ppa }}
 
-      - uses: actions/upload-artifact@v4
+      - uses: legoktm/gh-action-build-deb@ubuntu-focal
+        if: matrix.distro == 'ubuntu-focal'
+        name: Build package for ubuntu-focal
+        id: build-ubuntu-focal
+        with:
+          args: --no-sign
+          ppa: ${{ steps.ppa.outputs.ppa }}
+
+      - uses: legoktm/gh-action-build-deb@ubuntu-bionic
+        if: matrix.distro == 'ubuntu-bionic'
+        name: Build package for ubuntu-bionic
+        id: build-ubuntu-bionic
+        with:
+          args: --no-sign
+          ppa: ${{ steps.ppa.outputs.ppa }}
+
+      - uses: actions/upload-artifact@v2
         with:
           name: Packages for ${{ matrix.distro }}
           path: output
 
-      - uses: legoktm/gh-action-dput@main
+      - uses: legoktm/gh-action-dput@master
         name: Upload dev package
-        # Only upload on pushes to main
+        # Only upload on pushes to git default branch
         if: github.event_name == 'push' && github.event.ref == 'refs/heads/main' && startswith(matrix.distro, 'ubuntu-')
         with:
           gpg_key: ${{ secrets.LAUNCHPAD_GPG }}
           repository: ppa:kiwixteam/dev
           packages: output/*_source.changes
 
-      - uses: legoktm/gh-action-dput@main
+      - uses: legoktm/gh-action-dput@master
         name: Upload release package
-        if: github.event_name == 'release' && startswith(matrix.distro, 'ubuntu-')
+        # Only upload on pushes to master or tag
+        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && startswith(matrix.distro, 'ubuntu-')
         with:
           gpg_key: ${{ secrets.LAUNCHPAD_GPG }}
           repository: ppa:kiwixteam/release
           packages: output/*_source.changes
+

.readthedocs.yaml

@@ -1,21 +0,0 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the version of Python and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
-# We recommend specifying your dependencies to enable reproducible builds:
-# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-python:
-  install:
-  - requirements: docs/requirements.txt

ChangeLog

@@ -1,125 +1,3 @@
-libkiwix 14.1.1
-===============
-
-* Server:
-  - Fix regression for kiwix-serve --nosearchbar (@veloman-yunkan #1250)
-  - Avoid results content interpretation... crash in fulltext search (@vighnesh-sawant #1241)
-  - Fix for intermittent /content/blank.html errors (@veloman-yunkan #1249)
-
-libkiwix 14.1.0
-===============
-
- * Server:
-  - Viewer detects & tracks intrapage navigation anchors too (@veloman-yunkan #1213)
-  - Add support for catalog only mode (@veloman-yunkan #1219)
-  - Add API which returns server access url (@vighnesh-sawant #1234)
-  - Fix chrome searchbar placeholder text overflow (@aditii2712 #1185)
-  - Fix magnet link queryStyring (@rgaudin #1160)
-  - Improve chrome printing stylesheet (@kelson42 #1202)
-  - Default white background (@kelson42 #1205)
-
- * Other:
-  - Switched to the new libzim illustrations API (@veloman-yunkan #1226)
-  - Stop building Windows with DEBUG symbols in CI (@kelson42 #1165)
-  - Update many things in the CI/CD (@kelson42 #1203 #1194 #1209 #1207 #1235)
-  - Requires now libzim 9.4.0 (@kelson42 #1231)
-  - Fix compilation for FreeBSD (@OICe2 #1173 #1174)
-  - Wait up to 1s to let aria2c to start before complaining (@kelson42 #1169)
-
-libkiwix 14.0.0
-===============
-
- * Server:
-  - Support of IPv6 (@veloman-yunkan @aryanA101a #1074 #1093)
-  - Better public IP configuration/detection (@sgourdas #1132)
-  - Fix API errors in catalog searches if Xapian keyword in used (@veloman-yunkan #1137)
-  - Clearly define which Web browsers are supported (@kelson42 @rgaudin @jaifroid @benoit74 #1132)
-  - Improve welcome page download buttons (@veloman-yunkan #1094)
-  - Better handling of external (non-HTTP) links (@veloman-yunkan #1123)
-  - Fix book illustration size on welcome page to 48x48 pixels (@veloman-yunkan #1127)
-  - Remove "Multiple Languages" in language filter (@veloman-yunkan #1098)
-  - Stop transforming tags casing (@kelson42 @veloman-yunkan #1079 #1121)
-  - ZIM file size consistently advertised in MiB (@harsha-mangena #1132)
-  - Few new supported languages in the filter (@kelson42 #1080)
-  - Improve accesskeys (@kelson42 #1075)
-  - Add OpenSearch <link> to head of pages (@kelson42 #1070)
- * Compilation/Packaging:
-  - Multiple fixes around deb packaging (@kelson42 #1108 #1114 #1135)
-  - Generating of libkiwix.pc via Meson (@veloman-yunkan #1133)
-  - Native Windows CI/CD (@mgautierfr @kelson42 #1113 #1125)
-  - Better check (maximum) libzim version (@kelson42 #1124)
-  - Multiple automated tests improvements (@veloman-yunkan #1068 #1067)
- * Other:
-  - Deleted supported env. variable `$KIWIX_DATA_DIR` and `kiwix::getDataDirectory()` (@sgourdas #1107)
-  - New string slugification for filenames (@shaopenglin #1105)
-  - Multiple improvements around aria2c download mgmt. (@veloman-yunkan #1097)
-
-libkiwix 13.1.0
-===============
-
- * Server:
-  - Properly translated error pages (@veloman-yunkan #1032)
-  - Properly translated search result page (@veloman-yunkan #1046)
-  - Default UI language is resolved in frontend (@veloman-yunkan #1044)
-  - Better support of older Web browsers by polyfilling replaceAll() (@veloman-yunkan #1054)
- * New API to migrate bookmarks between books (@mgautierfr #1043)
- * Fixed compilation on Haiku OS (@Begasus #1048)
-
-libkiwix 13.0.0
-===============
-
- * Server:
-  - Improved look & feel of kiwix-serve UI (@veloman-yunkan #917 #1021)
-  - Increase tolerance to malformed (control characters) ZIM entry titles (@veloman-yunkan #1023)
-  - API allowing to filter many categories at once (@juuz0 #974)
-  - Cookie-less user language control (@veloman-yumkan #997)
-  - Hack to fix Mirrorbrain based broken magnet URLs (@rgaudin #1001)
- * Fix handling of books with 'Name' metadata with dots (@mgautier #1016)
- * New method beautifyFileSize() to provide nice-looking book sizes (@vuuz0 #971)
- * Fix a few missing includes (@mgautierfr #978)
- * New functions to read - kiwix-serve - languages and categories streams (@juuz0 #967)
- * Add support of Fon language (@kelson42 #1013)
- * C++17 code base compliancy (@mgautierfr #996)
- * Use everywhere std::shared_ptr in place of raw pointer (@mgautierfr #991)
- * Do not use [[nodiscard]] attribute on compiler not supporting it (@mgautierfr #1003)
- * Add a non minified version of autoComplete.js (@mgautierfr #1008)
- * Multiple CI/CD improvements (@kelson42 #982)
-
-libkiwix 12.1.0
-===============
-
- * Server:
-  - Introduce a `/nojs` endpoint to browse catalog and zim files with a browser without js (@juuz0 #897)
-  - Translate the viewer (@veloman-yunkan #871 #846)
-  - Display `mul` on tile when zim is multi-languages (@juuz0 #934)
-  - Suggestion links point to the `/content` endpoint (@veloman-yunkan #862)
-  - Correctly compress web fonts in http answers (@kelson42 #856)
-  - Correctly encode link in suggestions (@veloman-yunkan #859 #860 #963)
-  - Correctly encode url redirection (@veloman-yunkan #866 #890)
-  - Properly handle user language, through cookies and http headers (@veloman-yunkan #849 #869)
-  - Fix url encoding (@veloman-yunkan #870)
-  - Fix viewer for viewer for SeaMonkey (@veloman-yunkan #887)
-  - Make the downloader threadsafe (@mgautierfr #886)
-  - Add RSS feed in the main page (pointing to the catalog) (@juuz0 #882 #920)
-  - Correctly set the mimetype for json and ico (@veloman-yunkan #892)
-  - `count=-1` correspond to unlimited count (instead of 0) (@veloman-yunkan #894)
-  - Keep the navigation bar on top (@juuz0 #896)
-  - Make the viewer's iframe "safe" (@veloman-yunkan #906 #930)
-  - Correctly escape search link in XML Opds output (@veloman-yunkan #936)
-  - Store values needed for the viewer js in the url fragment instead of the query string (@juuz0 #907)
-  - Get rid of legacy OPDS API usage in the viewer (@veloman-yunkan #939)
-  - Fix charset encoding declaration in OPDS response MIME types (@veloman-yunkan #942)
-  - Fix PDF in the viewer (@veloman-yunkan #940)
-  - Fix external links handling in the viewer (@veloman-yunkan #959)
-  - Add tests of searching with accents (@mgautierfs #954)
- * Fix handling of missing illustration in the book (@veloman-yunkan #961)
- * Add support for multi languages zim files (@veloman-yunkan #904)
- * Fix includes for openbsd (@bentley #949)
- * Fix pathes in git to allow git clone on Windows (@adamlamar #868)
- * Switch to `main` as principal branch (instead of `master`) (@kelson42)
- * Remove libkiwix android publisher from the repository (@kelson42 #884)
- * Various fixes of meson and CI. (@mgautierfr @kelson42)
-
 libkiwix 12.0.0
 ===============
 
@@ -159,6 +37,7 @@ libkiwix 12.0.0
  * Fix documentation (@kelson42 #816)
  * Udpate translation (#787 #839 #847)
 
+
 libkiwix 11.0.0
 ===============
 

README.md

@@ -7,7 +7,7 @@ GNU/Linux, macOS, Android, iOS, ...).
 
 [![Release](https://img.shields.io/github/v/tag/kiwix/libkiwix?label=release&sort=semver)](https://download.kiwix.org/release/libkiwix/)
 [![Repositories](https://img.shields.io/repology/repositories/libkiwix?label=repositories)](https://github.com/kiwix/libkiwix/wiki/Repology)
-[![Build Status](https://github.com/kiwix/libkiwix/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kiwix/libkiwix/actions?query=branch%3Amain)
+[![Build Status](https://github.com/kiwix/libkiwix/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/kiwix/libkiwix/actions?query=branch%3Amain)
 [![Doc](https://readthedocs.org/projects/libkiwix/badge/?style=flat)](https://libkiwix.readthedocs.org/en/latest/?badge=latest)
 [![CodeFactor](https://www.codefactor.io/repository/github/kiwix/libkiwix/badge)](https://www.codefactor.io/repository/github/kiwix/libkiwix)
 [![Codecov](https://codecov.io/gh/kiwix/libkiwix/branch/main/graph/badge.svg)](https://codecov.io/gh/kiwix/libkiwix)
@@ -24,9 +24,9 @@ with the Libkiwix compilation itself, we recommend to have a look to
 Preamble
 --------
 
-Although the Libkiwix can be (cross-)compiled on/for many systems, the
+Although the Libkiwix can be (cross-)compiled on/for many sytems, the
 following documentation explains how to do it on POSIX ones. It is
-primarily thought for GNU/Linux systems and has been tested on recent
+primarly thought for GNU/Linux systems and has been tested on recent
 releases of Ubuntu and Fedora.
 
 Dependencies
@@ -54,7 +54,7 @@ The following dependency needs to be available at runtime:
 These dependencies may or may not be packaged by your operating
 system. They may also be packaged but only in an older version. The
 compilation script will tell you if one of them is missing or too old.
-In the worst case, you will have to download and compile bleeding edge
+In the worse case, you will have to download and compile bleeding edge
 version by hand.
 
 If you want to install these dependencies locally, then use the
@@ -190,7 +190,7 @@ To use JS provided by kiwix-serve you can use the following template to start wi
 - 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 category select box add - `<select id="categoryFilter"></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'>
@@ -201,7 +201,7 @@ To use JS provided by kiwix-serve you can use the following template to start wi
 
 
 If you compile manually Libmicrohttpd, you might need to compile it
-without GNU TLS, a bug here will impeach further compilation
+without GNU TLS, a bug here will empeach further compilation
 otherwise.
 
 If the compilation still fails, you might need to get a more recent

android-kiwix-lib-publisher/.gitignore

@@ -0,0 +1,13 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild

android-kiwix-lib-publisher/build.gradle

@@ -0,0 +1,25 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+
+buildscript {
+    repositories {
+        google()
+        jcenter()
+
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:3.4.1'
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
+    }
+}
+
+allprojects {
+    repositories {
+        google()
+        jcenter()
+    }
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

android-kiwix-lib-publisher/gradle.properties

@@ -0,0 +1,15 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx1536m
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+# Kotlin code style for this project: "official" or "obsolete":
+kotlin.code.style=official

android-kiwix-lib-publisher/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Wed Jun 19 15:28:39 BST 2019
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip

android-kiwix-lib-publisher/gradlew

@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"

android-kiwix-lib-publisher/gradlew.bat

@@ -0,0 +1,84 @@
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

android-kiwix-lib-publisher/kiwixLibAndroid/.gitignore

@@ -0,0 +1 @@
+/build

android-kiwix-lib-publisher/kiwixLibAndroid/build.gradle

@@ -0,0 +1,64 @@
+apply plugin: 'com.android.library'
+apply plugin: 'maven'
+
+android {
+    compileSdkVersion 28
+    defaultConfig {
+        minSdkVersion 15
+        targetSdkVersion 28
+        versionCode 1
+        versionName "1.0"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+}
+
+dependencies {
+    implementation 'com.getkeepsafe.relinker:relinker:1.3.1'
+}
+
+task writePom {
+  pom {
+    project {
+        groupId 'org.kiwix.kiwixlib'
+        artifactId 'kiwixlib'
+        version '10.1.1' + (System.env.KIWIXLIB_BUILDVERSION == null ? '' : '-'+System.env.KIWIXLIB_BUILDVERSION)
+        packaging 'aar'
+        name 'kiwixlib'
+        url 'https://github.com/kiwix/libkiwix'
+        licenses {
+            license {
+                name 'GPLv3'
+                url 'https://www.gnu.org/licenses/gpl-3.0.en.html'
+            }
+        }
+      developers {
+          developer {
+              id 'kiwix'
+              name 'kiwix'
+              email 'contact@kiwix.org'
+          }
+      }
+      scm {
+          connection 'https://github.com/kiwix/libkiwix.git'
+          developerConnection 'https://github.com/kiwix/libkiwix.git'
+          url 'https://github.com/kiwix/libkiwix'
+      }
+    }
+  }.withXml {
+    def dependenciesNode = asNode().appendNode('dependencies')
+
+    //Iterate over the implementation dependencies, adding a <dependency> node for each
+    configurations.implementation.allDependencies.each {
+      def dependencyNode = dependenciesNode.appendNode('dependency')
+      dependencyNode.appendNode('groupId', it.group)
+      dependencyNode.appendNode('artifactId', it.name)
+      dependencyNode.appendNode('version', it.version)
+    }
+  }.writeTo("$buildDir/pom.xml")
+}
+

android-kiwix-lib-publisher/kiwixLibAndroid/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

android-kiwix-lib-publisher/kiwixLibAndroid/src/main/AndroidManifest.xml

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

android-kiwix-lib-publisher/settings.gradle

@@ -0,0 +1 @@
+include ':kiwixLibAndroid'

debian/control

@@ -3,12 +3,13 @@ Priority: optional
 Maintainer: Kiwix team <kiwix@kiwix.org>
 Build-Depends: debhelper-compat (= 13),
  meson,
- pkgconf,
- libzim-dev (>= 9.0), libzim-dev (<< 10.0),
+ pkg-config,
+ libzim-dev (>= 7.2.0~),
  libcurl4-gnutls-dev,
  libicu-dev,
  libgtest-dev,
  libkainjow-mustache-dev,
+ liblzma-dev,
  libmicrohttpd-dev,
  libpugixml-dev,
  zlib1g-dev
@@ -21,13 +22,12 @@ Package: libkiwix-dev
 Section: libdevel
 Architecture: any
 Multi-Arch: same
-Depends: libkiwix14 (= ${binary:Version}), ${misc:Depends}, python3,
- libzim-dev (>= 9.0), libzim-dev (<< 10.0),
+Depends: libkiwix10 (= ${binary:Version}), ${misc:Depends}, python3,
+ libzim-dev (>= 7.2.0~),
  libicu-dev,
  libpugixml-dev,
  libcurl4-gnutls-dev,
- libmicrohttpd-dev,
- zlib1g-dev
+ libmicrohttpd-dev
 Description: library of common code for Kiwix (development)
  Kiwix is an offline Wikipedia reader. libkiwix provides the
  software core for Kiwix, and contains the code shared by all
@@ -35,12 +35,11 @@ Description: library of common code for Kiwix (development)
  .
  This package contains development files.
 
-Package: libkiwix14
+Package: libkiwix10
 Architecture: any
 Multi-Arch: same
 Depends: ${shlibs:Depends}, ${misc:Depends}, aria2
-Conflicts: libkiwix0, libkiwix3, libkiwix9, libkiwix10, libkiwix11, libkiwix12, libkiwix13
-Replaces: libkiwix0, libkiwix3, libkiwix9, libkiwix10, libkiwix11, libkiwix12, libkiwix13
+Conflicts: libkiwix0, libkiwix3, libkiwix9
 Description: library of common code for Kiwix
  Kiwix is an offline Wikipedia reader. libkiwix provides the
  software core for Kiwix, and contains the code shared by all

docs/conf.py

@@ -24,6 +24,8 @@ author = 'libkiwix-team'
 
 # -- General configuration ---------------------------------------------------
 
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -40,7 +42,9 @@ templates_path = ['_templates']
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-html_theme = 'sphinx_rtd_theme'
+
+if not on_rtd:
+    html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/requirements.txt

@@ -1,3 +1,2 @@
 breathe
 exhale
-sphinx_rtd_theme

include/book.h

@@ -79,9 +79,7 @@ class Book
   bool isPathValid() const { return m_pathValid; }
   const std::string& getTitle() const { return m_title; }
   const std::string& getDescription() const { return m_description; }
-  DEPRECATED const std::string& getLanguage() const { return m_language; }
-  const std::string& getCommaSeparatedLanguages() const { return m_language; }
-  const std::vector<std::string> getLanguages() const;
+  const std::string& getLanguage() const { return m_language; }
   const std::string& getCreator() const { return m_creator; }
   const std::string& getPublisher() const { return m_publisher; }
   const std::string& getDate() const { return m_date; }

include/bookmark.h

@@ -29,33 +29,19 @@ class xml_node;
 namespace kiwix
 {
 
-class Book;
 /**
  * A class to store information about a bookmark (an article in a book)
  */
 class Bookmark
 {
  public:
-  /**
-   *  Create an empty bookmark.
-   *
-   * Bookmark must be populated with `set*` methods
-   */
   Bookmark();
-
-  /**
-   * Create a bookmark given a Book, a path and a title.
-   */
-  Bookmark(const Book& book, const std::string& path, const std::string& title);
-
   ~Bookmark();
 
   void updateFromXml(const pugi::xml_node& node);
 
   const std::string& getBookId() const { return m_bookId; }
   const std::string& getBookTitle()  const { return m_bookTitle; }
-  const std::string& getBookName()  const { return m_bookName; }
-  const std::string& getBookFlavour()  const { return m_bookFlavour; }
   const std::string& getUrl() const { return m_url; }
   const std::string& getTitle() const { return m_title; }
   const std::string& getLanguage() const { return m_language; }
@@ -63,8 +49,6 @@ class Bookmark
 
   void setBookId(const std::string& bookId) { m_bookId = bookId; }
   void setBookTitle(const std::string& bookTitle) { m_bookTitle = bookTitle; }
-  void setBookName(const std::string& bookName) { m_bookName = bookName; }
-  void setBookFlavour(const std::string& bookFlavour) { m_bookFlavour = bookFlavour; }
   void setUrl(const std::string& url) { m_url = url; }
   void setTitle(const std::string& title) { m_title = title; }
   void setLanguage(const std::string& language) { m_language = language; }
@@ -73,8 +57,6 @@ class Bookmark
  protected:
   std::string m_bookId;
   std::string m_bookTitle;
-  std::string m_bookName;
-  std::string m_bookFlavour;
   std::string m_url;
   std::string m_title;
   std::string m_language;

include/common.h

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

include/downloader.h

@@ -25,7 +25,6 @@
 #include <map>
 #include <memory>
 #include <stdexcept>
-#include <mutex>
 
 namespace kiwix
 {
@@ -44,14 +43,6 @@ class AriaError : public std::runtime_error {
 };
 
 
-/**
- * A representation of a current download.
- *
- * `Download` is not thread safe. User must care to not call method on a
- * same download from different threads.
- * However, it is safe to use different `Download`s from different threads.
- */
-
 class Download {
  public:
   typedef enum { K_ACTIVE, K_WAITING, K_PAUSED, K_ERROR, K_COMPLETE, K_REMOVED, K_UNKNOWN } StatusResult;
@@ -62,89 +53,19 @@ class Download {
     : mp_aria(p_aria),
       m_status(K_UNKNOWN),
       m_did(did) {};
-
-  /**
-   * Update the status of the download.
-   *
-   * This call make an aria rpc call and is blocking.
-   * Some download (started with a metalink) are in fact several downloads.
-   * - A first one to download the metadlink.
-   * - A second one to download the real file.
-   *
-   * If `follow` is true, updateStatus tries to detect that and tracks
-   * the second download when the first one is finished.
-   * By passing false to `follow`, `Download` will only track the first download.
-   *
-   * `getFoo` methods are based on the last statusUpdate.
-   *
-   * @param follow: Do we have to follow following downloads.
-   */
-  void updateStatus(bool follow);
-
-  /**
-   * Pause the download (and call updateStatus)
-   */
+  void updateStatus(bool follow=false);
   void pauseDownload();
-
-  /**
-   * Resume the download (and call updateStatus)
-   */
   void resumeDownload();
-
-  /**
-   * Cancel the download.
-   *
-   * A canceled downlod cannot be resume and updateStatus does nothing.
-   * However, you can still get information based on the last known information.
-   */
   void cancelDownload();
-
-  /*
-   * Get the status of the download.
-   */
-  StatusResult getStatus() const             { return m_status; }
-
-  /*
-   * Get the id of the download.
-   */
-  const std::string&  getDid() const         { return m_did; }
-
-  /*
-   * Get the id of the "second" download.
-   *
-   * Set only if the "first" download is a metalink and is complete.
-   */
-  const std::string&  getFollowedBy() const  { return m_followedBy; }
-
-  /*
-   * Get the total length of the download.
-   */
-  uint64_t     getTotalLength() const        { return m_totalLength; }
-
-  /*
-   * Get the completed length of the download.
-   */
-  uint64_t     getCompletedLength() const    { return m_completedLength; }
-
-  /*
-   * Get the download speed of the download.
-   */
-  uint64_t     getDownloadSpeed() const      { return m_downloadSpeed; }
-
-  /*
-   * Get the verified length of the download.
-   */
-  uint64_t     getVerifiedLength() const     { return m_verifiedLength; }
-
-  /*
-   * Get the path (local file) of the download.
-   */
-  const std::string&  getPath() const        { return m_path; }
-
-  /*
-   * Get the download uris of the download.
-   */
-  const std::vector<std::string>&  getUris() const { return m_uris; }
+  StatusResult getStatus()          { return m_status; }
+  std::string  getDid()             { return m_did; }
+  std::string  getFollowedBy()      { return m_followedBy; }
+  uint64_t     getTotalLength()     { return m_totalLength; }
+  uint64_t     getCompletedLength() { return m_completedLength; }
+  uint64_t     getDownloadSpeed()   { return m_downloadSpeed; }
+  uint64_t     getVerifiedLength()  { return m_verifiedLength; }
+  std::string  getPath()            { return m_path; }
+  std::vector<std::string>&  getUris()             { return m_uris; }
 
  protected:
   std::shared_ptr<Aria2> mp_aria;
@@ -162,69 +83,23 @@ class Download {
 /**
  * A tool to download things.
  *
- * A Downloader manages `Download` using aria2 in the background.
- * `Downloader` is threadsafe.
- * However, the returned `Download`s are NOT threadsafe.
  */
 class Downloader
 {
- public: // types
-  typedef std::vector<std::pair<std::string, std::string>> Options;
-
- public: // functions
-  /*
-  * Create a new Downloader object.
-  *
-  * @param sessionFileDir: The directory where aria2 will store its session file.
-  */
-  explicit Downloader(std::string sessionFileDir);
+ public:
+  Downloader();
   virtual ~Downloader();
 
   void close();
 
-  /**
-   * Start a new download.
-   *
-   * This method is thread safe and returns a pointer to a newly created
-   * `Download` or an existing one with a matching URI. In the latter case
-   * the options parameter is ignored, which can lead to surprising results.
-   * For example, if the old and new download requests (sharing the same URI)
-   * have different values for the download directory or output file name
-   * options, after the download is reported to be complete the downloaded file
-   * will be present only at the location specified for the first request.
-   *
-   * User should call `update` on the returned `Download` to have an accurate status.
-   *
-   * @param uri: The uri of the thing to download.
-   * @param downloadDir: The download directory where the thing should be stored (takes precedence over any "dir" in `options`).
-   * @param options: A series of pair <option_name, option_value> to pass to aria.
-   * @return: The newly created Download.
-   */
-  std::shared_ptr<Download> startDownload(const std::string& uri, const std::string& downloadDir, Options options = {});
+  Download* startDownload(const std::string& uri, const std::vector<std::pair<std::string, std::string>>& options = {});
+  Download* getDownload(const std::string& did);
 
-  /**
-   * Get a download corrsponding to a download id (did)
-   * User should call `update` on the returned `Download` to have an accurate status.
-   *
-   * @param did: The download id to search for.
-   * @return: The Download corresponding to did.
-   * @throw: Throw std::out_of_range if did is not found.
-   */
-  std::shared_ptr<Download> getDownload(const std::string& did);
+  size_t getNbDownload() { return m_knownDownloads.size(); }
+  std::vector<std::string> getDownloadIds();
 
-  /**
-   * Get the number of downloads currently managed.
-   */
-  size_t getNbDownload() const;
-
-  /**
-   * Get the ids of the managed downloads.
-   */
-  std::vector<std::string> getDownloadIds() const;
-
- private: // data
-  mutable std::mutex m_lock;
-  std::map<std::string, std::shared_ptr<Download>> m_knownDownloads;
+ private:
+  std::map<std::string, std::unique_ptr<Download>> m_knownDownloads;
   std::shared_ptr<Aria2> mp_aria;
 };
 }

include/library.h

@@ -34,10 +34,6 @@
 
 #define KIWIX_LIBRARY_VERSION "20110515"
 
-namespace Xapian {
-class WritableDatabase;
-};
-
 namespace kiwix
 {
 
@@ -55,22 +51,6 @@ enum supportedListMode {
   NOVALID = 1 << 5
 };
 
-enum MigrationMode {
-  /** When migrating bookmarks, do not allow to migrate to an older book than the currently pointed one
-   * (or date stored in the bookmark if book is invalid)
-   *
-   * If no newer books are found, no upgrade is made.
-   */
-  UPGRADE_ONLY = 0,
-
-  /** Try hard to do a migration. This mostly does:
-   * - Try to find a newer book.
-   * - If book is invalid: find a best book, potentially older.
-   * Older book will never be returned if current book is a valid one.
-   */
-  ALLOW_DOWNGRADE = 1,
-};
-
 class Filter {
   public: // types
     using Tags = std::vector<std::string>;
@@ -87,7 +67,6 @@ class Filter {
     std::string _query;
     bool _queryIsPartial;
     std::string _name;
-    std::string _flavour;
 
   public: // functions
     Filter();
@@ -126,12 +105,6 @@ class Filter {
     Filter& acceptTags(const Tags& tags);
     Filter& rejectTags(const Tags& tags);
 
-    /**
-     *  Set the filter to only accept books in the specified category.
-     *
-     *  Multiple categories can be specified as a comma-separated list (in
-     *  which case a book in any of those categories will match).
-     */
     Filter& category(std::string category);
 
     /**
@@ -147,9 +120,6 @@ class Filter {
     Filter& maxSize(size_t size);
     Filter& query(std::string query, bool partial=true);
     Filter& name(std::string name);
-    Filter& flavour(std::string flavour);
-    Filter& clearLang();
-    Filter& clearCategory();
 
     bool hasQuery() const;
     const std::string& getQuery() const { return _query; }
@@ -170,9 +140,6 @@ class Filter {
     bool hasCreator() const;
     const std::string& getCreator() const { return _creator; }
 
-    bool hasFlavour() const;
-    const std::string& getFlavour() const { return _flavour; }
-
     const Tags& getAcceptTags() const { return _acceptTags; }
     const Tags& getRejectTags() const { return _rejectTags; }
 
@@ -198,53 +165,31 @@ class ZimSearcher : public zim::Searcher
     std::mutex m_mutex;
 };
 
-template<typename, typename>
-class ConcurrentCache;
-
-template<typename, typename>
-class MultiKeyCache;
-
-using LibraryPtr = std::shared_ptr<Library>;
-using ConstLibraryPtr = std::shared_ptr<const Library>;
-
-
-// Some compiler we use don't have [[nodiscard]] attribute.
-// We don't want to declare `create` with it in this case.
-#define LIBKIWIX_NODISCARD
-#if defined __has_cpp_attribute
-  #if __has_cpp_attribute (nodiscard)
-    #undef LIBKIWIX_NODISCARD
-    #define LIBKIWIX_NODISCARD [[nodiscard]]
-  #endif
-#endif
-
 /**
  * A Library store several books.
  */
-class Library: public std::enable_shared_from_this<Library>
+class Library
 {
+  // all data fields must be added in LibraryBase
+  mutable std::mutex m_mutex;
+
  public:
   typedef uint64_t Revision;
   typedef std::vector<std::string> BookIdCollection;
   typedef std::map<std::string, int> AttributeCounts;
   typedef std::set<std::string> BookIdSet;
 
- private:
-  Library();
-
  public:
-  LIBKIWIX_NODISCARD static LibraryPtr create() {
-    return LibraryPtr(new Library());
-  }
+  Library();
   ~Library();
 
   /**
    * Library is not a copiable object. However it can be moved.
    */
   Library(const Library& ) = delete;
-  Library(Library&& ) = delete;
+  Library(Library&& );
   void operator=(const Library& ) = delete;
-  Library& operator=(Library&& ) = delete;
+  Library& operator=(Library&& );
 
   /**
    * Add a book to the library.
@@ -271,7 +216,7 @@ class Library: public std::enable_shared_from_this<Library>
   void addBookmark(const Bookmark& bookmark);
 
   /**
-   * Remove a bookmark
+   * Remove a bookmarkk
    *
    * @param zimId The zimId of the bookmark.
    * @param url The url of the bookmark.
@@ -279,66 +224,6 @@ class Library: public std::enable_shared_from_this<Library>
    */
   bool removeBookmark(const std::string& zimId, const std::string& url);
 
-  /**
-   * Migrate all invalid bookmarks.
-   *
-   * All invalid bookmarks (ie pointing to unknown books, no check is made on bookmark pointing to
-   * invalid articles of valid book) will be migrated (if possible) to a better book.
-   * "Better book", will be determined using method `getBestTargetBookId`.
-   *
-   * @return A tuple<int, int>: <The number of bookmarks updated>, <Number of invalid bookmarks before migration was performed>.
-   */
-  std::tuple<int, int> migrateBookmarks(MigrationMode migrationMode = ALLOW_DOWNGRADE);
-
-  /**
-   * Migrate all bookmarks associated to a specific book.
-   *
-   * All bookmarks associated to `sourceBookId` book will be migrated to a better book.
-   * "Better book", will be determined using method `getBestTargetBookId`.
-   *
-   * @param sourceBookId the source bookId of the bookmarks to migrate.
-   * @param migrationMode how we will find the best book.
-   * @return The number of bookmarks updated.
-   */
-  int migrateBookmarks(const std::string& sourceBookId, MigrationMode migrationMode = UPGRADE_ONLY);
-
-  /**
-   * Migrate bookmarks
-   *
-   * Migrate all bookmarks pointing to `source` to `destination`.
-   *
-   * @param sourceBookId the source bookId of the bookmarks to migrate.
-   * @param targetBookId the destination bookId to migrate the bookmarks to.
-   * @return The number of bookmarks updated.
-   */
-  int migrateBookmarks(const std::string& sourceBookId, const std::string& targetBookId);
- 
-  /**
-   * Get the best available bookId for a bookmark.
-   *
-   * Given a bookmark, return the best available bookId.
-   * "best available bookId" is determined using heuristitcs based on book name, flavour and date.
-   *
-   * @param bookmark The bookmark to search the bookId for.
-   * @param migrationMode The migration mode to use.
-   * @return A bookId. Potentially empty string if no suitable book found.
-   */
-  std::string getBestTargetBookId(const Bookmark& bookmark, MigrationMode migrationMode) const;
-
-  /**
-   * Get the best bookId for a combination of book's name, flavour and date.
-   *
-   * Given a bookName (mandatory), try to find the best book.
-   * If preferedFlavour is given, will try to find a book with the same flavour. If not found, return a book with a different flavour.
-   * If minDate is given, return a book newer than minDate. If not found, return a empty bookId.
-   *
-   * @param bookName The name of the book
-   * @param preferedFlavour The prefered flavour.
-   * @param minDate the minimal book date acceptable. Must be a string in the format "YYYY-MM-DD".
-   * @return A bookId corresponding to the query, or empty string if not found.
-   */
-  std::string getBestTargetBookId(const std::string& bookName, const std::string& preferedFlavour="", const std::string& minDate="") const;
-
   // XXX: This is a non-thread-safe operation
   const Book& getBookById(const std::string& id) const;
   // XXX: This is a non-thread-safe operation
@@ -475,37 +360,19 @@ class Library: public std::enable_shared_from_this<Library>
 
 private: // types
   typedef const std::string& (Book::*BookStrPropMemFn)() const;
-  struct Entry : Book
-  {
-    Library::Revision lastUpdatedRevision = 0;
-  };
+  struct Impl;
 
 private: // functions
   AttributeCounts getBookAttributeCounts(BookStrPropMemFn p) const;
   std::vector<std::string> getBookPropValueSet(BookStrPropMemFn p) const;
   BookIdCollection filterViaBookDB(const Filter& filter) const;
-  std::string getBestFromBookCollection(BookIdCollection books, const Bookmark& bookmark, MigrationMode migrationMode) const;
-  unsigned int getBookCount_not_protected(const bool localBooks, const bool remoteBooks) const;
   void updateBookDB(const Book& book);
   void dropCache(const std::string& bookId);
 
 private: //data
-  mutable std::recursive_mutex m_mutex;
-  Library::Revision m_revision;
-  std::map<std::string, Entry> m_books;
-  using ArchiveCache = ConcurrentCache<std::string, std::shared_ptr<zim::Archive>>;
-  std::unique_ptr<ArchiveCache> mp_archiveCache;
-  using SearcherCache = MultiKeyCache<std::string, std::shared_ptr<ZimSearcher>>;
-  std::unique_ptr<SearcherCache> mp_searcherCache;
-  std::vector<kiwix::Bookmark> m_bookmarks;
-  std::unique_ptr<Xapian::WritableDatabase> m_bookDB;
+  std::unique_ptr<Impl> mp_impl;
 };
 
-// We don't need it anymore and we don't want to polute any other potential usage
-// of `LIBKIWIX_NODISCARD` token.
-#undef LIBKIWIX_NODISCARD
-
-
 }
 
 #endif

include/manager.h

@@ -37,10 +37,10 @@ namespace kiwix
 class LibraryManipulator
 {
  public: // functions
-  explicit LibraryManipulator(LibraryPtr library);
+  explicit LibraryManipulator(Library* library);
   virtual ~LibraryManipulator();
 
-  LibraryPtr getLibrary() const { return library; }
+  Library& getLibrary() const { return library; }
 
   bool addBookToLibrary(const Book& book);
   void addBookmarkToLibrary(const Bookmark& bookmark);
@@ -52,7 +52,7 @@ class LibraryManipulator
   virtual void booksWereRemovedFromLibrary();
 
  private: // data
-  LibraryPtr library;
+  kiwix::Library& library;
 };
 
 /**
@@ -64,8 +64,8 @@ class Manager
   typedef std::vector<std::string> Paths;
 
  public: // functions
-  explicit Manager(LibraryManipulator manipulator);
-  explicit Manager(LibraryPtr library);
+  explicit Manager(LibraryManipulator* manipulator);
+  explicit Manager(Library* library);
 
   /**
    * Read a `library.xml` and add book in the file to the library.
@@ -163,7 +163,7 @@ class Manager
   uint64_t m_itemsPerPage = 0;
 
  protected:
-  kiwix::LibraryManipulator manipulator;
+  std::shared_ptr<kiwix::LibraryManipulator> manipulator;
 
   bool readBookFromPath(const std::string& path, Book* book);
   bool parseXmlDom(const pugi::xml_document& doc,

include/meson.build

@@ -4,15 +4,15 @@ headers = [
   'common.h',
   'library.h',
   'manager.h',
+  'libxml_dumper.h',
+  'opds_dumper.h',
   'downloader.h',
   'search_renderer.h',
   'server.h',
-  'spelling_correction.h',
   'kiwixserve.h',
   'name_mapper.h',
   'tools.h',
-  'version.h',
-  'i18n.h'
+  'version.h'
 ]
 
 install_headers(headers, subdir:'kiwix')

include/name_mapper.h

@@ -50,19 +50,16 @@ class HumanReadableNameMapper : public NameMapper {
     std::map<std::string, std::string> m_nameToId;
 
   public:
-    HumanReadableNameMapper(const kiwix::Library& library, bool withAlias);
+    HumanReadableNameMapper(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;
-
-  private:
-    void mapName(const kiwix::Library& lib, std::string name, std::string id);
 };
 
 class UpdatableNameMapper : public NameMapper {
     typedef std::shared_ptr<NameMapper> NameMapperHandle;
   public:
-    UpdatableNameMapper(std::shared_ptr<Library> library, bool withAlias);
+    UpdatableNameMapper(Library& library, bool withAlias);
 
     virtual std::string getNameForId(const std::string& id) const;
     virtual std::string getIdForName(const std::string& name) const;
@@ -74,7 +71,7 @@ class UpdatableNameMapper : public NameMapper {
 
   private:
     mutable std::mutex mutex;
-    std::shared_ptr<Library> library;
+    Library& library;
     NameMapperHandle nameMapper;
     const bool withAlias;
 };

include/opds_dumper.h

@@ -28,7 +28,6 @@
 
 #include "library.h"
 #include "name_mapper.h"
-#include "library_dumper.h"
 
 using namespace std;
 
@@ -39,10 +38,11 @@ namespace kiwix
  * A tool to dump a `Library` into a opds stream.
  *
  */
-class OPDSDumper : public LibraryDumper
+class OPDSDumper
 {
  public:
-  OPDSDumper(const Library* library, const NameMapper* NameMapper);
+  OPDSDumper() = default;
+  OPDSDumper(Library* library, NameMapper* NameMapper);
   ~OPDSDumper();
 
   /**
@@ -85,6 +85,38 @@ class OPDSDumper : public LibraryDumper
    * @return The OPDS feed.
    */
   std::string languagesOPDSFeed() const;
+
+  /**
+   * Set the id of the library.
+   *
+   * @param id the id to use.
+   */
+  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.
+   *
+   * @param totalResult the total number of results of the search.
+   * @param startIndex the start index of the result.
+   * @param count the number of result of the current set (or page).
+   */
+  void setOpenSearchInfo(int totalResult, int startIndex, int count);
+
+ protected:
+  kiwix::Library* library;
+  kiwix::NameMapper* nameMapper;
+  std::string libraryId;
+  std::string rootLocation;
+  int m_totalResults;
+  int m_startIndex;
+  int m_count;
 };
 }
 

include/search_renderer.h

@@ -37,11 +37,29 @@ class SearchRenderer
   /**
    * Construct a SearchRenderer from a SearchResultSet.
    *
+   * The constructed version of the SearchRenderer will not introduce
+   * the book name for each result. It is better to use the other constructor
+   * with a Library pointer to have a better html page.
+   *
    * @param srs The `SearchResultSet` to render.
+   * @param mapper The `NameMapper` to use to do the rendering.
    * @param start The start offset used for the srs.
    * @param estimatedResultCount The estimatedResultCount of the whole search
    */
-  SearchRenderer(zim::SearchResultSet srs, unsigned int start, unsigned int estimatedResultCount);
+  SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper,
+                 unsigned int start, unsigned int estimatedResultCount);
+
+  /**
+   * Construct a SearchRenderer from a SearchResultSet.
+   *
+   * @param srs The `SearchResultSet` to render.
+   * @param mapper The `NameMapper` to use to do the rendering.
+   * @param library The `Library` to use to look up book details for search results.
+   * @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,
+                 unsigned int start, unsigned int estimatedResultCount);
 
   ~SearchRenderer();
 
@@ -72,39 +90,24 @@ class SearchRenderer
     this->pageLength  = pageLength;
   }
 
-  /**
-   * set user language
-   */
-  void setUserLang(const std::string& lang){
-    this->userlang  = lang;
-  }
+  std::string renderTemplate(const std::string& tmpl_str);
 
   /**
    * Generate the html page with the resutls of the search.
-   *
-   * @param mapper The `NameMapper` to use to do the rendering.
-   * @param library The `Library` to use to look up book details for search results.
-                    May be nullptr. In this case, bookName is not set in the rendered string.
-   * @return The html string
    */
-  std::string getHtml(const NameMapper& mapper, const Library* library);
+  std::string getHtml();
 
-  /**
+    /**
    * Generate the xml page with the resutls of the search.
-   *
-   * @param mapper The `NameMapper` to use to do the rendering.
-   * @param library The `Library` to use to look up book details for search results.
-                    May be nullptr. In this case, bookName is not set in the rendered string.
-   * @return The xml string
    */
-  std::string getXml(const NameMapper& mapper, const Library* library);
+  std::string getXml();
 
- protected: // function
-  std::string renderTemplate(const std::string& tmpl_str, const NameMapper& mapper, const Library *library);
 
  protected:
   std::string beautifyInteger(const unsigned int number);
   zim::SearchResultSet m_srs;
+  NameMapper* mp_nameMapper;
+  Library* mp_library;
   std::string searchBookQuery;
   std::string searchPattern;
   std::string protocolPrefix;
@@ -112,7 +115,6 @@ class SearchRenderer
   unsigned int pageLength;
   unsigned int estimatedResultCount;
   unsigned int resultStart;
-  std::string userlang = "en";
 };
 
 

include/server.h

@@ -22,7 +22,6 @@
 
 #include <string>
 #include <memory>
-#include "tools.h"
 
 namespace kiwix
 {
@@ -37,7 +36,7 @@ namespace kiwix
         *
         * @param library The library to serve.
         */
-       Server(std::shared_ptr<Library> library, std::shared_ptr<NameMapper> nameMapper=nullptr);
+       Server(Library* library, NameMapper* nameMapper=nullptr);
 
        virtual ~Server();
 
@@ -52,7 +51,7 @@ namespace kiwix
        void stop();
 
        void setRoot(const std::string& root);
-       void setAddress(const std::string& addr);
+       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; }
@@ -63,19 +62,14 @@ namespace kiwix
         { m_withTaskbar = withTaskbar; m_withLibraryButton = withLibraryButton; }
        void setBlockExternalLinks(bool blockExternalLinks)
         { m_blockExternalLinks = blockExternalLinks; }
-       void setCatalogOnlyMode(bool enable) { m_catalogOnlyMode = enable; }
-       void setContentServerUrl(std::string url) { m_contentServerUrl = url; }
-       void setIpMode(IpMode mode) { m_ipMode = mode; }
-       int getPort() const;
-       IpAddress getAddress() const;
-       IpMode getIpMode() const;
-       std::vector<std::string> getServerAccessUrls() const;
+       int getPort();
+       std::string getAddress();
 
      protected:
-       std::shared_ptr<Library> mp_library;
-       std::shared_ptr<NameMapper> mp_nameMapper;
+       Library* mp_library;
+       NameMapper* mp_nameMapper;
        std::string m_root = "";
-       IpAddress m_addr;
+       std::string m_addr = "";
        std::string m_indexTemplateString = "";
        int m_port = 80;
        int m_nbThreads = 1;
@@ -84,10 +78,7 @@ namespace kiwix
        bool m_withTaskbar = true;
        bool m_withLibraryButton = true;
        bool m_blockExternalLinks = false;
-       IpMode m_ipMode = IpMode::AUTO;
        int m_ipConnectionLimit = 0;
-       bool m_catalogOnlyMode = false;
-       std::string m_contentServerUrl;
        std::unique_ptr<InternalServer> mp_server;
   };
 }

include/spelling_correction.h

@@ -1,58 +0,0 @@
-/*
- * Copyright (C) 2025 Veloman Yunkan
- *
- * 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_SPELLING_CORRECTION_H
-#define KIWIX_SPELLING_CORRECTION_H
-
-#include <filesystem>
-#include <memory>
-#include <string>
-#include <vector>
-
-namespace zim
-{
-class Archive;
-}
-
-namespace Xapian
-{
-class Database;
-}
-
-namespace kiwix
-{
-
-class SpellingsDB
-{
-public: // functions
-  SpellingsDB(const zim::Archive& archive, std::filesystem::path cacheDirPath);
-  ~SpellingsDB();
-
-  SpellingsDB(const SpellingsDB& ) = delete;
-  void operator=(const SpellingsDB& ) = delete;
-
-  std::vector<std::string> getSpellingCorrections(const std::string& word, uint32_t maxCount) const;
-
-private: // data
-  std::unique_ptr<Xapian::Database> impl_;
-};
-
-} // namespace kiwix
-
-#endif // KIWIX_SPELLING_CORRECTION_H

include/tools.h

@@ -23,21 +23,8 @@
 #include <string>
 #include <vector>
 #include <map>
-#include <cstdint>
-#include "common.h"
 
-namespace kiwix
-{
-
-struct IpAddress
-{
-    std::string addr;  // IPv4 address
-    std::string addr6; // IPv6 address
-};
-
-typedef std::pair<std::string, std::string> LangNameCodePair;
-typedef std::vector<LangNameCodePair> FeedLanguages;
-typedef std::vector<std::string> FeedCategories;
+namespace kiwix {
 
 /**
  * Return the current directory.
@@ -46,6 +33,26 @@ typedef std::vector<std::string> FeedCategories;
  */
 std::string getCurrentDirectory();
 
+/**
+ * Return the data directory.
+ *
+ * The data directory is a directory where to put data (zim files, ...)
+ * It depends of the platform and it may be changed by user using environment variable.
+ *
+ * The resolution order is :
+ * - `KIWIX_DATA_DIR` env variable (if set).
+ * - On Windows :
+ *    . `$APPDATA/kiwix` if $APPDATA is set
+ *    . `$USERPROFILE/kiwix` if $USERPROFILE is set
+ * - Else :
+ *    . `$XDG_DATA_HOME/kiwix`if $XDG_DATA_HOME is set
+ *    . `$HOME/.local/share/kiwx` if $HOWE is set
+ * - current directory
+ *
+ * @return the path of the data directory (utf8 encoded)
+ */
+std::string getDataDirectory();
+
 /** Return the path of the executable
  *
  * Some application may be packaged in auto extractible archive (Appimage) and the
@@ -199,73 +206,15 @@ bool fileReadable(const std::string& path);
 std::string getMimeTypeForFile(const std::string& filename);
 
 /** Provides all available network interfaces
- *
- * This function provides the available IPv4 and IPv6 network interfaces
- * as a map from the interface name to its IPv4 and/or IPv6 address(es).
- */
-std::map<std::string, IpAddress> getNetworkInterfacesIPv4Or6();
-
-/** Provides all available IPv4 network interfaces
  *
  * This function provides the available IPv4 network interfaces
- * as a map from the interface name to its IPv4 address.
- *
- * Provided for backward compatibility with libkiwix v13.1.0.
  */
 std::map<std::string, std::string> getNetworkInterfaces();
 
 /** Provides the best IP address
- * This function provides the best IP addresses for both ipv4 and ipv6 protocols,
- * in an IpAddress struct, based on the list given by getNetworkInterfacesIPv4Or6()
- */
-IpAddress getBestPublicIps();
-
-/** Provides the best IPv4 adddress
- * Equivalent to getBestPublicIp(false). Provided for backward compatibility
- * with libkiwix v13.1.0.
+ * This function provides the best IP address from the list given by getNetworkInterfaces
  */
 std::string getBestPublicIp();
 
-/** Converts file size to human readable format.
- *
- * This function will convert a number to its equivalent size using units.
- *
- * @param number file size in bytes.
- * @return a human-readable string representation of the size, e.g., "2.3 KB", "1.8 MB", "5.2 GB".
- */
-std::string beautifyFileSize(uint64_t number);
-
-/**
- * Load languages stored in an OPDS stream.
- *
- * @param content the OPDS stream.
- * @return vector containing pairs of language code and their corresponding full language name.
- */
-FeedLanguages readLanguagesFromFeed(const std::string& content);
-
-/**
- * Load categories stored in an OPDS stream .
- *
- * @param content the OPDS stream.
- * @return vector containing category strings.
- */
-FeedCategories readCategoriesFromFeed(const std::string& content);
-
-/**
- * Retrieve the full language name associated with a given ISO 639-3 language code.
- *
- * @param lang ISO 639-3 language code.
- * @return full language name.
- */
-std::string getLanguageSelfName(const std::string& lang);
-
-/**
- * Slugifies the filename by converting any characters reserved by the operating
- * system to '_'. Note filename is only the file name and not a path.
- *
- * @param filename Valid UTF-8 encoded file name string. 
- * @return slugified string.
- */
-std::string getSlugifiedFileName(const std::string& filename);
 }
 #endif // KIWIX_TOOLS_H

kiwix.pc.in

@@ -0,0 +1,10 @@
+prefix=@prefix@
+libdir=${prefix}/lib64
+includedir=${prefix}/include
+
+Name: libkiwix
+Description: A library that contains a lot of things used by used by other kiwix programs
+Version: @version@
+Requires: @requires@
+Libs: -L${libdir} -lkiwix @extra_libs@
+Cflags: -I${includedir}/ @extra_cflags@

meson.build

@@ -1,61 +1,26 @@
 project('libkiwix', 'cpp',
-  version : '14.1.1',
+  version : '12.0.0',
   license : 'GPLv3+',
-  default_options : ['c_std=c11', 'cpp_std=c++17', 'werror=true'])
+  default_options : ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
 
 compiler = meson.get_compiler('cpp')
+
 static_deps = get_option('static-linkage') or get_option('default_library') == 'static'
-extra_libs = []
 
-# Atomics as compiled by GCC or clang can lead to external references to
-# functions depending on the type size and the platform. LLVM provides them in
-# 'libcompiler_rt', which clang normally automatically links in, while GNU
-# provides them in 'libatomic', which GCC *does not* link in automatically (but
-# this is probably going to change, see
-# https://gcc.gnu.org/bugzilla/show_bug.cgi?id=81358). Regardless of the setup
-# of the compiler driver itself (GCC or clang), we can thus assume that if some
-# atomic references can't be resolved, then 'libatomic' is missing.
-atomics_program = '''
-#include <atomic>
-#include <cstdint>
-
-using namespace std;
-
-int main() {
-  volatile atomic_bool a_b(true);
-  volatile atomic_ullong a_ull(-1);
-  // Next two lines are to cover atomic<socket_t> from 'httplib.h'.
-  volatile atomic<uint32_t> a_u32(-1);
-  volatile atomic<uint64_t> a_u64(-1);
-
-  return atomic_load(&a_b) == false && atomic_load(&a_ull) == 0 &&
-    atomic_load(&a_u32) == 0 && atomic_load(&a_u64) == 0;
-}
-'''
-if not compiler.links(atomics_program,
-                      name: 'compiler driver readily supports atomics')
-  libatomic = compiler.find_library('atomic')
-  compiler.links(atomics_program, name: 'atomics work with libatomic',
-                 dependencies: libatomic, required: true)
-  extra_libs += ['-latomic']
+# See https://github.com/kiwix/libkiwix/issues/371
+if ['arm', 'mips', 'm68k', 'ppc', 'sh4'].contains(host_machine.cpu_family())
+  extra_libs = ['-latomic']
+else
+  extra_libs = []
 endif
 
-# C++ std::thread is implemented using pthread on Linux by GCC, and on FreeBSD
-# for both GCC and LLVM.
-if (host_machine.system() == 'linux' and compiler.get_id() == 'gcc') or \
-   host_machine.system() == 'freebsd'
+if (compiler.get_id() == 'gcc' and build_machine.system() == 'linux') or host_machine.system() == 'freebsd'
+  # C++ std::thread is implemented using pthread on linux by gcc
   thread_dep = dependency('threads')
 else
   thread_dep = dependency('', required:false)
 endif
-
 libicu_dep = dependency('icu-i18n', static:static_deps)
-if libicu_dep.version().version_compare('>= 76')
-  libicu_deps = [libicu_dep, dependency('icu-uc', static:static_deps)]
-else
-  libicu_deps = [libicu_dep]
-endif
-
 pugixml_dep = dependency('pugixml', static:static_deps)
 libcurl_dep = dependency('libcurl', static:static_deps)
 microhttpd_dep = dependency('libmicrohttpd', static:static_deps)
@@ -70,10 +35,9 @@ else
   error('Cannot found header mustache.hpp')
 endif
 
-libzim_dep = dependency('libzim', version:['>=9.4.0', '<10.0.0'], static:static_deps)
-
-if not compiler.has_header_symbol('zim/zim.h', 'LIBZIM_WITH_XAPIAN', dependencies: libzim_dep)
-  error('Libzim seems to be compiled without Xapian. Xapian support is mandatory.')
+libzim_dep = dependency('libzim', version : '>=8.1.0', static:static_deps)
+if not compiler.has_header_symbol('zim/zim.h', 'LIBZIM_WITH_XAPIAN')
+  error('Libzim seems to be compiled without xapian. Xapian support is mandatory.')
 endif
 
 
@@ -85,25 +49,21 @@ endif
 
 if host_machine.system() == 'windows'
   add_project_arguments('-DNOMINMAX', language: 'cpp')
-  extra_libs += ['-liphlpapi']
 endif
 
-if build_machine.system() == 'windows'
-  extra_libs += ['-lshlwapi', '-lwinmm']
-endif
-
-
-# Dependencies as string
-all_deps = [thread_dep, libzim_dep, pugixml_dep, libcurl_dep, microhttpd_dep, zlib_dep, xapian_dep]
-
-# Dependencies as array
-all_deps += libicu_deps
+all_deps = [thread_dep, libicu_dep, libzim_dep, pugixml_dep, libcurl_dep, microhttpd_dep, zlib_dep, xapian_dep]
 
 inc = include_directories('include', extra_include)
 
 conf = configuration_data()
 conf.set('LIBKIWIX_VERSION', '"@0@"'.format(meson.project_version()))
 
+if build_machine.system() == 'windows'
+     extra_link_args = ['-lshlwapi', '-lwinmm']
+else
+     extra_link_args = []
+endif
+
 subdir('include')
 subdir('scripts')
 subdir('static')
@@ -113,10 +73,17 @@ if get_option('doc')
   subdir('docs')
 endif
 
-pkg_mod = import('pkgconfig')
-pkg_mod.generate(libraries : [libkiwix] + extra_libs,
-                 version : meson.project_version(),
-                 name : 'libkiwix',
-                 filebase : 'libkiwix',
-                 description : 'A library that contains useful primitives that Kiwix readers have in common',
-                 extra_cflags: extra_cflags)
+pkg_requires = ['libzim', 'icu-i18n', 'pugixml', 'libcurl', 'libmicrohttpd', 'xapian-core']
+
+pkg_conf = configuration_data()
+pkg_conf.set('prefix', get_option('prefix'))
+pkg_conf.set('requires', ' '.join(pkg_requires))
+pkg_conf.set('extra_libs', ' '.join(extra_libs))
+pkg_conf.set('extra_cflags', extra_cflags)
+pkg_conf.set('version', meson.project_version())
+configure_file(output : 'kiwix.pc',
+               configuration : pkg_conf,
+               input : 'kiwix.pc.in',
+               install_dir: get_option('libdir')+'/pkgconfig'
+              )
+

scripts/kiwix-compile-i18n

@@ -61,7 +61,7 @@ lang_table_entry_cxx_template = '''
 
 cxxfile_template = '''// This file is automatically generated. Do not modify it.
 
-#include "server/i18n_utils.h"
+#include "server/i18n.h"
 
 namespace kiwix {
 namespace i18n {

scripts/kiwix-compile-resources

@@ -61,32 +61,6 @@ resource_decl_template = """{namespaces_open}
 extern const std::string {identifier};
 {namespaces_close}"""
 
-BINARY_RESOURCE_EXTENSIONS = {'.ico', '.png', '.ttf'}
-
-TEXT_RESOURCE_EXTENSIONS = {
-    '.css',
-    '.html',
-    '.js',
-    '.json',
-    '.svg',
-    '.tmpl',
-    '.webmanifest',
-    '.xml',
-}
-
-if not BINARY_RESOURCE_EXTENSIONS.isdisjoint(TEXT_RESOURCE_EXTENSIONS):
-    raise RuntimeError(f"The following file type extensions are declared to be both binary and text: {BINARY_RESOURCE_EXTENSIONS.intersection(TEXT_RESOURCE_EXTENSIONS)}")
-
-def is_binary_resource(filename):
-    _, extension = os.path.splitext(filename)
-    is_binary = extension in BINARY_RESOURCE_EXTENSIONS
-    is_text = extension in TEXT_RESOURCE_EXTENSIONS
-    if not is_binary and not is_text:
-        # all file type extensions of static resources must be listed
-        # in either BINARY_RESOURCE_EXTENSIONS or TEXT_RESOURCE_EXTENSIONS
-        raise RuntimeError(f"Unknown file type extension: {extension}")
-    return is_binary
-
 class Resource:
     def __init__(self, base_dirs, filename, cacheid=None):
         filename = filename
@@ -98,8 +72,6 @@ class Resource:
             try:
                 with open(os.path.join(base_dir, filename), 'rb') as f:
                     self.data = f.read()
-                    if not is_binary_resource(filename):
-                        self.data = self.data.replace(b"\r\n", b"\n")
                 found = True
                 break
             except FileNotFoundError:
@@ -230,17 +202,15 @@ if __name__ == "__main__":
     parser.add_argument('--source_dir',
                         help="Additional directory where to look for resources.",
                         action='append')
-    parser.add_argument('resource_files', nargs='+',
+    parser.add_argument('resource_file',
                         help='The list of resources to compile.')
     args = parser.parse_args()
 
+    base_dir = os.path.dirname(os.path.realpath(args.resource_file))
     source_dir = args.source_dir or []
-    resources = []
-    for resfile in args.resource_files:
-        base_dir = os.path.dirname(os.path.realpath(resfile))
-        with open(resfile, 'r') as f:
-            resources += [Resource([base_dir]+source_dir, *line.strip().split())
-                            for line in f.readlines()]
+    with open(args.resource_file, 'r') as f:
+        resources = [Resource([base_dir]+source_dir, *line.strip().split())
+                        for line in f.readlines()]
 
     h_identifier = to_identifier(os.path.basename(args.hfile))
     with open(args.hfile, 'w') as f:

scripts/kiwix-compile-resources.1

@@ -2,7 +2,7 @@
 .SH NAME
 kiwix-compile-resources \- helper to compile and generate some Kiwix resources
 .SH SYNOPSIS
-\fBkiwix\-compile\-resources\fR [\-h] [\-\-cxxfile CXXFILE] [\-\-hfile HFILE] resource_file ...\fR
+\fBkiwix\-compile\-resources\fR [\-h] [\-\-cxxfile CXXFILE] [\-\-hfile HFILE] resource_file\fR
 .SH DESCRIPTION
 .TP
 resource_file

src/aria2.cpp

@@ -4,7 +4,6 @@
 #include "xmlrpc.h"
 #include <iostream>
 #include <algorithm>
-#include <fstream>
 #include <sstream>
 #include <thread>
 #include <chrono>
@@ -25,46 +24,25 @@
 #define LOG_ARIA_ERROR() \
   { \
     std::cerr << "ERROR: aria2 RPC request failed. (" << res << ")." << std::endl; \
-    std::cerr << (curlErrorBuffer[0] ? curlErrorBuffer : curl_easy_strerror(res)) << std::endl; \
+    std::cerr << (m_curlErrorBuffer[0] ? m_curlErrorBuffer.get() : curl_easy_strerror(res)) << std::endl; \
   }
 
 namespace kiwix {
 
-namespace {
-
-void pauseAnyActiveDownloads(const std::string& ariaSessionFilePath)
-{
-    std::ifstream inputFile(ariaSessionFilePath);
-    if ( !inputFile )
-        return;
-
-    std::ostringstream ss;
-    std::string line;
-    while ( std::getline(inputFile, line) ) {
-        if ( !startsWith(line, " pause=") ) {
-            ss << line << "\n";
-        }
-        if ( !line.empty() && line[0] != ' ' && line[0] != '#' ) {
-            ss << " pause=true\n";
-        }
-    }
-
-    std::ofstream outputFile(ariaSessionFilePath);
-    outputFile << ss.str();
-}
-
-} // unnamed namespace
-
-Aria2::Aria2(std::string sessionFileDir):
+Aria2::Aria2():
   mp_aria(nullptr),
   m_port(42042),
-  m_secret(getNewRpcSecret())
+  m_secret(getNewRpcSecret()),
+  m_curlErrorBuffer(new char[CURL_ERROR_SIZE]),
+  mp_curl(nullptr)
 {
+  m_downloadDir = getDataDirectory();
+  makeDirectory(m_downloadDir);
   std::vector<const char*> callCmd;
 
   std::string rpc_port = "--rpc-listen-port=" + to_string(m_port);
-  std::string session_file = appendToDirectory(sessionFileDir, "kiwix.session");
-  pauseAnyActiveDownloads(session_file);
+  std::string download_dir = "--dir=" + getDataDirectory();
+  std::string session_file = appendToDirectory(getDataDirectory(), "kiwix.session");
   std::string session = "--save-session=" + session_file;
   std::string inputFile = "--input-file=" + session_file;
 //  std::string log_dir = "--log=\"" + logDir + "\"";
@@ -91,6 +69,7 @@ Aria2::Aria2(std::string sessionFileDir):
   callCmd.push_back("--enable-rpc");
   callCmd.push_back(rpc_secret.c_str());
   callCmd.push_back(rpc_port.c_str());
+  callCmd.push_back(download_dir.c_str());
   if (fileReadable(session_file)) {
     callCmd.push_back(inputFile.c_str());
   }
@@ -112,42 +91,36 @@ Aria2::Aria2(std::string sessionFileDir):
       launchCmd.append(cmd).append(" ");
   }
   mp_aria = Subprocess::run(callCmd);
+  mp_curl = curl_easy_init();
 
-  CURL* p_curl = curl_easy_init();
-  char curlErrorBuffer[CURL_ERROR_SIZE];
+  curl_easy_setopt(mp_curl, CURLOPT_URL, "http://localhost/rpc");
+  curl_easy_setopt(mp_curl, CURLOPT_PORT, m_port);
+  curl_easy_setopt(mp_curl, CURLOPT_POST, 1L);
+  curl_easy_setopt(mp_curl, CURLOPT_ERRORBUFFER, m_curlErrorBuffer.get());
 
-  curl_easy_setopt(p_curl, CURLOPT_URL, "http://localhost/rpc");
-  curl_easy_setopt(p_curl, CURLOPT_PORT, m_port);
-  curl_easy_setopt(p_curl, CURLOPT_POST, 1L);
-  curl_easy_setopt(p_curl, CURLOPT_ERRORBUFFER, curlErrorBuffer);
-  curl_easy_setopt(p_curl, CURLOPT_TIMEOUT_MS, 100);
-
-  typedef std::chrono::duration<double> Seconds;
-
-  const double MAX_WAITING_TIME_SECONDS = 1;
-  const auto t0 = std::chrono::steady_clock::now();
-  bool maxWaitingTimeWasExceeded = false;
-
-  CURLcode res = CURLE_OK;
-  while ( !maxWaitingTimeWasExceeded ) {
+  int watchdog = 50;
+  while(--watchdog) {
     sleep(10);
-    curlErrorBuffer[0] = 0;
-    res = curl_easy_perform(p_curl);
+    m_curlErrorBuffer[0] = 0;
+    auto res = curl_easy_perform(mp_curl);
     if (res == CURLE_OK) {
       break;
+    } else if (watchdog == 1) {
+      LOG_ARIA_ERROR();
     }
-
-    const auto dt = std::chrono::steady_clock::now() - t0;
-    const double elapsedTime = std::chrono::duration_cast<Seconds>(dt).count();
-    maxWaitingTimeWasExceeded = elapsedTime > MAX_WAITING_TIME_SECONDS;
   }
-  curl_easy_cleanup(p_curl);
-  if ( maxWaitingTimeWasExceeded ) {
-    LOG_ARIA_ERROR();
+  if (!watchdog) {
+    curl_easy_cleanup(mp_curl);
     throw std::runtime_error("Cannot connect to aria2c rpc. Aria2c launch cmd : " + launchCmd);
   }
 }
 
+Aria2::~Aria2()
+{
+  std::unique_lock<std::mutex> lock(m_lock);
+  curl_easy_cleanup(mp_curl);
+}
+
 void Aria2::close()
 {
   saveSession();
@@ -167,25 +140,20 @@ std::string Aria2::doRequest(const MethodCall& methodCall)
   std::stringstream outStream;
   CURLcode res;
   long response_code;
-  char curlErrorBuffer[CURL_ERROR_SIZE];
-  CURL* p_curl = curl_easy_init();
-  curl_easy_setopt(p_curl, CURLOPT_URL, "http://localhost/rpc");
-  curl_easy_setopt(p_curl, CURLOPT_PORT, m_port);
-  curl_easy_setopt(p_curl, CURLOPT_POST, 1L);
-  curl_easy_setopt(p_curl, CURLOPT_ERRORBUFFER, curlErrorBuffer);
-  curl_easy_setopt(p_curl, CURLOPT_POSTFIELDSIZE, requestContent.size());
-  curl_easy_setopt(p_curl, CURLOPT_POSTFIELDS, requestContent.c_str());
-  curl_easy_setopt(p_curl, CURLOPT_WRITEFUNCTION, &write_callback_to_iss);
-  curl_easy_setopt(p_curl, CURLOPT_WRITEDATA, &outStream);
-  curlErrorBuffer[0] = 0;
-  res = curl_easy_perform(p_curl);
-  if (res != CURLE_OK) {
-    LOG_ARIA_ERROR();
-    curl_easy_cleanup(p_curl);
-    throw std::runtime_error("Cannot perform request");
+  {
+    std::unique_lock<std::mutex> lock(m_lock);
+    curl_easy_setopt(mp_curl, CURLOPT_POSTFIELDSIZE, requestContent.size());
+    curl_easy_setopt(mp_curl, CURLOPT_POSTFIELDS, requestContent.c_str());
+    curl_easy_setopt(mp_curl, CURLOPT_WRITEFUNCTION, &write_callback_to_iss);
+    curl_easy_setopt(mp_curl, CURLOPT_WRITEDATA, &outStream);
+    m_curlErrorBuffer[0] = 0;
+    res = curl_easy_perform(mp_curl);
+    if (res != CURLE_OK) {
+      LOG_ARIA_ERROR();
+      throw std::runtime_error("Cannot perform request");
+    }
+    curl_easy_getinfo(mp_curl, CURLINFO_RESPONSE_CODE, &response_code);
   }
-  curl_easy_getinfo(p_curl, CURLINFO_RESPONSE_CODE, &response_code);
-  curl_easy_cleanup(p_curl);
 
   auto responseContent = outStream.str();
   if (response_code != 200) {

src/aria2.h

@@ -12,6 +12,7 @@
 #include "xmlrpc.h"
 
 #include <memory>
+#include <mutex>
 #include <curl/curl.h>
 
 namespace kiwix {
@@ -22,11 +23,16 @@ class Aria2
     std::unique_ptr<Subprocess> mp_aria;
     int m_port;
     std::string m_secret;
+    std::string m_downloadDir;
+    std::unique_ptr<char[]> m_curlErrorBuffer;
+    CURL* mp_curl;
+    std::mutex m_lock;
+
     std::string doRequest(const MethodCall& methodCall);
 
   public:
-    explicit Aria2(std::string sessionFileDir);
-    virtual ~Aria2() = default;
+    Aria2();
+    virtual ~Aria2();
     void close();
 
     std::string addUri(const std::vector<std::string>& uri, const std::vector<std::pair<std::string, std::string>>& options = {});

src/book.cpp

@@ -82,11 +82,10 @@ void Book::update(const zim::Archive& archive) {
   m_size = static_cast<uint64_t>(getArchiveFileSize(archive)) << 10;
 
   m_illustrations.clear();
-  for ( const auto& illustrationInfo : archive.getIllustrationInfos() ) {
+  for ( const auto illustrationSize : archive.getIllustrationSizes() ) {
     const auto illustration = std::make_shared<Illustration>();
-    const zim::Item illustrationItem = archive.getIllustrationItem(illustrationInfo);
-    illustration->width = illustrationInfo.width;
-    illustration->height = illustrationInfo.height;
+    const zim::Item illustrationItem = archive.getIllustrationItem(illustrationSize);
+    illustration->width = illustration->height = illustrationSize;
     illustration->mimeType = illustrationItem.getMimetype();
     illustration->data = illustrationItem.getData();
     // NOTE: illustration->url is left uninitialized
@@ -118,12 +117,11 @@ void Book::updateFromXml(const pugi::xml_node& node, const std::string& baseDir)
   m_articleCount = strtoull(ATTR("articleCount"), 0, 0);
   m_mediaCount = strtoull(ATTR("mediaCount"), 0, 0);
   m_size = strtoull(ATTR("size"), 0, 0) << 10;
-  const std::string faviconMimeType = ATTR("faviconMimeType");
-  const std::string faviconBase64EncodedData = ATTR("favicon");
-  if ( !faviconMimeType.empty() && !faviconBase64EncodedData.empty() ) {
+  std::string favicon_mimetype = ATTR("faviconMimeType");
+  if (! favicon_mimetype.empty()) {
     const auto favicon = std::make_shared<Illustration>();
-    favicon->data = base64_decode(faviconBase64EncodedData);
-    favicon->mimeType = faviconMimeType;
+    favicon->data = base64_decode(ATTR("favicon"));
+    favicon->mimeType = favicon_mimetype;
     favicon->url = ATTR("faviconUrl");
     m_illustrations.assign(1, favicon);
   }
@@ -288,9 +286,4 @@ std::string Book::getCategoryFromTags() const
   }
 }
 
-const std::vector<std::string> Book::getLanguages() const
-{
-  return kiwix::split(m_language, ",");
-}
-
 }

src/bookmark.cpp

@@ -18,7 +18,6 @@
  */
 
 #include "bookmark.h"
-#include "book.h"
 
 #include <pugixml.hpp>
 
@@ -29,17 +28,6 @@ Bookmark::Bookmark()
 {
 }
 
-Bookmark::Bookmark(const Book& book, const std::string& path, const std::string& title):
-  m_bookId(book.getId()),
-  m_bookTitle(book.getTitle()),
-  m_bookName(book.getName()),
-  m_bookFlavour(book.getFlavour()),
-  m_url(path),
-  m_title(title),
-  m_language(book.getCommaSeparatedLanguages()),
-  m_date(book.getDate())
-{}
-
 /* Destructor */
 Bookmark::~Bookmark()
 {
@@ -50,8 +38,6 @@ void Bookmark::updateFromXml(const pugi::xml_node& node)
   auto bookNode = node.child("book");
   m_bookId = bookNode.child("id").child_value();
   m_bookTitle = bookNode.child("title").child_value();
-  m_bookName = bookNode.child("name").child_value();
-  m_bookFlavour = bookNode.child("flavour").child_value();
   m_language = bookNode.child("language").child_value();
   m_date = bookNode.child("date").child_value();
   m_title = node.child("title").child_value();

src/downloader.cpp

@@ -18,7 +18,6 @@
  */
 
 #include "downloader.h"
-#include "tools.h"
 #include "tools/pathTools.h"
 #include "tools/stringTools.h"
 
@@ -125,50 +124,38 @@ void Download::cancelDownload()
 }
 
 /* Constructor */
-Downloader::Downloader(std::string sessionFileDir) :
-  mp_aria(new Aria2(sessionFileDir))
+Downloader::Downloader() :
+  mp_aria(new Aria2())
 {
-  try {
-    for (auto gid : mp_aria->tellWaiting()) {
-      m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
-      m_knownDownloads[gid]->updateStatus(false);
-    }
-  } catch (std::exception& e) {
-    std::cerr << "aria2 tellWaiting failed : " << e.what() << std::endl;
-  }
   try {
     for (auto gid : mp_aria->tellActive()) {
-      if( m_knownDownloads.find(gid) == m_knownDownloads.end()) {
-        m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
-        m_knownDownloads[gid]->updateStatus(false);
-      }
+      m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
+      m_knownDownloads[gid]->updateStatus();
     }
   } catch (std::exception& e) {
     std::cerr << "aria2 tellActive failed : " << e.what() << std::endl;
   }
+  try {
+    for (auto gid : mp_aria->tellWaiting()) {
+      m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
+      m_knownDownloads[gid]->updateStatus();
+    }
+  } catch (std::exception& e) {
+    std::cerr << "aria2 tellWaiting failed : " << e.what() << std::endl;
+  }
 }
 
 /* Destructor */
 Downloader::~Downloader()
 {
-  close();
 }
 
 void Downloader::close()
 {
-  if ( mp_aria ) {
-    try {
-      mp_aria->close();
-    } catch (const std::exception& err) {
-      std::cerr << "ERROR: Failed to save the downloader state: "
-                << err.what() << std::endl;
-    }
-    mp_aria.reset();
-  }
+  mp_aria->close();
 }
 
-std::vector<std::string> Downloader::getDownloadIds() const {
-  std::unique_lock<std::mutex> lock(m_lock);
+std::vector<std::string> Downloader::getDownloadIds() {
   std::vector<std::string> ret;
   for(auto& p:m_knownDownloads) {
     ret.push_back(p.first);
@@ -176,82 +163,42 @@ std::vector<std::string> Downloader::getDownloadIds() const {
   return ret;
 }
 
-namespace
+Download* Downloader::startDownload(const std::string& uri, const std::vector<std::pair<std::string, std::string>>& options)
 {
-
-bool downloadCanBeReused(const Download& d,
-                         const std::string& uri,
-                         const Downloader::Options& /*options*/)
-{
-  const auto& uris = d.getUris();
-  const bool sameURI = std::find(uris.begin(), uris.end(), uri) != uris.end();
-
-  if ( !sameURI )
-    return false;
-
-  switch ( d.getStatus() ) {
-  case Download::K_ERROR:
-  case Download::K_UNKNOWN:
-  case Download::K_REMOVED:
-    return false;
-
-  case Download::K_ACTIVE:
-  case Download::K_WAITING:
-  case Download::K_PAUSED:
-    return true; // XXX: what if options are different?
-
-  case Download::K_COMPLETE:
-    return fileExists(d.getPath()); // XXX: what if options are different?
-  }
-
-  return false;
-}
-
-} // unnamed namespace
-
-std::shared_ptr<Download> Downloader::startDownload(const std::string& uri, const std::string& downloadDir, Options options)
-{
-  std::unique_lock<std::mutex> lock(m_lock);
-  options.erase(std::remove_if(options.begin(), options.end(), [](const auto& option) {
-    return option.first == "dir";
-  }), options.end());
-  options.push_back({"dir", downloadDir});
   for (auto& p: m_knownDownloads) {
     auto& d = p.second;
-    if ( downloadCanBeReused(*d, uri, options) )
-      return d;
+    auto& uris = d->getUris();
+    if (std::find(uris.begin(), uris.end(), uri) != uris.end())
+      return d.get();
   }
   std::vector<std::string> uris = {uri};
   auto gid = mp_aria->addUri(uris, options);
-  m_knownDownloads[gid] = std::make_shared<Download>(mp_aria, gid);
-  return m_knownDownloads[gid];
+  m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
+  return m_knownDownloads[gid].get();
 }
 
-std::shared_ptr<Download> Downloader::getDownload(const std::string& did)
+Download* Downloader::getDownload(const std::string& did)
 {
-  std::unique_lock<std::mutex> lock(m_lock);
   try {
-    return m_knownDownloads.at(did);
+    m_knownDownloads.at(did).get()->updateStatus(true);
+    return m_knownDownloads.at(did).get();
   } catch(std::exception& e) {
-    for (auto gid : mp_aria->tellWaiting()) {
-      if (gid == did) {
-        m_knownDownloads[gid] = std::make_shared<Download>(mp_aria, gid);
-        return m_knownDownloads[gid];
-      }
-    }
     for (auto gid : mp_aria->tellActive()) {
       if (gid == did) {
-        m_knownDownloads[gid] = std::make_shared<Download>(mp_aria, gid);
-        return m_knownDownloads[gid];
+        m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
+        m_knownDownloads.at(gid).get()->updateStatus(true);
+        return m_knownDownloads[gid].get();
       }
     }
+    for (auto gid : mp_aria->tellWaiting()) {
+      if (gid == did) {
+        m_knownDownloads[gid] = std::unique_ptr<Download>(new Download(mp_aria, gid));
+        m_knownDownloads.at(gid).get()->updateStatus(true);
+        return m_knownDownloads[gid].get();
+      }
+  }
     throw e;
   }
 }
 
-size_t Downloader::getNbDownload() const {
-  std::unique_lock<std::mutex> lock(m_lock);
-  return m_knownDownloads.size();
-}
-
 }

src/html_dumper.cpp

@@ -1,144 +0,0 @@
-#include "html_dumper.h"
-#include "libkiwix-resources.h"
-#include "tools/otherTools.h"
-#include "tools.h"
-#include "tools/regexTools.h"
-#include "server/i18n_utils.h"
-
-namespace kiwix
-{
-
-/* Constructor */
-HTMLDumper::HTMLDumper(const Library* library, const NameMapper* nameMapper)
-  : LibraryDumper(library, nameMapper)
-{
-}
-/* Destructor */
-HTMLDumper::~HTMLDumper()
-{
-}
-
-namespace {
-
-std::string humanFriendlyTitle(std::string title)
-{
-  std::string humanFriendlyString = replaceRegex(title, "_", " ");
-  humanFriendlyString[0] = toupper(humanFriendlyString[0]);
-  return humanFriendlyString;
-}
-
-kainjow::mustache::object getLangTag(const std::vector<std::string>& bookLanguages) {
-  std::string langShortString = "";
-  std::string langFullString = "???";
-
-  //if more than 1 languages then show "mul" else show the language
-  if(bookLanguages.size() > 1) {
-    std::vector<std::string> mulLanguages;
-    langShortString = "mul";
-    for (const auto& lang : bookLanguages) {
-      const std::string fullLang = getLanguageSelfName(lang);
-      mulLanguages.push_back(fullLang);
-    }
-    langFullString = kiwix::join(mulLanguages, ",");
-  } else if(bookLanguages.size() == 1) {
-    langShortString = bookLanguages[0];
-    langFullString = getLanguageSelfName(langShortString);
-  }
-
-  kainjow::mustache::object langTag;
-    langTag["langShortString"] = langShortString;
-    langTag["langFullString"] = langFullString;
-  return langTag;
-}
-
-kainjow::mustache::list getTagList(std::string tags)
-{
-  const auto tagsList = kiwix::split(tags, ";", true, false);
-  kainjow::mustache::list finalTagList;
-  for (auto tag : tagsList) {
-  if (tag[0] != '_')
-    finalTagList.push_back(kainjow::mustache::object{
-      {"tag", tag}
-    });
-  }
-  return finalTagList;
-}
-
-} // unnamed namespace
-
-std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const
-{
-  kainjow::mustache::list booksData;
-  const auto filteredBooks = library->filter(filter);
-  const auto searchQuery = filter.getQuery();
-  auto languages = getLanguageData();
-  auto categories = getCategoryData();
-
-  for (auto &category : categories) {
-    const auto categoryName = category.get("name")->string_value();
-    if (categoryName == filter.getCategory()) {
-      category["selected"] = true;
-    }
-    category["hf_name"] = humanFriendlyTitle(categoryName);
-  }
-
-  for (auto &language : languages) {
-    if (language.get("lang_code")->string_value() == filter.getLang()) {
-      language["selected"] = true;
-    }
-  }
-
-  for ( const auto& bookId : filteredBooks ) {
-    const auto bookObj = library->getBookById(bookId);
-    const auto bookTitle = bookObj.getTitle();
-    std::string contentId = "";
-    try {
-      contentId = urlEncode(nameMapper->getNameForId(bookId));
-    } catch (...) {}
-    const auto bookDescription = bookObj.getDescription();
-    const auto bookIconUrl = rootLocation + "/catalog/v2/illustration/" + bookId +  "/?size=48";
-    const auto tags = bookObj.getTags();
-    const auto downloadAvailable = (bookObj.getUrl() != "");
-    const auto langTagObj = getLangTag(bookObj.getLanguages());
-    std::string faviconAttr = "style=background-image:url(" + bookIconUrl + ")";
-    booksData.push_back(kainjow::mustache::object{
-      {"id", contentId},
-      {"title", bookTitle},
-      {"description", bookDescription},
-      {"langTag", langTagObj},
-      {"faviconAttr", faviconAttr},
-      {"tagList", getTagList(tags)},
-      {"downloadAvailable", downloadAvailable}
-    });
-  }
-
-  auto getTranslation = i18n::GetTranslatedStringWithMsgId(m_userLang);
-
-  const auto translations = kainjow::mustache::object{
-                    getTranslation("search"),
-                    getTranslation("download"),
-                    getTranslation("count-of-matching-books", {{"COUNT", to_string(filteredBooks.size())}}),
-                    getTranslation("book-filtering-all-categories"),
-                    getTranslation("book-filtering-all-languages"),
-                    getTranslation("powered-by-kiwix-html"),
-                    getTranslation("welcome-to-kiwix-server"),
-                    getTranslation("preview-book"),
-                    getTranslation("welcome-page-overzealous-filter", {{"URL", "?lang="}})
-  };
-
-  return render_template(
-             RESOURCE::templates::no_js_library_page_html,
-             kainjow::mustache::object{
-               {"root", rootLocation},
-               {"contentAccessUrl", onlyAsNonEmptyMustacheValue(contentAccessUrl)},
-               {"books", booksData },
-               {"searchQuery", searchQuery},
-               {"languages", languages},
-               {"categories", categories},
-               {"noResults", filteredBooks.size() == 0},
-               {"translations", translations}
-             }
-  );
-}
-
-} // namespace kiwix

src/html_dumper.h

@@ -1,50 +0,0 @@
-/*
- * Copyright 2023 Nikhil Tanwar <2002nikhiltanwar@gmail.com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_HTML_DUMPER_H
-#define KIWIX_HTML_DUMPER_H
-
-#include <string>
-
-#include "library_dumper.h"
-
-namespace kiwix
-{
-
-/**
- * A class to dump Library in HTML format.
- */
-class HTMLDumper : public LibraryDumper
-{
- public:
-  HTMLDumper(const Library* library, const NameMapper* NameMapper);
-  ~HTMLDumper();
-
-
-  /**
-   * Dump library in HTML
-   *
-   * @return HTML content
-   */
-  std::string dumpPlainHTML(kiwix::Filter filter) const;
-};
-
-}
-
-#endif // KIWIX_HTML_DUMPER_H

src/library.cpp

@@ -39,8 +39,6 @@
 namespace kiwix
 {
 
-
-
 namespace
 {
 
@@ -60,8 +58,6 @@ bool booksReferToTheSameArchive(const Book& book1, const Book& book2)
       && book1.getPath() == book2.getPath();
 }
 
-} // unnamed namespace
-
 template<typename Key, typename Value>
 class MultiKeyCache: public ConcurrentCache<std::set<Key>, Value>
 {
@@ -83,8 +79,49 @@ class MultiKeyCache: public ConcurrentCache<std::set<Key>, Value>
     }
 };
 
+} // unnamed namespace
+
+struct Library::Impl
+{
+  struct Entry : Book
+  {
+    Library::Revision lastUpdatedRevision = 0;
+  };
+
+  Library::Revision m_revision;
+  std::map<std::string, Entry> m_books;
+  using ArchiveCache = ConcurrentCache<std::string, std::shared_ptr<zim::Archive>>;
+  std::unique_ptr<ArchiveCache> mp_archiveCache;
+  using SearcherCache = MultiKeyCache<std::string, std::shared_ptr<ZimSearcher>>;
+  std::unique_ptr<SearcherCache> mp_searcherCache;
+  std::vector<kiwix::Bookmark> m_bookmarks;
+  Xapian::WritableDatabase m_bookDB;
+
+  unsigned int getBookCount(const bool localBooks, const bool remoteBooks) const;
+
+  Impl();
+  ~Impl();
+
+  Impl(Impl&& );
+  Impl& operator=(Impl&& );
+};
+
+Library::Impl::Impl()
+  : mp_archiveCache(new ArchiveCache(std::max(getEnvVar<int>("KIWIX_ARCHIVE_CACHE_SIZE", 1), 1))),
+    mp_searcherCache(new SearcherCache(std::max(getEnvVar<int>("KIWIX_SEARCHER_CACHE_SIZE", 1), 1))),
+    m_bookDB("", Xapian::DB_BACKEND_INMEMORY)
+{
+}
+
+Library::Impl::~Impl()
+{
+}
+
+Library::Impl::Impl(Library::Impl&& ) = default;
+Library::Impl& Library::Impl::operator=(Library::Impl&& ) = default;
+
 unsigned int
-Library::getBookCount_not_protected(const bool localBooks, const bool remoteBooks) const
+Library::Impl::getBookCount(const bool localBooks, const bool remoteBooks) const
 {
   unsigned int result = 0;
   for (auto& pair: m_books) {
@@ -99,41 +136,50 @@ Library::getBookCount_not_protected(const bool localBooks, const bool remoteBook
 
 /* Constructor */
 Library::Library()
-  : mp_archiveCache(new ArchiveCache(std::max(getEnvVar<int>("KIWIX_ARCHIVE_CACHE_SIZE", 1), 1))),
-    mp_searcherCache(new SearcherCache(std::max(getEnvVar<int>("KIWIX_SEARCHER_CACHE_SIZE", 1), 1))),
-    m_bookDB(new Xapian::WritableDatabase("", Xapian::DB_BACKEND_INMEMORY))
+  : mp_impl(new Library::Impl)
 {
 }
 
+Library::Library(Library&& other)
+  : mp_impl(std::move(other.mp_impl))
+{
+}
+
+Library& Library::operator=(Library&& other)
+{
+  mp_impl = std::move(other.mp_impl);
+  return *this;
+}
+
 /* Destructor */
 Library::~Library() = default;
 
 bool Library::addBook(const Book& book)
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  ++m_revision;
+  std::lock_guard<std::mutex> lock(m_mutex);
+  ++mp_impl->m_revision;
   /* Try to find it */
   updateBookDB(book);
   try {
-    auto& oldbook = m_books.at(book.getId());
+    auto& oldbook = mp_impl->m_books.at(book.getId());
     if ( ! booksReferToTheSameArchive(oldbook, book) ) {
       dropCache(book.getId());
     }
     oldbook.update(book); // XXX: This may have no effect if oldbook is readonly
                           // XXX: Then m_bookDB will become out-of-sync with
                           // XXX: the real contents of the library.
-    oldbook.lastUpdatedRevision = m_revision;
+    oldbook.lastUpdatedRevision = mp_impl->m_revision;
     return false;
   } catch (std::out_of_range&) {
-    auto& newEntry = m_books[book.getId()];
+    auto& newEntry = mp_impl->m_books[book.getId()];
     static_cast<Book&>(newEntry) = book;
-    newEntry.lastUpdatedRevision = m_revision;
-    size_t new_cache_size = static_cast<size_t>(std::ceil(getBookCount_not_protected(true, true)*0.1));
+    newEntry.lastUpdatedRevision = mp_impl->m_revision;
+    size_t new_cache_size = static_cast<size_t>(std::ceil(mp_impl->getBookCount(true, true)*0.1));
     if (getEnvVar<int>("KIWIX_ARCHIVE_CACHE_SIZE", -1) <= 0) {
-      mp_archiveCache->setMaxSize(new_cache_size);
+      mp_impl->mp_archiveCache->setMaxSize(new_cache_size);
     }
     if (getEnvVar<int>("KIWIX_SEARCHER_CACHE_SIZE", -1) <= 0) {
-      mp_searcherCache->setMaxSize(new_cache_size);
+      mp_impl->mp_searcherCache->setMaxSize(new_cache_size);
     }
     return true;
   }
@@ -141,186 +187,33 @@ bool Library::addBook(const Book& book)
 
 void Library::addBookmark(const Bookmark& bookmark)
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  m_bookmarks.push_back(bookmark);
+  std::lock_guard<std::mutex> lock(m_mutex);
+  mp_impl->m_bookmarks.push_back(bookmark);
 }
 
 bool Library::removeBookmark(const std::string& zimId, const std::string& url)
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  for(auto it=m_bookmarks.begin(); it!=m_bookmarks.end(); it++) {
+  std::lock_guard<std::mutex> lock(m_mutex);
+  for(auto it=mp_impl->m_bookmarks.begin(); it!=mp_impl->m_bookmarks.end(); it++) {
     if (it->getBookId() == zimId && it->getUrl() == url) {
-      m_bookmarks.erase(it);
+      mp_impl->m_bookmarks.erase(it);
       return true;
     }
   }
   return false;
 }
 
-std::tuple<int, int> Library::migrateBookmarks(MigrationMode migrationMode) {
-  std::set<std::string> sourceBooks;
-  int invalidBookmarks = 0;
-  {
-    std::lock_guard<std::recursive_mutex> lock(m_mutex);
-    for(auto& bookmark:m_bookmarks) {
-      if (m_books.find(bookmark.getBookId()) == m_books.end()) {
-        invalidBookmarks += 1;
-        sourceBooks.insert(bookmark.getBookId());
-      }
-    }
-  }
-  int changed = 0;
-  for(auto& sourceBook:sourceBooks) {
-    changed += migrateBookmarks(sourceBook, migrationMode);
-  }
-  return std::make_tuple(changed, invalidBookmarks);
-}
-
-std::string Library::getBestFromBookCollection(BookIdCollection books, const Bookmark& bookmark, MigrationMode migrationMode) const {
-  // This function try to get the best book for a bookmark from a book collection.
-  // It assumes that all books in the collection are "acceptable".
-  // (this definiton is not clear but for now it is book's name is equal to bookmark's bookName)
-  //
-  // The algorithm first sort the colletion by "flavour equality" and date.
-  // "flavour equality" is if book's flavour is same that bookmark's flavour (let's say "flavourA" here)
-  // So we have the sorted collection:
-  // - flavourA, date 5
-  // - flavourA, date 4
-  // - flavourB, date 6
-  // - flavourC, date 5
-  // - flavourB, date 3
-  //
-  // Then, depending of migrationMode:
-  // - If ALLOW_DOWNGRADE => take the first one
-  // - If UPGRADE_ONLY => loop on books until we find a book newer than bookmark.
-  //   So if bookmark date is 5 => flavourB, date 6
-  //      if bookmark date is 4 => flavourA, date 5
-  //      if bookmark date is 7 => No book
-
-  if (books.empty()) {
-    return "";
-  }
-
-  sort(books, DATE, false);
-  stable_sort(books.begin(), books.end(), [&](const std::string& bookId1, const std::string& bookId2) {
-    const auto& book1 = getBookById(bookId1);
-    const auto& book2 = getBookById(bookId2);
-    bool same_flavour1 = book1.getFlavour() == bookmark.getBookFlavour();
-    bool same_flavour2 = book2.getFlavour() == bookmark.getBookFlavour();
-    // return True if bookId1 is before bookId2, ie if same_flavour1 and not same_flavour2
-    return same_flavour1 > same_flavour2;
-  });
-
-  if (migrationMode == ALLOW_DOWNGRADE) {
-    return books[0];
-  } else {
-    for (const auto& bookId: books) {
-      const auto& book = getBookById(bookId);
-      if (book.getDate() >= bookmark.getDate()) {
-        return bookId;
-      }
-    }
-  }
-
-  return "";
-}
-
-std::string remove_quote(std::string input) {
-  std::replace(input.begin(), input.end(), '"', ' ');
-  return input;
-}
-
-std::string Library::getBestTargetBookId(const std::string& bookName, const std::string& preferedFlavour, const std::string& minDate) const {
-  // Let's reuse our algorithm based on bookmark.
-  MigrationMode migrationMode = UPGRADE_ONLY;
-  auto bookmark = Bookmark();
-  bookmark.setBookName(bookName);
-  bookmark.setBookFlavour(preferedFlavour);
-
-  if (minDate.empty()) {
-    migrationMode = ALLOW_DOWNGRADE;
-  } else {
-    bookmark.setDate(minDate);
-  }
-
-  return getBestTargetBookId(bookmark, migrationMode);
-}
-
-std::string Library::getBestTargetBookId(const Bookmark& bookmark, MigrationMode migrationMode) const {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  // Search for a existing book with the same name
-  auto book_filter = Filter();
-  if (!bookmark.getBookName().empty()) {
-    book_filter.name(bookmark.getBookName());
-  } else {
-    // We don't have a name stored (older bookmarks)
-    // Fallback on title (All bookmarks should have one, but let's be safe against wrongly filled bookmark)
-    if (bookmark.getBookTitle().empty()) {
-        // No bookName nor bookTitle, no way to find target book.
-        return "";
-    }
-    book_filter.query("title:\"" + remove_quote(bookmark.getBookTitle()) + "\"");
-  }
-  auto targetBooks = filter(book_filter);
-  auto bestBook = getBestFromBookCollection(targetBooks, bookmark, migrationMode);
-  if (bestBook.empty()) {
-    try {
-      getBookById(bookmark.getBookId());
-      return bookmark.getBookId();
-    } catch (std::out_of_range&) {}
-  }
-  return bestBook;
-}
-
-int Library::migrateBookmarks(const std::string& sourceBookId, MigrationMode migrationMode) {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-
-  Bookmark firstBookmarkToChange;
-  for(auto& bookmark:m_bookmarks) {
-    if (bookmark.getBookId() == sourceBookId) {
-      firstBookmarkToChange = bookmark;
-      break;
-    }
-  }
-
-  if (firstBookmarkToChange.getBookId().empty()) {
-    return 0;
-  }
-
-  std::string betterBook = getBestTargetBookId(firstBookmarkToChange, migrationMode);
-
-  if (betterBook.empty()) {
-    return 0;
-  }
-
-  return migrateBookmarks(sourceBookId, betterBook);
-}
-
-int Library::migrateBookmarks(const std::string& sourceBookId, const std::string& targetBookId) {
-  if (sourceBookId == targetBookId) {
-    return 0;
-  }
-  int changed = 0;
-  for (auto& bookmark:m_bookmarks) {
-    if (bookmark.getBookId() == sourceBookId) {
-      bookmark.setBookId(targetBookId);
-      changed +=1;
-    }
-  }
-  return changed;
-}
-
 
 void Library::dropCache(const std::string& id)
 {
-  mp_archiveCache->drop(id);
-  mp_searcherCache->drop(id);
+  mp_impl->mp_archiveCache->drop(id);
+  mp_impl->mp_searcherCache->drop(id);
 }
 
 bool Library::removeBookById(const std::string& id)
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  m_bookDB->delete_document("Q" + id);
+  std::lock_guard<std::mutex> lock(m_mutex);
+  mp_impl->m_bookDB.delete_document("Q" + id);
   dropCache(id);
   // We do not change the cache size here
   // Most of the time, the book is remove in case of library refresh, it is
@@ -328,25 +221,25 @@ bool Library::removeBookById(const std::string& id)
   // Having a too big cache is not a problem here (or it would have been before)
   // (And setMaxSize doesn't actually reduce the cache size, extra cached items
   //  will be removed in put or getOrPut).
-  const bool bookWasRemoved = m_books.erase(id) == 1;
+  const bool bookWasRemoved = mp_impl->m_books.erase(id) == 1;
   if ( bookWasRemoved ) {
-    ++m_revision;
+    ++mp_impl->m_revision;
   }
   return bookWasRemoved;
 }
 
 Library::Revision Library::getRevision() const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  return m_revision;
+  std::lock_guard<std::mutex> lock(m_mutex);
+  return mp_impl->m_revision;
 }
 
 uint32_t Library::removeBooksNotUpdatedSince(Revision libraryRevision)
 {
   BookIdCollection booksToRemove;
   {
-    std::lock_guard<std::recursive_mutex> lock(m_mutex);
-    for ( const auto& entry : m_books) {
+    std::lock_guard<std::mutex> lock(m_mutex);
+    for ( const auto& entry : mp_impl->m_books) {
       if ( entry.second.lastUpdatedRevision <= libraryRevision ) {
         booksToRemove.push_back(entry.first);
       }
@@ -365,12 +258,12 @@ const Book& Library::getBookById(const std::string& id) const
 {
   // XXX: Doesn't make sense to lock this operation since it cannot
   // XXX: guarantee thread-safety because of its return type
-  return m_books.at(id);
+  return mp_impl->m_books.at(id);
 }
 
 Book Library::getBookByIdThreadSafe(const std::string& id) const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
+  std::lock_guard<std::mutex> lock(m_mutex);
   return getBookById(id);
 }
 
@@ -378,7 +271,7 @@ const Book& Library::getBookByPath(const std::string& path) const
 {
   // XXX: Doesn't make sense to lock this operation since it cannot
   // XXX: guarantee thread-safety because of its return type
-  for(auto& it: m_books) {
+  for(auto& it: mp_impl->m_books) {
     auto& book = it.second;
     if (book.getPath() == path)
       return book;
@@ -391,7 +284,7 @@ const Book& Library::getBookByPath(const std::string& path) const
 std::shared_ptr<zim::Archive> Library::getArchiveById(const std::string& id)
 {
   try {
-    return mp_archiveCache->getOrPut(id,
+    return mp_impl->mp_archiveCache->getOrPut(id,
     [&](){
       auto book = getBookById(id);
       if (!book.isPathValid()) {
@@ -408,7 +301,7 @@ std::shared_ptr<ZimSearcher> Library::getSearcherByIds(const BookIdSet& ids)
 {
   assert(!ids.empty());
   try {
-    return mp_searcherCache->getOrPut(ids,
+    return mp_impl->mp_searcherCache->getOrPut(ids,
     [&](){
       std::vector<zim::Archive> archives;
       for(auto& id:ids) {
@@ -428,8 +321,8 @@ std::shared_ptr<ZimSearcher> Library::getSearcherByIds(const BookIdSet& ids)
 unsigned int Library::getBookCount(const bool localBooks,
                                    const bool remoteBooks) const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  return getBookCount_not_protected(localBooks, remoteBooks);
+  std::lock_guard<std::mutex> lock(m_mutex);
+  return mp_impl->getBookCount(localBooks, remoteBooks);
 }
 
 bool Library::writeToFile(const std::string& path) const
@@ -441,7 +334,7 @@ bool Library::writeToFile(const std::string& path) const
   dumper.setBaseDir(baseDir);
   std::string xml;
   {
-    std::lock_guard<std::recursive_mutex> lock(m_mutex);
+    std::lock_guard<std::mutex> lock(m_mutex);
     xml = dumper.dumpLibXMLContent(allBookIds);
   };
   return writeTextFile(path, xml);
@@ -457,10 +350,10 @@ bool Library::writeBookmarksToFile(const std::string& path) const
 
 Library::AttributeCounts Library::getBookAttributeCounts(BookStrPropMemFn p) const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
+  std::lock_guard<std::mutex> lock(m_mutex);
   AttributeCounts propValueCounts;
 
-  for (const auto& pair: m_books) {
+  for (const auto& pair: mp_impl->m_books) {
     const auto& book = pair.second;
     if (book.getOrigId().empty()) {
       propValueCounts[(book.*p)()] += 1;
@@ -480,35 +373,20 @@ std::vector<std::string> Library::getBookPropValueSet(BookStrPropMemFn p) const
 
 std::vector<std::string> Library::getBooksLanguages() const
 {
-  std::vector<std::string> langs;
-  for ( const auto& langAndCount : getBooksLanguagesWithCounts() ) {
-    langs.push_back(langAndCount.first);
-  }
-  return langs;
+  return getBookPropValueSet(&Book::getLanguage);
 }
 
 Library::AttributeCounts Library::getBooksLanguagesWithCounts() const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  AttributeCounts langsWithCounts;
-
-  for (const auto& pair: m_books) {
-    const auto& book = pair.second;
-    if (book.getOrigId().empty()) {
-      for ( const auto& lang : book.getLanguages() ) {
-        ++langsWithCounts[lang];
-      }
-    }
-  }
-  return langsWithCounts;
+  return getBookAttributeCounts(&Book::getLanguage);
 }
 
 std::vector<std::string> Library::getBooksCategories() const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
+  std::lock_guard<std::mutex> lock(m_mutex);
   std::set<std::string> categories;
 
-  for (const auto& pair: m_books) {
+  for (const auto& pair: mp_impl->m_books) {
     const auto& book = pair.second;
     const auto& c = book.getCategory();
     if ( !c.empty() ) {
@@ -532,12 +410,12 @@ std::vector<std::string> Library::getBooksPublishers() const
 const std::vector<kiwix::Bookmark> Library::getBookmarks(bool onlyValidBookmarks) const
 {
   if (!onlyValidBookmarks) {
-    return m_bookmarks;
+    return mp_impl->m_bookmarks;
   }
   std::vector<kiwix::Bookmark> validBookmarks;
   auto booksId = getBooksIds();
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  for(auto& bookmark:m_bookmarks) {
+  std::lock_guard<std::mutex> lock(m_mutex);
+  for(auto& bookmark:mp_impl->m_bookmarks) {
     if (std::find(booksId.begin(), booksId.end(), bookmark.getBookId()) != booksId.end()) {
       validBookmarks.push_back(bookmark);
     }
@@ -547,10 +425,10 @@ const std::vector<kiwix::Bookmark> Library::getBookmarks(bool onlyValidBookmarks
 
 Library::BookIdCollection Library::getBooksIds() const
 {
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
+  std::lock_guard<std::mutex> lock(m_mutex);
   BookIdCollection bookIds;
 
-  for (auto& pair: m_books) {
+  for (auto& pair: mp_impl->m_books) {
     bookIds.push_back(pair.first);
   }
 
@@ -562,14 +440,12 @@ void Library::updateBookDB(const Book& book)
 {
   Xapian::Stem stemmer;
   Xapian::TermGenerator indexer;
-  const auto langs = book.getLanguages();
-  if ( langs.size() == 1 ) {
-    try {
-      stemmer = Xapian::Stem(iso639_3ToXapian(langs[0]));
-      indexer.set_stemmer(stemmer);
-      indexer.set_stemming_strategy(Xapian::TermGenerator::STEM_SOME);
-    } catch (...) {}
-  }
+  const std::string lang = book.getLanguage();
+  try {
+    stemmer = Xapian::Stem(iso639_3ToXapian(lang));
+    indexer.set_stemmer(stemmer);
+    indexer.set_stemming_strategy(Xapian::TermGenerator::STEM_SOME);
+  } catch (...) {}
   Xapian::Document doc;
   indexer.set_document(doc);
 
@@ -584,13 +460,10 @@ void Library::updateBookDB(const Book& book)
   // Index all fields for field-based search
   indexer.index_text(title, 1, "S");
   indexer.index_text(desc,  1, "XD");
-  for ( const auto& lang : langs ) {
-    indexer.index_text(lang,  1, "L");
-  }
+  indexer.index_text(lang,  1, "L");
   indexer.index_text(normalizeText(book.getCreator()),   1, "A");
   indexer.index_text(normalizeText(book.getPublisher()), 1, "XP");
-  doc.add_term("XN"+normalizeText(book.getName()));
-  indexer.index_text(normalizeText(book.getFlavour()),  1, "XF");
+  indexer.index_text(normalizeText(book.getName()),      1, "XN");
   indexer.index_text(normalizeText(book.getCategory()),  1, "XC");
 
   for ( const auto& tag : split(normalizeText(book.getTags()), ";") ) {
@@ -606,7 +479,7 @@ void Library::updateBookDB(const Book& book)
 
   doc.set_data(book.getId());
 
-  m_bookDB->replace_document(idterm, doc);
+  mp_impl->m_bookDB.replace_document(idterm, doc);
 }
 
 namespace
@@ -631,7 +504,6 @@ Xapian::Query buildXapianQueryFromFilterQuery(const Filter& filter)
   queryParser.add_prefix("title", "S");
   queryParser.add_prefix("description", "XD");
   queryParser.add_prefix("name", "XN");
-  queryParser.add_prefix("flavour", "XF");
   queryParser.add_prefix("category", "XC");
   queryParser.add_prefix("lang", "L");
   queryParser.add_prefix("publisher", "XP");
@@ -645,6 +517,8 @@ Xapian::Query buildXapianQueryFromFilterQuery(const Filter& filter)
   //queryParser.set_stemmer(Xapian::Stem(iso639_3ToXapian(???)));
   //queryParser.set_stemming_strategy(Xapian::QueryParser::STEM_SOME);
   const auto flags = Xapian::QueryParser::FLAG_PHRASE
+                   | Xapian::QueryParser::FLAG_BOOLEAN
+                   | Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE
                    | Xapian::QueryParser::FLAG_LOVEHATE
                    | Xapian::QueryParser::FLAG_WILDCARD
                    | partialQueryFlag;
@@ -656,35 +530,25 @@ Xapian::Query nameQuery(const std::string& name)
   return Xapian::Query("XN" + normalizeText(name));
 }
 
-Xapian::Query flavourQuery(const std::string& name)
+Xapian::Query categoryQuery(const std::string& category)
 {
-  return Xapian::Query("XF" + normalizeText(name));
-}
-
-Xapian::Query multipleParamQuery(const std::string& commaSeparatedList, const std::string& prefix)
-{
-  Xapian::Query q;
-  bool firstIteration = true;
-  for ( const auto& elem : kiwix::split(commaSeparatedList, ",") ) {
-    const Xapian::Query singleQuery(prefix + normalizeText(elem));
-    if ( firstIteration ) {
-      q = singleQuery;
-      firstIteration = false;
-    } else {
-      q = Xapian::Query(Xapian::Query::OP_OR, q, singleQuery);
-    }
-  }
-  return q;
-}
-
-Xapian::Query categoryQuery(const std::string& commaSeparatedCategoryList)
-{
-  return multipleParamQuery(commaSeparatedCategoryList, "XC");
+  return Xapian::Query("XC" + normalizeText(category));
 }
 
 Xapian::Query langQuery(const std::string& commaSeparatedLanguageList)
 {
-  return multipleParamQuery(commaSeparatedLanguageList, "L");
+  Xapian::Query q;
+  bool firstIteration = true;
+  for ( const auto& lang : kiwix::split(commaSeparatedLanguageList, ",") ) {
+    const Xapian::Query singleLangQuery("L" + normalizeText(lang));
+    if ( firstIteration ) {
+      q = singleLangQuery;
+      firstIteration = false;
+    } else {
+      q = Xapian::Query(Xapian::Query::OP_OR, q, singleLangQuery);
+    }
+  }
+  return q;
 }
 
 Xapian::Query publisherQuery(const std::string& publisher)
@@ -728,9 +592,6 @@ Xapian::Query buildXapianQuery(const Filter& filter)
   if ( filter.hasName() ) {
     q = Xapian::Query(Xapian::Query::OP_AND, q, nameQuery(filter.getName()));
   }
-  if ( filter.hasFlavour() )  {
-    q = Xapian::Query(Xapian::Query::OP_AND, q, flavourQuery(filter.getFlavour()));     
-  }
   if ( filter.hasCategory() ) {
     q = Xapian::Query(Xapian::Query::OP_AND, q, categoryQuery(filter.getCategory()));
   }
@@ -761,10 +622,10 @@ Library::BookIdCollection Library::filterViaBookDB(const Filter& filter) const
 
   BookIdCollection bookIds;
 
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
-  Xapian::Enquire enquire(*m_bookDB);
+  std::lock_guard<std::mutex> lock(m_mutex);
+  Xapian::Enquire enquire(mp_impl->m_bookDB);
   enquire.set_query(query);
-  const auto results = enquire.get_mset(0, m_books.size());
+  const auto results = enquire.get_mset(0, mp_impl->m_books.size());
   for ( auto it = results.begin(); it != results.end(); ++it  ) {
     bookIds.push_back(it.get_document().get_data());
   }
@@ -776,9 +637,9 @@ Library::BookIdCollection Library::filter(const Filter& filter) const
 {
   BookIdCollection result;
   const auto preliminaryResult = filterViaBookDB(filter);
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
+  std::lock_guard<std::mutex> lock(m_mutex);
   for(auto id : preliminaryResult) {
-    if(filter.accept(m_books.at(id))) {
+    if(filter.accept(mp_impl->m_books.at(id))) {
       result.push_back(id);
     }
   }
@@ -850,7 +711,7 @@ void Library::sort(BookIdCollection& bookIds, supportedListSortBy sort, bool asc
   // NOTE: for the entire duration of the sort. Will need to obtain (under a
   // NOTE: lock) the required atributes from the books once, and then the
   // NOTE: sorting will run on a copy of data without locking.
-  std::lock_guard<std::recursive_mutex> lock(m_mutex);
+  std::lock_guard<std::mutex> lock(m_mutex);
   switch(sort) {
     case TITLE:
       std::sort(bookIds.begin(), bookIds.end(), Comparator<TITLE>(this, ascending));
@@ -896,7 +757,6 @@ enum filterTypes {
   QUERY = FLAG(12),
   NAME = FLAG(13),
   CATEGORY = FLAG(14),
-  FLAVOUR = FLAG(15),
 };
 
 Filter& Filter::local(bool accept)
@@ -998,25 +858,6 @@ Filter& Filter::name(std::string name)
   activeFilters |= NAME;
   return *this;
 }
-  
-Filter& Filter::flavour(std::string flavour)
-{
-  _flavour = flavour;
-  activeFilters |= FLAVOUR;
-  return *this;
-}
-
-Filter& Filter::clearLang()
-{
-  activeFilters &= ~LANG;
-  return *this;
-}
-
-Filter& Filter::clearCategory()
-{
-  activeFilters &= ~CATEGORY;
-  return *this;
-}
 
 #define ACTIVE(X) (activeFilters & (X))
 #define FILTER(TAG, TEST) if (ACTIVE(TAG) && !(TEST)) { return false; }
@@ -1050,12 +891,6 @@ bool Filter::hasCreator() const
   return ACTIVE(_CREATOR);
 }
 
-bool Filter::hasFlavour() const
-{
-  return ACTIVE(FLAVOUR);
-}
-
-
 bool Filter::accept(const Book& book) const
 {
   auto local = !book.getPath().empty();

src/library_dumper.cpp

@@ -1,61 +0,0 @@
-#include "library_dumper.h"
-#include "tools/stringTools.h"
-#include "tools/otherTools.h"
-#include "tools.h"
-
-namespace kiwix
-{
-/* Constructor */
-LibraryDumper::LibraryDumper(const Library* library, const NameMapper* nameMapper)
-  : library(library),
-    nameMapper(nameMapper)
-{
-}
-/* Destructor */
-LibraryDumper::~LibraryDumper()
-{
-}
-
-void LibraryDumper::setOpenSearchInfo(int totalResults, int startIndex, int count)
-{
-  m_totalResults = totalResults;
-  m_startIndex = startIndex,
-  m_count = count;
-}
-
-kainjow::mustache::list LibraryDumper::getCategoryData() const
-{
-  const auto now = gen_date_str();
-  kainjow::mustache::list categoryData;
-  for ( const auto& category : library->getBooksCategories() ) {
-    const auto urlencodedCategoryName = urlEncode(category);
-    categoryData.push_back(kainjow::mustache::object{
-      {"name", category},
-      {"urlencoded_name",  urlencodedCategoryName},
-      {"updated", now},
-      {"id", gen_uuid(libraryId + "/categories/" + urlencodedCategoryName)}
-    });
-  }
-  return categoryData;
-}
-
-kainjow::mustache::list LibraryDumper::getLanguageData() const
-{
-  const auto now = gen_date_str();
-  kainjow::mustache::list languageData;
-  for ( const auto& langAndBookCount : library->getBooksLanguagesWithCounts() ) {
-    const std::string languageCode = langAndBookCount.first;
-    const int bookCount = langAndBookCount.second;
-    const auto languageSelfName = getLanguageSelfName(languageCode);
-    languageData.push_back(kainjow::mustache::object{
-      {"lang_code",  languageCode},
-      {"lang_self_name", languageSelfName},
-      {"book_count", to_string(bookCount)},
-      {"updated", now},
-      {"id", gen_uuid(libraryId + "/languages/" + languageCode)}
-    });
-  }
-  return languageData;
-}
-
-} // namespace kiwix

src/library_dumper.h

@@ -1,99 +0,0 @@
-/*
- * Copyright 2023 Nikhil Tanwar <2002nikhiltanwar@gmail.com>
- * Copyright 2017 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_LIBRARY_DUMPER_H
-#define KIWIX_LIBRARY_DUMPER_H
-
-#include <string>
-
-
-#include "library.h"
-#include "name_mapper.h"
-#include <mustache.hpp>
-
-namespace kiwix
-{
-
-/**
- * A base class to dump Library in various formats.
- *
- */
-class LibraryDumper
-{
- public:
-  LibraryDumper(const Library* library, const NameMapper* NameMapper);
-  ~LibraryDumper();
-
-  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 the URL for accessing book content
-   *
-   * @param url the URL of the /content endpoint of the content server
-   */
-  void setContentAccessUrl(const std::string& url) { this->contentAccessUrl = url; }
-
-  /**
-   * Set some informations about the search results.
-   *
-   * @param totalResult the total number of results of the search.
-   * @param startIndex the start index of the result.
-   * @param count the number of result of the current set (or page).
-   */
-  void setOpenSearchInfo(int totalResult, int startIndex, int count);
-
-  /**
-   * Sets user default language
-   *
-   * @param userLang the user language to be set
-   */
-  void setUserLanguage(std::string userLang) { this->m_userLang = userLang; }
-
-  /**
-   * Get the data of categories
-   */
-  kainjow::mustache::list getCategoryData() const;
-
-  /**
-   * Get the data of languages
-   */
-  kainjow::mustache::list getLanguageData() const;
-
- protected:
-  const kiwix::Library* const library;
-  const kiwix::NameMapper* const nameMapper;
-  std::string libraryId;
-  std::string rootLocation;
-  std::string contentAccessUrl;
-  std::string m_userLang;
-  int m_totalResults;
-  int m_startIndex;
-  int m_count;
-};
-}
-
-#endif // KIWIX_LIBRARY_DUMPER_H

src/libxml_dumper.cpp

@@ -54,7 +54,7 @@ void LibXMLDumper::handleBook(Book book, pugi::xml_node root_node) {
   if (book.getOrigId().empty()) {
     ADD_ATTR_NOT_EMPTY(entry_node, "title", book.getTitle());
     ADD_ATTR_NOT_EMPTY(entry_node, "description", book.getDescription());
-    ADD_ATTR_NOT_EMPTY(entry_node, "language", book.getCommaSeparatedLanguages());
+    ADD_ATTR_NOT_EMPTY(entry_node, "language", book.getLanguage());
     ADD_ATTR_NOT_EMPTY(entry_node, "creator", book.getCreator());
     ADD_ATTR_NOT_EMPTY(entry_node, "publisher", book.getPublisher());
     ADD_ATTR_NOT_EMPTY(entry_node, "name", book.getName());
@@ -97,15 +97,11 @@ void LibXMLDumper::handleBookmark(Bookmark bookmark, pugi::xml_node root_node) {
     auto book = library->getBookByIdThreadSafe(bookmark.getBookId());
     ADD_TEXT_ENTRY(book_node, "id", book.getId());
     ADD_TEXT_ENTRY(book_node, "title", book.getTitle());
-    ADD_TEXT_ENTRY(book_node, "name", book.getName());
-    ADD_TEXT_ENTRY(book_node, "flavour", book.getFlavour());
-    ADD_TEXT_ENTRY(book_node, "language", book.getCommaSeparatedLanguages());
+    ADD_TEXT_ENTRY(book_node, "language", book.getLanguage());
     ADD_TEXT_ENTRY(book_node, "date", book.getDate());
   } catch (...) {
     ADD_TEXT_ENTRY(book_node, "id", bookmark.getBookId());
     ADD_TEXT_ENTRY(book_node, "title", bookmark.getBookTitle());
-    ADD_TEXT_ENTRY(book_node, "name", bookmark.getBookName());
-    ADD_TEXT_ENTRY(book_node, "flavour", bookmark.getBookFlavour());
     ADD_TEXT_ENTRY(book_node, "language", bookmark.getLanguage());
     ADD_TEXT_ENTRY(book_node, "date", bookmark.getDate());
   }
@@ -139,7 +135,7 @@ std::string LibXMLDumper::dumpLibXMLBookmark()
   pugi::xml_node bookmarksNode = doc.append_child("bookmarks");
 
   if (library) {
-    for (auto& bookmark: library->getBookmarks(false)) {
+    for (auto& bookmark: library->getBookmarks()) {
       handleBookmark(bookmark, bookmarksNode);
     }
   }

src/manager.cpp

@@ -27,12 +27,22 @@
 namespace kiwix
 {
 
+namespace
+{
+
+struct NoDelete
+{
+  template<class T> void operator()(T*) {}
+};
+
+} // unnamed namespace
+
 ////////////////////////////////////////////////////////////////////////////////
 // LibraryManipulator
 ////////////////////////////////////////////////////////////////////////////////
 
-LibraryManipulator::LibraryManipulator(LibraryPtr library)
-  : library(library)
+LibraryManipulator::LibraryManipulator(Library* library)
+  : library(*library)
 {}
 
 LibraryManipulator::~LibraryManipulator()
@@ -40,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);
   }
@@ -49,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();
   }
@@ -79,15 +89,15 @@ void LibraryManipulator::booksWereRemovedFromLibrary()
 ////////////////////////////////////////////////////////////////////////////////
 
 /* Constructor */
-Manager::Manager(LibraryManipulator manipulator):
+Manager::Manager(LibraryManipulator* manipulator):
   writableLibraryPath(""),
-  manipulator(manipulator)
+  manipulator(manipulator, NoDelete())
 {
 }
 
-Manager::Manager(LibraryPtr library) :
+Manager::Manager(Library* library) :
   writableLibraryPath(""),
-  manipulator(LibraryManipulator(library))
+  manipulator(new LibraryManipulator(library))
 {
 }
 
@@ -111,7 +121,7 @@ bool Manager::parseXmlDom(const pugi::xml_document& doc,
     if (!trustLibrary && !book.getPath().empty()) {
       this->readBookFromPath(book.getPath(), &book);
     }
-    manipulator.addBookToLibrary(book);
+    manipulator->addBookToLibrary(book);
   }
 
   return true;
@@ -156,7 +166,7 @@ bool Manager::parseOpdsDom(const pugi::xml_document& doc, const std::string& url
     book.updateFromOpds(entryNode, urlHost);
 
     /* Update the book properties with the new importer */
-    manipulator.addBookToLibrary(book);
+    manipulator->addBookToLibrary(book);
   }
 
   return true;
@@ -228,10 +238,10 @@ std::string Manager::addBookFromPathAndGetId(const std::string& pathToOpen,
     }
 
     if (!checkMetaData
-        || (!book.getTitle().empty() && !book.getLanguages().empty()
+        || (checkMetaData && !book.getTitle().empty() && !book.getLanguage().empty()
             && !book.getDate().empty())) {
       book.setUrl(url);
-      manipulator.addBookToLibrary(book);
+      manipulator->addBookToLibrary(book);
       return book.getId();
     }
   }
@@ -286,7 +296,7 @@ bool Manager::readBookmarkFile(const std::string& path)
 
     bookmark.updateFromXml(node);
 
-    manipulator.addBookmarkToLibrary(bookmark);
+    manipulator->addBookmarkToLibrary(bookmark);
   }
 
   return true;
@@ -294,7 +304,7 @@ bool Manager::readBookmarkFile(const std::string& path)
 
 void Manager::reload(const Paths& paths)
 {
-  const auto libRevision = manipulator.getLibrary()->getRevision();
+  const auto libRevision = manipulator->getLibrary().getRevision();
   for (std::string path : paths) {
     if (!path.empty()) {
       if ( kiwix::isRelativePath(path) )
@@ -306,7 +316,7 @@ void Manager::reload(const Paths& paths)
     }
   }
 
-  manipulator.removeBooksNotUpdatedSince(libRevision);
+  manipulator->removeBooksNotUpdatedSince(libRevision);
 }
 
 }

src/meson.build

@@ -5,8 +5,6 @@ kiwix_sources = [
   'manager.cpp',
   'libxml_dumper.cpp',
   'opds_dumper.cpp',
-  'html_dumper.cpp',
-  'library_dumper.cpp',
   'downloader.cpp',
   'server.cpp',
   'search_renderer.cpp',
@@ -17,8 +15,6 @@ kiwix_sources = [
   'tools/regexTools.cpp',
   'tools/stringTools.cpp',
   'tools/networkTools.cpp',
-  'tools/opdsParsingTools.cpp',
-  'tools/languageTools.cpp',
   'tools/otherTools.cpp',
   'tools/archiveTools.cpp',
   'kiwixserve.cpp',
@@ -28,10 +24,9 @@ kiwix_sources = [
   'server/request_context.cpp',
   'server/response.cpp',
   'server/internalServer.cpp',
-  'server/internalServer_catalog.cpp',
+  'server/internalServer_catalog_v2.cpp',
   'server/i18n.cpp',
   'opds_catalog.cpp',
-  'spelling_correction.cpp',
   'version.cpp'
 ]
 kiwix_sources += lib_resources

src/name_mapper.cpp

@@ -24,34 +24,30 @@
 
 namespace kiwix {
 
-HumanReadableNameMapper::HumanReadableNameMapper(const kiwix::Library& library, bool withAlias) {
-  for (auto& bookId: library.filter(kiwix::Filter())) {
+HumanReadableNameMapper::HumanReadableNameMapper(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();
     m_idToName[bookId] = bookName;
-    mapName(library, bookName, bookId);
+    m_nameToId[bookName] = bookId;
 
     if (!withAlias)
       continue;
 
     auto aliasName = replaceRegex(bookName, "", "_[[:digit:]]{4}-[[:digit:]]{2}$");
-    if (aliasName != bookName) {
-      mapName(library, aliasName, bookId);
+    if (aliasName == bookName) {
+      continue;
+    }
+    if (m_nameToId.find(aliasName) == m_nameToId.end()) {
+      m_nameToId[aliasName] = bookId;
+    } else {
+      auto alreadyPresentPath = library.getBookById(m_nameToId[aliasName]).getPath();
+      std::cerr << "Path collision: " << alreadyPresentPath
+                << " and " << currentBook.getPath()
+                << " can't share the same URL path '" << aliasName << "'."
+                << " Therefore, only " << alreadyPresentPath
+                << " will be served." << std::endl;
     }
-  }
-}
-
-void HumanReadableNameMapper::mapName(const Library& library, std::string name, std::string bookId) {
-  if (m_nameToId.find(name) == m_nameToId.end()) {
-    m_nameToId[name] = bookId;
-  } else {
-    const auto& currentBook = library.getBookById(bookId);
-    auto alreadyPresentPath = library.getBookById(m_nameToId[name]).getPath();
-    std::cerr << "Path collision: '" << alreadyPresentPath
-              << "' and '" << currentBook.getPath()
-              << "' can't share the same URL path '" << name << "'."
-              << " Therefore, only '" << alreadyPresentPath
-              << "' will be served." << std::endl;
   }
 }
 
@@ -67,7 +63,7 @@ std::string HumanReadableNameMapper::getIdForName(const std::string& name) const
 // UpdatableNameMapper
 ////////////////////////////////////////////////////////////////////////////////
 
-UpdatableNameMapper::UpdatableNameMapper(LibraryPtr lib, bool withAlias)
+UpdatableNameMapper::UpdatableNameMapper(Library& lib, bool withAlias)
   : library(lib)
   , withAlias(withAlias)
 {
@@ -76,7 +72,7 @@ UpdatableNameMapper::UpdatableNameMapper(LibraryPtr 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

@@ -30,8 +30,9 @@ namespace kiwix
 {
 
 /* Constructor */
-OPDSDumper::OPDSDumper(const Library* library, const NameMapper* nameMapper)
-  : LibraryDumper(library, nameMapper)
+OPDSDumper::OPDSDumper(Library* library, NameMapper* nameMapper)
+  : library(library),
+    nameMapper(nameMapper)
 {
 }
 /* Destructor */
@@ -39,6 +40,13 @@ OPDSDumper::~OPDSDumper()
 {
 }
 
+void OPDSDumper::setOpenSearchInfo(int totalResults, int startIndex, int count)
+{
+  m_totalResults = totalResults;
+  m_startIndex = startIndex,
+  m_count = count;
+}
+
 namespace
 {
 
@@ -51,31 +59,29 @@ typedef kainjow::mustache::list IllustrationInfo;
 IllustrationInfo getBookIllustrationInfo(const Book& book)
 {
     kainjow::mustache::list illustrations;
-    for ( const auto& illustration : book.getIllustrations() ) {
-      // For now, we are handling only sizexsize@1 illustration.
-      // So we can simply pass one size to mustache.
-      illustrations.push_back(kainjow::mustache::object{
-        {"icon_size", to_string(illustration->width)},
-        {"icon_mimetype", illustration->mimeType}
-      });
+    if ( book.isPathValid() ) {
+      for ( const auto& illustration : book.getIllustrations() ) {
+        // For now, we are handling only sizexsize@1 illustration.
+        // So we can simply pass one size to mustache.
+        illustrations.push_back(kainjow::mustache::object{
+          {"icon_size", to_string(illustration->width)},
+          {"icon_mimetype", illustration->mimeType}
+        });
+      }
     }
     return illustrations;
 }
 
-std::string fullEntryXML(const Book& book,
-                         const std::string& rootLocation,
-                         const std::string& contentAccessUrl,
-                         const std::string& contentId)
+std::string fullEntryXML(const Book& book, const std::string& rootLocation, const std::string& contentId)
 {
     const auto bookDate = book.getDate() + "T00:00:00Z";
     const kainjow::mustache::object data{
       {"root",  rootLocation},
-      {"contentAccessUrl",  onlyAsNonEmptyMustacheValue(contentAccessUrl)},
       {"id", book.getId()},
       {"name", book.getName()},
       {"title", book.getTitle()},
       {"description", book.getDescription()},
-      {"language", book.getCommaSeparatedLanguages()},
+      {"language", book.getLanguage()},
       {"content_id",  urlEncode(contentId)},
       {"updated", bookDate}, // XXX: this should be the entry update datetime
       {"book_date", bookDate},
@@ -107,12 +113,7 @@ std::string partialEntryXML(const Book& book, const std::string& rootLocation)
     return render_template(xmlTemplate, data);
 }
 
-BooksData getBooksData(const Library* library,
-                       const NameMapper* nameMapper,
-                       const std::vector<std::string>& bookIds,
-                       const std::string& rootLocation,
-                       const std::string& contentAccessUrl,
-                       bool partial)
+BooksData getBooksData(const Library* library, const NameMapper* nameMapper, const std::vector<std::string>& bookIds, const std::string& rootLocation, bool partial)
 {
   BooksData booksData;
   for ( const auto& bookId : bookIds ) {
@@ -121,7 +122,7 @@ BooksData getBooksData(const Library* library,
       const std::string contentId = nameMapper->getNameForId(bookId);
       const auto entryXML = partial
                           ? partialEntryXML(book, rootLocation)
-                          : fullEntryXML(book, rootLocation, contentAccessUrl, contentId);
+                          : fullEntryXML(book, rootLocation, contentId);
       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
@@ -132,11 +133,64 @@ BooksData getBooksData(const Library* library,
   return booksData;
 }
 
+std::map<std::string, std::string> iso639_3 = {
+  {"atj", "atikamekw"},
+  {"azb", "آذربایجان دیلی"},
+  {"bcl", "central bikol"},
+  {"bgs", "tagabawa"},
+  {"bxr", "буряад хэлэн"},
+  {"cbk", "chavacano"},
+  {"cdo", "閩東語"},
+  {"dag", "Dagbani"},
+  {"diq", "dimli"},
+  {"dty", "डोटेली"},
+  {"eml", "emiliân-rumagnōl"},
+  {"fbs", "српскохрватски"},
+  {"ido", "ido"},
+  {"kbp", "kabɩyɛ"},
+  {"kld", "Gamilaraay"},
+  {"lbe", "лакку маз"},
+  {"lbj", "ལ་དྭགས་སྐད་"},
+  {"map", "Austronesian"},
+  {"mhr", "марий йылме"},
+  {"mnw", "ဘာသာမန်"},
+  {"myn", "mayan"},
+  {"nah", "nahuatl"},
+  {"nai", "north American Indian"},
+  {"nds", "plattdütsch"},
+  {"nrm", "bhasa narom"},
+  {"olo", "livvi"},
+  {"pih", "Pitcairn-Norfolk"},
+  {"pnb", "Western Panjabi"},
+  {"rmr", "Caló"},
+  {"rmy", "romani shib"},
+  {"roa", "romance languages"},
+  {"twi", "twi"}
+};
+
+std::once_flag fillLanguagesFlag;
+
+void fillLanguagesMap()
+{
+  for (auto icuLangPtr = icu::Locale::getISOLanguages(); *icuLangPtr != NULL; ++icuLangPtr) {
+    const ICULanguageInfo lang(*icuLangPtr);
+    iso639_3.insert({lang.iso3Code(), lang.selfName()});
+  }
+}
+
+std::string getLanguageSelfName(const std::string& lang) {
+  const auto itr = iso639_3.find(lang);
+  if (itr != iso639_3.end()) {
+    return itr->second;
+  }
+  return lang;
+};
+
 } // unnamed namespace
 
 string OPDSDumper::dumpOPDSFeed(const std::vector<std::string>& bookIds, const std::string& query) const
 {
-  const auto booksData = getBooksData(library, nameMapper, bookIds, rootLocation, contentAccessUrl, false);
+  const auto booksData = getBooksData(library, nameMapper, bookIds, rootLocation, false);
   const kainjow::mustache::object template_data{
      {"date", gen_date_str()},
      {"root", rootLocation},
@@ -154,20 +208,20 @@ 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, nameMapper, bookIds, rootLocation, contentAccessUrl, partial);
+  const auto booksData = getBooksData(library, nameMapper, bookIds, rootLocation, partial);
 
   const char* const endpoint = partial ? "/partial_entries" : "/entries";
-  const std::string url = endpoint + (query.empty() ? "" : "?" + query);
   const kainjow::mustache::object template_data{
      {"date", gen_date_str()},
      {"endpoint_root", endpointRoot},
      {"feed_id", gen_uuid(libraryId + endpoint + "?" + query)},
      {"filter", onlyAsNonEmptyMustacheValue(query)},
-     {"self_url", url},
+     {"query", query.empty() ? "" : "?" + query},
      {"totalResults", to_string(m_totalResults)},
      {"startIndex", to_string(m_startIndex)},
      {"itemsPerPage", to_string(m_count)},
-     {"books", booksData }
+     {"books", booksData },
+     {"dump_partial_entries", MustacheData(partial)}
   };
 
   return render_template(RESOURCE::templates::catalog_v2_entries_xml, template_data);
@@ -179,13 +233,23 @@ std::string OPDSDumper::dumpOPDSCompleteEntry(const std::string& bookId) const
   const std::string contentId = nameMapper->getNameForId(bookId);
   return XML_HEADER
          + "\n"
-         + fullEntryXML(book, rootLocation, contentAccessUrl, contentId);
+         + fullEntryXML(book, rootLocation, contentId);
 }
 
 std::string OPDSDumper::categoriesOPDSFeed() const
 {
   const auto now = gen_date_str();
-  kainjow::mustache::list categoryData = getCategoryData();
+  kainjow::mustache::list categoryData;
+  for ( const auto& category : library->getBooksCategories() ) {
+    const auto urlencodedCategoryName = urlEncode(category);
+    categoryData.push_back(kainjow::mustache::object{
+      {"name", category},
+      {"urlencoded_name",  urlencodedCategoryName},
+      {"updated", now},
+      {"id", gen_uuid(libraryId + "/categories/" + urlencodedCategoryName)}
+    });
+  }
+
   return render_template(
              RESOURCE::templates::catalog_v2_categories_xml,
              kainjow::mustache::object{
@@ -200,7 +264,21 @@ std::string OPDSDumper::categoriesOPDSFeed() const
 std::string OPDSDumper::languagesOPDSFeed() const
 {
   const auto now = gen_date_str();
-  kainjow::mustache::list languageData = getLanguageData();
+  kainjow::mustache::list languageData;
+  std::call_once(fillLanguagesFlag, fillLanguagesMap);
+  for ( const auto& langAndBookCount : library->getBooksLanguagesWithCounts() ) {
+    const std::string languageCode = langAndBookCount.first;
+    const int bookCount = langAndBookCount.second;
+    const auto languageSelfName = getLanguageSelfName(languageCode);
+    languageData.push_back(kainjow::mustache::object{
+      {"lang_code",  languageCode},
+      {"lang_self_name", languageSelfName},
+      {"book_count", to_string(bookCount)},
+      {"updated", now},
+      {"id", gen_uuid(libraryId + "/languages/" + languageCode)}
+    });
+  }
+
   return render_template(
              RESOURCE::templates::catalog_v2_languages_xml,
              kainjow::mustache::object{

src/search_renderer.cpp

@@ -32,46 +32,20 @@
 #include "libkiwix-resources.h"
 #include "tools/stringTools.h"
 
-#include "server/i18n_utils.h"
-
 namespace kiwix
 {
 
-namespace
-{
-
-ParameterizedMessage searchResultsPageTitleMsg(const std::string& searchPattern)
-{
-  return ParameterizedMessage("search-results-page-title",
-                              {{"SEARCH_PATTERN", searchPattern}}
-  );
-}
-
-ParameterizedMessage searchResultsPageHeaderMsg(const std::string& searchPattern,
-                                                const kainjow::mustache::data& r)
-{
-  if ( r.get("count")->string_value() == "0" ) {
-    return ParameterizedMessage("empty-search-results-page-header",
-                                {{"SEARCH_PATTERN", searchPattern}}
-    );
-  } else {
-    return ParameterizedMessage("search-results-page-header",
-                                {
-                                  {"SEARCH_PATTERN", searchPattern},
-                                  {"START", r.get("startLabel")->string_value()},
-                                  {"END",   r.get("end")  ->string_value()},
-                                  {"COUNT", r.get("count")->string_value()},
-                                }
-    );
-  }
-}
-
-} // unnamed namespace
-
 /* Constructor */
-SearchRenderer::SearchRenderer(zim::SearchResultSet srs,
+SearchRenderer::SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper,
+                      unsigned int start, unsigned int estimatedResultCount)
+    : SearchRenderer(srs, mapper, nullptr, start, estimatedResultCount)
+{}
+
+SearchRenderer::SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper, Library* library,
                       unsigned int start, unsigned int estimatedResultCount)
     : m_srs(srs),
+      mp_nameMapper(mapper),
+      mp_library(library),
       protocolPrefix("zim://"),
       searchProtocolPrefix("search://"),
       estimatedResultCount(estimatedResultCount),
@@ -190,7 +164,7 @@ kainjow::mustache::data buildPagination(
   return pagination;
 }
 
-std::string SearchRenderer::renderTemplate(const std::string& tmpl_str, const NameMapper& nameMapper, const Library* library)
+std::string SearchRenderer::renderTemplate(const std::string& tmpl_str)
 {
   const std::string absPathPrefix = protocolPrefix;
   // Build the results list
@@ -198,25 +172,15 @@ std::string SearchRenderer::renderTemplate(const std::string& tmpl_str, const Na
   for (auto it = m_srs.begin(); it != m_srs.end(); it++) {
     kainjow::mustache::data result;
     const std::string zim_id(it.getZimId());
-    const auto path = nameMapper.getNameForId(zim_id) + "/" + it.getPath();
+    const auto path = mp_nameMapper->getNameForId(zim_id) + "/" + it.getPath();
     result.set("title", it.getTitle());
     result.set("absolutePath", absPathPrefix + urlEncode(path));
     result.set("snippet", it.getSnippet());
-    if (library) {
-      const std::string bookTitle = library->getBookById(zim_id).getTitle();
-      const ParameterizedMessage bookInfoMsg("search-result-book-info",
-          {{"BOOK_TITLE", bookTitle}}
-      );
-      result.set("bookInfo",  bookInfoMsg.getText(userlang)); // for HTML
-      result.set("bookTitle", bookTitle); // for XML
+    if (mp_library) {
+      result.set("bookTitle", mp_library->getBookById(zim_id).getTitle());
     }
     if (it.getWordCount() >= 0) {
-      const auto wordCountStr = kiwix::beautifyInteger(it.getWordCount());
-      const ParameterizedMessage wordCountMsg("word-count",
-          {{"COUNT", wordCountStr}}
-      );
-      result.set("wordCountInfo", wordCountMsg.getText(userlang)); // for HTML
-      result.set("wordCount", wordCountStr); // for XML
+      result.set("wordCount", kiwix::beautifyInteger(it.getWordCount()));
     }
 
     items.push_back(result);
@@ -224,9 +188,9 @@ std::string SearchRenderer::renderTemplate(const std::string& tmpl_str, const Na
   kainjow::mustache::data results;
   results.set("items", items);
   results.set("count", kiwix::beautifyInteger(estimatedResultCount));
+  results.set("hasResults", estimatedResultCount != 0);
   results.set("start", kiwix::beautifyInteger(resultStart));
-  results.set("startLabel", kiwix::beautifyInteger(resultStart+1));
-  results.set("end", kiwix::beautifyInteger(std::min(resultStart+pageLength, estimatedResultCount)));
+  results.set("end", kiwix::beautifyInteger(std::min(resultStart+pageLength-1, estimatedResultCount)));
 
   // pagination
   auto pagination = buildPagination(
@@ -241,15 +205,12 @@ std::string SearchRenderer::renderTemplate(const std::string& tmpl_str, const Na
     searchBookQuery
   );
 
-  const auto pageHeaderMsg = searchResultsPageHeaderMsg(searchPattern, results);
-  const kainjow::mustache::object allData{
-    {"PAGE_TITLE", searchResultsPageTitleMsg(searchPattern).getText(userlang)},
-    {"PAGE_HEADER", pageHeaderMsg.getText(userlang)},
-    {"searchProtocolPrefix", searchProtocolPrefix},
-    {"results", results},
-    {"pagination", pagination},
-    {"query", query},
-  };
+
+  kainjow::mustache::data allData;
+  allData.set("searchProtocolPrefix", searchProtocolPrefix);
+  allData.set("results", results);
+  allData.set("pagination", pagination);
+  allData.set("query", query);
 
   kainjow::mustache::mustache tmpl(tmpl_str);
 
@@ -261,14 +222,14 @@ std::string SearchRenderer::renderTemplate(const std::string& tmpl_str, const Na
   return ss.str();
 }
 
-std::string SearchRenderer::getHtml(const NameMapper& mapper, const Library* library)
+std::string SearchRenderer::getHtml()
 {
-  return renderTemplate(RESOURCE::templates::search_result_html, mapper, library);
+  return renderTemplate(RESOURCE::templates::search_result_html);
 }
 
-std::string SearchRenderer::getXml(const NameMapper& mapper, const Library* library)
+std::string SearchRenderer::getXml()
 {
-  return renderTemplate(RESOURCE::templates::search_result_xml, mapper, library);
+  return renderTemplate(RESOURCE::templates::search_result_xml);
 }
 
 

src/server.cpp

@@ -29,23 +29,7 @@
 
 namespace kiwix {
 
-namespace
-{
-
-std::string makeServerUrl(std::string host, int port, std::string root)
-{
-  const int httpDefaultPort = 80;
-
-  if (port == httpDefaultPort) {
-    return "http://" + host + root;
-  } else {
-    return "http://" + host + ":" + std::to_string(port) + root;
-  }
-}
-
-}  // unnamed namespace
-
-Server::Server(LibraryPtr library, std::shared_ptr<NameMapper> nameMapper) :
+Server::Server(Library* library, NameMapper* nameMapper) :
   mp_library(library),
   mp_nameMapper(nameMapper),
   mp_server(nullptr)
@@ -67,18 +51,9 @@ bool Server::start() {
     m_withTaskbar,
     m_withLibraryButton,
     m_blockExternalLinks,
-    m_ipMode,
     m_indexTemplateString,
-    m_ipConnectionLimit,
-    m_catalogOnlyMode,
-    m_contentServerUrl));
-  if (mp_server->start()) {
-    // this syncs m_addr of InternalServer and Server as they may diverge
-    m_addr = mp_server->getAddress();
-    return true;
-  } else {
-    return false;
-  }
+    m_ipConnectionLimit));
+  return mp_server->start();
 }
 
 void Server::stop() {
@@ -91,53 +66,22 @@ void Server::stop() {
 void Server::setRoot(const std::string& root)
 {
   m_root = root;
-  while (!m_root.empty() && m_root.back() == '/')
-    m_root.pop_back();
-
-  while (!m_root.empty() && m_root.front() == '/')
-    m_root = m_root.substr(1);
-  m_root = m_root.empty() ? m_root : "/" + m_root;
-}
-
-void Server::setAddress(const std::string& addr)
-{
-  m_addr.addr.clear();
-  m_addr.addr6.clear();
-
-  if (addr.empty()) return;
-
-  if (addr.find(':') != std::string::npos) { // IPv6
-    m_addr.addr6 = (addr[0] == '[') ? addr.substr(1, addr.length() - 2) : addr; // Remove brackets if any
-  } else {
-    m_addr.addr = addr;
+  if (m_root[0] != '/') {
+    m_root = "/" + m_root;
+  }
+  if (m_root.back() == '/') {
+    m_root.erase(m_root.size() - 1);
   }
 }
 
-int Server::getPort() const
+int Server::getPort()
 {
-  return m_port;
+  return mp_server->getPort();
 }
 
-IpAddress Server::getAddress() const
+std::string Server::getAddress()
 {
-  return m_addr;
-}
-
-IpMode Server::getIpMode() const
-{
-  return mp_server->getIpMode();
-}
-
-std::vector<std::string> Server::getServerAccessUrls() const
-{
-  std::vector<std::string> result;
-  if (!m_addr.addr.empty()) {
-    result.push_back(makeServerUrl(m_addr.addr, m_port, m_root));
-  }
-  if (!m_addr.addr6.empty()) {
-    result.push_back(makeServerUrl("[" + m_addr.addr6 + "]", m_port, m_root));
-  }
-  return result;
+  return mp_server->getAddress();
 }
 
 }

src/server/i18n.cpp

@@ -17,7 +17,7 @@
  * MA 02110-1301, USA.
  */
 
-#include "i18n_utils.h"
+#include "i18n.h"
 
 #include "tools/otherTools.h"
 
@@ -112,12 +112,8 @@ std::string expandParameterizedString(const std::string& lang,
                                       const std::string& key,
                                       const Parameters& params)
 {
-  kainjow::mustache::object mustacheParams;
-  for( const auto& kv : params ) {
-    mustacheParams[kv.first] = kv.second;
-  }
   const std::string tmpl = getTranslatedString(lang, key);
-  return render_template(tmpl, mustacheParams);
+  return render_template(tmpl, params);
 }
 
 } // namespace i18n
@@ -193,13 +189,4 @@ std::string selectMostSuitableLanguage(const UserLangPreferences& prefs)
   return bestLangSoFar;
 }
 
-std::string translateBookCategory(const std::string& lang, const std::string& category)
-{
-    try {
-        return getTranslatedString(lang, "book-category." + category);
-    } catch (...) {
-        return category;
-    }
-}
-
 } // namespace kiwix

src/server/i18n.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 Veloman Yunkan <veloman.yunkan@gmail.com>
+ * Copyright 2022 Veloman Yunkan <veloman.yunkan@gmail.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU  General Public License as published by
@@ -17,21 +17,34 @@
  * MA 02110-1301, USA.
  */
 
-#ifndef KIWIX_I18N
-#define KIWIX_I18N
+#ifndef KIWIX_SERVER_I18N
+#define KIWIX_SERVER_I18N
 
-#include <map>
 #include <string>
+#include <mustache.hpp>
 
 namespace kiwix
 {
 
+struct I18nString {
+  const char* const key;
+  const char* const value;
+};
+
+struct I18nStringTable {
+  const char* const lang;
+  const size_t entryCount;
+  const I18nString* const entries;
+
+  const char* get(const std::string& key) const;
+};
+
 std::string getTranslatedString(const std::string& lang, const std::string& key);
 
 namespace i18n
 {
 
-typedef std::map<std::string, std::string> Parameters;
+typedef kainjow::mustache::object Parameters;
 
 std::string expandParameterizedString(const std::string& lang,
                                       const std::string& key,
@@ -58,10 +71,10 @@ private:
 
 } // namespace i18n
 
-class ParameterizedMessage
+struct ParameterizedMessage
 {
 public: // types
-  typedef i18n::Parameters Parameters;
+  typedef kainjow::mustache::object Parameters;
 
 public: // functions
   ParameterizedMessage(const std::string& msgId, const Parameters& params)
@@ -71,22 +84,23 @@ public: // functions
 
   std::string getText(const std::string& lang) const;
 
-  const std::string& getMsgId()  const { return msgId; }
-  const Parameters&  getParams() const { return params; }
-
 private: // data
   const std::string msgId;
   const Parameters  params;
 };
 
-inline ParameterizedMessage nonParameterizedMessage(const std::string& msgId)
+struct LangPreference
 {
-  const ParameterizedMessage::Parameters noParams;
-  return ParameterizedMessage(msgId, noParams);
-}
+  const std::string lang;
+  const float preference;
+};
 
-std::string translateBookCategory(const std::string& lang, const std::string& category);
+typedef std::vector<LangPreference> UserLangPreferences;
+
+UserLangPreferences parseUserLanguagePreferences(const std::string& s);
+
+std::string selectMostSuitableLanguage(const UserLangPreferences& prefs);
 
 } // namespace kiwix
 
-#endif // KIWIX_I18N
+#endif // KIWIX_SERVER_I18N

src/server/i18n_utils.h

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

src/server/internalServer.cpp

@@ -19,7 +19,7 @@
 
 #include "internalServer.h"
 
-#ifndef _WIN32
+#ifdef __FreeBSD__
 #include <netinet/in.h>
 #endif
 
@@ -53,8 +53,7 @@ extern "C" {
 #include "name_mapper.h"
 #include "search_renderer.h"
 #include "opds_dumper.h"
-#include "html_dumper.h"
-#include "i18n_utils.h"
+#include "i18n.h"
 
 #include <zim/uuid.h>
 #include <zim/error.h>
@@ -85,42 +84,19 @@ namespace kiwix {
 namespace
 {
 
-bool ipAvailable(const std::string addr)
+inline std::string normalizeRootUrl(std::string rootUrl)
 {
-  auto interfaces = kiwix::getNetworkInterfacesIPv4Or6();
+  while ( !rootUrl.empty() && rootUrl.back() == '/' )
+    rootUrl.pop_back();
 
-  for (const auto& kv : interfaces) {
-    const auto& interfaceIps = kv.second;
-    if ((interfaceIps.addr == addr) || (interfaceIps.addr6 == addr)) {
-      return true;
-    }
-  }
-
-  return false;
+  while ( !rootUrl.empty() && rootUrl.front() == '/' )
+    rootUrl = rootUrl.substr(1);
+  return rootUrl.empty() ? rootUrl : "/" + rootUrl;
 }
 
-std::string
-fullURL2LocalURL(const std::string& fullUrl, const std::string& rootLocation)
+Filter get_search_filter(const RequestContext& request, const std::string& prefix="")
 {
-  if ( kiwix::startsWith(fullUrl, rootLocation) ) {
-    return fullUrl.substr(rootLocation.size());
-  } else {
-    return "INVALID URL";
-  }
-}
-
-std::string getSearchComponent(const RequestContext& request)
-{
-    const std::string query = request.get_query();
-    return query.empty() ? query : "?" + query;
-}
-
-Filter get_search_filter(const RequestContext& request, const std::string& prefix="", bool catalogOnlyMode = false)
-{
-    auto filter = kiwix::Filter();
-    if ( !catalogOnlyMode ) {
-      filter.valid(true).local(true);
-    }
+    auto filter = kiwix::Filter().valid(true).local(true);
     try {
       filter.query(request.get_argument(prefix+"q"));
     } catch (const std::out_of_range&) {}
@@ -197,6 +173,12 @@ ParameterizedMessage tooManyBooksMsg(size_t nbBooks, size_t limit)
   );
 }
 
+ParameterizedMessage nonParameterizedMessage(const std::string& msgId)
+{
+  const ParameterizedMessage::Parameters noParams;
+  return ParameterizedMessage(msgId, noParams);
+}
+
 struct Error : public std::runtime_error {
   explicit Error(const ParameterizedMessage& message)
     : std::runtime_error("Error while handling request"),
@@ -225,8 +207,7 @@ typedef std::set<std::string> Languages;
 Languages getLanguages(const Library& lib, const Library::BookIdSet& bookIds) {
   Languages langs;
   for ( const auto& b : bookIds ) {
-    const auto bookLangs = lib.getBookById(b).getLanguages();
-    langs.insert(bookLangs.begin(), bookLangs.end());
+    langs.insert(lib.getBookById(b).getLanguage());
   }
   return langs;
 }
@@ -255,11 +236,6 @@ get_matching_if_none_match_etag(const RequestContext& r, const std::string& etag
   }
 }
 
-struct NoDelete
-{
-  template<class T> void operator()(T*) {}
-};
-
 } // unnamed namespace
 
 std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const RequestContext& request) const
@@ -269,7 +245,7 @@ std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const Req
     auto bookName = request.get_argument("content");
     try {
       const auto bookIds = Library::BookIdSet{mp_nameMapper->getIdForName(bookName)};
-      const auto queryString = request.get_query([&](const std::string& key){return key == "content";}, true);
+      const auto queryString = request.get_query([&](const std::string& key){return key == "content";});
       return {queryString, bookIds};
     } catch (const std::out_of_range&) {
       throw Error(noSuchBookErrorMsg(bookName));
@@ -294,7 +270,7 @@ std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const Req
       }
     }
     const auto bookIds = Library::BookIdSet(id_vec.begin(), id_vec.end());
-    const auto queryString = request.get_query([&](const std::string& key){return key == "books.id";}, true);
+    const auto queryString = request.get_query([&](const std::string& key){return key == "books.id";});
     return {queryString, bookIds};
   } catch(const std::out_of_range&) {}
 
@@ -312,7 +288,7 @@ std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const Req
         throw Error(noSuchBookErrorMsg(bookName));
       }
     }
-    const auto queryString = request.get_query([&](const std::string& key){return key == "books.name";}, true);
+    const auto queryString = request.get_query([&](const std::string& key){return key == "books.name";});
     return {queryString, bookIds};
   } catch(const std::out_of_range&) {}
 
@@ -323,7 +299,7 @@ std::pair<std::string, Library::BookIdSet> InternalServer::selectBooks(const Req
     throw Error(nonParameterizedMessage("no-book-found"));
   }
   const auto bookIds = Library::BookIdSet(id_vec.begin(), id_vec.end());
-  const auto queryString = request.get_query([&](const std::string& key){return startsWith(key, "books.filter.");}, true);
+  const auto queryString = request.get_query([&](const std::string& key){return startsWith(key, "books.filter.");});
   return {queryString, bookIds};
 }
 
@@ -412,9 +388,9 @@ public:
 };
 
 
-InternalServer::InternalServer(LibraryPtr library,
-                               std::shared_ptr<NameMapper> nameMapper,
-                               IpAddress addr,
+InternalServer::InternalServer(Library* library,
+                               NameMapper* nameMapper,
+                               std::string addr,
                                int port,
                                std::string root,
                                int nbThreads,
@@ -423,35 +399,26 @@ InternalServer::InternalServer(LibraryPtr library,
                                bool withTaskbar,
                                bool withLibraryButton,
                                bool blockExternalLinks,
-                               IpMode ipMode,
                                std::string indexTemplateString,
-                               int ipConnectionLimit,
-                               bool catalogOnlyMode,
-                               std::string contentServerUrl) :
+                               int ipConnectionLimit) :
   m_addr(addr),
   m_port(port),
-  m_root(root),
-  m_rootPrefixOfDecodedURL(m_root),
+  m_root(normalizeRootUrl(root)),
   m_nbThreads(nbThreads),
   m_multizimSearchLimit(multizimSearchLimit),
   m_verbose(verbose),
   m_withTaskbar(withTaskbar),
   m_withLibraryButton(withLibraryButton),
   m_blockExternalLinks(blockExternalLinks),
-  m_ipMode(ipMode),
   m_indexTemplateString(indexTemplateString.empty() ? RESOURCE::templates::index_html : indexTemplateString),
   m_ipConnectionLimit(ipConnectionLimit),
   mp_daemon(nullptr),
   mp_library(library),
-  mp_nameMapper(nameMapper ? nameMapper : std::shared_ptr<NameMapper>(&defaultNameMapper, NoDelete())),
+  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))),
-  m_customizedResources(new CustomizedResources),
-  m_catalogOnlyMode(catalogOnlyMode),
-  m_contentServerUrl(contentServerUrl)
-{
-  m_root = urlEncode(m_root);
-}
+  m_customizedResources(new CustomizedResources)
+{}
 
 InternalServer::~InternalServer() = default;
 
@@ -464,62 +431,28 @@ bool InternalServer::start() {
   if (m_verbose.load())
     flags |= MHD_USE_DEBUG;
 
-
-  struct sockaddr_in sockAddr4={0};
-  sockAddr4.sin_family = AF_INET;
-  sockAddr4.sin_port = htons(m_port);
-  struct sockaddr_in6 sockAddr6={0};
-  sockAddr6.sin6_family = AF_INET6;
-  sockAddr6.sin6_port = htons(m_port);
-
-  if (m_addr.addr.empty() && m_addr.addr6.empty()) { // No ip address provided
-    if (m_ipMode == IpMode::AUTO) m_ipMode = IpMode::ALL;
-    sockAddr6.sin6_addr = in6addr_any;
-    sockAddr4.sin_addr.s_addr = htonl(INADDR_ANY);
-    IpAddress bestIps = kiwix::getBestPublicIps();
-    if (m_ipMode == IpMode::IPV4 || m_ipMode == IpMode::ALL) m_addr.addr = bestIps.addr;
-    if (m_ipMode == IpMode::IPV6 || m_ipMode == IpMode::ALL) m_addr.addr6 = bestIps.addr6;
+  struct sockaddr_in sockAddr;
+  memset(&sockAddr, 0, sizeof(sockAddr));
+  sockAddr.sin_family = AF_INET;
+  sockAddr.sin_port = htons(m_port);
+  if (m_addr.empty()) {
+    if (0 != INADDR_ANY) {
+      sockAddr.sin_addr.s_addr = htonl(INADDR_ANY);
+    }
+    m_addr = kiwix::getBestPublicIp();
   } else {
-    const std::string addr = !m_addr.addr.empty() ? m_addr.addr : m_addr.addr6;
-
-    if (m_ipMode != kiwix::IpMode::AUTO) {
-      std::cerr << "ERROR: When an IP address is provided the IP mode must not be set" << std::endl;
+    if (inet_pton(AF_INET, m_addr.c_str(), &(sockAddr.sin_addr.s_addr)) == 0) {
+      std::cerr << "Ip address " << m_addr << "  is not a valid ip address" << std::endl;
       return false;
     }
-
-    bool validV4 = inet_pton(AF_INET, m_addr.addr.c_str(), &(sockAddr4.sin_addr.s_addr)) == 1;
-    bool validV6 = inet_pton(AF_INET6, m_addr.addr6.c_str(), &(sockAddr6.sin6_addr.s6_addr)) == 1;
-
-    if (!validV4 && !validV6) {
-      std::cerr << "ERROR: invalid IP address: " << addr << std::endl;
-      return false;
-    }
-
-    if (!ipAvailable(addr)) {
-      std::cerr << "ERROR: IP address is not available on this system: " << addr << std::endl;
-      return false;
-    }
-
-    m_ipMode = !m_addr.addr.empty() ? IpMode::IPV4 : IpMode::IPV6;
   }
-
-  if (m_ipMode == IpMode::ALL) {
-    flags|=MHD_USE_DUAL_STACK;
-  } else if (m_ipMode == IpMode::IPV6) {
-    flags|=MHD_USE_IPv6;
-  }
-
-  struct sockaddr* sockaddr = (m_ipMode==IpMode::ALL || m_ipMode==IpMode::IPV6)
-                              ? (struct sockaddr*)&sockAddr6
-                              : (struct sockaddr*)&sockAddr4;
-
   mp_daemon = MHD_start_daemon(flags,
                             m_port,
                             NULL,
                             NULL,
                             &staticHandlerCallback,
                             this,
-                            MHD_OPTION_SOCK_ADDR, sockaddr,
+                            MHD_OPTION_SOCK_ADDR, &sockAddr,
                             MHD_OPTION_THREAD_POOL_SIZE, m_nbThreads,
                             MHD_OPTION_PER_IP_CONNECTION_LIMIT, m_ipConnectionLimit,
                             MHD_OPTION_END);
@@ -560,21 +493,8 @@ static MHD_Result staticHandlerCallback(void* cls,
                                 cont_cls);
 }
 
-namespace
-{
-
-MHD_Result add_name_value_pair(void *nvp, enum MHD_ValueKind kind,
-                               const char *key, const char *value)
-{
-  auto& nameValuePairs = *reinterpret_cast<RequestContext::NameValuePairs*>(nvp);
-  nameValuePairs.push_back({key, value});
-  return MHD_YES;
-}
-
-} // unnamed namespace
-
 MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
-                                           const char* fullUrl,
+                                           const char* url,
                                            const char* method,
                                            const char* version,
                                            const char* upload_data,
@@ -585,14 +505,9 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
   if (m_verbose.load() ) {
     printf("======================\n");
     printf("Requesting : \n");
-    printf("full_url  : %s\n", fullUrl);
+    printf("full_url  : %s\n", url);
   }
-
-  const auto url = fullURL2LocalURL(fullUrl, m_rootPrefixOfDecodedURL);
-  RequestContext::NameValuePairs headers, queryArgs;
-  MHD_get_connection_values(connection, MHD_HEADER_KIND, add_name_value_pair, &headers);
-  MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND, add_name_value_pair, &queryArgs);
-  RequestContext request(m_root, url, method, version, headers, queryArgs);
+  RequestContext request(connection, m_root, url, method, version);
 
   if (m_verbose.load() ) {
     request.print_debug_info();
@@ -612,7 +527,7 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
     printf("========== INTERNAL ERROR !! ============\n");
     if (!m_verbose.load()) {
       printf("Requesting : \n");
-      printf("full_url : %s\n", fullUrl);
+      printf("full_url : %s\n", url);
       request.print_debug_info();
     }
   }
@@ -621,7 +536,7 @@ MHD_Result InternalServer::handlerCallback(struct MHD_Connection* connection,
     response->set_etag_body(getLibraryId());
   }
 
-  auto ret = response->send(request, m_verbose.load(), 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()) {
@@ -650,19 +565,13 @@ std::unique_ptr<Response> InternalServer::handle_request(const RequestContext& r
 {
   try {
     if (! request.is_valid_url()) {
-      return UrlNotFoundResponse(request);
-    }
-
-    if ( request.get_url() == "" ) {
-      // Redirect /ROOT_LOCATION to /ROOT_LOCATION/ (note the added slash)
-      // so that relative URLs are resolved correctly
-      const std::string query = getSearchComponent(request);
-      return Response::build_redirect(m_root + "/" + query);
+      return HTTP404Response(*this, request)
+             + urlNotFoundMsg;
     }
 
     const ETag etag = get_matching_if_none_match_etag(request, getLibraryId());
     if ( etag )
-      return Response::build_304(etag);
+      return Response::build_304(*this, etag);
 
     const auto url = request.get_url();
     if ( isLocallyCustomizedResource(url) )
@@ -689,9 +598,6 @@ std::unique_ptr<Response> InternalServer::handle_request(const RequestContext& r
     if (isEndpointUrl(url, "search"))
       return handle_search(request);
 
-    if (isEndpointUrl(url, "nojs"))
-      return handle_no_js(request);
-
     if (isEndpointUrl(url, "suggest"))
      return handle_suggest(request);
 
@@ -701,15 +607,19 @@ std::unique_ptr<Response> InternalServer::handle_request(const RequestContext& r
     if (isEndpointUrl(url, "catch"))
       return handle_catch(request);
 
-    const std::string contentUrl = m_root + "/content" + urlEncode(url);
-    const std::string query = getSearchComponent(request);
-    return Response::build_redirect(contentUrl + query);
+    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(request, m_root, request.get_full_url(), e.what());
+    return HTTP500Response(*this, request)
+         + e.what();
   } catch (...) {
     fprintf(stderr, "===== Unhandled unknown error\n");
-    return HTTP500Response(request, m_root, request.get_full_url());
+    return HTTP500Response(*this, request)
+         + "Unknown error";
   }
 }
 
@@ -722,7 +632,7 @@ MustacheData InternalServer::get_default_data() const
 
 std::unique_ptr<Response> InternalServer::build_homepage(const RequestContext& request)
 {
-  return ContentResponse::build(m_indexTemplateString, get_default_data(), "text/html; charset=utf-8");
+  return ContentResponse::build(*this, m_indexTemplateString, get_default_data(), "text/html; charset=utf-8");
 }
 
 /**
@@ -751,7 +661,8 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
   }
 
   if ( startsWith(request.get_url(), "/suggest/") ) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
   std::string bookName, bookId;
@@ -765,7 +676,7 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
   }
 
   if (archive == nullptr) {
-    return HTTP404Response(request)
+    return HTTP404Response(*this, request)
            + noSuchBookErrorMsg(bookName);
   }
 
@@ -800,7 +711,7 @@ std::unique_ptr<Response> InternalServer::handle_suggest(const RequestContext& r
     results.addFTSearchSuggestion(request.get_user_language(), queryString);
   }
 
-  return ContentResponse::build(results.getJSON(), "application/json; charset=utf-8");
+  return ContentResponse::build(*this, results.getJSON(), "application/json; charset=utf-8");
 }
 
 std::unique_ptr<Response> InternalServer::handle_viewer_settings(const RequestContext& request)
@@ -814,78 +725,7 @@ std::unique_ptr<Response> InternalServer::handle_viewer_settings(const RequestCo
     {"enable_link_blocking", m_blockExternalLinks ? "true" : "false" },
     {"enable_library_button", m_withLibraryButton ? "true" : "false" }
   };
-  return ContentResponse::build(RESOURCE::templates::viewer_settings_js, data, "application/javascript; charset=utf-8");
-}
-
-std::string InternalServer::getNoJSDownloadPageHTML(const std::string& bookId, const std::string& userLang) const
-{
-  const auto book = mp_library->getBookById(bookId);
-  auto bookUrl = kiwix::stripSuffix(book.getUrl(), ".meta4");
-  auto getTranslation = i18n::GetTranslatedStringWithMsgId(userLang);
-  const auto translations = kainjow::mustache::object{
-                            getTranslation("download-links-heading", {{"BOOK_TITLE", book.getTitle()}}),
-                            getTranslation("download-links-title"),
-                            getTranslation("direct-download-link-text"),
-                            getTranslation("hash-download-link-text"),
-                            getTranslation("magnet-link-text"),
-                            getTranslation("torrent-download-link-text")
-  };
-
-  return render_template(
-             RESOURCE::templates::no_js_download_html,
-             kainjow::mustache::object{
-               {"url", bookUrl},
-               {"translations", translations}
-             }
-  );
-}
-
-void InternalServer::setContentAccessUrl(LibraryDumper& libDumper) const
-{
-  if ( !m_contentServerUrl.empty() ) {
-    libDumper.setContentAccessUrl(m_contentServerUrl + "/content");
-  } else if ( !m_catalogOnlyMode ) {
-    libDumper.setContentAccessUrl(m_root + "/content");
-  }
-}
-
-std::unique_ptr<Response> InternalServer::handle_no_js(const RequestContext& request)
-{
-  const auto url = request.get_url();
-  const auto urlParts = kiwix::split(url, "/", true, false);
-  HTMLDumper htmlDumper(mp_library.get(), mp_nameMapper.get());
-  htmlDumper.setRootLocation(m_root);
-  htmlDumper.setLibraryId(getLibraryId());
-  setContentAccessUrl(htmlDumper);
-  auto userLang = request.get_user_language();
-  htmlDumper.setUserLanguage(userLang);
-  std::string content;
-
-  if (urlParts.size() == 1) {
-    auto filter = get_search_filter(request, "", m_catalogOnlyMode);
-    try {
-      if (request.get_argument("category") == "") {
-        filter.clearCategory();
-      }
-    } catch (...) {}
-    try {
-      if (request.get_argument("lang") == "") {
-        filter.clearLang();
-      }
-    } catch (...) {}
-    content = htmlDumper.dumpPlainHTML(filter);
-  } else if ((urlParts.size() == 3) && (urlParts[1] == "download")) {
-    try {
-      const auto bookId = mp_nameMapper->getIdForName(urlParts[2]);
-      content = getNoJSDownloadPageHTML(bookId, userLang);
-    } catch (const std::out_of_range&) {
-      return UrlNotFoundResponse(request);
-    }
-  } else {
-    return UrlNotFoundResponse(request);
-  }
-
-  return ContentResponse::build(content, "text/html; charset=utf-8");
+  return ContentResponse::build(*this, RESOURCE::templates::viewer_settings_js, data, "application/javascript; charset=utf-8");
 }
 
 namespace
@@ -923,12 +763,14 @@ std::unique_ptr<Response> InternalServer::handle_skin(const RequestContext& requ
   try {
     const auto accessType = staticResourceAccessType(request, resourceCacheId);
     auto response = ContentResponse::build(
+        *this,
         getResource(resourceName),
         getMimeTypeForFile(resourceName));
     response->set_kind(accessType);
     return std::move(response);
   } catch (const ResourceNotFound& e) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 }
 
@@ -941,17 +783,20 @@ std::unique_ptr<Response> InternalServer::handle_search(const RequestContext& re
   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 UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
   try {
     return handle_search_request(request);
   } catch (const Error& e) {
-    return HTTP400Response(request)
+    return HTTP400Response(*this, request)
+      + invalidUrlMsg
       + e.message();
   }
 }
@@ -992,12 +837,11 @@ std::unique_ptr<Response> InternalServer::handle_search_request(const RequestCon
   } catch(std::runtime_error& e) {
     // Searcher->search will throw a runtime error if there is no valid xapian database to do the search.
     // (in case of zim file not containing a index)
-    const auto cssUrl = renderUrl(m_root, RESOURCE::templates::url_of_search_results_css_tmpl);
-    HTTPErrorResponse response(request, MHD_HTTP_NOT_FOUND,
+    const auto cssUrl = renderUrl(m_root, RESOURCE::templates::url_of_search_results_css);
+    HTTPErrorResponse response(*this, request, MHD_HTTP_NOT_FOUND,
                                "fulltext-search-unavailable",
                                "404-page-heading",
-                               cssUrl,
-                               /*includeKiwixResponseData=*/true);
+                               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.
@@ -1011,28 +855,21 @@ std::unique_ptr<Response> InternalServer::handle_search_request(const RequestCon
     return response;
   }
 
-  const auto start = max(0u, request.get_optional_param("start", 0u));
+  const auto start = max(1u, request.get_optional_param("start", 1u));
   const auto pageLength = getSearchPageSize(request);
 
   /* Get the results */
-  SearchRenderer renderer(search->getResults(start, pageLength), start,
+  SearchRenderer renderer(search->getResults(start-1, pageLength), mp_nameMapper, mp_library, start,
                           search->getEstimatedMatches());
   renderer.setSearchPattern(searchInfo.pattern);
   renderer.setSearchBookQuery(searchInfo.bookFilterQuery);
   renderer.setProtocolPrefix(m_root + "/content/");
   renderer.setSearchProtocolPrefix(m_root + "/search");
   renderer.setPageLength(pageLength);
-  renderer.setUserLang(request.get_user_language());
   if (request.get_requested_format() == "xml") {
-    return ContentResponse::build(
-      renderer.getXml(*mp_nameMapper, mp_library.get()),
-      "application/rss+xml; charset=utf-8"
-    );
+    return ContentResponse::build(*this, renderer.getXml(), "application/rss+xml; charset=utf-8");
   }
-  auto response = ContentResponse::build(
-    renderer.getHtml(*mp_nameMapper, mp_library.get()),
-    "text/html; 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.
   /*
@@ -1052,7 +889,8 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
   }
 
   if ( startsWith(request.get_url(), "/random/") ) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
   std::string bookName;
@@ -1066,7 +904,7 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
   }
 
   if (archive == nullptr) {
-    return HTTP404Response(request)
+    return HTTP404Response(*this, request)
            + noSuchBookErrorMsg(bookName);
   }
 
@@ -1074,7 +912,7 @@ std::unique_ptr<Response> InternalServer::handle_random(const RequestContext& re
     auto entry = archive->getRandomEntry();
     return build_redirect(bookName, getFinalItem(*archive, entry));
   } catch(zim::EntryNotFound& e) {
-    return HTTP404Response(request)
+    return HTTP404Response(*this, request)
            + nonParameterizedMessage("random-article-failure");
   }
 }
@@ -1087,10 +925,13 @@ std::unique_ptr<Response> InternalServer::handle_captured_external(const Request
   } catch (const std::out_of_range& e) {}
 
   if (source.empty()) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
-  return BlockExternalLinkResponse(request, m_root, source);
+  auto data = get_default_data();
+  data.set("source", source);
+  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)
@@ -1103,19 +944,70 @@ std::unique_ptr<Response> InternalServer::handle_catch(const RequestContext& req
     return handle_captured_external(request);
   }
 
-  return UrlNotFoundResponse(request);
+  return HTTP404Response(*this, request)
+         + urlNotFoundMsg;
+}
+
+std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& request)
+{
+  if (m_verbose.load()) {
+    printf("** running handle_catalog");
+  }
+
+  std::string host;
+  std::string url;
+  try {
+    host = request.get_header("Host");
+    url  = request.get_url_part(1);
+  } catch (const std::out_of_range&) {
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
+  }
+
+  if (url == "v2") {
+    return handle_catalog_v2(request);
+  }
+
+  if (url != "searchdescription.xml" && url != "root.xml" && url != "search") {
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
+  }
+
+  if (url == "searchdescription.xml") {
+    auto response = ContentResponse::build(*this, RESOURCE::opensearchdescription_xml, get_default_data(), "application/opensearchdescription+xml");
+    return std::move(response);
+  }
+
+  zim::Uuid uuid;
+  kiwix::OPDSDumper opdsDumper(mp_library, mp_nameMapper);
+  opdsDumper.setRootLocation(m_root);
+  opdsDumper.setLibraryId(getLibraryId());
+  std::vector<std::string> bookIdsToDump;
+  if (url == "root.xml") {
+    uuid = zim::Uuid::generate(host);
+    bookIdsToDump = mp_library->filter(kiwix::Filter().valid(true).local(true).remote(true));
+  } else if (url == "search") {
+    bookIdsToDump = search_catalog(request, opdsDumper);
+    uuid = zim::Uuid::generate();
+  }
+
+  auto response = ContentResponse::build(
+      *this,
+      opdsDumper.dumpOPDSFeed(bookIdsToDump, request.get_query()),
+      "application/atom+xml; profile=opds-catalog; kind=acquisition; charset=utf-8");
+  return std::move(response);
 }
 
 std::vector<std::string>
 InternalServer::search_catalog(const RequestContext& request,
                                kiwix::OPDSDumper& opdsDumper)
 {
-    const auto filter = get_search_filter(request, "", m_catalogOnlyMode);
+    const auto filter = get_search_filter(request);
     std::vector<std::string> bookIdsToDump = mp_library->filter(filter);
     const auto totalResults = bookIdsToDump.size();
-    const long count = request.get_optional_param("count", 10L);
+    const size_t count = request.get_optional_param("count", 10UL);
     const size_t startIndex = request.get_optional_param("start", 0UL);
-    const size_t intendedCount = count >= 0 ? count : bookIdsToDump.size();
+    const size_t intendedCount = count > 0 ? count : bookIdsToDump.size();
     bookIdsToDump = subrange(bookIdsToDump, startIndex, intendedCount);
     opdsDumper.setOpenSearchInfo(totalResults, startIndex, bookIdsToDump.size());
     return bookIdsToDump;
@@ -1124,38 +1016,23 @@ InternalServer::search_catalog(const RequestContext& request,
 namespace
 {
 
-///////////////////////////////////////////////////////////////////////////////
-// The content security policy below is set on responses to the /content
-// endpoint in order to prevent the ZIM content from interfering with the
-// viewer (e.g. breaking out of the viewer iframe by performing top-level
-// navigation).
-const std::string CONTENT_CSP_HEADER =
-    "default-src 'self' "
-                "data: "
-                "blob: "
-                "about: "
-                "'unsafe-inline' "
-                "'unsafe-eval'; "
-
-    "sandbox allow-scripts "
-            "allow-same-origin "
-            "allow-modals "
-            "allow-popups "
-            "allow-popups-to-escape-sandbox "
-            "allow-forms "
-            "allow-downloads;";
-
-// End of content security policy
-///////////////////////////////////////////////////////////////////////////////
+ParameterizedMessage suggestSearchMsg(const std::string& searchURL, const std::string& pattern)
+{
+  return ParameterizedMessage("suggest-search",
+                              {
+                                { "PATTERN",    pattern   },
+                                { "SEARCH_URL", searchURL }
+                              });
+}
 
 } // unnamed namespace
 
 std::unique_ptr<Response>
 InternalServer::build_redirect(const std::string& bookName, const zim::Item& item) const
 {
-  const auto contentPath = "/content/" + bookName + "/" + item.getPath();
-  const auto url = m_root + kiwix::urlEncode(contentPath);
-  return Response::build_redirect(url);
+  const auto path = kiwix::urlEncode(item.getPath());
+  const auto redirectUrl = m_root + "/content/" + bookName + "/" + path;
+  return Response::build_redirect(*this, redirectUrl);
 }
 
 std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& request)
@@ -1178,13 +1055,16 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
   } catch (const std::out_of_range& e) {}
 
   if (archive == nullptr) {
-    return NewHTTP404Response(request, m_root, m_root + url);
+    const std::string searchURL = m_root + "/search?pattern=" + kiwix::urlEncode(pattern);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg
+           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern));
   }
 
   const std::string archiveUuid(archive->getUuid());
   const ETag etag = get_matching_if_none_match_etag(request, archiveUuid);
   if ( etag )
-    return Response::build_304(etag);
+    return Response::build_304(*this, etag);
 
   auto urlStr = url.substr(prefixLength + bookName.size());
   if (urlStr[0] == '/') {
@@ -1203,16 +1083,9 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
       //    '-' namespaces, in which case that resource is returned instead.
       return build_redirect(bookName, getFinalItem(*archive, entry));
     }
-    auto response = ItemResponse::build(request, entry.getItem());
+    auto response = ItemResponse::build(*this, request, entry.getItem());
     response->set_etag_body(archiveUuid);
 
-    if ( !startsWith(entry.getItem().getMimetype(), "application/pdf") ) {
-      // NOTE: Content security policy is not applied to PDF content so that
-      // NOTE: it can be displayed in the viewer in Chromium-based browsers.
-      response->add_header("Content-Security-Policy", CONTENT_CSP_HEADER);
-      response->add_header("Referrer-Policy", "no-referrer");
-    }
-
     if (m_verbose.load()) {
       printf("Found %s\n", entry.getPath().c_str());
       printf("mimeType: %s\n", entry.getItem(true).getMimetype().c_str());
@@ -1223,7 +1096,10 @@ std::unique_ptr<Response> InternalServer::handle_content(const RequestContext& r
     if (m_verbose.load())
       printf("Failed to find %s\n", urlStr.c_str());
 
-    return NewHTTP404Response(request, m_root, m_root + url);
+    std::string searchURL = m_root + "/search?content=" + bookName + "&pattern=" + kiwix::urlEncode(pattern);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg
+           + suggestSearchMsg(searchURL, kiwix::urlDecode(pattern));
   }
 }
 
@@ -1240,11 +1116,13 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
      bookName = request.get_url_part(1);
      kind = request.get_url_part(2);
   } catch (const std::out_of_range& e) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
   if (kind != "meta" && kind!= "content") {
-    return UrlNotFoundResponse(request)
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg
            + invalidRawAccessMsg(kind);
   }
 
@@ -1255,14 +1133,15 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
   } catch (const std::out_of_range& e) {}
 
   if (archive == nullptr) {
-    return UrlNotFoundResponse(request)
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg
            + noSuchBookErrorMsg(bookName);
   }
 
   const std::string archiveUuid(archive->getUuid());
   const ETag etag = get_matching_if_none_match_etag(request, archiveUuid);
   if ( etag )
-    return Response::build_304(etag);
+    return Response::build_304(*this, etag);
 
   // Remove the beggining of the path:
   // /raw/<bookName>/<kind>/foo
@@ -1273,7 +1152,7 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
   try {
     if (kind == "meta") {
       auto item = archive->getMetadataItem(itemPath);
-      auto response = ItemResponse::build(request, item);
+      auto response = ItemResponse::build(*this, request, item);
       response->set_etag_body(archiveUuid);
       return response;
     } else {
@@ -1281,7 +1160,7 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
       if (entry.isRedirect()) {
         return build_redirect(bookName, entry.getItem(true));
       }
-      auto response = ItemResponse::build(request, entry.getItem());
+      auto response = ItemResponse::build(*this, request, entry.getItem());
       response->set_etag_body(archiveUuid);
       return response;
     }
@@ -1289,7 +1168,8 @@ std::unique_ptr<Response> InternalServer::handle_raw(const RequestContext& reque
     if (m_verbose.load()) {
       printf("Failed to find %s\n", itemPath.c_str());
     }
-    return UrlNotFoundResponse(request)
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg
            + rawEntryNotFoundMsg(kind, itemPath);
   }
 }
@@ -1314,10 +1194,12 @@ std::unique_ptr<Response> InternalServer::handle_locally_customized_resource(con
 
   auto byteRange = request.get_range().resolve(resourceData.size());
   if (byteRange.kind() != ByteRange::RESOLVED_FULL_CONTENT) {
-    return Response::build_416(resourceData.size());
+    return Response::build_416(*this, resourceData.size());
   }
 
-  return ContentResponse::build(resourceData, crd.mimeType);
+  return ContentResponse::build(*this,
+                                resourceData,
+                                crd.mimeType);
 }
 
 }

src/server/internalServer.h

@@ -27,7 +27,6 @@ extern "C" {
 
 #include "library.h"
 #include "name_mapper.h"
-#include "tools.h"
 
 #include <zim/search.h>
 #include <zim/suggestion.h>
@@ -90,13 +89,12 @@ class SearchInfo {
 
 typedef kainjow::mustache::data MustacheData;
 class OPDSDumper;
-class LibraryDumper;
 
 class InternalServer {
   public:
-    InternalServer(LibraryPtr library,
-                   std::shared_ptr<NameMapper> nameMapper,
-                   IpAddress addr,
+    InternalServer(Library* library,
+                   NameMapper* nameMapper,
+                   std::string addr,
                    int port,
                    std::string root,
                    int nbThreads,
@@ -105,11 +103,8 @@ class InternalServer {
                    bool withTaskbar,
                    bool withLibraryButton,
                    bool blockExternalLinks,
-                   IpMode ipMode,
                    std::string indexTemplateString,
-                   int ipConnectionLimit,
-                   bool catalogOnlyMode,
-                   std::string zimViewerURL);
+                   int ipConnectionLimit);
     virtual ~InternalServer();
 
     MHD_Result handlerCallback(struct MHD_Connection* connection,
@@ -121,9 +116,8 @@ class InternalServer {
                                void** cont_cls);
     bool start();
     void stop();
-    IpAddress getAddress() const { return m_addr; }
-    int getPort() const { return m_port; }
-    IpMode getIpMode() const { return m_ipMode; }
+    std::string getAddress() { return m_addr; }
+    int getPort() { return m_port; }
 
   private: // functions
     std::unique_ptr<Response> handle_request(const RequestContext& request);
@@ -137,7 +131,6 @@ class InternalServer {
     std::unique_ptr<Response> handle_catalog_v2_entries(const RequestContext& request, bool partial);
     std::unique_ptr<Response> handle_catalog_v2_complete_entry(const RequestContext& request, const std::string& entryId);
     std::unique_ptr<Response> handle_catalog_v2_categories(const RequestContext& request);
-    std::unique_ptr<Response> handle_no_js(const RequestContext& request);
     std::unique_ptr<Response> handle_catalog_v2_languages(const RequestContext& request);
     std::unique_ptr<Response> handle_catalog_v2_illustration(const RequestContext& request);
     std::unique_ptr<Response> handle_search(const RequestContext& request);
@@ -162,33 +155,27 @@ class InternalServer {
 
     std::string getLibraryId() const;
 
-    std::string getNoJSDownloadPageHTML(const std::string& bookId, const std::string& userLang) const;
-    OPDSDumper getOPDSDumper() const;
-    void setContentAccessUrl(LibraryDumper& libDumper) 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
-    IpAddress m_addr;
+    std::string m_addr;
     int m_port;
-    std::string m_root;                   // URI-encoded
-    std::string m_rootPrefixOfDecodedURL; // URI-decoded
+    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;
-    IpMode m_ipMode;
     std::string m_indexTemplateString;
     int m_ipConnectionLimit;
     struct MHD_Daemon* mp_daemon;
 
-    LibraryPtr mp_library;
-    std::shared_ptr<NameMapper> mp_nameMapper;
+    Library* mp_library;
+    NameMapper* mp_nameMapper;
 
     SearchCache searchCache;
     SuggestionSearcherCache suggestionSearcherCache;
@@ -198,8 +185,9 @@ class InternalServer {
     class CustomizedResources;
     std::unique_ptr<CustomizedResources> m_customizedResources;
 
-    const bool m_catalogOnlyMode;
-    const std::string m_contentServerUrl;
+    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);
+    friend std::unique_ptr<Response> ItemResponse::build(const InternalServer& server, const RequestContext& request, const zim::Item& item);
 };
 
 }

src/server/internalServer_catalog_v2.cpp

@@ -33,78 +33,6 @@
 
 namespace kiwix {
 
-namespace
-{
-
-enum OPDSResponseKind
-{
-  OPDS_ENTRY,
-  OPDS_NAVIGATION_FEED,
-  OPDS_ACQUISITION_FEED
-};
-
-const std::string opdsMimeType[] = {
-  "application/atom+xml;type=entry;profile=opds-catalog;charset=utf-8",
-  "application/atom+xml;profile=opds-catalog;kind=navigation;charset=utf-8",
-  "application/atom+xml;profile=opds-catalog;kind=acquisition;charset=utf-8"
-};
-
-} // unnamed namespace
-
-OPDSDumper InternalServer::getOPDSDumper() const
-{
-  kiwix::OPDSDumper opdsDumper(mp_library.get(), mp_nameMapper.get());
-  opdsDumper.setRootLocation(m_root);
-  opdsDumper.setLibraryId(getLibraryId());
-  setContentAccessUrl(opdsDumper);
-  return opdsDumper;
-}
-
-std::unique_ptr<Response> InternalServer::handle_catalog(const RequestContext& request)
-{
-  if (m_verbose.load()) {
-    printf("** running handle_catalog");
-  }
-
-  std::string host;
-  std::string url;
-  try {
-    host = request.get_header("Host");
-    url  = request.get_url_part(1);
-  } catch (const std::out_of_range&) {
-    return UrlNotFoundResponse(request);
-  }
-
-  if (url == "v2") {
-    return handle_catalog_v2(request);
-  }
-
-  if (url != "searchdescription.xml" && url != "root.xml" && url != "search") {
-    return UrlNotFoundResponse(request);
-  }
-
-  if (url == "searchdescription.xml") {
-    auto response = ContentResponse::build(RESOURCE::opensearchdescription_xml, get_default_data(), "application/opensearchdescription+xml");
-    return std::move(response);
-  }
-
-  zim::Uuid uuid;
-  kiwix::OPDSDumper opdsDumper = getOPDSDumper();
-  std::vector<std::string> bookIdsToDump;
-  if (url == "root.xml") {
-    uuid = zim::Uuid::generate(host);
-    bookIdsToDump = mp_library->filter(kiwix::Filter().valid(true).local(true).remote(true));
-  } else if (url == "search") {
-    bookIdsToDump = search_catalog(request, opdsDumper);
-    uuid = zim::Uuid::generate();
-  }
-
-  auto response = ContentResponse::build(
-      opdsDumper.dumpOPDSFeed(bookIdsToDump, request.get_query()),
-      opdsMimeType[OPDS_ACQUISITION_FEED]);
-  return std::move(response);
-}
-
 std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext& request)
 {
   if (m_verbose.load()) {
@@ -115,14 +43,15 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext
   try {
     url  = request.get_url_part(2);
   } catch (const std::out_of_range&) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
   if (url == "root.xml") {
     return handle_catalog_v2_root(request);
   } else if (url == "searchdescription.xml") {
     const std::string endpoint_root = m_root + "/catalog/v2";
-    return ContentResponse::build(
+    return ContentResponse::build(*this,
         RESOURCE::catalog_v2_searchdescription_xml,
         kainjow::mustache::object({{"endpoint_root", endpoint_root}}),
         "application/opensearchdescription+xml"
@@ -141,7 +70,8 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2(const RequestContext
   } else if (url == "illustration") {
     return handle_catalog_v2_illustration(request);
   } else {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 }
 
@@ -149,6 +79,7 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_root(const RequestCo
 {
   const std::string libraryId = getLibraryId();
   return ContentResponse::build(
+             *this,
              RESOURCE::templates::catalog_v2_root_xml,
              kainjow::mustache::object{
                {"date", gen_date_str()},
@@ -159,18 +90,21 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_root(const RequestCo
                {"category_list_feed_id", gen_uuid(libraryId + "/categories")},
                {"language_list_feed_id", gen_uuid(libraryId + "/languages")}
              },
-             opdsMimeType[OPDS_NAVIGATION_FEED]
+             "application/atom+xml;profile=opds-catalog;kind=navigation"
   );
 }
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_entries(const RequestContext& request, bool partial)
 {
-  kiwix::OPDSDumper opdsDumper = getOPDSDumper();
+  OPDSDumper opdsDumper(mp_library, mp_nameMapper);
+  opdsDumper.setRootLocation(m_root);
+  opdsDumper.setLibraryId(getLibraryId());
   const auto bookIds = search_catalog(request, opdsDumper);
   const auto opdsFeed = opdsDumper.dumpOPDSFeedV2(bookIds, request.get_query(), partial);
   return ContentResponse::build(
+             *this,
              opdsFeed,
-             opdsMimeType[OPDS_ACQUISITION_FEED]
+             "application/atom+xml;profile=opds-catalog;kind=acquisition"
   );
 }
 
@@ -179,32 +113,42 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_complete_entry(const
   try {
     mp_library->getBookById(entryId);
   } catch (const std::out_of_range&) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 
-  kiwix::OPDSDumper opdsDumper = getOPDSDumper();
+  OPDSDumper opdsDumper(mp_library, mp_nameMapper);
+  opdsDumper.setRootLocation(m_root);
+  opdsDumper.setLibraryId(getLibraryId());
   const auto opdsFeed = opdsDumper.dumpOPDSCompleteEntry(entryId);
   return ContentResponse::build(
+             *this,
              opdsFeed,
-             opdsMimeType[OPDS_ENTRY]
+             "application/atom+xml;type=entry;profile=opds-catalog"
   );
 }
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_categories(const RequestContext& request)
 {
-  kiwix::OPDSDumper opdsDumper = getOPDSDumper();
+  OPDSDumper opdsDumper(mp_library, mp_nameMapper);
+  opdsDumper.setRootLocation(m_root);
+  opdsDumper.setLibraryId(getLibraryId());
   return ContentResponse::build(
+             *this,
              opdsDumper.categoriesOPDSFeed(),
-             opdsMimeType[OPDS_NAVIGATION_FEED]
+             "application/atom+xml;profile=opds-catalog;kind=navigation"
   );
 }
 
 std::unique_ptr<Response> InternalServer::handle_catalog_v2_languages(const RequestContext& request)
 {
-  kiwix::OPDSDumper opdsDumper = getOPDSDumper();
+  OPDSDumper opdsDumper(mp_library, mp_nameMapper);
+  opdsDumper.setRootLocation(m_root);
+  opdsDumper.setLibraryId(getLibraryId());
   return ContentResponse::build(
+             *this,
              opdsDumper.languagesOPDSFeed(),
-             opdsMimeType[OPDS_NAVIGATION_FEED]
+             "application/atom+xml;profile=opds-catalog;kind=navigation"
   );
 }
 
@@ -216,11 +160,13 @@ std::unique_ptr<Response> InternalServer::handle_catalog_v2_illustration(const R
     auto size = request.get_argument<unsigned int>("size");
     auto illustration = book.getIllustration(size);
     return ContentResponse::build(
+               *this,
                illustration->getData(),
                illustration->mimeType
     );
   } catch(...) {
-    return UrlNotFoundResponse(request);
+    return HTTP404Response(*this, request)
+           + urlNotFoundMsg;
   }
 }
 

src/server/request_context.cpp

@@ -28,7 +28,7 @@
 #include <cctype>
 
 #include "tools/stringTools.h"
-#include "i18n_utils.h"
+#include "i18n.h"
 
 namespace kiwix {
 
@@ -49,29 +49,41 @@ RequestMethod str2RequestMethod(const std::string& method) {
   else                          return RequestMethod::OTHER;
 }
 
+std::string
+fullURL2LocalURL(const std::string& full_url, const std::string& rootLocation)
+{
+  if (rootLocation.empty()) {
+    // nothing special to handle.
+    return full_url;
+  } else if (full_url == rootLocation) {
+    return "/";
+  } else if (full_url.size() > rootLocation.size() &&
+             full_url.substr(0, rootLocation.size()+1) == rootLocation + "/") {
+    return full_url.substr(rootLocation.size());
+  } else {
+    return "";
+  }
+}
+
 } // unnamed namespace
 
-RequestContext::RequestContext(const std::string& _rootLocation, // URI-encoded
-                               const std::string& unrootedUrl,   // URI-decoded
+RequestContext::RequestContext(struct MHD_Connection* connection,
+                               std::string _rootLocation,
+                               const std::string& _url,
                                const std::string& _method,
-                               const std::string& version,
-                               const NameValuePairs& headers,
-                               const NameValuePairs& queryArgs) :
+                               const std::string& version) :
   rootLocation(_rootLocation),
-  url(unrootedUrl),
+  full_url(_url),
+  url(fullURL2LocalURL(_url, _rootLocation)),
   method(str2RequestMethod(_method)),
   version(version),
   requestIndex(s_requestIndex++),
   acceptEncodingGzip(false),
   byteRange_()
 {
-  for ( const auto& kv : headers ) {
-    add_header(kv.first, kv.second);
-  }
-
-  for ( const auto& kv : queryArgs ) {
-    add_argument(kv.first, kv.second);
-  }
+  MHD_get_connection_values(connection, MHD_HEADER_KIND, &RequestContext::fill_header, this);
+  MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND, &RequestContext::fill_argument, this);
+  MHD_get_connection_values(connection, MHD_COOKIE_KIND, &RequestContext::fill_cookie, this);
 
   try {
     acceptEncodingGzip =
@@ -88,14 +100,18 @@ RequestContext::RequestContext(const std::string& _rootLocation, // URI-encoded
 RequestContext::~RequestContext()
 {}
 
-void RequestContext::add_header(const char *key, const char *value)
+MHD_Result RequestContext::fill_header(void *__this, enum MHD_ValueKind kind,
+                                       const char *key, const char *value)
 {
-  this->headers[lcAll(key)] = value;
+  RequestContext *_this = static_cast<RequestContext*>(__this);
+  _this->headers[lcAll(key)] = value;
+  return MHD_YES;
 }
 
-void RequestContext::add_argument(const char *key, const char* value)
+MHD_Result RequestContext::fill_argument(void *__this, enum MHD_ValueKind kind,
+                                         const char *key, const char* value)
 {
-  RequestContext *_this = this;
+  RequestContext *_this = static_cast<RequestContext*>(__this);
   _this->arguments[key].push_back(value == nullptr ? "" : value);
   if ( ! _this->queryString.empty() ) {
     _this->queryString += "&";
@@ -105,6 +121,15 @@ void RequestContext::add_argument(const char *key, const char* value)
     _this->queryString += "=";
     _this->queryString += urlEncode(value);
   }
+  return MHD_YES;
+}
+
+MHD_Result RequestContext::fill_cookie(void *__this, enum MHD_ValueKind kind,
+                                         const char *key, const char* value)
+{
+  RequestContext *_this = static_cast<RequestContext*>(__this);
+  _this->cookies[key] = value == nullptr ? "" : value;
+  return MHD_YES;
 }
 
 void RequestContext::print_debug_info() const {
@@ -128,6 +153,7 @@ void RequestContext::print_debug_info() const {
     printf("\n");
   }
   printf("Parsed : \n");
+  printf("full_url: %s\n", full_url.c_str());
   printf("url   : %s\n", url.c_str());
   printf("acceptEncodingGzip : %d\n", acceptEncodingGzip);
   printf("has_range : %d\n", byteRange_.kind() != ByteRange::NONE);
@@ -165,7 +191,7 @@ std::string RequestContext::get_url_part(int number) const {
 }
 
 std::string RequestContext::get_full_url() const {
-  return rootLocation + urlEncode(url);
+  return full_url;
 }
 
 std::string RequestContext::get_root_path() const {
@@ -173,7 +199,7 @@ std::string RequestContext::get_root_path() const {
 }
 
 bool RequestContext::is_valid_url() const {
-  return url.empty() || url[0] == '/';
+  return !url.empty();
 }
 
 ByteRange RequestContext::get_range() const {
@@ -194,12 +220,21 @@ std::string RequestContext::get_user_language() const
   return userlang.lang;
 }
 
+bool RequestContext::user_language_comes_from_cookie() const
+{
+  return userlang.selectedBy == UserLanguage::SelectorKind::COOKIE;
+}
+
 RequestContext::UserLanguage RequestContext::determine_user_language() const
 {
   try {
     return {UserLanguage::SelectorKind::QUERY_PARAM, get_argument("userlang")};
   } catch(const std::out_of_range&) {}
 
+  try {
+     return {UserLanguage::SelectorKind::COOKIE, cookies.at("userlang")};
+  } catch(const std::out_of_range&) {}
+
   try {
     const std::string acceptLanguage = get_header("Accept-Language");
     const auto userLangPrefs = parseUserLanguagePreferences(acceptLanguage);

src/server/request_context.h

@@ -29,7 +29,7 @@
 #include <stdexcept>
 
 #include "byte_range.h"
-#include "../tools/stringTools.h"
+#include "tools/stringTools.h"
 
 extern "C" {
 #include "microhttpd_wrapper.h"
@@ -55,17 +55,12 @@ class IndexError: public std::runtime_error {};
 
 
 class RequestContext {
-  public: // types
-    typedef std::vector<std::pair<const char*, const char*>> NameValuePairs;
-
   public: // functions
-    RequestContext(const std::string& rootLocation, // URI-encoded
-                   const std::string& unrootedUrl,  // URI-decoded
+    RequestContext(struct MHD_Connection* connection,
+                   std::string rootLocation,
+                   const std::string& url,
                    const std::string& method,
-                   const std::string& version,
-                   const NameValuePairs& headers,
-                   const NameValuePairs& queryArgs);
-
+                   const std::string& version);
     ~RequestContext();
 
     void print_debug_info() const;
@@ -101,16 +96,15 @@ class RequestContext {
     std::string get_query() const { return queryString; }
 
     template<class F>
-    std::string get_query(F filter, bool mustEncode) const {
+    std::string get_query(F filter) const {
       std::string q;
       const char* sep = "";
-      auto encode = [=](const std::string& value) { return mustEncode?urlEncode(value):value; };
       for ( const auto& a : arguments ) {
         if (!filter(a.first)) {
           continue;
         }
         for (const auto& v: a.second) {
-          q += sep + encode(a.first) + '=' + encode(v);
+          q += sep + urlEncode(a.first) + '=' + urlEncode(v);
           sep = "&";
         }
       }
@@ -124,12 +118,15 @@ class RequestContext {
     std::string get_user_language() const;
     std::string get_requested_format() const;
 
+    bool user_language_comes_from_cookie() const;
+
   private: // types
     struct UserLanguage
     {
       enum SelectorKind
       {
         QUERY_PARAM,
+        COOKIE,
         ACCEPT_LANGUAGE_HEADER,
         DEFAULT
       };
@@ -140,6 +137,7 @@ class RequestContext {
 
   private: // data
     std::string rootLocation;
+    std::string full_url;
     std::string url;
     RequestMethod method;
     std::string version;
@@ -150,14 +148,16 @@ class RequestContext {
     ByteRange byteRange_;
     std::map<std::string, std::string> headers;
     std::map<std::string, std::vector<std::string>> arguments;
+    std::map<std::string, std::string> cookies;
     std::string queryString;
     UserLanguage userlang;
 
   private: // functions
     UserLanguage determine_user_language() const;
 
-    void add_header(const char* name, const char* value);
-    void add_argument(const char* name, const char* value);
+    static MHD_Result fill_header(void *, enum MHD_ValueKind, const char*, const char*);
+    static MHD_Result fill_cookie(void *, enum MHD_ValueKind, const char*, const char*);
+    static MHD_Result fill_argument(void *, enum MHD_ValueKind, const char*, const char*);
 };
 
 template<> std::string RequestContext::get_argument(const std::string& name) const;

src/server/response.cpp

@@ -32,9 +32,6 @@
 #include <zlib.h>
 
 #include <array>
-#include <list>
-#include <map>
-#include <regex>
 
 // This is somehow a magic value.
 // If this value is too small, we will compress (and lost cpu time) too much
@@ -50,8 +47,6 @@ namespace kiwix {
 
 namespace
 {
-typedef kainjow::mustache::data MustacheData;
-
 // some utilities
 
 std::string get_mime_type(const zim::Item& item)
@@ -124,8 +119,9 @@ const char* getCacheControlHeader(Response::Kind k)
 
 } // unnamed namespace
 
-Response::Response()
-  : m_returnCode(MHD_HTTP_OK)
+Response::Response(bool verbose)
+  : m_verbose(verbose),
+    m_returnCode(MHD_HTTP_OK)
 {
   add_header(MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN, "*");
 }
@@ -137,14 +133,14 @@ void Response::set_kind(Kind k)
     m_etag.set_option(ETag::ZIM_CONTENT);
 }
 
-std::unique_ptr<Response> Response::build()
+std::unique_ptr<Response> Response::build(const InternalServer& server)
 {
-  return std::make_unique<Response>();
+  return std::unique_ptr<Response>(new Response(server.m_verbose.load()));
 }
 
-std::unique_ptr<Response> Response::build_304(const ETag& etag)
+std::unique_ptr<Response> Response::build_304(const InternalServer& server, const ETag& etag)
 {
-  auto response = Response::build();
+  auto response = Response::build(server);
   response->set_code(MHD_HTTP_NOT_MODIFIED);
   response->m_etag = etag;
   if ( etag.get_option(ETag::ZIM_CONTENT) ) {
@@ -156,316 +152,67 @@ std::unique_ptr<Response> Response::build_304(const ETag& etag)
   return response;
 }
 
+const UrlNotFoundMsg urlNotFoundMsg;
+const InvalidUrlMsg invalidUrlMsg;
 
-namespace
+std::string ContentResponseBlueprint::getMessage(const std::string& msgId) const
 {
-
-// This class was introduced in order to work around the missing support
-// for std::variant (and std::optional) under some of the current build
-// platforms.
-template<class T>
-class Optional
-{
-public: // functions
-    Optional() {}
-    Optional(const T& t) : ptr(new T(t)) {}
-    Optional(const Optional& o) : ptr(o.has_value() ? new T(*o) : nullptr) {}
-    Optional(Optional&& o) : ptr(std::move(o.ptr)) {}
-
-    Optional& operator=(const Optional& o)
-    {
-      *this = Optional(o);
-      return *this;
-    }
-
-    Optional& operator=(Optional&& o)
-    {
-      ptr = std::move(o.ptr);
-      return *this;
-    }
-
-    bool has_value() const { return ptr.get() != nullptr; }
-    const T& operator*() const { return *ptr; }
-    T& operator*() { return *ptr; }
-
-private: // data
-    std::unique_ptr<T> ptr;
-};
-
-} // unnamed namespace
-
-class ContentResponseBlueprint::Data
-{
-public:
-  typedef std::list<Data>             List;
-  typedef std::map<std::string, Data> Object;
-
-private:
-  // std::variant<std::string, bool, List, Object> data;
-  // XXX: libkiwix is compiled on platforms where std::variant
-  // XXX: is not yet supported. Hence this hack. Only one
-  // XXX: of the below data members is expected to contain a value.
-  Optional<std::string> m_stringValue;
-  Optional<bool>        m_boolValue;
-  Optional<List>        m_listValue;
-  Optional<Object>      m_objectValue;
-
-public:
-  Data() {}
-  Data(const std::string& s) : m_stringValue(s) {}
-  Data(bool b)               : m_boolValue(b)   {}
-  Data(const List& l)        : m_listValue(l)   {}
-  Data(const Object& o)      : m_objectValue(o) {}
-
-  MustacheData toMustache(const std::string& lang) const;
-
-  Data& operator[](const std::string& key)
-  {
-    return (*m_objectValue)[key];
-  }
-
-  void push_back(const Data& d) { (*m_listValue).push_back(d); }
-
-  static Data onlyAsNonEmptyValue(const std::string& s)
-  {
-    return s.empty() ? Data(false) : Data(s);
-  }
-
-  static Data from(const ParameterizedMessage& pmsg)
-  {
-    Object obj;
-    for(const auto& kv : pmsg.getParams()) {
-      obj[kv.first] = kv.second;
-    }
-    return Object{
-              { "msgid", pmsg.getMsgId() },
-              { "params", Data(obj) }
-    };
-  }
-
-  static Data fromMsgId(const std::string& nonParameterizedMsgId)
-  {
-    return from(nonParameterizedMessage(nonParameterizedMsgId));
-  }
-
-  static Data staticMultiParagraphText(const std::string& msgIdPrefix, size_t n)
-  {
-    Object paragraphs;
-    for ( size_t i = 1; i <= n; ++i ) {
-      std::ostringstream oss;
-      oss << "p" << i;
-      const std::string pId = oss.str();
-      paragraphs[pId] = fromMsgId(msgIdPrefix + "." + pId);
-    }
-    return paragraphs;
-  }
-
-  std::string asJSON() const;
-  void dumpJSON(std::ostream& os) const;
-
-private:
-  bool isString() const { return m_stringValue.has_value(); }
-  bool isList()   const { return m_listValue.has_value();   }
-  bool isObject() const { return m_objectValue.has_value(); }
-
-  const std::string& stringValue() const { return *m_stringValue; }
-  bool               boolValue()   const { return *m_boolValue;   }
-  const List&        listValue()   const { return *m_listValue;   }
-  const Object&      objectValue() const { return *m_objectValue; }
-
-  const Data* get(const std::string& key) const
-  {
-    if ( !isObject() )
-      return nullptr;
-
-    const auto& obj = objectValue();
-    const auto it = obj.find(key);
-    return it != obj.end() ? &it->second : nullptr;
-  }
-};
-
-MustacheData ContentResponseBlueprint::Data::toMustache(const std::string& lang) const
-{
-  if ( this->isList() ) {
-    kainjow::mustache::list l;
-    for ( const auto& x : this->listValue() ) {
-      l.push_back(x.toMustache(lang));
-    }
-    return l;
-  } else if ( this->isObject() ) {
-    const Data* msgId = this->get("msgid");
-    const Data* msgParams = this->get("params");
-    if ( msgId && msgId->isString() && msgParams && msgParams->isObject() ) {
-      std::map<std::string, std::string> params;
-      for(const auto& kv : msgParams->objectValue()) {
-        params[kv.first] = kv.second.stringValue();
-      }
-      const ParameterizedMessage msg(msgId->stringValue(), ParameterizedMessage::Parameters(params));
-      return msg.getText(lang);
-    } else {
-      kainjow::mustache::object o;
-      for ( const auto& kv : this->objectValue() ) {
-        o[kv.first] = kv.second.toMustache(lang);
-      }
-      return o;
-    }
-  } else if ( this->isString() ) {
-    return this->stringValue();
-  } else {
-    return this->boolValue();
-  }
+  return getTranslatedString(m_request.get_user_language(), msgId);
 }
 
-void ContentResponseBlueprint::Data::dumpJSON(std::ostream& os) const
-{
-  if ( this->isString() ) {
-    os << '"' << escapeForJSON(this->stringValue()) << '"';
-  } else if ( this->isList() ) {
-    const char * sep = " ";
-    os << "[";
-
-    for ( const auto& x :  this->listValue() ) {
-      os << sep;
-      x.dumpJSON(os);
-      sep = ", ";
-    }
-    os << " ]";
-  } else if ( this->isObject() ) {
-    const char * sep = " ";
-    os << "{";
-    for ( const auto& kv : this->objectValue() ) {
-      os << sep << '"' << kv.first << "\" : ";
-      kv.second.dumpJSON(os);
-      sep = ", ";
-    }
-    os << " }";
-  } else {
-    os << (this->boolValue() ? "true" : "false");
-  }
-}
-
-std::string ContentResponseBlueprint::Data::asJSON() const
-{
-  std::ostringstream oss;
-  this->dumpJSON(oss);
-
-  // This JSON is going to be used in HTML inside a <script></script> tag.
-  // If it contains "</script>" (or "</script >") as a substring, then the HTML
-  // parser will be confused. Since for a valid JSON that may happen only inside
-  // a JSON string, we can safely take advantage of the answers to
-  // https://stackoverflow.com/questions/28259389/how-to-put-script-in-a-javascript-string
-  // and work around the issue by inserting an otherwise harmless backslash.
-  return std::regex_replace(oss.str(), std::regex("</script"), "</scr\\ipt");
-}
-
-ContentResponseBlueprint::ContentResponseBlueprint(const RequestContext* request,
-                         int httpStatusCode,
-                         const std::string& mimeType,
-                         const std::string& templateStr,
-                         bool includeKiwixResponseData)
-  : m_request(*request)
-  , m_httpStatusCode(httpStatusCode)
-  , m_mimeType(mimeType)
-  , m_template(templateStr)
-  , m_includeKiwixResponseData(includeKiwixResponseData)
-  , m_data(new Data)
-{}
-
-ContentResponseBlueprint::~ContentResponseBlueprint() = default;
-
 std::unique_ptr<ContentResponse> ContentResponseBlueprint::generateResponseObject() const
 {
-  kainjow::mustache::data d = m_data->toMustache(m_request.get_user_language());
-  if ( m_includeKiwixResponseData ) {
-    d.set("KIWIX_RESPONSE_TEMPLATE", escapeForJSON(m_template, false));
-    d.set("KIWIX_RESPONSE_DATA", m_data->asJSON());
-  }
-  auto r = ContentResponse::build(m_template, d, m_mimeType);
+  auto r = ContentResponse::build(m_server, m_template, m_data, m_mimeType);
   r->set_code(m_httpStatusCode);
   return r;
 }
 
-NewHTTP404Response::NewHTTP404Response(const RequestContext& request,
-                                       const std::string& root,
-                                       const std::string& urlPath)
-  : ContentResponseBlueprint(&request,
-                             MHD_HTTP_NOT_FOUND,
-                             "text/html; charset=utf-8",
-                             RESOURCE::templates::sexy404_html,
-                             /*includeKiwixResponseData=*/true)
-{
-  *this->m_data = Data(Data::Object{
-                    {"root", root },
-                    {"url_path", urlPath},
-                    {"PAGE_TITLE",   Data::fromMsgId("new-404-page-title")},
-                    {"PAGE_HEADING", Data::fromMsgId("new-404-page-heading")},
-                    {"404_img_text", Data::fromMsgId("404-img-text")},
-                    {"path_was_not_found_msg", Data::fromMsgId("path-was-not-found")},
-                    {"advice", Data::staticMultiParagraphText("404-advice", 5)},
-  });
-}
-
-BlockExternalLinkResponse::BlockExternalLinkResponse(const RequestContext& request,
-                                       const std::string& root,
-                                       const std::string& externalUrl)
-  : ContentResponseBlueprint(&request,
-                             MHD_HTTP_OK,
-                             "text/html; charset=utf-8",
-                             RESOURCE::templates::captured_external_html,
-                             /*includeKiwixResponseData=*/true)
-{
-  *this->m_data = Data(Data::Object{
-                    {"root", root },
-                    {"external_link_detected", Data::fromMsgId("external-link-detected") },
-                    {"url", externalUrl },
-                    {"caution_warning", Data::fromMsgId("caution-warning") },
-                    {"external_link_intro", Data::fromMsgId("external-link-intro") },
-                    {"advice", Data::staticMultiParagraphText("external-link-advice", 3)},
-  });
-}
-
-HTTPErrorResponse::HTTPErrorResponse(const RequestContext& request,
+HTTPErrorResponse::HTTPErrorResponse(const InternalServer& server,
+                                     const RequestContext& request,
                                      int httpStatusCode,
                                      const std::string& pageTitleMsgId,
                                      const std::string& headingMsgId,
-                                     const std::string& cssUrl,
-                                     bool includeKiwixResponseData)
-  : ContentResponseBlueprint(&request,
+                                     const std::string& cssUrl)
+  : ContentResponseBlueprint(&server,
+                             &request,
                              httpStatusCode,
                              request.get_requested_format() == "html" ? "text/html; charset=utf-8" : "application/xml; charset=utf-8",
-                             request.get_requested_format() == "html" ? RESOURCE::templates::error_html : RESOURCE::templates::error_xml,
-                             includeKiwixResponseData)
+                             request.get_requested_format() == "html" ? RESOURCE::templates::error_html : RESOURCE::templates::error_xml)
 {
-  Data::List emptyList;
-  *this->m_data = Data(Data::Object{
-                    {"CSS_URL", Data::onlyAsNonEmptyValue(cssUrl) },
-                    {"PAGE_TITLE",   Data::fromMsgId(pageTitleMsgId)},
-                    {"PAGE_HEADING", Data::fromMsgId(headingMsgId)},
+  kainjow::mustache::list emptyList;
+  this->m_data = kainjow::mustache::object{
+                    {"CSS_URL", onlyAsNonEmptyMustacheValue(cssUrl) },
+                    {"PAGE_TITLE",   getMessage(pageTitleMsgId)},
+                    {"PAGE_HEADING", getMessage(headingMsgId)},
                     {"details", emptyList}
-  });
+  };
 }
 
-HTTP404Response::HTTP404Response(const RequestContext& request)
-  : HTTPErrorResponse(request,
+HTTP404Response::HTTP404Response(const InternalServer& server,
+                                 const RequestContext& request)
+  : HTTPErrorResponse(server,
+                      request,
                       MHD_HTTP_NOT_FOUND,
                       "404-page-title",
-                      "404-page-heading",
-                      std::string(),
-                      /*includeKiwixResponseData=*/true)
+                      "404-page-heading")
 {
 }
 
-UrlNotFoundResponse::UrlNotFoundResponse(const RequestContext& request)
-    : HTTP404Response(request)
+HTTPErrorResponse& HTTP404Response::operator+(UrlNotFoundMsg /*unused*/)
 {
-  const std::string requestUrl = urlDecode(m_request.get_full_url(), false);
-  *this += ParameterizedMessage("url-not-found", {{"url", requestUrl}});
+  const std::string requestUrl = m_request.get_full_url();
+  return *this + ParameterizedMessage("url-not-found", {{"url", requestUrl}});
+}
+
+HTTPErrorResponse& HTTPErrorResponse::operator+(const std::string& msg)
+{
+  m_data["details"].push_back({"p", msg});
+  return *this;
 }
 
 HTTPErrorResponse& HTTPErrorResponse::operator+(const ParameterizedMessage& details)
 {
-  (*m_data)["details"].push_back(Data::Object{{"p", Data::from(details)}});
-  return *this;
+  return *this + details.getText(m_request.get_user_language());
 }
 
 HTTPErrorResponse& HTTPErrorResponse::operator+=(const ParameterizedMessage& details)
@@ -475,51 +222,50 @@ HTTPErrorResponse& HTTPErrorResponse::operator+=(const ParameterizedMessage& det
 }
 
 
-HTTP400Response::HTTP400Response(const RequestContext& request)
-  : HTTPErrorResponse(request,
+HTTP400Response::HTTP400Response(const InternalServer& server,
+                                 const RequestContext& request)
+  : HTTPErrorResponse(server,
+                      request,
                       MHD_HTTP_BAD_REQUEST,
                       "400-page-title",
-                      "400-page-heading",
-                      std::string(),
-                      /*includeKiwixResponseData=*/true)
+                      "400-page-heading")
 {
-  std::string requestUrl = urlDecode(m_request.get_full_url(), false);
+}
+
+HTTPErrorResponse& HTTP400Response::operator+(InvalidUrlMsg /*unused*/)
+{
+  std::string requestUrl = m_request.get_full_url();
   const auto query = m_request.get_query();
   if (!query.empty()) {
     requestUrl += "?" + encodeDiples(query);
   }
-  *this += ParameterizedMessage("invalid-request", {{"url", requestUrl}});
+  kainjow::mustache::mustache msgTmpl(R"(The requested URL "{{{url}}}" is not a valid request.)");
+  return *this + msgTmpl.render({"url", requestUrl});
 }
 
-HTTP500Response::HTTP500Response(const RequestContext& request,
-                                 const std::string& root,
-                                 const std::string& urlPath,
-                                 const std::string& errorText)
-  : ContentResponseBlueprint(&request,
-                             MHD_HTTP_INTERNAL_SERVER_ERROR,
-                             "text/html; charset=utf-8",
-                             RESOURCE::templates::sexy500_html,
-                             /*includeKiwixResponseData=*/true)
+HTTP500Response::HTTP500Response(const InternalServer& server,
+                                 const RequestContext& request)
+  : HTTPErrorResponse(server,
+                      request,
+                      MHD_HTTP_INTERNAL_SERVER_ERROR,
+                      "500-page-title",
+                      "500-page-heading")
 {
-  auto pageParams = Data::Object{
-    {"root", root },
-    {"url_path", urlPath},
-    {"PAGE_TITLE",   Data::fromMsgId("500-page-title")},
-    {"PAGE_HEADING", Data::fromMsgId("500-page-heading")},
-    {"PAGE_TEXT",    Data::fromMsgId("500-page-text")},
-    {"500_img_text", Data::fromMsgId("500-img-text")},
-  };
-
-  if ( !errorText.empty() ) {
-    pageParams["error"] = errorText;
-  }
-
-  *this->m_data = Data(pageParams);
+  // operator+() is a state-modifying operator (akin to operator+=)
+  *this + "An internal server error occured. We are sorry about that :/";
 }
 
-std::unique_ptr<Response> Response::build_416(size_t resourceLength)
+std::unique_ptr<ContentResponse> HTTP500Response::generateResponseObject() const
 {
-  auto response = Response::build();
+  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;
+}
+
+std::unique_ptr<Response> Response::build_416(const InternalServer& server, size_t resourceLength)
+{
+  auto response = Response::build(server);
 // [FIXME] (compile with recent enough version of libmicrohttpd)
 //  response->set_code(MHD_HTTP_RANGE_NOT_SATISFIABLE);
   response->set_code(416);
@@ -531,9 +277,9 @@ std::unique_ptr<Response> Response::build_416(size_t resourceLength)
 }
 
 
-std::unique_ptr<Response> Response::build_redirect(const std::string& redirectUrl)
+std::unique_ptr<Response> Response::build_redirect(const InternalServer& server, const std::string& redirectUrl)
 {
-  auto response = Response::build();
+  auto response = Response::build(server);
   response->m_returnCode = MHD_HTTP_FOUND;
   response->add_header(MHD_HTTP_HEADER_LOCATION, redirectUrl);
   return response;
@@ -628,7 +374,7 @@ ContentResponse::create_mhd_response(const RequestContext& request)
   return response;
 }
 
-MHD_Result Response::send(const RequestContext& request, bool verbose, MHD_Connection* connection)
+MHD_Result Response::send(const RequestContext& request, MHD_Connection* connection)
 {
   MHD_Response* response = create_mhd_response(request);
 
@@ -641,10 +387,17 @@ MHD_Result Response::send(const RequestContext& request, bool verbose, MHD_Conne
     MHD_add_response_header(response, p.first.c_str(), p.second.c_str());
   }
 
+  if ( ! request.user_language_comes_from_cookie() ) {
+    const std::string cookie = "userlang=" + request.get_user_language()
+                               + ";Path=" + request.get_root_path()
+                               + ";Max-Age=31536000";
+    MHD_add_response_header(response, MHD_HTTP_HEADER_SET_COOKIE, cookie.c_str());
+  }
+
   if (m_returnCode == MHD_HTTP_OK && m_byteRange.kind() == ByteRange::RESOLVED_PARTIAL_CONTENT)
     m_returnCode = MHD_HTTP_PARTIAL_CONTENT;
 
-  if (verbose)
+  if (m_verbose)
     print_response_info(m_returnCode, response);
 
   auto ret = MHD_queue_response(connection, m_returnCode, response);
@@ -652,8 +405,9 @@ MHD_Result Response::send(const RequestContext& request, bool verbose, MHD_Conne
   return ret;
 }
 
-ContentResponse::ContentResponse(const std::string& content, const std::string& mimetype) :
-  Response(),
+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)
 {
@@ -661,23 +415,29 @@ ContentResponse::ContentResponse(const std::string& content, const std::string&
 }
 
 std::unique_ptr<ContentResponse> ContentResponse::build(
+  const InternalServer& server,
   const std::string& content,
   const std::string& mimetype)
 {
-   return std::make_unique<ContentResponse>(content, mimetype);
+   return std::unique_ptr<ContentResponse>(new ContentResponse(
+        server.m_root,
+        server.m_verbose.load(),
+        content,
+        mimetype));
 }
 
 std::unique_ptr<ContentResponse> ContentResponse::build(
+  const InternalServer& server,
   const std::string& template_str,
   kainjow::mustache::data data,
   const std::string& mimetype)
 {
   auto content = render_template(template_str, data);
-  return ContentResponse::build(content, mimetype);
+  return ContentResponse::build(server, content, mimetype);
 }
 
-ItemResponse::ItemResponse(const zim::Item& item, const std::string& mimetype, const ByteRange& byterange) :
-  Response(),
+ItemResponse::ItemResponse(bool verbose, const zim::Item& item, const std::string& mimetype, const ByteRange& byterange) :
+  Response(verbose),
   m_item(item),
   m_mimeType(mimetype)
 {
@@ -686,26 +446,30 @@ ItemResponse::ItemResponse(const zim::Item& item, const std::string& mimetype, c
   add_header(MHD_HTTP_HEADER_CONTENT_TYPE, m_mimeType);
 }
 
-std::unique_ptr<Response> ItemResponse::build(const RequestContext& request, const zim::Item& item)
+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(item.getData(), mimetype);
+    auto response = ContentResponse::build(server, item.getData(), mimetype);
     response->set_kind(Response::ZIM_CONTENT);
     response->m_byteRange = byteRange;
     return std::move(response);
   }
 
   if (byteRange.kind() == ByteRange::RESOLVED_UNSATISFIABLE) {
-    auto response = Response::build_416(item.getSize());
+    auto response = Response::build_416(server, item.getSize());
     response->set_kind(Response::ZIM_CONTENT);
     return response;
   }
 
-  return std::make_unique<ItemResponse>(item, mimetype, byteRange);
+  return std::unique_ptr<Response>(new ItemResponse(
+        server.m_verbose.load(),
+        item,
+        mimetype,
+        byteRange));
 }
 
 MHD_Response*

src/server/response.h

@@ -27,7 +27,7 @@
 #include <mustache.hpp>
 #include "byte_range.h"
 #include "etag.h"
-#include "i18n_utils.h"
+#include "i18n.h"
 
 #include <zim/item.h>
 
@@ -41,6 +41,7 @@ class Archive;
 
 namespace kiwix {
 
+class InternalServer;
 class RequestContext;
 
 class Response {
@@ -53,15 +54,15 @@ class Response {
     };
 
   public:
-    Response();
+    Response(bool verbose);
     virtual ~Response() = default;
 
-    static std::unique_ptr<Response> build();
-    static std::unique_ptr<Response> build_304(const ETag& etag);
-    static std::unique_ptr<Response> build_416(size_t resourceLength);
-    static std::unique_ptr<Response> build_redirect(const std::string& redirectUrl);
+    static std::unique_ptr<Response> build(const InternalServer& server);
+    static std::unique_ptr<Response> build_304(const InternalServer& server, const ETag& etag);
+    static std::unique_ptr<Response> build_416(const InternalServer& server, size_t resourceLength);
+    static std::unique_ptr<Response> build_redirect(const InternalServer& server, const std::string& redirectUrl);
 
-    MHD_Result send(const RequestContext& request, bool verbose, MHD_Connection* connection);
+    MHD_Result send(const RequestContext& request, MHD_Connection* connection);
 
     void set_code(int code) { m_returnCode = code; }
     void set_kind(Kind k);
@@ -77,6 +78,7 @@ class Response {
 
   protected: // data
     Kind m_kind = DYNAMIC_CONTENT;
+    bool m_verbose;
     int m_returnCode;
     ByteRange m_byteRange;
     ETag m_etag;
@@ -89,21 +91,22 @@ class Response {
 class ContentResponse : public Response {
   public:
     ContentResponse(
+      const std::string& root,
+      bool verbose,
       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);
 
     static std::unique_ptr<ContentResponse> build(
+      const InternalServer& server,
       const std::string& template_str,
       kainjow::mustache::data data,
       const std::string& mimetype);
 
-    const std::string& getContent() const { return m_content; }
-    const std::string& getMimeType() const { return m_mimeType; }
-
   private:
     MHD_Response* create_mhd_response(const RequestContext& request);
 
@@ -111,6 +114,7 @@ class ContentResponse : public Response {
 
 
   private:
+    std::string m_root;
     std::string m_content;
     std::string m_mimeType;
  };
@@ -118,80 +122,99 @@ class ContentResponse : public Response {
 class ContentResponseBlueprint
 {
 public: // functions
-  ContentResponseBlueprint(const RequestContext* request,
+  ContentResponseBlueprint(const InternalServer* server,
+                           const RequestContext* request,
                            int httpStatusCode,
                            const std::string& mimeType,
-                           const std::string& templateStr,
-                           bool includeKiwixResponseData = false);
+                           const std::string& templateStr)
+    : m_server(*server)
+    , m_request(*request)
+    , m_httpStatusCode(httpStatusCode)
+    , m_mimeType(mimeType)
+    , m_template(templateStr)
+  {}
 
-  ~ContentResponseBlueprint();
+  virtual ~ContentResponseBlueprint() = default;
 
-  operator std::unique_ptr<Response>() const
+  operator std::unique_ptr<ContentResponse>() const
   {
     return generateResponseObject();
   }
 
-  std::unique_ptr<ContentResponse> generateResponseObject() const;
+  operator std::unique_ptr<Response>() const
+  {
+    return operator std::unique_ptr<ContentResponse>();
+  }
 
-protected: // types
-  class Data;
 
-protected: //data
+protected: // functions
+  std::string getMessage(const std::string& msgId) const;
+  virtual std::unique_ptr<ContentResponse> generateResponseObject() const;
+
+public: //data
+  const InternalServer& m_server;
   const RequestContext& m_request;
   const int m_httpStatusCode;
   const std::string m_mimeType;
   const std::string m_template;
-  const bool m_includeKiwixResponseData;
-  std::unique_ptr<Data> m_data;
-};
-
-struct NewHTTP404Response : ContentResponseBlueprint
-{
-  NewHTTP404Response(const RequestContext& request,
-                     const std::string& root,
-                     const std::string& urlPath);
+  kainjow::mustache::data m_data;
 };
 
 struct HTTPErrorResponse : ContentResponseBlueprint
 {
-  HTTPErrorResponse(const RequestContext& request,
+  HTTPErrorResponse(const InternalServer& server,
+                    const RequestContext& request,
                     int httpStatusCode,
                     const std::string& pageTitleMsgId,
                     const std::string& headingMsgId,
-                    const std::string& cssUrl = "",
-                    bool includeKiwixResponseData = false);
+                    const std::string& cssUrl = "");
 
+  HTTPErrorResponse& operator+(const std::string& msg);
   HTTPErrorResponse& operator+(const ParameterizedMessage& errorDetails);
   HTTPErrorResponse& operator+=(const ParameterizedMessage& errorDetails);
 };
 
+class UrlNotFoundMsg {};
+
+extern const UrlNotFoundMsg urlNotFoundMsg;
+
 struct HTTP404Response : HTTPErrorResponse
 {
-  explicit HTTP404Response(const RequestContext& request);
+  HTTP404Response(const InternalServer& server,
+                  const RequestContext& request);
+
+  using HTTPErrorResponse::operator+;
+  HTTPErrorResponse& operator+(UrlNotFoundMsg /*unused*/);
 };
 
-struct UrlNotFoundResponse : HTTP404Response
-{
-  explicit UrlNotFoundResponse(const RequestContext& request);
-};
+class InvalidUrlMsg {};
+
+extern const InvalidUrlMsg invalidUrlMsg;
 
 struct HTTP400Response : HTTPErrorResponse
 {
-  explicit HTTP400Response(const RequestContext& request);
+  HTTP400Response(const InternalServer& server,
+                  const RequestContext& request);
+
+  using HTTPErrorResponse::operator+;
+  HTTPErrorResponse& operator+(InvalidUrlMsg /*unused*/);
 };
 
-struct HTTP500Response : ContentResponseBlueprint
+struct HTTP500Response : HTTPErrorResponse
 {
-  HTTP500Response(const RequestContext& request,
-                  const std::string& root,
-                  const std::string& urlPath,
-                  const std::string& error = "");
+  HTTP500Response(const InternalServer& server,
+                  const RequestContext& request);
+
+private: // overrides
+  // generateResponseObject() is overriden in order to produce a minimal
+  // response without any need for additional resources from the server
+  std::unique_ptr<ContentResponse> generateResponseObject() const override;
 };
 
 class ItemResponse : public Response {
   public:
-    ItemResponse(const zim::Item& item, const std::string& mimetype, const ByteRange& byterange);
-    static std::unique_ptr<Response> build(const RequestContext& request, const zim::Item& item);
+    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);
 
   private:
     MHD_Response* create_mhd_response(const RequestContext& request);
@@ -200,13 +223,6 @@ class ItemResponse : public Response {
     std::string m_mimeType;
 };
 
-struct BlockExternalLinkResponse : ContentResponseBlueprint
-{
-  BlockExternalLinkResponse(const RequestContext& request,
-                            const std::string& root,
-                            const std::string& externalUrl);
-};
-
 }
 
 #endif //KIWIXLIB_SERVER_RESPONSE_H

src/spelling_correction.cpp

@@ -1,108 +0,0 @@
-/*
- * Copyright (C) 2025 Veloman Yunkan
- *
- * 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 "spelling_correction.h"
-#include "zim/archive.h"
-
-#include <sstream>
-#include <stdexcept>
-
-#include <xapian.h>
-
-namespace kiwix
-{
-
-namespace
-{
-
-std::vector<std::string> getAllTitles(const zim::Archive& a)
-{
-  std::vector<std::string> result;
-  for (const auto& entry : a.iterByPath() ) {
-     result.push_back(entry.getTitle());
-  }
-  return result;
-}
-
-void createXapianDB(std::string path, const zim::Archive& archive)
-{
-  const int flags = Xapian::DB_BACKEND_GLASS|Xapian::DB_CREATE;
-  const auto tmpDbPath = path + ".tmp";
-  Xapian::WritableDatabase db(tmpDbPath, flags);
-  for (const auto& t : getAllTitles(archive)) {
-    db.add_spelling(t);
-  }
-  db.commit();
-  db.compact(path, Xapian::DBCOMPACT_SINGLE_FILE);
-  db.close();
-  std::filesystem::remove_all(tmpDbPath);
-}
-
-std::string spellingsDBPathForZIMArchive(std::filesystem::path cacheDirPath, const zim::Archive& a)
-{
-  // The version of spellings DB must be updated each time an important change
-  // to the implementation is made that renders using the previous version
-  // impossible or undesirable.
-  const char SPELLINGS_DB_VERSION[] = "0.1";
-
-  std::ostringstream filename;
-  filename << a.getUuid() << ".spellingsdb.v" << SPELLINGS_DB_VERSION;
-  return (cacheDirPath / filename.str()).string();
-}
-
-std::unique_ptr<Xapian::Database> openOrCreateXapianDB(std::filesystem::path cacheDirPath, const zim::Archive& archive)
-{
-  const auto path = spellingsDBPathForZIMArchive(cacheDirPath, archive);
-  try
-  {
-    return std::make_unique<Xapian::Database>(path);
-  }
-  catch (const Xapian::DatabaseOpeningError& )
-  {
-    createXapianDB(path, archive);
-    return std::make_unique<Xapian::Database>(path);
-  }
-}
-
-} // unnamed namespace
-
-SpellingsDB::SpellingsDB(const zim::Archive& archive, std::filesystem::path cacheDirPath)
-  : impl_(openOrCreateXapianDB(cacheDirPath, archive))
-{
-}
-
-SpellingsDB::~SpellingsDB()
-{
-}
-
-std::vector<std::string> SpellingsDB::getSpellingCorrections(const std::string& word, uint32_t maxCount) const
-{
-  if ( maxCount > 1 ) {
-    throw std::runtime_error("More than one spelling correction was requested");
-  }
-
-  std::vector<std::string> result;
-  const auto term = impl_->get_spelling_suggestion(word, 3);
-  if ( !term.empty() ) {
-    result.push_back(term);
-  }
-  return result;
-}
-
-} // namespace kiwix

src/tools/languageTools.cpp

@@ -1,86 +0,0 @@
-#include "tools.h"
-#include "stringTools.h"
-#include <mutex>
-
-namespace kiwix
-{
-
-namespace
-{
-
-// These mappings are not provided by the ICU library, any such mappings can be manually added here
-std::map<std::string, std::string> iso639_3 = {
-    {"ami", "Amis"},
-    {"atj", "atikamekw"},
-    {"azb", "آذربایجان دیلی"},
-    {"bcl", "central bikol"},
-    {"bgs", "tagabawa"},
-    {"blk", "ပအိုဝ်ႏ"},
-    {"bxr", "буряад хэлэн"},
-    {"cbk", "chavacano"},
-    {"cdo", "閩東語"},
-    {"dag", "Dagbani"},
-    {"diq", "dimli"},
-    {"dty", "डोटेली"},
-    {"eml", "emiliân-rumagnōl"},
-    {"fbs", "српскохрватски"},
-    {"fon", "fɔ̀ngbè"},
-    {"gcr", "Kriyòl gwiyannen"},
-    {"guw", "Gungbe"},
-    {"hbs", "srpskohrvatski"},
-    {"hyw", "հայերէն/հայերեն"},
-    {"ido", "ido"},
-    {"kbp", "kabɩyɛ"},
-    {"kld", "Gamilaraay"},
-    {"lbe", "лакку маз"},
-    {"lbj", "ལ་དྭགས་སྐད་"},
-    {"lld", "ladin"},
-    {"map", "Austronesian"},
-    {"mhr", "марий йылме"},
-    {"mnw", "ဘာသာမန်"},
-    {"myn", "mayan"},
-    {"nah", "nahuatl"},
-    {"nai", "north American Indian"},
-    {"nds", "plattdütsch"},
-    {"nrm", "bhasa narom"},
-    {"olo", "livvi"},
-    {"pih", "Pitcairn-Norfolk"},
-    {"pnb", "Western Panjabi"},
-    {"pwn", "Pinayuanan"},
-    {"rmr", "Caló"},
-    {"rmy", "romani shib"},
-    {"roa", "romance languages"},
-    {"skr", "سرائیکی"},
-    {"szy", "Sakizaya"},
-    {"tay", "Tayal"},
-    {"tgl", "Wikang Tagalog"},
-    {"twi", "Akwapem Twi"},
-// ICU for Ubuntu versions <= focal (20.04) returns "" for the language code ""
-// unlike the later versions - which returns "und". We map this value to "Undetermined" for a common ground.
-    {"", "Undetermined"},
-};
-
-std::once_flag fillLanguagesFlag;
-
-void fillLanguagesMap()
-{
-    for (auto icuLangPtr = icu::Locale::getISOLanguages(); *icuLangPtr != NULL; ++icuLangPtr) {
-        const kiwix::ICULanguageInfo lang(*icuLangPtr);
-        iso639_3.insert({lang.iso3Code(), lang.selfName()});
-    }
-    iso639_3.erase("mul");
-}
-
-} // unnamed namespace
-
-std::string getLanguageSelfName(const std::string& lang)
-{
-    std::call_once(fillLanguagesFlag, fillLanguagesMap);
-    const auto itr = iso639_3.find(lang);
-    if (itr != iso639_3.end()) {
-        return itr->second;
-    }
-    return lang;
-};
-
-} // namespace kiwix

src/tools/networkTools.cpp

@@ -19,7 +19,6 @@
  */
 
 #include "tools.h"
-#include "stringTools.h"
 #include <tools/networkTools.h>
 
 #include <stdio.h>
@@ -33,30 +32,17 @@
 #include <stdexcept>
 
 #ifdef _WIN32
-#include <iphlpapi.h>
 #include <winsock2.h>
 #include <ws2tcpip.h>
 #include <iostream>
 #else
 #include <unistd.h>
-#include <arpa/inet.h>
-#include <ifaddrs.h>
+#include <sys/ioctl.h>
 #include <sys/socket.h>
-#include <netinet/in.h>
 #include <net/if.h>
 #include <netdb.h>
 #endif
 
-#ifdef __HAIKU__
-#include <sys/sockio.h>
-#endif
-
-namespace kiwix
-{
-
-namespace
-{
-
 size_t write_callback_to_iss(char* ptr, size_t size, size_t nmemb, void* userdata)
 {
   auto str = static_cast<std::stringstream*>(userdata);
@@ -64,15 +50,7 @@ size_t write_callback_to_iss(char* ptr, size_t size, size_t nmemb, void* userdat
   return nmemb;
 }
 
-void updatePublicIpAddress(IpAddress& publicIpAddr, const IpAddress& interfaceIpAddr)
-{
-  if (publicIpAddr.addr.empty())  publicIpAddr.addr  = interfaceIpAddr.addr;
-  if (publicIpAddr.addr6.empty()) publicIpAddr.addr6 = interfaceIpAddr.addr6;
-}
-
-} // unnamed namespace
-
-std::string download(const std::string& url) {
+std::string kiwix::download(const std::string& url) {
   auto curl = curl_easy_init();
   std::stringstream ss;
   curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
@@ -93,161 +71,103 @@ std::string download(const std::string& url) {
   return ss.str();
 }
 
-namespace
-{
+std::map<std::string, std::string> kiwix::getNetworkInterfaces() {
+  std::map<std::string, std::string> interfaces;
 
 #ifdef _WIN32
-
-std::map<std::string, IpAddress> getNetworkInterfacesWin() {
-  std::map<std::string, IpAddress> interfaces;
-
-  const int working_buffer_size = 15000;
-  const int max_tries = 3;
-
-  ULONG flags = GAA_FLAG_INCLUDE_PREFIX;
-
-  // default to unspecified address family (both)
-  ULONG family = AF_UNSPEC;
-
-  ULONG outBufLen = working_buffer_size;
-  ULONG Iterations = 0;
-  DWORD dwRetVal = 0;
-  PIP_ADAPTER_ADDRESSES interfacesHead = NULL;
-
-  // Successively allocate the required memory until GetAdaptersAddresses does not
-  // results in ERROR_BUFFER_OVERFLOW for a maximum of max_tries
-  do{
-    interfacesHead = (IP_ADAPTER_ADDRESSES *) malloc(outBufLen);
-    if (interfacesHead == NULL) {
-      std::cerr << "Memory allocation failed for IP_ADAPTER_ADDRESSES struct" << std::endl;
-      return interfaces;
-    }
-
-    dwRetVal = GetAdaptersAddresses(family, flags, NULL, interfacesHead, &outBufLen);
-  } while ((dwRetVal == ERROR_BUFFER_OVERFLOW) && (Iterations < max_tries));
-
-  if (dwRetVal == NO_ERROR) {
-    PIP_ADAPTER_UNICAST_ADDRESS pUnicast = NULL;
-    unsigned int i = 0;
-    for (PIP_ADAPTER_ADDRESSES temp = interfacesHead; temp != NULL;
-    temp = temp->Next) {
-      pUnicast = temp->FirstUnicastAddress;
-            if (pUnicast != NULL) {
-                for (i = 0; pUnicast != NULL; i++){
-                  if (pUnicast->Address.lpSockaddr->sa_family == AF_INET)
-                  {
-                      sockaddr_in *si = (sockaddr_in *)(pUnicast->Address.lpSockaddr);
-                      char host[INET_ADDRSTRLEN]={0};
-                      inet_ntop(AF_INET, &(si->sin_addr), host, sizeof(host));
-                      interfaces[temp->AdapterName].addr=host;
-                  }
-                  else if (pUnicast->Address.lpSockaddr->sa_family == AF_INET6)
-                  {
-                      sockaddr_in6 *si = (sockaddr_in6 *)(pUnicast->Address.lpSockaddr);
-                      char host[INET6_ADDRSTRLEN]={0};
-                      inet_ntop(AF_INET6, &(si->sin6_addr), host, sizeof(host));
-                      if (!IN6_IS_ADDR_LINKLOCAL(&(si->sin6_addr)))
-                        interfaces[temp->AdapterName].addr6=host;
-                  }
-                  pUnicast = pUnicast->Next;
-                }
-            }
-    }
-  } else {
-    std::cerr << "Call to GetAdaptersAddresses failed with error: "<< dwRetVal << std::endl;
+  SOCKET sd = WSASocket(AF_INET, SOCK_DGRAM, 0, 0, 0, 0);
+  if (sd == INVALID_SOCKET) {
+    std::cerr << "Failed to get a socket. Error " << WSAGetLastError() << std::endl;
+    return interfaces;
   }
 
-  if (interfacesHead) free(interfacesHead);
+  INTERFACE_INFO InterfaceList[20];
+  unsigned long nBytesReturned;
+  if (WSAIoctl(sd, SIO_GET_INTERFACE_LIST, 0, 0, &InterfaceList,
+      sizeof(InterfaceList), &nBytesReturned, 0, 0) == SOCKET_ERROR) {
+    std::cerr << "Failed calling WSAIoctl: error " << WSAGetLastError() << std::endl;
+    return interfaces;
+  }
 
+  int nNumInterfaces = nBytesReturned / sizeof(INTERFACE_INFO);
+  for (int i = 0; i < nNumInterfaces; ++i) {
+    sockaddr_in *pAddress;
+    pAddress = (sockaddr_in *) & (InterfaceList[i].iiAddress.AddressIn);
+    if(pAddress->sin_family == AF_INET) {
+    /* Add to the map */
+    std::string interfaceName = std::string(inet_ntoa(pAddress->sin_addr));
+    interfaces[interfaceName] = interfaceName;
+    }
+  }
+#else
+  /* Get Network interfaces information */
+  char buf[16384];
+  struct ifconf ifconf;
+  int fd = socket(PF_INET, SOCK_DGRAM, 0); /* Only IPV4 */
+  ifconf.ifc_len = sizeof(buf);
+  ifconf.ifc_buf=buf;
+  if(ioctl(fd, SIOCGIFCONF, &ifconf)!=0) {
+    perror("ioctl(SIOCGIFCONF)");
+  }
+
+  /* Go through each interface */
+  struct ifreq *ifreq;
+  ifreq = ifconf.ifc_req;
+  for (int i = 0; i < ifconf.ifc_len; ) {
+    if (ifreq->ifr_addr.sa_family == AF_INET) {
+      /* Get the network interface ip */
+      char host[128] = { 0 };
+      const int error = getnameinfo(&(ifreq->ifr_addr), sizeof(ifreq->ifr_addr),
+                                    host, sizeof(host),
+                                    0, 0, NI_NUMERICHOST);
+      if (!error) {
+        std::string interfaceName = std::string(ifreq->ifr_name);
+        std::string interfaceIp = std::string(host);
+        /* Add to the map */
+        interfaces[interfaceName] = interfaceIp;
+      } else {
+        perror("getnameinfo()");
+      }
+    }
+
+    /* some systems have ifr_addr.sa_len and adjust the length that
+     * way, but not mine. weird */
+    size_t len;
+#ifndef __linux__
+    len = IFNAMSIZ + ifreq->ifr_addr.sa_len;
+#else
+    len = sizeof(*ifreq);
+#endif
+    ifreq = (struct ifreq*)((char*)ifreq+len);
+    i += len;
+  }
+#endif
   return interfaces;
 }
 
-#else
+std::string kiwix::getBestPublicIp() {
+  auto interfaces = getNetworkInterfaces();
 
-std::map<std::string, IpAddress> getNetworkInterfacesPosix() {
-  std::map<std::string, IpAddress> interfaces;
-
-  struct ifaddrs *interfacesHead;
-  if (getifaddrs(&interfacesHead) == -1) {
-      perror("getifaddrs");
-  }
-
-  for (ifaddrs *temp = interfacesHead; temp != NULL; temp = temp->ifa_next) {
-      if (temp->ifa_addr == NULL) continue;
-
-      if (temp->ifa_addr->sa_family == AF_INET) {
-          sockaddr_in *si = (sockaddr_in *)(temp->ifa_addr);
-          char host[INET_ADDRSTRLEN] = {0};
-          inet_ntop(AF_INET, &(si->sin_addr), host, sizeof(host));
-          interfaces[temp->ifa_name].addr=host;
-      } else if (temp->ifa_addr->sa_family == AF_INET6) {
-          sockaddr_in6 *si = (sockaddr_in6 *)(temp->ifa_addr);
-          char host[INET6_ADDRSTRLEN] = {0};
-          inet_ntop(AF_INET6, &(si->sin6_addr), host, sizeof(host));
-          if (!IN6_IS_ADDR_LINKLOCAL(&(si->sin6_addr)))
-            interfaces[temp->ifa_name].addr6=host;
-      }
-  }
-
-  freeifaddrs(interfacesHead);
-
-  return interfaces;
-}
-
-#endif
-
-} // unnamed namespace
-
-std::map<std::string, IpAddress> getNetworkInterfacesIPv4Or6() {
-#ifdef _WIN32
-  return getNetworkInterfacesWin();
-#else
-  return getNetworkInterfacesPosix();
-#endif
-}
-
-std::map<std::string, std::string> getNetworkInterfaces() {
-  std::map<std::string, std::string> result;
-  for ( const auto& kv : getNetworkInterfacesIPv4Or6() ) {
-      const std::string& interfaceName = kv.first;
-      const auto& ipAddresses = kv.second;
-      if ( !ipAddresses.addr.empty() ) {
-        result[interfaceName] = ipAddresses.addr;
-      }
-  }
-  return result;
-}
-
-IpAddress getBestPublicIps() {
-  IpAddress bestPublicIps;
-  std::map<std::string, IpAddress> interfaces = getNetworkInterfacesIPv4Or6();
 #ifndef _WIN32
-  const char* const prioritizedNames[] = { "eth0", "eth1", "wlan0", "wlan1", "en0", "en1" };
-  for (const auto& name : prioritizedNames) {
-    const auto it = interfaces.find(name);
-    if (it != interfaces.end()) {
-      updatePublicIpAddress(bestPublicIps, it->second);
+  const char* const prioritizedNames[] =
+      { "eth0", "eth1", "wlan0", "wlan1", "en0", "en1" };
+  for(auto name: prioritizedNames) {
+    auto it = interfaces.find(name);
+    if(it != interfaces.end()) {
+      return it->second;
     }
   }
 #endif
-  const char* const v4prefixes[] = { "192.168", "172.16", "10.0" };
-  for (const auto& prefix : v4prefixes) {
-    for (const auto& kv : interfaces) {
-      const auto& interfaceIps = kv.second;
-      if (kiwix::startsWith(interfaceIps.addr, prefix)) {
-        updatePublicIpAddress(bestPublicIps, interfaceIps);
+
+  const char* const prefixes[] = { "192.168", "172.16.", "10.0" };
+  for(auto prefix : prefixes){
+    for(auto& itr : interfaces) {
+      auto interfaceIp = itr.second;
+      if (interfaceIp.find(prefix) == 0) {
+        return interfaceIp;
       }
     }
   }
 
-  updatePublicIpAddress(bestPublicIps, {"127.0.0.1", "::1"});
-
-  return bestPublicIps;
+  return "127.0.0.1";
 }
-
-std::string getBestPublicIp()
-{
-  return getBestPublicIps().addr;
-}
-
-} // namespace kiwix

src/tools/opdsParsingTools.cpp

@@ -1,70 +0,0 @@
-#include "tools.h"
-#include <pugixml.hpp>
-
-namespace kiwix
-{
-
-namespace
-{
-#define VALUE(name) entryNode.child(name).child_value()
-FeedLanguages parseLanguages(const pugi::xml_document& doc)
-{
-    pugi::xml_node feedNode = doc.child("feed");
-    FeedLanguages langs;
-
-    for (pugi::xml_node entryNode = feedNode.child("entry"); entryNode;
-        entryNode = entryNode.next_sibling("entry")) {
-            auto title = VALUE("title");
-            auto code = VALUE("dc:language");
-            langs.push_back({code, title});
-    }
-
-    return langs;
-}
-
-FeedCategories parseCategories(const pugi::xml_document& doc)
-{
-    pugi::xml_node feedNode = doc.child("feed");
-    FeedCategories categories;
-
-    for (pugi::xml_node entryNode = feedNode.child("entry"); entryNode;
-        entryNode = entryNode.next_sibling("entry")) {
-            auto title = VALUE("title");
-            categories.push_back(title);
-    }
-
-    return categories;
-}
-
-} // unnamed namespace
-
-FeedLanguages readLanguagesFromFeed(const std::string& content)
-{
-    pugi::xml_document doc;
-    pugi::xml_parse_result result
-        = doc.load_buffer((void*)content.data(), content.size());
-
-    if (result) {
-        auto langs = parseLanguages(doc);
-        return langs;
-    }
-
-    return FeedLanguages();
-}
-
-FeedCategories readCategoriesFromFeed(const std::string& content)
-{
-    pugi::xml_document doc;
-    pugi::xml_parse_result result
-        = doc.load_buffer((void*)content.data(), content.size());
-
-    FeedCategories categories;
-    if (result) {
-        categories = parseCategories(doc);
-        return categories;
-    }
-
-    return categories;
-}
-
-} // namespace kiwix

src/tools/otherTools.cpp

@@ -32,7 +32,7 @@
 #endif
 
 #include "tools/stringTools.h"
-#include "server/i18n_utils.h"
+#include "server/i18n.h"
 #include "libkiwix-resources.h"
 
 #include <map>
@@ -327,37 +327,22 @@ std::string kiwix::render_template(const std::string& template_str, kainjow::mus
   return ss.str();
 }
 
-// The escapeQuote parameter of escapeForJSON() defaults to true.
-// This constant makes the calls to escapeForJSON() where the quote symbol
-// should not be escaped (as it is later replaced with the HTML character entity
-// &quot;) more readable.
-static const bool DONT_ESCAPE_QUOTE = false;
-
-std::string kiwix::escapeForJSON(const std::string& s, bool escapeQuote)
-{
-  std::ostringstream oss;
-  for (char c : s) {
-    if ( c == '\\' ) {
-      oss << "\\\\";
-    } else if ( unsigned(c) < 0x20U ) {
-      switch ( c ) {
-      case '\n': oss << "\\n"; break;
-      case '\r': oss << "\\r"; break;
-      case '\t': oss << "\\t"; break;
-      default:   oss << "\\u" << std::setw(4) << std::setfill('0') << unsigned(c);
-      }
-    } else if ( c == '"' && escapeQuote ) {
-      oss << "\\\"";
-    } else {
-      oss << c;
-    }
-  }
-  return oss.str();
-}
-
 namespace
 {
 
+std::string escapeBackslashes(const std::string& s)
+{
+  std::string es;
+  es.reserve(s.size());
+  for (char c : s) {
+    if ( c == '\\' ) {
+      es.push_back('\\');
+    }
+    es.push_back(c);
+  }
+  return es;
+}
+
 std::string makeFulltextSearchSuggestion(const std::string& lang,
                                          const std::string& queryString)
 {
@@ -383,10 +368,10 @@ void kiwix::Suggestions::add(const zim::SuggestionItem& suggestion)
                           ? suggestion.getSnippet()
                           : suggestion.getTitle();
 
-  result.set("label", escapeForJSON(label, DONT_ESCAPE_QUOTE));
-  result.set("value", escapeForJSON(suggestion.getTitle(), DONT_ESCAPE_QUOTE));
+  result.set("label", escapeBackslashes(label));
+  result.set("value", escapeBackslashes(suggestion.getTitle()));
   result.set("kind", "path");
-  result.set("path", escapeForJSON(suggestion.getPath(), DONT_ESCAPE_QUOTE));
+  result.set("path", escapeBackslashes(suggestion.getPath()));
   result.set("first", m_data.is_empty_list());
   m_data.push_back(result);
 }
@@ -396,8 +381,8 @@ void kiwix::Suggestions::addFTSearchSuggestion(const std::string& uiLang,
 {
   kainjow::mustache::data result;
   const std::string label = makeFulltextSearchSuggestion(uiLang, queryString);
-  result.set("label", escapeForJSON(label, DONT_ESCAPE_QUOTE));
-  result.set("value", escapeForJSON(queryString + " ", DONT_ESCAPE_QUOTE));
+  result.set("label", escapeBackslashes(label));
+  result.set("value", escapeBackslashes(queryString + " "));
   result.set("kind", "pattern");
   result.set("first", m_data.is_empty_list());
   m_data.push_back(result);

src/tools/pathTools.cpp

@@ -320,6 +320,16 @@ bool kiwix::fileReadable(const std::string& path)
 #endif
 }
 
+bool makeDirectory(const std::string& path)
+{
+#ifdef _WIN32
+  int status = _wmkdir(Utf8ToWide(path).c_str());
+#else
+  int status = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
+#endif
+  return status == 0;
+}
+
 std::string makeTmpDirectory()
 {
 #ifdef _WIN32
@@ -428,6 +438,52 @@ std::string kiwix::getCurrentDirectory()
   return ret;
 }
 
+std::string kiwix::getDataDirectory()
+{
+// Try to get the dataDir from the `KIWIX_DATA_DIR` env var
+#ifdef _WIN32
+  wchar_t* cDataDir = ::_wgetenv(L"KIWIX_DATA_DIR");
+  if (cDataDir != nullptr) {
+    return WideToUtf8(cDataDir);
+  }
+#else
+  char* cDataDir = ::getenv("KIWIX_DATA_DIR");
+  if (cDataDir != nullptr) {
+    return cDataDir;
+  }
+#endif
+
+// Compute the dataDir from the user directory.
+  std::string dataDir;
+#ifdef _WIN32
+  cDataDir = ::_wgetenv(L"APPDATA");
+  if (cDataDir == nullptr)
+    cDataDir = ::_wgetenv(L"USERPROFILE");
+  if (cDataDir != nullptr)
+    dataDir = WideToUtf8(cDataDir);
+#else
+  cDataDir = ::getenv("XDG_DATA_HOME");
+  if (cDataDir != nullptr) {
+    dataDir = cDataDir;
+  } else {
+    cDataDir = ::getenv("HOME");
+    if (cDataDir != nullptr) {
+      dataDir = cDataDir;
+      dataDir = appendToDirectory(dataDir, ".local");
+      dataDir = appendToDirectory(dataDir, "share");
+    }
+  }
+#endif
+  if (!dataDir.empty()) {
+    dataDir = appendToDirectory(dataDir, "kiwix");
+    makeDirectory(dataDir);
+    return dataDir;
+  }
+
+// Let's use the currentDirectory
+  return getCurrentDirectory();
+}
+
 static std::map<std::string, std::string> extMimeTypes = {
  { "html", "text/html"},
  { "htm", "text/html"},
@@ -437,14 +493,12 @@ static std::map<std::string, std::string> extMimeTypes = {
  { "jpeg", "image/jpeg"},
  { "jpg", "image/jpeg"},
  { "gif", "image/gif"},
- { "ico", "image/x-icon"},
  { "svg", "image/svg+xml"},
  { "txt", "text/plain"},
  { "xml", "text/xml"},
  { "pdf", "application/pdf"},
  { "ogg", "application/ogg"},
  { "js", "application/javascript"},
- { "json", "application/json"},
  { "css", "text/css"},
  { "otf", "application/vnd.ms-opentype"},
  { "ttf", "application/font-ttf"},

src/tools/pathTools.h

@@ -29,6 +29,7 @@ std::wstring Utf8ToWide(const std::string& str);
 
 unsigned int getFileSize(const std::string& path);
 std::string getFileSizeAsString(const std::string& path);
+bool makeDirectory(const std::string& path);
 std::string makeTmpDirectory();
 bool copyFile(const std::string& sourcePath, const std::string& destPath);
 bool writeTextFile(const std::string& path, const std::string& content);

src/tools/stringTools.cpp

@@ -32,7 +32,6 @@
 
 #include <iostream>
 #include <iomanip>
-#include <regex>
 
 /* tell ICU where to find its dat file (tables) */
 void kiwix::loadICUExternalTables()
@@ -209,6 +208,43 @@ bool isHarmlessUriChar(char c)
   return false;
 }
 
+bool mustBeUriEncodedFor(kiwix::URIComponentKind target, char c)
+{
+  if (isHarmlessUriChar(c))
+    return false;
+
+  switch (c) {
+  case '/': // There is no reason to encode the path separator in the general
+            // case. It must be encoded only in a path component when its
+            // semantics of a path separator has to be suppressed.
+            return false;
+
+  case '@': // In a relative URL of the form abc@def/xyz (with no / in abc)
+            // a non-encoded @ will make "abc" and "def" to be interpreted as
+            // username and host components, respectively
+            return target == kiwix::URIComponentKind::PATH;
+
+  case ':': // In a relative URL of the form abc:def/xyz (with no / in abc)
+            // a non-encoded : will make "abc" and "def" to be interpreted as
+            // host and port components, respectively
+            return target == kiwix::URIComponentKind::PATH;
+
+  case '?': // A non-encoded '?' acts as a separator between the path
+            // and query components
+            return target == kiwix::URIComponentKind::PATH;
+
+  case '&': return target == kiwix::URIComponentKind::QUERY;
+  case '=': return target == kiwix::URIComponentKind::QUERY;
+  case '+': return target == kiwix::URIComponentKind::QUERY;
+
+  case '#': // A non-encoded '#' in either path or query-component
+            // would mark the beginning of the fragment component
+            return true;
+  }
+
+  return true;
+}
+
 int hexToInt(char c) {
   switch (c) {
   case '0': return 0;
@@ -248,6 +284,26 @@ std::string kiwix::urlEncode(const std::string& value)
   return os.str();
 }
 
+namespace kiwix
+{
+
+std::string uriEncode(URIComponentKind target, const std::string& value)
+{
+  std::ostringstream os;
+  os << std::hex << std::uppercase;
+  for (const char c : value) {
+    if ( mustBeUriEncodedFor(target, c)  ) {
+      const unsigned int charVal = static_cast<unsigned char>(c);
+      os << '%' << std::setw(2) << std::setfill('0') << charVal;
+    } else {
+      os << c;
+    }
+  }
+  return os.str();
+}
+
+} // namespace kiwix
+
 std::string kiwix::urlDecode(const std::string& value, bool component)
 {
   std::ostringstream os;
@@ -257,7 +313,7 @@ std::string kiwix::urlDecode(const std::string& value, bool component)
 
     // If there aren't enough characters left for this to be a
     // valid escape code, just use the character and move on
-    if (value.end() - it < 3) {
+    if (it > value.end() - 3) {
       os << *it;
       continue;
     }
@@ -416,17 +472,6 @@ bool kiwix::startsWith(const std::string& base, const std::string& start)
         && std::equal(start.begin(), start.end(), base.begin());
 }
 
-std::string kiwix::stripSuffix(const std::string& str, const std::string& suffix)
-{
-  if (str.size() > suffix.size()) {
-    const auto subStr = str.substr(str.size() - suffix.size(), str.size());
-    if (subStr == suffix) {
-      return str.substr(0, str.size() - suffix.size());
-    }
-  }
-  return str;
-}
-
 std::vector<std::string> kiwix::getTitleVariants(const std::string& title) {
   std::vector<std::string> variants;
   variants.push_back(title);
@@ -440,13 +485,3 @@ template<>
 std::string kiwix::extractFromString(const std::string& str) {
   return str;
 }
-
-std::string kiwix::getSlugifiedFileName(const std::string& filename)
-{
-#ifdef _WIN32
-  const std::regex reservedCharsReg(R"([<>:"/\\|?*])");
-#else
-  const std::regex reservedCharsReg("/");
-#endif
-  return std::regex_replace(filename, reservedCharsReg, "_"); 
-}

src/tools/stringTools.h

@@ -31,6 +31,7 @@
 namespace kiwix
 {
 std::string beautifyInteger(uint64_t number);
+std::string beautifyFileSize(uint64_t number);
 void printStringInHexadecimal(const char* s);
 void printStringInHexadecimal(icu::UnicodeString s);
 void stringReplacement(std::string& str,
@@ -53,22 +54,29 @@ private:
   const icu::Locale locale;
 };
 
-std::string escapeForJSON(const std::string& s, bool escapeQuote = true);
 
 /* urlEncode() is the equivalent of JS encodeURIComponent(), with the only
  * difference that the slash (/) symbol is NOT encoded. */
 std::string urlEncode(const std::string& value);
 std::string urlDecode(const std::string& value, bool component = false);
 
+// Only URI components that are of interest to libkiwix
+// are included in the below enumeration type
+enum class URIComponentKind
+{
+  PATH,
+  QUERY
+};
+
+// Encode 'value' for usage in a URI componenet specified by 'target'
+std::string uriEncode(URIComponentKind target, const std::string& value);
+
 std::string join(const std::vector<std::string>& list, const std::string& sep);
 
 std::string ucAll(const std::string& word);
 std::string lcAll(const std::string& word);
 std::string ucFirst(const std::string& word);
 std::string lcFirst(const std::string& word);
-
-/* This function is broken, related Github issue 
- * https://github.com/kiwix/libkiwix/issues/1188 */ 
 std::string toTitle(const std::string& word);
 
 std::string normalize(const std::string& word);
@@ -96,8 +104,6 @@ std::string extractFromString(const std::string& str);
 
 bool startsWith(const std::string& base, const std::string& start);
 
-std::string stripSuffix(const std::string& str, const std::string& suffix);
-
 std::vector<std::string> getTitleVariants(const std::string& title);
 } //namespace kiwix
 #endif

static/generate_i18n_resources_list.py

@@ -17,44 +17,15 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 from pathlib import Path
-import json
 
 script_path = Path(__file__)
 
 resource_file = script_path.parent / "i18n_resources_list.txt"
-translation_dir = script_path.parent / "skin/i18n"
-language_list_relpath = "skin/languages.js"
+translation_dir = script_path.parent / "i18n"
 
-def get_translation_info(filepath):
-    lang_code = Path(filepath).stem
-    with open(filepath, 'r', encoding="utf-8") as f:
-        content = json.load(f)
-        lang_name = content.get("name")
-        translation_count = len(content)
-        return dict(iso_code=lang_code,
-                    self_name=lang_name,
-                    translation_count=translation_count)
-
-language_list = []
 json_files = translation_dir.glob("*.json")
 with open(resource_file, 'w', encoding="utf-8") as f:
-    for i18n_file in sorted(translation_dir.glob("*.json")):
-        if i18n_file.name == "qqq.json":
+    for json in sorted(translation_dir.glob("*.json")):
+        if json.name == "qqq.json":
             continue
-        print("Processing", i18n_file.name)
-        if i18n_file.name != "test.json":
-            translation_info = get_translation_info(i18n_file)
-            lang_name = translation_info["self_name"]
-            if lang_name:
-                language_list.append(translation_info)
-            else:
-                print(f"Warning: missing 'name' in {i18n_file.name}")
-        f.write(str(i18n_file.relative_to(script_path.parent)) + '\n')
-
-language_list_jsobj_str = json.dumps(language_list,
-                                     indent=2,
-                                     ensure_ascii=False)
-print("Saving", language_list_relpath)
-fullpath = script_path.parent / language_list_relpath
-with open(fullpath, 'w', encoding="utf-8") as f:
-    f.write("const uiLanguages = " + language_list_jsobj_str)
+        f.write(str(json.relative_to(script_path.parent)) + '\n')

static/i18n/ar.json

@@ -0,0 +1,33 @@
+{
+	"@metadata": {
+		"authors": [
+			"Asma",
+			"Ravan",
+			"محمد أحمد عبد الفتاح"
+		]
+	},
+	"name": "الإنجليزية",
+	"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}}\"",
+	"confusion-of-tongues": "قد يشارك في البحث كتابان أو أكثر بلغات مختلفة، مما قد يؤدي إلى نتائج محيرة."
+}

static/i18n/bn.json

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

static/i18n/de.json

@@ -0,0 +1,20 @@
+{
+	"@metadata": {
+		"authors": [
+			"Lucas Werkmeister",
+			"ThisCarthing"
+		]
+	},
+	"name": "Deutsch",
+	"random-article-failure": "Hoppla! Konnte keinen zufälligen Artikel auswählen :(",
+	"400-page-title": "Ungültige Anfrage",
+	"400-page-heading": "Ungültige Anfrage",
+	"404-page-title": "Inhalt nicht gefunden",
+	"404-page-heading": "Nicht gefunden",
+	"500-page-title": "Interner Server-Fehler",
+	"500-page-heading": "Interner Server-Fehler",
+	"library-button-text": "Zur Willkommensseite gehen",
+	"home-button-text": "Zur Hauptseite von '{{BOOK_TITLE}}' gehen",
+	"random-page-button-text": "Zu einer zufällig ausgewählten Seite gehen",
+	"searchbox-tooltip": "Nach '{{BOOK_TITLE}}' suchen"
+}

static/i18n/en.json

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

static/i18n/fr.json

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

static/i18n/he.json

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

static/i18n/hy.json

@@ -13,20 +13,8 @@
 	"400-page-heading": "Անվավեր հարցում",
 	"404-page-title": "Սխալ հասցե",
 	"404-page-heading": "Սխալ հասցե",
-	"500-img-text": "Էջը չի աշխատում",
 	"library-button-text": "Գրադարանի էջ",
 	"home-button-text": "Դեպի '{{BOOK_TITLE}}'֊ի գլխավոր էջը",
 	"random-page-button-text": "Բացել պատահական էջ",
-	"searchbox-tooltip": "Որոնել '{{BOOK_TITLE}}'֊ում",
-	"book-filtering-all-categories": "Բոլոր կատեգորիաներ",
-	"book-category.wikibooks": "Վիքիգրքեր",
-	"book-category.wikinews": "Վիքիլուրեր",
-	"book-category.wikipedia": "Վիքիպեդիա",
-	"book-category.wikiquote": "Վիքիքաղվածք",
-	"book-category.wikisource": "Վիքիդարան",
-	"book-category.wikispecies": "Վիքիցեղեր",
-	"book-category.wikiversity": "Վիքիլսարան",
-	"book-category.wikivoyage": "Վիքիճամփորդ",
-	"book-category.wiktionary": "Վիքիբառարան",
-	"book-category.other": "Այլ"
+	"searchbox-tooltip": "Որոնել '{{BOOK_TITLE}}'֊ում"
 }

static/i18n/it.json

@@ -0,0 +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",
+	"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/ja.json

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

static/i18n/ko.json

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

static/i18n/mk.json

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

static/i18n/nqo.json

@@ -27,23 +27,5 @@
 	"library-button-text": "ߕߊ߯ ߟߊ߬ߛߣߍ߬ߟߌ߫ ߞߐߜߍ ߞߊ߲߬",
 	"home-button-text": "ߕߊ߯ {{BOOK_TITLE}} ߓߏ߬ߟߏ߲߬ߘߊ ߞߐߜߍ ߞߊ߲߬",
 	"random-page-button-text": "ߕߊ߯ ߓߍ߲߬ߛߋ߲߬ߡߊ߬ ߞߐߜߍ߫ ߛߎߥߊ߲ߘߌߣߍ߲ ߠߎ߬ ߞߊ߲߬",
-	"searchbox-tooltip": "ߕߌߙߌ߲ߠߌ߲ {{BOOK_TITLE}}",
-	"confusion-of-tongues": "ߞߊ߬ߝߊ߫ ߝߌ߬ߟߊ߬ ߥߟߊ߫ ߦߙߌߞߊ ߞߊ߲߫ ߜߘߍ ߟߎ߬ ߘߐ߫߸ ߏ߬ ߟߎ߫ ߘߌߣߊ߬ ߕߘߍ߬ ߢߌߣߌ߲ߠߌ߲ ߘߐ߫߸ ߡߍ߲ ߠߎ߬ ߛߌ߫ ߞߣߐ߬ߝߟߌ ߟߊߘߏ߲߬ ߠߊ߫ ߞߐߝߟߌ ߘߐ߫.",
-	"welcome-page-overzealous-filter": "ߞߐߝߟߌ߫ ߕߴߦߋ߲߬. ߊ߬ ߝߐ߫ ߌ ߦߴߊ߬ ߝߍ߬ ߞߊ߬ <a href=\"{{URL}}\">ߛߍ߲ߛߍ߲ߟߊ߲ ߘߐߛߌ߰ ߕߎ߲߯</a>؟",
-	"search": "ߢߌߣߌ߲ߠߌ߲",
-	"book-filtering-all-categories": "ߦߌߟߡߊ ߟߎ߬ ߓߍ߯",
-	"book-filtering-all-languages": "ߞߊ߲ ߠߎ߬ ߓߍ߯",
-	"count-of-matching-books": "ߞߊ߬ߝߊ {{COUNT}}(ߟߎ߫)",
-	"download": "ߟߊ߬ߖߌ߰ߒ߬ߞߎ߲߬ߠߌ߲",
-	"direct-download-link-text": "ߒߕߋߟߋ߲ߡߊ߬",
-	"direct-download-alt-text": "ߟߊ߬ߖߌ߰ߒ߬ߞߎ߲߬ߠߌ߲߫ ߝߊ߲ߞߢߊ",
-	"hash-download-alt-text": "ߤߊߛ߭ ߟߊߖߌ߰ ߌ ߞߎ߲߬",
-	"magnet-link-text": "ߡߊߢߍߕ ߛߘߌ߬ߜߋ߲",
-	"magnet-alt-text": "ߡߊߢߍߕ ߟߊߖߌ߰ ߌ ߞߎ߲߬",
-	"torrent-download-link-text": "ߕߏߙߍ߲ߕ ߞߐߕߐ߮",
-	"torrent-download-alt-text": "ߕߏߙߍ߲ߕ ߟߊߖߌ߰ ߌ ߞߎ߲߬",
-	"welcome-to-kiwix-server": "ߌ ߣߌ߫ ߛߣߍ߫ ߞߥߌߞߛ ߡߊߛߐߟߊ߲ ߞߣߐ߫",
-	"download-links-heading": "<b><i>{{BOOK_TITLE}}</i></b> ߛߘߌ߬ߜߋ߲ ߠߊߖߌ߰ ߌ ߞߎ߲߬",
-	"download-links-title": "ߞߊ߬ߝߊ ߟߊߖߌ߰ ߌ ߞߎ߲߬",
-	"preview-book": "ߊ߬ ߘߐߜߍ߫ ߡߎߣߎ߲߬"
+	"searchbox-tooltip": "ߕߌߙߌ߲ߠߌ߲ {{BOOK_TITLE}}"
 }

static/i18n/pl.json

@@ -1,8 +1,7 @@
 {
 	"@metadata": {
 		"authors": [
-			"Strebski",
-			"WaldiSt"
+			"Strebski"
 		]
 	},
 	"name": "Polski",
@@ -24,16 +23,5 @@
 	"library-button-text": "Przejdź do strony powitalnej",
 	"home-button-text": "Przejdź do głównej strony '{{BOOK_TITLE}}'",
 	"random-page-button-text": "Przejdź do losowo wybranej strony",
-	"searchbox-tooltip": "Szukaj '{{BOOK_TITLE}}'",
-	"search": "Szukaj",
-	"book-filtering-all-categories": "Wszystkie Kategorie",
-	"book-filtering-all-languages": "Wszystkie języki",
-	"download": "Pobierz",
-	"direct-download-link-text": "Bezpośrednio",
-	"direct-download-alt-text": "bezpośrednie pobieranie",
-	"torrent-download-link-text": "Plik torrent",
-	"welcome-to-kiwix-server": "Witamy na serwerze Kiwix",
-	"download-links-title": "Pobierz książkę",
-	"preview-book": "Podgląd",
-	"book-category.other": "Inne"
+	"searchbox-tooltip": "Szukaj '{{BOOK_TITLE}}'"
 }

static/i18n/qqq.json

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

static/i18n/ru.json

@@ -0,0 +1,35 @@
+{
+	"@metadata": {
+		"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": "Содержание не найдено",
+	"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}}'",
+	"confusion-of-tongues": "В поиске будут участвовать две или более книг на разных языках, что может привести к запутанным результатам."
+}

static/i18n/sc.json

@@ -1,7 +1,6 @@
 {
 	"@metadata": {
 		"authors": [
-			"Kelson",
 			"L2212"
 		]
 	},
@@ -29,28 +28,5 @@
 	"home-button-text": "Bae a sa pàgina printzipale de '{{BOOK_TITLE}}'",
 	"random-page-button-text": "Bae a una pàgina seletzionada a manera casuale",
 	"searchbox-tooltip": "Chirca '{{BOOK_TITLE}}'",
-	"confusion-of-tongues": "Duos o prus libros in limbas diferentes diant pigare parte a sa chirca, cosa chi diat pòdere causare resurtados confusionosos.",
-	"welcome-page-overzealous-filter": "Perunu resurtadu. Boles <a href=\"{{URL}}\">resetare su filtru</a>?",
-	"powered-by-kiwix-html": "Alimentadu dae&nbsp;<a href=\"https://kiwix.org\">Kiwix</a>",
-	"search": "Chirca",
-	"book-filtering-all-categories": "Totu sas categorias",
-	"book-filtering-all-languages": "Totu sas limbas",
-	"count-of-matching-books": "{{COUNT}} libru/os",
-	"download": "Iscàrriga",
-	"direct-download-link-text": "Diretu",
-	"direct-download-alt-text": "Iscàrriga in manera direta tràmite HTTP(S)",
-	"hash-download-link-text": "Summa de controllu SHA-256",
-	"hash-download-alt-text": "Mustra sa summa de controllu SHA-256",
-	"magnet-link-text": "Ligàmene Magnet",
-	"magnet-alt-text": "Iscàrriga impreende su ligàmene Magnet",
-	"torrent-download-link-text": "BitTorrent",
-	"torrent-download-alt-text": "Iscàrriga impreende BitTorrent",
-	"library-opds-feed-all-entries": "Flussu OPDS de sa biblioteca – Totu sos elementos",
-	"filter-by-tag": "Filtra pro eticheta \"{{{TAG}}}\"",
-	"stop-filtering-by-tag": "Non filtres prus pro eticheta \"{{{TAG}}}\"",
-	"library-opds-feed-parameterised": "Flussu OPDS de sa biblioteca - elementos chi currispondet cun {{#LANG}}\nLimba: {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategoria: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nEticheta: {{TAG}} {{/TAG}}{{#Q}}\nChirca: {{Q}} {{/Q}}",
-	"welcome-to-kiwix-server": "Bene bènnidu a su serbidore de Kiwix",
-	"download-links-heading": "Ligàmenes de iscarrigamentu pro <b><i>{{BOOK_TITLE}}</i></b>",
-	"download-links-title": "Iscàrriga su libru",
-	"preview-book": "Antiprima"
+	"confusion-of-tongues": "Duos o prus libros in limbas diferentes diant pigare parte a sa chirca, cosa chi diat pòdere causare resurtados confusionosos."
 }

static/i18n/sl.json

@@ -0,0 +1,32 @@
+{
+	"@metadata": {
+		"authors": [
+			"Eleassar"
+		]
+	},
+	"name": "slovenščina",
+	"suggest-full-text-search": "vsebuje »{{{SEARCH_TERMS}}}« ...",
+	"no-such-book": "Ni take knjige: {{BOOK_NAME}}",
+	"too-many-books": "Preveč zahtevanih knjig ({{NB_BOOKS}}), omejitev je {{LIMIT}}",
+	"no-book-found": "Izbirnim merilom ne ustreza nobena knjiga",
+	"url-not-found": "Zahtevanega URL-ja »{{url}}« v tem strežniku ni bilo mogoče najti.",
+	"suggest-search": "Preiščite celotno besedilo za <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>",
+	"random-article-failure": "Ups! Ni bilo mogoče izbrati naključnega članka :(",
+	"invalid-raw-data-type": "{{DATATYPE}} ni veljaven zahtevek za neobdelano vsebino.",
+	"no-value-for-arg": "Argument {{ARGUMENT}} nima določene nobene vrednosti",
+	"no-query": "Poizvedba ni podana.",
+	"raw-entry-not-found": "Ni mogoče najti vnosa {{ENTRY}} vrste {{DATATYPE}}",
+	"400-page-title": "Neveljaven zahtevek",
+	"400-page-heading": "Neveljaven zahtevek",
+	"404-page-title": "Vsebine ni mogoče najti",
+	"404-page-heading": "Ni najdeno",
+	"500-page-title": "Notranja napaka strežnika",
+	"500-page-heading": "Notranja napaka strežnika",
+	"fulltext-search-unavailable": "Iskanje po celotnem besedilu ni na voljo",
+	"no-search-results": "Iskalnik po celotnem besedilu za to vsebino ni na voljo.",
+	"library-button-text": "Pojdite na pozdravno stran",
+	"home-button-text": "Pojdite na glavno stran »{{BOOK_TITLE}}«",
+	"random-page-button-text": "Pojdite na naključno izbrano stran",
+	"searchbox-tooltip": "Poiščite »{{BOOK_TITLE}}«",
+	"confusion-of-tongues": "V iskanju bi bili uporabljeni dve ali več knjig v različnih jezikih, kar lahko pripelje do nejasnih zadetkov."
+}

static/i18n/sv.json

@@ -0,0 +1,34 @@
+{
+	"@metadata": {
+		"authors": [
+			"Jopparn",
+			"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}}",
+	"no-book-found": "Ingen bok matchar urvalskriterierna",
+	"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 :(",
+	"invalid-raw-data-type": "{{DATATYPE}} är ingen giltig begäran för oformaterat innehåll.",
+	"no-value-for-arg": "Inget värde angett för argumentet {{ARGUMENT}}",
+	"no-query": "Ingen fråga tillhandahålls.",
+	"raw-entry-not-found": "Kunde inte hitta {{DATATYPE}}-inlägget {{ENTRY}}",
+	"400-page-title": "Ogiltig begäran",
+	"400-page-heading": "Ogiltig begäran",
+	"404-page-title": "Innehållet hittades inte",
+	"404-page-heading": "Hittades inte",
+	"500-page-title": "Internt serverfel",
+	"500-page-heading": "Internt serverfel",
+	"fulltext-search-unavailable": "Fulltextsökning är inte tillgänglig",
+	"no-search-results": "Sökmaskinen för fulltext är inte tillgänglig för detta innehåll.",
+	"library-button-text": "Gå till hemsidan",
+	"home-button-text": "Gå till huvudsidan för \"{{BOOK_TITLE}}\"",
+	"random-page-button-text": "Gå till en slumpmässigt utvald sida",
+	"searchbox-tooltip": "Sök efter \"{{BOOK_TITLE}}\"",
+	"confusion-of-tongues": "Två eller fler böcker på olika språk skulle delta i sökningen, vilket kan ge förvirrande resultat."
+}

static/i18n/test.json

@@ -0,0 +1,20 @@
+{
+	"@metadata": {
+		"authors": [
+			"Kareyac"
+		]
+	},
+	"name": "Fake language for i18n testing"
+	, "suggest-full-text-search": "[I18N TESTING] cOnTaInInG '{{{SEARCH_TERMS}}}'..."
+	, "no-such-book": "[I18N TESTING] No such book: {{BOOK_NAME}}. Sorry."
+	, "url-not-found": "[I18N TESTING] URL not found: {{url}}"
+	, "suggest-search": "[I18N TESTING] Make a full text search for <a href=\"{{{SEARCH_URL}}}\">{{PATTERN}}</a>"
+	, "400-page-title": "[I18N TESTING] Invalid request ($400 fine must be paid)"
+	, "400-page-heading": "[I18N TESTING] -400 karma for an invalid request"
+	, "404-page-title": "[I18N TESTING] Not Found - Try Again"
+	, "404-page-heading": "[I18N TESTING] Content not found, but at least the server is alive"
+	, "library-button-text": "[I18N TESTING] Navigate to the welcome page"
+	, "home-button-text": "[I18N TESTING] Jump to the main page of '{{BOOK_TITLE}}'"
+	, "random-page-button-text": "[I18N TESTING] I am tired of determinism"
+	, "searchbox-tooltip": "[I18N TESTING] Let's search in '{{BOOK_TITLE}}'"
+}