Add a basic wrapper around libzim.

This validate the build system has we now have a compiling wrapper around
libzim.

Author: mgautierfr

.gitignore

@@ -1,3 +1,4 @@
 .gradle
 local.properties
 build
+lib/.cxx

lib/build.gradle

@@ -59,7 +59,7 @@ android {
     }
     externalNativeBuild {
         cmake {
-            path file('src/cpp/CMakeLists.txt')
+            path file('src/main/cpp/CMakeLists.txt')
             version '3.18.1'
         }
     }
@@ -285,5 +285,5 @@ task checkCurrentJavaVersion() {
 
 task generateHeaderFilesFromJavaWrapper(type: Exec) {
     workingDir "${projectDir}/src/main/java/org/kiwix/"
-    commandLine 'bash', '-c', "javac -h ${buildDir}/include/javah_generated/ -d ${buildDir}/kiwixlib/ kiwixlib/Book.java kiwixlib/DirectAccessInfo.java kiwixlib/Filter.java kiwixlib/JNIICU.java kiwixlib/JNIKiwixBool.java kiwixlib/JNIKiwixException.java kiwixlib/JNIKiwixInt.java kiwixlib/JNIKiwixReader.java kiwixlib/JNIKiwixSearcher.java kiwixlib/JNIKiwixServer.java kiwixlib/JNIKiwixString.java kiwixlib/Library.java kiwixlib/Manager.java"
+    commandLine 'bash', '-c', "javac -h ${buildDir}/include/javah_generated/ -d ${buildDir}/libzim/ libzim/Archive.java libzim/Blob.java libzim/Entry.java libzim/Item.java libzim/ZimFileFormatException.java"
 }

lib/src/main/cpp/CMakeLists.txt

@@ -0,0 +1,53 @@
+
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY BOTH)
+cmake_minimum_required(VERSION 3.18.1)
+
+set(CMAKE_ANDROID_STL_TYPE llvm-libc++_static)
+
+project("libzim_wrapper")
+
+add_library(
+        libzim_wrapper
+
+        SHARED
+        common.cpp
+        libzim/archive.cpp
+        libzim/entry.cpp
+        libzim/item.cpp
+        libzim/blob.cpp
+)
+
+find_library(libzim
+        zim
+        PATHS
+        ${BUILD_DIR}/jniLibs/${CMAKE_ANDROID_ARCH_ABI}/libzim)
+if (NOT libzim)
+        message(FATAL_ERROR "libzim not found!")
+endif()
+add_library(libzim SHARED IMPORTED)
+
+set_property(TARGET
+        libzim
+        PROPERTY
+        IMPORTED_LOCATION
+        ${BUILD_DIR}/jniLibs/${CMAKE_ANDROID_ARCH_ABI}/libzim/libzim.so)
+
+include_directories(
+${CMAKE_SOURCE_DIR}
+${BUILD_DIR}/include/libkiwix
+${BUILD_DIR}/include/libzim
+${BUILD_DIR}/include/javah_generated
+#${CMAKE_SOURCE_DIR}/include/utils
+)
+
+find_library(
+        log-lib
+        log)
+
+target_link_libraries(
+        libzim_wrapper
+        libzim
+
+        ${log-lib}
+        )
+

lib/src/main/cpp/book.cpp

@@ -23,6 +23,7 @@
 
 #include "utils.h"
 #include "book.h"
+#include <zim/archive.h>
 
 JNIEXPORT void JNICALL
 Java_org_kiwix_kiwixlib_Book_allocate(
@@ -46,7 +47,7 @@ METHOD(void, Book, update__Lorg_kiwix_kiwixlib_Book_2, jobject otherBook)
 
 METHOD(void, Book, update__Lorg_kiwix_kiwixlib_JNIKiwixReader_2, jobject reader)
 {
-  BOOK->update(**Handle<kiwix::Reader>::getHandle(env, reader));
+  BOOK->update(**Handle<zim::Archive>::getHandle(env, reader));
 }
 
 #define GETTER(retType, name) JNIEXPORT retType JNICALL \

lib/src/main/cpp/common.cpp

@@ -0,0 +1,4 @@
+
+#include <thread>
+
+std::mutex globalLock;

lib/src/main/cpp/libzim/archive.cpp

@@ -0,0 +1,232 @@
+/*
+ * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
+ * Copyright (C) 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 <jni.h>
+#include <exception>
+#include "org_kiwix_libzim_Archive.h"
+
+#include <utils.h>
+
+#include <iostream>
+#include <string>
+
+#include <zim/archive.h>
+#include <zim/item.h>
+
+/* Kiwix Reader JNI functions */
+JNIEXPORT jlong JNICALL Java_org_kiwix_libzim_Archive_getNativeArchive(
+    JNIEnv* env, jobject obj, jstring filename)
+{
+  std::string cPath = TO_C(filename);
+
+  LOG("Attempting to create reader with: %s", cPath.c_str());
+  Lock l;
+  try {
+    zim::Archive* reader = new zim::Archive(cPath);
+    return reinterpret_cast<jlong>(new Handle<zim::Archive>(reader));
+  } catch (std::exception& e) {
+    LOG("Error opening ZIM file");
+      LOG("%s", e.what());
+    return 0;
+  }
+}
+
+namespace
+{
+
+int jni2fd(const jobject& fdObj, JNIEnv* env)
+{
+  jclass class_fdesc = env->FindClass("java/io/FileDescriptor");
+  jfieldID field_fd = env->GetFieldID(class_fdesc, "fd", "I");
+  if ( field_fd == NULL )
+  {
+    env->ExceptionClear();
+    // Under Android the (private) 'fd' field of java.io.FileDescriptor has been
+    // renamed to 'descriptor'. See, for example,
+    // https://android.googlesource.com/platform/libcore/+/refs/tags/android-8.1.0_r1/ojluni/src/main/java/java/io/FileDescriptor.java#55
+    field_fd = env->GetFieldID(class_fdesc, "descriptor", "I");
+  }
+  return env->GetIntField(fdObj, field_fd);
+}
+
+} // unnamed namespace
+
+JNIEXPORT jlong JNICALL Java_org_kiwix_libzim_Archive_getNativeArchiveByFD(
+    JNIEnv* env, jobject obj, jobject fdObj)
+{
+#ifndef _WIN32
+  int fd = jni2fd(fdObj, env);
+
+  LOG("Attempting to create reader with fd: %d", fd);
+  Lock l;
+  try {
+    zim::Archive* reader = new zim::Archive(fd);
+    return reinterpret_cast<jlong>(new Handle<zim::Archive>(reader));
+  } catch (std::exception& e) {
+    LOG("Error opening ZIM file");
+       LOG("%s", e.what());
+    return 0;
+  }
+#else
+  jclass exception = env->FindClass("java/lang/UnsupportedOperationException");
+  env->ThrowNew(exception, "org.kiwix.libzim.Archive.getNativeArchiveByFD() is not supported under Windows");
+  return 0;
+#endif
+}
+
+JNIEXPORT jlong JNICALL Java_org_kiwix_libzim_Archive_getNativeArchiveEmbedded(
+    JNIEnv* env, jobject obj, jobject fdObj, jlong offset, jlong size)
+{
+#ifndef _WIN32
+  int fd = jni2fd(fdObj, env);
+
+  LOG("Attempting to create reader with fd: %d", fd);
+  Lock l;
+  try {
+    zim::Archive* reader = new zim::Archive(fd, offset, size);
+    return reinterpret_cast<jlong>(new Handle<zim::Archive>(reader));
+  } catch (std::exception& e) {
+    LOG("Error opening ZIM file");
+       LOG("%s", e.what());
+    return 0;
+  }
+#else
+  jclass exception = env->FindClass("java/lang/UnsupportedOperationException");
+  env->ThrowNew(exception, "org.kiwix.libzim.Archive.getNativeArchiveEmbedded() is not supported under Windows");
+  return 0;
+#endif
+}
+
+JNIEXPORT void JNICALL
+Java_org_kiwix_libzim_Archive_dispose(JNIEnv* env, jobject thisObj)
+{
+  dispose<zim::Archive>(env, thisObj);
+}
+
+#define THIS (Handle<zim::Archive>::getHandle(env, thisObj))
+#define GETTER(retType, name) JNIEXPORT retType JNICALL \
+Java_org_kiwix_libzim_Archive_##name (JNIEnv* env, jobject thisObj) \
+{ \
+  return TO_JNI(THIS->name()); \
+}
+
+
+GETTER(jstring, getFilename)
+GETTER(jlong, getFilesize)
+GETTER(jint, getAllEntryCount)
+GETTER(jint, getEntryCount)
+GETTER(jint, getArticleCount)
+GETTER(jint, getMediaCount)
+
+METHOD0(jstring, Archive, getUuid) {
+  return TO_JNI(std::string(THIS->getUuid()));
+}
+
+METHOD(jstring, Archive, getMetadata, jstring name) {
+  return TO_JNI(THIS->getMetadata(TO_C(name)));
+}
+
+METHOD(jobject, Archive, getMetadataItem, jstring name) {
+  auto item = THIS->getMetadataItem(TO_C(name));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Item", item);
+  return obj;
+}
+
+GETTER(jobjectArray, getMetadataKeys)
+
+METHOD(jobject, Archive, getIllustrationItem, jint size) {
+  auto item = THIS->getIllustrationItem(TO_C(size));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Item", item);
+  return obj;
+}
+
+METHOD(jboolean, Archive, hasIllustration, jint size) {
+  return TO_JNI(THIS->hasIllustration(TO_C(size)));
+}
+
+GETTER(jlongArray, getIllustrationSizes)
+
+METHOD(jobject, Archive, getEntryByPath, jlong index) {
+  auto entry = THIS->getEntryByPath(TO_C(index));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD(jobject, Archive, getEntryByPath, jstring path) {
+  auto entry = THIS->getEntryByPath(TO_C(path));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD(jobject, Archive, getEntryByTitle, jlong index) {
+  auto entry = THIS->getEntryByTitle(TO_C(index));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD(jobject, Archive, getEntryByTitle, jstring title) {
+  auto entry = THIS->getEntryByTitle(TO_C(title));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD(jobject, Archive, getEntryByClusterOrder, jlong index) {
+  auto entry = THIS->getEntryByClusterOrder(TO_C(index));
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD0(jobject, Archive, getMainEntry) {
+  auto entry = THIS->getMainEntry();
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD0(jobject, Archive, getRandomEntry) {
+  auto entry = THIS->getRandomEntry();
+  auto obj = CREATE_WRAPPER("org/kiwix/libzim/Entry", entry);
+  return obj;
+}
+
+METHOD(jboolean, Archive, hasEntryByPath, jstring path) {
+  return TO_JNI(THIS->hasEntryByPath(TO_C(path)));
+}
+
+METHOD(jboolean, Archive, hasEntryByTitle, jstring title) {
+  return TO_JNI(THIS->hasEntryByPath(TO_C(title)));
+}
+
+GETTER(jboolean, hasMainEntry)
+
+METHOD(jboolean, Archive, hasIllustration, jlong size) {
+  return TO_JNI(THIS->hasIllustration(TO_C(size)));
+}
+
+GETTER(jboolean, hasFulltextIndex)
+GETTER(jboolean, hasTitleIndex)
+GETTER(jboolean, hasChecksum)
+GETTER(jstring, getChecksum)
+GETTER(jboolean, check)
+
+GETTER(jboolean, isMultiPart)
+GETTER(jboolean, hasNewNamespaceScheme)
+
+
+

lib/src/main/cpp/libzim/blob.cpp

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2013 Emmanuel Engelhart <kelson@kiwix.org>
+ * Copyright (C) 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 <jni.h>
+#include <exception>
+#include "org_kiwix_libzim_Blob.h"
+
+#include "utils.h"
+
+#include <string>
+
+#include <zim/blob.h>
+
+JNIEXPORT void JNICALL
+Java_org_kiwix_kiwixlib_libzim_Blob_dispose(JNIEnv* env, jobject thisObj)
+{
+  dispose<zim::Blob>(env, thisObj);
+}
+
+#define THIS (Handle<zim::Blob>::getHandle(env, thisObj))
+#define GETTER(retType, name) JNIEXPORT retType JNICALL \
+Java_org_kiwix_libzim_Blob__##name (JNIEnv* env, jobject thisObj) \
+{ \
+  return TO_JNI(THIS->name()); \
+}
+
+METHOD0(jstring, Blob, getData) {
+  return TO_JNI(std::string(**THIS));
+}
+GETTER(jlong, size)