mirror of
https://github.com/gorhill/uBlock.git
synced 2024-09-02 09:09:38 +02:00
1519 lines
51 KiB
JavaScript
1519 lines
51 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
|
|
*/
|
|
|
|
// For background page
|
|
|
|
'use strict';
|
|
|
|
/******************************************************************************/
|
|
|
|
(function() {
|
|
|
|
/******************************************************************************/
|
|
|
|
var vAPI = self.vAPI = self.vAPI || {};
|
|
|
|
var chrome = self.chrome;
|
|
var manifest = chrome.runtime.getManifest();
|
|
|
|
vAPI.chrome = true;
|
|
vAPI.chromiumVersion = (function(){
|
|
var matches = /\bChrom(?:e|ium)\/(\d+)\b/.exec(navigator.userAgent);
|
|
return matches !== null ? parseInt(matches[1], 10) : NaN;
|
|
})();
|
|
vAPI.cantWebsocket =
|
|
chrome.webRequest.ResourceType instanceof Object === false ||
|
|
chrome.webRequest.ResourceType.WEBSOCKET !== 'websocket';
|
|
|
|
var noopFunc = function(){};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.app = {
|
|
name: manifest.name,
|
|
version: manifest.version
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.app.restart = function() {
|
|
chrome.runtime.reload();
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
// chrome.storage.local.get(null, function(bin){ console.debug('%o', bin); });
|
|
|
|
vAPI.storage = chrome.storage.local;
|
|
vAPI.cacheStorage = chrome.storage.local;
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
// https://github.com/gorhill/uMatrix/issues/234
|
|
// https://developer.chrome.com/extensions/privacy#property-network
|
|
|
|
// 2015-08-12: Wrapped Chrome API in try-catch statements. I had a fluke
|
|
// event in which it appeared Chrome 46 decided to restart uBlock (for
|
|
// unknown reasons) and again for unknown reasons the browser acted as if
|
|
// uBlock did not declare the `privacy` permission in its manifest, putting
|
|
// uBlock in a bad, non-functional state -- because call to `chrome.privacy`
|
|
// API threw an exception.
|
|
|
|
// https://github.com/gorhill/uBlock/issues/2048
|
|
// Do not mess up with existing settings if not assigning them stricter
|
|
// values.
|
|
|
|
vAPI.browserSettings = (function() {
|
|
// Not all platforms support `chrome.privacy`.
|
|
if ( chrome.privacy instanceof Object === false ) {
|
|
return;
|
|
}
|
|
|
|
return {
|
|
webRTCSupported: undefined,
|
|
|
|
// https://github.com/gorhill/uBlock/issues/875
|
|
// Must not leave `lastError` unchecked.
|
|
noopCallback: function() {
|
|
void chrome.runtime.lastError;
|
|
},
|
|
|
|
// Calling with `true` means IP address leak is not prevented.
|
|
// https://github.com/gorhill/uBlock/issues/533
|
|
// We must first check wether this Chromium-based browser was compiled
|
|
// with WebRTC support. To do this, we use an iframe, this way the
|
|
// empty RTCPeerConnection object we create to test for support will
|
|
// be properly garbage collected. This prevents issues such as
|
|
// a computer unable to enter into sleep mode, as reported in the
|
|
// Chrome store:
|
|
// https://github.com/gorhill/uBlock/issues/533#issuecomment-167931681
|
|
setWebrtcIPAddress: function(setting) {
|
|
// We don't know yet whether this browser supports WebRTC: find out.
|
|
if ( this.webRTCSupported === undefined ) {
|
|
this.webRTCSupported = { setting: setting };
|
|
var iframe = document.createElement('iframe');
|
|
var me = this;
|
|
var messageHandler = function(ev) {
|
|
if ( ev.origin !== self.location.origin ) {
|
|
return;
|
|
}
|
|
window.removeEventListener('message', messageHandler);
|
|
var setting = me.webRTCSupported.setting;
|
|
me.webRTCSupported = ev.data === 'webRTCSupported';
|
|
me.setWebrtcIPAddress(setting);
|
|
iframe.parentNode.removeChild(iframe);
|
|
iframe = null;
|
|
};
|
|
window.addEventListener('message', messageHandler);
|
|
iframe.src = 'is-webrtc-supported.html';
|
|
document.body.appendChild(iframe);
|
|
return;
|
|
}
|
|
|
|
// We are waiting for a response from our iframe. This makes the code
|
|
// safe to re-entrancy.
|
|
if ( typeof this.webRTCSupported === 'object' ) {
|
|
this.webRTCSupported.setting = setting;
|
|
return;
|
|
}
|
|
|
|
// https://github.com/gorhill/uBlock/issues/533
|
|
// WebRTC not supported: `webRTCMultipleRoutesEnabled` can NOT be
|
|
// safely accessed. Accessing the property will cause full browser
|
|
// crash.
|
|
if ( this.webRTCSupported !== true ) {
|
|
return;
|
|
}
|
|
|
|
var cp = chrome.privacy,
|
|
cpn = cp.network;
|
|
|
|
// Older version of Chromium do not support this setting, and is
|
|
// marked as "deprecated" since Chromium 48.
|
|
if ( typeof cpn.webRTCMultipleRoutesEnabled === 'object' ) {
|
|
try {
|
|
if ( setting ) {
|
|
cpn.webRTCMultipleRoutesEnabled.clear({
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
} else {
|
|
cpn.webRTCMultipleRoutesEnabled.set({
|
|
value: false,
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
}
|
|
} catch(ex) {
|
|
console.error(ex);
|
|
}
|
|
}
|
|
|
|
// This setting became available in Chromium 48.
|
|
if ( typeof cpn.webRTCIPHandlingPolicy === 'object' ) {
|
|
try {
|
|
if ( setting ) {
|
|
cpn.webRTCIPHandlingPolicy.clear({
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
} else {
|
|
// https://github.com/uBlockOrigin/uAssets/issues/333#issuecomment-289426678
|
|
// - Leverage virtuous side-effect of strictest setting.
|
|
cpn.webRTCIPHandlingPolicy.set({
|
|
value: 'disable_non_proxied_udp',
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
}
|
|
} catch(ex) {
|
|
console.error(ex);
|
|
}
|
|
}
|
|
},
|
|
|
|
set: function(details) {
|
|
for ( var setting in details ) {
|
|
if ( details.hasOwnProperty(setting) === false ) {
|
|
continue;
|
|
}
|
|
switch ( setting ) {
|
|
case 'prefetching':
|
|
try {
|
|
if ( !!details[setting] ) {
|
|
chrome.privacy.network.networkPredictionEnabled.clear({
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
} else {
|
|
chrome.privacy.network.networkPredictionEnabled.set({
|
|
value: false,
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
}
|
|
} catch(ex) {
|
|
console.error(ex);
|
|
}
|
|
break;
|
|
|
|
case 'hyperlinkAuditing':
|
|
try {
|
|
if ( !!details[setting] ) {
|
|
chrome.privacy.websites.hyperlinkAuditingEnabled.clear({
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
} else {
|
|
chrome.privacy.websites.hyperlinkAuditingEnabled.set({
|
|
value: false,
|
|
scope: 'regular'
|
|
}, this.noopCallback);
|
|
}
|
|
} catch(ex) {
|
|
console.error(ex);
|
|
}
|
|
break;
|
|
|
|
case 'webrtcIPAddress':
|
|
this.setWebrtcIPAddress(!!details[setting]);
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
};
|
|
})();
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.tabs = {};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.isBehindTheSceneTabId = function(tabId) {
|
|
return tabId.toString() === '-1';
|
|
};
|
|
|
|
vAPI.noTabId = '-1';
|
|
|
|
/******************************************************************************/
|
|
|
|
var toChromiumTabId = function(tabId) {
|
|
if ( typeof tabId === 'string' ) {
|
|
tabId = parseInt(tabId, 10);
|
|
}
|
|
if ( typeof tabId !== 'number' || isNaN(tabId) || tabId === -1 ) {
|
|
return 0;
|
|
}
|
|
return tabId;
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.tabs.registerListeners = function() {
|
|
var onNavigationClient = this.onNavigation || noopFunc;
|
|
var onUpdatedClient = this.onUpdated || noopFunc;
|
|
|
|
// https://developer.chrome.com/extensions/webNavigation
|
|
// [onCreatedNavigationTarget ->]
|
|
// onBeforeNavigate ->
|
|
// onCommitted ->
|
|
// onDOMContentLoaded ->
|
|
// onCompleted
|
|
|
|
// The chrome.webRequest.onBeforeRequest() won't be called for everything
|
|
// else than `http`/`https`. Thus, in such case, we will bind the tab as
|
|
// early as possible in order to increase the likelihood of a context
|
|
// properly setup if network requests are fired from within the tab.
|
|
// Example: Chromium + case #6 at
|
|
// http://raymondhill.net/ublock/popup.html
|
|
var reGoodForWebRequestAPI = /^https?:\/\//;
|
|
|
|
// https://forums.lanik.us/viewtopic.php?f=62&t=32826
|
|
// Chromium-based browsers: sanitize target URL. I've seen data: URI with
|
|
// newline characters in standard fields, possibly as a way of evading
|
|
// filters. As per spec, there should be no whitespaces in a data: URI's
|
|
// standard fields.
|
|
var sanitizeURL = function(url) {
|
|
if ( url.startsWith('data:') === false ) { return url; }
|
|
var pos = url.indexOf(',');
|
|
if ( pos === -1 ) { return url; }
|
|
var s = url.slice(0, pos);
|
|
if ( s.search(/\s/) === -1 ) { return url; }
|
|
return s.replace(/\s+/, '') + url.slice(pos);
|
|
};
|
|
|
|
var onCreatedNavigationTarget = function(details) {
|
|
//console.debug('onCreatedNavigationTarget: popup candidate tab id %d = "%s"', details.tabId, details.url);
|
|
if ( reGoodForWebRequestAPI.test(details.url) === false ) {
|
|
details.frameId = 0;
|
|
details.url = sanitizeURL(details.url);
|
|
onNavigationClient(details);
|
|
}
|
|
if ( typeof vAPI.tabs.onPopupCreated === 'function' ) {
|
|
vAPI.tabs.onPopupCreated(details.tabId.toString(), details.sourceTabId.toString());
|
|
}
|
|
};
|
|
|
|
var onBeforeNavigate = function(details) {
|
|
if ( details.frameId !== 0 ) {
|
|
return;
|
|
}
|
|
};
|
|
|
|
var onCommitted = function(details) {
|
|
if ( details.frameId !== 0 ) {
|
|
return;
|
|
}
|
|
details.url = sanitizeURL(details.url);
|
|
onNavigationClient(details);
|
|
};
|
|
|
|
var onActivated = function(details) {
|
|
vAPI.contextMenu.onMustUpdate(details.tabId);
|
|
};
|
|
|
|
var onUpdated = function(tabId, changeInfo, tab) {
|
|
if ( changeInfo.url ) {
|
|
changeInfo.url = sanitizeURL(changeInfo.url);
|
|
}
|
|
onUpdatedClient(tabId.toString(), changeInfo, tab);
|
|
};
|
|
|
|
chrome.webNavigation.onBeforeNavigate.addListener(onBeforeNavigate);
|
|
chrome.webNavigation.onCommitted.addListener(onCommitted);
|
|
// Not supported on Firefox WebExtensions yet.
|
|
if ( chrome.webNavigation.onCreatedNavigationTarget instanceof Object ) {
|
|
chrome.webNavigation.onCreatedNavigationTarget.addListener(onCreatedNavigationTarget);
|
|
}
|
|
chrome.tabs.onActivated.addListener(onActivated);
|
|
chrome.tabs.onUpdated.addListener(onUpdated);
|
|
|
|
if ( typeof this.onClosed === 'function' ) {
|
|
chrome.tabs.onRemoved.addListener(this.onClosed);
|
|
}
|
|
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.tabs.get = function(tabId, callback) {
|
|
var onTabReady = function(tab) {
|
|
// https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
if ( chrome.runtime.lastError ) {
|
|
/* noop */
|
|
}
|
|
// Caller must be prepared to deal with nil tab value
|
|
callback(tab);
|
|
};
|
|
|
|
if ( tabId !== null ) {
|
|
tabId = toChromiumTabId(tabId);
|
|
if ( tabId === 0 ) {
|
|
onTabReady(null);
|
|
} else {
|
|
chrome.tabs.get(tabId, onTabReady);
|
|
}
|
|
return;
|
|
}
|
|
|
|
var onTabReceived = function(tabs) {
|
|
// https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
void chrome.runtime.lastError;
|
|
callback(tabs[0]);
|
|
};
|
|
chrome.tabs.query({ active: true, currentWindow: true }, onTabReceived);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
// properties of the details object:
|
|
// url: 'URL', // the address that will be opened
|
|
// tabId: 1, // the tab is used if set, instead of creating a new one
|
|
// index: -1, // undefined: end of the list, -1: following tab, or after index
|
|
// active: false, // opens the tab in background - true and undefined: foreground
|
|
// select: true, // if a tab is already opened with that url, then select it instead of opening a new one
|
|
// popup: true // open in a new window
|
|
|
|
vAPI.tabs.open = function(details) {
|
|
var targetURL = details.url;
|
|
if ( typeof targetURL !== 'string' || targetURL === '' ) {
|
|
return null;
|
|
}
|
|
|
|
// extension pages
|
|
if ( /^[\w-]{2,}:/.test(targetURL) !== true ) {
|
|
targetURL = vAPI.getURL(targetURL);
|
|
}
|
|
|
|
// dealing with Chrome's asynchronous API
|
|
var wrapper = function() {
|
|
if ( details.active === undefined ) {
|
|
details.active = true;
|
|
}
|
|
|
|
var subWrapper = function() {
|
|
var _details = {
|
|
url: targetURL,
|
|
active: !!details.active
|
|
};
|
|
|
|
// Opening a tab from incognito window won't focus the window
|
|
// in which the tab was opened
|
|
var focusWindow = function(tab) {
|
|
if ( tab.active ) {
|
|
chrome.windows.update(tab.windowId, { focused: true });
|
|
}
|
|
};
|
|
|
|
if ( !details.tabId ) {
|
|
if ( details.index !== undefined ) {
|
|
_details.index = details.index;
|
|
}
|
|
|
|
chrome.tabs.create(_details, focusWindow);
|
|
return;
|
|
}
|
|
|
|
// update doesn't accept index, must use move
|
|
chrome.tabs.update(toChromiumTabId(details.tabId), _details, function(tab) {
|
|
// if the tab doesn't exist
|
|
if ( vAPI.lastError() ) {
|
|
chrome.tabs.create(_details, focusWindow);
|
|
} else if ( details.index !== undefined ) {
|
|
chrome.tabs.move(tab.id, {index: details.index});
|
|
}
|
|
});
|
|
};
|
|
|
|
// Open in a standalone window
|
|
if ( details.popup === true ) {
|
|
chrome.windows.create({ url: details.url, type: 'popup' });
|
|
return;
|
|
}
|
|
|
|
if ( details.index !== -1 ) {
|
|
subWrapper();
|
|
return;
|
|
}
|
|
|
|
vAPI.tabs.get(null, function(tab) {
|
|
if ( tab ) {
|
|
details.index = tab.index + 1;
|
|
} else {
|
|
delete details.index;
|
|
}
|
|
|
|
subWrapper();
|
|
});
|
|
};
|
|
|
|
if ( !details.select ) {
|
|
wrapper();
|
|
return;
|
|
}
|
|
|
|
// https://developer.chrome.com/extensions/tabs#method-query
|
|
// "Note that fragment identifiers are not matched."
|
|
// It's a lie, fragment identifiers ARE matched. So we need to remove the
|
|
// fragment.
|
|
var pos = targetURL.indexOf('#');
|
|
var targetURLWithoutHash = pos === -1 ? targetURL : targetURL.slice(0, pos);
|
|
|
|
chrome.tabs.query({ url: targetURLWithoutHash }, function(tabs) {
|
|
if ( chrome.runtime.lastError ) { /* noop */ }
|
|
var tab = Array.isArray(tabs) && tabs[0];
|
|
if ( !tab ) {
|
|
wrapper();
|
|
return;
|
|
}
|
|
var _details = {
|
|
active: true,
|
|
url: undefined
|
|
};
|
|
if ( targetURL !== tab.url ) {
|
|
_details.url = targetURL;
|
|
}
|
|
chrome.tabs.update(tab.id, _details, function(tab) {
|
|
chrome.windows.update(tab.windowId, { focused: true });
|
|
});
|
|
});
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
// Replace the URL of a tab. Noop if the tab does not exist.
|
|
|
|
vAPI.tabs.replace = function(tabId, url) {
|
|
tabId = toChromiumTabId(tabId);
|
|
if ( tabId === 0 ) {
|
|
return;
|
|
}
|
|
|
|
var targetURL = url;
|
|
|
|
// extension pages
|
|
if ( /^[\w-]{2,}:/.test(targetURL) !== true ) {
|
|
targetURL = vAPI.getURL(targetURL);
|
|
}
|
|
|
|
chrome.tabs.update(tabId, { url: targetURL }, function() {
|
|
// https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
if ( chrome.runtime.lastError ) {
|
|
/* noop */
|
|
}
|
|
});
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.tabs.remove = function(tabId) {
|
|
tabId = toChromiumTabId(tabId);
|
|
if ( tabId === 0 ) {
|
|
return;
|
|
}
|
|
|
|
var onTabRemoved = function() {
|
|
// https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
if ( chrome.runtime.lastError ) {
|
|
/* noop */
|
|
}
|
|
};
|
|
|
|
chrome.tabs.remove(tabId, onTabRemoved);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.tabs.reload = function(tabId /*, flags*/) {
|
|
tabId = toChromiumTabId(tabId);
|
|
if ( tabId === 0 ) {
|
|
return;
|
|
}
|
|
|
|
var onReloaded = function() {
|
|
// https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
if ( chrome.runtime.lastError ) {
|
|
/* noop */
|
|
}
|
|
};
|
|
|
|
chrome.tabs.reload(tabId, onReloaded);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
// Select a specific tab.
|
|
|
|
vAPI.tabs.select = function(tabId) {
|
|
tabId = toChromiumTabId(tabId);
|
|
if ( tabId === 0 ) {
|
|
return;
|
|
}
|
|
|
|
chrome.tabs.update(tabId, { active: true }, function(tab) {
|
|
if ( chrome.runtime.lastError ) {
|
|
/* noop */
|
|
}
|
|
if ( !tab ) {
|
|
return;
|
|
}
|
|
chrome.windows.update(tab.windowId, { focused: true });
|
|
});
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.tabs.injectScript = function(tabId, details, callback) {
|
|
var onScriptExecuted = function() {
|
|
// https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
if ( chrome.runtime.lastError ) {
|
|
/* noop */
|
|
}
|
|
if ( typeof callback === 'function' ) {
|
|
callback();
|
|
}
|
|
};
|
|
if ( tabId ) {
|
|
chrome.tabs.executeScript(toChromiumTabId(tabId), details, onScriptExecuted);
|
|
} else {
|
|
chrome.tabs.executeScript(details, onScriptExecuted);
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
// Must read: https://code.google.com/p/chromium/issues/detail?id=410868#c8
|
|
|
|
// https://github.com/chrisaljoudi/uBlock/issues/19
|
|
// https://github.com/chrisaljoudi/uBlock/issues/207
|
|
// Since we may be called asynchronously, the tab id may not exist
|
|
// anymore, so this ensures it does still exist.
|
|
|
|
vAPI.setIcon = function(tabId, iconStatus, badge) {
|
|
tabId = toChromiumTabId(tabId);
|
|
if ( tabId === 0 ) {
|
|
return;
|
|
}
|
|
|
|
var onIconReady = function() {
|
|
if ( vAPI.lastError() ) {
|
|
return;
|
|
}
|
|
chrome.browserAction.setBadgeText({ tabId: tabId, text: badge });
|
|
if ( badge !== '' ) {
|
|
chrome.browserAction.setBadgeBackgroundColor({
|
|
tabId: tabId,
|
|
color: '#666'
|
|
});
|
|
}
|
|
};
|
|
|
|
var iconPaths = iconStatus === 'on' ?
|
|
{ '19': 'img/browsericons/icon19.png', '38': 'img/browsericons/icon38.png' } :
|
|
{ '19': 'img/browsericons/icon19-off.png', '38': 'img/browsericons/icon38-off.png' };
|
|
|
|
chrome.browserAction.setIcon({ tabId: tabId, path: iconPaths }, onIconReady);
|
|
vAPI.contextMenu.onMustUpdate(tabId);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging = {
|
|
ports: {},
|
|
listeners: {},
|
|
defaultHandler: null,
|
|
NOOPFUNC: noopFunc,
|
|
UNHANDLED: 'vAPI.messaging.notHandled'
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging.listen = function(listenerName, callback) {
|
|
this.listeners[listenerName] = callback;
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging.onPortMessage = (function() {
|
|
var messaging = vAPI.messaging,
|
|
toAuxPending = {};
|
|
|
|
// Use a wrapper to avoid closure and to allow reuse.
|
|
var CallbackWrapper = function(port, request, timeout) {
|
|
this.callback = this.proxy.bind(this); // bind once
|
|
this.init(port, request, timeout);
|
|
};
|
|
|
|
CallbackWrapper.prototype.init = function(port, request, timeout) {
|
|
this.port = port;
|
|
this.request = request;
|
|
this.timerId = timeout !== undefined ?
|
|
vAPI.setTimeout(this.callback, timeout) :
|
|
null;
|
|
return this;
|
|
};
|
|
|
|
CallbackWrapper.prototype.proxy = function(response) {
|
|
if ( this.timerId !== null ) {
|
|
clearTimeout(this.timerId);
|
|
delete toAuxPending[this.timerId];
|
|
this.timerId = null;
|
|
}
|
|
// https://github.com/chrisaljoudi/uBlock/issues/383
|
|
if ( messaging.ports.hasOwnProperty(this.port.name) ) {
|
|
this.port.postMessage({
|
|
auxProcessId: this.request.auxProcessId,
|
|
channelName: this.request.channelName,
|
|
msg: response !== undefined ? response : null
|
|
});
|
|
}
|
|
// Mark for reuse
|
|
this.port = this.request = null;
|
|
callbackWrapperJunkyard.push(this);
|
|
};
|
|
|
|
var callbackWrapperJunkyard = [];
|
|
|
|
var callbackWrapperFactory = function(port, request, timeout) {
|
|
var wrapper = callbackWrapperJunkyard.pop();
|
|
if ( wrapper ) {
|
|
return wrapper.init(port, request, timeout);
|
|
}
|
|
return new CallbackWrapper(port, request, timeout);
|
|
};
|
|
|
|
var toAux = function(details, portFrom) {
|
|
var port, portTo,
|
|
chromiumTabId = toChromiumTabId(details.toTabId);
|
|
|
|
// TODO: This could be an issue with a lot of tabs: easy to address
|
|
// with a port name to tab id map.
|
|
for ( var portName in messaging.ports ) {
|
|
if ( messaging.ports.hasOwnProperty(portName) === false ) {
|
|
continue;
|
|
}
|
|
// When sending to an auxiliary process, the target is always the
|
|
// port associated with the root frame.
|
|
port = messaging.ports[portName];
|
|
if ( port.sender.frameId === 0 && port.sender.tab.id === chromiumTabId ) {
|
|
portTo = port;
|
|
break;
|
|
}
|
|
}
|
|
|
|
var wrapper;
|
|
if ( details.auxProcessId !== undefined ) {
|
|
wrapper = callbackWrapperFactory(portFrom, details, 1023);
|
|
}
|
|
|
|
// Destination not found:
|
|
if ( portTo === undefined ) {
|
|
if ( wrapper !== undefined ) {
|
|
wrapper.callback();
|
|
}
|
|
return;
|
|
}
|
|
|
|
// As per HTML5, timer id is always an integer, thus suitable to be
|
|
// used as a key, and which value is safe to use across process
|
|
// boundaries.
|
|
if ( wrapper !== undefined ) {
|
|
toAuxPending[wrapper.timerId] = wrapper;
|
|
}
|
|
|
|
portTo.postMessage({
|
|
mainProcessId: wrapper && wrapper.timerId,
|
|
channelName: details.toChannel,
|
|
msg: details.msg
|
|
});
|
|
};
|
|
|
|
var toAuxResponse = function(details) {
|
|
var mainProcessId = details.mainProcessId;
|
|
if ( mainProcessId === undefined ) {
|
|
return;
|
|
}
|
|
if ( toAuxPending.hasOwnProperty(mainProcessId) === false ) {
|
|
return;
|
|
}
|
|
var wrapper = toAuxPending[mainProcessId];
|
|
delete toAuxPending[mainProcessId];
|
|
wrapper.callback(details.msg);
|
|
};
|
|
|
|
var toFramework = function(msg, sender) {
|
|
var tabId = sender && sender.tab && sender.tab.id;
|
|
if ( !tabId ) { return; }
|
|
switch ( msg.what ) {
|
|
case 'userCSS':
|
|
if ( msg.toRemove ) {
|
|
chrome.tabs.removeCSS(tabId, {
|
|
code: msg.toRemove,
|
|
cssOrigin: 'user',
|
|
frameId: sender.frameId,
|
|
matchAboutBlank: true
|
|
});
|
|
}
|
|
if ( msg.toAdd ) {
|
|
chrome.tabs.insertCSS(tabId, {
|
|
code: msg.toAdd,
|
|
cssOrigin: 'user',
|
|
frameId: sender.frameId,
|
|
matchAboutBlank: true,
|
|
runAt: 'document_start'
|
|
});
|
|
}
|
|
break;
|
|
}
|
|
};
|
|
|
|
return function(request, port) {
|
|
// Auxiliary process to auxiliary process
|
|
if ( request.toTabId !== undefined ) {
|
|
toAux(request, port);
|
|
return;
|
|
}
|
|
|
|
// Auxiliary process to auxiliary process: response
|
|
if ( request.mainProcessId !== undefined ) {
|
|
toAuxResponse(request);
|
|
return;
|
|
}
|
|
|
|
// Content process to main process: framework handler.
|
|
// No callback supported/needed for now.
|
|
if ( request.channelName === 'vapi-background' ) {
|
|
toFramework(request.msg, port.sender);
|
|
return;
|
|
}
|
|
|
|
// Auxiliary process to main process: prepare response
|
|
var callback = messaging.NOOPFUNC;
|
|
if ( request.auxProcessId !== undefined ) {
|
|
callback = callbackWrapperFactory(port, request).callback;
|
|
}
|
|
|
|
// Auxiliary process to main process: specific handler
|
|
var r = messaging.UNHANDLED,
|
|
listener = messaging.listeners[request.channelName];
|
|
if ( typeof listener === 'function' ) {
|
|
r = listener(request.msg, port.sender, callback);
|
|
}
|
|
if ( r !== messaging.UNHANDLED ) {
|
|
return;
|
|
}
|
|
|
|
// Auxiliary process to main process: default handler
|
|
r = messaging.defaultHandler(request.msg, port.sender, callback);
|
|
if ( r !== messaging.UNHANDLED ) {
|
|
return;
|
|
}
|
|
|
|
// Auxiliary process to main process: no handler
|
|
console.error('uBlock> messaging > unknown request: %o', request);
|
|
|
|
// Need to callback anyways in case caller expected an answer, or
|
|
// else there is a memory leak on caller's side
|
|
callback();
|
|
};
|
|
})();
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging.onPortDisconnect = function(port) {
|
|
port.onDisconnect.removeListener(vAPI.messaging.onPortDisconnect);
|
|
port.onMessage.removeListener(vAPI.messaging.onPortMessage);
|
|
delete vAPI.messaging.ports[port.name];
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging.onPortConnect = function(port) {
|
|
port.onDisconnect.addListener(vAPI.messaging.onPortDisconnect);
|
|
port.onMessage.addListener(vAPI.messaging.onPortMessage);
|
|
vAPI.messaging.ports[port.name] = port;
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging.setup = function(defaultHandler) {
|
|
// Already setup?
|
|
if ( this.defaultHandler !== null ) {
|
|
return;
|
|
}
|
|
|
|
if ( typeof defaultHandler !== 'function' ) {
|
|
defaultHandler = function(){ return vAPI.messaging.UNHANDLED; };
|
|
}
|
|
this.defaultHandler = defaultHandler;
|
|
|
|
chrome.runtime.onConnect.addListener(this.onPortConnect);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.messaging.broadcast = function(message) {
|
|
var messageWrapper = {
|
|
broadcast: true,
|
|
msg: message
|
|
};
|
|
|
|
for ( var portName in this.ports ) {
|
|
if ( this.ports.hasOwnProperty(portName) === false ) {
|
|
continue;
|
|
}
|
|
this.ports[portName].postMessage(messageWrapper);
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.net = {};
|
|
|
|
/******************************************************************************/
|
|
|
|
vAPI.net.registerListeners = function() {
|
|
var µb = µBlock,
|
|
µburi = µb.URI,
|
|
wrApi = chrome.webRequest;
|
|
|
|
// https://bugs.chromium.org/p/chromium/issues/detail?id=410382
|
|
// Between Chromium 38-48, plug-ins' network requests were reported as
|
|
// type "other" instead of "object".
|
|
var is_v38_48 = /\bChrom[a-z]+\/(?:3[89]|4[0-8])\.[\d.]+\b/.test(navigator.userAgent);
|
|
|
|
// legacy Chromium understands only these network request types.
|
|
var validTypes = {
|
|
main_frame: true,
|
|
sub_frame: true,
|
|
stylesheet: true,
|
|
script: true,
|
|
image: true,
|
|
object: true,
|
|
xmlhttprequest: true,
|
|
other: true
|
|
};
|
|
// modern Chromium/WebExtensions: more types available.
|
|
if ( wrApi.ResourceType ) {
|
|
(function() {
|
|
for ( var typeKey in wrApi.ResourceType ) {
|
|
if ( wrApi.ResourceType.hasOwnProperty(typeKey) ) {
|
|
validTypes[wrApi.ResourceType[typeKey]] = true;
|
|
}
|
|
}
|
|
})();
|
|
}
|
|
|
|
var extToTypeMap = new Map([
|
|
['eot','font'],['otf','font'],['svg','font'],['ttf','font'],['woff','font'],['woff2','font'],
|
|
['mp3','media'],['mp4','media'],['webm','media'],
|
|
['gif','image'],['ico','image'],['jpeg','image'],['jpg','image'],['png','image'],['webp','image']
|
|
]);
|
|
|
|
var denormalizeTypes = function(aa) {
|
|
if ( aa.length === 0 ) {
|
|
return Object.keys(validTypes);
|
|
}
|
|
var out = [];
|
|
var i = aa.length,
|
|
type,
|
|
needOther = true;
|
|
while ( i-- ) {
|
|
type = aa[i];
|
|
if ( validTypes[type] ) {
|
|
out.push(type);
|
|
}
|
|
if ( type === 'other' ) {
|
|
needOther = false;
|
|
}
|
|
}
|
|
if ( needOther ) {
|
|
out.push('other');
|
|
}
|
|
return out;
|
|
};
|
|
|
|
var headerValue = function(headers, name) {
|
|
var i = headers.length;
|
|
while ( i-- ) {
|
|
if ( headers[i].name.toLowerCase() === name ) {
|
|
return headers[i].value.trim();
|
|
}
|
|
}
|
|
return '';
|
|
};
|
|
|
|
var normalizeRequestDetails = function(details) {
|
|
details.tabId = details.tabId.toString();
|
|
|
|
var type = details.type;
|
|
|
|
// https://github.com/gorhill/uBlock/issues/1493
|
|
// Chromium 49+/WebExtensions support a new request type: `ping`,
|
|
// which is fired as a result of using `navigator.sendBeacon`.
|
|
if ( type === 'ping' ) {
|
|
details.type = 'beacon';
|
|
return;
|
|
}
|
|
|
|
if ( type === 'imageset' ) {
|
|
details.type = 'image';
|
|
return;
|
|
}
|
|
|
|
// The rest of the function code is to normalize type
|
|
if ( type !== 'other' ) {
|
|
return;
|
|
}
|
|
|
|
// Try to map known "extension" part of URL to request type.
|
|
var path = µburi.pathFromURI(details.url),
|
|
pos = path.indexOf('.', path.length - 6);
|
|
if ( pos !== -1 && (type = extToTypeMap.get(path.slice(pos + 1))) ) {
|
|
details.type = type;
|
|
return;
|
|
}
|
|
|
|
// Try to extract type from response headers if present.
|
|
if ( details.responseHeaders ) {
|
|
type = headerValue(details.responseHeaders, 'content-type');
|
|
if ( type.startsWith('font/') ) {
|
|
details.type = 'font';
|
|
return;
|
|
}
|
|
if ( type.startsWith('image/') ) {
|
|
details.type = 'image';
|
|
return;
|
|
}
|
|
if ( type.startsWith('audio/') || type.startsWith('video/') ) {
|
|
details.type = 'media';
|
|
return;
|
|
}
|
|
}
|
|
|
|
// https://github.com/chrisaljoudi/uBlock/issues/862
|
|
// If no transposition possible, transpose to `object` as per
|
|
// Chromium bug 410382
|
|
// https://code.google.com/p/chromium/issues/detail?id=410382
|
|
if ( is_v38_48 ) {
|
|
details.type = 'object';
|
|
}
|
|
};
|
|
|
|
// https://bugs.chromium.org/p/chromium/issues/detail?id=129353
|
|
// https://github.com/gorhill/uBlock/issues/1497
|
|
// Expose websocket-based network requests to uBO's filtering engine,
|
|
// logger, etc.
|
|
// Counterpart of following block of code is found in "vapi-client.js" --
|
|
// search for "https://github.com/gorhill/uBlock/issues/1497".
|
|
//
|
|
// Once uBO 1.11.1 and uBO-Extra 2.12 are widespread, the image-based
|
|
// handling code can be removed.
|
|
var onBeforeWebsocketRequest = function(details) {
|
|
if ( (details.type !== 'image') &&
|
|
(details.method !== 'HEAD' || details.type !== 'xmlhttprequest')
|
|
) {
|
|
return;
|
|
}
|
|
var requestURL = details.url,
|
|
matches = /[?&]u(?:rl)?=([^&]+)/.exec(requestURL);
|
|
if ( matches === null ) { return; }
|
|
details.type = 'websocket';
|
|
details.url = decodeURIComponent(matches[1]);
|
|
var r = onBeforeRequestClient(details);
|
|
if ( r && r.cancel ) { return r; }
|
|
// Redirect to the provided URL, or a 1x1 data: URI if none provided.
|
|
matches = /[?&]r=([^&]+)/.exec(requestURL);
|
|
return {
|
|
redirectUrl: matches !== null ?
|
|
decodeURIComponent(matches[1]) :
|
|
'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='
|
|
};
|
|
};
|
|
|
|
var onBeforeRequestClient = this.onBeforeRequest.callback;
|
|
var onBeforeRequest = validTypes.websocket
|
|
// modern Chromium/WebExtensions: type 'websocket' is supported
|
|
? function(details) {
|
|
normalizeRequestDetails(details);
|
|
return onBeforeRequestClient(details);
|
|
}
|
|
// legacy Chromium
|
|
: function(details) {
|
|
// https://github.com/gorhill/uBlock/issues/1497
|
|
if ( details.url.endsWith('ubofix=f41665f3028c7fd10eecf573336216d3') ) {
|
|
var r = onBeforeWebsocketRequest(details);
|
|
if ( r !== undefined ) { return r; }
|
|
}
|
|
normalizeRequestDetails(details);
|
|
return onBeforeRequestClient(details);
|
|
};
|
|
|
|
// This is needed for Chromium 49-55.
|
|
var onBeforeSendHeaders = validTypes.csp_report
|
|
// modern Chromium/WebExtensions: type 'csp_report' is supported
|
|
? null
|
|
// legacy Chromium
|
|
: function(details) {
|
|
if ( details.type !== 'ping' || details.method !== 'POST' ) { return; }
|
|
var type = headerValue(details.requestHeaders, 'content-type');
|
|
if ( type === '' ) { return; }
|
|
if ( type.endsWith('/csp-report') ) {
|
|
details.type = 'csp_report';
|
|
return onBeforeRequestClient(details);
|
|
}
|
|
};
|
|
|
|
var onHeadersReceivedClient = this.onHeadersReceived.callback,
|
|
onHeadersReceivedClientTypes = this.onHeadersReceived.types.slice(0),
|
|
onHeadersReceivedTypes = denormalizeTypes(onHeadersReceivedClientTypes);
|
|
var onHeadersReceived = validTypes.font
|
|
// modern Chromium/WebExtensions: type 'font' is supported
|
|
? function(details) {
|
|
normalizeRequestDetails(details);
|
|
if (
|
|
onHeadersReceivedClientTypes.length !== 0 &&
|
|
onHeadersReceivedClientTypes.indexOf(details.type) === -1
|
|
) {
|
|
return;
|
|
}
|
|
return onHeadersReceivedClient(details);
|
|
}
|
|
// legacy Chromium
|
|
: function(details) {
|
|
normalizeRequestDetails(details);
|
|
// Hack to work around Chromium API limitations, where requests of
|
|
// type `font` are returned as `other`. For example, our normalization
|
|
// fail at transposing `other` into `font` for URLs which are outside
|
|
// what is expected. At least when headers are received we can check
|
|
// for content type `font/*`. Blocking at onHeadersReceived time is
|
|
// less worse than not blocking at all. Also, due to Chromium bug,
|
|
// `other` always becomes `object` when it can't be normalized into
|
|
// something else. Test case for "unfriendly" font URLs:
|
|
// https://www.google.com/fonts
|
|
if ( details.type === 'font' ) {
|
|
var r = onBeforeRequestClient(details);
|
|
if ( typeof r === 'object' && r.cancel === true ) {
|
|
return { cancel: true };
|
|
}
|
|
}
|
|
if (
|
|
onHeadersReceivedClientTypes.length !== 0 &&
|
|
onHeadersReceivedClientTypes.indexOf(details.type) === -1
|
|
) {
|
|
return;
|
|
}
|
|
return onHeadersReceivedClient(details);
|
|
};
|
|
|
|
var urls, types;
|
|
|
|
if ( onBeforeRequest ) {
|
|
urls = this.onBeforeRequest.urls || ['<all_urls>'];
|
|
types = this.onBeforeRequest.types || undefined;
|
|
if (
|
|
(validTypes.websocket) &&
|
|
(types === undefined || types.indexOf('websocket') !== -1) &&
|
|
(urls.indexOf('<all_urls>') === -1)
|
|
) {
|
|
if ( urls.indexOf('ws://*/*') === -1 ) {
|
|
urls.push('ws://*/*');
|
|
}
|
|
if ( urls.indexOf('wss://*/*') === -1 ) {
|
|
urls.push('wss://*/*');
|
|
}
|
|
}
|
|
wrApi.onBeforeRequest.addListener(
|
|
onBeforeRequest,
|
|
{ urls: urls, types: types },
|
|
this.onBeforeRequest.extra
|
|
);
|
|
}
|
|
|
|
// Chromium 48 and lower does not support `ping` type.
|
|
// Chromium 56 and higher does support `csp_report` stype.
|
|
if ( onBeforeSendHeaders ) {
|
|
wrApi.onBeforeSendHeaders.addListener(
|
|
onBeforeSendHeaders,
|
|
{
|
|
'urls': [ '<all_urls>' ],
|
|
'types': [ 'ping' ]
|
|
},
|
|
[ 'blocking', 'requestHeaders' ]
|
|
);
|
|
}
|
|
|
|
if ( onHeadersReceived ) {
|
|
urls = this.onHeadersReceived.urls || ['<all_urls>'];
|
|
types = onHeadersReceivedTypes;
|
|
wrApi.onHeadersReceived.addListener(
|
|
onHeadersReceived,
|
|
{ urls: urls, types: types },
|
|
this.onHeadersReceived.extra
|
|
);
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.contextMenu = {
|
|
_callback: null,
|
|
_entries: [],
|
|
_createEntry: function(entry) {
|
|
chrome.contextMenus.create(JSON.parse(JSON.stringify(entry)), function() {
|
|
void chrome.runtime.lastError;
|
|
});
|
|
},
|
|
onMustUpdate: function() {},
|
|
setEntries: function(entries, callback) {
|
|
entries = entries || [];
|
|
var n = Math.max(this._entries.length, entries.length),
|
|
oldEntryId, newEntry;
|
|
for ( var i = 0; i < n; i++ ) {
|
|
oldEntryId = this._entries[i];
|
|
newEntry = entries[i];
|
|
if ( oldEntryId && newEntry ) {
|
|
if ( newEntry.id !== oldEntryId ) {
|
|
chrome.contextMenus.remove(oldEntryId);
|
|
this._createEntry(newEntry);
|
|
this._entries[i] = newEntry.id;
|
|
}
|
|
} else if ( oldEntryId && !newEntry ) {
|
|
chrome.contextMenus.remove(oldEntryId);
|
|
} else if ( !oldEntryId && newEntry ) {
|
|
this._createEntry(newEntry);
|
|
this._entries[i] = newEntry.id;
|
|
}
|
|
}
|
|
n = this._entries.length = entries.length;
|
|
callback = callback || null;
|
|
if ( callback === this._callback ) {
|
|
return;
|
|
}
|
|
if ( n !== 0 && callback !== null ) {
|
|
chrome.contextMenus.onClicked.addListener(callback);
|
|
this._callback = callback;
|
|
} else if ( n === 0 && this._callback !== null ) {
|
|
chrome.contextMenus.onClicked.removeListener(this._callback);
|
|
this._callback = null;
|
|
}
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.commands = chrome.commands;
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.lastError = function() {
|
|
return chrome.runtime.lastError;
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
// This is called only once, when everything has been loaded in memory after
|
|
// the extension was launched. It can be used to inject content scripts
|
|
// in already opened web pages, to remove whatever nuisance could make it to
|
|
// the web pages before uBlock was ready.
|
|
|
|
vAPI.onLoadAllCompleted = function() {
|
|
// http://code.google.com/p/chromium/issues/detail?id=410868#c11
|
|
// Need to be sure to access `vAPI.lastError()` to prevent
|
|
// spurious warnings in the console.
|
|
var scriptDone = function() {
|
|
vAPI.lastError();
|
|
};
|
|
var scriptStart = function(tabId) {
|
|
vAPI.tabs.injectScript(tabId, {
|
|
file: 'js/vapi-client.js',
|
|
allFrames: true,
|
|
runAt: 'document_idle'
|
|
}, function(){ });
|
|
vAPI.tabs.injectScript(tabId, {
|
|
file: 'js/contentscript.js',
|
|
allFrames: true,
|
|
runAt: 'document_idle'
|
|
}, scriptDone);
|
|
};
|
|
var bindToTabs = function(tabs) {
|
|
var µb = µBlock;
|
|
var i = tabs.length, tab;
|
|
while ( i-- ) {
|
|
tab = tabs[i];
|
|
µb.tabContextManager.commit(tab.id, tab.url);
|
|
µb.bindTabToPageStats(tab.id);
|
|
// https://github.com/chrisaljoudi/uBlock/issues/129
|
|
if ( /^https?:\/\//.test(tab.url) ) {
|
|
scriptStart(tab.id);
|
|
}
|
|
}
|
|
};
|
|
|
|
chrome.tabs.query({ url: '<all_urls>' }, bindToTabs);
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.punycodeHostname = function(hostname) {
|
|
return hostname;
|
|
};
|
|
|
|
vAPI.punycodeURL = function(url) {
|
|
return url;
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
// https://github.com/gorhill/uBlock/issues/531
|
|
// Storage area dedicated to admin settings. Read-only.
|
|
|
|
// https://github.com/gorhill/uBlock/commit/43a5ed735b95a575a9339b6e71a1fcb27a99663b#commitcomment-13965030
|
|
// Not all Chromium-based browsers support managed storage. Merely testing or
|
|
// exception handling in this case does NOT work: I don't know why. The
|
|
// extension on Opera ends up in a non-sensical state, whereas vAPI become
|
|
// undefined out of nowhere. So only solution left is to test explicitly for
|
|
// Opera.
|
|
// https://github.com/gorhill/uBlock/issues/900
|
|
// Also, UC Browser: http://www.upsieutoc.com/image/WXuH
|
|
|
|
vAPI.adminStorage = {
|
|
getItem: function(key, callback) {
|
|
var onRead = function(store) {
|
|
var data;
|
|
if (
|
|
!chrome.runtime.lastError &&
|
|
typeof store === 'object' &&
|
|
store !== null
|
|
) {
|
|
data = store[key];
|
|
}
|
|
callback(data);
|
|
};
|
|
try {
|
|
chrome.storage.managed.get(key, onRead);
|
|
} catch (ex) {
|
|
callback();
|
|
}
|
|
}
|
|
};
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
vAPI.cloud = (function() {
|
|
// Not all platforms support `chrome.storage.sync`.
|
|
if ( chrome.storage.sync instanceof Object === false ) {
|
|
return;
|
|
}
|
|
|
|
var chunkCountPerFetch = 16; // Must be a power of 2
|
|
|
|
// Mind chrome.storage.sync.MAX_ITEMS (512 at time of writing)
|
|
var maxChunkCountPerItem = Math.floor(512 * 0.75) & ~(chunkCountPerFetch - 1);
|
|
|
|
// Mind chrome.storage.sync.QUOTA_BYTES_PER_ITEM (8192 at time of writing)
|
|
var maxChunkSize = Math.floor(chrome.storage.sync.QUOTA_BYTES_PER_ITEM * 0.75 || 6144);
|
|
|
|
// Mind chrome.storage.sync.QUOTA_BYTES (128 kB at time of writing)
|
|
// Firefox:
|
|
// https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage/sync
|
|
// > You can store up to 100KB of data using this API/
|
|
var maxStorageSize = chrome.storage.sync.QUOTA_BYTES || 102400;
|
|
|
|
var options = {
|
|
defaultDeviceName: window.navigator.platform,
|
|
deviceName: window.localStorage.getItem('deviceName') || ''
|
|
};
|
|
|
|
// This is used to find out a rough count of how many chunks exists:
|
|
// We "poll" at specific index in order to get a rough idea of how
|
|
// large is the stored string.
|
|
// This allows reading a single item with only 2 sync operations -- a
|
|
// good thing given chrome.storage.sync.MAX_WRITE_OPERATIONS_PER_MINUTE
|
|
// and chrome.storage.sync.MAX_WRITE_OPERATIONS_PER_HOUR.
|
|
|
|
var getCoarseChunkCount = function(dataKey, callback) {
|
|
var bin = {};
|
|
for ( var i = 0; i < maxChunkCountPerItem; i += 16 ) {
|
|
bin[dataKey + i.toString()] = '';
|
|
}
|
|
|
|
chrome.storage.sync.get(bin, function(bin) {
|
|
if ( chrome.runtime.lastError ) {
|
|
callback(0, chrome.runtime.lastError.message);
|
|
return;
|
|
}
|
|
|
|
var chunkCount = 0;
|
|
for ( var i = 0; i < maxChunkCountPerItem; i += 16 ) {
|
|
if ( bin[dataKey + i.toString()] === '' ) {
|
|
break;
|
|
}
|
|
chunkCount = i + 16;
|
|
}
|
|
|
|
callback(chunkCount);
|
|
});
|
|
};
|
|
|
|
var deleteChunks = function(dataKey, start) {
|
|
var keys = [];
|
|
|
|
// No point in deleting more than:
|
|
// - The max number of chunks per item
|
|
// - The max number of chunks per storage limit
|
|
var n = Math.min(
|
|
maxChunkCountPerItem,
|
|
Math.ceil(maxStorageSize / maxChunkSize)
|
|
);
|
|
for ( var i = start; i < n; i++ ) {
|
|
keys.push(dataKey + i.toString());
|
|
}
|
|
chrome.storage.sync.remove(keys);
|
|
};
|
|
|
|
var start = function(/* dataKeys */) {
|
|
};
|
|
|
|
var push = function(dataKey, data, callback) {
|
|
var bin = {
|
|
'source': options.deviceName || options.defaultDeviceName,
|
|
'tstamp': Date.now(),
|
|
'data': data,
|
|
'size': 0
|
|
};
|
|
bin.size = JSON.stringify(bin).length;
|
|
var item = JSON.stringify(bin);
|
|
|
|
// Chunkify taking into account QUOTA_BYTES_PER_ITEM:
|
|
// https://developer.chrome.com/extensions/storage#property-sync
|
|
// "The maximum size (in bytes) of each individual item in sync
|
|
// "storage, as measured by the JSON stringification of its value
|
|
// "plus its key length."
|
|
bin = {};
|
|
var chunkCount = Math.ceil(item.length / maxChunkSize);
|
|
for ( var i = 0; i < chunkCount; i++ ) {
|
|
bin[dataKey + i.toString()] = item.substr(i * maxChunkSize, maxChunkSize);
|
|
}
|
|
bin[dataKey + i.toString()] = ''; // Sentinel
|
|
|
|
chrome.storage.sync.set(bin, function() {
|
|
var errorStr;
|
|
if ( chrome.runtime.lastError ) {
|
|
errorStr = chrome.runtime.lastError.message;
|
|
}
|
|
callback(errorStr);
|
|
|
|
// Remove potentially unused trailing chunks
|
|
deleteChunks(dataKey, chunkCount);
|
|
});
|
|
};
|
|
|
|
var pull = function(dataKey, callback) {
|
|
var assembleChunks = function(bin) {
|
|
if ( chrome.runtime.lastError ) {
|
|
callback(null, chrome.runtime.lastError.message);
|
|
return;
|
|
}
|
|
|
|
// Assemble chunks into a single string.
|
|
var json = [], jsonSlice;
|
|
var i = 0;
|
|
for (;;) {
|
|
jsonSlice = bin[dataKey + i.toString()];
|
|
if ( jsonSlice === '' ) {
|
|
break;
|
|
}
|
|
json.push(jsonSlice);
|
|
i += 1;
|
|
}
|
|
|
|
var entry = null;
|
|
try {
|
|
entry = JSON.parse(json.join(''));
|
|
} catch(ex) {
|
|
}
|
|
callback(entry);
|
|
};
|
|
|
|
var fetchChunks = function(coarseCount, errorStr) {
|
|
if ( coarseCount === 0 || typeof errorStr === 'string' ) {
|
|
callback(null, errorStr);
|
|
return;
|
|
}
|
|
|
|
var bin = {};
|
|
for ( var i = 0; i < coarseCount; i++ ) {
|
|
bin[dataKey + i.toString()] = '';
|
|
}
|
|
|
|
chrome.storage.sync.get(bin, assembleChunks);
|
|
};
|
|
|
|
getCoarseChunkCount(dataKey, fetchChunks);
|
|
};
|
|
|
|
var getOptions = function(callback) {
|
|
if ( typeof callback !== 'function' ) {
|
|
return;
|
|
}
|
|
callback(options);
|
|
};
|
|
|
|
var setOptions = function(details, callback) {
|
|
if ( typeof details !== 'object' || details === null ) {
|
|
return;
|
|
}
|
|
|
|
if ( typeof details.deviceName === 'string' ) {
|
|
window.localStorage.setItem('deviceName', details.deviceName);
|
|
options.deviceName = details.deviceName;
|
|
}
|
|
|
|
getOptions(callback);
|
|
};
|
|
|
|
return {
|
|
start: start,
|
|
push: push,
|
|
pull: pull,
|
|
getOptions: getOptions,
|
|
setOptions: setOptions
|
|
};
|
|
})();
|
|
|
|
/******************************************************************************/
|
|
/******************************************************************************/
|
|
|
|
})();
|
|
|
|
/******************************************************************************/
|