@adguard/agtree
Version:
Tool set for working with adblock filter lists
150 lines (147 loc) • 7.01 kB
JavaScript
/*
* AGTree v3.2.1 (build date: Wed, 28 May 2025 13:36:39 GMT)
* (c) 2025 Adguard Software Ltd.
* Released under the MIT license
* https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
*/
import { ListNodeType, ListItemNodeType } from '../../../nodes/index.js';
import { createModifierNode } from '../../../ast-utils/modifiers.js';
import { RegExpUtils } from '../../../utils/regexp.js';
import { ADG_PATH_MODIFIER, ADG_URL_MODIFIER, COMMA_DOMAIN_LIST_SEPARATOR, ADG_DOMAINS_MODIFIER, PIPE_MODIFIER_SEPARATOR, ADG_APP_MODIFIER, UBO_MATCHES_PATH_OPERATOR, OPEN_SQUARE_BRACKET, CLOSE_SQUARE_BRACKET, ESCAPE_CHARACTER } from '../../../utils/constants.js';
import { StringUtils } from '../../../utils/string.js';
import { MultiValueMap } from '../../../utils/multi-value-map.js';
import { clone } from '../../../utils/clone.js';
import { createConversionResult } from '../../base-interfaces/conversion-result.js';
import 'json5';
import 'sprintf-js';
import '@adguard/css-tokenizer';
import { DomainListParser } from '../../../parser/misc/domain-list-parser.js';
import '../../../parser/css/balancing.js';
import '../../data/css.js';
import 'tldts';
import 'is-ip';
/**
* @file Cosmetic rule modifier converter from ADG to uBO
*/
/**
* Regular expression pattern for matching the main page
* https://github.com/gorhill/uBlock/wiki/Procedural-cosmetic-filters#subjectmatches-patharg
*/
const UBO_MAIN_PAGE_MATCHER = '/^/$/';
/**
* Special characters in modifier regexps that should be escaped
*/
const SPECIAL_MODIFIER_REGEX_CHARS = new Set([
OPEN_SQUARE_BRACKET,
CLOSE_SQUARE_BRACKET,
COMMA_DOMAIN_LIST_SEPARATOR,
ESCAPE_CHARACTER,
]);
/**
* Helper class for converting cosmetic rule modifiers from ADG to uBO
*/
class UboCosmeticRuleModifierConverter {
/**
* Converts a ADG cosmetic rule modifier list to uBO, if possible.
*
* @param modifierList Cosmetic rule modifier list node to convert
* @returns An object which follows the {@link ConversionResult} interface. Its `result` property contains
* the converted node, and its `isConverted` flag indicates whether the original node was converted.
* If the node was not converted, the result will contain the original node with the same object reference
* @throws If the modifier list cannot be converted
* @see {@link https://github.com/gorhill/uBlock/wiki/Procedural-cosmetic-filters#cosmetic-filter-operators}
*/
static convertFromAdg(modifierList) {
const conversionMap = new MultiValueMap();
let domainList = null;
let regexDomainValue;
modifierList.children.forEach((modifier, index) => {
let value;
let { exception } = modifier;
switch (modifier.name.value) {
// Special case: ADG's $app modifier
case ADG_APP_MODIFIER:
throw new Error('The $app modifier is not supported by uBO');
// Special case: ADG's $domains modifier
case ADG_DOMAINS_MODIFIER:
if (!domainList) {
domainList = {
type: ListNodeType.DomainList,
separator: COMMA_DOMAIN_LIST_SEPARATOR,
children: [],
start: modifier.start,
end: modifier.end,
};
}
if (!modifier?.value?.value) {
return;
}
domainList = DomainListParser.parse(modifier.value.value, {}, modifier.start, PIPE_MODIFIER_SEPARATOR);
conversionMap.add(index, null);
break;
// Special case: ADG's $url modifier
case ADG_URL_MODIFIER:
if (!domainList) {
domainList = {
type: ListNodeType.DomainList,
separator: COMMA_DOMAIN_LIST_SEPARATOR,
children: [],
start: modifier.start,
end: modifier.end,
};
}
if (!modifier?.value?.value) {
return;
}
regexDomainValue = RegExpUtils.patternToRegexp(modifier.value.value);
domainList = {
type: ListNodeType.DomainList,
separator: COMMA_DOMAIN_LIST_SEPARATOR,
children: [
{
type: ListItemNodeType.Domain,
value: RegExpUtils.ensureSlashes(regexDomainValue),
exception: modifier?.exception ?? false,
},
],
start: modifier.start,
end: modifier.end,
};
conversionMap.add(index, null);
break;
// Special case: ADG's $path modifier
case ADG_PATH_MODIFIER:
if (!modifier.value) {
value = UBO_MAIN_PAGE_MATCHER;
}
else if (RegExpUtils.isNegatedRegexPattern(modifier.value.value)) {
exception = true;
value = StringUtils.escapeCharacters(RegExpUtils.removeNegationFromRegexPattern(modifier.value.value), SPECIAL_MODIFIER_REGEX_CHARS);
}
else {
value = RegExpUtils.isRegexPattern(modifier.value.value)
? StringUtils.escapeCharacters(modifier.value.value, SPECIAL_MODIFIER_REGEX_CHARS)
: modifier.value.value;
}
conversionMap.add(index, createModifierNode(UBO_MATCHES_PATH_OPERATOR, value, exception));
break;
}
});
// Check if we have any converted modifiers
if (conversionMap.size) {
const modifierListClone = clone(modifierList);
// Replace the original modifiers with the converted ones
modifierListClone.children = modifierListClone.children
.map((modifier, index) => {
const convertedModifier = conversionMap.get(index);
return convertedModifier ?? modifier;
})
.flat()
.filter((modifier) => modifier !== null);
return createConversionResult({ modifierList: modifierListClone, domains: domainList || undefined }, true);
}
// Otherwise, just return the original modifier list without any changes
return createConversionResult({ modifierList, domains: undefined }, false);
}
}
export { UboCosmeticRuleModifierConverter };