mobile/android/components/AddonUpdateService.js

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 const Cc = Components.classes;
   6 const Ci = Components.interfaces;
   7 const Cu = Components.utils;
   8
   9 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
  10 Cu.import("resource://gre/modules/Services.jsm");
  11
  12 XPCOMUtils.defineLazyModuleGetter(this, "AddonManager",
  13                                   "resource://gre/modules/AddonManager.jsm");
  14
  15 XPCOMUtils.defineLazyModuleGetter(this, "AddonRepository",
  16                                   "resource://gre/modules/AddonRepository.jsm");
  17
  18 XPCOMUtils.defineLazyModuleGetter(this, "OS", "resource://gre/modules/osfile.jsm");
  19
  20 function getPref(func, preference, defaultValue) {
  21   try {
  22     return Services.prefs[func](preference);
  23   }
  24   catch (e) {}
  25   return defaultValue;
  26 }
  27
  28 // -----------------------------------------------------------------------
  29 // Add-on auto-update management service
  30 // -----------------------------------------------------------------------
  31
  32 const PREF_ADDON_UPDATE_ENABLED  = "extensions.autoupdate.enabled";
  33
  34 var gNeedsRestart = false;
  35
  36 function AddonUpdateService() {}
  37
  38 AddonUpdateService.prototype = {
  39   classDescription: "Add-on auto-update management",
  40   classID: Components.ID("{93c8824c-9b87-45ae-bc90-5b82a1e4d877}"),
  41
  42   QueryInterface: XPCOMUtils.generateQI([Ci.nsITimerCallback]),
  43
  44   notify: function aus_notify(aTimer) {
  45     if (aTimer && !getPref("getBoolPref", PREF_ADDON_UPDATE_ENABLED, true))
  46       return;
  47
  48     // If we already auto-upgraded and installed new versions, ignore this check
  49     if (gNeedsRestart)
  50       return;
  51
  52     Services.io.offline = false;
  53
  54     // Assume we are doing a periodic update check
  55     let reason = AddonManager.UPDATE_WHEN_PERIODIC_UPDATE;
  56     if (!aTimer)
  57       reason = AddonManager.UPDATE_WHEN_USER_REQUESTED;
  58
  59     AddonManager.getAddonsByTypes(null, function(aAddonList) {
  60       aAddonList.forEach(function(aAddon) {
  61         if (aAddon.permissions & AddonManager.PERM_CAN_UPGRADE) {
  62           let data = Cc["@mozilla.org/supports-string;1"].createInstance(Ci.nsISupportsString);
  63           data.data = JSON.stringify({ id: aAddon.id, name: aAddon.name });
  64           Services.obs.notifyObservers(data, "addon-update-started", null);
  65
  66           let listener = new UpdateCheckListener();
  67           aAddon.findUpdates(listener, reason);
  68         }
  69       });
  70     });
  71
  72     RecommendedSearchResults.search();
  73   }
  74 };
  75
  76 // -----------------------------------------------------------------------
  77 // Add-on update listener. Starts a download for any add-on with a viable
  78 // update waiting
  79 // -----------------------------------------------------------------------
  80
  81 function UpdateCheckListener() {
  82   this._status = null;
  83   this._version = null;
  84 }
  85
  86 UpdateCheckListener.prototype = {
  87   onCompatibilityUpdateAvailable: function(aAddon) {
  88     this._status = "compatibility";
  89   },
  90
  91   onUpdateAvailable: function(aAddon, aInstall) {
  92     this._status = "update";
  93     this._version = aInstall.version;
  94     aInstall.install();
  95   },
  96
  97   onNoUpdateAvailable: function(aAddon) {
  98     if (!this._status)
  99       this._status = "no-update";
 100   },
 101
 102   onUpdateFinished: function(aAddon, aError) {
 103     let data = Cc["@mozilla.org/supports-string;1"].createInstance(Ci.nsISupportsString);
 104     if (this._version)
 105       data.data = JSON.stringify({ id: aAddon.id, name: aAddon.name, version: this._version });
 106     else
 107       data.data = JSON.stringify({ id: aAddon.id, name: aAddon.name });
 108
 109     if (aError)
 110       this._status = "error";
 111
 112     Services.obs.notifyObservers(data, "addon-update-ended", this._status);
 113   }
 114 };
 115
 116 // -----------------------------------------------------------------------
 117 // RecommendedSearchResults fetches add-on data and saves it to a cache
 118 // -----------------------------------------------------------------------
 119
 120 var RecommendedSearchResults = {
 121   _getFile: function() {
 122     let dirService = Cc["@mozilla.org/file/directory_service;1"].getService(Ci.nsIProperties);
 123     let file = dirService.get("ProfD", Ci.nsILocalFile);
 124     file.append("recommended-addons.json");
 125     return file;
 126   },
 127
 128   _writeFile: function (aFile, aData) {
 129     if (!aData)
 130       return;
 131
 132     // Asynchronously copy the data to the file.
 133     let array = new TextEncoder().encode(aData);
 134     OS.File.writeAtomic(aFile.path, array, { tmpPath: aFile.path + ".tmp" }).then(function onSuccess() {
 135       Services.obs.notifyObservers(null, "recommended-addons-cache-updated", "");
 136     });
 137   },
 138
 139   searchSucceeded: function(aAddons, aAddonCount, aTotalResults) {
 140     let self = this;
 141
 142     // Filter addons already installed
 143     AddonManager.getAllAddons(function(aAllAddons) {
 144       let addons = aAddons.filter(function(addon) {
 145         for (let i = 0; i < aAllAddons.length; i++)
 146           if (addon.id == aAllAddons[i].id)
 147             return false;
 148
 149         return true;
 150       });
 151
 152       let json = {
 153         addons: []
 154       };
 155
 156       addons.forEach(function(aAddon) {
 157         json.addons.push({
 158           id: aAddon.id,
 159           name: aAddon.name,
 160           version: aAddon.version,
 161           learnmoreURL: aAddon.learnmoreURL,
 162           iconURL: aAddon.iconURL
 163         })
 164       });
 165
 166       let file = self._getFile();
 167       self._writeFile(file, JSON.stringify(json));
 168     });
 169   },
 170
 171   searchFailed: function searchFailed() { },
 172
 173   search: function() {
 174     const kAddonsMaxDisplay = 2;
 175
 176     if (AddonRepository.isSearching)
 177       AddonRepository.cancelSearch();
 178     AddonRepository.retrieveRecommendedAddons(kAddonsMaxDisplay, RecommendedSearchResults);
 179   }
 180 }
 181
 182 this.NSGetFactory = XPCOMUtils.generateNSGetFactory([AddonUpdateService]);
 183