The Tor Browser: browser/base/content/aboutDialog.js@6474c204b198 (annotated)

browser/base/content/aboutDialog.js@6474c204b198 (annotated)

browser/base/content/aboutDialog.js

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 // Services = object with smart getters for common XPCOM services
 Components.utils.import("resource://gre/modules/Services.jsm");
 const PREF_EM_HOTFIX_ID = "extensions.hotfix.id";
 #ifdef TOR_BROWSER_VERSION
 # Add double-quotes back on (stripped by JarMaker.py).
 #expand const TOR_BROWSER_VERSION = "__TOR_BROWSER_VERSION__";
 #endif
 function init(aEvent)
 {
   if (aEvent.target != document)
     return;
   try {
     var distroId = Services.prefs.getCharPref("distribution.id");
     if (distroId) {
       var distroVersion = Services.prefs.getCharPref("distribution.version");
       var distroIdField = document.getElementById("distributionId");
       distroIdField.value = distroId + " - " + distroVersion;
       distroIdField.style.display = "block";
       try {
         // This is in its own try catch due to bug 895473 and bug 900925.
         var distroAbout = Services.prefs.getComplexValue("distribution.about",
           Components.interfaces.nsISupportsString);
         var distroField = document.getElementById("distribution");
         distroField.value = distroAbout;
         distroField.style.display = "block";
       }
       catch (ex) {
         // Pref is unset
         Components.utils.reportError(ex);
       }
     }
   }
   catch (e) {
     // Pref is unset
   }
   // Include the build ID and display warning if this is an "a#" (nightly or aurora) build
   let version = Services.appinfo.version;
   if (/a\d+$/.test(version)) {
     document.getElementById("experimental").hidden = false;
     document.getElementById("communityDesc").hidden = true;
   }
 #ifdef TOR_BROWSER_VERSION
   let versionElem = document.getElementById("version");
   if (versionElem)
     versionElem.textContent += " (Tor Browser " + TOR_BROWSER_VERSION + ")";
 #endif
 #ifdef MOZ_UPDATER
   gAppUpdater = new appUpdater();
 #if MOZ_UPDATE_CHANNEL != release
   let defaults = Services.prefs.getDefaultBranch("");
   let channelLabel = document.getElementById("currentChannel");
   channelLabel.value = defaults.getCharPref("app.update.channel");
 #endif
 #endif
 #ifdef XP_MACOSX
   // it may not be sized at this point, and we need its width to calculate its position
   window.sizeToContent();
   window.moveTo((screen.availWidth / 2) - (window.outerWidth / 2), screen.availHeight / 5);
 #endif
 }
 #ifdef MOZ_UPDATER
 Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
 Components.utils.import("resource://gre/modules/DownloadUtils.jsm");
 Components.utils.import("resource://gre/modules/AddonManager.jsm");
 var gAppUpdater;
 function onUnload(aEvent) {
   if (gAppUpdater.isChecking)
     gAppUpdater.checker.stopChecking(Components.interfaces.nsIUpdateChecker.CURRENT_CHECK);
   // Safe to call even when there isn't a download in progress.
   gAppUpdater.removeDownloadListener();
   gAppUpdater = null;
 }
 function appUpdater()
 {
   this.updateDeck = document.getElementById("updateDeck");
   // Hide the update deck when there is already an update window open to avoid
   // syncing issues between them.
   if (Services.wm.getMostRecentWindow("Update:Wizard")) {
     this.updateDeck.hidden = true;
     return;
   }
   XPCOMUtils.defineLazyServiceGetter(this, "aus",
                                      "@mozilla.org/updates/update-service;1",
                                      "nsIApplicationUpdateService");
   XPCOMUtils.defineLazyServiceGetter(this, "checker",
                                      "@mozilla.org/updates/update-checker;1",
                                      "nsIUpdateChecker");
   XPCOMUtils.defineLazyServiceGetter(this, "um",
                                      "@mozilla.org/updates/update-manager;1",
                                      "nsIUpdateManager");
   this.bundle = Services.strings.
                 createBundle("chrome://browser/locale/browser.properties");
   let manualURL = Services.urlFormatter.formatURLPref("app.update.url.manual");
   let manualLink = document.getElementById("manualLink");
   manualLink.value = manualURL;
   manualLink.href = manualURL;
   document.getElementById("failedLink").href = manualURL;
   if (this.updateDisabledAndLocked) {
     this.selectPanel("adminDisabled");
     return;
   }
   if (this.isPending || this.isApplied) {
     this.selectPanel("apply");
     return;
   }
   if (this.aus.isOtherInstanceHandlingUpdates) {
     this.selectPanel("otherInstanceHandlingUpdates");
     return;
   }
   if (this.isDownloading) {
     this.startDownload();
     // selectPanel("downloading") is called from setupDownloadingUI().
     return;
   }
   // Honor the "Never check for updates" option by not only disabling background
   // update checks, but also in the About dialog, by presenting a
   // "Check for updates" button.
   // If updates are found, the user is then asked if he wants to "Update to <version>".
   if (!this.updateEnabled) {
     this.selectPanel("checkForUpdates");
     return;
   }
   // That leaves the options
   // "Check for updates, but let me choose whether to install them", and
   // "Automatically install updates".
   // In both cases, we check for updates without asking.
   // In the "let me choose" case, we ask before downloading though, in onCheckComplete.
   this.checkForUpdates();
 }
 appUpdater.prototype =
 {
   // true when there is an update check in progress.
   isChecking: false,
   // true when there is an update already staged / ready to be applied.
   get isPending() {
     if (this.update) {
       return this.update.state == "pending" ||
              this.update.state == "pending-service";
     }
     return this.um.activeUpdate &&
            (this.um.activeUpdate.state == "pending" ||
             this.um.activeUpdate.state == "pending-service");
   },
   // true when there is an update already installed in the background.
   get isApplied() {
     if (this.update)
       return this.update.state == "applied" ||
              this.update.state == "applied-service";
     return this.um.activeUpdate &&
            (this.um.activeUpdate.state == "applied" ||
             this.um.activeUpdate.state == "applied-service");
   },
   // true when there is an update download in progress.
   get isDownloading() {
     if (this.update)
       return this.update.state == "downloading";
     return this.um.activeUpdate &&
            this.um.activeUpdate.state == "downloading";
   },
   // true when updating is disabled by an administrator.
   get updateDisabledAndLocked() {
     return !this.updateEnabled &&
            Services.prefs.prefIsLocked("app.update.enabled");
   },
   // true when updating is enabled.
   get updateEnabled() {
     try {
       return Services.prefs.getBoolPref("app.update.enabled");
     }
     catch (e) { }
     return true; // Firefox default is true
   },
   // true when updating in background is enabled.
   get backgroundUpdateEnabled() {
     return this.updateEnabled &&
            gAppUpdater.aus.canStageUpdates;
   },
   // true when updating is automatic.
   get updateAuto() {
     try {
       return Services.prefs.getBoolPref("app.update.auto");
     }
     catch (e) { }
     return true; // Firefox default is true
   },
   /**
    * Sets the panel of the updateDeck.
    *
    * @param  aChildID
    *         The id of the deck's child to select, e.g. "apply".
    */
   selectPanel: function(aChildID) {
     let panel = document.getElementById(aChildID);
     let button = panel.querySelector("button");
     if (button) {
       if (aChildID == "downloadAndInstall") {
         let updateVersion = gAppUpdater.update.displayVersion;
         button.label = this.bundle.formatStringFromName("update.downloadAndInstallButton.label", [updateVersion], 1);
         button.accessKey = this.bundle.GetStringFromName("update.downloadAndInstallButton.accesskey");
       }
       this.updateDeck.selectedPanel = panel;
       if (!document.commandDispatcher.focusedElement || // don't steal the focus
           document.commandDispatcher.focusedElement.localName == "button") // except from the other buttons
         button.focus();
     } else {
       this.updateDeck.selectedPanel = panel;
     }
   },
   /**
    * Check for updates
    */
   checkForUpdates: function() {
     this.selectPanel("checkingForUpdates");
     this.isChecking = true;
     this.checker.checkForUpdates(this.updateCheckListener, true);
     // after checking, onCheckComplete() is called
   },
   /**
    * Check for addon compat, or start the download right away
    */
   doUpdate: function() {
     // skip the compatibility check if the update doesn't provide appVersion,
     // or the appVersion is unchanged, e.g. nightly update
 #ifdef TOR_BROWSER_UPDATE
     let pkgVersion = TOR_BROWSER_VERSION;
 #else
     let pkgVersion = Services.appinfo.version;
 #endif
     if (!this.update.appVersion ||
         Services.vc.compare(gAppUpdater.update.appVersion, pkgVersion) == 0) {
       this.startDownload();
     } else {
       this.checkAddonCompatibility();
     }
   },
   /**
    * Handles oncommand for the "Restart to Update" button
    * which is presented after the download has been downloaded.
    */
   buttonRestartAfterDownload: function() {
     if (!this.isPending && !this.isApplied)
       return;
       // Notify all windows that an application quit has been requested.
       let cancelQuit = Components.classes["@mozilla.org/supports-PRBool;1"].
                        createInstance(Components.interfaces.nsISupportsPRBool);
       Services.obs.notifyObservers(cancelQuit, "quit-application-requested", "restart");
       // Something aborted the quit process.
       if (cancelQuit.data)
         return;
       let appStartup = Components.classes["@mozilla.org/toolkit/app-startup;1"].
                        getService(Components.interfaces.nsIAppStartup);
       // If already in safe mode restart in safe mode (bug 327119)
       if (Services.appinfo.inSafeMode) {
         appStartup.restartInSafeMode(Components.interfaces.nsIAppStartup.eAttemptQuit);
         return;
       }
       appStartup.quit(Components.interfaces.nsIAppStartup.eAttemptQuit |
                       Components.interfaces.nsIAppStartup.eRestart);
     },
   /**
    * Handles oncommand for the "Apply Update…" button
    * which is presented if we need to show the billboard or license.
    */
   buttonApplyBillboard: function() {
     const URI_UPDATE_PROMPT_DIALOG = "chrome://mozapps/content/update/updates.xul";
     var ary = null;
     ary = Components.classes["@mozilla.org/supports-array;1"].
           createInstance(Components.interfaces.nsISupportsArray);
     ary.AppendElement(this.update);
     var openFeatures = "chrome,centerscreen,dialog=no,resizable=no,titlebar,toolbar=no";
     Services.ww.openWindow(null, URI_UPDATE_PROMPT_DIALOG, "", openFeatures, ary);
     window.close(); // close the "About" window; updates.xul takes over.
   },
   /**
    * Implements nsIUpdateCheckListener. The methods implemented by
    * nsIUpdateCheckListener are in a different scope from nsIIncrementalDownload
    * to make it clear which are used by each interface.
    */
   updateCheckListener: {
     /**
      * See nsIUpdateService.idl
      */
     onCheckComplete: function(aRequest, aUpdates, aUpdateCount) {
       gAppUpdater.isChecking = false;
       gAppUpdater.update = gAppUpdater.aus.
                            selectUpdate(aUpdates, aUpdates.length);
       if (!gAppUpdater.update) {
         gAppUpdater.selectPanel("noUpdatesFound");
         return;
       }
       if (gAppUpdater.update.unsupported) {
         if (gAppUpdater.update.detailsURL) {
           let unsupportedLink = document.getElementById("unsupportedLink");
           unsupportedLink.href = gAppUpdater.update.detailsURL;
         }
         gAppUpdater.selectPanel("unsupportedSystem");
         return;
       }
       if (!gAppUpdater.aus.canApplyUpdates) {
         gAppUpdater.selectPanel("manualUpdate");
         return;
       }
       // Firefox no longer displays a license for updates and the licenseURL
       // check is just in case a distibution does.
       if (gAppUpdater.update.billboardURL || gAppUpdater.update.licenseURL) {
         gAppUpdater.selectPanel("applyBillboard");
         return;
       }
       if (gAppUpdater.updateAuto) // automatically download and install
         gAppUpdater.doUpdate();
       else // ask
         gAppUpdater.selectPanel("downloadAndInstall");
     },
     /**
      * See nsIUpdateService.idl
      */
     onError: function(aRequest, aUpdate) {
       // Errors in the update check are treated as no updates found. If the
       // update check fails repeatedly without a success the user will be
       // notified with the normal app update user interface so this is safe.
       gAppUpdater.isChecking = false;
       gAppUpdater.selectPanel("noUpdatesFound");
     },
     /**
      * See nsISupports.idl
      */
     QueryInterface: function(aIID) {
       if (!aIID.equals(Components.interfaces.nsIUpdateCheckListener) &&
           !aIID.equals(Components.interfaces.nsISupports))
         throw Components.results.NS_ERROR_NO_INTERFACE;
       return this;
     }
   },
   /**
    * Checks the compatibility of add-ons for the application update.
    */
   checkAddonCompatibility: function() {
     try {
       var hotfixID = Services.prefs.getCharPref(PREF_EM_HOTFIX_ID);
     }
     catch (e) { }
     var self = this;
     AddonManager.getAllAddons(function(aAddons) {
       self.addons = [];
       self.addonsCheckedCount = 0;
       aAddons.forEach(function(aAddon) {
         // Protect against code that overrides the add-ons manager and doesn't
         // implement the isCompatibleWith or the findUpdates method.
         if (!("isCompatibleWith" in aAddon) || !("findUpdates" in aAddon)) {
           let errMsg = "Add-on doesn't implement either the isCompatibleWith " +
                        "or the findUpdates method!";
           if (aAddon.id)
             errMsg += " Add-on ID: " + aAddon.id;
           Components.utils.reportError(errMsg);
           return;
         }
         // If an add-on isn't appDisabled and isn't userDisabled then it is
         // either active now or the user expects it to be active after the
         // restart. If that is the case and the add-on is not installed by the
         // application and is not compatible with the new application version
         // then the user should be warned that the add-on will become
         // incompatible. If an addon's type equals plugin it is skipped since
         // checking plugins compatibility information isn't supported and
         // getting the scope property of a plugin breaks in some environments
         // (see bug 566787). The hotfix add-on is also ignored as it shouldn't
         // block the user from upgrading.
         try {
 #ifdef TOR_BROWSER_UPDATE
           let compatVersion = self.update.platformVersion;
 #else
           let compatVersion = self.update.appVersion;
 #endif
           if (aAddon.type != "plugin" && aAddon.id != hotfixID &&
               !aAddon.appDisabled && !aAddon.userDisabled &&
               aAddon.scope != AddonManager.SCOPE_APPLICATION &&
               aAddon.isCompatible &&
               !aAddon.isCompatibleWith(compatVersion,
                                        self.update.platformVersion))
             self.addons.push(aAddon);
         }
         catch (e) {
           Components.utils.reportError(e);
         }
       });
       self.addonsTotalCount = self.addons.length;
       if (self.addonsTotalCount == 0) {
         self.startDownload();
         return;
       }
       self.checkAddonsForUpdates();
     });
   },
   /**
    * Checks if there are updates for add-ons that are incompatible with the
    * application update.
    */
   checkAddonsForUpdates: function() {
     this.addons.forEach(function(aAddon) {
 #ifdef TOR_BROWSER_UPDATE
       let compatVersion = this.update.platformVersion;
 #else
       let compatVersion = this.update.appVersion;
 #endif
       aAddon.findUpdates(this, AddonManager.UPDATE_WHEN_NEW_APP_DETECTED,
                          compatVersion,
                          this.update.platformVersion);
     }, this);
   },
   /**
    * See XPIProvider.jsm
    */
   onCompatibilityUpdateAvailable: function(aAddon) {
     for (var i = 0; i < this.addons.length; ++i) {
       if (this.addons[i].id == aAddon.id) {
         this.addons.splice(i, 1);
         break;
       }
     }
   },
   /**
    * See XPIProvider.jsm
    */
   onUpdateAvailable: function(aAddon, aInstall) {
 #ifdef TOR_BROWSER_UPDATE
     let compatVersion = this.update.platformVersion;
 #else
     let compatVersion = this.update.appVersion;
 #endif
     if (!Services.blocklist.isAddonBlocklisted(aAddon,
                                                compatVersion,
                                                this.update.platformVersion)) {
       // Compatibility or new version updates mean the same thing here.
       this.onCompatibilityUpdateAvailable(aAddon);
     }
   },
   /**
    * See XPIProvider.jsm
    */
   onUpdateFinished: function(aAddon) {
     ++this.addonsCheckedCount;
     if (this.addonsCheckedCount < this.addonsTotalCount)
       return;
     if (this.addons.length == 0) {
       // Compatibility updates or new version updates were found for all add-ons
       this.startDownload();
       return;
     }
     this.selectPanel("apply");
   },
   /**
    * Starts the download of an update mar.
    */
   startDownload: function() {
     if (!this.update)
       this.update = this.um.activeUpdate;
     this.update.QueryInterface(Components.interfaces.nsIWritablePropertyBag);
     this.update.setProperty("foregroundDownload", "true");
     this.aus.pauseDownload();
     let state = this.aus.downloadUpdate(this.update, false);
     if (state == "failed") {
       this.selectPanel("downloadFailed");
       return;
     }
     this.setupDownloadingUI();
   },
   /**
    * Switches to the UI responsible for tracking the download.
    */
   setupDownloadingUI: function() {
     this.downloadStatus = document.getElementById("downloadStatus");
     this.downloadStatus.value =
       DownloadUtils.getTransferTotal(0, this.update.selectedPatch.size);
     this.selectPanel("downloading");
     this.aus.addDownloadListener(this);
   },
   removeDownloadListener: function() {
     if (this.aus) {
       this.aus.removeDownloadListener(this);
     }
   },
   /**
    * See nsIRequestObserver.idl
    */
   onStartRequest: function(aRequest, aContext) {
   },
   /**
    * See nsIRequestObserver.idl
    */
   onStopRequest: function(aRequest, aContext, aStatusCode) {
     switch (aStatusCode) {
     case Components.results.NS_ERROR_UNEXPECTED:
       if (this.update.selectedPatch.state == "download-failed" &&
           (this.update.isCompleteUpdate || this.update.patchCount != 2)) {
         // Verification error of complete patch, informational text is held in
         // the update object.
         this.removeDownloadListener();
         this.selectPanel("downloadFailed");
         break;
       }
       // Verification failed for a partial patch, complete patch is now
       // downloading so return early and do NOT remove the download listener!
       break;
     case Components.results.NS_BINDING_ABORTED:
       // Do not remove UI listener since the user may resume downloading again.
       break;
     case Components.results.NS_OK:
       this.removeDownloadListener();
       if (this.backgroundUpdateEnabled) {
         this.selectPanel("applying");
         let update = this.um.activeUpdate;
         let self = this;
         Services.obs.addObserver(function (aSubject, aTopic, aData) {
           // Update the UI when the background updater is finished
           let status = aData;
           if (status == "applied" || status == "applied-service" ||
               status == "pending" || status == "pending-service") {
             // If the update is successfully applied, or if the updater has
             // fallen back to non-staged updates, show the "Restart to Update"
             // button.
             self.selectPanel("apply");
           } else if (status == "failed") {
             // Background update has failed, let's show the UI responsible for
             // prompting the user to update manually.
             self.selectPanel("downloadFailed");
           } else if (status == "downloading") {
             // We've fallen back to downloading the full update because the
             // partial update failed to get staged in the background.
             // Therefore we need to keep our observer.
             self.setupDownloadingUI();
             return;
           }
           Services.obs.removeObserver(arguments.callee, "update-staged");
         }, "update-staged", false);
       } else {
         this.selectPanel("apply");
       }
       break;
     default:
       this.removeDownloadListener();
       this.selectPanel("downloadFailed");
       break;
     }
   },
   /**
    * See nsIProgressEventSink.idl
    */
   onStatus: function(aRequest, aContext, aStatus, aStatusArg) {
   },
   /**
    * See nsIProgressEventSink.idl
    */
   onProgress: function(aRequest, aContext, aProgress, aProgressMax) {
     this.downloadStatus.value =
       DownloadUtils.getTransferTotal(aProgress, aProgressMax);
   },
   /**
    * See nsISupports.idl
    */
   QueryInterface: function(aIID) {
     if (!aIID.equals(Components.interfaces.nsIProgressEventSink) &&
         !aIID.equals(Components.interfaces.nsIRequestObserver) &&
         !aIID.equals(Components.interfaces.nsISupports))
       throw Components.results.NS_ERROR_NO_INTERFACE;
     return this;
   }
 };
 #endif