Как составлять свои фильтры

Введение

Фильтр — это набор правил фильтрации рекламного контента (баннеров, всплывающих окон и тому подобного). Вместе с AdGuard поставляется набор стандартных фильтров, создаваемых нами. Они постоянно дорабатываются и дополняются, и, как мы надеемся, удовлетворяют требованиям большинства пользователей.

Вместе с тем, AdGuard позволяет создать ваш собственный пользовательский фильтр, используя те же самые правила, которые используем мы в наших фильтрах.

Для описания синтаксиса правил мы используем Augmented BNF for Syntax Specifications, но мы не всегда строго следуем этой спецификации.

Синтаксис правил AdGuard изначально основан на синтаксисе правил Adblock Plus, но расширяет его, добавляя новые типы правил для улучшения фильтрации. Часть информации в этой статье об общих для ABP и AdGuard типах правил взята из этой статьи.

Комментарии

Любое правило, начинающееся с восклицательного знака, содержит комментарий. Оно отображается в списке правил серым цветом. 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/

Блокировка конкретного адреса

Это правило блокирует:

  • http://example.org/

Это правило не блокирует:

  • https://example.org/banner/img

Базовые модификаторы правил

Правила фильтрации поддерживают множество модификаторов, которые позволяют вам точно настраивать поведение правила. Вот пример правила с некоторыми простыми модификаторами.

Это правило блокирует:

  • http://example.org/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 Подробнее.

Расширенный CSS позволяет разработчикам фильтров справляться с гораздо более сложными случаями. Однако, чтобы использовать эти расширенные правила, вы должны хорошо понимать, что такое CSS.

Популярные CSS-селекторы

Имя CSS-селектор Описание
ID selector #banners Соответствует всем элементам с атрибутом id равным banners.
Class selector .banners Соответствует всем элементам типа class содержащих banners.
Attribute selector div[class="banners"] Соответствует всем div элементам с class равным banners.
Attribute substring selector div[class^="advert1"] Соответствует всем div элементам класс class которых начинается с advert1 строки.
Attribute substring selector div[class$="banners_ads"] Соответствует всем div элементам class которых заканчивается на banners_ads.
Attribute substring selector a[href^="http://example.com/"] Соответствует всем ссылкам загруженным с http://example.com/
Attribute selector a[href="http://example.com/"] Соответствует всем ссылкам конкретно http://example.com/ .

Базовые правила

Так называемые "Базовые правила" — самый простой вид правил. Эти правила предназначены для блокировки запросов на определенный адрес. Либо, при наличии специального маркера @@ в начале правила, для разблокировки запроса. Основной принцип для этого типа правил достаточно прост: необходимо указать адрес и дополнительные параметры, которые ограничивают или расширяют область действия правила.

Подзапросы

Базовые правила, блокирующие запросы, применяются только к подзапросам. То есть, они не будут блокировать загрузку страницы в браузере.

Статус ответа

Браузер определяет заблокированный подзапрос как выполненный с ошибкой.

Синтаксис базовых правил

      rule = ["@@"] pattern [ "$" modifiers ]
 modifiers = [modifier0, modifier1[, ...[, modifierN]]]
  • pattern — маска адреса. URL каждого запроса сопоставляется с этой маской. В шаблоне вы можете использовать некоторые специальные символы, описание которых будет дано ниже.
  • @@ — маркер, который используется для обозначения правил-исключений. С такого маркера должны начинаться правила, отключающие фильтрацию для запроса.
  • 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.

Визуальное представление

Советуем ознакомиться с этой статьей, чтобы лучше понять, как должны строиться такие правила.

Поддержка регулярных выражений

Если вы хотите добиться еще большей гибкости при составлении правил, вы можете использовать регулярные выражения вместо упрощенной маски со специальными символами, которая используется по умолчанию.

Производительность

Такие правила работают медленнее обычных, поэтому рекомендуется избегать их, или хотя бы ограничивать их область действия конкретными доменами.

Чтобы блокировщик определил, что вы хотите использовать регулярное выражение, необходимо, чтобы 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-символ для доменов верхнего уровня в паттернах косметических, html и js правил. Например, правило example.*##.banner будет соответствовать всем example.TLD доменам: example.ru, example.com, example.net, example.org и т.д.
При составлении базовых правил вы можете использовать wildcard-символ для TLD только вместе с модификатором $domain. Например, ||*/banners/*$image,domain=example.*

Примеры базовых правил

  • ||example.com/ads/* — простое правило, которое соотвествует адресам типа http://example.com/ads/banner.jpg и даже http://subdomain.example.com/ads/otherbanner.jpg.

  • ||example.org^$third-party — правило, которое блокирует сторонние запросы к домену example.org и его поддоменам.

  • @@||example.com$document — наиболее общее правило-исключение. Такое правило полностью отключает фильтрацию на домене example.com и всех его поддоменах. Существует ряд параметров, которые также можно использовать в правилах-исключениях. Более подробно о правилах-исключениях и параметрах, которые могут в таких правилах использоваться, написано ниже.

Модификаторы

Обратите внимание

Возможности, описанные в этом разделе, обычно используются опытными пользователями. Они расширяют возможности «Общих правил», но для их применения необходимо иметь начальное представление о работе браузера.

Вы можете изменить поведение «общего правила», используя дополнительные модификаторы. Список этих параметров располагается в конце правила за знаком доллара $ и разделяется запятыми.

Пример использования модификаторов:

||domain.com^$popup,third-party

Визуальное представление

Советуем ознакомиться с этой статьей, чтобы лучше понять, как должны применяться модификаторы.

Базовые модификаторы

Приведенные ниже модификаторы являются наиболее простыми для понимания и часто применяемыми.

domain

Модификатор domain ограничивает область действия правила списком доменов (и их поддоменов). Для того чтобы указать несколько доменов в одном правиле, нужно использовать символ | в качестве разделителя.

Примеры 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|~foo.example.org — в данном примере правило будет соответствовать запросам, отправленным с домена example.org и всех его поддоменов, кроме поддомена foo.example.org.

third-party

Ограничение на сторонние или собственные запросы. Сторонним является запрос, отправленный с другого сайта. Например, запрос к домену example.org, отправленный с домена domain.com, является сторонним.

Поддомены

Обратите внимание, что запрос, отправленный на поддомен того же домена (или наоборот), сторонним не является. Например, запрос к subdomain.example.org, отправленный с домена example.org, не является сторонним.

Если указан модификатор third-party, то правило применяется только к сторонним запросам.

Примеры third-party
  • ||domain.com^$third-party — правило применяется на всех сайтах, кроме domain.com и его поддоменов. Пример стороннего запроса: http://example.org/banner.jpg.

Если указан модификатор ~third-party, то правило применяется только к запросам, которые не являются сторонними. То есть, эти запросы отправлены с того же домена.

Примеры ~third-party
  • ||domain.com$~third-party — такое правило уже будет применяться только на самом domain.com, но не на других сайтах. Пример запроса, который не является сторонним: http://domain.com/icon.ico.

popup

AdGuard будет пытаться закрыть браузерную вкладку с любым адресом, подходящим под правило с этим модификатором. Обратите внимание, что закрыть можно не любую вкладку.

Примеры popup
  • ||domain.com^$popup — при попытке перехода на сайт http://domain.com с любой страницы в браузере, новая вкладка, в которой должен открыться указанный сайт, будет закрыта.

match-case

Определяет правило, которое применяется только к адресам с совпадением регистра символов. По умолчанию регистр символов не учитывается.

Примеры match-case
  • */BannerAd.gif$match-case — такоe правило будет блокировать http://example.com/BannerAd.gif, но не http://example.com/bannerad.gif.

Ограничение по типу контента

Существует целый набор модификаторов, которые ограничивают действие правила только запросами к ресурсам определенного типа. Эти модификаторы можно комбинировать, например распространить правило одновременно на картинки и скрипты.

Совместимость с разными версиями AdGuard

Обратите внимание, что существует большая разница в том, как разные версии AdGuard определяют тип контента. В случае браузерных расширений тип контента для каждого запроса предоставляется самим браузером. В случае AdGuard для Windows, macOS и Android для определения используется следующая методика: вначале мы пытаемся определить тип запроса по расширению загружаемого файла. Если запрос не заблокирован на этом этапе, то тип запроса уточняется с использованием заголовка Content-Type в начале ответа, полученного от сервера.

Примеры ограничений
  • ||example.org^$image — соответствует всем картинкам с домена example.org.
  • ||example.org^$script,stylesheet — соответствует всем скриптам и стилям с домена example.org.
  • ||example.org^$~image,~script,~stylesheet — соответствует всем запросам к домену example.org кроме картинок, скриптов и стилей.

image

Правило будет соответствовать запросам к изображениям.

stylesheet

Правило будет соответствовать запросам к файлам CSS стилей.

script

Правило будет соответствовать запросам к файлам скриптов (например javascript, vbscript).

object

Правило применяется к ресурсам, управляемым браузерными плагинами (например, Java или Flash).

object-subrequest

Запросы, инициированные плагинами (чаще всего это Flash).

Совместимость с разными версиями AdGuard

AdGuard для Windows, macOS и Android часто не могут корректно определить этот тип, и определяют его как other.

font

Правило будет соответствовать запросам к файлам шрифтов (например, файлам с расширением .woff).

media

Правило будет соответствовать запросам к медиа-файлам (музыка и видео, например, файлы с расширением .mp4).

subdocument

Правило будет соответствовать запросам к встроенным страницам (HTML-теги frame и iframe).

ping

Правило будет соответствовать запросам, сделанным либо navigator.sendBeacon(), либо атрибутом ссылки ping.

Совместимость с разными версиями AdGuard

AdGuard для Windows, macOS и Android не всегда могут корректно определить navigator.sendBeacon(). Для надёжного определения используйте браузерные расширения AdGuard.

xmlhttprequest

Правило применяется только к ajax-запросам. То есть к запросам, отправленным с помощью javascript-объекта XMLHttpRequest.

Совместимость с разными версиями AdGuard

AdGuard для Windows, macOS и Android не всегда могут корректно определить этот тип контента, и определяют его как other или script.

websocket

Правило применяется только к WebSocket-соединениям.

webrtc

Правило применяется только к WebRTC-соединениям.

Обратите внимание, что блокировка WebRTC может мешать работе некоторых браузерных приложений, таких как мессенджеры, чаты, кинотеатры, игры и др.

Примеры webrtc
  • ||example.com^$webrtc,domain=example.org - это правило блокирует WebRTC-соединения c example.com для example.org.
  • @@*$webrtc,domain=example.org - это правило отменяет блокировку всех WebRTC-соединений для example.org.

other

Правило применяется к запросам, для которых не был определен ни один из перечисленных выше типов.

Модификаторы правил-исключений

Правила-исключения отключают действие других базовых правил для адресов, которым они соответствуют. Отличаются правила-исключения тем, что они начинаются со специального маркера @@. Для таких правил работают все базовые модификаторы, перечисленные выше. Также добавляется несколько специальных модификаторов, которые будут описаны ниже.

Визуальное представление

Советуем ознакомиться с этой статьей, чтобы лучше понять, как должны строиться правила-исключения.

elemhide

Отключает косметические правила на страницах, подходящих под правило. О косметических правилах речь пойдет ниже.

Примеры elemhide
  • @@||example.com^$elemhide — отменяет все косметические правила для страниц на сайте example.com и на всех его поддоменах.

content

Отключает правила фильтрации HTML-элементов на страницах, подходящих под правило. О правилах фильтрации HTML-элементов речь пойдет ниже.

Примеры content
  • @@||example.com^$content — отменяет все правила фильтрации HTML-элементов для страниц на сайте example.com и на всех его поддоменах.

jsinject

Запрещает добавление javascript-кода на страницу. О javascript правилах речь пойдет ниже.

Примеры jsinject
  • @@||example.com^$jsinject — отменяет все javascript правила для страниц на сайте example.com и на всех его поддоменах.

urlblock

Отключает блокировку всех запросов, отправленных со страниц, подходящих под это правило.

Примеры urlblock
  • @@||example.com^$urlblock — запросы, отправленные со страниц на сайте example.com и всех его поддоменов, не будет блокироваться.

extension

Отключает все пользовательские скрипты на страницах, подходящих под это правило.

extension example
  • @@||example.com^$extension — пользовательские скрипты не будут работать на всех страницах сайта example.com.

document

Полностью отключает блокировку на страницах, подходящих под это правило. Эквивалентно одновременному использованию модификаторов elemhide, content, urlblock и jsinject.

Примеры document
  • @@||example.com^$document — полностью отключает блокировку для всех страниц на домене example.com и всех его поддоменах.
  • @@||example.com^$document,~extension — полностью отключает блокировку для всех страниц на домене example.com и его поддоменах, но разрешает работу пользовательских скриптов.

stealth

Отключает модуль "Антитрекинг" для всех страниц и запросов, подходящих под это правило.

Совместимость с разными версиями AdGuard

Модуль "Антитрекинг" на данный момент доступен в приложениях AdGuard для Windows, Mac, Android и браузерном расширении AdGuard. В продуктах без поддержки модуля "Антитрекинг" правила с этим модификатором игнорируются.

Примеры stealth
  • @@||example.com^$stealth — полностью отключает модуль Антитрекинг для запросов к example.com и поддоменам.
  • @@||domain.com^$script,stealth,domain=example.com — полностью отключает модуль Антитрекинг только для script-запросов к domain.com (и поддоменам) на example.com и всех его поддоменах.

Generic правила

Перед тем, как перейти к описанию следующих модификаторов, необходимо ввести определение "generic правил". Правило является "generic", если его действие не ограничено конкретными доменами.
Например, следующие правила являются "generic":

###banner
~domain.com###banner
||domain.com^
||domain.com^$domain=~example.com

А вот такие правила уже не являются "generic":

domain.com###banner
||domain.com^$domain=example.com

generichide

Отключает все "generic" косметические правила на страницах, подходящих под правило-исключение.

  • @@||example.com^generichide — отключает "generic" косметические правила на страницах сайта example.com и всех его поддоменах.

genericblock

Отключает все generic базовые правила на страницах, подходящих под правило-исключение.

  • @@||example.com^$genericblock — отключает "generic" базовые правила на страницах сайта example.com и всех его поддоменах.

Расширенные возможности

Модификаторы, описанные в этом разделе, полностью меняют поведение базовых правил, к которым эти модификаторы применены.

removeparam

Правила с модификатором $removeparam предназначены для того, чтобы расширить возможности Антитрекинга по блокированию параметров отслеживания на URL-страницах. Обратите внимание, что подобные правила применяются только к запросам типа GET.

Совместимость с разными версиями AdGuard

Правила с модификаторами $removeparam поддерживаются в AdGuard для Windows, Mac и Android.

Несколько правил в одном запросе

В случае, если несколько правил $removeparam соответствуют одному запросу, мы применим каждый из них поочередно.

Ограничения

Обратите внимание, что этот тип правил может быть использован только в проверенных фильтрах. В эту категорию входят ваш собственный Пользовательский фильтр и все фильтры, созданные командой AdGuard.

Совместимость с другими модификаторами

Правила $removeparam совместимы только с модификаторами: $domain, $third-party, $app, $important и $match-case. Правила с любыми другими модификаторами будут считаться неверными и применяться не будут.

Синтаксис

Чтобы уточнить параметр, на который должно влиять правило, следует использовать следующий синтаксис:

  • $removeparam=param -- убирает параметр с названием param из URL любого запроса. Например, запрос к http://example.com/page?param=1&another=2 будет преобразован в http://example.com/page?another=2.

Используйте | для разделения параметров:

  • $removeparam=p1|p2 -- убирает параметры p1 и p2 из URL любого запроса. Например, запрос к http://example.com/page?p1=1&p2&p3 будет преобразован в http://example.com/page?p3.

Обратите внимание, что блокирующее правило с параметром $removeparam должно содержать хотя бы один уточнённый параметр. Например, правило вроде example.com$removeparam будет считаться неверным и применяться не будет.

Параметры сопоставляются лексикографически. Это значит, что правило $removeparam=param не станет убирать параметр с названием Param или some_param. Если вы хотите обойти этот момент, вы можете использовать регулярные выражения:

removeparam = "/" regex "/" options

В этом случае:

  • regex - это регулярное выражение согласно синтаксису Perl,
  • options - опции регулярного выражения.

Список поддерживаемых опций для регулярных выражений:

  • i - делает сопоставление без учета регистра.

Примеры:

  • $removeparam=/param/ -- убирает параметры, соответствующие шаблону param, из URL любых запросов. Например, запрос к http://example.com/page?param=1&some_pArAm=2 будет преобразован в http://example.com/page?some_pArAm=2
  • $removeparam=/param/i -- убирает параметры, соответствующие шаблону param (без учета регистра) из URL любых запросов. Например, запрос к http://example.com/page?param=1&some_pArAm=2 будет преобразован в http://example.com/page

Важно: в случае использования регулярных выражений необходимо экранировать следующие символы: запятая ,, / и $. Используйте для этого символ \. Например, "запятая" будет в этом случае выглядеть так: \,.

Списки, разделенные с помощью | - также поддерживают регулярные выражения: $removeparam=p1|/p2/i|/p3/|p4.

Используйте исключения, если вы не хотите очищать от параметров некоторые URL:

1) Пример 1:

    $removeparam=gclid|yclid|fbclid
    @@||example.com^$removeparam=gclid

С этими правилами метки метрик компаний Google, Yandex и Facebook будут удалены, кроме меток Google для запросов к example.com. Например: http://google.com/page?gclid=1&fbclid=2&yclid=3 будет преобразован в http://google.com/page, но http://example.com/page?gclid=1&fbclid=2&yclid=3 будет преобразован в http://example.com/page?gclid=1.

2) Пример 2:

```
$removeparam=utm_source|utm_medium|utm_term
$removeparam=utm_content|utm_campaign|utm_referrer
@@||example.com^$removeparam
```

С этими правилами некоторые utm-параметры будут удалены из любого запроса, но в запросах к example.com не будут удаляться совсем. Например: http://google.com/page?utm_source=s&utm_referrer=fb.com&utm_content=img будет преобразован в http://google.com/page, но http://example.com/page?utm_source=s&utm_referrer=fb.com&utm_content=img вообще не будет затронут этим правилом блокировки.

Обратите внимание, что блокировку правил $removeparam также можно отключить с помощью правил исключений $document и $urlblock. Но базовые правила исключений без модификаторов не могут этого сделать. Например, @@||example.com^ не отключит $removeparam=p для запросов к example.com, а вот @@||example.com^$urlblock - отключит.

important

Модификатор $important, применённый к правилу, повышает его приоритет отсноительно любого другого правила без модификатора $important, даже относительно базовых правил-исключений.

Пример 1:
||example.org^$important
@@||example.org^

||example.org^$important заблокирует все запросы, несмотря на правило-исключение.

Пример 2:
||example.org^$important
@@||example.org^$important

Теперь правило-исключение также имеет модификатор $important, так что оно будет иметь более высокий приоритет.

Пример 3:

Модификатор $important будет проигнорирован, если применяется правило-исключение на уровне документа.

||example.org^$important
@@||test.org^$document

Если запрос к example.org отправлен с домена test.org, правило не будет применено несмотря на наличие модификатора $important.

badfilter

Совместимость с разными версиями AdGuard

Модификатор badfilter на данный момент работает только в браузерных расширениях AdGuard. Мы планируем в скором времени добавить поддержку этого модификатора и другими продуктами AdGuard.

Правила, содержащие модификатор badfilter, отключают базовые правила, на которые они ссылаются. Это означает, что текст отключенного правила должен соответствовать тексту badfilter-правила (за исключением самого модификатора badfilter).

Примеры badfilter
  • ||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

Совместимость с разными версиями AdGuard

Модификаторы ниже из этого раздела доступны только в AdGuard для Windows, macOS и Android. Браузерные расширения ограничены возможностями, предоставляемыми браузерами, и некоторые функции им просто недоступны.

empty

Обычно заблокированный запрос выглядит для браузера как ошибка сервера. В случае применения модификатора empty, AdGuard эмулирует пустой ответ сервера со статусом 200 OK.

Примеры empty
  • ||example.org^$empty — возвращает пустой ответ для всех запросов к домену example.org и всех его поддоменов.

mp4

В качестве ответа на заблокированный запрос AdGuard возвращает короткое видео-заглушку.

Примеры mp4
  • ||example.com/videos/$mp4 — блокирует загрузку видео с адресов ||example.com/videos/* и заменяет ответ на видео-заглушку.

replace

Этот модификатор полностью меняет поведение страницы. Когда он применяется, правило не блокирует запрос. Вместо этого ответ будет модифицирован.

Обратите внимание

Вам потребуется некоторое знание регулярных выражений, чтобы использовать этот модификатор.

Совместимость с различными версиями AdGuard

Такие правила поддерживаются продуктами AdGuard для Windows, AdGuard для Mac, AdGuard для Android и расширением AdGuard для Firefox.
Этот тип правил не будет работать в расширениях для других браузеров, потому что они не могут изменять содержимое страницы на сетевом уровне.

Особенности правил $replace
  • Правила $replace применяются к любому текстовому ответу, но не будут применяться к binary (media, image, object и т.д.).
  • Правила $replace не применяются, если размер оригинального ответа превышает 3Мб.
  • Правила $replace имеют более высокий приоритет, чем другие базовые правила (включая правила-исключения). Так что если запрос соответствует двум различным правилам, одно из которых имеет модификатор $replace, применится именно это правило.
  • Правила-исключения уровня document с модификаторами $content или $document отменяют срабатывание правил $replace, даже если запрос им соответствует.
  • Прочие правила-исключения уровня document (модификаторы $generichide, $elemhide или $jsinject) применяются вместе с правилами $replace. Это означает, что вы можете изменять содержимое страницы при помощи правила $replace и одновременно отменять косметические правила.

Значение $replace может быть пустым в случае правил-исключений. Смотрите раздел с примерами за дополнительной информацией.

Несколько правил, соотвтествующих одному запросу

В случае, когда несколько правил $replace соответствуют одному запросу, мы применим каждое из них. Правила будут применяться в алфавитном порядке.

Синтаксис $replace

Как правило, синтаксис replace похож на синтаксис замены при помощи регулярных выражений в Perl.

replace = "/" regex "/" replacement "/" modifiers
  • regex — регулярное выражение.
  • replacement — строка, которая будет использована для замены строки в соответствии с regex.
  • modifiers — флаги регулярных выражений. Например, i - поиск без учёта регистра, или s - режим одной строки.

В значении $replace необходимо экранировать два символа: запятую (,) и ($). Для экранирования используйте (\). Например, экранированная запятая будет выглядеть так: \,.

Пример $replace
||example.org^$replace=/(<VAST[\s\S]*?>)[\s\S]*<\/VAST>/\$1<\/VAST>/

У этого правила три части:

  • Регулярное выражение: (<VAST(.|\s)*?>)(.|\s)*<\/VAST>
  • Замена \$1<\/VAST> (заметьте, что символ $ экранирован)
  • Флаги регулярного выражения: i (поиск без учёта регистра)

Здесь вы можете увидеть, как работает это правило:
http://regexr.com/3cesk

Пример нескольких правил $replace
  1. ||example.org^$replace=/X/Y/
  2. ||example.org^$replace=/Z/Y/
  3. @@||example.org/page/*$replace=/Z/Y/
  • И правило 1, и правило 2 будут применены ко всем запросам, отправленным к example.org.
  • Правило 2 отключено для запросов, соответствующих ||example.org/page/, но правило 1 при этом всё равно работает!.
Отключение правил $replace
  • @@||example.org^$replace отключит все правила $replace, соответствующие ||example.org^.
  • @@||example.org^$document или @@||example.org^$content отключит все правила $replace, исходящие со страниц домена example.org, включая саму эту страницу.

csp

Этот модификатор полностью меняет поведение правила. Будучи применённым к правилу, он не заблокирует попадший под него запрос. Вместо этого будут изменены заголовки ответа.

Чтобы использовать правила этого типа, необходимо базовое понимание слоя безопасности Политики Безопасности Контента.

Для запросов, подходящих под $csp-правило, мы усилим политику безопасности ответа, добавив дополнительную политику, равнозначную содержимому модификатора $csp. Правила $csp применяются независимо от правил любого другого типа. Прочие базовые правила никак на них не влияют, кроме правил исключений уровня document (смотрите примеры ниже).

Когда несколько правил соответствуют одному запросу.
В случае, когда несколько $csp-правил соответствуют одному запросу, мы применяем их все.

Синтаксис csp

Синтаксис занчений $csp похож на синтаксис заголовков Политики Безопасности Контента.

Значение $csp может быть пустым в случае правил-исключений. Смотрите примеры ниже для более подробной информации.

Ограничения

  1. Пожалуйста, обратите внимание, что некоторые символы запрещены в значении $csp: (,), ($)
  2. $csp-правила поддерживают ограниченный список модификаторов: domain, important, subdocument
  3. Правила с директивами report-* считаются некорректными.
Примеры $csp
  • ||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-правила на всех страницах, подходящих под паттерн правила.

cookie

Модификатор $cookie полностью меняет поведение правила. Вместо того, чтобы блокировать запрос, этот модификатор позволяет нам блокировать или изменять заголовки Cookie или Set-Cookie.

Несколько правил, соотвтествующих одному запросу
В случае, когда несколько правил $cookie соответствуют одному запросу, мы применим каждое из них по очереди.

синтаксис $cookie

Синтаксис правила зависит от того, собираемся ли мы заблокировать все cookie или удалить один cookie. Поведение правила можно изменить с помощью модификаторов maxAge и sameSite.

  • ||example.org^$cookie=NAME;maxAge=3600;sameSite=lax -- каждый раз, когда AdGuard встречает cookie с именем NAME в запросе кexample.org, он будет делать следующее:

    • Установит дату истечения срока хранения на текущее время плюс 3600 секунд
    • Позволяет cookie использовать Same-Site "lax" стратегию.
  • ||example.org^$cookie -- Блокирует ВСЕ cookie установленные example.org. Это эквивалентно установке maxAge 0.
  • ||example.org^$cookie=NAME -- Блокирует единственную cookie с именем NAME.
  • ||example.org^$cookie=/regular_expression/ -- Блокирует все cookie, которые совпадают с регулярным выражением.

Важно: В случае использования регулярных выражений необходимо экранировать следующие символы: запятая (,) и ($). Используйте (\) для этого. Например, экранированная запятая выглядит так: \,.

Правила исключения (@@) не влияют на правила $cookie, только если это не правило иключение $document. Чтобы отключить правило $cookie, правило исключение также должно иметь модификатор $cookie. Вот как это работает:

  • @@||example.org^$cookie -- разблокирует все cookie, установленные example.org
  • @@||example.org^$cookie=NAME -- разблокирует одну cookie с именем NAME
  • @@||example.org^$cookie=/regular_expression/ -- разблокирует все cookie, соответствующие заданному регулярному выражению

Ограничения
$cookie правила поддерживают ограниченный список модификаторов: domain, ~domain, important, third-party, ~third-party.

Примеры с $cookie

  • $cookie=__cfduid -- блокирует CloudFlare cookie везде
  • $cookie=/__utm[a-z]/ -- блокирует Google Analytics cookie везде
  • ||facebook.com^$third-party,cookie=c_user -- не позволяет Facebook'у отслеживать вас, даже если вы вошли в систему

network

Правила этого типа позволяют полностью блокировать доступ к указанному удалённому адресу, то есть фактически работают как Брандмауэр.

Совместимость с различными версиями AdGuard

Только версии AdGuard для Windows, Mac и Android имеют техническую возможность использовать правила такого типа.

  1. $network-правила соответствуют только IP-адресам! Эти правила не получится использовать для блокирования или разблокирования доступа к домену.
  2. Чтобы задать соответствие IPv6-адресу, вам надо использовать "сколлапсированный" синтаксис, например, используйте [2001:4860:4860::8888]$network вместо [2001:4860:4860:0:0:0:0:8888]$network.
  3. Разблокирующее $network-правило заставит AdGuard направлять трафик в подходящую под соответствие конечную точку, например, тем самым можно прекратить всю последующую фильтрацию.
Примеры с network
  • 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 направлять трафик в конечную точку. Никакие другие правила не будут применены.

app

Этот модификатор ограничивает действие правила до конкретного приложения (или списка приложений). Это может быть не так критично на Windows или Mac, но на мобильных устройствах, где для корректной работы некоторые правила должны быть специфичны для конкретных приложений, данная функция крайне важна.

  • Android - используйте имя пакета приложения (например, org.example.app).
  • Windows - используйте имя процесса (например, chrome.exe).
  • Mac - используйте bundle ID или имя процесса (например, com.google.Chrome).

На Mac вы можете найти bundle ID или имя процесса интересующего вас приложения в деталях соответствующих запросов в Журнале фильтрации

Примеры использования app
  • ||baddomain.com^$app=org.example.app — правило для блокирования запросов, подходящих под заданную маску и посылаемых Android-приложением com.adguard.android.
  • ||baddomain.com^$app=org.example.app1|org.example.app2 — аналогичное правило, но оно работает как для приложения org.example.app1, так и для org.example.app2.

Если вы хотите, чтообы правило не применялось к заданному приложению, предваряйте имя приложения символом ~.

Примеры использования app и ~
  • ||baddomain.com^$app=~org.example.app — правило, блокирующее запросы, подходящие под заданную маску и посылаемые любым приложением кроме org.example.app.
  • ||baddomain.com^$domain=~org.example.app1|~org.example.app2 — аналогично, но в исключениях два приложения: org.example.app1 и org.example.app2.

redirect

Синтаксис redirect

AdGuard использует тот ж синтаксис правил фильтрации, что и uBlock Origin. Он совместим с модификатором $rewrite=abp-resource Adblock Plus.

$redirect – это модификатор для базовых правил, поэтому правила с ним поддерживают все остальные базовые модификаторы, такие как $domain, $third-party, $script, и т.д.

Значение модификатора $redirect должно быть именем ресурса, который будет использован для переадресации.

Приоритетность правил $redirect выше, чем у обычных базовых правил блокировки. Это означает, что, если есть базовое правило (даже с модификатором$important), $redirect будет иметь над ним преимущество. Если есть белый список (@@) с совпадающим URL, он также заблокирует переадресацию (только если правило $redirect также не отмечено как $important).

примеры redirect
||example.org/script.js$script,redirect=noopjs

Это правило перенаправляет все запросы script.js к ресурсу noopjs.

||example.org/test.mp4$media,redirect=noopmp4-1s

Это правило перенаправляет все запросы example.org/test.mp4 к ресурсу noopmp4-1s.

Больше информации о скриптлетах, редиректах и их использовании доступно в этом разделе GitHub.

Другие правила

Однако возможностей базовых правил может быть недостаточно, чтобы заблокировать рекламу. Иногда для этого требуется скрыть какой-нибудь элемент или изменить часть HTML-кода страницы, при этом ничего не сломав. Для этого предназначены правила, описанные в этом разделе.

Косметические правила

Для работы с косметическими правилами необходимы знания HTML и CSS. Так что если вы хотите научиться самостоятельно составлять такие правила, нужно получить хотя бы базовые навыки владения этими технологиями. Рекомендуем ознакомиться с этой документацией.

Правила скрытия элемeнтов

Правила скрытия элементов предназначены, как это следует из их названия, для скрытия элементов веб-страниц. По сути это аналогично применению стиля { display: none; } к выбранному элементу.

Синтаксис правил скрытия

   rule = [domains] "##" selector
domains = [domain0, domain1[, ...[, domainN]]]
  • selectorCSS-селектор, задающий элементы, которые должны быть скрыты.
  • domains — ограничение на домены, на страницах которых будет применено правило.

Если вы хотите ограничить область действия одним или более доменами, просто перечислите их через запятую. Например: example.org,example.com##selector.

Обратите внимание, что это правило будет работать также на всех поддоменах example.org и example.com.

Если вы хотите запретить действие правила на определенном домене, используйте символ ~ перед именем домена. Например: ~example.org##selector.

Обратите внимание, что вы можете использовать оба подхода в одном правиле. Например, правило example.org,~subdomain.example.org##domain будет работать для домена example.org и всех его поддоменов, кроме subdomain.example.org.

Обратите внимание

Правила скрытия не зависят друг от друга. Если в фильтре есть правило example.org##selector, и вы добавляете правило ~example.org##selector, то оба этих правила будут применены независимо друг от друга.

Примеры правил скрытия

  • example.com##div.textad — скроет элемент div с классом textad на домене example.com и всех его поддоменах.
  • example.com,example.org###adblock - скроет элемент с атрибутом id равным adblock на доменах example.com, example.org и всех их поддоменах.
  • ~example.com##.textad - скроет элемент с классом textad на всех доменах, кроме example.com и всех его поддоменах.

Исключения для правил скрытия

Существует специальный тип правил, "выключающий" отдельные правила скрытия на определенных доменах. Синтаксис таких правил очень похож на обычные правила скрытия, но вместо маркера ## используется #@#.

Например, пусть в фильтре есть следующее правило.

##.textad

Если вы хотите отключить это правило для домена example.com, можно воспользоваться правилом-исключением.

example.com#@#.textad

В некоторых случаях может потребоваться отключение всех запрещающих правил. Например, на время тестирования. Для этого следует воспользоваться правилом исключения без указания домена.

#@#.textad

Применять такие исключения рекомендуется только в случае, когда изменить само правило скрытия не представляется возможным. Во всех остальных случаях лучше изменить исходное правило, используя ограничение на домены.

Правила CSS-стилей

Иногда недостаточно просто скрыть какой-либо элемент, чтобы заблокировать рекламу. Например, блокировка рекламного элемента может просто сломать верстку сайта. Для таких случаев AdGuard позволяет использовать гораздо более гибкие правила, чем обычные правила скрытия. По сути, с помощью таких правил вы можете добавить на страницу любой CSS-стиль.

Ограничения

Запрещено использование стилей, которые могут приводить к загрузке каких-либо ресурсов. По сути это означает, что запрещено использование атрибутов типа <url>.

Синтаксис

   rule = [domains] "#$#" selector "{" style "}"
domains = [domain0, domain1[, ...[, domainN]]]
  • selectorCSS-селектор, задающий элементы, которые должны быть скрыты.
  • domains — ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.
  • style — CSS-стиль, который мы хотим применить к элементам, выбранным selector.

Примеры

example.com#$#body { background-color: #333!important; }

Это правило применит стиль background-color: #333!important; к элементу body для домена example.com и всех его поддоменов.

Исключения

По аналогии с правилами скрытия, существует специальный тип правил, отключающий действие выбранного правила CSS-стилей для определенных доменов. Синтаксис правил-исключений практически такой же, только маркер #$# заменяется на #@$#.

Например, пусть в фильтре есть следующее правило.

#$#.textad { visibility: hidden; }

Если вы хотите отключить это правило для домена example.com, можно воспользоваться правилом-исключением.

example.com#@$#.textad { visibility: hidden; }

Применять такие исключения рекомендуется только в случае, когда изменить само правило CSS-стиля не представляется возможным. Во всех остальных случаях лучше изменить исходное правило, используя ограничение на домены.

Расширенные CSS-селекторы

Возможностей CSS 3.0 не всегда хватает для блокировки рекламы. Чтобы решить эту проблему, AdGuard расширяет возможности CSS, добавляя поддержку новых псевдо-элементов. Для поддержки расширенных CSS-селекторов нами был разработан отдельный модуль с открытым кодом.

Обратная совместимость

В общедоступных фильтрах мы используем так называемый обратно-совместимый синтаксис. Дело в том, что использование расширенных псевдоклассов может помешать применению косметических правил в старых версиях AdGuard или других блокировщиках рекламы, не поддерживающих расширенный CSS. Например, вместо псевдокласса :has(selector) можно использовать атрибут [-ext-has="selector"].

Область применения

Расширенные селекторы можно применять в любом косметическом правиле, будь то правила скрытия или правила CSS стилей.

Синтаксис

Независимо от того, какие CSS-псевдоклассы вы используете в правилах, вы можете использовать специальные маркеры, чтобы эти правила обрабатывались движком "Extended CSS". Рекомендуется использовать эти маркеры для всех косметических расширенных CSS-правил, чтобы их было легче отличить.
Синтаксис расширенных CSS-правил:

  • #?# — для скрытия элементов (#@?# - для исключений)
  • #$?# — для вставки CSS (#@$?# - для исключений)
Примеры
  • 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) — это правило отменяет действие предыдущего правила.

Обратите внимание, что вы можете использовать движок ExtCss для простых селекторов, применяя правило вида:
#?#div

Псевдокласс :has()

Черновик спецификации CSS 4.0 описывает псевдо-элемент :has. К сожалению, пока что он не поддерживается браузерами.

Синтаксис

:has(selector)

Обратно-совместимый синтаксис:

[-ext-has="selector"]

Поддерживаемые синонимы для лучшей совместимости: :-abp-has, :if.

Псевдокласс :has() выбирает те элементы, внутри которых есть элементы, подходящие под selector.

Примеры

Выделение всех элементов div, содержащих элемент с классом banner:

<!-- HTML code -->
<div>Do not select this div</div>
<div>Select this div<span class="banner"></span></div>

Селектор:

div:has(.banner)

Обратно-совместимый синтаксис:

div[-ext-has=".banner"]

Псевдокласс :if-not()

Этот псевдокласс фактически является сокращением от :not(:has()). Он поддерживается ExtendedCSS для лучшей совместимости с некоторыми фильтрами, но не рекомендуется к использованию в фильтрах AdGuard. Обосновывается это тем, что однажды браузеры будет добавлять встроенную поддержку :has, но этого никогда не случится для этого псевдокласса.

Псевдокласс :contains()

Принцип действия этого псевдокласса очень прост: он позволяет выбрать элементы, которые содержат внутри заданный текст, либо чьё содержимое соответствует указанному регулярному выражению. Пожалуйста, обратите внимание, что этот псевдокласс использует свойство элемента textContent для определения соответствия (а не innerHTML).

Синтаксис

// соответствие по обычному тексту
:contains(text)

// соответствие по регулярному выражению
:contains(/regex/i)

Обратно-совместимый синтаксис:

// соответствие по обычному тексту
[-ext-contains="text"]

// соответствие по регулярному выражению
[-ext-contains="/regex/"]

Поддерживаемые синонимы для лучшей совместимости: :-abp-contains, :has-text.

Примеры

Выделение всех элементов div, содержащих текст banner:

<!-- HTML code -->
<div>Do not select this div</div>
<div id="selected">Select this div (banner)</div>
<div>Do not select this div <div class="banner"></div></div>

Селектор:

// соответствие по обычному тексту
div:contains(banner)

// соответствие по регулярному выражению
div:contains(/this .* banner/)

// поддерживаются флаги регулярных выражений
div:contains(/this .* banner/gi)

Обратно-совместимый синтаксис:

// соответствие по обычному тексту
div[-ext-contains="banner"]

// соответствие по регулярному выражению
div[-ext-contains="/this .* banner/"]

Обратите внимание, что в этом примере будет выбран только div с id=selected, так как следующий за ним элемент не содержит текст (banner является частью кода, а не текста).

Псевдокласс :matches-css()

Эти псевдоклассы позволяют выделять элемент по его текущему свойству стиля. Работа этого псевдокласса основана на использовании функции window.getComputedStyle.

Синтаксис

/* element style matching */
selector:matches-css(property-name ":" pattern)

/* ::before pseudo-element style matching */
selector:matches-css-before(property-name ":" pattern)

/* ::after pseudo-element style matching */
selector:matches-css-after(property-name ":" pattern)

Обратно-совместимый синтаксис:

selector[-ext-matches-css="property-name ":" pattern"]
selector[-ext-matches-css-after="property-name ":" pattern"]
selector[-ext-matches-css-before="property-name ":" pattern"]
  • property-name — название CSS свойства, которое будет проверено у элемента
  • pattern — паттерн значений, использующий то же простое соответствие по вайлдкардам как и базовые правила URL-фильтрации ИЛИ регулярное выражение. Для этого типа соответствия AdGuard не обращает внимание на регистр. В случае с регулярными выражениями, паттерн будет выглядеть как /regex/.

Для паттернов, не являющихся регулярными выражениями, символы (,),[,] должны быть экранированы, потому что мы экранируем их в правилах фильтрации.

Для регулярных выражений символы " и \ должны быть экранированы, потому что мы вручную экранируем их в extended-css-selector.js.

Примеры

Выделение всех элементов div, содержащих псевдокласс ::before с указанным содержимым:

<!-- HTML code -->
<style type="text/css">
    #to-be-blocked::before {
        content: "Block me"
    }
</style>
<div id="to-be-blocked" class="banner"></div>
<div id="not-to-be-blocked" class="banner"></div>

Селектор:

// Обычное соответствие
div.banner:matches-css-before(content: block me)

// Регулярные выражения
div.banner:matches-css-before(content: /block me/)

Обратно-совместимый синтаксис:

// Обычное соответствие
div.banner[-ext-matches-css-before="content: block me"]

// Регулярные выражения
div.banner[-ext-matches-css-before="content: /block me/"]

Псевдокласс :matches-attr()

Этот псевдокласс позволяет выделить элемент по его атрибутам, особенно если они рандомизированы и не постоянные.

Синтаксис

selector:matches-attr("name"[="value"])
  • name — название атрибута ИЛИ регулярное выражение для названия атрибута
  • value — необязательно, значение атрибута ИЛИ регулярное выражение для значения атрибута

Для регулярных выражений символы " и \ должны быть экранированы.

Примеры

<!-- HTML code -->
<div id="targer1" class="matches-attr" hsd4jkf-link="ssdgsg-banner_240x400"></div>

<div id="targer2" class="has matches-attr">
  <div data-sdfghlhw="adbanner"></div>
</div>

<div id="targer3-host" class="matches-attr has contains">
  <div id="not-targer3" wsdfg-unit012="click">
    <span>socials</span>
  </div>
  <div id="targer3" hrewq-unit094="click">
    <span>ads</span>
  </div>
</div>

<div id="targer4" class="matches-attr upward">
  <div >
    <inner-afhhw class="nyf5tx3" nt4f5be90delay="1000"></inner-afhhw>
  </div>
</div>
// для div#targer1
div:matches-attr("/-link/")

// для div#targer2
div:has(> div:matches-attr("/data-/"="adbanner"))

// для div#targer3
div:matches-attr("/-unit/"="/click/"):has(> span:contains(ads))

// для div#targer4
*[class]:matches-attr("/.{5,}delay$/"="/^[0-9]*$/"):upward(2)

Псевдокласс :matches-property()

Этот псевдокласс позволяет выделить элемент по его свойствам.

Синтаксис

selector:matches-property("name"[="value"])
  • name — название свойства ИЛИ регулярное выражение для названия свойства
  • value — необязательно, значение свойства ИЛИ регулярное выражение для значения свойства

Для регулярных выражений символы " и \ должны быть экранированы.

name поддерживает регулярные выражения для обозначения свойства в цепи, например, prop./^unit[\\d]{4}$/.type

Примеры

divProperties = {
    id: 1,
    check: {
        track: true,
        unit_2ksdf1: true,
    },
    memoizedProps: {
        key: null,
        tag: 12,
        _owner: {
            effectTag: 1,
            src: 'ad.com',
        },
    },
};
// элемент с такими свойствами может быть выделен любым из таких правил:

div:matches-property("check.track")

div:matches-property("check./^unit_.{4,6}$/"))

div:matches-property("memoizedProps.key"="null")

div:matches-property("memoizedProps._owner.src"="/ad/")
Для разработчиков фильтров Чтобы проверить свойства элемента, нужно: 1. Выбрать нужный элемент во вкладке Elements. 2. В Консоли выполнить команду `console.dir($0)`.

Псевдокласс :xpath()

Этот псевдокласс позволяет выбирать элементы согласно Xpath выражению.

Может быть только в конце выражения, за исключением использования псевдокласса :remove().

Этот псевдокласс отличается от других тем, что он может использоваться не только для фильтрации текущей выборки элементов, но и для расширения или создания новой. По этой причине selector является необязательным параметром. Например, выражение :xpath() может использоваться для выбора всех родительских элементов, что невозможно было бы сделать с помощью css-селекторов.

Синтаксис

[selector]:xpath(expression)
  • selector- необязательно, CSS-селектор
  • expression — XPath выражение

Примеры

// Фильтрация результатов выборки селектора
div:xpath(//*[@class="test-xpath-class"])
div:has-text(/test-xpath-content/):xpath(../../..)

// Использование xpath для выборки элементов
facebook.com##:xpath(//div[@id="stream_pagelet"]//div[starts-with(@id,"hyperfeed_story_id_")][.//h6//span/text()="People You May Know"])

Псевдокласс :nth-ancestor()

Этот псевдокласс позволяет выбирать родительские элементы указанного n-поколения относительно элемента.

Это своего рода эквивалент :xpath(..[/..]*).

Может быть только в конце выражения, за исключением использования псевдокласса :remove().

Синтаксис

selector:nth-ancestor(n)
  • selector — CSS-селектор
  • n — натуральное число от 1 до 255, количество поколений от выбранного элемента

Примеры

div.test:nth-ancestor(4)

div:has-text(/test/):nth-ancestor(2)

Псевдокласс :upward()

Этот псевдокласс позволяет выбирать ближайшие родительские элементы относительно указанного элемента.

Может быть только в конце выражения, за исключением использования псевдокласса :remove().

Синтаксис

/* параметр в виде селектора */
subjectSelector:upward(targetSelector)

/* параметр в виде числа */
subjectSelector:upward(n)
  • subjectSelector — CSS-селектор — элемент, относительно которого будет искаться родительский элемент
  • targetSelector — CSS-селектор — условный родительский элемент
  • n — натуральное число от 1 до 255, количество поколений от выбранного элемента

Примеры

div.child:upward(div[id])
div:contains(test):upward(div[class^="parent-wrapper-")

div.test:upward(4)
div:has-text(/test/):upward(2)

Псевдокласс :remove() и псевдо-свойство remove

Иногда необходимо именно удалить определенный элемент, а не просто скрыть его или применить какие-либо правила стиля. В таких случаях можно использовать псевдокласс:remove() или псевдо-свойство remove.

Псевдо-класс :remove() может быть только в конце выражения.

Синтаксис

! псевдокласс
selector:remove()

! псевдо-свойство
selector { remove: true; }
  • selector — CSS-селектор

Примеры

div.inner:remove()
div:has(> div[ad-attr]):remove()
div:xpath(../..):remove()

div:contains(target text) { remove: true; }
div[class]:has(> a:not([id])) { remove: true; }

Пожалуйста, обратите внимание, если используется псевдокласс :remove() или псевдо-свойство remove, то другие свойства этого стиля будут проигнорированы.

Режим отладки селекторов

Иногда вам может понадобиться проверить работу того или иного селектора или стиля. Чтобы сделать это без прямого взаимодействия с javascript, вы можете воспользоваться особым свойством стиля debug. Когда ExtendedCss сталкивается с этим свойством, он включает режим отладки, либо для отдельного селектора, либо для всех селекторов — в зависимости от значения debug.

Отладка отдельного селектора

#$#.banner { display: none; debug: true; }

Включение глобальной отладки

#$#.banner { display: none; debug: global; }

Тестирование расширенных селекторов

Чтобы загрузить ExtendedCss на текущую страницу, скопируйте и запустите в браузерной консоли следующий код:

!function(E,x,t,C,s,s_){C=E.createElement(x),s=E.getElementsByTagName(x)[0],C.src=t,
C.onload=function(){alert('ExtCss loaded successfully')},s.parentNode.insertBefore(C,s)}
(document,'script','https://AdguardTeam.github.io/ExtendedCss/extended-css.min.js')

Как вариант, установите пользовательский скрипт "ExtendedCssDebugger": https://github.com/AdguardTeam/Userscripts/blob/master/extendedCssDebugger/extended-css.debugger.user.js

Вы теперь можете использовать конструктор ExtendedCss в глобальном масштабе, а его метод ExtendedCss.query — как document.querySelectorAll.

var selectorText = "div.block[-ext-has='.header:matches-css-after(content: Anzeige)']";

ExtendedCss.query(selectorText) // returns an array of Elements matching selectorText

Правила фильтрации HTML

В большинстве случаев достаточно использовать базовые и косметические правила. Но иногда для фильтрации рекламы необходимо изменять HTML-код самой страницы до того, как он будет загружен браузером. Для того чтобы сделать это, применяются правила фильтрации HTML-контента. Они позволяют указать, какие HTML-элементы необходимо вырезать из страницы перед тем, как страница попадет в браузер.

Совместимость

Правила поддерживаются приложениями AdGuard для Windows, Mac, Android и расширением AdGuard для Firefox.
Правила этого типа не работают в расширениях для других браузеров, т.к. они не могут модифицировать контент на сетевом уровне.

Синтаксис

      rule = [domains] "$$" tagName [attributes]
   domains = [domain0, domain1[, ...[, domainN]]]      
attributes = "[" name0 = value0 "]" "[" name1 = value2 "]" ... "[" nameN = valueN "]"
  • tagName — имя элемента в нижнем регистре, например, div или script.
  • domains — ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.
  • attributes — список атрибутов, ограничивающих выбор элементов. name - название атрибута, value - подстрока, которая содержится в значении атрибута.

Примеры

HTML code

<script data-src="/banner.js"></script>

Правило

example.org$$script[data-src="banner"]

Это правило удалит из кода страниц все элементы script со значением data-src, содержащим подстроку banner. При этом правило будет работать только для домена example.org и всех его поддоменов.

Специальные атрибуты

Помимо обычных атрибутов, значение которых проверяется у каждого элемента, существует набор специальных атрибутов правила, которые изменяют способ работы правила. Ниже мы перечислим все эти атрибуты.

tag-content

Пожалуй, наиболее часто используемый специальный атрибут. Он ограничивает выбор теми элементами, внутренний HTML код которых (innerHTML) содержит указанную подстроку.

Используйте "" для экранирования ", например:
$$script[tag-content="alert(""this is ad"")"]

Например, рассмотрим такой HTML код:

<script type="text/javascript">
    document.write('<div>banner text</div>" />');
</script>

Следующее правило удалит со страницы все элементы script, код которых содержит подстроку banner.

$$script[tag-content="banner"]

Вложенные элементы

Если мы имеем дело с несколькими вложенными друг в друга элементами, каждый из которых подходит под одно и то же правило фильтрации HTML-контента, то удалены будут все эти элементы.

wildcard

Этот специальный атрибут работает практически также как tag-content и позволяет проверить внутренний HTML-код элемента. Правило проверит, удовлетворяет ли HTML-код элемента заданному шаблону поиска.

Используйте "" для экранирования ", например:
$$script[wildcard=""banner""]

Возьмем для примера следующее правило:
$$script[wildcard="*banner*text*"]

Оно проверит, что код элемента содержит две последовательные подстроки banner и text.

max-length

Задает максимальную длину содержимого HTML-элемента. Если этот параметр задан, и длина содержимого превышает заданное значение — правило не применяется к элементу.

Значение по умолчанию

Если этот параметр не задан, то max-length считается равным 8192.

Например, возьмем следующее правило:

$$div[tag-content="banner"][max-length="400"]

Это правило удалит все элементы div, код которых содержит подстроку banner, и длина которых не превышает 400 символов.

min-length

Задает минимальную длину содержимого HTML-элемента. Если этот параметр задан, и длина содержимого меньше заданного значения — правило не применяется к элементу.

Например, возьмем следующее правило:

$$div[tag-content="banner"][min-length="400"]

Это правило удалит все элементы div, код которых содержит подстроку banner, и длина которых превышает 400 символов.

Исключения для правил фильтрации HTML

По аналогии с правилами скрытия, существует специальный тип правил, отключающий действие выбранного правила фильтрации HTML для определенных доменов. Синтаксис правил-исключений такой же, только маркер $$ заменяется на $@$.

Например, пусть в фильтре есть следующее правило.

$$script[tag-content="banner"]

Если вы хотите отключить это правило для домена example.com, можно воспользоваться правилом-исключением.

example.com$@$script[tag-content="banner"]

В некоторых случаях может потребоваться отключение всех запрещающих правил. Например, на время тестирования. Для этого следует воспользоваться правилом исключения без указания домена.

$@$script[tag-content="banner"]

Применять такие исключения рекомендуется только в случае, когда изменить само правило скрытия не представляется возможным. Во всех остальных случаях лучше изменить исходное правило, используя ограничение на домены.

JavaScript-правила

AdGuard поддерживает специальный тип правил, позволяющий вставить любой javascript-код на страницы интернет-сайтов.

Ограничения

Обратите внимание, что этот тип правил может быть использован только в доверенных фильтрах. В эту категорию попадает ваш собственный пользовательский фильтр, и фильтры, которые создаются командой AdGuard.

Синтаксис

rule = [domains]  "#%#" script
  • domains — ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.
  • script — произвольный javascript-код в одну строку.

Примеры

  • example.org#%#window.__gaq = undefined; — выполняет код window.__gaq = undefined; на всех страницах сайта example.org и всех его поддоменах.

Исключения

По аналогии с правилами скрытия, существует специальный тип правил, отключающий действие выбранного javascript правила для определенных доменов. Синтаксис правил-исключения такой же, только маркер #%# заменяется на #@%#.

Например, пусть в фильтре есть следующее правило.

#%#window.__gaq = undefined;

Если вы хотите отключить это правило для домена example.com, можно воспользоваться правилом-исключением.

example.com#@%#window.__gaq = undefined;

В некоторых случаях может потребоваться отключение всех запрещающих правил. Например, на время тестирования. Для этого следует воспользоваться правилом исключения без указания домена.

#@%#window.__gaq = undefined;

Применять такие исключения рекомендуется только в случае, когда изменить само правило скрытия не представляется возможным. Во всех остальных случаях лучше изменить исходное правило, используя ограничение на домены.

Скриптлеты

Скриптлет — это функция JavaScript, которая предоставляет расширенные возможности для блокирования контента. Эта функции могут использоваться в декларативной манере в правилах фильтрации AdGuard.

AdGuard поддерживает множество различных криптлетов. Пожалуйста, обратите внимание, что для того, чтобы добиться совместимости между различными блокировщиками, мы также поддерживаем синтаксис uBO и ABP.

Синтаксис

rule = [domains]  "#%#//scriptlet(" scriptletName arguments ")"

scriptletName (обязательно) — это имя скриптлета из библиотеки скриптлетов AdGuard
arguments (опционально) — это список аргументов в формате String (другие типы аргументов не поддерживаются)

Примеры

example.org#%#//scriptlet("abort-on-property-read", "alert")

Это правило применится на страницах домена example.org (и его поддоменов) и выполнит скриптлет "abort-on-property-read" с параметром "alert".

[$app=com.apple.Safari]example.org#%#//scriptlet('prevent-setInterval', 'check', '!300')

Это правило применит соответствующий скриптлет только в браузере Safari на Mac.

Больше информации о редиректах можно найти на GitHub.

Модификаторы

Вы можете изменить поведение косметического правила, используя модификаторы, описанные ниже.

Синтаксис

rule = "[$" modifiers "]" [rule text]
modifiers = modifier0[, modifier1[, ...[, modifierN]]]
  • modifier — группа модификаторов, описанных ниже.
  • rule text — косметическое правило, которое нужно модифицировать.

Например: [$domain=example.com,app=test_app]##selector.

В значениях модификаторов следующие символы должны быть экранированы: [, ], , и \ (если он не используется для экранирования). Используйте \, чтобы экранировать их. Например, экранированная скобка выглядит так: \].

app

Модификатор app ограничивает действие правила до конкретного приложения (или списка приложений).
Поведение и синтаксис модификатора полностью совпадают с соответствующим модификатором $app для базовых правил.

Примеры использования app:

  • [$app=org.example.app]example.com##.textad — скрывает div и заменяет его на класс textad на example.com и всех поддоменах в запросах, посланных из org.example.app приложения Android.
  • [$app=~org.example.app1|~org.example.app2]example.com##.textad — скрывает div и заменяет его на класс textad на example.com и всех поддоменах в запросах, посланных из любого приложения кроме org.example.app1 и org.example.app2.
  • [$app=org.example.app]#@#.textad — отключит все правила ##.textad для всех доменов при использовании приложения org.example.app.

domain

Модификатор domain ограничивает область действия правила списком доменов (и их поддоменов).
Поведение и синтаксис модификатора полностью совпадают с соответствующим модификатором $domain из базовых правил.

Примеры использования domain:

  • [$domain=example.com]##.textad — скрывает div и заменяет его на класс textad на example.com и всех поддоменах.
  • [$domain=example.com|example.org]###adblock — скрывает элемент с атрибутом id, равным adblock, на example.com, example.org и всех поддоменах.
  • [$domain=~example.com]##.textad — скрывает div и заменяет его на класс textad на всех доменах кроме example.com и его поддоменов.

Пожалуйста, обратите внимание, что существует 2 способа указать доменные ограничения для косметических правил:
1) «классический»: обозначить ограничение на домены перед маской и атрибутами правила: example.com##.textad;
2) с помощью модификаторов: обозначить ограничение на домены через модификатор domain: [$domain=example.com]##.textad.

Но правила, в которых используется смешанный стиль ограничения на домены, считаются некорректными. Так, например, правило [$domain=example.org]example.com##.textad будет отклонено.

Редиректы

AdGuard может перенаправлять веб-запросы к локальному "ресурсу".

Синтаксис

AdGuard использует тот же синтаксис правил фильтрации, что и uBlock Origin. Кроме того, он совместим с модификатором $rewrite=abp-resource AdblockPlus.

$redirect — это модификатор для базовых правил фильтрации, так что правила с этим модифиактором поддерживают все другие базовые модификаторы, такие, как $domain, $third-party, $script и т.д.

Значение модификатора $redirect должно быть именем ресурса, который будет использоваться для редиректа.

Приоритет $redirect-правил выше, чем приоритет обычных базовых правил. Это означает, что если есть базовое правило фильтрации (даже с модификатором $important), то правило с модификатором $redirect будет применяться раньше него. Если этому же URL соответствует правило-исключение (@@), то оно отменит редирект (если только $redirect-правило также не помечено как $important).

Примеры

||example.org/script.js$script,redirect=noopjs

Это правило перенаправляет все запросы к script.js на ресурс с названием noopjs.

||example.org/test.mp4$media,redirect=noopmp4-1s

Это правило перенаправляет все запросы к example.org/test.mp4 на ресурс с названием noopmp4-1s.

Дополнительная информация о скриптлетах, редиректах и их использовании доступна в соответствующем разделе на GitHub.

Информация для разработчиков фильтров

Если вы разрабатываете сторонний фильтр, известный AdGuard, вам может быть интересна информация, представленная в настоящем разделе. Пожалуйста, имейте в виду, что специальные комментарии hint будут применяться только к зарегистрированным фильтрам. Фильтр считается зарегистрированным и известным AdGuard, если он присутствует в перечне известных фильтров. Если вы желаете зарегистрировать свой фильтр, пожалуйста, направьте запрос в репозиторий AdGuardFilters.

Директивы пре-процессинга

Мы предоставляем несколько директив пре-процессинга, которые могут быть использованы разработчиками фильтров для улучшения совместимости с различными блокировщиками рекламы. Директивы могут

Любая ошибка в пре-процессинговой директиве приведёт к невозможности обновить фильтр, как если бы URL фильтра был недоступен.

Директивы пре-процессинга можно использовать в Пользовательских правилах в собственных (кастомных) фильтрах.

Включение файла

Директива !#include позволяет включать в фильтр содержимое заданного файла. Она поддерживает только файлы из того же источника, чтобы удостовериться, что разработчик фильтров является владельцем указанного файла. Включённый файл также может содержать директивы пре-процессинга (даже другие !#include директивы). Блокировщики должны принимать во внимание случай рекурсивного использования !#include и внедрять защитный механизм.

Синтаксис

!#include file_path
  • file_path — абсолютный (того же источника) или относительный путь к файлу

Если включённый файл не найден или недоступен, не будут работать обновления всего фильтра.

Для локальных собственных фильтров ограничение на тот же источник не распространяется.

Примеры

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

Условия

Разработчики фильтров могут использовать условия, чтобы подставлять нужные правила, в зависимости от типа блокировщика. Когда блокировщик рекламы сталкивается с директивой !#if, за которой затем следует директива !#endif, он скомпилирует код внутри блока, только если выполнено указанное условие. Условие поддерживает базовые логические операторы.

Директива с условием, начинающаяся с директивы !#if, должна явно прерываться директивой !#endif.

Пробелы имеют значение. !#if — это корректная директива, в то время как !# if — нет.

Синтаксис

!#if (conditions)
rules_list
!#endif
  • !#if (conditions) — начало блока
  • conditions — точно так же, как и в случае с некоторыми популярными языками программирования, условия пре-процессинга основаны на константах, объявляемых блокировщиками. Разработчики блокировщиков самостоятельно определяют, какие именно константы объявлять. Возможные значения:
    • adguard — объявляется всегда; даёт разработчикам фильтров понять, что это один из продуктов AdGuard; должно быть достаточно в 95% случаев
    • специфичные для конкретных продуктов константы, которые нужны в редких случаях, когда правило должно работать (или не работать — тогда перед константой используйте !) только для конкретного продукта:
    • adguard_app_windows — AdGuard для Windows
    • adguard_app_mac — AdGuard для Mac
    • adguard_app_android — AdGuard для Android
    • adguard_app_ios — AdGuard для iOS
    • adguard_ext_safari — AdGuard для Safari
    • adguard_ext_chromium — Браузерное расширение AdGuard для Chrome (и браузеров на базе Chromium, например, новый Microsoft Edge)
    • adguard_ext_firefox — Браузерное расширение AdGuard для Firefox
    • adguard_ext_edge — Браузерное расширение AdGuard для Edge Legacy
    • adguard_ext_opera — Браузерное расширение AdGuard для Opera
    • adguard_ext_android_cb — AdGuard Content Blocker для мобильных браузеров Samsung и Yandex
    • ext_ublock — особый случай; эта константа объявляется, когда версия фильтра для ublock компилируется при помощи FiltersRegistry
  • 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

Влияние на блокировщик контента Safari

В Safari существует строгое ограничение в 50 тысяч правил на один блокировщик контента. Но в AdGuard для Safari и в AdGuard для iOS максимальное число поддерживаемых правил увеличено до 300 тысяч. Это получилось благодаря условному их разделению на несколько блокировщиков контента. В целом, отдельные категории фильтров более-менее незавизимы, поэтому они поделены между блокировщиками контента следующим образом:

  • AdGuard General — Блокировка рекламы, Языковые
  • AdGuard Privacy — Антитрекинг
  • AdGuard Social — Виджеты социальных сетей, Раздражители
  • AdGuard Security — Безопасность
  • AdGuard Other — Другие
  • AdGuard Custom — Собственные

Пользователькие правила и Белый список добавляются в каждый блокировщик контента.

Главным недостатком использования нескольких блокировщиков контента является то, что они не могут работать вместе и ссылаться в своих правилах фильтрации друг на друга. И из-за этого бывают весьма неожиданные проблемы. Чтобы избежать этого и заставить правила внутри блока (из одного блокировщика) применяться вместе с правилами из другого блокировщика контента, разработчики фильтров могут использовать директиву !#safari_cb_affinity.

Синтаксис

!#safari_cb_affinity(content_blockers)
rules_list
!#safari_cb_affinity
  • !#safari_cb_affinity(content_blockers) — начало блока
  • content_blockers — список блокировщиков контента, разделенные запятой. Возможные значения:
    • general — блокировщик контента AdGuard General
    • privacy — блокировщик контента AdGuard Privacy
    • social — блокировщик контента AdGuard Social
    • security — блокировщик контента AdGuard Security
    • other — блокировщик контента AdGuard Other
    • custom — блокировщик контента AdGuard Custom
    • all — особое ключевое слово, что значит применение правил ко всем блокировщикам контента
  • rules_list — список правил
  • !#safari_cb_affinity(content_blockers) — конец блока

Примеры

! чтобы не-скрывать указанный элемент, который скрывается Базовым фильтром:
!#safari_cb_affinity(general)
example.org#@#.adBanner
!#safari_cb_affinity
! чтобы разблокировать запрос, который блокируется Фильтр счетчиков и систем аналитики:
!#safari_cb_affinity(privacy)
@@||example.org^
!#safari_cb_affinity

Hints

"Hint" - это специальный комментарий, инструкция для компилятора фильтров, работающего на стороне сервера (см. FiltersRegistry).

Синтаксис Hints

!+ HINT_NAME1(PARAMS) HINT_NAME2(PARAMS)

Обратите внимание: вы можете использовать несколько комментариев hint.

NOT_OPTIMIZED hint

Для каждого фильтра AdGuard существуют две версии: полная и оптимизированная. Оптимизированная версия имеет намного меньший объем и не включает правила, которые не используются совсем или используются редко.

Частота использования правил определяется собранной статистикой по рекламным фильтрам. Но оптимизация основана также на исходной конфигурации для каждого фильтра. Например, вот так это выглядит для Базового фильтра:

"filter": Базовый фильтр AdGuard,
"percent": 30,
"minPercent": 20,
"maxPercent": 40,
"strict": true

Где:

  • filter — идентификатор фильтра
  • percent — ожидаемый процент оптимизации ~= (количество правил в оптимизированном фильтре) / (количество правил в исходном фильтре) * 100
  • minPercent — нижняя граница значения percent
  • maxPercent — верхняя граница значения percent
  • strict — если percent < minPercent ИЛИ percent > maxPercent и включен режим strict, то компиляция фильтра должна завершиться неудачно, в противном случае должны использоваться оригинальные правила

Иными словами, percent это "уровень сжатия". Например, для Базового фильтра он настроен на 40%. Это значит, что алгоритм оптимизации удалит 60% правил.

В итоге, вот так выглядят версии Базового фильтра для браузерного расширения AdGuard:

  • полная: https://filters.adtidy.org/extension/chromium/filters/2.txt
  • оптимизированная: https://filters.adtidy.org/extension/chromium/filters/2_optimized.txt

Важно: Если вы хотите добавить правило, которое не должно удаляться при оптимизации, используйте хинт NOT_OPTIMIZED:

!+ NOT_OPTIMIZED
||example.org^

А такое правило не будет оптимизировано только для ОС Android:

!+ NOT_OPTIMIZED PLATFORM(android)
||example.org^

PLATFORM и NOT_PLATFORM hints

Записи этого типа позволяют указывать системную платформу, для которой применяется правило. Ниже представлен список используемых платформ:

Примеры:

Это правило будет действовать только для Windows, Mac и Android:

!+ PLATFORM(windows,mac,android)
||example.org^

Это правило будет действовать для всех платформ за исключением расширения Safari, iOS, и Android:

!+ NOT_PLATFORM(ext_safari, ext_android_cb, ios)
||example.org^

Удачи в составлении своих фильтров!

Желаем вам удачи в составлении собственных фильтров.

Если вы хотите спросить совета о том, как правильно составлять фильтры, на нашем форуме есть специальный раздел, посвященный написанию собственных правил.