From 4994faa3c103a9672cdd48c7838d5073ddc86a48 Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Fri, 3 Feb 2012 16:49:44 -0800 Subject: [PATCH 1/7] Use services where possible. --- extensions/firefox/components/PdfStreamConverter.js | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index bd3bfffcf..115db3e1f 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -17,8 +17,7 @@ Cu.import('resource://gre/modules/Services.jsm'); function log(aMsg) { let msg = 'PdfStreamConverter.js: ' + (aMsg.join ? aMsg.join('') : aMsg); - Cc['@mozilla.org/consoleservice;1'].getService(Ci.nsIConsoleService) - .logStringMessage(msg); + Services.console.logStringMessage(msg); dump(msg + '\n'); } let application = Cc['@mozilla.org/fuel/application;1'] @@ -121,8 +120,7 @@ PdfStreamConverter.prototype = { aRequest.cancel(Cr.NS_BINDING_ABORTED); // Create a new channel that is viewer loaded as a resource. - var ioService = Cc['@mozilla.org/network/io-service;1'] - .getService(Ci.nsIIOService); + var ioService = Services.io; var channel = ioService.newChannel( 'resource://pdf.js/web/viewer.html', null, null); From b6f05fb8c6c4dc4ce6a00fba34a57bc77b8b02ed Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Mon, 6 Feb 2012 13:23:18 -0800 Subject: [PATCH 2/7] Throw exception for sync version. Don't use const. --- extensions/firefox/components/PdfStreamConverter.js | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index 115db3e1f..c990e80d5 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -9,7 +9,6 @@ const Cr = Components.results; const Cu = Components.utils; const PDFJS_EVENT_ID = 'pdf.js.message'; const PDF_CONTENT_TYPE = 'application/pdf'; -const NS_ERROR_NOT_IMPLEMENTED = 0x80004001; const EXT_PREFIX = 'extensions.uriloader@pdf.js'; Cu.import('resource://gre/modules/XPCOMUtils.jsm'); @@ -94,13 +93,13 @@ PdfStreamConverter.prototype = { // nsIStreamConverter::convert convert: function(aFromStream, aFromType, aToType, aCtxt) { - return aFromStream; + throw Cr.NS_ERROR_NOT_IMPLEMENTED; }, // nsIStreamConverter::asyncConvertData asyncConvertData: function(aFromType, aToType, aListener, aCtxt) { if (!Services.prefs.getBoolPref('extensions.pdf.js.active')) - throw NS_ERROR_NOT_IMPLEMENTED; + throw Cr.NS_ERROR_NOT_IMPLEMENTED; // Store the listener passed to us this.listener = aListener; }, From 7a17676b06cf185e5e484c64fc6c225b0affc3f6 Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Mon, 6 Feb 2012 16:06:18 -0800 Subject: [PATCH 3/7] Better way to add custom event listener. --- .../firefox/components/PdfStreamConverter.js | 48 ++++++++++++++----- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index c990e80d5..54cc6890d 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -19,6 +19,18 @@ function log(aMsg) { Services.console.logStringMessage(msg); dump(msg + '\n'); } +function getWindow(top, id) top.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIDOMWindowUtils) + .getOuterWindowWithId(id); +function windowID(win) win.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIDOMWindowUtils) + .outerWindowID; +function topWindow(win) win.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIWebNavigation) + .QueryInterface(Ci.nsIDocShellTreeItem) + .rootTreeItem + .QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIDOMWindow); let application = Cc['@mozilla.org/fuel/application;1'] .getService(Ci.fuelIApplication); let privateBrowsing = Cc['@mozilla.org/privatebrowsing;1'] @@ -131,20 +143,30 @@ PdfStreamConverter.prototype = { // that its the one we want by its URL. When the correct DOM is found create // an event listener on that window for the pdf.js events that require // chrome priviledges. - var url = aRequest.URI.spec; - var gb = Services.wm.getMostRecentWindow('navigator:browser'); - var domListener = function domListener(event) { - var doc = event.originalTarget; - var win = doc.defaultView; - if (doc.location.href === url) { - gb.removeEventListener('DOMContentLoaded', domListener); - var requestListener = new RequestListener(new ChromeActions()); - win.addEventListener(PDFJS_EVENT_ID, function(event) { - requestListener.receive(event); - }, false, true); + let window = aRequest.loadGroup.groupObserver + .QueryInterface(Ci.nsIWebProgress) + .DOMWindow; + let top = topWindow(window); + let id = windowID(window); + window = null; + + top.addEventListener('DOMWindowCreated', function onDOMWinCreated(event) { + let doc = event.originalTarget; + let win = doc.defaultView; + + if (id == windowID(win)) { + top.removeEventListener('DOMWindowCreated', onDOMWinCreated, true); + if (!doc.documentURIObject.equals(aRequest.URI)) + return; + + let requestListener = new RequestListener(new ChromeActions); + win.addEventListener(PDFJS_EVENT_ID, function(event) { + requestListener.receive(event); + }, false, true); + } else if (!getWindow(top, id)) { + top.removeEventListener('DOMWindowCreated', onDOMWinCreated, true); } - }; - gb.addEventListener('DOMContentLoaded', domListener, false); + }, true); }, // nsIRequestObserver::onStopRequest From 9a1741f466a695752027c74e8196f0683ba5a49b Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Mon, 6 Feb 2012 21:04:53 -0800 Subject: [PATCH 4/7] Protect against a malicious setDatabase. Remove unneeded save data. --- extensions/firefox/components/PdfStreamConverter.js | 5 ++++- web/viewer.js | 4 +--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index 54cc6890d..78a1f5a46 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -48,6 +48,9 @@ ChromeActions.prototype = { setDatabase: function(data) { if (this.inPrivateBrowswing) return; + // Protect against something sending tons of data to setDatabase. + if (data.length > 4096) + return; application.prefs.setValue(EXT_PREFIX + '.database', data); }, getDatabase: function() { @@ -142,7 +145,7 @@ PdfStreamConverter.prototype = { // Setup a global listener waiting for the next DOM to be created and verfiy // that its the one we want by its URL. When the correct DOM is found create // an event listener on that window for the pdf.js events that require - // chrome priviledges. + // chrome priviledges. Code snippet from John Galt. let window = aRequest.loadGroup.groupObserver .QueryInterface(Ci.nsIWebProgress) .DOMWindow; diff --git a/web/viewer.js b/web/viewer.js index 3aca926e9..5a1a1df03 100644 --- a/web/viewer.js +++ b/web/viewer.js @@ -109,7 +109,7 @@ var Settings = (function SettingsClosure() { var database = null; var index; if (isFirefoxExtension) - database = FirefoxCom.request('getDatabase', null); + database = FirefoxCom.request('getDatabase', null) || '{}'; else if (isLocalStorageEnabled) database = localStorage.getItem('database') || '{}'; else @@ -131,8 +131,6 @@ var Settings = (function SettingsClosure() { index = database.files.push({fingerprint: fingerprint}) - 1; this.file = database.files[index]; this.database = database; - if (isLocalStorageEnabled) - localStorage.setItem('database', JSON.stringify(database)); } Settings.prototype = { From 1af9a72011f26b9f1641d656923f2090337a2688 Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Tue, 7 Feb 2012 16:39:07 -0800 Subject: [PATCH 5/7] Make the add-on truly restartless. --- Makefile | 2 - extensions/firefox/bootstrap.js | 72 +++++++++++++++---- extensions/firefox/chrome.manifest | 5 -- .../firefox/components/PdfStreamConverter.js | 2 + 4 files changed, 62 insertions(+), 19 deletions(-) delete mode 100644 extensions/firefox/chrome.manifest diff --git a/Makefile b/Makefile index c1062d49d..043cb7fb5 100644 --- a/Makefile +++ b/Makefile @@ -223,14 +223,12 @@ FIREFOX_CONTENT_DIR := $(EXTENSION_SRC)/firefox/$(CONTENT_DIR)/ FIREFOX_EXTENSION_FILES_TO_COPY = \ *.js \ *.rdf \ - chrome.manifest \ components \ $(NULL) FIREFOX_EXTENSION_FILES = \ content \ *.js \ install.rdf \ - chrome.manifest \ components \ content \ $(NULL) diff --git a/extensions/firefox/bootstrap.js b/extensions/firefox/bootstrap.js index f1a712c0c..fbea70203 100644 --- a/extensions/firefox/bootstrap.js +++ b/extensions/firefox/bootstrap.js @@ -3,8 +3,9 @@ 'use strict'; +const RESOURCE_NAME = 'pdf.js'; const EXT_PREFIX = 'extensions.uriloader@pdf.js'; -const PDFJS_EVENT_ID = 'pdf.js.message'; + let Cc = Components.classes; let Ci = Components.interfaces; let Cm = Components.manager; @@ -16,24 +17,71 @@ function log(str) { dump(str + '\n'); } +// Register/unregister a class as a component. +let Factory = { + registrar: null, + aClass: null, + register: function(aClass) { + if (this.aClass) { + log('Cannot register more than one class'); + return; + } + this.registrar = Cm.QueryInterface(Ci.nsIComponentRegistrar); + this.aClass = aClass; + var proto = aClass.prototype; + this.registrar.registerFactory(proto.classID, proto.classDescription, + proto.contractID, this); + }, + unregister: function() { + if (!this.aClass) { + log('Class was never registered.'); + return; + } + var proto = this.aClass.prototype; + this.registrar.unregisterFactory(proto.classID, this); + this.aClass = null; + }, + // nsIFactory::createInstance + createInstance: function(outer, iid) { + if (outer !== null) + throw Cr.NS_ERROR_NO_AGGREGATION; + return (new (this.aClass)).QueryInterface(iid); + } +}; + +// As of Firefox 13 bootstrapped add-ons don't support automatic registering and +// unregistering of resource urls and components/contracts. Until then we do +// it programatically. See ManifestDirective ManifestParser.cpp for support. function startup(aData, aReason) { - let manifestPath = 'chrome.manifest'; - let manifest = Cc['@mozilla.org/file/local;1'] - .createInstance(Ci.nsILocalFile); - try { - manifest.initWithPath(aData.installPath.path); - manifest.append(manifestPath); - Cm.QueryInterface(Ci.nsIComponentRegistrar).autoRegister(manifest); - Services.prefs.setBoolPref('extensions.pdf.js.active', true); - } catch (e) { - log(e); - } + // Setup the resource url. + var ioService = Services.io; + var resProt = ioService.getProtocolHandler('resource') + .QueryInterface(Ci.nsIResProtocolHandler); + var aliasFile = Cc['@mozilla.org/file/local;1'] + .createInstance(Ci.nsILocalFile); + var componentPath = aData.installPath.clone(); + componentPath.append('content'); + aliasFile.initWithPath(componentPath.path); + var aliasURI = ioService.newFileURI(aliasFile); + resProt.setSubstitution(RESOURCE_NAME, aliasURI); + + // Load the component and register it. + Cu.import(aData.resourceURI.spec + 'components/PdfStreamConverter.js'); + Factory.register(PdfStreamConverter); + Services.prefs.setBoolPref('extensions.pdf.js.active', true); } function shutdown(aData, aReason) { if (Services.prefs.getBoolPref('extensions.pdf.js.active')) Services.prefs.setBoolPref('extensions.pdf.js.active', false); + var ioService = Services.io; + var resProt = ioService.getProtocolHandler('resource') + .QueryInterface(Ci.nsIResProtocolHandler); + // Remove the resource url. + resProt.setSubstitution(RESOURCE_NAME, null); + // Remove the contract/component. + Factory.unregister(); } function install(aData, aReason) { diff --git a/extensions/firefox/chrome.manifest b/extensions/firefox/chrome.manifest deleted file mode 100644 index 5351257e7..000000000 --- a/extensions/firefox/chrome.manifest +++ /dev/null @@ -1,5 +0,0 @@ -resource pdf.js content/ - -component {6457a96b-2d68-439a-bcfa-44465fbcdbb1} components/PdfStreamConverter.js -contract @mozilla.org/streamconv;1?from=application/pdf&to=*/* {6457a96b-2d68-439a-bcfa-44465fbcdbb1} - diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index 78a1f5a46..7b8cdab49 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -3,6 +3,8 @@ 'use strict'; +var EXPORTED_SYMBOLS = ['PdfStreamConverter']; + const Cc = Components.classes; const Ci = Components.interfaces; const Cr = Components.results; From b867aa9922be54bc040abfbda00dec86f33f45b8 Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Tue, 7 Feb 2012 16:44:03 -0800 Subject: [PATCH 6/7] Switch to constant for max database length. --- extensions/firefox/components/PdfStreamConverter.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index 7b8cdab49..4a990df92 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -12,6 +12,7 @@ const Cu = Components.utils; const PDFJS_EVENT_ID = 'pdf.js.message'; const PDF_CONTENT_TYPE = 'application/pdf'; const EXT_PREFIX = 'extensions.uriloader@pdf.js'; +const MAX_DATABASE_LENGTH = 4096; Cu.import('resource://gre/modules/XPCOMUtils.jsm'); Cu.import('resource://gre/modules/Services.jsm'); @@ -51,7 +52,7 @@ ChromeActions.prototype = { if (this.inPrivateBrowswing) return; // Protect against something sending tons of data to setDatabase. - if (data.length > 4096) + if (data.length > MAX_DATABASE_LENGTH) return; application.prefs.setValue(EXT_PREFIX + '.database', data); }, From fb31dc3f86e137fd0a56dba711033d70c0b97210 Mon Sep 17 00:00:00 2001 From: Brendan Dahl Date: Tue, 7 Feb 2012 17:54:40 -0800 Subject: [PATCH 7/7] Fix some nits. --- .../firefox/components/PdfStreamConverter.js | 50 +++++++++++-------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/extensions/firefox/components/PdfStreamConverter.js b/extensions/firefox/components/PdfStreamConverter.js index 4a990df92..06db4e2d3 100644 --- a/extensions/firefox/components/PdfStreamConverter.js +++ b/extensions/firefox/components/PdfStreamConverter.js @@ -22,18 +22,24 @@ function log(aMsg) { Services.console.logStringMessage(msg); dump(msg + '\n'); } -function getWindow(top, id) top.QueryInterface(Ci.nsIInterfaceRequestor) - .getInterface(Ci.nsIDOMWindowUtils) - .getOuterWindowWithId(id); -function windowID(win) win.QueryInterface(Ci.nsIInterfaceRequestor) - .getInterface(Ci.nsIDOMWindowUtils) - .outerWindowID; -function topWindow(win) win.QueryInterface(Ci.nsIInterfaceRequestor) - .getInterface(Ci.nsIWebNavigation) - .QueryInterface(Ci.nsIDocShellTreeItem) - .rootTreeItem - .QueryInterface(Ci.nsIInterfaceRequestor) - .getInterface(Ci.nsIDOMWindow); +function getWindow(top, id) { + return top.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIDOMWindowUtils) + .getOuterWindowWithId(id); +} +function windowID(win) { + return win.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIDOMWindowUtils) + .outerWindowID; +} +function topWindow(win) { + return win.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIWebNavigation) + .QueryInterface(Ci.nsIDocShellTreeItem) + .rootTreeItem + .QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIDOMWindow); +} let application = Cc['@mozilla.org/fuel/application;1'] .getService(Ci.fuelIApplication); let privateBrowsing = Cc['@mozilla.org/privatebrowsing;1'] @@ -150,8 +156,8 @@ PdfStreamConverter.prototype = { // an event listener on that window for the pdf.js events that require // chrome priviledges. Code snippet from John Galt. let window = aRequest.loadGroup.groupObserver - .QueryInterface(Ci.nsIWebProgress) - .DOMWindow; + .QueryInterface(Ci.nsIWebProgress) + .DOMWindow; let top = topWindow(window); let id = windowID(window); window = null; @@ -161,14 +167,14 @@ PdfStreamConverter.prototype = { let win = doc.defaultView; if (id == windowID(win)) { - top.removeEventListener('DOMWindowCreated', onDOMWinCreated, true); - if (!doc.documentURIObject.equals(aRequest.URI)) - return; - - let requestListener = new RequestListener(new ChromeActions); - win.addEventListener(PDFJS_EVENT_ID, function(event) { - requestListener.receive(event); - }, false, true); + top.removeEventListener('DOMWindowCreated', onDOMWinCreated, true); + if (!doc.documentURIObject.equals(aRequest.URI)) + return; + + let requestListener = new RequestListener(new ChromeActions); + win.addEventListener(PDFJS_EVENT_ID, function(event) { + requestListener.receive(event); + }, false, true); } else if (!getWindow(top, id)) { top.removeEventListener('DOMWindowCreated', onDOMWinCreated, true); }