Integrate zimwriterfs sources into zim-tools source tree

Author: asashnov

zimwriterfs/.clang-format .clang-format

@@ -15,7 +15,7 @@ jobs:
       - name: Install packages
         uses: mstksg/get-package@v1
         with:
-          brew: gcovr pkg-config ninja
+          brew: gcovr pkg-config ninja libmagic
       - name: Install python modules
         run: pip3 install meson==0.49.2 pytest
       - name: Install deps

zimwriterfs/.dockerignore .dockerignore

@@ -27,3 +27,10 @@
 *.exe
 *.out
 *.app
+zimwriterfs
+
+# Temporary and test files
+*.kate-swp
+.*.swp
+*.zim
+pip-selfcheck.json

.github/workflows/ci.yml

@@ -1,3 +1,8 @@
+zim-tools 1.2.2
+===============
+
+ * zimwriterfs: the tool version 1.3.10 migrated to zim-tools sources tree
+
 zim-tools 1.2.1
 ===============
 

.gitignore

@@ -6,9 +6,18 @@ and the [openZIM project](https://openzim.org).
 
 [![latest release](https://img.shields.io/github/v/tag/openzim/zim-tools?label=latest%20release&sort=semver)](https://download.openzim.org/release/zim-tools/)
 [![Build Status](https://github.com/openzim/zim-tools/workflows/CI/badge.svg?query=branch%3Amaster)](https://github.com/openzim/zim-tools/actions?query=branch%3Amaster)
+[![Docker Build Status](https://img.shields.io/docker/build/openzim/zim-tools)](https://hub.docker.com/r/openzim/zim-tools)
 [![CodeFactor](https://www.codefactor.io/repository/github/openzim/zim-tools/badge)](https://www.codefactor.io/repository/github/openzim/zim-tools)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
+`zimwriterfs` is a console tool to create [ZIM](https://openzim.org)
+files from a locally-stored directory containing "self-sufficient"
+HTML content (with pictures, javascript and stylesheets). The result
+will contain all the files of the local directory compressed and
+merged in the ZIM file. Nothing more, nothing less. The generated file
+can be opened with a ZIM reader; [Kiwix](https://kiwix.org) is one
+example, but there are [others](https://openzim.org/wiki/ZIM_Readers).
+
 
 Releases
 ----------
@@ -29,18 +38,27 @@ with the ZIM libary compilation itself, we recommend to have a look to
 Dependencies
 ------------
 
-The Kiwix library relies on the libzim.
+Most of the utilities form zim-tools programs relies on the libzim:
 
 * [ZIM](https://openzim.org) (package `libzim-dev` on Debian/Ubuntu)
 
+`zimwriterfs` relies on many third parts software libraries. They are
+prerequisites to the Zimwriterfs compilation. Following libraries
+need to be available:
+
+* [Magic](https://www.darwinsys.com/file/) (package  `libmagic-dev` on Debian/Ubuntu)
+* [Z](https://zlib.net/) (package `zlib1g-dev` on Debian/Ubuntu)
+* [Gumbo](https://github.com/google/gumbo-parser) (package `libgumbo-dev` on Debian/Ubuntu)
+* [ICU](http://site.icu-project.org/) (package `libicu-dev` on Debian/Ubuntu)
+
 These dependencies may or may not be packaged by your operating
 system. They may also be packaged but only in an older version. The
 compilation script will tell you if one of them is missing or too old.
 In the worse case, you will have to download and compile a more recent
 version by hand.
 
 If you want to install these dependencies locally, then ensure that
-meson (through pkg-config) will properly find them.
+meson (through `pkg-config`) will properly find them.
 
 Environment
 -------------
@@ -98,6 +116,13 @@ ninja -C build uninstall
 Like for the installation, you might need to run the command as user
 `root` (or using `sudo`).
 
+Docker
+------
+
+A Docker image with `zimwriterfs` can be built from the `docker`
+directory. The project maintains an official image available at
+https://hub.docker.com/r/openzim/mwoffliner.
+
 Troubleshooting
 ---------------
 

ChangeLog

@@ -15,6 +15,7 @@ endif
 libzim_dep = dependency('libzim', version : '>=6.1.1', static:static_linkage)
 
 compiler = meson.get_compiler('cpp')
+find_library_in_compiler = meson.version().version_compare('>=0.31.0')
 rt_dep = compiler.find_library('rt', required:false)
 
 subdir('src')

README.md

@@ -1,2 +1,4 @@
 option('static-linkage', type : 'boolean', value : false,
   description : 'Create statically linked binaries.')
+option('magic-install-prefix', type : 'string', value : '',
+  description : 'Prefix where libmagic has been installed')

zimwriterfs/contrib/zimwriterfs-in-docker contrib/zimwriterfs-in-docker

@@ -33,3 +33,5 @@ executable('zimcheck', 'zimcheck.cpp',
 executable('zimrecreate', 'zimrecreate.cpp',
   dependencies: libzim_dep,
   install: true)
+
+subdir('zimwriterfs')

zimwriterfs/docker/Dockerfile docker/Dockerfile

@@ -1,18 +1,3 @@
-project('zimwriterfs', ['c', 'cpp'],
-  version : '1.3.10',
-  license : 'GPL-3.0-or-later',
-  default_options : ['c_std=c11', 'cpp_std=c++11', 'werror=true'])
-
-add_global_arguments('-DVERSION="@0@"'.format(meson.project_version()), language : 'cpp')
-
-compiler = meson.get_compiler('cpp')
-find_library_in_compiler = meson.version().version_compare('>=0.31.0')
-
-static_linkage = get_option('static-linkage')
-if static_linkage
-  add_global_link_arguments('-static-libstdc++', '--static', language:'cpp')
-endif
-
 thread_dep = dependency('threads')
 libzim_dep = dependency('libzim', version : '>=6.1.2', static:static_linkage)
 zlib_dep = dependency('zlib', static:static_linkage)
@@ -52,5 +37,18 @@ else
   endif
 endif
 
-subdir('src')
 
+sources = [
+  'zimwriterfs.cpp',
+  'tools.cpp',
+  'article.cpp',
+  'zimcreatorfs.cpp',
+  'mimetypecounter.cpp'
+]
+
+deps = [thread_dep, libzim_dep, zlib_dep, gumbo_dep, magic_dep]
+
+zimwriterfs = executable('zimwriterfs',
+                         sources,
+                         dependencies : deps,
+                         install : true)