[CRX] Show nicely formatted URL in omnibox
Before commit:
chrome-extension://EXTENSIONID/content/web/viewer.html?file=http%3A%2F%2Fexample.com%2Ffile.pdf
After commit:
chrome-extension://EXTENSIONID/http://example/file.pdf
Technical details:
- The extension's background page uses the webRequest API to intercept
requests for <extension host>/<real path to pdf>, and redirect it to
the viewer's URL.
- viewer.js uses history.replaceState to rewrite the URL, so that it's
easier for users to recognize and copy-paste URLs.
- The fake paths /http:, /https:, /file:, etc. have been added to the
web_accessible_resources section of the manifest file, in order to
avoid seeing chrome-extension://invalid/ instead of the actual URL
when using history back/forward to navigate from/to the PDF viewer.
- Since the relative path resolving doesn't work because relative URLs
are inaccurate, a <base> tag has been added. This method has already
been proven to work in the Firefox add-on.
Notes:
- This commit has been cherry-picked from crx-using-streams-api.
- Need to merge https://github.com/mozilla/pdf.js/pull/3582 to deal with
a bug in Chrome <=30
- In Chrome, getting the contents of a FTP file is not possible, so
there's no support for FTP files, even though the extension router
recognizes the ftp: scheme.
2013-08-16 05:47:30 +09:00
|
|
|
/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set shiftwidth=2 tabstop=2 autoindent cindent expandtab: */
|
|
|
|
/*
|
|
|
|
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 */
|
|
|
|
|
|
|
|
'use strict';
|
|
|
|
(function ExtensionRouterClosure() {
|
|
|
|
var VIEWER_URL = chrome.extension.getURL('content/web/viewer.html');
|
|
|
|
var CRX_BASE_URL = chrome.extension.getURL('/');
|
|
|
|
|
2014-01-26 06:29:33 +09:00
|
|
|
var schemes = [
|
|
|
|
'http',
|
|
|
|
'https',
|
|
|
|
'ftp',
|
|
|
|
'file',
|
|
|
|
'chrome-extension',
|
|
|
|
// Chromium OS
|
|
|
|
'filesystem',
|
|
|
|
// Chromium OS, shorthand for filesystem:<origin>/external/
|
|
|
|
'drive'
|
|
|
|
];
|
|
|
|
|
2013-12-07 20:32:08 +09:00
|
|
|
/**
|
|
|
|
* @param {string} url The URL prefixed with chrome-extension://.../
|
|
|
|
* @return {string|undefined} The percent-encoded URL of the (PDF) file.
|
|
|
|
*/
|
|
|
|
function parseExtensionURL(url) {
|
|
|
|
url = url.substring(CRX_BASE_URL.length);
|
2014-01-26 06:29:33 +09:00
|
|
|
// Find the (url-encoded) colon and verify that the scheme is whitelisted.
|
|
|
|
var schemeIndex = url.search(/:|%3A/i);
|
|
|
|
if (schemeIndex === -1) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
var scheme = url.slice(0, schemeIndex).toLowerCase();
|
|
|
|
if (schemes.indexOf(scheme) >= 0) {
|
2013-12-07 20:32:08 +09:00
|
|
|
url = url.split('#')[0];
|
2014-01-26 06:29:33 +09:00
|
|
|
if (url.charAt(schemeIndex) === ':') {
|
2013-12-07 20:32:08 +09:00
|
|
|
url = encodeURIComponent(url);
|
|
|
|
}
|
|
|
|
return url;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {string} url URL of PDF Viewer.
|
|
|
|
* @return {string|undefined} The percent-encoded URL of the (PDF) file.
|
|
|
|
*/
|
|
|
|
function parseViewerURL(url) {
|
|
|
|
if (url.lastIndexOf(VIEWER_URL, 0) !== 0) {
|
|
|
|
// Does not even start with the correct URL. Bye!
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
url = url.match(/[&?]file=([^&#]+)/);
|
|
|
|
if (url) {
|
|
|
|
url = url[1];
|
|
|
|
return url;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {number} tabId ID of tab where the page action will be shown
|
|
|
|
* @param {string} url URL to be displayed in page action
|
|
|
|
*/
|
|
|
|
function showPageAction(tabId, displayUrl) {
|
|
|
|
var url = parseExtensionURL(displayUrl) || parseViewerURL(displayUrl);
|
|
|
|
if (url) {
|
|
|
|
chrome.pageAction.setPopup({
|
|
|
|
tabId: tabId,
|
|
|
|
popup: 'pageActionPopup.html?file=' + url
|
|
|
|
});
|
|
|
|
chrome.pageAction.show(tabId);
|
|
|
|
} else {
|
|
|
|
console.log('Unable to get PDF url from ' + displayUrl);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
[CRX] Show nicely formatted URL in omnibox
Before commit:
chrome-extension://EXTENSIONID/content/web/viewer.html?file=http%3A%2F%2Fexample.com%2Ffile.pdf
After commit:
chrome-extension://EXTENSIONID/http://example/file.pdf
Technical details:
- The extension's background page uses the webRequest API to intercept
requests for <extension host>/<real path to pdf>, and redirect it to
the viewer's URL.
- viewer.js uses history.replaceState to rewrite the URL, so that it's
easier for users to recognize and copy-paste URLs.
- The fake paths /http:, /https:, /file:, etc. have been added to the
web_accessible_resources section of the manifest file, in order to
avoid seeing chrome-extension://invalid/ instead of the actual URL
when using history back/forward to navigate from/to the PDF viewer.
- Since the relative path resolving doesn't work because relative URLs
are inaccurate, a <base> tag has been added. This method has already
been proven to work in the Firefox add-on.
Notes:
- This commit has been cherry-picked from crx-using-streams-api.
- Need to merge https://github.com/mozilla/pdf.js/pull/3582 to deal with
a bug in Chrome <=30
- In Chrome, getting the contents of a FTP file is not possible, so
there's no support for FTP files, even though the extension router
recognizes the ftp: scheme.
2013-08-16 05:47:30 +09:00
|
|
|
// TODO(rob): Use declarativeWebRequest once declared URL-encoding is
|
|
|
|
// supported, see http://crbug.com/273589
|
|
|
|
// (or rewrite the query string parser in viewer.js to get it to
|
|
|
|
// recognize the non-URL-encoded PDF URL.)
|
|
|
|
chrome.webRequest.onBeforeRequest.addListener(function(details) {
|
|
|
|
// This listener converts chrome-extension://.../http://...pdf to
|
|
|
|
// chrome-extension://.../content/web/viewer.html?file=http%3A%2F%2F...pdf
|
2013-12-07 20:32:08 +09:00
|
|
|
var url = parseExtensionURL(details.url);
|
|
|
|
if (url) {
|
[CRX] Show nicely formatted URL in omnibox
Before commit:
chrome-extension://EXTENSIONID/content/web/viewer.html?file=http%3A%2F%2Fexample.com%2Ffile.pdf
After commit:
chrome-extension://EXTENSIONID/http://example/file.pdf
Technical details:
- The extension's background page uses the webRequest API to intercept
requests for <extension host>/<real path to pdf>, and redirect it to
the viewer's URL.
- viewer.js uses history.replaceState to rewrite the URL, so that it's
easier for users to recognize and copy-paste URLs.
- The fake paths /http:, /https:, /file:, etc. have been added to the
web_accessible_resources section of the manifest file, in order to
avoid seeing chrome-extension://invalid/ instead of the actual URL
when using history back/forward to navigate from/to the PDF viewer.
- Since the relative path resolving doesn't work because relative URLs
are inaccurate, a <base> tag has been added. This method has already
been proven to work in the Firefox add-on.
Notes:
- This commit has been cherry-picked from crx-using-streams-api.
- Need to merge https://github.com/mozilla/pdf.js/pull/3582 to deal with
a bug in Chrome <=30
- In Chrome, getting the contents of a FTP file is not possible, so
there's no support for FTP files, even though the extension router
recognizes the ftp: scheme.
2013-08-16 05:47:30 +09:00
|
|
|
url = VIEWER_URL + '?file=' + url;
|
|
|
|
console.log('Redirecting ' + details.url + ' to ' + url);
|
|
|
|
return { redirectUrl: url };
|
|
|
|
}
|
|
|
|
}, {
|
|
|
|
types: ['main_frame', 'sub_frame'],
|
2014-01-26 06:29:33 +09:00
|
|
|
urls: schemes.map(function(scheme) {
|
|
|
|
// Format: "chrome-extension://[EXTENSIONID]/<scheme>*"
|
|
|
|
return CRX_BASE_URL + scheme + '*';
|
|
|
|
})
|
[CRX] Show nicely formatted URL in omnibox
Before commit:
chrome-extension://EXTENSIONID/content/web/viewer.html?file=http%3A%2F%2Fexample.com%2Ffile.pdf
After commit:
chrome-extension://EXTENSIONID/http://example/file.pdf
Technical details:
- The extension's background page uses the webRequest API to intercept
requests for <extension host>/<real path to pdf>, and redirect it to
the viewer's URL.
- viewer.js uses history.replaceState to rewrite the URL, so that it's
easier for users to recognize and copy-paste URLs.
- The fake paths /http:, /https:, /file:, etc. have been added to the
web_accessible_resources section of the manifest file, in order to
avoid seeing chrome-extension://invalid/ instead of the actual URL
when using history back/forward to navigate from/to the PDF viewer.
- Since the relative path resolving doesn't work because relative URLs
are inaccurate, a <base> tag has been added. This method has already
been proven to work in the Firefox add-on.
Notes:
- This commit has been cherry-picked from crx-using-streams-api.
- Need to merge https://github.com/mozilla/pdf.js/pull/3582 to deal with
a bug in Chrome <=30
- In Chrome, getting the contents of a FTP file is not possible, so
there's no support for FTP files, even though the extension router
recognizes the ftp: scheme.
2013-08-16 05:47:30 +09:00
|
|
|
}, ['blocking']);
|
2013-11-22 19:44:43 +09:00
|
|
|
|
2013-12-07 20:32:08 +09:00
|
|
|
chrome.runtime.onMessage.addListener(function(message, sender) {
|
|
|
|
if (message === 'showPageAction' && sender.tab) {
|
2014-01-26 04:09:04 +09:00
|
|
|
showPageAction(sender.tab.id, sender.tab.url);
|
2013-12-07 20:32:08 +09:00
|
|
|
}
|
|
|
|
});
|
|
|
|
|
2013-11-22 19:44:43 +09:00
|
|
|
// When session restore is used, viewer pages may be loaded before the
|
|
|
|
// webRequest event listener is attached (= page not found).
|
|
|
|
// Reload these tabs.
|
|
|
|
chrome.tabs.query({
|
2014-01-26 06:29:33 +09:00
|
|
|
url: CRX_BASE_URL + '*:*'
|
2013-11-22 19:44:43 +09:00
|
|
|
}, function(tabsFromLastSession) {
|
|
|
|
for (var i = 0; i < tabsFromLastSession.length; ++i) {
|
|
|
|
chrome.tabs.reload(tabsFromLastSession[i].id);
|
|
|
|
}
|
|
|
|
});
|
[CRX] Show nicely formatted URL in omnibox
Before commit:
chrome-extension://EXTENSIONID/content/web/viewer.html?file=http%3A%2F%2Fexample.com%2Ffile.pdf
After commit:
chrome-extension://EXTENSIONID/http://example/file.pdf
Technical details:
- The extension's background page uses the webRequest API to intercept
requests for <extension host>/<real path to pdf>, and redirect it to
the viewer's URL.
- viewer.js uses history.replaceState to rewrite the URL, so that it's
easier for users to recognize and copy-paste URLs.
- The fake paths /http:, /https:, /file:, etc. have been added to the
web_accessible_resources section of the manifest file, in order to
avoid seeing chrome-extension://invalid/ instead of the actual URL
when using history back/forward to navigate from/to the PDF viewer.
- Since the relative path resolving doesn't work because relative URLs
are inaccurate, a <base> tag has been added. This method has already
been proven to work in the Firefox add-on.
Notes:
- This commit has been cherry-picked from crx-using-streams-api.
- Need to merge https://github.com/mozilla/pdf.js/pull/3582 to deal with
a bug in Chrome <=30
- In Chrome, getting the contents of a FTP file is not possible, so
there's no support for FTP files, even though the extension router
recognizes the ftp: scheme.
2013-08-16 05:47:30 +09:00
|
|
|
console.log('Set up extension URL router.');
|
|
|
|
})();
|