addOnBundleInstaller.js

Go to the documentation of this file.

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
 */

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Add-on bundle installer widget services.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Add-on bundle installer widget services defs.
//
//------------------------------------------------------------------------------

// Component manager defs.
if (typeof(Cc) == "undefined")
  var Cc = Components.classes;
if (typeof(Ci) == "undefined")
  var Ci = Components.interfaces;
if (typeof(Cr) == "undefined")
  var Cr = Components.results;
if (typeof(Cu) == "undefined")
  var Cu = Components.utils;


//------------------------------------------------------------------------------
//
// Add-on bundle installer widget services.
//
//------------------------------------------------------------------------------

function addOnBundleInstallerSvc(aWidget) {
  this._widget = aWidget;
}

// Define the object.
addOnBundleInstallerSvc.prototype = {
  // Set the constructor.
  constructor: addOnBundleInstallerSvc,

  //
  // Public widget services fields.
  //
  //   restartRequired          True if add-on installation requires a restart.
  //

  restartRequired: false,


  //
  // Internal widget services fields.
  //
  //   _widget                  First-run wizard add-ons widget.
  //   _addOnBundle             Add-on bundle object.
  //   _addOnInstallList        List of add-ons to install.
  //   _nextAddOnToInstall      Index within _addOnInstallList of next add-on to
  //                            install.
  //   _addOnFileDownloader     File downloader for add-on.
  //

  _widget: null,
  _addOnBundle: null,
  _addOnInstallList: null,
  _nextAddOnToInstall: 0,
  _addOnFileDownloader: null,


  //----------------------------------------------------------------------------
  //
  // Widget services.
  //
  //----------------------------------------------------------------------------

  initialize: function addOnBundleInstallerSvc_initialize() {
  },


  finalize: function addOnBundleInstallerSvc_finalize() {
    // Finalize the add-on file downloader.
    if (this._addOnFileDownloader) {
      this._addOnFileDownloader.listener = null;
      this._addOnFileDownloader.cancel();
      this._addOnFileDownloader = null;
    }

    // Clear object fields.
    this._widget = null;
    this._addOnBundle = null;
    this._addOnInstallList = null;
  },


  install: function addOnBundleInstallerSvc_install(aAddOnBundle) {
    // Set the add-on bundle to install.
    this._addOnBundle = aAddOnBundle;

    // Get the list of add-ons to install.
    this._addOnInstallList = [];
    var extensionCount = this._addOnBundle.bundleExtensionCount;
    for (var i = 0; i < extensionCount; i++) {
      if (this._addOnBundle.getExtensionInstallFlag(i)) {
        var installInfo = { index: i, failed: false };
        this._addOnInstallList.push(installInfo);
      }
    }

    // Start downloading the add-ons.
    this._downloadNextAddOnStart();
  },


  cancel: function addOnBundleInstallerSvc_cancel() {
    if (this._addOnFileDownloader) {
      this._addOnFileDownloader.listener = null;
      this._addOnFileDownloader.cancel();
      this._addOnFileDownloader = null;
    }
  },


  //----------------------------------------------------------------------------
  //
  // Widget nsIFileDownloaderListener services.
  //
  //----------------------------------------------------------------------------

  onProgress: function addOnBundleInstallerSvc_onProgress() {
    // Update the UI.
    this._update();
  },


  onComplete: function addOnBundleInstallerSvc_onComplete() {
    // Update the UI.
    this._update();

    // Complete downloading of next add-on.
    this._downloadNextAddOnComplete();
  },


  //----------------------------------------------------------------------------
  //
  // Internal widget services.
  //
  //----------------------------------------------------------------------------

  _update: function addOnBundleInstallerSvc__update() {
    // Get the current add-on index.
    var currentAddOnIndex =
          this._addOnInstallList[this._nextAddOnToInstall].index;

    // Set the current add-on name.
    var currentAddOnLabelElem = this._getElement("current_add_on_label");
    currentAddOnLabelElem.value =
      this._addOnBundle.getExtensionAttribute(currentAddOnIndex, "name");

    // Set the total progress label.
    var totalProgressLabelElem = this._getElement("total_progress_label");
    totalProgressLabelElem.value =
      SBFormattedString("add_on_bundle_installer.progress_all",
                        [ this._nextAddOnToInstall + 1,
                          this._addOnInstallList.length ]);

    // Set the current add-on download progress meter.
    var progressMeterElem = this._getElement("progressmeter");
    if (this._addOnFileDownloader)
      progressMeterElem.value = this._addOnFileDownloader.percentComplete;
    else
      progressMeterElem.value = 0;
  },


  _downloadNextAddOnStart:
    function addOnBundleInstallerSvc__downloadNextAddOnStart() {
    // If all add-ons have been downloaded, install them all.
    if (this._nextAddOnToInstall == this._addOnInstallList.length) {
      this._installAllAddOns();
      return;
    }

    // Get the index of the next add-on to install.
    var nextAddOnIndex =
          this._addOnInstallList[this._nextAddOnToInstall].index;

    // Create an add-on file downloader.
    this._addOnFileDownloader =
           Cc["@songbirdnest.com/Songbird/FileDownloader;1"]
             .createInstance(Ci.sbIFileDownloader);
    this._addOnFileDownloader.listener = this;
    this._addOnFileDownloader.sourceURISpec =
      this._addOnBundle.getExtensionAttribute(nextAddOnIndex, "url");
    this._addOnFileDownloader.destinationFileExtension = "xpi";

    // Start downloading add-on.
    this._addOnFileDownloader.start();

    // Update the UI.
    this._update();
  },


  _downloadNextAddOnComplete:
    function addOnBundleInstallerSvc__downloadNextAddOnComplete() {
    // Add downloaded file to the add-on install list.
    var installInfo = this._addOnInstallList[this._nextAddOnToInstall];
    if (this._addOnFileDownloader.succeeded)
      installInfo.file = this._addOnFileDownloader.destinationFile;
    else
      installInfo.failed = true;
    this._addOnFileDownloader.listener = null;
    this._addOnFileDownloader = null;

    // Start download of the next add-on.
    this._nextAddOnToInstall++;
    this._downloadNextAddOnStart();
  },


  _installAllAddOns: function addOnBundleInstallerSvc__installAddOns() {
    // Install all of the add-ons.
    for (var i = 0; i < this._addOnInstallList.length; i++) {
      var installInfo = this._addOnInstallList[i];
      if (!installInfo.failed)
        this._installAddOnFile(installInfo);
    }

    // Present any add-on install errors.
    this._widget.errorCount = this._presentErrors();

    // Post an install completion event.
    var event = document.createEvent("Events");
    event.initEvent("complete", true, true);
    this._widget.dispatchEvent(event);
  },


  _installAddOnFile:
    function addOnBundleInstallerSvc__installAddOnFile(aInstallInfo) {
    // Ensure an add-on file was downloaded.
    if (!aInstallInfo.file) {
      aInstallInfo.failed = true;
      return;
    }

    // Get the extension manager.
    var extensionManager = Cc["@mozilla.org/extensions/manager;1"]
                             .getService(Ci.nsIExtensionManager);

    // Install the add-on.
    try {
      extensionManager.installItemFromFile(aInstallInfo.file, "app-profile");
      this.restartRequired = true;
    } catch (ex) {
      // Report exception.
      Cu.reportError("Error installing add-on: " + ex);

      // Add-on install failed.
      aInstallInfo.failed = true;
    }

    // Remove the add-on file.
    aInstallInfo.file.remove(false);
  },


  _presentErrors: function addOnBundleInstallerSvc__presentErrors() {
    var errorCount = 0;

    // Fill the error listbox with the failed add-ons.
    var errorListBoxElem = this._getElement("error_listbox");
    for (var i = 0; i < this._addOnInstallList.length; i++) {
      // Get add-on install info and skip if it did not fail to install.
      var installInfo = this._addOnInstallList[i];
      if (!installInfo.failed)
        continue;

      // One more error.
      errorCount++;

      // Get the add-on info.
      var addOnBundleIndex = installInfo.index;
      var addOnName = this._addOnBundle.getExtensionAttribute(addOnBundleIndex,
                                                              "name");
      errorListBoxElem.appendItem(addOnName);
    }

    // Present the error panel if any errors occurred.
    if (errorCount > 0) {
      // Set the error description line 1.
      var description = SBFormattedCountString
                          ("add_on_bundle_installer.error.description1",
                           errorCount);
      var descriptionTextNode = document.createTextNode(description);
      var errorDescriptionElem = this._getElement("error_description_1");
      errorDescriptionElem.appendChild(descriptionTextNode);

      // Set the error description line 2.
      description = SBFormattedCountString
                      ("add_on_bundle_installer.error.description2",
                       errorCount,
                       [ SBStringBrandShortName() ]);
      descriptionTextNode = document.createTextNode(description);
      errorDescriptionElem = this._getElement("error_description_2");
      errorDescriptionElem.appendChild(descriptionTextNode);

      // Show the error panel.
      var statusDeckElem = this._getElement("status_deck");
      var errorPanelElem = this._getElement("error_panel");
      statusDeckElem.selectedPanel = errorPanelElem;
    }

    // Return results.
    return errorCount;
  },


  _getElement: function addOnBundleInstallerSvc__getElement(aElementID) {
    return document.getAnonymousElementByAttribute(this._widget,
                                                   "anonid",
                                                   aElementID);
  }
}