Adapt kiwix-tools to new libkiwix API.

Added missing parameters to kiwix-serve.1

.github/workflows/ci.yml

@@ -36,22 +36,12 @@ jobs:
       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'])
+      uses: actions/checkout@v3
     - 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
+        wget -O- http://tmp.kiwix.org/ci/${ARCHIVE_NAME} | tar -xJ -C ${{env.HOME}}
     - name: Compile
       shell: bash
       run: |
@@ -63,10 +53,9 @@ jobs:
         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"
+        PKG_CONFIG_PATH: "${{env.HOME}}/BUILD_${{matrix.target}}/INSTALL/lib/pkgconfig:${{env.HOME}}/BUILD_${{matrix.target}}/INSTALL/lib${{matrix.lib_postfix}}/pkgconfig"
+        CPPFLAGS: "-I${{env.HOME}}/BUILD_${{matrix.target}}/INSTALL/include"

.github/workflows/docker.yml

@@ -28,8 +28,10 @@ jobs:
             VERSION={tag}
           platforms: |
             linux/amd64
-            linux/arm/v7
             linux/arm64
+            linux/arm/v7
+            linux/arm/v6
+            linux/386
           restrict-to: kiwix/kiwix-tools
           manual-tag: ${{ github.event.inputs.version }}
           repo_description: auto
@@ -55,8 +57,10 @@ jobs:
             VERSION={tag}
           platforms: |
             linux/amd64
-            linux/arm/v7
             linux/arm64
+            linux/arm/v7
+            linux/arm/v6
+            linux/386
           restrict-to: kiwix/kiwix-tools
           manual-tag: ${{ github.event.inputs.version }}
           repo_description: auto

Changelog

@@ -1,3 +1,8 @@
+Unreleased
+==========
+
+ * Additional docker images archs for armv6 and i386.
+
 kiwix-tools 3.5.0
 =================
 

docker/Dockerfile

@@ -1,12 +1,25 @@
-FROM alpine:3.16
+FROM alpine:3.18
 LABEL org.opencontainers.image.source https://github.com/openzim/kiwix-tools
+
+# TARGETPLATFORM is injected by docker build
+ARG TARGETPLATFORM
 ARG VERSION
 
-RUN apk --no-cache add dumb-init curl && \
-    ARCH=$(cat /etc/apk/arch) && \
-    if [ "$ARCH" = "x86" ]; then ARCH="i586"; \
-    elif [ "$ARCH" = "aarch64" ]; then ARCH="armhf"; \
-    elif [ "$ARCH" = "armv7" ]; then ARCH="armhf"; fi && \
+RUN set -e && \
+    apk --no-cache add dumb-init curl && \
+    echo "TARGETPLATFORM: $TARGETPLATFORM" && \
+    if [ "$TARGETPLATFORM" = "linux/386" ]; then ARCH="i586"; \
+    # linux/arm64/v8 points to linux/arm64
+    elif [ "$TARGETPLATFORM" = "linux/arm64/v8" \
+        -o "$TARGETPLATFORM" = "linux/arm64" ]; then ARCH="aarch64"; \
+    # linux/arm translates to linux/arm/v7
+    elif [ "$TARGETPLATFORM" = "linux/arm/v7" ]; then ARCH="armv8"; \
+    elif [ "$TARGETPLATFORM" = "linux/arm/v6" ]; then ARCH="armv6"; \
+    elif [ "$TARGETPLATFORM" = "linux/amd64/v3" \
+        -o "$TARGETPLATFORM" = "linux/amd64/v2" \
+        -o "$TARGETPLATFORM" = "linux/amd64" ]; then ARCH="x86_64"; \
+    # we dont suppot any other arch so let it fail
+    else ARCH="unknown"; fi && \
     # download requested kiwix-tools version
     url="http://mirror.download.kiwix.org/release/kiwix-tools/kiwix-tools_linux-$ARCH-$VERSION.tar.gz" && \
     echo "URL: $url" && \

docker/README.md

@@ -30,3 +30,7 @@ docker run -v $(pwd):/data -it ghcr.io/kiwix/kiwix-tools kiwix-search /data/wiki
 
 - `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.
+
+## See also
+
+If you are interested by a Kiwix server only container image, [here it is](server/README.md).

docker/server/README.md

@@ -12,6 +12,12 @@ With local ZIM file(s)
 docker run -v /tmp/zim:/data -p 8080:8080 ghcr.io/kiwix/kiwix-serve wikipedia.zim wiktionary.zim
 ```
 
+or, if you want to load all ZIM files within a directory, then use globbing:
+
+```bash
+docker run -v /tmp/zim:/data -p 8080:8080 ghcr.io/kiwix/kiwix-serve '*.zim'
+```
+
 With remote ZIM file
 --------------------
 

docker/server/docker-compose.yml.example

@@ -3,7 +3,7 @@ services:
   kiwix-serve:
       ports:
         - 8080:8080
-      image: kiwix/kiwix-serve
+      image: ghcr.io/kiwix/kiwix-serve:latest
       # uncomment next 4 lines to use it with local zim file in /tmp/zim
       # volumes:
       #   - /tmp/zim:/data

src/man/kiwix-serve.1

@@ -1,60 +1,132 @@
-.TH KIWIX 1 "21 May 2012"
+.TH KIWIX 1 "10 July 2023"
+
 .SH NAME
-kiwix\-serve \- Kiwix HTTP Server
+kiwix-serve \- Kiwix HTTP Server
+
 .SH SYNOPSIS
-.IX Header "SYNOPSIS"
+
+.B kiwix-serve --library [OPTIONS] LIBRARY_FILE_PATH
 .br
-kiwix\-serve [\-\-index=INDEX_PATH] [\-\-port=PORT] [\-\-verbose] [\-\-daemon] [\-\-attachToProcess=PID] ZIM_PATH
-.br
-kiwix\-serve \-\-library [\-\-port=PORT] [\-\-verbose] [\-\-daemon] [\-\-attachToProcess=PID] LIBRARY_PATH
+.B kiwix-serve [OPTIONS] ZIM_FILE_PATH ...
+
 .SH DESCRIPTION
-.PP
-Stand\-alone HTTP server for serving ZIM contents over the network.
+The \fBkiwix-serve\fR command is used to run a stand-alone HTTP server for serving ZIM contents over the network.
+
+.SH ARGUMENTS
+.TP
+\fBLIBRARY_FILE_PATH\fR
+Path of an XML library file listing ZIM files to serve. To be used only with the --library option. Multiple library files can be provided as a semicolon (;) separated list.
 
 .TP
-\fB\-\-index=INDEX_PATH\fR
-Path to index folder created using \fBkiwix-install\fB.
+\fBZIM_FILE_PATH ...\fR
+ZIM file path(s). Multiple arguments are allowed.
+
+.SH OPTIONS
+.TP
+\fB--library\fR
+By default, kiwix-serve expects a list of ZIM files as command line arguments. Providing the --library option tells kiwix-serve that the command line argument is rather a library XML file.
 
 .TP
-\fB\-\-port=PORT\fR
-Port number on which the server should listen.
+\fB-i ADDR, --address=ADDR\fR
+Listen only on this IP address. By default, the server listens on all available IP addresses.
+
+.TP
+\fB-p PORT, --port=PORT\fR
+TCP port on which to listen for HTTP requests (default: 80).
+
+.TP
+\fB-r ROOT, --urlRootLocation=ROOT\fR
+URL prefix on which the content should be made available (default: empty).
+
+.TP
+\fB-d, --daemon\fR
+Detach the HTTP server daemon from the main process.
+
+.TP
+\fB-a PID, --attachToProcess=PID\fR
+Exit when the process with id PID stops running.
+
+.TP
+\fB-M, --monitorLibrary\fR
+Monitor the XML library file and reload it automatically when it changes.
+
+Library reloading can be forced anytime by sending a SIGHUP signal to the
+\*(lqkiwix-serve\*(rq process (this works regardless of the presence of the
+\*(lq--monitorLibrary\*(rq/\*(lq-M\*(rq option).
+
+.TP
+\fB-m, --nolibrarybutton\fR
+Disable the library home button in the ZIM viewer toolbar.
+
+.TP
+\fB-n, --nosearchbar\fR
+Disable the search box in the ZIM viewer toolbar.
+
+.TP
+\fB-b, --blockexternal\fR
+Prevent users from directly navigating to external resources via links in ZIM content.
+
+.TP
+\fB-t N, --threads=N\fR
+Number of threads to run in parallel (default: 4).
+
+.TP
+\fB-s N, --searchLimit=N\fR
+Maximum number of ZIM files in a fulltext multizim search (default: No limit).
+
+.TP
+\fB-z, --nodatealiases\fR
+Create URL aliases for each content by removing the date embedded in the file name.
+
+The expected format of the date in the filename is \*(lq_YYYY-MM\*(rq. For example, a ZIM file named \*(lqwikipedia_en_all_2020-08.zim\*(rq will be accessible both as \*(lqwikipedia_en_all_2020-08\*(rq and \*(lqwikipedia_en_all\*(rq.
+
+.TP
+\fB-c PATH, --customIndex=PATH\fR
+Override the welcome page with a custom HTML file.
+
+.TP
+\fB-L N, --ipConnectionLimit=N\fR
+Max number of (concurrent) connections per IP (default: infinite, recommended: >= 6).
+
+.TP
+\fB-v, --verbose\fR
+Print debug log to STDOUT.
+
+.TP
+\fB-V, --version\fR
+Print the software version.
+
+.TP
+\fB-h, --help\fR
+Print a help message.
+
+.SH EXAMPLES
+Serve a single ZIM file:
+.sp
+.nf
+.B kiwix-serve myzim.zim
+.fi
+
+Serve multiple ZIM files:
+.sp
+.nf
+.B kiwix-serve zim1.zim zim2.zim zim3.zim
+.fi
+
+Serve ZIM files from a library:
+.sp
+.nf
+.B kiwix-serve --library library.xml
+.fi
+
+.SH DOCUMENTATION
+Online documentation: https://kiwix-tools.readthedocs.io/en/latest/kiwix-serve.html
 .br
-By default, server listens on port 80.
-
-.TP
-\fB\-\-verbose\fR
-Enable verbose output.
-
-.TP
-\fB\-\-daemon\fR
-Run the server as a daemon.
-
-.TP
-\fB\-\-attachToProcess=PID\fR
-Shutdown the server when process numbered PID dies.
-
-.TP
-\fBZIM_PATH\fR
-ZIM file of the content to serve.
+Source code: https://github.com/kiwix/kiwix-tools
 .br
-Mandatory if not in library mode.
+More info: https://wiki.kiwix.org/wiki/Kiwix-serve
 
-.TP
-\fB\-\-library\fR
-Enable library mode.
-.br
-Serves the contents of a library file instead of a single ZIM file.
-
-.TP
-\fBLIBRARY_PATH\fR
-Kiwix library file path.
-.br
-Library is an XML file created using \fBkiwix-manage\fB.
-
-.SH SEE ALSO
-kiwix(1) kiwix\-manage(1)
-
-.SH AUTHOR
+.SH AUTHORS
 Emmanuel Engelhart <kelson@kiwix.org>
 .br
-Vasudev Kamath <kamathvasudev@gmail.com> (Manual)
+Vasudev Kamath <kamathvasudev@gmail.com>

src/manager/kiwix-manage.cpp

@@ -29,10 +29,10 @@ using namespace std;
 
 enum supportedAction { NONE, ADD, SHOW, REMOVE };
 
-void show(kiwix::Library* library, const std::string& bookId)
+void show(const kiwix::Library& library, const std::string& bookId)
 {
   try {
-    auto& book = library->getBookById(bookId);
+    auto& book = library.getBookById(bookId);
     std::cout << "id:\t\t" << book.getId() << std::endl
               << "path:\t\t" << book.getPath() << std::endl
               << "url:\t\t" << book.getUrl() << std::endl
@@ -96,7 +96,7 @@ void usage()
             << std::endl;
 }
 
-int handle_show(kiwix::Library* library, const std::string& libraryPath,
+int handle_show(const kiwix::Library& library, const std::string& libraryPath,
                  int argc, char* argv[])
 {
   if (argc > 3 ) {
@@ -105,7 +105,7 @@ int handle_show(kiwix::Library* library, const std::string& libraryPath,
        show(library, bookId);
     }
   } else {
-    auto booksIds = library->getBooksIds();
+    auto booksIds = library.getBooksIds();
     for(auto& bookId: booksIds) {
       show(library, bookId);
     }
@@ -113,7 +113,7 @@ int handle_show(kiwix::Library* library, const std::string& libraryPath,
   return(0);
 }
 
-int handle_add(kiwix::Library* library, const std::string& libraryPath,
+int handle_add(std::shared_ptr<kiwix::Library> library, const std::string& libraryPath,
                 int argc, char* argv[])
 {
   string zimPath;
@@ -182,7 +182,7 @@ int handle_add(kiwix::Library* library, const std::string& libraryPath,
   return(resultCode);
 }
 
-int handle_remove(kiwix::Library* library, const std::string& libraryPath,
+int handle_remove(std::shared_ptr<kiwix::Library> library, const std::string& libraryPath,
                    int argc, char* argv[])
 {
   std::string bookId;
@@ -216,7 +216,7 @@ int main(int argc, char** argv)
 {
   string libraryPath = "";
   supportedAction action = NONE;
-  kiwix::Library library;
+  auto library = std::make_shared<kiwix::Library>();
 
   /* General argument parsing */
   static struct option long_options[] = {
@@ -261,7 +261,7 @@ int main(int argc, char** argv)
   libraryPath = kiwix::isRelativePath(libraryPath)
                     ? kiwix::computeAbsolutePath(kiwix::getCurrentDirectory(), libraryPath)
                     : libraryPath;
-  kiwix::Manager manager(&library);
+  kiwix::Manager manager(library);
   if (!manager.readFile(libraryPath, false)) {
     if (kiwix::fileExists(libraryPath) || action!=ADD) {
       std::cerr << "Cannot read the library " << libraryPath << std::endl;
@@ -273,13 +273,13 @@ int main(int argc, char** argv)
   int exitCode = 0;
   switch (action) {
     case SHOW:
-      exitCode = handle_show(&library, libraryPath, argc, argv);
+      exitCode = handle_show(*library, libraryPath, argc, argv);
       break;
     case ADD:
-      exitCode = handle_add(&library, libraryPath, argc, argv);
+      exitCode = handle_add(library, libraryPath, argc, argv);
       break;
     case REMOVE:
-      exitCode = handle_remove(&library, libraryPath, argc, argv);
+      exitCode = handle_remove(library, libraryPath, argc, argv);
       break;
     case NONE:
       break;
@@ -292,7 +292,7 @@ int main(int argc, char** argv)
   /* Rewrite the library file */
   if (action == REMOVE || action == ADD) {
     // writeToFile return true (1) if everything is ok => exitCode is 0
-    if (!library.writeToFile(libraryPath)) {
+    if (!library->writeToFile(libraryPath)) {
       std::cerr << "Cannot write the library " << libraryPath << std::endl;
       return 1;
     }

src/server/kiwix-serve.cpp

@@ -61,7 +61,7 @@ void usage()
 
             << "Optional arguments:" << std::endl << std::endl
             << "\t-h, --help\t\tPrint this help" << std::endl << std::endl
-            << "\t-a, --attachToProcess\tWxit if given process id is not running anymore" << std::endl
+            << "\t-a, --attachToProcess\tExit if given process id is not running anymore" << std::endl
             << "\t-d, --daemon\t\tDetach the HTTP server daemon from the main process" << std::endl
             << "\t-i, --address\t\tListen only on this ip address, all available ones otherwise" << std::endl
             << "\t-M, --monitorLibrary\tMonitor the XML library file and reload it automatically" << std::endl
@@ -197,7 +197,7 @@ int main(int argc, char** argv)
 #endif
 
   std::string rootLocation = "/";
-  kiwix::Library library;
+  auto library = std::make_shared<kiwix::Library>();
   unsigned int nb_threads = DEFAULT_THREADS;
   std::vector<std::string> zimPathes;
   std::string libraryPath;
@@ -331,7 +331,7 @@ int main(int argc, char** argv)
   }
 
   /* Setup the library manager and get the list of books */
-  kiwix::Manager manager(&library);
+  kiwix::Manager manager(library);
   std::vector<std::string> libraryPaths;
   if (libraryFlag) {
     libraryPaths = kiwix::split(libraryPath, ";");
@@ -340,7 +340,7 @@ int main(int argc, char** argv)
     }
 
     /* Check if the library is not empty (or only remote books)*/
-    if (library.getBookCount(true, false) == 0) {
+    if (library->getBookCount(true, false) == 0) {
       std::cerr << "The XML library file '" << libraryPath
            << "' is empty (or has only remote books)." << std::endl;
     }
@@ -376,8 +376,8 @@ int main(int argc, char** argv)
   }
 #endif
 
-  kiwix::UpdatableNameMapper nameMapper(library, noDateAliasesFlag);
-  kiwix::Server server(&library, &nameMapper);
+  auto nameMapper = std::make_shared<kiwix::UpdatableNameMapper>(library, noDateAliasesFlag);
+  kiwix::Server::Configuration configuration(library, nameMapper);
 
   if (!customIndexPath.empty()) {
     try {
@@ -388,17 +388,18 @@ int main(int argc, char** argv)
     }
   }
 
-  server.setAddress(address);
-  server.setRoot(rootLocation);
-  server.setPort(serverPort);
-  server.setNbThreads(nb_threads);
-  server.setVerbose(isVerboseFlag);
-  server.setTaskbar(!noSearchBarFlag, !noLibraryButtonFlag);
-  server.setBlockExternalLinks(blockExternalLinks);
-  server.setIndexTemplateString(indexTemplateString);
-  server.setIpConnectionLimit(ipConnectionLimit);
-  server.setMultiZimSearchLimit(searchLimit);
+  configuration.setAddress(address);
+  configuration.setRoot(rootLocation);
+  configuration.setPort(serverPort);
+  configuration.setNbThreads(nb_threads);
+  configuration.setVerbose(isVerboseFlag);
+  configuration.setTaskbar(!noSearchBarFlag, !noLibraryButtonFlag);
+  configuration.setBlockExternalLinks(blockExternalLinks);
+  configuration.setIndexTemplateString(indexTemplateString);
+  configuration.setIpConnectionLimit(ipConnectionLimit);
+  configuration.setMultiZimSearchLimit(searchLimit);
 
+  kiwix::Server server(configuration);
   if (! server.start()) {
     exit(1);
   }
@@ -447,7 +448,7 @@ int main(int argc, char** argv)
     if ( libraryMustBeReloaded && !libraryPaths.empty() ) {
       libraryFileTimestamp = curLibraryFileTimestamp;
       reloadLibrary(manager, libraryPaths);
-      nameMapper.update();
+      nameMapper->update();
       libraryMustBeReloaded = false;
     }
   } while (waiting);