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

Merge pull request #4426 from timvandermeij/extensions-chromium-syntax

Browse Source 
Making extensions/chromium/*.js adhere to the style guide
This commit is contained in:
Jonas Jenwald 2014-03-14 12:48:31 +01:00
commit ba8a59034c
5 changed files with 521 additions and 478 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:
* "web_accessible_resources": ["getFrameId"]
*/
/* globals chrome, console */
(function() {
/* jshint browser:true, maxlen:100 */
/* globals chrome, console */
'use strict';
chrome.tabs.executeScriptInFrame = executeScript;
// This URL is used to communicate the frameId. The resource is never visited, so it should
// be a non-existent location. Do not use *, ", ' or line breaks in the file name.
// This URL is used to communicate the frameId. The resource is never
// 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');
// The callback will be called within ... ms:
// Don't set a too low value.
@ -38,12 +40,14 @@ var callbacks = {};
chrome.webRequest.onBeforeRequest.addListener(function showFrameId(details) {
// 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;
// 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);
// When frameId > 0xFFFF, use the height to convey the additional information.
// Again, add 1 to make sure that the height is non-zero.
// When frameId > 0xFFFF, use the height to convey the additional
// information. Again, add 1 to make sure that the height is non-zero.
var height = String.fromCharCode((frameId >> 16) + 1, 0);
// Convert data to base64 to avoid loss of bytes
var image = 'data:image/gif;base64,' + btoa(
@ -82,7 +86,8 @@ chrome.webRequest.onBeforeRequest.addListener(function showFrameId(details) {
types: ['image']
}, ['blocking']);
chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
chrome.runtime.onMessage.addListener(function(message, sender,
sendResponse) {
if (message && message.executeScriptCallback) {
var callback = callbacks[message.identifier];
if (callback) {
@ -91,10 +96,12 @@ chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
return;
}
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]);
} 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.code {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 callback {optional function(optional array of any result)} When an error occurs, result
* @param details.runAt {optional string} One of "document_start",
* "document_end", "document_idle"
* @param callback {optional function(optional result array)} When an error
* occurs, result
* is not set.
*/
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;
console.assert(typeof tabId === 'number', 'details.tabId must be a number');
console.assert(typeof frameId === 'number', 'details.frameId must be a number');
var sourceType = 'code' in details ? 'code' : 'file';
console.assert(typeof tabId === 'number',
'details.tabId must be a number');
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');
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;
if (!callback) callback = function() {/* no-op*/};
console.assert(typeof callback === 'function', 'callback must be a function');
if (!callback) {
callback = function() {/* no-op*/};
}
console.assert(typeof callback === 'function',
'callback must be a function');
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 = {
allFrames: false,
runAt: runAt
@ -149,7 +166,8 @@ function executeScript(tabId, details, callback) {
x.onerror = function executeScriptResourceFetchError() {
var message = 'Failed to load file: "' + sourceValue + '".';
console.error('executeScript: ' + message);
chrome.runtime.lastError = chrome.extension.lastError = { message: message };
chrome.runtime.lastError = chrome.extension.lastError =
{ message: message };
try {
callback();
} finally {
@ -160,7 +178,6 @@ function executeScript(tabId, details, callback) {
})();
}
function executeScriptInFrame() {
callbacks[identifier] = callback;
chrome.tabs.executeScript(tabId, {
@ -173,7 +190,8 @@ function executeScript(tabId, details, callback) {
runAt: 'document_start'
}, function(results) {
if (results) {
callback.timer = setTimeout(executeScriptTimedOut, MAXIMUM_RESPONSE_TIME_MS);
callback.timer = setTimeout(executeScriptTimedOut,
MAXIMUM_RESPONSE_TIME_MS);
} else {
// Failed :(
delete callbacks[identifier];
@ -181,15 +199,18 @@ function executeScript(tabId, details, callback) {
}
});
}
function executeScriptTimedOut() {
var callback = callbacks[identifier];
if (!callback) {
return;
}
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);
chrome.runtime.lastError = chrome.extension.lastError = { message: message };
chrome.runtime.lastError = chrome.extension.lastError =
{ message: message };
try {
callback();
} finally {
@ -201,12 +222,14 @@ function executeScript(tabId, details, callback) {
/**
* 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;
if ('__executeScript_frameId__' in window) {
evalAsContentScript();
} 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.onload = function() {
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
// (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) {
@ -230,13 +254,14 @@ var DETECT_FRAME = '' + function checkFrame(window, identifier, frameId, code) {
// URL. chrome.tabs.executeScript will run the script for the frame.
}
}
function evalAsContentScript() {
if (window.__executeScript_frameId__ !== frameId) {
return;
}
// 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
// to be triggered
// in the evaluated code does not cause the time-out in the background
// page to be triggered
chrome.runtime.sendMessage({
executeScriptCallback: 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);
})();

1
extensions/chromium/extension-router.js
View File

@ -18,6 +18,7 @@ limitations under the License.
/* globals chrome */
'use strict';
(function ExtensionRouterClosure() {
var VIEWER_URL = chrome.extension.getURL('content/web/viewer.html');
var CRX_BASE_URL = chrome.extension.getURL('/');

49
extensions/chromium/pdfHandler-v2.js
View File

@ -25,7 +25,8 @@ if (!chrome.streamsPrivate) {
console.warn('streamsPrivate not available, PDF from FTP or POST ' +
'requests will not be displayed using this extension! ' +
'See http://crbug.com/326949');
chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
chrome.runtime.onMessage.addListener(function(message, sender,
sendResponse) {
if (message && message.action === 'getPDFStream') {
sendResponse();
}
@ -49,7 +50,7 @@ var STREAM_NO_TABID = 0;
function hasStream(tabId, pdfUrl) {
var streams = urlToStream[streamSupportsTabId ? tabId : STREAM_NO_TABID];
return streams && streams[pdfUrl] && streams[pdfUrl].length > 0;
return (streams && streams[pdfUrl] && streams[pdfUrl].length > 0);
}
/**
@ -59,7 +60,9 @@ function hasStream(tabId, pdfUrl) {
* property contentLength (= expected size)
*/
function getStream(tabId, pdfUrl) {
if (!streamSupportsTabId) tabId = STREAM_NO_TABID;
if (!streamSupportsTabId) {
tabId = STREAM_NO_TABID;
}
if (hasStream(tabId, pdfUrl)) {
var streamInfo = urlToStream[tabId][pdfUrl].shift();
if (urlToStream[tabId][pdfUrl].length === 0) {
@ -74,8 +77,12 @@ function getStream(tabId, pdfUrl) {
function setStream(tabId, pdfUrl, streamUrl, expectedSize) {
tabId = tabId || STREAM_NO_TABID;
if (!urlToStream[tabId]) urlToStream[tabId] = {};
if (!urlToStream[tabId][pdfUrl]) urlToStream[tabId][pdfUrl] = [];
if (!urlToStream[tabId]) {
urlToStream[tabId] = {};
}
if (!urlToStream[tabId][pdfUrl]) {
urlToStream[tabId][pdfUrl] = [];
}
urlToStream[tabId][pdfUrl].push({
streamUrl: streamUrl,
contentLength: expectedSize
@ -115,19 +122,27 @@ function transferStreamToIncognitoProfile(tabId, pdfUrl) {
});
});
}
if (chrome.extension.inIncognitoContext) {
var importStream = function(itemId, streamInfo) {
if (itemId.lastIndexOf('streamInfo:', 0) !== 0) return;
console.log('Importing stream info from non-incognito profile', streamInfo);
handleStream('', streamInfo.pdfUrl, streamInfo.streamUrl, streamInfo.tabId,
streamInfo.contentLength);
if (itemId.lastIndexOf('streamInfo:', 0) !== 0) {
return;
}
console.log('Importing stream info from non-incognito profile',
streamInfo);
handleStream('', streamInfo.pdfUrl, streamInfo.streamUrl,
streamInfo.tabId, streamInfo.contentLength);
chrome.storage.local.remove(itemId);
};
var handleStorageItems = function(items) {
Object.keys(items).forEach(function(itemId) {
var item = items[itemId];
if (item.oldValue && !item.newValue) return; // storage remove event
if (item.newValue) item = item.newValue; // storage setter event
if (item.oldValue && !item.newValue) {
return; // storage remove event
}
if (item.newValue) {
item = item.newValue; // storage setter event
}
importStream(itemId, item);
});
};
@ -184,7 +199,7 @@ function handleStream(mimeType, pdfUrl, streamUrl, tabId, expectedSize) {
}, function(details) {
if (details) {
details = details.filter(function(frame) {
return frame.url === pdfUrl;
return (frame.url === pdfUrl);
});
if (details.length > 0) {
if (details.length !== 1) {
@ -221,10 +236,11 @@ function handleStream(mimeType, pdfUrl, streamUrl, tabId, expectedSize) {
*
* @param details {object}
* @param details.tabId {number} The ID of the tab
* @param details.url {string} The URL being navigated when the error occurred.
* @param details.frameId {number} 0 indicates the navigation happens in the tab
* content window; a positive value indicates
* navigation in a subframe.
* @param details.url {string} The URL being navigated when the error
* occurred.
* @param details.frameId {number} 0 indicates the navigation happens in
* the tab content window; a positive value
* indicates navigation in a subframe.
*/
function handleWebNavigation(details) {
var tabId = details.tabId;
@ -257,5 +273,4 @@ function handleWebNavigation(details) {
});
}
}
})();

4
extensions/chromium/pdfHandler-vcros.js
View File

@ -29,7 +29,8 @@ chrome.fileBrowserHandler.onExecute.addListener(onExecuteFileBrowserHandler);
/**
* Invoked when "Open with PDF Viewer" is chosen in the File browser.
*
* @param {String} id File browser action ID as specified in manifest.json
* @param {String} id File browser action ID as specified in
* manifest.json
* @param {Object} details Object of type FileHandlerExecuteEventDetails
*/
function onExecuteFileBrowserHandler(id, details) {
@ -91,5 +92,4 @@ function openViewer(windowId, fileEntries) {
});
}
}
})();

23
extensions/chromium/pdfHandler.js
View File

@ -31,15 +31,17 @@ function getViewerURL(pdf_url) {
* @return {boolean} True if the PDF file should be downloaded.
*/
function isPdfDownloadable(details) {
if (details.url.indexOf('pdfjs.action=download') >= 0)
if (details.url.indexOf('pdfjs.action=download') >= 0) {
return true;
}
// Display the PDF viewer regardless of the Content-Disposition header
// if the file is displayed in the main frame.
if (details.type == 'main_frame')
if (details.type == 'main_frame') {
return false;
var cdHeader = details.responseHeaders &&
getHeaderFromHeaders(details.responseHeaders, 'content-disposition');
return cdHeader && /^attachment/i.test(cdHeader.value);
}
var cdHeader = (details.responseHeaders &&
getHeaderFromHeaders(details.responseHeaders, 'content-disposition'));
return (cdHeader && /^attachment/i.test(cdHeader.value));
}
/**
@ -67,9 +69,9 @@ function isPdfFile(details) {
var header = getHeaderFromHeaders(details.responseHeaders, 'content-type');
if (header) {
var headerValue = header.value.toLowerCase().split(';',1)[0].trim();
return headerValue === 'application/pdf' ||
return (headerValue === 'application/pdf' ||
headerValue === 'application/octet-stream' &&
details.url.toLowerCase().indexOf('.pdf') > 0;
details.url.toLowerCase().indexOf('.pdf') > 0);
}
}
@ -101,9 +103,9 @@ chrome.webRequest.onHeadersReceived.addListener(
// Don't intercept POST requests until http://crbug.com/104058 is fixed.
return;
}
if (!isPdfFile(details))
if (!isPdfFile(details)) {
return;
}
if (isPdfDownloadable(details)) {
// Force download by ensuring that Content-Disposition: attachment is set
return getHeadersWithContentDispositionAttachment(details);
@ -172,8 +174,9 @@ chrome.webRequest.onHeadersReceived.addListener(
chrome.webRequest.onBeforeRequest.addListener(
function(details) {
if (isPdfDownloadable(details))
if (isPdfDownloadable(details)) {
return;
}
// NOTE: The manifest file has declared an empty content script
// at file://*/* to make sure that the viewer can load the PDF file