Scriptlets/src/scriptlets/set-attr.js at v1.9.105 · AdguardTeam/Scriptlets · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
import {
    hit,
    observeDOMChanges,
    nativeIsNaN,
    // following helpers should be imported and injected
    // because they are used by helpers above
    throttle,
} from '../helpers/index';

/* eslint-disable max-len */
/**
 * @scriptlet set-attr
 *
 * @description
 * Sets the specified attribute on the specified elements. This scriptlet runs once when the page loads
 * and after that and after that on DOM tree changes.
 *
 * Related UBO scriptlet:
 * https://github.com/gorhill/uBlock/wiki/Resources-Library#set-attrjs-
 *
 * ### Syntax
 *
 * ```text
 * example.org#%#//scriptlet('set-attr', selector, attr[, value])
 * ```
 *
 * - `selector` — required, CSS selector, specifies DOM nodes to set attributes on
 * - `attr` — required, attribute to be set
 * - `value` — the value to assign to the attribute, defaults to ''. Possible values:
 *     - `''` — empty string
 *     - positive decimal integer `<= 32767`
 *     - `true` / `false` in any case variation
 *
 * ### Examples
 *
 * 1. Set attribute by selector
 *
 *     ```adblock
 *     example.org#%#//scriptlet('set-attr', 'div.class > a.class', 'test-attribute', '0')
 *     ```
 *
 *     ```html
 *     <!-- before -->
 *     <a class="class">Some text</div>
 *
 *     <!-- after -->
 *     <a class="class" test-attribute="0">Some text</div>
 *     ```
 *
 * 1. Set attribute without value
 *
 *     ```adblock
 *     example.org#%#//scriptlet('set-attr', 'div.class > a.class', 'test-attribute')
 *     ```
 *
 *     ```html
 *     <!-- before -->
 *     <a class="class">Some text</div>
 *
 *     <!-- after -->
 *     <a class="class" test-attribute>Some text</div>
 *     ```
 *
 * 1. Set attribute value to `TRUE`
 *
 *     ```adblock
 *     example.org#%#//scriptlet('set-attr', 'div.class > a.class', 'test-attribute', 'TRUE')
 *     ```
 *
 *     ```html
 *     <!-- before -->
 *     <a class="class">Some text</div>
 *
 *     <!-- after -->
 *     <a class="class" test-attribute="TRUE">Some text</div>
 *     ```
 *
 * 1. Set attribute value to `fAlse`
 *
 *     ```adblock
 *     example.org#%#//scriptlet('set-attr', 'div.class > a.class', 'test-attribute', 'fAlse')
 *     ```
 *
 *     ```html
 *     <!-- before -->
 *     <a class="class">Some text</div>
 *
 *     <!-- after -->
 *     <a class="class" test-attribute="fAlse">Some text</div>
 *     ```
 *
 * @added v1.5.0.
 */
/* eslint-enable max-len */
export function setAttr(source, selector, attr, value = '') {
    if (!selector || !attr) {
        return;
    }

    const allowedValues = ['true', 'false'];

    // Drop strings that cant be parsed into number, negative numbers and numbers below 32767
    if (value.length !== 0
        && (nativeIsNaN(parseInt(value, 10))
            || parseInt(value, 10) < 0
            || parseInt(value, 10) > 32767)
        && !allowedValues.includes(value.toLowerCase())) {
        return;
    }

    const setAttr = () => {
        const nodes = [].slice.call(document.querySelectorAll(selector));
        let set = false;
        nodes.forEach((node) => {
            node.setAttribute(attr, value);
            set = true;
        });
        if (set) {
            hit(source);
        }
    };

    setAttr();
    observeDOMChanges(setAttr, true);
}

setAttr.names = [
    'set-attr',
    // aliases are needed for matching the related scriptlet converted into our syntax
    'set-attr.js',
    'ubo-set-attr.js',
    'ubo-set-attr',
];

setAttr.injections = [
    hit,
    observeDOMChanges,
    nativeIsNaN,
    // following helpers should be imported and injected
    // because they are used by helpers above
    throttle,
];