summaryrefslogtreecommitdiff
path: root/qutebrowser/components/braveadblock.py
diff options
context:
space:
mode:
authorÁrni Dagur <arni@dagur.eu>2020-10-01 04:58:51 +0000
committerÁrni Dagur <arni@dagur.eu>2020-12-19 20:29:28 +0000
commit1cafa8fe402c2b1a5af859362c7afec6897751cc (patch)
treed856d7b571ed12ae5dd60270cb44bea1be08b6e5 /qutebrowser/components/braveadblock.py
parentd3bd3ca3b06eeb9b0879c5ad05f379368d4265fe (diff)
downloadqutebrowser-1cafa8fe402c2b1a5af859362c7afec6897751cc.tar.gz
qutebrowser-1cafa8fe402c2b1a5af859362c7afec6897751cc.zip
Address code review comments
Diffstat (limited to 'qutebrowser/components/braveadblock.py')
-rw-r--r--qutebrowser/components/braveadblock.py21
1 files changed, 15 insertions, 6 deletions
diff --git a/qutebrowser/components/braveadblock.py b/qutebrowser/components/braveadblock.py
index 076ef3a0c..71cd889f5 100644
--- a/qutebrowser/components/braveadblock.py
+++ b/qutebrowser/components/braveadblock.py
@@ -45,7 +45,7 @@ except ImportError:
logger = logging.getLogger("network")
-ad_blocker = typing.cast(typing.Optional["BraveAdBlocker"], None)
+ad_blocker = None # type: typing.Optional["BraveAdBlocker"]
def _should_be_used() -> bool:
@@ -141,18 +141,21 @@ class BraveAdBlocker:
) -> bool:
"""Check whether the given request is blocked."""
if not self.enabled:
+ # Do nothing if `content.blocking.method` is not set to enable the
+ # use of this adblocking module.
return False
- if first_party_url is not None and not first_party_url.isValid():
- first_party_url = None
-
- if not first_party_url:
+ if first_party_url is None or not first_party_url.isValid():
+ # FIXME: It seems that when `first_party_url` is None, every URL
+ # I try is blocked. This may have been a result of me incorrectly
+ # using the upstream library, or an upstream bug. For now we don't
+ # block any request with `first_party_url=None`.
return False
qtutils.ensure_valid(request_url)
if not config.get("content.blocking.enabled", url=first_party_url):
- # Do nothing if adblocking is disabled.
+ # Do nothing if adblocking is disabled for this site.
return False
result = self._engine.check_network_urls(
@@ -164,6 +167,12 @@ class BraveAdBlocker:
if not result.matched:
return False
elif result.exception is not None and not result.important:
+ # Exception is not `None` when the blocker matched on an exception
+ # rule. Effectively this means that there was a match, but the
+ # request should not be blocked.
+ #
+ # An `important` match means that exceptions should not apply and
+ # no further checking is neccesary--the request should be blocked.
logger.debug(
"Excepting %s from being blocked by %s because of %s",
request_url.toDisplayString(),