Release 3.1.2

Use new suggestion API of kiwix-lib.

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: CI
 
-on: [pull_request]
+on: [push]
 
 jobs:
   Linux:
@@ -31,25 +31,20 @@ jobs:
     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: |
-        import json
         from subprocess import check_call
         from os import environ
-        with open(environ['GITHUB_EVENT_PATH'], 'r') as f:
-            content = f.read()
-        event_data = json.loads(content)
-        try:
-            branch_ref = event_data['ref'].split('/')[-1]
-        except KeyError:
-            branch_ref = event_data['pull_request']['head']['ref']
-        print("Cloning branch", branch_ref)
         command = [
           'git', 'clone',
           'https://github.com/${{github.repository}}',
           '--depth=1',
-          '--branch', branch_ref
+          '--branch', '${{steps.extract_branch.outputs.branch}}'
         ]
         check_call(command, cwd=environ['HOME'])
     - name: Install deps

Changelog

@@ -1,7 +1,22 @@
+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 parsin
+ * [MANAGER] Fix broken --version argument parsing
 
 kiwix-tools 3.0.2
 =================

README.md

@@ -8,7 +8,7 @@ command line tools:
 * kiwix-search: Fulltext search in ZIM files
 * kiwix-serve: HTTP daemon serving ZIM files
 
-[![Build Status](https://travis-ci.com/kiwix/kiwix-tools.svg?branch=master)](https://travis-ci.com/kiwix/kiwix-tools)
+[![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)
 

meson.build

@@ -1,5 +1,5 @@
 project('kiwix-tools', 'cpp',
-  version : '3.0.3',
+  version : '3.1.2',
   license : 'GPL',
   default_options: ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
 
@@ -13,7 +13,7 @@ if static_linkage
 endif
 
 thread_dep = dependency('threads')
-kiwixlib_dep = dependency('kiwix', version:'>=9.0.0', static:static_linkage)
+kiwixlib_dep = dependency('kiwix', version:'>=9.3.0', static:static_linkage)
 microhttpd_dep = dependency('libmicrohttpd', static:static_linkage)
 z_dep = dependency('zlib', static:static_linkage)
 

src/reader/kiwix-read.cpp

@@ -90,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[0] << std::endl;
       }
     }
 

src/server/kiwix-serve.cpp

@@ -23,7 +23,9 @@
 #include <kiwix/name_mapper.h>
 #include <kiwix/tools/otherTools.h>
 
-#ifndef _WIN32
+#ifdef _WIN32
+# include <windows.h>
+#else
 # include <unistd.h>
 #endif
 
@@ -60,6 +62,7 @@ void usage()
             << "\t-i, --address\t\tlisten only on this ip address, all available ones otherwise" << std::endl
             << "\t-m, --nolibrarybutton\tdo not print the builtin home button in the builtin top bar overlay" << std::endl
             << "\t-n, --nosearchbar\tdo not print the builtin bar overlay on the top of each served page" << std::endl
+            << "\t-b, --blockexternal\tprevent users from directly accessing external links" << std::endl
             << "\t-p, --port\t\tTCP port on which to listen to HTTP requests (default: 80)" << std::endl
             << "\t-r, --urlRootLocation\tURL prefix on which the content should be made available (default: /)" << std::endl
             << "\t-t, --threads\t\tnumber of threads to run in parallel (default: " << DEFAULT_THREADS << ")" << std::endl
@@ -90,6 +93,7 @@ int main(int argc, char** argv)
   bool noLibraryButtonFlag = false;
   bool noSearchBarFlag = false;
   bool noDateAliasesFlag = false;
+  bool blockExternalLinks = false;
   bool isVerboseFlag = false;
   bool trustlibrary = true;
   string PPIDString;
@@ -103,6 +107,7 @@ int main(int argc, char** argv)
          {"nolibrarybutton", no_argument, 0, 'm'},
          {"nodatealiases", no_argument, 0, 'z'},
          {"nosearchbar", no_argument, 0, 'n'},
+         {"blockexternallinks", no_argument, 0, 'b'},
          {"attachToProcess", required_argument, 0, 'a'},
          {"port", required_argument, 0, 'p'},
          {"address", required_argument, 0, 'i'},
@@ -115,7 +120,7 @@ int main(int argc, char** argv)
   while (true) {
     int option_index = 0;
     int c
-        = getopt_long(argc, argv, "zmndvVla:p:f:t:r:i:", long_options, &option_index);
+        = getopt_long(argc, argv, "zmnbdvVla:p:f:t:r:i:", long_options, &option_index);
 
     if (c != -1) {
       switch (c) {
@@ -134,6 +139,9 @@ int main(int argc, char** argv)
         case 'n':
           noSearchBarFlag = true;
           break;
+        case 'b':
+          blockExternalLinks = true;
+          break;
         case 'z':
           noDateAliasesFlag = true;
           break;
@@ -249,6 +257,7 @@ int main(int argc, char** argv)
   server.setNbThreads(nb_threads);
   server.setVerbose(isVerboseFlag);
   server.setTaskbar(!noSearchBarFlag, !noLibraryButtonFlag);
+  server.setBlockExternalLinks(blockExternalLinks);
 
   if (! server.start()) {
     cerr << "Unable to instantiate the HTTP daemon. The port " << serverPort