mirror of
https://github.com/gorhill/uBlock.git
synced 2024-09-15 15:32:28 +02:00
400 lines
13 KiB
JavaScript
400 lines
13 KiB
JavaScript
/*******************************************************************************
|
|
|
|
uBlock Origin - a browser extension to block requests.
|
|
Copyright (C) 2014-2017 The uBlock Origin authors
|
|
|
|
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
|
|
*/
|
|
|
|
/* global HTMLDocument, XMLDocument,
|
|
addMessageListener, removeMessageListener, sendAsyncMessage, outerShutdown
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
// For non background pages
|
|
|
|
/******************************************************************************/
|
|
|
|
(function(self) {
|
|
|
|
// https://github.com/chrisaljoudi/uBlock/issues/464
|
|
if ( document instanceof HTMLDocument === false ) {
|
|
// https://github.com/chrisaljoudi/uBlock/issues/1528
|
|
// A XMLDocument can be a valid HTML document.
|
|
if (
|
|
document instanceof XMLDocument === false ||
|
|
document.createElement('div') instanceof HTMLDivElement === false
|
|
) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
/******************************************************************************/
|
|
|
|
// https://bugs.chromium.org/p/project-zero/issues/detail?id=1225&desc=6#c10
|
|
if ( !self.vAPI || self.vAPI.uBO !== true ) {
|
|
self.vAPI = { uBO: true };
|
|
}
|
|
|
|
var vAPI = self.vAPI;
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.firefox = true;
|
|
|
|
vAPI.randomToken = function() {
|
|
return String.fromCharCode(Date.now() % 26 + 97) +
|
|
Math.floor(Math.random() * 982451653 + 982451653).toString(36);
|
|
};
|
|
|
|
vAPI.sessionId = vAPI.randomToken();
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.setTimeout = vAPI.setTimeout || function(callback, delay, extra) {
|
|
return setTimeout(function(a) { callback(a); }, delay, extra);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.shutdown = {
|
|
jobs: [],
|
|
add: function(job) {
|
|
this.jobs.push(job);
|
|
},
|
|
exec: function() {
|
|
var job;
|
|
while ( (job = this.jobs.pop()) ) {
|
|
job();
|
|
}
|
|
},
|
|
remove: function(job) {
|
|
var pos;
|
|
while ( (pos = this.jobs.indexOf(job)) !== -1 ) {
|
|
this.jobs.splice(pos, 1);
|
|
}
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
(function() {
|
|
if ( !self.getScriptTagFilters ) {
|
|
return;
|
|
}
|
|
var hostname = location.hostname;
|
|
if ( !hostname ) {
|
|
return;
|
|
}
|
|
var filters = self.getScriptTagFilters({
|
|
rootURL: self.location.href,
|
|
frameURL: self.location.href,
|
|
frameHostname: hostname
|
|
});
|
|
if ( typeof filters !== 'string' || filters === '' ) {
|
|
return;
|
|
}
|
|
var reFilters = new RegExp(filters);
|
|
document.addEventListener('beforescriptexecute', function(ev) {
|
|
if ( reFilters.test(ev.target.textContent) ) {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
}
|
|
});
|
|
})();
|
|
|
|
/******************************************************************************/
|
|
|
|
var insertUserCSS = self.injectCSS || function(){},
|
|
removeUserCSS = self.removeCSS || function(){};
|
|
|
|
var processUserCSS = function(details, callback) {
|
|
var cssText;
|
|
var aa = details.add;
|
|
if ( Array.isArray(aa) ) {
|
|
for ( cssText of aa ) {
|
|
insertUserCSS(
|
|
'data:text/css;charset=utf-8,' +
|
|
encodeURIComponent(cssText)
|
|
);
|
|
}
|
|
}
|
|
aa = details.remove;
|
|
if ( Array.isArray(aa) ) {
|
|
for ( cssText of aa ) {
|
|
removeUserCSS(
|
|
'data:text/css;charset=utf-8,' +
|
|
encodeURIComponent(cssText)
|
|
);
|
|
}
|
|
}
|
|
if ( typeof callback === 'function' ) {
|
|
callback();
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging = {
|
|
channels: new Map(),
|
|
pending: new Map(),
|
|
auxProcessId: 1,
|
|
connected: false,
|
|
|
|
messageListener: function(msg) {
|
|
var details = JSON.parse(msg);
|
|
if ( !details ) { return; }
|
|
|
|
// Sent to all channels
|
|
if ( details.broadcast && !details.channelName ) {
|
|
for ( var channelName of this.channels.keys() ) {
|
|
this.sendToChannelListeners(channelName, details.msg);
|
|
}
|
|
return;
|
|
}
|
|
|
|
// Response to specific message previously sent
|
|
if ( details.auxProcessId ) {
|
|
var listener = this.pending.get(details.auxProcessId);
|
|
this.pending.delete(details.auxProcessId);
|
|
if ( listener ) {
|
|
listener(details.msg);
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Sent to a specific channel
|
|
this.sendToChannelListeners(details.channelName, details.msg);
|
|
},
|
|
|
|
builtinListener: function(msg) {
|
|
if ( msg.cmd === 'injectScript' ) {
|
|
// injectScript is not always present.
|
|
// - See contentObserver.initContentScripts in frameModule.js
|
|
if ( typeof self.injectScript !== 'function' ) { return; }
|
|
var details = msg.details;
|
|
// Whether to inject in all child frames. Default to only top frame.
|
|
var allFrames = details.allFrames || false;
|
|
if ( allFrames !== true && window !== window.top ) { return; }
|
|
// https://github.com/gorhill/uBlock/issues/876
|
|
// Enforce `details.runAt`. Default to `document_end`.
|
|
var runAt = details.runAt || 'document_end';
|
|
if ( runAt === 'document_start' || document.readyState !== 'loading' ) {
|
|
self.injectScript(details.file);
|
|
return;
|
|
}
|
|
var injectScriptDelayed = function() {
|
|
document.removeEventListener('DOMContentLoaded', injectScriptDelayed);
|
|
self.injectScript(details.file);
|
|
};
|
|
document.addEventListener('DOMContentLoaded', injectScriptDelayed);
|
|
return;
|
|
}
|
|
if ( msg.cmd === 'shutdownSandbox' ) {
|
|
vAPI.shutdown.exec();
|
|
vAPI.messaging.stop();
|
|
if ( typeof self.outerShutdown === 'function' ) {
|
|
outerShutdown();
|
|
}
|
|
// https://github.com/gorhill/uBlock/issues/1573
|
|
// Will let uBO's own web pages close themselves. `window.top` is
|
|
// used on the assumption that uBO's own web pages will never be
|
|
// embedded in anything else than its own documents.
|
|
try {
|
|
var top = window.top;
|
|
if ( top.location.href.startsWith(vAPI.getURL('')) ) {
|
|
top.close();
|
|
}
|
|
} catch (ex) {
|
|
}
|
|
return;
|
|
}
|
|
},
|
|
|
|
toggleListener: function({type, persisted}) {
|
|
if ( type === 'pagehide' && !persisted ) {
|
|
vAPI.shutdown.exec();
|
|
this.stop();
|
|
if ( typeof self.outerShutdown === 'function' ) {
|
|
outerShutdown();
|
|
}
|
|
return;
|
|
}
|
|
|
|
if ( type === 'pagehide' ) {
|
|
this.disconnect();
|
|
} else /* if ( type === 'pageshow' ) */ {
|
|
this.connect();
|
|
}
|
|
},
|
|
toggleListenerCallback: null,
|
|
|
|
start: function() {
|
|
this.addChannelListener('vAPI', this.builtinListener);
|
|
if ( this.toggleListenerCallback === null ) {
|
|
this.toggleListenerCallback = this.toggleListener.bind(this);
|
|
}
|
|
window.addEventListener('pagehide', this.toggleListenerCallback, true);
|
|
window.addEventListener('pageshow', this.toggleListenerCallback, true);
|
|
},
|
|
|
|
stop: function() {
|
|
if ( this.toggleListenerCallback !== null ) {
|
|
window.removeEventListener('pagehide', this.toggleListenerCallback, true);
|
|
window.removeEventListener('pageshow', this.toggleListenerCallback, true);
|
|
}
|
|
this.disconnect();
|
|
this.channels.clear();
|
|
// service pending callbacks
|
|
var pending = this.pending;
|
|
this.pending = new Map();
|
|
for ( var callback of pending.values() ) {
|
|
if ( typeof callback === 'function' ) {
|
|
callback(null);
|
|
}
|
|
}
|
|
},
|
|
|
|
connect: function() {
|
|
if ( !this.connected ) {
|
|
addMessageListener(this.messageListener.bind(this));
|
|
this.connected = true;
|
|
}
|
|
},
|
|
|
|
disconnect: function() {
|
|
if ( this.connected ) {
|
|
removeMessageListener();
|
|
this.connected = false;
|
|
}
|
|
},
|
|
|
|
send: function(channelName, message, callback) {
|
|
// User stylesheets are handled content-side on legacy Firefox.
|
|
if ( channelName === 'vapi' && message.what === 'userCSS' ) {
|
|
return processUserCSS(message, callback);
|
|
}
|
|
if ( !this.connected ) {
|
|
if ( typeof callback === 'function' ) { callback(); }
|
|
return;
|
|
}
|
|
// Too large a gap between the last request and the last response means
|
|
// the main process is no longer reachable: memory leaks and bad
|
|
// performance become a risk -- especially for long-lived, dynamic
|
|
// pages. Guard against this.
|
|
if ( this.pendingCount > 25 ) {
|
|
vAPI.shutdown.exec();
|
|
}
|
|
this.connect();
|
|
var auxProcessId;
|
|
if ( callback ) {
|
|
auxProcessId = this.auxProcessId++;
|
|
this.pending.set(auxProcessId, callback);
|
|
}
|
|
sendAsyncMessage('ublock0:background', {
|
|
channelName: self._sandboxId_ + '|' + channelName,
|
|
auxProcessId: auxProcessId,
|
|
msg: message
|
|
});
|
|
},
|
|
|
|
// TODO: implement as time permits.
|
|
connectTo: function(from, to, handler) {
|
|
handler({
|
|
what: 'connectionRefused',
|
|
from: from,
|
|
to: to
|
|
});
|
|
},
|
|
|
|
disconnectFrom: function() {
|
|
},
|
|
|
|
sendTo: function() {
|
|
},
|
|
|
|
addChannelListener: function(channelName, listener) {
|
|
var listeners = this.channels.get(channelName);
|
|
if ( listeners === undefined ) {
|
|
this.channels.set(channelName, [ listener ]);
|
|
} else if ( listeners.indexOf(listener) === -1 ) {
|
|
listeners.push(listener);
|
|
}
|
|
this.connect();
|
|
},
|
|
|
|
removeChannelListener: function(channelName, listener) {
|
|
var listeners = this.channels.get(channelName);
|
|
if ( listeners === undefined ) { return; }
|
|
var pos = this.listeners.indexOf(listener);
|
|
if ( pos === -1 ) { return; }
|
|
listeners.splice(pos, 1);
|
|
if ( listeners.length === 0 ) {
|
|
this.channels.delete(channelName);
|
|
}
|
|
},
|
|
|
|
removeAllChannelListeners: function(channelName) {
|
|
this.channels.delete(channelName);
|
|
},
|
|
|
|
sendToChannelListeners: function(channelName, msg) {
|
|
var listeners = this.channels.get(channelName);
|
|
if ( listeners === undefined ) { return; }
|
|
listeners = listeners.slice(0);
|
|
var response;
|
|
for ( var listener of listeners ) {
|
|
response = listener(msg);
|
|
if ( response !== undefined ) { break; }
|
|
}
|
|
return response;
|
|
}
|
|
};
|
|
|
|
vAPI.messaging.start();
|
|
|
|
// https://www.youtube.com/watch?v=Cg0cmhjdiLs
|
|
|
|
/******************************************************************************/
|
|
|
|
// https://bugzilla.mozilla.org/show_bug.cgi?id=444165
|
|
// https://github.com/gorhill/uBlock/issues/2256
|
|
// Not the prettiest solution, but that's the safest/simplest I can think
|
|
// of at this point. If/when bugzilla issue above is solved, we will need
|
|
// version detection to decide whether the patch needs to be applied.
|
|
|
|
vAPI.iframeLoadEventPatch = function(target) {
|
|
if ( target.localName === 'iframe' ) {
|
|
target.dispatchEvent(new Event('load'));
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
// No need to have vAPI client linger around after shutdown if
|
|
// we are not a top window (because element picker can still
|
|
// be injected in top window).
|
|
if ( window !== window.top ) {
|
|
// Can anything be done?
|
|
}
|
|
|
|
/******************************************************************************/
|
|
|
|
})(this);
|
|
|
|
/******************************************************************************/
|