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

• Введение
• Комментарии
• Примеры
  • Блокировка по имени домена
  • Блокировка конкретного адреса
  • Базовые модификаторы правил
  • Разблокировка адреса
  • Разблокировка всего сайта
  • Косметические правила
    • Популярные CSS селекторы
• Базовые правила
  • Синтаксис базовых правил
  • Специальные символы
  • Поддержка регулярных выражений
  • Поддержка wildcard для TLD
  • Примеры базовых правил
  • Модификаторы
    • Базовые модификаторы
      • $domain
      • $third-party
      • $popup
      • $match-case
    • Ограничение по типу контента
      • Примеры ограничений
      • $image
      • $stylesheet
      • $script
      • $object
      • $object-subrequest
      • $font
      • $media
      • $subdocument
      • $xmlhttprequest
      • $websocket
      • $other
    • Модификаторы правил-исключений
      • $elemhide
      • $content
      • $jsinject
      • $urlblock
      • $extension
      • $document
      • $stealth
      • Generic правила
        • $generichide
        • $genericblock
  • Расширенные возможности
    • $important
    • $badfilter
    • $empty
    • $mp4
    • $replace
    • $csp
    • $cookie
    • $network
    • $app
• Косметические правила
  • Правила скрытия элементов
    • Синтаксис правил скрытия
    • Примеры правил скрытия
    • Исключения для правил скрытия
  • Правила CSS стилей
    • Синтаксис правил CSS стилей
    • Примеры правил CSS стилей
    • Исключения для правил CSS стилей
  • Расширенные CSS селекторы
    • Псевдо-класс :has()
    • Псевдо-класс :if-not()
    • Псевдо-класс :contains()
    • Псевдо-класс :matches-css()
    • Режим отладки селекторов
    • Тестирование расширенных селекторов
• Правила фильтрации HTML
  • Синтаксис правил фильтрации HTML
  • Примеры правил фильтрации HTML
  • Специальные атрибуты
    • tag-content
    • wildcard
    • max-length
    • min-length
  • Исключения для правил фильтрации HTML
• Javascript правила
  • Синтаксис javascript правил
  • Примеры javascript правил
  • Исключения для javascript правил
• Информация для разработчиков фильтров
  • Директивы пре-процессора
  • Hints
    • Синтаксис Hints
    • NOT_OPTIMIZED hint
    • PLATFORM и NOT_PLATFORM hints
• Удачи в составлении своих фильтров!

Введение

Фильтр — это набор правил фильтрации рекламного контента (баннеров, всплывающих окон и тому подобного). Вместе с 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.org/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").

Поддержка wilcard для доменов верхнего уровня (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).

xmlhttprequest

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

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

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

websocket

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

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, AdGuard для Mac и AdGuard для Android. В будущем мы планируем добавить его во все продукты AdGuard. В продуктах без поддержки модуля "Антитрекинг" правила с этим модификатором игнорируются.

Примеры stealth

• @@||example.com^$stealth — полностью отключает модуль Антитрекинг для всех страниц на домене 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 и всех его поддоменах.

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

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

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 - используйте имя процесса (например, firefox-bin).

Примеры использования 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.

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

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

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

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

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

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

   rule = [domains] "##" selector
domains = [domain0, domain1[, ...[, domainN]]]

• selector — CSS селектор, задающий элементы, которые должны быть скрыты.
• 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##.textad — скроет элемент div с классом textad на домене example.com и всех его поддоменах.
• example.com,example.org###adblock - скроет элемент с атрибутом id равным adblock на доменах example.com, example.org и всех их поддоменах.
• ~example.com##.textad - скроет элемент div с классом textad на всех доменах, кроме example.com и всех его поддоменах.

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

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

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

##.textad

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

example.com#@#.textad

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

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

Правило-исключение без указания конкретных доменов не имеет смысла и будет проигнорировано.

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

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

Ограничения

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

Синтаксис правил CSS стилей

   rule = [domains] "#$#" selector "{" style "}"
domains = [domain0, domain1[, ...[, domainN]]]

• selector — CSS селектор, задающий элементы, которые должны быть скрыты.
• domains — ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.
• style — CSS стиль, который мы хотим применить к элементам, выбранным selector.

Примеры правил CSS стилей

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

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

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

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

Независимо от того, какие CSS псевдо-классы вы используете в правилах, вы можете использовать специальные маркеры, чтобы эти правила обрабатывались движком "Extended CSS". Рекомендуется использовать эти маркеры для всех косметических расширенных 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()

:has(selector)

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

[-ext-has="selector"]

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

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

Примеры :has()

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

HTML код

<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()

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

Синтаксис :contains()

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

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

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

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

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

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

Примеры :contains()

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

HTML код

<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[-ext-contains="banner"]

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

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

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

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

Синтаксис :matches-css()

/* 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.

Примеры :matches-css()

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

HTML код

<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/"]

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

Иногда вам может понадобиться проверить работу того или иного селектора или стиля. Чтобы сделать это без прямого взаимодействия с 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.
Правила этого типа не работают в расширениях для других браузеров, т.к. они не могут модифицировать контент на сетевом уровне.

Синтаксис правил фильтрации HTML

      rule = [domains] "$$" tagName [attributes]
   domains = [domain0, domain1[, ...[, domainN]]]      
attributes = "[" name0 = value0 "]" "[" name1 = value2 "]" ... "[" nameN = valueN "]"

• tagName — имя элемента в нижнем регистре, например, div или script.
• domains — ограничение на домены, на страницах которых будет применено правило. Строится по тем же правилам, что и в случае правил скрытия элементов.
• attributes — список атрибутов, ограничивающих выбор элементов. name - название атрибута, value - подстрока, которая содержится в значении атрибута.

Примеры правил фильтрации HTML

HTML code

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

Правило

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

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

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

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

tag-content

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

Например, рассмотрим такой 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*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"]

Javascript правила

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

Ограничения

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

Синтаксис javascript правил

rule = [domains]  "#%#" script

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

Примеры javascript правил

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

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

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

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

#%#window.__gaq = undefined;

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

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

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

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

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

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

Синтаксис

!#if условие
Здесь можно указать что угодно
!#include URL_или_относительный_путь
!#endif

• !#if, !#endif -- разработчики фильтров могут использовать эти условия, чтобы подставлять нужные правила, в зависимости от типа блокировщика.
• condition -- точно так же, как и в случае с некоторыми популярными языками программирования, условия пре-процессинга основаны на константах, объявляемых блокировщиками. Разработчики блокировщиков самостоятельно определяют, какие именно константы объявлять.
• !#include -- эта директива позволяет включать в фильтр содержимое заданного файла.

Условия

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

Пример:

!#if (adguard && !adguard_ext_safari)
||example.org^$third-party
!#endif

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

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

Блокировщики должны принимать во внимание случай рекурсивного использования !#include и внедрять защитный механизм.

Примеры

URL фильтра: https://example.org/path/filter.txt

!
! Корректный (тот же источник):
!#include https://example.org/path/includedfile.txt
!
! Корректный (относительный путь):
!#include /includedfile.txt
!#include ../path2/includedfile.txt
!
! Некорректный (другой источник):
!#include https://example.com/path/includedfile.txt

Заметки

• Если включённый файл не найден или недоступен, не будут работать обновления всего фильтра.
• Директива с условием, начинающаяся с директивы !#if, должна явно прерываться директивой !#endif.
• Пробелы имеют значение. !#if — это корректная директива, в то время как !# if — нет.

Специфика AdGuard

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

Какие константы мы объявляем

• adguard -- объявляется всегда. Она даёт разработчикам фильтров занть, что это один из продуктов AdGuard. Этого должно быть достаточно в 95% случаев.

Константы, специфичные для конкретных продуктов, которые нужны в редких случаях, когда правило должно работать (или не работать) только для конкретного продукта:

• adguard_app_windows -- AG для Windows
• adguard_app_mac -- AG для Mac
• adguard_app_android -- AG для Android
• adguard_app_ios -- AG для iOS
• adguard_ext_chromium -- Браузерное расширение AG для Chrome
• adguard_ext_firefox -- Браузерное расширение AG для Firefox
• adguard_ext_edge -- Браузерное расширение AG для Edge
• adguard_ext_safari -- Браузерное расширение AG для Safari
• adguard_ext_opera -- Браузерное расширение AG для Opera
• adguard_ext_android_cb -- Блокировщик контента AG для браузеров Samsung/Яндекс

Особый случай: ext_ublock. Эта константа объявляется, когда версия фильтра для ublock компилируется при помощи FiltersRegistry.

Hints

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

Синтаксис Hints

!+ HINT_NAME1(PARAMS) HINT_NAME2(PARAMS)

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

NOT_OPTIMIZED hint

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

Пример оптимизированной версии английского фильтра представлен по следующей ссылке: https://filters.adtidy.org/extension/edge/filters/2_optimized.txt.

Примеры:

Это правило не будет оптимизировано:

!+ NOT_OPTIMIZED
||example.org^

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

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

PLATFORM и NOT_PLATFORM hints

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

• windows - Пример: английский фильтр для Windows - https://filters.adtidy.org/windows/filters/2.txt

• mac - Пример: английский фильтр для Mac - https://filters.adtidy.org/mac_v2/filters/2.txt

• android - Пример: английский фильтр для Android - https://filters.adtidy.org/android/filters/2.txt

• ios - Пример: английский фильтр для iOS - https://filters.adtidy.org/ios/filters/2.txt

• ext_chromium - Пример: расширение AdGuard для браузера Chrome - https://filters.adtidy.org/extension/chromium/filters/2.txt

• ext_ff - Пример: расширение AdGuard для браузера Firefox - https://filters.adtidy.org/extension/firefox/filters/2.txt

• ext_edge - Пример: расширение AdGuard для браузера Edge - https://filters.adtidy.org/extension/edge/filters/2.txt

• ext_opera - Пример: расширение AdGuard для браузера Opera - https://filters.adtidy.org/extension/opera/filters/2.txt

• ext_ublock - Пример: uBlock Origin - https://filters.adtidy.org/extension/ublock/filters/2.txt

• ext_safari - Пример: расширение AdGuard для браузера Safari - https://filters.adtidy.org/extension/safari/filters/2.txt

• ext_android_cb - Пример: AdGuard Content Blocker - https://filters.adtidy.org/extension/android-content-blocker/filters/2.txt

Примеры:

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

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

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

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

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

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

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