Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Making extensions/chromium/chrome.tabs.executeScriptInFrame.js adhere to the style guide

Browse Source
This commit is contained in:
Tim van der Meij 2014-03-09 23:29:34 +01:00
parent 8d2068dc6f
commit 241cb7999d
1 changed files with 189 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
extensions/chromium/chrome.tabs.executeScriptInFrame.js
View File

@ -18,15 +18,17 @@
* In addition, the following field must also be set in manifest.json: * In addition, the following field must also be set in manifest.json:
* "web_accessible_resources": ["getFrameId"] * "web_accessible_resources": ["getFrameId"]
*/ */
/* globals chrome, console */
(function() { (function() {
/* jshint browser:true, maxlen:100 */ /* jshint browser:true, maxlen:100 */
/* globals chrome, console */
'use strict'; 'use strict';
chrome.tabs.executeScriptInFrame = executeScript; chrome.tabs.executeScriptInFrame = executeScript;
// This URL is used to communicate the frameId. The resource is never visited, so it should // This URL is used to communicate the frameId. The resource is never
// be a non-existent location. Do not use *, ", ' or line breaks in the file name. // visited, so it should be a non-existent location. Do not use *, ", '
// or line breaks in the file name.
var URL_WHAT_IS_MY_FRAME_ID = chrome.extension.getURL('getFrameId'); var URL_WHAT_IS_MY_FRAME_ID = chrome.extension.getURL('getFrameId');
// The callback will be called within ... ms: // The callback will be called within ... ms:
// Don't set a too low value. // Don't set a too low value.
@ -38,12 +40,14 @@ var callbacks = {};
chrome.webRequest.onBeforeRequest.addListener(function showFrameId(details) { chrome.webRequest.onBeforeRequest.addListener(function showFrameId(details) {
// Positive integer frameId >= 0 // Positive integer frameId >= 0
// Since an image is used as a data transport, we add 1 to get a non-zero width. // Since an image is used as a data transport, we add 1 to get a
// non-zero width.
var frameId = details.frameId + 1; var frameId = details.frameId + 1;
// Assume that the frameId fits in three bytes - which is a very reasonable assumption. // Assume that the frameId fits in three bytes - which is a very
// reasonable assumption.
var width = String.fromCharCode(frameId & 0xFF, (frameId >> 8) & 0xFF); var width = String.fromCharCode(frameId & 0xFF, (frameId >> 8) & 0xFF);
// When frameId > 0xFFFF, use the height to convey the additional information. // When frameId > 0xFFFF, use the height to convey the additional
// Again, add 1 to make sure that the height is non-zero. // information. Again, add 1 to make sure that the height is non-zero.
var height = String.fromCharCode((frameId >> 16) + 1, 0); var height = String.fromCharCode((frameId >> 16) + 1, 0);
// Convert data to base64 to avoid loss of bytes // Convert data to base64 to avoid loss of bytes
var image = 'data:image/gif;base64,' + btoa( var image = 'data:image/gif;base64,' + btoa(
@ -82,7 +86,8 @@ chrome.webRequest.onBeforeRequest.addListener(function showFrameId(details) {
types: ['image'] types: ['image']
}, ['blocking']); }, ['blocking']);
chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) { chrome.runtime.onMessage.addListener(function(message, sender,
sendResponse) {
if (message && message.executeScriptCallback) { if (message && message.executeScriptCallback) {
var callback = callbacks[message.identifier]; var callback = callbacks[message.identifier];
if (callback) { if (callback) {
@ -91,10 +96,12 @@ chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
return; return;
} }
delete callbacks[message.identifier]; delete callbacks[message.identifier];
// Result within an array to be consistent with the chrome.tabs.executeScript API. // Result within an array to be consistent with the
// chrome.tabs.executeScript API.
callback([message.evalResult]); callback([message.evalResult]);
} else { } else {
console.warn('Callback not found for response in tab ' + sender.tab.id); console.warn('Callback not found for response in tab ' +
sender.tab.id);
} }
} }
}); });
@ -106,25 +113,35 @@ chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
* @param details.frameId {integer} required * @param details.frameId {integer} required
* @param details.code {string} Code or file is required (not both) * @param details.code {string} Code or file is required (not both)
* @param details.file {string} Code or file is required (not both) * @param details.file {string} Code or file is required (not both)
* @param details.runAt {optional string} One of "document_start", "document_end", "document_idle" * @param details.runAt {optional string} One of "document_start",
* @param callback {optional function(optional array of any result)} When an error occurs, result * "document_end", "document_idle"
* @param callback {optional function(optional result array)} When an error
* occurs, result
* is not set. * is not set.
*/ */
function executeScript(tabId, details, callback) { function executeScript(tabId, details, callback) {
console.assert(typeof details === 'object', 'details must be an object (argument 0)'); console.assert(typeof details === 'object',
'details must be an object (argument 0)');
var frameId = details.frameId; var frameId = details.frameId;
console.assert(typeof tabId === 'number', 'details.tabId must be a number'); console.assert(typeof tabId === 'number',
console.assert(typeof frameId === 'number', 'details.frameId must be a number'); 'details.tabId must be a number');
var sourceType = 'code' in details ? 'code' : 'file'; console.assert(typeof frameId === 'number',
'details.frameId must be a number');
var sourceType = ('code' in details ? 'code' : 'file');
console.assert(sourceType in details, 'No source code or file specified'); console.assert(sourceType in details, 'No source code or file specified');
var sourceValue = details[sourceType]; var sourceValue = details[sourceType];
console.assert(typeof sourceValue === 'string', 'details.' + sourceType + ' must be a string'); console.assert(typeof sourceValue === 'string',
'details.' + sourceType + ' must be a string');
var runAt = details.runAt; var runAt = details.runAt;
if (!callback) callback = function() {/* no-op*/}; if (!callback) {
console.assert(typeof callback === 'function', 'callback must be a function'); callback = function() {/* no-op*/};
}
console.assert(typeof callback === 'function',
'callback must be a function');
if (frameId === 0) { if (frameId === 0) {
// No need for heavy lifting if we want to inject the script in the main frame // No need for heavy lifting if we want to inject the script
// in the main frame
var injectDetails = { var injectDetails = {
allFrames: false, allFrames: false,
runAt: runAt runAt: runAt
@ -149,7 +166,8 @@ function executeScript(tabId, details, callback) {
x.onerror = function executeScriptResourceFetchError() { x.onerror = function executeScriptResourceFetchError() {
var message = 'Failed to load file: "' + sourceValue + '".'; var message = 'Failed to load file: "' + sourceValue + '".';
console.error('executeScript: ' + message); console.error('executeScript: ' + message);
chrome.runtime.lastError = chrome.extension.lastError = { message: message }; chrome.runtime.lastError = chrome.extension.lastError =
{ message: message };
try { try {
callback(); callback();
} finally { } finally {
@ -160,7 +178,6 @@ function executeScript(tabId, details, callback) {
})(); })();
} }
function executeScriptInFrame() { function executeScriptInFrame() {
callbacks[identifier] = callback; callbacks[identifier] = callback;
chrome.tabs.executeScript(tabId, { chrome.tabs.executeScript(tabId, {
@ -173,7 +190,8 @@ function executeScript(tabId, details, callback) {
runAt: 'document_start' runAt: 'document_start'
}, function(results) { }, function(results) {
if (results) { if (results) {
callback.timer = setTimeout(executeScriptTimedOut, MAXIMUM_RESPONSE_TIME_MS); callback.timer = setTimeout(executeScriptTimedOut,
MAXIMUM_RESPONSE_TIME_MS);
} else { } else {
// Failed :( // Failed :(
delete callbacks[identifier]; delete callbacks[identifier];
@ -181,15 +199,18 @@ function executeScript(tabId, details, callback) {
} }
}); });
} }
function executeScriptTimedOut() { function executeScriptTimedOut() {
var callback = callbacks[identifier]; var callback = callbacks[identifier];
if (!callback) { if (!callback) {
return; return;
} }
delete callbacks[identifier]; delete callbacks[identifier];
var message = 'Failed to execute script: Frame ' + frameId + ' not found in tab ' + tabId; var message = 'Failed to execute script: Frame ' + frameId +
' not found in tab ' + tabId;
console.error('executeScript: ' + message); console.error('executeScript: ' + message);
chrome.runtime.lastError = chrome.extension.lastError = { message: message }; chrome.runtime.lastError = chrome.extension.lastError =
{ message: message };
try { try {
callback(); callback();
} finally { } finally {
@ -201,12 +222,14 @@ function executeScript(tabId, details, callback) {
/** /**
* Code executed as a content script. * Code executed as a content script.
*/ */
var DETECT_FRAME = '' + function checkFrame(window, identifier, frameId, code) { var DETECT_FRAME = '' + function checkFrame(window, identifier, frameId,
code) {
var i; var i;
if ('__executeScript_frameId__' in window) { if ('__executeScript_frameId__' in window) {
evalAsContentScript(); evalAsContentScript();
} else { } else {
// Do NOT use new Image(), because of http://crbug.com/245296 in Chrome 27-29 // Do NOT use new Image() because of http://crbug.com/245296
// in Chrome 27-29
i = window.document.createElement('img'); i = window.document.createElement('img');
i.onload = function() { i.onload = function() {
window.__executeScript_frameId__ = (this.naturalWidth - 1) + window.__executeScript_frameId__ = (this.naturalWidth - 1) +
@ -215,7 +238,8 @@ var DETECT_FRAME = '' + function checkFrame(window, identifier, frameId, code) {
}; };
// Trigger webRequest event to get frameId // Trigger webRequest event to get frameId
// (append extra characters to bust the cache) // (append extra characters to bust the cache)
i.src = 'URL_WHAT_IS_MY_FRAME_ID?' + Math.random().toString(36).slice(-6); i.src = 'URL_WHAT_IS_MY_FRAME_ID?' +
Math.random().toString(36).slice(-6);
} }
for (i = 0 ; i < window.frames.length; ++i) { for (i = 0 ; i < window.frames.length; ++i) {
@ -230,13 +254,14 @@ var DETECT_FRAME = '' + function checkFrame(window, identifier, frameId, code) {
// URL. chrome.tabs.executeScript will run the script for the frame. // URL. chrome.tabs.executeScript will run the script for the frame.
} }
} }
function evalAsContentScript() { function evalAsContentScript() {
if (window.__executeScript_frameId__ !== frameId) { if (window.__executeScript_frameId__ !== frameId) {
return; return;
} }
// Send an early message to make sure that any blocking code // Send an early message to make sure that any blocking code
// in the evaluated code does not cause the time-out in the background page // in the evaluated code does not cause the time-out in the background
// to be triggered // page to be triggered
chrome.runtime.sendMessage({ chrome.runtime.sendMessage({
executeScriptCallback: true, executeScriptCallback: true,
hello: true, hello: true,
@ -255,5 +280,4 @@ var DETECT_FRAME = '' + function checkFrame(window, identifier, frameId, code) {
} }
} }
}.toString().replace('URL_WHAT_IS_MY_FRAME_ID', URL_WHAT_IS_MY_FRAME_ID); }.toString().replace('URL_WHAT_IS_MY_FRAME_ID', URL_WHAT_IS_MY_FRAME_ID);
})(); })();