Merge pull request #276 from kiwix/new_version

New version 1.2.0

Changelog

@@ -1,11 +1,52 @@
+kiwix-tools 1.2.0
+=================
+
+ * Remove rpath for installed binaries.
+
+kiwix-serve
+-----------
+
+ * New Dockerfile of kiwix-serve
+ * New --nodatealiases option
+ * Do not use POLL on windows
+
+kiwix-manage
+------------
+
+ * Do not show all books if book ids has been provided.
+ * Be able to add several zim files in the same time in a library.
+
+kiwix-tools 1.1.0
+=================
+
+kiwix-serve
+-----------
+
+ * Fix bug about handling of absolute url in old zim file.
+ * All the catalog to be searched by tags.
+
+kiwix-tools 1.0.0
+=================
+
+ * [CI] Use the new deps archive xz
+ * Move version 1.0.0. There is no need to stay in pre 1.0 version.
+
+kiwix-serve
+-----------
+
+ * Correctly implement redirection.
+   kiwix-serve now return a 302 http status code instead of resolving the
+   redirection internally and return the content.
+
+
 kiwix-tools 0.9.0
 =================
 
-* Update README
-* Update man pages
-* Remove support of external indexes (manage, search, serve)
-* Update build system as we don't use ctpp2 anymore
-* Update to last kiwix-lib API.
+ * Update README
+ * Update man pages
+ * Remove support of external indexes (manage, search, serve)
+ * Update build system as we don't use ctpp2 anymore
+ * Update to last kiwix-lib API.
 
 kiwix-manage
 ------------

README.md

@@ -106,6 +106,12 @@ ninja -C build uninstall
 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.
+
 Troubleshooting
 ---------------
 

docker/server/Dockerfile

@@ -0,0 +1,15 @@
+FROM alpine:latest
+LABEL maintainer Emmanuel Engelhart <kelson@kiwix.org>
+
+# 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.1.0.tar.gz | tar -xz && \
+    mv kiwix-tools*/kiwix-serve /usr/local/bin && \
+    rm -r kiwix-tools*
+
+# Run kiwix-serve
+EXPOSE 80
+VOLUME /data
+WORKDIR /data
+ENTRYPOINT ["/usr/local/bin/kiwix-serve", "--port", "80"]

docker/server/README.md

@@ -0,0 +1,13 @@
+kiwix-serve Docker image
+========================
+
+* Download a ZIM file from <https://wiki.kiwix.org/wiki/Content>
+
+* Given `wikipedia.zim` resides in `/tmp/zim/`, execute the following:
+
+```
+docker run -v /tmp/zim:/data -p 8080:80 kiwix/kiwix-serve wikipedia.zim
+```
+
+![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)

meson.build

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

src/manager/kiwix-manage.cpp

@@ -35,14 +35,11 @@ using namespace std;
 
 enum supportedAction { NONE, ADD, SHOW, REMOVE, DOWNLOAD };
 
-void show(kiwix::Library* library)
+void show(kiwix::Library* library, const std::string& bookId)
 {
-  auto booksIds = library->getBooksIds();
-  unsigned int inc = 1;
-  for(auto& id: booksIds) {
-    auto& book = library->getBookById(id);
-    std::cout << "#" << inc++ << std::endl
-              << "id:\t\t" << book.getId() << std::endl
+  try {
+    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
               << "title:\t\t" << book.getTitle() << std::endl
@@ -53,9 +50,11 @@ void show(kiwix::Library* library)
               << "date:\t\t" << book.getDate() << std::endl
               << "articleCount:\t" << book.getArticleCount() << std::endl
               << "mediaCount:\t" << book.getMediaCount() << std::endl
-              << "size:\t\t" << book.getSize() << " KB" << std::endl
-              << std::endl;
+              << "size:\t\t" << book.getSize() << " KB" << std::endl;
+  } catch (std::out_of_range&) {
+     std::cout << "No book " << bookId << " in the library" << std::endl;
   }
+  std::cout << std::endl;
 }
 
 void usage()
@@ -75,7 +74,17 @@ void usage()
 bool handle_show(kiwix::Library* library, const std::string& libraryPath,
                  int argc, char* argv[])
 {
-  show(library);
+  if (argc > 3 ) {
+    for(auto i=3; i<argc; i++) {
+       std::string bookId = argv[i];
+       show(library, bookId);
+    }
+  } else {
+    auto booksIds = library->getBooksIds();
+    for(auto& bookId: booksIds) {
+      show(library, bookId);
+    }
+  }
   return(0);
 }
 
@@ -90,47 +99,63 @@ bool handle_add(kiwix::Library* library, const std::string& libraryPath,
   int c = 0;
   bool resultCode = 0;
 
-  if (argc > 3) {
-    zimPath = argv[3];
+  if (argc <= 3) {
+    std::cerr << "Path to zim file to add is missing in the command line" << std::endl;
+    return (-1);
   }
 
   /* Options parsing */
-  optind = 2;
-  while (42) {
-    static struct option long_options[]
-        = {{"url", required_argument, 0, 'u'},
-           {"origId", required_argument, 0, 'o'},
-           {"zimPathToSave", required_argument, 0, 'z'},
-           {0, 0, 0, 0}};
+  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}
+  };
 
+  bool has_option = false;
+  while (true) {
     c = getopt_long(argc, argv, "cz:u:", long_options, &option_index);
-
-    if (c != -1) {
-      switch (c) {
-        case 'u':
-          url = optarg;
-          break;
-
-        case 'o':
-          origID = optarg;
-          break;
-
-        case 'z':
-          zimPathToSave = optarg;
-          break;
-      }
-    } else {
+    if (c == -1)
       break;
+
+    has_option = true;
+    switch (c) {
+      case 'u':
+        url = optarg;
+        break;
+
+      case 'o':
+        origID = optarg;
+        break;
+
+      case 'z':
+        zimPathToSave = optarg;
+        break;
     }
   }
 
-  if (!zimPath.empty()) {
-    kiwix::Manager manager(library);
-    zimPathToSave = zimPathToSave == "." ? zimPath : zimPathToSave;
-    manager.addBookFromPathAndGetId(zimPath, zimPathToSave, url, false);
-  } else {
-    std::cerr << "Invalid zim file path" << std::endl;
-    resultCode = 1;
+  if (optind >= argc) {
+    std::cerr << "Path to zim file to add is missing in the command line" << std::endl;
+    return (-1);
+  }
+
+  if (has_option && argc-optind > 1) {
+    std::cerr << "You cannot give option and several zim files to add" << std::endl;
+    return (-1);
+  }
+
+  kiwix::Manager manager(library);
+
+  for(auto i=optind; i<argc; i++) {
+    std::string zimPath = argv[i];
+    if (!zimPath.empty()) {
+      zimPathToSave = zimPathToSave == "." ? zimPath : zimPathToSave;
+      manager.addBookFromPathAndGetId(zimPath, zimPathToSave, url, false);
+    } else {
+      std::cerr << "Invalid zim file path" << std::endl;
+      resultCode = 1;
+    }
   }
 
   return(resultCode);

src/manager/meson.build

@@ -1,4 +1,3 @@
 executable('kiwix-manage', ['kiwix-manage.cpp'],
   dependencies:all_deps,
-  install:true,
-  install_rpath: join_paths(get_option('prefix'), get_option('libdir')))
+  install:true)

src/reader/meson.build

@@ -1,4 +1,3 @@
 executable('kiwix-read', ['kiwix-read.cpp'],
   dependencies:all_deps,
-  install:true,
-  install_rpath: join_paths(get_option('prefix'), get_option('libdir')))
+  install:true)

src/searcher/meson.build

@@ -1,4 +1,3 @@
 executable('kiwix-search', ['kiwix-search.cpp'],
   dependencies:all_deps,
-  install:true,
-  install_rpath: join_paths(get_option('prefix'), get_option('libdir')))
+  install:true)

src/server/kiwix-serve.cpp

@@ -93,6 +93,7 @@ using namespace std;
 
 static bool noLibraryButtonFlag = false;
 static bool noSearchBarFlag = false;
+static bool noDateAliasesFlag = false;
 static string welcomeHTML;
 static string catalogOpenSearchDescription;
 static std::atomic_bool isVerbose(false);
@@ -698,6 +699,7 @@ static struct MHD_Response* handle_catalog(RequestContext* request)
     } else if (url == "search") {
       std::string query;
       std::string language;
+      std::vector<std::string> tags;
       size_t count(10);
       size_t startIndex(0);
       try {
@@ -712,13 +714,19 @@ static struct MHD_Response* handle_catalog(RequestContext* request)
       try {
         startIndex = stoul(request->get_argument("start"));
       } catch (...) {}
+      try {
+        tags.push_back(request->get_argument("tag"));
+      } catch (...) {}
       opdsDumper.setTitle("Search result for " + query);
       uuid = zim::Uuid::generate();
       bookIdsToDump = library.listBooksIds(
         kiwix::VALID|kiwix::LOCAL|kiwix::REMOTE,
         kiwix::UNSORTED,
         query,
-        language);
+        language,
+        "", // creator
+        "", // publisher
+        tags);
       auto totalResults = bookIdsToDump.size();
       bookIdsToDump.erase(bookIdsToDump.begin(), bookIdsToDump.begin()+startIndex);
       if (count>0 && bookIdsToDump.size() > count) {
@@ -766,10 +774,22 @@ static struct MHD_Response* handle_content(RequestContext* request)
   }
 
   auto urlStr = request->get_url().substr(humanReadableBookId.size()+1);
+  if (urlStr[0] == '/') {
+    urlStr = urlStr.substr(1);
+  }
 
   try {
     entry = reader->getEntryFromPath(urlStr);
-    entry = entry.getFinalEntry();
+    if (entry.isRedirect() || urlStr.empty()) {
+      // If urlStr is empty, we want to mainPage.
+      // We must do a redirection to the real page.
+      entry = entry.getFinalEntry();
+      std::string httpRedirection = (
+        rootLocation + "/" + humanReadableBookId + "/" +
+        kiwix::urlEncode(entry.getPath()));
+      request->httpResponseCode = MHD_HTTP_FOUND;
+      return build_response("", 0, httpRedirection, "", false, false);
+    }
   } catch(kiwix::NoEntry& e) {
     if (isVerbose.load())
       printf("Failed to find %s\n", urlStr.c_str());
@@ -797,7 +817,6 @@ static struct MHD_Response* handle_content(RequestContext* request)
     /* Special rewrite URL in case of ZIM file use intern *asbolute* url like
      * /A/Kiwix */
     if (mimeType.find("text/html") != string::npos) {
-      baseUrl = "/" + entry.getPath();
       pthread_mutex_lock(&regexLock);
       content = replaceRegex(content,
                              "$1$2" + rootLocation + "/" + humanReadableBookId + "/$3/",
@@ -805,10 +824,6 @@ static struct MHD_Response* handle_content(RequestContext* request)
       content = replaceRegex(content,
                              "$1$2" + rootLocation + "/" + humanReadableBookId + "/$3/",
                              "(@import[ ]+)([\"|\']{0,1})/([A-Z|\\-])/");
-      content = replaceRegex(
-          content,
-          "<head><base href=\"" + rootLocation + "/" + humanReadableBookId + baseUrl + "\" />",
-          "<head>");
       pthread_mutex_unlock(&regexLock);
       introduceTaskbar(content, humanReadableBookId);
     } else if (mimeType.find("text/css") != string::npos) {
@@ -909,6 +924,19 @@ static int accessHandlerCallback(void* cls,
   return ret;
 }
 
+bool hasHumanReadableIdCollision(const string &humanReadableId,
+                                 const string &zimPath)
+{
+  if (readers.find(humanReadableId) != readers.end()) {
+    cerr << "Path collision: " << readers[humanReadableId]->getZimFilePath()
+         << " and " << zimPath << " can't share the same URL path /"
+         << humanReadableId << "/. Therefore, only "
+         << zimPath << " will be served." << endl;
+    return true;
+  }
+  return false;
+}
+
 int main(int argc, char** argv)
 {
   struct MHD_Daemon* daemon;
@@ -928,6 +956,7 @@ int main(int argc, char** argv)
          {"verbose", no_argument, 0, 'v'},
          {"library", no_argument, 0, 'l'},
          {"nolibrarybutton", no_argument, 0, 'm'},
+         {"nodatealiases", no_argument, 0, 'z'},
          {"nosearchbar", no_argument, 0, 'n'},
          {"attachToProcess", required_argument, 0, 'a'},
          {"port", required_argument, 0, 'p'},
@@ -956,6 +985,9 @@ int main(int argc, char** argv)
         case 'n':
           noSearchBarFlag = true;
           break;
+        case 'z':
+          noDateAliasesFlag = true;
+          break;
         case 'm':
           noLibraryButtonFlag = true;
           break;
@@ -1003,13 +1035,13 @@ int main(int argc, char** argv)
   /* Print usage)) if necessary */
   if (zimPathes.empty() && libraryPath.empty()) {
     cerr << "Usage: kiwix-serve [--index=INDEX_PATH] [--port=PORT] [--verbose] "
-            "[--nosearchbar] [--nolibrarybutton] [--daemon] "
+            "[--nosearchbar] [--nolibrarybutton] [--nodatealiases] [--daemon] "
             "[--attachToProcess=PID] [--interface=IF_NAME] "
             "[--urlRootLocation=/URL_ROOT] "
             "[--threads=NB_THREAD(" << nb_threads << ")] ZIM_PATH+"
          << endl;
     cerr << "       kiwix-serve --library [--port=PORT] [--verbose] [--daemon] "
-            "[--nosearchbar] [--nolibrarybutton] [--attachToProcess=PID] "
+            "[--nosearchbar] [--nolibrarybutton] [--nodatealiases] [--attachToProcess=PID] "
             "[--interface=IF_NAME] [--urlRootLocation=/URL_ROOT] "
             "[--threads=NB_THREAD(" << nb_threads << ")] LIBRARY_PATH "
          << endl;
@@ -1082,6 +1114,7 @@ int main(int argc, char** argv)
     }
 
     auto humanReadableId = currentBook.getHumanReadableIdFromPath();
+    hasHumanReadableIdCollision(humanReadableId, currentBook.getPath());
     readers[humanReadableId] = reader;
 
     if (reader->hasFulltextIndex()) {
@@ -1092,7 +1125,15 @@ int main(int argc, char** argv)
       globalSearcher->add_reader(reader, humanReadableId);
       searchers[humanReadableId] = searcher;
     } else {
-        searchers[humanReadableId] = nullptr;
+      searchers[humanReadableId] = nullptr;
+    }
+
+    /* Deal with noDateAliases */
+    if (noDateAliasesFlag) {
+      string alias = replaceRegex(humanReadableId, "", "_[[:digit:]]{4}-[[:digit:]]{2}$");
+      hasHumanReadableIdCollision(alias, currentBook.getPath());
+      readers[alias] = readers[humanReadableId];
+      searchers[alias] = searchers[humanReadableId];
     }
   }
 
@@ -1244,7 +1285,7 @@ int main(int argc, char** argv)
 #endif
 
   } else {
-    daemon = MHD_start_daemon(MHD_USE_POLL_INTERNALLY,
+    daemon = MHD_start_daemon(MHD_USE_SELECT_INTERNALLY,
                               serverPort,
                               NULL,
                               NULL,

src/server/meson.build

@@ -4,5 +4,4 @@ sources += server_resources
 
 executable('kiwix-serve', sources,
   dependencies:all_deps,
-  install:true,
-  install_rpath: join_paths(get_option('prefix'), get_option('libdir')))
+  install:true)

travis/install_deps.sh

@@ -3,7 +3,7 @@
 set -e
 
 REPO_NAME=${TRAVIS_REPO_SLUG#*/}
-ARCHIVE_NAME=deps_${TRAVIS_OS_NAME}_${PLATFORM}_${REPO_NAME}.tar.gz
+ARCHIVE_NAME=deps_${TRAVIS_OS_NAME}_${PLATFORM}_${REPO_NAME}.tar.xz
 
 # Packages.
 case ${PLATFORM} in
@@ -32,7 +32,7 @@ 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
+python3.5 -m pip install --user meson==0.49.2
 
 # Ninja
 cd $HOME