Как составлять свои фильтры
В этой статье мы рассказываем, как писать пользовательские правила фильтрации для использования в продуктах AdGuard. Чтобы проверить правила, скачайте приложение AdGuard
Фильтр — это набор правил фильтрации рекламного контента (баннеров, всплывающих окон и тому подобного). В AdGuard есть список базовых фильтров, созданных нашей командой. Они постоянно дорабатываются и дополняются, и, как мы надеемся, удовлетворяют требованиям большинства пользователей.
В то же время AdGuard позволяет создавать пользовательские фильтры, используя те же типы правил, что и в наших фильтрах.
Для описания синтаксиса правил мы используем Augmented BNF for Syntax Specifications, но не всегда строго следуем этой спецификации.
Синтаксис правил AdGuard изначально основан на синтаксисе правил Adblock Plus. Позже мы расширили его новыми типами правил для лучшей фильтрации рекламы. Часть информации в этой статье об общих для ABP и AdGuard типах правил взята из руководства Adblock Plus по написанию фильтров.
Комментарии
Любая строка, начинающаяся с восклицательного знака, является комментарием. В списке правил она подсвечивается серым цветом. AdGuard будет игнорировать эту строку, так что можете спокойно писать там всё, что хотите. Комментарии обычно размещаются над правилами и описывают то, что они делают.
Например:
! Это комментарий. Под этой строкой находится правило фильтрации.
||example.org^
Примеры
Блокировка по имени домена
Это правило блокирует:
http://example.org/ad1.gif
http://subdomain.example.org/ad1.gif
https://ads.example.org:8000/
Это правило не блокирует:
http://ads.example.org.us/ad1.gif
http://example.com/redirect/http://ads.example.org/
By default, such rules do not work for document requests. This means that the ||example.org^
rule will block a request made to example.org
when you try to navigate to this domain from another website, but if you type example.org
into the address bar and try to navigate to it, the website will open. To block the document request, you will need to use a rule with the $document
modifier: ||example.org^$document
.
Блокировка конкретного адреса
Это правило блокирует:
http://example.org/
Это правило не блокирует:
https://example.org/banner/img
Модификаторы базовых правил
Правила фильтрации поддерживают множество модификаторов, которые позволяют вам точно настраивать поведение правила. Вот пример правила с некоторыми простыми модификаторами.
Это правило блокирует:
http://example.com/script.js
, если этот скрипт загружен сexample.com
.
Это правило не блокирует:
https://example.org/script.js
если этот скрипт загружен сexample.org
.https://example.org/banner.png
потому что это не скрипт.
Разблокировка адреса
Это правило разблокирует:
http://example.org/banner.png
, даже если для этого адреса есть правило блокировки.
Правила блокировки с модификатором $important
приоритетнее, чем обычные правила разблокировки.
Разблокировка всего сайта
Это правило разблокирует
- Оно отключает все косметические правила на
example.com
. - Оно блокирует все запросы, отправленные с этого сайта, даже если есть правила блокировки, соответствующие этим запросам.
Косметические правила
Косметические правила применяются с использованием CSS — специального языка программирования, который понимает каждый браузер. В основном, он добавляет новый стиль CSS на сайт, цель которого — скрыть определённые элементы. Вы можете узнать больше о CSS в целом здесь.
AdGuard расширяет возможности CSS и позволяет разработчикам фильтров решать гораздо более сложные задачи. Но чтобы использовать эти расширенные правила, вы должны хорошо понимать, что такое CSS.
Популярные CSS-селекторы
Имя | CSS-селектор | Описание |
---|---|---|
Селектор ID | #banners | Выбирает все элементы, id которых равен banners . |
Селектор класса | .banners | Выбирает все элементы с атрибутом class , содержащие banners . |
Селектор атрибута | div[class="banners"] | Соответствует всем div элементам с атрибутом class , равным banners . |
Селектор вхождения подстроки | div[class^="advert1"] | Выбирает все div -элементы, атрибут class которых начинается с advert1 . |
Селектор вхождения подстроки | div[class$="banners_ads"] | Выбирает все div -элементы, атрибут class которых заканчивается на banners_ads . |
Селектор вхождения подстроки | a[href^="http://example.com/"] | Выбирает все ссылки, загруженные с домена http://example.com/ . |
Селектор атрибута | a[href="http://example.com/"] | Выбирает все ссылки, которые точное соответствуют http://example.com/ . |
Ограничения и запреты
Доверенные фильтры
Некоторые правила можно использовать только в доверенных фильтрах. В эту категорию входят:
- Списки фильтров, созданные командой AdGuard
- Пользовательские списки фильтров, помеченные как
trusted
(доверенные) - Пользовательские правила
AdGuard Content Blocker
AdGuard Content Blocker — это расширение для браузеров Samsung и Яндекс, которое можно установить из Google Play. Его не следует путать с полнофункциональным AdGuard для Android, который можно загрузить только с нашего сайта. К сожалению, возможности AdGuard Content Blocker ограничены тем, что позволяют браузеры, а они поддерживают только старый синтаксис фильтров Adblock Plus:
- Базовые правила блокировки со следующими модификаторами:
$domain
,$third-party
и модификаторы типа контента. - Базовые правила исключения со следующими модификаторами:
$document
,$elemhide
. - Базовые правила скрытия элементов без расширенной поддержки CSS.
Из-за указанных выше ограничений AdGuard Content Blocker не будет упоминаться в примечаниях по совместимости.
Базовые правила
Самые простые правила — это так называемые Базовые правила. Они используются для блокировки запросов к определённым URL-адресам. Либо, при наличии специального маркера @@ в начале правила, для разблокировки запроса. Основной принцип для этого типа правил достаточно прост: необходимо указать адрес и дополнительные параметры, которые ограничивают или расширяют область действия правила.
Базовые правила, блокирующие запросы, применяются только к подзапросам. Это означает, что они не будут блокировать загрузку страницы, если это не будет явно указано с помощью модификатора $document
.
Браузер определяет заблокированный подзапрос как выполненный с ошибкой.
Правила короче 4 символов считаются некорректными и игнорируются.
Синтаксис базовых правил
rule = ["@@"] pattern [ "$" modifiers ]
modifiers = [modifier0, modifier1[, ...[, modifierN]]]
pattern
— маска адреса. URL каждого запроса сопоставляется с этой маской. In the template, you can also use the special characters described below. Note that AdGuard truncates URLs to a length of 4096 characters in order to speed up matching and avoid issues with ridiculously long URLs.@@
— маркер, который используется для обозначения правил-исключений. С такого маркера должны начинаться правила, отключающие фильтрацию для запроса.modifiers
— параметры, используемые для «уточнения» базового правила. Некоторые параметры ограничивают область действия правила, а некоторые могут полностью изменить принцип его работы.
Специальные символы
*
— wildcard-символ. Используется, чтобы обозначить любой набор символов. Это может быть как пустая строка, так и строка любой длины.||
— указание на применение правила к указанному домену и его поддоменам. Этот специальный символ позволяет не указывать конкретный протокол и поддомен в маске адреса. То есть||
соответствует сразуhttp://*.
,https://*.
,ws://*.
иwss://*.
.^
— указатель для разделительного символа. Разделителем может быть любой символ кроме буквы, цифры и следующих символов:_
-
.
%
. Например, в адресеhttp:
//
example.com
/?
t=1
&
t2=t3
жирным выделены разделительные символы. Конец адреса также принимается в качестве разделителя.|
— указатель на начало или конец адреса. Значение зависит от расположения символов в маске. Например, правилоswf|
соответствуетhttp://example.com/annoyingflash.swf
, но неhttp://example.com/swf/index.html
.|http://example.org
соответствуетhttp://example.org
, но неhttp://domain.com?url=http://example.org
.
|
, ||
, ^
can only be used with rules that have a URL pattern. For example, ||example.com##.advert
is incorrect and will be ignored by the blocker.
Рекомендуем также прочитать шпаргалку по фильтрам от Adblock Plus, чтобы лучше понять, как строятся такие правила.
Поддержка регулярных выражений
Если вы хотите добиться ещё большей гибкости при составлении правил, вы можете использовать регулярные выражения вместо упрощённой маски со специальными символами, которая используется по умолчанию.
Такие правила работают медленнее обычных, поэтому рекомендуется избегать их или хотя бы ограничивать их область действия конкретными доменами.
Чтобы блокировщик определил, что вы хотите использовать регулярное выражение, необходимо, чтобы pattern
имел особый вид:
pattern = "/" regexp "/"
Например, правило /banner\d+/$third-party
применит регулярное выражение banner\d+
ко всем сторонним запросам. Правила-исключения с использованием регулярных выражений выглядят вот так: @@/banner\d+/
.
AdGuard для Safari и AdGuard для iOS не полностью поддерживают регулярные выражения в силу ограничений Content Blocking API (см. раздел The Regular expression format).
Поддержка wildcard для доменов верхнего уровня (TLD)
Wildcard-символы поддерживаются для TLD-доменов в шаблонах косметических правил, правил HTML-фильтрации и JavaScript.
Для косметических правил, например, example.*##.banner
, несколько доменов будут сопоставлены благодаря части .*
, т.е. example.com
, sub.example.net
, example.co.uk
и т. д.
При составлении базовых правил вы можете использовать wildcard-символ для TLD только вместе с модификатором $domain
. Например, ||*/banners/*$image,domain=example.*
.
В AdGuard для Windows, Mac и Android и в браузерном расширении AdGuard правила с подстановочным знаком .*
соответствуют любому публичному суффиксу (или eTLD). Но для AdGuard для Safari и iOS поддерживаемый список доменов верхнего уровня ограничен из-за ограничений Safari.
Правила с wildcard для доменов верхнего уровня не поддерживаются в AdGuard Content Blocker.
Примеры базовых правил
||example.com/ads/*
— простое правило, которое соответствует адресам типаhttp://example.com/ads/banner.jpg
и дажеhttp://subdomain.example.com/ads/otherbanner.jpg
.||example.org^$third-party
— this rule blocks third-party requests toexample.org
and its subdomains.@@||example.com$document
— наиболее общее правило-исключение. Такое правило полностью отключает фильтрацию на доменеexample.com
и всех его поддоменах. Существует ряд параметров, которые также можно использовать в правилах-исключениях. Более подробно о правилах-исключениях и параметрах, которые могут в таких правилах использоваться, написано ниже.
Модификаторы базовых правил
Возможности, описанные в этом разделе, предназначены для опытных пользователей. Они расширяют возможности «Общих правил», но для их применения необходимо представлять, как работает браузер.
Вы можете изменить поведение «общего правила», используя дополнительные модификаторы. Список этих параметров располагается в конце правила за знаком доллара $
и разделяется запятыми.
Пример:
||domain.com^$popup,third-party
Базовые модификаторы
Приведённые ниже модификаторы самые простые и часто применяемые. В основном, они просто ограничивают сферу применения правила.
Модификатор \ Продукты | Приложения CoreLibs | AdGuard для Chromium | AdGuard для Firefox | AdGuard для iOS | AdGuard для Safari | AdGuard Content Blocker |
---|---|---|---|---|---|---|
$app | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$denyallow | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$domain | ✅ | ✅ | ✅ | ✅ * | ✅ * | ✅ |
$header | ✅ | 🧩 ** | 🧩 ** | ❌ | ❌ | ❌ |
$important | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$match-case | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$method | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$popup | ✅ *** | ✅ | ✅ | ✅ *** | ✅ *** | ❌ |
$third-party | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$to | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
- ✅ — полностью поддерживается
- ✅ * — поддерживается, но надёжность может быть разной или могут возникнуть ограничения; ознакомьтесь с описанием модификатора для получения подробной информации
- 🧩 — может быть уже реализован в nightly или бета-версиях, но пока не поддерживается в релизных версиях
- ❌ — не поддерживается
$app
Этот модификатор ограничивает действие правила до конкретного приложения (или списка приложений). Это может быть не слишком важно для Windows и Mac, но это очень важно для мобильных устройств, где некоторые правила фильтрации должны быть связаны с конкретным приложением.
- Android — используйте имя пакета приложения, например,
org.example.app
. - Windows — используйте имя процесса, например,
chrome.exe
. - Mac — используйте bundle ID или имя процесса, например,
com.google.Chrome
.
На Mac вы можете найти bundle ID или имя процесса интересующего вас приложения в деталях соответствующих запросов в Журнале фильтрации.
Примеры
||baddomain.com^$app=org.example.app
— правило для блокировки запросов, которые соответствуют указанной маске и отправлены Android-приложениемorg.example.app
.||baddomain.com^$app=org.example.app1|org.example.app2
— аналогичное правило, но оно работает как для приложенияorg.example.app1
, так и дляorg.example.app2
.
Если вы хотите, чтобы правило не применялось к определённым приложениям, начните название приложения с символа ~
.
||baddomain.com^$app=~org.example.app
— правило для блокировки запросов, соответствующих указанной маске и отправленных из любого приложения, кромеorg.example.app
.||baddomain.com^$app=~org.example.app1|~org.example.app2
— аналогично, но в исключениях два приложения:org.example.app1
иorg.example.app2
.
В модификаторе правила к приложениям нельзя добавлять подстановочный знак (), например `$app=com..music`. Правила с таким модификатором считаются недействительными.
- Только AdGuard для Windows, Mac и Android имеют технические возможности для поддержки правил с модификатором
$app
. - On Windows the process name is case-insensitive starting with AdGuard for Windows with CoreLibs v1.12 or later.
$denyallow
Модификатор $denyallow
позволяет избежать создания дополнительных правил, когда требуется отключить то или иное правило для определённых доменов. Модификатор $denyallow
соответствует только целевым доменам, но не доменам реферера.
Добавление этого модификатора в правило равносильно исключению доменов при помощи паттерна правила либо при помощи добавления дополнительных правил-исключений. To add multiple domains to one rule, use the |
character as a separator.
Примеры
Это правило:
*$script,domain=a.com|b.com,denyallow=x.com|y.com
эквивалентно этому правилу:
/^(?!.*(x.com|y.com)).*$/$script,domain=a.com|b.com
или комбинации этих трёх:
*$script,domain=a.com|b.com
@@||x.com$script,domain=a.com|b.com
@@||y.com$script,domain=a.com|b.com
- Паттерн правила не может указывать на конкретные домены, например, не может начинаться с
||
. - Domains in the modifier value cannot be negated, e.g.
$denyallow=~x.com
, or have a wildcard TLD, e.g.$denyallow=x.*
, or be a regular expression, e.g.$denyallow=/\.(com\|org)/
. $denyallow
cannot be used together with$to
. It can be expressed with inverted$to
:$denyallow=a.com|b.com
is equivalent to$to=~a.com|~b.com
.
Правила, нарушающие эти ограничения, считаются недействительными.
Правила с модификатором $denyallow
не поддерживаются в AdGuard для iOS, Safari и AdGuard Content Blocker.
$domain
$domain
ограничивает область действия правила запросами, сделанными с указанных доменов и их поддоменов (как указано в HTTP-заголовке Referer).
Syntax
Модификатор представляет собой список из одного или нескольких выражений, разделённых символом |
, каждое из которых сопоставляется с доменом определённым образом в зависимости от его типа (см. ниже).
domains = ["~"] entry_0 ["|" ["~"] entry_1 ["|" ["~"]entry_2 ["|" ... ["|" ["~"]entry_N]]]]
entry_i = ( regular_domain / any_tld_domain / regexp )
Regular_domain
— обычное доменное имя (domain.com
). Соответствует указанному домену и его поддоменам. Сопоставляется лексикографически.any_tld_domain
— доменное имя, оканчивающееся подстановочным знаком в качестве публичного суффикса, например, дляexample.*
этоco.uk
вexample.co.uk
. Соответствует указанному домену и его поддоменам с любым публичным суффиксом. Сопоставляется лексикографически.regexp
— регулярное выражение, начинается и заканчивается символом/
. Паттерн работает так же, как и в основных URL-правилах, но символы/
,$
и,
должны быть экранированы с помощью\
.
Правила с модификатором $domain
в виде regular_domain
или any_tld_domain
поддерживаются всеми продуктами AdGuard.
Примеры
Просто $domain
:
||baddomain.com^$domain=example.org
блокирует запросы, которые соответствуют указанной маске и отправлены с доменаexample.org
или его поддоменов.||baddomain.com^$domain=example.org|example.com
— такое же правило, но срабатывать оно будет как для доменаexample.org
, так и дляexample.com
.
Если вы хотите, чтобы правило не применялось к определённым доменам, начните доменное имя со знака ~
.
$domain
и инверсия ~
:
||baddomain.com^$domain=example.org
блокирует запросы, которые соответствуют указанной маске и отправлены с доменаexample.org
или его поддоменов.||baddomain.com^$domain=example.org|example.com
— такое же правило, но срабатывать оно будет как для доменаexample.org
, так и дляexample.com
.||baddomain.com^$domain=~example.org
блокирует запросы, которые соответствуют указанной маске и отправлены с любого домена, кромеexample.org
и его поддоменов.||baddomain.com^$domain=example.org|~foo.example.org
блокирует запросы, отправленные с доменаexample.org
и всех его поддоменов, кромеfoo.example.org
.||baddomain.com^$domain=/(^\|.+\.)example\.(com\|org)\$/
блокирует запросы, отправляемые с доменовexample.org
иexample.com
и всех их поддоменов.||baddomain.com^$domain=~a.com|~b.*|~/(^\|.+\.)c\.(com\|org)\$/
блокирует запросы, отправленные с любых доменов, кромеa.com
,b
с любым публичным суффиксом (b.com
,b.co.uk
, и т.д.),c.com
,c.org
и их поддоменов.
Модификатор $domain
, соответствующий целевому домену:
В некоторых случаях модификатор $domain
может соответствовать не только домену-рефереру, но и целевому домену. This happens when all the following conditions are met:
- The request has the
document
content type - Шаблон правила не соответствует ни одному конкретному домену
- Шаблон правила не содержит регулярных выражений
- Модификатор
$domain
содержит только исключённые домены, например,$domain=~example.org|~example.com
Для сопоставления целевого домена должен выполняться следующий предикат:
1 И ((2 И 3) ИЛИ 4)
То есть, если модификатор $domain
содержит только исключённые домены, то правилу не нужно выполнять второе и третье условия, чтобы соответствовать целевому домену $domain
.
Если какие-либо из условий выше не выполнены, но правило содержит модификатор $cookie
или $csp
, модификатор всё равно будет соответствовать целевому домену.
Если реферер соответствует правилу с $domain
, которое явно исключает домен реферера, то правило не сработает, даже если целевой домен тоже ему соответствует. Это также касается правил с модификаторами $cookie
и $csp
.
Примеры
*$cookie,domain=example.org|example.com
заблокирует cookies для всех запросов от и кexample.org
иexample.com
.*$document,domain=example.org|example.com
заблокирует все запросы от и кexample.org
иexample.com
.
В следующих примерах предполагается, что запросы отправляются от http://example.org/page
(реферер), а целевой URL — http://targetdomain.com/page
.
page$domain=example.org
сработает, так как соответствует рефереру.page$domain=targetdomain.com
сработает, так как соответствует целевому домену и удовлетворяет всем требованиям, перечисленным выше.||*page$domain=targetdomain.com
не сработает, так как шаблон||*page
может указывать на конкретные домены, например,example.page
.||*page$domain=targetdomain.com,cookie
сработает, потому что правило содержит модификатор$cookie
, несмотря на то, что шаблон||*page
может соответствовать конкретным доменам./banner\d+/$domain=targetdomain.com
не сработает, поскольку правило содержит регулярное выражение.page$domain=targetdomain.com|~example.org
не сработает, так как домен реферера явно исключён.
Ограничения модификатора $domain
Safari не поддерживает одновременно разрешённые и запрещённые домены, поэтому правила вида ||baddomain.com^$domain=example.org|~foo.example.org
не работают в AdGuard для iOS и AdGuard для Safari.
Rules with regular expressions in the $domain
modifier are supported by AdGuard for Windows, AdGuard for Mac, and AdGuard for Android with CoreLibs v1.11 or later, and AdGuard Browser Extension with TSUrlFilter v3.0.0 or later.
In AdGuard for Windows, Mac and Android with CoreLibs v1.12 or later the $domain
modifier can be alternatively spelled as $from
.
$header
Модификатор $header
позволяет сопоставлять HTTP-ответ, имеющий определённый заголовок, с определённым значением (опционально).
Syntax
$header "=" h_name [":" h_value]
h_value = string / regexp
где:
h_name
(обязательно) — имя HTTP-заголовка. It is matched case-insensitively.h_value
(опционально) — выражение для сопоставления значения HTTP-заголовка, может быть одним из:string
— последовательность символов. Лексикографически сопоставляется со значением заголовка;regexp
— регулярное выражение, начинается и заканчивается символом/
. Паттерн работает так же, как и в основных URL-правилах, но символы/
,$
и,
должны быть экранированы с помощью\
.
The modifier part, ":" h_value
, may be omitted. В этом случае модификатор сопоставляет только имя заголовка.
Примеры
||example.com^$header=set-cookie:foo
— блокирует запрос, ответ которого содержит заголовокSet-Cookie
со значениемfoo
.||example.com^$header=set-cookie
блокирует запрос, ответ которого содержит заголовокSet-Cookie
с любым значением.@@||example.com^$header=set-cookie:/foo\, bar\$/
разблокирует запросы, ответы которых содержат заголовокSet-Cookie
со значениемfoo, bar$
.@@||example.com^$header=set-cookie
разблокирует запрос, ответ которого содержит заголовокSet-Cookie
с любым значением.
$header
modifier limitations
- The
$header
modifier can be matched only when headers are received. So if the request is blocked or redirected at an earlier stage, the modifier cannot be applied. - In Adguard Browser Extension, the
$header
modifier is only compatible with$csp
,$removeheader
,$important
, and$badfilter
.
Rules with the $header
modifier are supported by AdGuard for Windows, AdGuard for Mac, and AdGuard for Android with CoreLibs v1.11 or later, and AdGuard Browser Extension with TSUrlFilter v3.0.0 or later.
$important
The $important
modifier applied to a rule increases its priority over rules without the identical modifier. Даже относительно базовых правил-исключений.
Перейдите к приоритетам правил для более подробной информации.
Примеры
! блокирующее правило заблокирует все запросы, несмотря на правило-исключение
||example.org^$important
@@||example.org^
! если правило-исключение тоже содержит модификатор `$important`, его приоритет будет выше, и запросы не будут заблокированы
||example.org^$important
@@||example.org^$important
$match-case
Этот модификатор определяет правило, которое применяется только к адресам с совпадением регистра символов. По умолчанию регистр символов не учитывается.
Примеры
*/BannerAd.gif$match-case
— такое правило будет блокироватьhttp://example.com/BannerAd.gif
, но неhttp://example.com/bannerad.gif
.
Rules with the $match-case
are supported by AdGuard for iOS and AdGuard for Safari with SafariConverterLib v2.0.43 or later.
Все остальные продукты уже поддерживают этот модификатор.
$method
Этот модификатор ограничивает область действия правила запросами, использующими указанный набор методов HTTP. Допускается инверсия (~). Методы должны быть указаны строчными буквами, но сопоставляются они без учёта регистра. Чтобы добавить несколько методов в одно правило, используйте в качестве разделителя вертикальную черту |
.
Примеры
||evil.com^$method=get|head
блокирует только запросы GET и HEAD кevil.com
.||evil.com^$method=~post|~put
блокирует любые запросы кevil.com
, кроме POST или PUT.@@||evil.com$method=get
разблокирует только GET-запросы кevil.com
.@@||evil.com$method=~post
разблокирует любые запросы кevil.com
, кроме POST.
Правила, где к одному методу применяется инверсия (~), а к другому нет, считаются недействительными. Так, например, правило ||evil.com^$method=get|~head
будет отклонено.
Rules with $method
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.12 or later and AdGuard Browser Extension for Chrome, Firefox, and Edge with TSUrlFilter v2.1.1 or later.
$popup
AdGuard будет пытаться закрыть браузерную вкладку с любым адресом, подходящим под правило с этим модификатором. Обратите внимание, что закрыть можно не любую вкладку.
Примеры
||domain.com^$popup
— при попытке перехода на сайтhttp://domain.com
с любой страницы в браузере, новая вкладка, в которой должен открыться указанный сайт, будет закрыта.
$popup
modifier limitations
- The
$popup
modifier works best in AdGuard Browser Extension. - In AdGuard for iOS and AdGuard for Safari,
$popup
rules simply block the page right away. - In AdGuard for Windows, AdGuard for Mac, and AdGuard for Android, the
$popup
modifier may not detect a popup in some cases and it will not be blocked. The$popup
modifier applies thedocument
content type with a special flag which is passed to a blocking page. Блокирующая страница сама может провести некоторые проверки и закрыть окно, если это действительно всплывающее окно. В противном случае страница должна быть загружена. Его можно комбинировать с другими модификаторами типа request, такими как$third-party
и$important
.
Rules with the $popup
modifier are not supported by AdGuard Content Blocker.
$third-party
Ограничение на сторонние или собственные запросы. Сторонним является запрос, отправленный с другого домена. Например, запрос к домену example.org
, отправленный с домена domain.com
, является сторонним.
Чтобы считаться таковым, сторонний запрос должен соответствовать одному из следующих условий:
- Его реферер — это не поддомен целевого домена, или наоборот. Например, запрос к
subdomain.example.org
, отправленный с доменаexample.org
, не является сторонним - Значение его заголовка
Sec-Fetch-Site
—cross-site
Примеры
$third-party
:
||domain.com^$third-party
— правило применяется на всех сайтах, кромеdomain.com
и его поддоменов. Пример стороннего запроса:http://example.org/banner.jpg
.
Если указан модификатор $~third-party
, то правило применяется только к запросам, которые не являются сторонними. То есть эти запросы отправлены с того же домена.
$~third-party
:
||domain.com$~third-party
— this rule is applied exclusively todomain.com
. Example of a non third-party request:http://domain.com/icon.ico
.
Вы можете использовать более короткое название (псевдоним) вместо полного названия модификатора: $3p
.
$to
$to
ограничивает область действия правила запросами, сделанными на указанные домены и их поддомены. To add multiple domains to one rule, use the |
character as a separator.
Примеры
/ads$to=evil.com|evil.org
блокирует любые запросы кevil.com
илиevil.org
и их поддоменам с путём, соответствующим/ads
./ads$to=~not.evil.com|evil.com
блокирует любые запросы кevil.com
и его поддоменам с путём, совпадающим с/ads
, за исключением запросов кnot.evil.com
и его поддоменам./ads$to=~good.com|~good.org
блокирует любые запросы с путём, соответствующим/ads
, за исключением запросов кgood.com
илиgood.org
и их поддоменам.
$denyallow
cannot be used together with $to
. It can be expressed with inverted $to
: $denyallow=a.com|b.com
is equivalent to $to=~a.com|~b.com
.
Rules with the $to
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.12 or later and AdGuard Browser Extension with TSUrlFilter v2.1.3 or later.
Модификаторы типа контента
Существует целый набор модификаторов, которые ограничивают область применения правила только определённым типом контента. Эти модификаторы можно комбинировать, чтобы, например, распространить правило одновременно и на картинки, и на скрипты.
Существует большая разница в том, как AdGuard определяет тип контента на разных платформах. В случае Браузерного расширения AdGuard, тип контента для каждого запроса предоставляется самим браузером. В случае AdGuard для Windows, Mac и Android для определения используется следующая методика: сначала мы пытаемся определить тип запроса по заголовку запроса Sec-Fetch-Dest
или по расширению имени файла. Если запрос не заблокирован на этом этапе, то тип запроса уточняется с использованием заголовка Content-Type
в начале ответа, полученного от сервера.
Примеры модификаторов типа контента
||example.org^$image
— соответствует всем картинкам с доменаexample.org
.||example.org^$script,stylesheet
— соответствует всем скриптам и стилям с доменаexample.org
.||example.org^$~image,~script,~stylesheet
— соответствует всем запросам к доменуexample.org
, кроме картинок, скриптов и стилей.
Модификатор \ Продукты | Приложения CoreLibs | AdGuard для Chromium | AdGuard для Firefox | AdGuard для iOS | AdGuard для Safari | AdGuard Content Blocker |
---|---|---|---|---|---|---|
$document | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$font | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$image | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$media | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$object | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$other | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$ping | ✅ * | ✅ | ✅ | ❌ | ❌ | ✅ |
$script | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$stylesheet | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$subdocument | ✅ * | ✅ | ✅ | ✅ | ✅ | ❌ |
$websocket | ✅ | ✅ | ✅ | ✅ * | ✅ * | ✅ |
$xmlhttprequest | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$webrtc 🚫 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
$object-subrequest 🚫 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
- ✅ — полностью поддерживается
- ✅ * — поддерживается, но надёжность может быть разной или могут возникнуть ограничения; ознакомьтесь с описанием модификатора для получения подробной информации
- ❌ — не поддерживается
- 🚫 — удалён и больше не поддерживается
$document
Правило соответствует запросам основного документа страницы, т.е. HTML-документа, который загружается во вкладке браузера. Оно не подходит для iframe, для них существует модификатор $subdocument
.
По умолчанию AdGuard не блокирует запросы, которые загружаются во вкладке браузера (например, «обход основного фрейма»). Идея заключается в том, чтобы не препятствовать загрузке страниц, поскольку пользователь явно указал, что он хочет, чтобы эта страница была загружена. Однако, если использовать модификатор $document
, то AdGuard не будет использовать эту логику и предотвратит загрузку страницы. Другими словами, заблокирует её.
Если этот модификатор используется в правиле-исключении (@@
), то оно полностью отключает блокировку на соответствующих страницах. Это равносильно одновременному использованию модификаторов $elemhide
, $content
, $urlblock
, $jsinject
и $extension
.
Примеры
@@||example.com^$document
полностью отключает фильтрацию на всех страницах сайтаexample.com
и всех его поддоменах.||example.com^$document
блокирует запрос HTML-документа наexample.com
с помощью блокирующей страницы.||example.com^$document,redirect=noopframe
перенаправляет запрос HTML-документа сайтаexample.com
на пустой HTML-документ.||example.com^$document,removeparam=test
removestest
query parameter from HTML document request toexample.com
.||example.com^$document,replace=/test1/test2/
replacestest1
withtest2
in HTML document request toexample.com
.
Вы можете использовать более короткое имя (псевдоним) вместо полного имени модификатора: $doc
.
$font
Правило соответствует запросам к файлам шрифтов (например, файлам с расширением .woff
).
$image
Правило соответствует запросам к изображениям.
$media
Правило соответствует запросам к медиафайлам — музыке и видео, например файлам .mp4
.
$object
Правило соответствует ресурсам плагинов браузера, например, Java или Flash.
$other
Правило применяется к запросам, тип которых не был определён или не соответствует перечисленным выше типам.
$ping
Правило соответствует запросам, вызванным атрибутом navigator.sendBeacon()
или ping
в ссылках.
AdGuard для Windows, Mac и Android часто не может точно определить navigator.sendBeacon()
. Не рекомендуется использовать $ping
в фильтрах, которые должны использоваться продуктами AdGuard на базе CoreLibs.
Правила с модификатором $ping
не поддерживаются в AdGuard для Safari и iOS.
$script
Правило соответствет запросам к файлам скриптов, например, javascript или vbscript.
$stylesheet
Правило соответствует запросам к файлам CSS-стилей.
Вы можете использовать более короткое имя (псевдоним) вместо полного имени модификатора: $css
.
$subdocument
Правило соответствует запросам к встроенным страницам — HTML-теги frame
и iframe
.
Примеры
||example.com^$subdocument
блокирует запросы встроенных страниц (frame
иiframe
) кexample.com
и всем его поддоменам.||example.com^$subdocument,domain=domain.com
блокирует запросы встроенных страниц (frame
иiframe
) кexample.com
и его поддоменам сdomain.com
и всех его поддоменов.
Вы можете использовать более короткое имя (псевдоним) вместо полного имени модификатора: $frame
.
В AdGuard для Windows, Mac и Android вложенные документы обнаруживаются по заголовку Sec-Fetch-Dest, если он есть. В противном случае некоторые основные страницы могут рассматриваться как поддокументы.
Правила с модификатором $subdocument
не поддерживаются в AdGuard Content Blocker.
$websocket
Правило применяется только к соединениям WebSocket.
Модификатор $websocket
поддерживается во всех продуктах AdGuard, кроме AdGuard Content Blocker. Что касается AdGuard для Safari и AdGuard для iOS, то они поддерживаются на устройствах с macOS Monterey (версия 12) и iOS 16 и выше.
$xmlhttprequest
Правило применяется только к ajax-запросам (запросам, отправленным через объект JavaScript XMLHttpRequest
).
Вы можете использовать более короткое имя (псевдоним) вместо полного имени модификатора: $xhr
.
AdGuard для Windows, Mac и Android часто не может точно определить этот тип модификатора и иногда определяет его как $other
или $script
. Они могут надёжно обнаружить этот тип контента только при фильтрации современных браузеров, поддерживающих Fetch metadata request headers.
$object-subrequest
(удалён)
Модификатор $object-subrequest
удалён и больше не поддерживается. Правила с ним не работают. Правило соответствует запросам плагинов браузера (обычно это Flash).
$webrtc
(удалён)
Этот модификатор удалён и больше не поддерживается. Правила с ним не работают. Если вы хотите блокировать WebRTC, рассмотрите возможность использования скриптлета nowebrtc
.
Правило применяется только к WebRTC-соединениям.
Примеры
||example.com^$webrtc,domain=example.org
blocks webRTC connections toexample.com
fromexample.org
.@@*$webrtc,domain=example.org
— это правило отключает оболочку RTC дляexample.org
.
Модификаторы правил исключений
Правила исключений отключают действие других базовых правил для адресов, которым они соответствуют. Они начинаются с маркера @@
. Для таких правил работают все базовые модификаторы, перечисленные выше. Также добавляется несколько специальных модификаторов, которые будут описаны ниже.
Рекомендуем также прочитать шпаргалку по фильтрам от Adblock Plus, чтобы лучше понять, как строятся правила исключений.
Модификатор \ Продукты | Приложения CoreLibs | AdGuard для Chromium | AdGuard для Firefox | AdGuard для iOS | AdGuard для Safari | AdGuard Content Blocker |
---|---|---|---|---|---|---|
$content | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
$elemhide | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$extension | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$jsinject | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$stealth | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$urlblock | ✅ | ✅ | ✅ | ✅ * | ✅ * | ❌ |
$genericblock | ✅ | ✅ | ✅ | ✅ * | ✅ * | ❌ |
$generichide | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
$specifichide | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
- ✅ — полностью поддерживается
- ✅ * — поддерживается, но надёжность может быть разной или могут возникнуть ограничения; ознакомьтесь с описанием модификатора для получения подробной информации
- ❌ — не поддерживается
$content
Отключает HTML-фильтрацию, правила $hls
, $replace
и $jsonprune
на страницах, соответствующих правилу.
Примеры
@@||example.com^$content
отключает все правила модификации контента на страницахexample.com
и всех его поддоменах.
$elemhide
Отключает любые косметические правила на страницах, подходящих под правило.
Примеры
@@||example.com^$elemhide
отменяет все косметические правила для страниц на сайтеexample.com
и на всех его поддоменах.
Вы можете использовать более короткое название (псевдоним) вместо полного названия модификатора: $ehide
.
$extension
Отключает пользовательские скрипты — определённые или все для данного домена.
Syntax
$extension[="userscript_name1"[|"userscript_name2"[|"userscript_name3"[...]]]]
userscript_name(i)
обозначает конкретное имя пользовательского скрипта, которое должно быть отключено модификатором. The modifier can contain any number of userscript names or none. В последнем случае модификатор отключает все пользовательские скрипты.
Имена пользовательских скриптов обычно содержат пробелы или другие специальные символы, поэтому необходимо заключать их в кавычки. Поддерживаются как одинарные ('
), так и двойные ("
) ASCII-кавычки. Несколько имён пользовательских скриптов должны быть разделены вертикальной чертой (|
). Однако если имя пользовательского скрипта представляет собой одно слово без специальных символов, то его можно использовать без кавычек.
Вы также можете исключить пользовательский скрипт из фильтрации, добавив перед ним символ ~
. В этом случае пользовательский скрипт не будет отключён модификатором.
$extension=~"userscript name"
Исключая пользовательский скрипт из фильтрации, обязательно выносите символ ~
за кавычки.
Если имя пользовательского скрипта содержит кавычки ("
), запятые (,
) или вертикальную черту (|
), они должны быть экранированы обратной косой чертой (\
).
$extension="userscript name\, with \"quote\""
Примеры
@@||example.com^$extension="AdGuard Assistant"
отключает пользовательский скриптAdGuard Assistant
на сайтеexample.com
.@@||example.com^$extension=MyUserscript
отключает пользовательский скриптMyUserscript
на сайтеexample.com
.@@||example.com^$extension='AdGuard Assistant'|'Popup Blocker'
отключает оба пользовательских скриптаAdGuard Assistant
иPopup Blocker
на сайтеexample.com
.@@||example.com^$extension=~"AdGuard Assistant"
отключает все пользовательские скрипты на сайтеexample.com
, кромеAdGuard Assistant
.@@||example.com^$extension=~"AdGuard Assistant"|~"Popup Blocker"
отключает все пользовательские скрипты на сайтеexample.com
, кромеAdGuard Assistant
иPopup Blocker
.@@||example.com^$extension
— пользовательские скрипты не будут работать на страницах сайтаexample.com
.@@||example.com^$extension="AdGuard \"Assistant\""
отключает пользовательский скриптAdGuard "Assistant"
на сайтеexample.com
.
- Только AdGuard для Windows, Mac и Android имеют технические возможности для поддержки правил с модификатором
$extension
. - Rules with
$extension
modifier with specific userscript name are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.13 or later.
$jsinject
Запрещает добавление javascript-кода на страницу. О скриптлетах и javascript-правилах речь пойдёт ниже.
Примеры
@@||example.com^$jsinject
отменяет все javascript-правила для страниц на сайтеexample.com
и на всех его поддоменах.
$stealth
Отключает модуль «Антитрекинг» для всех страниц и запросов, подходящих под это правило.
Syntax
$stealth [= opt1 [| opt2 [| opt3 [...]]]]
Здесь opt(i)
обозначают опции «Антитрекинг», отключаемые правилами. The modifier can contain any number of specific options (see below) or none. В последнем случае модификатор отключает модуль «Антитрекинг» полностью.
Список доступных опций модификатора:
searchqueries
отключает опцию Скрывать поисковые запросыdonottrack
отключает опцию Просить сайты не отслеживать вас3p-cookie
отключает Самоуничтожение сторонних куки1p-cookie
отключает Самоуничтожение куки сайта3p-cache
отключает опцию Блокировать заголовки ETag и If-None-Match3p-auth
отключает опцию Блокировать сторонний заголовок авторизацииwebrtc
отключает опцию Блокировать WebRTCpush
отключает опцию Блокировать Push APIlocation
отключает опцию Блокировать Location APIflash
отключает опцию Блокировать Flashjava
отключает опцию Блокировать Javareferrer
отключает опцию Скрывать Referer от третьих лицuseragent
отключает опцию Скрывать User-Agentip
отключает опцию Скрывать IP-адресxclientdata
отключает опцию Удалять заголовок X-Client-Datadpi
отключает опцию Защищать от DPI
Примеры
@@||example.com^$stealth
полностью отключает модуль «Антитрекинг» для запросов кexample.com
и поддоменам, кроме блокировки куки и скрытия параметров отслеживания (см.ниже).@@||domain.com^$script,stealth,domain=example.com
отключает модуль «Антитрекинг» только для script-запросов кdomain.com
(и поддоменам) наexample.com
и всех его поддоменах.@@||example.com^$stealth=3p-cookie|dpi
отключает блокировку сторонних куки-файлов и меры защиты от DPI для запросов кexample.com
.
Blocking cookies and removing tracking parameters is achieved by using rules with the $cookie
, $urltransform
and $removeparam
modifiers. Exception rules that contain only the $stealth
modifier will not do these things. If you want to completely disable all Stealth mode features for a given domain, you must include all three modifiers: @@||example.org^$stealth,removeparam,cookie
.
- Modifier options must be lowercase, i.e.
$stealth=DPI
will be rejected. - Параметры модификатора не могут отрицаться, т.е.
$stealth=~3p-cookie
будет отклонён. - AdGuard Browser Extension supports only
searchqueries
,donottrack
,referrer
,xclientdata
,1p-cookie
and3p-cookie
options.
- Stealth Mode is available in AdGuard for Windows, AdGuard for Mac, AdGuard for Android, and AdGuard Browser Extension. Все остальные продукты будут игнорировать правила с модификатором
$stealth
. - Rules with
$stealth
modifier with specific options are supported by AdGuard for Windows, AdGuard for Mac, and AdGuard for Android with CoreLibs v1.10 or later, and AdGuard Browser Extension with TSUrlFilter v3.0.0 or later.
$urlblock
Отключает все правила $cookie
и блокировку всех запросов со страниц, соответствующих правилу.
Примеры
@@||example.com^$urlblock
— любые запросы, отправленные со страниц сайтаexample.com
и всех его поддоменов, не будут блокироваться.
В AdGuard для iOS и AdGuard для Safari правила $urlblock
работают как исключение $document — они разблокируют всё.
Правила с модификатором $urlblock
не поддерживаются в AdGuard Content Blocker.
Generic-правила
Перед тем, как перейти к описанию следующих модификаторов, необходимо ввести определение generic-правил. Правило относится к generic-правилам, если его действие не ограничено конкретными доменами. Также поддерживается wildcard-символ *
.
Например, это generic-правила:
###banner
*###banner
#@#.adsblock
*#@#.adsblock
~domain.com###banner
||domain.com^
||domain.com^$domain=~example.com
А это уже не generic-правила:
domain.com###banner
||domain.com^$domain=example.com
$genericblock
Отключает все базовые правила generic на страницах, подходящих под правило-исключение.
Примеры
@@||example.com^$genericblock
отключает базовые правила generic на любых страницахexample.com
и всех поддоменах.
В AdGuard для iOS и AdGuard для Safari правила $genericblock
работают как исключение $document — они разблокируют всё.
Правила с модификатором $genericblock
не поддерживаются в AdGuard Content Blocker.
$generichide
Отключает все косметические правила generic на страницах, соответствующих правилу-исключению.
Примеры
@@||example.com^$generichide
отключает косметические правила generic на страницах сайтаexample.com
и всех его поддоменах.
Вы можете использовать более короткое имя (псевдоним) вместо полного имени модификатора: $ghide
.
specifichide
Отключает все specific-правила скрытия элементов и CSS-правила, но не отключает general-правила. Имеет эффект, противоположный $generichide
.
Примеры
@@||example.org^$specifichide
отключаетexample.org##.banner
, но не##.banner
.
Вы можете использовать более короткое имя (псевдоним) вместо полного имени модификатора: $shide
.
Все косметические правила, а не только specific, можно отключить модификатором $elemhide
.
Правила с модификатором $specifichide
не поддерживаются в AdGuard для iOS, AdGuard для Safari и AdGuard Content Blocker.
Расширенные возможности
Модификаторы, описанные в этом разделе, полностью меняют поведение базовых правил.
Модификатор \ Продукты | Приложения CoreLibs | AdGuard для Chromium | AdGuard для Firefox | AdGuard для iOS | AdGuard для Safari | AdGuard Content Blocker |
---|---|---|---|---|---|---|
$all | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$badfilter | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$cookie | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$csp | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$hls | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$inline-font | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$inline-script | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$jsonprune | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$xmlprune | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$network | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$permissions | ✅ * | 🧩 | 🧩 * | ❌ | ❌ | ❌ |
$redirect | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$redirect-rule | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$referrerpolicy | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$removeheader | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$removeparam | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$replace | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
$urltransform | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
noop | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$empty 👎 | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
$mp4 👎 | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
- ✅ — полностью поддерживается
- ✅ * — поддерживается, но надёжность может быть разной или могут возникнуть ограничения; ознакомьтесь с описанием модификатора для получения подробной информации
- 🧩 — может быть уже реализован в nightly или бета-версиях, но пока не поддерживается в релизных версиях
- ❌ — не поддерживается
- 👎 — deprecated; still supported but will be removed in the future
$all
$all
modifier is made of all content-types modifiers and $popup
. E.g. rule ||example.org^$all
is converting into rule:
||example.org^$document,subdocument,font,image,media,object,other,ping,script,stylesheet,websocket,xmlhttprequest,popup
This modifier cannot be used as an exception with the @@
mark.
Rules with $all
modifier are not supported by AdGuard Content Blocker.
$badfilter
The rules with the $badfilter
modifier disable other basic rules to which they refer. It means that the text of the disabled rule should match the text of the $badfilter
rule (without the $badfilter
modifier).
Примеры
||example.com$badfilter
отключает||example.com
||example.com$image,badfilter
отключает||example.com$image
@@||example.com$badfilter
отключает@@||example.com
||example.com$domain=domain.com,badfilter
отключает||example.com$domain=domain.com
Rules with $badfilter
modifier can disable other basic rules for specific domains if they fulfill the following conditions:
- В правиле есть модификатор
$domain
- В модификаторе
$domain
нет отрицания домена~
In that case, the $badfilter
rule will disable the corresponding rule for domains specified in both the $badfilter
and basic rules. Please note that wildcard-TLD logic works here as well.
Примеры
/some$domain=example.com|example.org|example.io
отключено дляexample.com
правилом/some$domain=example.com,badfilter
/some$domain=example.com|example.org|example.io
отключено дляexample.com
иexample.org
правилом/some$domain=example.com|example.org,badfilter
/some$domain=example.com|example.org
и/some$domain=example.io
полностью отключены правилом/some$domain=example.com|example.org|example.io,badfilter
/some$domain=example.com|example.org|example.io
полностью отключено правилом/some$domain=example.*,badfilter
/some$domain=example.*
отключено дляexample.com
иexample.org
правилом/some$domain=example.com|example.org,badfilter
/some$domain=example.com|example.org|example.io
НЕ отключено дляexample.com
правилом/some$domain=example.com|~example.org,badfilter
, поскольку значение модификатора$domain
содержит отрицание домена
Rules with $badfilter
modifier are not supported by AdGuard Content Blocker.
$cookie
The $cookie
modifier completely changes rule behavior. Instead of blocking a request, this modifier makes AdGuard suppress or modify the Cookie
and Set-Cookie
headers.
Multiple rules matching a single request
In case if multiple $cookie
rules match a single request, we will apply each of them one by one.
Syntax
$cookie [= name[; maxAge = seconds [; sameSite = strategy ]]]
где:
name
— опционально, строка или регулярное выражение для сопоставления с именем куки.seconds
— количество секунд, на которое сместится истечение срока действия куки.strategy
— строка для стратегии Same-Site для использования куки.
For example,
||example.org^$cookie=NAME;maxAge=3600;sameSite=lax
every time AdGuard encounters a cookie called NAME
in a request to example.org
, it will do the following:
- Установит дату истечения срока хранения на текущее время плюс
3600
секунд - Позволяет куки использовать стратегию Same-Site.
Escaping special characters
If regular expression name
is used for matching, two characters must be escaped: comma ,
and dollar sign $
. Use backslash \
escape each of them. For example, escaped comma looks like this: \,
.
Примеры
||example.org^$cookie
блокирует все куки, установленныеexample.org
; это эквивалентно установкеmaxAge=0
$cookie=__cfduid
блокирует куки CloudFlare везде$cookie=/__utm[a-z]/
блокирует куки Google Analytics везде||facebook.com^$third-party,cookie=c_user
не позволяет Facebook отслеживать вас, даже если вы вошли в систему
There are two methods to deactivate $cookie
rules: the primary method involves using an exception marked with @@
— @@||example.org^$cookie
. The alternative method employs a $urlblock
exception (also included under the $document
exception alias — $elemhide,jsinject,content,urlblock,extension
). Here's how it works:
@@||example.org^$cookie
разблокирует все куки-файлы, установленныеexample.org
@@||example.org^$urlblock
разблокирует все файлы куки, установленныеexample.org
, и отключает блокировку всех запросов, отправленных сexample.org
@@||example.org^$cookie=concept
разблокирует один куки-файл с именемconcept
@@||example.org^$cookie=/^_ga_/
разблокирует все куки, соответствующие регулярному выражению
$cookie
rules support three types of modifiers: $domain
, $~domain
, $important
, $third-party
, and $~third-party
.
Rules with $cookie
modifier are not supported by AdGuard Content Blocker, AdGuard for iOS, and AdGuard for Safari.
$csp
This modifier completely changes the rule behavior. If it is applied to a rule, the rule will not block the matching request. Response headers will be modified instead.
In order to use this type of rules, it is required to have the basic understanding of the Content Security Policy security layer.
For the requests matching a $csp
rule, we will strengthen response security policy by enhancing the content security policy, similar to the content security policy of the $csp
modifier contents. $csp
rules are applied independently from any other rule type. Only document-level exceptions can influence it (see the examples section), but no other basic rules.
Multiple rules matching a single request
In case if multiple $csp
rules match a single request, we will apply each of them.
Syntax
$csp
value syntax is similar to the Content Security Policy header syntax.
$csp
value can be empty in the case of exception rules. See examples section below.
Примеры
||example.org^$csp=frame-src 'none'
запрещает все фреймы на example.org и его поддоменах.@@||example.org/page/*$csp=frame-src 'none'
отключает все правила с модификатором$csp
, в точности соответствующимframe-src 'none'
на всех страницах, подходящих под паттерн правила. Например, правило выше.@@||example.org/page/*$csp
отключает все$csp
-правила на всех страницах, подходящих под паттерн правила.||example.org^$csp=script-src 'self' 'unsafe-eval' http: https:
отключает инлайн-скрипты на всех страницах, подходящих под паттерн правила.@@||example.org^$document
или@@||example.org^$urlblock
отключает все$csp
-правила на всех страницах, подходящих под паттерн правила.
- Некоторые символы запрещены в значении
$csp
:,
,$
. $csp
-правила поддерживают ограниченный список модификаторов:$domain
,$important
,$subdocument
.- Правила с директивами
report-*
считаются некорректными.
Rules with $csp
modifier are not supported by AdGuard Content Blocker, AdGuard for iOS and AdGuard for Safari.
$hls
$hls
rules modify the response of a matching request. They are intended as a convenient way to remove segments from HLS playlists (RFC 8216).
The word "segment" in this document means either a "Media Segment" or a "playlist" as part of a "Master Playlist": $hls
rules do not distinguish between a "Master Playlist" and a "Media Playlist".
Syntax
||example.org^$hls=urlpattern
удаляет сегменты, URL которых соответствует паттернуurlpattern
. Паттерн работает так же, как в базовых URL-правилах, однако символы/
,$
и,
в составеurlpattern
необходимо экранировать с помощью\
.||example.org^$hls=/regexp/options
удаляет сегменты, в которых URL-адрес или один из тегов (для определённых параметров, если они есть) соответствуют регулярному выражениюregexp
. Доступные значенияoptions
:t
— вместо URL-адреса сегмента проверять каждый тег сегмента на соответствие регулярному выражению. Сегмент с соответствующим тегом будет удалён;i
— сделать регулярное выражение нечувствительным к регистру символов.
The characters /
, $
and ,
must be escaped with \
inside regexp
.
Исключения
Basic URL exceptions shall not disable rules with $hls
modifier. They can be disabled as described below:
@@||example.org^$hls
отключает все правила$hls
для ответов от URL-адресов, соответствующих||example.org^ URL
.@@||example.org^$hls=text
отключает все правила$hls
, у которых значение модификатора$hls
равноtext
, для ответов с URL-адресов, соответствующих||example.org^ URL
.
$hls
rules can also be disabled by $document
, $content
and $urlblock
exception rules.
When multiple $hls
rules match the same request, their effect is cumulative.
Примеры
||example.org^$hls=\/videoplayback^?*&source=dclk_video_ads
удаляет все сегменты с соответствующим URL.||example.org^$hls=/\/videoplayback\/?\?.*\&source=dclk_video_ads/i
делает почти то же самое, но с помощью регулярного выражения вместо URL-паттерна.||example.org^$hls=/#UPLYNK-SEGMENT:.*\,ad/t
удаляет все сегменты с соответствующим тегом.
Anatomy of an HLS playlist
A quick summary of the specification:
- HLS-плейлист — это набор текстовых строк
- Можно использовать пустую строку, комментарий (начинается с
#
), тег (тоже начинается с#
, распознаётся по содержанию) или URL - Строка с URL называется сегментом
- Тег может относиться к одному сегменту, т.е. к первой строке с URL, следующей после данного тега, ко всем последующим сегментам (пока не встретится тег с тем же названием) или ко всему плейлисту
Some points specific to the operation of $hls
rules:
- Когда сегмент удаляется, все теги, относящиеся только к нему, тоже удаляются
- Теги, относящиеся к нескольким сегментам, удаляются, если все эти сегменты были удалены
- Поскольку различные типы тегов невозможно распознать по синтаксису, мы распознаем все теги, указанные в RFC, плюс некоторые нестандартные теги, которые встречались нам в полевых условиях. Любые строки, начинающиеся с
#
и не распознанные как тег, пропускаются без модификации и не сопоставляются с правилами - Tags will not be matched if they apply to the entire playlist, and
$hls
rrules cannot be used to remove them, as these rule types are intended for segment removals. Если вы знаете, что делаете, вы можете использовать правила$replace
для удаления или перезаписи только одного тега из плейлиста
An example of a transformation done by the rules:
Original response
#EXTM3U
#EXT-X-TARGETDURATION:10
#EXTINF,5
preroll.ts
#UPLYNK-SEGMENT:abc123,ad
#UPLYNK-KEY:aabb1122
#EXT-X-DISCONTINUITY
#EXTINF,10
01.ts
#EXTINF,10
02.ts
#UPLYNK-SEGMENT:abc123,segment
#UPLYNK-KEY:ccdd2233
#EXT-X-DISCONTINUITY
#EXTINF,10
01.ts
#EXTINF,10
02.ts
#EXT-X-ENDLIST
Applied rules
||example.org^$hls=preroll
||example.org^$hls=/#UPLYNK-SEGMENT:.*\,ad/t
Modified response
#EXTM3U
#EXT-X-TARGETDURATION:10
#UPLYNK-SEGMENT:abc123,segment
#UPLYNK-KEY:ccdd2233
#EXT-X-DISCONTINUITY
#EXTINF,10
01.ts
#EXTINF,10
02.ts
#EXT-X-ENDLIST
- Правила
$hls
разрешены только в доверенных фильтрах. - Правила
$hls
совместимы с модификаторами$domain
,$third-party
,$app
,$important
,$match-case
и$xmlhttprequest
. - Правила
$hls
применимы только к HLS-плейлистам, т. е. к тексту в кодировке UTF-8, начинающемуся со строки#EXTM3U
. Никакие другие ответы не будут модифицированы этими правилами. $hls
rules do not apply if the size of the original response is more than 10 MB.
Rules with the $hls
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.10 or later.
$inline-script
The $inline-script
modifier is designed to block inline JavaScript embedded into the web page, using Content Security Policy (CSP). It improves security and privacy by preventing application of inline ads or potentially malicious scripts. The rule ||example.org^$inline-script
is converting into the CSP-syntax rule:
||example.org^$csp=script-src 'self' 'unsafe-eval' http: https: data: blob: mediastream: filesystem:
$inline-font
The $inline-font
modifier is designed to block inline fonts embedded into the web page, using Content Security Policy (CSP). It improves security and privacy by preventing application of inline fonts that could be used for data collection and fingerprinting. The rule ||example.org^$inline-font
is converting into the CSP-syntax rule:
||example.org^$csp=font-src 'self' 'unsafe-eval' http: https: data: blob: mediastream: filesystem:
$jsonprune
$jsonprune
rules modify the response to a matching request by removing JSON items that match a modified JSONPath expression. They do not modify responses which are not valid JSON documents.
In AdGuard for Windows, Mac, and Android with CoreLibs v1.11 or later, $jsonprune
also supports modifying JSONP (padded JSON) documents.
Syntax
||example.org^$jsonprune=expression
удаляет из ответа элементы, соответствующие изменённому JSONPath-выражениюexpression
.
Due to the way rule parsing works, the characters $
and ,
must be escaped with \
inside expression
.
The modified JSONPath syntax has the following differences from the original:
- Выражения на сценарном языке (script expressions) не поддерживаются
- Поддерживаемые предикаты (filter expressions):
?(has <key>)
— верно, если текущий объект содержит указанный ключ?(key-eq <key> <value>)
— верно, если текущий объект содержит указанный ключ и его значение равно указанному?(key-substr <key> <value>)
— верно, если указанное значение является подстрокой значения ключа текущего объекта
- Пробелы вне двойных или одинарных кавычек игнорируются
- Можно использовать строки как с двойными, так и с одинарными кавычками
- Выражения, оканчивающиеся на
..
, не поддерживаются - Разрешено указывать несколько срезов массива (array slices) в квадратных скобках
There are various online tools that make working with JSONPath expressions more convenient:
https://www.site24x7.com/tools/jsonpath-finder-validator.html https://jsonpathfinder.com/ https://jsonpath.com/
Keep in mind, though, that all JSONPath implementations have unique features/quirks and are subtly incompatible with each other.
Исключения
Basic URL exceptions shall not disable rules with the $jsonprune
modifier. They can be disabled as described below:
@@||example.org^$jsonprune
отключает все правила$jsonprune
для ответов от URL-адресов, соответствующих||example.org^
.@@||example.org^$jsonprune=text
disables all$jsonprune
rules with the value of the$jsonprune
modifier equal totext
for responses from URLs matching||example.org^
.
$jsonprune
rules can also be disabled by $document
, $content
and $urlblock
exception rules.
When multiple $jsonprune
rules match the same request, they are sorted in lexicographical order, the first rule is applied to the original response, and each of the remaining rules is applied to the result of applying the previous one.
Примеры
||example.org^$jsonprune=\$..[one\, "two three"]
удаляет все вхождения ключей one и two three в любом месте JSON-документа.
Input
{
"one": 1,
"two": {
"two three": 23,
"four five": 45
}
}
Output
{
"two": {
"four five": 45
}
}
||example.org^$jsonprune=\$.a[?(has ad_origin)]
удаляет всех прямых потомковa
, которые обладают свойствомad_origin
.
Input
{
"a": [
{
"ad_origin": "https://example.org",
"b": 42
},
{
"b": 1234
}
]
}
Output
{
"a": [
{
"b": 1234
}
]
}
||example.org^$jsonprune=\$.*.*[?(key-eq 'Some key' 'Some value')]
удаляет все элементы на уровне вложенности 3, обладающие свойством Some key, равным Some value.
Input
{
"a": {"b": {"c": {"Some key": "Some value"}, "d": {"Some key": "Other value"}}},
"e": {"f": [{"Some key": "Some value"}, {"Some key": "Other value"}]}
}
Output
{
"a": {"b": {"d": {"Some key": "Other value"}}},
"e": {"f": [{"Some key": "Other value"}]}
}
Nested JSONPath expressions
In AdGuard for Windows, Mac and Android with CoreLibs v1.11 or later, JSONPath expressions may be used as keys in filter expressions.
||example.org^$jsonprune=\$.elems[?(has "\$.a.b.c")]
удаляет всех прямых потомковelems
, которые обладают свойством, выбираемым JSONPath-выражением$.a.b.c
.
Input
{
"elems": [
{
"a": {"b": {"c": 123}},
"k": "v"
},
{
"d": {"e": {"f": 123}},
"k1": "v1"
}
]
}
Output
{
"elems": [
{
"d": {"e": {"f": 123}},
"k1": "v1"
}
]
}
||example.org^$jsonprune=\$.elems[?(key-eq "\$.a.b.c" "abc")]
удаляет всех прямых потомковelems
, которые обладают свойством, выбираемым выражением JSONPath$.a.b.c
со значением, равным"abc"
.
Input
{
"elems": [
{
"a": {"b": {"c": 123}},
},
{
"a": {"b": {"c": "abc"}}
}
]
}
Output
{
"elems": [
{
"a": {"b": {"c": 123}}
}
]
}
$jsonprune
rules are only compatible with these modifiers:$domain
,$third-party
,$app
,$important
,$match-case
, and$xmlhttprequest
.$jsonprune
rules do not apply if the size of the original response is greater than 10 MB.
Rules with the $jsonprune
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.10 or later.
$xmlprune
$xmlprune
rules modify the response to a matching request by removing XML items that match an XPath 1.0 expression. The expression must return a node-set. $xmlprune
rules do not modify responses which are not well-formed XML documents.
Syntax
||example.org^$xmlprune=expression
removes items that match the XPath expressionexpression
from the response.
Due to the way rule parsing works, the characters $
and ,
must be escaped with \
inside expression
.
Исключения
Basic URL exceptions shall not disable rules with the $xmlprune
modifier. They can be disabled as described below:
@@||example.org^$xmlprune
disables all$xmlprune
rules for responses from URLs matching||example.org^
.@@||example.org^$xmlprune=text
disables all$xmlprune
rules with the value of the$xmlprune
modifier equal totext
for responses from URLs matching||example.org^
.
$xmlprune
rules can also be disabled by $document
, $content
and $urlblock
exception rules.
When multiple $xmlprune
rules match the same request, they are applied in lexicographical order.
Примеры
||example.org^$xmlprune=/bookstore/book[position() mod 2 = 1]
removes odd-numbered books from the bookstore.
Input
<?xml version="1.0" encoding="UTF-8"?>
<bookstore>
<book category="cooking">
<title lang="en">Everyday Italian</title>
<author>Giada De Laurentiis</author>
<year>2005</year>
<price>30.00</price>
</book>
<book category="children">
<title lang="en">Harry Potter</title>
<author>J K. Rowling</author>
<year>2005</year>
<price>29.99</price>
</book>
<book category="web">
<title lang="en">XQuery Kick Start</title>
<author>James McGovern</author>
<author>Per Bothner</author>
<author>Kurt Cagle</author>
<author>James Linn</author>
<author>Vaidyanathan Nagarajan</author>
<year>2003</year>
<price>49.99</price>
</book>
<book category="web">
<title lang="en">Learning XML</title>
<author>Erik T. Ray</author>
<year>2003</year>
<price>39.95</price>
</book>
</bookstore>
Output
<?xml version="1.0" encoding="UTF-8"?>
<bookstore>
<book category="children">
<title lang="en">Harry Potter</title>
<author>J K. Rowling</author>
<year>2005</year>
<price>29.99</price>
</book>
<book category="web">
<title lang="en">Learning XML</title>
<author>Erik T. Ray</author>
<year>2003</year>
<price>39.95</price>
</book>
</bookstore>
||example.org^$xmlprune=/bookstore/book[year = 2003]
removes books from the year 2003 from the bookstore.
Input
<?xml version="1.0" encoding="UTF-8"?>
<bookstore>
<book category="cooking">
<title lang="en">Everyday Italian</title>
<author>Giada De Laurentiis</author>
<year>2005</year>
<price>30.00</price>
</book>
<book category="children">
<title lang="en">Harry Potter</title>
<author>J K. Rowling</author>
<year>2005</year>
<price>29.99</price>
</book>
<book category="web">
<title lang="en">XQuery Kick Start</title>
<author>James McGovern</author>
<author>Per Bothner</author>
<author>Kurt Cagle</author>
<author>James Linn</author>
<author>Vaidyanathan Nagarajan</author>
<year>2003</year>
<price>49.99</price>
</book>
<book category="web">
<title lang="en">Learning XML</title>
<author>Erik T. Ray</author>
<year>2003</year>
<price>39.95</price>
</book>
</bookstore>
Output
<?xml version="1.0" encoding="UTF-8"?>
<bookstore>
<book category="cooking">
<title lang="en">Everyday Italian</title>
<author>Giada De Laurentiis</author>
<year>2005</year>
<price>30.00</price>
</book>
<book category="children">
<title lang="en">Harry Potter</title>
<author>J K. Rowling</author>
<year>2005</year>
<price>29.99</price>
</book>
</bookstore>
||example.org^$xmlprune=//*/@*
removes all attributes from all elements.
Input
<?xml version="1.0" encoding="UTF-8"?>
<bookstore location="cy">
<book category="cooking">
<title lang="en">Everyday Italian</title>
<author>Giada De Laurentiis</author>
<year>2005</year>
<price>30.00</price>
</book>
</bookstore>
Output
<?xml version="1.0" encoding="UTF-8"?>
<bookstore>
<book>
<title>Everyday Italian</title>
<author>Giada De Laurentiis</author>
<year>2005</year>
<price>30.00</price>
</book>
</bookstore>
$xmlprune
rules are only compatible with these modifiers:$domain
,$third-party
,$app
,$important
,$match-case
, and$xmlhttprequest
.$xmlprune
rules do not apply if the size of the original response is greater than 10 MB.
Rules with the $xmlprune
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.15 or later.
$network
This is basically a Firewall-like rule allowing to fully block or unblock access to a specified remote address.
- Правила
$network
соответствуют только IP-адресам! Вы не можете использовать их, чтобы блокировать или разблокировать доступ к домену. - Чтобы сопоставить адрес IPv6, вы должны использовать сжатый синтаксис, например, использовать
[2001:4860:4860::8888]$network
вместо[2001:4860:4860:0:0:0:0:8888]$network
. - An allowlist
$network
rule makes AdGuard bypass data to the matching endpoint, hence there will be no further filtering at all. - Если часть IP начинается и заканчивается символом
/
, она рассматривается как регулярное выражение.
We recommend to get acquainted with this article for better understanding of regular expressions.
The $network
modifier can only be used in rules together with the $app
and $important
modifiers, and not with any other modifiers.
Примеры
174.129.166.49:3478^$network
блокирует доступ к174.129.166.49:3478
(но не к174.129.166.49:34788
).[2001:4860:4860::8888]:443^$network
блокирует доступ к[2001:4860:4860::8888]:443
.174.129.166.49$network
блокирует доступ к174.129.166.49:*
.@@174.129.166.49$network
заставляет AdGuard направлять трафик в конечную точку. Никакие другие правила применяться не будут./.+:3[0-9]{4}/$network
блокирует доступ к диапазанону портов 30000–39999./8.8.8.(:?8|4)/$network
блокирует доступ к8.8.8.8
и к8.8.8.4
.
Only AdGuard for Windows, Mac, and Android are technically capable of using rules with $network
modifier.
$permissions
This modifier completely changes the rule behavior. If it is applied to a rule, the rule will not block the matching request. Response headers will be modified instead.
In order to use this type of rules, it is required to have a basic understanding of the Permissions Policy security layer.
For the requests matching a $permissions
rule, AdGuard strengthens response's permissions policy by adding an additional permission policy equal to the $permissions
modifier contents. $permissions
rules are applied independently from any other rule type. Only document-level exceptions can influence it (see the examples section), but no other basic rules.
Syntax
$permissions
value syntax is identical to that of the Permissions-Policy
header syntax with the following exceptions:
- A comma that separates multiple features MUST be escaped — see examples below.
- A pipe character (
|
) can be used to separate features instead of a comma.
The list of available directives is available here.
$permissions
value can be empty in the case of exception rules — see examples below.
Примеры
||example.org^$permissions=autoplay=()
запрещает автовоспроизведение медиафайлов, запрашиваемых через интерфейсHTMLMediaElement
на сайтеexample.org
.@@||example.org/page/*$permissions=autoplay=()
отключает все правила с модификатором$permissions
, в точности соответствующимautoplay=()
на всех страницах, подходящих под паттерн правила. Например, правило выше. It is important to note that the exception rule only takes effect in the case of an exact value match. For example, if you want to disable the rule$permissions=a=()\,b=()
, you need exception rule@@$permissions=a=()\,b=()
, and not@@$permissions=b=()\,a=()
, nor@@$permissions=b=()
becauseb=()\,a=()
orb=()
does not match witha=()\,b=()
.@@||example.org/page/*$permissions
отключает все$permissions
-правила на всех страницах, подходящих под паттерн правила.$domain=example.org|example.com,permissions=storage-access=()\, camera=()
запрещает использование Storage Access API для запроса доступа к неразмеченным куки, а также использование устройств видеоввода на сайтахexample.org
иexample.com
.$domain=example.org|example.com,permissions=storage-access=()|camera=()
does the same — a|
can be used to separate the features instead of an escaped comma.@@||example.org^$document
или@@||example.org^$urlblock
отключает все$permission
-правила на всех страницах, подходящих под паттерн правила.
$permissions
rules only take effect for main frame and sub frame requests. This means they are applied when a page is loaded or when an iframe is loaded.
If there are multiple $permissions
rules that match the same request, multiple Permissions-Policy
headers will be added to the response for each rule with their $permissions
value. So if you have two rules: ||example.org^$permissions=autoplay=()
and ||example.org^$permissions=geolocation=()\,camera=()
that match the same request, the response will contain two Permissions-Policy
headers: autoplay=()
and geolocation=()\,camera=()
.
$permissions
modifier limitations
Firefox ignores the Permissions-Policy
header. For more information, see this issue.
- Characters forbidden in the
$permissions
value:$
. $permissions
is compatible with a limited set of modifiers:$domain
,$important
,$subdocument
, and content-type modifiers.$permissions
rules that do not have any content-type modifiers will match only requests where content type isdocument
.
- Rules with the
$permissions
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.11 or later, and AdGuard Browser Extension with TSUrlFilter v3.0.0 or later. - Pipe separator
|
instead of escaped comma is supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.14 or later, and AdGuard Browser Extension with TSUrlFilter v3.0.0 or later.
$redirect
AdGuard is able to redirect web requests to a local "resource".
Syntax
AdGuard uses the same filtering rule syntax as uBlock Origin. Also, it is compatible with ABP $rewrite=abp-resource
modifier.
$redirect
is a modifier for the basic filtering rules so rules with this modifier support all other basic modifiers like $domain
, $third-party
, $script
, etc.
The value of the $redirect
modifier must be the name of the resource that will be used for redirection.
Отключение правил $redirect
||example.org/script.js$script,redirect=noopjs
— это правило перенаправляет все запросы кexample.org/script.js
на ресурс с именемnoopjs
.||example.org/test.mp4$media,redirect=noopmp4-1s
— это правило перенаправляет все запросы кexample.org/script.js
на ресурс с именемnoopmp4-1s
.@@||example.org^$redirect
отключит все правила$redirect
для URL-адресов, соответствующих||example.org^
.@@||example.org^$redirect=nooptext
отключит все правила с$redirect=nooptext
для любого запроса, который соответствует||example.org^
.
More information on redirects and their usage is available on GitHub.
Приоритеты правил $redirect
$redirect
rules have higher priority than regular basic blocking rules. This means that if there is a basic blocking rule, the $redirect
rule will override it. Allowlist rules with @@
mark have higher priority than $redirect
rules. If a basic rule with the $important
modifier and the $redirect
rule matches the same URL, the latter is overridden unless it's also marked as $important
.
In short: $important
> @@
> $redirect
> basic rules
.
Перейдите к приоритетам правил для более подробной информации.
- Правила с модификатором
$redirect
не поддерживаются в AdGuard Content Blocker, AdGuard для iOS и AdGuard для Safari. $redirect
в uBlock Origin поддерживает указание приоритета, например,$redirect=noopjs:42
. AdGuard не поддерживает его и вместо этого просто отбрасывает приоритетный постфикс.
$redirect-rule
This is basically an alias to $redirect
since it has the same "redirection" values and the logic is almost similar. The difference is that $redirect-rule
is applied only in the case when the target request is blocked by a different basic rule.
Перейдите к приоритетам правил для более подробной информации.
Negating $redirect-rule
works exactly the same way as for regular $redirect
rules. Even more than that, @@||example.org^$redirect
will negate both $redirect
and $redirect-rule
rules.
Примеры
||example.org/script.js
||example.org^$redirect-rule=noopjs
In this case, only requests to example.org/script.js
will be "redirected" to noopjs
. All other requests to example.org
will be kept intact.
Rules with $redirect-rule
modifier are not supported by AdGuard Content Blocker, AdGuard for iOS, and AdGuard for Safari.
$referrerpolicy
These rules allow overriding of a page's referrer policy. Responses to matching requests will have all of their Referrer-Policy
headers replaced with a single header with the value equal to the matching rule's modifier value. If the response carries an HTML document with a <meta name="referrer"...
tag, the content
attribute of the tag will also be replaced with the modifier value.
An exception rule with a modifier value disables the blocking rule with the same modifier value. An exception rule without a modifier value disables all matched referrer-policy rules.
If a request matches multiple $referrerpolicy
rules not disabled by exceptions, only one of them (it is not specified which one) is applied. $referrerpolicy
rules without specified content-type modifiers apply to $document
and $subdocument
content types.
Примеры
||example.com^$referrerpolicy=unsafe-url
переопределяет политику referrer дляexample.com
сunsafe-url
.@@||example.com^$referrerpolicy=unsafe-url
отключает предыдущее правило.@@||example.com/abcd.html^$referrerpolicy
отключает все правила$referrerpolicy
наexample.com/abcd.html
.
Rules with the $referrerpolicy
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.12 or later.
$removeheader
Rules with $removeheader
modifier are intended to remove headers from HTTP requests and responses. The initial motivation for this rule type is to be able to get rid of the Refresh
header which is often used to redirect users to an undesirable location. However, this is not the only case where this modifier can be useful.
Just like $csp
, $redirect
, $removeparam
, and $cookie
, this modifier exists independently, rules with it do not depend on the regular basic rules, i.e. regular exception or blocking rules will not affect it. By default, it only affects response headers. However, you can also change it to remove headers from HTTP requests as well.
Syntax
Basic syntax
||example.org^$removeheader=header-name
убирает заголовок ответа с названиемheader-name
||example.org^$removeheader=request:header-name
убирает заголовок запроса с названиемheader-name
$removeheader
is case-insensitive, but we suggest always using lower case.
Negating $removeheader
This type of rules works pretty much the same way it works with $csp
and $redirect
modifiers.
Use @@
to negate $removeheader
:
@@||example.org^$removeheader
отменяет все правила$removeheader
для URL-адресов, соответствующих||example.org^
.@@||example.org^$removeheader=header
отменяет все правила с$removeheader=header
для любого запроса, соответствующего||example.org^
.
$removeheader
rules can also be disabled by $document
and $urlblock
exception rules. But basic exception rules without modifiers will not do that. For example, @@||example.com^
will not disable $removeheader=p
for requests to example.com
, but @@||example.com^$urlblock
will.
In case of multiple $removeheader
rules matching a single request, we will apply each of them one by one.
Примеры
|
|example.org^$removeheader=refresh
убирает заголовокRefresh
из всех HTTP-ответов, возвращённыхexample.org
и его поддоменами.||example.org^$removeheader=request:x-client-data
убирает заголовокX-Client-Data
из всех HTTP-запросов.Данный блок правил убирает заголовки
Refresh
иLocation
из всех HTTP-ответов, возвращённыхexample.org
, кроме запросов кexample.org/path/*
, для которого заголовки не будут убраны:||example.org^$removeheader=refresh
||example.org^$removeheader=location
@@||example.org/path/$removeheader
This type of rules can be used only in trusted filters.
Чтобы избежать потенциальных проблем с безопасностью,
$removeheader
не может убрать следующие заголовки:access-control-allow-origin
access-control-allow-credentials
access-control-allow-headers
access-control-allow-methods
access-control-expose-headers
access-control-max-age
access-control-request-headers
access-control-request-method
origin
timing-allow-origin
allow
cross-origin-embedder-policy
cross-origin-opener-policy
cross-origin-resource-policy
content-security-policy
content-security-policy-report-only
expect-ct
feature-policy
origin-isolation
strict-transport-security
upgrade-insecure-requests
x-content-type-options
x-download-options
x-frame-options
x-permitted-cross-domain-policies
x-powered-by
x-xss-protection
public-key-pins
public-key-pins-report-only
sec-websocket-key
sec-websocket-extensions
sec-websocket-accept
sec-websocket-protocol
sec-websocket-version
p3p
sec-fetch-mode
sec-fetch-dest
sec-fetch-site
sec-fetch-user
referrer-policy
content-type
content-length
accept
accept-encoding
host
connection
transfer-encoding
upgrade
Правила с
$removeheader
совместимы с модификаторами$domain
,$third-party
,$app
,$important
,$match-case
, а также модификаторами типа контента, такими как$script
и$stylesheet
. Правила с другими модификаторами считаются некорректными и не будут применены.
Rules with $removeheader
modifier are supported by AdGuard for Windows, Mac, and Android, and AdGuard Browser Extension for Chrome, Firefox, and Edge.
$removeparam
$queryprune
is an alias of $removeparam
. Since $queryprune
is deprecated, avoid using it and use $removeparam
instead.
Rules with $removeparam
modifier are intended to strip query parameters from requests' URLs. Please note that such rules are only applied to GET
, HEAD
, OPTIONS
, and sometimes POST
requests.
$removeparam
rules that do not have any content type modifiers will match only requests where content type is document
.
Syntax
Basic syntax
$removeparam=param
убирает параметр запроса с именемparam
из URL любого запроса. Например, запрос кhttp://example.com/page?param=1&&another=2
будет преобразован вhttp://example.com/page?another=2
.
Rules with $removeparam
modifier are supported by AdGuard for Windows, Mac and, Android with CoreLibs v1.7 or later and AdGuard Browser Extension v3.6 or later.
Regular expressions
You can also use regular expressions to match query parameters and/or their values:
$removeparam=/regexp/[options]
убирает из URL-адреса любого запроса все параметры, соответствующие заданному регулярному выражениюregexp
. В отличие от базового синтаксиса, это означает «убрать параметры запроса, нормализованные к строкеname=value
, которая соответствуетрегулярному выражению
».[options]
— это список опций регулярного выражения. На данный момент единственная поддерживаемая опция — этоi
, делающая соответствие нечувствительным к регистру.
Escaping special characters
Do not forget to escape special characters like ,
, /
and $
in the regular expressions. Use \
character for that purpose. For example, an escaped comma should look like this: \,
.
Regexp-type rules target both name and value of the parameter. To minimize mistakes, it is safer to start every regexp with /^
unless you specifically target parameter values.
We will try to detect and ignore unescaped $
automatically using a simple rule of thumb — it is not an options delimiter if all three are true:
- Есть сочетание
$/
- Слева от символа есть ещё один слеш
/
- Слева от этого слеша есть ещё один неэкранированный символ
$
Remove all query parameters
Specify naked $removeparam
to remove all query parameters:
||example.org^$removeparam
удаляет все параметры запроса из URL-адресов, соответствующих правилу||example.org^
.
Inversion
Use ~
to apply inversion:
$removeparam=~param
удаляет все параметры запроса, кромеparam
.$removeparam=~/regexp/
удаляет все параметры запроса, которые не совпадают с заданным регулярным выражениемregexp
.
Negating $removeparam
This sort of rules work pretty much the same way it works with $csp
and $redirect
modifiers.
Use @@
to negate $removeparam
:
@@||example.org^$removeparam
не даёт применять правила с$removeparam
для URL, соответствующихexample.org
.@@||example.org^$removeparam=param
не даёт применять правила с$removeparam=param
для запросов кexample.org
.@@||example.org^$removeparam=/regexp/
не даёт применять правила с$removeparam=/regexp/
для запросов кexample.org
.
Multiple rules matching a single request
In the case when multiple $removeparam
rules match a single request, each of them will be applied one by one.
Примеры
$removeparam=/^(utm_source|utm_medium|utm_term)=/
$removeparam=/^(utm_content|utm_campaign|utm_referrer)=/
@@||example.com^$removeparam
With these rules some UTM parameters will be stripped out from any request, except that requests to example.com
will not be stripped at all, e.g. http://google.com/page?utm_source=s&utm_referrer=fb.com&utm_content=img
will be transformed to http://google.com/page
, but http://example.com/page?utm_source=s&utm_referrer=fb.com&utm_content=img
will not be affected by the blocking rule.
$removeparam=utm_source
удаляет параметрutm_source
из всех запросов.$removeparam=/utm_.*/
удаляет все параметрыutm_*
из URL любого запроса. Например, запросhttp://example.com/page?utm_source=test
будет трансформирован вhttp://example.com/page
.$removeparam=/^utm_source=campaign$/
удаляет параметрutm_source
со значениемcampaign
. Не затрагивает другие параметрыutm_source
.
Negating one $removeparam
rule and replacing it with a different rule
$removeparam=/^(gclid|yclid|fbclid)=/
@@||example.com^$removeparam=/^(gclid|yclid|fbclid)=/
||example.com^$removeparam=/^(yclid|fbclid)=/
With these rules, Google, Yandex, and Facebook Click IDs will be removed from all requests. There is one exception: Google Click ID (gclid) will not be removed from requests to example.com.
Negating $removeparam
for all parameters
$removeparam=/^(utm_source|utm_medium|utm_term)=/
$removeparam=/^(utm_content|utm_campaign|utm_referrer)=/
@@||example.com^$removeparam
With these rules, specified UTM parameters will be removed from any request save for requests to example.org
.
$removeparam
rules can also be disabled by $document
and $urlblock
exception rules. But basic exception rules without modifiers do not do that. For example, @@||example.com^
will not disable $removeparam=p
for requests to example.com, but @@||example.com^$urlblock
will.
- Правила с модификатором
$removeparam
могут быть использованы только в доверенных фильтрах. - Правила с
$removeparam
совместимы с базовыми модификаторами, модификаторами типа контента, а также с модификаторами$important
и$app
. Правила с любыми другими модификаторами считаются некорректными и не будут применены.
- Правила с модификатором
$removeparam
поддерживаются в AdGuard для Windows, Mac и Android и Браузерном расширении AdGuard для Chrome, Firefox и Edge. $removeparam
syntax for regular expressions is supported by AdGuard Browser Extension v4.0 and AdGuard for Windows, Mac, and Android with CoreLibs v1.8 or later.POST
request types are supported only by AdGuard for Windows, Mac, and Android with CoreLibs v1.10 or later, and AdGuard Browser Extension with TSWebExtension v0.4.6 or later.
$replace
This modifier completely changes the rule behavior. If it is applied, the rule will not block the request. The response is going to be modified instead.
You will need some knowledge of regular expressions to use $replace
modifier.
Features
- Правила с
$replace
применяются к любому текстовому ответу, но не применяются к binary (media
,image
,object
и т. д.). $replace
rules do not apply if the size of the original response is more than 10 MB.- Правила с
$replace
обладают более высоким приоритетом, чем другие базовые правила (включая правила исключений). Если запрос соответствует двум различным правилам, одно из которых имеет модификатор$replace
, применится именно это правило. - Правила исключений уровня document с модификаторами
$content
или$document
отменяют срабатывание правил$replace
, даже если запрос им соответствует. - Прочие правила исключений уровня document (с модификаторами
$generichide
,$elemhide
или$jsinject
) применяются вместе с правилами$replace
. Это означает, что вы можете изменять содержимое страницы при помощи правила$replace
и одновременно отменять косметические правила.
$replace
value can be empty in the case of exception rules. See examples section for further information.
Multiple rules matching a single request
In case if multiple $replace
rules match a single request, we will apply each of them. The order is defined alphabetically.
Syntax
In general, $replace
syntax is similar to replacement with regular expressions in Perl.
replace = "/" regexp "/" replacement "/" modifiers
regexp
— регулярное выражение.replacement
— строка, которая будет использована для замены строки в соответствии сregexp
.modifiers
— флаги регулярных выражений. Например,i
— поиск без учёта регистра, илиs
— режим одной строки.
In the $replace
value, two characters must be escaped: comma ,
and dollar sign $
. Use backslash \
for it. For example, an escaped comma looks like this: \,
.
Примеры
||example.org^$replace=/(<VAST[\s\S]*?>)[\s\S]*<\/VAST>/\$1<\/VAST>/i
There are three parts in this rule:
regexp
(регулярное выражение) —(<VAST(.|\s)*?>)(.|\s)*<\/VAST>
replacement
(замена) —\$1<\/VAST>
где$
экранируетсяmodifiers
(флаги регулярных выражений) —i
для поиска без учёта регистра
You can see how this rule works here: http://regexr.com/3cesk
Multiple $replace
rules
||example.org^$replace=/X/Y/
||example.org^$replace=/Z/Y/
@@||example.org/page/*$replace=/Z/Y/
- Правила 1 и 2 будут применены ко всем запросам, отправленным к
example.org
. - Правило 2 отключено для запросов, соответствующих
||example.org/page/
, но правило 1 при этом всё равно работает!
Disabling $replace
rules
@@||example.org^$replace
отключит все правила с$replace
, где есть||example.org^
.@@||example.org^$document
или@@||example.org^$content
отключит все правила с$replace
, исходящие со страниц доменаexample.org
, включая саму эту страницу.
Rules with $replace
modifier can be used only in trusted filters.
Rules with $replace
modifier are supported by AdGuard for Windows, Mac, and Android and AdGuard Browser Extension for Firefox. Such rules do not work in extensions for other browsers because they are unable to modify content on the network level.
urltransform
The $urltransform
rules allow you to modify the request URL by replacing the text matched by the regular expression.
Features
$urltransform
rules apply to any request URL text.$urltransform
rules can also modify the query part of the URL.$urltransform
will not be applied if the original URL is blocked by other rules.$urltransform
will be applied before$removeparam
rules.
The $urltransform
value can be empty for exception rules.
Multiple rules matching a single request
If multiple $urltransform
rules match a single request, we will apply each of them. The order is defined alphabetically.
Syntax
$urltransform
syntax is similar to replacement with regular expressions in Perl.
urltransform = "/" regexp "/" replacement "/" modifiers
regexp
— регулярное выражение.replacement
— строка, которая будет использована для замены строки в соответствии сregexp
.modifiers
— флаги регулярных выражений. Например,i
— поиск без учёта регистра, илиs
— режим одной строки.
In the $urltransform
value, two characters must be escaped: the comma ,
and the dollar sign $
. Use the backslash character \
for this. For example, an escaped comma looks like this: \,
.
Примеры
||example.org^$urltransform=/(pref\/).*\/(suf)/\$1\$2/i
There are three parts in this rule:
regexp
—(pref\/).*\/(suf)
;replacement
—\$1\$2
where$
is escaped;modifiers
(флаги регулярных выражений) —i
для поиска без учёта регистра
Multiple $urltransform
rules
||example.org^$urltransform=/X/Y/
||example.org^$urltransform=/Z/Y/
@@||example.org/page/*$urltransform=/Z/Y/
- Правила 1 и 2 будут применены ко всем запросам, отправленным к
example.org
. - Правило 2 отключено для запросов, соответствующих
||example.org/page/
, но правило 1 при этом всё равно работает!
Re-matching rules after transforming the URL
If the $urltransform
rule is applied to a request, all the rules will be re-evaluated against the new URL.
E.g., with the following rules:
||example.com^$urltransform=/firstpath/secondpath/
||example.com/secondpath^
the request to https://example.com/firstpath
will be blocked before it is sent.
However, $urltransform
rules will not be re-applied in this case to avoid infinite recursion, e.g., with the following rules:
||example.com/firstpath^$urltransform=/firstpath/secondpath/
||example.com/secondpath^$urltransform=/secondpath/firstpath/
the request to https://example.com/fisrtpath
will be transformed to https://example.com/secondpath
and the second rule will not be applied.
Disabling $urltransform
rules
@@||example.org^$urltransform
will disable all$urltransform
rules matching||example.org^
.@@||example.org^$urltransform=/Z/Y/
will disable the rule with$urltransform=/Z/Y/
for any request matching||example.org^
.
$urltransform
rules can also be disabled by $document
and $urlblock
exception rules. But basic exception rules without modifiers do not do that. For example, @@||example.com^
will not disable $urltransform=/X/Y/
for requests to example.com, but @@||example.com^$urlblock
will.
Rules with the $urltransform
modifier can be used only in trusted filters.
Rules with the $urltransform
modifier are supported by AdGuard for Windows, AdGuard for Mac, and AdGuard for Android with CoreLibs v1.15 or later.
noop
noop
modifier does nothing and can be used solely to increase rules' readability. It consists of a sequence of underscore characters (_
) of any length and can appear in a rule as many times as needed.
Примеры
||example.com$_,removeparam=/^ss\\$/,_,image
||example.com$replace=/bad/good/,___,~third-party
Rules with noop
modifier are not supported by AdGuard Content Blocker.
$empty
(устаревший)
This modifier is deprecated in favor of the $redirect
modifier. Rules with $empty
are still supported and being converted into $redirect=nooptext
now but the support shall be removed in the future.
Usually, blocked requests look like a server error to browser. If you use $empty
modifier, AdGuard will emulate a blank response from the server with200 OK
status.
Примеры
||example.org^$empty
возвращает пустой ответ для всех запросов к доменуexample.org
и всех его поддоменов.
Rules with $empty
modifier are not supported by AdGuard Content Blocker, AdGuard for iOS, and AdGuard for Safari.
$mp4
(устаревший)
This modifier is deprecated in favor of the $redirect
modifier. Rules with $mp4
are still supported and being converted into $redirect=noopmp4-1s,media
now but the support shall be removed in the future.
As a response to blocked request AdGuard returns a short video placeholder.
Примеры
||example.com/videos/$mp4
блокирует загрузку видео с адресов||example.com/videos/*
и заменяет ответ на видео-заглушку.
Rules with $mp4
modifier are not supported by AdGuard Content Blocker, AdGuard for iOS, and AdGuard for Safari.
Приоритеты правил
Each rule has its own priority, which is necessary when several rules match the request and the filtering engine needs to select one of them. Priority is measured by a positive integer.
When two rules with the same priority match the same request, it depends on the filtering engine implementation which one will be selected.
The concept of rule priorities becomes increasingly important in light of Manifest V3 as the existing rules need to be converted to declarativeNetRequest rules.
Priority calculation
To calculate priority, we've categorized modifiers into different groups. These groups are ranked based on their priority, from lowest to highest. A modifier that significantly narrows the scope of a rule adds more weight to its total priority. Conversely, if a rule applies to a broader range of requests, its priority decreases.
It's worth noting that there are cases where a single-parameter modifier has a higher priority than multi-parameter ones. For instance, in the case of $domain=example.com|example.org
, a rule that includes two domains has a slightly broader effective area than a rule with one specified domain, therefore its priority is lower.
The base priority of any rule is 1. If the calculated priority is a floating-point number, it will be rounded up to the smallest integer greater than or equal to the calculated priority.
- The concept of priority has been introduced in TSUrlFilter v2.1.0 and CoreLibs v1.13. До этого в AdGuard не было специального алгоритма вычисления приоритетов, и обработка конфликтов могла отличаться в зависимости от продукта и версии AdGuard.
- AdGuard для iOS, Safari и AdGuard Content Blocker зависят от реализации браузера и не могут следовать указанным здесь правилам.
Modifier aliases (1p
, 3p
, etc.) are not included in these categories, however, they are utilized within the engine to compute the rule priority.
Базовые модификаторы, наличие каждого добавляет 1 к приоритету
$app
с приложениями, исключаемыми с помощью~
$denyallow
$domain
с доменами, исключаемыми с помощью~
$match-case
$method
с методами, исключаемыми с помощью~
$third-party
$to
- ограниченные модификаторы сontent-type с
~
When dealing with a negated domain, app, method, or content-type, we add 1 point for the existence of the modifier itself, regardless of the quantity of negated domains or content-types. This is because the rule's scope is already infinitely broad. Put simply, by prohibiting multiple domains, content-types, methods or apps, the scope of the rule becomes only minimally smaller.
Defined content-type modifiers, defined methods, defined headers, $all, $popup, specific exceptions
All allowed content types:
This also includes rules that implicitly add all content types:
$all
;
Or rules that implicitly add the modifier $document
:
Or some specific exceptions that implicitly add $document,subdocument
:
Or allowed methods via $method
.
Or rules with $header
.
The presence of any content-type modifiers adds (50 + 50 / N)
, where N
is the number of modifiers present, for example: ||example.com^$image,script
will add 50 + 50 / 2 = 50 + 25 = 75
to the total weight of the rule.
The $all
also belongs to this category, because it implicitly adds all content type modifiers, e.g., $document,subdocument,image,script,media,<etc>
+ $popup
.
The $popup
also belongs to this category, because it implicitly adds the modifier $document
. Similarly, specific exceptions add $document,subdocument
.
If there is a $method
modifier in the rule with allowed methods it adds (50 + 50 / N)
, where N
is the number of methods allowed, for example: ||example.com^$method=GET|POST|PUT
will add 50 + 50 / 3 = 50 + 16.6 = 67
to the total weight of the rule.
If there is a $header
modifier in the rule it adds 50
.
$domain
или $app
с разрешёнными доменами или приложениями
Specified domains through $domain
or specified applications through $app
add 100 + 100 / N
, where N
is the number of modifier values for example: ||example.com^$domain=example.com|example.org|example.net
will add 100 + 100 / 3 = 134.3 = 135
or ||example.com^$app=org.example.app1|org.example.app2
will add 100 + 100 / 2 = 151
or ||example.com^$domain=example.com,app=org.example.app1|org.example.app2
will add 100 + 100/1
($domain part) and 100 + 100/2
($app part), totaling 350
.
Modifier values that are regexps or tld will be interpreted as normal entries of the form example.com
and counted one by one, for example: ||example.com^$domain=example.*
will add 100 + 100 / 1 = 200
or ||example.com^$domain=example.*|adguard.*
will add 100 + 100 / 2 = 150
.
Правила $redirect
Each of which adds 10^3
to rule priority.
Особые исключения
Each of which adds 10^4
to the priority.
As well as exception with $document modifier
: because it's an alias for $elemhide,content,jsinject,urlblock,extension
. It will add 10^4
for each modifier from the top list, 10^4 * 5
in total.
In addition, each of these exceptions implicitly adds the two allowed content-type modifiers $document,subdocument
.
Правила белого списка
Modifier @@
adds 10^5
to rule priority.
Правила $important
Modifier $important
adds 10^6
to rule priority.
Правила, для которых нет веса приоритета
Other modifiers, which are supposed to perform additional post- or pre-processing of requests, do not add anything to the rules priority.
Примеры
||example.com^
Вес правила без модификаторов:
1
.||example.com^$match-case
Rule weight: base weight + weight of the modifier from category 1:
1 + 1 = 2
.||example.org^$removeparam=p
Rule weight: base weight + 0, since $removeparam is not involved in the priority calculation:
1 + 0 = 1
.||example.org^$document,redirect=nooptext
Rule weight: base weight + allowed content type, category 3 + $redirect from category 6:
1 + (100 + 100 / 1) + 1000 = 1201
.@@||example.org^$removeparam=p,document
Rule weight: base weight + allowlist rule, category 5 + 0 because $removeparam is not involved in the priority calculation + allowed content type, category 2:
1 + 10000 + 0 + (50 + 50 / 1) = 10101
.@@||example.com/ad/*$domain=example.org|example.net,important
Rule weight: base weight + allowlist rule, category 5 + important rule, category 7 + allowed domains, category 3:
1 + 10000 + 1000000 + (100 + 100 / 2) = 1010152
.@@||example.org^$document
без дополнительных модификаторов — это псевдоним для@@|||example.com^$elemhide,content,jsinject,urlblock,extension
Rule weight: base weight + specific exceptions, category 4 + two allowed content types (document and subdocument), category 2:
1 + 10000 * 4 + (50 + 50 / 2) = 40076
.*$script,domain=a.com,denyallow=x.com|y.com
Rule weight: base weight + allowed content type, category 2 + allowed domain, category 3 + denyallow, category 1:
1 + (50 + 50/1) + (100 + 100 / 1) + 1 = 303
.||example.com^$all
— alias to||example.com^$document,subdocument,image,script,media,etc. + $popup
Rule weight: base weight + popup (category 1) + allowed content types (category 2):
1 + 1 + (50 + 50/12) = 55
.
Другие правила
However, basic rules may not be enough to block ads. Sometimes you need to hide an element or change part of the HTML code of a web page without breaking anything. The rules described in this section are created specifically for this purpose.
Категории \ Продукты | Приложения CoreLibs | AdGuard для Chromium | AdGuard для Firefox | AdGuard для iOS | AdGuard для Safari | AdGuard Content Blocker |
---|---|---|---|---|---|---|
Скрытие элементов | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
CSS-правила | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
Расширенный CSS | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
Фильтрация HTML | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
JavaScript | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
Скриптлеты | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
- ✅ — полностью поддерживается
- ❌ — не поддерживается
Косметические правила
Work with non-basic rules requires the basic knowledge of HTML and CSS. So, if you want to learn how to make such rules, we recommend to get acquainted with this documentation.
Правила скрытия элементов
Element hiding rules are used to hide the elements of web pages. It is similar to applying { display: none; }
style to selected element.
Element hiding rules may operate differently depending on the platform.
Syntax
rule = [domains] "##" selector
domains = [domain0, domain1[, ...[, domainN]]]
selector
— CSS-селектор, задающий элементы, которые должны быть скрыты.domains
— ограничение на домены, на страницах которых будет применено правило.
If you want to limit the rule application area to certain domains, just enter them separated with commas. For example: example.org,example.com##selector
.
This rule will be also applied to all subdomains of example.org
and example.com
.
Если вы хотите, чтобы правило не применялось к определённым доменам, начните доменное имя со знака ~
. For example: ~example.org##selector
.
You can use both approaches in a single rule. For example, example.org,~subdomain.example.org##domain
will work for example.org
and all subdomains, except subdomain.example.org
.
Element hiding rules are not dependent on each other. If there is a rule example.org##selector
in the filter and you add ~example.org##selector
both rules will be applied independently.
Примеры
example.com##div.textad
— hides adiv
with the classtextad
atexample.com
and all subdomains.example.com,example.org###adblock
скроет элемент с атрибутомid
равнымadblock
на доменахexample.com
,example.org
и всех их поддоменах.~example.com##.textad
— hides an element with the classtextad
at all domains, exceptexample.com
and its subdomains.
Ограничения
Safari does not support both permitted and restricted domains. So the rules like example.org,~foo.example.org##.textad
are invalid in AdGuard for Safari.
Исключения
Exceptions can disable some rules on particular domains. They are very similar to usual exception rules, but instead of ##
you have to use #@#
.
For example, there is a rule in filter:
##.textad
If you want to disable it for example.com
, you can create an exception rule:
example.com#@#.textad
Sometimes, it may be necessary to disable all restriction rules. For example, to conduct tests. To do this, use the exclusion rule without specifying a domain. It will completely disable matching CSS elemhide rule on ALL domains:
#@#.textad
The same can be achieved by adding this rule:
*#@#.textad
We recommend to use this kind of exceptions only if it is not possible to change the hiding rule itself. In other cases it is better to change the original rule, using domain restrictions.
CSS-правила
Sometimes, simple hiding of an element is not enough to deal with advertising. For example, blocking an advertising element can just break the page layout. In this case AdGuard can use rules that are much more flexible than hiding rules. With these rules you can basically add any CSS styles to the page.
Syntax
rule = [domains] "#$#" selector "{" style "}"
domains = [domain0, domain1[, ...[, domainN]]]
selector
— CSS-селектор, определяющий элементы, к которым мы хотим применить стиль.domains
— ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.style
— CSS-стиль, который мы хотим применить к выбранным элементам.
Примеры
example.com#$#body { background-color: #333!important; }
This rule will apply a style background-color: #333!important;
to the body
element at example.com
and all subdomains.
Исключения
Just like with element hiding, there is a type of rules that disable the selected CSS style rule for particular domains. Exception rule syntax is almost the same, you just have to change #$#
to #@$#
.
For example, there is a rule in filter:
#$#.textad { visibility: hidden; }
If you want to disable it for example.com
, you can create an exception rule:
example.com#@$#.textad { visibility: hidden; }
We recommend to use this kind of exceptions only if it is not possible to change the CSS rule itself. In other cases it is better to change the original rule, using domain restrictions.
Styles that lead to loading any resource are forbidden. Basically, it means that you cannot use any <url>
type of value in the style.
CSS rules are not supported by AdGuard Content Blocker.
CSS rules may operate differently depending on the platform.
Расширенные CSS-селекторы
- Ограничения
- Псевдокласс
:has()
- Псевдокласс
:contains()
- Псевдокласс
:matches-css()
- Псевдокласс
:matches-attr()
- Псевдокласс
:matches-property()
- Псевдокласс
:xpath()
- Псевдокласс
:nth-ancestor()
- Псевдокласс
:upward()
- Псевдокласс
:remove()
и псевдосвойствоremove
- Псевдокласс
:is()
- Псевдокласс
:not()
- Псевдокласс
:if-not()
(удалён)
CSS 3.0 is not always enough to block ads. To solve this problem AdGuard extends CSS capabilities by adding support for the new pseudo-elements. We have developed a separate open-source library for non-standard element selecting and applying CSS styles with extended properties.
The idea of extended capabilities is an opportunity to match DOM elements with selectors based on their own representation (style, text content, etc.) or relations with other elements. There is also an opportunity to apply styles with non-standard CSS properties.
Application area
Extended selectors can be used in any cosmetic rule, whether they are element hiding rules or CSS rules.
Rules with extended CSS selectors are not supported by AdGuard Content Blocker.
Syntax
Regardless of the CSS pseudo-classes you are using in the rule, you can use special markers to force applying these rules by ExtendedCss. It is recommended to use these markers for all extended CSS cosmetic rules so that it was easier to find them.
The syntax for extended CSS rules:
#?#
— для скрытия элементов,#@?#
— для исключений#$?#
— для CSS-стилей,#@$?#
— для исключений
We strongly recommend using these markers any time when you use an extended CSS selector.
Примеры
example.org#?#div:has(> a[target="_blank"][rel="nofollow"])
— это правило блокирует все элементыdiv
, которые содержат дочерний элемент со ссылкой с атрибутами[target="_blank"][rel="nofollow"]
. При этом правило будет работать только для доменаexample.org
и всех его поддоменов.example.com#$?#h3:contains(cookies) { display: none!important; }
— это правило устанавливает стильdisplay: none!important
для всех элементовh3
, которые содержат словоcookies
. При этом правило будет работать только для доменаexample.com
и всех его поддоменов.example.net#?#.banner:matches-css(width: 360px)
— это правило блокирует все элементы.banner
, которые содержат стильwidth: 360px
. При этом правило будет работать только для доменаexample.net
и всех его поддоменов.example.net#@?#.banner:matches-css(width: 360px)
— это правило отменяет действие предыдущего правила.
You can apply standard CSS selectors using the ExtendedCss library by using the rule marker #?#
, e.g. #?#div.banner
.
Learn more about how to debug extended selectors.
Some pseudo-classes do not require selector before it. Still adding the universal selector *
makes an extended selector easier to read, even though it has no effect on the matching behavior. So selector #block :has(> .inner)
works exactly like #block *:has(> .inner)
but second one is more obvious.
Pseudo-class names are case-insensitive, e.g. :HAS()
works as :has()
. Still the lower-case names are used commonly.
Ограничения ExtendedCss
CSS-комментарии и at-rules не поддерживаются.
У конкретного псевдокласса могут быть свои ограничения:
:has()
,:xpath()
,:nth-ancestor()
,:upward()
,:is()
,:not()
, and:remove()
.
Псевдокласс :has()
Draft CSS 4.0 specification describes the :has()
pseudo-class. Unfortunately, it is not yet supported by all popular browsers.
Rules with the :has()
pseudo-class must use the native implementation of :has()
if they use ##
marker and if it is possible, i.e. with no other extended selectors inside. To force applying of ExtendedCss rules with :has()
, use #?#
/#$?#
marker explicitly.
Compatibility with other pseudo-classes
Synonyms :-abp-has()
is supported by ExtendedCss for better compatibility.
:if()
is no longer supported as a synonym for :has()
.
Syntax
[target]:has(selector)
target
— optional, standard or extended CSS selector, can be skipped for checking any elementselector
— необходимый, стандартный или расширенный CSS-селектор
The pseudo-class :has()
selects the target
elements that fit to the selector
. Also the selector
can start with a combinator.
A selector list can be set in selector
as well. In this case all selectors in the list are being matched for now. In the future it will be fixed for <forgiving-relative-selector-list>
as argument.
Ограничения :has()
Usage of the :has()
pseudo-class is restricted for some cases (2, 3):
- запретить
:has()
внутри псевдоселекторов, принимающих только составные селекторы; - запретить
:has()
после обычных псевдоэлементов.
Native :has()
pseudo-class does not allow :has()
, :is()
, :where()
inside :has()
argument to avoid increasing the :has()
invalidation complexity (case 1). But ExtendedCss did not have such limitation earlier and filter lists already contain such rules, so we have not added this limitation to ExtendedCss and allow to use :has()
inside :has()
as it was possible before. To use it, just force ExtendedCss usage by setting #?#
/#$?#
rule marker.
Native implementation does not allow any usage of :scope
inside the :has()
argument ([1], [2]). Still, there are some such rules in filter lists: div:has(:scope a)
which we continue to support by simply converting them to div:has(> a)
, as it used to be done previously.
Примеры
div:has(.banner)
selects all div
elements which include an element with the banner
class:
<!-- HTML code -->
<div>Not selected</div>
<div>Selected
<span class="banner">inner element</span>
</div>
div:has(> .banner)
selects all div
elements which include an banner
class element as a direct child of div
:
<!-- HTML code -->
<div>Not selected</div>
<div>Selected
<p class="banner">child element</p>
</div>
div:has(+ .banner)
selects all div
elements preceding banner
class element which immediately follows the div
and both are children of the same parent:
<!-- HTML code -->
<div>Not selected</div>
<div>Selected</div>
<p class="banner">adjacent sibling</p>
<span>Not selected</span>
div:has(~ .banner)
selects all div
elements preceding banner
class element which follows the div
but not necessarily immediately and both are children of the same parent:
<!-- HTML code -->
<div>Not selected</div>
<div>Selected</div>
<span>Not selected</span>
<p class="banner">general sibling</p>
div:has(span, .banner)
selects all div
elements which include both span
element and banner
class element:
<!-- HTML code -->
<div>Not selected</div>
<div>Selected
<span>child span</span>
<p class="banner">child .banner</p>
</div>
Backward compatible syntax for :has()
is supported but not recommended.
Псевдокласс :contains()
The :contains()
pseudo-class principle is very simple: it allows to select the elements that contain specified text or which content matches a specified regular expression. Regexp flags are supported.
The :contains()
pseudo-class uses the textContent
element property for matching, not the innerHTML
.
Compatibility with other pseudo-classes
Synonyms :-abp-contains()
and :has-text()
are supported for better compatibility.
Syntax
[target]:contains(match)
target
— optional, standard or extended CSS selector, can be skipped for checking any elementmatch
— требуется, строка или регулярное выражение для соответствия элементуtextContent
. Также поддерживаются флаги регулярных выражений.
Примеры
For such DOM:
<!-- HTML code -->
<div>Not selected</div>
<div id="match">Selected as IT contains "banner"</div>
<div>Not selected <div class="banner"></div></div>
the element div#match
can be selected by any of these extended selectors:
! plain text
div:contains(banner)
! регулярное выражение
div:contains(/as .* banner/)
! регулярное выражение с флагами
div:contains(/it .* banner/gi)
Only the div
with id=match
is selected because the next element does not contain any text, and banner
is a part of code, not a text.
Backward compatible syntax for :contains()
is supported but not recommended.
Псевдокласс :matches-css()
The :matches-css()
pseudo-class allows to match the element by its current style properties. The work of the pseudo-class is based on using the Window.getComputedStyle()
method.
Syntax
[target]:matches-css([pseudo-element, ] property: pattern)
target
— optional, standard or extended CSS selector, can be skipped for checking any elementpseudo-element
— необязательный, допустимый стандартный псевдоэлемент, например,before
,after
,first-line
и т. д.property
— требуется, название CSS-свойства, которое будет проверено у элементаpattern
— required, a value pattern that is using the same simple wildcard matching as in the basic url filtering rules OR a regular expression. Для этого типа соответствия AdGuard не обращает внимание на регистр. В случае с регулярными выражениями шаблон будет выглядеть так:/regexp/
.
Special characters escaping and unescaping
For non-regexp patterns (
,)
,[
,]
must be unescaped, e.g. :matches-css(background-image:url(data:*))
.
For regexp patterns \
should be escaped, e.g. :matches-css(background-image: /^url\\("data:image\\/gif;base64.+/)
.
Примеры
For such DOM:
<!-- HTML code -->
<style type="text/css">
#matched::before {
content: "Block me"
}
</style>
<div id="matched"></div>
<div id="not-matched"></div>
the div
elements with pseudo-element ::before
and with specified content
property can be selected by any of these extended selectors:
! паттерн строки
div:matches-css(before, content: block me)
! паттерн строки с подстановочным знаком
div:matches-css(before, content: block*)
! паттерн регулярного выражения
div:matches-css(before, content: /block me/)
Regexp patterns do not support flags.
Obsolete pseudo-classes :matches-css-before()
and :matches-css-after()
are no longer recommended but still are supported for better compatibility.
Backward compatible syntax for :matches-css()
is supported but not recommended.
Псевдокласс :matches-attr()
The :matches-attr()
pseudo-class allows selecting an element by its attributes, especially if they are randomized.
Syntax
[target]:matches-attr("name"[="value"])
target
— optional, standard or extended CSS selector, can be skipped for checking any elementname
— требуется, простая строка, или строка с подстановочным знаком, или регулярное выражение для сопоставления имени атрибутаvalue
— необязательный, простая строка, или строка с подстановочным знаком, или регулярное выражение для сопоставления значения атрибута
Escaping special characters
For regexp patterns "
and \
should be escaped, e.g. div:matches-attr(class=/[\\w]{5}/)
.
Примеры
div:matches-attr("ad-link")
selects the element div#target1
:
<!-- HTML code -->
<div id="target1" ad-link="1random23-banner_240x400"></div>
div:matches-attr("data-*"="adBanner")
selects the element div#target2
:
<!-- HTML code -->
<div id="target2" data-1random23="adBanner"></div>
div:matches-attr(*unit*=/^click$/)
selects the element div#target3
:
<!-- HTML code -->
<div id="target3" random123-unit094="click"></div>
*:matches-attr("/.{5,}delay$/"="/^[0-9]*$/")
selects the element #target4
:
<!-- HTML code -->
<div>
<inner-random23 id="target4" nt4f5be90delay="1000"></inner-random23>
</div>
Regexp patterns do not support flags.
Псевдокласс :matches-property()
The :matches-property()
pseudo-class allows selecting an element by matching its properties.
Syntax
[target]:matches-property("name"[="value"])
target
— optional, standard or extended CSS selector, can be skipped for checking any elementname
— требуется, простая строка, или строка с подстановочным знаком, или регулярное выражение для сопоставления имени свойства элементаvalue
— необязательный, простая строка, или строка с подстановочным знаком, или регулярное выражение для сопоставления значения свойства элемента
Escaping special characters
For regexp patterns "
and \
must be escaped, e.g. div:matches-property(prop=/[\\w]{4}/)
.
Regexp patterns are supported in name
for any property in chain, e.g. prop./^unit[\\d]{4}$/.type
.
Примеры
An element with such properties:
divProperties = {
id: 1,
check: {
track: true,
unit_2random1: true,
},
memoizedProps: {
key: null,
tag: 12,
_owner: {
effectTag: 1,
src: 'ad.com',
},
},
};
can be selected by any of these extended selectors:
div:matches-property(check.track)
div:matches-property("check./^unit_.{4,8}$/")
div:matches-property("check.unit_*"=true)
div:matches-property(memoizedProps.key="null")
div:matches-property(memoizedProps._owner.src=/ad/)
To check properties of a specific element, do the following:
- Проверьте элемент страницы или выберите его в Инструментах разработчика браузера во вкладке
Элементы
- Запустите
console.dir($0)
во вкладкеКонсоль
Regexp patterns do not support flags.
Псевдокласс :xpath()
The :xpath()
pseudo-class allows selecting an element by evaluating an XPath expression.
Syntax
[target]:xpath(expression)
target
— необязательный, стандартный или расширенный CSS-селекторexpression
— требуется, допустимое XPath выражение
Ограничения :xpath()
target
can be omitted so it is optional. For any other pseudo-class that would mean "apply to all DOM nodes", but in case of :xpath()
it just means "apply to the whole document", and such applying slows elements selecting significantly. That's why rules like #?#:xpath(expression)
are limited to looking inside the body
tag. For example, rule #?#:xpath(//div[@data-st-area=\'Advert\'])
is parsed as #?#body:xpath(//div[@data-st-area=\'Advert\'])
.
Extended selectors with defined target
as any selector — *:xpath(expression)
— can still be used but it is not recommended, so target
should be specified instead.
Works properly only at the end of selector, except for pseudo-class :remove().
Примеры
:xpath(//*[@class="banner"])
selects the element div#target1
:
<!-- HTML code -->
<div id="target1" class="banner"></div>
:xpath(//*[@class="inner"]/..)
selects the element div#target2
:
<!-- HTML code -->
<div id="target2">
<div class="inner"></div>
</div>
Псевдокласс :nth-ancestor()
The :nth-ancestor()
pseudo-class allows to lookup the nth ancestor relative to the previously selected element.
subject:nth-ancestor(n)
subject
— обязателен. Стандартный или расширенный CSS-селекторn
— обязателен. Число >= 1 и < 256, расстояние до нужного родителя от элемента, выбранногоsubject
Syntax
subject:nth-ancestor(n)
subject
— required, standard or extended CSS selectorn
— обязателен. Число >= 1 и < 256, расстояние до нужного родителя от элемента, выбранногоsubject
Ограничения :nth-ancestor()
The :nth-ancestor()
pseudo-class is not supported inside the argument of the :not()
pseudo-class.
Примеры
For such DOM:
<!-- HTML code -->
<div id="target1">
<div class="child"></div>
<div id="target2">
<div>
<div>
<div class="inner"></div>
</div>
</div>
</div>
</div>
.child:nth-ancestor(1)
selects the element div#target1
, div[class="inner"]:nth-ancestor(3)
selects the element div#target2
.
Псевдокласс :upward()
The :upward()
pseudo-class allows to lookup the ancestor relative to the previously selected element.
Syntax
subject:upward(ancestor)
subject
— стандартный или расширенный CSS-селектор, необходимancestor
— требуется, спецификация для предка элемента, выбранногоsubject
, может быть задана как:- число >= 1 и < 256 для указания расстояния до нужного предка, то же, что и
:nth-ancestor()
- стандартный CSS-селектор для поиска ближайшего предка
- число >= 1 и < 256 для указания расстояния до нужного предка, то же, что и
Ограничения :upward()
The :upward()
pseudo-class is not supported inside the argument of the :not()
pseudo-class.
Примеры
For such DOM:
<!-- HTML code -->
<div id="target1" data="true">
<div class="child"></div>
<div id="target2">
<div>
<div>
<div class="inner"></div>
</div>
</div>
</div>
</div>
.inner:upward(div[data])
selects the element div#target1
, .inner:upward(div[id])
selects the element div#target2
, .child:upward(1)
selects the element div#target1
, .inner:upward(3)
selects the element div#target2
.
Псевдокласс :remove()
и псевдосвойство remove
Sometimes, it is necessary to remove a matching element instead of hiding it or applying custom styles. In order to do it, you can use the :remove()
pseudo-class as well as the remove
pseudo-property.
Pseudo-class :remove()
can be placed only at the end of a selector.
Syntax
! pseudo-class
selector:remove()
! псевдосвойство
selector { remove: true; }
subject
— обязателен. Стандартный или расширенный CSS-селектор
Ограничения :remove()
и remove
The :remove()
pseudo-class is limited to work properly only at the end of selector.
For applying the :remove()
pseudo-class to any element, the universal selector *
should be used. Otherwise such extended selector may be considered as invalid, e.g. .banner > :remove()
is not valid for removing any child element of banner
class element, so it should look like .banner > *:remove()
.
If the :remove()
pseudo-class or the remove
pseudo-property is used, all style properties are ignored except for the debug
pseudo-property.
Примеры
div.banner:remove()
div:has(> div[ad-attr]):remove()
div:contains(advertisement) { remove: true; }
div[class]:has(> a > img) { remove: true; }
Rules with the remove
pseudo-property must use #$?#
marker: $
for CSS-style rule syntax, ?
for ExtendedCss syntax.
Псевдокласс :is()
The :is()
pseudo-class allows to match any element that can be selected by any of selectors passed to it. Invalid selectors are skipped and the pseudo-class deals with valid ones with no error thrown. Our implementation of the native :is()
pseudo-class.
Syntax
[target]:is(selectors)
target
— optional, standard or extended CSS selector, can be skipped for checking any elementselectors
— щадящий список стандартных и расширенных селекторов. For extended selectors, only compound selectors are supported, not complex.
Ограничения :is()
Rules with the :is()
pseudo-class must use the native implementation of :is()
if rules use ##
marker and it is possible, i.e. with no other extended selectors inside. To force applying ExtendedCss rules with :is()
, use #?#
/#$?#
marker explicitly.
If the :is()
pseudo-class argument selectors
is an extended selector, due to the way how the :is()
pseudo-class is implemented in ExtendedCss v2.0, it is impossible to apply it to the top DOM node which is html
, i.e. #?#html:is(<extended-selectors>)
does not work. So if target
is not defined or defined as the universal selector *
, the extended pseudo-class applying is limited to html
's children, e.g. rules #?#:is(...)
and #?#*:is(...)
are parsed as #?#html *:is(...)
. Please note that there is no such limitation for a standard selector argument, i.e. #?#html:is(.locked)
works fine.
Complex selectors with extended pseudo-classes are not supported as selectors
argument for :is()
pseudo-class, only compound ones are allowed. Check examples below for more details.
Примеры
#container *:is(.inner, .footer)
selects only the element div#target1
:
<!-- HTML code -->
<div id="container">
<div data="true">
<div>
<div id="target1" class="inner"></div>
</div>
</div>
</div>
Due to limitations :is(*:not([class]) > .banner)'
does not work but :is(*:not([class]):has(> .banner))
can be used instead of it to select the element div#target2
:
<!-- HTML code -->
<span class="span">text</span>
<div id="target2">
<p class="banner">inner paragraph</p>
</div>
Псевдокласс :not()
The :not()
pseudo-class allows to select elements which are not matched by selectors passed as argument. Invalid argument selectors are not allowed and error is to be thrown. Our implementation of the :not()
pseudo-class.
Syntax
[target]:not(selectors)
target
— optional, standard or extended CSS selector, can be skipped for checking any elementselectors
— список стандартных или расширенных селекторов
Ограничения :not()
Rules with the :not()
pseudo-class must use the native implementation of :not()
if rules use ##
marker and it is possible, i.e. with no other extended selectors inside. To force applying ExtendedCss rules with :not()
, use #?#
/#$?#
marker explicitly.
If the :not()
pseudo-class argument selectors
is an extended selector, due to the way how the :not()
pseudo-class is implemented in ExtendedCss v2.0, it is impossible to apply it to the top DOM node which is html
, i.e. #?#html:not(<extended-selectors>)
does not work. So if target
is not defined or defined as the universal selector *
, the extended pseudo-class applying is limited to html
's children, e.g. rules #?#:not(...)
and #?#*:not(...)
are parsed as #?#html *:not(...)
. Please note that there is no such limitation for a standard selector argument, i.e. #?#html:not(.locked)
works fine.
The :not()
is considered as a standard CSS pseudo-class inside the argument of the :upward()
pseudo-class because :upward()
supports only standard selectors.
"Up-looking" pseudo-classes which are :nth-ancestor()
and :upward()
are not supported inside selectors
argument for :not()
pseudo-class.
Примеры
#container > *:not(h2, .text)
selects only the element div#target1
:
<!-- HTML code -->
<div id="container">
<h2>Header</h2>
<div id="target1"></div>
<span class="text">text</span>
</div>
Псевдокласс :if-not()
(удалён)
The :if-not()
pseudo-class is removed and is no longer supported. Правила с ним не работают.
This pseudo-class was basically a shortcut for :not(:has())
. It was supported by ExtendedCss for better compatibility with some filters subscriptions.
Приоритет косметических правил
The way element hiding and CSS rules are applied is platform-specific.
In AdGuard for Windows, Mac, and Android, we use a stylesheet injected into the page. The priority of cosmetic rules is the same as any other websites' CSS stylesheet. But there is a limitation: element hiding and CSS rules cannot override inline styles. In such cases, it is recommended to use extended selectors or HTML filtering.
In AdGuard Browser Extension, the so called "user stylesheets" are used. They have higher priority than even the inline styles.
Extended CSS selectors use JavaScript to work and basically add an inline style themselves, therefore they can override any style.
Правила фильтрации HTML
In most cases, the basis and cosmetic rules are enough to filter ads. But sometimes it is necessary to change the HTML-code of the page itself before it is loaded. This is when you need filtering rules for HTML content. They allow to indicate the HTML elements to be cut out before the browser loads the page.
HTML filtering rules are supported by AdGuard for Windows, Mac, Android, and AdGuard Browser Extension for Firefox. Such rules do not work in extensions for other browsers because they are unable to modify content on network level.
Syntax
selector = [tagName] [attributes] [pseudoClasses]
combinator = ">"
rule = [domains] "$$" selector *(combinator selector)
domains = [domain0, domain1[, ...[, domainN]]]
attributes = "[" name0 = value0 "]" "[" name1 = value2 "]" ... "[" nameN = valueN "]"
pseudoClasses = pseudoClass *pseudoClass
pseudoClass = ":" pseudoName [ "(" pseudoArgs ")" ]
tagName
— имя элемента в нижнем регистре, например,div
илиscript
.domains
— ограничение на домены, на страницах которых будет применено правило. Те же принципы, что и в синтаксисе правил скрытия элементов.attributes
— список атрибутов, ограничивающих выбор элементов.name
— имя атрибута,value
— подстрока, которая содержится в значении атрибута.pseudoName
— имя псевдокласса.pseudoArgs
— аргументы псевдокласса, записанного в виде функции.combinator
— оператор, который работает аналогично CSS-комбинатору дочерних элементов: селектор справа от комбинатора будет относиться только к элементу, прямой родительский элемент которого соответствует селектору слева от комбинатора.
Примеры
HTML code:
<script data-src="/banner.js"></script>
Rule:
example.org$$script[data-src="banner"]
This rule removes all script
elements with the attribute data-src
containing the substring banner
. The rule applies only to example.org
and all its subdomains.
Специальные атрибуты
In addition to usual attributes, which value is every element checked for, there is a set of special attributes that change the way a rule works. Below there is a list of these attributes:
tag-content
This special attribute may become unsupported in the future. Prefer using the :contains()
pseudo-class where it is available.
This is the most frequently used special attribute. It limits selection with those elements whose innerHTML code contains the specified substring.
You must use ""
to escape "
, for instance: $$script[tag-content="alert(""this is ad"")"]
For example, take a look at this HTML code:
<script type="text/javascript">
document.write('<div>banner text</div>" />');
</script>
Following rule will delete all script
elements with a banner
substring in their code:
$$script[tag-content="banner"]
The tag-content
special attribute must not appear in a selector to the left of a >
combinator.
wildcard
This special attribute may become unsupported in the future. Prefer using the :contains()
pseudo-class where it is available.
This special attribute works almost like tag-content
and allows you to check the innerHTML code of the document. Rule will check if HTML code of the element fits to the search pattern.
You must use ""
to escape "
, for instance: $$script[wildcard=""banner""]
For example: $$script[wildcard="*banner*text*"]
It checks if the element code contains the two consecutive substrings banner
and text
.
The wildcard
special attribute must not appear in a selector to the left of a >
combinator.
max-length
This special attribute may become unsupported in the future. Prefer using the :contains()
pseudo-class with a regular expression where it is available.
Specifies the maximum length for content of HTML element. If this parameter is set and the content length exceeds the value, a rule does not apply to the element.
Default value
If this parameter is not specified, the max-length
is considered to be 8192.
Например:
$$div[tag-content="banner"][max-length="400"]
This rule will remove all the div
elements, whose code contains the substring banner
and the length of which does not exceed 400
characters.
The max-length
special attribute must not appear in a selector to the left of a >
combinator.
min-length
This special attribute may become unsupported in the future. Prefer using the :contains()
pseudo-class with a regular expression where it is available.
Specifies the minimum length for content of HTML element. If this parameter is set and the content length is less than preset value, a rule does not apply to the element.
Например:
$$div[tag-content="banner"][min-length="400"]
This rule will remove all the div
elements, whose code contains the substring banner
and the length of which exceeds 400
characters.
The min-length
special attribute must not appear in a selector to the left of a >
combinator.
Псевдоклассы
:contains()
Syntax
:contains(текст без кавычек)
или
:contains(/reg(ular)?ex(pression)?/)
:-abp-contains()
and :has-text()
are synonyms for :contains()
.
The :contains()
pseudo-class is supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.13 or later.
Requires that the inner HTML of the element contains the specified text or matches the specified regular expression.
A :contains()
pseudo-class must not appear in a selector to the left of a >
combinator.
Исключения
Similar to hiding rules, there is a special type of rules that disable the selected HTML filtering rule for particular domains. The syntax is the same, you just have to change $$
to $@$
.
For example, there is a rule in filter:
$$script[tag-content="banner"]
If you want to disable it for example.com
, you can create an exception rule:
example.com$@$script[tag-content="banner"]
Sometimes, it may be necessary to disable all restriction rules. For example, to conduct tests. To do this, use the exclusion rule without specifying a domain.
$@$script[tag-content="banner"]
We recommend to use this kind of exceptions only if it is not possible to change the hiding rule itself. In other cases it is better to change the original rule, using domain restrictions.
Правила JavaScript
AdGuard supports a special type of rules that allows you to inject any javascript code to websites pages.
We strongly recommend using scriptlets instead of JavaScript rules whenever possible. JS rules are supposed to help with debugging, but as a long-time solution a scriptlet rule should be used.
Syntax
rule = [domains] "#%#" script
domains
— ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.script
— произвольный javascript-код в одну строку.
Примеры
example.org#%#window.__gaq = undefined;
выполняет кодwindow.__gaq = undefined;
на всех страницах сайтаexample.org
и всех его поддоменах.
Исключения
Similar to hiding rules, there is a special type of rules that disable the selected javascript rule for particular domains. The syntax is the same, you just have to change #%#
to #@%#
.
For example, there is a rule in filter:
#%#window.__gaq = undefined;
If you want to disable it for example.com
, you can create an exception rule:
example.com#@%#window.__gaq = undefined;
Sometimes, it may be necessary to disable all restriction rules. For example, to conduct tests. To do this, use the exclusion rule without specifying a domain.
#@%#window.__gaq = undefined;
We recommend to use this kind of exceptions only if it is not possible to change the hiding rule itself. In other cases it is better to change the original rule, using domain restrictions.
JavaScript rules can be used only in trusted filters.
JavaScript rules are not supported by AdGuard Content Blocker.
Правила скриптлета
Scriptlet is a JavaScript function that provides extended capabilities for content blocking. These functions can be used in a declarative manner in AdGuard filtering rules.
AdGuard supports a lot of different scriptlets. In order to achieve cross-blocker compatibility, we also support syntax of uBO and ABP.
Syntax
rule = [domains] "#%#//scriptlet(" scriptletName arguments ")"
scriptletName
(обязательно) — это имя скриптлета из библиотеки скриптлетов AdGuardarguments
(опционально) — это список аргументов в форматеstring
(другие типы аргументов не поддерживаются)
Примеры
example.org#%#//scriptlet("abort-on-property-read", "alert")
This rule will be applied to example.org
and subdomains pages and will execute the abort-on-property-read
scriptlet with the alert
parameter.
Learn more about how to debug scriptlets.
More information about scriptlets can be found on GitHub.
Scriptlet rules are not supported by AdGuard Content Blocker.
Доверенные скриптлеты
Trusted scriptlets are scriptlets with extended functionality. It means the same syntax and restrictions. Trusted scriptlet names are prefixed with trusted-
, e.g. trusted-set-cookie
, to be easily distinguished from common scriptlets.
Trusted scriptlets are not compatible with other ad blockers except AdGuard.
Trusted scriptlets rules can be used only in trusted filters.
Trusted scriptlets rules are not supported by AdGuard Content Blocker.
Learn more about how to debug scriptlets.
More information about trusted scriptlets can be found on GitHub.
Модификаторы для небазовых правил
Each rule can be modified using the modifiers described in the following paragraphs.
Syntax {#non-basic-rules-modifiers-syntax}
rule = "[$" modifiers "]" [rule text]
modifiers = modifier0[, modifier1[, ...[, modifierN]]]
modifier
— набор модификаторов, описанных ниже.rule text
— правило, которое нужно модифицировать.
For example, [$domain=example.com,app=test_app]##selector
.
In the modifiers values, the following characters must be escaped: [
, ]
, ,
, and \
(unless it is used for the escaping). Use \
to escape them. For example, an escaped bracket looks like this: \]
.
Модификатор \ Продукты | Приложения CoreLibs | AdGuard для Chromium | AdGuard для Firefox | AdGuard для iOS | AdGuard для Safari | AdGuard Content Blocker |
---|---|---|---|---|---|---|
$app | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
$domain | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$path | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
$url | ✅ | 🧩 * | 🧩 * | ❌ | ❌ | ❌ |
- ✅ — полностью поддерживается
- 🧩 — может быть уже реализован в nightly или бета-версиях, но пока не поддерживается в релизных версиях
- ❌ — не поддерживается
$app
$app
modifier lets you narrow the rule coverage down to a specific application or a list of applications. The modifier's behavior and syntax perfectly match the corresponding basic rules $app
modifier.
Примеры
[$app=org.example.app]example.com##.textad
hides adiv
with the classtextad
atexample.com
and all subdomains in requests sent from theorg.example.app
Android app.[$app=~org.example.app1|~org.example.app2]example.com##.textad
hides adiv
with the classtextad
atexample.com
and all subdomains in requests sent from any app exceptorg.example.app1
andorg.example.app2
.[$app=com.apple.Safari]example.org#%#//scriptlet('prevent-setInterval', 'check', '!300')
применяет скриптлетprevent-setInterval
только в браузере Safari на Mac.[$app=org.example.app]#@#.textad
отключает все правила##.textad
для всех доменов при использованииorg.example.app
.
Such rules with $app
modifier are supported by AdGuard for Windows, Mac, and Android.
$domain
$domain
modifier limits the rule application area to a list of domains and their subdomains. The modifier's behavior and syntax perfectly match the corresponding basic rules $domain
modifier.
Примеры
[$domain=example.com]##.textad
— hides adiv
with the classtextad
atexample.com
and all subdomains.[$domain=example.com|example.org]
скроет элемент с атрибутомid
равнымadblock
на доменахexample.com
,example.org
и всех их поддоменах.[$domain=~example.com]##.textad
скроет элементыdiv
с классомtextad
на всех доменах, кромеexample.com
и всех его поддоменов.
There are 2 ways to specify domain restrictions for non-basic rules:
- «классический»: обозначить ограничение на домены перед маской и атрибутами правила:
example.com##.textad
; - с помощью модификаторов: обозначить ограничение на домены через модификатор
$domain
:[$domain=example.com]##.textad
.
But rules with mixed style domains restriction are considered invalid. So, for example, the rule [$domain=example.org]example.com##.textad
will be ignored.
Such rules with $domain
modifier are supported by AdGuard for Windows, Mac, Android, and AdGuard Browser Extension for Chrome, Firefox, Edge.
$path
$path
modifier limits the rule application area to specific locations or pages on websites.
Syntax
$path ["=" pattern]
pattern
— optional, a path mask to which the rule is restricted. Its syntax and behavior are pretty much the same as with the pattern for basic rules. You can also use special characters, except for ||
, which does not make any sense in this case (see examples below).
If pattern
is not set for $path
, rule will apply only on the main page of website.
$path
modifier matches the query string as well.
$path
modifier supports regular expressions in the same way basic rules do.
Примеры
[$path=page.html]##.textad
hides adiv
with the classtextad
at/page.html
or/page.html?<query>
or/sub/page.html
or/another_page.html
[$path=/page.html]##.textad
hides adiv
with the classtextad
at/page.html
or/page.html?<query>
or/sub/page.html
of any domain but not at/another_page.html
[$path=|/page.html]##.textad
hides adiv
with the classtextad
at/page.html
or/page.html?<query>
of any domain but not at/sub/page.html
[$path=/page.html|]##.textad
hides adiv
with the classtextad
at/page.html
or/sub/page.html
of any domain but not at/page.html?<query>
[$path=/page*.html]example.com##.textad
hides adiv
with the classtextad
at/page1.html
or/page2.html
or any other path matching/page<...>.html
ofexample.com
[$path]example.com##.textad
hides adiv
with the classtextad
at the main page ofexample.com
[$domain=example.com,path=/page.html]##.textad
hides adiv
with the classtextad
atpage.html
ofexample.com
and all subdomains but not atanother_page.html
[$path=/\\/(sub1|sub2)\\/page\\.html/]##.textad
hides adiv
with the classtextad
at both/sub1/page.html
and/sub2/page.html
of any domain (please note the escaped special characters)
Rules with $path
modifier are not supported by AdGuard Content Blocker.
$url
$url
modifier limits the rule application area to URLs matching the specified mask.
Syntax
url = pattern
where pattern
is pretty much the same as pattern
of the basic rules assuming that some characters must be escaped. The special characters and regular expressions are supported as well.
Примеры
[$url=||example.com/content/*]##div.textad
hides adiv
with the classtextad
at addresses likehttps://example.com/content/article.html
and evenhttps://subdomain.example.com/content/article.html
.[$url=||example.org^]###adblock
скрывает элемент с атрибутомid
равнымadblock
в запросах кexample.org
и всем его поддоменам.[$url=/\[a-z\]+\\.example\\.com^/]##.textad
скрываетdiv
с классомtextad
в запросах ко всем доменам, соответствующим регулярному выражению[a-z]+\.example\.com^
.
$url
modifier limitations
Rules with the $url
modifier are supported by AdGuard for Windows, Mac, and Android with CoreLibs v1.11 or later, and AdGuard Browser Extension with TSUrlFilter v3.0.0 or later.
Информация для разработчиков фильтров
If you maintain a third-party filter that is known to AdGuard, you might be interested in the information presented in this section. Please note that hints will be applied to registered filters only. The filter is considered to be registered and known by AdGuard, if it is present in the known filters index. If you want your filter to be registered, please file an issue to AdguardFilters repo.
Директивы препроцессора
We provide preprocessor directives that can be used by filters maintainers to improve compatibility with different ad blockers and provide:
- включать содержимое отдельного файла в фильтр
- применять правила в зависимости от типа блокировщика
- уточнять блокировщик контента для применения правил в Safari
Any mistake in a preprocessor directive will lead to AdGuard failing the filter update in the same way as if the filter URL was unavailable.
Preprocessor directives can be used in the user rules or in the custom filters.
Включение файла
The !#include
directive allows to include contents of a specified file into the filter. It supports only files from the same origin to make sure that the filter maintainer is in control of the specified file. The included file can also contain pre- directives (even other !#include
directives). Ad blockers should consider the case of recursive !#include
and implement a protection mechanism.
Syntax
!#include file_path
where file_path
is a same origin absolute or relative file path to be included.
The files must originate from the same domain but may be located in a different folder.
If included file is not found or unavailable, the whole filter update should fail.
Same-origin limitation should be disabled for local custom filters.
Примеры
Filter URL: https://example.org/path/filter.txt
! Корректный (тот же источник):
!#include https://example.org/path/includedfile.txt
!
! Корректный (относительный путь):
!#include /includedfile.txt
!#include ../path2/includedfile.txt
!
! Некорректный (другой источник):
!#include https://domain.com/path/includedfile.txt
Условия
Filters maintainers can use conditions to supply different rules depending on the ad blocker type. A conditional directive beginning with an !#if
directive must explicitly be terminated with an !#endif
directive. Conditions support all basic logical operators.
There are two possible scenarios:
Если блокировщик рекламы встречает директиву
!#if
и не встречает директиву!#else
, то он компилирует код между директивами!#if
и!#endif
только в том случае, если указанное условие истинно.Если существует директива
!#else
, код между!#if
и!#else
будет скомпилирован, если условие истинно; в противном случае будет скомпилирован код между!#else
и!#endif
.
Whitespaces matter. !#if
is a valid directive, while !# if
is not.
Syntax
!#if (conditions)
rules_list
!#endif
или
!#if (условия)
true_conditions_rules_list
!#else
false_conditions_rules_list
!#endif
где:
!#if (условия)
— начало блока при выполнении условийconditions
— точно так же, как и в случае с некоторыми популярными языками программирования, условия препроцессинга основаны на константах, объявляемых блокировщиками. Разработчики блокировщиков самостоятельно определяют, какие именно константы объявлять. Возможные значения:adguard
объявляется всегда; даёт разработчикам фильтров понять, что это один из продуктов AdGuard; должно быть достаточно в 95% случаев- специфичные для конкретных продуктов константы, которые нужны в редких случаях, когда правило должно работать (или не работать — тогда перед константой используйте
!
) только для конкретного продукта:adguard_app_windows
— AdGuard для Windowsadguard_app_mac
— AdGuard для Macadguard_app_android
— AdGuard для Androidadguard_app_ios
— AdGuard для iOSadguard_ext_safari
— AdGuard для Safariadguard_ext_chromium
— Браузерное расширение AdGuard для Chrome (и браузеры на основе Chrome, например, новый Microsoft Edge)adguard_ext_firefox
— Браузерное расширение AdGuard для Firefoxadguard_ext_edge
— Браузерное расширение AdGuard для Edge Legacyadguard_ext_opera
— Браузерное расширение AdGuard для Operaadguard_ext_android_cb
— AdGuard Content Blocker для мобильных браузеров Samsung и Яндексext_ublock
— особый случай; эта константа объявляется, когда версия фильтра для uBlock компилируется при помощи FiltersRegistrycap_html_filtering
— продукты, поддерживающие правила HTML-фильтрации: AdGuard для Windows, AdGuard для Mac и AdGuard для Android
!#else
— начало блока, когда условия ложныrules_list
,true_conditions_rules_list
,false_conditions_rules_list
— списки правил!#endif
— конец блока
Примеры
! для всех продуктов AdGuard, кроме AdGuard для Safari
!#if (adguard && !adguard_ext_safari)
||example.org^$third-party
domain.com##div.ad
!#endif
! директивы также можно совмещать
!#if (adguard_app_android)
!#include /androidspecific.txt
!#endif
!#if (adguard && !adguard_ext_safari)
! для всех продуктов AdGuard, кроме AdGuard для Safari
||example.org^$third-party
domain.com##div.ad
!#else
! только для AdGuard для Safari
||subdomain.example.org^$third-party
!#endif
The !#else
directive is supported by the FiltersDownloader v1.1.20 or later.
It is already supported for filter lists compiled by the FiltersRegistry, but it still may not be supported by AdGuard products when adding a filter list with !#else
as a custom one. The following products will support it in the mentioned versions or later:
- AdGuard for Windows, Mac, and Android with CoreLibs v1.13;
- Браузерное расширение AdGuard 4.2.208;
- AdGuard v1.11.16 for Safari.
Правила фильтрации в Safari
Safari's limit for each content blocker is 150,000 active rules. But in AdGuard for Safari and AdGuard for iOS, we've split the rules into 6 content blockers, thus increasing the rule limit to 900,000.
Here is the composition of each content blocker:
- AdGuard General — Блокировка рекламы, Языковые
- AdGuard Privacy — Антитрекинг
- AdGuard Social — Виджеты социальных сетей, Раздражители
- AdGuard Security — Безопасность
- AdGuard Other — Другие
- AdGuard Custom — Собственные
User rules and allowlist are added to every content blocker.
The main disadvantage of using multiple content blockers is that rules from different blockers are applied independently. Blocking rules are not affected by this, but unblocking rules may cause problems. If a blocking rule is in one content blocker and an exception is in another, the exception will not work. Filter maintainers use !#safari_cb_affinity
to define Safari content blocker affinity for the rules inside of the directive block.
Syntax
!#safari_cb_affinity(content_blockers)
rules_list
!#safari_cb_affinity
где:
!#safari_cb_affinity(content_blockers)
— начало блокаcontent_blockers
— список блокировщиков контента, разделённых запятой. Возможные значения:general
— блокировщик контента AdGuard Generalprivacy
— блокировщик контента AdGuard Privacysocial
— блокировщик контента AdGuard Socialsecurity
— блокировщик контента AdGuard Securityother
— блокировщик контента AdGuard Othercustom
— блокировщик контента AdGuard Customall
— специальное ключевое слово, которое означает, что правила должны быть включены во все блокировщики контента
rules_list
— список правил!#safari_cb_affinity
— конец блока
Примеры
! чтобы не скрывать указанный элемент, который скрывается Базовым фильтром:
!#safari_cb_affinity(general)
example.org#@#.adBanner
!#safari_cb_affinity
! to allowlist basic rule from AdGuard Tracking Protection filter:
!#safari_cb_affinity(privacy)
@@||example.org^
!#safari_cb_affinity
Подсказки
"Hint" is a special comment, instruction to the filters compiler used on the server side (see FiltersRegistry).
Syntax
!+ HINT_NAME1(PARAMS) HINT_NAME2(PARAMS)
Multiple hints can be applied.
Подсказка NOT_OPTIMIZED
For each filter, AdGuard compiles two versions: full and optimized. Optimized version is much more lightweight and does not contain rules which are not used at all or used rarely.
Rules usage frequency comes from the collected filter rules statistics. But filters optimization is based on more than that — some filters have specific configuration. This is how it looks like for Base filter:
"filter": Базовый фильтр AdGuard,
"percent": 30,
"minPercent": 20,
"maxPercent": 40,
"strict": true
где:
- filter — идентификатор фильтра
- percent — ожидаемый процент оптимизации
~= (количество правил в оптимизированном фильтре) / (количество правил в исходном фильтре) * 100
- minPercent — нижняя граница значения
percent
- maxPercent — верхняя граница значения
percent
- Strict — если
percent < minPercent
илиpercent > maxPercent
и включён режим Strict, то компиляция фильтра должна завершиться неудачно, в противном случае должны использоваться оригинальные правила
In other words, percent
is the "compression level". For instance, for the Base filter it is configured to 40%. It means that optimization algorithm should strip 60% of rules.
Eventually, here are the two versions of the Base filter for AdGuard Browser Extension:
- полная: https://filters.adtidy.org/extension/chromium/filters/2.txt
- оптимизированная: https://filters.adtidy.org/extension/chromium/filters/2_optimized.txt
If you want to add a rule which should not be removed at optimization use the NOT_OPTIMIZED
hint:
!+ NOT_OPTIMIZED
||example.org^
And this rule will not be optimized only for AdGuard for Android:
!+ NOT_OPTIMIZED PLATFORM(android)
||example.org^
Подсказки PLATFORM
и NOT_PLATFORM
Used to specify the platforms to apply the rules. List of existing platforms and links to Base filter, for example, for each of them:
windows
— AdGuard для Windows — https://filters.adtidy.org/windows/filters/2.txtmac
— AdGuard для Mac — https://filters.adtidy.org/mac_v2/filters/2.txtandroid
— AdGuard для Android — https://filters.adtidy.org/android/filters/2.txtios
— AdGuard для iOS — https://filters.adtidy.org/ios/filters/2.txtext_chromium
— Браузерное расширение AdGuard для Chrome — https://filters.adtidy.org/extension/chromium/filters/2.txtext_chromium_mv3
— AdGuard Browser Extension for Chrome MV3 — https://filters.adtidy.org/extension/chromium-mv3/filters/2.txtext_ff
— Браузерное расширение AdGuard для Firefox — https://filters.adtidy.org/extension/firefox/filters/2.txtext_edge
— Браузерное расширение AdGuard для Edge — https://filters.adtidy.org/extension/edge/filters/2.txtext_opera
— Браузерное расширение AdGuard для Opera — https://filters.adtidy.org/extension/opera/filters/2.txtext_safari
— AdGuard для Safari — https://filters.adtidy.org/extension/safari/filters/2.txtext_android_cb
— AdGuard Content Blocker — https://filters.adtidy.org/extension/android-content-blocker/filters/2.txtext_ublock
— uBlock Origin — https://filters.adtidy.org/extension/ublock/filters/2.txt
Примеры
This rule will be available only in AdGuard for Windows, Mac, Android:
!+ PLATFORM(windows,mac,android)
||example.org^
Except for AdGuard for Safari, AdGuard Content Blocker, and AdGuard for iOS, this rule is available on all platforms:
!+ NOT_PLATFORM(ext_safari, ext_android_cb, ios)
||example.org^
Отладка правил фильтрации
It may be possible to create simple filtering rules "in your head" but for anything even slightly more complicated you will need additional tools to debug and iterate them. There are tools to assist you with that. You can use DevTools in Chrome and its analogs in other browsers but most AdGuard products provide another one — Filtering log.
Журнал фильтрации
Filtering log is an advanced tool that will be helpful mostly to filter developers. It lists all web requests that pass through AdGuard, gives you exhaustive information on each of them, offers multiple sorting options, and has other useful features.
Depending on which AdGuard product you are using, Filtering log can be located in different places.
- В AdGuard для Windows вы найдёте его во вкладке настроек Антибаннер или через меню трея
- В AdGuard для Mac он располагается в разделе Настройки → Дополнительно → Журнал фильтрации
- В AdGuard для Android его можно найти в разделе Статистика → Недавняя активность. Доступ к недавней активности также можно получить из Помощника
- В Браузерном расширении AdGuard он находится во вкладке настроек Дополнительно, а также доступен по клику правой кнопкой мыши по иконке расширения. Only Chromium- and Firefox-based web browsers show applied element hiding rules (including CSS, ExtCSS) and JS rules and scriptlets in their Filtering logs
In AdGuard for iOS and AdGuard for Safari, Filtering log does not exist because of the way content blockers are implemented in Safari. AdGuard does not see the web requests and therefore cannot display them.
Режим отладки селекторов
Sometimes, you might need to check the performance of a given selector or a stylesheet. In order to do it without interacting with JavaScript directly, you can use a special debug
style property. When ExtendedCss
meets this property, it enables the debugging mode either for a single selector or for all selectors, depending on the debug
value.
Open the browser console while on a web page to see the timing statistics for selector(s) that were applied there. Debugging mode displays the following stats as object where each of the debugged selectors are keys, and value is an object with such properties:
Always printed:
selectorParsed
— окончательный текст селектора после парсингаtimings
— список узлов DOM, соответствующих селекторуappliesCount
— общее количество раз, когда на странице был применён селекторappliesTimings
— время, которое ушло на применение селектора на странице, для каждого из случаев применения этого селектора (в миллисекундах)meanTiming
— среднее время, ушедшее на применение селектора на страницеstandardDeviation
— стандартное отклонениеtimingsSum
— общее время, ушедшее на все применения селектора на текущей странице
Printed only for remove pseudos:
removed
— flag to signal if elements were removed
Printed if elements are not removed:
matchedElements
— список узлов DOM, соответствующих селекторуstyleApplied
— объявление обработанного стиля правила, связанного с селектором
Примеры
Debugging a single selector:
When the value of the debug
property is true
, only information about this selector will be shown in the browser console.
#$?#.banner { display: none; debug: true; }
Enabling global debug:
When the value of the debug
property is global
, the console will display information about all extended CSS selectors that have matches on the current page, for all the rules from any of the enabled filters.
#$?#.banner { display: none; debug: global; }
Testing extended selectors without AdGuard
ExtendedCss can be executed on any page without using any AdGuard product. In order to do that you should copy and execute the following code in a browser console:
!function(e,t,d){C=e.createElement(t),C.src=d,C.onload=function(){alert("ExtendedCss loaded successfully")},s=e.getElementsByTagName(t)[0],s?s.parentNode.insertBefore(C,s):(h=e.getElementsByTagName("head")[0],h.appendChild(C))}(document,"script","https://AdguardTeam.github.io/ExtendedCss/extended-css.min.js");
Alternatively, install the ExtendedCssDebugger userscript.
Now you can now use the ExtendedCss
from global scope, and run its method query()
as Document.querySelectorAll()
.
Примеры
const selector = 'div.block:has=(.header:matches-css(after, content: Ads))';
// массив HTMLElements, соответствующих `selector`, должен быть возвращён
ExtendedCss.query(selector);
Отладка скриптлетов
If you are using AdGuard Browser Extension and want to debug a scriptlet or a trusted scriptlet rule, you can get additional information by opening the Filtering log. In that case, scriptlets will switch to debug mode and there will be more information in the browser console.
The following scriptlets are especially developed for debug purposes:
debug-current-inline-script
debug-on-property-read
debug-on-property-write
log-addEventListener
log-on-stack-trace
log-eval
log
The following scriptlets also may be used for debug purposes:
json-prune
prevent-fetch
prevent-requestAnimationFrame
prevent-setInterval
prevent-setTimeout
prevent-window-open
со специальным параметромreplacement
prevent-xhr
trusted-replace-fetch-response
trusted-replace-xhr-response
Легенда таблиц совместимости
Краткие обозначения продуктов
Приложения CoreLibs
— AdGuard для Windows, AdGuard для Mac и AdGuard для AndroidAdGuard для Chromium
— Браузерное расширение AdGuard для Chrome и других браузеров на основе Chromium, таких как Microsoft Edge и OperaAdGuard для Firefox
— Браузерное расширение AdGuard для FirefoxAdGuard для iOS
— AdGuard для iOS и AdGuard Pro для iOS (для мобильного браузера Safari)AdGuard для Safari
— AdGuard для веб-браузера SafariAdGuard Content Blocker
— Content Blocker для мобильных браузеров Android: Samsung Internet и Яндекс Браузер
Краткие обозначения совместимости
- ✅ — полностью поддерживается
- ✅ * — поддерживается, но надёжность может быть разной или могут возникнуть ограничения; ознакомьтесь с описанием модификатора для получения подробной информации
- 🧩 — может быть уже реализован в nightly или бета-версиях, но пока не поддерживается в релизных версиях
- ⏳ — функция, которая реализована или планируется к реализации, но пока недоступна ни в одном продукте
- ❌ — не поддерживается
- 👎 — deprecated; still supported but will be removed in the future
- 🚫 — удалён и больше не поддерживается