components/startup-observer.js

   1 // Bug 1506 P1-3: This code is mostly hackish remnants of session store
   2 // support. There are a couple of observer events that *might* be worth
   3 // listening to. Search for 1506 in the code.
   4
   5 /*************************************************************************
   6  * Startup observer (JavaScript XPCOM component)
   7  *
   8  * Cases tested (each during Tor and Non-Tor, FF4 and FF3.6)
   9  *    1. Crash
  10  *    2. Upgrade
  11  *    3. Fresh install
  12  *
  13  *************************************************************************/
  14
  15 const { AppConstants } = ChromeUtils.import(
  16   "resource://gre/modules/AppConstants.jsm"
  17 );
  18 const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
  19 const { XPCOMUtils } = ChromeUtils.import(
  20   "resource://gre/modules/XPCOMUtils.jsm"
  21 );
  22
  23 const { TorProtocolService } = ChromeUtils.import(
  24   "resource://gre/modules/TorProtocolService.jsm"
  25 );
  26
  27 XPCOMUtils.defineLazyModuleGetters(this, {
  28   ComponentUtils: "resource://gre/modules/ComponentUtils.jsm",
  29 });
  30
  31 // Module specific constants
  32 const kMODULE_NAME = "Startup";
  33 const kMODULE_CONTRACTID = "@torproject.org/startup-observer;1";
  34 const kMODULE_CID = Components.ID("06322def-6fde-4c06-aef6-47ae8e799629");
  35
  36 function cleanupCookies() {
  37   const migratedPref = "extensions.torbutton.cookiejar_migrated";
  38   if (!Services.prefs.getBoolPref(migratedPref, false)) {
  39     // Cleanup stored cookie-jar-selector json files
  40     const profileFolder = Services.dirsvc.get("ProfD", Ci.nsIFile).clone();
  41     for (const file of profileFolder.directoryEntries) {
  42       if (file.leafName.match(/^(cookies|protected)-.*[.]json$/)) {
  43         try {
  44           file.remove(false);
  45         } catch (e) {}
  46       }
  47     }
  48     Services.prefs.setBoolPref(migratedPref, true);
  49   }
  50 }
  51
  52 function StartupObserver() {
  53   this.logger = Cc["@torproject.org/torbutton-logger;1"].getService(
  54     Ci.nsISupports
  55   ).wrappedJSObject;
  56   this._prefs = Services.prefs;
  57   this.logger.log(3, "Startup Observer created");
  58
  59   var env = Cc["@mozilla.org/process/environment;1"].getService(
  60     Ci.nsIEnvironment
  61   );
  62   var prefName = "browser.startup.homepage";
  63   if (env.exists("TOR_DEFAULT_HOMEPAGE")) {
  64     // if the user has set this value in a previous installation, don't override it
  65     if (!this._prefs.prefHasUserValue(prefName)) {
  66       this._prefs.setCharPref(prefName, env.get("TOR_DEFAULT_HOMEPAGE"));
  67     }
  68   }
  69
  70   this.is_tbb = true;
  71
  72   try {
  73     // XXX: We're in a race with HTTPS-Everywhere to update our proxy settings
  74     // before the initial SSL-Observatory test... If we lose the race, Firefox
  75     // caches the old proxy settings for check.tp.o somehwere, and it never loads :(
  76     this.setProxySettings();
  77   } catch (e) {
  78     this.logger.log(
  79       4,
  80       "Early proxy change failed. Will try again at profile load. Error: " + e
  81     );
  82   }
  83
  84   cleanupCookies();
  85 }
  86
  87 StartupObserver.prototype = {
  88   // Bug 6803: We need to get the env vars early due to
  89   // some weird proxy caching code that showed up in FF15.
  90   // Otherwise, homepage domain loads fail forever.
  91   setProxySettings() {
  92     if (!this.is_tbb) {
  93       return;
  94     }
  95
  96     // Bug 1506: Still want to get these env vars
  97     let environ = Cc["@mozilla.org/process/environment;1"].getService(
  98       Ci.nsIEnvironment
  99     );
 100     if (environ.exists("TOR_TRANSPROXY")) {
 101       this.logger.log(3, "Resetting Tor settings to transproxy");
 102       this._prefs.setBoolPref("network.proxy.socks_remote_dns", false);
 103       this._prefs.setIntPref("network.proxy.type", 0);
 104       this._prefs.setIntPref("network.proxy.socks_port", 0);
 105       this._prefs.setCharPref("network.proxy.socks", "");
 106     } else {
 107       // Try to retrieve SOCKS proxy settings from Tor Launcher.
 108       let socksPortInfo;
 109       try {
 110         socksPortInfo = TorProtocolService.torGetSOCKSPortInfo();
 111       } catch (e) {
 112         this.logger.log(3, "tor launcher failed " + e);
 113       }
 114
 115       // If Tor Launcher is not available, check environment variables.
 116       if (!socksPortInfo) {
 117         socksPortInfo = { ipcFile: undefined, host: undefined, port: 0 };
 118
 119         let isWindows = Services.appinfo.OS === "WINNT";
 120         if (!isWindows && environ.exists("TOR_SOCKS_IPC_PATH")) {
 121           socksPortInfo.ipcFile = new FileUtils.File(
 122             environ.get("TOR_SOCKS_IPC_PATH")
 123           );
 124         } else {
 125           if (environ.exists("TOR_SOCKS_HOST")) {
 126             socksPortInfo.host = environ.get("TOR_SOCKS_HOST");
 127           }
 128           if (environ.exists("TOR_SOCKS_PORT")) {
 129             socksPortInfo.port = parseInt(environ.get("TOR_SOCKS_PORT"));
 130           }
 131         }
 132       }
 133
 134       // Adjust network.proxy prefs.
 135       if (socksPortInfo.ipcFile) {
 136         let fph = Services.io
 137           .getProtocolHandler("file")
 138           .QueryInterface(Ci.nsIFileProtocolHandler);
 139         let fileURI = fph.newFileURI(socksPortInfo.ipcFile);
 140         this.logger.log(3, "Reset socks to " + fileURI.spec);
 141         this._prefs.setCharPref("network.proxy.socks", fileURI.spec);
 142         this._prefs.setIntPref("network.proxy.socks_port", 0);
 143       } else {
 144         if (socksPortInfo.host) {
 145           this._prefs.setCharPref("network.proxy.socks", socksPortInfo.host);
 146           this.logger.log(3, "Reset socks host to " + socksPortInfo.host);
 147         }
 148         if (socksPortInfo.port) {
 149           this._prefs.setIntPref(
 150             "network.proxy.socks_port",
 151             socksPortInfo.port
 152           );
 153           this.logger.log(3, "Reset socks port to " + socksPortInfo.port);
 154         }
 155       }
 156
 157       if (socksPortInfo.ipcFile || socksPortInfo.host || socksPortInfo.port) {
 158         this._prefs.setBoolPref("network.proxy.socks_remote_dns", true);
 159         this._prefs.setIntPref("network.proxy.type", 1);
 160       }
 161     }
 162
 163     // Force prefs to be synced to disk
 164     Services.prefs.savePrefFile(null);
 165
 166     this.logger.log(3, "Synced network settings to environment.");
 167   },
 168
 169   observe(subject, topic, data) {
 170     if (topic == "profile-after-change") {
 171       // Bug 1506 P1: We listen to these prefs as signals for startup,
 172       // but only for hackish reasons.
 173       this._prefs.setBoolPref("extensions.torbutton.startup", true);
 174
 175       this.setProxySettings();
 176     }
 177
 178     // In all cases, force prefs to be synced to disk
 179     Services.prefs.savePrefFile(null);
 180   },
 181
 182   QueryInterface: ChromeUtils.generateQI([Ci.nsIClassInfo]),
 183
 184   // method of nsIClassInfo
 185   classDescription: "Torbutton Startup Observer",
 186   classID: kMODULE_CID,
 187   contractID: kMODULE_CONTRACTID,
 188
 189   // Hack to get us registered early to observe recovery
 190   _xpcom_categories: [{ category: "profile-after-change" }],
 191 };
 192
 193 // Assign factory to global object.
 194 const NSGetFactory = XPCOMUtils.generateNSGetFactory
 195   ? XPCOMUtils.generateNSGetFactory([StartupObserver])
 196   : ComponentUtils.generateNSGetFactory([StartupObserver]);