From 068183f0a667399ef51aa97cea49710826ad3566 Mon Sep 17 00:00:00 2001 From: Martin Rotter Date: Mon, 3 May 2021 11:31:59 +0200 Subject: [PATCH] Update docs to adblock. --- resources/docs/Documentation.md | 6 ++++-- src/librssguard/network-web/adblock/adblockmatcher.h | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/resources/docs/Documentation.md b/resources/docs/Documentation.md index da2650049..2183e9154 100644 --- a/resources/docs/Documentation.md +++ b/resources/docs/Documentation.md @@ -285,9 +285,11 @@ RSS Guard allows you to define a set of custom tools which you can subsequently ## AdBlock -[Web-based variant](#web-based-and-lite-app-variants) of RSS Guard offers ad-blocking functionality. AdBlock uses standard AdBlock-Plus-like scripts, thus allowing you to use EasyList etc. AdBlock supports all fundamental features of AdBlock-Plus format, including element hiding rules and site-wide blocking. +[Web-based variant](#web-based-and-lite-app-variants) of RSS Guard offers ad-blocking functionality via [Adblocker](https://github.com/cliqz-oss/adblocker). Adblocker offers similar performance to [uBlock Origin](https://github.com/gorhill/uBlock). -You can find its settings in `Web browser & tabs` section of main menu. AdBlock is of course available only in [WebEngine-based](#web-based-and-lite-app-variants) version of the app. +You need to have have [Node.js](https://nodejs.org) installed to have ad-blocking in RSS Guard working. Also, the implementation requires additional [npm](https://www.npmjs.com) modules to be installed, specifically: `@cliqz/adblocker`, `concat-stream`, `psl`, `node-fetch`. + +The way ad-blocking internally works is that RSS Guard starts local HTTP browser which provides API determine which elements of website should (or should not) be blocked. RSS Guard then asks the server about each file to be downloaded. ## GUI tweaking RSS Guard's GUI is very customizable. You can, for example, hide many GUI elements. There are even people who use RSS Guard on mobile devices powered by Linux like PinePhone or Librem devices. diff --git a/src/librssguard/network-web/adblock/adblockmatcher.h b/src/librssguard/network-web/adblock/adblockmatcher.h index ad066dfae..0af9ec8e9 100644 --- a/src/librssguard/network-web/adblock/adblockmatcher.h +++ b/src/librssguard/network-web/adblock/adblockmatcher.h @@ -37,7 +37,7 @@ class AdBlockMatcher : public QObject { explicit AdBlockMatcher(AdBlockManager* manager); virtual ~AdBlockMatcher(); - const AdBlockRule* match(const AdblockRequestInfo& request, const QString& urlDomain, const QString& urlString) const; + const AdBlockRule* match(const AdblockRequestInfo& request, const QString& url_domain, const QString& url_string) const; bool adBlockDisabledForUrl(const QUrl& url) const; bool elemHideDisabledForUrl(const QUrl& url) const;