Update name of the project in meson.build.

The right name is `kiwix-lib`, not `kiwixlib`.
Also update the version to be able to do a small fix release.

.codecov.yml

@@ -1,12 +0,0 @@
-codecov:
-  notify:
-    require_ci_to_pass: yes
-
-coverage:
-  status:
-    project:
-      default:
-        threshold: 1%
-
-ignore:
-  - "test"

.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: kiwix
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # https://kiwix.org/support-us/

.github/move.yml

@@ -1,27 +0,0 @@
-# Configuration for Move Issues - https://github.com/dessant/move-issues
-
-# Delete the command comment when it contains no other content
-deleteCommand: true
-
-# Close the source issue after moving
-closeSourceIssue: true
-
-# Lock the source issue after moving
-lockSourceIssue: false
-
-# Mention issue and comment authors
-mentionAuthors: true
-
-# Preserve mentions in the issue content
-keepContentMentions: true
-
-# Move labels that also exist on the target repository
-moveLabels: true
-
-# Set custom aliases for targets
-# aliases:
-#   r: repo
-#   or: owner/repo
-
-# Repository to extend settings from
-# _extends: repo

.github/stale.yml

@@ -1,15 +0,0 @@
-daysUntilClose: false
-staleLabel: stale
-
-issues:
-  daysUntilStale: 60
-  markComment: >
-    This issue has been automatically marked as stale because it has not had
-    recent activity. It will be now be reviewed manually. Thank you
-    for your contributions.
-pulls:
-   daysUntilStale: 7
-   markComment: >
-     This pull request has been automatically marked as stale because it has not had
-     recent activity. It will be now be reviewed manually. Thank you
-     for your contributions.

.github/workflows/ci.yml

@@ -1,163 +0,0 @@
-name: CI
-
-on: [push]
-
-jobs:
-  Macos:
-    runs-on: macos-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v1
-      - name: Setup python 3.5
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.5'
-      - name: Install packages
-        run: |
-          brew update
-          brew install gcovr pkg-config ninja
-      - name: Install python modules
-        run: pip3 install meson==0.49.2 pytest
-      - name: Install deps
-        shell: bash
-        run: |
-          ARCHIVE_NAME=deps2_osx_native_dyn_kiwix-lib.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
-          ninja coverage
-        env:
-          SKIP_BIG_MEMORY_TEST: 1
-      - name: Publish coverage
-        shell: bash
-        run: |
-          curl https://codecov.io/bash -o codecov.sh
-          bash codecov.sh -n osx_native_dyn -Z
-          rm codecov.sh
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  Linux:
-    strategy:
-      fail-fast: false
-      matrix:
-        name:
-          - native_static
-          - native_dyn
-          - native_dyn_bionic
-          - android_arm
-          - android_arm64
-          - win32_static
-          - win32_dyn
-        include:
-          - name: native_static
-            target: native_static
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
-          - name: native_dyn
-            target: native_dyn
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
-          - name: native_dyn_bionic
-            target: native_dyn
-            image_variant: bionic
-            lib_postfix: '/x86_64-linux-gnu'
-          - name: android_arm
-            target: android_arm
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
-          - name: android_arm64
-            target: android_arm64
-            image_variant: xenial
-            lib_postfix: '/x86_64-linux-gnu'
-          - name: win32_static
-            target: win32_static
-            image_variant: f31
-            lib_postfix: '64'
-          - name: win32_dyn
-            target: win32_dyn
-            image_variant: f31
-            lib_postfix: '64'
-    env:
-      HOME: /home/runner
-    runs-on: ubuntu-latest
-    container:
-      image: "kiwix/kiwix-build_ci:${{matrix.image_variant}}-26"
-    steps:
-    - name: Extract branch name
-      shell: bash
-      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-      id: extract_branch
-    - name: Checkout code
-      shell: python
-      run: |
-        from subprocess import check_call
-        from os import environ
-        command = [
-          'git', 'clone',
-          'https://github.com/${{github.repository}}',
-          '--depth=1',
-          '--branch', '${{steps.extract_branch.outputs.branch}}'
-        ]
-        check_call(command, cwd=environ['HOME'])
-    - name: Install deps
-      shell: bash
-      run: |
-        ARCHIVE_NAME=deps2_${OS_NAME}_${{matrix.target}}_kiwix-lib.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
-          MESON_OPTION="--default-library=shared"
-        else
-          MESON_OPTION="--default-library=static"
-        fi
-        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
-          MESON_OPTION="$MESON_OPTION -Dandroid=true"
-        fi
-        cd $HOME/libkiwix
-        meson . build ${MESON_OPTION}
-        cd build
-        ninja
-      env:
-        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: startsWith(matrix.target, 'native_')
-      shell: bash
-      run: |
-        cd $HOME/libkiwix/build
-        meson test --verbose
-        ninja coverage
-      env:
-        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
-      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_') && matrix.image_variant == 'xenial'
-      env:
-        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/package.yml

@@ -1,87 +0,0 @@
-name: Packages
-on: [push, pull_request]
-
-jobs:
-  build-deb:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        distro: [ubuntu-hirsute, ubuntu-groovy, ubuntu-focal, ubuntu-bionic]
-    steps:
-      - uses: actions/checkout@v2
-
-      # Determine which PPA we should upload to
-      - name: PPA
-        id: ppa
-        run: |
-          if [[ $REF == refs/tags* ]]
-          then
-            echo "::set-output name=ppa::kiwixteam/release"
-          else
-            echo "::set-output name=ppa::kiwixteam/dev"
-          fi
-        env:
-          REF: ${{ github.ref }}
-
-      - 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@ubuntu-hirsute
-        if: matrix.distro == 'ubuntu-hirsute'
-        name: Build package for ubuntu-hirsute
-        id: build-ubuntu-hirsute
-        with:
-          args: --no-sign
-          ppa: ${{ steps.ppa.outputs.ppa }}
-
-      - uses: legoktm/gh-action-build-deb@ubuntu-groovy
-        if: matrix.distro == 'ubuntu-groovy'
-        name: Build package for ubuntu-groovy
-        id: build-ubuntu-groovy
-        with:
-          args: --no-sign
-          ppa: ${{ steps.ppa.outputs.ppa }}
-
-      - uses: legoktm/gh-action-build-deb@ubuntu-focal
-        if: matrix.distro == 'ubuntu-focal'
-        name: Build package for ubuntu-focal
-        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@master
-        name: Upload dev package
-        # Only upload on pushes to master
-        if: github.event_name == 'push' && github.event.ref == 'refs/heads/master' && startswith(matrix.distro, 'ubuntu-')
-        with:
-          gpg_key: ${{ secrets.LAUNCHPAD_GPG }}
-          repository: ppa:kiwixteam/dev
-          packages: output/*_source.changes
-
-      - uses: legoktm/gh-action-dput@master
-        name: Upload release package
-        # 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
-

.gitignore

@@ -1,7 +0,0 @@
-.idea/
-*.swp
-subprojects/googletest-release*
-*.class
-build/
-.vscode/
-builddir/

.travis.yml

@@ -0,0 +1,13 @@
+language: cpp
+dist: trusty
+sudo: required
+cache: ccache
+install: travis/install_deps.sh
+script: travis/compile.sh
+env:
+ - PLATFORM="native_static"
+ - PLATFORM="native_dyn"
+ - PLATFORM="win32_static"
+ - PLATFORM="win32_dyn"
+ - PLATFORM="android_arm"
+ - PLATFORM="android_arm64"

COPYING

@@ -77,7 +77,7 @@ modification follow.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
-
+ 
   "The Program" refers to any copyrightable work licensed under this
 License.  Each licensee is addressed as "you".  "Licensees" and
 "recipients" may be individuals or organizations.
@@ -510,7 +510,7 @@ actual knowledge that, but for the patent license, your conveying the
 covered work in a country, or your recipient's use of the covered work
 in a country, would infringe one or more identifiable patents in that
 country that you have reason to believe are valid.
-
+  
   If, pursuant to or in connection with a single transaction or
 arrangement, you convey, or propagate by procuring conveyance of, a
 covered work, and grant a patent license to some of the parties

ChangeLog

@@ -1,401 +1,3 @@
-libkiwix 10.0.0
-===============
-
- * ...
-
-kiwix-lib 9.4.1
-===============
-
- * Fix `M/Counter` parsing.
- * [SERVER] Adjust body padding-top for taskbar
- * Fix potential crash when stoping a server not started.
- * Various fix in build system and the CI.
-
-kiwix-lib 9.4.0
-===============
-
- * [SERVER] Make the headers handling case insensitive.
- * [SERVER] Make server answer 204 http status code for empty search
- * [PACKAGING] Made CI build deb packages.
- * [SERVER] Add a way to prevent taskbar and external link bloquer at article
-   level.
- * Fix meson file to be compatible with meson 0.45
- * [SERVER] Update search requests to use pageStart/pageLength instead of
-   pageStart/pageEnd arguments.
- * [SERVER] Set a fixed favicon size in the main page.
- * [SERVER] Refactor the response system code to better handling future new
-   libzim api.
- * Fix segmentation fault around exchange with aria2 process making
-   kiwix-desktop crash at exit.
-
-kiwix-lib 9.3.1
-===============
-
- * Fix handling of samba path on windows.
- * Do not include `kiwix_config.h` in public header.
- * Fix compilation with libmicrohttpd v0.97.1
- * Increase default test timeout to 160seconds/test.
- * Add automatic debian packaging.
- * Use non-minified version of jquery-ui.js
- * Pass `-latomic` compile option for sh4 architecture.
- * Make mesion install `kiwix-compile-resources` man page.
-
-kiwix-lib 9.3.0
-===============
-
- * Add a thread safe method to search suggestions.
-   Old methods are now deprecated.
-
-kiwix-lib 9.2.3
-===============
-
- * Add test on byte-range
- * Fix compilation on bionic and windows.
- * Allow building using debian packaged kainjow-mustache
- * Pass `-latomic` compile option for architectures that need it
-
-kiwix-lib 9.2.2
-===============
-
- * Fix handling on empty content in byte range management (wrong assert)
-
-kiwix-lib 9.2.1
-===============
-
- * Fix support of byte range request.
-
-kiwix-lib 9.2
-=============
-
- * Add tests
- * Refactoring server code.
- * [SERVER] Add HEAD, Etag and If-None-Match support.
- * [SERVER] Compress opds catalog answers.
-
-kiwix-lib 9.1.2
-===============
-
- * Do not use the pathToSave if it is empty.
-
-kiwix-lib 9.1.1
-===============
-
- * Fix the detection of the dataDirectory on windows.
-
-kiwix-lib 9.1.0
-===============
-
- * [JAVA] Add a method to get the size of an article.
- * Add a new method to the libray to get the book by path.
- * Add a option to make the server blocks external link.
-   Links are intercepted by js an redirected to a "portail" page.
- * [ODPS] Correctly handle book's articleCount and mediaCount.
-
-kiwix-lib 9.0.1
-===============
-
- * [JAVA] Use a long to store the offset of an article in the zim file instead
-    of an int.
-
-kiwix-lib 9.0.0
-===============
-
- * [OPDS] Correctly set the id of the OPDS stream.
- * [OPDS] Do not try to filter the catalog if no filter field is given in the
-   request.
- * [WINDOWS] Correctly convert path to wide chars when opening the library.xml
- * [LIBRARY] Remove the function the read file using a native path.
-   All path must be utf8, no need to pass a native path along the utf8 path.
- * [TEST] Fix tests using the main function of gtest instead of custom one.
- * [CI] Move to github CI instead of Travis.
- * The `Book::update` method always update the book's fields. Even if they are
-   not empty.
- * [JAVA] Add wrapping around the library manager (opds parsing)
- * [ARIA2] Add api option to start download with option (destination folder)
- * [OPDS] Fixes about opds parsing, generation (missing attributes)
-   and requesting (server)
- * Add methods on `Book` to get specific tag values (was on `Reader` only)
- * Add flavour attribute to `Book`
- * Fix opensearch description.
- * Trust the given library.xml (by default) instead of reading the value from
-   the zim files.
- * [OPDS] Be able to filter the content by name or size.
- * [WINDOWS] Fix launching subcommand when there is spaces in the path.
-
-kiwix-lib 8.2.2
-===============
-
- * Improve a few compilation scripts
-
-kiwix-lib 8.2.1
-===============
-
- * Reintroduce kiwix-serve taskbar
-
-kiwix-lib 8.2.0
-===============
-
- * More debug information if aria2c command fails
- * Allow to set kiwix-serve port
- * Better (dead) bookmarks mgmt
-
-kiwix-lib 8.1.0
-===============
-
- * Fix pathTools manipulation.
- * Add missing implementation of getArticleCount and getMediaCount on android.
- * Correctly convert windows path to utf8.
- * Add code coverage in the CI
-
-kiwix-lib 8.0.1
-===============
-
- * Fix join function
-
-kiwix-lib 8.0.0
-===============
-
- * Add new methods to get all (and new) metadata from the zim file.
- * Add methods to get the value of a specific tag.
- * [API Change] Convert tags value to the new convention.
- * [API Change] Rename `getMatatag` method to `getMetadata`
- * [ABI Change] Correctly detect executable path in appimage.
-
-kiwix-lib 7.0.0
-===============
-
- * [API break] Add a argument to kiwix-serve to specify the library to use.
-
-kiwix-lib 6.0.4
-===============
-
- * Fix HTML rendering of the search result if there is no result.
- * Do not crash at html rendering if request ask for 0 results (start == end)
- * Correctly find the executable path if we are using AppImage
-
-kiwix-lib 6.0.3
-===============
-
- * force one column suggestion in kiwix-serve suggestions
- * fix fulltext search link in suggestions
- * UI fixes in kiwix-serve rendering
-
-kiwix-lib 6.0.2
-===============
-
- * Correctly set the groupId in the pom file.
-
-kiwix-lib 6.0.1
-===============
-
- * Generate the pom file for android/maven
-
-kiwix-lib 6.0.0
-===============
-
- * Move the server code in kiwix-lib (from kiwix-serve).
- * Add unit test on regex functions.
- * Fix computerAbsolutePath (thread safe, memory leak).
- * Correctly set the book's path as valid if we construct the book from a
-   reader.
- * [JNI] Add a method to know if a article is a redirection.
- * Do not embed the gtest dependency.
- * [JNI] Add a constructor to JNIKiwixString.
- * Change order of search of the favicon urls.
- * Clean a lot of unecessary includes in headers. (potential "API break")
-
-kiwix-lib 5.2.0
-===============
-
- * kiwix-serve integration (as a seperated process).
- * Fix crash in the suggestion search.
- * Better API to filter the library books.
- * New kiwix-lib application for android. (.aar)
- * Use ReLinker to link with libkiwix.so in android.
- * Correctly set the verbosity of zim search.
-
-kiwix-lib 5.1.0
-===============
-
- * Add function to pause, resume and stop downloads.
- * Add zim's tags in the opds stream.
- * Addapt to new libzim 5.0.0 API.
-
-kiwix-lib 5.0.0
-===============
-
- * Remove error message when trying to open an wrong zim file.
- * Rewrite `makeTmpDirectory` to not use uuid functions on windows.
- * [API break] Remove `getNetworkInterfaces` and `getBestPublicIp`.
- * Remove rpath
- * Detect infinite (and too long) redirect loops.
-
-kiwix-lib 4.1.0
-===============
-
- * Allow the library to be filtered by tags.
- * Fix language mapping.
- * Update README about mustache dependency.
-
-kiwix-lib 4.0.1
-===============
-
- * Fix "maybe uninitialize variable" issue.
- * Ensure path are stored correctly (absolute path) in the library.
- * [CI] Use the new deps archive xz
-
-kiwix-lib 4.0.0
-===============
-
- * [API break] Remove support for external index.
- * Move to the mustache templating system instead of ctpp2.
- * Make meson.build works for meson>=0.43.0
- * [API break] Move the basic tools from the `common` directory to `tools`.
-
-kiwix-lib 3.1.1
-===============
-
- * The OPDS feed book's date must be the date of the book, not the date of the
- feed generation.
- * Convert the standard opds date to our format (YYYY-MM-DD)
- * Remove duplicate language attribute in the libxml dumper.
- * Create the datadirectory to not fail to write a file in a non-existent
-   directory
-
-kiwix-lib 3.1.0
-===============
-
- * Add a method to get the favicon url of book (if available).
- * Move dump code of library.xml in a specific class.
- * Add a first support to bookmarks
-
-kiwix-lib 3.0.3
-===============
-
- * Add the 'en' language to the mapping alpha2-code ('en') to alpha3-code
- ('eng').
- * Correctly write the 'ArticleCount' and 'MediaCount' in the library.xml.
- * Correctly fill the book size for the zim file size.
- * Fix launch of aria2c.
-
-kiwix-lib 3.0.2
-===============
-
- * Use the correct path separator when computing relativePath on Windows.
-
-kiwix-lib 3.0.1
-===============
-
- * Small fix about parsing the opdsStream.
-
-kiwix-lib 3.0.0
-===============
-
- * Change the downloader to use aria2 using a separated process (with rpc)
-   instead of using the libaria2. This simplify a lot the link process to
-   libaria2 on Windows.
-    - kiwix-lib doesn't depend on libaria2 anymore.
-    - kiwix-lib now depends on libcurl.
- * [API break] Library class API has been updated :
-    - Books are referenced by id, not index. A lot of methods have been
-      updated this way.
-    - Books "list" is now private.
-    - There is no more "current" book.
-    - listBooksIds's filters have been updated.
- * [API break] Book class API has been updated :
-    - Move the definition of Book in `book.h`.
-    - Use getter/setter methods instead public members.
-    - Size (getSize/setSize) is now returned in bytes, not kB.
-    - Dependending of how the book has been initialized (opdsfeed), the
-      faviconUrl may be stored in the book, the favicon being downloaded when
-      using `getFavicon`.
-    - The path (and indexPath) are always absolute path.
-    - Book has now a downloadId, corresponding to the aria2 download id (if
-      exists)
-  * [API break] Manager class API has been updated :
-    - The manager is mainly use to fill a Libray from a "library.xml" file or
-      opds feed. Other operations (has removeBookById, setBookPath, filter, ...)
-      have been removed.
-    - The manager use a intermediate class (LibraryManipulator) to add book to
-      the library. This dependency injection allow caller code to hook the add
-      of a book to the library.
-    - The manager work on a existing Library. It doesn't how a internal
-      Library.
-  * [API break] OpdsDumper class API has been updated :
-    - dumpOPDSFeed method now take the list of bookIds to dump instead of
-      dumping all books in the library.
-    - OpdsDumper can now dump openSearch result information (total result
-      count, start index, ...).
-  * [API break] Common tools API has been updated :
-    - `base64_encode` and `base64_decode` take std::string as arguments.
-    - New `download` function in networkTools.h using libcurl.
-    - New `getDataDirectory` function in pathTools.
-    - Better `beautifyInteger` and `beautifyFileSize` functions.
-    - New `nodeToString` function serializing a pugi::xml_node to a string.
-    - New `converta2toa3` function to convert alpha2 language code to aplha3
-      language code.
-
-
-kiwix-lib 2.0.2
-===============
-
- * [Android] Forward c++ errors message de Java world.
- * Follow redirection of favicon.
- * Make aria2 dependency optional.
- * Inculde unistd.h only on unix platform.
-
-kiwix-lib 2.0.1
-===============
-
- * Fix parsing of url.
- * Remove unused static resources.
- * Correctly decode reserved characters in URLs.
- * Explicitly use icu namespace to allow use of packaged icu lib.
-
-kiwix-lib 2.0.0
-===============
-
- * Introduce a new API to retrive content from a reader.
-   * Introduce the `Entry` class.
-   * Reader's methods return an `Entry`.
-   * Content and other information can be retrieved from the `Entry`.
-   * Older Reader's methods are depreciated.
- * Add an `OPDSDumper` class to dump a whole `Library` as an OPDS feed.
- * Add a tool function to get the content of a file.
- * Add a tool function to create a tempory directory.
- * Add a `Downloader` class to download a file.
- * Allow the manager to populate a `Library` from an OPDS feed.
- * Try to locate libctpp2 in default system libdir and then fallback in 'lib'
-   directory.
- * Build kiwix-lib setting RPATH.
- * Build kiwix-lib without warning (werror=true)
- * Build kiwix-lib on macos.
-
-kiwix-lib 1.1.1
-===============
-
- * Correct the name of kiwix-lib (from `kiwixlib`) in meson.build to generate
-   dist archive with the correct name.
- * Libzim version need to be at least 3.2.0
-
-kiwix-lib 1.1.0
-===============
-
- * Allow for more than 70 search result per page in html results rendering
-   (kiwix/kiwix-tools#92)
- * Add a small api to do geo queries.
- * Add multi-search support in the JNI (#67)
- * Add an API to get only one part of an article.
- * Add an API to get direct location of an article content in the zim file.
- * Improve urlencoding
- * Fix pagination in html results rendering.
- * Compile using gcc-5 on Travis.
- * Allow JNI to access search snippets.
- * JNI throw an exception instead of returning an invalid object if something
-   goes wrong.
- * Add doctext documentation. (#116)
- * Various bug fixes.
-
 kiwix-lib 1.0.0
 ===============
 

README.md

@@ -1,53 +1,42 @@
-Libkiwix
-========
+Kiwix library
+=============
 
-The Libkiwix provides the [Kiwix](https://kiwix.org) software suite
-core. It contains the code shared by all Kiwix ports (Windows,
-GNU/Linux, macOS, Android, iOS, ...).
-
-[![Repositories](https://img.shields.io/repology/repositories/libkiwix?label=repositories)](https://github.com/kiwix/libkiwix/wiki/Repology)
-[![Build Status](https://github.com/kiwix/libkiwix/workflows/CI/badge.svg?query=branch%3Amaster)](https://github.com/kiwix/libkiwix/actions?query=branch%3Amaster)
-[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/libkiwix/badge)](https://www.codefactor.io/repository/github/kiwix/libkiwix)
-[![Codecov](https://codecov.io/gh/kiwix/libkiwix/branch/master/graph/badge.svg)](https://codecov.io/gh/kiwix/libkiwix)
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+The Kiwix library provides the Kiwix software core. It contains the
+code shared by all Kiwix ports (Windows, Linux, OSX, Android, ...).
 
 Disclaimer
 ----------
 
 This document assumes you have a little knowledge about software
 compilation. If you experience difficulties with the dependencies or
-with the Libkiwix compilation itself, we recommend to have a look to
-[kiwix-build](https://github.com/kiwix/kiwix-build).
+with the Kiwix libary compilation itself, we recommend to have a look
+to [kiwix-build](https://github.com/kiwix/kiwix-build).
 
 Preamble
 --------
 
-Although the Libkiwix can be (cross-)compiled on/for many sytems, the
-following documentation explains how to do it on POSIX ones. It is
-primarly thought for GNU/Linux systems and has been tested on recent
-releases of Ubuntu and Fedora.
+Although the Kiwix library can be compiled/cross-compiled on/for many
+sytems, the following documentation explains how to do it on POSIX
+ones. It is primarly though for GNU/Linux systems and has been tested
+on recent releases of Ubuntu and Fedora.
 
 Dependencies
 ------------
 
-The Libkiwix relies on many third party software libraries. They are
-prerequisites to the Libkiwix compilation. Following libraries need to
-be available:
-* [ICU](https://site.icu-project.org/) (package `libicu-dev` on Ubuntu)
-* [ZIM](https://openzim.org/) (package `libzim-dev` on Ubuntu)
-* [Pugixml](https://pugixml.org/) (package `libpugixml-dev` on Ubuntu)
-* [Mustache](https://github.com/kainjow/Mustache) (Just copy the
-header `mustache.hpp` somewhere it can be found by the compiler and/or
-set CPPFLAGS with correct `-I` option). Use Mustache version 4.1 or above.
-* [Libcurl](https://curl.se/libcurl) (`libcurl4-gnutls-dev`, `libcurl4-nss-dev` or `libcurl4-openssl-dev` on Ubuntu)
-* [Microhttpd](https://www.gnu.org/software/libmicrohttpd) (package `libmicrohttpd-dev` on Ubuntu)
-* [Zlib](https://zlib.net/) (package `zlib1g-dev` on Ubuntu)
+The Kiwix library relies on many third parts software libraries. They
+are prerequisites to the Kiwix library compilation. Following
+libraries need to be available:
 
-To test the code:
-* [Google Test](https://github.com/google/googletest) (package `googletest` on Ubuntu)
-
-The following dependency needs to be available at runtime:
-* [Aria2](https://aria2.github.io/) (package `aria2` on Ubuntu)
+* ICU ................................... http://site.icu-project.org/
+(package libicu-dev on Ubuntu)
+* ZIM ........................................ http://www.openzim.org/
+(package libzim-dev on Ubuntu)
+* Pugixml ........................................ http://pugixml.org/
+(package libpugixml-dev on Ubuntu)
+* ctpp2 ........................................ http://ctpp.havoc.ru/
+(package libctpp2-dev on Ubuntu)
+* Xapian ......................................... https://xapian.org/
+(package libxapian-dev on Ubuntu)
 
 These dependencies may or may not be packaged by your operating
 system. They may also be packaged but only in an older version. The
@@ -56,108 +45,76 @@ 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
-`libkiwix` directory as install prefix.
+kiwix-lib directory as install prefix.
 
-Environment
+If you compile ctpp2 from source and want to compile the Kiwix library
+statically then you will probably need to rename ctpp2 static library
+from ctpp2-st.a to ctpp2.a.
+
+Environnement
 -------------
 
-The Libkiwix builds using [Meson](https://mesonbuild.com/) version
-0.45 or higher. Meson relies itself on Ninja, pkg-config and few other
+The Kiwix library builds using [Meson](http://mesonbuild.com/) version
+0.34 or higher. Meson relies itself on Ninja, pkg-config and few other
 compilation tools.
 
 Install first the few common compilation tools:
-* [Meson](https://mesonbuild.com/)
-* [Ninja](https://ninja-build.org/)
-* [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
+* Automake
+* Libtool
+* Virtualenv
+* Pkg-config
 
-These tools should be packaged if you use a cutting edge operating
-system. If not, have a look to the [Troubleshooting](#Troubleshooting)
-section.
-
-Compilation
------------
-
-Once all dependencies are installed, you can compile the Libkiwix
-with:
-```bash
-meson . build
-ninja -C build
+Then install Meson itself:
 ```
-
-By default, it will compile dynamic linked libraries. All binary files
-will be created in the `build` directory created automatically by
-Meson. If you want statically linked libraries, you can add
-`--default-library=static` option to the Meson command.
-
-Depending of you system, `ninja` may be called `ninja-build`.
-
-Testing
--------
-
-To run the automated tests:
-```bash
-cd build
-meson test
-```
-
-Installation
-------------
-
-If you want to install the Libkiwix and the headers you just have
-compiled on your system, here we go:
-```bash
-ninja -C build install
-```
-
-You might need to run the command as root (or using `sudo`), depending
-where you want to install the libraries. After the installation
-succeeded, you may need to run `ldconfig` (as `root`).
-
-Uninstallation
-------------
-
-If you want to uninstall the Kiwix library:
-```bash
-ninja -C build uninstall
-```
-
-Like for the installation, you might need to run the command as `root`
-(or using `sudo`).
-
-Troubleshooting
----------------
-
-If you need to install Meson "manually":
-```bash
 virtualenv -p python3 ./ # Create virtualenv
 source bin/activate      # Activate the virtualenv
-pip3 install meson       # Install Meson
+pip install meson        # Install Meson
 hash -r                  # Refresh bash paths
 ```
 
-If you need to install Ninja "manually":
-```bash
+Finally download and build Ninja locally:
+```
 git clone git://github.com/ninja-build/ninja.git
 cd ninja
 git checkout release
 ./configure.py --bootstrap
-mkdir ../bin
+mkdir ../bin                      
 cp ninja ../bin
 cd ..
 ```
 
-If you compile manually Libmicrohttpd, you might need to compile it
-without GNU TLS, a bug here will empeach further compilation
-otherwise.
+Compilation
+-----------
 
-If the compilation still fails, you might need to get a more recent
-version of a dependency than the one packaged by your Linux
-distribution. Try then with a source tarball distributed by the
-problematic upstream project or even directly from the source code
-repository.
+Once all dependencies are installed, you can compile kiwix-lib with:
+```
+mkdir build
+meson . build
+cd build
+ninja
+```
+
+By default, it will compile dynamic linked libraries. If you want
+statically linked libraries, you can add `--default-library=static`
+option to the Meson command.
+
+Depending of you system, `ninja` may be called `ninja-build`.
+
+Installation
+------------
+
+If you want to install the libraries you just have compiled on your
+system, here we go:
+
+```
+ninja install
+cd ..
+```
+
+You might need to run the command as root, depending where you want to
+install the libraries.
 
 License
 -------
 
-[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see
-[COPYING](COPYING) for more details.
+GPLv3 or later, see COPYING for more details.

android-kiwix-lib-publisher/.gitignore

@@ -1,13 +0,0 @@
-*.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

@@ -1,25 +0,0 @@
-// 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,6 +0,0 @@
-#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

@@ -1,172 +0,0 @@
-#!/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

@@ -1,84 +0,0 @@
-@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

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

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

@@ -1,64 +0,0 @@
-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.0.0' + (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

@@ -1,21 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-<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

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

debian/changelog

@@ -1,5 +0,0 @@
-libkiwix (0.0.0) unstable; urgency=medium
-
-  * Initial release
-
- -- Kunal Mehta <legoktm@debian.org>  Wed, 08 Jul 2020 18:12:32 -0700

debian/control

@@ -1,46 +0,0 @@
-Source: libkiwix
-Priority: optional
-Maintainer: Kiwix team <kiwix@kiwix.org>
-Build-Depends: debhelper-compat (= 13),
- meson,
- pkg-config,
- libzim-dev (>= 6.1.8),
- libcurl4-gnutls-dev,
- libicu-dev,
- libgtest-dev,
- libkainjow-mustache-dev,
- liblzma-dev,
- libmicrohttpd-dev,
- libpugixml-dev,
- zlib1g-dev
-Standards-Version: 4.5.0
-Section: libs
-Homepage: https://github.com/kiwix/libkiwix
-Rules-Requires-Root: no
-
-Package: libkiwix-dev
-Section: libdevel
-Architecture: any
-Multi-Arch: same
-Depends: libkiwix10 (= ${binary:Version}), ${misc:Depends}, python3,
- libzim-dev (>= 6.0.0),
- libicu-dev,
- libpugixml-dev,
- libcurl4-gnutls-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
- Kiwix ports (Windows, Linux, OSX, Android, etc.).
- .
- This package contains development files.
-
-Package: libkiwix10
-Architecture: any
-Multi-Arch: same
-Depends: ${shlibs:Depends}, ${misc:Depends}, aria2
-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
- Kiwix ports (Windows, Linux, OSX, Android, etc.).

debian/copyright

@@ -1 +0,0 @@
-See COPYING in the repository root.

debian/libkiwix-dev.install

@@ -1,4 +0,0 @@
-usr/include
-usr/lib/*/libkiwix.so
-usr/lib/*/pkgconfig
-usr/bin

debian/libkiwix-dev.manpages

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

debian/libkiwix10.install

@@ -1 +0,0 @@
-usr/lib/*/libkiwix.so.*

debian/rules

@@ -1,8 +0,0 @@
-#!/usr/bin/make -f
-export DEB_BUILD_MAINT_OPTIONS = hardening=+all
-
-%:
-	dh $@ --buildsystem=meson
-
-override_dh_auto_test:
-	dh_auto_test -- -t 3

debian/source/format

@@ -1 +0,0 @@
-3.0 (native)

include/book.h

@@ -1,129 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_BOOK_H
-#define KIWIX_BOOK_H
-
-#include <string>
-
-namespace pugi {
-class xml_node;
-}
-
-namespace kiwix
-{
-
-class OPDSDumper;
-class Reader;
-
-/**
- * A class to store information about a book (a zim file)
- */
-class Book
-{
- public:
-  Book();
-  ~Book();
-
-  bool update(const Book& other);
-  void update(const Reader& reader);
-  void updateFromXml(const pugi::xml_node& node, const std::string& baseDir);
-  void updateFromOpds(const pugi::xml_node& node, const std::string& urlHost);
-  std::string getHumanReadableIdFromPath() const;
-
-  bool readOnly() const { return m_readOnly; }
-  const std::string& getId() const { return m_id; }
-  const std::string& getPath() const { return m_path; }
-  bool isPathValid() const { return m_pathValid; }
-  const std::string& getTitle() const { return m_title; }
-  const std::string& getDescription() const { return m_description; }
-  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; }
-  const std::string& getUrl() const { return m_url; }
-  const std::string& getName() const { return m_name; }
-  std::string getCategory() const;
-  const std::string& getTags() const { return m_tags; }
-  std::string getTagStr(const std::string& tagName) const;
-  bool getTagBool(const std::string& tagName) const;
-  const std::string& getFlavour() const { return m_flavour; }
-  const std::string& getOrigId() const { return m_origId; }
-  const uint64_t& getArticleCount() const { return m_articleCount; }
-  const uint64_t& getMediaCount() const { return m_mediaCount; }
-  const uint64_t& getSize() const { return m_size; }
-  const std::string& getFavicon() const;
-  const std::string& getFaviconUrl() const { return m_faviconUrl; }
-  const std::string& getFaviconMimeType() const { return m_faviconMimeType; }
-  const std::string& getDownloadId() const { return m_downloadId; }
-
-  void setReadOnly(bool readOnly) { m_readOnly = readOnly; }
-  void setId(const std::string& id) { m_id = id; }
-  void setPath(const std::string& path);
-  void setPathValid(bool valid) { m_pathValid = valid; }
-  void setTitle(const std::string& title) { m_title = title; }
-  void setDescription(const std::string& description) { m_description = description; }
-  void setLanguage(const std::string& language) { m_language = language; }
-  void setCreator(const std::string& creator) { m_creator = creator; }
-  void setPublisher(const std::string& publisher) { m_publisher = publisher; }
-  void setDate(const std::string& date) { m_date = date; }
-  void setUrl(const std::string& url) { m_url = url; }
-  void setName(const std::string& name) { m_name = name; }
-  void setFlavour(const std::string& flavour) { m_flavour = flavour; }
-  void setTags(const std::string& tags) { m_tags = tags; }
-  void setOrigId(const std::string& origId) { m_origId = origId; }
-  void setArticleCount(uint64_t articleCount) { m_articleCount = articleCount; }
-  void setMediaCount(uint64_t mediaCount) { m_mediaCount = mediaCount; }
-  void setSize(uint64_t size) { m_size = size; }
-  void setFavicon(const std::string& favicon) { m_favicon = favicon; }
-  void setFaviconMimeType(const std::string& faviconMimeType) { m_faviconMimeType = faviconMimeType; }
-  void setDownloadId(const std::string& downloadId) { m_downloadId = downloadId; }
-
- private:
-  std::string getCategoryFromTags() const;
-
- protected:
-  std::string m_id;
-  std::string m_downloadId;
-  std::string m_path;
-  bool m_pathValid = false;
-  std::string m_title;
-  std::string m_description;
-  std::string m_category;
-  std::string m_language;
-  std::string m_creator;
-  std::string m_publisher;
-  std::string m_date;
-  std::string m_url;
-  std::string m_name;
-  std::string m_flavour;
-  std::string m_tags;
-  std::string m_origId;
-  uint64_t m_articleCount = 0;
-  uint64_t m_mediaCount = 0;
-  bool m_readOnly = false;
-  uint64_t m_size = 0;
-  mutable std::string m_favicon;
-  std::string m_faviconUrl;
-  std::string m_faviconMimeType;
-};
-
-}
-
-#endif

include/bookmark.h

@@ -1,68 +0,0 @@
-/*
- * Copyright 2018 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_BOOKMARK_H
-#define KIWIX_BOOKMARK_H
-
-#include <string>
-
-namespace pugi {
-class xml_node;
-}
-
-namespace kiwix
-{
-
-/**
- * A class to store information about a bookmark (an article in a book)
- */
-class Bookmark
-{
- public:
-  Bookmark();
-  ~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& getUrl() const { return m_url; }
-  const std::string& getTitle() const { return m_title; }
-  const std::string& getLanguage() const { return m_language; }
-  const std::string& getDate() const { return m_date; }
-
-  void setBookId(const std::string& bookId) { m_bookId = bookId; }
-  void setBookTitle(const std::string& bookTitle) { m_bookTitle = bookTitle; }
-  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; }
-  void setDate(const std::string& date) { m_date = date; }
-
- protected:
-  std::string m_bookId;
-  std::string m_bookTitle;
-  std::string m_url;
-  std::string m_title;
-  std::string m_language;
-  std::string m_date;
-};
-
-}
-
-#endif

include/common.h

@@ -1,24 +0,0 @@
-
-#ifndef _KIWIX_COMMON_H_
-#define _KIWIX_COMMON_H_
-
-#include <zim/zim.h>
-
-#ifdef __GNUC__
-#define DEPRECATED __attribute__((deprecated))
-#elif defined(_MSC_VER)
-#define DEPRECATED __declspec(deprecated)
-#else
-#praga message("WARNING: You need to implement DEPRECATED for this compiler")
-#define DEPRECATED
-#endif
-
-
-namespace kiwix {
-
-typedef zim::size_type size_type;
-typedef zim::offset_type offset_type;
-
-}
-
-#endif //_KIWIX_COMMON_H_

include/common/base64.h

@@ -0,0 +1,4 @@
+#include <string>
+
+std::string base64_encode(unsigned char const* , unsigned int len);
+std::string base64_decode(std::string const& s);

include/common/networkTools.h

@@ -1,6 +1,5 @@
 /*
- * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
- * Copyright (C) 2017 Matthieu Gautier <mgautier@kymeria.fr>
+ * Copyright 2012 Emmanuel Engelhart <kelson@kiwix.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU  General Public License as published by
@@ -18,27 +17,33 @@
  * MA 02110-1301, USA.
  */
 
-#include <jni.h>
-#include "org_kiwix_kiwixlib_JNIICU.h"
+#ifndef KIWIX_NETWORKTOOLS_H
+#define KIWIX_NETWORKTOOLS_H
+
+#ifdef _WIN32
+#include <winsock2.h>
+#include <ws2tcpip.h>
+#else
+#include <net/if.h>
+#include <netdb.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/ioctl.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <unistd.h>
+#endif
 
 #include <iostream>
+#include <map>
 #include <string>
+#include <vector>
 
-#include "unicode/putil.h"
-
-#include "utils.h"
-
-std::mutex globalLock;
-
-JNIEXPORT void JNICALL Java_org_kiwix_kiwixlib_JNIICU_setDataDirectory(
-    JNIEnv* env, jclass kclass, jstring dirStr)
+namespace kiwix
 {
-  std::string cPath = jni2c(dirStr, env);
-
-  Lock l;
-  try {
-    u_setDataDirectory(cPath.c_str());
-  } catch (...) {
-    std::cerr << "Unable to set data directory " << cPath << std::endl;
-  }
+std::map<std::string, std::string> getNetworkInterfaces();
+std::string getBestPublicIp();
 }
+
+#endif

include/common/otherTools.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Emmanuel Engelhart <kelson@kiwix.org>
+ * Copyright 2014 Emmanuel Engelhart <kelson@kiwix.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU  General Public License as published by
@@ -17,8 +17,18 @@
  * MA 02110-1301, USA.
  */
 
-#include <microhttpd.h>
+#ifndef KIWIX_OTHERTOOLS_H
+#define KIWIX_OTHERTOOLS_H
+
+#ifdef _WIN32
+#include <windows.h>
+#else
+#include <unistd.h>
+#endif
+
+namespace kiwix
+{
+void sleep(unsigned int milliseconds);
+}
 
-#if MHD_VERSION < 0x00097002
-typedef int MHD_Result;
 #endif

include/common/pathTools.h

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#ifndef KIWIX_PATHTOOLS_H
+#define KIWIX_PATHTOOLS_H
+
+#include <fcntl.h>
+#include <limits.h>
+#include <stdio.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <fstream>
+#include <ios>
+#include <iostream>
+#include <sstream>
+#include <string>
+#include <vector>
+
+#ifdef _WIN32
+#include <direct.h>
+#endif
+
+#include "stringTools.h"
+
+using namespace std;
+
+bool isRelativePath(const string& path);
+string computeAbsolutePath(const string path, const string relativePath);
+string computeRelativePath(const string path, const string absolutePath);
+string removeLastPathElement(const string path,
+                             const bool removePreSeparator = false,
+                             const bool removePostSeparator = false);
+string appendToDirectory(const string& directoryPath, const string& filename);
+
+unsigned int getFileSize(const string& path);
+string getFileSizeAsString(const string& path);
+bool fileExists(const string& path);
+bool makeDirectory(const string& path);
+bool copyFile(const string& sourcePath, const string& destPath);
+string getLastPathElement(const string& path);
+string getExecutablePath();
+string getCurrentDirectory();
+bool writeTextFile(const string& path, const string& content);
+#endif

include/common/regexTools.h

@@ -20,6 +20,9 @@
 #ifndef KIWIX_REGEXTOOLS_H
 #define KIWIX_REGEXTOOLS_H
 
+#include <unicode/regex.h>
+#include <unicode/ucnv.h>
+#include <map>
 #include <string>
 
 bool matchRegex(const std::string& content, const std::string& regex);
@@ -27,10 +30,7 @@ std::string replaceRegex(const std::string& content,
                          const std::string& replacement,
                          const std::string& regex);
 std::string appendToFirstOccurence(const std::string& content,
-                                   const std::string& regex,
+                                   const std::string regex,
                                    const std::string& replacement);
-std::string prependToFirstOccurence(const std::string& content,
-                                    const std::string& regex,
-                                    const std::string& replacement);
 
 #endif

include/common/stringTools.h

@@ -22,29 +22,38 @@
 
 #include <unicode/unistr.h>
 
+#include <fstream>
+#include <iostream>
+#include <sstream>
 #include <string>
 #include <vector>
-#include <sstream>
+
+#include "pathTools.h"
 
 namespace kiwix
 {
-std::string beautifyInteger(uint64_t number);
-std::string beautifyFileSize(uint64_t number);
+#ifndef __ANDROID__
+
+std::string beautifyInteger(const unsigned int number);
+std::string beautifyFileSize(const unsigned int number);
+std::string urlEncode(const std::string& c);
 void printStringInHexadecimal(const char* s);
-void printStringInHexadecimal(icu::UnicodeString s);
+void printStringInHexadecimal(UnicodeString s);
 void stringReplacement(std::string& str,
                        const std::string& oldStr,
                        const std::string& newStr);
 std::string encodeDiples(const std::string& str);
 
+#endif
+
 std::string removeAccents(const std::string& text);
 void loadICUExternalTables();
+std::string urlDecode(const std::string& c);
 
-std::string urlEncode(const std::string& value, bool encodeReserved = false);
-std::string urlDecode(const std::string& value, bool component = false);
-
-std::vector<std::string> split(const std::string& str, const std::string& delims, bool trimEmpty = true, bool keepDelim = false);
-std::string join(const std::vector<std::string>& list, const std::string& sep);
+std::vector<std::string> split(const std::string&, const std::string&);
+std::vector<std::string> split(const char*, const char*);
+std::vector<std::string> split(const std::string&, const char*);
+std::vector<std::string> split(const char*, const std::string&);
 
 std::string ucAll(const std::string& word);
 std::string lcAll(const std::string& word);
@@ -53,22 +62,6 @@ std::string lcFirst(const std::string& word);
 std::string toTitle(const std::string& word);
 
 std::string normalize(const std::string& word);
-template<typename T>
-std::string to_string(T value)
-{
-    std::ostringstream oss;
-    oss << value;
-    return oss.str();
 }
 
-template<typename T>
-T extractFromString(const std::string& str) {
-    std::istringstream iss(str);
-    T ret;
-    iss >> ret;
-    return ret;
-}
-
-bool startsWith(const std::string& base, const std::string& start);
-} //namespace kiwix
 #endif

include/ctpp2/CTPP2VMStringLoader.hpp

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2013 Renaud Gaudin <reg@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#ifndef _CTPP2_VM_STRING_LOADER_HPP__
+#define _CTPP2_VM_STRING_LOADER_HPP__ 1
+
+#include <ctpp2/CTPP2VMLoader.hpp>
+#include <ctpp2/CTPP2Util.hpp>
+#include <ctpp2/CTPP2Exception.hpp>
+#include <ctpp2/CTPP2VMExecutable.hpp>
+#include <ctpp2/CTPP2VMInstruction.hpp>
+#include <ctpp2/CTPP2VMMemoryCore.hpp>
+
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <iostream>
+#include <string>
+
+/**
+  @file VMStringLoader.hpp
+  @brief Load program core from file
+*/
+
+namespace CTPP // C++ Template Engine
+{
+// FWD
+struct VMExecutable;
+
+/**
+  @class VMStringLoader CTPP2VMStringLoader.hpp <CTPP2VMStringLoader.hpp>
+  @brief Load program core from file
+*/
+class CTPP2DECL VMStringLoader:
+  public VMLoader
+{
+public:
+	/**
+	*/
+	VMStringLoader(CCHAR_P rawContent, size_t rawContentSize);
+	/**
+	  @brief Get ready-to-run program
+	*/
+	const VMMemoryCore * GetCore() const;
+
+	/**
+	  @brief A destructor
+	*/
+	~VMStringLoader() throw();
+private:
+	/** Program core             */
+	VMExecutable  * oCore;
+	/** Ready-to-run program     */
+	VMMemoryCore  * pVMMemoryCore;
+};
+
+} // namespace CTPP
+#endif // _CTPP2_VM_STRING_LOADER_HPP__
+// End.

include/downloader.h

@@ -1,107 +0,0 @@
-/*
- * Copyright 2018 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_DOWNLOADER_H
-#define KIWIX_DOWNLOADER_H
-
-#include <string>
-#include <vector>
-#include <map>
-#include <memory>
-#include <stdexcept>
-
-namespace kiwix
-{
-
-class Aria2;
-struct DownloadedFile {
-  DownloadedFile()
-   : success(false) {}
-  bool success;
-  std::string path;
-};
-
-class AriaError : public std::runtime_error {
- public:
-  AriaError(const std::string& message) : std::runtime_error(message) {}
-};
-
-
-class Download {
- public:
-  typedef enum { K_ACTIVE, K_WAITING, K_PAUSED, K_ERROR, K_COMPLETE, K_REMOVED, K_UNKNOWN } StatusResult;
-
-  Download() :
-    m_status(K_UNKNOWN) {}
-  Download(std::shared_ptr<Aria2> p_aria, std::string did)
-    : mp_aria(p_aria),
-      m_status(K_UNKNOWN),
-      m_did(did) {};
-  void updateStatus(bool follow=false);
-  void pauseDownload();
-  void resumeDownload();
-  void cancelDownload();
-  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;
-  StatusResult m_status;
-  std::string m_did = "";
-  std::string m_followedBy = "";
-  uint64_t m_totalLength;
-  uint64_t m_completedLength;
-  uint64_t m_downloadSpeed;
-  uint64_t m_verifiedLength;
-  std::vector<std::string> m_uris;
-  std::string m_path;
-};
-
-/**
- * A tool to download things.
- *
- */
-class Downloader
-{
- public:
-  Downloader();
-  virtual ~Downloader();
-
-  void close();
-
-  Download* startDownload(const std::string& uri, const std::vector<std::pair<std::string, std::string>>& options = {});
-  Download* getDownload(const std::string& did);
-
-  size_t getNbDownload() { return m_knownDownloads.size(); }
-  std::vector<std::string> getDownloadIds();
-
- private:
-  std::map<std::string, std::unique_ptr<Download>> m_knownDownloads;
-  std::shared_ptr<Aria2> mp_aria;
-};
-}
-
-#endif

include/entry.h

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

include/kiwixserve.h

@@ -1,30 +0,0 @@
-#ifndef KIWIXLIB_KIWIX_SERVE_H_
-#define KIWIXLIB_KIWIX_SERVE_H_
-
-#include <memory>
-#include <string>
-
-class Subprocess;
-namespace kiwix {
-
-class KiwixServe
-{
-  public:
-    KiwixServe(const std::string& libraryPath, int port = 8181);
-    ~KiwixServe();
-
-    void run();
-    void shutDown();
-    bool isRunning();
-    int getPort() { return m_port; }
-    int setPort(int port);
-
-  private:
-  std::unique_ptr<Subprocess> mp_kiwixServe;
-  int m_port;
-  std::string m_libraryPath;
-};
-
-}; //end namespace kiwix
-
-#endif // KIWIXLIB_KIWIX_SERVE_H_

include/library.h

@@ -20,329 +20,87 @@
 #ifndef KIWIX_LIBRARY_H
 #define KIWIX_LIBRARY_H
 
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stack>
 #include <string>
 #include <vector>
-#include <map>
-#include <memory>
 
-#include "book.h"
-#include "bookmark.h"
-#include "common.h"
+#include "common/regexTools.h"
+#include "common/stringTools.h"
 
 #define KIWIX_LIBRARY_VERSION "20110515"
 
+using namespace std;
+
 namespace kiwix
 {
+enum supportedIndexType { UNKNOWN, XAPIAN };
 
-class OPDSDumper;
-class Library;
+class Book
+{
+ public:
+  Book();
+  ~Book();
 
-enum supportedListSortBy { UNSORTED, TITLE, SIZE, DATE, CREATOR, PUBLISHER };
-enum supportedListMode {
-  ALL = 0,
-  LOCAL = 1,
-  REMOTE = 1 << 1,
-  NOLOCAL = 1 << 2,
-  NOREMOTE = 1 << 3,
-  VALID = 1 << 4,
-  NOVALID = 1 << 5
+  static bool sortByLastOpen(const Book& a, const Book& b);
+  static bool sortByTitle(const Book& a, const Book& b);
+  static bool sortBySize(const Book& a, const Book& b);
+  static bool sortByDate(const Book& a, const Book& b);
+  static bool sortByCreator(const Book& a, const Book& b);
+  static bool sortByPublisher(const Book& a, const Book& b);
+  static bool sortByLanguage(const Book& a, const Book& b);
+  string getHumanReadableIdFromPath();
+
+  string id;
+  string path;
+  string pathAbsolute;
+  string last;
+  string indexPath;
+  string indexPathAbsolute;
+  supportedIndexType indexType;
+  string title;
+  string description;
+  string language;
+  string creator;
+  string publisher;
+  string date;
+  string url;
+  string name;
+  string tags;
+  string origId;
+  string articleCount;
+  string mediaCount;
+  bool readOnly;
+  string size;
+  string favicon;
+  string faviconMimeType;
 };
 
-class Filter {
-  public: // types
-    using Tags = std::vector<std::string>;
-
-  private: // data
-    uint64_t activeFilters;
-    Tags _acceptTags;
-    Tags _rejectTags;
-    std::string _category;
-    std::string _lang;
-    std::string _publisher;
-    std::string _creator;
-    size_t _maxSize;
-    std::string _query;
-    bool _queryIsPartial;
-    std::string _name;
-
-  public: // functions
-    Filter();
-    ~Filter() = default;
-
-    /**
-     *  Set the filter to check local.
-     *
-     *  A local book is a book with a path.
-     *  If accept is true, only local book are accepted.
-     *  If accept is false, only non local book are accepted.
-     */
-    Filter& local(bool accept);
-
-    /**
-     *  Set the filter to check remote.
-     *
-     *  A remote book is a book with a url.
-     *  If accept is true, only remote book are accepted.
-     *  If accept is false, only non remote book are accepted.
-     */
-    Filter& remote(bool accept);
-
-    /**
-     *  Set the filter to check validity.
-     *
-     *  A valid book is a book with a path pointing to a existing zim file.
-     *  If accept is true, only valid book are accepted.
-     *  If accept is false, only non valid book are accepted.
-     */
-    Filter& valid(bool accept);
-
-    /**
-     * Set the filter to only accept book with corresponding tag.
-     */
-    Filter& acceptTags(const Tags& tags);
-    Filter& rejectTags(const Tags& tags);
-
-    Filter& category(std::string category);
-    Filter& lang(std::string lang);
-    Filter& publisher(std::string publisher);
-    Filter& creator(std::string creator);
-    Filter& maxSize(size_t size);
-    Filter& query(std::string query, bool partial=true);
-    Filter& name(std::string name);
-
-    bool hasQuery() const;
-    const std::string& getQuery() const { return _query; }
-    bool queryIsPartial() const { return _queryIsPartial; }
-
-    bool hasName() const;
-    const std::string& getName() const { return _name; }
-
-    bool hasCategory() const;
-    const std::string& getCategory() const { return _category; }
-
-    bool hasLang() const;
-    const std::string& getLang() const { return _lang; }
-
-    bool hasPublisher() const;
-    const std::string& getPublisher() const { return _publisher; }
-
-    bool hasCreator() const;
-    const std::string& getCreator() const { return _creator; }
-
-    const Tags& getAcceptTags() const { return _acceptTags; }
-    const Tags& getRejectTags() const { return _rejectTags; }
-
-private: // functions
-    friend class Library;
-
-    bool accept(const Book& book) const;
-};
-
-
-/**
- * A Library store several books.
- */
 class Library
 {
-  std::map<std::string, kiwix::Book> m_books;
-  std::map<std::string, std::shared_ptr<Reader>> m_readers;
-  std::vector<kiwix::Bookmark> m_bookmarks;
-  class BookDB;
-  std::unique_ptr<BookDB> m_bookDB;
-
- public:
-  typedef std::vector<std::string> BookIdCollection;
-
  public:
   Library();
   ~Library();
 
-  /**
-   * Library is not a copiable object. However it can be moved.
-   */
-  Library(const Library& ) = delete;
-  Library(Library&& );
-  void operator=(const Library& ) = delete;
-  Library& operator=(Library&& );
-
-  /**
-   * Add a book to the library.
-   *
-   * If a book already exist in the library with the same id, update
-   * the existing book instead of adding a new one.
-   *
-   * @param book The book to add.
-   * @return True if the book has been added.
-   *         False if a book has been updated.
-   */
+  string version;
   bool addBook(const Book& book);
+  bool removeBookByIndex(const unsigned int bookIndex);
+  vector<kiwix::Book> books;
 
-  /**
-   * Add a bookmark to the library.
-   *
-   * @param bookmark the book to add.
+  /*
+   * 'current' is the variable storing the current content/book id
+   * in the library. This is used to be able to load per default a
+   * content. As Kiwix may work with many library XML files, you may
+   * have "current" defined many time with different values. The
+   * last XML file read has the priority, Although we do not have an
+   * library object for each file, we want to be able to fallback to
+   * an 'old' current book if the one which should be load
+   * failed. That is the reason why we need a stack here
    */
-  void addBookmark(const Bookmark& bookmark);
-
-  /**
-   * Remove a bookmarkk
-   *
-   * @param zimId The zimId of the bookmark.
-   * @param url The url of the bookmark.
-   * @return True if the bookmark has been removed.
-   */
-  bool removeBookmark(const std::string& zimId, const std::string& url);
-
-  const Book& getBookById(const std::string& id) const;
-  Book& getBookById(const std::string& id);
-  const Book& getBookByPath(const std::string& path) const;
-  Book& getBookByPath(const std::string& path);
-  std::shared_ptr<Reader> getReaderById(const std::string& id);
-
-  /**
-   * Remove a book from the library.
-   *
-   * @param id the id of the book to remove.
-   * @return True if the book were in the lirbrary and has been removed.
-   */
-  bool removeBookById(const std::string& id);
-
-  /**
-   * Write the library to a file.
-   *
-   * @param path the path of the file to write to.
-   * @return True if the library has been correctly saved.
-   */
-  bool writeToFile(const std::string& path) const;
-
-  /**
-   * Write the library bookmarks to a file.
-   *
-   * @param path the path of the file to write to.
-   * @return True if the library has been correctly saved.
-   */
-  bool writeBookmarksToFile(const std::string& path) const;
-
-  /**
-   * Get the number of book in the library.
-   *
-   * @param localBooks If we must count local books (books with a path).
-   * @param remoteBooks If we must count remote books (books with an url)
-   * @return The number of books.
-   */
-  unsigned int getBookCount(const bool localBooks, const bool remoteBooks) const;
-
-  /**
-   * Get all languagues of the books in the library.
-   *
-   * @return A list of languages.
-   */
-  std::vector<std::string> getBooksLanguages() const;
-
-  /**
-   * Get all categories of the books in the library.
-   *
-   * @return A list of categories.
-   */
-  std::vector<std::string> getBooksCategories() const;
-
-  /**
-   * Get all book creators of the books in the library.
-   *
-   * @return A list of book creators.
-   */
-  std::vector<std::string> getBooksCreators() const;
-
-  /**
-   * Get all book publishers of the books in the library.
-   *
-   * @return A list of book publishers.
-   */
-  std::vector<std::string> getBooksPublishers() const;
-
-  /**
-   * Get all bookmarks.
-   *
-   * @return A list of bookmarks
-   */
-  const std::vector<kiwix::Bookmark> getBookmarks(bool onlyValidBookmarks = true) const;
-
-  /**
-   * Get all book ids of the books in the library.
-   *
-   * @return A list of book ids.
-   */
-  BookIdCollection getBooksIds() const;
-
-  /**
-   * Filter the library and generate a new one with the keep elements.
-   *
-   * This is equivalent to `listBookIds(ALL, UNSORTED, search)`.
-   *
-   * @param search List only books with search in the title or description.
-   * @return The list of bookIds corresponding to the query.
-   */
-  DEPRECATED BookIdCollection filter(const std::string& search) const;
-
-
-  /**
-   * Filter the library and return the id of the keep elements.
-   *
-   * @param filter The filter to use.
-   * @return The list of bookIds corresponding to the filter.
-   */
-  BookIdCollection filter(const Filter& filter) const;
-
-
-  /**
-   * Sort (in place) bookIds using the given comparator.
-   *
-   * @param bookIds the list of book Ids to sort
-   * @param comparator how to sort the books
-   * @return The sorted list of books
-   */
-  void sort(BookIdCollection& bookIds, supportedListSortBy sortBy, bool ascending) const;
-
-  /**
-   * List books in the library.
-   *
-   * @param mode The mode of listing :
-   *             - LOCAL    : list only local books (with a path).
-   *             - REMOTE   : list only remote books (with an url).
-   *             - VALID    : list only valid books (without a path or with a
-   *                          path pointing to a valid zim file).
-   *             - NOLOCAL  : list only books without valid path.
-   *             - NOREMOTE : list only books without url.
-   *             - NOVALID  : list only books not valid.
-   *             - ALL : Do not do any filter (LOCAL or REMOTE)
-   *             - Flags can be combined.
-   * @param sortBy Attribute to sort by the book list.
-   * @param search List only books with search in the title, description.
-   * @param language List only books in this language.
-   * @param creator List only books of this creator.
-   * @param publisher List only books of this publisher.
-   * @param maxSize Do not list book bigger than maxSize.
-   *                Set to 0 to cancel this filter.
-   * @return The list of bookIds corresponding to the query.
-   */
-  DEPRECATED BookIdCollection listBooksIds(
-    int supportedListMode = ALL,
-    supportedListSortBy sortBy = UNSORTED,
-    const std::string& search = "",
-    const std::string& language = "",
-    const std::string& creator = "",
-    const std::string& publisher = "",
-    const std::vector<std::string>& tags = {},
-    size_t maxSize = 0) const;
-
-  friend class OPDSDumper;
-  friend class libXMLDumper;
-
-private: // functions
-  BookIdCollection filterViaBookDB(const Filter& filter) const;
-  void updateBookDB(const Book& book);
+  stack<string> current;
 };
-
 }
 
 #endif

include/libxml_dumper.h

@@ -1,83 +0,0 @@
-/*
- * Copyright 2018 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_LIBXML_DUMPER_H
-#define KIWIX_LIBXML_DUMPER_H
-
-#include <string>
-#include <vector>
-
-#include <pugixml.hpp>
-
-#include "library.h"
-
-namespace kiwix
-{
-
-/**
- * A tool to dump a `Library` into a basic library.xml
- *
- */
-class LibXMLDumper
-{
- public:
-  LibXMLDumper() = default;
-  LibXMLDumper(const Library* library);
-  ~LibXMLDumper();
-
-  /**
-   * Dump the library.xml
-   *
-   * @param id The id of the library.
-   * @return The library.xml content.
-   */
-  std::string dumpLibXMLContent(const std::vector<std::string>& bookIds);
-
-
-  /**
-   * Dump the bookmark of the library.
-   *
-   * @return The bookmark.xml content.
-   */
-  std::string dumpLibXMLBookmark();
-
-  /**
-   * Set the base directory used.
-   *
-   * @param baseDir the base directory to use.
-   */
-  void setBaseDir(const std::string& baseDir) { this->baseDir = baseDir; }
-
-  /**
-   * Set the library to dump.
-   *
-   * @param library The library to dump.
-   */
-  void setLibrary(const Library* library) { this->library = library; }
-
- protected:
-  const kiwix::Library* library;
-  std::string baseDir;
- private:
-  void handleBook(Book book, pugi::xml_node root_node);
-  void handleBookmark(Bookmark bookmark, pugi::xml_node root_node);
-};
-}
-
-#endif // KIWIX_OPDS_DUMPER_H

include/manager.h

@@ -20,147 +20,88 @@
 #ifndef KIWIX_MANAGER_H
 #define KIWIX_MANAGER_H
 
-#include "book.h"
+#include <time.h>
+#include <sstream>
+#include <string>
+
+#include <pugixml.hpp>
+
+#include "common/base64.h"
+#include "common/pathTools.h"
+#include "common/regexTools.h"
 #include "library.h"
 #include "reader.h"
 
-#include <string>
-#include <vector>
-
-namespace pugi {
-class xml_document;
-}
+using namespace std;
 
 namespace kiwix
 {
+enum supportedListMode { LASTOPEN, REMOTE, LOCAL };
+enum supportedListSortBy { TITLE, SIZE, DATE, CREATOR, PUBLISHER };
 
-class LibraryManipulator {
- public:
-  virtual ~LibraryManipulator() {}
-  virtual bool addBookToLibrary(Book book) = 0;
-  virtual void addBookmarkToLibrary(Bookmark bookmark) = 0;
-};
-
-class DefaultLibraryManipulator : public LibraryManipulator {
- public:
-  DefaultLibraryManipulator(Library* library) :
-    library(library) {}
-  virtual ~DefaultLibraryManipulator() {}
-  bool addBookToLibrary(Book book) {
-    return library->addBook(book);
-  }
-  void addBookmarkToLibrary(Bookmark bookmark) {
-    library->addBookmark(bookmark);
-  }
- private:
-   kiwix::Library* library;
-};
-
-/**
- * A tool to manage a `Library`.
- */
 class Manager
 {
  public:
-  Manager(LibraryManipulator* manipulator);
-  Manager(Library* library);
+  Manager();
   ~Manager();
 
-  /**
-   * Read a `library.xml` and add book in the file to the library.
-   *
-   * @param path The (utf8) path to the `library.xml`.
-   * @param readOnly Set if the libray path could be overwritten latter with
-   *                 updated content.
-   * @return True if file has been properly parsed.
-   */
-  bool readFile(const std::string& path, bool readOnly = true, bool trustLibrary = true);
-
-  /**
-   * Load a library content store in the string.
-   *
-   * @param xml The content corresponding of the library xml
-   * @param readOnly Set if the libray path could be overwritten latter with
-   *                 updated content.
-   * @param libraryPath The library path (used to resolve relative path)
-   * @return True if the content has been properly parsed.
-   */
-  bool readXml(const std::string& xml,
+  bool readFile(const string path, const bool readOnly = true);
+  bool readFile(const string nativePath,
+                const string UTF8Path,
+                const bool readOnly = true);
+  bool readXml(const string xml,
                const bool readOnly = true,
-               const std::string& libraryPath = "",
-               bool trustLibrary = true);
-
-  /**
-   * Load a library content stored in a OPDS stream.
-   *
-   * @param content The content of the OPDS stream.
-   * @param readOnly Set if the library path could be overwritten later with
-   *                 updated content.
-   * @param libraryPath The library path (used to resolve relative path)
-   * @return True if the content has been properly parsed.
-   */
-  bool readOpds(const std::string& content, const std::string& urlHost);
-
-
-  /**
-   * Load a bookmark file.
-   *
-   * @param path The path of the file to read.
-   * @return True if the content has been properly parsed.
-   */
-  bool readBookmarkFile(const std::string& path);
-
-  /**
-   * Add a book to the library.
-   *
-   * @param pathToOpen The path to the zim file to add.
-   * @param pathToSave The path to store in the library in place of pathToOpen.
-   * @param url        The url of the book to store in the library.
-   * @param checMetaData Tell if we check metadata before adding book to the
-   *                     library.
-   * @return The id of the book if the book has been added to the library.
-   *         Else, an empty string.
-   */
-  std::string addBookFromPathAndGetId(const std::string& pathToOpen,
-                                 const std::string& pathToSave = "",
-                                 const std::string& url = "",
+               const string libraryPath = "");
+  bool writeFile(const string path);
+  bool removeBookByIndex(const unsigned int bookIndex);
+  bool removeBookById(const string id);
+  bool setCurrentBookId(const string id);
+  string getCurrentBookId();
+  bool setBookIndex(const string id,
+                    const string path,
+                    const supportedIndexType type);
+  bool setBookIndex(const string id, const string path);
+  bool setBookPath(const string id, const string path);
+  string addBookFromPathAndGetId(const string pathToOpen,
+                                 const string pathToSave = "",
+                                 const string url = "",
                                  const bool checkMetaData = false);
-
-  /**
-   * Add a book to the library.
-   *
-   * @param pathToOpen The path to the zim file to add.
-   * @param pathToSave The path to store in the library in place of pathToOpen.
-   * @param url        The url of the book to store in the library.
-   * @param checMetaData Tell if we check metadata before adding book to the
-   *                     library.
-   * @return True if the book has been added to the library.
-   */
-
-  bool addBookFromPath(const std::string& pathToOpen,
-                       const std::string& pathToSave = "",
-                       const std::string& url = "",
+  bool addBookFromPath(const string pathToOpen,
+                       const string pathToSave = "",
+                       const string url = "",
                        const bool checkMetaData = false);
+  Library cloneLibrary();
+  bool getBookById(const string id, Book& book);
+  bool getCurrentBook(Book& book);
+  unsigned int getBookCount(const bool localBooks, const bool remoteBooks);
+  bool updateBookLastOpenDateById(const string id);
+  void removeBookPaths();
+  bool listBooks(const supportedListMode mode,
+                 const supportedListSortBy sortBy,
+                 const unsigned int maxSize,
+                 const string language,
+                 const string creator,
+                 const string publisher,
+                 const string search);
+  vector<string> getBooksLanguages();
+  vector<string> getBooksCreators();
+  vector<string> getBooksPublishers();
+  vector<string> getBooksIds();
 
-  std::string writableLibraryPath;
+  string writableLibraryPath;
 
-  bool m_hasSearchResult = false;
-  uint64_t m_totalBooks = 0;
-  uint64_t m_startIndex = 0;
-  uint64_t m_itemsPerPage = 0;
+  vector<std::string> bookIdList;
 
  protected:
-  kiwix::LibraryManipulator* manipulator;
-  bool mustDeleteManipulator;
+  kiwix::Library library;
 
-  bool readBookFromPath(const std::string& path, Book* book);
+  bool readBookFromPath(const string path, Book* book = NULL);
   bool parseXmlDom(const pugi::xml_document& doc,
-                   bool readOnly,
-                   const std::string& libraryPath,
-                   bool trustLibrary);
-  bool parseOpdsDom(const pugi::xml_document& doc,
-                    const std::string& urlHost);
+                   const bool readOnly,
+                   const string libraryPath);
 
+ private:
+  void checkAndCleanBookPaths(Book& book, const string& libraryPath);
 };
 }
 

include/meson.build

@@ -1,30 +1,30 @@
 headers = [
-  'book.h',
-  'bookmark.h',
-  'common.h',
   'library.h',
   'manager.h',
-  'libxml_dumper.h',
-  'opds_dumper.h',
-  'downloader.h',
   'reader.h',
-  'entry.h',
-  'searcher.h',
-  'search_renderer.h',
-  'server.h',
-  'kiwixserve.h',
-  'name_mapper.h'
+  'searcher.h'
 ]
 
+if xapian_dep.found()
+  headers += ['xapianSearcher.h']
+endif
+
 install_headers(headers, subdir:'kiwix')
 
 install_headers(
-  'tools/base64.h',
-  'tools/networkTools.h',
-  'tools/otherTools.h',
-  'tools/pathTools.h',
-  'tools/regexTools.h',
-  'tools/stringTools.h',
-  subdir:'kiwix/tools'
+  'common/base64.h',
+  'common/networkTools.h',
+  'common/otherTools.h',
+  'common/pathTools.h',
+  'common/regexTools.h',
+  'common/stringTools.h',
+  subdir:'kiwix/common'
 )
 
+if has_ctpp2_dep
+  install_headers(
+    'ctpp2/CTPP2VMStringLoader.hpp',
+    subdir:'kiwix/ctpp2'
+  )
+endif
+

include/name_mapper.h

@@ -1,61 +0,0 @@
-/*
- * Copyright 2019 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_NAMEMAPPER_H
-#define KIWIX_NAMEMAPPER_H
-
-#include <string>
-#include <map>
-
-namespace kiwix
-{
-
-class Library;
-
-class NameMapper {
-  public:
-    virtual ~NameMapper() = default;
-    virtual std::string getNameForId(const std::string& id) = 0;
-    virtual std::string getIdForName(const std::string& name) = 0;
-};
-
-
-class IdNameMapper : public NameMapper {
-  public:
-    virtual std::string getNameForId(const std::string& id) { return id; };
-    virtual std::string getIdForName(const std::string& name) { return name; };
-};
-
-class HumanReadableNameMapper : public NameMapper {
-  private:
-    std::map<std::string, std::string> m_idToName;
-    std::map<std::string, std::string> m_nameToId;
-
-  public:
-    HumanReadableNameMapper(kiwix::Library& library, bool withAlias);
-    virtual ~HumanReadableNameMapper() = default;
-    virtual std::string getNameForId(const std::string& id);
-    virtual std::string getIdForName(const std::string& name);
-};
-
-
-
-}
-
-#endif

include/opds_dumper.h

@@ -1,110 +0,0 @@
-/*
- * 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_OPDS_DUMPER_H
-#define KIWIX_OPDS_DUMPER_H
-
-#include <time.h>
-#include <sstream>
-#include <string>
-
-#include <pugixml.hpp>
-
-#include "tools/base64.h"
-#include "tools/pathTools.h"
-#include "tools/regexTools.h"
-#include "library.h"
-#include "reader.h"
-
-using namespace std;
-
-namespace kiwix
-{
-
-/**
- * A tool to dump a `Library` into a opds stream.
- *
- */
-class OPDSDumper
-{
- public:
-  OPDSDumper() = default;
-  OPDSDumper(Library* library);
-  ~OPDSDumper();
-
-  /**
-   * Dump the OPDS feed.
-   *
-   * @param bookIds the ids of the books to include in the feed
-   * @param query the query used to obtain the list of book ids
-   * @return The OPDS feed.
-   */
-  std::string dumpOPDSFeed(const std::vector<std::string>& bookIds, const std::string& query) const;
-
-  /**
-   * Dump the OPDS feed.
-   *
-   * @param bookIds the ids of the books to include in the feed
-   * @param query the query used to obtain the list of book ids
-   * @return The OPDS feed.
-   */
-  std::string dumpOPDSFeedV2(const std::vector<std::string>& bookIds, const std::string& query) const;
-
-  /**
-   * Dump the categories OPDS feed.
-   *
-   * @param categories list of category names
-   * @return The OPDS feed.
-   */
-  std::string categoriesOPDSFeed(const std::vector<std::string>& categories) 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;
-  std::string libraryId;
-  std::string rootLocation;
-  int m_totalResults;
-  int m_startIndex;
-  int m_count;
-};
-}
-
-#endif // KIWIX_OPDS_DUMPER_H

include/reader.h

@@ -21,478 +21,105 @@
 #define KIWIX_READER_H
 
 #include <stdio.h>
+#include <zim/article.h>
+#include <zim/file.h>
+#include <zim/fileiterator.h>
 #include <zim/zim.h>
-#include <zim/archive.h>
 #include <exception>
 #include <map>
 #include <sstream>
 #include <string>
-#include "common.h"
-#include "entry.h"
-#include "tools/pathTools.h"
-#include "tools/stringTools.h"
+#include "common/pathTools.h"
+#include "common/stringTools.h"
 
 using namespace std;
 
 namespace kiwix
 {
-
-/**
- * The SuggestionItem is a helper class that contains the info about a single
- * suggestion item.
- */
-
-class SuggestionItem
-{
-  // Functions
-  private:
-    // Create a sugggestion item.
-    explicit SuggestionItem(std::string title, std::string normalizedTitle,
-                            std::string path, std::string snippet = "") :
-      title(title),
-      normalizedTitle(normalizedTitle),
-      path(path),
-      snippet(snippet) {}
-
-  public:
-    const std::string getTitle()           {return title;}
-    const std::string getNormalizedTitle() {return normalizedTitle;}
-    const std::string getPath()            {return path;}
-    const std::string getSnippet()         {return snippet;}
-
-    const bool hasSnippet()                {return !snippet.empty();}
-
-  // Data
-  private:
-    std::string title;
-    std::string normalizedTitle;
-    std::string path;
-    std::string snippet;
-
-  friend class Reader;
-};
-
-/**
- * The Reader class is the class who allow to get an entry content from a zim
- * file.
- */
-
-using SuggestionsList_t = std::vector<SuggestionItem>;
 class Reader
 {
  public:
-  /**
-   * Create a Reader to read a zim file specified by zimFilePath.
-   *
-   * @param zimFilePath The path to the zim file to read.
-   *                    The zim file can be splitted (.zimaa, .zimab, ...).
-   *                    In this case, the file path must still point to the
-   *                    unsplitted path as if the file were not splitted
-   *                    (.zim extesion).
-   */
-  explicit Reader(const string zimFilePath);
-#ifndef _WIN32
-  explicit Reader(int fd);
-  Reader(int fd, zim::offset_type offset, zim::size_type size);
-#endif
-  ~Reader() = default;
+  Reader(const string zimFilePath);
+  ~Reader();
 
-  /**
-   * Get the number of "displayable" entries in the zim file.
-   *
-   * @return If the zim file has a /M/Counter metadata, return the number of
-   *         entries with the 'text/html' MIMEtype specified in the metadata.
-   *         Else return the number of entries in the 'A' namespace.
-   */
+  void reset();
   unsigned int getArticleCount() const;
-
-  /**
-   * Get the number of media in the zim file.
-   *
-   * @return If the zim file has a /M/Counter metadata, return the number of
-   *         entries with the 'image/jpeg', 'image/gif' and 'image/png' in
-   *         the metadata.
-   *         Else return the number of entries in the 'I' namespace.
-   */
   unsigned int getMediaCount() const;
-
-  /**
-   * Get the number of all entries in the zim file.
-   *
-   * @return Return the number of all the entries, whatever their MIMEtype or
-   *         their namespace.
-   */
   unsigned int getGlobalCount() const;
-
-  /**
-   * Get the path of the zim file.
-   *
-   * @return the path of the zim file as given in the constructor.
-   */
   string getZimFilePath() const;
-
-  /**
-   * Get the Id of the zim file.
-   *
-   * @return The uuid stored in the zim file.
-   */
   string getId() const;
-
-  /**
-   * Get a random page.
-   *
-   * @return A random Entry. The entry is picked from all entries in
-   *         the 'A' namespace.
-   *         The main entry is excluded from the potential results.
-   */
-  Entry getRandomPage() const;
-
-  /**
-   * Get the entry of the main page.
-   *
-   * @return Entry of the main page as specified in the zim file.
-   */
-  Entry getMainPage() const;
-
-  /**
-   * Get the content of a metadata.
-   *
-   * @param[in]  name The name of the metadata.
-   * @param[out] value The value will be set to the content of the metadata.
-   * @return True if it was possible to get the content of the metadata.
-   */
-  bool getMetadata(const string& name, string& value) const;
-
-  /**
-   * Get the name of the zim file.
-   *
-   * @return The name of the zim file as specified in the zim metadata.
-   */
-  string getName() const;
-
-  /**
-   * Get the title of the zim file.
-   *
-   * @return The title of zim file as specified in the zim metadata.
-   *         If no title has been set, return a title computed from the
-   *         file path.
-   */
+  string getRandomPageUrl() const;
+  string getFirstPageUrl() const;
+  string getMainPageUrl() const;
+  bool getMetatag(const string& url, string& content) const;
   string getTitle() const;
-
-  /**
-   * Get the creator of the zim file.
-   *
-   * @return The creator of the zim file as specified in the zim metadata.
-   */
-  string getCreator() const;
-
-  /**
-   * Get the publisher of the zim file.
-   *
-   * @return The publisher of the zim file as specified in the zim metadata.
-   */
-  string getPublisher() const;
-
-  /**
-   * Get the date of the zim file.
-   *
-   * @return The date of the zim file as specified in the zim metadata.
-   */
-  string getDate() const;
-
-  /**
-   * Get the description of the zim file.
-   *
-   * @return The description of the zim file as specified in the zim metadata.
-   *         If no description has been set, return the subtitle.
-   */
   string getDescription() const;
-
-  /**
-   * Get the long description of the zim file.
-   *
-   * @return The long description of the zim file as specifed in the zim metadata.
-   */
-  string getLongDescription() const;
-
-  /**
-   * Get the language of the zim file.
-   *
-   * @return The language of the zim file as specified in the zim metadata.
-   */
   string getLanguage() const;
-
-  /**
-   * Get the license of the zim file.
-   *
-   * @return The license of the zim file as specified in the zim metadata.
-   */
-  string getLicense() const;
-
-  /**
-   * Get the tags of the zim file.
-   *
-   * @param original If true, return the original tags as specified in the zim metadata.
-   *                 Else, try to convert it to the new 'normalized' format.
-   * @return The tags of the zim file.
-   */
-  string getTags(bool original=false) const;
-
-  /**
-   * Get the value (as a string) of a specific tag.
-   *
-   * According to https://wiki.openzim.org/wiki/Tags
-   *
-   * @return The value of the specified tag.
-   * @throw  std::out_of_range if the specified tag is not found.
-   */
-  string getTagStr(const std::string& tagName) const;
-
-  /**
-   * Get the boolean value of a specific tag.
-   *
-   * According to https://wiki.openzim.org/wiki/Tags
-   *
-   * @return The boolean value of the specified tag.
-   * @throw  std::out_of_range if the specified tag is not found.
-   *         std::domain_error if the value of the tag cannot be convert to bool.
-   */
-  bool getTagBool(const std::string& tagName) const;
-
-  /**
-   * Get the relations of the zim file.
-   *
-   * @return The relation of the zim file as specified in the zim metadata.
-   */
-  string getRelation() const;
-
-  /**
-   * Get the flavour of the zim file.
-   *
-   * @return The flavour of the zim file as specified in the zim metadata.
-   */
-  string getFlavour() const;
-
-  /**
-   * Get the source of the zim file.
-   *
-   * @return The source of the zim file as specified in the zim metadata.
-   */
-  string getSource() const;
-
-  /**
-   * Get the scraper of the zim file.
-   *
-   * @return The scraper of the zim file as specified in the zim metadata.
-   */
-  string getScraper() const;
-
-  /**
-   * Get the origId of the zim file.
-   *
-   * The origId is only used in the case of patch zim file and is the Id
-   * of the original zim file.
-   *
-   * @return The origId of the zim file as specified in the zim metadata.
-   */
+  string getName() const;
+  string getTags() const;
+  string getDate() const;
+  string getCreator() const;
+  string getPublisher() const;
   string getOrigId() const;
-
-  /**
-   * Get the favicon of the zim file.
-   *
-   * @param[out] content The content of the favicon.
-   * @param[out] mimeType The mimeType of the favicon.
-   * @return True if a favicon has been found.
-   */
   bool getFavicon(string& content, string& mimeType) const;
-
-  /**
-   * Get an entry associated to an path.
-   *
-   * @param path The path of the entry.
-   * @return The entry.
-   * @throw NoEntry If no entry correspond to the path.
-   */
-  Entry getEntryFromPath(const std::string& path) const;
-
-  /**
-   * Get an entry associated to an url encoded path.
-   *
-   * Equivalent to `getEntryFromPath(urlDecode(path));`
-   *
-   * @param path The url encoded path.
-   * @return The entry.
-   * @throw NoEntry If no entry correspond to the path.
-   */
-  Entry getEntryFromEncodedPath(const std::string& path) const;
-
-  /**
-   * Get un entry associated to a title.
-   *
-   * @param title The title.
-   * @return The entry
-   * throw NoEntry If no entry correspond to the url.
-   */
-  Entry getEntryFromTitle(const std::string& title) const;
-
-  /**
-   * Search for entries with title starting with prefix (case sensitive).
-   *
-   * Suggestions are stored in an internal vector and can be retrieved using
-   * `getNextSuggestion` method.
-   * This method is not thread safe and is deprecated. Use :
-   * bool searchSuggestions(const string& prefix,
-   *                        unsigned int suggestionsCount,
-   *                        SuggestionsList_t& results);
-   *
-   * @param prefix The prefix to search.
-   * @param suggestionsCount How many suggestions to search for.
-   * @param reset If true, remove previous suggestions in the internal vector.
-   *              If false, add suggestions to the internal vector
-   *              (until internal vector size is suggestionCount (or no more
-   *               suggestion))
-   * @return True if some suggestions have been added to the internal vector.
-   */
-  DEPRECATED bool searchSuggestions(const string& prefix,
-                         unsigned int suggestionsCount,
-                         const bool reset = true);
-
-  /**
-   * Search for entries with title starting with prefix (case sensitive).
-   *
-   * Suggestions are added to the `result` vector.
-   *
-   * @param prefix The prefix to search.
-   * @param suggestionsCount How many suggestions to search for.
-   * @param result The vector where to store the suggestions.
-   * @return True if some suggestions have been added to the vector.
-   */
-
+  bool getPageUrlFromTitle(const string& title, string& url) const;
+  bool getMimeTypeByUrl(const string& url, string& mimeType) const;
+  bool getContentByUrl(const string& url,
+                       string& content,
+                       string& title,
+                       unsigned int& contentLength,
+                       string& contentType) const;
+  bool getContentByEncodedUrl(const string& url,
+                              string& content,
+                              string& title,
+                              unsigned int& contentLength,
+                              string& contentType,
+                              string& baseUrl) const;
+  bool getContentByEncodedUrl(const string& url,
+                              string& content,
+                              string& title,
+                              unsigned int& contentLength,
+                              string& contentType) const;
+  bool getContentByDecodedUrl(const string& url,
+                              string& content,
+                              string& title,
+                              unsigned int& contentLength,
+                              string& contentType,
+                              string& baseUrl) const;
+  bool getContentByDecodedUrl(const string& url,
+                              string& content,
+                              string& title,
+                              unsigned int& contentLength,
+                              string& contentType) const;
   bool searchSuggestions(const string& prefix,
                          unsigned int suggestionsCount,
-                         SuggestionsList_t& resuls);
-
-  /**
-   * Search for entries for the given prefix.
-   *
-   * If the zim file has a internal fulltext index, the suggestions will be
-   * searched using it.
-   * Else the suggestions will be search using `searchSuggestions` while trying
-   * to be smart about case sensitivity (using `getTitleVariants`).
-   *
-   * In any case, suggestions are stored in an internal vector and can be
-   * retrieved using `getNextSuggestion` method.
-   * The internal vector will be reset.
-   * This method is not thread safe and is deprecated. Use :
-   * bool searchSuggestionsSmart(const string& prefix,
-   *                             unsigned int suggestionsCount,
-   *                             SuggestionsList_t& results);
-   *
-   * @param prefix The prefix to search for.
-   * @param suggestionsCount How many suggestions to search for.
-   */
-  DEPRECATED bool searchSuggestionsSmart(const string& prefix,
+                         const bool reset = true);
+  bool searchSuggestionsSmart(const string& prefix,
                               unsigned int suggestionsCount);
-
-  /**
-   * Search for entries for the given prefix.
-   *
-   * If the zim file has a internal fulltext index, the suggestions will be
-   * searched using it.
-   * Else the suggestions will be search using `searchSuggestions` while trying
-   * to be smart about case sensitivity (using `getTitleVariants`).
-   *
-   * In any case, suggestions are stored in an internal vector and can be
-   * retrieved using `getNextSuggestion` method.
-   * The internal vector will be reset.
-   *
-   * @param prefix The prefix to search for.
-   * @param suggestionsCount How many suggestions to search for.
-   * @param results The vector where to store the suggestions
-   * @return True if some suggestions have been added to the results.
-   */
-   bool searchSuggestionsSmart(const string& prefix,
-                              unsigned int suggestionsCount,
-                              SuggestionsList_t& results);
-
-
-  /**
-   * Check if the path exists in the zim file.
-   *
-   * @param path the path to check.
-   * @return True if the path exists in the zim file.
-   */
-  bool pathExists(const string& path) const;
-
-  /**
-   * Check if the zim file has a embedded fulltext index.
-   *
-   * @return True if the zim file has a embedded fulltext index
-   *         and is not split (else the fulltext is not accessible).
-   */
+  bool urlExists(const string& url) const;
   bool hasFulltextIndex() const;
-
-  /**
-   * Get potential case title variations for a title.
-   *
-   * @param title a title.
-   * @return the list of variantions.
-   */
   std::vector<std::string> getTitleVariants(const std::string& title) const;
-
-  /**
-   * Get the next suggestion title.
-   *
-   * @param[out] title the title of the suggestion.
-   * @return True if title has been set.
-   */
-  DEPRECATED bool getNextSuggestion(string& title);
-
-  /**
-   * Get the next suggestion title and url.
-   *
-   * @param[out] title the title of the suggestion.
-   * @param[out] url the url of the suggestion.
-   * @return True if title and url have been set.
-   */
-  DEPRECATED bool getNextSuggestion(string& title, string& url);
-
-  /**
-   * Get if we can check zim file integrity (has a checksum).
-   *
-   * @return True if zim file have a checksum.
-   */
+  bool getNextSuggestion(string& title);
+  bool getNextSuggestion(string& title, string& url);
   bool canCheckIntegrity() const;
-
-  /**
-   * Check is zim file is corrupted.
-   *
-   * @return True if zim file is corrupted.
-   */
   bool isCorrupted() const;
-
-  /**
-   * Return the total size of the zim file.
-   *
-   * If zim file is split, return the sum of all parts' size.
-   *
-   * @return Size of the size file is KiB.
-   */
+  bool parseUrl(const string& url, char* ns, string& title) const;
   unsigned int getFileSize() const;
-
-  /**
-   * Get the zim file handler.
-   *
-   * @return The libzim file handler.
-   */
-  zim::Archive* getZimArchive() const;
+  zim::File* getZimFileHandler() const;
+  bool getArticleObjectByDecodedUrl(const string& url,
+                                    zim::Article& article) const;
 
  protected:
-  std::unique_ptr<zim::Archive> zimArchive;
+  zim::File* zimFileHandler;
+  zim::size_type firstArticleOffset;
+  zim::size_type lastArticleOffset;
+  zim::size_type currentArticleOffset;
+  zim::size_type nsACount;
+  zim::size_type nsICount;
   std::string zimFilePath;
 
-  SuggestionsList_t suggestions;
-  SuggestionsList_t::iterator suggestionsOffset;
+  std::vector<std::vector<std::string>> suggestions;
+  std::vector<std::vector<std::string>>::iterator suggestionsOffset;
 
  private:
   std::map<const std::string, unsigned int> parseCounterMetadata() const;

include/search_renderer.h

@@ -1,91 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_SEARCH_RENDERER_H
-#define KIWIX_SEARCH_RENDERER_H
-
-#include <string>
-
-namespace kiwix
-{
-
-class Searcher;
-class NameMapper;
-/**
- * The SearcherRenderer class is used to render a search result to a html page.
- */
-class SearchRenderer
-{
- public:
-  /**
-   * The default constructor.
-   *
-   * @param humanReadableName The global zim's humanReadableName.
-   *                          Used to generate pagination links.
-   */
-  SearchRenderer(Searcher* searcher, NameMapper* mapper);
-
-  ~SearchRenderer();
-
-  void setSearchPattern(const std::string& pattern);
-
-  /**
-   * Set the search content id.
-   */
-  void setSearchContent(const std::string& name);
-
-  /**
-   * Set protocol prefix.
-   */
-  void setProtocolPrefix(const std::string& prefix);
-
-  /**
-   * Set search protocol prefix.
-   */
-  void setSearchProtocolPrefix(const std::string& prefix);
-
-  /**
-   * set result count per page
-   */
-  void setPageLength(unsigned int pageLength){
-    this->pageLength  = pageLength;
-  }
-
-  /**
-   * Generate the html page with the resutls of the search.
-   */
-  std::string getHtml();
-
- protected:
-  std::string beautifyInteger(const unsigned int number);
-  Searcher* mp_searcher;
-  NameMapper* mp_nameMapper;
-  std::string searchContent;
-  std::string searchPattern;
-  std::string protocolPrefix;
-  std::string searchProtocolPrefix;
-  unsigned int pageLength;
-  unsigned int estimatedResultCount;
-  unsigned int resultStart;
-};
-
-
-}
-
-#endif

include/searcher.h

@@ -27,10 +27,11 @@
 #include <cctype>
 #include <locale>
 #include <string>
-#include <memory>
 #include <vector>
-#include "tools/pathTools.h"
-#include "tools/stringTools.h"
+#include <vector>
+#include "common/pathTools.h"
+#include "common/stringTools.h"
+#include "kiwix_config.h"
 
 using namespace std;
 
@@ -48,102 +49,35 @@ class Result
   virtual std::string get_content() = 0;
   virtual int get_wordCount() = 0;
   virtual int get_size() = 0;
-  virtual std::string get_zimId() = 0;
+  virtual int get_readerIndex() = 0;
 };
 
 struct SearcherInternal;
-/**
- * The Searcher class is reponsible to do different kind of search using the
- * fulltext index.
- */
 class Searcher
 {
  public:
-  /**
-   * The default constructor.
-   */
   Searcher();
-
+  Searcher(const string& xapianDirectoryPath,
+           Reader* reader,
+           const string& humanReadableName);
   ~Searcher();
 
-  /**
-   * Add a reader (containing embedded fulltext index) to the search.
-   *
-   * @param reader The Reader for the zim containing the fulltext index.
-   * @return true if the reader has been added.
-   *         false if the reader cannot be added (no embedded fulltext index present)
-   */
-  bool add_reader(Reader* reader);
-
-
-  Reader* get_reader(int index);
-
-  /**
-   * Start a search on the zim associated to the Searcher.
-   *
-   * Search results should be retrived using the getNextResult method.
-   *
-   * @param search The search query.
-   * @param resultStart the start offset of the search results (used for pagination).
-   * @param resultEnd the end offset of the search results (used for pagination).
-   * @param verbose print some info on stdout if true.
-   */
-  void search(const std::string& search,
+  void add_reader(Reader* reader, const std::string& humanReaderName);
+  void search(std::string& search,
               unsigned int resultStart,
               unsigned int resultEnd,
               const bool verbose = false);
-
-  /**
-   * Start a geographique search.
-   * The search return result for entry in a disc of center latitude/longitude
-   * and radius distance.
-   *
-   * Search results should be retrived using the getNextResult method.
-   *
-   * @param latitude The latitude of the center point.
-   * @param longitude The longitude of the center point.
-   * @param distance The radius of the disc.
-   * @param resultStart the start offset of the search results (used for pagination).
-   * @param resultEnd the end offset of the search results (used for pagination).
-   * @param verbose print some info on stdout if true.
-   */
-  void geo_search(float latitude, float longitude, float distance,
-                  unsigned int resultStart,
-                  unsigned int resultEnd,
-                  const bool verbose = false);
-
-  /**
-   * Start a suggestion search.
-   * The search made depend of the "version" of the embedded index.
-   *  - If the index is newer enough and have a title namespace, the search is
-   *    made in the titles only.
-   *  - Else the search is made on the whole article content.
-   * In any case, the search is made "partial" (as adding '*' at the end of the query)
-   *
-   * @param search The search query.
-   * @param verbose print some info on stdout if true.
-   */
   void suggestions(std::string& search, const bool verbose = false);
-
-  /**
-   * Get the next result of a started search.
-   * This is the method to use to loop hover the search results.
-   */
   Result* getNextResult();
-
-  /**
-   * Restart the previous search.
-   * Next call to getNextResult will return the first result.
-   */
   void restart_search();
-
-  /**
-   * Get a estimation of the result count.
-   */
   unsigned int getEstimatedResultCount();
+  bool setProtocolPrefix(const std::string prefix);
+  bool setSearchProtocolPrefix(const std::string prefix);
+  void reset();
 
-  unsigned int getResultStart() { return resultStart; }
-  unsigned int getResultEnd() { return resultEnd; }
+#ifdef ENABLE_CTPP2
+  string getHtml();
+#endif
 
  protected:
   std::string beautifyInteger(const unsigned int number);
@@ -154,18 +88,17 @@ class Searcher
                      const bool verbose = false);
 
   std::vector<Reader*> readers;
-  std::unique_ptr<SearcherInternal> internal;
+  std::vector<std::string> humanReaderNames;
+  SearcherInternal* internal;
   std::string searchPattern;
+  std::string protocolPrefix;
+  std::string searchProtocolPrefix;
+  unsigned int resultCountPerPage;
   unsigned int estimatedResultCount;
   unsigned int resultStart;
   unsigned int resultEnd;
-
- private:
-  void reset();
-
+  std::string contentHumanReadableId;
 };
-
-
 }
 
 #endif

include/server.h

@@ -1,78 +0,0 @@
-/*
- * Copyright 2019 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_SERVER_H
-#define KIWIX_SERVER_H
-
-#include <string>
-#include <memory>
-
-namespace kiwix
-{
-  class Library;
-  class NameMapper;
-  class InternalServer;
-
-  class Server {
-     public:
-       /**
-        * The default constructor.
-        *
-        * @param library The library to serve.
-        */
-       Server(Library* library, NameMapper* nameMapper=nullptr);
-
-       virtual ~Server();
-
-       /**
-        * Serve the content.
-        */
-       bool start();
-
-       /**
-        * Stop the daemon.
-        */
-       void stop();
-
-       void setRoot(const std::string& root);
-       void setAddress(const std::string& addr) { m_addr = addr; }
-       void setPort(int port) { m_port = port; }
-       void setNbThreads(int threads) { m_nbThreads = threads; }
-       void setVerbose(bool verbose) { m_verbose = verbose; }
-       void setTaskbar(bool withTaskbar, bool withLibraryButton)
-        { m_withTaskbar = withTaskbar; m_withLibraryButton = withLibraryButton; }
-       void setBlockExternalLinks(bool blockExternalLinks)
-        { m_blockExternalLinks = blockExternalLinks; }
-
-     protected:
-       Library* mp_library;
-       NameMapper* mp_nameMapper;
-       std::string m_root = "";
-       std::string m_addr = "";
-       int m_port = 80;
-       int m_nbThreads = 1;
-       bool m_verbose = false;
-       bool m_withTaskbar = true;
-       bool m_withLibraryButton = true;
-       bool m_blockExternalLinks = false;
-       std::unique_ptr<InternalServer> mp_server;
-  };
-}
-
-#endif

include/tools/base64.h

@@ -1,4 +0,0 @@
-#include <string>
-
-std::string base64_encode(const std::string& inString);
-std::string base64_decode(const std::string& s);

include/tools/otherTools.h

@@ -1,56 +0,0 @@
-/*
- * Copyright 2014 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_OTHERTOOLS_H
-#define KIWIX_OTHERTOOLS_H
-
-#include <string>
-#include <vector>
-#include <map>
-#include <zim/zim.h>
-#include <mustache.hpp>
-
-namespace pugi {
-  class xml_node;
-}
-
-namespace kiwix
-{
-  void sleep(unsigned int milliseconds);
-  std::string nodeToString(const pugi::xml_node& node);
-  std::string converta2toa3(const std::string& a2code);
-
-  /*
-   * Convert all format tag string to new format
-   */
-  std::vector<std::string> convertTags(const std::string& tags_str);
-  std::string getTagValueFromTagList(const std::vector<std::string>& tagList,
-                                     const std::string& tagName);
-  bool convertStrToBool(const std::string& value);
-
-  using MimeCounterType = std::map<const std::string, zim::entry_index_type>;
-  MimeCounterType parseMimetypeCounter(const std::string& counterData);
-
-  std::string gen_date_str();
-  std::string gen_uuid(const std::string& s);
-
-  std::string render_template(const std::string& template_str, kainjow::mustache::data data);
-}
-
-#endif

include/tools/pathTools.h

@@ -1,48 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#ifndef KIWIX_PATHTOOLS_H
-#define KIWIX_PATHTOOLS_H
-
-#include <string>
-
-#ifdef _WIN32
-std::string WideToUtf8(const std::wstring& wstr);
-std::wstring Utf8ToWide(const std::string& str);
-#endif
-bool isRelativePath(const std::string& path);
-std::string computeAbsolutePath(const std::string& path, const std::string& relativePath);
-std::string computeRelativePath(const std::string& path, const std::string& absolutePath);
-std::string removeLastPathElement(const std::string& path);
-std::string appendToDirectory(const std::string& directoryPath, const std::string& filename);
-
-unsigned int getFileSize(const std::string& path);
-std::string getFileSizeAsString(const std::string& path);
-std::string getFileContent(const std::string& path);
-bool fileExists(const std::string& path);
-bool makeDirectory(const std::string& path);
-std::string makeTmpDirectory();
-bool copyFile(const std::string& sourcePath, const std::string& destPath);
-std::string getLastPathElement(const std::string& path);
-std::string getExecutablePath(bool realPathOnly = false);
-std::string getCurrentDirectory();
-std::string getDataDirectory();
-bool writeTextFile(const std::string& path, const std::string& content);
-std::string getMimeTypeForFile(const std::string& filename);
-#endif

include/xapianSearcher.h

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#ifndef KIWIX_XAPIAN_SEARCHER_H
+#define KIWIX_XAPIAN_SEARCHER_H
+
+#include <xapian.h>
+#include "reader.h"
+#include "searcher.h"
+
+#include <map>
+#include <string>
+
+using namespace std;
+
+namespace kiwix
+{
+class XapianSearcher;
+
+class XapianResult : public Result
+{
+ public:
+  XapianResult(XapianSearcher* searcher, Xapian::MSetIterator& iterator);
+  virtual ~XapianResult(){};
+
+  virtual std::string get_url();
+  virtual std::string get_title();
+  virtual int get_score();
+  virtual std::string get_snippet();
+  virtual std::string get_content();
+  virtual int get_wordCount();
+  virtual int get_size();
+  virtual int get_readerIndex() { return 0; };
+
+ private:
+  XapianSearcher* searcher;
+  Xapian::MSetIterator iterator;
+  Xapian::Document document;
+};
+
+class NoXapianIndexInZim : public exception
+{
+  virtual const char* what() const throw()
+  {
+    return "There is no fulltext index in the zim file";
+  }
+};
+
+class XapianSearcher
+{
+  friend class XapianResult;
+
+ public:
+  XapianSearcher(const string& xapianDirectoryPath, Reader* reader);
+  virtual ~XapianSearcher(){};
+  void searchInIndex(string& search,
+                     const unsigned int resultStart,
+                     const unsigned int resultEnd,
+                     const bool verbose = false);
+  virtual Result* getNextResult();
+  void restart_search();
+
+  Xapian::MSet results;
+
+ protected:
+  void closeIndex();
+  void openIndex(const string& xapianDirectoryPath);
+  void setup_queryParser();
+
+  Reader* reader;
+  Xapian::Database readableDatabase;
+  std::string language;
+  std::string stopwords;
+  Xapian::QueryParser queryParser;
+  Xapian::Stem stemmer;
+  Xapian::SimpleStopper stopper;
+  Xapian::MSetIterator current_result;
+  std::map<std::string, int> valuesmap;
+};
+}
+
+#endif

meson.build

@@ -1,85 +1,100 @@
-project('libkiwix', 'cpp',
-  version : '10.0.0', # Also change this in android-kiwix-lib-publisher/kiwixLibAndroid/build.gradle
-  license : 'GPLv3+',
-  default_options : ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
+project('kiwix-lib', 'cpp',
+  version : '1.0.2',
+  license : 'GPL',
+  default_options : ['c_std=c11', 'cpp_std=c++11'])
 
 compiler = meson.get_compiler('cpp')
+find_library_in_compiler = meson.version().version_compare('>=0.31.0')
 
-wrapper = get_option('wrapper')
+static_deps = get_option('android') or get_option('default_library') == 'static'
 
-static_deps = wrapper.contains('android') or wrapper.contains('java') or get_option('default_library') == 'static'
-if wrapper.contains('android')
-  extra_libs = ['-llog']
-else
-  extra_libs = []
-endif
-
-if wrapper.contains('java')
-  add_languages('java')
-endif
-
-# See https://github.com/kiwix/libkiwix/issues/371
-if ['arm', 'mips', 'm68k', 'ppc', 'sh4'].contains(target_machine.cpu_family())
-  extra_libs += '-latomic'
-endif
-
-if (compiler.get_id() == 'gcc' and build_machine.system() == 'linux') or target_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
+thread_dep = dependency('threads')
 libicu_dep = dependency('icu-i18n', static:static_deps)
+libzim_dep = dependency('libzim', version : '>=3.0.0', static:static_deps)
 pugixml_dep = dependency('pugixml', static:static_deps)
-libcurl_dep = dependency('libcurl', static:static_deps)
-microhttpd_dep = dependency('libmicrohttpd', static:static_deps)
-zlib_dep = dependency('zlib', static:static_deps)
-xapian_dep = dependency('xapian-core', static:static_deps)
 
-if compiler.has_header('mustache.hpp')
-  extra_include = []
-elif compiler.has_header('mustache.hpp', args: '-I/usr/include/kainjow')
-  extra_include = ['/usr/include/kainjow']
+ctpp2_include_path = ''
+has_ctpp2_dep = false
+ctpp2_prefix_install = get_option('ctpp2-install-prefix')
+ctpp2_link_args = []
+if ctpp2_prefix_install == ''
+  if compiler.has_header('ctpp2/CTPP2Logger.hpp')
+    if find_library_in_compiler
+      ctpp2_lib = compiler.find_library('ctpp2')
+    else
+      ctpp2_lib = find_library('ctpp2')
+    endif
+    ctpp2_link_args = ['-lctpp2']
+    if meson.is_cross_build() and host_machine.system() == 'windows'
+      if find_library_in_compiler
+        iconv_lib = compiler.find_library('iconv', required:false)
+      else
+        iconv_lib = find_library('iconv', required:false)
+      endif
+      if iconv_lib.found()
+        ctpp2_link_args += ['-liconv']
+      endif
+    endif
+    has_ctpp2_dep = true
+    ctpp2_dep = declare_dependency(link_args:ctpp2_link_args)
+  else
+    message('ctpp2/CTPP2Logger.hpp not found. Compiling without CTPP2 support')
+  endif
 else
-  error('Cannot found header mustache.hpp')
+  if not find_library_in_compiler
+    error('For custom ctpp2_prefix_install you need a meson version >=0.31.0')
+  endif
+  ctpp2_include_path = ctpp2_prefix_install + '/include'
+  ctpp2_include_args = ['-I'+ctpp2_include_path]
+  if compiler.has_header('ctpp2/CTPP2Logger.hpp', args:ctpp2_include_args)
+    ctpp2_include_dir = include_directories(ctpp2_include_path, is_system:true)
+    ctpp2_lib_path = ctpp2_prefix_install+'/lib'
+    ctpp2_lib = compiler.find_library('ctpp2', dirs:ctpp2_lib_path)
+    ctpp2_link_args = ['-L'+ctpp2_lib_path, '-lctpp2']
+    if meson.is_cross_build() and host_machine.system() == 'windows'
+      iconv_lib = compiler.find_library('iconv', required:false)
+      if iconv_lib.found()
+        ctpp2_link_args += ['-liconv']
+      endif
+    endif
+    has_ctpp2_dep = true
+    ctpp2_dep = declare_dependency(include_directories:ctpp2_include_dir, link_args:ctpp2_link_args)
+  else
+    message('ctpp2/CTPP2Logger.hpp not found. Compiling without CTPP2 support')
+  endif
 endif
 
-libzim_dep = dependency('libzim', version : '>=7.0.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.')
+xapian_dep = dependency('xapian-core', required:false, static:static_deps)
+
+all_deps = [thread_dep, libicu_dep, libzim_dep, xapian_dep, pugixml_dep]
+if has_ctpp2_dep
+  all_deps += [ctpp2_dep]
 endif
 
-
-extra_cflags = ''
-if target_machine.system() == 'windows' and static_deps
-  add_project_arguments('-DCURL_STATICLIB', language : 'cpp')
-  extra_cflags += '-DCURL_STATICLIB'
-endif
-
-if target_machine.system() == 'windows'
-  add_project_arguments('-DNOMINMAX', language: 'cpp')
-endif
-
-all_deps = [thread_dep, libicu_dep, libzim_dep, pugixml_dep, libcurl_dep, microhttpd_dep, zlib_dep, xapian_dep]
-
-inc = include_directories('include', extra_include)
+inc = include_directories('include')
 
 conf = configuration_data()
 conf.set('VERSION', '"@0@"'.format(meson.project_version()))
-
-if build_machine.system() == 'windows'
-     extra_link_args = ['-lshlwapi', '-lwinmm']
-else
-     extra_link_args = []
-endif
+conf.set('ENABLE_CTPP2', has_ctpp2_dep)
 
 subdir('include')
 subdir('scripts')
 subdir('static')
 subdir('src')
-subdir('test')
 
-pkg_requires = ['libzim', 'icu-i18n', 'pugixml', 'libcurl', 'libmicrohttpd', 'xapian-core']
+pkg_requires = ['libzim', 'icu-i18n', 'pugixml']
+if xapian_dep.found()
+    pkg_requires += ['xapian-core']
+endif
+
+extra_libs = []
+extra_cflags = ''
+if has_ctpp2_dep
+  extra_libs += ctpp2_link_args
+  if ctpp2_include_path != ''
+    extra_cflags = '-I'+ctpp2_include_path
+  endif
+endif
 
 pkg_conf = configuration_data()
 pkg_conf.set('prefix', get_option('prefix'))

meson_options.txt

@@ -1,2 +1,4 @@
-option('wrapper', type:'array', choices:['java', 'android'], value:[],
-  description: 'The wrapper to generate.')
+option('ctpp2-install-prefix', type : 'string', value : '',
+  description : 'Prefix where ctpp libs has been installed')
+option('android', type : 'boolean', value : false,
+  description : 'Do we make a kiwix-lib for android')

scripts/ctpp2c.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+
+ctpp2c=$1
+SOURCE=$(pwd)/$2
+DEST=$3
+
+$ctpp2c $SOURCE $DEST

scripts/kiwix-compile-resources

@@ -81,12 +81,12 @@ class Resource:
             data_identifier="_".join([""]+self.identifier),
             resource_content=",\n    ".join(", ".join("{:#04x}".format(i) for i in r) for r in sliced),
             resource_len=len(self.data),
-            namespaces_open=" ".join("namespace {} {{".format(id) for id in self.identifier[:-1]),
+            namespaces_open=" ".join("namespace {} {{".format(id) for id in self.identifier[:-1]), 
             namespaces_close=" ".join(["}"]*(len(self.identifier)-1)),
             identifier=self.identifier[-1],
             env_identifier="RES_"+"_".join(self.identifier)+"_PATH"
         )
-
+    
     def dump_getter(self):
         return resource_getter_template.format(
             common_name=self.filename,
@@ -95,11 +95,11 @@ class Resource:
 
     def dump_decl(self):
         return resource_decl_template.format(
-            namespaces_open=" ".join("namespace {} {{".format(id) for id in self.identifier[:-1]),
+            namespaces_open=" ".join("namespace {} {{".format(id) for id in self.identifier[:-1]), 
             namespaces_close=" ".join(["}"]*(len(self.identifier)-1)),
             identifier=self.identifier[-1]
         )
-
+    
 
 
 master_c_template = """//This file is automaically generated. Do not modify it.
@@ -113,7 +113,7 @@ static std::string init_resource(const char* name, const unsigned char* content,
     char * resPath = getenv(name);
     if (NULL == resPath)
         return std::string(reinterpret_cast<const char*>(content), len);
-
+    
     std::ifstream ifs(resPath);
     if (!ifs.good())
         return std::string(reinterpret_cast<const char*>(content), len);
@@ -137,7 +137,7 @@ def gen_c_file(resources, basename):
        include_file=basename,
        basename=to_identifier(basename)
     )
-
+ 
 
 
 master_h_template = """//This file is automaically generated. Do not modify it.

scripts/kiwix-compile-resources.1

@@ -1,20 +0,0 @@
-.TH KIWIX-COMPILE-RESOURCES "1" "August 2017" "Kiwix" "User Commands"
-.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
-.SH DESCRIPTION
-.TP
-resource_file
-The list of resources to compile.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-show a help message and exit
-.TP
-\fB\-\-cxxfile\fR CXXFILE
-The Cpp file name to generate
-.TP
-\fB\-\-hfile\fR HFILE
-The h file name to generate
-.SH AUTHOR
-Matthieu Gautier <mgautier@kymeria.fr>

scripts/meson.build

@@ -1,6 +1,5 @@
 
 res_compiler = find_program('kiwix-compile-resources')
+intermediate_ctpp2c = find_program('ctpp2c.sh')
 
 install_data(res_compiler.path(), install_dir:get_option('bindir'))
-
-install_man('kiwix-compile-resources.1')

src/android/gen_kiwix.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+BUILD_PATH=$(pwd)
+
+javac -d $BUILD_PATH/src/android $1 $2 $3 $4
+
+cd $BUILD_PATH/src/android
+javah -jni org.kiwix.kiwixlib.JNIKiwix
+cd $BUILD_PATH

src/android/kiwix.cpp

@@ -0,0 +1,559 @@
+/*
+ * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <jni.h>
+#include "org_kiwix_kiwixlib_JNIKiwix.h"
+
+#include <stdio.h>
+#include <string.h>
+
+#include <iostream>
+#include <string>
+
+#include "common/base64.h"
+#include "reader.h"
+#include "searcher.h"
+#include "unicode/putil.h"
+
+#include <android/log.h>
+#define LOGI(...) __android_log_print(ANDROID_LOG_INFO, "kiwix", __VA_ARGS__)
+
+#include <xapian.h>
+#include <zim/article.h>
+#include <zim/error.h>
+#include <zim/file.h>
+#include <zim/zim.h>
+
+/* global variables */
+kiwix::Reader* reader = NULL;
+kiwix::Searcher* searcher = NULL;
+
+static pthread_mutex_t readerLock = PTHREAD_MUTEX_INITIALIZER;
+static pthread_mutex_t searcherLock = PTHREAD_MUTEX_INITIALIZER;
+
+/* c2jni type conversion functions */
+jboolean c2jni(const bool& val)
+{
+  return val ? JNI_TRUE : JNI_FALSE;
+}
+jstring c2jni(const std::string& val, JNIEnv* env)
+{
+  return env->NewStringUTF(val.c_str());
+}
+
+jint c2jni(const int val)
+{
+  return (jint)val;
+}
+jint c2jni(const unsigned val)
+{
+  return (unsigned)val;
+}
+/* jni2c type conversion functions */
+bool jni2c(const jboolean& val)
+{
+  return val == JNI_TRUE;
+}
+std::string jni2c(const jstring& val, JNIEnv* env)
+{
+  return std::string(env->GetStringUTFChars(val, 0));
+}
+
+int jni2c(const jint val)
+{
+  return (int)val;
+}
+/* Method to deal with variable passed by reference */
+void setStringObjValue(const std::string& value, const jobject obj, JNIEnv* env)
+{
+  jclass objClass = env->GetObjectClass(obj);
+  jfieldID objFid = env->GetFieldID(objClass, "value", "Ljava/lang/String;");
+  env->SetObjectField(obj, objFid, c2jni(value, env));
+}
+
+void setIntObjValue(const int value, const jobject obj, JNIEnv* env)
+{
+  jclass objClass = env->GetObjectClass(obj);
+  jfieldID objFid = env->GetFieldID(objClass, "value", "I");
+  env->SetIntField(obj, objFid, value);
+}
+
+void setBoolObjValue(const bool value, const jobject obj, JNIEnv* env)
+{
+  jclass objClass = env->GetObjectClass(obj);
+  jfieldID objFid = env->GetFieldID(objClass, "value", "Z");
+  env->SetIntField(obj, objFid, c2jni(value));
+}
+
+/* Kiwix library functions */
+JNIEXPORT jstring JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_getMainPage(JNIEnv* env, jobject obj)
+{
+  jstring url;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cUrl = reader->getMainPageUrl();
+      url = c2jni(cUrl, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM main page" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return url;
+}
+
+JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getId(JNIEnv* env,
+                                                                 jobject obj)
+{
+  jstring id;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cId = reader->getId();
+      id = c2jni(cId, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM id" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return id;
+}
+
+JNIEXPORT jint JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getFileSize(JNIEnv* env,
+                                                                    jobject obj)
+{
+  jint size;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      int cSize = reader->getFileSize();
+      size = c2jni(cSize);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM file size" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return size;
+}
+
+JNIEXPORT jstring JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_getCreator(JNIEnv* env, jobject obj)
+{
+  jstring creator;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cCreator = reader->getCreator();
+      creator = c2jni(cCreator, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM creator" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return creator;
+}
+
+JNIEXPORT jstring JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_getPublisher(JNIEnv* env, jobject obj)
+{
+  jstring publisher;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cPublisher = reader->getPublisher();
+      publisher = c2jni(cPublisher, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM creator" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return publisher;
+}
+
+JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getName(JNIEnv* env,
+                                                                   jobject obj)
+{
+  jstring name;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cName = reader->getName();
+      name = c2jni(cName, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM name" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return name;
+}
+
+JNIEXPORT jstring JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_getFavicon(JNIEnv* env, jobject obj)
+{
+  jstring favicon;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cContent;
+      std::string cMime;
+      reader->getFavicon(cContent, cMime);
+      favicon
+          = c2jni(base64_encode(
+                      reinterpret_cast<const unsigned char*>(cContent.c_str()),
+                      cContent.length()),
+                  env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM favicon" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return favicon;
+}
+
+JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getDate(JNIEnv* env,
+                                                                   jobject obj)
+{
+  jstring date;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cDate = reader->getDate();
+      date = c2jni(cDate, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM date" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return date;
+}
+
+JNIEXPORT jstring JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_getLanguage(JNIEnv* env, jobject obj)
+{
+  jstring language;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cLanguage = reader->getLanguage();
+      language = c2jni(cLanguage, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM language" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return language;
+}
+
+JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getMimeType(
+    JNIEnv* env, jobject obj, jstring url)
+{
+  jstring mimeType;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    std::string cUrl = jni2c(url, env);
+    try {
+      std::string cMimeType;
+      reader->getMimeTypeByUrl(cUrl, cMimeType);
+      mimeType = c2jni(cMimeType, env);
+    } catch (...) {
+      std::cerr << "Unable to get mime-type for url " << cUrl << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return mimeType;
+}
+
+JNIEXPORT jboolean JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_loadZIM(JNIEnv* env, jobject obj, jstring path)
+{
+  jboolean retVal = JNI_TRUE;
+  std::string cPath = jni2c(path, env);
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    if (reader != NULL) {
+      delete reader;
+    }
+    reader = new kiwix::Reader(cPath);
+  } catch (...) {
+    std::cerr << "Unable to load ZIM " << cPath << std::endl;
+    reader = NULL;
+    retVal = JNI_FALSE;
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return retVal;
+}
+
+JNIEXPORT jbyteArray JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getContent(
+    JNIEnv* env, jobject obj, jstring url, jobject titleObj, jobject mimeTypeObj, jobject sizeObj)
+{
+  /* Default values */
+  setStringObjValue("", titleObj, env);
+  setStringObjValue("", mimeTypeObj, env);
+  setIntObjValue(0, sizeObj, env);
+  jbyteArray data = env->NewByteArray(0);
+
+  /* Retrieve the content */
+  if (reader != NULL) {
+    std::string cUrl = jni2c(url, env);
+    std::string cData;
+    std::string cTitle;
+    std::string cMimeType;
+    unsigned int cSize = 0;
+
+    pthread_mutex_lock(&readerLock);
+    try {
+      if (reader->getContentByUrl(cUrl, cData, cTitle, cSize, cMimeType)) {
+        data = env->NewByteArray(cSize);
+        env->SetByteArrayRegion(
+            data, 0, cSize, reinterpret_cast<const jbyte*>(cData.c_str()));
+        setStringObjValue(cMimeType, mimeTypeObj, env);
+        setStringObjValue(cTitle, titleObj, env);
+        setIntObjValue(cSize, sizeObj, env);
+      }
+    } catch (...) {
+      std::cerr << "Unable to get content for url " << cUrl << std::endl;
+    }
+    pthread_mutex_unlock(&readerLock);
+  }
+
+  return data;
+}
+
+JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_searchSuggestions(
+    JNIEnv* env, jobject obj, jstring prefix, jint count)
+{
+  jboolean retVal = JNI_FALSE;
+  std::string cPrefix = jni2c(prefix, env);
+  unsigned int cCount = jni2c(count);
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    if (reader != NULL) {
+      if (reader->searchSuggestionsSmart(cPrefix, cCount)) {
+        retVal = JNI_TRUE;
+      }
+    }
+  } catch (...) {
+    std::cerr << "Unable to search suggestions for pattern " << cPrefix
+              << std::endl;
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return retVal;
+}
+
+JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getNextSuggestion(
+    JNIEnv* env, jobject obj, jobject titleObj)
+{
+  jboolean retVal = JNI_FALSE;
+  std::string cTitle;
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    if (reader != NULL) {
+      if (reader->getNextSuggestion(cTitle)) {
+        setStringObjValue(cTitle, titleObj, env);
+        retVal = JNI_TRUE;
+      }
+    }
+  } catch (...) {
+    std::cerr << "Unable to get next suggestion" << std::endl;
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return retVal;
+}
+
+JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getPageUrlFromTitle(
+    JNIEnv* env, jobject obj, jstring title, jobject urlObj)
+{
+  jboolean retVal = JNI_FALSE;
+  std::string cTitle = jni2c(title, env);
+  std::string cUrl;
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    if (reader != NULL) {
+      if (reader->getPageUrlFromTitle(cTitle, cUrl)) {
+        setStringObjValue(cUrl, urlObj, env);
+        retVal = JNI_TRUE;
+      }
+    }
+  } catch (...) {
+    std::cerr << "Unable to get URL for title " << cTitle << std::endl;
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return retVal;
+}
+
+JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getTitle(
+    JNIEnv* env, jobject obj, jobject titleObj)
+{
+  jboolean retVal = JNI_FALSE;
+  std::string cTitle;
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    if (reader != NULL) {
+      std::string cTitle = reader->getTitle();
+      setStringObjValue(cTitle, titleObj, env);
+      retVal = JNI_TRUE;
+    }
+  } catch (...) {
+    std::cerr << "Unable to get ZIM title" << std::endl;
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return retVal;
+}
+
+JNIEXPORT jstring JNICALL
+Java_org_kiwix_kiwixlib_JNIKiwix_getDescription(JNIEnv* env, jobject obj)
+{
+  jstring description;
+
+  pthread_mutex_lock(&readerLock);
+  if (reader != NULL) {
+    try {
+      std::string cDescription = reader->getDescription();
+      description = c2jni(cDescription, env);
+    } catch (...) {
+      std::cerr << "Unable to get ZIM description" << std::endl;
+    }
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return description;
+}
+
+JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_getRandomPage(
+    JNIEnv* env, jobject obj, jobject urlObj)
+{
+  jboolean retVal = JNI_FALSE;
+  std::string cUrl;
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    if (reader != NULL) {
+      std::string cUrl = reader->getRandomPageUrl();
+      setStringObjValue(cUrl, urlObj, env);
+      retVal = JNI_TRUE;
+    }
+  } catch (...) {
+    std::cerr << "Unable to get random page" << std::endl;
+  }
+  pthread_mutex_unlock(&readerLock);
+
+  return retVal;
+}
+
+JNIEXPORT void JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_setDataDirectory(
+    JNIEnv* env, jobject obj, jstring dirStr)
+{
+  std::string cPath = jni2c(dirStr, env);
+
+  pthread_mutex_lock(&readerLock);
+  try {
+    u_setDataDirectory(cPath.c_str());
+  } catch (...) {
+    std::cerr << "Unable to set data directory " << cPath << std::endl;
+  }
+  pthread_mutex_unlock(&readerLock);
+}
+
+JNIEXPORT jboolean JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_loadFulltextIndex(
+    JNIEnv* env, jobject obj, jstring path)
+{
+  jboolean retVal = JNI_TRUE;
+  std::string cPath = jni2c(path, env);
+
+  pthread_mutex_lock(&searcherLock);
+  try {
+    if (searcher != NULL) {
+      delete searcher;
+    }
+    if (!reader || !reader->hasFulltextIndex()) {
+      // Use old API (no embedded full text index).
+      searcher = new kiwix::Searcher(cPath, reader, "");
+    } else {
+      // Use the new API. We don't care about the human readable name as
+      // we don't use it (in android).
+      searcher = new kiwix::Searcher();
+      searcher->add_reader(reader, "");
+    }
+  } catch (...) {
+    searcher = NULL;
+    retVal = JNI_FALSE;
+    std::cerr << "Unable to load full text index " << cPath << std::endl;
+  }
+  pthread_mutex_unlock(&searcherLock);
+
+  return retVal;
+}
+
+JNIEXPORT jstring JNICALL Java_org_kiwix_kiwixlib_JNIKiwix_indexedQuery(
+    JNIEnv* env, jclass obj, jstring query, jint count)
+{
+  std::string cQuery = jni2c(query, env);
+  unsigned int cCount = jni2c(count);
+  kiwix::Result* p_result;
+  std::string result;
+
+  pthread_mutex_lock(&searcherLock);
+  try {
+    if (searcher != NULL) {
+      searcher->search(cQuery, 0, count);
+      while ((p_result = searcher->getNextResult())
+             && !(p_result->get_title().empty())
+             && !(p_result->get_url().empty())) {
+        result += p_result->get_title() + "\n";
+        delete p_result;
+      }
+    }
+  } catch (...) {
+    std::cerr << "Unable to make indexed query " << cQuery << std::endl;
+  }
+  pthread_mutex_unlock(&searcherLock);
+
+  return env->NewStringUTF(result.c_str());
+}

src/android/meson.build

@@ -0,0 +1,17 @@
+
+jni_generator = find_program('gen_kiwix.sh')
+
+kiwix_jni = custom_target('jni',
+  input: ['org/kiwix/kiwixlib/JNIKiwix.java',
+          'org/kiwix/kiwixlib/JNIKiwixInt.java',
+          'org/kiwix/kiwixlib/JNIKiwixString.java',
+          'org/kiwix/kiwixlib/JNIKiwixBool.java'],
+  output: ['org_kiwix_kiwixlib_JNIKiwix.h'],
+  command:[jni_generator, '@INPUT@']
+)
+
+kiwix_sources += ['android/kiwix.cpp', kiwix_jni]
+
+install_subdir('org', install_dir: 'kiwix-lib/java')
+install_subdir('res', install_dir: 'kiwix-lib')
+install_data('AndroidManifest.xml', install_dir: 'kiwix-lib')

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

@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+package org.kiwix.kiwixlib;
+
+import org.kiwix.kiwixlib.JNIKiwixString;
+import org.kiwix.kiwixlib.JNIKiwixBool;
+import org.kiwix.kiwixlib.JNIKiwixInt;
+
+public class JNIKiwix
+{
+  static { System.loadLibrary("kiwix"); }
+  public native String getMainPage();
+
+  public native String getId();
+
+  public native String getLanguage();
+
+  public native String getMimeType(String url);
+
+  public native boolean loadZIM(String path);
+
+  public native boolean loadFulltextIndex(String path);
+
+  public native byte[] getContent(String url, JNIKiwixString title, JNIKiwixString mimeType, JNIKiwixInt size);
+
+  public native boolean searchSuggestions(String prefix, int count);
+
+  public native boolean getNextSuggestion(JNIKiwixString title);
+
+  public native boolean getPageUrlFromTitle(String title, JNIKiwixString url);
+
+  public native boolean getTitle(JNIKiwixString title);
+
+  public native String getDescription();
+
+  public native String getDate();
+
+  public native String getFavicon();
+
+  public native String getCreator();
+
+  public native String getPublisher();
+
+  public native String getName();
+
+  public native int getFileSize();
+
+  public native int getArticleCount();
+
+  public native int getMediaCount();
+
+  public native boolean getRandomPage(JNIKiwixString url);
+
+  public native void setDataDirectory(String icuDataDir);
+
+  public static native String indexedQuery(String db, int count);
+}

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

@@ -22,16 +22,4 @@ package org.kiwix.kiwixlib;
 public class JNIKiwixString
 {
   public String value;
-
-  public JNIKiwixString(String value) {
-    this.value = value;
-  }
-
-  public JNIKiwixString() {
-    this("");
-  }
-
-  public String getValue() {
-    return value;
-  }
 }

src/aria2.cpp

@@ -1,272 +0,0 @@
-
-
-#include "aria2.h"
-#include "xmlrpc.h"
-#include <iostream>
-#include <sstream>
-#include <thread>
-#include <chrono>
-#include <tools/otherTools.h>
-#include <tools/pathTools.h>
-#include <tools/stringTools.h>
-#include <downloader.h> // For AriaError
-
-#ifdef _WIN32
-# define ARIA2_CMD "aria2c.exe"
-#else
-# define ARIA2_CMD "aria2c"
-# include <unistd.h>
-#endif
-
-
-#define LOG_ARIA_ERROR() \
-  { \
-    std::cerr << "ERROR: aria2 RPC request failed. (" << res << ")." << std::endl; \
-    std::cerr << (m_curlErrorBuffer[0] ? m_curlErrorBuffer.get() : curl_easy_strerror(res)) << std::endl; \
-  }
-
-namespace kiwix {
-
-Aria2::Aria2():
-  mp_aria(nullptr),
-  m_port(42042),
-  m_secret("kiwixariarpc"),
-  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 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 + "\"";
-#ifdef _WIN32
-  int pid = GetCurrentProcessId();
-#else
-  pid_t pid = getpid();
-#endif
-  std::string stop_with_pid = "--stop-with-process=" + to_string(pid);
-  std::string rpc_secret = "--rpc-secret=" + m_secret;
-  m_secret = "token:"+m_secret;
-
-  std::string aria2cmd = appendToDirectory(
-    removeLastPathElement(getExecutablePath(true)),
-    ARIA2_CMD);
-  if (fileExists(aria2cmd)) {
-    // A local aria2c exe exists (packaged with kiwix-desktop), use it.
-    callCmd.push_back(aria2cmd.c_str());
-  } else {
-    // Try to use a potential installed aria2c.
-    callCmd.push_back(ARIA2_CMD);
-  }
-  callCmd.push_back("--follow-metalink=mem");
-  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 (fileExists(session_file)) {
-    callCmd.push_back(inputFile.c_str());
-  }
-  callCmd.push_back(session.c_str());
-//  callCmd.push_back(log_dir.c_str());
-  callCmd.push_back("--auto-save-interval=10");
-  callCmd.push_back(stop_with_pid.c_str());
-  callCmd.push_back("--allow-overwrite=true");
-  callCmd.push_back("--dht-entry-point=router.bittorrent.com:6881");
-  callCmd.push_back("--dht-entry-point6=router.bittorrent.com:6881");
-  callCmd.push_back("--quiet=true");
-  callCmd.push_back("--bt-enable-lpd=true");
-  callCmd.push_back("--always-resume=true");
-  callCmd.push_back("--max-concurrent-downloads=42");
-  callCmd.push_back("--rpc-max-request-size=6M");
-  callCmd.push_back("--file-allocation=none");
-  std::string launchCmd;
-  for (auto &cmd : callCmd) {
-      launchCmd.append(cmd).append(" ");
-  }
-  mp_aria = Subprocess::run(callCmd);
-  mp_curl = curl_easy_init();
-
-  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());
-
-  int watchdog = 50;
-  while(--watchdog) {
-    sleep(10);
-    m_curlErrorBuffer[0] = 0;
-    auto res = curl_easy_perform(mp_curl);
-    if (res == CURLE_OK) {
-      break;
-    } else if (watchdog == 1) {
-      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();
-  shutdown();
-}
-
-size_t write_callback_to_iss(char* ptr, size_t size, size_t nmemb, void* userdata)
-{
-  auto outStream = static_cast<std::stringstream*>(userdata);
-  outStream->write(ptr, nmemb);
-  return nmemb;
-}
-
-std::string Aria2::doRequest(const MethodCall& methodCall)
-{
-  auto requestContent = methodCall.toString();
-  std::stringstream outStream;
-  CURLcode res;
-  long response_code;
-  {
-    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);
-  }
-
-  auto responseContent = outStream.str();
-  if (response_code != 200) {
-    std::cerr << "ERROR: Invalid return code (" << response_code << ") from aria :" << std::endl;
-    std::cerr << responseContent << std::endl;
-    throw std::runtime_error("Invalid return code from aria");
-  }
-
-  MethodResponse response(responseContent);
-  if (response.isFault()) {
-    throw AriaError(response.getFault().getFaultString());
-  }
-  return responseContent;
-}
-
-std::string Aria2::addUri(const std::vector<std::string>& uris, const std::vector<std::pair<std::string, std::string>>& options)
-{
-  MethodCall methodCall("aria2.addUri", m_secret);
-  auto uriParams = methodCall.newParamValue().getArray();
-  for (auto& uri : uris) {
-    uriParams.addValue().set(uri);
-  }
-  for (auto& option : options) {
-    methodCall.newParamValue().getStruct().addMember(option.first).getValue().set(option.second);
-  }
-  auto ret = doRequest(methodCall);
-  MethodResponse response(ret);
-  return response.getParamValue(0).getAsS();
-}
-
-std::string Aria2::tellStatus(const std::string& gid, const std::vector<std::string>& statusKey)
-{
-  MethodCall methodCall("aria2.tellStatus", m_secret);
-  methodCall.newParamValue().set(gid);
-  if (!statusKey.empty()) {
-    auto statusArray = methodCall.newParamValue().getArray();
-    for (auto& key : statusKey) {
-      statusArray.addValue().set(key);
-    }
-  }
-  return doRequest(methodCall);
-}
-
-std::vector<std::string> Aria2::tellActive()
-{
-  MethodCall methodCall("aria2.tellActive", m_secret);
-  auto statusArray = methodCall.newParamValue().getArray();
-  statusArray.addValue().set(std::string("gid"));
-  auto responseContent = doRequest(methodCall);
-  MethodResponse response(responseContent);
-  std::vector<std::string> activeGID;
-  int index = 0;
-  while(true) {
-    try {
-      auto structNode = response.getParamValue(0).getArray().getValue(index++).getStruct();
-      auto gidNode = structNode.getMember("gid");
-      activeGID.push_back(gidNode.getValue().getAsS());
-    } catch (InvalidRPCNode& e) { break; }
-  }
-  return activeGID;
-}
-
-std::vector<std::string> Aria2::tellWaiting()
-{
-  MethodCall methodCall("aria2.tellWaiting", m_secret);
-  methodCall.newParamValue().set(0);
-  methodCall.newParamValue().set(99); // max number of downloads to be returned, don't know how to set this properly assumed that there will not be more than 99 paused downloads.
-  auto statusArray = methodCall.newParamValue().getArray();
-  statusArray.addValue().set(std::string("gid"));
-  auto responseContent = doRequest(methodCall);
-  MethodResponse response(responseContent);
-  std::vector<std::string> waitingGID;
-  int index = 0;
-  while(true) {
-    try {
-      auto structNode = response.getParamValue(0).getArray().getValue(index++).getStruct();
-      auto gidNode = structNode.getMember("gid");
-      waitingGID.push_back(gidNode.getValue().getAsS());
-    } catch (InvalidRPCNode& e) { break; }
-  }
-  return waitingGID;
-}
-
-void Aria2::saveSession()
-{
-  MethodCall methodCall("aria2.saveSession", m_secret);
-  doRequest(methodCall);
-  std::cout << "session saved" << std::endl;
-}
-
-void Aria2::shutdown()
-{
-  MethodCall methodCall("aria2.shutdown", m_secret);
-  doRequest(methodCall);
-}
-
-void Aria2::pause(const std::string& gid)
-{
-    MethodCall methodCall("aria2.pause", m_secret);
-    methodCall.newParamValue().set(gid);
-    doRequest(methodCall);
-}
-
-void Aria2::unpause(const std::string& gid)
-{
-    MethodCall methodCall("aria2.unpause", m_secret);
-    methodCall.newParamValue().set(gid);
-    doRequest(methodCall);
-}
-
-void Aria2::remove(const std::string& gid)
-{
-    MethodCall methodCall("aria2.remove", m_secret);
-    methodCall.newParamValue().set(gid);
-    doRequest(methodCall);
-}
-
-} // end namespace kiwix

src/aria2.h

@@ -1,51 +0,0 @@
-
-
-#ifndef KIWIXLIB_ARIA2_H_
-#define KIWIXLIB_ARIA2_H_
-
-#ifdef _WIN32
-// winsock2.h need to be included before windows.h (included by curl.h)
-# include <winsock2.h>
-#endif
-
-#include "subprocess.h"
-#include "xmlrpc.h"
-
-#include <memory>
-#include <mutex>
-#include <curl/curl.h>
-
-namespace kiwix {
-
-class Aria2
-{
-  private:
-    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:
-    Aria2();
-    virtual ~Aria2();
-    void close();
-
-    std::string addUri(const std::vector<std::string>& uri, const std::vector<std::pair<std::string, std::string>>& options = {});
-    std::string tellStatus(const std::string& gid, const std::vector<std::string>& statusKey);
-    std::vector<std::string> tellActive();
-    std::vector<std::string> tellWaiting();
-    void saveSession();
-    void shutdown();
-    void pause(const std::string& gid);
-    void unpause(const std::string& gid);
-    void remove(const std::string& gid);
-};
-
-}; //end namespace kiwix
-
-#endif // KIWIXLIB_ARIA2_H_

src/book.cpp

@@ -1,246 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "book.h"
-#include "reader.h"
-
-#include "tools/base64.h"
-#include "tools/regexTools.h"
-#include "tools/networkTools.h"
-#include "tools/otherTools.h"
-
-#include <pugixml.hpp>
-
-namespace kiwix
-{
-/* Constructor */
-Book::Book() :
-  m_pathValid(false),
-  m_readOnly(false)
-{
-}
-/* Destructor */
-Book::~Book()
-{
-}
-
-bool Book::update(const kiwix::Book& other)
-{
-  if (m_readOnly)
-    return false;
-
-  if (m_id != other.m_id)
-    return false;
-
-  m_readOnly = other.m_readOnly;
-  m_path = other.m_path;
-  m_pathValid = other.m_pathValid;
-  m_title = other.m_title;
-  m_description = other.m_description;
-  m_language = other.m_language;
-  m_creator = other.m_creator;
-  m_publisher = other.m_publisher;
-  m_date = other.m_date;
-  m_url = other.m_url;
-  m_name = other.m_name;
-  m_flavour = other.m_flavour;
-  m_tags = other.m_tags;
-  m_category = other.m_category;
-  m_origId = other.m_origId;
-  m_articleCount = other.m_articleCount;
-  m_mediaCount = other.m_mediaCount;
-  m_size = other.m_size;
-  m_favicon = other.m_favicon;
-  m_faviconMimeType = other.m_faviconMimeType;
-  m_faviconUrl = other.m_faviconUrl;
-
-  m_downloadId = other.m_downloadId;
-
-  return true;
-}
-
-void Book::update(const kiwix::Reader& reader)
-{
-  m_path = reader.getZimFilePath();
-  m_pathValid = true;
-  m_id = reader.getId();
-  m_title = reader.getTitle();
-  m_description = reader.getDescription();
-  m_language = reader.getLanguage();
-  m_creator = reader.getCreator();
-  m_publisher = reader.getPublisher();
-  m_date = reader.getDate();
-  m_name = reader.getName();
-  m_flavour = reader.getFlavour();
-  m_tags = reader.getTags();
-  m_category = getCategoryFromTags();
-  m_origId = reader.getOrigId();
-  m_articleCount = reader.getArticleCount();
-  m_mediaCount = reader.getMediaCount();
-  m_size = static_cast<uint64_t>(reader.getFileSize()) << 10;
-  m_pathValid = true;
-
-  reader.getFavicon(m_favicon, m_faviconMimeType);
-}
-
-#define ATTR(name) node.attribute(name).value()
-void Book::updateFromXml(const pugi::xml_node& node, const std::string& baseDir)
-{
-  m_id = ATTR("id");
-  std::string path = ATTR("path");
-  if (isRelativePath(path)) {
-    path = computeAbsolutePath(baseDir, path);
-  }
-  m_path = path;
-  m_pathValid = fileExists(path);
-  m_title = ATTR("title");
-  m_description = ATTR("description");
-  m_language = ATTR("language");
-  m_creator = ATTR("creator");
-  m_publisher = ATTR("publisher");
-  m_date = ATTR("date");
-  m_url = ATTR("url");
-  m_name = ATTR("name");
-  m_flavour = ATTR("flavour");
-  m_tags = ATTR("tags");
-  m_origId = ATTR("origId");
-  m_articleCount = strtoull(ATTR("articleCount"), 0, 0);
-  m_mediaCount = strtoull(ATTR("mediaCount"), 0, 0);
-  m_size = strtoull(ATTR("size"), 0, 0) << 10;
-  m_favicon = base64_decode(ATTR("favicon"));
-  m_faviconMimeType = ATTR("faviconMimeType");
-  m_faviconUrl = ATTR("faviconUrl");
-  try {
-    m_downloadId = ATTR("downloadId");
-  } catch(...) {}
-  const auto catattr = node.attribute("category");
-  m_category = catattr.empty() ? getCategoryFromTags() : catattr.value();
-}
-#undef ATTR
-
-
-static std::string fromOpdsDate(const std::string& date)
-{
-  //The opds date use the standard <YYYY>-<MM>-<DD>T<HH>:<mm>:<SS>Z
-  //and we want <YYYY>-<MM>-<DD>. That's easy, let's take the first 10 char
-  return date.substr(0, 10);
-}
-
-
-#define VALUE(name) node.child(name).child_value()
-void Book::updateFromOpds(const pugi::xml_node& node, const std::string& urlHost)
-{
-  m_id = VALUE("id");
-  if (!m_id.compare(0, 9, "urn:uuid:")) {
-    m_id.erase(0, 9);
-  }
-  // No path on opds.
-  m_title = VALUE("title");
-  m_description = VALUE("summary");
-  m_language = VALUE("language");
-  m_creator = node.child("author").child("name").child_value();
-  m_publisher = node.child("publisher").child("name").child_value();
-  m_date = fromOpdsDate(VALUE("updated"));
-  m_name = VALUE("name");
-  m_flavour = VALUE("flavour");
-  m_tags = VALUE("tags");
-  const auto catnode = node.child("category");
-  m_category = catnode.empty() ? getCategoryFromTags() : catnode.child_value();
-  m_articleCount = strtoull(VALUE("articleCount"), 0, 0);
-  m_mediaCount = strtoull(VALUE("mediaCount"), 0, 0);
-  for(auto linkNode = node.child("link"); linkNode;
-           linkNode = linkNode.next_sibling("link")) {
-    std::string rel = linkNode.attribute("rel").value();
-
-    if (rel == "http://opds-spec.org/acquisition/open-access") {
-      m_url = linkNode.attribute("href").value();
-      m_size = strtoull(linkNode.attribute("length").value(), 0, 0);
-    }
-    if (rel == "http://opds-spec.org/image/thumbnail") {
-      m_faviconUrl = urlHost + linkNode.attribute("href").value();
-      m_faviconMimeType = linkNode.attribute("type").value();
-    }
- }
-
-}
-#undef VALUE
-
-std::string Book::getHumanReadableIdFromPath() const
-{
-  std::string id = m_path;
-  if (!id.empty()) {
-    kiwix::removeAccents(id);
-
-#ifdef _WIN32
-    id = replaceRegex(id, "", "^.*\\\\");
-#else
-    id = replaceRegex(id, "", "^.*/");
-#endif
-
-    id = replaceRegex(id, "", "\\.zim[a-z]*$");
-    id = replaceRegex(id, "_", " ");
-    id = replaceRegex(id, "plus", "\\+");
-  }
-  return id;
-}
-
-void Book::setPath(const std::string& path)
-{
- m_path = isRelativePath(path)
-   ? computeAbsolutePath(getCurrentDirectory(), path)
-   : path;
-}
-
-const std::string& Book::getFavicon() const {
-  if (m_favicon.empty() && !m_faviconUrl.empty()) {
-    try {
-      m_favicon = download(m_faviconUrl);
-    } catch(...) {
-      std::cerr << "Cannot download favicon from " << m_faviconUrl;
-    }
-  }
-  return m_favicon;
-}
-
-std::string Book::getTagStr(const std::string& tagName) const {
-  return getTagValueFromTagList(convertTags(m_tags), tagName);
-}
-
-bool Book::getTagBool(const std::string& tagName) const {
-  return convertStrToBool(getTagStr(tagName));
-}
-
-std::string Book::getCategory() const
-{
-  return m_category;
-}
-
-std::string Book::getCategoryFromTags() const
-{
-  try
-  {
-    return getTagStr("category");
-  }
-  catch ( const std::out_of_range& )
-  {
-    return "";
-  }
-}
-
-}

src/bookmark.cpp

@@ -1,47 +0,0 @@
-/*
- * Copyright 2018 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "bookmark.h"
-
-#include <pugixml.hpp>
-
-namespace kiwix
-{
-/* Constructor */
-Bookmark::Bookmark()
-{
-}
-
-/* Destructor */
-Bookmark::~Bookmark()
-{
-}
-
-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_language = bookNode.child("language").child_value();
-  m_date = bookNode.child("date").child_value();
-  m_title = node.child("title").child_value();
-  m_url = node.child("url").child_value();
-}
-
-}

src/common/base64.cpp

@@ -1,4 +1,4 @@
-/*
+/* 
    base64.cpp and base64.h
 
    Copyright (C) 2004-2008 René Nyffenegger
@@ -24,10 +24,10 @@
    René Nyffenegger rene.nyffenegger@adp-gmbh.ch
 */
 
-#include <tools/base64.h>
+#include <common/base64.h>
 #include <iostream>
 
-static const std::string base64_chars =
+static const std::string base64_chars = 
              "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
              "abcdefghijklmnopqrstuvwxyz"
   "0123456789+/";
@@ -37,10 +37,8 @@ static inline bool is_base64(unsigned char c) {
   return (isalnum(c) || (c == '+') || (c == '/'));
 }
 
-std::string base64_encode(const std::string& inString) {
+std::string base64_encode(unsigned char const* bytes_to_encode, unsigned int in_len) {
   std::string ret;
-  auto in_len = inString.size();
-  const unsigned char* bytes_to_encode = reinterpret_cast<const unsigned char*>(inString.data());
   int i = 0;
   int j = 0;
   unsigned char char_array_3[3];

src/common/networkTools.cpp

@@ -0,0 +1,160 @@
+/*
+ * Copyright 2012 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <common/networkTools.h>
+
+std::map<std::string, std::string> kiwix::getNetworkInterfaces()
+{
+  std::map<std::string, std::string> interfaces;
+
+#ifdef _WIN32
+  SOCKET sd = WSASocket(AF_INET, SOCK_DGRAM, 0, 0, 0, 0);
+  if (sd == SOCKET_ERROR) {
+    std::cerr << "Failed to get a socket. Error " << WSAGetLastError()
+              << std::endl;
+    return interfaces;
+  }
+
+  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);
+
+    /* Add to the map */
+    std::string interfaceName = std::string(inet_ntoa(pAddress->sin_addr));
+    std::string interfaceIp = std::string(inet_ntoa(pAddress->sin_addr));
+    interfaces.insert(
+        std::pair<std::string, std::string>(interfaceName, interfaceIp));
+  }
+#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)");
+    exit(EXIT_FAILURE);
+  }
+
+  /* Go through each interface */
+  int i;
+  size_t len;
+  struct ifreq* ifreq;
+  ifreq = ifconf.ifc_req;
+  for (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.insert(
+            std::pair<std::string, std::string>(interfaceName, interfaceIp));
+      } else {
+        perror("getnameinfo()");
+      }
+    }
+
+/* some systems have ifr_addr.sa_len and adjust the length that
+ * way, but not mine. weird */
+#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;
+}
+
+std::string kiwix::getBestPublicIp()
+{
+  std::map<std::string, std::string> interfaces = kiwix::getNetworkInterfaces();
+
+#ifndef _WIN32
+  const char* const prioritizedNames[]
+      = {"eth0", "eth1", "wlan0", "wlan1", "en0", "en1"};
+  const int count = (sizeof prioritizedNames) / (sizeof prioritizedNames[0]);
+  for (int i = 0; i < count; ++i) {
+    std::map<std::string, std::string>::const_iterator it
+        = interfaces.find(prioritizedNames[i]);
+    if (it != interfaces.end()) {
+      return it->second;
+    }
+  }
+#endif
+
+  for (std::map<std::string, std::string>::iterator iter = interfaces.begin();
+       iter != interfaces.end();
+       ++iter) {
+    std::string interfaceIp = iter->second;
+    if (interfaceIp.length() >= 7 && interfaceIp.substr(0, 7) == "192.168") {
+      return interfaceIp;
+    }
+  }
+
+  for (std::map<std::string, std::string>::iterator iter = interfaces.begin();
+       iter != interfaces.end();
+       ++iter) {
+    std::string interfaceIp = iter->second;
+    if (interfaceIp.length() >= 7 && interfaceIp.substr(0, 7) == "172.16.") {
+      return interfaceIp;
+    }
+  }
+
+  for (std::map<std::string, std::string>::iterator iter = interfaces.begin();
+       iter != interfaces.end();
+       ++iter) {
+    std::string interfaceIp = iter->second;
+    if (interfaceIp.length() >= 3 && interfaceIp.substr(0, 3) == "10.") {
+      return interfaceIp;
+    }
+  }
+
+  return "127.0.0.1";
+}

src/common/otherTools.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 Emmanuel Engelhart <kelson@kiwix.org>
+ * Copyright 2014 Emmanuel Engelhart <kelson@kiwix.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU  General Public License as published by
@@ -17,14 +17,13 @@
  * MA 02110-1301, USA.
  */
 
-#ifndef KIWIX_NETWORKTOOLS_H
-#define KIWIX_NETWORKTOOLS_H
+#include <common/otherTools.h>
 
-#include <string>
-
-namespace kiwix
+void kiwix::sleep(unsigned int milliseconds)
 {
-std::string download(const std::string& url);
-}
-
+#ifdef _WIN32
+  Sleep(milliseconds);
+#else
+  usleep(1000 * milliseconds);
 #endif
+}

src/common/pathTools.cpp

@@ -0,0 +1,274 @@
+/*
+ * Copyright 2011-2014 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <common/pathTools.h>
+
+#ifdef __APPLE__
+#include <limits.h>
+#include <mach-o/dyld.h>
+#elif _WIN32
+#include <direct.h>
+#include <windows.h>
+#include "shlwapi.h"
+#define getcwd _getcwd  // stupid MSFT "deprecation" warning
+#endif
+
+#ifdef _WIN32
+#else
+#include <unistd.h>
+#endif
+
+#ifdef _WIN32
+#define SEPARATOR "\\"
+#else
+#define SEPARATOR "/"
+#include <unistd.h>
+#endif
+
+#include <stdlib.h>
+
+#ifndef PATH_MAX
+#define PATH_MAX 1024
+#endif
+
+bool isRelativePath(const string& path)
+{
+#ifdef _WIN32
+  return path.empty() || path.substr(1, 2) == ":\\" ? false : true;
+#else
+  return path.empty() || path.substr(0, 1) == "/" ? false : true;
+#endif
+}
+
+string computeRelativePath(const string path, const string absolutePath)
+{
+  std::vector<std::string> pathParts = kiwix::split(path, SEPARATOR);
+  std::vector<std::string> absolutePathParts
+      = kiwix::split(absolutePath, SEPARATOR);
+
+  unsigned int commonCount = 0;
+  while (commonCount < pathParts.size()
+         && commonCount < absolutePathParts.size()
+         && pathParts[commonCount] == absolutePathParts[commonCount]) {
+    if (!pathParts[commonCount].empty()) {
+      commonCount++;
+    }
+  }
+
+  string relativePath;
+#ifdef _WIN32
+  /* On Windows you have a token more because the root is represented
+     by a letter */
+  if (commonCount == 0) {
+    relativePath = "../";
+  }
+#endif
+
+  for (unsigned int i = commonCount; i < pathParts.size(); i++) {
+    relativePath += "../";
+  }
+  for (unsigned int i = commonCount; i < absolutePathParts.size(); i++) {
+    relativePath += absolutePathParts[i];
+    relativePath += i + 1 < absolutePathParts.size() ? "/" : "";
+  }
+
+  return relativePath;
+}
+
+/* Warning: the relative path must be with slashes */
+string computeAbsolutePath(const string path, const string relativePath)
+{
+  string absolutePath;
+
+  if (path.empty()) {
+    char* path = NULL;
+    size_t size = 0;
+
+#ifdef _WIN32
+    path = _getcwd(path, size);
+#else
+    path = getcwd(path, size);
+#endif
+
+    absolutePath = string(path) + SEPARATOR;
+  } else {
+    absolutePath = path.substr(path.length() - 1, 1) == SEPARATOR
+                       ? path
+                       : path + SEPARATOR;
+  }
+
+#if _WIN32
+  char* cRelativePath = _strdup(relativePath.c_str());
+#else
+  char* cRelativePath = strdup(relativePath.c_str());
+#endif
+  char* token = strtok(cRelativePath, "/");
+
+  while (token != NULL) {
+    if (string(token) == "..") {
+      absolutePath = removeLastPathElement(absolutePath, true, false);
+      token = strtok(NULL, "/");
+    } else if (strcmp(token, ".") && strcmp(token, "")) {
+      absolutePath += string(token);
+      token = strtok(NULL, "/");
+      if (token != NULL) {
+        absolutePath += SEPARATOR;
+      }
+    } else {
+      token = strtok(NULL, "/");
+    }
+  }
+
+  return absolutePath;
+}
+
+string removeLastPathElement(const string path,
+                             const bool removePreSeparator,
+                             const bool removePostSeparator)
+{
+  string newPath = path;
+  size_t offset = newPath.find_last_of(SEPARATOR);
+  if (removePreSeparator &&
+#ifndef _WIN32
+      offset != newPath.find_first_of(SEPARATOR) &&
+#endif
+      offset == newPath.length() - 1) {
+    newPath = newPath.substr(0, offset);
+    offset = newPath.find_last_of(SEPARATOR);
+  }
+  newPath = removePostSeparator ? newPath.substr(0, offset)
+                                : newPath.substr(0, offset + 1);
+  return newPath;
+}
+
+string appendToDirectory(const string& directoryPath, const string& filename)
+{
+  string newPath = directoryPath + SEPARATOR + filename;
+  return newPath;
+}
+
+string getLastPathElement(const string& path)
+{
+  return path.substr(path.find_last_of(SEPARATOR) + 1);
+}
+
+unsigned int getFileSize(const string& path)
+{
+#ifdef _WIN32
+  struct _stat filestatus;
+  _stat(path.c_str(), &filestatus);
+#else
+  struct stat filestatus;
+  stat(path.c_str(), &filestatus);
+#endif
+
+  return filestatus.st_size / 1024;
+}
+
+string getFileSizeAsString(const string& path)
+{
+  ostringstream convert;
+  convert << getFileSize(path);
+  return convert.str();
+}
+
+bool fileExists(const string& path)
+{
+#ifdef _WIN32
+  return PathFileExists(path.c_str());
+#else
+  bool flag = false;
+  fstream fin;
+  fin.open(path.c_str(), ios::in);
+  if (fin.is_open()) {
+    flag = true;
+  }
+  fin.close();
+  return flag;
+#endif
+}
+
+bool makeDirectory(const string& path)
+{
+#ifdef _WIN32
+  int status = _mkdir(path.c_str());
+#else
+  int status = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
+#endif
+  return status == 0;
+}
+
+/* Try to create a link and if does not work then make a copy */
+bool copyFile(const string& sourcePath, const string& destPath)
+{
+  try {
+#ifndef _WIN32
+    if (link(sourcePath.c_str(), destPath.c_str()) != 0) {
+#endif
+      std::ifstream infile(sourcePath.c_str(), std::ios_base::binary);
+      std::ofstream outfile(destPath.c_str(), std::ios_base::binary);
+      outfile << infile.rdbuf();
+#ifndef _WIN32
+    }
+#endif
+  } catch (exception& e) {
+    cerr << e.what() << endl;
+    return false;
+  }
+
+  return true;
+}
+
+string getExecutablePath()
+{
+  char binRootPath[PATH_MAX];
+
+#ifdef _WIN32
+  GetModuleFileName(NULL, binRootPath, PATH_MAX);
+  return std::string(binRootPath);
+#elif __APPLE__
+  uint32_t max = (uint32_t)PATH_MAX;
+  _NSGetExecutablePath(binRootPath, &max);
+  return std::string(binRootPath);
+#else
+  ssize_t size = readlink("/proc/self/exe", binRootPath, PATH_MAX);
+  if (size != -1) {
+    return std::string(binRootPath, size);
+  }
+#endif
+
+  return "";
+}
+
+bool writeTextFile(const string& path, const string& content)
+{
+  std::ofstream file;
+  file.open(path.c_str());
+  file << content;
+  file.close();
+  return true;
+}
+
+string getCurrentDirectory()
+{
+  char* a_cwd = getcwd(NULL, 0);
+  string s_cwd(a_cwd);
+  free(a_cwd);
+  return s_cwd;
+}

src/common/regexTools.cpp

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <common/regexTools.h>
+
+std::map<std::string, RegexMatcher*> regexCache;
+
+RegexMatcher* buildRegex(const std::string& regex)
+{
+  RegexMatcher* matcher;
+  std::map<std::string, RegexMatcher*>::iterator itr = regexCache.find(regex);
+
+  /* Regex is in cache */
+  if (itr != regexCache.end()) {
+    matcher = itr->second;
+  }
+
+  /* Regex needs to be parsed (and cached) */
+  else {
+    UErrorCode status = U_ZERO_ERROR;
+    UnicodeString uregex = UnicodeString(regex.c_str());
+    matcher = new RegexMatcher(uregex, UREGEX_CASE_INSENSITIVE, status);
+    regexCache[regex] = matcher;
+  }
+
+  return matcher;
+}
+
+/* todo */
+void freeRegexCache()
+{
+}
+bool matchRegex(const std::string& content, const std::string& regex)
+{
+  ucnv_setDefaultName("UTF-8");
+  UnicodeString ucontent = UnicodeString(content.c_str());
+  RegexMatcher* matcher = buildRegex(regex);
+  matcher->reset(ucontent);
+  return matcher->find();
+}
+
+std::string replaceRegex(const std::string& content,
+                         const std::string& replacement,
+                         const std::string& regex)
+{
+  ucnv_setDefaultName("UTF-8");
+  UnicodeString ucontent = UnicodeString(content.c_str());
+  UnicodeString ureplacement = UnicodeString(replacement.c_str());
+  RegexMatcher* matcher = buildRegex(regex);
+  matcher->reset(ucontent);
+  UErrorCode status = U_ZERO_ERROR;
+  UnicodeString uresult = matcher->replaceAll(ureplacement, status);
+  std::string tmp;
+  uresult.toUTF8String(tmp);
+  return tmp;
+}
+
+std::string appendToFirstOccurence(const std::string& content,
+                                   const std::string regex,
+                                   const std::string& replacement)
+{
+  ucnv_setDefaultName("UTF-8");
+  UnicodeString ucontent = UnicodeString(content.c_str());
+  UnicodeString ureplacement = UnicodeString(replacement.c_str());
+  RegexMatcher* matcher = buildRegex(regex);
+  matcher->reset(ucontent);
+
+  if (matcher->find()) {
+    UErrorCode status = U_ZERO_ERROR;
+    ucontent.insert(matcher->end(status), ureplacement);
+    std::string tmp;
+    ucontent.toUTF8String(tmp);
+    return tmp;
+  }
+
+  return content;
+}

src/common/stringTools.cpp

@@ -0,0 +1,316 @@
+/*
+ * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <common/stringTools.h>
+
+#include <unicode/normlzr.h>
+#include <unicode/rep.h>
+#include <unicode/translit.h>
+#include <unicode/ucnv.h>
+#include <unicode/uniset.h>
+#include <unicode/ustring.h>
+
+/* tell ICU where to find its dat file (tables) */
+void kiwix::loadICUExternalTables()
+{
+#ifdef __APPLE__
+  std::string executablePath = getExecutablePath();
+  std::string executableDirectory = removeLastPathElement(executablePath);
+  std::string datPath
+      = computeAbsolutePath(executableDirectory, "icudt49l.dat");
+  try {
+    u_setDataDirectory(datPath.c_str());
+  } catch (exception& e) {
+    std::cerr << e.what() << std::endl;
+  }
+#endif
+}
+
+std::string kiwix::removeAccents(const std::string& text)
+{
+  loadICUExternalTables();
+  ucnv_setDefaultName("UTF-8");
+  UErrorCode status = U_ZERO_ERROR;
+  Transliterator* removeAccentsTrans = Transliterator::createInstance(
+      "Lower; NFD; [:M:] remove; NFC", UTRANS_FORWARD, status);
+  UnicodeString ustring = UnicodeString(text.c_str());
+  removeAccentsTrans->transliterate(ustring);
+  delete removeAccentsTrans;
+  std::string unaccentedText;
+  ustring.toUTF8String(unaccentedText);
+  return unaccentedText;
+}
+
+#ifndef __ANDROID__
+
+/* Prepare integer for display */
+std::string kiwix::beautifyInteger(const unsigned int number)
+{
+  std::stringstream numberStream;
+  numberStream << number;
+  std::string numberString = numberStream.str();
+
+  signed int offset = numberString.size() - 3;
+  while (offset > 0) {
+    numberString.insert(offset, ",");
+    offset -= 3;
+  }
+
+  return numberString;
+}
+
+std::string kiwix::beautifyFileSize(const unsigned int number)
+{
+  if (number > 1024 * 1024) {
+    return kiwix::beautifyInteger(number / (1024 * 1024)) + " GB";
+  } else {
+    return kiwix::beautifyInteger(number / 1024 != 0 ? number / 1024 : 1)
+           + " MB";
+  }
+}
+
+void kiwix::printStringInHexadecimal(UnicodeString s)
+{
+  std::cout << std::showbase << std::hex;
+  for (int i = 0; i < s.length(); i++) {
+    char c = (char)((s.getTerminatedBuffer())[i]);
+    if (c & 0x80) {
+      std::cout << (c & 0xffff) << " ";
+    } else {
+      std::cout << c << " ";
+    }
+  }
+  std::cout << std::endl;
+}
+
+void kiwix::printStringInHexadecimal(const char* s)
+{
+  std::cout << std::showbase << std::hex;
+  for (char const* pc = s; *pc; ++pc) {
+    if (*pc & 0x80) {
+      std::cout << (*pc & 0xffff);
+    } else {
+      std::cout << *pc;
+    }
+    std::cout << ' ';
+  }
+  std::cout << std::endl;
+}
+
+void kiwix::stringReplacement(std::string& str,
+                              const std::string& oldStr,
+                              const std::string& newStr)
+{
+  size_t pos = 0;
+  while ((pos = str.find(oldStr, pos)) != std::string::npos) {
+    str.replace(pos, oldStr.length(), newStr);
+    pos += newStr.length();
+  }
+}
+
+/* Encode string to avoid XSS attacks */
+std::string kiwix::encodeDiples(const std::string& str)
+{
+  std::string result = str;
+  kiwix::stringReplacement(result, "<", "&lt;");
+  kiwix::stringReplacement(result, ">", "&gt;");
+  return result;
+}
+
+// Urlencode
+// based on javascript encodeURIComponent()
+
+std::string char2hex(char dec)
+{
+  char dig1 = (dec & 0xF0) >> 4;
+  char dig2 = (dec & 0x0F);
+  if (0 <= dig1 && dig1 <= 9) {
+    dig1 += 48;  // 0,48inascii
+  }
+  if (10 <= dig1 && dig1 <= 15) {
+    dig1 += 97 - 10;  // a,97inascii
+  }
+  if (0 <= dig2 && dig2 <= 9) {
+    dig2 += 48;
+  }
+  if (10 <= dig2 && dig2 <= 15) {
+    dig2 += 97 - 10;
+  }
+
+  std::string r;
+  r.append(&dig1, 1);
+  r.append(&dig2, 1);
+  return r;
+}
+
+std::string kiwix::urlEncode(const std::string& c)
+{
+  std::string escaped = "";
+  int max = c.length();
+  for (int i = 0; i < max; i++) {
+    if ((48 <= c[i] && c[i] <= 57) ||  // 0-9
+        (65 <= c[i] && c[i] <= 90)
+        ||  // abc...xyz
+        (97 <= c[i] && c[i] <= 122)
+        ||  // ABC...XYZ
+        (c[i] == '~' || c[i] == '!' || c[i] == '*' || c[i] == '(' || c[i] == ')'
+         || c[i] == '\'')) {
+      escaped.append(&c[i], 1);
+    } else {
+      escaped.append("%");
+      escaped.append(char2hex(c[i]));  // converts char 255 to string "ff"
+    }
+  }
+  return escaped;
+}
+
+#endif
+
+static char charFromHex(std::string a)
+{
+  std::istringstream Blat(a);
+  int Z;
+  Blat >> std::hex >> Z;
+  return char(Z);
+}
+
+std::string kiwix::urlDecode(const std::string& originalUrl)
+{
+  std::string url = originalUrl;
+  std::string::size_type pos = 0;
+  while ((pos = url.find('%', pos)) != std::string::npos
+         && pos + 2 < url.length()) {
+    url.replace(pos, 3, 1, charFromHex(url.substr(pos + 1, 2)));
+    ++pos;
+  }
+  return url;
+}
+
+/* Split string in a token array */
+std::vector<std::string> kiwix::split(const std::string& str,
+                                      const std::string& delims = " *-")
+{
+  std::string::size_type lastPos = str.find_first_not_of(delims, 0);
+  std::string::size_type pos = str.find_first_of(delims, lastPos);
+  std::vector<std::string> tokens;
+
+  while (std::string::npos != pos || std::string::npos != lastPos) {
+    tokens.push_back(str.substr(lastPos, pos - lastPos));
+    lastPos = str.find_first_not_of(delims, pos);
+    pos = str.find_first_of(delims, lastPos);
+  }
+
+  return tokens;
+}
+
+std::vector<std::string> kiwix::split(const char* lhs, const char* rhs)
+{
+  const std::string m1(lhs), m2(rhs);
+  return split(m1, m2);
+}
+
+std::vector<std::string> kiwix::split(const char* lhs, const std::string& rhs)
+{
+  return split(lhs, rhs.c_str());
+}
+
+std::vector<std::string> kiwix::split(const std::string& lhs, const char* rhs)
+{
+  return split(lhs.c_str(), rhs);
+}
+
+std::string kiwix::ucFirst(const std::string& word)
+{
+  if (word.empty()) {
+    return "";
+  }
+
+  std::string result;
+
+  UnicodeString unicodeWord(word.c_str());
+  UnicodeString unicodeFirstLetter = UnicodeString(unicodeWord, 0, 1).toUpper();
+  unicodeWord.replace(0, 1, unicodeFirstLetter);
+  unicodeWord.toUTF8String(result);
+
+  return result;
+}
+
+std::string kiwix::ucAll(const std::string& word)
+{
+  if (word.empty()) {
+    return "";
+  }
+
+  std::string result;
+
+  UnicodeString unicodeWord(word.c_str());
+  unicodeWord.toUpper().toUTF8String(result);
+
+  return result;
+}
+
+std::string kiwix::lcFirst(const std::string& word)
+{
+  if (word.empty()) {
+    return "";
+  }
+
+  std::string result;
+
+  UnicodeString unicodeWord(word.c_str());
+  UnicodeString unicodeFirstLetter = UnicodeString(unicodeWord, 0, 1).toLower();
+  unicodeWord.replace(0, 1, unicodeFirstLetter);
+  unicodeWord.toUTF8String(result);
+
+  return result;
+}
+
+std::string kiwix::lcAll(const std::string& word)
+{
+  if (word.empty()) {
+    return "";
+  }
+
+  std::string result;
+
+  UnicodeString unicodeWord(word.c_str());
+  unicodeWord.toLower().toUTF8String(result);
+
+  return result;
+}
+
+std::string kiwix::toTitle(const std::string& word)
+{
+  if (word.empty()) {
+    return "";
+  }
+
+  std::string result;
+
+  UnicodeString unicodeWord(word.c_str());
+  unicodeWord = unicodeWord.toTitle(0);
+  unicodeWord.toUTF8String(result);
+
+  return result;
+}
+
+std::string kiwix::normalize(const std::string& word)
+{
+  return kiwix::lcAll(word);
+}

src/config.h.in

@@ -1,3 +1,4 @@
 
 #mesondefine VERSION
 
+#mesondefine ENABLE_CTPP2

src/ctpp2/CTPP2VMStringLoader.cpp

@@ -0,0 +1,210 @@
+/*
+ * Copyright 2013 Renaud Gaudin <reg@kiwix.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <ctpp2/CTPP2VMStringLoader.hpp>
+
+namespace CTPP // C++ Template Engine
+{
+
+//
+// Convert byte order
+//
+static void ConvertExecutable(VMExecutable * oCore)
+{
+	// Code entry point
+	oCore -> entry_point = Swap32(oCore -> entry_point);
+	// Offset of code segment
+	oCore -> code_offset = Swap32(oCore -> code_offset);
+
+	// Code segment size
+	oCore -> code_size   = Swap32(oCore -> code_size);
+
+	// Offset of static text segment
+	oCore -> syscalls_offset    = Swap32(oCore -> syscalls_offset);
+	// Static text segment size
+	oCore -> syscalls_data_size = Swap32(oCore -> syscalls_data_size);
+
+	// Offset of static text index segment
+	oCore -> syscalls_index_offset = Swap32(oCore -> syscalls_index_offset);
+	// Static text index segment size
+	oCore -> syscalls_index_size   = Swap32(oCore -> syscalls_index_size);
+
+	// Offset of static data segment
+	oCore -> static_data_offset    = Swap32(oCore -> static_data_offset);
+
+	// Static data segment size
+	oCore -> static_data_data_size = Swap32(oCore -> static_data_data_size);
+
+	// Offset of static text segment
+	oCore -> static_text_offset    = Swap32(oCore -> static_text_offset);
+	// Static text segment size
+	oCore -> static_text_data_size = Swap32(oCore -> static_text_data_size);
+
+	// Offset of static text index segment
+	oCore -> static_text_index_offset = Swap32(oCore -> static_text_index_offset);
+	// Static text index segment size
+	oCore -> static_text_index_size   = Swap32(oCore -> static_text_index_size);
+
+	// Version 2.2+
+	// Offset of static data bit index
+	oCore -> static_data_bit_index_offset = Swap32(oCore -> static_data_bit_index_offset);
+	/// Offset of static data bit index
+	oCore -> static_data_bit_index_size = Swap32(oCore -> static_data_bit_index_size);
+
+	// Platform
+	oCore -> platform      = Swap64(oCore -> platform);
+
+	// Ugly-jolly hack!
+	// ... dereferencing type-punned pointer will break strict-aliasing rules ...
+	UINT_64 iTMP;
+	memcpy(&iTMP, &(oCore -> ieee754double), sizeof(UINT_64));
+	iTMP = Swap64(iTMP);
+	memcpy(&(oCore -> ieee754double), &iTMP, sizeof(UINT_64));
+
+	// Cyclic Redundancy Check
+	oCore -> crc = 0;
+
+	// Convert data structures
+
+	// Convert code segment
+	VMInstruction * pInstructions = const_cast<VMInstruction *>(VMExecutable::GetCodeSeg(oCore));
+	UINT_32 iI = 0;
+	UINT_32 iSteps = oCore -> code_size / sizeof(VMInstruction);
+	for(iI = 0; iI < iSteps; ++iI)
+	{
+		pInstructions -> instruction = Swap32(pInstructions -> instruction);
+		pInstructions -> argument    = Swap32(pInstructions -> argument);
+		pInstructions -> reserved    = Swap64(pInstructions -> reserved);
+		++pInstructions;
+	}
+
+	// Convert syscalls index
+	TextDataIndex * pTextIndex = const_cast<TextDataIndex *>(VMExecutable::GetSyscallsIndexSeg(oCore));
+	iSteps = oCore -> syscalls_index_size / sizeof(TextDataIndex);
+	for(iI = 0; iI < iSteps; ++iI)
+	{
+		pTextIndex -> offset = Swap32(pTextIndex -> offset);
+		pTextIndex -> length = Swap32(pTextIndex -> length);
+		++pTextIndex;
+	}
+
+	// Convert static text index
+	pTextIndex = const_cast<TextDataIndex *>(VMExecutable::GetStaticTextIndexSeg(oCore));
+	iSteps = oCore -> static_text_index_size / sizeof(TextDataIndex);
+	for(iI = 0; iI < iSteps; ++iI)
+	{
+		pTextIndex -> offset = Swap32(pTextIndex -> offset);
+		pTextIndex -> length = Swap32(pTextIndex -> length);
+		++pTextIndex;
+	}
+
+	// Convert static data
+	StaticDataVar * pStaticDataVar = const_cast<StaticDataVar *>(VMExecutable::GetStaticDataSeg(oCore));
+	iSteps = oCore -> static_data_data_size / sizeof(StaticDataVar);
+	for(iI = 0; iI < iSteps; ++iI)
+	{
+		(*pStaticDataVar).i_data = Swap64((*pStaticDataVar).i_data);
+		++pStaticDataVar;
+	}
+}
+
+//
+// Constructor
+//
+VMStringLoader::VMStringLoader(CCHAR_P rawContent, size_t rawContentSize)
+{
+    oCore = (VMExecutable *)malloc(rawContentSize + 1);
+    memcpy(oCore, rawContent, rawContentSize);
+
+	if (oCore -> magic[0] == 'C' &&
+	    oCore -> magic[1] == 'T' &&
+	    oCore -> magic[2] == 'P' &&
+	    oCore -> magic[3] == 'P')
+	{
+		// Check version
+		if (oCore -> version[0] >= 1)
+		{
+			// Platform-dependent data (byte order)
+			if (oCore -> platform == 0x4142434445464748ull)
+			{
+#ifdef _DEBUG
+				fprintf(stderr, "Big/Little Endian conversion: Nothing to do\n");
+#endif
+
+				// Nothing to do, only check crc
+				UINT_32 iCRC = oCore -> crc;
+				oCore -> crc = 0;
+
+				// Calculate CRC of file
+                // KELSON: next line used to refer to oStat.st_size
+                // changed it to rawContentSize
+				if (iCRC != crc32((UCCHAR_P)oCore, rawContentSize))
+				{
+					free(oCore);
+					throw CTPPLogicError("CRC checksum invalid");
+				}
+			}
+			// Platform-dependent data (byte order)
+			else if (oCore -> platform == 0x4847464544434241ull)
+			{
+				// Need to reconvert data
+#ifdef _DEBUG
+				fprintf(stderr, "Big/Little Endian conversion: Need to reconvert core\n");
+#endif
+				ConvertExecutable(oCore);
+			}
+			else
+			{
+				free(oCore);
+				throw CTPPLogicError("Conversion of middle-end architecture does not supported.");
+			}
+
+			// Check IEEE 754 format
+			if (oCore -> ieee754double != 15839800103804824402926068484019465486336.0)
+			{
+				free(oCore);
+				throw CTPPLogicError("IEEE 754 format is broken, cannot convert file");
+			}
+		}
+
+		pVMMemoryCore = new VMMemoryCore(oCore);
+	}
+	else
+	{
+		free(oCore);
+		throw CTPPLogicError("Not an CTPP bytecode file.");
+	}
+}
+
+//
+// Get ready-to-run program
+//
+const VMMemoryCore * VMStringLoader::GetCore() const { return pVMMemoryCore; }
+
+//
+// A destructor
+//
+VMStringLoader::~VMStringLoader() throw()
+{
+	delete pVMMemoryCore;
+	free(oCore);
+}
+
+} // namespace CTPP
+// End.

src/downloader.cpp

@@ -1,204 +0,0 @@
-/*
- * Copyright 2018 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "downloader.h"
-#include "tools/pathTools.h"
-#include "tools/stringTools.h"
-
-#include <algorithm>
-#include <thread>
-#include <chrono>
-
-#include <iostream>
-
-#include "aria2.h"
-#include "xmlrpc.h"
-#include "tools/otherTools.h"
-#include <pugixml.hpp>
-
-namespace kiwix
-{
-
-void Download::updateStatus(bool follow)
-{
-  if (m_status == Download::K_REMOVED)
-    return;
-  static std::vector<std::string> statusKey = {"status", "files", "totalLength",
-                                               "completedLength", "followedBy",
-                                               "downloadSpeed", "verifiedLength"};
-  std::string strStatus;
-  if(follow && !m_followedBy.empty()) {
-    strStatus = mp_aria->tellStatus(m_followedBy, statusKey);
-  } else {
-    strStatus = mp_aria->tellStatus(m_did, statusKey);
-  }
-//  std::cout << strStatus << std::endl;
-  MethodResponse response(strStatus);
-  if (response.isFault()) {
-    m_status = Download::K_UNKNOWN;
-    return;
-  }
-  auto structNode = response.getParams().getParam(0).getValue().getStruct();
-  auto _status = structNode.getMember("status").getValue().getAsS();
-  auto status = _status == "active" ? Download::K_ACTIVE
-              : _status == "waiting" ? Download::K_WAITING
-              : _status == "paused" ? Download::K_PAUSED
-              : _status == "error" ? Download::K_ERROR
-              : _status == "complete" ? Download::K_COMPLETE
-              : _status == "removed" ? Download::K_REMOVED
-              : Download::K_UNKNOWN;
-  if (status == K_COMPLETE) {
-    try {
-      auto followedByMember = structNode.getMember("followedBy");
-      m_followedBy = followedByMember.getValue().getArray().getValue(0).getAsS();
-      if (follow) {
-        status = K_ACTIVE;
-        updateStatus(true);
-        return;
-      }
-    } catch (InvalidRPCNode& e) { }
-  }
-  m_status = status;
-  m_totalLength = extractFromString<uint64_t>(structNode.getMember("totalLength").getValue().getAsS());
-  m_completedLength = extractFromString<uint64_t>(structNode.getMember("completedLength").getValue().getAsS());
-  m_downloadSpeed = extractFromString<uint64_t>(structNode.getMember("downloadSpeed").getValue().getAsS());
-  try {
-    auto verifiedLengthValue = structNode.getMember("verifiedLength").getValue();
-    m_verifiedLength = extractFromString<uint64_t>(verifiedLengthValue.getAsS());
-  } catch (InvalidRPCNode& e) { m_verifiedLength = 0; }
-  auto filesMember = structNode.getMember("files");
-  auto fileStruct = filesMember.getValue().getArray().getValue(0).getStruct();
-  m_path = fileStruct.getMember("path").getValue().getAsS();
-  auto urisArray = fileStruct.getMember("uris").getValue().getArray();
-  int index = 0;
-  m_uris.clear();
-  while(true) {
-    try {
-      auto uriNode = urisArray.getValue(index++).getStruct().getMember("uri");
-      m_uris.push_back(uriNode.getValue().getAsS());
-    } catch(InvalidRPCNode& e) { break; }
-  }
-}
-
-void Download::resumeDownload()
-{
-    if (!m_followedBy.empty())
-        mp_aria->unpause(m_followedBy);
-    else
-        mp_aria->unpause(m_did);
-    updateStatus(true);
-}
-
-void Download::pauseDownload()
-{
-    if (!m_followedBy.empty())
-        mp_aria->pause(m_followedBy);
-    else
-        mp_aria->pause(m_did);
-    updateStatus(true);
-}
-
-void Download::cancelDownload()
-{
-    if (!m_followedBy.empty())
-        mp_aria->remove(m_followedBy);
-    else
-        mp_aria->remove(m_did);
-    m_status = Download::K_REMOVED;
-}
-
-/* Constructor */
-Downloader::Downloader() :
-  mp_aria(new Aria2())
-{
-  try {
-    for (auto gid : mp_aria->tellActive()) {
-      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()
-{
-}
-
-void Downloader::close()
-{
-  mp_aria->close();
-}
-
-std::vector<std::string> Downloader::getDownloadIds() {
-  std::vector<std::string> ret;
-  for(auto& p:m_knownDownloads) {
-    ret.push_back(p.first);
-  }
-  return ret;
-}
-
-Download* Downloader::startDownload(const std::string& uri, const std::vector<std::pair<std::string, std::string>>& options)
-{
-  for (auto& p: m_knownDownloads) {
-    auto& d = p.second;
-    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::unique_ptr<Download>(new Download(mp_aria, gid));
-  return m_knownDownloads[gid].get();
-}
-
-Download* Downloader::getDownload(const std::string& did)
-{
-  try {
-    m_knownDownloads.at(did).get()->updateStatus(true);
-    return m_knownDownloads.at(did).get();
-  } catch(std::exception& e) {
-    for (auto gid : mp_aria->tellActive()) {
-      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();
-      }
-    }
-    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;
-  }
-}
-
-}

src/entry.cpp

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

src/kiwixserve.cpp

@@ -1,81 +0,0 @@
-#include "kiwixserve.h"
-#include "subprocess.h"
-
-#ifdef _WIN32
-    # define KIWIXSERVE_CMD "kiwix-serve.exe"
-    # include <windows.h>
-#else
-    # define KIWIXSERVE_CMD "kiwix-serve"
-    # include <unistd.h>
-#endif
-
-#include "tools/pathTools.h"
-#include "tools/stringTools.h"
-
-namespace kiwix {
-
-KiwixServe::KiwixServe(const std::string& libraryPath, int port)
-  : m_port(port),
-    m_libraryPath(libraryPath)
-{
-}
-
-KiwixServe::~KiwixServe()
-{
-    shutDown();
-}
-
-void KiwixServe::run()
-{
-    #ifdef _WIN32
-        int pid = GetCurrentProcessId();
-    #else
-        pid_t pid = getpid();
-
-    #endif
-
-    std::vector<const char*> callCmd;
-    std::string kiwixServeCmd = appendToDirectory(
-        removeLastPathElement(getExecutablePath(true)),
-        KIWIXSERVE_CMD);
-    if (fileExists(kiwixServeCmd)) {
-        // A local kiwix-serve exe exists (packaged with kiwix-desktop), use it.
-        callCmd.push_back(kiwixServeCmd.c_str());
-    } else {
-        // Try to use a potential installed kiwix-serve.
-        callCmd.push_back(KIWIXSERVE_CMD);
-    }
-    std::string attachProcessOpt = "-a" + to_string(pid);
-    std::string portOpt = "-p" + to_string(m_port);
-    callCmd.push_back(attachProcessOpt.c_str());
-    callCmd.push_back(portOpt.c_str());
-    callCmd.push_back("-l");
-    callCmd.push_back(m_libraryPath.c_str());
-    mp_kiwixServe = Subprocess::run(callCmd);
-}
-
-void KiwixServe::shutDown()
-{
-    if (mp_kiwixServe)
-        mp_kiwixServe->kill();
-}
-
-bool KiwixServe::isRunning()
-{
-    if (mp_kiwixServe) {
-        return (mp_kiwixServe->isRunning());
-    }
-    return false;
-}
-
-int KiwixServe::setPort(int port)
-{
-    if (port >= 1 && port <= 65535) {
-        m_port = port;
-    } else {
-        return -1;
-    }
-    return m_port;
-}
-
-}

src/library.cpp

@@ -18,768 +18,137 @@
  */
 
 #include "library.h"
-#include "book.h"
-#include "reader.h"
-#include "libxml_dumper.h"
-
-#include "tools/base64.h"
-#include "tools/regexTools.h"
-#include "tools/pathTools.h"
-#include "tools/stringTools.h"
-
-#include <pugixml.hpp>
-#include <algorithm>
-#include <set>
-#include <unicode/locid.h>
-#include <xapian.h>
 
 namespace kiwix
 {
-
-namespace
+/* Constructor */
+Book::Book() : readOnly(false)
 {
-
-std::string iso639_3ToXapian(const std::string& lang) {
-  return icu::Locale(lang.c_str()).getLanguage();
-};
-
-std::string normalizeText(const std::string& text)
+}
+/* Destructor */
+Book::~Book()
 {
-  return removeAccents(text);
+}
+/* Sort functions */
+bool Book::sortByLastOpen(const kiwix::Book& a, const kiwix::Book& b)
+{
+  return atoi(a.last.c_str()) > atoi(b.last.c_str());
 }
 
-} // unnamed namespace
-
-class Library::BookDB : public Xapian::WritableDatabase
+bool Book::sortByTitle(const kiwix::Book& a, const kiwix::Book& b)
 {
-public:
-  BookDB() : Xapian::WritableDatabase("", Xapian::DB_BACKEND_INMEMORY) {}
-};
+  return strcmp(a.title.c_str(), b.title.c_str()) < 0;
+}
+
+bool Book::sortByDate(const kiwix::Book& a, const kiwix::Book& b)
+{
+  return strcmp(a.date.c_str(), b.date.c_str()) > 0;
+}
+
+bool Book::sortBySize(const kiwix::Book& a, const kiwix::Book& b)
+{
+  return atoi(a.size.c_str()) < atoi(b.size.c_str());
+}
+
+bool Book::sortByPublisher(const kiwix::Book& a, const kiwix::Book& b)
+{
+  return strcmp(a.publisher.c_str(), b.publisher.c_str()) < 0;
+}
+
+bool Book::sortByCreator(const kiwix::Book& a, const kiwix::Book& b)
+{
+  return strcmp(a.creator.c_str(), b.creator.c_str()) < 0;
+}
+
+bool Book::sortByLanguage(const kiwix::Book& a, const kiwix::Book& b)
+{
+  return strcmp(a.language.c_str(), b.language.c_str()) < 0;
+}
+
+std::string Book::getHumanReadableIdFromPath()
+{
+  std::string id = pathAbsolute;
+  if (!id.empty()) {
+    kiwix::removeAccents(id);
+
+#ifdef _WIN32
+    id = replaceRegex(id, "", "^.*\\\\");
+#else
+    id = replaceRegex(id, "", "^.*/");
+#endif
+
+    id = replaceRegex(id, "", "\\.zim[a-z]*$");
+    id = replaceRegex(id, "_", " ");
+    id = replaceRegex(id, "plus", "\\+");
+  }
+  return id;
+}
 
 /* Constructor */
-Library::Library()
-  : m_bookDB(new BookDB)
+Library::Library() : version(KIWIX_LIBRARY_VERSION)
 {
 }
-
-Library::Library(Library&& ) = default;
-
-Library& Library::operator=(Library&& ) = default;
-
 /* Destructor */
 Library::~Library()
 {
 }
-
-
 bool Library::addBook(const Book& book)
 {
   /* Try to find it */
-  updateBookDB(book);
-  try {
-    auto& oldbook = m_books.at(book.getId());
-    oldbook.update(book);
-    return false;
-  } catch (std::out_of_range&) {
-    m_books[book.getId()] = book;
-    return true;
-  }
-}
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = this->books.begin(); itr != this->books.end(); ++itr) {
+    if (itr->id == book.id) {
+      if (!itr->readOnly) {
+        itr->readOnly = book.readOnly;
 
-void Library::addBookmark(const Bookmark& bookmark)
-{
-  m_bookmarks.push_back(bookmark);
-}
+        if (itr->path.empty()) {
+          itr->path = book.path;
+        }
 
-bool Library::removeBookmark(const std::string& zimId, const std::string& url)
-{
-  for(auto it=m_bookmarks.begin(); it!=m_bookmarks.end(); it++) {
-    if (it->getBookId() == zimId && it->getUrl() == url) {
-      m_bookmarks.erase(it);
-      return true;
-    }
-  }
-  return false;
-}
+        if (itr->pathAbsolute.empty()) {
+          itr->pathAbsolute = book.pathAbsolute;
+        }
 
+        if (itr->url.empty()) {
+          itr->url = book.url;
+        }
 
+        if (itr->tags.empty()) {
+          itr->tags = book.tags;
+        }
 
-bool Library::removeBookById(const std::string& id)
-{
-  m_bookDB->delete_document("Q" + id);
-  m_readers.erase(id);
-  return m_books.erase(id) == 1;
-}
+        if (itr->name.empty()) {
+          itr->name = book.name;
+        }
 
-const Book& Library::getBookById(const std::string& id) const
-{
-  return m_books.at(id);
-}
+        if (itr->indexPath.empty()) {
+          itr->indexPath = book.indexPath;
+          itr->indexType = book.indexType;
+        }
 
-Book& Library::getBookById(const std::string& id)
-{
-  const Library& const_self = *this;
-  return const_cast<Book&>(const_self.getBookById(id));
-}
+        if (itr->indexPathAbsolute.empty()) {
+          itr->indexPathAbsolute = book.indexPathAbsolute;
+          itr->indexType = book.indexType;
+        }
 
-const Book& Library::getBookByPath(const std::string& path) const
-{
-  for(auto& it: m_books) {
-    auto& book = it.second;
-    if (book.getPath() == path)
-      return book;
-  }
-  std::ostringstream ss;
-  ss << "No book with path " << path << " in the library." << std::endl;
-  throw std::out_of_range(ss.str());
-}
-
-Book& Library::getBookByPath(const std::string& path)
-{
-  const Library& const_self = *this;
-  return const_cast<Book&>(const_self.getBookByPath(path));
-}
-
-std::shared_ptr<Reader> Library::getReaderById(const std::string& id)
-{
-  try {
-    return m_readers.at(id);
-  } catch (std::out_of_range& e) {}
-
-  auto book = getBookById(id);
-  if (!book.isPathValid())
-    return nullptr;
-  auto sptr = make_shared<Reader>(book.getPath());
-  m_readers[id] = sptr;
-  return sptr;
-}
-
-unsigned int Library::getBookCount(const bool localBooks,
-                                   const bool remoteBooks) const
-{
-  unsigned int result = 0;
-  for (auto& pair: m_books) {
-    auto& book = pair.second;
-    if ((!book.getPath().empty() && localBooks)
-        || (book.getPath().empty() && remoteBooks)) {
-      result++;
-    }
-  }
-  return result;
-}
-
-bool Library::writeToFile(const std::string& path) const
-{
-  auto baseDir = removeLastPathElement(path);
-  LibXMLDumper dumper(this);
-  dumper.setBaseDir(baseDir);
-  return writeTextFile(path, dumper.dumpLibXMLContent(getBooksIds()));
-}
-
-bool Library::writeBookmarksToFile(const std::string& path) const
-{
-  LibXMLDumper dumper(this);
-  return writeTextFile(path, dumper.dumpLibXMLBookmark());
-}
-
-std::vector<std::string> Library::getBooksLanguages() const
-{
-  std::vector<std::string> booksLanguages;
-  std::map<std::string, bool> booksLanguagesMap;
-
-  for (auto& pair: m_books) {
-    auto& book = pair.second;
-    auto& language = book.getLanguage();
-    if (booksLanguagesMap.find(language) == booksLanguagesMap.end()) {
-      if (book.getOrigId().empty()) {
-        booksLanguagesMap[language] = true;
-        booksLanguages.push_back(language);
+        if (itr->faviconMimeType.empty()) {
+          itr->favicon = book.favicon;
+          itr->faviconMimeType = book.faviconMimeType;
+        }
       }
+
+      return false;
     }
   }
 
-  return booksLanguages;
-}
-
-std::vector<std::string> Library::getBooksCategories() const
-{
-  std::set<std::string> categories;
-
-  for (const auto& pair: m_books) {
-    const auto& book = pair.second;
-    const auto& c = book.getCategory();
-    if ( !c.empty() ) {
-      categories.insert(c);
-    }
-  }
-
-  return std::vector<std::string>(categories.begin(), categories.end());
-}
-
-std::vector<std::string> Library::getBooksCreators() const
-{
-  std::vector<std::string> booksCreators;
-  std::map<std::string, bool> booksCreatorsMap;
-
-  for (auto& pair: m_books) {
-    auto& book = pair.second;
-    auto& creator = book.getCreator();
-    if (booksCreatorsMap.find(creator) == booksCreatorsMap.end()) {
-      if (book.getOrigId().empty()) {
-        booksCreatorsMap[creator] = true;
-        booksCreators.push_back(creator);
-      }
-    }
-  }
-
-  return booksCreators;
-}
-
-std::vector<std::string> Library::getBooksPublishers() const
-{
-  std::vector<std::string> booksPublishers;
-  std::map<std::string, bool> booksPublishersMap;
-
-  for (auto& pair:m_books) {
-    auto& book = pair.second;
-    auto& publisher = book.getPublisher();
-    if (booksPublishersMap.find(publisher) == booksPublishersMap.end()) {
-      if (book.getOrigId().empty()) {
-        booksPublishersMap[publisher] = true;
-        booksPublishers.push_back(publisher);
-      }
-    }
-  }
-
-  return booksPublishers;
-}
-
-const std::vector<kiwix::Bookmark> Library::getBookmarks(bool onlyValidBookmarks) const
-{
-  if (!onlyValidBookmarks) {
-    return m_bookmarks;
-  }
-  std::vector<kiwix::Bookmark> validBookmarks;
-  auto booksId = getBooksIds();
-  for(auto& bookmark:m_bookmarks) {
-    if (std::find(booksId.begin(), booksId.end(), bookmark.getBookId()) != booksId.end()) {
-      validBookmarks.push_back(bookmark);
-    }
-  }
-  return validBookmarks;
-}
-
-Library::BookIdCollection Library::getBooksIds() const
-{
-  BookIdCollection bookIds;
-
-  for (auto& pair: m_books) {
-    bookIds.push_back(pair.first);
-  }
-
-  return bookIds;
-}
-
-Library::BookIdCollection Library::filter(const std::string& search) const
-{
-  if (search.empty()) {
-    return getBooksIds();
-  }
-
-  return filter(Filter().query(search));
-}
-
-
-void Library::updateBookDB(const Book& book)
-{
-  Xapian::Stem stemmer;
-  Xapian::TermGenerator indexer;
-  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);
-
-  const std::string title = normalizeText(book.getTitle());
-  const std::string desc = normalizeText(book.getDescription());
-
-  // Index title and description without prefixes for general search
-  indexer.index_text(title);
-  indexer.increase_termpos();
-  indexer.index_text(desc);
-
-  // Index all fields for field-based search
-  indexer.index_text(title, 1, "S");
-  indexer.index_text(desc,  1, "XD");
-  indexer.index_text(lang,  1, "L");
-  indexer.index_text(normalizeText(book.getCreator()),   1, "A");
-  indexer.index_text(normalizeText(book.getPublisher()), 1, "XP");
-  indexer.index_text(normalizeText(book.getName()),      1, "XN");
-  indexer.index_text(normalizeText(book.getCategory()),  1, "XC");
-
-  for ( const auto& tag : split(normalizeText(book.getTags()), ";") )
-    doc.add_boolean_term("XT" + tag);
-
-  const std::string idterm = "Q" + book.getId();
-  doc.add_boolean_term(idterm);
-
-  doc.set_data(book.getId());
-
-  m_bookDB->replace_document(idterm, doc);
-}
-
-namespace
-{
-
-bool willSelectEverything(const Xapian::Query& query)
-{
-  return query.get_type() == Xapian::Query::LEAF_MATCH_ALL;
-}
-
-
-Xapian::Query buildXapianQueryFromFilterQuery(const Filter& filter)
-{
-  if ( !filter.hasQuery() || filter.getQuery().empty() ) {
-    // This is a thread-safe way to construct an equivalent of
-    // a Xapian::Query::MatchAll query
-    return Xapian::Query(std::string());
-  }
-
-  Xapian::QueryParser queryParser;
-  queryParser.set_default_op(Xapian::Query::OP_AND);
-  queryParser.add_prefix("title", "S");
-  queryParser.add_prefix("description", "XD");
-  queryParser.add_prefix("name", "XN");
-  queryParser.add_prefix("category", "XC");
-  queryParser.add_prefix("lang", "L");
-  queryParser.add_prefix("publisher", "XP");
-  queryParser.add_prefix("creator", "A");
-  queryParser.add_prefix("tag", "XT");
-  const auto partialQueryFlag = filter.queryIsPartial()
-                              ? Xapian::QueryParser::FLAG_PARTIAL
-                              : 0;
-  // Language assumed for the query is not known for sure so stemming
-  // is not applied
-  //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;
-  return queryParser.parse_query(normalizeText(filter.getQuery()), flags);
-}
-
-Xapian::Query nameQuery(const std::string& name)
-{
-  return Xapian::Query("XN" + normalizeText(name));
-}
-
-Xapian::Query categoryQuery(const std::string& category)
-{
-  return Xapian::Query("XC" + normalizeText(category));
-}
-
-Xapian::Query langQuery(const std::string& lang)
-{
-  return Xapian::Query("L" + normalizeText(lang));
-}
-
-Xapian::Query publisherQuery(const std::string& publisher)
-{
-  Xapian::QueryParser queryParser;
-  queryParser.set_default_op(Xapian::Query::OP_OR);
-  queryParser.set_stemming_strategy(Xapian::QueryParser::STEM_NONE);
-  const auto flags = 0;
-  const auto q = queryParser.parse_query(normalizeText(publisher), flags, "XP");
-  return Xapian::Query(Xapian::Query::OP_PHRASE, q.get_terms_begin(), q.get_terms_end(), q.get_length());
-}
-
-Xapian::Query creatorQuery(const std::string& creator)
-{
-  Xapian::QueryParser queryParser;
-  queryParser.set_default_op(Xapian::Query::OP_OR);
-  queryParser.set_stemming_strategy(Xapian::QueryParser::STEM_NONE);
-  const auto flags = 0;
-  const auto q = queryParser.parse_query(normalizeText(creator), flags, "A");
-  return Xapian::Query(Xapian::Query::OP_PHRASE, q.get_terms_begin(), q.get_terms_end(), q.get_length());
-}
-
-Xapian::Query tagsQuery(const Filter::Tags& acceptTags, const Filter::Tags& rejectTags)
-{
-  Xapian::Query q = Xapian::Query(std::string());
-  if (!acceptTags.empty()) {
-    for ( const auto& tag : acceptTags )
-      q &= Xapian::Query("XT" + normalizeText(tag));
-  }
-
-  if (!rejectTags.empty()) {
-    for ( const auto& tag : rejectTags )
-      q = Xapian::Query(Xapian::Query::OP_AND_NOT, q, "XT" + normalizeText(tag));
-  }
-  return q;
-}
-
-Xapian::Query buildXapianQuery(const Filter& filter)
-{
-  auto q = buildXapianQueryFromFilterQuery(filter);
-  if ( filter.hasName() ) {
-    q = Xapian::Query(Xapian::Query::OP_AND, q, nameQuery(filter.getName()));
-  }
-  if ( filter.hasCategory() ) {
-    q = Xapian::Query(Xapian::Query::OP_AND, q, categoryQuery(filter.getCategory()));
-  }
-  if ( filter.hasLang() ) {
-    q = Xapian::Query(Xapian::Query::OP_AND, q, langQuery(filter.getLang()));
-  }
-  if ( filter.hasPublisher() ) {
-    q = Xapian::Query(Xapian::Query::OP_AND, q, publisherQuery(filter.getPublisher()));
-  }
-  if ( filter.hasCreator() ) {
-    q = Xapian::Query(Xapian::Query::OP_AND, q, creatorQuery(filter.getCreator()));
-  }
-  if ( !filter.getAcceptTags().empty() || !filter.getRejectTags().empty() ) {
-    const auto tq = tagsQuery(filter.getAcceptTags(), filter.getRejectTags());
-    q = Xapian::Query(Xapian::Query::OP_AND, q, tq);;
-  }
-  return q;
-}
-
-} // unnamed namespace
-
-Library::BookIdCollection Library::filterViaBookDB(const Filter& filter) const
-{
-  const auto query = buildXapianQuery(filter);
-
-  if ( willSelectEverything(query) )
-    return getBooksIds();
-
-  BookIdCollection bookIds;
-
-  Xapian::Enquire enquire(*m_bookDB);
-  enquire.set_query(query);
-  const auto results = enquire.get_mset(0, m_books.size());
-  for ( auto it = results.begin(); it != results.end(); ++it  ) {
-    bookIds.push_back(it.get_document().get_data());
-  }
-
-  return bookIds;
-}
-
-Library::BookIdCollection Library::filter(const Filter& filter) const
-{
-  BookIdCollection result;
-  for(auto id : filterViaBookDB(filter)) {
-    if(filter.accept(m_books.at(id))) {
-      result.push_back(id);
-    }
-  }
-  return result;
-}
-
-template<supportedListSortBy SORT>
-struct KEY_TYPE {
-  typedef std::string TYPE;
-};
-
-template<>
-struct KEY_TYPE<SIZE> {
-  typedef size_t TYPE;
-};
-
-template<supportedListSortBy sort>
-class Comparator {
-  private:
-    const Library* const lib;
-    const bool     ascending;
-
-    inline typename KEY_TYPE<sort>::TYPE get_key(const std::string& id);
-
-  public:
-    Comparator(const Library* lib, bool ascending) : lib(lib), ascending(ascending) {}
-    inline bool operator() (const std::string& id1, const std::string& id2) {
-      if (ascending) {
-        return get_key(id1) < get_key(id2);
-      } else {
-        return get_key(id2) < get_key(id1);
-      }
-    }
-};
-
-template<>
-std::string Comparator<TITLE>::get_key(const std::string& id)
-{
-  return lib->getBookById(id).getTitle();
-}
-
-template<>
-size_t Comparator<SIZE>::get_key(const std::string& id)
-{
-  return lib->getBookById(id).getSize();
-}
-
-template<>
-std::string Comparator<DATE>::get_key(const std::string& id)
-{
-  return lib->getBookById(id).getDate();
-}
-
-template<>
-std::string Comparator<CREATOR>::get_key(const std::string& id)
-{
-  return lib->getBookById(id).getCreator();
-}
-
-template<>
-std::string Comparator<PUBLISHER>::get_key(const std::string& id)
-{
-  return lib->getBookById(id).getPublisher();
-}
-
-void Library::sort(BookIdCollection& bookIds, supportedListSortBy sort, bool ascending) const
-{
-  switch(sort) {
-    case TITLE:
-      std::sort(bookIds.begin(), bookIds.end(), Comparator<TITLE>(this, ascending));
-      break;
-    case SIZE:
-      std::sort(bookIds.begin(), bookIds.end(), Comparator<SIZE>(this, ascending));
-      break;
-    case DATE:
-      std::sort(bookIds.begin(), bookIds.end(), Comparator<DATE>(this, ascending));
-      break;
-    case CREATOR:
-      std::sort(bookIds.begin(), bookIds.end(), Comparator<CREATOR>(this, ascending));
-      break;
-    case PUBLISHER:
-      std::sort(bookIds.begin(), bookIds.end(), Comparator<PUBLISHER>(this, ascending));
-      break;
-    default:
-      break;
-  }
-}
-
-
-Library::BookIdCollection Library::listBooksIds(
-    int mode,
-    supportedListSortBy sortBy,
-    const std::string& search,
-    const std::string& language,
-    const std::string& creator,
-    const std::string& publisher,
-    const std::vector<std::string>& tags,
-    size_t maxSize) const {
-
-  Filter _filter;
-  if (mode & LOCAL)
-    _filter.local(true);
-  if (mode & NOLOCAL)
-    _filter.local(false);
-  if (mode & VALID)
-    _filter.valid(true);
-  if (mode & NOVALID)
-    _filter.valid(false);
-  if (mode & REMOTE)
-    _filter.remote(true);
-  if (mode & NOREMOTE)
-    _filter.remote(false);
-  if (!tags.empty())
-    _filter.acceptTags(tags);
-  if (maxSize != 0)
-    _filter.maxSize(maxSize);
-  if (!language.empty())
-    _filter.lang(language);
-  if (!publisher.empty())
-    _filter.publisher(publisher);
-  if (!creator.empty())
-    _filter.creator(creator);
-  if (!search.empty())
-    _filter.query(search);
-
-  auto bookIds = filter(_filter);
-
-  sort(bookIds, sortBy, true);
-  return bookIds;
-}
-
-Filter::Filter()
-  : activeFilters(0),
-    _maxSize(0)
-{};
-
-#define FLAG(x) (1 << x)
-enum filterTypes {
-  NONE = 0,
-  _LOCAL = FLAG(0),
-  _REMOTE = FLAG(1),
-  _NOLOCAL = FLAG(2),
-  _NOREMOTE = FLAG(3),
-  _VALID = FLAG(4),
-  _NOVALID = FLAG(5),
-  ACCEPTTAGS = FLAG(6),
-  REJECTTAGS = FLAG(7),
-  LANG = FLAG(8),
-  _PUBLISHER = FLAG(9),
-  _CREATOR = FLAG(10),
-  MAXSIZE = FLAG(11),
-  QUERY = FLAG(12),
-  NAME = FLAG(13),
-  CATEGORY = FLAG(14),
-};
-
-Filter& Filter::local(bool accept)
-{
-  if (accept) {
-    activeFilters |= _LOCAL;
-    activeFilters &= ~_NOLOCAL;
-  } else {
-    activeFilters |= _NOLOCAL;
-    activeFilters &= ~_LOCAL;
-  }
-  return *this;
-}
-
-Filter& Filter::remote(bool accept)
-{
-  if (accept) {
-    activeFilters |= _REMOTE;
-    activeFilters &= ~_NOREMOTE;
-  } else {
-    activeFilters |= _NOREMOTE;
-    activeFilters &= ~_REMOTE;
-  }
-  return *this;
-}
-
-Filter& Filter::valid(bool accept)
-{
-  if (accept) {
-    activeFilters |= _VALID;
-    activeFilters &= ~_NOVALID;
-  } else {
-    activeFilters |= _NOVALID;
-    activeFilters &= ~_VALID;
-  }
-  return *this;
-}
-
-Filter& Filter::acceptTags(const Tags& tags)
-{
-  _acceptTags = tags;
-  activeFilters |= ACCEPTTAGS;
-  return *this;
-}
-
-Filter& Filter::rejectTags(const Tags& tags)
-{
-  _rejectTags = tags;
-  activeFilters |= REJECTTAGS;
-  return *this;
-}
-
-Filter& Filter::category(std::string category)
-{
-  _category = category;
-  activeFilters |= CATEGORY;
-  return *this;
-}
-
-Filter& Filter::lang(std::string lang)
-{
-  _lang = lang;
-  activeFilters |= LANG;
-  return *this;
-}
-
-Filter& Filter::publisher(std::string publisher)
-{
-  _publisher = publisher;
-  activeFilters |= _PUBLISHER;
-  return *this;
-}
-
-Filter& Filter::creator(std::string creator)
-{
-  _creator = creator;
-  activeFilters |= _CREATOR;
-  return *this;
-}
-
-Filter& Filter::maxSize(size_t maxSize)
-{
-  _maxSize = maxSize;
-  activeFilters |= MAXSIZE;
-  return *this;
-}
-
-Filter& Filter::query(std::string query, bool partial)
-{
-  _query = query;
-  _queryIsPartial = partial;
-  activeFilters |= QUERY;
-  return *this;
-}
-
-Filter& Filter::name(std::string name)
-{
-  _name = name;
-  activeFilters |= NAME;
-  return *this;
-}
-
-#define ACTIVE(X) (activeFilters & (X))
-#define FILTER(TAG, TEST) if (ACTIVE(TAG) && !(TEST)) { return false; }
-bool Filter::hasQuery() const
-{
-  return ACTIVE(QUERY);
-}
-
-bool Filter::hasName() const
-{
-  return ACTIVE(NAME);
-}
-
-bool Filter::hasCategory() const
-{
-  return ACTIVE(CATEGORY);
-}
-
-bool Filter::hasLang() const
-{
-  return ACTIVE(LANG);
-}
-
-bool Filter::hasPublisher() const
-{
-  return ACTIVE(_PUBLISHER);
-}
-
-bool Filter::hasCreator() const
-{
-  return ACTIVE(_CREATOR);
-}
-
-bool Filter::accept(const Book& book) const
-{
-  auto local = !book.getPath().empty();
-  FILTER(_LOCAL, local)
-  FILTER(_NOLOCAL, !local)
-
-  auto valid = book.isPathValid();
-  FILTER(_VALID, valid)
-  FILTER(_NOVALID, !valid)
-
-  auto remote = !book.getUrl().empty();
-  FILTER(_REMOTE, remote)
-  FILTER(_NOREMOTE, !remote)
-
-  FILTER(MAXSIZE, book.getSize() <= _maxSize)
-
+  /* otherwise */
+  this->books.push_back(book);
   return true;
 }
 
+bool Library::removeBookByIndex(const unsigned int bookIndex)
+{
+  books.erase(books.begin() + bookIndex);
+  return true;
+}
 }

src/libxml_dumper.cpp

@@ -1,142 +0,0 @@
-/*
- * 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.
- */
-
-#include "libxml_dumper.h"
-#include "book.h"
-
-#include "tools/base64.h"
-#include "tools/stringTools.h"
-#include "tools/otherTools.h"
-#include "tools/pathTools.h"
-
-namespace kiwix
-{
-/* Constructor */
-LibXMLDumper::LibXMLDumper(const Library* library)
-  : library(library)
-{
-}
-/* Destructor */
-LibXMLDumper::~LibXMLDumper()
-{
-}
-
-#define ADD_ATTRIBUTE(node, name, value) { (node).append_attribute((name)) = (value).c_str(); }
-#define ADD_ATTR_NOT_EMPTY(node, name, value) { if (!(value).empty()) ADD_ATTRIBUTE(node, name, value); }
-
-void LibXMLDumper::handleBook(Book book, pugi::xml_node root_node) {
-  if (book.readOnly())
-    return;
-
-  auto entry_node = root_node.append_child("book");
-  ADD_ATTRIBUTE(entry_node, "id", book.getId());
-
-  if (!book.getPath().empty()) {
-    ADD_ATTRIBUTE(entry_node, "path", computeRelativePath(baseDir, book.getPath()));
-  }
-
-  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.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());
-    ADD_ATTR_NOT_EMPTY(entry_node, "flavour", book.getFlavour());
-    ADD_ATTR_NOT_EMPTY(entry_node, "tags", book.getTags());
-    ADD_ATTR_NOT_EMPTY(entry_node, "faviconMimeType", book.getFaviconMimeType());
-    ADD_ATTR_NOT_EMPTY(entry_node, "faviconUrl", book.getFaviconUrl());
-    if (!book.getFavicon().empty())
-      ADD_ATTRIBUTE(entry_node, "favicon", base64_encode(book.getFavicon()));
-  } else {
-    ADD_ATTRIBUTE(entry_node, "origId", book.getOrigId());
-  }
-
-  ADD_ATTR_NOT_EMPTY(entry_node, "date", book.getDate());
-  ADD_ATTR_NOT_EMPTY(entry_node, "url", book.getUrl());
-
-  if (book.getArticleCount())
-    ADD_ATTRIBUTE(entry_node, "articleCount", to_string(book.getArticleCount()));
-
-  if (book.getMediaCount())
-    ADD_ATTRIBUTE(entry_node, "mediaCount", to_string(book.getMediaCount()));
-
-  if (book.getSize())
-    ADD_ATTRIBUTE(entry_node, "size", to_string(book.getSize()>>10));
-
-  ADD_ATTR_NOT_EMPTY(entry_node, "downloadId", book.getDownloadId());
-}
-
-#define ADD_TEXT_ENTRY(node, child, value) (node).append_child((child)).append_child(pugi::node_pcdata).set_value((value).c_str())
-
-void LibXMLDumper::handleBookmark(Bookmark bookmark, pugi::xml_node root_node) {
-
-  auto entry_node = root_node.append_child("bookmark");
-  auto book_node = entry_node.append_child("book");
-
-  try {
-    auto book = library->getBookById(bookmark.getBookId());
-    ADD_TEXT_ENTRY(book_node, "id", book.getId());
-    ADD_TEXT_ENTRY(book_node, "title", book.getTitle());
-    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, "language", bookmark.getLanguage());
-    ADD_TEXT_ENTRY(book_node, "date", bookmark.getDate());
-  }
-  ADD_TEXT_ENTRY(entry_node, "title", bookmark.getTitle());
-  ADD_TEXT_ENTRY(entry_node, "url", bookmark.getUrl());
-}
-
-
-std::string LibXMLDumper::dumpLibXMLContent(const std::vector<std::string>& bookIds)
-{
-  pugi::xml_document doc;
-
-  /* Add the library node */
-  pugi::xml_node libraryNode = doc.append_child("library");
-
-  libraryNode.append_attribute("version") = KIWIX_LIBRARY_VERSION;
-
-  if (library) {
-    for (auto& bookId: bookIds) {
-      handleBook(library->getBookById(bookId), libraryNode);
-    }
-  }
-  return nodeToString(libraryNode);
-}
-
-std::string LibXMLDumper::dumpLibXMLBookmark()
-{
-  pugi::xml_document doc;
-
-  /* Add the library node */
-  pugi::xml_node bookmarksNode = doc.append_child("bookmarks");
-
-  if (library) {
-    for (auto& bookmark: library->getBookmarks()) {
-      handleBookmark(bookmark, bookmarksNode);
-    }
-  }
-  return nodeToString(bookmarksNode);
-}
-
-}

src/manager.cpp

@@ -19,137 +19,105 @@
 
 #include "manager.h"
 
-#include "tools/pathTools.h"
-
-#include <pugixml.hpp>
-
 namespace kiwix
 {
 /* Constructor */
-Manager::Manager(LibraryManipulator* manipulator):
-  writableLibraryPath(""),
-  manipulator(manipulator),
-  mustDeleteManipulator(false)
+Manager::Manager() : writableLibraryPath("")
 {
 }
-
-Manager::Manager(Library* library) :
-  writableLibraryPath(""),
-  manipulator(new DefaultLibraryManipulator(library)),
-  mustDeleteManipulator(true)
-{
-}
-
 /* Destructor */
 Manager::~Manager()
 {
-  if (mustDeleteManipulator) {
-    delete manipulator;
-  }
 }
 bool Manager::parseXmlDom(const pugi::xml_document& doc,
-                          bool readOnly,
-                          const std::string& libraryPath,
-                          bool trustLibrary)
+                          const bool readOnly,
+                          const string libraryPath)
 {
   pugi::xml_node libraryNode = doc.child("library");
 
-  std::string libraryVersion = libraryNode.attribute("version").value();
+  if (strlen(libraryNode.attribute("current").value()))
+    this->setCurrentBookId(libraryNode.attribute("current").value());
+
+  string libraryVersion = libraryNode.attribute("version").value();
 
   for (pugi::xml_node bookNode = libraryNode.child("book"); bookNode;
        bookNode = bookNode.next_sibling("book")) {
+    bool ok = true;
     kiwix::Book book;
 
-    book.setReadOnly(readOnly);
-    book.updateFromXml(bookNode,
-                       removeLastPathElement(libraryPath));
+    book.readOnly = readOnly;
+    book.id = bookNode.attribute("id").value();
+    book.path = bookNode.attribute("path").value();
+    book.last = (std::string(bookNode.attribute("last").value()) != "undefined"
+                     ? bookNode.attribute("last").value()
+                     : "");
+    book.indexPath = bookNode.attribute("indexPath").value();
+    book.indexType = XAPIAN;
+    book.title = bookNode.attribute("title").value();
+    book.name = bookNode.attribute("name").value();
+    book.tags = bookNode.attribute("tags").value();
+    book.description = bookNode.attribute("description").value();
+    book.language = bookNode.attribute("language").value();
+    book.date = bookNode.attribute("date").value();
+    book.creator = bookNode.attribute("creator").value();
+    book.publisher = bookNode.attribute("publisher").value();
+    book.url = bookNode.attribute("url").value();
+    book.origId = bookNode.attribute("origId").value();
+    book.articleCount = bookNode.attribute("articleCount").value();
+    book.mediaCount = bookNode.attribute("mediaCount").value();
+    book.size = bookNode.attribute("size").value();
+    book.favicon = bookNode.attribute("favicon").value();
+    book.faviconMimeType = bookNode.attribute("faviconMimeType").value();
 
-    if (!trustLibrary && !book.getPath().empty()) {
-      this->readBookFromPath(book.getPath(), &book);
-    }
-    manipulator->addBookToLibrary(book);
-  }
-
-  return true;
-}
-
-bool Manager::readXml(const std::string& xml,
-                      bool readOnly,
-                      const std::string& libraryPath,
-                      bool trustLibrary)
-{
-  pugi::xml_document doc;
-  pugi::xml_parse_result result
-      = doc.load_buffer((void*)xml.data(), xml.size());
-
-  if (result) {
-    this->parseXmlDom(doc, readOnly, libraryPath, trustLibrary);
-  }
-
-  return true;
-}
-
-
-
-bool Manager::parseOpdsDom(const pugi::xml_document& doc, const std::string& urlHost)
-{
-  pugi::xml_node libraryNode = doc.child("feed");
-
-  try {
-    m_totalBooks = strtoull(libraryNode.child("totalResults").child_value(), 0, 0);
-    m_startIndex = strtoull(libraryNode.child("startIndex").child_value(), 0, 0);
-    m_itemsPerPage = strtoull(libraryNode.child("itemsPerPage").child_value(), 0, 0);
-    m_hasSearchResult = true;
-  } catch(...) {
-    m_hasSearchResult = false;
-  }
-
-  for (pugi::xml_node entryNode = libraryNode.child("entry"); entryNode;
-       entryNode = entryNode.next_sibling("entry")) {
-    kiwix::Book book;
-
-    book.setReadOnly(false);
-    book.updateFromOpds(entryNode, urlHost);
+    /* Check absolute and relative paths */
+    this->checkAndCleanBookPaths(book, libraryPath);
 
     /* Update the book properties with the new importer */
-    manipulator->addBookToLibrary(book);
+    if (libraryVersion.empty()
+        || atoi(libraryVersion.c_str()) <= atoi(KIWIX_LIBRARY_VERSION)) {
+      if (!book.path.empty()) {
+        ok = this->readBookFromPath(book.pathAbsolute);
+      }
+    }
+
+    if (ok) {
+      library.addBook(book);
+    }
   }
 
   return true;
 }
 
-
-
-bool Manager::readOpds(const std::string& content, const std::string& urlHost)
+bool Manager::readXml(const string xml,
+                      const bool readOnly,
+                      const string libraryPath)
 {
   pugi::xml_document doc;
   pugi::xml_parse_result result
-      = doc.load_buffer((void*)content.data(), content.size());
+      = doc.load_buffer_inplace((void*)xml.data(), xml.size());
 
   if (result) {
-    this->parseOpdsDom(doc, urlHost);
-    return true;
+    this->parseXmlDom(doc, readOnly, libraryPath);
   }
 
-  return false;
+  return true;
 }
 
-bool Manager::readFile(
-  const std::string& path,
-  bool readOnly,
-  bool trustLibrary)
+bool Manager::readFile(const string path, const bool readOnly)
+{
+  return this->readFile(path, path, readOnly);
+}
+
+bool Manager::readFile(const string nativePath,
+                       const string UTF8Path,
+                       const bool readOnly)
 {
   bool retVal = true;
   pugi::xml_document doc;
-
-#ifdef _WIN32
-  pugi::xml_parse_result result = doc.load_file(Utf8ToWide(path).c_str());
-#else
-  pugi::xml_parse_result result = doc.load_file(path.c_str());
-#endif
+  pugi::xml_parse_result result = doc.load_file(nativePath.c_str());
 
   if (result) {
-    this->parseXmlDom(doc, readOnly, path, trustLibrary);
+    this->parseXmlDom(doc, readOnly, UTF8Path);
   } else {
     retVal = false;
   }
@@ -158,37 +126,154 @@ bool Manager::readFile(
    * able to know where to save the library if new content are
    * available */
   if (!readOnly) {
-    this->writableLibraryPath = path;
+    this->writableLibraryPath = UTF8Path;
   }
 
   return retVal;
 }
 
+bool Manager::writeFile(const string path)
+{
+  pugi::xml_document doc;
+
+  /* Add the library node */
+  pugi::xml_node libraryNode = doc.append_child("library");
+
+  if (!getCurrentBookId().empty()) {
+    libraryNode.append_attribute("current") = getCurrentBookId().c_str();
+  }
+
+  if (!library.version.empty())
+    libraryNode.append_attribute("version") = library.version.c_str();
+
+  /* Add each book */
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (!itr->readOnly) {
+      this->checkAndCleanBookPaths(*itr, path);
+
+      pugi::xml_node bookNode = libraryNode.append_child("book");
+      bookNode.append_attribute("id") = itr->id.c_str();
+
+      if (!itr->path.empty()) {
+        bookNode.append_attribute("path") = itr->path.c_str();
+      }
+
+      if (!itr->last.empty() && itr->last != "undefined") {
+        bookNode.append_attribute("last") = itr->last.c_str();
+      }
+
+      if (!itr->indexPath.empty())
+        bookNode.append_attribute("indexPath") = itr->indexPath.c_str();
+
+      if (!itr->indexPath.empty() || !itr->indexPathAbsolute.empty()) {
+        if (itr->indexType == XAPIAN) {
+          bookNode.append_attribute("indexType") = "xapian";
+        }
+      }
+
+      if (itr->origId.empty()) {
+        if (!itr->title.empty())
+          bookNode.append_attribute("title") = itr->title.c_str();
+
+        if (!itr->name.empty())
+          bookNode.append_attribute("name") = itr->name.c_str();
+
+        if (!itr->tags.empty())
+          bookNode.append_attribute("tags") = itr->tags.c_str();
+
+        if (!itr->description.empty())
+          bookNode.append_attribute("description") = itr->description.c_str();
+
+        if (!itr->language.empty())
+          bookNode.append_attribute("language") = itr->language.c_str();
+
+        if (!itr->creator.empty())
+          bookNode.append_attribute("creator") = itr->creator.c_str();
+
+        if (!itr->publisher.empty())
+          bookNode.append_attribute("publisher") = itr->publisher.c_str();
+
+        if (!itr->favicon.empty())
+          bookNode.append_attribute("favicon") = itr->favicon.c_str();
+
+        if (!itr->faviconMimeType.empty())
+          bookNode.append_attribute("faviconMimeType")
+              = itr->faviconMimeType.c_str();
+      }
+
+      if (!itr->date.empty()) {
+        bookNode.append_attribute("date") = itr->date.c_str();
+      }
+
+      if (!itr->url.empty()) {
+        bookNode.append_attribute("url") = itr->url.c_str();
+      }
+
+      if (!itr->origId.empty())
+        bookNode.append_attribute("origId") = itr->origId.c_str();
+
+      if (!itr->articleCount.empty())
+        bookNode.append_attribute("articleCount") = itr->articleCount.c_str();
+
+      if (!itr->mediaCount.empty())
+        bookNode.append_attribute("mediaCount") = itr->mediaCount.c_str();
+
+      if (!itr->size.empty()) {
+        bookNode.append_attribute("size") = itr->size.c_str();
+      }
+    }
+  }
+
+  /* saving file */
+  doc.save_file(path.c_str());
+
+  return true;
+}
+
+bool Manager::setCurrentBookId(const string id)
+{
+  if (library.current.empty() || library.current.top() != id) {
+    if (id.empty() && !library.current.empty()) {
+      library.current.pop();
+    } else {
+      library.current.push(id);
+    }
+  }
+  return true;
+}
+
+string Manager::getCurrentBookId()
+{
+  return library.current.empty() ? "" : library.current.top();
+}
 
 /* Add a book to the library. Return empty string if failed, book id otherwise
  */
-std::string Manager::addBookFromPathAndGetId(const std::string& pathToOpen,
-                                             const std::string& pathToSave,
-                                             const std::string& url,
-                                             const bool checkMetaData)
+string Manager::addBookFromPathAndGetId(const string pathToOpen,
+                                        const string pathToSave,
+                                        const string url,
+                                        const bool checkMetaData)
 {
   kiwix::Book book;
 
   if (this->readBookFromPath(pathToOpen, &book)) {
-    if (!pathToSave.empty() && pathToSave != pathToOpen) {
-      book.setPath(isRelativePath(pathToSave)
+    if (pathToSave != pathToOpen) {
+      book.path = pathToSave;
+      book.pathAbsolute
+          = isRelativePath(pathToSave)
                 ? computeAbsolutePath(
-                      removeLastPathElement(writableLibraryPath),
+                      removeLastPathElement(writableLibraryPath, true, false),
                       pathToSave)
-                : pathToSave);
+                : pathToSave;
     }
 
     if (!checkMetaData
-        || (checkMetaData && !book.getTitle().empty() && !book.getLanguage().empty()
-            && !book.getDate().empty())) {
-      book.setUrl(url);
-      manipulator->addBookToLibrary(book);
-      return book.getId();
+        || (checkMetaData && !book.title.empty() && !book.language.empty()
+            && !book.date.empty())) {
+      book.url = url;
+      library.addBook(book);
+      return book.id;
     }
   }
 
@@ -197,9 +282,9 @@ std::string Manager::addBookFromPathAndGetId(const std::string& pathToOpen,
 
 /* Wrapper over Manager::addBookFromPath which return a bool instead of a string
  */
-bool Manager::addBookFromPath(const std::string& pathToOpen,
-                              const std::string& pathToSave,
-                              const std::string& url,
+bool Manager::addBookFromPath(const string pathToOpen,
+                              const string pathToSave,
+                              const string url,
                               const bool checkMetaData)
 {
   return !(
@@ -207,45 +292,367 @@ bool Manager::addBookFromPath(const std::string& pathToOpen,
           .empty());
 }
 
-bool Manager::readBookFromPath(const std::string& path, kiwix::Book* book)
+bool Manager::readBookFromPath(const string path, kiwix::Book* book)
 {
-  std::string tmp_path = path;
-  if (isRelativePath(path)) {
-    tmp_path = computeAbsolutePath(getCurrentDirectory(), path);
-  }
   try {
-    kiwix::Reader reader(tmp_path);
-    book->update(reader);
-    book->setPathValid(true);
+    kiwix::Reader* reader = new kiwix::Reader(path);
+
+    if (book != NULL) {
+      book->path = path;
+      book->pathAbsolute = path;
+      book->id = reader->getId();
+      book->description = reader->getDescription();
+      book->language = reader->getLanguage();
+      book->date = reader->getDate();
+      book->creator = reader->getCreator();
+      book->publisher = reader->getPublisher();
+      book->title = reader->getTitle();
+      book->name = reader->getName();
+      book->tags = reader->getTags();
+      book->origId = reader->getOrigId();
+      std::ostringstream articleCountStream;
+      articleCountStream << reader->getArticleCount();
+      book->articleCount = articleCountStream.str();
+
+      std::ostringstream mediaCountStream;
+      mediaCountStream << reader->getMediaCount();
+      book->mediaCount = mediaCountStream.str();
+
+      ostringstream convert;
+      convert << reader->getFileSize();
+      book->size = convert.str();
+
+      string favicon;
+      string faviconMimeType;
+      if (reader->getFavicon(favicon, faviconMimeType)) {
+        book->favicon = base64_encode(
+            reinterpret_cast<const unsigned char*>(favicon.c_str()),
+            favicon.length());
+        book->faviconMimeType = faviconMimeType;
+      }
+    }
+
+    delete reader;
   } catch (const std::exception& e) {
-    book->setPathValid(false);
+    std::cerr << e.what() << std::endl;
     return false;
   }
 
   return true;
 }
 
-bool Manager::readBookmarkFile(const std::string& path)
+bool Manager::removeBookByIndex(const unsigned int bookIndex)
 {
-  pugi::xml_document doc;
-  pugi::xml_parse_result result = doc.load_file(path.c_str());
+  return this->library.removeBookByIndex(bookIndex);
+}
 
-  if (!result) {
-    return false;
+bool Manager::removeBookById(const string id)
+{
+  unsigned int bookIndex = 0;
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (itr->id == id) {
+      return this->library.removeBookByIndex(bookIndex);
+    }
+    bookIndex++;
+  }
+  return false;
+}
+
+vector<string> Manager::getBooksLanguages()
+{
+  std::vector<string> booksLanguages;
+  std::vector<kiwix::Book>::iterator itr;
+  std::map<string, bool> booksLanguagesMap;
+
+  std::sort(
+      library.books.begin(), library.books.end(), kiwix::Book::sortByLanguage);
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (booksLanguagesMap.find(itr->language) == booksLanguagesMap.end()) {
+      if (itr->origId.empty()) {
+        booksLanguagesMap[itr->language] = true;
+        booksLanguages.push_back(itr->language);
+      }
+    }
   }
 
-  pugi::xml_node libraryNode = doc.child("bookmarks");
+  return booksLanguages;
+}
 
-  for (pugi::xml_node node = libraryNode.child("bookmark"); node;
-       node = node.next_sibling("bookmark")) {
-    kiwix::Bookmark bookmark;
+vector<string> Manager::getBooksCreators()
+{
+  std::vector<string> booksCreators;
+  std::vector<kiwix::Book>::iterator itr;
+  std::map<string, bool> booksCreatorsMap;
 
-    bookmark.updateFromXml(node);
+  std::sort(
+      library.books.begin(), library.books.end(), kiwix::Book::sortByCreator);
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (booksCreatorsMap.find(itr->creator) == booksCreatorsMap.end()) {
+      if (itr->origId.empty()) {
+        booksCreatorsMap[itr->creator] = true;
+        booksCreators.push_back(itr->creator);
+      }
+    }
+  }
 
-    manipulator->addBookmarkToLibrary(bookmark);
+  return booksCreators;
+}
+
+vector<string> Manager::getBooksIds()
+{
+  std::vector<string> booksIds;
+  std::vector<kiwix::Book>::iterator itr;
+
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    booksIds.push_back(itr->id);
+  }
+
+  return booksIds;
+}
+
+vector<string> Manager::getBooksPublishers()
+{
+  std::vector<string> booksPublishers;
+  std::vector<kiwix::Book>::iterator itr;
+  std::map<string, bool> booksPublishersMap;
+
+  std::sort(
+      library.books.begin(), library.books.end(), kiwix::Book::sortByPublisher);
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (booksPublishersMap.find(itr->publisher) == booksPublishersMap.end()) {
+      if (itr->origId.empty()) {
+        booksPublishersMap[itr->publisher] = true;
+        booksPublishers.push_back(itr->publisher);
+      }
+    }
+  }
+
+  return booksPublishers;
+}
+
+kiwix::Library Manager::cloneLibrary()
+{
+  return this->library;
+}
+bool Manager::getCurrentBook(Book& book)
+{
+  string currentBookId = getCurrentBookId();
+  if (currentBookId.empty()) {
+    return false;
+  } else {
+    getBookById(currentBookId, book);
+    return true;
+  }
+}
+
+bool Manager::getBookById(const string id, Book& book)
+{
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (itr->id == id) {
+      book = *itr;
+      return true;
+    }
+  }
+  return false;
+}
+
+bool Manager::updateBookLastOpenDateById(const string id)
+{
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (itr->id == id) {
+      char unixdate[12];
+      sprintf(unixdate, "%d", (int)time(NULL));
+      itr->last = unixdate;
+      return true;
+    }
+  }
+
+  return false;
+}
+
+bool Manager::setBookIndex(const string id,
+                           const string path,
+                           const supportedIndexType type)
+{
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (itr->id == id) {
+      itr->indexPath = path;
+      itr->indexPathAbsolute
+          = isRelativePath(path)
+                ? computeAbsolutePath(
+                      removeLastPathElement(writableLibraryPath, true, false),
+                      path)
+                : path;
+      itr->indexType = type;
+      return true;
+    }
+  }
+
+  return false;
+}
+
+bool Manager::setBookIndex(const string id, const string path)
+{
+  return this->setBookIndex(id, path, XAPIAN);
+}
+
+bool Manager::setBookPath(const string id, const string path)
+{
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if (itr->id == id) {
+      itr->path = path;
+      itr->pathAbsolute
+          = isRelativePath(path)
+                ? computeAbsolutePath(
+                      removeLastPathElement(writableLibraryPath, true, false),
+                      path)
+                : path;
+      return true;
+    }
+  }
+
+  return false;
+}
+
+void Manager::removeBookPaths()
+{
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    itr->path = "";
+    itr->pathAbsolute = "";
+  }
+}
+
+unsigned int Manager::getBookCount(const bool localBooks,
+                                   const bool remoteBooks)
+{
+  unsigned int result = 0;
+  std::vector<kiwix::Book>::iterator itr;
+  for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+    if ((!itr->path.empty() && localBooks)
+        || (itr->path.empty() && remoteBooks)) {
+      result++;
+    }
+  }
+  return result;
+}
+
+bool Manager::listBooks(const supportedListMode mode,
+                        const supportedListSortBy sortBy,
+                        const unsigned int maxSize,
+                        const string language,
+                        const string creator,
+                        const string publisher,
+                        const string search)
+{
+  this->bookIdList.clear();
+  std::vector<kiwix::Book>::iterator itr;
+
+  /* Sort */
+  if (sortBy == TITLE) {
+    std::sort(
+        library.books.begin(), library.books.end(), kiwix::Book::sortByTitle);
+  } else if (sortBy == SIZE) {
+    std::sort(
+        library.books.begin(), library.books.end(), kiwix::Book::sortBySize);
+  } else if (sortBy == DATE) {
+    std::sort(
+        library.books.begin(), library.books.end(), kiwix::Book::sortByDate);
+  } else if (sortBy == CREATOR) {
+    std::sort(
+        library.books.begin(), library.books.end(), kiwix::Book::sortByCreator);
+  } else if (sortBy == PUBLISHER) {
+    std::sort(library.books.begin(),
+              library.books.end(),
+              kiwix::Book::sortByPublisher);
+  }
+
+  /* Special sort for LASTOPEN */
+  if (mode == LASTOPEN) {
+    std::sort(library.books.begin(),
+              library.books.end(),
+              kiwix::Book::sortByLastOpen);
+    for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+      if (!itr->last.empty()) {
+        this->bookIdList.push_back(itr->id);
+      }
+    }
+  } else {
+    /* Generate the list of book id */
+    for (itr = library.books.begin(); itr != library.books.end(); ++itr) {
+      bool ok = true;
+
+      if (mode == LOCAL && itr->path.empty()) {
+        ok = false;
+      }
+
+      if (ok == true && mode == REMOTE
+          && (!itr->path.empty() || itr->url.empty())) {
+        ok = false;
+      }
+
+      if (ok == true && maxSize != 0
+          && (unsigned int)atoi(itr->size.c_str()) > maxSize * 1024 * 1024) {
+        ok = false;
+      }
+
+      if (ok == true && !language.empty()
+          && !matchRegex(itr->language, language)) {
+        ok = false;
+      }
+
+      if (ok == true && !creator.empty() && itr->creator != creator) {
+        ok = false;
+      }
+
+      if (ok == true && !publisher.empty() && itr->publisher != publisher) {
+        ok = false;
+      }
+
+      if ((ok == true && !search.empty())
+          && !(matchRegex(itr->title, "\\Q" + search + "\\E")
+               || matchRegex(itr->description, "\\Q" + search + "\\E")
+               || matchRegex(itr->language, "\\Q" + search + "\\E"))) {
+        ok = false;
+      }
+
+      if (ok == true) {
+        this->bookIdList.push_back(itr->id);
+      }
+    }
   }
 
   return true;
 }
 
+void Manager::checkAndCleanBookPaths(Book& book, const string& libraryPath)
+{
+  if (!book.path.empty()) {
+    if (isRelativePath(book.path)) {
+      book.pathAbsolute = computeAbsolutePath(
+          removeLastPathElement(libraryPath, true, false), book.path);
+    } else {
+      book.pathAbsolute = book.path;
+      book.path = computeRelativePath(
+          removeLastPathElement(libraryPath, true, false), book.pathAbsolute);
+    }
+  }
+
+  if (!book.indexPath.empty()) {
+    if (isRelativePath(book.indexPath)) {
+      book.indexPathAbsolute = computeAbsolutePath(
+          removeLastPathElement(libraryPath, true, false), book.indexPath);
+    } else {
+      book.indexPathAbsolute = book.indexPath;
+      book.indexPath
+          = computeRelativePath(removeLastPathElement(libraryPath, true, false),
+                                book.indexPathAbsolute);
+    }
+  }
+}
 }

src/meson.build

@@ -1,49 +1,33 @@
 kiwix_sources = [
-  'book.cpp',
-  'bookmark.cpp',
   'library.cpp',
   'manager.cpp',
-  'libxml_dumper.cpp',
-  'opds_dumper.cpp',
-  'downloader.cpp',
   'reader.cpp',
-  'entry.cpp',
-  'server.cpp',
   'searcher.cpp',
-  'search_renderer.cpp',
-  'subprocess.cpp',
-  'aria2.cpp',
-  'tools/base64.cpp',
-  'tools/pathTools.cpp',
-  'tools/regexTools.cpp',
-  'tools/stringTools.cpp',
-  'tools/networkTools.cpp',
-  'tools/otherTools.cpp',
-  'kiwixserve.cpp',
-  'name_mapper.cpp',
-  'server/byte_range.cpp',
-  'server/etag.cpp',
-  'server/request_context.cpp',
-  'server/response.cpp',
-  'server/internalServer.cpp',
-  'server/internalServer_catalog_v2.cpp'
+  'common/base64.cpp',
+  'common/pathTools.cpp',
+  'common/regexTools.cpp',
+  'common/stringTools.cpp',
+  'common/networkTools.cpp',
+  'common/otherTools.cpp',
+  'xapian/htmlparse.cc',
+  'xapian/myhtmlparse.cc'
 ]
 kiwix_sources += lib_resources
 
-if host_machine.system() == 'windows'
-  kiwix_sources += 'subprocess_windows.cpp'
-else
-  kiwix_sources += 'subprocess_unix.cpp'
+if xapian_dep.found()
+  kiwix_sources += ['xapianSearcher.cpp']
 endif
 
-if wrapper.contains('android')
+if get_option('android')
+  subdir('android')
   install_dir = 'kiwix-lib/jniLibs/' + meson.get_cross_property('android_abi')
 else
   install_dir = get_option('libdir')
 endif
 
-if wrapper.contains('android') or wrapper.contains('java')
-  subdir('wrapper/java')
+
+if has_ctpp2_dep
+  kiwix_sources += ['ctpp2/CTPP2VMStringLoader.cpp']
 endif
 
 config_h = configure_file(output : 'kiwix_config.h',
@@ -55,7 +39,6 @@ kiwixlib = library('kiwix',
                    kiwix_sources,
                    include_directories : inc,
                    dependencies : all_deps,
-                   link_args: extra_libs,
                    version: meson.project_version(),
                    install: true,
                    install_dir: install_dir)

src/name_mapper.cpp

@@ -1,62 +0,0 @@
-/*
- * Copyright 2019 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "name_mapper.h"
-#include "library.h"
-#include "tools/regexTools.h"
-#include <iostream>
-
-namespace kiwix {
-
-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;
-    m_nameToId[bookName] = bookId;
-
-    if (!withAlias)
-      continue;
-
-    auto aliasName = replaceRegex(bookName, "", "_[[:digit:]]{4}-[[:digit:]]{2}$");
-    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;
-    }
-  }
-}
-
-std::string HumanReadableNameMapper::getNameForId(const std::string& id) {
-  return m_idToName.at(id);
-}
-
-std::string HumanReadableNameMapper::getIdForName(const std::string& name) {
-  return m_nameToId.at(name);
-}
-
-}

src/opds_dumper.cpp

@@ -1,148 +0,0 @@
-/*
- * 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.
- */
-
-#include "opds_dumper.h"
-#include "book.h"
-
-#include "tools/otherTools.h"
-
-#include "kiwixlib-resources.h"
-#include <mustache.hpp>
-
-namespace kiwix
-{
-
-/* Constructor */
-OPDSDumper::OPDSDumper(Library* library)
-  : library(library)
-{
-}
-/* Destructor */
-OPDSDumper::~OPDSDumper()
-{
-}
-
-void OPDSDumper::setOpenSearchInfo(int totalResults, int startIndex, int count)
-{
-  m_totalResults = totalResults;
-  m_startIndex = startIndex,
-  m_count = count;
-}
-
-namespace
-{
-
-typedef kainjow::mustache::data MustacheData;
-typedef kainjow::mustache::list BookData;
-
-BookData getBookData(const Library* library, const std::vector<std::string>& bookIds)
-{
-  BookData bookData;
-  for ( const auto& bookId : bookIds ) {
-    const Book& book = library->getBookById(bookId);
-    const MustacheData bookUrl = book.getUrl().empty()
-                               ? MustacheData(false)
-                               : MustacheData(book.getUrl());
-    bookData.push_back(kainjow::mustache::object{
-      {"id", "urn:uuid:"+book.getId()},
-      {"name", book.getName()},
-      {"title", book.getTitle()},
-      {"description", book.getDescription()},
-      {"language", book.getLanguage()},
-      {"content_id",  book.getHumanReadableIdFromPath()},
-      {"updated", book.getDate() + "T00:00:00Z"},
-      {"category", book.getCategory()},
-      {"flavour", book.getFlavour()},
-      {"tags", book.getTags()},
-      {"article_count", to_string(book.getArticleCount())},
-      {"media_count", to_string(book.getMediaCount())},
-      {"author_name", book.getCreator()},
-      {"publisher_name", book.getPublisher()},
-      {"url", bookUrl},
-      {"size", to_string(book.getSize())},
-    });
-  }
-
-  return bookData;
-}
-
-} // unnamed namespace
-
-string OPDSDumper::dumpOPDSFeed(const std::vector<std::string>& bookIds, const std::string& query) const
-{
-  const auto bookData = getBookData(library, bookIds);
-  const kainjow::mustache::object template_data{
-     {"date", gen_date_str()},
-     {"root", rootLocation},
-     {"feed_id", gen_uuid(libraryId + "/catalog/search?"+query)},
-     {"filter", query.empty() ? MustacheData(false) : MustacheData(query)},
-     {"totalResults", to_string(m_totalResults)},
-     {"startIndex", to_string(m_startIndex)},
-     {"itemsPerPage", to_string(m_count)},
-     {"books", bookData }
-  };
-
-  return render_template(RESOURCE::templates::catalog_entries_xml, template_data);
-}
-
-string OPDSDumper::dumpOPDSFeedV2(const std::vector<std::string>& bookIds, const std::string& query) const
-{
-  const auto bookData = getBookData(library, bookIds);
-
-  const kainjow::mustache::object template_data{
-     {"date", gen_date_str()},
-     {"endpoint_root", rootLocation + "/catalog/v2"},
-     {"feed_id", gen_uuid(libraryId + "/entries?"+query)},
-     {"filter", query.empty() ? MustacheData(false) : MustacheData(query)},
-     {"query", query.empty() ? "" : "?" + urlEncode(query)},
-     {"totalResults", to_string(m_totalResults)},
-     {"startIndex", to_string(m_startIndex)},
-     {"itemsPerPage", to_string(m_count)},
-     {"books", bookData }
-  };
-
-  return render_template(RESOURCE::templates::catalog_v2_entries_xml, template_data);
-}
-
-std::string OPDSDumper::categoriesOPDSFeed(const std::vector<std::string>& categories) const
-{
-  const auto now = gen_date_str();
-  kainjow::mustache::list categoryData;
-  for ( const auto& category : categories ) {
-    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{
-               {"date", now},
-               {"endpoint_root", rootLocation + "/catalog/v2"},
-               {"feed_id", gen_uuid(libraryId + "/categories")},
-               {"categories", categoryData }
-             }
-  );
-}
-
-}

src/reader.cpp

@@ -21,10 +21,6 @@
 #include <time.h>
 
 #include <zim/search.h>
-#include <zim/item.h>
-#include <zim/error.h>
-
-#include "tools/otherTools.h"
 
 inline char hi(char v)
 {
@@ -67,9 +63,7 @@ std::string hexUUID(std::string in)
 namespace kiwix
 {
 /* Constructor */
-Reader::Reader(const string zimFilePath)
-  :  zimArchive(nullptr),
-     zimFilePath(zimFilePath)
+Reader::Reader(const string zimFilePath) : zimFileHandler(NULL)
 {
   string tmpZimFilePath = zimFilePath;
 
@@ -80,43 +74,62 @@ Reader::Reader(const string zimFilePath)
     tmpZimFilePath.resize(tmpZimFilePath.size() - 2);
   }
 
-  zimArchive.reset(new zim::Archive(tmpZimFilePath));
+  this->zimFileHandler = new zim::File(tmpZimFilePath);
 
-  /* initialize random seed: */
-  srand(time(nullptr));
-}
-
-#ifndef _WIN32
-Reader::Reader(int fd)
-  :  zimArchive(new zim::Archive(fd)),
-     zimFilePath("")
-{
-  /* initialize random seed: */
-  srand(time(nullptr));
-}
-
-Reader::Reader(int fd, zim::offset_type offset, zim::size_type size)
-  :  zimArchive(new zim::Archive(fd, offset, size)),
-     zimFilePath("")
-{
-  /* initialize random seed: */
-  srand(time(nullptr));
-}
-#endif // #ifndef _WIN32
-
-zim::Archive* Reader::getZimArchive() const
-{
-  return zimArchive.get();
-}
-
-MimeCounterType Reader::parseCounterMetadata() const
-{
-  try {
-    auto counterContent = zimArchive->getMetadata("Counter");
-    return parseMimetypeCounter(counterContent);
-  } catch (zim::EntryNotFound& e) {
-    return {};
+  if (this->zimFileHandler != NULL) {
+    this->firstArticleOffset
+        = this->zimFileHandler->getNamespaceBeginOffset('A');
+    this->lastArticleOffset = this->zimFileHandler->getNamespaceEndOffset('A');
+    this->currentArticleOffset = this->firstArticleOffset;
+    this->nsACount = this->zimFileHandler->getNamespaceCount('A');
+    this->nsICount = this->zimFileHandler->getNamespaceCount('I');
+    this->zimFilePath = zimFilePath;
   }
+
+  /* initialize random seed: */
+  srand(time(NULL));
+}
+
+/* Destructor */
+Reader::~Reader()
+{
+  if (this->zimFileHandler != NULL) {
+    delete this->zimFileHandler;
+  }
+}
+
+zim::File* Reader::getZimFileHandler() const
+{
+  return this->zimFileHandler;
+}
+/* Reset the cursor for GetNextArticle() */
+void Reader::reset()
+{
+  this->currentArticleOffset = this->firstArticleOffset;
+}
+std::map<const std::string, unsigned int> Reader::parseCounterMetadata() const
+{
+  std::map<const std::string, unsigned int> counters;
+  string mimeType, item, counterString;
+  unsigned int counter;
+
+  zim::Article article = this->zimFileHandler->getArticle('M', "Counter");
+
+  if (article.good()) {
+    stringstream ssContent(article.getData());
+
+    while (getline(ssContent, item, ';')) {
+      stringstream ssItem(item);
+      getline(ssItem, mimeType, '=');
+      getline(ssItem, counterString, '=');
+      if (!counterString.empty() && !mimeType.empty()) {
+        sscanf(counterString.c_str(), "%u", &counter);
+        counters.insert(pair<string, int>(mimeType, counter));
+      }
+    }
+  }
+
+  return counters;
 }
 
 /* Get the count of articles which can be indexed/displayed */
@@ -126,9 +139,12 @@ unsigned int Reader::getArticleCount() const
       = this->parseCounterMetadata();
   unsigned int counter = 0;
 
-  for(auto &pair:counterMap) {
-    if (startsWith(pair.first, "text/html")) {
-      counter += pair.second;
+  if (counterMap.empty()) {
+    counter = this->nsACount;
+  } else {
+    auto it = counterMap.find("text/html");
+    if (it != counterMap.end()) {
+      counter = it->second;
     }
   }
 
@@ -142,84 +158,139 @@ unsigned int Reader::getMediaCount() const
       = this->parseCounterMetadata();
   unsigned int counter = 0;
 
-  for (auto &pair:counterMap) {
-    if (startsWith(pair.first, "image/") ||
-        startsWith(pair.first, "video/") ||
-        startsWith(pair.first, "audio/")) {
-      counter += pair.second;
+  if (counterMap.empty()) {
+    counter = this->nsICount;
+  } else {
+    auto it = counterMap.find("image/jpeg");
+    if (it != counterMap.end()) {
+      counter += it->second;
+    }
+
+    it = counterMap.find("image/gif");
+    if (it != counterMap.end()) {
+      counter += it->second;
+    }
+
+    it = counterMap.find("image/png");
+    if (it != counterMap.end()) {
+      counter += it->second;
     }
   }
-
   return counter;
 }
 
 /* Get the total of all items of a ZIM file, redirects included */
 unsigned int Reader::getGlobalCount() const
 {
-  return zimArchive->getEntryCount();
+  return this->zimFileHandler->getCountArticles();
 }
 
 /* Return the UID of the ZIM file */
 string Reader::getId() const
 {
   std::ostringstream s;
-  s << zimArchive->getUuid();
+  s << this->zimFileHandler->getFileheader().getUuid();
   return s.str();
 }
 
-Entry Reader::getRandomPage() const
+/* Return a page url from a title */
+bool Reader::getPageUrlFromTitle(const string& title, string& url) const
 {
-  try {
-    return zimArchive->getRandomEntry();
-  } catch(...) {
-    throw NoEntry();
+  /* Extract the content from the zim file */
+  zim::Article article = this->zimFileHandler->getArticleByTitle('A', title);
+
+  if (!article.good()) {
+    return false;
   }
+
+  unsigned int loopCounter = 0;
+  while (article.isRedirect() && loopCounter++ < 42) {
+    article = article.getRedirectArticle();
+  }
+
+  url = article.getLongUrl();
+  return true;
 }
 
-Entry Reader::getMainPage() const
+/* Return an URL from a title */
+string Reader::getRandomPageUrl() const
 {
-  return zimArchive->getMainEntry();
+  zim::Article article;
+  zim::size_type idx;
+  std::string mainPageUrl = this->getMainPageUrl();
+
+  do {
+    idx = this->firstArticleOffset
+          + (zim::size_type)((double)rand() / ((double)RAND_MAX + 1)
+                             * this->nsACount);
+    article = zimFileHandler->getArticle(idx);
+  } while (article.getLongUrl() == mainPageUrl);
+
+  return article.getLongUrl();
+}
+
+/* Return the welcome page URL */
+string Reader::getMainPageUrl() const
+{
+  string url = "";
+
+  if (this->zimFileHandler->getFileheader().hasMainPage()) {
+    zim::Article article = zimFileHandler->getArticle(
+        this->zimFileHandler->getFileheader().getMainPage());
+    url = article.getLongUrl();
+
+    if (url.empty()) {
+      url = getFirstPageUrl();
+    }
+  } else {
+    url = getFirstPageUrl();
+  }
+
+  return url;
 }
 
 bool Reader::getFavicon(string& content, string& mimeType) const
 {
-  try {
-    auto item = zimArchive->getIllustrationItem();
-    content = item.getData();
-    mimeType = item.getMimetype();
-    return true;
-  } catch(zim::EntryNotFound& e) {};
+  unsigned int contentLength = 0;
+  string title;
 
-  return false;
+  this->getContentByUrl("/-/favicon.png", content, title, contentLength, mimeType);
+
+  if (content.empty()) {
+    this->getContentByUrl("/I/favicon.png", content, title, contentLength, mimeType);
+
+    if (content.empty()) {
+      this->getContentByUrl("/I/favicon", content, title, contentLength, mimeType);
+
+      if (content.empty()) {
+        this->getContentByUrl("/-/favicon", content, title, contentLength, mimeType);
+      }
+    }
+  }
+
+  return content.empty() ? false : true;
 }
 
 string Reader::getZimFilePath() const
 {
-  return zimFilePath;
+  return this->zimFilePath;
 }
 /* Return a metatag value */
-bool Reader::getMetadata(const string& name, string& value) const
+bool Reader::getMetatag(const string& name, string& value) const
 {
-  try {
-    value = zimArchive->getMetadata(name);
-    return true;
-  } catch(zim::EntryNotFound& e) {
-    return false;
-  }
-}
+  unsigned int contentLength = 0;
+  string contentType = "";
+  string title;
 
-#define METADATA(NAME) std::string v; getMetadata(NAME, v); return v;
-
-string Reader::getName() const
-{
-  METADATA("Name")
+  return this->getContentByUrl("/M/" + name, value, title, contentLength, contentType);
 }
 
 string Reader::getTitle() const
 {
-  string value = zimArchive->getMetadata("Title");
+  string value;
+  this->getMetatag("Title", value);
   if (value.empty()) {
-    value = getLastPathElement(zimFilePath);
+    value = getLastPathElement(zimFileHandler->getFilename());
     std::replace(value.begin(), value.end(), '_', ' ');
     size_t pos = value.find(".zim");
     value = value.substr(0, pos);
@@ -227,98 +298,65 @@ string Reader::getTitle() const
   return value;
 }
 
-string Reader::getCreator() const
+string Reader::getName() const
 {
-  METADATA("Creator")
+  string value;
+  this->getMetatag("Name", value);
+  return value;
 }
 
-string Reader::getPublisher() const
+string Reader::getTags() const
 {
-  METADATA("Publisher")
-}
-
-string Reader::getDate() const
-{
-  METADATA("Date")
+  string value;
+  this->getMetatag("Tags", value);
+  return value;
 }
 
 string Reader::getDescription() const
 {
   string value;
-  this->getMetadata("Description", value);
+  this->getMetatag("Description", value);
 
   /* Mediawiki Collection tends to use the "Subtitle" name */
   if (value.empty()) {
-    this->getMetadata("Subtitle", value);
+    this->getMetatag("Subtitle", value);
   }
 
   return value;
 }
 
-string Reader::getLongDescription() const
-{
-  METADATA("LongDescription")
-}
-
 string Reader::getLanguage() const
 {
-  METADATA("Language")
+  string value;
+  this->getMetatag("Language", value);
+  return value;
 }
 
-string Reader::getLicense() const
+string Reader::getDate() const
 {
-  METADATA("License")
+  string value;
+  this->getMetatag("Date", value);
+  return value;
 }
 
-string Reader::getTags(bool original) const
+string Reader::getCreator() const
 {
-  string tags_str;
-  getMetadata("Tags", tags_str);
-  if (original) {
-    return tags_str;
-  }
-  auto tags = convertTags(tags_str);
-  return join(tags, ";");
+  string value;
+  this->getMetatag("Creator", value);
+  return value;
 }
 
-
-string Reader::getTagStr(const std::string& tagName) const
+string Reader::getPublisher() const
 {
-  string tags_str;
-  getMetadata("Tags", tags_str);
-  return getTagValueFromTagList(convertTags(tags_str), tagName);
+  string value;
+  this->getMetatag("Publisher", value);
+  return value;
 }
 
-bool Reader::getTagBool(const std::string& tagName) const
-{
-  return convertStrToBool(getTagStr(tagName));
-}
-
-string Reader::getRelation() const
-{
-  METADATA("Relation")
-}
-
-string Reader::getFlavour() const
-{
-  METADATA("Flavour")
-}
-
-string Reader::getSource() const
-{
-  METADATA("Source")
-}
-
-string Reader::getScraper() const
-{
-  METADATA("Scraper")
-}
-#undef METADATA
-
 string Reader::getOrigId() const
 {
   string value;
-  this->getMetadata("startfileuid", value);
+  this->getMetatag("startfileuid", value);
   if (value.empty()) {
     return "";
   }
@@ -340,50 +378,229 @@ string Reader::getOrigId() const
   return origID;
 }
 
-Entry Reader::getEntryFromPath(const std::string& path) const
+/* Return the first page URL */
+string Reader::getFirstPageUrl() const
 {
-  if (path.empty() || path == "/") {
-    return getMainPage();
+  zim::size_type firstPageOffset = zimFileHandler->getNamespaceBeginOffset('A');
+  zim::Article article = zimFileHandler->getArticle(firstPageOffset);
+  return article.getLongUrl();
+}
+
+bool Reader::parseUrl(const string& url, char* ns, string& title) const
+{
+  /* Offset to visit the url */
+  unsigned int urlLength = url.size();
+  unsigned int offset = 0;
+
+  /* Ignore the '/' */
+  while ((offset < urlLength) && (url[offset] == '/')) {
+    offset++;
   }
 
-  try {
-    return zimArchive->getEntryByPath(path);
-  } catch (zim::EntryNotFound& e) {
-    throw NoEntry();
+  /* Get namespace */
+  while ((offset < urlLength) && (url[offset] != '/')) {
+    *ns = url[offset];
+    offset++;
+  }
+
+  /* Ignore the '/' */
+  while ((offset < urlLength) && (url[offset] == '/')) {
+    offset++;
+  }
+
+  /* Get content title */
+  unsigned int titleOffset = offset;
+  while (offset < urlLength) {
+    offset++;
+  }
+
+  /* unescape title */
+  title = url.substr(titleOffset, offset - titleOffset);
+
+  return true;
+}
+
+/* Return article by url */
+bool Reader::getArticleObjectByDecodedUrl(const string& url,
+                                          zim::Article& article) const
+{
+  if (this->zimFileHandler == NULL) {
+    return false;
+  }
+
+  /* Parse the url */
+  char ns = 0;
+  string urlStr;
+  this->parseUrl(url, &ns, urlStr);
+
+  /* Main page */
+  if (urlStr.empty() && ns == 0) {
+    this->parseUrl(this->getMainPageUrl(), &ns, urlStr);
+  }
+
+  /* Extract the content from the zim file */
+  article = zimFileHandler->getArticle(ns, urlStr);
+  return article.good();
+}
+
+/* Return the mimeType without the content */
+bool Reader::getMimeTypeByUrl(const string& url, string& mimeType) const
+{
+  if (this->zimFileHandler == NULL) {
+    return false;
+  }
+
+  zim::Article article;
+  if (this->getArticleObjectByDecodedUrl(url, article)) {
+    try {
+      mimeType = article.getMimeType();
+    } catch (exception& e) {
+      cerr << "Unable to get the mimetype for " << url << ":" << e.what()
+           << endl;
+      mimeType = "application/octet-stream";
+    }
+    return true;
+  } else {
+    mimeType = "";
+    return false;
   }
 }
 
-Entry Reader::getEntryFromEncodedPath(const std::string& path) const
+/* Get a content from a zim file */
+bool Reader::getContentByUrl(const string& url,
+                             string& content,
+                             string& title,
+                             unsigned int& contentLength,
+                             string& contentType) const
 {
-  return getEntryFromPath(urlDecode(path, true));
+  return this->getContentByEncodedUrl(url, content, title, contentLength, contentType);
 }
 
-Entry Reader::getEntryFromTitle(const std::string& title) const
+bool Reader::getContentByEncodedUrl(const string& url,
+                                    string& content,
+                                    string& title,
+                                    unsigned int& contentLength,
+                                    string& contentType,
+                                    string& baseUrl) const
 {
-  try {
-    return zimArchive->getEntryByTitle(title);
-  } catch(zim::EntryNotFound& e) {
-    throw NoEntry();
+  return this->getContentByDecodedUrl(
+      kiwix::urlDecode(url), content, title, contentLength, contentType, baseUrl);
+}
+
+bool Reader::getContentByEncodedUrl(const string& url,
+                                    string& content,
+                                    string& title,
+                                    unsigned int& contentLength,
+                                    string& contentType) const
+{
+  std::string stubRedirectUrl;
+  return this->getContentByEncodedUrl(kiwix::urlDecode(url),
+                                      content,
+                                      title,
+                                      contentLength,
+                                      contentType,
+                                      stubRedirectUrl);
+}
+
+bool Reader::getContentByDecodedUrl(const string& url,
+                                    string& content,
+                                    string& title,
+                                    unsigned int& contentLength,
+                                    string& contentType) const
+{
+  std::string stubRedirectUrl;
+  return this->getContentByDecodedUrl(kiwix::urlDecode(url),
+                                      content,
+                                      title,
+                                      contentLength,
+                                      contentType,
+                                      stubRedirectUrl);
+}
+
+bool Reader::getContentByDecodedUrl(const string& url,
+                                    string& content,
+                                    string& title,
+                                    unsigned int& contentLength,
+                                    string& contentType,
+                                    string& baseUrl) const
+{
+  content = "";
+  contentType = "";
+  contentLength = 0;
+
+  zim::Article article;
+  if (!this->getArticleObjectByDecodedUrl(url, article)) {
+    return false;
   }
+
+  /* If redirect */
+  unsigned int loopCounter = 0;
+  while (article.isRedirect() && loopCounter++ < 42) {
+    article = article.getRedirectArticle();
+  }
+
+  if (loopCounter < 42) {
+    /* Compute base url (might be different from the url if redirects */
+    baseUrl
+        = "/" + std::string(1, article.getNamespace()) + "/" + article.getUrl();
+
+    /* Get the content mime-type */
+    try {
+      contentType
+          = string(article.getMimeType().data(), article.getMimeType().size());
+    } catch (exception& e) {
+      cerr << "Unable to get the mimetype for " << baseUrl << ":" << e.what()
+           << endl;
+      contentType = "application/octet-stream";
+    }
+
+    /* Get the data */
+    content = string(article.getData().data(), article.getArticleSize());
+    title = article.getTitle();
+  }
+
+  /* Try to set a stub HTML header/footer if necesssary */
+  if (contentType.find("text/html") != string::npos
+      && content.find("<body") == std::string::npos
+      && content.find("<BODY") == std::string::npos) {
+    content = "<html><head><title>" + article.getTitle() +
+              "</title><meta http-equiv=\"Content-Type\" content=\"text/html; "
+              "charset=utf-8\" /></head><body>" +
+              content + "</body></html>";
+  }
+
+  /* Get the data length */
+  contentLength = article.getArticleSize();
+
+  return true;
 }
 
-bool Reader::pathExists(const string& path) const
+/* Check if an article exists */
+bool Reader::urlExists(const string& url) const
 {
-  return zimArchive->hasEntryByPath(path);
+  char ns = 0;
+  string titleStr;
+  this->parseUrl(url, &ns, titleStr);
+  titleStr = "/" + titleStr;
+  zim::File::const_iterator findItr = zimFileHandler->find(ns, titleStr);
+  return findItr != zimFileHandler->end() && findItr->getUrl() == titleStr;
 }
 
 /* Does the ZIM file has a fulltext index */
 bool Reader::hasFulltextIndex() const
 {
-  return zimArchive->hasFulltextIndex();
+  return ( this->urlExists("/Z/fulltextIndex/xapian")
+        && !zimFileHandler->is_multiPart() );
 }
 
 /* Search titles by prefix */
-
 bool Reader::searchSuggestions(const string& prefix,
                                unsigned int suggestionsCount,
                                const bool reset)
 {
+  bool retVal = false;
+  zim::File::const_iterator articleItr;
+
   /* Reset the suggestions otherwise check if the suggestions number is less
    * than the suggestionsCount */
   if (reset) {
@@ -395,48 +612,39 @@ bool Reader::searchSuggestions(const string& prefix,
     }
   }
 
-  auto ret =  searchSuggestions(prefix, suggestionsCount, this->suggestions);
-
-  /* Set the cursor to the begining */
-  this->suggestionsOffset = this->suggestions.begin();
-
-  return ret;
-}
-
-
-bool Reader::searchSuggestions(const string& prefix,
-                               unsigned int suggestionsCount,
-                               SuggestionsList_t& results)
-{
-  bool retVal = false;
-
   /* Return if no prefix */
   if (prefix.size() == 0) {
     return false;
   }
 
-  for (auto& entry: zimArchive->findByTitle(prefix)) {
-    if (results.size() >= suggestionsCount) {
-      break;
-    }
+  for (articleItr = zimFileHandler->findByTitle('A', prefix);
+       articleItr != zimFileHandler->end()
+       && articleItr->getTitle().compare(0, prefix.size(), prefix) == 0
+       && this->suggestions.size() < suggestionsCount;
+       ++articleItr) {
     /* Extract the interesting part of article title & url */
     std::string normalizedArticleTitle
-        = kiwix::normalize(entry.getTitle());
-
-    // Get the final path.
-    auto item = entry.getItem(true);
-    std::string articleFinalUrl = item.getPath();
+        = kiwix::normalize(articleItr->getTitle());
+    std::string articleFinalUrl = "/A/" + articleItr->getUrl();
+    if (articleItr->isRedirect()) {
+      zim::Article article = *articleItr;
+      unsigned int loopCounter = 0;
+      while (article.isRedirect() && loopCounter++ < 42) {
+        article = article.getRedirectArticle();
+      }
+      articleFinalUrl = "/A/" + article.getUrl();
+    }
 
     /* Go through all already found suggestions and skip if this
        article is already in the suggestions list (with an other
        title) */
     bool insert = true;
-    std::vector<SuggestionItem>::iterator suggestionItr;
-    for (suggestionItr = results.begin();
-         suggestionItr != results.end();
+    std::vector<std::vector<std::string>>::iterator suggestionItr;
+    for (suggestionItr = this->suggestions.begin();
+         suggestionItr != this->suggestions.end();
          suggestionItr++) {
-      int result = normalizedArticleTitle.compare((*suggestionItr).getNormalizedTitle());
-      if (result == 0 && articleFinalUrl.compare((*suggestionItr).getPath()) == 0) {
+      int result = normalizedArticleTitle.compare((*suggestionItr)[2]);
+      if (result == 0 && articleFinalUrl.compare((*suggestionItr)[1]) == 0) {
         insert = false;
         break;
       } else if (result < 0) {
@@ -446,14 +654,20 @@ bool Reader::searchSuggestions(const string& prefix,
 
     /* Insert if possible */
     if (insert) {
-      SuggestionItem suggestion(entry.getTitle(), normalizedArticleTitle, articleFinalUrl);
-      results.insert(suggestionItr, suggestion);
+      std::vector<std::string> suggestion;
+      suggestion.push_back(articleItr->getTitle());
+      suggestion.push_back(articleFinalUrl);
+      suggestion.push_back(normalizedArticleTitle);
+      this->suggestions.insert(suggestionItr, suggestion);
     }
 
     /* Suggestions where found */
     retVal = true;
   }
 
+  /* Set the cursor to the begining */
+  this->suggestionsOffset = this->suggestions.begin();
+
   return retVal;
 }
 
@@ -468,50 +682,36 @@ std::vector<std::string> Reader::getTitleVariants(
   return variants;
 }
 
-
+/* Try also a few variations of the prefix to have better results */
 bool Reader::searchSuggestionsSmart(const string& prefix,
                                     unsigned int suggestionsCount)
 {
+  std::vector<std::string> variants = this->getTitleVariants(prefix);
+  bool retVal;
+
   this->suggestions.clear();
   this->suggestionsOffset = this->suggestions.begin();
-
-  auto ret = searchSuggestionsSmart(prefix, suggestionsCount, this->suggestions);
-
-  this->suggestionsOffset = this->suggestions.begin();
-
-  return ret;
-}
-
-/* Try also a few variations of the prefix to have better results */
-bool Reader::searchSuggestionsSmart(const string& prefix,
-                                    unsigned int suggestionsCount,
-                                    SuggestionsList_t& results)
-{
-  std::vector<std::string> variants = this->getTitleVariants(prefix);
-  bool retVal = false;
-
   /* Try to search in the title using fulltext search database */
+  const zim::Search* suggestionSearch
+      = this->getZimFileHandler()->suggestions(prefix, 0, suggestionsCount);
 
-  auto suggestionSearcher = zim::Searcher(*zimArchive);
-  zim::Query suggestionQuery;
-  suggestionQuery.setQuery(prefix, true);
-  auto suggestionSearch = suggestionSearcher.search(suggestionQuery);
-
-  if (suggestionSearch.getEstimatedMatches()) {
-    const auto suggestions = suggestionSearch.getResults(0, suggestionsCount);
-    for (auto current = suggestions.begin();
-         current != suggestions.end();
+  if (suggestionSearch->get_matches_estimated()) {
+    for (auto current = suggestionSearch->begin();
+         current != suggestionSearch->end();
          current++) {
-      SuggestionItem suggestion(current.getTitle(), kiwix::normalize(current.getTitle()),
-                                current.getPath(), current.getSnippet());
-      results.push_back(suggestion);
+      std::vector<std::string> suggestion;
+      suggestion.push_back(current->getTitle());
+      suggestion.push_back("/A/" + current->getUrl());
+      suggestion.push_back(kiwix::normalize(current->getTitle()));
+      this->suggestions.push_back(suggestion);
     }
+    this->suggestionsOffset = this->suggestions.begin();
     retVal = true;
   } else {
     for (std::vector<std::string>::iterator variantsItr = variants.begin();
          variantsItr != variants.end();
          variantsItr++) {
-      retVal = this->searchSuggestions(*variantsItr, suggestionsCount, results)
+      retVal = this->searchSuggestions(*variantsItr, suggestionsCount, false)
                || retVal;
     }
   }
@@ -524,7 +724,7 @@ bool Reader::getNextSuggestion(string& title)
 {
   if (this->suggestionsOffset != this->suggestions.end()) {
     /* title */
-    title = (*(this->suggestionsOffset)).getTitle();
+    title = (*(this->suggestionsOffset))[0];
 
     /* increment the cursor for the next call */
     this->suggestionsOffset++;
@@ -539,8 +739,8 @@ bool Reader::getNextSuggestion(string& title, string& url)
 {
   if (this->suggestionsOffset != this->suggestions.end()) {
     /* title */
-    title = (*(this->suggestionsOffset)).getTitle();
-    url = (*(this->suggestionsOffset)).getPath();
+    title = (*(this->suggestionsOffset))[0];
+    url = (*(this->suggestionsOffset))[1];
 
     /* increment the cursor for the next call */
     this->suggestionsOffset++;
@@ -554,14 +754,14 @@ bool Reader::getNextSuggestion(string& title, string& url)
 /* Check if the file has as checksum */
 bool Reader::canCheckIntegrity() const
 {
-  return zimArchive->hasChecksum();
+  return this->zimFileHandler->getChecksum() != "";
 }
 
 /* Return true if corrupted, false otherwise */
 bool Reader::isCorrupted() const
 {
   try {
-    if (zimArchive->check() == true) {
+    if (this->zimFileHandler->verify() == true) {
       return false;
     }
   } catch (exception& e) {
@@ -575,7 +775,13 @@ bool Reader::isCorrupted() const
 /* Return the file size, works also for splitted files */
 unsigned int Reader::getFileSize() const
 {
-  return zimArchive->getFilesize() / 1024;
-}
+  zim::File* file = this->getZimFileHandler();
+  zim::offset_type size = 0;
 
+  if (file != NULL) {
+    size = file->getFilesize();
+  }
+
+  return (size / 1024);
+}
 }

src/search_renderer.cpp

@@ -1,149 +0,0 @@
-/*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include <cmath>
-
-#include "search_renderer.h"
-#include "searcher.h"
-#include "reader.h"
-#include "library.h"
-#include "name_mapper.h"
-
-#include <zim/search.h>
-
-#include <mustache.hpp>
-#include "kiwixlib-resources.h"
-
-
-namespace kiwix
-{
-
-/* Constructor */
-SearchRenderer::SearchRenderer(Searcher* searcher, NameMapper* mapper)
-    : mp_searcher(searcher),
-      mp_nameMapper(mapper),
-      protocolPrefix("zim://"),
-      searchProtocolPrefix("search://?")
-{}
-
-/* Destructor */
-SearchRenderer::~SearchRenderer() = default;
-
-void SearchRenderer::setSearchPattern(const std::string& pattern)
-{
-  this->searchPattern = pattern;
-}
-
-void SearchRenderer::setSearchContent(const std::string& name)
-{
-  this->searchContent = name;
-}
-
-void SearchRenderer::setProtocolPrefix(const std::string& prefix)
-{
-  this->protocolPrefix = prefix;
-}
-
-void SearchRenderer::setSearchProtocolPrefix(const std::string& prefix)
-{
-  this->searchProtocolPrefix = prefix;
-}
-
-std::string SearchRenderer::getHtml()
-{
-  kainjow::mustache::data results{kainjow::mustache::data::type::list};
-
-  mp_searcher->restart_search();
-  Result* p_result = NULL;
-  while ((p_result = mp_searcher->getNextResult())) {
-    kainjow::mustache::data result;
-    result.set("title", p_result->get_title());
-    result.set("url", p_result->get_url());
-    result.set("snippet", p_result->get_snippet());
-    result.set("resultContentId", mp_nameMapper->getNameForId(p_result->get_zimId()));
-
-    if (p_result->get_wordCount() >= 0) {
-      result.set("wordCount", kiwix::beautifyInteger(p_result->get_wordCount()));
-    }
-
-    results.push_back(result);
-    delete p_result;
-  }
-
-  // pages
-  kainjow::mustache::data pages{kainjow::mustache::data::type::list};
-
-  auto resultStart = mp_searcher->getResultStart();
-  auto resultEnd = 0U;
-  auto estimatedResultCount = mp_searcher->getEstimatedResultCount();
-  auto currentPage = 0U;
-  auto pageStart = 0U;
-  auto pageEnd = 0U;
-  auto lastPageStart = 0U;
-  if (pageLength) {
-    currentPage = resultStart/pageLength;
-    pageStart = currentPage > 4 ? currentPage-4 : 0;
-    pageEnd = currentPage + 5;
-    if (pageEnd > estimatedResultCount / pageLength) {
-      pageEnd = (estimatedResultCount + pageLength - 1) / pageLength;
-    }
-    if (estimatedResultCount > pageLength) {
-      lastPageStart = ((estimatedResultCount-1)/pageLength)*pageLength;
-    }
-  }
-
-  resultEnd = resultStart+pageLength; //setting result end
-
-  for (unsigned int i = pageStart; i < pageEnd; i++) {
-    kainjow::mustache::data page;
-    page.set("label", to_string(i + 1));
-    page.set("start", to_string(i * pageLength));
-
-    if (i == currentPage) {
-      page.set("selected", true);
-    }
-    pages.push_back(page);
-  }
-
-  std::string template_str = RESOURCE::templates::search_result_html;
-  kainjow::mustache::mustache tmpl(template_str);
-
-  kainjow::mustache::data allData;
-  allData.set("results", results);
-  allData.set("pages", pages);
-  allData.set("hasResults", estimatedResultCount != 0);
-  allData.set("hasPages", pageStart != pageEnd);
-  allData.set("count", kiwix::beautifyInteger(estimatedResultCount));
-  allData.set("searchPattern", kiwix::encodeDiples(this->searchPattern));
-  allData.set("searchPatternEncoded", urlEncode(this->searchPattern));
-  allData.set("resultStart", to_string(resultStart + 1));
-  allData.set("resultEnd", to_string(min(resultEnd, estimatedResultCount)));
-  allData.set("pageLength", to_string(pageLength));
-  allData.set("resultLastPageStart", to_string(lastPageStart));
-  allData.set("protocolPrefix", this->protocolPrefix);
-  allData.set("searchProtocolPrefix", this->searchProtocolPrefix);
-  allData.set("contentId", this->searchContent);
-
-  std::stringstream ss;
-  tmpl.render(allData, [&ss](const std::string& str) { ss << str; });
-  return ss.str();
-}
-
-}

src/searcher.cpp

@@ -17,25 +17,28 @@
  * MA 02110-1301, USA.
  */
 
-
-#include <cmath>
-
 #include "searcher.h"
+#include "kiwixlib-resources.h"
 #include "reader.h"
+#include "xapianSearcher.h"
 
 #include <zim/search.h>
 
-#include <mustache.hpp>
-#include "kiwixlib-resources.h"
+#ifdef ENABLE_CTPP2
+#include <ctpp2/CDT.hpp>
+#include <ctpp2/CTPP2FileLogger.hpp>
+#include <ctpp2/CTPP2SimpleVM.hpp>
+#include "ctpp2/CTPP2VMStringLoader.hpp"
 
-#define MAX_SEARCH_LEN 140
+using namespace CTPP;
+#endif
 
 namespace kiwix
 {
 class _Result : public Result
 {
  public:
-  _Result(zim::SearchResultSet::iterator iterator);
+  _Result(Searcher* searcher, zim::Search::iterator& iterator);
   virtual ~_Result(){};
 
   virtual std::string get_url();
@@ -45,25 +48,57 @@ class _Result : public Result
   virtual std::string get_content();
   virtual int get_wordCount();
   virtual int get_size();
-  virtual std::string get_zimId();
+  virtual int get_readerIndex();
 
  private:
-  zim::SearchResultSet::iterator iterator;
+  Searcher* searcher;
+  zim::Search::iterator iterator;
 };
 
-struct SearcherInternal : zim::SearchResultSet {
-  explicit SearcherInternal(const zim::SearchResultSet& srs)
-    : zim::SearchResultSet(srs)
-    , current_iterator(srs.begin())
-  {
-  }
+struct SearcherInternal {
+  const zim::Search* _search;
+  XapianSearcher* _xapianSearcher;
+  zim::Search::iterator current_iterator;
 
-  zim::SearchResultSet::iterator current_iterator;
+  SearcherInternal() : _search(NULL), _xapianSearcher(NULL) {}
+  ~SearcherInternal()
+  {
+    if (_search != NULL) {
+      delete _search;
+    }
+    if (_xapianSearcher != NULL) {
+      delete _xapianSearcher;
+    }
+  }
 };
 
 /* Constructor */
+Searcher::Searcher(const string& xapianDirectoryPath,
+                   Reader* reader,
+                   const string& humanReadableName)
+    : internal(new SearcherInternal()),
+      searchPattern(""),
+      protocolPrefix("zim://"),
+      searchProtocolPrefix("search://?"),
+      resultCountPerPage(0),
+      estimatedResultCount(0),
+      resultStart(0),
+      resultEnd(0)
+{
+  loadICUExternalTables();
+  if (!reader || !reader->hasFulltextIndex()) {
+    internal->_xapianSearcher = new XapianSearcher(xapianDirectoryPath, reader);
+  }
+  this->contentHumanReadableId = humanReadableName;
+  this->humanReaderNames.push_back(humanReadableName);
+}
+
 Searcher::Searcher()
-    : searchPattern(""),
+    : internal(new SearcherInternal()),
+      searchPattern(""),
+      protocolPrefix("zim://"),
+      searchProtocolPrefix("search://?"),
+      resultCountPerPage(0),
       estimatedResultCount(0),
       resultStart(0),
       resultEnd(0)
@@ -74,25 +109,17 @@ Searcher::Searcher()
 /* Destructor */
 Searcher::~Searcher()
 {
+  delete internal;
 }
 
-bool Searcher::add_reader(Reader* reader)
+void Searcher::add_reader(Reader* reader, const std::string& humanReadableName)
 {
-  if (!reader->hasFulltextIndex()) {
-      return false;
-  }
   this->readers.push_back(reader);
-  return true;
-}
-
-
-Reader* Searcher::get_reader(int readerIndex)
-{
-  return readers.at(readerIndex);
+  this->humanReaderNames.push_back(humanReadableName);
 }
 
 /* Search strings in the database */
-void Searcher::search(const std::string& search,
+void Searcher::search(std::string& search,
                       unsigned int resultStart,
                       unsigned int resultEnd,
                       const bool verbose)
@@ -103,84 +130,65 @@ void Searcher::search(const std::string& search,
     cout << "Performing query `" << search << "'" << endl;
   }
 
-  this->searchPattern = search;
-  this->resultStart = resultStart;
-  this->resultEnd = resultEnd;
+  /* If resultEnd & resultStart inverted */
+  if (resultStart > resultEnd) {
+    resultEnd += resultStart;
+    resultStart = resultEnd - resultStart;
+    resultEnd -= resultStart;
+  }
+
   /* Try to find results */
   if (resultStart != resultEnd) {
-    /* Perform the search */
-    string unaccentedSearch = removeAccents(search);
-    std::vector<zim::Archive> archives;
-    for (auto current = this->readers.begin(); current != this->readers.end();
-         current++) {
-      if ( (*current)->hasFulltextIndex() ) {
-          archives.push_back(*(*current)->getZimArchive());
-      }
+    /* Avoid big researches */
+    this->resultCountPerPage = resultEnd - resultStart;
+    if (this->resultCountPerPage > 70) {
+      resultEnd = resultStart + 70;
+      this->resultCountPerPage = 70;
+    }
+
+    /* Perform the search */
+    this->searchPattern = search;
+    this->resultStart = resultStart;
+    this->resultEnd = resultEnd;
+    string unaccentedSearch = removeAccents(search);
+    if (internal->_xapianSearcher) {
+      internal->_xapianSearcher->searchInIndex(
+          unaccentedSearch, resultStart, resultEnd, verbose);
+      this->estimatedResultCount
+          = internal->_xapianSearcher->results.get_matches_estimated();
+    } else {
+      std::vector<const zim::File*> zims;
+      for (auto current = this->readers.begin(); current != this->readers.end();
+           current++) {
+        zims.push_back((*current)->getZimFileHandler());
+      }
+      zim::Search* search = new zim::Search(zims);
+      search->set_query(unaccentedSearch);
+      search->set_range(resultStart, resultEnd);
+      internal->_search = search;
+      internal->current_iterator = internal->_search->begin();
+      this->estimatedResultCount = internal->_search->get_matches_estimated();
     }
-    zim::Searcher searcher(archives);
-    zim::Query query;
-    query.setQuery(unaccentedSearch, false);
-    query.setVerbose(verbose);
-    zim::Search search = searcher.search(query);
-    internal.reset(new SearcherInternal(search.getResults(resultStart, resultEnd)));
-    this->estimatedResultCount = search.getEstimatedMatches();
   }
 
   return;
 }
 
-
-void Searcher::geo_search(float latitude, float longitude, float distance,
-                          unsigned int resultStart,
-                          unsigned int resultEnd,
-                          const bool verbose)
-{
-  this->reset();
-
-  if (verbose == true) {
-    cout << "Performing geo query `" << distance << "&(" << latitude << ";" << longitude << ")'" << endl;
-  }
-
-  /* Perform the search */
-  std::ostringstream oss;
-  oss << "Articles located less than " << distance << " meters of " << latitude << ";" << longitude;
-  this->searchPattern = oss.str();
-  this->resultStart = resultStart;
-  this->resultEnd = resultEnd;
-
-  /* Try to find results */
-  if (resultStart == resultEnd) {
-    return;
-  }
-
-  std::vector<zim::Archive> archives;
-  for (auto current = this->readers.begin(); current != this->readers.end();
-       current++) {
-    archives.push_back(*(*current)->getZimArchive());
-  }
-  zim::Searcher searcher(archives);
-  zim::Query query;
-  query.setVerbose(verbose);
-  query.setQuery("", false);
-  query.setGeorange(latitude, longitude, distance);
-  zim::Search search = searcher.search(query);
-  internal.reset(new SearcherInternal(search.getResults(resultStart, resultEnd)));
-  this->estimatedResultCount = search.getEstimatedMatches();
-}
-
-
 void Searcher::restart_search()
 {
-  if (internal.get()) {
-    internal->current_iterator = internal->begin();
+  if (internal->_xapianSearcher) {
+    internal->_xapianSearcher->restart_search();
+  } else {
+    internal->current_iterator = internal->_search->begin();
   }
 }
 
 Result* Searcher::getNextResult()
 {
-  if (internal.get() &&
-             internal->current_iterator != internal->end()) {
-    Result* result = new _Result(internal->current_iterator);
+  if (internal->_xapianSearcher) {
+    return internal->_xapianSearcher->getNextResult();
+  } else if (internal->current_iterator != internal->_search->end()) {
+    Result* result = new _Result(this, internal->current_iterator);
     internal->current_iterator++;
     return result;
   }
@@ -195,31 +203,37 @@ void Searcher::reset()
   return;
 }
 
-void Searcher::suggestions(std::string& searchPattern, const bool verbose)
+void Searcher::suggestions(std::string& search, const bool verbose)
 {
   this->reset();
 
   if (verbose == true) {
-    cout << "Performing suggestion query `" << searchPattern << "`" << endl;
+    cout << "Performing suggestion query `" << search << "`" << endl;
   }
 
-  this->searchPattern = searchPattern;
+  this->searchPattern = search;
   this->resultStart = 0;
   this->resultEnd = 10;
-  string unaccentedSearch = removeAccents(searchPattern);
+  string unaccentedSearch = removeAccents(search);
 
-  std::vector<zim::Archive> archives;
-  for (auto current = this->readers.begin(); current != this->readers.end();
-       current++) {
-    archives.push_back(*(*current)->getZimArchive());
+  if (internal->_xapianSearcher) {
+    /* [TODO] Suggestion on a external database ?
+     * We do not support that. */
+    this->estimatedResultCount = 0;
+  } else {
+    std::vector<const zim::File*> zims;
+    for (auto current = this->readers.begin(); current != this->readers.end();
+         current++) {
+      zims.push_back((*current)->getZimFileHandler());
+    }
+    zim::Search* search = new zim::Search(zims);
+    search->set_query(unaccentedSearch);
+    search->set_range(resultStart, resultEnd);
+    search->set_suggestion_mode(true);
+    internal->_search = search;
+    internal->current_iterator = internal->_search->begin();
+    this->estimatedResultCount = internal->_search->get_matches_estimated();
   }
-  zim::Searcher searcher(archives);
-  zim::Query query;
-  query.setVerbose(verbose);
-  query.setQuery(unaccentedSearch, true);
-  zim::Search search = searcher.search(query);
-  internal.reset(new SearcherInternal(search.getResults(resultStart, resultEnd)));
-  this->estimatedResultCount = search.getEstimatedMatches();
 }
 
 /* Return the result count estimation */
@@ -228,45 +242,150 @@ unsigned int Searcher::getEstimatedResultCount()
   return this->estimatedResultCount;
 }
 
-_Result::_Result(zim::SearchResultSet::iterator iterator)
-    : iterator(iterator)
+bool Searcher::setProtocolPrefix(const std::string prefix)
+{
+  this->protocolPrefix = prefix;
+  return true;
+}
+
+bool Searcher::setSearchProtocolPrefix(const std::string prefix)
+{
+  this->searchProtocolPrefix = prefix;
+  return true;
+}
+
+_Result::_Result(Searcher* searcher, zim::Search::iterator& iterator)
+    : searcher(searcher), iterator(iterator)
 {
 }
 
 std::string _Result::get_url()
 {
-  return iterator.getPath();
+  return iterator.get_url();
 }
 std::string _Result::get_title()
 {
-  return iterator.getTitle();
+  return iterator.get_title();
 }
 int _Result::get_score()
 {
-  return iterator.getScore();
+  return iterator.get_score();
 }
 std::string _Result::get_snippet()
 {
-  return iterator.getSnippet();
+  return iterator.get_snippet();
 }
 std::string _Result::get_content()
 {
-  return iterator->getItem(true).getData();
+  if (iterator->good()) {
+    return iterator->getData();
+  }
+  return "";
 }
 int _Result::get_size()
 {
-  return iterator.getSize();
+  return iterator.get_size();
 }
 int _Result::get_wordCount()
 {
-  return iterator.getWordCount();
+  return iterator.get_wordCount();
 }
-std::string _Result::get_zimId()
+int _Result::get_readerIndex()
 {
-  std::ostringstream s;
-  s << iterator.getZimId();
-  return s.str();
+  return iterator.get_fileIndex();
+}
+#ifdef ENABLE_CTPP2
+
+string Searcher::getHtml()
+{
+  SimpleVM oSimpleVM;
+
+  // Fill data
+  CDT oData;
+  CDT resultsCDT(CDT::ARRAY_VAL);
+
+  this->restart_search();
+  Result* p_result = NULL;
+  while ((p_result = this->getNextResult())) {
+    CDT result;
+    result["title"] = p_result->get_title();
+    result["url"] = p_result->get_url();
+    result["snippet"] = p_result->get_snippet();
+    result["contentId"] = humanReaderNames[p_result->get_readerIndex()];
+
+    if (p_result->get_size() >= 0) {
+      result["size"] = kiwix::beautifyInteger(p_result->get_size());
+    }
+
+    if (p_result->get_wordCount() >= 0) {
+      result["wordCount"] = kiwix::beautifyInteger(p_result->get_wordCount());
+    }
+
+    resultsCDT.PushBack(result);
+    delete p_result;
+  }
+  this->restart_search();
+  oData["results"] = resultsCDT;
+
+  // pages
+  CDT pagesCDT(CDT::ARRAY_VAL);
+
+  unsigned int pageStart
+      = this->resultStart / this->resultCountPerPage >= 5
+            ? this->resultStart / this->resultCountPerPage - 4
+            : 0;
+  unsigned int pageCount
+      = this->estimatedResultCount / this->resultCountPerPage + 1 - pageStart;
+
+  if (pageCount > 10) {
+    pageCount = 10;
+  } else if (pageCount == 1) {
+    pageCount = 0;
+  }
+
+  for (unsigned int i = pageStart; i < pageStart + pageCount; i++) {
+    CDT page;
+    page["label"] = i + 1;
+    page["start"] = i * this->resultCountPerPage;
+    page["end"] = (i + 1) * this->resultCountPerPage;
+
+    if (i * this->resultCountPerPage == this->resultStart) {
+      page["selected"] = true;
+    }
+
+    pagesCDT.PushBack(page);
+  }
+  oData["pages"] = pagesCDT;
+
+  oData["count"] = kiwix::beautifyInteger(this->estimatedResultCount);
+  oData["searchPattern"] = kiwix::encodeDiples(this->searchPattern);
+  oData["searchPatternEncoded"] = urlEncode(this->searchPattern);
+  oData["resultStart"] = this->resultStart + 1;
+  oData["resultEnd"] = (this->resultEnd > this->estimatedResultCount
+                            ? this->estimatedResultCount
+                            : this->resultEnd);
+  oData["resultRange"] = this->resultCountPerPage;
+  oData["resultLastPageStart"]
+      = this->estimatedResultCount > this->resultCountPerPage
+            ? this->estimatedResultCount - this->resultCountPerPage
+            : 0;
+  oData["protocolPrefix"] = this->protocolPrefix;
+  oData["searchProtocolPrefix"] = this->searchProtocolPrefix;
+  oData["contentId"] = this->contentHumanReadableId;
+
+  std::string template_ct2 = RESOURCE::results_ct2;
+  VMStringLoader oLoader(template_ct2.c_str(), template_ct2.size());
+
+  FileLogger oLogger(stderr);
+
+  // DEBUG only (write output to stdout)
+  // oSimpleVM.Run(oData, oLoader, stdout, oLogger);
+
+  std::string sResult;
+  oSimpleVM.Run(oData, oLoader, sResult, oLogger);
+
+  return sResult;
 }
 
-
+#endif
 }

src/server.cpp

@@ -1,73 +0,0 @@
-/*
- * Copyright 2019 Matthieu Gautier <mgautier@kymeria.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-#include "server.h"
-
-#include "library.h"
-#include "name_mapper.h"
-
-#include <string>
-
-#include "server/internalServer.h"
-
-namespace kiwix {
-
-Server::Server(Library* library, NameMapper* nameMapper) :
-  mp_library(library),
-  mp_nameMapper(nameMapper),
-  mp_server(nullptr)
-{
-}
-
-Server::~Server() = default;
-
-bool Server::start() {
-  mp_server.reset(new InternalServer(
-    mp_library,
-    mp_nameMapper,
-    m_addr,
-    m_port,
-    m_root,
-    m_nbThreads,
-    m_verbose,
-    m_withTaskbar,
-    m_withLibraryButton,
-    m_blockExternalLinks));
-  return mp_server->start();
-}
-
-void Server::stop() {
-  if (mp_server) {
-    mp_server->stop();
-    mp_server.reset(nullptr);
-  }
-}
-
-void Server::setRoot(const std::string& root)
-{
-  m_root = root;
-  if (m_root[0] != '/') {
-    m_root = "/" + m_root;
-  }
-  if (m_root.back() == '/') {
-    m_root.erase(m_root.size() - 1);
-  }
-}
-
-}

src/server/byte_range.cpp

@@ -1,127 +0,0 @@
-/*
- * Copyright 2020 Veloman Yunkan <veloman.yunkan@gmail.com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU  General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- */
-
-
-#include "byte_range.h"
-
-#include "tools/stringTools.h"
-
-#include <cassert>
-#include <algorithm>
-
-namespace kiwix {
-
-namespace {
-
-ByteRange parseByteRange(const std::string& rangeStr)
-{
-  std::istringstream iss(rangeStr);
-
-  int64_t start, end = INT64_MAX;
-  if (iss >> start) {
-    if ( start < 0 ) {
-      if ( iss.eof() )
-        return ByteRange(-start);
-    } else {
-      char c;
-      if (iss >> c && c=='-') {
-        iss >> end; // if this fails, end is not modified, which is OK
-        if (iss.eof() && start <= end)
-          return ByteRange(ByteRange::PARSED, start, end);
-      }
-    }
-  }
-
-  return ByteRange(ByteRange::INVALID, 0, INT64_MAX);
-}
-
-} // unnamed namespace
-
-ByteRange::ByteRange()
-  : kind_(NONE)
-  , first_(0)
-  , last_(INT64_MAX)
-{}
-
-ByteRange::ByteRange(Kind kind, int64_t first, int64_t last)
-  : kind_(kind)
-  , first_(first)
-  , last_(last)
-{
-  assert(kind != NONE);
-  assert(first >= 0);
-  assert(last >= first || (first == 0 && last == -1));
-}
-
-ByteRange::ByteRange(int64_t suffix_length)
-  : kind_(PARSED)
-  , first_(-suffix_length)
-  , last_(INT64_MAX)
-{
-  assert(suffix_length > 0);
-}
-
-int64_t ByteRange::first() const
-{
-  assert(kind_ > PARSED);
-  return first_;
-}
-
-int64_t ByteRange::last() const
-{
-  assert(kind_ > PARSED);
-  return last_;
-}
-
-int64_t ByteRange::length() const
-{
-  assert(kind_ > PARSED);
-  return last_ + 1 - first_;
-}
-
-ByteRange ByteRange::parse(const std::string& rangeStr)
-{
-  const std::string byteUnitSpec("bytes=");
-  if ( ! kiwix::startsWith(rangeStr, byteUnitSpec) )
-    return ByteRange(INVALID, 0, INT64_MAX);
-
-  return parseByteRange(rangeStr.substr(byteUnitSpec.size()));
-}
-
-ByteRange ByteRange::resolve(int64_t contentSize) const
-{
-  if ( kind() == NONE )
-    return ByteRange(RESOLVED_FULL_CONTENT, 0, contentSize-1);
-
-  if ( kind() == INVALID )
-    return ByteRange(RESOLVED_UNSATISFIABLE, 0, contentSize-1);
-
-  const int64_t resolved_first = first_ < 0
-                               ? std::max(int64_t(0), contentSize + first_)
-                               : first_;
-
-  const int64_t resolved_last = std::min(contentSize-1, last_);
-
-  if ( resolved_first > resolved_last )
-    return ByteRange(RESOLVED_UNSATISFIABLE, 0, contentSize-1);
-
-  return ByteRange(RESOLVED_PARTIAL_CONTENT, resolved_first, resolved_last);
-}
-
-} // namespace kiwix

src/server/byte_range.h

@@ -1,86 +0,0 @@
-/*
- * Copyright 2020 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 KIWIXLIB_SERVER_BYTE_RANGE_H
-#define KIWIXLIB_SERVER_BYTE_RANGE_H
-
-#include <cstdint>
-#include <string>
-
-namespace kiwix {
-
-class ByteRange
-{
-  public: // types
-    // ByteRange is parsed in a request, then it must be resolved (taking
-    // into account the actual size of the requested resource) before
-    // being applied in the response.
-    // The Kind enum represents possible states in such a lifecycle.
-    enum Kind {
-      // The request is not a range request (no Range header)
-      NONE,
-
-      // The value of the Range header is not a valid continuous
-      // range. Note that a valid (according to RFC7233) sequence of multiple
-      // byte ranges is considered invalid in the current implementation
-      // (i.e. only single-range partial requests are supported).
-      INVALID,
-
-      // This byte-range has been successfully parsed from the request
-      PARSED,
-
-      // This is a response to a regular (non-range) request
-      RESOLVED_FULL_CONTENT,
-
-      // The range request is invalid or unsatisfiable
-      RESOLVED_UNSATISFIABLE,
-
-      // This is a response to a (satisfiable) range request
-      RESOLVED_PARTIAL_CONTENT,
-    };
-
-  public: // functions
-    // Constructs a ByteRange object of NONE kind
-    ByteRange();
-
-    // Constructs a ByteRange object of the given kind (except NONE)
-    ByteRange(Kind kind, int64_t first, int64_t last);
-
-    // Constructs a ByteRange object of PARSED kind corresponding to a
-    // range request of the form "Range: bytes=-suffix_length"
-    explicit ByteRange(int64_t suffix_length);
-
-    Kind kind() const { return kind_; }
-    int64_t first() const;
-    int64_t last() const;
-    int64_t length() const;
-
-    static ByteRange parse(const std::string& rangeStr);
-    ByteRange resolve(int64_t contentSize) const;
-
-  private: // data
-    Kind kind_;
-    int64_t first_;
-    int64_t last_;
-};
-
-} // namespace kiwix
-
-#endif //KIWIXLIB_SERVER_BYTE_RANGE_H