Merge pull request #525 from kiwix/version_3.2.0

zlib and microhttpd are used by libkiwix, not kiwix-tools.

We indeed need libzim, but we use no feature related to xapian so no
need to mark it as mandatory.
(Libkiwix needs it and the check is there)

.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: kiwix # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 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
@@ -9,4 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
 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/
+custom: # https://kiwix.org/support-us/

.github/move.yml

@@ -0,0 +1,27 @@
+# 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/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on: [push]
+
+jobs:
+  Linux:
+    strategy:
+      fail-fast: false
+      matrix:
+        target:
+          - native_static
+          - native_dyn
+          - win32_static
+          - win32_dyn
+        include:
+          - target: native_static
+            image_variant: xenial
+            lib_postfix: '/x86_64-linux-gnu'
+          - target: native_dyn
+            image_variant: xenial
+            lib_postfix: '/x86_64-linux-gnu'
+          - target: win32_static
+            image_variant: f31
+            lib_postfix: '64'
+          - 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}}-31"
+    steps:
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+    - name: Checkout code
+      shell: python
+      run: |
+        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-tools.tar.xz
+        wget -O- http://tmp.kiwix.org/ci/${ARCHIVE_NAME} | tar -xJ -C /home/runner
+    - name: Compile
+      shell: bash
+      run: |
+        if [[ "${{matrix.target}}" =~ .*_static ]]; then
+          MESON_OPTION="-Dstatic-linkage=true"
+        else
+          MESON_OPTION=""
+        fi
+        if [[ ! "${{matrix.target}}" =~ native_.* ]]; then
+          MESON_OPTION="$MESON_OPTION --cross-file $HOME/BUILD_${{matrix.target}}/meson_cross_file.txt"
+        fi
+        cd $HOME/kiwix-tools
+        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"

.github/workflows/docker.yml

@@ -0,0 +1,61 @@
+name: Docker
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Specific version to build (overrides on-master and tag-pattern)
+        required: false
+        default: ''
+
+jobs:
+  build-and-push-kiwix-tools:
+    name: Deploy kiwix-tools Docker Image
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: build and publish kiwix-tools
+        uses: openzim/docker-publish-action@v5
+        with:
+          image-name: kiwix/kiwix-tools
+          credentials: |
+            DOCKERIO_USERNAME=${{ secrets.DOCKERHUB_USERNAME }}
+            DOCKERIO_TOKEN=${{ secrets.DOCKERHUB_PASSWORD }}
+            GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
+            GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
+          context: docker
+          latest-on-tag: true
+          build-args:
+            VERSION={tag}
+          platforms: |
+            linux/amd64
+            linux/arm/v7
+            linux/arm64
+          restrict-to: kiwix/kiwix-tools
+          manual-tag: ${{ github.event.inputs.version }}
+
+  build-and-push-kiwix-serve:
+    name: Deploy kiwix-serve Docker Image
+    runs-on: ubuntu-20.04
+    needs: build-and-push-kiwix-tools
+    steps:
+      - uses: actions/checkout@v2
+      - name: build and publish kiwix-serve
+        uses: openzim/docker-publish-action@v5
+        with:
+          image-name: kiwix/kiwix-serve
+          credentials: |
+            DOCKERIO_USERNAME=${{ secrets.DOCKERHUB_USERNAME }}
+            DOCKERIO_TOKEN=${{ secrets.DOCKERHUB_PASSWORD }}
+            GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
+            GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
+          context: docker/server
+          latest-on-tag: true
+          build-args:
+            VERSION={tag}
+          platforms: |
+            linux/amd64
+            linux/arm/v7
+            linux/arm64
+          restrict-to: kiwix/kiwix-tools
+          manual-tag: ${{ github.event.inputs.version }}

.github/workflows/package.yml

@@ -0,0 +1,91 @@
+name: Packages
+on: [push, pull_request]
+
+jobs:
+  build-deb:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        distro:
+          - ubuntu-jammy
+          - ubuntu-impish
+          - ubuntu-hirsute
+          - ubuntu-focal
+    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-jammy
+        if: matrix.distro == 'ubuntu-jammy'
+        name: Build package for ubuntu-jammy
+        id: build-ubuntu-jammy
+        with:
+          args: --no-sign
+          ppa: ${{ steps.ppa.outputs.ppa }}
+
+      - uses: legoktm/gh-action-build-deb@ubuntu-impish
+        if: matrix.distro == 'ubuntu-impish'
+        name: Build package for ubuntu-impish
+        id: build-ubuntu-impish
+        with:
+          args: --no-sign
+          ppa: ${{ steps.ppa.outputs.ppa }}
+
+      - uses: legoktm/gh-action-build-deb@ubuntu-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-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: 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
+

.travis.yml

@@ -1,12 +0,0 @@
-language: cpp
-dist: xenial
-sudo: true
-cache: ccache
-install: travis/install_deps.sh
-script: travis/compile.sh
-env:
-  matrix:
-    - PLATFORM="native_static"
-    - PLATFORM="native_dyn"
-    - PLATFORM="win32_static"
-    - PLATFORM="win32_dyn"

Changelog

@@ -1,3 +1,66 @@
+kiwix-tools 3.2.0
+=================
+
+ * Print the version of all dependencies (@kelson42 #516)
+ * Better Docker images (@kelson42 @rgaudin)
+ * Update Readme (@kelson42)
+ * Build debian packages on CI (@legoktm #394)
+ * Add man pages for kiwix-read and kiwix-search (@legoktm #392)
+ * Various fixes (@legoktm @hashworks @mgautierfr)
+
+
+kiwix-serve
+-----------
+
+ * Print the url on which a user can connect to on startup (@nikhil #499 #522)
+ * Reload library on SIGHUP signal (@veloman-yunkan #497)
+ * Add a option `--monitorLibrary` to monitor and automically reload the library
+   (@veloman-yunkan #503)
+ * Correct handling of SIGTERM and SIGINT (@veloman-yunkan #488)
+ * Add `--customIndexTemplate` option (@manan #477)
+ * Add `--help` option (@kelson42 #511)
+
+
+kiwix-tools 3.1.2
+=================
+
+ * Use new threadsafe API of kiwix-lib to do suggestions search.
+
+kiwix-tools 3.1.1
+=================
+
+ * Fix compilation on Windows' CI
+
+kiwix-tools 3.1.0
+=================
+
+ * [SERVER] Add option to block external links
+
+kiwix-tools 3.0.3
+=================
+
+ * [MANAGER] Fix broken --version argument parsing
+
+kiwix-tools 3.0.2
+=================
+
+ * New option --version for all tools
+ * Remove benchmark.sh file.
+ * [DOCKER] Add ability to download a file at container start.
+ * [CI] Move to github actions instead of travis.
+ * [SERVER] Trust the given library by default.
+ * [SERVER] Add shortcut alias for option `--address` and `--nodatealias`
+
+kiwix-tools 3.0.1
+=================
+
+ * Fix --nodatealiases inverted logic regression
+
+kiwix-tools 3.0.0
+=================
+
+ * Move kiwix-serve implementation in kiwix-lib.
+
 kiwix-tools 2.1.0
 =================
 

README.md

@@ -1,12 +1,22 @@
 Kiwix tools
 ===========
 
-The Kiwix tools is a collection of Kiwix related command line tools:
+The Kiwix tools is a collection of [Kiwix](https://kiwix.org) related
+command line tools:
 * kiwix-manage: Manage XML based library of ZIM files
 * kiwix-read: Read ZIM file content
 * kiwix-search: Fulltext search in ZIM files
 * kiwix-serve: HTTP daemon serving ZIM files
 
+[![latest release](https://img.shields.io/github/v/tag/kiwix/kiwix-tools?label=latest%20release&sort=semver)](https://download.kiwix.org/release/kiwix-tools/)
+[![Repositories](https://img.shields.io/repology/repositories/kiwix-tools?label=repositories)](https://github.com/kiwix/kiwix-tools/wiki/Repology)
+[![Docker](https://img.shields.io/docker/v/kiwix/kiwix-tools?arch=amd64&label=Docker&sort=date)](https://hub.docker.com/r/kiwix/kiwix-tools)
+[![Docker (kiwix-serve)](https://img.shields.io/docker/v/kiwix/kiwix-serve?arch=amd64&label=Docker%20(kiwix-serve)&sort=date)](https://hub.docker.com/r/kiwix/kiwix-serve)
+[![Sandstorm](https://img.shields.io/badge/Sandstorm-kiwix-blue)](https://apps.sandstorm.io/app/5uh349d0kky2zp5whrh2znahn27gwha876xze3864n0fu9e5220h)
+[![Build Status](https://github.com/kiwix/kiwix-tools/workflows/CI/badge.svg?query=branch%3Amaster)](https://github.com/kiwix/kiwix-tools/actions?query=branch%3Amaster)
+[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/kiwix-tools/badge)](https://www.codefactor.io/repository/github/kiwix/kiwix-tools)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
 Disclaimer
 ----------
 
@@ -21,7 +31,9 @@ Preamble
 Although the Kiwix tools can be compiled/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.
+on recent releases of
+[Debian](https://debian.org)/[Ubuntu](https://ubuntu.com) and
+[Fedora](https://getfedora.org).
 
 Dependencies
 ------------
@@ -29,10 +41,8 @@ Dependencies
 The Kiwix tools rely on a few third party software libraries. They are
 prerequisites to the Kiwix tools compilation. Therefore, following
 libraries need to be available:
-
-* [Kiwix lib](https://github.com/kiwix/kiwix-lib) (no package so far)
-* [Libmicrohttpd](https://www.gnu.org/software/libmicrohttpd/) (package libmicrohttpd-dev on Ubuntu)
-* [Zlib](https://www.zlib.net/) (package zlib1g-dev on Ubuntu)
+* [libkiwix](https://github.com/kiwix/libkiwix) (package `libkiwix` on Debian/Ubuntu)
+* [libzim](https://github.com/openzim/libzim) (package `libzim` on Debian/Ubuntu)
 
 These dependencies may or may not be packaged by your operating
 system. They may also be packaged but only in an older version. They
@@ -45,12 +55,8 @@ If you want to install these dependencies locally, then use the
 kiwix-tools directory as install prefix.
 
 If you want to compile Kiwix tools statically, the dependencies should
-be compiled statically (provide a lib...a library), for example by
-using "--enable-static" with "./configure".
-
-If you compile manually Libmicrohttpd, you might need to compile it
-without GNU TLS, a bug here will empeach further compilation of Kiwix
-tools otherwise.
+be compiled statically (provide a `lib...a` library), for example by
+using `--enable-static` with `./configure`.
 
 Environment
 -------------
@@ -58,18 +64,19 @@ Environment
 The Kiwix tools build using [Meson](http://mesonbuild.com/) version
 0.43 or higher. Meson relies itself on Ninja, pkg-config and few other
 compilation tools. Install them first:
-* Meson
-* Ninja
-* Pkg-config
+* [Meson](http://mesonbuild.com/)
+* [Ninja](https://ninja-build.org/)
+* [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
 
 These tools should be packaged if you use a cutting edge operating
-system. If not, have a look to the "Troubleshooting" section.
+system. If not, have a look to the [Troubleshooting](#Troubleshooting)
+section.
 
 Compilation
 -----------
 
 Once all dependencies are installed, you can compile Kiwix tools with:
-```
+```bash
 meson . build
 ninja -C build
 ```
@@ -84,38 +91,38 @@ Installation
 ------------
 
 If you want to install the Kiwix tools, 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 Kiwix tools. After the installation
-succeeded, you may need to run ldconfig (as root).
+You might need to run the command as `root` (or using `sudo`),
+depending where you want to install the Kiwix tools. After the
+installation succeeded, you may need to run ldconfig (as `root`).
 
 Uninstallation
 ------------
 
 If you want to uninstall the Kiwix tools:
-
-```
+```bash
 ninja -C build uninstall
 ```
 
-Like for the installation, you might need to run the command as root
-(or using 'sudo').
+Like for the installation, you might need to run the command as `root`
+(or using `sudo`).
 
 Docker
 ------
 
-An official Docker image of `kiwix-serve` can be found at
-https://hub.docker.com/r/kiwix/kiwix-serve.
+An official Docker image of the Kiwix tools can be found in the
+[Docker Hub](https://hub.docker.com/r/kiwix/kiwix-tools). A
+`kiwix-serve` dedicated Docker image [exists
+too](https://hub.docker.com/r/kiwix/kiwix-serve).
 
 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
@@ -123,7 +130,7 @@ hash -r                  # Refresh bash paths
 ```
 
 If you need to install Ninja "manually":
-```
+```bash
 git clone git://github.com/ninja-build/ninja.git
 cd ninja
 git checkout release
@@ -142,4 +149,5 @@ repository.
 License
 -------
 
-GPLv3 or later, see COPYING for more details.
+[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see
+[COPYING](COPYING) for more details.

debian/changelog

@@ -0,0 +1,5 @@
+kiwix-tools (0.0.0) unstable; urgency=medium
+
+  * Initial release
+
+ -- Kunal Mehta <legoktm@debian.org>  Mon, 13 Jul 2020 17:21:11 -0700

debian/control

@@ -0,0 +1,26 @@
+Source: kiwix-tools
+Section: utils
+Priority: optional
+Maintainer: Kiwix team <kiwix@kiwix.org>
+Build-Depends: debhelper-compat (= 13),
+               libkiwix-dev (>= 10.0.0),
+               libzim-dev (>= 7.2.0),
+               meson,
+               pkg-config,
+Standards-Version: 4.5.0
+Homepage: https://github.com/kiwix/kiwix-tools
+Rules-Requires-Root: no
+
+Package: kiwix-tools
+Architecture: any
+Depends: ${misc:Depends}, ${shlibs:Depends}
+Description: collection of Kiwix tools
+ kiwix-tools is a collection of various command-line tools used to help
+ users interact with and manage ZIM files. It includes:
+  * kiwix-serve is a standalone HTTP server for serving ZIM files
+    over the network.
+  * kiwix-manage allows one to manage the content of the Kiwix library (an
+    XML file listing available ZIM files).
+  * kiwix-read allows for reading ZIM files from the command-line.
+  * kiwix-search allows one to find articles in a ZIM file using fulltext
+    search patterns.

debian/copyright

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

debian/rules

@@ -0,0 +1,5 @@
+#!/usr/bin/make -f
+export DEB_BUILD_MAINT_OPTIONS = hardening=+all
+
+%:
+	dh $@

debian/source/format

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

docker/Dockerfile

@@ -0,0 +1,49 @@
+# dumb-init to use as entrypoint so it can forward signals to our CMD
+FROM debian:bullseye-slim as builder
+RUN apt-get update -y \
+    && apt-get install -y --no-install-recommends \
+    build-essential ca-certificates musl-tools wget unzip make \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+# compile dumb-init
+RUN wget -nv https://github.com/Yelp/dumb-init/archive/refs/tags/v1.2.5.zip && \
+    unzip v1.2.5.zip && cd dumb-init-1.2.5 && CC=musl-gcc make
+
+# declare build option ARCH if not using buildx
+ARG ARCH=
+# declare version to build image for
+ARG VERSION=
+
+# alpine is a multi-arch image
+FROM alpine:3
+LABEL org.opencontainers.image.source https://github.com/openzim/kiwix-tools
+
+# TARGETARCH is injected by buildx
+ARG TARGETARCH
+ARG VERSION
+ARG ARCH
+
+# copy built dumb-init
+COPY --from=builder /dumb-init-1.2.5/dumb-init /usr/bin/dumb-init
+
+# find and store arch in image, using (in this order):
+# $TARGETARCH || --build-arg ARCH (not using buildx) || amd64
+RUN echo "amd64" > /etc/docker_arch && \
+    if [ ! -z "$ARCH" ] ; then echo "$ARCH" > /etc/docker_arch ; fi && \
+    if [ ! -z "$TARGETARCH" ] ; then echo "$TARGETARCH" > /etc/docker_arch ; fi
+
+# decide which kiwix arch to download later (`armhf` for all arm* and x86_64 otherwise)
+RUN if [ $(cut -c 1-3 /etc/docker_arch) = "arm" ] ; then echo "armhf" > /etc/kiwix_arch ; else echo "x86_64" > /etc/kiwix_arch ; fi
+
+# Install kiwix-tools
+RUN url="http://mirror.download.kiwix.org/release/kiwix-tools/kiwix-tools_linux-$(cat /etc/kiwix_arch)-$VERSION.tar.gz" && \
+    echo "URL: $url" && \
+    wget -q -O - $url | tar -xz && \
+    mv kiwix-tools*/kiwix-* /usr/local/bin && \
+    rm -r kiwix-tools*
+
+# expose kiwix-serve default port
+EXPOSE 80
+
+ENTRYPOINT ["/usr/bin/dumb-init", "--"]
+CMD ["/bin/sh", "-c", "echo 'Welcome to kiwix-tools! The following binaries are available:' && ls /usr/local/bin/"]

docker/README.md

@@ -0,0 +1,32 @@
+Kiwix-tools Docker image
+===
+
+- Available on [docker.io](https://hub.docker.com/r/kiwix/kiwix-tools) and [ghcr.io](https://ghcr.io/kiwix/kiwix-tools).
+- multi-arch (`linux/amd64`, `linux/arm64`, `linux/arm/v7`)
+- based on official `kiwix-tools` binaries.
+
+## Usage
+
+``` sh
+$ docker run -it kiwix/kiwix-tools:3.1.2
+
+Welcome to kiwix-tools! The following binaries are available:
+kiwix-manage  kiwix-read    kiwix-search  kiwix-serve
+```
+
+`kiwix-tools` operates on zim files. You shall mount a volume to access the files.
+
+```sh
+docker run -v $(pwd):/data -it kiwix/kiwix-tools kiwix-read --suggest="Mali" /data/wikipedia_fr_test.zim
+```
+
+## Building and reusing
+
+- `kiwix/kiwix-tools` is multi-arch and is ideally built using `buildx`.
+- requires a `--build-arg VERSION=` with the kiwix-tools release.
+- can be built using `docker build` in which case it expects an additionnal `--build-arg ARCH=arm` for arm. Otherwise defaults to `amd64`.
+
+**Notes:**
+
+- `wget` in `alpine:3` on `arm/v7` (__inside github action only__) crashes when downloading from HTTPs locations. Keep http-only in Dockerfile.
+- Was also unhappy when using the mirrors so it's using `mirror.download` on purpose.

docker/server/Dockerfile

@@ -1,15 +1,14 @@
-FROM alpine:latest
-LABEL maintainer Emmanuel Engelhart <kelson@kiwix.org>
+ARG VERSION=latest
 
-# Install kiwix-serve
-WORKDIR /
-RUN apk add --no-cache curl bzip2
-RUN curl -kL https://download.kiwix.org/release/kiwix-tools/kiwix-tools_linux-x86_64-1.2.1.tar.gz | tar -xz && \
-    mv kiwix-tools*/kiwix-serve /usr/local/bin && \
-    rm -r kiwix-tools*
+# kiwix-tools is multi-arch
+FROM kiwix/kiwix-tools:$VERSION
+LABEL org.opencontainers.image.source https://github.com/openzim/kiwix-tools
 
-# Run kiwix-serve
+# expose kiwix-serve default port and workdir
 EXPOSE 80
 VOLUME /data
 WORKDIR /data
-ENTRYPOINT ["/usr/local/bin/kiwix-serve", "--port", "80"]
+
+COPY ./start.sh /usr/local/bin/
+
+ENTRYPOINT ["/usr/bin/dumb-init", "--", "/usr/local/bin/start.sh"]

docker/server/README.md

@@ -1,13 +1,36 @@
-kiwix-serve Docker image
+Kiwix serve Docker image
 ========================
 
+With local ZIM file(s)
+----------------------
+
 * Download a ZIM file from <https://wiki.kiwix.org/wiki/Content>
 
-* Given `wikipedia.zim` resides in `/tmp/zim/`, execute the following:
+* Given `wikipedia.zim` and `wiktionary.zim` reside in `/tmp/zim/`, execute the following:
 
+```bash
+docker run -v /tmp/zim:/data -p 8080:80 kiwix/kiwix-serve wikipedia.zim wiktionary.zim
 ```
-docker run -v /tmp/zim:/data -p 8080:80 kiwix/kiwix-serve wikipedia.zim
+
+With remote ZIM file
+--------------------
+
+```bash
+docker run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -p 8080:80 kiwix/kiwix-serve
 ```
 
+ARM
+---
+
+Build an image for an ARM based GNU/Linux:
+```bash
+docker build . -t kiwix/kiwix-serve:latest --build-arg ARCH="arm32v7/"
+```
+
+You can also deploy kiwix with [`docker-compose`](https://docs.docker.com/compose/). Check out a sample at [docker-compose.yml.example](docker-compose.yml.example)
+
+Screenshots
+-----------
+
 ![screenshot_1.png](https://github.com/kiwix/kiwix-tools/raw/master/docker/server/pictures/screenshot_1.png)
 ![screenshot_2.png](https://github.com/kiwix/kiwix-tools/raw/master/docker/server/pictures/screenshot_2.png)

docker/server/docker-compose.yml.example

@@ -0,0 +1,14 @@
+version: '3.3'
+services:
+  kiwix-serve:
+      ports:
+        - 8080:80
+      image: kiwix/kiwix-serve
+      # uncomment next 4 lines to use it with local zim file in /tmp/zim
+      # volumes:
+      #   - /tmp/zim:/data
+      # command:
+      #   - *.zim
+      # uncomment next 2 lines to use it with remote zim file
+      # environment:
+      #   - 'DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim'

docker/server/start.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+# Download if necessary a file
+if [ ! -z "$DOWNLOAD" ]
+then
+    ZIM=`basename $DOWNLOAD`
+    wget $DOWNLOAD -O "$ZIM"
+
+    # Set arguments
+    if [ "$#" -eq "0" ]
+    then
+        set -- "$@" $ZIM
+    fi
+fi
+
+CMD="/usr/local/bin/kiwix-serve --port=80 $@"
+echo $CMD
+$CMD
+
+# If error, print the content of /data
+if [ $? -ne 0 ]
+then
+    echo "Here is the content of /data:"
+    find /data -type f
+fi

meson.build

@@ -1,21 +1,22 @@
 project('kiwix-tools', 'cpp',
-  version : '2.1.0',
+  version : '3.2.0',
   license : 'GPL',
-  default_options: ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
+  default_options: ['c_std=c11', 'cpp_std=c++11'])
 
 compiler = meson.get_compiler('cpp')
 
+add_global_arguments('-DKIWIX_TOOLS_VERSION="@0@"'.format(meson.project_version()), language : 'cpp')
+
 static_linkage = get_option('static-linkage')
 if static_linkage
   add_global_link_arguments('-static-libstdc++', '--static', language:'cpp')
 endif
 
 thread_dep = dependency('threads')
-kiwixlib_dep = dependency('kiwix', version:'>=5.2.0', static:static_linkage)
-microhttpd_dep = dependency('libmicrohttpd', static:static_linkage)
-z_dep = dependency('zlib', static:static_linkage)
+kiwixlib_dep = dependency('kiwix', version:'>=10.0.0', static:static_linkage)
+libzim_dep = dependency('libzim', version:'>=7.2.0', static:static_linkage)
 
-all_deps = [thread_dep, kiwixlib_dep, microhttpd_dep, z_dep]
+all_deps = [thread_dep, kiwixlib_dep, libzim_dep]
 
 if static_linkage
   librt = compiler.find_library('rt', required:false)
@@ -24,6 +25,4 @@ if static_linkage
   endif
 endif
 
-#subdir('include')
-subdir('static')
 subdir('src')

src/man/kiwix-read.1

@@ -0,0 +1,18 @@
+.TH KIWIX-READ "1" "July 2020" "kiwix-tools" "User Commands"
+.SH NAME
+kiwix-read \- Read ZIM file content
+.SH SYNOPSIS
+\fBkiwix-read\fR [\-\-verbose] [\-\-version] \-\-suggest=PATTERN ZIM\fR
+.SH DESCRIPTION
+.TP
+ZIM
+ZIM file to search
+.TP
+\fB\-\-verbose\fR
+Enable extra output
+.TP
+\fB\-\-version\fR
+print software version
+.TP
+\fB\-\-suggest=PATTERN\fR
+Get search suggestions for the provided pattern

src/man/kiwix-search.1

@@ -0,0 +1,21 @@
+.TH KIWIX-SEARCH "1" "July 2020" "kiwix-tools" "User Commands"
+.SH NAME
+kiwix-search \- find articles using a fulltext search pattern
+.SH SYNOPSIS
+\fBkiwix-search\fR [OPTIONS] ZIM PATTERN\fR
+.SH DESCRIPTION
+.TP
+ZIM
+ZIM file to search
+.TP
+PATTERN
+Words or parts of words to search for in the ZIM file
+.TP
+\fB\-s\fR, \fB\-\-suggestion\fR
+Suggest article titles based on the PATTERN instead of a fulltext search
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print software version
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Give details about the search process

src/man/meson.build

@@ -1,3 +1,5 @@
 install_man('kiwix-manage.1',
+            'kiwix-read.1',
+            'kiwix-search.1',
             'kiwix-serve.1')
 subdir('fr')

src/manager/kiwix-manage.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
+ * Copyright 2011-2019 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,11 +18,13 @@
  */
 
 #include <getopt.h>
-#include <kiwix/tools/stringTools.h>
 #include <kiwix/manager.h>
+#include <kiwix/tools.h>
 #include <cstdlib>
 #include <iostream>
 
+#include "../version.h"
+
 using namespace std;
 
 enum supportedAction { NONE, ADD, SHOW, REMOVE };
@@ -78,6 +80,9 @@ void usage()
             << "\t\t\t--zimPathToSave=CUSTOM_ZIM_PATH to replace the current ZIM file path" << std::endl
             << "\t\t\t--url=HTTP_ZIM_URL to create an \"url\" attribute for the online version of the ZIM file" << std::endl
             << std::endl
+            << "\t\t\tOther options:" << std::endl
+            << "\t\t\t-v, --version to print the software version" << std::endl
+            << std::endl
 
             << "Examples:" << std::endl
             << "\tAdd ZIM files to library: kiwix-manage my_library.xml add first.zim second.zim" << std::endl
@@ -114,7 +119,6 @@ int handle_add(kiwix::Library* library, const std::string& libraryPath,
   string zimPath;
   string zimPathToSave = ".";
   string url;
-  string origID = "";
   int option_index = 0;
   int c = 0;
   int resultCode = 0;
@@ -128,7 +132,6 @@ int handle_add(kiwix::Library* library, const std::string& libraryPath,
   optind = 3;
   static struct option long_options[] = {
     {"url", required_argument, 0, 'u'},
-    {"origId", required_argument, 0, 'o'},
     {"zimPathToSave", required_argument, 0, 'z'},
     {0, 0, 0, 0}
   };
@@ -144,11 +147,6 @@ int handle_add(kiwix::Library* library, const std::string& libraryPath,
       case 'u':
         url = optarg;
         break;
-
-      case 'o':
-        origID = optarg;
-        break;
-
       case 'z':
         zimPathToSave = optarg;
         break;
@@ -217,7 +215,27 @@ int main(int argc, char** argv)
   supportedAction action = NONE;
   kiwix::Library library;
 
-  /* Argument parsing */
+  /* General argument parsing */
+  static struct option long_options[] = {
+    {"version", no_argument, 0, 'v'},
+    {0, 0, 0, 0}
+  };
+
+  int option_index = 0;
+  int c;
+  while (true && argc == 2) {
+    c = getopt_long(argc, argv, "v", long_options, &option_index);
+    if (c == -1)
+      break;
+
+    switch (c) {
+      case 'v':
+        version();
+        return 0;
+    }
+  }
+
+  /* Action related argument parsing */
   if (argc > 2) {
     libraryPath = argv[1];
     string actionString = argv[2];
@@ -237,8 +255,8 @@ int main(int argc, char** argv)
   }
 
   /* Try to read the file */
-  libraryPath = isRelativePath(libraryPath)
-                    ? computeAbsolutePath(getCurrentDirectory(), libraryPath)
+  libraryPath = kiwix::isRelativePath(libraryPath)
+                    ? kiwix::computeAbsolutePath(kiwix::getCurrentDirectory(), libraryPath)
                     : libraryPath;
   kiwix::Manager manager(&library);
   manager.readFile(libraryPath, false);

src/reader/kiwix-read.cpp

@@ -22,9 +22,11 @@
 #include <map>
 #include <string>
 
+#include "../version.h"
+
 void usage()
 {
-  cout << "Usage: kiwix-read --suggest=<PATTERN> ZIM_FILE_PATH" << endl;
+  cout << "Usage: kiwix-read [--verbose] [--version] --suggest=<PATTERN> ZIM_FILE_PATH" << endl;
   exit(1);
 }
 
@@ -42,15 +44,19 @@ int main(int argc, char** argv)
   while (42) {
     static struct option long_options[]
         = {{"verbose", no_argument, 0, 'v'},
+           {"version", no_argument, 0, 'V'},
            {"suggest", required_argument, 0, 's'},
            {0, 0, 0, 0}};
 
     if (c != -1) {
-      c = getopt_long(argc, argv, "vs:", long_options, &option_index);
+      c = getopt_long(argc, argv, "Vvs:", long_options, &option_index);
 
       switch (c) {
         case 'v':
           break;
+        case 'V':
+          version();
+          return 0;
         case 's':
           pattern = optarg;
           break;
@@ -84,10 +90,10 @@ int main(int argc, char** argv)
 
     if (pattern != NULL) {
       std::cout << "Searching suggestions for: " << pattern << std::endl;
-
-      reader->searchSuggestionsSmart(pattern, 10);
-      while (reader->getNextSuggestion(suggestion)) {
-        std::cout << suggestion << std::endl;
+      kiwix::SuggestionsList_t suggestions;
+      reader->searchSuggestionsSmart(pattern, 10, suggestions);
+      for (auto& suggestion: suggestions) {
+        std::cout << suggestion.getTitle() << std::endl;
       }
     }
 

src/searcher/kiwix-search.cpp

@@ -21,15 +21,17 @@
 #include <kiwix/reader.h>
 #include <kiwix/searcher.h>
 
+#include "../version.h"
 
 void usage()
 {
   cout << "Usage: kiwix-search [OPTIONS] ZIM PATTERN" << endl << endl
-       << "  kiwix-search allows to find articles based on the a fulltext search pattern." << endl << endl
+       << "  kiwix-search allows one to find articles based on the a fulltext search pattern." << endl << endl
        << "  ZIM is the full path of the ZIM file." << endl
        << "  PATTERN is/are word(s) - or part of - to search in the ZIM." << endl << endl
        << "  -s, --suggestion\tSuggest article titles based on the few letters of the PATTERN instead of making a fulltext search. Work a bit like a completion solution." << endl
-       << "  -v, --verbose\t\tGive details about the search process" << endl;
+       << "  -v, --verbose\t\tGive details about the search process" << endl
+       << "  -V, --version\t\tPrint software version" << endl;
   exit(1);
 }
 
@@ -54,15 +56,19 @@ int main(int argc, char** argv)
     static struct option long_options[]
         = {{"verbose", no_argument, 0, 'v'},
            {"suggestion", no_argument, 0, 's'},
+           {"version", no_argument, 0, 'V'},
            {0, 0, 0, 0}};
 
     if (c != -1) {
-      c = getopt_long(argc, argv, "vsb:", long_options, &option_index);
+      c = getopt_long(argc, argv, "Vvsb:", long_options, &option_index);
 
       switch (c) {
         case 'v':
           verboseFlag = true;
           break;
+        case 'V':
+          version();
+          return 0;
         case 's':
           suggestionFlag = true;
           break;
@@ -98,7 +104,14 @@ int main(int argc, char** argv)
 
   if (reader) {
     searcher = new kiwix::Searcher();
-    searcher->add_reader(reader, "");
+    bool contians_FTIndex=searcher->add_reader(reader);
+    if(!contians_FTIndex){
+        std::cerr << "The Zim file does not contain a full-text index." << std::endl;
+        if(suggestionFlag){
+            exit(0);
+        }
+        exit(1);
+      }
   } else {
     cerr << "Unable to search through zim '" << zimPath << "'." << endl;
     exit(1);

src/server/benchmark.sh

@@ -1,72 +0,0 @@
-#!/bin/bash
-
-# Parse command line
-zim=$1
-serve=$2
-if (( $# != 2 ))
-then
-    echo "Usage: ./benchmark ZIM_PATH KIWIX-SERVE_PATH"
-    exit 1
-fi
-
-# Constants
-delay=0.01
-top_log=/tmp/top.log
-top_calc=/tmp/top.calc
-
-# Available memory
-memory_kb=`cat /proc/meminfo | grep "MemTotal" | tr -d " " | cut -f2 -d: | sed -e 's/[^0123456789]//g'`
-memory_mb=`echo "scale=2;$memory_kb/1024" | bc -l`
-
-# Start Kiwix-serve
-echo "Starting kiwix-serve to be tested..."
-$serve --port=8080 "$zim" &
-serve_pid=$!
-
-# Start top to monitor resource usage
-top -d $delay -b -p $serve_pid | grep $serve_pid > "$top_log" &
-top_pid=$!
-
-# Print environnement informations
-echo "Process to monitor: $serve_pid"
-echo "Monitoring process: $top_pid"
-echo "Monitoring delay:   $delay s"
-echo "ZIM file path:      $zim"
-echo "Kiwix-serve path:   $serve"
-echo "Total memory:       $memory_mb MB"
-echo
-
-# Compute artice list
-echo "Computing article list snippet..."
-articles=`zimdump -l $zim | grep ".html" | shuf | head -n 1000`
-
-# Run wget against kiwix-serve
-start_date=`date +%s`
-for LINE in $articles
-do
-    echo "Scrapping $LINE..."
-    wget --quiet p -P /dev/shm/tmp "http://localhost:8080/wikipedia_en_medicine_2016-09/A/$LINE"
-    rm -rf /dev/shm/tmp
-done
-end_date=`date +%s`
-
-# Kill top instance
-kill -s STOP $top_pid 2>&1 > /dev/null
-sed -i '$ d' "$top_log"
-times=`cat "$top_log" | wc -l`
-
-# Compute KPI
-duration=`echo "$end_date-$start_date" | bc -l`
-cpu_percent=`cat "$top_log" | sed -r -e "s;\s\s*; ;g" -e "s;^ *;;" | cut -d' ' -f9 | tr '\n' '+0' | sed -r -e "s;(.*)[+]$;\1;" -e "s/.*/scale=2\n(&)\/$times\nquit\n/" > "$top_calc" ; bc -q "$top_calc"`
-memory_percent=`cat "$top_log" | sed -r -e "s;\s\s*; ;g" -e "s;^ *;;" | cut -d' ' -f10 | tr '\n' '+' | sed -r -e "s;(.*)[+]$;\1;" -e "s/.*/scale=2\n(&)\/$times\nquit\n/" > "$top_calc" ; bc -q "$top_calc"`
-memory_absolut=`echo "scale=2;$memory_mb/100*$memory_percent" | bc -l`
- 
-echo 
-echo "Measure count:      $times"
-echo "Duration:           $duration s"
-echo "CPU (average):      $cpu_percent %"
-echo "Memory (average):   $memory_absolut MB"
-
-# Kill kiwix-serve & top instances
-kill -s STOP $serve_pid 2>&1 > /dev/null
-#rm "$top_log" "$top_calc"

src/server/meson.build

@@ -1,6 +1,5 @@
 
-sources = ['kiwix-serve.cpp', 'request_context.cpp']
-sources += server_resources
+sources = ['kiwix-serve.cpp']
 
 executable('kiwix-serve', sources,
   dependencies:all_deps,

src/server/request_context.cpp

@@ -1,201 +0,0 @@
-/*
- * Copyright 2009-2016 Emmanuel Engelhart <kelson@kiwix.org>
- * 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 "request_context.h"
-#include <string.h>
-#include <stdexcept>
-#include <sstream>
-#include <cstdio>
-
-RequestContext::RequestContext(struct MHD_Connection* connection,
-                               std::string rootLocation,
-                               const std::string& _url,
-                               const std::string& method,
-                               const std::string& version) :
-  full_url(_url),
-  url(_url),
-  valid_url(true),
-  version(version),
-  acceptEncodingDeflate(false),
-  accept_range(false),
-  range_pair(0, -1)
-{
-  if (method == "GET") {
-    this->method = RequestMethod::GET;
-  } else if (method == "HEAD") {
-    this->method = RequestMethod::HEAD;
-  } else if (method == "POST") {
-    this->method = RequestMethod::POST;
-  } else if (method == "PUT") {
-    this->method = RequestMethod::PUT;
-  } else if (method == "DELETE") {
-    this->method = RequestMethod::DELETE_;
-  } else if (method == "CONNECT") {
-    this->method = RequestMethod::CONNECT;
-  } else if (method == "OPTIONS") {
-    this->method = RequestMethod::OPTIONS;
-  } else if (method == "TRACE") {
-    this->method = RequestMethod::TRACE;
-  } else if (method == "PATCH") {
-    this->method = RequestMethod::PATCH;
-  } else {
-    this->method = RequestMethod::OTHER;
-  }
-
-  MHD_get_connection_values(connection, MHD_HEADER_KIND, &RequestContext::fill_header, this);
-  MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND, &RequestContext::fill_argument, this);
-
-  valid_url = true;
-  if (rootLocation.empty()) {
-    // nothing special to handle.
-    url = full_url;
-  } else {
-    if (full_url.size() > rootLocation.size() &&
-        full_url.substr(0, rootLocation.size()+1) == rootLocation + "/") {
-      url = full_url.substr(rootLocation.size());
-    } else {
-      valid_url = false;
-    }
-  }
-
-  try {
-    acceptEncodingDeflate =
-        (get_header(MHD_HTTP_HEADER_ACCEPT_ENCODING).find("deflate") != std::string::npos);
-  } catch (const std::out_of_range&) {}
-
-  /*Check if range is requested. */
-  try {
-    auto range = get_header(MHD_HTTP_HEADER_RANGE);
-    int start = 0;
-    int end = -1;
-    std::istringstream iss(range);
-    char c;
-
-    iss >> start >> c;
-    if (iss.good() && c=='-') {
-      iss >> end;
-      if (iss.fail()) {
-        // Something went wrong will extracting.
-        end = -1;
-      }
-      if (iss.eof()) {
-        accept_range = true;
-        range_pair = std::pair<int, int>(start, end);
-      }
-    }
-  } catch (const std::out_of_range&) {}
-
-
-}
-
-RequestContext::~RequestContext()
-{}
-
-
-int RequestContext::fill_header(void *__this, enum MHD_ValueKind kind,
-                                 const char *key, const char *value)
-{
-  RequestContext *_this = static_cast<RequestContext*>(__this);
-  _this->headers[key] = value;
-  return MHD_YES;
-}
-
-int RequestContext::fill_argument(void *__this, enum MHD_ValueKind kind,
-                                   const char *key, const char* value)
-{
-  RequestContext *_this = static_cast<RequestContext*>(__this);
-  _this->arguments[key] = value == nullptr ? "" : value;
-  return MHD_YES;
-}
-
-void RequestContext::print_debug_info() {
-  printf("method    : %s (%d)\n", method==RequestMethod::GET ? "GET" :
-                                  method==RequestMethod::POST ? "POST" :
-                                  "OTHER", (int)method);
-  printf("version   : %s\n", version.c_str());
-  printf("headers   :\n");
-  for (auto it=headers.begin(); it!=headers.end(); it++) {
-    printf(" - %s : '%s'\n", it->first.c_str(), it->second.c_str());
-  }
-  printf("arguments :\n");
-  for (auto it=arguments.begin(); it!=arguments.end(); it++) {
-    printf(" - %s : '%s'\n", it->first.c_str(), it->second.c_str());
-  }
-  printf("Parsed : \n");
-  printf("url   : %s\n", url.c_str());
-  printf("acceptEncodingDeflate : %d\n", acceptEncodingDeflate);
-  printf("has_range : %d\n", accept_range);
-  printf(".............\n");
-}
-
-
-RequestMethod RequestContext::get_method() {
-  return method;
-}
-
-std::string RequestContext::get_url() {
-  return url;
-}
-
-std::string RequestContext::get_url_part(int number) {
-  size_t start = 1;
-  while(true) {
-    auto found = url.find('/', start);
-    if (number == 0) {
-      if (found == std::string::npos) {
-        return url.substr(start);
-      } else {
-        return url.substr(start, found-start);
-      }
-    } else {
-      if (found == std::string::npos) {
-        throw std::out_of_range("No parts");
-      }
-      start = found + 1;
-      number -= 1;
-    }
-  }
-}
-
-std::string RequestContext::get_full_url() {
-  return full_url;
-}
-
-bool RequestContext::is_valid_url() {
-  return valid_url;
-}
-
-bool RequestContext::has_range() {
-  return accept_range;
-}
-
-std::pair<int, int> RequestContext::get_range() {
-  return range_pair;
-}
-
-template<>
-std::string RequestContext::get_argument(const std::string& name) {
-  return arguments.at(name);
-}
-
-std::string RequestContext::get_header(const std::string& name) {
-  return headers.at(name);
-}

src/server/request_context.h

@@ -1,108 +0,0 @@
-/*
- * Copyright 2009-2016 Emmanuel Engelhart <kelson@kiwix.org>
- * 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 REQUEST_CONTEXT_H
-#define REQUEST_CONTEXT_H
-
-#include <string>
-#include <sstream>
-#include <map>
-#include <stdexcept>
-
-extern "C" {
-#include <microhttpd.h>
-}
-
-enum class RequestMethod {
-    GET,
-    HEAD,
-    POST,
-    PUT,
-    DELETE_,
-    CONNECT,
-    OPTIONS,
-    TRACE,
-    PATCH,
-    OTHER
-};
-
-class KeyError : public std::runtime_error {};
-class IndexError: public std::runtime_error {};
-
-
-class RequestContext {
-  public:
-    RequestContext(struct MHD_Connection* connection,
-                   std::string rootLocation,
-                   const std::string& url,
-                   const std::string& method,
-                   const std::string& version);
-    ~RequestContext();
-
-    void print_debug_info();
-
-    bool is_valid_url();
-
-    std::string get_header(const std::string& name);
-    template<typename T=std::string>
-    T get_argument(const std::string& name) {
-        std::istringstream stream(arguments.at(name));
-        T v;
-        stream >> v;
-        return v;
-    }
-
-
-    RequestMethod get_method();
-    std::string get_url();
-    std::string get_url_part(int part);
-    std::string get_full_url();
-
-    bool has_range();
-    std::pair<int, int> get_range();
-
-    bool can_compress() { return acceptEncodingDeflate; }
-
-    // [TODO] Move this to the response builder
-    int httpResponseCode;
-
-  private:
-    std::string full_url;
-    std::string url;
-    bool valid_url;
-    RequestMethod method;
-    std::string version;
-
-    bool acceptEncodingDeflate;
-
-    bool accept_range;
-    std::pair<int, int> range_pair;
-    std::map<std::string, std::string> headers;
-    std::map<std::string, std::string> arguments;
-
-    static int fill_header(void *, enum MHD_ValueKind, const char*, const char*);
-    static int fill_argument(void *, enum MHD_ValueKind, const char*, const char*);
-};
-
-template<> std::string RequestContext::get_argument(const std::string& name);
-
-
-#endif //REQUEST_CONTEXT_H

src/version.h

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2009-2016 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_TOOLS_VERSION_H_
+#define _KIWIX_TOOLS_VERSION_H_
+
+#ifndef KIWIX_TOOLS_VERSION
+  #define KIWIX_TOOLS_VERSION "undefined"
+#endif
+
+#include <kiwix/version.h>
+#include <zim/version.h>
+
+void version()
+{
+  std::cout << "kiwix-tools " << KIWIX_TOOLS_VERSION << std::endl << std::endl;
+  kiwix::printVersions();
+  std::cout << std::endl;
+  zim::printVersions();
+}
+
+#endif //_KIWIX_TOOLs_VERSION_H_

static/meson.build

@@ -1,4 +0,0 @@
-
-res_compiler = find_program('kiwix-compile-resources', 'compile_resources.py')
-
-subdir('server')

static/server/global_taskbar.html.part

@@ -1,13 +0,0 @@
-<span class="kiwix">
-  <span id="kiwixtoolbar" class="ui-widget-header">
-    <div class="kiwix_centered">
-      <div class="kiwix_searchform" style="margin: auto auto;float: none;">
-        <form class="kiwixsearch" method="GET" action="__ROOT_LOCATION__/search" id="kiwixsearchform">
-          <label for="kiwixsearchbox" style="line-height: 30px;">&#x1f50d;</label>
-          <input autocomplete="off" class="ui-autocomplete-input" id="kiwixsearchbox" name="pattern" type="text">
-        </form>
-      </div>
-    </div>
-  </span>
-</span>
-<div style="display: block; height: 5em;"></div>

static/server/home.html.tmpl

@@ -1,56 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-  <meta charset="UTF-8" />
-  <title>Welcome to Kiwix Server</title>
-  <script type="text/javascript" src="__ROOT_LOCATION__/skin/jquery-ui/external/jquery/jquery.js"></script>
-  <script type="text/javascript" src="__ROOT_LOCATION__/skin/jquery-ui/jquery-ui.min.js"></script>
-  <link type="text/css" href="__ROOT_LOCATION__/skin/jquery-ui/jquery-ui.min.css" rel="Stylesheet" />
-  <link type="text/css" href="__ROOT_LOCATION__/skin/jquery-ui/jquery-ui.theme.min.css" rel="Stylesheet" />
-  <style>
-    	body {
-	        background:
-     	        radial-gradient(#EEEEEE 15%, transparent 16%) 0 0,
-	        radial-gradient(#EEEEEE 15%, transparent 16%) 8px 8px,
-	        radial-gradient(rgba(255,255,255,.1) 15%, transparent 20%) 0 1px,
-	        radial-gradient(rgba(255,255,255,.1) 15%, transparent 20%) 8px 9px;
-	        background-color:#E8E8E8;
-	        background-size:16px 16px;
-          	margin-left: auto;
-        	margin-right: auto;
-        	max-width: 1100px;
-	}
-	.book__list { text-align: center; }
-	.book {
-		display: inline-block; vertical-align: bottom; margin: 8px; padding: 12px 15px; width: 300px;
-		border: 1px solid #ccc; border-radius: 8px;
-	        text-align: left; color: #000; font-family: sans-serif; font-size: 13px;
-	        background-color:#F1F1F1;
-	        box-shadow: 2px 2px 5px 0px #ccc;
-	}
-	.book:hover { background-color: #F9F9F9; box-shadow: none;}
-	.book__background { background-repeat: no-repeat; background-size: auto; background-position: top right; }
-	.book__title {
-		padding: 0 55px 0 0; overflow: hidden; text-overflow: ellipsis; white-space: nowrap;
-		font-size: 18px; color: #0645ad;
-	}
-	.book__description {
-		padding: 5px 55px 5px 0px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap;
-		font-size: 15px;
-	}
-	.book__info { line-height: 18px; color: #777; font-weight: bold; font-size: 13px; }
-  </style>
-  <script type="text/javascript" src="__ROOT_LOCATION__/skin/taskbar.js" async></script>
-</head>
-<body class="kiwix">
-
-<div class="kiwix">
-  __BOOKS__
-</div>
-
-<div id="kiwixfooter">
-  Powered by <a href="https://kiwix.org">Kiwix</a>
-</div>
-
-</body>
-</html>

static/server/include.html.part

@@ -1,28 +0,0 @@
-<link type="text/css" href="__ROOT_LOCATION__/skin/jquery-ui/jquery-ui.min.css" rel="Stylesheet" />
-<link type="text/css" href="__ROOT_LOCATION__/skin/jquery-ui/jquery-ui.theme.min.css" rel="Stylesheet" />
-<link type="text/css" href="__ROOT_LOCATION__/skin/taskbar.css" rel="Stylesheet" />
-<script type="text/javascript" src="__ROOT_LOCATION__/skin/jquery-ui/external/jquery/jquery.js"></script>
-<script type="text/javascript" src="__ROOT_LOCATION__/skin/jquery-ui/jquery-ui.min.js"></script>
-<script>
-  var jk = jQuery.noConflict();
-  jk(function() {
-  jk( "#kiwixsearchbox" ).autocomplete({
-
-  source: "__ROOT_LOCATION__/suggest?content=__CONTENT_ESCAPED__",
-  dataType: "json",
-  cache: false,
-
-  select: function(event, ui) {
-  jk( "#kiwixsearchbox" ).val(ui.item.value);
-  jk( "#kiwixsearchform" ).submit();
-  },
-
-  });
-  });
-
-  /* cybook hack */
-  if (navigator.userAgent.indexOf("bookeen/cybook") != -1) {
-  	jk("html").addClass("cybook");
-  }
-</script>
-<script type="text/javascript" src="__ROOT_LOCATION__/skin/taskbar.js" async></script>

static/server/meson.build

@@ -1,8 +0,0 @@
-
-server_resources = custom_target('resources',
-  input: 'resources_list.txt',
-  output: ['server-resources.cpp', 'server-resources.h'],
-  command:[res_compiler, '--cxxfile', '@OUTPUT0@', '--hfile', '@OUTPUT1@', '@INPUT@'],
-  build_always: true
-)
-  

static/server/opensearchdescription.xml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
-  <ShortName>Zim catalog search</ShortName>
-  <Description>Search zim files in the catalog.</Description>
-  <Url type="application/atom+xml;profile=opds-catalog" 
-       xmlns:atom="http://www.w3.org/2005/Atom"
-       indexOffset="0"
-       template="/__ROOT_LOCATION__/catalog/search?q={searchTerms}&lang={language}&count={count}&start={startIndex}"/>
-</OpenSearchDescription>

static/server/resources_list.txt

@@ -1,27 +0,0 @@
-jquery-ui/jquery-ui.structure.min.css
-jquery-ui/jquery-ui.min.js
-jquery-ui/external/jquery/jquery.js
-jquery-ui/images/ui-bg_flat_0_aaaaaa_40x100.png
-jquery-ui/images/ui-bg_flat_75_ffffff_40x100.png
-jquery-ui/images/ui-icons_222222_256x240.png
-jquery-ui/images/ui-bg_glass_55_fbf9ee_1x400.png
-jquery-ui/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-jquery-ui/images/ui-bg_glass_65_ffffff_1x400.png
-jquery-ui/images/ui-icons_2e83ff_256x240.png
-jquery-ui/images/ui-icons_cd0a0a_256x240.png
-jquery-ui/images/ui-icons_888888_256x240.png
-jquery-ui/images/ui-bg_glass_75_e6e6e6_1x400.png
-jquery-ui/images/animated-overlay.gif
-jquery-ui/images/ui-bg_glass_75_dadada_1x400.png
-jquery-ui/images/ui-icons_454545_256x240.png
-jquery-ui/images/ui-bg_glass_95_fef1ec_1x400.png
-jquery-ui/jquery-ui.theme.min.css
-jquery-ui/jquery-ui.min.css
-home.html.tmpl
-include.html.part
-caret.png
-taskbar.js
-taskbar.css
-taskbar.html.part
-global_taskbar.html.part
-opensearchdescription.xml

static/server/taskbar.css

@@ -1,186 +0,0 @@
-#kiwixtoolbar {
-    position: fixed;
-    padding: .5em;
-    left: 0;
-    right: 0;
-    top: 0;
-    z-index: 100;
-    background-position-y: 0px;
-    transition: 0.3s;
-    width: 100%;
-    box-sizing: border-box;
-}
-
-#kiwixtoolbar>a {
-    float: left;
-}
-
-#kiwixfooter {
-    text-align: center;
-    margin-top: 1em;
-}
-
-.height_separator {
-    height: 3em;
-}
-
-.kiwixsearch {
-    position: relative;
-    height: 26px;
-    width: 100%;
-    left: 0;
-    margin-bottom: 0;
-}
-
-.kiwix_searchform {
-    width: 20em;
-}
-
-#kiwix_serve_taskbar_home_button button {
-    overflow: hidden;
-    text-overflow: ellipsis;
-    white-space: nowrap;
-    max-width: 160px;
-}
-
-.kiwix .kiwix_centered {
-    max-width: 720px;
-    margin: 0 auto;
-}
-
-#kiwix_button_show_toggle {
-    display: none;
-}
-
-#kiwix_button_show_toggle:checked~label~.kiwix_button_cont,
-#kiwix_button_show_toggle:checked~label~.kiwix_button_cont>a {
-    display: block;
-}
-
-#kiwix_button_show_toggle:not(:checked)~label~.kiwix_button_cont {
-    display: none;
-}
-
-label[for="kiwix_button_show_toggle"] {
-    display: inline-block;
-    height: 26px;
-}
-
-label[for="kiwix_button_show_toggle"] img {
-    transition: 0.1s;
-    height: 26px;
-}
-
-#kiwix_button_show_toggle:checked~label img {
-    transform: rotate(-180deg);
-}
-
-label[for="kiwix_button_show_toggle"],
-.kiwix_button_cont {
-    display: block;
-}
-
-.kiwix .kiwix_searchform {
-    float: right;
-}
-
-.kiwix #kiwixtoolbar button,
-.kiwix #kiwixtoolbar input[type="submit"] {
-    box-sizing: border-box !important;
-    height: 26px !important;
-    line-height: 20px !important;
-    margin-right: 5px !important;
-    padding: 2px 6px !important;
-    border: 1px solid #999 !important;
-    border-radius: 3px !important;
-    background-color: #ededed !important;
-    font-weight: normal !important;
-    cursor: pointer !important;
-    font-size: 16px !important;
-}
-
-.kiwix #kiwixtoolbar #kiwixsearchform input[type='text'] {
-    position: absolute;
-    left: 0;
-    box-sizing: border-box !important;
-    width: 100%;
-    height: 26px !important;
-    line-height: 20px !important;
-    border: 1px solid #999 !important;
-    border-radius: 3px !important;
-    background-color: #fff !important;
-    padding: 2px 2px 2px 27px !important;
-    font-size: 16px !important;
-}
-
-label[for=kiwixsearchbox] {
-    z-index: 1;
-    position: absolute;
-    height: 100%;
-    left: 5px;
-    font-size: 90%;
-    line-height: 26px;
-    vertical-align: middle;
-}
-
-body {
-    padding-top: 40px !important;
-}
-
-/* Try to fix buggy stuff in jquery-ui autocomplete */
-#ui-id-1,
-.ui-autocomplete {
-    background: white !important;
-    border: solid 1px grey !important;
-}
-
-li.ui-state-focus {
-    font-weight: bold;
-}
-
-@media(min-width:420px) {
-    .kiwix_button_cont {
-        display: inline-block !important;
-    }
-
-    .kiwix_button_cont>a {
-        display: inline-block !important;
-    }
-
-    label[for="kiwix_button_show_toggle"] {
-        display: none;
-    }
-}
-
-@media (max-width: 645px) {
-
-    #kiwix_button_show_toggle~label~.kiwix_button_cont.searching {
-        display: none !important;
-    }
-
-    label[for="kiwix_button_show_toggle"].searching {
-        display: none !important;
-    }
-
-    .kiwix_searchform.full_width {
-        width: 100%;
-    }
-
-    .kiwixsearch {
-        float: none;
-    }
-
-    .kiwix_searchform {
-        width: 36%;
-    }
-
-    .height_separator {
-        height: 6em;
-    }
-}
-
-@media(max-width:415px) {
-    .kiwix_searchform {
-        width: 80%;
-    }
-}

static/server/taskbar.html.part

@@ -1,21 +0,0 @@
-<span class="kiwix">
-  <span id="kiwixtoolbar" class="ui-widget-header">
-    <div class="kiwix_centered">
-      <div class="kiwix_searchform">
-        <form class="kiwixsearch" method="GET" action="__ROOT_LOCATION__/search" id="kiwixsearchform">
-          <input type="hidden" name="content" value="__CONTENT__" />
-          <label for="kiwixsearchbox">&#x1f50d;</label>
-          <input autocomplete="off" class="ui-autocomplete-input" id="kiwixsearchbox" name="pattern" type="text">
-        </form>
-      </div>
-      <input type="checkbox" id="kiwix_button_show_toggle">
-      <label for="kiwix_button_show_toggle"><img src="__ROOT_LOCATION__/skin/caret.png" alt=""></label>
-      <div class="kiwix_button_cont">
-        <a id="kiwix_serve_taskbar_library_button" href="__ROOT_LOCATION__/"><button>&#x1f3e0;</button></a>
-        <a id="kiwix_serve_taskbar_home_button" href="__ROOT_LOCATION__/__CONTENT__/"><button>__ZIM_TITLE__</button></a>
-        <a id="kiwix_serve_taskbar_random_button"
-          href="__ROOT_LOCATION__/random?content=__CONTENT_ESCAPED__"><button>&#x1F3B2;</button></a>
-      </div>
-    </div>
-  </span>
-</span>

static/server/taskbar.js

@@ -1,49 +0,0 @@
-
-(function ($) {
-    if ($(window).width() < 520) {
-        var didScroll;
-        var lastScrollTop = 0;
-        var delta = 5;
-        // on scroll, let the interval function know the user has scrolled
-        $(window).scroll(function (event) {
-            didScroll = true;
-        });
-        // run hasScrolled() and reset didScroll status
-        setInterval(function () {
-            if (didScroll) {
-                hasScrolled();
-                didScroll = false;
-            }
-        }, 250);
-        function hasScrolled() {
-            var st = $(this).scrollTop();
-
-            // Make sure they scroll more than delta
-            if (Math.abs(lastScrollTop - st) <= delta)
-                return;
-
-            // If they scrolled down and are past the navbar, add class .nav-up.
-            // This is necessary so you never see what is "behind" the navbar.
-            if (st > lastScrollTop) {
-                // Scroll Down
-                $('#kiwixtoolbar').css({ top: '-100%' });
-            } else {
-                // Scroll Up
-                $('#kiwixtoolbar').css({ top: '0' });
-            }
-
-            lastScrollTop = st;
-        }
-    }
-
-    $('#kiwixsearchbox').on({
-        focus: function () {
-            $('.kiwix_searchform').addClass('full_width');
-            $('label[for="kiwix_button_show_toggle"], .kiwix_button_cont').addClass('searching');
-        },
-        blur: function () {
-            $('.kiwix_searchform').removeClass('full_width');
-            $('label[for="kiwix_button_show_toggle"], .kiwix_button_cont').removeClass('searching');
-        }
-    });
-})(jQuery);

travis/compile.sh

@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-BUILD_DIR=${HOME}/BUILD_${PLATFORM}
-INSTALL_DIR=${BUILD_DIR}/INSTALL
-
-
-case ${PLATFORM} in
-    "native_static")
-         MESON_OPTION="-Dstatic-linkage=true"
-         ;;
-    "native_dyn")
-         MESON_OPTION=""
-         ;;
-    "win32_static")
-         MESON_OPTION="-Dstatic-linkage=true --cross-file ${BUILD_DIR}/meson_cross_file.txt"
-         ;;
-    "win32_dyn")
-         MESON_OPTION="--cross-file ${BUILD_DIR}/meson_cross_file.txt"
-         ;;
-esac
-
-cd ${TRAVIS_BUILD_DIR}
-export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/x86_64-linux-gnu/pkgconfig
-export PATH=${INSTALL_DIR}/bin:$PATH
-meson . build ${MESON_OPTION}
-cd build
-ninja

travis/install_deps.sh

@@ -1,49 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-REPO_NAME=${TRAVIS_REPO_SLUG#*/}
-ARCHIVE_NAME=deps_linux_xenial_${PLATFORM}_${REPO_NAME}.tar.xz
-
-# Packages.
-case ${PLATFORM} in
-     "native_static")
-         PACKAGES="gcc python3.5 cmake libbz2-dev ccache zlib1g-dev uuid-dev"
-         ;;
-     "native_dyn")
-         PACKAGES="gcc python3.5 cmake libbz2-dev ccache zlib1g-dev uuid-dev libmicrohttpd-dev"
-         ;;
-     "win32_static")
-         PACKAGES="g++-mingw-w64-i686 gcc-mingw-w64-i686 gcc-mingw-w64-base mingw-w64-tools ccache python3.5"
-         ;;
-     "win32_dyn")
-         PACKAGES="g++-mingw-w64-i686 gcc-mingw-w64-i686 gcc-mingw-w64-base mingw-w64-tools ccache python3.5"
-         ;;
-     "android_arm")
-         PACKAGES="gcc python3.5 cmake ccache"
-         ;;
-     "android_arm64")
-         PACKAGES="gcc python3.5 cmake ccache"
-         ;;
-esac
-
-sudo apt-get update -qq
-sudo apt-get install -qq python3-pip ${PACKAGES}
-wget https://bootstrap.pypa.io/get-pip.py
-python3.5 get-pip.py --user
-python3.5 -m pip install --user --upgrade pip
-python3.5 -m pip install --user meson==0.49.2
-
-# Ninja
-cd $HOME
-git clone git://github.com/ninja-build/ninja.git
-cd ninja
-git checkout release
-./configure.py --bootstrap
-sudo cp ninja /bin
-
-# Dependencies comming from kiwix-build.
-cd ${HOME}
-wget http://tmp.kiwix.org/ci/${ARCHIVE_NAME}
-tar xf ${HOME}/${ARCHIVE_NAME}
-sudo ln -s travis ../ci_builder