0ad8bf45fc
In many use cases, it is not wanted to have user accidentaly click on external links and leave the served ZIM content. This could be because the result is unpredictible (reader not implementing this properly) or because the serve user knows there's no backup internet connexion or because there is an induced cost behind external links that doesn't affect served content. using a new flag (`blockExternalLinks`) on `Response`/`setTaskBar`, a piece of JS code is injected into the taskbar code. This code adds a JS handler on all link click events and verifies the destination. If the destination appears to be an external link (1), the link target is changed to a specific URL: ``` /external?source=<original_uri> ``` (1) external is a link that's not on the same origin and starts with either `http:` `https:` or `//`. Server implements a new handler on `/external` that displays a new page (`captured_external.html`) which returns a generic message explaining the situation and offering to click on the link again should the user really want to. This is done by specifically asking `set_taskbar` to not block external requests on that page. This approach allows integrators using a reverse proxy to handle that endpoint differently (rebrand it) 1. `Server` now has an `m_blockExternalLinks` defaulting to `false` 1. `Server.setTaskbar` is extended to support an additional bool to set the variable. 1. `Response` now has an `m_blockExternalLinks` 1. `Response` constr expects an additional bool for `blockExternalLinks`. 1. `Response.set_taskbar` is extended to support an additional bool to set the variable. 1. JNI/Java Wrapper reflects the extensions. 1. New resource file `templates/block_external.js` (included in head_part). Should it be in skin? 1. New resource file `templates/captured_external.html` for `handle_captured_external()` 1. Added a comment on `head_part.html` to help with JS insertion at the right place 1. `introduce_taskbar()` conditionnaly inserts the JS inside the taskbar |
||
|---|---|---|
| .github | ||
| android-kiwix-lib-publisher | ||
| include | ||
| scripts | ||
| src | ||
| static | ||
| subprojects | ||
| test | ||
| .clang-format | ||
| .codecov.yml | ||
| .gitignore | ||
| AUTHORS | ||
| COPYING | ||
| ChangeLog | ||
| README.md | ||
| format_code.sh | ||
| kiwix.pc.in | ||
| meson.build | ||
| meson_options.txt | ||
README.md
Kiwix library
The Kiwix library provides the Kiwix software suite core. It contains the code shared by all Kiwix ports (Windows, GNU/Linux, macOS, Android, iOS, ...).
Disclaimer
This document assumes you have a little knowledge about software compilation. If you experience difficulties with the dependencies or with the Kiwix libary compilation itself, we recommend to have a look to kiwix-build.
Preamble
Although the Kiwix library can be (cross-)compiled on/for many sytems, the following documentation explains how to do it on POSIX ones. It is primarly thought for GNU/Linux systems and has been tested on recent releases of Ubuntu and Fedora.
Dependencies
The Kiwix library relies on many third parts software libraries. They are prerequisites to the Kiwix library compilation. Following libraries need to be available:
- ICU (package
libicu-devon Ubuntu) - ZIM (package
libzim-devon Ubuntu) - Pugixml (package
libpugixml-devon Ubuntu) - Aria2 (package
aria2on Ubuntu) - Mustache (Just copy the
header
mustache.hppsomewhere it can be found by the compiler and/or set CPPFLAGS with correct-Ioption)
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 bleeding edge version by hand.
If you want to install these dependencies locally, then use the
kiwix-lib directory as install prefix.
Environment
The Kiwix library builds using Meson version 0.43 or higher. Meson relies itself on Ninja, pkg-config and few other compilation tools.
Install first the few common compilation tools:
These tools should be packaged if you use a cutting edge operating system. If not, have a look to the Troubleshooting section.
Compilation
Once all dependencies are installed, you can compile the Kiwix library with:
meson . build
ninja -C build
By default, it will compile dynamic linked libraries. All binary files
will be created in the "build" directory created automatically by
Meson. If you want statically linked libraries, you can add
--default-library=static option to the Meson command.
Depending of you system, ninja may be called ninja-build.
Installation
If you want to install the Kiwix library and the headers you just have compiled on your system, here we go:
ninja -C build install
You might need to run the command as root (or using sudo), depending
where you want to install the libraries. After the installation
succeeded, you may need to run ldconfig (as root).
Uninstallation
If you want to uninstall the Kiwix library:
ninja -C build uninstall
Like for the installation, you might need to run the command as root
(or using sudo).
Troubleshooting
If you need to install Meson "manually":
virtualenv -p python3 ./ # Create virtualenv
source bin/activate # Activate the virtualenv
pip3 install meson # Install Meson
hash -r # Refresh bash paths
If you need to install Ninja "manually":
git clone git://github.com/ninja-build/ninja.git
cd ninja
git checkout release
./configure.py --bootstrap
mkdir ../bin
cp ninja ../bin
cd ..
If the compilation still fails, you might need to get a more recent version of a dependency than the one packaged by your Linux distribution. Try then with a source tarball distributed by the problematic upstream project or even directly from the source code repository.