Win kiwix serve (#274)

Win kiwix serve

ChangeLog

@@ -1,3 +1,15 @@
+kiwix-lib 7.0.0
+===============
+
+ * [API break] Add a argument to kiwix-serve to specify the library to use.
+
+kiwix-lib 6.0.4
+===============
+
+ * Fix HTML rendering of the search result if there is no result.
+ * Do not crash at html rendering if request ask for 0 results (start == end)
+ * Correctly find the executable path if we are using AppImage
+
 kiwix-lib 6.0.3
 ===============
 

README.md

@@ -6,6 +6,7 @@ suite core. It contains the code shared by all Kiwix ports (Windows,
 Linux, OSX, Android, ...).
 
 [![Download](https://api.bintray.com/packages/kiwix/kiwix/kiwixlib/images/download.svg)](https://bintray.com/kiwix/kiwix/kiwixlib/_latestVersion)
+[![AUR version](https://img.shields.io/aur/version/kiwix-lib)](https://aur.archlinux.org/packages/kiwix-lib/)
 [![Build Status](https://travis-ci.org/kiwix/kiwix-lib.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-lib)
 [![CodeFactor](https://www.codefactor.io/repository/github/kiwix/kiwix-lib/badge)](https://www.codefactor.io/repository/github/kiwix/kiwix-lib)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

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

@@ -26,7 +26,7 @@ task writePom {
     project {
         groupId 'org.kiwix.kiwixlib'
         artifactId 'kiwixlib'
-        version '6.0.3' + (System.env.KIWIXLIB_BUILDVERSION == null ? '' : '-'+System.env.KIWIXLIB_BUILDVERSION)
+        version '7.0.0' + (System.env.KIWIXLIB_BUILDVERSION == null ? '' : '-'+System.env.KIWIXLIB_BUILDVERSION)
         packaging 'aar'
         name 'kiwixlib'
         url 'https://github.com/kiwix/kiwix-lib'

include/kiwixserve.h

@@ -2,6 +2,7 @@
 #define KIWIXLIB_KIWIX_SERVE_H_
 
 #include <memory>
+#include <string>
 
 class Subprocess;
 namespace kiwix {
@@ -9,7 +10,7 @@ namespace kiwix {
 class KiwixServe
 {
   public:
-    KiwixServe(int port = 8181);
+    KiwixServe(const std::string& libraryPath, int port = 8181);
     ~KiwixServe();
 
     void run();
@@ -20,6 +21,7 @@ class KiwixServe
   private:
   std::unique_ptr<Subprocess> mp_kiwixServe;
   int m_port;
+  std::string m_libraryPath;
 };
 
 }; //end namespace kiwix

meson.build

@@ -1,5 +1,5 @@
 project('kiwix-lib', 'cpp',
-  version : '6.0.3', # Also change this in android-kiwix-lib-publisher/kiwixLibAndroid/build.gradle
+  version : '7.0.0', # Also change this in android-kiwix-lib-publisher/kiwixLibAndroid/build.gradle
   license : 'GPL',
   default_options : ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
 

src/kiwixserve.cpp

@@ -14,7 +14,9 @@
 
 namespace kiwix {
 
-KiwixServe::KiwixServe(int port) : m_port(port)
+KiwixServe::KiwixServe(const std::string& libraryPath, int port)
+  : m_port(port),
+    m_libraryPath(libraryPath)
 {
 }
 
@@ -43,13 +45,12 @@ void KiwixServe::run()
         // Try to use a potential installed kiwix-serve.
         callCmd.push_back(KIWIXSERVE_CMD);
     }
-    std::string libraryPath = getDataDirectory() + "/library.xml";
     std::string attachProcessOpt = "-a" + to_string(pid);
     std::string portOpt = "-p" + to_string(m_port);
     callCmd.push_back(attachProcessOpt.c_str());
     callCmd.push_back(portOpt.c_str());
     callCmd.push_back("-l");
-    callCmd.push_back(libraryPath.c_str());
+    callCmd.push_back(m_libraryPath.c_str());
     mp_kiwixServe = Subprocess::run(callCmd);
 }
 

src/search_renderer.cpp

@@ -96,27 +96,29 @@ std::string SearchRenderer::getHtml()
   auto resultEnd = mp_searcher->getResultEnd();
   auto resultCountPerPage = resultEnd - resultStart;
   auto estimatedResultCount = mp_searcher->getEstimatedResultCount();
-
-  unsigned int pageStart
-      = resultStart / resultCountPerPage >= 5
-            ? resultStart / resultCountPerPage - 4
-            : 0;
-  unsigned int pageCount
-      = estimatedResultCount / resultCountPerPage + 1 - pageStart;
-
-  if (pageCount > 10) {
-    pageCount = 10;
-  } else if (pageCount == 1) {
-    pageCount = 0;
+  auto currentPage = 0U;
+  auto pageStart = 0U;
+  auto pageEnd = 0U;
+  auto lastPageStart = 0U;
+  if (resultCountPerPage) {
+    currentPage = resultStart/resultCountPerPage;
+    pageStart = currentPage > 4 ? currentPage-4 : 0;
+    pageEnd = currentPage + 5;
+    if (pageEnd > estimatedResultCount / resultCountPerPage) {
+      pageEnd = estimatedResultCount / resultCountPerPage;
+    }
+    if (estimatedResultCount > resultCountPerPage) {
+      lastPageStart = static_cast<int>(round(estimatedResultCount/resultCountPerPage)) * resultCountPerPage;
+    }
   }
 
-  for (unsigned int i = pageStart; i < pageStart + pageCount; i++) {
+  for (unsigned int i = pageStart; i < pageEnd; i++) {
     kainjow::mustache::data page;
     page.set("label", to_string(i + 1));
     page.set("start", to_string(i * resultCountPerPage));
     page.set("end", to_string((i + 1) * resultCountPerPage));
 
-    if (i * resultCountPerPage == resultStart) {
+    if (i == currentPage) {
       page.set("selected", true);
     }
     pages.push_back(page);
@@ -128,16 +130,15 @@ std::string SearchRenderer::getHtml()
   kainjow::mustache::data allData;
   allData.set("results", results);
   allData.set("pages", pages);
-  allData.set("hasResult", estimatedResultCount != 0);
+  allData.set("hasResults", estimatedResultCount != 0);
+  allData.set("hasPages", pageStart != pageEnd);
   allData.set("count", kiwix::beautifyInteger(estimatedResultCount));
   allData.set("searchPattern", kiwix::encodeDiples(this->searchPattern));
   allData.set("searchPatternEncoded", urlEncode(this->searchPattern));
   allData.set("resultStart", to_string(resultStart + 1));
   allData.set("resultEnd", to_string(min(resultEnd, estimatedResultCount)));
   allData.set("resultRange", to_string(resultCountPerPage));
-  allData.set("resultLastPageStart", to_string(estimatedResultCount > resultCountPerPage
-             ? round(estimatedResultCount / resultCountPerPage) * resultCountPerPage
-             : 0));
+  allData.set("resultLastPageStart", to_string(lastPageStart));
   allData.set("lastResult", to_string(estimatedResultCount));
   allData.set("protocolPrefix", this->protocolPrefix);
   allData.set("searchProtocolPrefix", this->searchProtocolPrefix);

src/searcher.cpp

@@ -108,12 +108,12 @@ void Searcher::search(std::string& search,
     cout << "Performing query `" << search << "'" << endl;
   }
 
+  this->searchPattern = search;
+  this->resultStart = resultStart;
+  this->resultEnd = resultEnd;
   /* Try to find results */
   if (resultStart != resultEnd) {
     /* Perform the search */
-    this->searchPattern = search;
-    this->resultStart = resultStart;
-    this->resultEnd = resultEnd;
     string unaccentedSearch = removeAccents(search);
     std::vector<const zim::File*> zims;
     for (auto current = this->readers.begin(); current != this->readers.end();
@@ -146,11 +146,6 @@ void Searcher::geo_search(float latitude, float longitude, float distance,
     cout << "Performing geo query `" << distance << "&(" << latitude << ";" << longitude << ")'" << endl;
   }
 
-  /* Try to find results */
-  if (resultStart == resultEnd) {
-    return;
-  }
-
   /* Perform the search */
   std::ostringstream oss;
   oss << "Articles located less than " << distance << " meters of " << latitude << ";" << longitude;
@@ -158,6 +153,11 @@ void Searcher::geo_search(float latitude, float longitude, float distance,
   this->resultStart = resultStart;
   this->resultEnd = resultEnd;
 
+  /* Try to find results */
+  if (resultStart == resultEnd) {
+    return;
+  }
+
   std::vector<const zim::File*> zims;
   for (auto current = this->readers.begin(); current != this->readers.end();
        current++) {

src/tools/pathTools.cpp

@@ -283,6 +283,21 @@ std::string getExecutablePath()
 {
   char binRootPath[PATH_MAX];
 
+  char* cAppImage = ::getenv("APPIMAGE");
+  if (cAppImage) {
+    char* cArgv0 = ::getenv("ARGV0");
+    char* cOwd = ::getenv("OWD");
+    if (!cArgv0 && !cOwd) {
+      // Nothing to clean, goto in the same function...
+      // This is silly but .. ok..
+      // And we should pass here, if APPIMAGE is set ARGV0 and OWD should also
+      // (except if there is a bug in appimage)
+      goto normal;
+    }
+    return appendToDirectory(cOwd, cArgv0);
+  }
+normal:
+
 #ifdef _WIN32
   GetModuleFileName(NULL, binRootPath, PATH_MAX);
   return std::string(binRootPath);

static/skin/taskbar.css

@@ -124,7 +124,7 @@ label[for=kiwixsearchbox] {
 }
 
 body {
-    padding-top: 40px !important;
+    padding-top: 3em !important;
 }
 
 /* Try to fix buggy stuff in jquery-ui autocomplete */

static/templates/search_result.html

@@ -95,7 +95,7 @@
   </head>
   <body bgcolor="white">
     <div class="header">
-      {{#hasResult}}
+      {{#hasResults}}
         Results
         <b>
           {{resultStart}}-{{resultEnd}}
@@ -104,10 +104,10 @@
         </b> for <b>
           {{searchPattern}}
         </b>
-      {{/hasResult}}
-      {{^hasResult}}
+      {{/hasResults}}
+      {{^hasResults}}
         No results were found for <b>{{searchPattern}}</b>
-      {{/hasResult}}
+      {{/hasResults}}
     </div>
 
     <div class="results">
@@ -129,30 +129,32 @@
     </div>
 
     <div class="footer">
-      <ul>
-        {{#resultLastPageStart}}
-          <li>
-            <a href="{{searchProtocolPrefix}}pattern={{searchPatternEncoded}}{{#contentId}}&content={{.}}{{/contentId}}&start=0&end={{resultRange}}">
-              ◀
-            </a>
-          </li>
-        {{/resultLastPageStart}}
-        {{#pages}}
-          <li>
-            <a {{#selected}}class="selected"{{/selected}}
-               href="{{searchProtocolPrefix}}pattern={{searchPatternEncoded}}{{#contentId}}&content={{.}}{{/contentId}}&start={{start}}&end={{end}}">
-              {{label}}
-            </a>
-          </li>
-        {{/pages}}
-        {{#resultLastPageStart}}
-          <li>
-            <a href="{{searchProtocolPrefix}}pattern={{searchPatternEncoded}}{{#contentId}}&content={{.}}{{/contentId}}&start={{resultLastPageStart}}&end={{lastResult}}">
-              ▶
-            </a>
-          </li>
-        {{/resultLastPageStart}}
-      </ul>
+      {{#hasPages}}
+        <ul>
+          {{#resultLastPageStart}}
+            <li>
+              <a href="{{searchProtocolPrefix}}pattern={{searchPatternEncoded}}{{#contentId}}&content={{.}}{{/contentId}}&start=0&end={{resultRange}}">
+                ◀
+              </a>
+            </li>
+          {{/resultLastPageStart}}
+          {{#pages}}
+            <li>
+              <a {{#selected}}class="selected"{{/selected}}
+                 href="{{searchProtocolPrefix}}pattern={{searchPatternEncoded}}{{#contentId}}&content={{.}}{{/contentId}}&start={{start}}&end={{end}}">
+                {{label}}
+              </a>
+            </li>
+          {{/pages}}
+          {{#resultLastPageStart}}
+            <li>
+              <a href="{{searchProtocolPrefix}}pattern={{searchPatternEncoded}}{{#contentId}}&content={{.}}{{/contentId}}&start={{resultLastPageStart}}&end={{lastResult}}">
+                ▶
+              </a>
+            </li>
+          {{/resultLastPageStart}}
+        </ul>
+      {{/hasPages}}
     </div>
   </body>
 </html>