1
0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-16 23:42:39 +01:00
uBlock/platform/safari/vapi-client.js
Chris fa3666f85d Refactor context-keeping
Improves reliability and thoroughness of blocking on all
browsers.
2015-04-13 18:58:50 -06:00

325 lines
11 KiB
JavaScript

/*******************************************************************************
uBlock - a browser extension to block requests.
Copyright (C) 2015 The uBlock 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/chrisaljoudi/uBlock
*/
/******************************************************************************/
// For non background pages
(function(self) {
'use strict';
var vAPI = self.vAPI = self.vAPI || {};
if(vAPI.vapiClientInjected) {
return;
}
var safari;
if(typeof self.safari === "undefined") {
safari = self.top.safari;
}
else {
safari = self.safari;
}
vAPI.vapiClientInjected = true;
vAPI.safari = true;
vAPI.sessionId = String.fromCharCode(Date.now() % 25 + 97) +
Math.random().toString(36).slice(2);
/******************************************************************************/
var messagingConnector = function(response) {
if(!response) {
return;
}
var channels = vAPI.messaging.channels;
var channel, listener;
if(response.broadcast === true && !response.channelName) {
for(channel in channels) {
if(channels.hasOwnProperty(channel) === false) {
continue;
}
listener = channels[channel].listener;
if(typeof listener === 'function') {
listener(response.msg);
}
}
return;
}
if(response.requestId) {
listener = vAPI.messaging.listeners[response.requestId];
delete vAPI.messaging.listeners[response.requestId];
delete response.requestId;
}
if(!listener) {
channel = channels[response.channelName];
listener = channel && channel.listener;
}
if(typeof listener === 'function') {
listener(response.msg);
}
};
/******************************************************************************/
// Relevant?
// https://developer.apple.com/library/safari/documentation/Tools/Conceptual/SafariExtensionGuide/MessagesandProxies/MessagesandProxies.html#//apple_ref/doc/uid/TP40009977-CH14-SW12
vAPI.messaging = {
channels: {},
listeners: {},
requestId: 1,
setup: function() {
this.connector = function(msg) {
// messages from the background script are sent to every frame,
// so we need to check the vAPI.sessionId to accept only
// what is meant for the current context
if(msg.name === vAPI.sessionId || msg.name === 'broadcast') {
messagingConnector(msg.message);
}
};
safari.self.addEventListener('message', this.connector, false);
this.channels['vAPI'] = {
listener: function(msg) {
if(msg.cmd === 'injectScript' && msg.details.code) {
Function(msg.details.code).call(self);
}
}
};
},
close: function() {
if(this.connector) {
safari.self.removeEventListener('message', this.connector, false);
this.connector = null;
this.channels = {};
this.listeners = {};
}
},
channel: function(channelName, callback) {
if(!channelName) {
return;
}
this.channels[channelName] = {
channelName: channelName,
listener: typeof callback === 'function' ? callback : null,
send: function(message, callback) {
if(!vAPI.messaging.connector) {
vAPI.messaging.setup();
}
message = {
channelName: this.channelName,
msg: message
};
if(callback) {
message.requestId = vAPI.messaging.requestId++;
vAPI.messaging.listeners[message.requestId] = callback;
}
// popover content doesn't know messaging...
if(safari.extension.globalPage) {
if(!safari.self.visible) {
return;
}
safari.extension.globalPage.contentWindow.vAPI.messaging.onMessage({
name: vAPI.sessionId,
message: message,
target: {
page: {
dispatchMessage: function(name, msg) {
messagingConnector(msg);
}
}
}
});
} else {
safari.self.tab.dispatchMessage(vAPI.sessionId, message);
}
},
close: function() {
delete vAPI.messaging.channels[this.channelName];
}
};
return this.channels[channelName];
}
};
// The following code should run only in content pages
if(location.protocol === "safari-extension:" || typeof safari !== "object") {
return;
}
var frameId = window === window.top ? 0 : Date.now() % 1E5;
var parentFrameId = (frameId ? 0 : -1);
// Helper event to message background,
// and helper anchor element
var beforeLoadEvent,
legacyMode = false,
linkHelper = document.createElement("a");
try {
beforeLoadEvent = new Event("beforeload")
}
catch(ex) {
legacyMode = true;
beforeLoadEvent = document.createEvent("Event");
beforeLoadEvent.initEvent("beforeload");
}
// Inform that we've navigated
if(frameId === 0) {
safari.self.tab.canLoad(beforeLoadEvent, {
url: location.href,
type: "main_frame"
});
}
var nodeTypes = {
"frame": "sub_frame",
"iframe": "sub_frame",
"script": "script",
"img": "image",
"input": "image",
"object": "object",
"embed": "object",
"link": "stylesheet"
};
var shouldBlockDetailedRequest = function(details) {
linkHelper.href = details.url;
details.url = linkHelper.href;
details.frameId = frameId;
details.parentFrameId = parentFrameId;
details.timeStamp = Date.now();
return !(safari.self.tab.canLoad(beforeLoadEvent, details));
};
var onBeforeLoad = function(e) {
if(firstMutation !== false) {
firstMutation();
}
linkHelper.href = e.url;
if(linkHelper.protocol.charCodeAt(0) !== 104) { // h = 104
return;
}
var details = {
url: linkHelper.href,
type: nodeTypes[e.target.nodeName.toLowerCase()] || "other",
// tabId is determined in the background script
frameId: frameId,
parentFrameId: parentFrameId,
timeStamp: Date.now()
};
var response = safari.self.tab.canLoad(e, details);
if(response === false) {
e.preventDefault();
}
};
document.addEventListener("beforeload", onBeforeLoad, true);
// Block popups, intercept XHRs
var firstMutation = function() {
document.removeEventListener("DOMContentLoaded", firstMutation, true);
firstMutation = false;
document.addEventListener(vAPI.sessionId, function(e) {
if(shouldBlockDetailedRequest(e.detail)) {
e.detail.url = false;
}
}, true);
var tmpJS = document.createElement("script");
var tmpScript = "\
(function() {\
var block = function(u, t) {" +
(legacyMode ?
"var e = document.createEvent('CustomEvent');\
e.initCustomEvent('" + vAPI.sessionId + "', false, false, {url: u, type: t});"
: "var e = new CustomEvent('" + vAPI.sessionId + "', {bubbles: false, detail: {url: u, type: t}});"
) +
"document.dispatchEvent(e);\
return e.detail.url === false;\
},\
wo = open,\
xo = XMLHttpRequest.prototype.open,\
img = Image;\
Image = function() {\
var x = new img();\
try{\
Object.defineProperty(x, 'src', {\
get: function() {\
return x.getAttribute('src');\
},\
set: function(val) {\
x.setAttribute('src', block(val, 'image') ? 'data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=' : val);\
}\
});\
}\catch(e){}\
return x;\
};\
open = function(u) {\
if(block(u, 'popup')) return {}; else return wo.apply(this, arguments);\
};\
XMLHttpRequest.prototype.open = function(m, u) {\
if(block(u, 'xmlhttprequest')) {throw 'InvalidAccessError'; return;}\
else {xo.apply(this, arguments); return;}\
};";
if(frameId === 0) {
tmpScript += "\
var pS = history.pushState,\
rS = history.replaceState,\
onpopstate = function(e) {\
if(!e || e.state !== null) {\
block(location.href, 'popstate');\
}\
};\
window.addEventListener('popstate', onpopstate, true);\
history.pushState = function() {\
var r = pS.apply(this, arguments);\
onpopstate();\
return r;\
};\
history.replaceState = function() {\
var r = rS.apply(this, arguments);\
onpopstate();\
return r;\
};";
}
tmpScript += "})();";
tmpJS.textContent = tmpScript;
document.documentElement.removeChild(document.documentElement.appendChild(tmpJS));
};
document.addEventListener("DOMContentLoaded", firstMutation, true);
var onContextMenu = function(e) {
var target = e.target;
var tagName = target.tagName.toLowerCase();
var details = {
tagName: tagName,
pageUrl: location.href,
insideFrame: window !== window.top
};
details.editable = (tagName === "textarea" || tagName === "input");
if(target.hasOwnProperty("checked")) {
details.checked = target.checked;
}
if(tagName === "a") {
details.linkUrl = target.href;
}
if(target.hasOwnProperty("src")) {
details.srcUrl = target.src;
if(tagName === "img") {
details.mediaType = "image";
} else if(tagName === "video" || tagName === "audio") {
details.mediaType = tagName;
}
}
safari.self.tab.setContextMenuEventUserInfo(e, details);
};
self.addEventListener("contextmenu", onContextMenu, true);
})(this);
/******************************************************************************/