From fc658a718cc3b91ff390e9a9c6af722646c5b9f3 Mon Sep 17 00:00:00 2001 From: Rob Wu Date: Mon, 9 May 2016 22:49:47 +0200 Subject: [PATCH] Remove streamsPrivate usage This was only ever useful for the Opera extension because the API requires a whitelisted extension ID. Opera ditched PDF.js from their extension gallery, so we don't need to keep this in the tree. --- extensions/chromium/manifest.json | 6 +- extensions/chromium/pdfHandler-v2.js | 285 --------------------------- extensions/chromium/pdfHandler.html | 1 - web/chromecom.js | 122 +++++------- 4 files changed, 50 insertions(+), 364 deletions(-) delete mode 100644 extensions/chromium/pdfHandler-v2.js diff --git a/extensions/chromium/manifest.json b/extensions/chromium/manifest.json index 872db3532..55f65f483 100644 --- a/extensions/chromium/manifest.json +++ b/extensions/chromium/manifest.json @@ -14,8 +14,7 @@ "", "tabs", "webNavigation", - "storage", - "streamsPrivate" + "storage" ], "content_scripts": [{ "matches": [ @@ -37,9 +36,6 @@ "filesystem:*.pdf" ] }], - "mime_types": [ - "application/pdf" - ], "storage": { "managed_schema": "preferences_schema.json" }, diff --git a/extensions/chromium/pdfHandler-v2.js b/extensions/chromium/pdfHandler-v2.js deleted file mode 100644 index ec4ba1cff..000000000 --- a/extensions/chromium/pdfHandler-v2.js +++ /dev/null @@ -1,285 +0,0 @@ -/* -Copyright 2013 Mozilla Foundation - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ -/* globals chrome, URL, getViewerURL, Features */ - -(function() { - 'use strict'; - - if (!chrome.streamsPrivate) { - // Aww, PDF.js is still not whitelisted... See http://crbug.com/326949 - 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) { - if (message && message.action === 'getPDFStream') { - sendResponse(); - } - }); - return; - } - - // - // Stream URL storage manager - // - - // Hash map of "": { "": ["", ...], ... } - var urlToStream = {}; - - chrome.streamsPrivate.onExecuteMimeTypeHandler.addListener(handleStream); - - // Chrome before 27 does not support tabIds on stream events. - var streamSupportsTabId = true; - // "tabId" used for Chrome before 27. - 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); - } - - /** - * Get stream URL for a given tabId and PDF url. The retrieved stream URL - * will be removed from the list. - * @return {object} An object with property url (= blob:-URL) and - * property contentLength (= expected size) - */ - function getStream(tabId, pdfUrl) { - if (!streamSupportsTabId) { - tabId = STREAM_NO_TABID; - } - if (hasStream(tabId, pdfUrl)) { - var streamInfo = urlToStream[tabId][pdfUrl].shift(); - if (urlToStream[tabId][pdfUrl].length === 0) { - delete urlToStream[tabId][pdfUrl]; - if (Object.keys(urlToStream[tabId]).length === 0) { - delete urlToStream[tabId]; - } - } - return streamInfo; - } - } - - function setStream(tabId, pdfUrl, streamUrl, expectedSize) { - tabId = tabId || STREAM_NO_TABID; - if (!urlToStream[tabId]) { - urlToStream[tabId] = {}; - } - if (!urlToStream[tabId][pdfUrl]) { - urlToStream[tabId][pdfUrl] = []; - } - urlToStream[tabId][pdfUrl].push({ - streamUrl: streamUrl, - contentLength: expectedSize - }); - } - - // http://crbug.com/276898 - the onExecuteMimeTypeHandler event is sometimes - // dispatched in the wrong incognito profile. To work around the bug, transfer - // the stream information from the incognito session when the bug is detected. - function transferStreamToIncognitoProfile(tabId, pdfUrl) { - if (chrome.extension.inIncognitoContext) { - console.log('Already within incognito profile. Aborted stream transfer.'); - return; - } - var streamInfo = getStream(tabId, pdfUrl); - if (!streamInfo) { - return; - } - console.log('Attempting to transfer stream info to a different profile...'); - var itemId = 'streamInfo:' + window.performance.now(); - var items = {}; - items[itemId] = { - tabId: tabId, - pdfUrl: pdfUrl, - streamUrl: streamInfo.streamUrl, - contentLength: streamInfo.contentLength - }; - // The key will be removed whenever an incognito session is started, - // or when an incognito session is active. - chrome.storage.local.set(items, function() { - chrome.extension.isAllowedIncognitoAccess(function(isAllowedAccess) { - if (!isAllowedAccess) { - // If incognito is disabled, forget about the stream. - console.warn('Incognito is disabled, unexpected unknown stream.'); - chrome.storage.local.remove(items); - } - }); - }); - } - - 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); - 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 - } - importStream(itemId, item); - }); - }; - // Parse information that was set before the event pages were ready. - chrome.storage.local.get(null, handleStorageItems); - chrome.storage.onChanged.addListener(handleStorageItems); - } - // End of work-around for crbug 276898 - - chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) { - if (message && message.action === 'getPDFStream') { - var pdfUrl = message.data; - var streamInfo = getStream(sender.tab.id, pdfUrl) || {}; - sendResponse({ - streamUrl: streamInfo.streamUrl, - contentLength: streamInfo.contentLength, - extensionSupportsFTP: Features.extensionSupportsFTP - }); - } - }); - - // - // PDF detection and activation of PDF viewer. - // - - /** - * Callback for when we receive a stream - * - * @param mimeType {string} The mime type of the incoming stream - * @param pdfUrl {string} The full URL to the file - * @param streamUrl {string} The url pointing to the open stream - * @param tabId {number} The ID of the tab in which the stream has been opened - * (undefined before Chrome 27, http://crbug.com/225605) - * @param expectedSize {number} The expected content length of the stream. - * (added in Chrome 29, http://crbug.com/230346) - */ - function handleStream(mimeType, pdfUrl, streamUrl, tabId, expectedSize) { - if (typeof mimeType === 'object') { - // API change: argument list -> object, see crbug.com/345882 - // documentation: chrome/common/extensions/api/streams_private.idl - var streamInfo = mimeType; - mimeType = streamInfo.mimeType; - pdfUrl = streamInfo.originalUrl; - streamUrl = streamInfo.streamUrl; - tabId = streamInfo.tabId; - expectedSize = streamInfo.expectedContentSize; - } - console.log('Intercepted ' + mimeType + ' in tab ' + tabId + ' with URL ' + - pdfUrl + '\nAvailable as: ' + streamUrl); - streamSupportsTabId = typeof tabId === 'number'; - - setStream(tabId, pdfUrl, streamUrl, expectedSize); - - if (!tabId) { // Chrome doesn't set the tabId before v27 - // PDF.js targets Chrome 28+ because of fatal bugs in incognito mode - // for older versions of Chrome. So, don't bother implementing a fallback. - // For those who are interested, either loop through all tabs, or use the - // webNavigation.onBeforeNavigate event to map pdfUrls to tab + frame IDs. - return; - } - - // Check if the frame has already been rendered. - chrome.webNavigation.getAllFrames({ - tabId: tabId - }, function(details) { - if (details) { - details = details.filter(function(frame) { - return (frame.url === pdfUrl); - }); - if (details.length > 0) { - if (details.length !== 1) { - // (Rare case) Multiple frames with same URL. - // TODO(rob): Find a better way to handle this case - // (e.g. open in new tab). - console.warn('More than one frame found for tabId ' + tabId + - ' with URL ' + pdfUrl + '. Using first frame.'); - } - details = details[0]; - details = { - tabId: tabId, - frameId: details.frameId, - url: details.url - }; - handleWebNavigation(details); - } else { - console.warn('No webNavigation frames found for tabId ' + tabId); - } - } else { - console.warn('Unable to get frame information for tabId ' + tabId); - // This branch may occur when a new incognito session is launched. - // The event is dispatched in the non-incognito session while it should - // be dispatched in the incognito session. See http://crbug.com/276898 - transferStreamToIncognitoProfile(tabId, pdfUrl); - } - }); - } - - /** - * This method is called when the chrome.streamsPrivate API has intercepted - * the PDF stream. This method detects such streams, finds the frame where - * the request was made, and loads the viewer in that frame. - * - * @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. - */ - function handleWebNavigation(details) { - var tabId = details.tabId; - var frameId = details.frameId; - var pdfUrl = details.url; - - if (!hasStream(tabId, pdfUrl)) { - console.log('No PDF stream found in tab ' + tabId + ' for ' + pdfUrl); - return; - } - - var viewerUrl = getViewerURL(pdfUrl); - - if (frameId === 0) { // Main frame - console.log('Going to render PDF Viewer in main frame for ' + pdfUrl); - chrome.tabs.update(tabId, { - url: viewerUrl - }); - } else { - console.log('Going to render PDF Viewer in sub frame for ' + pdfUrl); - // Non-standard Chrome API. chrome.tabs.executeScriptInFrame and docs - // is available at https://github.com/Rob--W/chrome-api - chrome.tabs.executeScriptInFrame(tabId, { - frameId: frameId, - code: 'location.href = ' + JSON.stringify(viewerUrl) + ';' - }, function(result) { - if (!result) { // Did the tab disappear? Is the frame inaccessible? - console.warn('Frame not found, viewer not rendered in tab ' + tabId); - } - }); - } - } -})(); diff --git a/extensions/chromium/pdfHandler.html b/extensions/chromium/pdfHandler.html index a9bdca160..10ec5e2fc 100644 --- a/extensions/chromium/pdfHandler.html +++ b/extensions/chromium/pdfHandler.html @@ -19,7 +19,6 @@ limitations under the License. - diff --git a/web/chromecom.js b/web/chromecom.js index a31343585..5f4eaf6a6 100644 --- a/web/chromecom.js +++ b/web/chromecom.js @@ -75,83 +75,59 @@ file = file.replace(/^drive:/i, 'filesystem:' + location.origin + '/external/'); - ChromeCom.request('getPDFStream', file, function(response) { - if (response) { - // We will only get a response when the streamsPrivate API is available. - - var isFTPFile = /^ftp:/i.test(file); - var streamUrl = response.streamUrl; - if (streamUrl) { - console.log('Found data stream for ' + file); - callback(streamUrl, response.contentLength, file); + if (/^filesystem:/.test(file) && !pdfjsLib.PDFJS.disableWorker) { + // The security origin of filesystem:-URLs are not preserved when the + // URL is passed to a Web worker, (http://crbug.com/362061), so we have + // to create an intermediate blob:-URL as a work-around. + var resolveLocalFileSystemURL = window.resolveLocalFileSystemURL || + window.webkitResolveLocalFileSystemURL; + resolveLocalFileSystemURL(file, function onResolvedFSURL(fileEntry) { + fileEntry.file(function(fileObject) { + var blobUrl = URL.createObjectURL(fileObject); + callback(blobUrl, fileObject.size); + }); + }, function onFileSystemError(error) { + // This should not happen. When it happens, just fall back to the + // usual way of getting the File's data (via the Web worker). + console.warn('Cannot resolve file ' + file + ', ' + error.name + ' ' + + error.message); + callback(file); + }); + return; + } + if (/^https?:/.test(file)) { + // Assumption: The file being opened is the file that was requested. + // There is no UI to input a different URL, so this assumption will hold + // for now. + setReferer(file, function() { + callback(file); + }); + return; + } + if (/^file?:/.test(file)) { + getEmbedderOrigin(function(origin) { + // If the origin cannot be determined, let Chrome decide whether to + // allow embedding files. Otherwise, only allow local files to be + // embedded from local files or Chrome extensions. + // Even without this check, the file load in frames is still blocked, + // but this may change in the future (https://crbug.com/550151). + if (origin && !/^file:|^chrome-extension:/.test(origin)) { + PDFViewerApplication.error('Blocked ' + origin + ' from loading ' + + file + '. Refused to load a local file in a non-local page ' + + 'for security reasons.'); return; } - if (isFTPFile && !response.extensionSupportsFTP) { - // Stream not found, and it's loaded from FTP. - // When the browser does not support loading ftp resources over - // XMLHttpRequest, just reload the page. - // NOTE: This will not lead to an infinite redirect loop, because - // if the file exists, then the streamsPrivate API will capture the - // stream and send back the response. If the stream does not exist, - // a "Webpage not available" error will be shown (not the PDF Viewer). - location.replace(file); - return; - } - } - if (/^filesystem:/.test(file) && !pdfjsLib.PDFJS.disableWorker) { - // The security origin of filesystem:-URLs are not preserved when the - // URL is passed to a Web worker, (http://crbug.com/362061), so we have - // to create an intermediate blob:-URL as a work-around. - var resolveLocalFileSystemURL = window.resolveLocalFileSystemURL || - window.webkitResolveLocalFileSystemURL; - resolveLocalFileSystemURL(file, function onResolvedFSURL(fileEntry) { - fileEntry.file(function(fileObject) { - var blobUrl = URL.createObjectURL(fileObject); - callback(blobUrl, fileObject.size); - }); - }, function onFileSystemError(error) { - // This should not happen. When it happens, just fall back to the - // usual way of getting the File's data (via the Web worker). - console.warn('Cannot resolve file ' + file + ', ' + error.name + ' ' + - error.message); - callback(file); - }); - return; - } - if (/^https?:/.test(file)) { - // Assumption: The file being opened is the file that was requested. - // There is no UI to input a different URL, so this assumption will hold - // for now. - setReferer(file, function() { - callback(file); - }); - return; - } - if (/^file?:/.test(file)) { - getEmbedderOrigin(function(origin) { - // If the origin cannot be determined, let Chrome decide whether to - // allow embedding files. Otherwise, only allow local files to be - // embedded from local files or Chrome extensions. - // Even without this check, the file load in frames is still blocked, - // but this may change in the future (https://crbug.com/550151). - if (origin && !/^file:|^chrome-extension:/.test(origin)) { - PDFViewerApplication.error('Blocked ' + origin + ' from loading ' + - file + '. Refused to load a local file in a non-local page ' + - 'for security reasons.'); - return; + isAllowedFileSchemeAccess(function(isAllowedAccess) { + if (isAllowedAccess) { + callback(file); + } else { + requestAccessToLocalFile(file); } - isAllowedFileSchemeAccess(function(isAllowedAccess) { - if (isAllowedAccess) { - callback(file); - } else { - requestAccessToLocalFile(file); - } - }); }); - return; - } - callback(file); - }); + }); + return; + } + callback(file); }; function getEmbedderOrigin(callback) {