commit f313438cb5d9d7e2f0080dc2fdd31828100fe4ae Author: Mike Perry <mikeperry-git@fscked.org> Date: Tue Feb 5 16:19:38 2013 -0800 Rename crash observer to the startup observer. --- src/chrome.manifest | 6 +- src/components/crash-observer.js | 266 ------------------------------------ src/components/startup-observer.js | 266 ++++++++++++++++++++++++++++++++++++ 3 files changed, 269 insertions(+), 269 deletions(-) diff --git a/src/chrome.manifest b/src/chrome.manifest index a6b2937..a6b2ef5 100644 --- a/src/chrome.manifest +++ b/src/chrome.manifest @@ -137,8 +137,8 @@ contract @mozilla.org/widget/dragservice;1 {3da0269f-fc29-4e9e-a678-c3b1cafcf13f component {aef08952-b003-4697-b935-a392367e214f} components/tbSessionStore.js contract @torproject.org/torbutton-ss-blocker;1 {aef08952-b003-4697-b935-a392367e214f} -component {06322def-6fde-4c06-aef6-47ae8e799629} components/crash-observer.js -contract @torproject.org/crash-observer;1 {06322def-6fde-4c06-aef6-47ae8e799629} +component {06322def-6fde-4c06-aef6-47ae8e799629} components/startup-observer.js +contract @torproject.org/startup-observer;1 {06322def-6fde-4c06-aef6-47ae8e799629} component {e6204253-b690-4159-bfe8-d4eedab6b3be} components/cookie-jar-selector.js contract @torproject.org/cookie-jar-selector;1 {e6204253-b690-4159-bfe8-d4eedab6b3be} @@ -161,4 +161,4 @@ contract @torproject.org/torbutton-logger;1 {f36d72c9-9718-4134-b550-e109638331d category profile-after-change CookieJarSelector @torproject.org/cookie-jar-selector;1 # category profile-after-change RefSpoofer @torproject.org/torRefSpoofer;1 category profile-after-change TBSessionBlocker @torproject.org/torbutton-ss-blocker;1 -category profile-after-change CrashObserver @torproject.org/crash-observer;1 +category profile-after-change StartupObserver @torproject.org/startup-observer;1 diff --git a/src/components/crash-observer.js b/src/components/crash-observer.js deleted file mode 100644 index 89b0f49..0000000 --- a/src/components/crash-observer.js +++ /dev/null @@ -1,266 +0,0 @@ -// Bug 1506 P1-3: This code is mostly hackish remnants of session store -// support. There are a couple of observer events that *might* be worth -// listening to. Search for 1506 in the code. - -/************************************************************************* - * Crash observer (JavaScript XPCOM component) - * - * Cases tested (each during Tor and Non-Tor, FF4 and FF3.6) - * 1. Crash - * 2. Upgrade - * 3. Uninstall: - * XXX: Currently broken. Need - * https://developer.mozilla.org/en/Addons/Add-on_Manager/AddonListener#onOpera... - * https://developer.mozilla.org/en/Addons/Add-on_Manager/AddonManager#addAddon... - * 4. Fresh install - * - *************************************************************************/ - -const Cc = Components.classes; -const Ci = Components.interfaces; -const Cr = Components.results; - -// Module specific constants -const kMODULE_NAME = "Session crash detector"; -const kMODULE_CONTRACTID = "@torproject.org/crash-observer;1"; -const kMODULE_CID = Components.ID("06322def-6fde-4c06-aef6-47ae8e799629"); -const TORBUTTON_EXTENSION_UUID = "{E0204BD5-9D31-402B-A99D-A6AA8FFEBDCA}"; - -function CrashObserver() { - this._uninstall = false; - this.logger = Components.classes["@torproject.org/torbutton-logger;1"] - .getService(Components.interfaces.nsISupports).wrappedJSObject; - this._prefs = Components.classes["@mozilla.org/preferences-service;1"] - .getService(Components.interfaces.nsIPrefBranch); - this.logger.log(3, "Crash Observer created"); - - var observerService = Cc["@mozilla.org/observer-service;1"]. - getService(Ci.nsIObserverService); - observerService.addObserver(this, "quit-application-granted", false); - - // Determine if we are firefox 4 or not.. They changed the addon listeners - // in a backwards-incompatible way... - var appInfo = Components.classes["@mozilla.org/xre/app-info;1"] - .getService(Components.interfaces.nsIXULAppInfo); - var versionChecker = Components.classes["@mozilla.org/xpcom/version-comparator;1"] - .getService(Components.interfaces.nsIVersionComparator); - - if(versionChecker.compare(appInfo.version, "4.0a1") >= 0) { - this.is_ff4 = true; - } else { - this.is_ff4 = false; - } - - try { - var test = this._prefs.getCharPref("torbrowser.version"); - this.is_tbb = true; - this.logger.log(3, "This is a Tor Browser's XPCOM"); - } catch(e) { - this.logger.log(3, "This is not a Tor Browser's XPCOM"); - } - - if (this.is_ff4) { - // Bug 1506 P2/P3: You probably want to register this observer to clean up - // prefs if you're going to support using normal firefox. - Components.utils.import("resource://gre/modules/AddonManager.jsm"); - this.onEnabling = this.onOperationCancelled; - this.onDisabling = this.onUninstalling; - AddonManager.addAddonListener(this); - } else { - observerService.addObserver(this, "em-action-requested", false); - } -} - -CrashObserver.prototype = { - // AddonListeners. We need to listen to see if we are about to be - // disabled or uninstalled. We also need to track this, and listen - // for an arbitrary "cancel" event that changes the current state. - // This is for FF4 and above. The logic in em-action-requested handles - // it for earlier versions - // XXX: If firefox crashes before quit here, and still manages to uninstall - // us somehow, we will leave the browser in a sorry state... Let's hope they - // have the sense not to uninstall addons after an improper shutdown/crash - // (or at least give us this event again in that case). - // Bug 1506 P2/P3: You probably want to register this observer to clean up - // prefs if you're going to support using normal firefox. - onUninstalling: function(addon, needsRestart) { - if (addon.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { - this._uninstall = true; - this.logger.log(4, "User requested disable/uninstall of Torbutton. Preparing for death."); - - if (!needsRestart) { - this.logger.log(5, - "Torbutton uninstalled/disabled, but a restart is not needed? How can this happen?"); - } - } - }, - - // This is done in the constructor. JS doesn't allow this... - //onDisabling: this.onUninstalling, - - // Bug 1506 P2/P3: You probably want to register this observer to clean up - // prefs if you're going to support using normal firefox. - onOperationCancelled: function(addon) { - if (addon.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { - this.logger.log(4, "Uninstall of Torbutton canceled. Hurray!"); - this._uninstall = false; - } - }, - - // Bug 6803: We need to get the env vars early due to - // some weird proxy caching code that showed up in FF15. - // Otherwise, homepage domain loads fail forever. - getProxySettings: function() { - // Bug 1506: Still want to get these env vars - var environ = Components.classes["@mozilla.org/process/environment;1"] - .getService(Components.interfaces.nsIEnvironment); - - if (environ.exists("TOR_SOCKS_PORT")) { - this.logger.log(3, "Resetting socks port to "+environ.get("TOR_SOCKS_PORT")); - this._prefs.setIntPref('extensions.torbutton.socks_port', - parseInt(environ.get("TOR_SOCKS_PORT"))); - if (this.is_tbb) { - this._prefs.setIntPref('network.proxy.socks_port', parseInt(environ.get("TOR_SOCKS_PORT"))); - - // XXX: Hack for TBB people who alternate between transproxy and non - this._prefs.setCharPref('extensions.torbutton.settings_method', 'recommended'); - this._prefs.setBoolPref('extensions.torbutton.saved.transparentTor', false); - this._prefs.setBoolPref('network.proxy.socks_remote_dns', true); - this._prefs.setIntPref('network.proxy.type', 1); - } - } else if (this._prefs.getCharPref('extensions.torbutton.settings_method') == 'recommended') { - this._prefs.setIntPref('extensions.torbutton.socks_port', 9050); - } - - if (environ.exists("TOR_SOCKS_HOST")) { - this._prefs.setCharPref('extensions.torbutton.socks_host', environ.get("TOR_SOCKS_HOST")); - if (this.is_tbb) { - this._prefs.setCharPref('network.proxy.socks', environ.get("TOR_SOCKS_HOST")); - } - } else if (this._prefs.getCharPref('extensions.torbutton.settings_method') == 'recommended') { - this._prefs.setCharPref('extensions.torbutton.socks_host', '127.0.0.1'); - } - - if (environ.exists("TOR_TRANSPROXY")) { - this.logger.log(3, "Resetting Tor settings to transproxy"); - this._prefs.setCharPref('extensions.torbutton.settings_method', 'transparent'); - this._prefs.setBoolPref('extensions.torbutton.saved.transparentTor', true); - this._prefs.setIntPref('extensions.torbutton.socks_port', 0); - this._prefs.setCharPref('extensions.torbutton.socks_host', ""); - if (this.is_tbb) { - this._prefs.setBoolPref('network.proxy.socks_remote_dns', false); - this._prefs.setIntPref('network.proxy.type', 0); - this._prefs.setIntPref('network.proxy.socks_port', 0); - this._prefs.setCharPref('network.proxy.socks', ""); - } - } - }, - - observe: function(subject, topic, data) { - if(topic == "profile-after-change") { - // Bug 1506 P1: We listen to these prefs as signals for startup, - // but only for hackish reasons. - this._prefs.setBoolPref("extensions.torbutton.startup", true); - - this.getProxySettings(); - } else if (topic == "em-action-requested") { - this.logger.log(3, "Uninstall action requested.."); - // http://xulsolutions.blogspot.com/2006/07/creating-uninstall-script-for.html - subject.QueryInterface(Components.interfaces.nsIUpdateItem); - this.logger.log(3, "Uninstall: "+data+" "+subject.id.toUpperCase()); - - if (subject.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { - this.logger.log(3, "Uninstall: "+data); - if (data == "item-uninstalled" || data == "item-disabled") { - this._uninstall = true; - } else if (data == "item-cancel-action") { - this._uninstall = false; - } - } - } else if (topic == "quit-application-granted") { - // Bug 1506 P2/P3: You probably want to register this observer to clean up - // prefs if you're going to support using normal firefox. - this.logger.log(3, "Got firefox quit event."); - var chrome = null; - try { - var wm = Cc["@mozilla.org/appshell/window-mediator;1"] - .getService(Components.interfaces.nsIWindowMediator); - var chrome = wm.getMostRecentWindow("navigator:browser"); - } catch(e) { - this.logger.log(3, "Exception on shutdown window: "+e); - } - - if (this._uninstall) { - if (chrome) { - chrome.torbutton_disable_tor(); - this.logger.log(4, - "Disabling Torbutton prior to uninstall."); - } else { - this.logger.log(5, - "User asked to uninstall, but we have no window!"); - } - } - - if((this._prefs.getIntPref("extensions.torbutton.shutdown_method") == 1 && - this._prefs.getBoolPref("extensions.torbutton.tor_enabled")) - || this._prefs.getIntPref("extensions.torbutton.shutdown_method") == 2) { - var selector = - Components.classes["@torproject.org/cookie-jar-selector;1"] - .getService(Components.interfaces.nsISupports) - .wrappedJSObject; - selector.clearCookies(); - // clear the cookie jar by saving the empty cookies to it. - if(this._prefs.getIntPref("extensions.torbutton.shutdown_method") == 2) { - if(this._prefs.getBoolPref('extensions.torbutton.dual_cookie_jars')) - selector.saveCookies("tor"); - selector.saveCookies("nontor"); - } else if(this._prefs.getBoolPref('extensions.torbutton.dual_cookie_jars')) { - selector.saveCookies("tor"); - } - } - this.logger.log(3, "Torbutton normal exit."); - //this.unregister(); - } - - // In all cases, force prefs to be synced to disk - var prefService = Components.classes["@mozilla.org/preferences-service;1"] - .getService(Components.interfaces.nsIPrefService); - prefService.savePrefFile(null); - }, - - QueryInterface: function(iid) { - if (iid.equals(Components.interfaces.nsISupports)) { - return this; - } - if(iid.equals(Components.interfaces.nsIClassInfo)) { - return this; - } - return this; - }, - - // method of nsIClassInfo - classDescription: "Torbutton Crash Observer", - classID: kMODULE_CID, - contractID: kMODULE_CONTRACTID, - - // Hack to get us registered early to observe recovery - _xpcom_categories: [{category:"profile-after-change"}], - - getInterfaces: function(count) { - var interfaceList = [nsIClassInfo]; - count.value = interfaceList.length; - return interfaceList; - }, - getHelperForLanguage: function(count) { return null; } - -}; - -/** -* XPCOMUtils.generateNSGetFactory was introduced in Mozilla 2 (Firefox 4). -* XPCOMUtils.generateNSGetModule is for Mozilla 1.9.2 (Firefox 3.6). -*/ -Components.utils.import("resource://gre/modules/XPCOMUtils.jsm"); -if (XPCOMUtils.generateNSGetFactory) - var NSGetFactory = XPCOMUtils.generateNSGetFactory([CrashObserver]); -else - var NSGetModule = XPCOMUtils.generateNSGetModule([CrashObserver]); diff --git a/src/components/startup-observer.js b/src/components/startup-observer.js new file mode 100644 index 0000000..10d805e --- /dev/null +++ b/src/components/startup-observer.js @@ -0,0 +1,266 @@ +// Bug 1506 P1-3: This code is mostly hackish remnants of session store +// support. There are a couple of observer events that *might* be worth +// listening to. Search for 1506 in the code. + +/************************************************************************* + * Startup observer (JavaScript XPCOM component) + * + * Cases tested (each during Tor and Non-Tor, FF4 and FF3.6) + * 1. Crash + * 2. Upgrade + * 3. Uninstall: + * XXX: Currently broken. Need + * https://developer.mozilla.org/en/Addons/Add-on_Manager/AddonListener#onOpera... + * https://developer.mozilla.org/en/Addons/Add-on_Manager/AddonManager#addAddon... + * 4. Fresh install + * + *************************************************************************/ + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cr = Components.results; + +// Module specific constants +const kMODULE_NAME = "Startup"; +const kMODULE_CONTRACTID = "@torproject.org/startup-observer;1"; +const kMODULE_CID = Components.ID("06322def-6fde-4c06-aef6-47ae8e799629"); +const TORBUTTON_EXTENSION_UUID = "{E0204BD5-9D31-402B-A99D-A6AA8FFEBDCA}"; + +function StartupObserver() { + this._uninstall = false; + this.logger = Components.classes["@torproject.org/torbutton-logger;1"] + .getService(Components.interfaces.nsISupports).wrappedJSObject; + this._prefs = Components.classes["@mozilla.org/preferences-service;1"] + .getService(Components.interfaces.nsIPrefBranch); + this.logger.log(3, "Startup Observer created"); + + var observerService = Cc["@mozilla.org/observer-service;1"]. + getService(Ci.nsIObserverService); + observerService.addObserver(this, "quit-application-granted", false); + + // Determine if we are firefox 4 or not.. They changed the addon listeners + // in a backwards-incompatible way... + var appInfo = Components.classes["@mozilla.org/xre/app-info;1"] + .getService(Components.interfaces.nsIXULAppInfo); + var versionChecker = Components.classes["@mozilla.org/xpcom/version-comparator;1"] + .getService(Components.interfaces.nsIVersionComparator); + + if(versionChecker.compare(appInfo.version, "4.0a1") >= 0) { + this.is_ff4 = true; + } else { + this.is_ff4 = false; + } + + try { + var test = this._prefs.getCharPref("torbrowser.version"); + this.is_tbb = true; + this.logger.log(3, "This is a Tor Browser's XPCOM"); + } catch(e) { + this.logger.log(3, "This is not a Tor Browser's XPCOM"); + } + + if (this.is_ff4) { + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. + Components.utils.import("resource://gre/modules/AddonManager.jsm"); + this.onEnabling = this.onOperationCancelled; + this.onDisabling = this.onUninstalling; + AddonManager.addAddonListener(this); + } else { + observerService.addObserver(this, "em-action-requested", false); + } +} + +StartupObserver.prototype = { + // AddonListeners. We need to listen to see if we are about to be + // disabled or uninstalled. We also need to track this, and listen + // for an arbitrary "cancel" event that changes the current state. + // This is for FF4 and above. The logic in em-action-requested handles + // it for earlier versions + // XXX: If firefox crashes before quit here, and still manages to uninstall + // us somehow, we will leave the browser in a sorry state... Let's hope they + // have the sense not to uninstall addons after an improper shutdown/crash + // (or at least give us this event again in that case). + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. + onUninstalling: function(addon, needsRestart) { + if (addon.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { + this._uninstall = true; + this.logger.log(4, "User requested disable/uninstall of Torbutton. Preparing for death."); + + if (!needsRestart) { + this.logger.log(5, + "Torbutton uninstalled/disabled, but a restart is not needed? How can this happen?"); + } + } + }, + + // This is done in the constructor. JS doesn't allow this... + //onDisabling: this.onUninstalling, + + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. + onOperationCancelled: function(addon) { + if (addon.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { + this.logger.log(4, "Uninstall of Torbutton canceled. Hurray!"); + this._uninstall = false; + } + }, + + // Bug 6803: We need to get the env vars early due to + // some weird proxy caching code that showed up in FF15. + // Otherwise, homepage domain loads fail forever. + getProxySettings: function() { + // Bug 1506: Still want to get these env vars + var environ = Components.classes["@mozilla.org/process/environment;1"] + .getService(Components.interfaces.nsIEnvironment); + + if (environ.exists("TOR_SOCKS_PORT")) { + this.logger.log(3, "Resetting socks port to "+environ.get("TOR_SOCKS_PORT")); + this._prefs.setIntPref('extensions.torbutton.socks_port', + parseInt(environ.get("TOR_SOCKS_PORT"))); + if (this.is_tbb) { + this._prefs.setIntPref('network.proxy.socks_port', parseInt(environ.get("TOR_SOCKS_PORT"))); + + // XXX: Hack for TBB people who alternate between transproxy and non + this._prefs.setCharPref('extensions.torbutton.settings_method', 'recommended'); + this._prefs.setBoolPref('extensions.torbutton.saved.transparentTor', false); + this._prefs.setBoolPref('network.proxy.socks_remote_dns', true); + this._prefs.setIntPref('network.proxy.type', 1); + } + } else if (this._prefs.getCharPref('extensions.torbutton.settings_method') == 'recommended') { + this._prefs.setIntPref('extensions.torbutton.socks_port', 9050); + } + + if (environ.exists("TOR_SOCKS_HOST")) { + this._prefs.setCharPref('extensions.torbutton.socks_host', environ.get("TOR_SOCKS_HOST")); + if (this.is_tbb) { + this._prefs.setCharPref('network.proxy.socks', environ.get("TOR_SOCKS_HOST")); + } + } else if (this._prefs.getCharPref('extensions.torbutton.settings_method') == 'recommended') { + this._prefs.setCharPref('extensions.torbutton.socks_host', '127.0.0.1'); + } + + if (environ.exists("TOR_TRANSPROXY")) { + this.logger.log(3, "Resetting Tor settings to transproxy"); + this._prefs.setCharPref('extensions.torbutton.settings_method', 'transparent'); + this._prefs.setBoolPref('extensions.torbutton.saved.transparentTor', true); + this._prefs.setIntPref('extensions.torbutton.socks_port', 0); + this._prefs.setCharPref('extensions.torbutton.socks_host', ""); + if (this.is_tbb) { + this._prefs.setBoolPref('network.proxy.socks_remote_dns', false); + this._prefs.setIntPref('network.proxy.type', 0); + this._prefs.setIntPref('network.proxy.socks_port', 0); + this._prefs.setCharPref('network.proxy.socks', ""); + } + } + }, + + observe: function(subject, topic, data) { + if(topic == "profile-after-change") { + // Bug 1506 P1: We listen to these prefs as signals for startup, + // but only for hackish reasons. + this._prefs.setBoolPref("extensions.torbutton.startup", true); + + this.getProxySettings(); + } else if (topic == "em-action-requested") { + this.logger.log(3, "Uninstall action requested.."); + // http://xulsolutions.blogspot.com/2006/07/creating-uninstall-script-for.html + subject.QueryInterface(Components.interfaces.nsIUpdateItem); + this.logger.log(3, "Uninstall: "+data+" "+subject.id.toUpperCase()); + + if (subject.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { + this.logger.log(3, "Uninstall: "+data); + if (data == "item-uninstalled" || data == "item-disabled") { + this._uninstall = true; + } else if (data == "item-cancel-action") { + this._uninstall = false; + } + } + } else if (topic == "quit-application-granted") { + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. + this.logger.log(3, "Got firefox quit event."); + var chrome = null; + try { + var wm = Cc["@mozilla.org/appshell/window-mediator;1"] + .getService(Components.interfaces.nsIWindowMediator); + var chrome = wm.getMostRecentWindow("navigator:browser"); + } catch(e) { + this.logger.log(3, "Exception on shutdown window: "+e); + } + + if (this._uninstall) { + if (chrome) { + chrome.torbutton_disable_tor(); + this.logger.log(4, + "Disabling Torbutton prior to uninstall."); + } else { + this.logger.log(5, + "User asked to uninstall, but we have no window!"); + } + } + + if((this._prefs.getIntPref("extensions.torbutton.shutdown_method") == 1 && + this._prefs.getBoolPref("extensions.torbutton.tor_enabled")) + || this._prefs.getIntPref("extensions.torbutton.shutdown_method") == 2) { + var selector = + Components.classes["@torproject.org/cookie-jar-selector;1"] + .getService(Components.interfaces.nsISupports) + .wrappedJSObject; + selector.clearCookies(); + // clear the cookie jar by saving the empty cookies to it. + if(this._prefs.getIntPref("extensions.torbutton.shutdown_method") == 2) { + if(this._prefs.getBoolPref('extensions.torbutton.dual_cookie_jars')) + selector.saveCookies("tor"); + selector.saveCookies("nontor"); + } else if(this._prefs.getBoolPref('extensions.torbutton.dual_cookie_jars')) { + selector.saveCookies("tor"); + } + } + this.logger.log(3, "Torbutton normal exit."); + //this.unregister(); + } + + // In all cases, force prefs to be synced to disk + var prefService = Components.classes["@mozilla.org/preferences-service;1"] + .getService(Components.interfaces.nsIPrefService); + prefService.savePrefFile(null); + }, + + QueryInterface: function(iid) { + if (iid.equals(Components.interfaces.nsISupports)) { + return this; + } + if(iid.equals(Components.interfaces.nsIClassInfo)) { + return this; + } + return this; + }, + + // method of nsIClassInfo + classDescription: "Torbutton Startup Observer", + classID: kMODULE_CID, + contractID: kMODULE_CONTRACTID, + + // Hack to get us registered early to observe recovery + _xpcom_categories: [{category:"profile-after-change"}], + + getInterfaces: function(count) { + var interfaceList = [nsIClassInfo]; + count.value = interfaceList.length; + return interfaceList; + }, + getHelperForLanguage: function(count) { return null; } + +}; + +/** +* XPCOMUtils.generateNSGetFactory was introduced in Mozilla 2 (Firefox 4). +* XPCOMUtils.generateNSGetModule is for Mozilla 1.9.2 (Firefox 3.6). +*/ +Components.utils.import("resource://gre/modules/XPCOMUtils.jsm"); +if (XPCOMUtils.generateNSGetFactory) + var NSGetFactory = XPCOMUtils.generateNSGetFactory([StartupObserver]); +else + var NSGetModule = XPCOMUtils.generateNSGetModule([StartupObserver]);