uBlock/src/js/messaging.js

1269 lines
37 KiB
JavaScript
Raw Normal View History

2014-06-24 00:42:43 +02:00
/*******************************************************************************
uBlock Origin - a browser extension to block requests.
Copyright (C) 2014-2016 Raymond Hill
2014-06-24 00:42:43 +02:00
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
*/
/******************************************************************************/
/******************************************************************************/
2016-08-06 18:05:01 +02:00
'use strict';
// Default handler
(function() {
/******************************************************************************/
var µb = µBlock;
/******************************************************************************/
var getDomainNames = function(targets) {
var out = [];
var µburi = µb.URI;
var target, domain;
for ( var i = 0; i < targets.length; i++ ) {
target = targets[i];
if ( target.indexOf('/') !== -1 ) {
domain = µburi.domainFromURI(target) || '';
} else {
domain = µburi.domainFromHostname(target) || target;
}
out.push(domain);
}
return out;
};
/******************************************************************************/
var onMessage = function(request, sender, callback) {
// Async
switch ( request.what ) {
case 'getAssetContent':
// https://github.com/chrisaljoudi/uBlock/issues/417
µb.assets.get(request.url, callback);
return;
case 'listsFromNetFilter':
µb.staticFilteringReverseLookup.fromNetFilter(
request.compiledFilter,
request.rawFilter,
callback
);
return;
case 'listsFromCosmeticFilter':
µb.staticFilteringReverseLookup.fromCosmeticFilter(
request.hostname,
request.rawFilter,
callback
);
return;
2015-06-26 06:08:41 +02:00
case 'reloadAllFilters':
µb.reloadAllFilters(callback);
return;
case 'scriptlet':
µb.scriptlets.inject(request.tabId, request.scriptlet, callback);
return;
default:
break;
}
var tabId = sender && sender.tab ? sender.tab.id : 0;
// Sync
var response;
switch ( request.what ) {
case 'mouseClick':
µb.mouseX = request.x;
µb.mouseY = request.y;
µb.mouseURL = request.url;
break;
case 'cosmeticFiltersInjected':
µb.cosmeticFilteringEngine.addToSelectorCache(request);
/* falls through */
case 'cosmeticFiltersActivated':
// Net-based cosmetic filters are of no interest for logging purpose.
2015-05-19 19:59:53 +02:00
if ( µb.logger.isEnabled() && request.type !== 'net' ) {
µb.logCosmeticFilters(tabId);
}
break;
2015-03-11 04:46:18 +01:00
case 'createUserFilter':
µb.appendUserFilters(request.filters);
2016-07-07 22:42:01 +02:00
// https://github.com/gorhill/uBlock/issues/1786
µb.cosmeticFilteringEngine.removeFromSelectorCache(request.pageDomain);
break;
case 'forceUpdateAssets':
µb.assetUpdater.force();
break;
2014-12-01 17:25:33 +01:00
case 'getAppData':
response = {name: vAPI.app.name, version: vAPI.app.version};
break;
case 'getDomainNames':
response = getDomainNames(request.targets);
break;
2016-03-06 16:51:06 +01:00
case 'getWhitelist':
response = µb.stringFromWhitelist(µb.netWhitelist);
break;
case 'launchElementPicker':
// Launched from some auxiliary pages, clear context menu coords.
µb.mouseX = µb.mouseY = -1;
µb.elementPickerExec(request.tabId, request.targetURL || '');
break;
case 'gotoURL':
vAPI.tabs.open(request.details);
break;
case 'reloadTab':
if ( vAPI.isBehindTheSceneTabId(request.tabId) === false ) {
vAPI.tabs.reload(request.tabId);
if ( request.select && vAPI.tabs.select ) {
vAPI.tabs.select(request.tabId);
}
}
break;
2015-06-26 06:08:41 +02:00
case 'scriptletResponse':
µb.scriptlets.report(tabId, request.scriptlet, request.response);
break;
case 'selectFilterLists':
µb.selectFilterLists(request.switches);
break;
2015-03-11 04:46:18 +01:00
2016-03-06 16:51:06 +01:00
case 'setWhitelist':
µb.netWhitelist = µb.whitelistFromString(request.whitelist);
µb.saveWhitelist();
break;
case 'toggleHostnameSwitch':
µb.toggleHostnameSwitch(request);
break;
2015-03-27 18:00:55 +01:00
case 'userSettings':
response = µb.changeUserSettings(request.name, request.value);
break;
default:
return vAPI.messaging.UNHANDLED;
}
callback(response);
};
vAPI.messaging.setup(onMessage);
/******************************************************************************/
})();
2014-09-14 22:20:40 +02:00
/******************************************************************************/
2014-06-24 00:42:43 +02:00
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: popupPanel
2014-09-28 18:05:46 +02:00
2014-06-24 00:42:43 +02:00
(function() {
2014-09-28 18:05:46 +02:00
/******************************************************************************/
var µb = µBlock;
2014-06-24 00:42:43 +02:00
/******************************************************************************/
2014-12-30 22:36:29 +01:00
var getHostnameDict = function(hostnameToCountMap) {
2015-02-17 03:15:09 +01:00
var r = {}, de;
2015-01-08 16:37:19 +01:00
var domainFromHostname = µb.URI.domainFromHostname;
2015-02-17 03:15:09 +01:00
var domain, counts, blockCount, allowCount;
2014-12-30 22:36:29 +01:00
for ( var hostname in hostnameToCountMap ) {
if ( hostnameToCountMap.hasOwnProperty(hostname) === false ) {
continue;
}
if ( r.hasOwnProperty(hostname) ) {
continue;
}
2015-01-11 15:47:14 +01:00
domain = domainFromHostname(hostname) || hostname;
2014-12-30 22:36:29 +01:00
counts = hostnameToCountMap[domain] || 0;
2015-02-17 03:15:09 +01:00
blockCount = counts & 0xFFFF;
allowCount = counts >>> 16 & 0xFFFF;
if ( r.hasOwnProperty(domain) === false ) {
de = r[domain] = {
domain: domain,
blockCount: blockCount,
allowCount: allowCount,
2016-02-22 21:54:07 +01:00
totalBlockCount: blockCount,
totalAllowCount: allowCount
2015-02-17 03:15:09 +01:00
};
} else {
de = r[domain];
}
counts = hostnameToCountMap[hostname] || 0;
blockCount = counts & 0xFFFF;
allowCount = counts >>> 16 & 0xFFFF;
de.totalBlockCount += blockCount;
de.totalAllowCount += allowCount;
2014-12-30 22:36:29 +01:00
if ( hostname === domain ) {
continue;
}
r[hostname] = {
domain: domain,
2015-02-17 03:15:09 +01:00
blockCount: blockCount,
allowCount: allowCount,
totalBlockCount: 0,
totalAllowCount: 0
2014-12-30 22:36:29 +01:00
};
}
return r;
};
/******************************************************************************/
var getFirewallRules = function(srcHostname, desHostnames) {
var r = {};
2015-05-21 20:15:17 +02:00
var df = µb.sessionFirewall;
r['/ * *'] = df.evaluateCellZY('*', '*', '*').toFilterString();
r['/ * image'] = df.evaluateCellZY('*', '*', 'image').toFilterString();
r['/ * 3p'] = df.evaluateCellZY('*', '*', '3p').toFilterString();
r['/ * inline-script'] = df.evaluateCellZY('*', '*', 'inline-script').toFilterString();
r['/ * 1p-script'] = df.evaluateCellZY('*', '*', '1p-script').toFilterString();
r['/ * 3p-script'] = df.evaluateCellZY('*', '*', '3p-script').toFilterString();
r['/ * 3p-frame'] = df.evaluateCellZY('*', '*', '3p-frame').toFilterString();
2014-12-30 22:36:29 +01:00
if ( typeof srcHostname !== 'string' ) {
return r;
}
2015-05-21 20:15:17 +02:00
r['. * *'] = df.evaluateCellZY(srcHostname, '*', '*').toFilterString();
r['. * image'] = df.evaluateCellZY(srcHostname, '*', 'image').toFilterString();
r['. * 3p'] = df.evaluateCellZY(srcHostname, '*', '3p').toFilterString();
r['. * inline-script'] = df.evaluateCellZY(srcHostname, '*', 'inline-script').toFilterString();
r['. * 1p-script'] = df.evaluateCellZY(srcHostname, '*', '1p-script').toFilterString();
r['. * 3p-script'] = df.evaluateCellZY(srcHostname, '*', '3p-script').toFilterString();
r['. * 3p-frame'] = df.evaluateCellZY(srcHostname, '*', '3p-frame').toFilterString();
2014-12-30 22:36:29 +01:00
for ( var desHostname in desHostnames ) {
if ( desHostnames.hasOwnProperty(desHostname) ) {
2015-05-21 20:15:17 +02:00
r['/ ' + desHostname + ' *'] = df.evaluateCellZY('*', desHostname, '*').toFilterString();
r['. ' + desHostname + ' *'] = df.evaluateCellZY(srcHostname, desHostname, '*').toFilterString();
2014-12-30 22:36:29 +01:00
}
}
return r;
2014-10-06 20:02:44 +02:00
};
/******************************************************************************/
2015-05-18 16:39:20 +02:00
var popupDataFromTabId = function(tabId, tabTitle) {
2015-12-02 06:59:51 +01:00
var tabContext = µb.tabContextManager.mustLookup(tabId);
var rootHostname = tabContext.rootHostname;
2014-06-24 00:42:43 +02:00
var r = {
advancedUserEnabled: µb.userSettings.advancedUserEnabled,
2014-12-01 17:25:33 +01:00
appName: vAPI.app.name,
appVersion: vAPI.app.version,
colorBlindFriendly: µb.userSettings.colorBlindFriendly,
cosmeticFilteringSwitch: false,
dfEnabled: µb.userSettings.dynamicFilteringEnabled,
2015-02-17 03:15:09 +01:00
firewallPaneMinimized: µb.userSettings.firewallPaneMinimized,
2014-06-24 00:42:43 +02:00
globalAllowedRequestCount: µb.localSettings.allowedRequestCount,
globalBlockedRequestCount: µb.localSettings.blockedRequestCount,
netFilteringSwitch: false,
2015-04-09 00:46:08 +02:00
rawURL: tabContext.rawURL,
pageURL: tabContext.normalURL,
pageHostname: rootHostname,
2015-04-09 00:46:08 +02:00
pageDomain: tabContext.rootDomain,
2014-06-24 00:42:43 +02:00
pageAllowedRequestCount: 0,
pageBlockedRequestCount: 0,
2016-01-04 16:48:28 +01:00
popupBlockedCount: 0,
2015-03-02 19:49:34 +01:00
tabId: tabId,
tabTitle: tabTitle,
tooltipsDisabled: µb.userSettings.tooltipsDisabled
2014-06-24 00:42:43 +02:00
};
2015-04-09 00:46:08 +02:00
2014-12-30 22:36:29 +01:00
var pageStore = µb.pageStoreFromTabId(tabId);
2014-06-24 00:42:43 +02:00
if ( pageStore ) {
r.pageBlockedRequestCount = pageStore.perLoadBlockedRequestCount;
r.pageAllowedRequestCount = pageStore.perLoadAllowedRequestCount;
2014-08-02 17:40:27 +02:00
r.netFilteringSwitch = pageStore.getNetFilteringSwitch();
2014-12-30 22:36:29 +01:00
r.hostnameDict = getHostnameDict(pageStore.hostnameToCountMap);
2015-01-10 17:23:28 +01:00
r.contentLastModified = pageStore.contentLastModified;
r.firewallRules = getFirewallRules(rootHostname, r.hostnameDict);
r.canElementPicker = rootHostname.indexOf('.') !== -1;
r.noPopups = µb.hnSwitches.evaluateZ('no-popups', rootHostname);
2016-01-04 16:48:28 +01:00
r.popupBlockedCount = pageStore.popupBlockedCount;
r.noCosmeticFiltering = µb.hnSwitches.evaluateZ('no-cosmetic-filtering', rootHostname);
r.noLargeMedia = µb.hnSwitches.evaluateZ('no-large-media', rootHostname);
r.largeMediaCount = pageStore.largeMediaCount;
r.noRemoteFonts = µb.hnSwitches.evaluateZ('no-remote-fonts', rootHostname);
r.remoteFontCount = pageStore.remoteFontCount;
2014-12-30 22:36:29 +01:00
} else {
r.hostnameDict = {};
r.firewallRules = getFirewallRules();
}
2015-04-09 00:46:08 +02:00
r.matrixIsDirty = !µb.sessionFirewall.hasSameRules(
µb.permanentFirewall,
rootHostname,
2015-04-09 00:46:08 +02:00
r.hostnameDict
);
2014-06-24 00:42:43 +02:00
return r;
};
/******************************************************************************/
2015-05-18 16:39:20 +02:00
var popupDataFromRequest = function(request, callback) {
if ( request.tabId ) {
callback(popupDataFromTabId(request.tabId, ''));
return;
}
2015-01-21 17:13:32 +01:00
2015-05-18 16:39:20 +02:00
// Still no target tab id? Use currently selected tab.
vAPI.tabs.get(null, function(tab) {
var tabId = '';
var tabTitle = '';
if ( tab ) {
tabId = tab.id;
tabTitle = tab.title || '';
}
callback(popupDataFromTabId(tabId, tabTitle));
});
};
/******************************************************************************/
2014-06-24 00:42:43 +02:00
var onMessage = function(request, sender, callback) {
2016-08-06 18:05:01 +02:00
var pageStore;
2014-06-24 00:42:43 +02:00
// Async
switch ( request.what ) {
2016-08-06 18:05:01 +02:00
case 'getPopupLazyData':
pageStore = µb.pageStoreFromTabId(request.tabId);
if ( pageStore !== null ) {
pageStore.hiddenElementCount = 0;
µb.scriptlets.injectDeep(request.tabId, 'cosmetic-survey');
}
2015-04-24 14:36:19 +02:00
return;
2015-04-24 14:36:19 +02:00
case 'getPopupData':
2015-05-18 16:39:20 +02:00
popupDataFromRequest(request, callback);
2015-04-24 14:36:19 +02:00
return;
2015-04-24 14:36:19 +02:00
default:
break;
2014-06-24 00:42:43 +02:00
}
// Sync
var response;
switch ( request.what ) {
2015-04-24 14:36:19 +02:00
case 'hasPopupContentChanged':
pageStore = µb.pageStoreFromTabId(request.tabId);
var lastModified = pageStore ? pageStore.contentLastModified : 0;
response = lastModified !== request.contentLastModified;
break;
case 'revertFirewallRules':
µb.sessionFirewall.copyRules(
µb.permanentFirewall,
request.srcHostname,
request.desHostnames
);
2015-05-09 14:25:05 +02:00
// https://github.com/gorhill/uBlock/issues/188
µb.cosmeticFilteringEngine.removeFromSelectorCache(request.srcHostname, 'net');
2015-05-18 16:39:20 +02:00
response = popupDataFromTabId(request.tabId);
2015-04-24 14:36:19 +02:00
break;
case 'saveFirewallRules':
µb.permanentFirewall.copyRules(
µb.sessionFirewall,
request.srcHostname,
request.desHostnames
);
µb.savePermanentFirewallRules();
break;
case 'toggleFirewallRule':
µb.toggleFirewallRule(request);
2015-05-18 16:39:20 +02:00
response = popupDataFromTabId(request.tabId);
2015-04-24 14:36:19 +02:00
break;
case 'toggleNetFiltering':
pageStore = µb.pageStoreFromTabId(request.tabId);
if ( pageStore ) {
pageStore.toggleNetFilteringSwitch(request.url, request.scope, request.state);
µb.updateBadgeAsync(request.tabId);
}
break;
2014-06-24 00:42:43 +02:00
2015-04-24 14:36:19 +02:00
default:
return vAPI.messaging.UNHANDLED;
2014-06-24 00:42:43 +02:00
}
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('popupPanel', onMessage);
2014-09-28 18:05:46 +02:00
/******************************************************************************/
2014-06-24 00:42:43 +02:00
})();
2014-09-14 22:20:40 +02:00
/******************************************************************************/
2014-06-24 00:42:43 +02:00
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: contentscript
2014-06-27 23:06:42 +02:00
(function() {
2014-09-28 18:05:46 +02:00
/******************************************************************************/
2014-08-02 17:40:27 +02:00
var µb = µBlock;
2014-09-14 22:20:40 +02:00
/******************************************************************************/
var tagNameToRequestTypeMap = {
'embed': 'object',
'iframe': 'sub_frame',
'img': 'image',
'object': 'object'
};
/******************************************************************************/
// Evaluate many requests.
// https://github.com/gorhill/uBlock/issues/1782
// Treat `data:` URIs as 1st-party resources.
2014-09-14 22:20:40 +02:00
var filterRequests = function(pageStore, details) {
2015-03-29 18:13:28 +02:00
var requests = details.requests;
if ( µb.userSettings.collapseBlocked === false ) {
return requests;
}
//console.debug('messaging.js/contentscript-end.js: processing %d requests', requests.length);
var hostnameFromURI = µb.URI.hostnameFromURI;
var redirectEngine = µb.redirectEngine;
2015-11-28 16:29:05 +01:00
var punycodeURL = vAPI.punycodeURL;
// Create evaluation context
2015-04-09 00:46:08 +02:00
var context = pageStore.createContextFromFrameHostname(details.pageHostname);
2015-03-29 18:13:28 +02:00
var request, r;
2015-03-29 18:13:28 +02:00
var i = requests.length;
2014-09-14 22:20:40 +02:00
while ( i-- ) {
2015-03-29 18:13:28 +02:00
request = requests[i];
if ( request.url.startsWith('data:') ) {
context.requestURL = request.url;
context.requestHostname = context.pageHostname;
} else {
context.requestURL = punycodeURL(request.url);
context.requestHostname = hostnameFromURI(context.requestURL);
}
context.requestType = tagNameToRequestTypeMap[request.tag];
r = pageStore.filterRequest(context);
if ( typeof r !== 'string' || r.charAt(1) !== 'b' ) {
continue;
}
// Redirected? (We do not hide redirected resources.)
if ( redirectEngine.matches(context) ) {
continue;
2014-09-14 22:20:40 +02:00
}
request.collapse = true;
2014-09-14 22:20:40 +02:00
}
2016-07-01 04:03:29 +02:00
context.dispose();
2015-03-29 18:13:28 +02:00
return requests;
2014-09-14 22:20:40 +02:00
};
/******************************************************************************/
var onMessage = function(request, sender, callback) {
2014-06-27 23:06:42 +02:00
// Async
switch ( request.what ) {
default:
break;
2014-06-27 23:06:42 +02:00
}
// Sync
var response;
var pageStore;
if ( sender && sender.tab ) {
2014-08-02 17:40:27 +02:00
pageStore = µb.pageStoreFromTabId(sender.tab.id);
2014-06-27 23:06:42 +02:00
}
switch ( request.what ) {
2016-03-06 16:51:06 +01:00
case 'retrieveDomainCosmeticSelectors':
if ( pageStore && pageStore.getNetFilteringSwitch() ) {
response = µb.cosmeticFilteringEngine.retrieveDomainSelectors(request);
if ( response && response.skipCosmeticFiltering !== true ) {
response.skipCosmeticFiltering = !pageStore.getSpecificCosmeticFilteringSwitch();
}
}
break;
case 'retrieveGenericCosmeticSelectors':
response = {
shutdown: !pageStore || !pageStore.getNetFilteringSwitch(),
result: null
};
if ( !response.shutdown && pageStore.getGenericCosmeticFilteringSwitch() ) {
response.result = µb.cosmeticFilteringEngine.retrieveGenericSelectors(request);
}
break;
2014-06-27 23:06:42 +02:00
case 'filterRequests':
response = {
shutdown: !pageStore || !pageStore.getNetFilteringSwitch(),
result: null,
netSelectorCacheCountMax: µb.cosmeticFilteringEngine.netSelectorCacheCountMax
};
if ( !response.shutdown ) {
response.result = filterRequests(pageStore, request);
}
break;
default:
return vAPI.messaging.UNHANDLED;
}
2014-06-24 00:42:43 +02:00
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('contentscript', onMessage);
/******************************************************************************/
})();
/******************************************************************************/
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: elementPicker
(function() {
/******************************************************************************/
2014-09-28 18:05:46 +02:00
var µb = µBlock;
/******************************************************************************/
var onMessage = function(request, sender, callback) {
// Async
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
case 'elementPickerArguments':
var xhr = new XMLHttpRequest();
xhr.open('GET', 'epicker.html', true);
xhr.overrideMimeType('text/html;charset=utf-8');
xhr.responseType = 'text';
xhr.onload = function() {
this.onload = null;
var i18n = {
bidi_dir: document.body.getAttribute('dir'),
create: vAPI.i18n('pickerCreate'),
pick: vAPI.i18n('pickerPick'),
quit: vAPI.i18n('pickerQuit'),
preview: vAPI.i18n('pickerPreview'),
2015-05-19 19:59:53 +02:00
netFilters: vAPI.i18n('pickerNetFilters'),
cosmeticFilters: vAPI.i18n('pickerCosmeticFilters'),
cosmeticFiltersHint: vAPI.i18n('pickerCosmeticFiltersHint')
};
var reStrings = /\{\{(\w+)\}\}/g;
var replacer = function(a0, string) {
return i18n[string];
2014-07-13 02:32:44 +02:00
};
2015-05-19 19:59:53 +02:00
callback({
frameContent: this.responseText.replace(reStrings, replacer),
target: µb.epickerTarget,
clientX: µb.mouseX,
clientY: µb.mouseY,
2015-05-19 19:59:53 +02:00
eprom: µb.epickerEprom
});
µb.epickerTarget = '';
µb.mouseX = -1;
µb.mouseY = -1;
2015-05-19 19:59:53 +02:00
};
xhr.send();
return;
default:
break;
}
2014-07-13 02:32:44 +02:00
// Sync
var response;
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
case 'elementPickerEprom':
µb.epickerEprom = request;
break;
2015-05-19 19:59:53 +02:00
default:
return vAPI.messaging.UNHANDLED;
2014-07-13 02:32:44 +02:00
}
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('elementPicker', onMessage);
2014-09-28 18:05:46 +02:00
/******************************************************************************/
2014-06-24 00:42:43 +02:00
})();
2014-09-14 22:20:40 +02:00
/******************************************************************************/
2014-06-24 00:42:43 +02:00
/******************************************************************************/
2015-08-11 21:29:14 +02:00
2016-03-06 16:51:06 +01:00
// channel: cloudWidget
2015-08-11 21:29:14 +02:00
(function() {
/******************************************************************************/
var µb = µBlock;
/******************************************************************************/
var onMessage = function(request, sender, callback) {
// Async
switch ( request.what ) {
case 'cloudGetOptions':
vAPI.cloud.getOptions(function(options) {
options.enabled = µb.userSettings.cloudStorageEnabled === true;
callback(options);
});
return;
case 'cloudSetOptions':
vAPI.cloud.setOptions(request.options, callback);
return;
case 'cloudPull':
return vAPI.cloud.pull(request.datakey, callback);
case 'cloudPush':
return vAPI.cloud.push(request.datakey, request.data, callback);
default:
break;
}
// Sync
var response;
switch ( request.what ) {
// For when cloud storage is disabled.
case 'cloudPull':
// fallthrough
case 'cloudPush':
break;
default:
return vAPI.messaging.UNHANDLED;
}
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('cloudWidget', onMessage);
/******************************************************************************/
})();
/******************************************************************************/
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: dashboard
2014-07-17 16:52:43 +02:00
(function() {
2014-09-28 18:05:46 +02:00
/******************************************************************************/
2014-07-17 16:52:43 +02:00
2014-09-28 18:05:46 +02:00
var µb = µBlock;
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// Settings
2014-09-28 18:05:46 +02:00
2015-03-07 05:36:09 +01:00
var getLocalData = function(callback) {
var onStorageInfoReady = function(bytesInUse) {
var o = µb.restoreBackupSettings;
2014-10-07 14:59:35 +02:00
callback({
2015-03-07 05:36:09 +01:00
storageUsed: bytesInUse,
lastRestoreFile: o.lastRestoreFile,
lastRestoreTime: o.lastRestoreTime,
lastBackupFile: o.lastBackupFile,
lastBackupTime: o.lastBackupTime
2014-10-07 14:59:35 +02:00
});
};
2015-03-07 05:36:09 +01:00
µb.getBytesInUse(onStorageInfoReady);
};
var backupUserData = function(callback) {
2015-04-16 18:14:43 +02:00
var userData = {
timeStamp: Date.now(),
version: vAPI.app.version,
userSettings: µb.userSettings,
filterLists: {},
netWhitelist: µb.stringFromWhitelist(µb.netWhitelist),
dynamicFilteringString: µb.permanentFirewall.toString(),
2015-05-21 20:15:17 +02:00
urlFilteringString: µb.permanentURLFiltering.toString(),
2015-04-16 18:14:43 +02:00
hostnameSwitchesString: µb.hnSwitches.toString(),
userFilters: ''
};
var onSelectedListsReady = function(filterLists) {
userData.filterLists = filterLists;
2015-03-07 05:36:09 +01:00
var now = new Date();
var filename = vAPI.i18n('aboutBackupFilename')
.replace('{{datetime}}', now.toLocaleString())
.replace(/ +/g, '_');
vAPI.download({
'url': 'data:text/plain;charset=utf-8,' + encodeURIComponent(JSON.stringify(userData, null, ' ')),
'filename': filename
});
µb.restoreBackupSettings.lastBackupFile = filename;
µb.restoreBackupSettings.lastBackupTime = Date.now();
2015-04-10 15:52:16 +02:00
vAPI.storage.set(µb.restoreBackupSettings);
2015-03-07 05:36:09 +01:00
getLocalData(callback);
};
2015-04-16 18:14:43 +02:00
var onUserFiltersReady = function(details) {
userData.userFilters = details.content;
µb.extractSelectedFilterLists(onSelectedListsReady);
};
2016-02-17 15:28:20 +01:00
µb.assets.get(µb.userFiltersPath, onUserFiltersReady);
2014-10-07 14:59:35 +02:00
};
2015-03-07 05:36:09 +01:00
var restoreUserData = function(request) {
var userData = request.userData;
2015-05-21 20:15:17 +02:00
var countdown = 8;
2014-10-11 22:44:56 +02:00
var onCountdown = function() {
countdown -= 1;
if ( countdown === 0 ) {
vAPI.app.restart();
2014-10-11 22:44:56 +02:00
}
};
var onAllRemoved = function() {
// Be sure to adjust `countdown` if adding/removing anything below
2015-04-10 08:17:12 +02:00
µb.keyvalSetOne('version', userData.version);
2015-11-29 23:06:58 +01:00
µBlock.saveLocalSettings();
2015-04-10 15:52:16 +02:00
vAPI.storage.set(userData.userSettings, onCountdown);
2015-04-10 08:17:12 +02:00
µb.keyvalSetOne('remoteBlacklists', userData.filterLists, onCountdown);
µb.keyvalSetOne('netWhitelist', userData.netWhitelist || '', onCountdown);
2015-03-07 05:36:09 +01:00
2015-03-27 18:00:55 +01:00
// With versions 0.9.2.4-, dynamic rules were saved within the
// `userSettings` object. No longer the case.
var s = userData.dynamicFilteringString || userData.userSettings.dynamicFilteringString || '';
2015-04-10 08:17:12 +02:00
µb.keyvalSetOne('dynamicFilteringString', s, onCountdown);
2015-03-27 18:00:55 +01:00
2015-05-21 20:15:17 +02:00
µb.keyvalSetOne('urlFilteringString', userData.urlFilteringString || '', onCountdown);
2015-04-10 08:17:12 +02:00
µb.keyvalSetOne('hostnameSwitchesString', userData.hostnameSwitchesString || '', onCountdown);
2016-02-17 15:28:20 +01:00
µb.assets.put(µb.userFiltersPath, userData.userFilters, onCountdown);
2015-04-10 15:52:16 +02:00
vAPI.storage.set({
2015-03-07 05:36:09 +01:00
lastRestoreFile: request.file || '',
lastRestoreTime: Date.now(),
lastBackupFile: '',
lastBackupTime: 0
}, onCountdown);
2014-10-11 22:44:56 +02:00
};
2015-04-07 03:26:05 +02:00
// https://github.com/chrisaljoudi/uBlock/issues/1102
2015-03-27 14:50:31 +01:00
// Ensure all currently cached assets are flushed from storage AND memory.
µb.assets.rmrf();
2014-10-07 16:46:10 +02:00
// If we are going to restore all, might as well wipe out clean local
// storage
2015-04-10 08:17:12 +02:00
vAPI.storage.clear(onAllRemoved);
2014-10-07 14:59:35 +02:00
};
var resetUserData = function() {
2015-04-10 08:17:12 +02:00
vAPI.storage.clear();
2015-03-11 16:05:13 +01:00
2014-10-07 14:59:35 +02:00
// Keep global counts, people can become quite attached to numbers
2015-11-29 23:06:58 +01:00
µb.saveLocalSettings();
2015-03-11 16:05:13 +01:00
vAPI.app.restart();
2014-10-07 14:59:35 +02:00
};
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// 3rd-party filters
var prepListEntries = function(entries) {
var µburi = µb.URI;
var entry, hn;
for ( var k in entries ) {
if ( entries.hasOwnProperty(k) === false ) {
continue;
}
entry = entries[k];
if ( typeof entry.supportURL === 'string' && entry.supportURL !== '' ) {
entry.supportName = µburi.hostnameFromURI(entry.supportURL);
} else if ( typeof entry.homeURL === 'string' && entry.homeURL !== '' ) {
hn = µburi.hostnameFromURI(entry.homeURL);
entry.supportURL = 'http://' + hn + '/';
entry.supportName = µburi.domainFromHostname(hn);
}
}
};
var getLists = function(callback) {
var r = {
autoUpdate: µb.userSettings.autoUpdate,
available: null,
cache: null,
cosmetic: µb.userSettings.parseAllABPHideFilters,
cosmeticFilterCount: µb.cosmeticFilteringEngine.getFilterCount(),
current: µb.remoteBlacklists,
manualUpdate: false,
netFilterCount: µb.staticNetFilteringEngine.getFilterCount(),
userFiltersPath: µb.userFiltersPath
};
var onMetadataReady = function(entries) {
r.cache = entries;
r.manualUpdate = µb.assetUpdater.manualUpdate;
r.manualUpdateProgress = µb.assetUpdater.manualUpdateProgress;
prepListEntries(r.cache);
callback(r);
};
var onLists = function(lists) {
r.available = lists;
prepListEntries(r.available);
µb.assets.metadata(onMetadataReady);
};
µb.getAvailableLists(onLists);
};
/******************************************************************************/
// My rules
var getRules = function() {
return {
permanentRules: µb.permanentFirewall.toString() + '\n' + µb.permanentURLFiltering.toString(),
sessionRules: µb.sessionFirewall.toString() + '\n' + µb.sessionURLFiltering.toString(),
hnSwitches: µb.hnSwitches.toString()
};
};
// Untangle firewall rules, url rules and switches.
var untangleRules = function(s) {
var textEnd = s.length;
var lineBeg = 0, lineEnd;
var line;
var firewallRules = [];
var urlRules = [];
var switches = [];
while ( lineBeg < textEnd ) {
lineEnd = s.indexOf('\n', lineBeg);
if ( lineEnd < 0 ) {
lineEnd = s.indexOf('\r', lineBeg);
if ( lineEnd < 0 ) {
lineEnd = textEnd;
}
}
line = s.slice(lineBeg, lineEnd).trim();
lineBeg = lineEnd + 1;
if ( line.indexOf('://') !== -1 ) {
urlRules.push(line);
} else if ( line.indexOf(':') === -1 ) {
firewallRules.push(line);
} else {
switches.push(line);
}
}
return {
firewallRules: firewallRules.join('\n'),
urlRules: urlRules.join('\n'),
switches: switches.join('\n')
};
};
/******************************************************************************/
2014-09-28 18:05:46 +02:00
var onMessage = function(request, sender, callback) {
2014-06-24 00:42:43 +02:00
// Async
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
case 'backupUserData':
return backupUserData(callback);
2015-03-07 05:36:09 +01:00
2016-03-06 16:51:06 +01:00
case 'getLists':
return getLists(callback);
2015-05-19 19:59:53 +02:00
case 'getLocalData':
return getLocalData(callback);
2014-06-24 00:42:43 +02:00
2016-03-06 16:51:06 +01:00
case 'purgeAllCaches':
return µb.assets.purgeAll(callback);
case 'readUserFilters':
return µb.loadUserFilters(callback);
case 'writeUserFilters':
return µb.saveUserFilters(request.content, callback);
2015-05-19 19:59:53 +02:00
default:
break;
2014-06-24 00:42:43 +02:00
}
// Sync
var response;
switch ( request.what ) {
2016-03-06 16:51:06 +01:00
case 'getRules':
response = getRules();
break;
case 'purgeCache':
µb.assets.purgeCacheableAsset(request.path);
break;
2015-05-19 19:59:53 +02:00
case 'restoreUserData':
restoreUserData(request);
break;
2014-10-07 14:59:35 +02:00
2015-05-19 19:59:53 +02:00
case 'resetUserData':
resetUserData();
break;
2016-03-06 16:51:06 +01:00
case 'setSessionRules':
// https://github.com/chrisaljoudi/uBlock/issues/772
µb.cosmeticFilteringEngine.removeFromSelectorCache('*');
response = untangleRules(request.rules);
µb.sessionFirewall.fromString(response.firewallRules);
µb.sessionURLFiltering.fromString(response.urlRules);
µb.hnSwitches.fromString(response.switches);
µb.saveHostnameSwitches();
response = getRules();
break;
case 'setPermanentRules':
response = untangleRules(request.rules);
µb.permanentFirewall.fromString(response.firewallRules);
µb.savePermanentFirewallRules();
µb.permanentURLFiltering.fromString(response.urlRules);
µb.savePermanentURLFilteringRules();
µb.hnSwitches.fromString(response.switches);
µb.saveHostnameSwitches();
response = getRules();
break;
2015-05-19 19:59:53 +02:00
default:
return vAPI.messaging.UNHANDLED;
2014-06-24 00:42:43 +02:00
}
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('dashboard', onMessage);
2014-09-28 18:05:46 +02:00
/******************************************************************************/
2014-06-24 00:42:43 +02:00
})();
/******************************************************************************/
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: loggerUI
(function() {
/******************************************************************************/
var µb = µBlock;
/******************************************************************************/
2015-05-21 20:15:17 +02:00
var getURLFilteringData = function(details) {
var colors = {};
var response = {
dirty: false,
colors: colors
};
var suf = µb.sessionURLFiltering;
var puf = µb.permanentURLFiltering;
var urls = details.urls,
context = details.context,
type = details.type;
var url, colorEntry;
var i = urls.length;
while ( i-- ) {
url = urls[i];
colorEntry = colors[url] = { r: 0, own: false };
if ( suf.evaluateZ(context, url, type).r !== 0 ) {
colorEntry.r = suf.r;
colorEntry.own = suf.context === context && suf.url === url && suf.type === type;
}
if ( response.dirty ) {
continue;
}
puf.evaluateZ(context, url, type);
response.dirty = colorEntry.own !== (puf.context === context && puf.url === url && puf.type === type);
}
return response;
};
/******************************************************************************/
var onMessage = function(request, sender, callback) {
// Async
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
default:
break;
}
// Sync
var response;
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
case 'readAll':
var tabIds = {}, pageStore;
var loggerURL = vAPI.getURL('logger-ui.html');
for ( var tabId in µb.pageStores ) {
pageStore = µb.pageStoreFromTabId(tabId);
if ( pageStore === null ) {
continue;
2015-05-09 00:28:01 +02:00
}
if ( pageStore.rawURL.startsWith(loggerURL) ) {
2015-05-19 19:59:53 +02:00
continue;
}
tabIds[tabId] = pageStore.title;
}
response = {
colorBlind: µb.userSettings.colorBlindFriendly,
entries: µb.logger.readAll(),
maxEntries: µb.userSettings.requestLogMaxEntries,
noTabId: vAPI.noTabId,
tabIds: tabIds,
tabIdsToken: µb.pageStoresToken
};
break;
2015-05-21 20:15:17 +02:00
case 'saveURLFilteringRules':
2015-05-22 14:05:55 +02:00
response = µb.permanentURLFiltering.copyRules(
µb.sessionURLFiltering,
request.context,
request.urls,
request.type
);
if ( response ) {
2015-05-21 20:15:17 +02:00
µb.savePermanentURLFilteringRules();
}
break;
case 'setURLFilteringRule':
µb.toggleURLFilteringRule(request);
break;
case 'getURLFilteringData':
response = getURLFilteringData(request);
break;
2015-05-19 19:59:53 +02:00
default:
return vAPI.messaging.UNHANDLED;
}
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('loggerUI', onMessage);
/******************************************************************************/
})();
// https://www.youtube.com/watch?v=3_WcygKJP1k
2014-06-24 00:42:43 +02:00
/******************************************************************************/
2015-03-09 17:57:52 +01:00
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: documentBlocked
2015-03-26 00:28:22 +01:00
(function() {
/******************************************************************************/
var onMessage = function(request, sender, callback) {
// Async
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
default:
break;
2015-03-26 00:28:22 +01:00
}
// Sync
var response;
switch ( request.what ) {
2015-05-19 19:59:53 +02:00
case 'temporarilyWhitelistDocument':
µBlock.webRequest.temporarilyWhitelistDocument(request.hostname);
break;
2015-03-26 00:28:22 +01:00
2015-05-19 19:59:53 +02:00
default:
return vAPI.messaging.UNHANDLED;
2015-03-26 00:28:22 +01:00
}
callback(response);
};
2016-03-06 16:51:06 +01:00
vAPI.messaging.listen('documentBlocked', onMessage);
2015-03-26 00:28:22 +01:00
/******************************************************************************/
})();
2015-03-09 17:57:52 +01:00
/******************************************************************************/
/******************************************************************************/
2016-03-06 16:51:06 +01:00
// channel: scriptlets
(function() {
/******************************************************************************/
var µb = µBlock;
2016-08-06 18:05:01 +02:00
var broadcastTimers = Object.create(null);
/******************************************************************************/
var cosmeticallyFilteredElementCountChanged = function(tabId) {
delete broadcastTimers[tabId + '-cosmeticallyFilteredElementCountChanged'];
var pageStore = µb.pageStoreFromTabId(tabId);
if ( pageStore === null ) {
return;
}
vAPI.messaging.broadcast({
what: 'cosmeticallyFilteredElementCountChanged',
tabId: tabId,
count: pageStore.hiddenElementCount
});
};
/******************************************************************************/
var logCosmeticFilters = function(tabId, details) {
if ( µb.logger.isEnabled() === false ) {
return;
}
var selectors = details.matchedSelectors;
selectors.sort();
for ( var i = 0; i < selectors.length; i++ ) {
µb.logger.writeOne(
tabId,
'cosmetic',
'cb:##' + selectors[i],
'dom',
details.frameURL,
null,
details.frameHostname
);
}
};
/******************************************************************************/
var onMessage = function(request, sender, callback) {
2015-06-26 06:08:41 +02:00
var tabId = sender && sender.tab ? sender.tab.id : 0;
var pageStore = µb.pageStoreFromTabId(tabId);
2015-06-26 06:08:41 +02:00
// Async
switch ( request.what ) {
default:
break;
}
// Sync
var response;
switch ( request.what ) {
2016-08-06 18:05:01 +02:00
case 'cosmeticallyFilteredElementCount':
if ( pageStore !== null && request.filteredElementCount ) {
pageStore.hiddenElementCount += request.filteredElementCount;
var broadcastKey = tabId + '-cosmeticallyFilteredElementCountChanged';
if ( broadcastTimers[broadcastKey] === undefined ) {
broadcastTimers[broadcastKey] = vAPI.setTimeout(
cosmeticallyFilteredElementCountChanged.bind(null, tabId),
250
);
}
}
break;
case 'logCosmeticFilteringData':
logCosmeticFilters(tabId, request);
break;
case 'temporarilyAllowLargeMediaElement':
if ( pageStore !== null ) {
pageStore.allowLargeMediaElementsUntil = Date.now() + 2000;
}
break;
case 'subscriberData':
response = {
confirmStr: vAPI.i18n('subscriberConfirm'),
externalLists: µBlock.userSettings.externalLists
};
break;
default:
return vAPI.messaging.UNHANDLED;
}
callback(response);
};
vAPI.messaging.listen('scriptlets', onMessage);
/******************************************************************************/
})();
2015-06-26 06:08:41 +02:00
/******************************************************************************/
/******************************************************************************/