/* -*- Mode: Java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- * vim: sw=2 ts=8 et : */ /* 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/. */ const Cc = Components.classes; const Ci = Components.interfaces; const Cu = Components.utils; Cu.import("resource://gre/modules/XPCOMUtils.jsm"); Cu.import("resource://gre/modules/Services.jsm"); const VERBOSE = 1; let log = VERBOSE ? function log_dump(msg) { dump("UpdatePrompt: "+ msg +"\n"); } : function log_noop(msg) { }; const PREF_APPLY_PROMPT_TIMEOUT = "b2g.update.apply-prompt-timeout"; const PREF_APPLY_IDLE_TIMEOUT = "b2g.update.apply-idle-timeout"; const NETWORK_ERROR_OFFLINE = 111; const FILE_ERROR_TOO_BIG = 112; const STATE_DOWNLOADING = 'downloading'; XPCOMUtils.defineLazyServiceGetter(Services, "aus", "@mozilla.org/updates/update-service;1", "nsIApplicationUpdateService"); XPCOMUtils.defineLazyServiceGetter(Services, "um", "@mozilla.org/updates/update-manager;1", "nsIUpdateManager"); XPCOMUtils.defineLazyServiceGetter(Services, "idle", "@mozilla.org/widget/idleservice;1", "nsIIdleService"); XPCOMUtils.defineLazyServiceGetter(Services, "settings", "@mozilla.org/settingsService;1", "nsISettingsService"); function UpdateCheckListener(updatePrompt) { this._updatePrompt = updatePrompt; } UpdateCheckListener.prototype = { QueryInterface: XPCOMUtils.generateQI([Ci.nsIUpdateCheckListener]), _updatePrompt: null, onCheckComplete: function UCL_onCheckComplete(request, updates, updateCount) { if (Services.um.activeUpdate) { return; } if (updateCount == 0) { this._updatePrompt.setUpdateStatus("no-updates"); return; } let update = Services.aus.selectUpdate(updates, updateCount); if (!update) { this._updatePrompt.setUpdateStatus("already-latest-version"); return; } this._updatePrompt.setUpdateStatus("check-complete"); this._updatePrompt.showUpdateAvailable(update); }, onError: function UCL_onError(request, update) { if (update.errorCode == NETWORK_ERROR_OFFLINE) { this._updatePrompt.setUpdateStatus("retry-when-online"); } Services.aus.QueryInterface(Ci.nsIUpdateCheckListener); Services.aus.onError(request, update); }, onProgress: function UCL_onProgress(request, position, totalSize) { Services.aus.QueryInterface(Ci.nsIUpdateCheckListener); Services.aus.onProgress(request, position, totalSize); } }; function UpdatePrompt() { this.wrappedJSObject = this; this._updateCheckListener = new UpdateCheckListener(this); Services.obs.addObserver(this, "update-check-start", false); } UpdatePrompt.prototype = { classID: Components.ID("{88b3eb21-d072-4e3b-886d-f89d8c49fe59}"), QueryInterface: XPCOMUtils.generateQI([Ci.nsIUpdatePrompt, Ci.nsIUpdateCheckListener, Ci.nsIRequestObserver, Ci.nsIProgressEventSink, Ci.nsIObserver]), _xpcom_factory: XPCOMUtils.generateSingletonFactory(UpdatePrompt), _update: null, _applyPromptTimer: null, _waitingForIdle: false, _updateCheckListner: null, get applyPromptTimeout() { return Services.prefs.getIntPref(PREF_APPLY_PROMPT_TIMEOUT); }, get applyIdleTimeout() { return Services.prefs.getIntPref(PREF_APPLY_IDLE_TIMEOUT); }, // nsIUpdatePrompt // FIXME/bug 737601: we should have users opt-in to downloading // updates when on a billed pipe. Initially, opt-in for 3g, but // that doesn't cover all cases. checkForUpdates: function UP_checkForUpdates() { }, showUpdateAvailable: function UP_showUpdateAvailable(aUpdate) { if (!this.sendUpdateEvent("update-available", aUpdate)) { log("Unable to prompt for available update, forcing download"); this.downloadUpdate(aUpdate); } }, showUpdateDownloaded: function UP_showUpdateDownloaded(aUpdate, aBackground) { // The update has been downloaded and staged. We send the update-downloaded // event right away. After the user has been idle for a while, we send the // update-prompt-restart event, increasing the chances that we can apply the // update quietly without user intervention. this.sendUpdateEvent("update-downloaded", aUpdate); if (Services.idle.idleTime >= this.applyIdleTimeout) { this.showApplyPrompt(aUpdate); return; } let applyIdleTimeoutSeconds = this.applyIdleTimeout / 1000; // We haven't been idle long enough, so register an observer log("Update is ready to apply, registering idle timeout of " + applyIdleTimeoutSeconds + " seconds before prompting."); this._update = aUpdate; this.waitForIdle(); }, showUpdateError: function UP_showUpdateError(aUpdate) { log("Update error, state: " + aUpdate.state + ", errorCode: " + aUpdate.errorCode); this.sendUpdateEvent("update-error", aUpdate); this.setUpdateStatus(aUpdate.statusText); }, showUpdateHistory: function UP_showUpdateHistory(aParent) { }, showUpdateInstalled: function UP_showUpdateInstalled() { let lock = Services.settings.createLock(); lock.set("deviceinfo.last_updated", Date.now(), null, null); }, // Custom functions waitForIdle: function UP_waitForIdle() { if (this._waitingForIdle) { return; } this._waitingForIdle = true; Services.idle.addIdleObserver(this, this.applyIdleTimeout / 1000); Services.obs.addObserver(this, "quit-application", false); }, setUpdateStatus: function UP_setUpdateStatus(aStatus) { log("Setting gecko.updateStatus: " + aStatus); let lock = Services.settings.createLock(); lock.set("gecko.updateStatus", aStatus, null); }, showApplyPrompt: function UP_showApplyPrompt(aUpdate) { if (!this.sendUpdateEvent("update-prompt-apply", aUpdate)) { log("Unable to prompt, forcing restart"); this.restartProcess(); return; } // Schedule a fallback timeout in case the UI is unable to respond or show // a prompt for some reason. this._applyPromptTimer = this.createTimer(this.applyPromptTimeout); }, _copyProperties: ["appVersion", "buildID", "detailsURL", "displayVersion", "errorCode", "isOSUpdate", "platformVersion", "previousAppVersion", "state", "statusText"], sendUpdateEvent: function UP_sendUpdateEvent(aType, aUpdate) { let detail = {}; for each (let property in this._copyProperties) { detail[property] = aUpdate[property]; } let patch = aUpdate.selectedPatch; if (!patch && aUpdate.patchCount > 0) { // For now we just check the first patch to get size information if a // patch hasn't been selected yet. patch = aUpdate.getPatchAt(0); } if (patch) { detail.size = patch.size; detail.updateType = patch.type; } else { log("Warning: no patches available in update"); } this._update = aUpdate; return this.sendChromeEvent(aType, detail); }, sendChromeEvent: function UP_sendChromeEvent(aType, aDetail) { let browser = Services.wm.getMostRecentWindow("navigator:browser"); if (!browser) { log("Warning: Couldn't send update event " + aType + ": no content browser"); return false; } let detail = aDetail || {}; detail.type = aType; browser.shell.sendChromeEvent(detail); return true; }, handleAvailableResult: function UP_handleAvailableResult(aDetail) { // If the user doesn't choose "download", the updater will implicitly call // showUpdateAvailable again after a certain period of time switch (aDetail.result) { case "download": this.downloadUpdate(this._update); break; } }, handleApplyPromptResult: function UP_handleApplyPromptResult(aDetail) { if (this._applyPromptTimer) { this._applyPromptTimer.cancel(); this._applyPromptTimer = null; } switch (aDetail.result) { case "wait": // Wait until the user is idle before prompting to apply the update this.waitForIdle(); break; case "restart": this.finishUpdate(); this._update = null; break; } }, downloadUpdate: function UP_downloadUpdate(aUpdate) { if (!aUpdate) { aUpdate = Services.um.activeUpdate; if (!aUpdate) { log("No active update found to download"); return; } } let status = Services.aus.downloadUpdate(aUpdate, true); if (status == STATE_DOWNLOADING) { Services.aus.addDownloadListener(this); return; } log("Error downloading update " + aUpdate.name + ": " + aUpdate.errorCode); if (aUpdate.errorCode == FILE_ERROR_TOO_BIG) { aUpdate.statusText = "file-too-big"; } this.showUpdateError(aUpdate); }, handleDownloadCancel: function UP_handleDownloadCancel() { log("Pausing download"); Services.aus.pauseDownload(); }, finishUpdate: function UP_finishUpdate() { if (!this._update.isOSUpdate) { // Standard gecko+gaia updates will just need to restart the process this.restartProcess(); return; } let osApplyToDir; try { this._update.QueryInterface(Ci.nsIWritablePropertyBag); osApplyToDir = this._update.getProperty("osApplyToDir"); } catch (e) {} if (!osApplyToDir) { log("Error: Update has no osApplyToDir"); return; } let updateFile = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile); updateFile.initWithPath(osApplyToDir + "/update.zip"); if (!updateFile.exists()) { log("Error: FOTA update not found at " + updateFile.path); return; } this.finishOSUpdate(updateFile.path); }, restartProcess: function UP_restartProcess() { log("Update downloaded, restarting to apply it"); #ifndef MOZ_WIDGET_GONK let appStartup = Cc["@mozilla.org/toolkit/app-startup;1"] .getService(Ci.nsIAppStartup); appStartup.quit(appStartup.eForceQuit | appStartup.eRestart); #else // NB: on Gonk, we rely on the system process manager to restart us. let pmService = Cc["@mozilla.org/power/powermanagerservice;1"] .getService(Ci.nsIPowerManagerService); pmService.restart(); #endif }, finishOSUpdate: function UP_finishOSUpdate(aOsUpdatePath) { let recoveryService = Cc["@mozilla.org/recovery-service;1"] .getService(Ci.nsIRecoveryService); log("Rebooting into recovery to apply FOTA update: " + aOsUpdatePath); try { recoveryService.installFotaUpdate(aOsUpdatePath); } catch(e) { log("Error: Couldn't reboot into recovery to apply FOTA update " + aOsUpdatePath); } }, forceUpdateCheck: function UP_forceUpdateCheck() { log("Forcing update check"); let checker = Cc["@mozilla.org/updates/update-checker;1"] .createInstance(Ci.nsIUpdateChecker); checker.checkForUpdates(this._updateCheckListener, true); }, handleEvent: function UP_handleEvent(evt) { if (evt.type !== "mozContentEvent") { return; } let detail = evt.detail; if (!detail) { return; } switch (detail.type) { case "force-update-check": this.forceUpdateCheck(); break; case "update-available-result": this.handleAvailableResult(detail); this._update = null; break; case "update-download-cancel": this.handleDownloadCancel(); break; case "update-prompt-apply-result": this.handleApplyPromptResult(detail); break; } }, appsUpdated: function UP_appsUpdated(aApps) { log("appsUpdated: " + aApps.length + " apps to update"); let lock = Services.settings.createLock(); lock.set("apps.updateStatus", "check-complete", null); this.sendChromeEvent("apps-update-check", { apps: aApps }); this._checkingApps = false; }, // Trigger apps update check and wait for all to be done before // notifying gaia. onUpdateCheckStart: function UP_onUpdateCheckStart() { // Don't start twice. if (this._checkingApps) { return; } this._checkingApps = true; let self = this; let window = Services.wm.getMostRecentWindow("navigator:browser"); let all = window.navigator.mozApps.mgmt.getAll(); all.onsuccess = function() { let appsCount = this.result.length; let appsChecked = 0; let appsToUpdate = []; this.result.forEach(function updateApp(aApp) { let update = aApp.checkForUpdate(); update.onsuccess = function() { appsChecked += 1; appsToUpdate.push(aApp.manifestURL); if (appsChecked == appsCount) { self.appsUpdated(appsToUpdate); } } update.onerror = function() { appsChecked += 1; if (appsChecked == appsCount) { self.appsUpdated(appsToUpdate); } } }); } all.onerror = function() { // Could not get the app list, just notify to update nothing. self.appsUpdated([]); } }, // nsIObserver observe: function UP_observe(aSubject, aTopic, aData) { switch (aTopic) { case "idle": this._waitingForIdle = false; this.showApplyPrompt(this._update); // Fall through case "quit-application": Services.idle.removeIdleObserver(this, this.applyIdleTimeout / 1000); Services.obs.removeObserver(this, "quit-application"); break; case "update-check-start": this.onUpdateCheckStart(); break; } }, // nsITimerCallback notify: function UP_notify(aTimer) { if (aTimer == this._applyPromptTimer) { log("Timed out waiting for result, restarting"); this._applyPromptTimer = null; this.finishUpdate(); } }, createTimer: function UP_createTimer(aTimeoutMs) { let timer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer); timer.initWithCallback(this, aTimeoutMs, timer.TYPE_ONE_SHOT); return timer; }, // nsIRequestObserver _startedSent: false, onStartRequest: function UP_onStartRequest(aRequest, aContext) { // Wait until onProgress to send the update-download-started event, in case // this request turns out to fail for some reason this._startedSent = false; }, onStopRequest: function UP_onStopRequest(aRequest, aContext, aStatusCode) { let paused = !Components.isSuccessCode(aStatusCode); this.sendChromeEvent("update-download-stopped", { paused: paused }); Services.aus.removeDownloadListener(this); }, // nsIProgressEventSink onProgress: function UP_onProgress(aRequest, aContext, aProgress, aProgressMax) { if (!this._startedSent) { this.sendChromeEvent("update-download-started", { total: aProgressMax }); this._startedSent = true; } this.sendChromeEvent("update-download-progress", { progress: aProgress, total: aProgressMax }); }, onStatus: function UP_onStatus(aRequest, aUpdate, aStatus, aStatusArg) { } }; this.NSGetFactory = XPCOMUtils.generateNSGetFactory([UpdatePrompt]);