mirror of
https://github.com/gorhill/uBlock.git
synced 2024-09-02 09:09:38 +02:00
The new parser no longer uses the browser DOM to validate that a cosmetic filter is valid or not, this is now done through a JS library, CSSTree. This means filter list authors will have to be more careful to ensure that a cosmetic filter is really valid, as there is no more guarantee that a cosmetic filter which works for a given browser/version will still work properly on another browser, or different version of the same browser. This change has become necessary because of many reasons, one of them being the flakiness of the previous parser as exposed by many issues lately: - https://github.com/uBlockOrigin/uBlock-issues/issues/2262 - https://github.com/uBlockOrigin/uBlock-issues/issues/2228 The new parser introduces breaking changes, there was no way to do otherwise. Some current procedural cosmetic filters will be shown as invalid with this change. This occurs because the CSSTree library gets confused with some syntax which was previously allowed by the previous parser because it was more permissive. Mainly the issue is with the arguments passed to some procedural cosmetic filters, and these issues can be solved as follow: Use quotes around the argument. You can use either single or double-quotes, whichever is most convenient. If your argument contains a single quote, use double-quotes, and vice versa. Additionally, try to escape a quote inside an argument using backslash. THis may work, but if not, use quotes around the argument. When the parser encounter quotes around an argument, it will discard them before trying to process the argument, same with escaped quotes inside the argument. Examples: Breakage: ...##^script:has-text(toscr') Fix: ...##^script:has-text(toscr\') Breakage: ...##:xpath(//*[contains(text(),"VPN")]):upward(2) Fix: ...##:xpath('//*[contains(text(),"VPN")]'):upward(2) There are not many filters which break in the default set of filter lists, so this should be workable for default lists. Unfortunately those fixes will break the filter for previous versions of uBO since these to not deal with quoted argument. In such case, it may be necessary to keep the previous filter, which will be discarded as broken on newer version of uBO. THis was a necessary change as the old parser was becoming more and more flaky after being constantly patched for new cases arising, The new parser should be far more robust and stay robist through expanding procedural cosmetic filter syntax. Additionally, in the MV3 version, filters are pre-compiled using a Nodejs script, i.e. outside the browser, so validating cosmetic filters using a live DOM no longer made sense. This new parser will have to be tested throughly before stable release.
193 lines
5.6 KiB
JavaScript
193 lines
5.6 KiB
JavaScript
/*******************************************************************************
|
|
|
|
uBlock Origin - a browser extension to block requests.
|
|
Copyright (C) 2014-2015 The uBlock Origin authors
|
|
Copyright (C) 2014-present Raymond Hill
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see {http://www.gnu.org/licenses/}.
|
|
|
|
Home: https://github.com/gorhill/uBlock
|
|
*/
|
|
|
|
// For background page or non-background pages
|
|
|
|
/* global browser */
|
|
|
|
'use strict';
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.T0 = Date.now();
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.setTimeout = vAPI.setTimeout || self.setTimeout.bind(self);
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.webextFlavor = {
|
|
major: 0,
|
|
soup: new Set(),
|
|
get env() {
|
|
return Array.from(this.soup);
|
|
}
|
|
};
|
|
|
|
(( ) => {
|
|
const ua = navigator.userAgent;
|
|
const flavor = vAPI.webextFlavor;
|
|
const soup = flavor.soup;
|
|
const dispatch = function() {
|
|
window.dispatchEvent(new CustomEvent('webextFlavor'));
|
|
};
|
|
|
|
// This is always true.
|
|
soup.add('ublock').add('webext');
|
|
|
|
// Whether this is a dev build.
|
|
if ( /^\d+\.\d+\.\d+\D/.test(browser.runtime.getManifest().version) ) {
|
|
soup.add('devbuild');
|
|
}
|
|
|
|
if ( /\bMobile\b/.test(ua) ) {
|
|
soup.add('mobile');
|
|
}
|
|
|
|
// Asynchronous
|
|
if (
|
|
browser instanceof Object &&
|
|
typeof browser.runtime.getBrowserInfo === 'function'
|
|
) {
|
|
browser.runtime.getBrowserInfo().then(info => {
|
|
flavor.major = parseInt(info.version, 10) || flavor.major;
|
|
soup.add(info.vendor.toLowerCase())
|
|
.add(info.name.toLowerCase());
|
|
dispatch();
|
|
});
|
|
if ( browser.runtime.getURL('').startsWith('moz-extension://') ) {
|
|
soup.add('firefox')
|
|
.add('user_stylesheet')
|
|
.add('html_filtering');
|
|
flavor.major = 91;
|
|
}
|
|
return;
|
|
}
|
|
|
|
// Synchronous -- order of tests is important
|
|
const match = /\bChrom(?:e|ium)\/([\d.]+)/.exec(ua);
|
|
if ( match !== null ) {
|
|
soup.add('chromium')
|
|
.add('user_stylesheet');
|
|
flavor.major = parseInt(match[1], 10) || 0;
|
|
if ( flavor.major >= 105 ) {
|
|
soup.add('native_css_has');
|
|
}
|
|
}
|
|
|
|
// Don't starve potential listeners
|
|
vAPI.setTimeout(dispatch, 97);
|
|
})();
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.download = function(details) {
|
|
if ( !details.url ) { return; }
|
|
const a = document.createElement('a');
|
|
a.href = details.url;
|
|
a.setAttribute('download', details.filename || '');
|
|
a.setAttribute('type', 'text/plain');
|
|
a.dispatchEvent(new MouseEvent('click'));
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.getURL = browser.runtime.getURL;
|
|
|
|
/******************************************************************************/
|
|
|
|
// https://github.com/gorhill/uBlock/issues/3057
|
|
// - webNavigation.onCreatedNavigationTarget become broken on Firefox when we
|
|
// try to make the popup panel close itself using the original
|
|
// `window.open('', '_self').close()`.
|
|
|
|
vAPI.closePopup = function() {
|
|
if ( vAPI.webextFlavor.soup.has('firefox') ) {
|
|
window.close();
|
|
return;
|
|
}
|
|
|
|
// TODO: try to figure why this was used instead of a plain window.close().
|
|
// https://github.com/gorhill/uBlock/commit/b301ac031e0c2e9a99cb6f8953319d44e22f33d2#diff-bc664f26b9c453e0d43a9379e8135c6a
|
|
window.open('', '_self').close();
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
// A localStorage-like object which should be accessible from the
|
|
// background page or auxiliary pages.
|
|
//
|
|
// https://github.com/uBlockOrigin/uBlock-issues/issues/899
|
|
// Convert into asynchronous access API.
|
|
|
|
vAPI.localStorage = {
|
|
clear: function() {
|
|
vAPI.messaging.send('vapi', {
|
|
what: 'localStorage',
|
|
fn: 'clear',
|
|
});
|
|
},
|
|
getItemAsync: function(key) {
|
|
return vAPI.messaging.send('vapi', {
|
|
what: 'localStorage',
|
|
fn: 'getItemAsync',
|
|
args: [ key ],
|
|
});
|
|
},
|
|
removeItem: function(key) {
|
|
return vAPI.messaging.send('vapi', {
|
|
what: 'localStorage',
|
|
fn: 'removeItem',
|
|
args: [ key ],
|
|
});
|
|
},
|
|
setItem: function(key, value = undefined) {
|
|
return vAPI.messaging.send('vapi', {
|
|
what: 'localStorage',
|
|
fn: 'setItem',
|
|
args: [ key, value ]
|
|
});
|
|
},
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/*******************************************************************************
|
|
|
|
DO NOT:
|
|
- Remove the following code
|
|
- Add code beyond the following code
|
|
Reason:
|
|
- https://github.com/gorhill/uBlock/pull/3721
|
|
- uBO never uses the return value from injected content scripts
|
|
|
|
**/
|
|
|
|
void 0;
|