mirror of
https://github.com/kiwix/libkiwix.git
synced 2025-08-03 18:26:11 -04:00
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
79 lines
2.3 KiB
C++
79 lines
2.3 KiB
C++
/*
|
|
* Copyright 2019 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.
|
|
*/
|
|
|
|
#ifndef KIWIX_SERVER_H
|
|
#define KIWIX_SERVER_H
|
|
|
|
#include <string>
|
|
#include <memory>
|
|
|
|
namespace kiwix
|
|
{
|
|
class Library;
|
|
class NameMapper;
|
|
class InternalServer;
|
|
|
|
class Server {
|
|
public:
|
|
/**
|
|
* The default constructor.
|
|
*
|
|
* @param library The library to serve.
|
|
*/
|
|
Server(Library* library, NameMapper* nameMapper=nullptr);
|
|
|
|
virtual ~Server();
|
|
|
|
/**
|
|
* Serve the content.
|
|
*/
|
|
bool start();
|
|
|
|
/**
|
|
* Stop the daemon.
|
|
*/
|
|
void stop();
|
|
|
|
void setRoot(const std::string& root);
|
|
void setAddress(const std::string& addr) { m_addr = addr; }
|
|
void setPort(int port) { m_port = port; }
|
|
void setNbThreads(int threads) { m_nbThreads = threads; }
|
|
void setVerbose(bool verbose) { m_verbose = verbose; }
|
|
void setTaskbar(bool withTaskbar, bool withLibraryButton)
|
|
{ setTaskbar(withTaskbar, withLibraryButton, m_blockExternalLinks); }
|
|
void setTaskbar(bool withTaskbar, bool withLibraryButton, bool blockExternalLinks)
|
|
{ m_withTaskbar = withTaskbar; m_withLibraryButton = withLibraryButton; m_blockExternalLinks = blockExternalLinks; }
|
|
|
|
protected:
|
|
Library* mp_library;
|
|
NameMapper* mp_nameMapper;
|
|
std::string m_root = "";
|
|
std::string m_addr = "";
|
|
int m_port = 80;
|
|
int m_nbThreads = 1;
|
|
bool m_verbose = false;
|
|
bool m_withTaskbar = true;
|
|
bool m_withLibraryButton = true;
|
|
bool m_blockExternalLinks = false;
|
|
std::unique_ptr<InternalServer> mp_server;
|
|
};
|
|
}
|
|
|
|
#endif
|