uBlock/platform/firefox/bootstrap.js

194 lines
5.9 KiB
JavaScript
Raw Normal View History

/*******************************************************************************
µBlock - a browser extension to block requests.
Copyright (C) 2014 The µBlock 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
*/
2015-09-25 18:26:56 +02:00
/* global ADDON_UNINSTALL, APP_SHUTDOWN */
/* exported startup, shutdown, install, uninstall */
'use strict';
/******************************************************************************/
2015-07-28 14:54:12 +02:00
const {classes: Cc, interfaces: Ci} = Components;
2015-06-26 06:08:41 +02:00
// Accessing the context of the background page:
// var win = Services.appShell.hiddenDOMWindow.document.querySelector('iframe[src*=ublock0]').contentWindow;
2015-01-15 13:24:35 +01:00
2015-11-03 22:40:22 +01:00
let bgProcess = null;
2015-02-02 11:52:40 +01:00
let version;
const hostName = 'ublock0';
2015-01-04 13:58:17 +01:00
const restartListener = {
get messageManager() {
2015-06-26 06:08:41 +02:00
return Cc['@mozilla.org/parentprocessmessagemanager;1']
2015-07-28 14:54:12 +02:00
.getService(Ci.nsIMessageListenerManager);
2014-12-29 17:54:18 +01:00
},
2015-01-04 13:58:17 +01:00
receiveMessage: function() {
2014-12-29 17:54:18 +01:00
shutdown();
startup();
2014-12-28 21:26:06 +01:00
}
};
/******************************************************************************/
2015-09-25 18:26:56 +02:00
function startup(data/*, reason*/) {
2015-02-02 11:52:40 +01:00
if ( data !== undefined ) {
version = data.version;
}
2015-11-03 22:40:22 +01:00
// Already started?
if ( bgProcess !== null ) {
return;
}
2015-06-26 06:08:41 +02:00
let appShell = Cc['@mozilla.org/appshell/appShellService;1']
2015-07-28 14:54:12 +02:00
.getService(Ci.nsIAppShellService);
2015-11-03 22:40:22 +01:00
let isReady = function() {
2015-11-04 00:00:08 +01:00
var hiddenDoc;
2014-12-29 17:54:18 +01:00
2015-11-03 22:40:22 +01:00
try {
hiddenDoc = appShell.hiddenDOMWindow &&
appShell.hiddenDOMWindow.document;
} catch (ex) {
}
2015-11-04 00:00:08 +01:00
// Do not test against `loading`: it does appear `readyState` could be
// undefined if looked up too early.
if ( !hiddenDoc ||
hiddenDoc.readyState !== 'interactive' && hiddenDoc.readyState !== 'complete' ) {
2015-11-03 22:40:22 +01:00
return false;
}
bgProcess = hiddenDoc.documentElement.appendChild(
hiddenDoc.createElementNS('http://www.w3.org/1999/xhtml', 'iframe')
2014-12-29 17:54:18 +01:00
);
bgProcess.setAttribute(
'src',
2015-02-02 11:52:40 +01:00
'chrome://' + hostName + '/content/background.html#' + version
2014-12-29 17:54:18 +01:00
);
2015-01-04 13:58:17 +01:00
2015-11-04 00:00:08 +01:00
// https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIMessageListenerManager#addMessageListener%28%29
// "If the same listener registers twice for the same message, the
// "second registration is ignored."
2015-01-04 13:58:17 +01:00
restartListener.messageManager.addMessageListener(
hostName + '-restart',
restartListener
);
2015-11-03 22:40:22 +01:00
return true;
2014-12-29 17:54:18 +01:00
};
2015-11-03 22:40:22 +01:00
if ( isReady() ) {
2014-12-28 21:26:06 +01:00
return;
}
2014-12-28 21:26:06 +01:00
2015-11-03 22:40:22 +01:00
// https://github.com/gorhill/uBlock/issues/749
// Poll until the proper environment is set up -- or give up eventually.
2015-11-04 00:00:08 +01:00
// We poll frequently early on but relax poll delay as time pass.
2014-12-28 21:26:06 +01:00
2015-11-04 00:00:08 +01:00
let tryDelay = 5;
let trySum = 0;
let tryMax = 30000;
2015-11-03 22:40:22 +01:00
let timer = Cc['@mozilla.org/timer;1']
.createInstance(Ci.nsITimer);
2015-11-03 22:40:22 +01:00
let checkLater = function() {
2015-11-04 00:00:08 +01:00
trySum += tryDelay;
if ( trySum >= tryMax ) {
2015-11-03 22:40:22 +01:00
timer = null;
2015-11-04 00:00:08 +01:00
return;
}
timer.init(timerObserver, tryDelay, timer.TYPE_ONE_SHOT);
tryDelay *= 2;
if ( tryDelay > 500 ) {
tryDelay = 500;
2015-11-03 22:40:22 +01:00
}
};
2015-11-03 22:40:22 +01:00
var timerObserver = {
observe: function() {
timer.cancel();
if ( isReady() ) {
timer = null;
} else {
checkLater();
}
2014-12-28 21:26:06 +01:00
}
2015-11-03 22:40:22 +01:00
};
checkLater();
}
/******************************************************************************/
function shutdown(data, reason) {
2014-12-28 21:26:06 +01:00
if ( reason === APP_SHUTDOWN ) {
return;
}
2014-12-28 21:26:06 +01:00
2015-11-03 22:40:22 +01:00
if ( bgProcess !== null ) {
bgProcess.parentNode.removeChild(bgProcess);
bgProcess = null;
}
2014-12-29 17:54:18 +01:00
if ( data === undefined ) {
return;
2014-12-29 17:54:18 +01:00
}
// Remove the restartObserver only when the extension is being disabled
restartListener.messageManager.removeMessageListener(
hostName + '-restart',
restartListener
);
}
/******************************************************************************/
2015-04-19 17:33:04 +02:00
function install(/*aData, aReason*/) {
// https://bugzil.la/719376
2015-06-26 06:08:41 +02:00
Cc['@mozilla.org/intl/stringbundle;1']
2015-07-28 14:54:12 +02:00
.getService(Ci.nsIStringBundleService)
.flushBundles();
}
/******************************************************************************/
2015-04-19 17:33:04 +02:00
// https://developer.mozilla.org/en-US/Add-ons/Bootstrapped_extensions#uninstall
// "if you have code in uninstall it will not run, you MUST run some code
// "in the install function, at the least you must set arguments on the
// "install function so like: function install(aData, aReason) {} then
// "uninstall WILL WORK."
function uninstall(aData, aReason) {
if ( aReason !== ADDON_UNINSTALL ) {
return;
}
// https://github.com/gorhill/uBlock/issues/84
// "Add cleanup task to remove local storage settings when uninstalling"
// To cleanup vAPI.localStorage in vapi-common.js
// As I get more familiar with FF API, will find out whetehr there was
// a better way to do this.
Components.utils.import('resource://gre/modules/Services.jsm', null)
.Services.prefs.getBranch('extensions.' + hostName + '.').deleteBranch('');
}
/******************************************************************************/