diff options
Diffstat (limited to 'toolkit/components/jsdownloads')
35 files changed, 12236 insertions, 0 deletions
diff --git a/toolkit/components/jsdownloads/moz.build b/toolkit/components/jsdownloads/moz.build new file mode 100644 index 000000000..62f08b160 --- /dev/null +++ b/toolkit/components/jsdownloads/moz.build @@ -0,0 +1,18 @@ +# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*- +# vim: set filetype=python: +# 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/. + +with Files('*'): + BUG_COMPONENT = ('Toolkit', 'Download Manager') + +DIRS += ['public', 'src'] + +XPCSHELL_TESTS_MANIFESTS += ['test/unit/xpcshell.ini'] +BROWSER_CHROME_MANIFESTS += ['test/browser/browser.ini'] + +TEST_HARNESS_FILES.xpcshell.toolkit.components.jsdownloads.test.data += [ + 'test/data/empty.txt', + 'test/data/source.txt', +] diff --git a/toolkit/components/jsdownloads/public/moz.build b/toolkit/components/jsdownloads/public/moz.build new file mode 100644 index 000000000..6ea66bf5f --- /dev/null +++ b/toolkit/components/jsdownloads/public/moz.build @@ -0,0 +1,9 @@ +# 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/. + +XPIDL_MODULE = 'jsdownloads' + +XPIDL_SOURCES += [ + 'mozIDownloadPlatform.idl', +] diff --git a/toolkit/components/jsdownloads/public/mozIDownloadPlatform.idl b/toolkit/components/jsdownloads/public/mozIDownloadPlatform.idl new file mode 100644 index 000000000..d4f49bb4b --- /dev/null +++ b/toolkit/components/jsdownloads/public/mozIDownloadPlatform.idl @@ -0,0 +1,61 @@ +/* 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/. */ + +#include "nsISupports.idl" + +interface nsIURI; +interface nsIFile; + +[scriptable, uuid(9f556e4a-d9b3-46c3-9f8f-d0db1ac6c8c1)] +interface mozIDownloadPlatform : nsISupports +{ + /** + * Perform platform specific operations when a download is done. + * + * Windows: + * Add the download to the recent documents list + * Set the file to be indexed for searching + * Mac: + * Bounce the downloads dock icon + * GTK: + * Add the download to the recent documents list + * Save the source uri in the downloaded file's metadata + * Android: + * Scan media + * + * @param aSource + * Source URI of the download + * @param aReferrer + * Referrer URI of the download + * @param aTarget + * Downloaded file + * @param aContentType + * The source's content type + * @param aIsPrivate + * True for private downloads + * @return none + */ + void downloadDone(in nsIURI aSource, in nsIURI aReferrer, in nsIFile aTarget, + in ACString aContentType, in boolean aIsPrivate); + + /** + * Security Zone constants. Used by mapUrlToZone(). + */ + const unsigned long ZONE_MY_COMPUTER = 0; + const unsigned long ZONE_INTRANET = 1; + const unsigned long ZONE_TRUSTED = 2; + const unsigned long ZONE_INTERNET = 3; + const unsigned long ZONE_RESTRICTED = 4; + + /** + * Proxy for IInternetSecurityManager::MapUrlToZone(). + * + * Windows only. + * + * @param aURL + * URI of the download + * @return Security Zone corresponding to aURL. + */ + unsigned long mapUrlToZone(in AString aURL); +}; diff --git a/toolkit/components/jsdownloads/src/DownloadCore.jsm b/toolkit/components/jsdownloads/src/DownloadCore.jsm new file mode 100644 index 000000000..d89dd5805 --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadCore.jsm @@ -0,0 +1,2871 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +/** + * This file includes the following constructors and global objects: + * + * Download + * Represents a single download, with associated state and actions. This object + * is transient, though it can be included in a DownloadList so that it can be + * managed by the user interface and persisted across sessions. + * + * DownloadSource + * Represents the source of a download, for example a document or an URI. + * + * DownloadTarget + * Represents the target of a download, for example a file in the global + * downloads directory, or a file in the system temporary directory. + * + * DownloadError + * Provides detailed information about a download failure. + * + * DownloadSaver + * Template for an object that actually transfers the data for the download. + * + * DownloadCopySaver + * Saver object that simply copies the entire source file to the target. + * + * DownloadLegacySaver + * Saver object that integrates with the legacy nsITransfer interface. + * + * DownloadPDFSaver + * This DownloadSaver type creates a PDF file from the current document in a + * given window, specified using the windowRef property of the DownloadSource + * object associated with the download. + */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "Download", + "DownloadSource", + "DownloadTarget", + "DownloadError", + "DownloadSaver", + "DownloadCopySaver", + "DownloadLegacySaver", + "DownloadPDFSaver", +]; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/Integration.jsm"); +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "FileUtils", + "resource://gre/modules/FileUtils.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "NetUtil", + "resource://gre/modules/NetUtil.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm") +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Services", + "resource://gre/modules/Services.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "PrivateBrowsingUtils", + "resource://gre/modules/PrivateBrowsingUtils.jsm"); + +XPCOMUtils.defineLazyServiceGetter(this, "gDownloadHistory", + "@mozilla.org/browser/download-history;1", + Ci.nsIDownloadHistory); +XPCOMUtils.defineLazyServiceGetter(this, "gExternalAppLauncher", + "@mozilla.org/uriloader/external-helper-app-service;1", + Ci.nsPIExternalAppLauncher); +XPCOMUtils.defineLazyServiceGetter(this, "gExternalHelperAppService", + "@mozilla.org/uriloader/external-helper-app-service;1", + Ci.nsIExternalHelperAppService); +XPCOMUtils.defineLazyServiceGetter(this, "gPrintSettingsService", + "@mozilla.org/gfx/printsettings-service;1", + Ci.nsIPrintSettingsService); + +Integration.downloads.defineModuleGetter(this, "DownloadIntegration", + "resource://gre/modules/DownloadIntegration.jsm"); + +const BackgroundFileSaverStreamListener = Components.Constructor( + "@mozilla.org/network/background-file-saver;1?mode=streamlistener", + "nsIBackgroundFileSaver"); + +/** + * Returns true if the given value is a primitive string or a String object. + */ +function isString(aValue) { + // We cannot use the "instanceof" operator reliably across module boundaries. + return (typeof aValue == "string") || + (typeof aValue == "object" && "charAt" in aValue); +} + +/** + * Serialize the unknown properties of aObject into aSerializable. + */ +function serializeUnknownProperties(aObject, aSerializable) +{ + if (aObject._unknownProperties) { + for (let property in aObject._unknownProperties) { + aSerializable[property] = aObject._unknownProperties[property]; + } + } +} + +/** + * Check for any unknown properties in aSerializable and preserve those in the + * _unknownProperties field of aObject. aFilterFn is called for each property + * name of aObject and should return true only for unknown properties. + */ +function deserializeUnknownProperties(aObject, aSerializable, aFilterFn) +{ + for (let property in aSerializable) { + if (aFilterFn(property)) { + if (!aObject._unknownProperties) { + aObject._unknownProperties = { }; + } + + aObject._unknownProperties[property] = aSerializable[property]; + } + } +} + +/** + * This determines the minimum time interval between updates to the number of + * bytes transferred, and is a limiting factor to the sequence of readings used + * in calculating the speed of the download. + */ +const kProgressUpdateIntervalMs = 400; + +// Download + +/** + * Represents a single download, with associated state and actions. This object + * is transient, though it can be included in a DownloadList so that it can be + * managed by the user interface and persisted across sessions. + */ +this.Download = function () +{ + this._deferSucceeded = Promise.defer(); +} + +this.Download.prototype = { + /** + * DownloadSource object associated with this download. + */ + source: null, + + /** + * DownloadTarget object associated with this download. + */ + target: null, + + /** + * DownloadSaver object associated with this download. + */ + saver: null, + + /** + * Indicates that the download never started, has been completed successfully, + * failed, or has been canceled. This property becomes false when a download + * is started for the first time, or when a failed or canceled download is + * restarted. + */ + stopped: true, + + /** + * Indicates that the download has been completed successfully. + */ + succeeded: false, + + /** + * Indicates that the download has been canceled. This property can become + * true, then it can be reset to false when a canceled download is restarted. + * + * This property becomes true as soon as the "cancel" method is called, though + * the "stopped" property might remain false until the cancellation request + * has been processed. Temporary files or part files may still exist even if + * they are expected to be deleted, until the "stopped" property becomes true. + */ + canceled: false, + + /** + * When the download fails, this is set to a DownloadError instance indicating + * the cause of the failure. If the download has been completed successfully + * or has been canceled, this property is null. This property is reset to + * null when a failed download is restarted. + */ + error: null, + + /** + * Indicates the start time of the download. When the download starts, + * this property is set to a valid Date object. The default value is null + * before the download starts. + */ + startTime: null, + + /** + * Indicates whether this download's "progress" property is able to report + * partial progress while the download proceeds, and whether the value in + * totalBytes is relevant. This depends on the saver and the download source. + */ + hasProgress: false, + + /** + * Progress percent, from 0 to 100. Intermediate values are reported only if + * hasProgress is true. + * + * @note You shouldn't rely on this property being equal to 100 to determine + * whether the download is completed. You should use the individual + * state properties instead. + */ + progress: 0, + + /** + * When hasProgress is true, indicates the total number of bytes to be + * transferred before the download finishes, that can be zero for empty files. + * + * When hasProgress is false, this property is always zero. + * + * @note This property may be different than the final file size on disk for + * downloads that are encoded during the network transfer. You can use + * the "size" property of the DownloadTarget object to get the actual + * size on disk once the download succeeds. + */ + totalBytes: 0, + + /** + * Number of bytes currently transferred. This value starts at zero, and may + * be updated regardless of the value of hasProgress. + * + * @note You shouldn't rely on this property being equal to totalBytes to + * determine whether the download is completed. You should use the + * individual state properties instead. This property may not be + * updated during the last part of the download. + */ + currentBytes: 0, + + /** + * Fractional number representing the speed of the download, in bytes per + * second. This value is zero when the download is stopped, and may be + * updated regardless of the value of hasProgress. + */ + speed: 0, + + /** + * Indicates whether, at this time, there is any partially downloaded data + * that can be used when restarting a failed or canceled download. + * + * Even if the download has partial data on disk, hasPartialData will be false + * if that data cannot be used to restart the download. In order to determine + * if a part file is being used which contains partial data the + * Download.target.partFilePath should be checked. + * + * This property is relevant while the download is in progress, and also if it + * failed or has been canceled. If the download has been completed + * successfully, this property is always false. + * + * Whether partial data can actually be retained depends on the saver and the + * download source, and may not be known before the download is started. + */ + hasPartialData: false, + + /** + * Indicates whether, at this time, there is any data that has been blocked. + * Since reputation blocking takes place after the download has fully + * completed a value of true also indicates 100% of the data is present. + */ + hasBlockedData: false, + + /** + * This can be set to a function that is called after other properties change. + */ + onchange: null, + + /** + * This tells if the user has chosen to open/run the downloaded file after + * download has completed. + */ + launchWhenSucceeded: false, + + /** + * This represents the MIME type of the download. + */ + contentType: null, + + /** + * This indicates the path of the application to be used to launch the file, + * or null if the file should be launched with the default application. + */ + launcherPath: null, + + /** + * Raises the onchange notification. + */ + _notifyChange: function D_notifyChange() { + try { + if (this.onchange) { + this.onchange(); + } + } catch (ex) { + Cu.reportError(ex); + } + }, + + /** + * The download may be stopped and restarted multiple times before it + * completes successfully. This may happen if any of the download attempts is + * canceled or fails. + * + * This property contains a promise that is linked to the current attempt, or + * null if the download is either stopped or in the process of being canceled. + * If the download restarts, this property is replaced with a new promise. + * + * The promise is resolved if the attempt it represents finishes successfully, + * and rejected if the attempt fails. + */ + _currentAttempt: null, + + /** + * Starts the download for the first time, or restarts a download that failed + * or has been canceled. + * + * Calling this method when the download has been completed successfully has + * no effect, and the method returns a resolved promise. If the download is + * in progress, the method returns the same promise as the previous call. + * + * If the "cancel" method was called but the cancellation process has not + * finished yet, this method waits for the cancellation to finish, then + * restarts the download immediately. + * + * @note If you need to start a new download from the same source, rather than + * restarting a failed or canceled one, you should create a separate + * Download object with the same source as the current one. + * + * @return {Promise} + * @resolves When the download has finished successfully. + * @rejects JavaScript exception if the download failed. + */ + start: function D_start() + { + // If the download succeeded, it's the final state, we have nothing to do. + if (this.succeeded) { + return Promise.resolve(); + } + + // If the download already started and hasn't failed or hasn't been + // canceled, return the same promise as the previous call, allowing the + // caller to wait for the current attempt to finish. + if (this._currentAttempt) { + return this._currentAttempt; + } + + // While shutting down or disposing of this object, we prevent the download + // from returning to be in progress. + if (this._finalized) { + return Promise.reject(new DownloadError({ + message: "Cannot start after finalization."})); + } + + if (this.error && this.error.becauseBlockedByReputationCheck) { + return Promise.reject(new DownloadError({ + message: "Cannot start after being blocked " + + "by a reputation check."})); + } + + // Initialize all the status properties for a new or restarted download. + this.stopped = false; + this.canceled = false; + this.error = null; + this.hasProgress = false; + this.hasBlockedData = false; + this.progress = 0; + this.totalBytes = 0; + this.currentBytes = 0; + this.startTime = new Date(); + + // Create a new deferred object and an associated promise before starting + // the actual download. We store it on the download as the current attempt. + let deferAttempt = Promise.defer(); + let currentAttempt = deferAttempt.promise; + this._currentAttempt = currentAttempt; + + // Restart the progress and speed calculations from scratch. + this._lastProgressTimeMs = 0; + + // This function propagates progress from the DownloadSaver object, unless + // it comes in late from a download attempt that was replaced by a new one. + // If the cancellation process for the download has started, then the update + // is ignored. + function DS_setProgressBytes(aCurrentBytes, aTotalBytes, aHasPartialData) + { + if (this._currentAttempt == currentAttempt) { + this._setBytes(aCurrentBytes, aTotalBytes, aHasPartialData); + } + } + + // This function propagates download properties from the DownloadSaver + // object, unless it comes in late from a download attempt that was + // replaced by a new one. If the cancellation process for the download has + // started, then the update is ignored. + function DS_setProperties(aOptions) + { + if (this._currentAttempt != currentAttempt) { + return; + } + + let changeMade = false; + + for (let property of ["contentType", "progress", "hasPartialData", + "hasBlockedData"]) { + if (property in aOptions && this[property] != aOptions[property]) { + this[property] = aOptions[property]; + changeMade = true; + } + } + + if (changeMade) { + this._notifyChange(); + } + } + + // Now that we stored the promise in the download object, we can start the + // task that will actually execute the download. + deferAttempt.resolve(Task.spawn(function* task_D_start() { + // Wait upon any pending operation before restarting. + if (this._promiseCanceled) { + yield this._promiseCanceled; + } + if (this._promiseRemovePartialData) { + try { + yield this._promiseRemovePartialData; + } catch (ex) { + // Ignore any errors, which are already reported by the original + // caller of the removePartialData method. + } + } + + // In case the download was restarted while cancellation was in progress, + // but the previous attempt actually succeeded before cancellation could + // be processed, it is possible that the download has already finished. + if (this.succeeded) { + return; + } + + try { + // Disallow download if parental controls service restricts it. + if (yield DownloadIntegration.shouldBlockForParentalControls(this)) { + throw new DownloadError({ becauseBlockedByParentalControls: true }); + } + + // Disallow download if needed runtime permissions have not been granted + // by user. + if (yield DownloadIntegration.shouldBlockForRuntimePermissions()) { + throw new DownloadError({ becauseBlockedByRuntimePermissions: true }); + } + + // We should check if we have been canceled in the meantime, after all + // the previous asynchronous operations have been executed and just + // before we call the "execute" method of the saver. + if (this._promiseCanceled) { + // The exception will become a cancellation in the "catch" block. + throw undefined; + } + + // Execute the actual download through the saver object. + this._saverExecuting = true; + yield this.saver.execute(DS_setProgressBytes.bind(this), + DS_setProperties.bind(this)); + + // Now that the actual saving finished, read the actual file size on + // disk, that may be different from the amount of data transferred. + yield this.target.refresh(); + + // Check for the last time if the download has been canceled. This must + // be done right before setting the "stopped" property of the download, + // without any asynchronous operations in the middle, so that another + // cancellation request cannot start in the meantime and stay unhandled. + if (this._promiseCanceled) { + try { + yield OS.File.remove(this.target.path); + } catch (ex) { + Cu.reportError(ex); + } + + this.target.exists = false; + this.target.size = 0; + + // Cancellation exceptions will be changed in the catch block below. + throw new DownloadError(); + } + + // Update the status properties for a successful download. + this.progress = 100; + this.succeeded = true; + this.hasPartialData = false; + } catch (originalEx) { + // We may choose a different exception to propagate in the code below, + // or wrap the original one. We do this mutation in a different variable + // because of the "no-ex-assign" ESLint rule. + let ex = originalEx; + + // Fail with a generic status code on cancellation, so that the caller + // is forced to actually check the status properties to see if the + // download was canceled or failed because of other reasons. + if (this._promiseCanceled) { + throw new DownloadError({ message: "Download canceled." }); + } + + // An HTTP 450 error code is used by Windows to indicate that a uri is + // blocked by parental controls. This will prevent the download from + // occuring, so an error needs to be raised. This is not performed + // during the parental controls check above as it requires the request + // to start. + if (this._blockedByParentalControls) { + ex = new DownloadError({ becauseBlockedByParentalControls: true }); + } + + // Update the download error, unless a new attempt already started. The + // change in the status property is notified in the finally block. + if (this._currentAttempt == currentAttempt || !this._currentAttempt) { + if (!(ex instanceof DownloadError)) { + let properties = {innerException: ex}; + + if (ex.message) { + properties.message = ex.message; + } + + ex = new DownloadError(properties); + } + + this.error = ex; + } + throw ex; + } finally { + // Any cancellation request has now been processed. + this._saverExecuting = false; + this._promiseCanceled = null; + + // Update the status properties, unless a new attempt already started. + if (this._currentAttempt == currentAttempt || !this._currentAttempt) { + this._currentAttempt = null; + this.stopped = true; + this.speed = 0; + this._notifyChange(); + if (this.succeeded) { + yield this._succeed(); + } + } + } + }.bind(this))); + + // Notify the new download state before returning. + this._notifyChange(); + return currentAttempt; + }, + + /** + * Perform the actions necessary when a Download succeeds. + * + * @return {Promise} + * @resolves When the steps to take after success have completed. + * @rejects JavaScript exception if any of the operations failed. + */ + _succeed: Task.async(function* () { + yield DownloadIntegration.downloadDone(this); + + this._deferSucceeded.resolve(); + + if (this.launchWhenSucceeded) { + this.launch().then(null, Cu.reportError); + + // Always schedule files to be deleted at the end of the private browsing + // mode, regardless of the value of the pref. + if (this.source.isPrivate) { + gExternalAppLauncher.deleteTemporaryPrivateFileWhenPossible( + new FileUtils.File(this.target.path)); + } else if (Services.prefs.getBoolPref( + "browser.helperApps.deleteTempFileOnExit")) { + gExternalAppLauncher.deleteTemporaryFileOnExit( + new FileUtils.File(this.target.path)); + } + } + }), + + /** + * When a request to unblock the download is received, contains a promise + * that will be resolved when the unblock request is completed. This property + * will then continue to hold the promise indefinitely. + */ + _promiseUnblock: null, + + /** + * When a request to confirm the block of the download is received, contains + * a promise that will be resolved when cleaning up the download has + * completed. This property will then continue to hold the promise + * indefinitely. + */ + _promiseConfirmBlock: null, + + /** + * Unblocks a download which had been blocked by reputation. + * + * The file will be moved out of quarantine and the download will be + * marked as succeeded. + * + * @return {Promise} + * @resolves When the Download has been unblocked and succeeded. + * @rejects JavaScript exception if any of the operations failed. + */ + unblock: function() { + if (this._promiseUnblock) { + return this._promiseUnblock; + } + + if (this._promiseConfirmBlock) { + return Promise.reject(new Error( + "Download block has been confirmed, cannot unblock.")); + } + + if (!this.hasBlockedData) { + return Promise.reject(new Error( + "unblock may only be called on Downloads with blocked data.")); + } + + this._promiseUnblock = Task.spawn(function* () { + try { + yield OS.File.move(this.target.partFilePath, this.target.path); + yield this.target.refresh(); + } catch (ex) { + yield this.refresh(); + this._promiseUnblock = null; + throw ex; + } + + this.succeeded = true; + this.hasBlockedData = false; + this._notifyChange(); + yield this._succeed(); + }.bind(this)); + + return this._promiseUnblock; + }, + + /** + * Confirms that a blocked download should be cleaned up. + * + * If a download was blocked but retained on disk this method can be used + * to remove the file. + * + * @return {Promise} + * @resolves When the Download's data has been removed. + * @rejects JavaScript exception if any of the operations failed. + */ + confirmBlock: function() { + if (this._promiseConfirmBlock) { + return this._promiseConfirmBlock; + } + + if (this._promiseUnblock) { + return Promise.reject(new Error( + "Download is being unblocked, cannot confirmBlock.")); + } + + if (!this.hasBlockedData) { + return Promise.reject(new Error( + "confirmBlock may only be called on Downloads with blocked data.")); + } + + this._promiseConfirmBlock = Task.spawn(function* () { + try { + yield OS.File.remove(this.target.partFilePath); + } catch (ex) { + yield this.refresh(); + this._promiseConfirmBlock = null; + throw ex; + } + + this.hasBlockedData = false; + this._notifyChange(); + }.bind(this)); + + return this._promiseConfirmBlock; + }, + + /* + * Launches the file after download has completed. This can open + * the file with the default application for the target MIME type + * or file extension, or with a custom application if launcherPath + * is set. + * + * @return {Promise} + * @resolves When the instruction to launch the file has been + * successfully given to the operating system. Note that + * the OS might still take a while until the file is actually + * launched. + * @rejects JavaScript exception if there was an error trying to launch + * the file. + */ + launch: function () { + if (!this.succeeded) { + return Promise.reject( + new Error("launch can only be called if the download succeeded") + ); + } + + return DownloadIntegration.launchDownload(this); + }, + + /* + * Shows the folder containing the target file, or where the target file + * will be saved. This may be called at any time, even if the download + * failed or is currently in progress. + * + * @return {Promise} + * @resolves When the instruction to open the containing folder has been + * successfully given to the operating system. Note that + * the OS might still take a while until the folder is actually + * opened. + * @rejects JavaScript exception if there was an error trying to open + * the containing folder. + */ + showContainingDirectory: function D_showContainingDirectory() { + return DownloadIntegration.showContainingDirectory(this.target.path); + }, + + /** + * When a request to cancel the download is received, contains a promise that + * will be resolved when the cancellation request is processed. When the + * request is processed, this property becomes null again. + */ + _promiseCanceled: null, + + /** + * True between the call to the "execute" method of the saver and the + * completion of the current download attempt. + */ + _saverExecuting: false, + + /** + * Cancels the download. + * + * The cancellation request is asynchronous. Until the cancellation process + * finishes, temporary files or part files may still exist even if they are + * expected to be deleted. + * + * In case the download completes successfully before the cancellation request + * could be processed, this method has no effect, and it returns a resolved + * promise. You should check the properties of the download at the time the + * returned promise is resolved to determine if the download was cancelled. + * + * Calling this method when the download has been completed successfully, + * failed, or has been canceled has no effect, and the method returns a + * resolved promise. This behavior is designed for the case where the call + * to "cancel" happens asynchronously, and is consistent with the case where + * the cancellation request could not be processed in time. + * + * @return {Promise} + * @resolves When the cancellation process has finished. + * @rejects Never. + */ + cancel: function D_cancel() + { + // If the download is currently stopped, we have nothing to do. + if (this.stopped) { + return Promise.resolve(); + } + + if (!this._promiseCanceled) { + // Start a new cancellation request. + let deferCanceled = Promise.defer(); + this._currentAttempt.then(() => deferCanceled.resolve(), + () => deferCanceled.resolve()); + this._promiseCanceled = deferCanceled.promise; + + // The download can already be restarted. + this._currentAttempt = null; + + // Notify that the cancellation request was received. + this.canceled = true; + this._notifyChange(); + + // Execute the actual cancellation through the saver object, in case it + // has already started. Otherwise, the cancellation will be handled just + // before the saver is started. + if (this._saverExecuting) { + this.saver.cancel(); + } + } + + return this._promiseCanceled; + }, + + /** + * Indicates whether any partially downloaded data should be retained, to use + * when restarting a failed or canceled download. The default is false. + * + * Whether partial data can actually be retained depends on the saver and the + * download source, and may not be known before the download is started. + * + * To have any effect, this property must be set before starting the download. + * Resetting this property to false after the download has already started + * will not remove any partial data. + * + * If this property is set to true, care should be taken that partial data is + * removed before the reference to the download is discarded. This can be + * done using the removePartialData or the "finalize" methods. + */ + tryToKeepPartialData: false, + + /** + * When a request to remove partially downloaded data is received, contains a + * promise that will be resolved when the removal request is processed. When + * the request is processed, this property becomes null again. + */ + _promiseRemovePartialData: null, + + /** + * Removes any partial data kept as part of a canceled or failed download. + * + * If the download is not canceled or failed, this method has no effect, and + * it returns a resolved promise. If the "cancel" method was called but the + * cancellation process has not finished yet, this method waits for the + * cancellation to finish, then removes the partial data. + * + * After this method has been called, if the tryToKeepPartialData property is + * still true when the download is restarted, partial data will be retained + * during the new download attempt. + * + * @return {Promise} + * @resolves When the partial data has been successfully removed. + * @rejects JavaScript exception if the operation could not be completed. + */ + removePartialData: function () + { + if (!this.canceled && !this.error) { + return Promise.resolve(); + } + + let promiseRemovePartialData = this._promiseRemovePartialData; + + if (!promiseRemovePartialData) { + let deferRemovePartialData = Promise.defer(); + promiseRemovePartialData = deferRemovePartialData.promise; + this._promiseRemovePartialData = promiseRemovePartialData; + + deferRemovePartialData.resolve( + Task.spawn(function* task_D_removePartialData() { + try { + // Wait upon any pending cancellation request. + if (this._promiseCanceled) { + yield this._promiseCanceled; + } + // Ask the saver object to remove any partial data. + yield this.saver.removePartialData(); + // For completeness, clear the number of bytes transferred. + if (this.currentBytes != 0 || this.hasPartialData) { + this.currentBytes = 0; + this.hasPartialData = false; + this._notifyChange(); + } + } finally { + this._promiseRemovePartialData = null; + } + }.bind(this))); + } + + return promiseRemovePartialData; + }, + + /** + * This deferred object contains a promise that is resolved as soon as this + * download finishes successfully, and is never rejected. This property is + * initialized when the download is created, and never changes. + */ + _deferSucceeded: null, + + /** + * Returns a promise that is resolved as soon as this download finishes + * successfully, even if the download was stopped and restarted meanwhile. + * + * You can use this property for scheduling download completion actions in the + * current session, for downloads that are controlled interactively. If the + * download is not controlled interactively, you should use the promise + * returned by the "start" method instead, to check for success or failure. + * + * @return {Promise} + * @resolves When the download has finished successfully. + * @rejects Never. + */ + whenSucceeded: function D_whenSucceeded() + { + return this._deferSucceeded.promise; + }, + + /** + * Updates the state of a finished, failed, or canceled download based on the + * current state in the file system. If the download is in progress or it has + * been finalized, this method has no effect, and it returns a resolved + * promise. + * + * This allows the properties of the download to be updated in case the user + * moved or deleted the target file or its associated ".part" file. + * + * @return {Promise} + * @resolves When the operation has completed. + * @rejects Never. + */ + refresh: function () + { + return Task.spawn(function* () { + if (!this.stopped || this._finalized) { + return; + } + + if (this.succeeded) { + let oldExists = this.target.exists; + let oldSize = this.target.size; + yield this.target.refresh(); + if (oldExists != this.target.exists || oldSize != this.target.size) { + this._notifyChange(); + } + return; + } + + // Update the current progress from disk if we retained partial data. + if ((this.hasPartialData || this.hasBlockedData) && + this.target.partFilePath) { + + try { + let stat = yield OS.File.stat(this.target.partFilePath); + + // Ignore the result if the state has changed meanwhile. + if (!this.stopped || this._finalized) { + return; + } + + // Update the bytes transferred and the related progress properties. + this.currentBytes = stat.size; + if (this.totalBytes > 0) { + this.hasProgress = true; + this.progress = Math.floor(this.currentBytes / + this.totalBytes * 100); + } + } catch (ex) { + if (!(ex instanceof OS.File.Error) || !ex.becauseNoSuchFile) { + throw ex; + } + // Ignore the result if the state has changed meanwhile. + if (!this.stopped || this._finalized) { + return; + } + + this.hasBlockedData = false; + this.hasPartialData = false; + } + + this._notifyChange(); + } + }.bind(this)).then(null, Cu.reportError); + }, + + /** + * True if the "finalize" method has been called. This prevents the download + * from starting again after having been stopped. + */ + _finalized: false, + + /** + * Ensures that the download is stopped, and optionally removes any partial + * data kept as part of a canceled or failed download. After this method has + * been called, the download cannot be started again. + * + * This method should be used in place of "cancel" and removePartialData while + * shutting down or disposing of the download object, to prevent other callers + * from interfering with the operation. This is required because cancellation + * and other operations are asynchronous. + * + * @param aRemovePartialData + * Whether any partially downloaded data should be removed after the + * download has been stopped. + * + * @return {Promise} + * @resolves When the operation has finished successfully. + * @rejects JavaScript exception if an error occurred while removing the + * partially downloaded data. + */ + finalize: function (aRemovePartialData) + { + // Prevents the download from starting again after having been stopped. + this._finalized = true; + + if (aRemovePartialData) { + // Cancel the download, in case it is currently in progress, then remove + // any partially downloaded data. The removal operation waits for + // cancellation to be completed before resolving the promise it returns. + this.cancel(); + return this.removePartialData(); + } + // Just cancel the download, in case it is currently in progress. + return this.cancel(); + }, + + /** + * Indicates the time of the last progress notification, expressed as the + * number of milliseconds since January 1, 1970, 00:00:00 UTC. This is zero + * until some bytes have actually been transferred. + */ + _lastProgressTimeMs: 0, + + /** + * Updates progress notifications based on the number of bytes transferred. + * + * The number of bytes transferred is not updated unless enough time passed + * since this function was last called. This limits the computation load, in + * particular when the listeners update the user interface in response. + * + * @param aCurrentBytes + * Number of bytes transferred until now. + * @param aTotalBytes + * Total number of bytes to be transferred, or -1 if unknown. + * @param aHasPartialData + * Indicates whether the partially downloaded data can be used when + * restarting the download if it fails or is canceled. + */ + _setBytes: function D_setBytes(aCurrentBytes, aTotalBytes, aHasPartialData) { + let changeMade = (this.hasPartialData != aHasPartialData); + this.hasPartialData = aHasPartialData; + + // Unless aTotalBytes is -1, we can report partial download progress. In + // this case, notify when the related properties changed since last time. + if (aTotalBytes != -1 && (!this.hasProgress || + this.totalBytes != aTotalBytes)) { + this.hasProgress = true; + this.totalBytes = aTotalBytes; + changeMade = true; + } + + // Updating the progress and computing the speed require that enough time + // passed since the last update, or that we haven't started throttling yet. + let currentTimeMs = Date.now(); + let intervalMs = currentTimeMs - this._lastProgressTimeMs; + if (intervalMs >= kProgressUpdateIntervalMs) { + // Don't compute the speed unless we started throttling notifications. + if (this._lastProgressTimeMs != 0) { + // Calculate the speed in bytes per second. + let rawSpeed = (aCurrentBytes - this.currentBytes) / intervalMs * 1000; + if (this.speed == 0) { + // When the previous speed is exactly zero instead of a fractional + // number, this can be considered the first element of the series. + this.speed = rawSpeed; + } else { + // Apply exponential smoothing, with a smoothing factor of 0.1. + this.speed = rawSpeed * 0.1 + this.speed * 0.9; + } + } + + // Start throttling notifications only when we have actually received some + // bytes for the first time. The timing of the first part of the download + // is not reliable, due to possible latency in the initial notifications. + // This also allows automated tests to receive and verify the number of + // bytes initially transferred. + if (aCurrentBytes > 0) { + this._lastProgressTimeMs = currentTimeMs; + + // Update the progress now that we don't need its previous value. + this.currentBytes = aCurrentBytes; + if (this.totalBytes > 0) { + this.progress = Math.floor(this.currentBytes / this.totalBytes * 100); + } + changeMade = true; + } + } + + if (changeMade) { + this._notifyChange(); + } + }, + + /** + * Returns a static representation of the current object state. + * + * @return A JavaScript object that can be serialized to JSON. + */ + toSerializable: function () + { + let serializable = { + source: this.source.toSerializable(), + target: this.target.toSerializable(), + }; + + let saver = this.saver.toSerializable(); + if (!serializable.source || !saver) { + // If we are unable to serialize either the source or the saver, + // we won't persist the download. + return null; + } + + // Simplify the representation for the most common saver type. If the saver + // is an object instead of a simple string, we can't simplify it because we + // need to persist all its properties, not only "type". This may happen for + // savers of type "copy" as well as other types. + if (saver !== "copy") { + serializable.saver = saver; + } + + if (this.error) { + serializable.errorObj = this.error.toSerializable(); + } + + if (this.startTime) { + serializable.startTime = this.startTime.toJSON(); + } + + // These are serialized unless they are false, null, or empty strings. + for (let property of kPlainSerializableDownloadProperties) { + if (this[property]) { + serializable[property] = this[property]; + } + } + + serializeUnknownProperties(this, serializable); + + return serializable; + }, + + /** + * Returns a value that changes only when one of the properties of a Download + * object that should be saved into a file also change. This excludes + * properties whose value doesn't usually change during the download lifetime. + * + * This function is used to determine whether the download should be + * serialized after a property change notification has been received. + * + * @return String representing the relevant download state. + */ + getSerializationHash: function () + { + // The "succeeded", "canceled", "error", and startTime properties are not + // taken into account because they all change before the "stopped" property + // changes, and are not altered in other cases. + return this.stopped + "," + this.totalBytes + "," + this.hasPartialData + + "," + this.contentType; + }, +}; + +/** + * Defines which properties of the Download object are serializable. + */ +const kPlainSerializableDownloadProperties = [ + "succeeded", + "canceled", + "totalBytes", + "hasPartialData", + "hasBlockedData", + "tryToKeepPartialData", + "launcherPath", + "launchWhenSucceeded", + "contentType", +]; + +/** + * Creates a new Download object from a serializable representation. This + * function is used by the createDownload method of Downloads.jsm when a new + * Download object is requested, thus some properties may refer to live objects + * in place of their serializable representations. + * + * @param aSerializable + * An object with the following fields: + * { + * source: DownloadSource object, or its serializable representation. + * See DownloadSource.fromSerializable for details. + * target: DownloadTarget object, or its serializable representation. + * See DownloadTarget.fromSerializable for details. + * saver: Serializable representation of a DownloadSaver object. See + * DownloadSaver.fromSerializable for details. If omitted, + * defaults to "copy". + * } + * + * @return The newly created Download object. + */ +Download.fromSerializable = function (aSerializable) { + let download = new Download(); + if (aSerializable.source instanceof DownloadSource) { + download.source = aSerializable.source; + } else { + download.source = DownloadSource.fromSerializable(aSerializable.source); + } + if (aSerializable.target instanceof DownloadTarget) { + download.target = aSerializable.target; + } else { + download.target = DownloadTarget.fromSerializable(aSerializable.target); + } + if ("saver" in aSerializable) { + download.saver = DownloadSaver.fromSerializable(aSerializable.saver); + } else { + download.saver = DownloadSaver.fromSerializable("copy"); + } + download.saver.download = download; + + if ("startTime" in aSerializable) { + let time = aSerializable.startTime.getTime + ? aSerializable.startTime.getTime() + : aSerializable.startTime; + download.startTime = new Date(time); + } + + // If 'errorObj' is present it will take precedence over the 'error' property. + // 'error' is a legacy property only containing message, which is insufficient + // to represent all of the error information. + // + // Instead of just replacing 'error' we use a new 'errorObj' so that previous + // versions will keep it as an unknown property. + if ("errorObj" in aSerializable) { + download.error = DownloadError.fromSerializable(aSerializable.errorObj); + } else if ("error" in aSerializable) { + download.error = aSerializable.error; + } + + for (let property of kPlainSerializableDownloadProperties) { + if (property in aSerializable) { + download[property] = aSerializable[property]; + } + } + + deserializeUnknownProperties(download, aSerializable, property => + kPlainSerializableDownloadProperties.indexOf(property) == -1 && + property != "startTime" && + property != "source" && + property != "target" && + property != "error" && + property != "saver"); + + return download; +}; + +// DownloadSource + +/** + * Represents the source of a download, for example a document or an URI. + */ +this.DownloadSource = function () {} + +this.DownloadSource.prototype = { + /** + * String containing the URI for the download source. + */ + url: null, + + /** + * Indicates whether the download originated from a private window. This + * determines the context of the network request that is made to retrieve the + * resource. + */ + isPrivate: false, + + /** + * String containing the referrer URI of the download source, or null if no + * referrer should be sent or the download source is not HTTP. + */ + referrer: null, + + /** + * For downloads handled by the (default) DownloadCopySaver, this function + * can adjust the network channel before it is opened, for example to change + * the HTTP headers or to upload a stream as POST data. + * + * @note If this is defined this object will not be serializable, thus the + * Download object will not be persisted across sessions. + * + * @param aChannel + * The nsIChannel to be adjusted. + * + * @return {Promise} + * @resolves When the channel has been adjusted and can be opened. + * @rejects JavaScript exception that will cause the download to fail. + */ + adjustChannel: null, + + /** + * Returns a static representation of the current object state. + * + * @return A JavaScript object that can be serialized to JSON. + */ + toSerializable: function () + { + if (this.adjustChannel) { + // If the callback was used, we can't reproduce this across sessions. + return null; + } + + // Simplify the representation if we don't have other details. + if (!this.isPrivate && !this.referrer && !this._unknownProperties) { + return this.url; + } + + let serializable = { url: this.url }; + if (this.isPrivate) { + serializable.isPrivate = true; + } + if (this.referrer) { + serializable.referrer = this.referrer; + } + + serializeUnknownProperties(this, serializable); + return serializable; + }, +}; + +/** + * Creates a new DownloadSource object from its serializable representation. + * + * @param aSerializable + * Serializable representation of a DownloadSource object. This may be a + * string containing the URI for the download source, an nsIURI, or an + * object with the following properties: + * { + * url: String containing the URI for the download source. + * isPrivate: Indicates whether the download originated from a private + * window. If omitted, the download is public. + * referrer: String containing the referrer URI of the download source. + * Can be omitted or null if no referrer should be sent or + * the download source is not HTTP. + * adjustChannel: For downloads handled by (default) DownloadCopySaver, + * this function can adjust the network channel before + * it is opened, for example to change the HTTP headers + * or to upload a stream as POST data. Optional. + * } + * + * @return The newly created DownloadSource object. + */ +this.DownloadSource.fromSerializable = function (aSerializable) { + let source = new DownloadSource(); + if (isString(aSerializable)) { + // Convert String objects to primitive strings at this point. + source.url = aSerializable.toString(); + } else if (aSerializable instanceof Ci.nsIURI) { + source.url = aSerializable.spec; + } else if (aSerializable instanceof Ci.nsIDOMWindow) { + source.url = aSerializable.location.href; + source.isPrivate = PrivateBrowsingUtils.isContentWindowPrivate(aSerializable); + source.windowRef = Cu.getWeakReference(aSerializable); + } else { + // Convert String objects to primitive strings at this point. + source.url = aSerializable.url.toString(); + if ("isPrivate" in aSerializable) { + source.isPrivate = aSerializable.isPrivate; + } + if ("referrer" in aSerializable) { + source.referrer = aSerializable.referrer; + } + if ("adjustChannel" in aSerializable) { + source.adjustChannel = aSerializable.adjustChannel; + } + + deserializeUnknownProperties(source, aSerializable, property => + property != "url" && property != "isPrivate" && property != "referrer"); + } + + return source; +}; + +// DownloadTarget + +/** + * Represents the target of a download, for example a file in the global + * downloads directory, or a file in the system temporary directory. + */ +this.DownloadTarget = function () {} + +this.DownloadTarget.prototype = { + /** + * String containing the path of the target file. + */ + path: null, + + /** + * String containing the path of the ".part" file containing the data + * downloaded so far, or null to disable the use of a ".part" file to keep + * partially downloaded data. + */ + partFilePath: null, + + /** + * Indicates whether the target file exists. + * + * This is a dynamic property updated when the download finishes or when the + * "refresh" method of the Download object is called. It can be used by the + * front-end to reduce I/O compared to checking the target file directly. + */ + exists: false, + + /** + * Size in bytes of the target file, or zero if the download has not finished. + * + * Even if the target file does not exist anymore, this property may still + * have a value taken from the download metadata. If the metadata has never + * been available in this session and the size cannot be obtained from the + * file because it has already been deleted, this property will be zero. + * + * For single-file downloads, this property will always match the actual file + * size on disk, while the totalBytes property of the Download object, when + * available, may represent the size of the encoded data instead. + * + * For downloads involving multiple files, like complete web pages saved to + * disk, the meaning of this value is undefined. It currently matches the size + * of the main file only rather than the sum of all the written data. + * + * This is a dynamic property updated when the download finishes or when the + * "refresh" method of the Download object is called. It can be used by the + * front-end to reduce I/O compared to checking the target file directly. + */ + size: 0, + + /** + * Sets the "exists" and "size" properties based on the actual file on disk. + * + * @return {Promise} + * @resolves When the operation has finished successfully. + * @rejects JavaScript exception. + */ + refresh: Task.async(function* () { + try { + this.size = (yield OS.File.stat(this.path)).size; + this.exists = true; + } catch (ex) { + // Report any error not caused by the file not being there. In any case, + // the size of the download is not updated and the known value is kept. + if (!(ex instanceof OS.File.Error && ex.becauseNoSuchFile)) { + Cu.reportError(ex); + } + this.exists = false; + } + }), + + /** + * Returns a static representation of the current object state. + * + * @return A JavaScript object that can be serialized to JSON. + */ + toSerializable: function () + { + // Simplify the representation if we don't have other details. + if (!this.partFilePath && !this._unknownProperties) { + return this.path; + } + + let serializable = { path: this.path, + partFilePath: this.partFilePath }; + serializeUnknownProperties(this, serializable); + return serializable; + }, +}; + +/** + * Creates a new DownloadTarget object from its serializable representation. + * + * @param aSerializable + * Serializable representation of a DownloadTarget object. This may be a + * string containing the path of the target file, an nsIFile, or an + * object with the following properties: + * { + * path: String containing the path of the target file. + * partFilePath: optional string containing the part file path. + * } + * + * @return The newly created DownloadTarget object. + */ +this.DownloadTarget.fromSerializable = function (aSerializable) { + let target = new DownloadTarget(); + if (isString(aSerializable)) { + // Convert String objects to primitive strings at this point. + target.path = aSerializable.toString(); + } else if (aSerializable instanceof Ci.nsIFile) { + // Read the "path" property of nsIFile after checking the object type. + target.path = aSerializable.path; + } else { + // Read the "path" property of the serializable DownloadTarget + // representation, converting String objects to primitive strings. + target.path = aSerializable.path.toString(); + if ("partFilePath" in aSerializable) { + target.partFilePath = aSerializable.partFilePath; + } + + deserializeUnknownProperties(target, aSerializable, property => + property != "path" && property != "partFilePath"); + } + return target; +}; + +// DownloadError + +/** + * Provides detailed information about a download failure. + * + * @param aProperties + * Object which may contain any of the following properties: + * { + * result: Result error code, defaulting to Cr.NS_ERROR_FAILURE + * message: String error message to be displayed, or null to use the + * message associated with the result code. + * inferCause: If true, attempts to determine if the cause of the + * download is a network failure or a local file failure, + * based on a set of known values of the result code. + * This is useful when the error is received by a + * component that handles both aspects of the download. + * } + * The properties object may also contain any of the DownloadError's + * because properties, which will be set accordingly in the error object. + */ +this.DownloadError = function (aProperties) +{ + const NS_ERROR_MODULE_BASE_OFFSET = 0x45; + const NS_ERROR_MODULE_NETWORK = 6; + const NS_ERROR_MODULE_FILES = 13; + + // Set the error name used by the Error object prototype first. + this.name = "DownloadError"; + this.result = aProperties.result || Cr.NS_ERROR_FAILURE; + if (aProperties.message) { + this.message = aProperties.message; + } else if (aProperties.becauseBlocked || + aProperties.becauseBlockedByParentalControls || + aProperties.becauseBlockedByReputationCheck || + aProperties.becauseBlockedByRuntimePermissions) { + this.message = "Download blocked."; + } else { + let exception = new Components.Exception("", this.result); + this.message = exception.toString(); + } + if (aProperties.inferCause) { + let module = ((this.result & 0x7FFF0000) >> 16) - + NS_ERROR_MODULE_BASE_OFFSET; + this.becauseSourceFailed = (module == NS_ERROR_MODULE_NETWORK); + this.becauseTargetFailed = (module == NS_ERROR_MODULE_FILES); + } + else { + if (aProperties.becauseSourceFailed) { + this.becauseSourceFailed = true; + } + if (aProperties.becauseTargetFailed) { + this.becauseTargetFailed = true; + } + } + + if (aProperties.becauseBlockedByParentalControls) { + this.becauseBlocked = true; + this.becauseBlockedByParentalControls = true; + } else if (aProperties.becauseBlockedByReputationCheck) { + this.becauseBlocked = true; + this.becauseBlockedByReputationCheck = true; + this.reputationCheckVerdict = aProperties.reputationCheckVerdict || ""; + } else if (aProperties.becauseBlockedByRuntimePermissions) { + this.becauseBlocked = true; + this.becauseBlockedByRuntimePermissions = true; + } else if (aProperties.becauseBlocked) { + this.becauseBlocked = true; + } + + if (aProperties.innerException) { + this.innerException = aProperties.innerException; + } + + this.stack = new Error().stack; +} + +/** + * These constants are used by the reputationCheckVerdict property and indicate + * the detailed reason why a download is blocked. + * + * @note These values should not be changed because they can be serialized. + */ +this.DownloadError.BLOCK_VERDICT_MALWARE = "Malware"; +this.DownloadError.BLOCK_VERDICT_POTENTIALLY_UNWANTED = "PotentiallyUnwanted"; +this.DownloadError.BLOCK_VERDICT_UNCOMMON = "Uncommon"; + +this.DownloadError.prototype = { + __proto__: Error.prototype, + + /** + * The result code associated with this error. + */ + result: false, + + /** + * Indicates an error occurred while reading from the remote location. + */ + becauseSourceFailed: false, + + /** + * Indicates an error occurred while writing to the local target. + */ + becauseTargetFailed: false, + + /** + * Indicates the download failed because it was blocked. If the reason for + * blocking is known, the corresponding property will be also set. + */ + becauseBlocked: false, + + /** + * Indicates the download was blocked because downloads are globally + * disallowed by the Parental Controls or Family Safety features on Windows. + */ + becauseBlockedByParentalControls: false, + + /** + * Indicates the download was blocked because it failed the reputation check + * and may be malware. + */ + becauseBlockedByReputationCheck: false, + + /** + * Indicates the download was blocked because a runtime permission required to + * download files was not granted. + * + * This does not apply to all systems. On Android this flag is set to true if + * a needed runtime permission (storage) has not been granted by the user. + */ + becauseBlockedByRuntimePermissions: false, + + /** + * If becauseBlockedByReputationCheck is true, indicates the detailed reason + * why the download was blocked, according to the "BLOCK_VERDICT_" constants. + * + * If the download was not blocked or the reason for the block is unknown, + * this will be an empty string. + */ + reputationCheckVerdict: "", + + /** + * If this DownloadError was caused by an exception this property will + * contain the original exception. This will not be serialized when saving + * to the store. + */ + innerException: null, + + /** + * Returns a static representation of the current object state. + * + * @return A JavaScript object that can be serialized to JSON. + */ + toSerializable: function () + { + let serializable = { + result: this.result, + message: this.message, + becauseSourceFailed: this.becauseSourceFailed, + becauseTargetFailed: this.becauseTargetFailed, + becauseBlocked: this.becauseBlocked, + becauseBlockedByParentalControls: this.becauseBlockedByParentalControls, + becauseBlockedByReputationCheck: this.becauseBlockedByReputationCheck, + becauseBlockedByRuntimePermissions: this.becauseBlockedByRuntimePermissions, + reputationCheckVerdict: this.reputationCheckVerdict, + }; + + serializeUnknownProperties(this, serializable); + return serializable; + }, +}; + +/** + * Creates a new DownloadError object from its serializable representation. + * + * @param aSerializable + * Serializable representation of a DownloadError object. + * + * @return The newly created DownloadError object. + */ +this.DownloadError.fromSerializable = function (aSerializable) { + let e = new DownloadError(aSerializable); + deserializeUnknownProperties(e, aSerializable, property => + property != "result" && + property != "message" && + property != "becauseSourceFailed" && + property != "becauseTargetFailed" && + property != "becauseBlocked" && + property != "becauseBlockedByParentalControls" && + property != "becauseBlockedByReputationCheck" && + property != "becauseBlockedByRuntimePermissions" && + property != "reputationCheckVerdict"); + + return e; +}; + +// DownloadSaver + +/** + * Template for an object that actually transfers the data for the download. + */ +this.DownloadSaver = function () {} + +this.DownloadSaver.prototype = { + /** + * Download object for raising notifications and reading properties. + * + * If the tryToKeepPartialData property of the download object is false, the + * saver should never try to keep partially downloaded data if the download + * fails. + */ + download: null, + + /** + * Executes the download. + * + * @param aSetProgressBytesFn + * This function may be called by the saver to report progress. It + * takes three arguments: the first is the number of bytes transferred + * until now, the second is the total number of bytes to be + * transferred (or -1 if unknown), the third indicates whether the + * partially downloaded data can be used when restarting the download + * if it fails or is canceled. + * @param aSetPropertiesFn + * This function may be called by the saver to report information + * about new download properties discovered by the saver during the + * download process. It takes an object where the keys represents + * the names of the properties to set, and the value represents the + * value to set. + * + * @return {Promise} + * @resolves When the download has finished successfully. + * @rejects JavaScript exception if the download failed. + */ + execute: function DS_execute(aSetProgressBytesFn, aSetPropertiesFn) + { + throw new Error("Not implemented."); + }, + + /** + * Cancels the download. + */ + cancel: function DS_cancel() + { + throw new Error("Not implemented."); + }, + + /** + * Removes any partial data kept as part of a canceled or failed download. + * + * This method is never called until the promise returned by "execute" is + * either resolved or rejected, and the "execute" method is not called again + * until the promise returned by this method is resolved or rejected. + * + * @return {Promise} + * @resolves When the operation has finished successfully. + * @rejects JavaScript exception. + */ + removePartialData: function DS_removePartialData() + { + return Promise.resolve(); + }, + + /** + * This can be called by the saver implementation when the download is already + * started, to add it to the browsing history. This method has no effect if + * the download is private. + */ + addToHistory: function () + { + if (this.download.source.isPrivate) { + return; + } + + let sourceUri = NetUtil.newURI(this.download.source.url); + let referrer = this.download.source.referrer; + let referrerUri = referrer ? NetUtil.newURI(referrer) : null; + let targetUri = NetUtil.newURI(new FileUtils.File( + this.download.target.path)); + + // The start time is always available when we reach this point. + let startPRTime = this.download.startTime.getTime() * 1000; + + try { + gDownloadHistory.addDownload(sourceUri, referrerUri, startPRTime, + targetUri); + } + catch (ex) { + if (!(ex instanceof Components.Exception) || + ex.result != Cr.NS_ERROR_NOT_AVAILABLE) { + throw ex; + } + // + // Under normal operation the download history service may not + // be available. We don't want all downloads that are public to fail + // when this happens so we'll ignore this error and this error only! + // + } + }, + + /** + * Returns a static representation of the current object state. + * + * @return A JavaScript object that can be serialized to JSON. + */ + toSerializable: function () + { + throw new Error("Not implemented."); + }, + + /** + * Returns the SHA-256 hash of the downloaded file, if it exists. + */ + getSha256Hash: function () + { + throw new Error("Not implemented."); + }, + + getSignatureInfo: function () + { + throw new Error("Not implemented."); + }, +}; // DownloadSaver + +/** + * Creates a new DownloadSaver object from its serializable representation. + * + * @param aSerializable + * Serializable representation of a DownloadSaver object. If no initial + * state information for the saver object is needed, can be a string + * representing the class of the download operation, for example "copy". + * + * @return The newly created DownloadSaver object. + */ +this.DownloadSaver.fromSerializable = function (aSerializable) { + let serializable = isString(aSerializable) ? { type: aSerializable } + : aSerializable; + let saver; + switch (serializable.type) { + case "copy": + saver = DownloadCopySaver.fromSerializable(serializable); + break; + case "legacy": + saver = DownloadLegacySaver.fromSerializable(serializable); + break; + case "pdf": + saver = DownloadPDFSaver.fromSerializable(serializable); + break; + default: + throw new Error("Unrecoginzed download saver type."); + } + return saver; +}; + +// DownloadCopySaver + +/** + * Saver object that simply copies the entire source file to the target. + */ +this.DownloadCopySaver = function () {} + +this.DownloadCopySaver.prototype = { + __proto__: DownloadSaver.prototype, + + /** + * BackgroundFileSaver object currently handling the download. + */ + _backgroundFileSaver: null, + + /** + * Indicates whether the "cancel" method has been called. This is used to + * prevent the request from starting in case the operation is canceled before + * the BackgroundFileSaver instance has been created. + */ + _canceled: false, + + /** + * Save the SHA-256 hash in raw bytes of the downloaded file. This is null + * unless BackgroundFileSaver has successfully completed saving the file. + */ + _sha256Hash: null, + + /** + * Save the signature info as an nsIArray of nsIX509CertList of nsIX509Cert + * if the file is signed. This is empty if the file is unsigned, and null + * unless BackgroundFileSaver has successfully completed saving the file. + */ + _signatureInfo: null, + + /** + * Save the redirects chain as an nsIArray of nsIPrincipal. + */ + _redirects: null, + + /** + * True if the associated download has already been added to browsing history. + */ + alreadyAddedToHistory: false, + + /** + * String corresponding to the entityID property of the nsIResumableChannel + * used to execute the download, or null if the channel was not resumable or + * the saver was instructed not to keep partially downloaded data. + */ + entityID: null, + + /** + * Implements "DownloadSaver.execute". + */ + execute: function DCS_execute(aSetProgressBytesFn, aSetPropertiesFn) + { + let copySaver = this; + + this._canceled = false; + + let download = this.download; + let targetPath = download.target.path; + let partFilePath = download.target.partFilePath; + let keepPartialData = download.tryToKeepPartialData; + + return Task.spawn(function* task_DCS_execute() { + // Add the download to history the first time it is started in this + // session. If the download is restarted in a different session, a new + // history visit will be added. We do this just to avoid the complexity + // of serializing this state between sessions, since adding a new visit + // does not have any noticeable side effect. + if (!this.alreadyAddedToHistory) { + this.addToHistory(); + this.alreadyAddedToHistory = true; + } + + // To reduce the chance that other downloads reuse the same final target + // file name, we should create a placeholder as soon as possible, before + // starting the network request. The placeholder is also required in case + // we are using a ".part" file instead of the final target while the + // download is in progress. + try { + // If the file already exists, don't delete its contents yet. + let file = yield OS.File.open(targetPath, { write: true }); + yield file.close(); + } catch (ex) { + if (!(ex instanceof OS.File.Error)) { + throw ex; + } + // Throw a DownloadError indicating that the operation failed because of + // the target file. We cannot translate this into a specific result + // code, but we preserve the original message using the toString method. + let error = new DownloadError({ message: ex.toString() }); + error.becauseTargetFailed = true; + throw error; + } + + try { + let deferSaveComplete = Promise.defer(); + + if (this._canceled) { + // Don't create the BackgroundFileSaver object if we have been + // canceled meanwhile. + throw new DownloadError({ message: "Saver canceled." }); + } + + // Create the object that will save the file in a background thread. + let backgroundFileSaver = new BackgroundFileSaverStreamListener(); + try { + // When the operation completes, reflect the status in the promise + // returned by this download execution function. + backgroundFileSaver.observer = { + onTargetChange: function () { }, + onSaveComplete: (aSaver, aStatus) => { + // Send notifications now that we can restart if needed. + if (Components.isSuccessCode(aStatus)) { + // Save the hash before freeing backgroundFileSaver. + this._sha256Hash = aSaver.sha256Hash; + this._signatureInfo = aSaver.signatureInfo; + this._redirects = aSaver.redirects; + deferSaveComplete.resolve(); + } else { + // Infer the origin of the error from the failure code, because + // BackgroundFileSaver does not provide more specific data. + let properties = { result: aStatus, inferCause: true }; + deferSaveComplete.reject(new DownloadError(properties)); + } + // Free the reference cycle, to release resources earlier. + backgroundFileSaver.observer = null; + this._backgroundFileSaver = null; + }, + }; + + // Create a channel from the source, and listen to progress + // notifications. + let channel = NetUtil.newChannel({ + uri: download.source.url, + loadUsingSystemPrincipal: true, + }); + if (channel instanceof Ci.nsIPrivateBrowsingChannel) { + channel.setPrivate(download.source.isPrivate); + } + if (channel instanceof Ci.nsIHttpChannel && + download.source.referrer) { + channel.referrer = NetUtil.newURI(download.source.referrer); + } + + // If we have data that we can use to resume the download from where + // it stopped, try to use it. + let resumeAttempted = false; + let resumeFromBytes = 0; + if (channel instanceof Ci.nsIResumableChannel && this.entityID && + partFilePath && keepPartialData) { + try { + let stat = yield OS.File.stat(partFilePath); + channel.resumeAt(stat.size, this.entityID); + resumeAttempted = true; + resumeFromBytes = stat.size; + } catch (ex) { + if (!(ex instanceof OS.File.Error) || !ex.becauseNoSuchFile) { + throw ex; + } + } + } + + channel.notificationCallbacks = { + QueryInterface: XPCOMUtils.generateQI([Ci.nsIInterfaceRequestor]), + getInterface: XPCOMUtils.generateQI([Ci.nsIProgressEventSink]), + onProgress: function DCSE_onProgress(aRequest, aContext, aProgress, + aProgressMax) + { + let currentBytes = resumeFromBytes + aProgress; + let totalBytes = aProgressMax == -1 ? -1 : (resumeFromBytes + + aProgressMax); + aSetProgressBytesFn(currentBytes, totalBytes, aProgress > 0 && + partFilePath && keepPartialData); + }, + onStatus: function () { }, + }; + + // If the callback was set, handle it now before opening the channel. + if (download.source.adjustChannel) { + yield download.source.adjustChannel(channel); + } + + // Open the channel, directing output to the background file saver. + backgroundFileSaver.QueryInterface(Ci.nsIStreamListener); + channel.asyncOpen2({ + onStartRequest: function (aRequest, aContext) { + backgroundFileSaver.onStartRequest(aRequest, aContext); + + // Check if the request's response has been blocked by Windows + // Parental Controls with an HTTP 450 error code. + if (aRequest instanceof Ci.nsIHttpChannel && + aRequest.responseStatus == 450) { + // Set a flag that can be retrieved later when handling the + // cancellation so that the proper error can be thrown. + this.download._blockedByParentalControls = true; + aRequest.cancel(Cr.NS_BINDING_ABORTED); + return; + } + + aSetPropertiesFn({ contentType: channel.contentType }); + + // Ensure we report the value of "Content-Length", if available, + // even if the download doesn't generate any progress events + // later. + if (channel.contentLength >= 0) { + aSetProgressBytesFn(0, channel.contentLength); + } + + // If the URL we are downloading from includes a file extension + // that matches the "Content-Encoding" header, for example ".gz" + // with a "gzip" encoding, we should save the file in its encoded + // form. In all other cases, we decode the body while saving. + if (channel instanceof Ci.nsIEncodedChannel && + channel.contentEncodings) { + let uri = channel.URI; + if (uri instanceof Ci.nsIURL && uri.fileExtension) { + // Only the first, outermost encoding is considered. + let encoding = channel.contentEncodings.getNext(); + if (encoding) { + channel.applyConversion = + gExternalHelperAppService.applyDecodingForExtension( + uri.fileExtension, encoding); + } + } + } + + if (keepPartialData) { + // If the source is not resumable, don't keep partial data even + // if we were asked to try and do it. + if (aRequest instanceof Ci.nsIResumableChannel) { + try { + // If reading the ID succeeds, the source is resumable. + this.entityID = aRequest.entityID; + } catch (ex) { + if (!(ex instanceof Components.Exception) || + ex.result != Cr.NS_ERROR_NOT_RESUMABLE) { + throw ex; + } + keepPartialData = false; + } + } else { + keepPartialData = false; + } + } + + // Enable hashing and signature verification before setting the + // target. + backgroundFileSaver.enableSha256(); + backgroundFileSaver.enableSignatureInfo(); + if (partFilePath) { + // If we actually resumed a request, append to the partial data. + if (resumeAttempted) { + // TODO: Handle Cr.NS_ERROR_ENTITY_CHANGED + backgroundFileSaver.enableAppend(); + } + + // Use a part file, determining if we should keep it on failure. + backgroundFileSaver.setTarget(new FileUtils.File(partFilePath), + keepPartialData); + } else { + // Set the final target file, and delete it on failure. + backgroundFileSaver.setTarget(new FileUtils.File(targetPath), + false); + } + }.bind(copySaver), + + onStopRequest: function (aRequest, aContext, aStatusCode) { + try { + backgroundFileSaver.onStopRequest(aRequest, aContext, + aStatusCode); + } finally { + // If the data transfer completed successfully, indicate to the + // background file saver that the operation can finish. If the + // data transfer failed, the saver has been already stopped. + if (Components.isSuccessCode(aStatusCode)) { + backgroundFileSaver.finish(Cr.NS_OK); + } + } + }.bind(copySaver), + + onDataAvailable: function (aRequest, aContext, aInputStream, + aOffset, aCount) { + backgroundFileSaver.onDataAvailable(aRequest, aContext, + aInputStream, aOffset, + aCount); + }.bind(copySaver), + }); + + // We should check if we have been canceled in the meantime, after + // all the previous asynchronous operations have been executed and + // just before we set the _backgroundFileSaver property. + if (this._canceled) { + throw new DownloadError({ message: "Saver canceled." }); + } + + // If the operation succeeded, store the object to allow cancellation. + this._backgroundFileSaver = backgroundFileSaver; + } catch (ex) { + // In case an error occurs while setting up the chain of objects for + // the download, ensure that we release the resources of the saver. + backgroundFileSaver.finish(Cr.NS_ERROR_FAILURE); + // Since we're not going to handle deferSaveComplete.promise below, + // we need to make sure that the rejection is handled. + deferSaveComplete.promise.catch(() => {}); + throw ex; + } + + // We will wait on this promise in case no error occurred while setting + // up the chain of objects for the download. + yield deferSaveComplete.promise; + + yield this._checkReputationAndMove(aSetPropertiesFn); + } catch (ex) { + // Ensure we always remove the placeholder for the final target file on + // failure, independently of which code path failed. In some cases, the + // background file saver may have already removed the file. + try { + yield OS.File.remove(targetPath); + } catch (e2) { + // If we failed during the operation, we report the error but use the + // original one as the failure reason of the download. Note that on + // Windows we may get an access denied error instead of a no such file + // error if the file existed before, and was recently deleted. + if (!(e2 instanceof OS.File.Error && + (e2.becauseNoSuchFile || e2.becauseAccessDenied))) { + Cu.reportError(e2); + } + } + throw ex; + } + }.bind(this)); + }, + + /** + * Perform the reputation check and cleanup the downloaded data if required. + * If the download passes the reputation check and is using a part file we + * will move it to the target path since reputation checking is the final + * step in the saver. + * + * @param aSetPropertiesFn + * Function provided to the "execute" method. + * + * @return {Promise} + * @resolves When the reputation check and cleanup is complete. + * @rejects DownloadError if the download should be blocked. + */ + _checkReputationAndMove: Task.async(function* (aSetPropertiesFn) { + let download = this.download; + let targetPath = this.download.target.path; + let partFilePath = this.download.target.partFilePath; + + let { shouldBlock, verdict } = + yield DownloadIntegration.shouldBlockForReputationCheck(download); + if (shouldBlock) { + let newProperties = { progress: 100, hasPartialData: false }; + + // We will remove the potentially dangerous file if instructed by + // DownloadIntegration. We will always remove the file when the + // download did not use a partial file path, meaning it + // currently has its final filename. + if (!DownloadIntegration.shouldKeepBlockedData() || !partFilePath) { + try { + yield OS.File.remove(partFilePath || targetPath); + } catch (ex) { + Cu.reportError(ex); + } + } else { + newProperties.hasBlockedData = true; + } + + aSetPropertiesFn(newProperties); + + throw new DownloadError({ + becauseBlockedByReputationCheck: true, + reputationCheckVerdict: verdict, + }); + } + + if (partFilePath) { + yield OS.File.move(partFilePath, targetPath); + } + }), + + /** + * Implements "DownloadSaver.cancel". + */ + cancel: function DCS_cancel() + { + this._canceled = true; + if (this._backgroundFileSaver) { + this._backgroundFileSaver.finish(Cr.NS_ERROR_FAILURE); + this._backgroundFileSaver = null; + } + }, + + /** + * Implements "DownloadSaver.removePartialData". + */ + removePartialData: function () + { + return Task.spawn(function* task_DCS_removePartialData() { + if (this.download.target.partFilePath) { + try { + yield OS.File.remove(this.download.target.partFilePath); + } catch (ex) { + if (!(ex instanceof OS.File.Error) || !ex.becauseNoSuchFile) { + throw ex; + } + } + } + }.bind(this)); + }, + + /** + * Implements "DownloadSaver.toSerializable". + */ + toSerializable: function () + { + // Simplify the representation if we don't have other details. + if (!this.entityID && !this._unknownProperties) { + return "copy"; + } + + let serializable = { type: "copy", + entityID: this.entityID }; + serializeUnknownProperties(this, serializable); + return serializable; + }, + + /** + * Implements "DownloadSaver.getSha256Hash" + */ + getSha256Hash: function () + { + return this._sha256Hash; + }, + + /* + * Implements DownloadSaver.getSignatureInfo. + */ + getSignatureInfo: function () + { + return this._signatureInfo; + }, + + /* + * Implements DownloadSaver.getRedirects. + */ + getRedirects: function () + { + return this._redirects; + } +}; + +/** + * Creates a new DownloadCopySaver object, with its initial state derived from + * its serializable representation. + * + * @param aSerializable + * Serializable representation of a DownloadCopySaver object. + * + * @return The newly created DownloadCopySaver object. + */ +this.DownloadCopySaver.fromSerializable = function (aSerializable) { + let saver = new DownloadCopySaver(); + if ("entityID" in aSerializable) { + saver.entityID = aSerializable.entityID; + } + + deserializeUnknownProperties(saver, aSerializable, property => + property != "entityID" && property != "type"); + + return saver; +}; + +// DownloadLegacySaver + +/** + * Saver object that integrates with the legacy nsITransfer interface. + * + * For more background on the process, see the DownloadLegacyTransfer object. + */ +this.DownloadLegacySaver = function () +{ + this.deferExecuted = Promise.defer(); + this.deferCanceled = Promise.defer(); +} + +this.DownloadLegacySaver.prototype = { + __proto__: DownloadSaver.prototype, + + /** + * Save the SHA-256 hash in raw bytes of the downloaded file. This may be + * null when nsExternalHelperAppService (and thus BackgroundFileSaver) is not + * invoked. + */ + _sha256Hash: null, + + /** + * Save the signature info as an nsIArray of nsIX509CertList of nsIX509Cert + * if the file is signed. This is empty if the file is unsigned, and null + * unless BackgroundFileSaver has successfully completed saving the file. + */ + _signatureInfo: null, + + /** + * Save the redirect chain as an nsIArray of nsIPrincipal. + */ + _redirects: null, + + /** + * nsIRequest object associated to the status and progress updates we + * received. This object is null before we receive the first status and + * progress update, and is also reset to null when the download is stopped. + */ + request: null, + + /** + * This deferred object contains a promise that is resolved as soon as this + * download finishes successfully, and is rejected in case the download is + * canceled or receives a failure notification through nsITransfer. + */ + deferExecuted: null, + + /** + * This deferred object contains a promise that is resolved if the download + * receives a cancellation request through the "cancel" method, and is never + * rejected. The nsITransfer implementation will register a handler that + * actually causes the download cancellation. + */ + deferCanceled: null, + + /** + * This is populated with the value of the aSetProgressBytesFn argument of the + * "execute" method, and is null before the method is called. + */ + setProgressBytesFn: null, + + /** + * Called by the nsITransfer implementation while the download progresses. + * + * @param aCurrentBytes + * Number of bytes transferred until now. + * @param aTotalBytes + * Total number of bytes to be transferred, or -1 if unknown. + */ + onProgressBytes: function DLS_onProgressBytes(aCurrentBytes, aTotalBytes) + { + this.progressWasNotified = true; + + // Ignore progress notifications until we are ready to process them. + if (!this.setProgressBytesFn) { + // Keep the data from the last progress notification that was received. + this.currentBytes = aCurrentBytes; + this.totalBytes = aTotalBytes; + return; + } + + let hasPartFile = !!this.download.target.partFilePath; + + this.setProgressBytesFn(aCurrentBytes, aTotalBytes, + aCurrentBytes > 0 && hasPartFile); + }, + + /** + * Whether the onProgressBytes function has been called at least once. + */ + progressWasNotified: false, + + /** + * Called by the nsITransfer implementation when the request has started. + * + * @param aRequest + * nsIRequest associated to the status update. + * @param aAlreadyAddedToHistory + * Indicates that the nsIExternalHelperAppService component already + * added the download to the browsing history, unless it was started + * from a private browsing window. When this parameter is false, the + * download is added to the browsing history here. Private downloads + * are never added to history even if this parameter is false. + */ + onTransferStarted: function (aRequest, aAlreadyAddedToHistory) + { + // Store the entity ID to use for resuming if required. + if (this.download.tryToKeepPartialData && + aRequest instanceof Ci.nsIResumableChannel) { + try { + // If reading the ID succeeds, the source is resumable. + this.entityID = aRequest.entityID; + } catch (ex) { + if (!(ex instanceof Components.Exception) || + ex.result != Cr.NS_ERROR_NOT_RESUMABLE) { + throw ex; + } + } + } + + // For legacy downloads, we must update the referrer at this time. + if (aRequest instanceof Ci.nsIHttpChannel && aRequest.referrer) { + this.download.source.referrer = aRequest.referrer.spec; + } + + if (!aAlreadyAddedToHistory) { + this.addToHistory(); + } + }, + + /** + * Called by the nsITransfer implementation when the request has finished. + * + * @param aRequest + * nsIRequest associated to the status update. + * @param aStatus + * Status code received by the nsITransfer implementation. + */ + onTransferFinished: function DLS_onTransferFinished(aRequest, aStatus) + { + // Store a reference to the request, used when handling completion. + this.request = aRequest; + + if (Components.isSuccessCode(aStatus)) { + this.deferExecuted.resolve(); + } else { + // Infer the origin of the error from the failure code, because more + // specific data is not available through the nsITransfer implementation. + let properties = { result: aStatus, inferCause: true }; + this.deferExecuted.reject(new DownloadError(properties)); + } + }, + + /** + * When the first execution of the download finished, it can be restarted by + * using a DownloadCopySaver object instead of the original legacy component + * that executed the download. + */ + firstExecutionFinished: false, + + /** + * In case the download is restarted after the first execution finished, this + * property contains a reference to the DownloadCopySaver that is executing + * the new download attempt. + */ + copySaver: null, + + /** + * String corresponding to the entityID property of the nsIResumableChannel + * used to execute the download, or null if the channel was not resumable or + * the saver was instructed not to keep partially downloaded data. + */ + entityID: null, + + /** + * Implements "DownloadSaver.execute". + */ + execute: function DLS_execute(aSetProgressBytesFn, aSetPropertiesFn) + { + // Check if this is not the first execution of the download. The Download + // object guarantees that this function is not re-entered during execution. + if (this.firstExecutionFinished) { + if (!this.copySaver) { + this.copySaver = new DownloadCopySaver(); + this.copySaver.download = this.download; + this.copySaver.entityID = this.entityID; + this.copySaver.alreadyAddedToHistory = true; + } + return this.copySaver.execute.apply(this.copySaver, arguments); + } + + this.setProgressBytesFn = aSetProgressBytesFn; + if (this.progressWasNotified) { + this.onProgressBytes(this.currentBytes, this.totalBytes); + } + + return Task.spawn(function* task_DLS_execute() { + try { + // Wait for the component that executes the download to finish. + yield this.deferExecuted.promise; + + // At this point, the "request" property has been populated. Ensure we + // report the value of "Content-Length", if available, even if the + // download didn't generate any progress events. + if (!this.progressWasNotified && + this.request instanceof Ci.nsIChannel && + this.request.contentLength >= 0) { + aSetProgressBytesFn(0, this.request.contentLength); + } + + // If the component executing the download provides the path of a + // ".part" file, it means that it expects the listener to move the file + // to its final target path when the download succeeds. In this case, + // an empty ".part" file is created even if no data was received from + // the source. + // + // When no ".part" file path is provided the download implementation may + // not have created the target file (if no data was received from the + // source). In this case, ensure that an empty file is created as + // expected. + if (!this.download.target.partFilePath) { + try { + // This atomic operation is more efficient than an existence check. + let file = yield OS.File.open(this.download.target.path, + { create: true }); + yield file.close(); + } catch (ex) { + if (!(ex instanceof OS.File.Error) || !ex.becauseExists) { + throw ex; + } + } + } + + yield this._checkReputationAndMove(aSetPropertiesFn); + + } catch (ex) { + // Ensure we always remove the final target file on failure, + // independently of which code path failed. In some cases, the + // component executing the download may have already removed the file. + try { + yield OS.File.remove(this.download.target.path); + } catch (e2) { + // If we failed during the operation, we report the error but use the + // original one as the failure reason of the download. Note that on + // Windows we may get an access denied error instead of a no such file + // error if the file existed before, and was recently deleted. + if (!(e2 instanceof OS.File.Error && + (e2.becauseNoSuchFile || e2.becauseAccessDenied))) { + Cu.reportError(e2); + } + } + // In case the operation failed, ensure we stop downloading data. Since + // we never re-enter this function, deferCanceled is always available. + this.deferCanceled.resolve(); + throw ex; + } finally { + // We don't need the reference to the request anymore. We must also set + // deferCanceled to null in order to free any indirect references it + // may hold to the request. + this.request = null; + this.deferCanceled = null; + // Allow the download to restart through a DownloadCopySaver. + this.firstExecutionFinished = true; + } + }.bind(this)); + }, + + _checkReputationAndMove: function () { + return DownloadCopySaver.prototype._checkReputationAndMove + .apply(this, arguments); + }, + + /** + * Implements "DownloadSaver.cancel". + */ + cancel: function DLS_cancel() + { + // We may be using a DownloadCopySaver to handle resuming. + if (this.copySaver) { + return this.copySaver.cancel.apply(this.copySaver, arguments); + } + + // If the download hasn't stopped already, resolve deferCanceled so that the + // operation is canceled as soon as a cancellation handler is registered. + // Note that the handler might not have been registered yet. + if (this.deferCanceled) { + this.deferCanceled.resolve(); + } + }, + + /** + * Implements "DownloadSaver.removePartialData". + */ + removePartialData: function () + { + // DownloadCopySaver and DownloadLeagcySaver use the same logic for removing + // partially downloaded data, though this implementation isn't shared by + // other saver types, thus it isn't found on their shared prototype. + return DownloadCopySaver.prototype.removePartialData.call(this); + }, + + /** + * Implements "DownloadSaver.toSerializable". + */ + toSerializable: function () + { + // This object depends on legacy components that are created externally, + // thus it cannot be rebuilt during deserialization. To support resuming + // across different browser sessions, this object is transformed into a + // DownloadCopySaver for the purpose of serialization. + return DownloadCopySaver.prototype.toSerializable.call(this); + }, + + /** + * Implements "DownloadSaver.getSha256Hash". + */ + getSha256Hash: function () + { + if (this.copySaver) { + return this.copySaver.getSha256Hash(); + } + return this._sha256Hash; + }, + + /** + * Called by the nsITransfer implementation when the hash is available. + */ + setSha256Hash: function (hash) + { + this._sha256Hash = hash; + }, + + /** + * Implements "DownloadSaver.getSignatureInfo". + */ + getSignatureInfo: function () + { + if (this.copySaver) { + return this.copySaver.getSignatureInfo(); + } + return this._signatureInfo; + }, + + /** + * Called by the nsITransfer implementation when the hash is available. + */ + setSignatureInfo: function (signatureInfo) + { + this._signatureInfo = signatureInfo; + }, + + /** + * Implements "DownloadSaver.getRedirects". + */ + getRedirects: function () + { + if (this.copySaver) { + return this.copySaver.getRedirects(); + } + return this._redirects; + }, + + /** + * Called by the nsITransfer implementation when the redirect chain is + * available. + */ + setRedirects: function (redirects) + { + this._redirects = redirects; + }, +}; + +/** + * Returns a new DownloadLegacySaver object. This saver type has a + * deserializable form only when creating a new object in memory, because it + * cannot be serialized to disk. + */ +this.DownloadLegacySaver.fromSerializable = function () { + return new DownloadLegacySaver(); +}; + +// DownloadPDFSaver + +/** + * This DownloadSaver type creates a PDF file from the current document in a + * given window, specified using the windowRef property of the DownloadSource + * object associated with the download. + * + * In order to prevent the download from saving a different document than the one + * originally loaded in the window, any attempt to restart the download will fail. + * + * Since this DownloadSaver type requires a live document as a source, it cannot + * be persisted across sessions, unless the download already succeeded. + */ +this.DownloadPDFSaver = function () { +} + +this.DownloadPDFSaver.prototype = { + __proto__: DownloadSaver.prototype, + + /** + * An nsIWebBrowserPrint instance for printing this page. + * This is null when saving has not started or has completed, + * or while the operation is being canceled. + */ + _webBrowserPrint: null, + + /** + * Implements "DownloadSaver.execute". + */ + execute: function (aSetProgressBytesFn, aSetPropertiesFn) + { + return Task.spawn(function* task_DCS_execute() { + if (!this.download.source.windowRef) { + throw new DownloadError({ + message: "PDF saver must be passed an open window, and cannot be restarted.", + becauseSourceFailed: true, + }); + } + + let win = this.download.source.windowRef.get(); + + // Set windowRef to null to avoid re-trying. + this.download.source.windowRef = null; + + if (!win) { + throw new DownloadError({ + message: "PDF saver can't save a window that has been closed.", + becauseSourceFailed: true, + }); + } + + this.addToHistory(); + + let targetPath = this.download.target.path; + + // An empty target file must exist for the PDF printer to work correctly. + let file = yield OS.File.open(targetPath, { truncate: true }); + yield file.close(); + + let printSettings = gPrintSettingsService.newPrintSettings; + + printSettings.printToFile = true; + printSettings.outputFormat = Ci.nsIPrintSettings.kOutputFormatPDF; + printSettings.toFileName = targetPath; + + printSettings.printSilent = true; + printSettings.showPrintProgress = false; + + printSettings.printBGImages = true; + printSettings.printBGColors = true; + printSettings.printFrameType = Ci.nsIPrintSettings.kFramesAsIs; + printSettings.headerStrCenter = ""; + printSettings.headerStrLeft = ""; + printSettings.headerStrRight = ""; + printSettings.footerStrCenter = ""; + printSettings.footerStrLeft = ""; + printSettings.footerStrRight = ""; + + this._webBrowserPrint = win.QueryInterface(Ci.nsIInterfaceRequestor) + .getInterface(Ci.nsIWebBrowserPrint); + + try { + yield new Promise((resolve, reject) => { + this._webBrowserPrint.print(printSettings, { + onStateChange: function (webProgress, request, stateFlags, status) { + if (stateFlags & Ci.nsIWebProgressListener.STATE_STOP) { + if (!Components.isSuccessCode(status)) { + reject(new DownloadError({ result: status, + inferCause: true })); + } else { + resolve(); + } + } + }, + onProgressChange: function (webProgress, request, curSelfProgress, + maxSelfProgress, curTotalProgress, + maxTotalProgress) { + aSetProgressBytesFn(curTotalProgress, maxTotalProgress, false); + }, + onLocationChange: function () {}, + onStatusChange: function () {}, + onSecurityChange: function () {}, + }); + }); + } finally { + // Remove the print object to avoid leaks + this._webBrowserPrint = null; + } + + let fileInfo = yield OS.File.stat(targetPath); + aSetProgressBytesFn(fileInfo.size, fileInfo.size, false); + }.bind(this)); + }, + + /** + * Implements "DownloadSaver.cancel". + */ + cancel: function DCS_cancel() + { + if (this._webBrowserPrint) { + this._webBrowserPrint.cancel(); + this._webBrowserPrint = null; + } + }, + + /** + * Implements "DownloadSaver.toSerializable". + */ + toSerializable: function () + { + if (this.download.succeeded) { + return DownloadCopySaver.prototype.toSerializable.call(this); + } + + // This object needs a window to recreate itself. If it didn't succeded + // it will not be possible to restart. Returning null here will + // prevent us from serializing it at all. + return null; + }, +}; + +/** + * Creates a new DownloadPDFSaver object, with its initial state derived from + * its serializable representation. + * + * @param aSerializable + * Serializable representation of a DownloadPDFSaver object. + * + * @return The newly created DownloadPDFSaver object. + */ +this.DownloadPDFSaver.fromSerializable = function (aSerializable) { + return new DownloadPDFSaver(); +}; diff --git a/toolkit/components/jsdownloads/src/DownloadImport.jsm b/toolkit/components/jsdownloads/src/DownloadImport.jsm new file mode 100644 index 000000000..5fb7fd0c7 --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadImport.jsm @@ -0,0 +1,193 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "DownloadImport", +]; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "Downloads", + "resource://gre/modules/Downloads.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm") +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Sqlite", + "resource://gre/modules/Sqlite.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "NetUtil", + "resource://gre/modules/NetUtil.jsm"); + +/** + * These values come from the previous interface + * nsIDownloadManager, which has now been deprecated. + * These are the only types of download states that + * we will import. + */ +const DOWNLOAD_NOTSTARTED = -1; +const DOWNLOAD_DOWNLOADING = 0; +const DOWNLOAD_PAUSED = 4; +const DOWNLOAD_QUEUED = 5; + +// DownloadImport + +/** + * Provides an object that has a method to import downloads + * from the previous SQLite storage format. + * + * @param aList A DownloadList where each successfully + * imported download will be added. + * @param aPath The path to the database file. + */ +this.DownloadImport = function (aList, aPath) +{ + this.list = aList; + this.path = aPath; +} + +this.DownloadImport.prototype = { + /** + * Imports unfinished downloads from the previous SQLite storage + * format (supporting schemas 7 and up), to the new Download object + * format. Each imported download will be added to the DownloadList + * + * @return {Promise} + * @resolves When the operation has completed (i.e., every download + * from the previous database has been read and added to + * the DownloadList) + */ + import: function () { + return Task.spawn(function* task_DI_import() { + let connection = yield Sqlite.openConnection({ path: this.path }); + + try { + let schemaVersion = yield connection.getSchemaVersion(); + // We don't support schemas older than version 7 (from 2007) + // - Version 7 added the columns mimeType, preferredApplication + // and preferredAction in 2007 + // - Version 8 added the column autoResume in 2007 + // (if we encounter version 7 we will treat autoResume = false) + // - Version 9 is the last known version, which added a unique + // GUID text column that is not used here + if (schemaVersion < 7) { + throw new Error("Unable to import in-progress downloads because " + + "the existing profile is too old."); + } + + let rows = yield connection.execute("SELECT * FROM moz_downloads"); + + for (let row of rows) { + try { + // Get the DB row data + let source = row.getResultByName("source"); + let target = row.getResultByName("target"); + let tempPath = row.getResultByName("tempPath"); + let startTime = row.getResultByName("startTime"); + let state = row.getResultByName("state"); + let referrer = row.getResultByName("referrer"); + let maxBytes = row.getResultByName("maxBytes"); + let mimeType = row.getResultByName("mimeType"); + let preferredApplication = row.getResultByName("preferredApplication"); + let preferredAction = row.getResultByName("preferredAction"); + let entityID = row.getResultByName("entityID"); + + let autoResume = false; + try { + autoResume = (row.getResultByName("autoResume") == 1); + } catch (ex) { + // autoResume wasn't present in schema version 7 + } + + if (!source) { + throw new Error("Attempted to import a row with an empty " + + "source column."); + } + + let resumeDownload = false; + + switch (state) { + case DOWNLOAD_NOTSTARTED: + case DOWNLOAD_QUEUED: + case DOWNLOAD_DOWNLOADING: + resumeDownload = true; + break; + + case DOWNLOAD_PAUSED: + resumeDownload = autoResume; + break; + + default: + // We won't import downloads in other states + continue; + } + + // Transform the data + let targetPath = NetUtil.newURI(target) + .QueryInterface(Ci.nsIFileURL).file.path; + + let launchWhenSucceeded = (preferredAction != Ci.nsIMIMEInfo.saveToDisk); + + let downloadOptions = { + source: { + url: source, + referrer: referrer + }, + target: { + path: targetPath, + partFilePath: tempPath, + }, + saver: { + type: "copy", + entityID: entityID + }, + startTime: new Date(startTime / 1000), + totalBytes: maxBytes, + hasPartialData: !!tempPath, + tryToKeepPartialData: true, + launchWhenSucceeded: launchWhenSucceeded, + contentType: mimeType, + launcherPath: preferredApplication + }; + + // Paused downloads that should not be auto-resumed are considered + // in a "canceled" state. + if (!resumeDownload) { + downloadOptions.canceled = true; + } + + let download = yield Downloads.createDownload(downloadOptions); + + yield this.list.add(download); + + if (resumeDownload) { + download.start().catch(() => {}); + } else { + yield download.refresh(); + } + + } catch (ex) { + Cu.reportError("Error importing download: " + ex); + } + } + + } catch (ex) { + Cu.reportError(ex); + } finally { + yield connection.close(); + } + }.bind(this)); + } +} + diff --git a/toolkit/components/jsdownloads/src/DownloadIntegration.jsm b/toolkit/components/jsdownloads/src/DownloadIntegration.jsm new file mode 100644 index 000000000..5fed9212a --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadIntegration.jsm @@ -0,0 +1,1273 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +/** + * Provides functions to integrate with the host application, handling for + * example the global prompts on shutdown. + */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "DownloadIntegration", +]; + +//////////////////////////////////////////////////////////////////////////////// +//// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/Integration.jsm"); +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "AsyncShutdown", + "resource://gre/modules/AsyncShutdown.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DeferredTask", + "resource://gre/modules/DeferredTask.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Downloads", + "resource://gre/modules/Downloads.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadStore", + "resource://gre/modules/DownloadStore.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadImport", + "resource://gre/modules/DownloadImport.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadUIHelper", + "resource://gre/modules/DownloadUIHelper.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "FileUtils", + "resource://gre/modules/FileUtils.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "NetUtil", + "resource://gre/modules/NetUtil.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm"); +#ifdef MOZ_PLACES +XPCOMUtils.defineLazyModuleGetter(this, "PlacesUtils", + "resource://gre/modules/PlacesUtils.jsm"); +#endif +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Services", + "resource://gre/modules/Services.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "NetUtil", + "resource://gre/modules/NetUtil.jsm"); + +XPCOMUtils.defineLazyServiceGetter(this, "gDownloadPlatform", + "@mozilla.org/toolkit/download-platform;1", + "mozIDownloadPlatform"); +XPCOMUtils.defineLazyServiceGetter(this, "gEnvironment", + "@mozilla.org/process/environment;1", + "nsIEnvironment"); +XPCOMUtils.defineLazyServiceGetter(this, "gMIMEService", + "@mozilla.org/mime;1", + "nsIMIMEService"); +XPCOMUtils.defineLazyServiceGetter(this, "gExternalProtocolService", + "@mozilla.org/uriloader/external-protocol-service;1", + "nsIExternalProtocolService"); +#ifdef MOZ_WIDGET_ANDROID +XPCOMUtils.defineLazyModuleGetter(this, "RuntimePermissions", + "resource://gre/modules/RuntimePermissions.jsm"); +#endif + +XPCOMUtils.defineLazyGetter(this, "gParentalControlsService", function() { + if ("@mozilla.org/parental-controls-service;1" in Cc) { + return Cc["@mozilla.org/parental-controls-service;1"] + .createInstance(Ci.nsIParentalControlsService); + } + return null; +}); + +XPCOMUtils.defineLazyServiceGetter(this, "gApplicationReputationService", + "@mozilla.org/downloads/application-reputation-service;1", + Ci.nsIApplicationReputationService); + +XPCOMUtils.defineLazyServiceGetter(this, "volumeService", + "@mozilla.org/telephony/volume-service;1", + "nsIVolumeService"); + +// We have to use the gCombinedDownloadIntegration identifier because, in this +// module only, the DownloadIntegration identifier refers to the base version. +Integration.downloads.defineModuleGetter(this, "gCombinedDownloadIntegration", + "resource://gre/modules/DownloadIntegration.jsm", + "DownloadIntegration"); + +const Timer = Components.Constructor("@mozilla.org/timer;1", "nsITimer", + "initWithCallback"); + +/** + * Indicates the delay between a change to the downloads data and the related + * save operation. + * + * For best efficiency, this value should be high enough that the input/output + * for opening or closing the target file does not overlap with the one for + * saving the list of downloads. + */ +const kSaveDelayMs = 1500; + +/** + * This pref indicates if we have already imported (or attempted to import) + * the downloads database from the previous SQLite storage. + */ +const kPrefImportedFromSqlite = "browser.download.importedFromSqlite"; + +/** + * List of observers to listen against + */ +const kObserverTopics = [ + "quit-application-requested", + "offline-requested", + "last-pb-context-exiting", + "last-pb-context-exited", + "sleep_notification", + "suspend_process_notification", + "wake_notification", + "resume_process_notification", + "network:offline-about-to-go-offline", + "network:offline-status-changed", + "xpcom-will-shutdown", +]; + +/** + * Maps nsIApplicationReputationService verdicts with the DownloadError ones. + */ +const kVerdictMap = { + [Ci.nsIApplicationReputationService.VERDICT_DANGEROUS]: + Downloads.Error.BLOCK_VERDICT_MALWARE, + [Ci.nsIApplicationReputationService.VERDICT_UNCOMMON]: + Downloads.Error.BLOCK_VERDICT_UNCOMMON, + [Ci.nsIApplicationReputationService.VERDICT_POTENTIALLY_UNWANTED]: + Downloads.Error.BLOCK_VERDICT_POTENTIALLY_UNWANTED, + [Ci.nsIApplicationReputationService.VERDICT_DANGEROUS_HOST]: + Downloads.Error.BLOCK_VERDICT_MALWARE, +}; + +//////////////////////////////////////////////////////////////////////////////// +//// DownloadIntegration + +/** + * Provides functions to integrate with the host application, handling for + * example the global prompts on shutdown. + */ +this.DownloadIntegration = { + /** + * Main DownloadStore object for loading and saving the list of persistent + * downloads, or null if the download list was never requested and thus it + * doesn't need to be persisted. + */ + _store: null, + + /** + * Returns whether data for blocked downloads should be kept on disk. + * Implementations which support unblocking downloads may return true to + * keep the blocked download on disk until its fate is decided. + * + * If a download is blocked and the partial data is kept the Download's + * 'hasBlockedData' property will be true. In this state Download.unblock() + * or Download.confirmBlock() may be used to either unblock the download or + * remove the downloaded data respectively. + * + * Even if shouldKeepBlockedData returns true, if the download did not use a + * partFile the blocked data will be removed - preventing the complete + * download from existing on disk with its final filename. + * + * @return boolean True if data should be kept. + */ + shouldKeepBlockedData() { + const FIREFOX_ID = "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}"; + return Services.appinfo.ID == FIREFOX_ID; + }, + + /** + * Performs initialization of the list of persistent downloads, before its + * first use by the host application. This function may be called only once + * during the entire lifetime of the application. + * + * @param list + * DownloadList object to be initialized. + * + * @return {Promise} + * @resolves When the list has been initialized. + * @rejects JavaScript exception. + */ + initializePublicDownloadList: Task.async(function* (list) { + try { + yield this.loadPublicDownloadListFromStore(list); + } catch (ex) { + Cu.reportError(ex); + } + + // After the list of persistent downloads has been loaded, we can add the + // history observers, even if the load operation failed. This object is kept + // alive by the history service. + new DownloadHistoryObserver(list); + }), + + /** + * Called by initializePublicDownloadList to load the list of persistent + * downloads, before its first use by the host application. This function may + * be called only once during the entire lifetime of the application. + * + * @param list + * DownloadList object to be populated with the download objects + * serialized from the previous session. This list will be persisted + * to disk during the session lifetime. + * + * @return {Promise} + * @resolves When the list has been populated. + * @rejects JavaScript exception. + */ + loadPublicDownloadListFromStore: Task.async(function* (list) { + if (this._store) { + throw new Error("Initialization may be performed only once."); + } + + this._store = new DownloadStore(list, OS.Path.join( + OS.Constants.Path.profileDir, + "downloads.json")); + this._store.onsaveitem = this.shouldPersistDownload.bind(this); + + try { + if (this._importedFromSqlite) { + yield this._store.load(); + } else { + let sqliteDBpath = OS.Path.join(OS.Constants.Path.profileDir, + "downloads.sqlite"); + + if (yield OS.File.exists(sqliteDBpath)) { + let sqliteImport = new DownloadImport(list, sqliteDBpath); + yield sqliteImport.import(); + + let importCount = (yield list.getAll()).length; + if (importCount > 0) { + try { + yield this._store.save(); + } catch (ex) { } + } + + // No need to wait for the file removal. + OS.File.remove(sqliteDBpath).then(null, Cu.reportError); + } + + Services.prefs.setBoolPref(kPrefImportedFromSqlite, true); + + // Don't even report error here because this file is pre Firefox 3 + // and most likely doesn't exist. + OS.File.remove(OS.Path.join(OS.Constants.Path.profileDir, + "downloads.rdf")).catch(() => {}); + + } + } catch (ex) { + Cu.reportError(ex); + } + + // Add the view used for detecting changes to downloads to be persisted. + // We must do this after the list of persistent downloads has been loaded, + // even if the load operation failed. We wait for a complete initialization + // so other callers cannot modify the list without being detected. The + // DownloadAutoSaveView is kept alive by the underlying DownloadList. + yield new DownloadAutoSaveView(list, this._store).initialize(); + }), + + /** + * Determines if a Download object from the list of persistent downloads + * should be saved into a file, so that it can be restored across sessions. + * + * This function allows filtering out downloads that the host application is + * not interested in persisting across sessions, for example downloads that + * finished successfully. + * + * @param aDownload + * The Download object to be inspected. This is originally taken from + * the global DownloadList object for downloads that were not started + * from a private browsing window. The item may have been removed + * from the list since the save operation started, though in this case + * the save operation will be repeated later. + * + * @return True to save the download, false otherwise. + */ + shouldPersistDownload(aDownload) { + // On all platforms, we save all the downloads currently in progress, as + // well as stopped downloads for which we retained partially downloaded + // data or we have blocked data. + if (!aDownload.stopped || aDownload.hasPartialData || + aDownload.hasBlockedData) { + return true; + } +#ifdef MOZ_B2G + // On B2G we keep a few days of history. + let maxTime = Date.now() - + Services.prefs.getIntPref("dom.downloads.max_retention_days") * 24 * 60 * 60 * 1000; + return aDownload.startTime > maxTime; +#elif defined(MOZ_WIDGET_ANDROID) + // On Android we store all history. + return true; +#else + // On Desktop, stopped downloads for which we don't need to track the + // presence of a ".part" file are only retained in the browser history. + return false; +#endif + }, + + /** + * Returns the system downloads directory asynchronously. + * + * @return {Promise} + * @resolves The downloads directory string path. + */ + getSystemDownloadsDirectory: Task.async(function* () { + if (this._downloadsDirectory) { + return this._downloadsDirectory; + } + + let directoryPath = null; +#ifdef XP_MACOSX + directoryPath = this._getDirectory("DfltDwnld"); +#elifdef XP_WIN + // For XP/2K, use My Documents/Downloads. Other version uses + // the default Downloads directory. + let version = parseFloat(Services.sysinfo.getProperty("version")); + if (version < 6) { + directoryPath = yield this._createDownloadsDirectory("Pers"); + } else { + directoryPath = this._getDirectory("DfltDwnld"); + } +#elifdef XP_UNIX +#ifdef MOZ_WIDGET_ANDROID + // Android doesn't have a $HOME directory, and by default we only have + // write access to /data/data/org.mozilla.{$APP} and /sdcard + directoryPath = gEnvironment.get("DOWNLOADS_DIRECTORY"); + if (!directoryPath) { + throw new Components.Exception("DOWNLOADS_DIRECTORY is not set.", + Cr.NS_ERROR_FILE_UNRECOGNIZED_PATH); + } +#else + // For Linux, use XDG download dir, with a fallback to Home/Downloads + // if the XDG user dirs are disabled. + try { + directoryPath = this._getDirectory("DfltDwnld"); + } catch(e) { + directoryPath = yield this._createDownloadsDirectory("Home"); + } +#endif +#else + directoryPath = yield this._createDownloadsDirectory("Home"); +#endif + + this._downloadsDirectory = directoryPath; + return this._downloadsDirectory; + }), + _downloadsDirectory: null, + + /** + * Returns the user downloads directory asynchronously. + * + * @return {Promise} + * @resolves The downloads directory string path. + */ + getPreferredDownloadsDirectory: Task.async(function* () { + let directoryPath = null; + let prefValue = 1; + + try { + prefValue = Services.prefs.getIntPref("browser.download.folderList"); + } catch(e) {} + + switch(prefValue) { + case 0: // Desktop + directoryPath = this._getDirectory("Desk"); + break; + case 1: // Downloads + directoryPath = yield this.getSystemDownloadsDirectory(); + break; + case 2: // Custom + try { + let directory = Services.prefs.getComplexValue("browser.download.dir", + Ci.nsIFile); + directoryPath = directory.path; + yield OS.File.makeDir(directoryPath, { ignoreExisting: true }); + } catch(ex) { + // Either the preference isn't set or the directory cannot be created. + directoryPath = yield this.getSystemDownloadsDirectory(); + } + break; + default: + directoryPath = yield this.getSystemDownloadsDirectory(); + } + return directoryPath; + }), + + /** + * Returns the temporary downloads directory asynchronously. + * + * @return {Promise} + * @resolves The downloads directory string path. + */ + getTemporaryDownloadsDirectory: Task.async(function* () { + let directoryPath = null; +#ifdef XP_MACOSX + directoryPath = yield this.getPreferredDownloadsDirectory(); +#elifdef MOZ_WIDGET_ANDROID + directoryPath = yield this.getSystemDownloadsDirectory(); +#elifdef MOZ_WIDGET_GONK + directoryPath = yield this.getSystemDownloadsDirectory(); +#else + directoryPath = this._getDirectory("TmpD"); +#endif + return directoryPath; + }), + + /** + * Checks to determine whether to block downloads for parental controls. + * + * aParam aDownload + * The download object. + * + * @return {Promise} + * @resolves The boolean indicates to block downloads or not. + */ + shouldBlockForParentalControls(aDownload) { + let isEnabled = gParentalControlsService && + gParentalControlsService.parentalControlsEnabled; + let shouldBlock = isEnabled && + gParentalControlsService.blockFileDownloadsEnabled; + + // Log the event if required by parental controls settings. + if (isEnabled && gParentalControlsService.loggingEnabled) { + gParentalControlsService.log(gParentalControlsService.ePCLog_FileDownload, + shouldBlock, + NetUtil.newURI(aDownload.source.url), null); + } + + return Promise.resolve(shouldBlock); + }, + + /** + * Checks to determine whether to block downloads for not granted runtime permissions. + * + * @return {Promise} + * @resolves The boolean indicates to block downloads or not. + */ + shouldBlockForRuntimePermissions() { +#ifdef MOZ_WIDGET_ANDROID + return RuntimePermissions.waitForPermissions(RuntimePermissions.WRITE_EXTERNAL_STORAGE) + .then(permissionGranted => !permissionGranted); +#else + return Promise.resolve(false); +#endif + }, + + /** + * Checks to determine whether to block downloads because they might be + * malware, based on application reputation checks. + * + * aParam aDownload + * The download object. + * + * @return {Promise} + * @resolves Object with the following properties: + * { + * shouldBlock: Whether the download should be blocked. + * verdict: Detailed reason for the block, according to the + * "Downloads.Error.BLOCK_VERDICT_" constants, or empty + * string if the reason is unknown. + * } + */ + shouldBlockForReputationCheck(aDownload) { + let hash; + let sigInfo; + let channelRedirects; + try { + hash = aDownload.saver.getSha256Hash(); + sigInfo = aDownload.saver.getSignatureInfo(); + channelRedirects = aDownload.saver.getRedirects(); + } catch (ex) { + // Bail if DownloadSaver doesn't have a hash or signature info. + return Promise.resolve({ + shouldBlock: false, + verdict: "", + }); + } + if (!hash || !sigInfo) { + return Promise.resolve({ + shouldBlock: false, + verdict: "", + }); + } + let deferred = Promise.defer(); + let aReferrer = null; + if (aDownload.source.referrer) { + aReferrer = NetUtil.newURI(aDownload.source.referrer); + } + gApplicationReputationService.queryReputation({ + sourceURI: NetUtil.newURI(aDownload.source.url), + referrerURI: aReferrer, + fileSize: aDownload.currentBytes, + sha256Hash: hash, + suggestedFileName: OS.Path.basename(aDownload.target.path), + signatureInfo: sigInfo, + redirects: channelRedirects }, + function onComplete(aShouldBlock, aRv, aVerdict) { + deferred.resolve({ + shouldBlock: aShouldBlock, + verdict: (aShouldBlock && kVerdictMap[aVerdict]) || "", + }); + }); + return deferred.promise; + }, + +#ifdef XP_WIN + /** + * Checks whether downloaded files should be marked as coming from + * Internet Zone. + * + * @return true if files should be marked + */ + _shouldSaveZoneInformation() { + let key = Cc["@mozilla.org/windows-registry-key;1"] + .createInstance(Ci.nsIWindowsRegKey); + try { + key.open(Ci.nsIWindowsRegKey.ROOT_KEY_CURRENT_USER, + "Software\\Microsoft\\Windows\\CurrentVersion\\Policies\\Attachments", + Ci.nsIWindowsRegKey.ACCESS_QUERY_VALUE); + try { + return key.readIntValue("SaveZoneInformation") != 1; + } finally { + key.close(); + } + } catch (ex) { + // If the key is not present, files should be marked by default. + return true; + } + }, +#endif + + /** + * Performs platform-specific operations when a download is done. + * + * aParam aDownload + * The Download object. + * + * @return {Promise} + * @resolves When all the operations completed successfully. + * @rejects JavaScript exception if any of the operations failed. + */ + downloadDone: Task.async(function* (aDownload) { +#ifdef XP_WIN + // On Windows, we mark any file saved to the NTFS file system as coming + // from the Internet security zone unless Group Policy disables the + // feature. We do this by writing to the "Zone.Identifier" Alternate + // Data Stream directly, because the Save method of the + // IAttachmentExecute interface would trigger operations that may cause + // the application to hang, or other performance issues. + // The stream created in this way is forward-compatible with all the + // current and future versions of Windows. + if (this._shouldSaveZoneInformation()) { + let zone; + try { + zone = gDownloadPlatform.mapUrlToZone(aDownload.source.url); + } catch (e) { + // Default to Internet Zone if mapUrlToZone failed for + // whatever reason. + zone = Ci.mozIDownloadPlatform.ZONE_INTERNET; + } + try { + // Don't write zone IDs for Local, Intranet, or Trusted sites + // to match Windows behavior. + if (zone >= Ci.mozIDownloadPlatform.ZONE_INTERNET) { + let streamPath = aDownload.target.path + ":Zone.Identifier"; + let stream = yield OS.File.open( + streamPath, + { create: true }, + { winAllowLengthBeyondMaxPathWithCaveats: true } + ); + try { + yield stream.write(new TextEncoder().encode("[ZoneTransfer]\r\nZoneId=" + zone + "\r\n")); + } finally { + yield stream.close(); + } + } + } catch (ex) { + // If writing to the stream fails, we ignore the error and continue. + // The Windows API error 123 (ERROR_INVALID_NAME) is expected to + // occur when working on a file system that does not support + // Alternate Data Streams, like FAT32, thus we don't report this + // specific error. + if (!(ex instanceof OS.File.Error) || ex.winLastError != 123) { + Cu.reportError(ex); + } + } + } +#endif + + // The file with the partially downloaded data has restrictive permissions + // that don't allow other users on the system to access it. Now that the + // download is completed, we need to adjust permissions based on whether + // this is a permanently downloaded file or a temporary download to be + // opened read-only with an external application. + try { + // The following logic to determine whether this is a temporary download + // is due to the fact that "deleteTempFileOnExit" is false on Mac, where + // downloads to be opened with external applications are preserved in + // the "Downloads" folder like normal downloads. + let isTemporaryDownload = + aDownload.launchWhenSucceeded && (aDownload.source.isPrivate || + Services.prefs.getBoolPref("browser.helperApps.deleteTempFileOnExit")); + // Permanently downloaded files are made accessible by other users on + // this system, while temporary downloads are marked as read-only. + let options = {}; + if (isTemporaryDownload) { + options.unixMode = 0o400; + options.winAttributes = {readOnly: true}; + } else { + options.unixMode = 0o666; + } + // On Unix, the umask of the process is respected. + yield OS.File.setPermissions(aDownload.target.path, options); + } catch (ex) { + // We should report errors with making the permissions less restrictive + // or marking the file as read-only on Unix and Mac, but this should not + // prevent the download from completing. + // The setPermissions API error EPERM is expected to occur when working + // on a file system that does not support file permissions, like FAT32, + // thus we don't report this error. + if (!(ex instanceof OS.File.Error) || ex.unixErrno != OS.Constants.libc.EPERM) { + Cu.reportError(ex); + } + } + + let aReferrer = null; + if (aDownload.source.referrer) { + aReferrer = NetUtil.newURI(aDownload.source.referrer); + } + + gDownloadPlatform.downloadDone(NetUtil.newURI(aDownload.source.url), + aReferrer, + new FileUtils.File(aDownload.target.path), + aDownload.contentType, + aDownload.source.isPrivate); + }), + + /** + * Launches a file represented by the target of a download. This can + * open the file with the default application for the target MIME type + * or file extension, or with a custom application if + * aDownload.launcherPath is set. + * + * @param aDownload + * A Download object that contains the necessary information + * to launch the file. The relevant properties are: the target + * file, the contentType and the custom application chosen + * to launch it. + * + * @return {Promise} + * @resolves When the instruction to launch the file has been + * successfully given to the operating system. Note that + * the OS might still take a while until the file is actually + * launched. + * @rejects JavaScript exception if there was an error trying to launch + * the file. + */ + launchDownload: Task.async(function* (aDownload) { + let file = new FileUtils.File(aDownload.target.path); + +#ifndef XP_WIN + // Ask for confirmation if the file is executable, except on Windows where + // the operating system will show the prompt based on the security zone. + // We do this here, instead of letting the caller handle the prompt + // separately in the user interface layer, for two reasons. The first is + // because of its security nature, so that add-ons cannot forget to do + // this check. The second is that the system-level security prompt would + // be displayed at launch time in any case. + if (file.isExecutable() && + !(yield this.confirmLaunchExecutable(file.path))) { + return; + } +#endif + + // In case of a double extension, like ".tar.gz", we only + // consider the last one, because the MIME service cannot + // handle multiple extensions. + let fileExtension = null, mimeInfo = null; + let match = file.leafName.match(/\.([^.]+)$/); + if (match) { + fileExtension = match[1]; + } + + try { + // The MIME service might throw if contentType == "" and it can't find + // a MIME type for the given extension, so we'll treat this case as + // an unknown mimetype. + mimeInfo = gMIMEService.getFromTypeAndExtension(aDownload.contentType, + fileExtension); + } catch (e) { } + + if (aDownload.launcherPath) { + if (!mimeInfo) { + // This should not happen on normal circumstances because launcherPath + // is only set when we had an instance of nsIMIMEInfo to retrieve + // the custom application chosen by the user. + throw new Error( + "Unable to create nsIMIMEInfo to launch a custom application"); + } + + // Custom application chosen + let localHandlerApp = Cc["@mozilla.org/uriloader/local-handler-app;1"] + .createInstance(Ci.nsILocalHandlerApp); + localHandlerApp.executable = new FileUtils.File(aDownload.launcherPath); + + mimeInfo.preferredApplicationHandler = localHandlerApp; + mimeInfo.preferredAction = Ci.nsIMIMEInfo.useHelperApp; + + this.launchFile(file, mimeInfo); + return; + } + + // No custom application chosen, let's launch the file with the default + // handler. First, let's try to launch it through the MIME service. + if (mimeInfo) { + mimeInfo.preferredAction = Ci.nsIMIMEInfo.useSystemDefault; + + try { + this.launchFile(file, mimeInfo); + return; + } catch (ex) { } + } + + // If it didn't work or if there was no MIME info available, + // let's try to directly launch the file. + try { + this.launchFile(file); + return; + } catch (ex) { } + + // If our previous attempts failed, try sending it through + // the system's external "file:" URL handler. + gExternalProtocolService.loadUrl(NetUtil.newURI(file)); + }), + + /** + * Asks for confirmation for launching the specified executable file. This + * can be overridden by regression tests to avoid the interactive prompt. + */ + confirmLaunchExecutable: Task.async(function* (path) { + // We don't anchor the prompt to a specific window intentionally, not + // only because this is the same behavior as the system-level prompt, + // but also because the most recently active window is the right choice + // in basically all cases. + return yield DownloadUIHelper.getPrompter().confirmLaunchExecutable(path); + }), + + /** + * Launches the specified file, unless overridden by regression tests. + */ + launchFile(file, mimeInfo) { + if (mimeInfo) { + mimeInfo.launchWithFile(file); + } else { + file.launch(); + } + }, + + /** + * Shows the containing folder of a file. + * + * @param aFilePath + * The path to the file. + * + * @return {Promise} + * @resolves When the instruction to open the containing folder has been + * successfully given to the operating system. Note that + * the OS might still take a while until the folder is actually + * opened. + * @rejects JavaScript exception if there was an error trying to open + * the containing folder. + */ + showContainingDirectory: Task.async(function* (aFilePath) { + let file = new FileUtils.File(aFilePath); + + try { + // Show the directory containing the file and select the file. + file.reveal(); + return; + } catch (ex) { } + + // If reveal fails for some reason (e.g., it's not implemented on unix + // or the file doesn't exist), try using the parent if we have it. + let parent = file.parent; + if (!parent) { + throw new Error( + "Unexpected reference to a top-level directory instead of a file"); + } + + try { + // Open the parent directory to show where the file should be. + parent.launch(); + return; + } catch (ex) { } + + // If launch also fails (probably because it's not implemented), let + // the OS handler try to open the parent. + gExternalProtocolService.loadUrl(NetUtil.newURI(parent)); + }), + + /** + * Calls the directory service, create a downloads directory and returns an + * nsIFile for the downloads directory. + * + * @return {Promise} + * @resolves The directory string path. + */ + _createDownloadsDirectory(aName) { + // We read the name of the directory from the list of translated strings + // that is kept by the UI helper module, even if this string is not strictly + // displayed in the user interface. + let directoryPath = OS.Path.join(this._getDirectory(aName), + DownloadUIHelper.strings.downloadsFolder); + + // Create the Downloads folder and ignore if it already exists. + return OS.File.makeDir(directoryPath, { ignoreExisting: true }) + .then(() => directoryPath); + }, + + /** + * Returns the string path for the given directory service location name. This + * can be overridden by regression tests to return the path of the system + * temporary directory in all cases. + */ + _getDirectory(name) { + return Services.dirsvc.get(name, Ci.nsIFile).path; + }, + + /** + * Register the downloads interruption observers. + * + * @param aList + * The public or private downloads list. + * @param aIsPrivate + * True if the list is private, false otherwise. + * + * @return {Promise} + * @resolves When the views and observers are added. + */ + addListObservers(aList, aIsPrivate) { + DownloadObserver.registerView(aList, aIsPrivate); + if (!DownloadObserver.observersAdded) { + DownloadObserver.observersAdded = true; + for (let topic of kObserverTopics) { + Services.obs.addObserver(DownloadObserver, topic, false); + } + } + return Promise.resolve(); + }, + + /** + * Force a save on _store if it exists. Used to ensure downloads do not + * persist after being sanitized on Android. + * + * @return {Promise} + * @resolves When _store.save() completes. + */ + forceSave() { + if (this._store) { + return this._store.save(); + } + return Promise.resolve(); + }, + + /** + * Checks if we have already imported (or attempted to import) + * the downloads database from the previous SQLite storage. + * + * @return boolean True if we the previous DB was imported. + */ + get _importedFromSqlite() { + try { + return Services.prefs.getBoolPref(kPrefImportedFromSqlite); + } catch (ex) { + return false; + } + }, +}; + +//////////////////////////////////////////////////////////////////////////////// +//// DownloadObserver + +this.DownloadObserver = { + /** + * Flag to determine if the observers have been added previously. + */ + observersAdded: false, + + /** + * Timer used to delay restarting canceled downloads upon waking and returning + * online. + */ + _wakeTimer: null, + + /** + * Set that contains the in progress publics downloads. + * It's kept updated when a public download is added, removed or changes its + * properties. + */ + _publicInProgressDownloads: new Set(), + + /** + * Set that contains the in progress private downloads. + * It's kept updated when a private download is added, removed or changes its + * properties. + */ + _privateInProgressDownloads: new Set(), + + /** + * Set that contains the downloads that have been canceled when going offline + * or to sleep. These are started again when returning online or waking. This + * list is not persisted so when exiting and restarting, the downloads will not + * be started again. + */ + _canceledOfflineDownloads: new Set(), + + /** + * Registers a view that updates the corresponding downloads state set, based + * on the aIsPrivate argument. The set is updated when a download is added, + * removed or changes its properties. + * + * @param aList + * The public or private downloads list. + * @param aIsPrivate + * True if the list is private, false otherwise. + */ + registerView: function DO_registerView(aList, aIsPrivate) { + let downloadsSet = aIsPrivate ? this._privateInProgressDownloads + : this._publicInProgressDownloads; + let downloadsView = { + onDownloadAdded: aDownload => { + if (!aDownload.stopped) { + downloadsSet.add(aDownload); + } + }, + onDownloadChanged: aDownload => { + if (aDownload.stopped) { + downloadsSet.delete(aDownload); + } else { + downloadsSet.add(aDownload); + } + }, + onDownloadRemoved: aDownload => { + downloadsSet.delete(aDownload); + // The download must also be removed from the canceled when offline set. + this._canceledOfflineDownloads.delete(aDownload); + } + }; + + // We register the view asynchronously. + aList.addView(downloadsView).then(null, Cu.reportError); + }, + + /** + * Wrapper that handles the test mode before calling the prompt that display + * a warning message box that informs that there are active downloads, + * and asks whether the user wants to cancel them or not. + * + * @param aCancel + * The observer notification subject. + * @param aDownloadsCount + * The current downloads count. + * @param aPrompter + * The prompter object that shows the confirm dialog. + * @param aPromptType + * The type of prompt notification depending on the observer. + */ + _confirmCancelDownloads: function DO_confirmCancelDownload( + aCancel, aDownloadsCount, aPrompter, aPromptType) { + // If user has already dismissed the request, then do nothing. + if ((aCancel instanceof Ci.nsISupportsPRBool) && aCancel.data) { + return; + } + // Handle test mode + if (gCombinedDownloadIntegration._testPromptDownloads) { + gCombinedDownloadIntegration._testPromptDownloads = aDownloadsCount; + return; + } + + aCancel.data = aPrompter.confirmCancelDownloads(aDownloadsCount, aPromptType); + }, + + /** + * Resume all downloads that were paused when going offline, used when waking + * from sleep or returning from being offline. + */ + _resumeOfflineDownloads: function DO_resumeOfflineDownloads() { + this._wakeTimer = null; + + for (let download of this._canceledOfflineDownloads) { + download.start().catch(() => {}); + } + }, + + //////////////////////////////////////////////////////////////////////////// + //// nsIObserver + + observe: function DO_observe(aSubject, aTopic, aData) { + let downloadsCount; + let p = DownloadUIHelper.getPrompter(); + switch (aTopic) { + case "quit-application-requested": + downloadsCount = this._publicInProgressDownloads.size + + this._privateInProgressDownloads.size; + this._confirmCancelDownloads(aSubject, downloadsCount, p, p.ON_QUIT); + break; + case "offline-requested": + downloadsCount = this._publicInProgressDownloads.size + + this._privateInProgressDownloads.size; + this._confirmCancelDownloads(aSubject, downloadsCount, p, p.ON_OFFLINE); + break; + case "last-pb-context-exiting": + downloadsCount = this._privateInProgressDownloads.size; + this._confirmCancelDownloads(aSubject, downloadsCount, p, + p.ON_LEAVE_PRIVATE_BROWSING); + break; + case "last-pb-context-exited": + let promise = Task.spawn(function() { + let list = yield Downloads.getList(Downloads.PRIVATE); + let downloads = yield list.getAll(); + + // We can remove the downloads and finalize them in parallel. + for (let download of downloads) { + list.remove(download).then(null, Cu.reportError); + download.finalize(true).then(null, Cu.reportError); + } + }); + // Handle test mode + if (gCombinedDownloadIntegration._testResolveClearPrivateList) { + gCombinedDownloadIntegration._testResolveClearPrivateList(promise); + } else { + promise.catch(ex => Cu.reportError(ex)); + } + break; + case "sleep_notification": + case "suspend_process_notification": + case "network:offline-about-to-go-offline": + for (let download of this._publicInProgressDownloads) { + download.cancel(); + this._canceledOfflineDownloads.add(download); + } + for (let download of this._privateInProgressDownloads) { + download.cancel(); + this._canceledOfflineDownloads.add(download); + } + break; + case "wake_notification": + case "resume_process_notification": + let wakeDelay = 10000; + try { + wakeDelay = Services.prefs.getIntPref("browser.download.manager.resumeOnWakeDelay"); + } catch(e) {} + + if (wakeDelay >= 0) { + this._wakeTimer = new Timer(this._resumeOfflineDownloads.bind(this), wakeDelay, + Ci.nsITimer.TYPE_ONE_SHOT); + } + break; + case "network:offline-status-changed": + if (aData == "online") { + this._resumeOfflineDownloads(); + } + break; + // We need to unregister observers explicitly before we reach the + // "xpcom-shutdown" phase, otherwise observers may be notified when some + // required services are not available anymore. We can't unregister + // observers on "quit-application", because this module is also loaded + // during "make package" automation, and the quit notification is not sent + // in that execution environment (bug 973637). + case "xpcom-will-shutdown": + for (let topic of kObserverTopics) { + Services.obs.removeObserver(this, topic); + } + break; + } + }, + + //////////////////////////////////////////////////////////////////////////// + //// nsISupports + + QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver]) +}; + +//////////////////////////////////////////////////////////////////////////////// +//// DownloadHistoryObserver + +#ifdef MOZ_PLACES +/** + * Registers a Places observer so that operations on download history are + * reflected on the provided list of downloads. + * + * You do not need to keep a reference to this object in order to keep it alive, + * because the history service already keeps a strong reference to it. + * + * @param aList + * DownloadList object linked to this observer. + */ +this.DownloadHistoryObserver = function (aList) +{ + this._list = aList; + PlacesUtils.history.addObserver(this, false); +} + +this.DownloadHistoryObserver.prototype = { + /** + * DownloadList object linked to this observer. + */ + _list: null, + + //////////////////////////////////////////////////////////////////////////// + //// nsISupports + + QueryInterface: XPCOMUtils.generateQI([Ci.nsINavHistoryObserver]), + + //////////////////////////////////////////////////////////////////////////// + //// nsINavHistoryObserver + + onDeleteURI: function DL_onDeleteURI(aURI, aGUID) { + this._list.removeFinished(download => aURI.equals(NetUtil.newURI( + download.source.url))); + }, + + onClearHistory: function DL_onClearHistory() { + this._list.removeFinished(); + }, + + onTitleChanged: function () {}, + onBeginUpdateBatch: function () {}, + onEndUpdateBatch: function () {}, + onVisit: function () {}, + onPageChanged: function () {}, + onDeleteVisits: function () {}, +}; +#else +/** + * Empty implementation when we have no Places support, for example on B2G. + */ +this.DownloadHistoryObserver = function (aList) {} +#endif + +//////////////////////////////////////////////////////////////////////////////// +//// DownloadAutoSaveView + +/** + * This view can be added to a DownloadList object to trigger a save operation + * in the given DownloadStore object when a relevant change occurs. You should + * call the "initialize" method in order to register the view and load the + * current state from disk. + * + * You do not need to keep a reference to this object in order to keep it alive, + * because the DownloadList object already keeps a strong reference to it. + * + * @param aList + * The DownloadList object on which the view should be registered. + * @param aStore + * The DownloadStore object used for saving. + */ +this.DownloadAutoSaveView = function (aList, aStore) +{ + this._list = aList; + this._store = aStore; + this._downloadsMap = new Map(); + this._writer = new DeferredTask(() => this._store.save(), kSaveDelayMs); + AsyncShutdown.profileBeforeChange.addBlocker("DownloadAutoSaveView: writing data", + () => this._writer.finalize()); +} + +this.DownloadAutoSaveView.prototype = { + /** + * DownloadList object linked to this view. + */ + _list: null, + + /** + * The DownloadStore object used for saving. + */ + _store: null, + + /** + * True when the initial state of the downloads has been loaded. + */ + _initialized: false, + + /** + * Registers the view and loads the current state from disk. + * + * @return {Promise} + * @resolves When the view has been registered. + * @rejects JavaScript exception. + */ + initialize: function () + { + // We set _initialized to true after adding the view, so that + // onDownloadAdded doesn't cause a save to occur. + return this._list.addView(this).then(() => this._initialized = true); + }, + + /** + * This map contains only Download objects that should be saved to disk, and + * associates them with the result of their getSerializationHash function, for + * the purpose of detecting changes to the relevant properties. + */ + _downloadsMap: null, + + /** + * DeferredTask for the save operation. + */ + _writer: null, + + /** + * Called when the list of downloads changed, this triggers the asynchronous + * serialization of the list of downloads. + */ + saveSoon: function () + { + this._writer.arm(); + }, + + ////////////////////////////////////////////////////////////////////////////// + //// DownloadList view + + onDownloadAdded: function (aDownload) + { + if (gCombinedDownloadIntegration.shouldPersistDownload(aDownload)) { + this._downloadsMap.set(aDownload, aDownload.getSerializationHash()); + if (this._initialized) { + this.saveSoon(); + } + } + }, + + onDownloadChanged: function (aDownload) + { + if (!gCombinedDownloadIntegration.shouldPersistDownload(aDownload)) { + if (this._downloadsMap.has(aDownload)) { + this._downloadsMap.delete(aDownload); + this.saveSoon(); + } + return; + } + + let hash = aDownload.getSerializationHash(); + if (this._downloadsMap.get(aDownload) != hash) { + this._downloadsMap.set(aDownload, hash); + this.saveSoon(); + } + }, + + onDownloadRemoved: function (aDownload) + { + if (this._downloadsMap.has(aDownload)) { + this._downloadsMap.delete(aDownload); + this.saveSoon(); + } + }, +}; diff --git a/toolkit/components/jsdownloads/src/DownloadLegacy.js b/toolkit/components/jsdownloads/src/DownloadLegacy.js new file mode 100644 index 000000000..fc9fb35d2 --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadLegacy.js @@ -0,0 +1,309 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* 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/. */ + +/** + * This component implements the XPCOM interfaces required for integration with + * the legacy download components. + * + * New code is expected to use the "Downloads.jsm" module directly, without + * going through the interfaces implemented in this XPCOM component. These + * interfaces are only maintained for backwards compatibility with components + * that still work synchronously on the main thread. + */ + +"use strict"; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "Downloads", + "resource://gre/modules/Downloads.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); + +// DownloadLegacyTransfer + +/** + * nsITransfer implementation that provides a bridge to a Download object. + * + * Legacy downloads work differently than the JavaScript implementation. In the + * latter, the caller only provides the properties for the Download object and + * the entire process is handled by the "start" method. In the legacy + * implementation, the caller must create a separate object to execute the + * download, and then make the download visible to the user by hooking it up to + * an nsITransfer instance. + * + * Since nsITransfer instances may be created before the download system is + * initialized, and initialization as well as other operations are asynchronous, + * this implementation is able to delay all progress and status notifications it + * receives until the associated Download object is finally created. + * + * Conversely, the DownloadLegacySaver object can also receive execution and + * cancellation requests asynchronously, before or after it is connected to + * this nsITransfer instance. For that reason, those requests are communicated + * in a potentially deferred way, using promise objects. + * + * The component that executes the download implements nsICancelable to receive + * cancellation requests, but after cancellation it cannot be reused again. + * + * Since the components that execute the download may be different and they + * don't always give consistent results, this bridge takes care of enforcing the + * expectations, for example by ensuring the target file exists when the + * download is successful, even if the source has a size of zero bytes. + */ +function DownloadLegacyTransfer() +{ + this._deferDownload = Promise.defer(); +} + +DownloadLegacyTransfer.prototype = { + classID: Components.ID("{1b4c85df-cbdd-4bb6-b04e-613caece083c}"), + + // nsISupports + + QueryInterface: XPCOMUtils.generateQI([Ci.nsIWebProgressListener, + Ci.nsIWebProgressListener2, + Ci.nsITransfer]), + + // nsIWebProgressListener + + onStateChange: function DLT_onStateChange(aWebProgress, aRequest, aStateFlags, + aStatus) + { + if (!Components.isSuccessCode(aStatus)) { + this._componentFailed = true; + } + + if ((aStateFlags & Ci.nsIWebProgressListener.STATE_START) && + (aStateFlags & Ci.nsIWebProgressListener.STATE_IS_NETWORK)) { + + let blockedByParentalControls = false; + // If it is a failed download, aRequest.responseStatus doesn't exist. + // (missing file on the server, network failure to download) + try { + // If the request's response has been blocked by Windows Parental Controls + // with an HTTP 450 error code, we must cancel the request synchronously. + blockedByParentalControls = aRequest instanceof Ci.nsIHttpChannel && + aRequest.responseStatus == 450; + } catch (e) { + if (e.result == Cr.NS_ERROR_NOT_AVAILABLE) { + aRequest.cancel(Cr.NS_BINDING_ABORTED); + } + } + + if (blockedByParentalControls) { + aRequest.cancel(Cr.NS_BINDING_ABORTED); + } + + // The main request has just started. Wait for the associated Download + // object to be available before notifying. + this._deferDownload.promise.then(download => { + // If the request was blocked, now that we have the download object we + // should set a flag that can be retrieved later when handling the + // cancellation so that the proper error can be thrown. + if (blockedByParentalControls) { + download._blockedByParentalControls = true; + } + + download.saver.onTransferStarted( + aRequest, + this._cancelable instanceof Ci.nsIHelperAppLauncher); + + // To handle asynchronous cancellation properly, we should hook up the + // handler only after we have been notified that the main request + // started. We will wait until the main request stopped before + // notifying that the download has been canceled. Since the request has + // not completed yet, deferCanceled is guaranteed to be set. + return download.saver.deferCanceled.promise.then(() => { + // Only cancel if the object executing the download is still running. + if (this._cancelable && !this._componentFailed) { + this._cancelable.cancel(Cr.NS_ERROR_ABORT); + if (this._cancelable instanceof Ci.nsIWebBrowserPersist) { + // This component will not send the STATE_STOP notification. + download.saver.onTransferFinished(aRequest, Cr.NS_ERROR_ABORT); + this._cancelable = null; + } + } + }); + }).then(null, Cu.reportError); + } else if ((aStateFlags & Ci.nsIWebProgressListener.STATE_STOP) && + (aStateFlags & Ci.nsIWebProgressListener.STATE_IS_NETWORK)) { + // The last file has been received, or the download failed. Wait for the + // associated Download object to be available before notifying. + this._deferDownload.promise.then(download => { + // At this point, the hash has been set and we need to copy it to the + // DownloadSaver. + if (Components.isSuccessCode(aStatus)) { + download.saver.setSha256Hash(this._sha256Hash); + download.saver.setSignatureInfo(this._signatureInfo); + download.saver.setRedirects(this._redirects); + } + download.saver.onTransferFinished(aRequest, aStatus); + }).then(null, Cu.reportError); + + // Release the reference to the component executing the download. + this._cancelable = null; + } + }, + + onProgressChange: function DLT_onProgressChange(aWebProgress, aRequest, + aCurSelfProgress, + aMaxSelfProgress, + aCurTotalProgress, + aMaxTotalProgress) + { + this.onProgressChange64(aWebProgress, aRequest, aCurSelfProgress, + aMaxSelfProgress, aCurTotalProgress, + aMaxTotalProgress); + }, + + onLocationChange: function () { }, + + onStatusChange: function DLT_onStatusChange(aWebProgress, aRequest, aStatus, + aMessage) + { + // The status change may optionally be received in addition to the state + // change, but if no network request actually started, it is possible that + // we only receive a status change with an error status code. + if (!Components.isSuccessCode(aStatus)) { + this._componentFailed = true; + + // Wait for the associated Download object to be available. + this._deferDownload.promise.then(function DLT_OSC_onDownload(aDownload) { + aDownload.saver.onTransferFinished(aRequest, aStatus); + }).then(null, Cu.reportError); + } + }, + + onSecurityChange: function () { }, + + // nsIWebProgressListener2 + + onProgressChange64: function DLT_onProgressChange64(aWebProgress, aRequest, + aCurSelfProgress, + aMaxSelfProgress, + aCurTotalProgress, + aMaxTotalProgress) + { + // Wait for the associated Download object to be available. + this._deferDownload.promise.then(function DLT_OPC64_onDownload(aDownload) { + aDownload.saver.onProgressBytes(aCurTotalProgress, aMaxTotalProgress); + }).then(null, Cu.reportError); + }, + + onRefreshAttempted: function DLT_onRefreshAttempted(aWebProgress, aRefreshURI, + aMillis, aSameURI) + { + // Indicate that refreshes and redirects are allowed by default. However, + // note that download components don't usually call this method at all. + return true; + }, + + // nsITransfer + + init: function DLT_init(aSource, aTarget, aDisplayName, aMIMEInfo, aStartTime, + aTempFile, aCancelable, aIsPrivate) + { + this._cancelable = aCancelable; + + let launchWhenSucceeded = false, contentType = null, launcherPath = null; + + if (aMIMEInfo instanceof Ci.nsIMIMEInfo) { + launchWhenSucceeded = + aMIMEInfo.preferredAction != Ci.nsIMIMEInfo.saveToDisk; + contentType = aMIMEInfo.type; + + let appHandler = aMIMEInfo.preferredApplicationHandler; + if (aMIMEInfo.preferredAction == Ci.nsIMIMEInfo.useHelperApp && + appHandler instanceof Ci.nsILocalHandlerApp) { + launcherPath = appHandler.executable.path; + } + } + + // Create a new Download object associated to a DownloadLegacySaver, and + // wait for it to be available. This operation may cause the entire + // download system to initialize before the object is created. + Downloads.createDownload({ + source: { url: aSource.spec, isPrivate: aIsPrivate }, + target: { path: aTarget.QueryInterface(Ci.nsIFileURL).file.path, + partFilePath: aTempFile && aTempFile.path }, + saver: "legacy", + launchWhenSucceeded: launchWhenSucceeded, + contentType: contentType, + launcherPath: launcherPath + }).then(function DLT_I_onDownload(aDownload) { + // Legacy components keep partial data when they use a ".part" file. + if (aTempFile) { + aDownload.tryToKeepPartialData = true; + } + + // Start the download before allowing it to be controlled. Ignore errors. + aDownload.start().catch(() => {}); + + // Start processing all the other events received through nsITransfer. + this._deferDownload.resolve(aDownload); + + // Add the download to the list, allowing it to be seen and canceled. + return Downloads.getList(Downloads.ALL).then(list => list.add(aDownload)); + }.bind(this)).then(null, Cu.reportError); + }, + + setSha256Hash: function (hash) + { + this._sha256Hash = hash; + }, + + setSignatureInfo: function (signatureInfo) + { + this._signatureInfo = signatureInfo; + }, + + setRedirects: function (redirects) + { + this._redirects = redirects; + }, + + // Private methods and properties + + /** + * This deferred object contains a promise that is resolved with the Download + * object associated with this nsITransfer instance, when it is available. + */ + _deferDownload: null, + + /** + * Reference to the component that is executing the download. This component + * allows cancellation through its nsICancelable interface. + */ + _cancelable: null, + + /** + * Indicates that the component that executes the download has notified a + * failure condition. In this case, we should never use the component methods + * that cancel the download. + */ + _componentFailed: false, + + /** + * Save the SHA-256 hash in raw bytes of the downloaded file. + */ + _sha256Hash: null, + + /** + * Save the signature info in a serialized protobuf of the downloaded file. + */ + _signatureInfo: null, +}; + +// Module + +this.NSGetFactory = XPCOMUtils.generateNSGetFactory([DownloadLegacyTransfer]); diff --git a/toolkit/components/jsdownloads/src/DownloadList.jsm b/toolkit/components/jsdownloads/src/DownloadList.jsm new file mode 100644 index 000000000..f725bd3de --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadList.jsm @@ -0,0 +1,559 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +/** + * This file includes the following constructors and global objects: + * + * DownloadList + * Represents a collection of Download objects that can be viewed and managed by + * the user interface, and persisted across sessions. + * + * DownloadCombinedList + * Provides a unified, unordered list combining public and private downloads. + * + * DownloadSummary + * Provides an aggregated view on the contents of a DownloadList. + */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "DownloadList", + "DownloadCombinedList", + "DownloadSummary", +]; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); + +// DownloadList + +/** + * Represents a collection of Download objects that can be viewed and managed by + * the user interface, and persisted across sessions. + */ +this.DownloadList = function () +{ + this._downloads = []; + this._views = new Set(); +} + +this.DownloadList.prototype = { + /** + * Array of Download objects currently in the list. + */ + _downloads: null, + + /** + * Retrieves a snapshot of the downloads that are currently in the list. The + * returned array does not change when downloads are added or removed, though + * the Download objects it contains are still updated in real time. + * + * @return {Promise} + * @resolves An array of Download objects. + * @rejects JavaScript exception. + */ + getAll: function DL_getAll() { + return Promise.resolve(Array.slice(this._downloads, 0)); + }, + + /** + * Adds a new download to the end of the items list. + * + * @note When a download is added to the list, its "onchange" event is + * registered by the list, thus it cannot be used to monitor the + * download. To receive change notifications for downloads that are + * added to the list, use the addView method to register for + * onDownloadChanged notifications. + * + * @param aDownload + * The Download object to add. + * + * @return {Promise} + * @resolves When the download has been added. + * @rejects JavaScript exception. + */ + add: function DL_add(aDownload) { + this._downloads.push(aDownload); + aDownload.onchange = this._change.bind(this, aDownload); + this._notifyAllViews("onDownloadAdded", aDownload); + + return Promise.resolve(); + }, + + /** + * Removes a download from the list. If the download was already removed, + * this method has no effect. + * + * This method does not change the state of the download, to allow adding it + * to another list, or control it directly. If you want to dispose of the + * download object, you should cancel it afterwards, and remove any partially + * downloaded data if needed. + * + * @param aDownload + * The Download object to remove. + * + * @return {Promise} + * @resolves When the download has been removed. + * @rejects JavaScript exception. + */ + remove: function DL_remove(aDownload) { + let index = this._downloads.indexOf(aDownload); + if (index != -1) { + this._downloads.splice(index, 1); + aDownload.onchange = null; + this._notifyAllViews("onDownloadRemoved", aDownload); + } + + return Promise.resolve(); + }, + + /** + * This function is called when "onchange" events of downloads occur. + * + * @param aDownload + * The Download object that changed. + */ + _change: function DL_change(aDownload) { + this._notifyAllViews("onDownloadChanged", aDownload); + }, + + /** + * Set of currently registered views. + */ + _views: null, + + /** + * Adds a view that will be notified of changes to downloads. The newly added + * view will receive onDownloadAdded notifications for all the downloads that + * are already in the list. + * + * @param aView + * The view object to add. The following methods may be defined: + * { + * onDownloadAdded: function (aDownload) { + * // Called after aDownload is added to the end of the list. + * }, + * onDownloadChanged: function (aDownload) { + * // Called after the properties of aDownload change. + * }, + * onDownloadRemoved: function (aDownload) { + * // Called after aDownload is removed from the list. + * }, + * } + * + * @return {Promise} + * @resolves When the view has been registered and all the onDownloadAdded + * notifications for the existing downloads have been sent. + * @rejects JavaScript exception. + */ + addView: function DL_addView(aView) + { + this._views.add(aView); + + if ("onDownloadAdded" in aView) { + for (let download of this._downloads) { + try { + aView.onDownloadAdded(download); + } catch (ex) { + Cu.reportError(ex); + } + } + } + + return Promise.resolve(); + }, + + /** + * Removes a view that was previously added using addView. + * + * @param aView + * The view object to remove. + * + * @return {Promise} + * @resolves When the view has been removed. At this point, the removed view + * will not receive any more notifications. + * @rejects JavaScript exception. + */ + removeView: function DL_removeView(aView) + { + this._views.delete(aView); + + return Promise.resolve(); + }, + + /** + * Notifies all the views of a download addition, change, or removal. + * + * @param aMethodName + * String containing the name of the method to call on the view. + * @param aDownload + * The Download object that changed. + */ + _notifyAllViews: function (aMethodName, aDownload) { + for (let view of this._views) { + try { + if (aMethodName in view) { + view[aMethodName](aDownload); + } + } catch (ex) { + Cu.reportError(ex); + } + } + }, + + /** + * Removes downloads from the list that have finished, have failed, or have + * been canceled without keeping partial data. A filter function may be + * specified to remove only a subset of those downloads. + * + * This method finalizes each removed download, ensuring that any partially + * downloaded data associated with it is also removed. + * + * @param aFilterFn + * The filter function is called with each download as its only + * argument, and should return true to remove the download and false + * to keep it. This parameter may be null or omitted to have no + * additional filter. + */ + removeFinished: function DL_removeFinished(aFilterFn) { + Task.spawn(function* () { + let list = yield this.getAll(); + for (let download of list) { + // Remove downloads that have been canceled, even if the cancellation + // operation hasn't completed yet so we don't check "stopped" here. + // Failed downloads with partial data are also removed. + if (download.stopped && (!download.hasPartialData || download.error) && + (!aFilterFn || aFilterFn(download))) { + // Remove the download first, so that the views don't get the change + // notifications that may occur during finalization. + yield this.remove(download); + // Ensure that the download is stopped and no partial data is kept. + // This works even if the download state has changed meanwhile. We + // don't need to wait for the procedure to be complete before + // processing the other downloads in the list. + download.finalize(true).then(null, Cu.reportError); + } + } + }.bind(this)).then(null, Cu.reportError); + }, +}; + +// DownloadCombinedList + +/** + * Provides a unified, unordered list combining public and private downloads. + * + * Download objects added to this list are also added to one of the two + * underlying lists, based on their "source.isPrivate" property. Views on this + * list will receive notifications for both public and private downloads. + * + * @param aPublicList + * Underlying DownloadList containing public downloads. + * @param aPrivateList + * Underlying DownloadList containing private downloads. + */ +this.DownloadCombinedList = function (aPublicList, aPrivateList) +{ + DownloadList.call(this); + this._publicList = aPublicList; + this._privateList = aPrivateList; + aPublicList.addView(this).then(null, Cu.reportError); + aPrivateList.addView(this).then(null, Cu.reportError); +} + +this.DownloadCombinedList.prototype = { + __proto__: DownloadList.prototype, + + /** + * Underlying DownloadList containing public downloads. + */ + _publicList: null, + + /** + * Underlying DownloadList containing private downloads. + */ + _privateList: null, + + /** + * Adds a new download to the end of the items list. + * + * @note When a download is added to the list, its "onchange" event is + * registered by the list, thus it cannot be used to monitor the + * download. To receive change notifications for downloads that are + * added to the list, use the addView method to register for + * onDownloadChanged notifications. + * + * @param aDownload + * The Download object to add. + * + * @return {Promise} + * @resolves When the download has been added. + * @rejects JavaScript exception. + */ + add: function (aDownload) + { + if (aDownload.source.isPrivate) { + return this._privateList.add(aDownload); + } + return this._publicList.add(aDownload); + }, + + /** + * Removes a download from the list. If the download was already removed, + * this method has no effect. + * + * This method does not change the state of the download, to allow adding it + * to another list, or control it directly. If you want to dispose of the + * download object, you should cancel it afterwards, and remove any partially + * downloaded data if needed. + * + * @param aDownload + * The Download object to remove. + * + * @return {Promise} + * @resolves When the download has been removed. + * @rejects JavaScript exception. + */ + remove: function (aDownload) + { + if (aDownload.source.isPrivate) { + return this._privateList.remove(aDownload); + } + return this._publicList.remove(aDownload); + }, + + // DownloadList view + + onDownloadAdded: function (aDownload) + { + this._downloads.push(aDownload); + this._notifyAllViews("onDownloadAdded", aDownload); + }, + + onDownloadChanged: function (aDownload) + { + this._notifyAllViews("onDownloadChanged", aDownload); + }, + + onDownloadRemoved: function (aDownload) + { + let index = this._downloads.indexOf(aDownload); + if (index != -1) { + this._downloads.splice(index, 1); + } + this._notifyAllViews("onDownloadRemoved", aDownload); + }, +}; + +// DownloadSummary + +/** + * Provides an aggregated view on the contents of a DownloadList. + */ +this.DownloadSummary = function () +{ + this._downloads = []; + this._views = new Set(); +} + +this.DownloadSummary.prototype = { + /** + * Array of Download objects that are currently part of the summary. + */ + _downloads: null, + + /** + * Underlying DownloadList whose contents should be summarized. + */ + _list: null, + + /** + * This method may be called once to bind this object to a DownloadList. + * + * Views on the summarized data can be registered before this object is bound + * to an actual list. This allows the summary to be used without requiring + * the initialization of the DownloadList first. + * + * @param aList + * Underlying DownloadList whose contents should be summarized. + * + * @return {Promise} + * @resolves When the view on the underlying list has been registered. + * @rejects JavaScript exception. + */ + bindToList: function (aList) + { + if (this._list) { + throw new Error("bindToList may be called only once."); + } + + return aList.addView(this).then(() => { + // Set the list reference only after addView has returned, so that we don't + // send a notification to our views for each download that is added. + this._list = aList; + this._onListChanged(); + }); + }, + + /** + * Set of currently registered views. + */ + _views: null, + + /** + * Adds a view that will be notified of changes to the summary. The newly + * added view will receive an initial onSummaryChanged notification. + * + * @param aView + * The view object to add. The following methods may be defined: + * { + * onSummaryChanged: function () { + * // Called after any property of the summary has changed. + * }, + * } + * + * @return {Promise} + * @resolves When the view has been registered and the onSummaryChanged + * notification has been sent. + * @rejects JavaScript exception. + */ + addView: function (aView) + { + this._views.add(aView); + + if ("onSummaryChanged" in aView) { + try { + aView.onSummaryChanged(); + } catch (ex) { + Cu.reportError(ex); + } + } + + return Promise.resolve(); + }, + + /** + * Removes a view that was previously added using addView. + * + * @param aView + * The view object to remove. + * + * @return {Promise} + * @resolves When the view has been removed. At this point, the removed view + * will not receive any more notifications. + * @rejects JavaScript exception. + */ + removeView: function (aView) + { + this._views.delete(aView); + + return Promise.resolve(); + }, + + /** + * Indicates whether all the downloads are currently stopped. + */ + allHaveStopped: true, + + /** + * Indicates the total number of bytes to be transferred before completing all + * the downloads that are currently in progress. + * + * For downloads that do not have a known final size, the number of bytes + * currently transferred is reported as part of this property. + * + * This is zero if no downloads are currently in progress. + */ + progressTotalBytes: 0, + + /** + * Number of bytes currently transferred as part of all the downloads that are + * currently in progress. + * + * This is zero if no downloads are currently in progress. + */ + progressCurrentBytes: 0, + + /** + * This function is called when any change in the list of downloads occurs, + * and will recalculate the summary and notify the views in case the + * aggregated properties are different. + */ + _onListChanged: function () { + let allHaveStopped = true; + let progressTotalBytes = 0; + let progressCurrentBytes = 0; + + // Recalculate the aggregated state. See the description of the individual + // properties for an explanation of the summarization logic. + for (let download of this._downloads) { + if (!download.stopped) { + allHaveStopped = false; + progressTotalBytes += download.hasProgress ? download.totalBytes + : download.currentBytes; + progressCurrentBytes += download.currentBytes; + } + } + + // Exit now if the properties did not change. + if (this.allHaveStopped == allHaveStopped && + this.progressTotalBytes == progressTotalBytes && + this.progressCurrentBytes == progressCurrentBytes) { + return; + } + + this.allHaveStopped = allHaveStopped; + this.progressTotalBytes = progressTotalBytes; + this.progressCurrentBytes = progressCurrentBytes; + + // Notify all the views that our properties changed. + for (let view of this._views) { + try { + if ("onSummaryChanged" in view) { + view.onSummaryChanged(); + } + } catch (ex) { + Cu.reportError(ex); + } + } + }, + + // DownloadList view + + onDownloadAdded: function (aDownload) + { + this._downloads.push(aDownload); + if (this._list) { + this._onListChanged(); + } + }, + + onDownloadChanged: function (aDownload) + { + this._onListChanged(); + }, + + onDownloadRemoved: function (aDownload) + { + let index = this._downloads.indexOf(aDownload); + if (index != -1) { + this._downloads.splice(index, 1); + } + this._onListChanged(); + }, +}; diff --git a/toolkit/components/jsdownloads/src/DownloadPlatform.cpp b/toolkit/components/jsdownloads/src/DownloadPlatform.cpp new file mode 100644 index 000000000..1506b7c30 --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadPlatform.cpp @@ -0,0 +1,275 @@ +/* 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/. */ + +#include "DownloadPlatform.h" +#include "nsAutoPtr.h" +#include "nsNetUtil.h" +#include "nsString.h" +#include "nsINestedURI.h" +#include "nsIProtocolHandler.h" +#include "nsIURI.h" +#include "nsIFile.h" +#include "nsIObserverService.h" +#include "nsISupportsPrimitives.h" +#include "nsDirectoryServiceDefs.h" + +#include "mozilla/Preferences.h" +#include "mozilla/Services.h" + +#define PREF_BDM_ADDTORECENTDOCS "browser.download.manager.addToRecentDocs" + +#ifdef XP_WIN +#include <shlobj.h> +#include <urlmon.h> +#include "nsILocalFileWin.h" +#endif + +#ifdef XP_MACOSX +#include <CoreFoundation/CoreFoundation.h> +#include "../../../../xpcom/io/CocoaFileUtils.h" +#endif + +#ifdef MOZ_WIDGET_ANDROID +#include "FennecJNIWrappers.h" +#endif + +#ifdef MOZ_WIDGET_GTK +#include <gtk/gtk.h> +#endif + +using namespace mozilla; + +DownloadPlatform *DownloadPlatform::gDownloadPlatformService = nullptr; + +NS_IMPL_ISUPPORTS(DownloadPlatform, mozIDownloadPlatform); + +DownloadPlatform* DownloadPlatform::GetDownloadPlatform() +{ + if (!gDownloadPlatformService) { + gDownloadPlatformService = new DownloadPlatform(); + } + + NS_ADDREF(gDownloadPlatformService); + +#if defined(MOZ_WIDGET_GTK) + g_type_init(); +#endif + + return gDownloadPlatformService; +} + +#ifdef MOZ_ENABLE_GIO +static void gio_set_metadata_done(GObject *source_obj, GAsyncResult *res, gpointer user_data) +{ + GError *err = nullptr; + g_file_set_attributes_finish(G_FILE(source_obj), res, nullptr, &err); + if (err) { +#ifdef DEBUG + NS_DebugBreak(NS_DEBUG_WARNING, "Set file metadata failed: ", err->message, __FILE__, __LINE__); +#endif + g_error_free(err); + } +} +#endif + +#ifdef XP_MACOSX +// Caller is responsible for freeing any result (CF Create Rule) +CFURLRef CreateCFURLFromNSIURI(nsIURI *aURI) { + nsAutoCString spec; + if (aURI) { + aURI->GetSpec(spec); + } + + CFStringRef urlStr = ::CFStringCreateWithCString(kCFAllocatorDefault, + spec.get(), + kCFStringEncodingUTF8); + if (!urlStr) { + return NULL; + } + + CFURLRef url = ::CFURLCreateWithString(kCFAllocatorDefault, + urlStr, + NULL); + + ::CFRelease(urlStr); + + return url; +} +#endif + +nsresult DownloadPlatform::DownloadDone(nsIURI* aSource, nsIURI* aReferrer, nsIFile* aTarget, + const nsACString& aContentType, bool aIsPrivate) +{ +#if defined(XP_WIN) || defined(XP_MACOSX) || defined(MOZ_WIDGET_ANDROID) \ + || defined(MOZ_WIDGET_GTK) || defined(MOZ_WIDGET_GONK) + + nsAutoString path; + if (aTarget && NS_SUCCEEDED(aTarget->GetPath(path))) { +#if defined(XP_WIN) || defined(MOZ_WIDGET_GTK) || defined(MOZ_WIDGET_ANDROID) + // On Windows and Gtk, add the download to the system's "recent documents" + // list, with a pref to disable. + { + bool addToRecentDocs = Preferences::GetBool(PREF_BDM_ADDTORECENTDOCS); +#ifdef MOZ_WIDGET_ANDROID + if (jni::IsFennec() && addToRecentDocs) { + java::DownloadsIntegration::ScanMedia(path, aContentType); + } +#else + if (addToRecentDocs && !aIsPrivate) { +#ifdef XP_WIN + ::SHAddToRecentDocs(SHARD_PATHW, path.get()); +#elif defined(MOZ_WIDGET_GTK) + GtkRecentManager* manager = gtk_recent_manager_get_default(); + + gchar* uri = g_filename_to_uri(NS_ConvertUTF16toUTF8(path).get(), + nullptr, nullptr); + if (uri) { + gtk_recent_manager_add_item(manager, uri); + g_free(uri); + } +#endif + } +#endif +#ifdef MOZ_ENABLE_GIO + // Use GIO to store the source URI for later display in the file manager. + GFile* gio_file = g_file_new_for_path(NS_ConvertUTF16toUTF8(path).get()); + nsCString source_uri; + nsresult rv = aSource->GetSpec(source_uri); + NS_ENSURE_SUCCESS(rv, rv); + GFileInfo *file_info = g_file_info_new(); + g_file_info_set_attribute_string(file_info, "metadata::download-uri", source_uri.get()); + g_file_set_attributes_async(gio_file, + file_info, + G_FILE_QUERY_INFO_NONE, + G_PRIORITY_DEFAULT, + nullptr, gio_set_metadata_done, nullptr); + g_object_unref(file_info); + g_object_unref(gio_file); +#endif + } +#endif + +#ifdef XP_MACOSX + // On OS X, make the downloads stack bounce. + CFStringRef observedObject = ::CFStringCreateWithCString(kCFAllocatorDefault, + NS_ConvertUTF16toUTF8(path).get(), + kCFStringEncodingUTF8); + CFNotificationCenterRef center = ::CFNotificationCenterGetDistributedCenter(); + ::CFNotificationCenterPostNotification(center, CFSTR("com.apple.DownloadFileFinished"), + observedObject, nullptr, TRUE); + ::CFRelease(observedObject); + + // Add OS X origin and referrer file metadata + CFStringRef pathCFStr = NULL; + if (!path.IsEmpty()) { + pathCFStr = ::CFStringCreateWithCharacters(kCFAllocatorDefault, + (const UniChar*)path.get(), + path.Length()); + } + if (pathCFStr) { + bool isFromWeb = IsURLPossiblyFromWeb(aSource); + + CFURLRef sourceCFURL = CreateCFURLFromNSIURI(aSource); + CFURLRef referrerCFURL = CreateCFURLFromNSIURI(aReferrer); + + CocoaFileUtils::AddOriginMetadataToFile(pathCFStr, + sourceCFURL, + referrerCFURL); + CocoaFileUtils::AddQuarantineMetadataToFile(pathCFStr, + sourceCFURL, + referrerCFURL, + isFromWeb); + + ::CFRelease(pathCFStr); + if (sourceCFURL) { + ::CFRelease(sourceCFURL); + } + if (referrerCFURL) { + ::CFRelease(referrerCFURL); + } + } +#endif + } + +#endif + + return NS_OK; +} + +nsresult DownloadPlatform::MapUrlToZone(const nsAString& aURL, + uint32_t* aZone) +{ +#ifdef XP_WIN + RefPtr<IInternetSecurityManager> inetSecMgr; + if (FAILED(CoCreateInstance(CLSID_InternetSecurityManager, NULL, + CLSCTX_ALL, IID_IInternetSecurityManager, + getter_AddRefs(inetSecMgr)))) { + return NS_ERROR_UNEXPECTED; + } + + DWORD zone; + if (inetSecMgr->MapUrlToZone(PromiseFlatString(aURL).get(), + &zone, 0) != S_OK) { + return NS_ERROR_UNEXPECTED; + } else { + *aZone = zone; + } + + return NS_OK; +#else + return NS_ERROR_NOT_IMPLEMENTED; +#endif +} + +// Check if a URI is likely to be web-based, by checking its URI flags. +// If in doubt (e.g. if anything fails during the check) claims things +// are from the web. +bool DownloadPlatform::IsURLPossiblyFromWeb(nsIURI* aURI) +{ + nsCOMPtr<nsIIOService> ios = do_GetIOService(); + nsCOMPtr<nsIURI> uri = aURI; + if (!ios) { + return true; + } + + while (uri) { + // We're not using nsIIOService::ProtocolHasFlags because it doesn't + // take per-URI flags into account. We're also not using + // NS_URIChainHasFlags because we're checking for *any* of 3 flags + // to be present on *all* of the nested URIs, which it can't do. + nsAutoCString scheme; + nsresult rv = uri->GetScheme(scheme); + if (NS_FAILED(rv)) { + return true; + } + nsCOMPtr<nsIProtocolHandler> ph; + rv = ios->GetProtocolHandler(scheme.get(), getter_AddRefs(ph)); + if (NS_FAILED(rv)) { + return true; + } + uint32_t flags; + rv = ph->DoGetProtocolFlags(uri, &flags); + if (NS_FAILED(rv)) { + return true; + } + // If not dangerous to load, not a UI resource and not a local file, + // assume this is from the web: + if (!(flags & nsIProtocolHandler::URI_DANGEROUS_TO_LOAD) && + !(flags & nsIProtocolHandler::URI_IS_UI_RESOURCE) && + !(flags & nsIProtocolHandler::URI_IS_LOCAL_FILE)) { + return true; + } + // Otherwise, check if the URI is nested, and if so go through + // the loop again: + nsCOMPtr<nsINestedURI> nestedURI = do_QueryInterface(uri); + uri = nullptr; + if (nestedURI) { + rv = nestedURI->GetInnerURI(getter_AddRefs(uri)); + if (NS_FAILED(rv)) { + return true; + } + } + } + return false; +} diff --git a/toolkit/components/jsdownloads/src/DownloadPlatform.h b/toolkit/components/jsdownloads/src/DownloadPlatform.h new file mode 100644 index 000000000..ef3c7554f --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadPlatform.h @@ -0,0 +1,34 @@ +/* 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/. */ + +#ifndef __DownloadPlatform_h__ +#define __DownloadPlatform_h__ + +#include "mozIDownloadPlatform.h" + +#include "nsCOMPtr.h" +class nsIURI; + +class DownloadPlatform : public mozIDownloadPlatform +{ +protected: + + virtual ~DownloadPlatform() { } + +public: + + NS_DECL_ISUPPORTS + NS_DECL_MOZIDOWNLOADPLATFORM + + DownloadPlatform() { } + + static DownloadPlatform *gDownloadPlatformService; + + static DownloadPlatform* GetDownloadPlatform(); + +private: + static bool IsURLPossiblyFromWeb(nsIURI* aURI); +}; + +#endif diff --git a/toolkit/components/jsdownloads/src/DownloadStore.jsm b/toolkit/components/jsdownloads/src/DownloadStore.jsm new file mode 100644 index 000000000..765a45c5a --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadStore.jsm @@ -0,0 +1,203 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +/** + * Handles serialization of Download objects and persistence into a file, so + * that the state of downloads can be restored across sessions. + * + * The file is stored in JSON format, without indentation. With indentation + * applied, the file would look like this: + * + * { + * "list": [ + * { + * "source": "http://www.example.com/download.txt", + * "target": "/home/user/Downloads/download.txt" + * }, + * { + * "source": { + * "url": "http://www.example.com/download.txt", + * "referrer": "http://www.example.com/referrer.html" + * }, + * "target": "/home/user/Downloads/download-2.txt" + * } + * ] + * } + */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "DownloadStore", +]; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "Downloads", + "resource://gre/modules/Downloads.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm") +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); + +XPCOMUtils.defineLazyGetter(this, "gTextDecoder", function () { + return new TextDecoder(); +}); + +XPCOMUtils.defineLazyGetter(this, "gTextEncoder", function () { + return new TextEncoder(); +}); + +// DownloadStore + +/** + * Handles serialization of Download objects and persistence into a file, so + * that the state of downloads can be restored across sessions. + * + * @param aList + * DownloadList object to be populated or serialized. + * @param aPath + * String containing the file path where data should be saved. + */ +this.DownloadStore = function (aList, aPath) +{ + this.list = aList; + this.path = aPath; +} + +this.DownloadStore.prototype = { + /** + * DownloadList object to be populated or serialized. + */ + list: null, + + /** + * String containing the file path where data should be saved. + */ + path: "", + + /** + * This function is called with a Download object as its first argument, and + * should return true if the item should be saved. + */ + onsaveitem: () => true, + + /** + * Loads persistent downloads from the file to the list. + * + * @return {Promise} + * @resolves When the operation finished successfully. + * @rejects JavaScript exception. + */ + load: function DS_load() + { + return Task.spawn(function* task_DS_load() { + let bytes; + try { + bytes = yield OS.File.read(this.path); + } catch (ex) { + if (!(ex instanceof OS.File.Error) || !ex.becauseNoSuchFile) { + throw ex; + } + // If the file does not exist, there are no downloads to load. + return; + } + + let storeData = JSON.parse(gTextDecoder.decode(bytes)); + + // Create live downloads based on the static snapshot. + for (let downloadData of storeData.list) { + try { + let download = yield Downloads.createDownload(downloadData); + try { + if (!download.succeeded && !download.canceled && !download.error) { + // Try to restart the download if it was in progress during the + // previous session. Ignore errors. + download.start().catch(() => {}); + } else { + // If the download was not in progress, try to update the current + // progress from disk. This is relevant in case we retained + // partially downloaded data. + yield download.refresh(); + } + } finally { + // Add the download to the list if we succeeded in creating it, + // after we have updated its initial state. + yield this.list.add(download); + } + } catch (ex) { + // If an item is unrecognized, don't prevent others from being loaded. + Cu.reportError(ex); + } + } + }.bind(this)); + }, + + /** + * Saves persistent downloads from the list to the file. + * + * If an error occurs, the previous file is not deleted. + * + * @return {Promise} + * @resolves When the operation finished successfully. + * @rejects JavaScript exception. + */ + save: function DS_save() + { + return Task.spawn(function* task_DS_save() { + let downloads = yield this.list.getAll(); + + // Take a static snapshot of the current state of all the downloads. + let storeData = { list: [] }; + let atLeastOneDownload = false; + for (let download of downloads) { + try { + if (!this.onsaveitem(download)) { + continue; + } + + let serializable = download.toSerializable(); + if (!serializable) { + // This item cannot be persisted across sessions. + continue; + } + storeData.list.push(serializable); + atLeastOneDownload = true; + } catch (ex) { + // If an item cannot be converted to a serializable form, don't + // prevent others from being saved. + Cu.reportError(ex); + } + } + + if (atLeastOneDownload) { + // Create or overwrite the file if there are downloads to save. + let bytes = gTextEncoder.encode(JSON.stringify(storeData)); + yield OS.File.writeAtomic(this.path, bytes, + { tmpPath: this.path + ".tmp" }); + } else { + // Remove the file if there are no downloads to save at all. + try { + yield OS.File.remove(this.path); + } catch (ex) { + if (!(ex instanceof OS.File.Error) || + !(ex.becauseNoSuchFile || ex.becauseAccessDenied)) { + throw ex; + } + // On Windows, we may get an access denied error instead of a no such + // file error if the file existed before, and was recently deleted. + } + } + }.bind(this)); + }, +}; diff --git a/toolkit/components/jsdownloads/src/DownloadUIHelper.jsm b/toolkit/components/jsdownloads/src/DownloadUIHelper.jsm new file mode 100644 index 000000000..f5102b4a8 --- /dev/null +++ b/toolkit/components/jsdownloads/src/DownloadUIHelper.jsm @@ -0,0 +1,243 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +/** + * Provides functions to handle status and messages in the user interface. + */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "DownloadUIHelper", +]; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); +Cu.import("resource://gre/modules/AppConstants.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Services", + "resource://gre/modules/Services.jsm"); + +const kStringBundleUrl = + "chrome://mozapps/locale/downloads/downloads.properties"; + +const kStringsRequiringFormatting = { + fileExecutableSecurityWarning: true, + cancelDownloadsOKTextMultiple: true, + quitCancelDownloadsAlertMsgMultiple: true, + quitCancelDownloadsAlertMsgMacMultiple: true, + offlineCancelDownloadsAlertMsgMultiple: true, + leavePrivateBrowsingWindowsCancelDownloadsAlertMsgMultiple2: true +}; + +// DownloadUIHelper + +/** + * Provides functions to handle status and messages in the user interface. + */ +this.DownloadUIHelper = { + /** + * Returns an object that can be used to display prompts related to downloads. + * + * The prompts may be either anchored to a specified window, or anchored to + * the most recently active window, for example if the prompt is displayed in + * response to global notifications that are not associated with any window. + * + * @param aParent + * If specified, should reference the nsIDOMWindow to which the prompts + * should be attached. If omitted, the prompts will be attached to the + * most recently active window. + * + * @return A DownloadPrompter object. + */ + getPrompter: function (aParent) + { + return new DownloadPrompter(aParent || null); + }, +}; + +/** + * Returns an object whose keys are the string names from the downloads string + * bundle, and whose values are either the translated strings or functions + * returning formatted strings. + */ +XPCOMUtils.defineLazyGetter(DownloadUIHelper, "strings", function () { + let strings = {}; + let sb = Services.strings.createBundle(kStringBundleUrl); + let enumerator = sb.getSimpleEnumeration(); + while (enumerator.hasMoreElements()) { + let string = enumerator.getNext().QueryInterface(Ci.nsIPropertyElement); + let stringName = string.key; + if (stringName in kStringsRequiringFormatting) { + strings[stringName] = function () { + // Convert "arguments" to a real array before calling into XPCOM. + return sb.formatStringFromName(stringName, + Array.slice(arguments, 0), + arguments.length); + }; + } else { + strings[stringName] = string.value; + } + } + return strings; +}); + +// DownloadPrompter + +/** + * Allows displaying prompts related to downloads. + * + * @param aParent + * The nsIDOMWindow to which prompts should be attached, or null to + * attach prompts to the most recently active window. + */ +this.DownloadPrompter = function (aParent) +{ + if (AppConstants.MOZ_B2G) { + // On B2G there is no prompter implementation. + this._prompter = null; + } else { + this._prompter = Services.ww.getNewPrompter(aParent); + } +} + +this.DownloadPrompter.prototype = { + /** + * Constants with the different type of prompts. + */ + ON_QUIT: "prompt-on-quit", + ON_OFFLINE: "prompt-on-offline", + ON_LEAVE_PRIVATE_BROWSING: "prompt-on-leave-private-browsing", + + /** + * nsIPrompt instance for displaying messages. + */ + _prompter: null, + + /** + * Displays a warning message box that informs that the specified file is + * executable, and asks whether the user wants to launch it. The user is + * given the option of disabling future instances of this warning. + * + * @param aPath + * String containing the full path to the file to be opened. + * + * @return {Promise} + * @resolves Boolean indicating whether the launch operation can continue. + * @rejects JavaScript exception. + */ + confirmLaunchExecutable: function (aPath) + { + const kPrefAlertOnEXEOpen = "browser.download.manager.alertOnEXEOpen"; + + try { + // Always launch in case we have no prompter implementation. + if (!this._prompter) { + return Promise.resolve(true); + } + + try { + if (!Services.prefs.getBoolPref(kPrefAlertOnEXEOpen)) { + return Promise.resolve(true); + } + } catch (ex) { + // If the preference does not exist, continue with the prompt. + } + + let leafName = OS.Path.basename(aPath); + + let s = DownloadUIHelper.strings; + let checkState = { value: false }; + let shouldLaunch = this._prompter.confirmCheck( + s.fileExecutableSecurityWarningTitle, + s.fileExecutableSecurityWarning(leafName, leafName), + s.fileExecutableSecurityWarningDontAsk, + checkState); + + if (shouldLaunch) { + Services.prefs.setBoolPref(kPrefAlertOnEXEOpen, !checkState.value); + } + + return Promise.resolve(shouldLaunch); + } catch (ex) { + return Promise.reject(ex); + } + }, + + /** + * Displays a warning message box that informs that there are active + * downloads, and asks whether the user wants to cancel them or not. + * + * @param aDownloadsCount + * The current downloads count. + * @param aPromptType + * The type of prompt notification depending on the observer. + * + * @return False to cancel the downloads and continue, true to abort the + * operation. + */ + confirmCancelDownloads: function DP_confirmCancelDownload(aDownloadsCount, + aPromptType) + { + // Always continue in case we have no prompter implementation, or if there + // are no active downloads. + if (!this._prompter || aDownloadsCount <= 0) { + return false; + } + + let s = DownloadUIHelper.strings; + let buttonFlags = (Ci.nsIPrompt.BUTTON_TITLE_IS_STRING * Ci.nsIPrompt.BUTTON_POS_0) + + (Ci.nsIPrompt.BUTTON_TITLE_IS_STRING * Ci.nsIPrompt.BUTTON_POS_1); + let okButton = aDownloadsCount > 1 ? s.cancelDownloadsOKTextMultiple(aDownloadsCount) + : s.cancelDownloadsOKText; + let title, message, cancelButton; + + switch (aPromptType) { + case this.ON_QUIT: + title = s.quitCancelDownloadsAlertTitle; + if (AppConstants.platform != "macosx") { + message = aDownloadsCount > 1 + ? s.quitCancelDownloadsAlertMsgMultiple(aDownloadsCount) + : s.quitCancelDownloadsAlertMsg; + cancelButton = s.dontQuitButtonWin; + } else { + message = aDownloadsCount > 1 + ? s.quitCancelDownloadsAlertMsgMacMultiple(aDownloadsCount) + : s.quitCancelDownloadsAlertMsgMac; + cancelButton = s.dontQuitButtonMac; + } + break; + case this.ON_OFFLINE: + title = s.offlineCancelDownloadsAlertTitle; + message = aDownloadsCount > 1 + ? s.offlineCancelDownloadsAlertMsgMultiple(aDownloadsCount) + : s.offlineCancelDownloadsAlertMsg; + cancelButton = s.dontGoOfflineButton; + break; + case this.ON_LEAVE_PRIVATE_BROWSING: + title = s.leavePrivateBrowsingCancelDownloadsAlertTitle; + message = aDownloadsCount > 1 + ? s.leavePrivateBrowsingWindowsCancelDownloadsAlertMsgMultiple2(aDownloadsCount) + : s.leavePrivateBrowsingWindowsCancelDownloadsAlertMsg2; + cancelButton = s.dontLeavePrivateBrowsingButton2; + break; + } + + let rv = this._prompter.confirmEx(title, message, buttonFlags, okButton, + cancelButton, null, null, {}); + return (rv == 1); + } +}; diff --git a/toolkit/components/jsdownloads/src/Downloads.jsm b/toolkit/components/jsdownloads/src/Downloads.jsm new file mode 100644 index 000000000..9511dc4ca --- /dev/null +++ b/toolkit/components/jsdownloads/src/Downloads.jsm @@ -0,0 +1,305 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */ +/* 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/. */ + +/** + * Main entry point to get references to all the back-end objects. + */ + +"use strict"; + +this.EXPORTED_SYMBOLS = [ + "Downloads", +]; + +// Globals + +const Cc = Components.classes; +const Ci = Components.interfaces; +const Cu = Components.utils; +const Cr = Components.results; + +Cu.import("resource://gre/modules/Integration.jsm"); +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); +Cu.import("resource://gre/modules/DownloadCore.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "DownloadCombinedList", + "resource://gre/modules/DownloadList.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadList", + "resource://gre/modules/DownloadList.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadSummary", + "resource://gre/modules/DownloadList.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadUIHelper", + "resource://gre/modules/DownloadUIHelper.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); + +Integration.downloads.defineModuleGetter(this, "DownloadIntegration", + "resource://gre/modules/DownloadIntegration.jsm"); + +// Downloads + +/** + * This object is exposed directly to the consumers of this JavaScript module, + * and provides the only entry point to get references to back-end objects. + */ +this.Downloads = { + /** + * Work on downloads that were not started from a private browsing window. + */ + get PUBLIC() { + return "{Downloads.PUBLIC}"; + }, + /** + * Work on downloads that were started from a private browsing window. + */ + get PRIVATE() { + return "{Downloads.PRIVATE}"; + }, + /** + * Work on both Downloads.PRIVATE and Downloads.PUBLIC downloads. + */ + get ALL() { + return "{Downloads.ALL}"; + }, + + /** + * Creates a new Download object. + * + * @param aProperties + * Provides the initial properties for the newly created download. + * This matches the serializable representation of a Download object. + * Some of the most common properties in this object include: + * { + * source: String containing the URI for the download source. + * Alternatively, may be an nsIURI, a DownloadSource object, + * or an object with the following properties: + * { + * url: String containing the URI for the download source. + * isPrivate: Indicates whether the download originated from a + * private window. If omitted, the download is public. + * referrer: String containing the referrer URI of the download + * source. Can be omitted or null if no referrer should + * be sent or the download source is not HTTP. + * }, + * target: String containing the path of the target file. + * Alternatively, may be an nsIFile, a DownloadTarget object, + * or an object with the following properties: + * { + * path: String containing the path of the target file. + * }, + * saver: String representing the class of the download operation. + * If omitted, defaults to "copy". Alternatively, may be the + * serializable representation of a DownloadSaver object. + * } + * + * @return {Promise} + * @resolves The newly created Download object. + * @rejects JavaScript exception. + */ + createDownload: function D_createDownload(aProperties) + { + try { + return Promise.resolve(Download.fromSerializable(aProperties)); + } catch (ex) { + return Promise.reject(ex); + } + }, + + /** + * Downloads data from a remote network location to a local file. + * + * This download method does not provide user interface, or the ability to + * cancel or restart the download programmatically. For that, you should + * obtain a reference to a Download object using the createDownload function. + * + * Since the download cannot be restarted, any partially downloaded data will + * not be kept in case the download fails. + * + * @param aSource + * String containing the URI for the download source. Alternatively, + * may be an nsIURI or a DownloadSource object. + * @param aTarget + * String containing the path of the target file. Alternatively, may + * be an nsIFile or a DownloadTarget object. + * @param aOptions + * An optional object used to control the behavior of this function. + * You may pass an object with a subset of the following fields: + * { + * isPrivate: Indicates whether the download originated from a + * private window. + * } + * + * @return {Promise} + * @resolves When the download has finished successfully. + * @rejects JavaScript exception if the download failed. + */ + fetch: function (aSource, aTarget, aOptions) { + return this.createDownload({ + source: aSource, + target: aTarget, + }).then(function D_SD_onSuccess(aDownload) { + if (aOptions && ("isPrivate" in aOptions)) { + aDownload.source.isPrivate = aOptions.isPrivate; + } + return aDownload.start(); + }); + }, + + /** + * Retrieves the specified type of DownloadList object. There is one download + * list for each type, and this method always retrieves a reference to the + * same download list when called with the same argument. + * + * Calling this function may cause the list of public downloads to be reloaded + * from the previous session, if it wasn't loaded already. + * + * @param aType + * This can be Downloads.PUBLIC, Downloads.PRIVATE, or Downloads.ALL. + * Downloads added to the Downloads.PUBLIC and Downloads.PRIVATE lists + * are reflected in the Downloads.ALL list, and downloads added to the + * Downloads.ALL list are also added to either the Downloads.PUBLIC or + * the Downloads.PRIVATE list based on their properties. + * + * @return {Promise} + * @resolves The requested DownloadList or DownloadCombinedList object. + * @rejects JavaScript exception. + */ + getList: function (aType) + { + if (!this._promiseListsInitialized) { + this._promiseListsInitialized = Task.spawn(function* () { + let publicList = new DownloadList(); + let privateList = new DownloadList(); + let combinedList = new DownloadCombinedList(publicList, privateList); + + try { + yield DownloadIntegration.addListObservers(publicList, false); + yield DownloadIntegration.addListObservers(privateList, true); + yield DownloadIntegration.initializePublicDownloadList(publicList); + } catch (ex) { + Cu.reportError(ex); + } + + let publicSummary = yield this.getSummary(Downloads.PUBLIC); + let privateSummary = yield this.getSummary(Downloads.PRIVATE); + let combinedSummary = yield this.getSummary(Downloads.ALL); + + yield publicSummary.bindToList(publicList); + yield privateSummary.bindToList(privateList); + yield combinedSummary.bindToList(combinedList); + + this._lists[Downloads.PUBLIC] = publicList; + this._lists[Downloads.PRIVATE] = privateList; + this._lists[Downloads.ALL] = combinedList; + }.bind(this)); + } + + return this._promiseListsInitialized.then(() => this._lists[aType]); + }, + + /** + * Promise resolved when the initialization of the download lists has + * completed, or null if initialization has never been requested. + */ + _promiseListsInitialized: null, + + /** + * After initialization, this object is populated with one key for each type + * of download list that can be returned (Downloads.PUBLIC, Downloads.PRIVATE, + * or Downloads.ALL). The values are the DownloadList objects. + */ + _lists: {}, + + /** + * Retrieves the specified type of DownloadSummary object. There is one + * download summary for each type, and this method always retrieves a + * reference to the same download summary when called with the same argument. + * + * Calling this function does not cause the list of public downloads to be + * reloaded from the previous session. The summary will behave as if no + * downloads are present until the getList method is called. + * + * @param aType + * This can be Downloads.PUBLIC, Downloads.PRIVATE, or Downloads.ALL. + * + * @return {Promise} + * @resolves The requested DownloadList or DownloadCombinedList object. + * @rejects JavaScript exception. + */ + getSummary: function (aType) + { + if (aType != Downloads.PUBLIC && aType != Downloads.PRIVATE && + aType != Downloads.ALL) { + throw new Error("Invalid aType argument."); + } + + if (!(aType in this._summaries)) { + this._summaries[aType] = new DownloadSummary(); + } + + return Promise.resolve(this._summaries[aType]); + }, + + /** + * This object is populated by the getSummary method with one key for each + * type of object that can be returned (Downloads.PUBLIC, Downloads.PRIVATE, + * or Downloads.ALL). The values are the DownloadSummary objects. + */ + _summaries: {}, + + /** + * Returns the system downloads directory asynchronously. + * Mac OSX: + * User downloads directory + * XP/2K: + * My Documents/Downloads + * Vista and others: + * User downloads directory + * Linux: + * XDG user dir spec, with a fallback to Home/Downloads + * Android: + * standard downloads directory i.e. /sdcard + * + * @return {Promise} + * @resolves The downloads directory string path. + */ + getSystemDownloadsDirectory: function D_getSystemDownloadsDirectory() { + return DownloadIntegration.getSystemDownloadsDirectory(); + }, + + /** + * Returns the preferred downloads directory based on the user preferences + * in the current profile asynchronously. + * + * @return {Promise} + * @resolves The downloads directory string path. + */ + getPreferredDownloadsDirectory: function D_getPreferredDownloadsDirectory() { + return DownloadIntegration.getPreferredDownloadsDirectory(); + }, + + /** + * Returns the temporary directory where downloads are placed before the + * final location is chosen, or while the document is opened temporarily + * with an external application. This may or may not be the system temporary + * directory, based on the platform asynchronously. + * + * @return {Promise} + * @resolves The downloads directory string path. + */ + getTemporaryDownloadsDirectory: function D_getTemporaryDownloadsDirectory() { + return DownloadIntegration.getTemporaryDownloadsDirectory(); + }, + + /** + * Constructor for a DownloadError object. When you catch an exception during + * a download, you can use this to verify if "ex instanceof Downloads.Error", + * before reading the exception properties with the error details. + */ + Error: DownloadError, +}; diff --git a/toolkit/components/jsdownloads/src/Downloads.manifest b/toolkit/components/jsdownloads/src/Downloads.manifest new file mode 100644 index 000000000..03d4ed4a6 --- /dev/null +++ b/toolkit/components/jsdownloads/src/Downloads.manifest @@ -0,0 +1,2 @@ +component {1b4c85df-cbdd-4bb6-b04e-613caece083c} DownloadLegacy.js +contract @mozilla.org/transfer;1 {1b4c85df-cbdd-4bb6-b04e-613caece083c} diff --git a/toolkit/components/jsdownloads/src/moz.build b/toolkit/components/jsdownloads/src/moz.build new file mode 100644 index 000000000..87abed62e --- /dev/null +++ b/toolkit/components/jsdownloads/src/moz.build @@ -0,0 +1,31 @@ +# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*- +# vim: set filetype=python: +# 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/. + +SOURCES += [ + 'DownloadPlatform.cpp', +] + +EXTRA_COMPONENTS += [ + 'DownloadLegacy.js', + 'Downloads.manifest', +] + +EXTRA_JS_MODULES += [ + 'DownloadCore.jsm', + 'DownloadImport.jsm', + 'DownloadList.jsm', + 'Downloads.jsm', + 'DownloadStore.jsm', + 'DownloadUIHelper.jsm', +] + +EXTRA_PP_JS_MODULES += [ + 'DownloadIntegration.jsm', +] + +FINAL_LIBRARY = 'xul' + +CXXFLAGS += CONFIG['TK_CFLAGS'] diff --git a/toolkit/components/jsdownloads/test/browser/.eslintrc.js b/toolkit/components/jsdownloads/test/browser/.eslintrc.js new file mode 100644 index 000000000..7c8021192 --- /dev/null +++ b/toolkit/components/jsdownloads/test/browser/.eslintrc.js @@ -0,0 +1,7 @@ +"use strict"; + +module.exports = { + "extends": [ + "../../../../../testing/mochitest/browser.eslintrc.js" + ] +}; diff --git a/toolkit/components/jsdownloads/test/browser/browser.ini b/toolkit/components/jsdownloads/test/browser/browser.ini new file mode 100644 index 000000000..131fc4ec8 --- /dev/null +++ b/toolkit/components/jsdownloads/test/browser/browser.ini @@ -0,0 +1,7 @@ +[DEFAULT] +support-files = + head.js + testFile.html + +[browser_DownloadPDFSaver.js] +skip-if = os != "win" diff --git a/toolkit/components/jsdownloads/test/browser/browser_DownloadPDFSaver.js b/toolkit/components/jsdownloads/test/browser/browser_DownloadPDFSaver.js new file mode 100644 index 000000000..80ed9665a --- /dev/null +++ b/toolkit/components/jsdownloads/test/browser/browser_DownloadPDFSaver.js @@ -0,0 +1,97 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the PDF download saver, and tests using a window as a + * source for the copy download saver. + */ + +"use strict"; + +/** + * Helper function to make sure a window reference exists on the download source. + */ +function* test_download_windowRef(aTab, aDownload) { + ok(aDownload.source.windowRef, "Download source had a window reference"); + ok(aDownload.source.windowRef instanceof Ci.xpcIJSWeakReference, "Download window reference is a weak ref"); + is(aDownload.source.windowRef.get(), aTab.linkedBrowser.contentWindow, "Download window exists during test"); +} + +/** + * Helper function to check the state of a completed download. + */ +function* test_download_state_complete(aTab, aDownload, aPrivate, aCanceled) { + ok(aDownload.source, "Download has a source"); + is(aDownload.source.url, aTab.linkedBrowser.contentWindow.location, "Download source has correct url"); + is(aDownload.source.isPrivate, aPrivate, "Download source has correct private state"); + ok(aDownload.stopped, "Download is stopped"); + is(aCanceled, aDownload.canceled, "Download has correct canceled state"); + is(!aCanceled, aDownload.succeeded, "Download has correct succeeded state"); + is(aDownload.error, null, "Download error is not defined"); +} + +function* test_createDownload_common(aPrivate, aType) { + let win = yield BrowserTestUtils.openNewBrowserWindow({ private : aPrivate}); + + let tab = yield BrowserTestUtils.openNewForegroundTab(win.gBrowser, getRootDirectory(gTestPath) + "testFile.html"); + let download = yield Downloads.createDownload({ + source: tab.linkedBrowser.contentWindow, + target: { path: getTempFile(TEST_TARGET_FILE_NAME_PDF).path }, + saver: { type: aType } + }); + + yield test_download_windowRef(tab, download); + yield download.start(); + + yield test_download_state_complete(tab, download, aPrivate, false); + if (aType == "pdf") { + let signature = yield OS.File.read(download.target.path, + { bytes: 4, encoding: "us-ascii" }); + is(signature, "%PDF", "File exists and signature matches"); + } else { + ok((yield OS.File.exists(download.target.path)), "File exists"); + } + + win.gBrowser.removeTab(tab); + win.close() +} + +add_task(function* test_createDownload_pdf_private() { + yield test_createDownload_common(true, "pdf"); +}); +add_task(function* test_createDownload_pdf_not_private() { + yield test_createDownload_common(false, "pdf"); +}); + +// Even for the copy saver, using a window should produce valid results +add_task(function* test_createDownload_copy_private() { + yield test_createDownload_common(true, "copy"); +}); +add_task(function* test_createDownload_copy_not_private() { + yield test_createDownload_common(false, "copy"); +}); + +add_task(function* test_cancel_pdf_download() { + let tab = gBrowser.addTab(getRootDirectory(gTestPath) + "testFile.html"); + yield promiseBrowserLoaded(tab.linkedBrowser); + + let download = yield Downloads.createDownload({ + source: tab.linkedBrowser.contentWindow, + target: { path: getTempFile(TEST_TARGET_FILE_NAME_PDF).path }, + saver: "pdf", + }); + + yield test_download_windowRef(tab, download); + download.start().catch(() => {}); + + // Immediately cancel the download to test that it is erased correctly. + yield download.cancel(); + yield test_download_state_complete(tab, download, false, true); + + let exists = yield OS.File.exists(download.target.path) + ok(!exists, "Target file does not exist"); + + gBrowser.removeTab(tab); +}); diff --git a/toolkit/components/jsdownloads/test/browser/head.js b/toolkit/components/jsdownloads/test/browser/head.js new file mode 100644 index 000000000..769aaacb3 --- /dev/null +++ b/toolkit/components/jsdownloads/test/browser/head.js @@ -0,0 +1,87 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Provides infrastructure for automated download components tests. + */ + +"use strict"; + +// Globals + +var Cc = Components.classes; +var Ci = Components.interfaces; +var Cu = Components.utils; +var Cr = Components.results; + +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "DownloadPaths", + "resource://gre/modules/DownloadPaths.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Downloads", + "resource://gre/modules/Downloads.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "FileUtils", + "resource://gre/modules/FileUtils.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Services", + "resource://gre/modules/Services.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "HttpServer", + "resource://testing-common/httpd.js"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm"); + +const TEST_TARGET_FILE_NAME_PDF = "test-download.pdf"; + +// Support functions + +// While the previous test file should have deleted all the temporary files it +// used, on Windows these might still be pending deletion on the physical file +// system. Thus, start from a new base number every time, to make a collision +// with a file that is still pending deletion highly unlikely. +var gFileCounter = Math.floor(Math.random() * 1000000); + +/** + * Returns a reference to a temporary file, that is guaranteed not to exist, and + * to have never been created before. + * + * @param aLeafName + * Suggested leaf name for the file to be created. + * + * @return nsIFile pointing to a non-existent file in a temporary directory. + * + * @note It is not enough to delete the file if it exists, or to delete the file + * after calling nsIFile.createUnique, because on Windows the delete + * operation in the file system may still be pending, preventing a new + * file with the same name to be created. + */ +function getTempFile(aLeafName) +{ + // Prepend a serial number to the extension in the suggested leaf name. + let [base, ext] = DownloadPaths.splitBaseNameAndExtension(aLeafName); + let leafName = base + "-" + gFileCounter + ext; + gFileCounter++; + + // Get a file reference under the temporary directory for this test file. + let file = FileUtils.getFile("TmpD", [leafName]); + ok(!file.exists(), "Temp file does not exist"); + + registerCleanupFunction(function () { + if (file.exists()) { + file.remove(false); + } + }); + + return file; +} + +function promiseBrowserLoaded(browser) { + return new Promise(resolve => { + browser.addEventListener("load", function onLoad(event) { + if (event.target == browser.contentDocument) { + browser.removeEventListener("load", onLoad, true); + resolve(); + } + }, true); + }); +} diff --git a/toolkit/components/jsdownloads/test/browser/testFile.html b/toolkit/components/jsdownloads/test/browser/testFile.html new file mode 100644 index 000000000..ee413514b --- /dev/null +++ b/toolkit/components/jsdownloads/test/browser/testFile.html @@ -0,0 +1,9 @@ +<!DOCTYPE html> +<html> + <head> + <title>Test Save as PDF</title> + </head> + <body> + <p>Save me as a PDF!</p> + </body> +</html> diff --git a/toolkit/components/jsdownloads/test/data/.eslintrc.js b/toolkit/components/jsdownloads/test/data/.eslintrc.js new file mode 100644 index 000000000..d35787cd2 --- /dev/null +++ b/toolkit/components/jsdownloads/test/data/.eslintrc.js @@ -0,0 +1,7 @@ +"use strict"; + +module.exports = { + "extends": [ + "../../../../../testing/xpcshell/xpcshell.eslintrc.js" + ] +}; diff --git a/toolkit/components/jsdownloads/test/data/empty.txt b/toolkit/components/jsdownloads/test/data/empty.txt new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/toolkit/components/jsdownloads/test/data/empty.txt diff --git a/toolkit/components/jsdownloads/test/data/source.txt b/toolkit/components/jsdownloads/test/data/source.txt new file mode 100644 index 000000000..2156cb8c0 --- /dev/null +++ b/toolkit/components/jsdownloads/test/data/source.txt @@ -0,0 +1 @@ +This test string is downloaded.
\ No newline at end of file diff --git a/toolkit/components/jsdownloads/test/unit/.eslintrc.js b/toolkit/components/jsdownloads/test/unit/.eslintrc.js new file mode 100644 index 000000000..d35787cd2 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/.eslintrc.js @@ -0,0 +1,7 @@ +"use strict"; + +module.exports = { + "extends": [ + "../../../../../testing/xpcshell/xpcshell.eslintrc.js" + ] +}; diff --git a/toolkit/components/jsdownloads/test/unit/common_test_Download.js b/toolkit/components/jsdownloads/test/unit/common_test_Download.js new file mode 100644 index 000000000..42d4c5682 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/common_test_Download.js @@ -0,0 +1,2432 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * This script is loaded by "test_DownloadCore.js" and "test_DownloadLegacy.js" + * with different values of the gUseLegacySaver variable, to apply tests to both + * the "copy" and "legacy" saver implementations. + */ + +"use strict"; + +// Globals + +const kDeleteTempFileOnExit = "browser.helperApps.deleteTempFileOnExit"; + +/** + * Creates and starts a new download, using either DownloadCopySaver or + * DownloadLegacySaver based on the current test run. + * + * @return {Promise} + * @resolves The newly created Download object. The download may be in progress + * or already finished. The promiseDownloadStopped function can be + * used to wait for completion. + * @rejects JavaScript exception. + */ +function promiseStartDownload(aSourceUrl) { + if (gUseLegacySaver) { + return promiseStartLegacyDownload(aSourceUrl); + } + + return promiseNewDownload(aSourceUrl).then(download => { + download.start().catch(() => {}); + return download; + }); +} + +/** + * Creates and starts a new download, configured to keep partial data, and + * returns only when the first part of "interruptible_resumable.txt" has been + * saved to disk. You must call "continueResponses" to allow the interruptible + * request to continue. + * + * This function uses either DownloadCopySaver or DownloadLegacySaver based on + * the current test run. + * + * @return {Promise} + * @resolves The newly created Download object, still in progress. + * @rejects JavaScript exception. + */ +function promiseStartDownload_tryToKeepPartialData() { + return Task.spawn(function* () { + mustInterruptResponses(); + + // Start a new download and configure it to keep partially downloaded data. + let download; + if (!gUseLegacySaver) { + let targetFilePath = getTempFile(TEST_TARGET_FILE_NAME).path; + download = yield Downloads.createDownload({ + source: httpUrl("interruptible_resumable.txt"), + target: { path: targetFilePath, + partFilePath: targetFilePath + ".part" }, + }); + download.tryToKeepPartialData = true; + download.start().catch(() => {}); + } else { + // Start a download using nsIExternalHelperAppService, that is configured + // to keep partially downloaded data by default. + download = yield promiseStartExternalHelperAppServiceDownload(); + } + + yield promiseDownloadMidway(download); + yield promisePartFileReady(download); + + return download; + }); +} + +/** + * This function should be called after the progress notification for a download + * is received, and waits for the worker thread of BackgroundFileSaver to + * receive the data to be written to the ".part" file on disk. + * + * @return {Promise} + * @resolves When the ".part" file has been written to disk. + * @rejects JavaScript exception. + */ +function promisePartFileReady(aDownload) { + return Task.spawn(function* () { + // We don't have control over the file output code in BackgroundFileSaver. + // After we receive the download progress notification, we may only check + // that the ".part" file has been created, while its size cannot be + // determined because the file is currently open. + try { + do { + yield promiseTimeout(50); + } while (!(yield OS.File.exists(aDownload.target.partFilePath))); + } catch (ex) { + if (!(ex instanceof OS.File.Error)) { + throw ex; + } + // This indicates that the file has been created and cannot be accessed. + // The specific error might vary with the platform. + do_print("Expected exception while checking existence: " + ex.toString()); + // Wait some more time to allow the write to complete. + yield promiseTimeout(100); + } + }); +} + +/** + * Checks that the actual data written to disk matches the expected data as well + * as the properties of the given DownloadTarget object. + * + * @param downloadTarget + * The DownloadTarget object whose details have to be verified. + * @param expectedContents + * String containing the octets that are expected in the file. + * + * @return {Promise} + * @resolves When the properties have been verified. + * @rejects JavaScript exception. + */ +var promiseVerifyTarget = Task.async(function* (downloadTarget, + expectedContents) { + yield promiseVerifyContents(downloadTarget.path, expectedContents); + do_check_true(downloadTarget.exists); + do_check_eq(downloadTarget.size, expectedContents.length); +}); + +/** + * Waits for an attempt to launch a file, and returns the nsIMIMEInfo used for + * the launch, or null if the file was launched with the default handler. + */ +function waitForFileLaunched() { + return new Promise(resolve => { + let waitFn = base => ({ + launchFile(file, mimeInfo) { + Integration.downloads.unregister(waitFn); + if (!mimeInfo || + mimeInfo.preferredAction == Ci.nsIMIMEInfo.useSystemDefault) { + resolve(null); + } else { + resolve(mimeInfo); + } + return Promise.resolve(); + }, + }); + Integration.downloads.register(waitFn); + }); +} + +/** + * Waits for an attempt to show the directory where a file is located, and + * returns the path of the file. + */ +function waitForDirectoryShown() { + return new Promise(resolve => { + let waitFn = base => ({ + showContainingDirectory(path) { + Integration.downloads.unregister(waitFn); + resolve(path); + return Promise.resolve(); + }, + }); + Integration.downloads.register(waitFn); + }); +} + +// Tests + +/** + * Executes a download and checks its basic properties after construction. + * The download is started by constructing the simplest Download object with + * the "copy" saver, or using the legacy nsITransfer interface. + */ +add_task(function* test_basic() +{ + let targetFile = getTempFile(TEST_TARGET_FILE_NAME); + + let download; + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we have control over the download, thus + // we can check its basic properties before it starts. + download = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt") }, + target: { path: targetFile.path }, + saver: { type: "copy" }, + }); + + do_check_eq(download.source.url, httpUrl("source.txt")); + do_check_eq(download.target.path, targetFile.path); + + yield download.start(); + } else { + // When testing DownloadLegacySaver, the download is already started when it + // is created, thus we must check its basic properties while in progress. + download = yield promiseStartLegacyDownload(null, + { targetFile: targetFile }); + + do_check_eq(download.source.url, httpUrl("source.txt")); + do_check_eq(download.target.path, targetFile.path); + + yield promiseDownloadStopped(download); + } + + // Check additional properties on the finished download. + do_check_true(download.source.referrer === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); +}); + +/** + * Executes a download with the tryToKeepPartialData property set, and ensures + * that the file is saved correctly. When testing DownloadLegacySaver, the + * download is executed using the nsIExternalHelperAppService component. + */ +add_task(function* test_basic_tryToKeepPartialData() +{ + let download = yield promiseStartDownload_tryToKeepPartialData(); + continueResponses(); + yield promiseDownloadStopped(download); + + // The target file should now have been created, and the ".part" file deleted. + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + do_check_eq(32, download.saver.getSha256Hash().length); +}); + +/** + * Tests the permissions of the final target file once the download finished. + */ +add_task(function* test_unix_permissions() +{ + // This test is only executed on some Desktop systems. + if (Services.appinfo.OS != "Darwin" && Services.appinfo.OS != "Linux" && + Services.appinfo.OS != "WINNT") { + do_print("Skipping test."); + return; + } + + let launcherPath = getTempFile("app-launcher").path; + + for (let autoDelete of [false, true]) { + for (let isPrivate of [false, true]) { + for (let launchWhenSucceeded of [false, true]) { + do_print("Checking " + JSON.stringify({ autoDelete, + isPrivate, + launchWhenSucceeded })); + + Services.prefs.setBoolPref(kDeleteTempFileOnExit, autoDelete); + + let download; + if (!gUseLegacySaver) { + download = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt"), isPrivate }, + target: getTempFile(TEST_TARGET_FILE_NAME).path, + launchWhenSucceeded, + launcherPath, + }); + yield download.start(); + } else { + download = yield promiseStartLegacyDownload(httpUrl("source.txt"), { + isPrivate, + launchWhenSucceeded, + launcherPath: launchWhenSucceeded && launcherPath, + }); + yield promiseDownloadStopped(download); + } + + let isTemporary = launchWhenSucceeded && (autoDelete || isPrivate); + let stat = yield OS.File.stat(download.target.path); + if (Services.appinfo.OS == "WINNT") { + // On Windows + // Temporary downloads should be read-only + do_check_eq(stat.winAttributes.readOnly, isTemporary ? true : false); + } else { + // On Linux, Mac + // Temporary downloads should be read-only and not accessible to other + // users, while permanently downloaded files should be readable and + // writable as specified by the system umask. + do_check_eq(stat.unixMode, + isTemporary ? 0o400 : (0o666 & ~OS.Constants.Sys.umask)); + } + } + } + } + + // Clean up the changes to the preference. + Services.prefs.clearUserPref(kDeleteTempFileOnExit); +}); + +/** + * Checks the referrer for downloads. + */ +add_task(function* test_referrer() +{ + let sourcePath = "/test_referrer.txt"; + let sourceUrl = httpUrl("test_referrer.txt"); + let targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + + function cleanup() { + gHttpServer.registerPathHandler(sourcePath, null); + } + do_register_cleanup(cleanup); + + gHttpServer.registerPathHandler(sourcePath, function (aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + + do_check_true(aRequest.hasHeader("Referer")); + do_check_eq(aRequest.getHeader("Referer"), TEST_REFERRER_URL); + }); + let download = yield Downloads.createDownload({ + source: { url: sourceUrl, referrer: TEST_REFERRER_URL }, + target: targetPath, + }); + do_check_eq(download.source.referrer, TEST_REFERRER_URL); + yield download.start(); + + download = yield Downloads.createDownload({ + source: { url: sourceUrl, referrer: TEST_REFERRER_URL, + isPrivate: true }, + target: targetPath, + }); + do_check_eq(download.source.referrer, TEST_REFERRER_URL); + yield download.start(); + + // Test the download still works for non-HTTP channel with referrer. + sourceUrl = "data:text/html,<html><body></body></html>"; + download = yield Downloads.createDownload({ + source: { url: sourceUrl, referrer: TEST_REFERRER_URL }, + target: targetPath, + }); + do_check_eq(download.source.referrer, TEST_REFERRER_URL); + yield download.start(); + + cleanup(); +}); + +/** + * Checks the adjustChannel callback for downloads. + */ +add_task(function* test_adjustChannel() +{ + const sourcePath = "/test_post.txt"; + const sourceUrl = httpUrl("test_post.txt"); + const targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + const customHeader = { name: "X-Answer", value: "42" }; + const postData = "Don't Panic"; + + function cleanup() { + gHttpServer.registerPathHandler(sourcePath, null); + } + do_register_cleanup(cleanup); + + gHttpServer.registerPathHandler(sourcePath, aRequest => { + do_check_eq(aRequest.method, "POST"); + + do_check_true(aRequest.hasHeader(customHeader.name)); + do_check_eq(aRequest.getHeader(customHeader.name), customHeader.value); + + const stream = aRequest.bodyInputStream; + const body = NetUtil.readInputStreamToString(stream, stream.available()); + do_check_eq(body, postData); + }); + + function adjustChannel(channel) { + channel.QueryInterface(Ci.nsIHttpChannel); + channel.setRequestHeader(customHeader.name, customHeader.value, false); + + const stream = Cc["@mozilla.org/io/string-input-stream;1"] + .createInstance(Ci.nsIStringInputStream); + stream.setData(postData, postData.length); + + channel.QueryInterface(Ci.nsIUploadChannel2); + channel.explicitSetUploadStream(stream, null, -1, "POST", false); + + return Promise.resolve(); + } + + const download = yield Downloads.createDownload({ + source: { url: sourceUrl, adjustChannel }, + target: targetPath, + }); + do_check_eq(download.source.adjustChannel, adjustChannel); + do_check_eq(download.toSerializable(), null); + yield download.start(); + + cleanup(); +}); + +/** + * Checks initial and final state and progress for a successful download. + */ +add_task(function* test_initial_final_state() +{ + let download; + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we have control over the download, thus + // we can check its state before it starts. + download = yield promiseNewDownload(); + + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + do_check_eq(download.progress, 0); + do_check_true(download.startTime === null); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + yield download.start(); + } else { + // When testing DownloadLegacySaver, the download is already started when it + // is created, thus we cannot check its initial state. + download = yield promiseStartLegacyDownload(); + yield promiseDownloadStopped(download); + } + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + do_check_eq(download.progress, 100); + do_check_true(isValidDate(download.startTime)); + do_check_true(download.target.exists); + do_check_eq(download.target.size, TEST_DATA_SHORT.length); +}); + +/** + * Checks the notification of the final download state. + */ +add_task(function* test_final_state_notified() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + let onchangeNotified = false; + let lastNotifiedStopped; + let lastNotifiedProgress; + download.onchange = function () { + onchangeNotified = true; + lastNotifiedStopped = download.stopped; + lastNotifiedProgress = download.progress; + }; + + // Allow the download to complete. + let promiseAttempt = download.start(); + continueResponses(); + yield promiseAttempt; + + // The view should have been notified before the download completes. + do_check_true(onchangeNotified); + do_check_true(lastNotifiedStopped); + do_check_eq(lastNotifiedProgress, 100); +}); + +/** + * Checks intermediate progress for a successful download. + */ +add_task(function* test_intermediate_progress() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + yield promiseDownloadMidway(download); + + do_check_true(download.hasProgress); + do_check_eq(download.currentBytes, TEST_DATA_SHORT.length); + do_check_eq(download.totalBytes, TEST_DATA_SHORT.length * 2); + + // The final file size should not be computed for in-progress downloads. + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + // Continue after the first chunk of data is fully received. + continueResponses(); + yield promiseDownloadStopped(download); + + do_check_true(download.stopped); + do_check_eq(download.progress, 100); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); +}); + +/** + * Downloads a file with a "Content-Length" of 0 and checks the progress. + */ +add_task(function* test_empty_progress() +{ + let download = yield promiseStartDownload(httpUrl("empty.txt")); + yield promiseDownloadStopped(download); + + do_check_true(download.stopped); + do_check_true(download.hasProgress); + do_check_eq(download.progress, 100); + do_check_eq(download.currentBytes, 0); + do_check_eq(download.totalBytes, 0); + + // We should have received the content type even for an empty file. + do_check_eq(download.contentType, "text/plain"); + + do_check_eq((yield OS.File.stat(download.target.path)).size, 0); + do_check_true(download.target.exists); + do_check_eq(download.target.size, 0); +}); + +/** + * Downloads a file with a "Content-Length" of 0 with the tryToKeepPartialData + * property set, and ensures that the file is saved correctly. + */ +add_task(function* test_empty_progress_tryToKeepPartialData() +{ + // Start a new download and configure it to keep partially downloaded data. + let download; + if (!gUseLegacySaver) { + let targetFilePath = getTempFile(TEST_TARGET_FILE_NAME).path; + download = yield Downloads.createDownload({ + source: httpUrl("empty.txt"), + target: { path: targetFilePath, + partFilePath: targetFilePath + ".part" }, + }); + download.tryToKeepPartialData = true; + download.start().catch(() => {}); + } else { + // Start a download using nsIExternalHelperAppService, that is configured + // to keep partially downloaded data by default. + download = yield promiseStartExternalHelperAppServiceDownload( + httpUrl("empty.txt")); + } + yield promiseDownloadStopped(download); + + // The target file should now have been created, and the ".part" file deleted. + do_check_eq((yield OS.File.stat(download.target.path)).size, 0); + do_check_true(download.target.exists); + do_check_eq(download.target.size, 0); + + do_check_false(yield OS.File.exists(download.target.partFilePath)); + do_check_eq(32, download.saver.getSha256Hash().length); +}); + +/** + * Downloads an empty file with no "Content-Length" and checks the progress. + */ +add_task(function* test_empty_noprogress() +{ + let sourcePath = "/test_empty_noprogress.txt"; + let sourceUrl = httpUrl("test_empty_noprogress.txt"); + let deferRequestReceived = Promise.defer(); + + // Register an interruptible handler that notifies us when the request occurs. + function cleanup() { + gHttpServer.registerPathHandler(sourcePath, null); + } + do_register_cleanup(cleanup); + + registerInterruptibleHandler(sourcePath, + function firstPart(aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + deferRequestReceived.resolve(); + }, function secondPart(aRequest, aResponse) { }); + + // Start the download, without allowing the request to finish. + mustInterruptResponses(); + let download; + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we have control over the download, thus + // we can hook its onchange callback that will be notified when the + // download starts. + download = yield promiseNewDownload(sourceUrl); + + download.onchange = function () { + if (!download.stopped) { + do_check_false(download.hasProgress); + do_check_eq(download.currentBytes, 0); + do_check_eq(download.totalBytes, 0); + } + }; + + download.start().catch(() => {}); + } else { + // When testing DownloadLegacySaver, the download is already started when it + // is created, and it may have already made all needed property change + // notifications, thus there is no point in checking the onchange callback. + download = yield promiseStartLegacyDownload(sourceUrl); + } + + // Wait for the request to be received by the HTTP server, but don't allow the + // request to finish yet. Before checking the download state, wait for the + // events to be processed by the client. + yield deferRequestReceived.promise; + yield promiseExecuteSoon(); + + // Check that this download has no progress report. + do_check_false(download.stopped); + do_check_false(download.hasProgress); + do_check_eq(download.currentBytes, 0); + do_check_eq(download.totalBytes, 0); + + // Now allow the response to finish. + continueResponses(); + yield promiseDownloadStopped(download); + + // We should have received the content type even if no progress is reported. + do_check_eq(download.contentType, "text/plain"); + + // Verify the state of the completed download. + do_check_true(download.stopped); + do_check_false(download.hasProgress); + do_check_eq(download.progress, 100); + do_check_eq(download.currentBytes, 0); + do_check_eq(download.totalBytes, 0); + do_check_true(download.target.exists); + do_check_eq(download.target.size, 0); + + do_check_eq((yield OS.File.stat(download.target.path)).size, 0); +}); + +/** + * Calls the "start" method two times before the download is finished. + */ +add_task(function* test_start_twice() +{ + mustInterruptResponses(); + + let download; + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we have control over the download, thus + // we can start the download later during the test. + download = yield promiseNewDownload(httpUrl("interruptible.txt")); + } else { + // When testing DownloadLegacySaver, the download is already started when it + // is created. Effectively, we are starting the download three times. + download = yield promiseStartLegacyDownload(httpUrl("interruptible.txt")); + } + + // Call the start method two times. + let promiseAttempt1 = download.start(); + let promiseAttempt2 = download.start(); + + // Allow the download to finish. + continueResponses(); + + // Both promises should now be resolved. + yield promiseAttempt1; + yield promiseAttempt2; + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); +}); + +/** + * Cancels a download and verifies that its state is reported correctly. + */ +add_task(function* test_cancel_midway() +{ + mustInterruptResponses(); + + // In this test case, we execute different checks that are only possible with + // DownloadCopySaver or DownloadLegacySaver respectively. + let download; + let options = {}; + if (!gUseLegacySaver) { + download = yield promiseNewDownload(httpUrl("interruptible.txt")); + } else { + download = yield promiseStartLegacyDownload(httpUrl("interruptible.txt"), + options); + } + + // Cancel the download after receiving the first part of the response. + let deferCancel = Promise.defer(); + let onchange = function () { + if (!download.stopped && !download.canceled && download.progress == 50) { + // Cancel the download immediately during the notification. + deferCancel.resolve(download.cancel()); + + // The state change happens immediately after calling "cancel", but + // temporary files or part files may still exist at this point. + do_check_true(download.canceled); + } + }; + + // Register for the notification, but also call the function directly in + // case the download already reached the expected progress. This may happen + // when using DownloadLegacySaver. + download.onchange = onchange; + onchange(); + + let promiseAttempt; + if (!gUseLegacySaver) { + promiseAttempt = download.start(); + } + + // Wait on the promise returned by the "cancel" method to ensure that the + // cancellation process finished and temporary files were removed. + yield deferCancel.promise; + + if (gUseLegacySaver) { + // The nsIWebBrowserPersist instance should have been canceled now. + do_check_eq(options.outPersist.result, Cr.NS_ERROR_ABORT); + } + + do_check_true(download.stopped); + do_check_true(download.canceled); + do_check_true(download.error === null); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + do_check_false(yield OS.File.exists(download.target.path)); + + // Progress properties are not reset by canceling. + do_check_eq(download.progress, 50); + do_check_eq(download.totalBytes, TEST_DATA_SHORT.length * 2); + do_check_eq(download.currentBytes, TEST_DATA_SHORT.length); + + if (!gUseLegacySaver) { + // The promise returned by "start" should have been rejected meanwhile. + try { + yield promiseAttempt; + do_throw("The download should have been canceled."); + } catch (ex) { + if (!(ex instanceof Downloads.Error)) { + throw ex; + } + do_check_false(ex.becauseSourceFailed); + do_check_false(ex.becauseTargetFailed); + } + } +}); + +/** + * Cancels a download while keeping partially downloaded data, and verifies that + * both the target file and the ".part" file are deleted. + */ +add_task(function* test_cancel_midway_tryToKeepPartialData() +{ + let download = yield promiseStartDownload_tryToKeepPartialData(); + + do_check_true(yield OS.File.exists(download.target.path)); + do_check_true(yield OS.File.exists(download.target.partFilePath)); + + yield download.cancel(); + yield download.removePartialData(); + + do_check_true(download.stopped); + do_check_true(download.canceled); + do_check_true(download.error === null); + + do_check_false(yield OS.File.exists(download.target.path)); + do_check_false(yield OS.File.exists(download.target.partFilePath)); +}); + +/** + * Cancels a download right after starting it. + */ +add_task(function* test_cancel_immediately() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + let promiseAttempt = download.start(); + do_check_false(download.stopped); + + let promiseCancel = download.cancel(); + do_check_true(download.canceled); + + // At this point, we don't know whether the download has already stopped or + // is still waiting for cancellation. We can wait on the promise returned + // by the "start" method to know for sure. + try { + yield promiseAttempt; + do_throw("The download should have been canceled."); + } catch (ex) { + if (!(ex instanceof Downloads.Error)) { + throw ex; + } + do_check_false(ex.becauseSourceFailed); + do_check_false(ex.becauseTargetFailed); + } + + do_check_true(download.stopped); + do_check_true(download.canceled); + do_check_true(download.error === null); + + do_check_false(yield OS.File.exists(download.target.path)); + + // Check that the promise returned by the "cancel" method has been resolved. + yield promiseCancel; +}); + +/** + * Cancels and restarts a download sequentially. + */ +add_task(function* test_cancel_midway_restart() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + // The first time, cancel the download midway. + yield promiseDownloadMidway(download); + yield download.cancel(); + + do_check_true(download.stopped); + + // The second time, we'll provide the entire interruptible response. + continueResponses(); + download.onchange = null; + let promiseAttempt = download.start(); + + // Download state should have already been reset. + do_check_false(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error === null); + + // For the following test, we rely on the network layer reporting its progress + // asynchronously. Otherwise, there is nothing stopping the restarted + // download from reaching the same progress as the first request already. + do_check_eq(download.progress, 0); + do_check_eq(download.totalBytes, 0); + do_check_eq(download.currentBytes, 0); + + yield promiseAttempt; + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); +}); + +/** + * Cancels a download and restarts it from where it stopped. + */ +add_task(function* test_cancel_midway_restart_tryToKeepPartialData() +{ + let download = yield promiseStartDownload_tryToKeepPartialData(); + yield download.cancel(); + + do_check_true(download.stopped); + do_check_true(download.hasPartialData); + + // The target file should not exist, but we should have kept the partial data. + do_check_false(yield OS.File.exists(download.target.path)); + yield promiseVerifyContents(download.target.partFilePath, TEST_DATA_SHORT); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + // Verify that the server sent the response from the start. + do_check_eq(gMostRecentFirstBytePos, 0); + + // The second time, we'll request and obtain the second part of the response, + // but we still stop when half of the remaining progress is reached. + let deferMidway = Promise.defer(); + download.onchange = function () { + if (!download.stopped && !download.canceled && + download.currentBytes == Math.floor(TEST_DATA_SHORT.length * 3 / 2)) { + download.onchange = null; + deferMidway.resolve(); + } + }; + + mustInterruptResponses(); + let promiseAttempt = download.start(); + + // Continue when the number of bytes we received is correct, then check that + // progress is at about 75 percent. The exact figure may vary because of + // rounding issues, since the total number of bytes in the response might not + // be a multiple of four. + yield deferMidway.promise; + do_check_true(download.progress > 72 && download.progress < 78); + + // Now we allow the download to finish. + continueResponses(); + yield promiseAttempt; + + // Check that the server now sent the second part only. + do_check_eq(gMostRecentFirstBytePos, TEST_DATA_SHORT.length); + + // The target file should now have been created, and the ".part" file deleted. + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); + do_check_false(yield OS.File.exists(download.target.partFilePath)); +}); + +/** + * Cancels a download while keeping partially downloaded data, then removes the + * data and restarts the download from the beginning. + */ +add_task(function* test_cancel_midway_restart_removePartialData() +{ + let download = yield promiseStartDownload_tryToKeepPartialData(); + yield download.cancel(); + + do_check_true(download.hasPartialData); + yield promiseVerifyContents(download.target.partFilePath, TEST_DATA_SHORT); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + yield download.removePartialData(); + + do_check_false(download.hasPartialData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + // The second time, we'll request and obtain the entire response again. + continueResponses(); + yield download.start(); + + // Verify that the server sent the response from the start. + do_check_eq(gMostRecentFirstBytePos, 0); + + // The target file should now have been created, and the ".part" file deleted. + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); + do_check_false(yield OS.File.exists(download.target.partFilePath)); +}); + +/** + * Cancels a download while keeping partially downloaded data, then removes the + * data and restarts the download from the beginning without keeping the partial + * data anymore. + */ +add_task(function* test_cancel_midway_restart_tryToKeepPartialData_false() +{ + let download = yield promiseStartDownload_tryToKeepPartialData(); + yield download.cancel(); + + download.tryToKeepPartialData = false; + + // The above property change does not affect existing partial data. + do_check_true(download.hasPartialData); + yield promiseVerifyContents(download.target.partFilePath, TEST_DATA_SHORT); + + yield download.removePartialData(); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + + // Restart the download from the beginning. + mustInterruptResponses(); + download.start().catch(() => {}); + + yield promiseDownloadMidway(download); + yield promisePartFileReady(download); + + // While the download is in progress, we should still have a ".part" file. + do_check_false(download.hasPartialData); + do_check_true(yield OS.File.exists(download.target.partFilePath)); + + // On Unix, verify that the file with the partially downloaded data is not + // accessible by other users on the system. + if (Services.appinfo.OS == "Darwin" || Services.appinfo.OS == "Linux") { + do_check_eq((yield OS.File.stat(download.target.partFilePath)).unixMode, + 0o600); + } + + yield download.cancel(); + + // The ".part" file should be deleted now that the download is canceled. + do_check_false(download.hasPartialData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + + // The third time, we'll request and obtain the entire response again. + continueResponses(); + yield download.start(); + + // Verify that the server sent the response from the start. + do_check_eq(gMostRecentFirstBytePos, 0); + + // The target file should now have been created, and the ".part" file deleted. + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); + do_check_false(yield OS.File.exists(download.target.partFilePath)); +}); + +/** + * Cancels a download right after starting it, then restarts it immediately. + */ +add_task(function* test_cancel_immediately_restart_immediately() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + let promiseAttempt = download.start(); + + do_check_false(download.stopped); + + download.cancel(); + do_check_true(download.canceled); + + let promiseRestarted = download.start(); + do_check_false(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error === null); + + // For the following test, we rely on the network layer reporting its progress + // asynchronously. Otherwise, there is nothing stopping the restarted + // download from reaching the same progress as the first request already. + do_check_eq(download.hasProgress, false); + do_check_eq(download.progress, 0); + do_check_eq(download.totalBytes, 0); + do_check_eq(download.currentBytes, 0); + + // Ensure the next request is now allowed to complete, regardless of whether + // the canceled request was received by the server or not. + continueResponses(); + try { + yield promiseAttempt; + // If we get here, it means that the first attempt actually succeeded. In + // fact, this could be a valid outcome, because the cancellation request may + // not have been processed in time before the download finished. + do_print("The download should have been canceled."); + } catch (ex) { + if (!(ex instanceof Downloads.Error)) { + throw ex; + } + do_check_false(ex.becauseSourceFailed); + do_check_false(ex.becauseTargetFailed); + } + + yield promiseRestarted; + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); +}); + +/** + * Cancels a download midway, then restarts it immediately. + */ +add_task(function* test_cancel_midway_restart_immediately() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + let promiseAttempt = download.start(); + + // The first time, cancel the download midway. + yield promiseDownloadMidway(download); + download.cancel(); + do_check_true(download.canceled); + + let promiseRestarted = download.start(); + do_check_false(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error === null); + + // For the following test, we rely on the network layer reporting its progress + // asynchronously. Otherwise, there is nothing stopping the restarted + // download from reaching the same progress as the first request already. + do_check_eq(download.hasProgress, false); + do_check_eq(download.progress, 0); + do_check_eq(download.totalBytes, 0); + do_check_eq(download.currentBytes, 0); + + // The second request is allowed to complete. + continueResponses(); + try { + yield promiseAttempt; + do_throw("The download should have been canceled."); + } catch (ex) { + if (!(ex instanceof Downloads.Error)) { + throw ex; + } + do_check_false(ex.becauseSourceFailed); + do_check_false(ex.becauseTargetFailed); + } + + yield promiseRestarted; + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); +}); + +/** + * Calls the "cancel" method on a successful download. + */ +add_task(function* test_cancel_successful() +{ + let download = yield promiseStartDownload(); + yield promiseDownloadStopped(download); + + // The cancel method should succeed with no effect. + yield download.cancel(); + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); +}); + +/** + * Calls the "cancel" method two times in a row. + */ +add_task(function* test_cancel_twice() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + let promiseAttempt = download.start(); + do_check_false(download.stopped); + + let promiseCancel1 = download.cancel(); + do_check_true(download.canceled); + let promiseCancel2 = download.cancel(); + + try { + yield promiseAttempt; + do_throw("The download should have been canceled."); + } catch (ex) { + if (!(ex instanceof Downloads.Error)) { + throw ex; + } + do_check_false(ex.becauseSourceFailed); + do_check_false(ex.becauseTargetFailed); + } + + // Both promises should now be resolved. + yield promiseCancel1; + yield promiseCancel2; + + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_true(download.canceled); + do_check_true(download.error === null); + + do_check_false(yield OS.File.exists(download.target.path)); +}); + +/** + * Checks the "refresh" method for succeeded downloads. + */ +add_task(function* test_refresh_succeeded() +{ + let download = yield promiseStartDownload(); + yield promiseDownloadStopped(download); + + // The DownloadTarget properties should be the same after calling "refresh". + yield download.refresh(); + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); + + // If the file is removed, only the "exists" property should change, and the + // "size" property should keep its previous value. + yield OS.File.move(download.target.path, download.target.path + ".old"); + yield download.refresh(); + do_check_false(download.target.exists); + do_check_eq(download.target.size, TEST_DATA_SHORT.length); + + // The DownloadTarget properties should be restored when the file is put back. + yield OS.File.move(download.target.path + ".old", download.target.path); + yield download.refresh(); + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); +}); + +/** + * Checks that a download cannot be restarted after the "finalize" method. + */ +add_task(function* test_finalize() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + let promiseFinalized = download.finalize(); + + try { + yield download.start(); + do_throw("It should not be possible to restart after finalization."); + } catch (ex) { } + + yield promiseFinalized; + + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_true(download.canceled); + do_check_true(download.error === null); + + do_check_false(yield OS.File.exists(download.target.path)); +}); + +/** + * Checks that the "finalize" method can remove partially downloaded data. + */ +add_task(function* test_finalize_tryToKeepPartialData() +{ + // Check finalization without removing partial data. + let download = yield promiseStartDownload_tryToKeepPartialData(); + yield download.finalize(); + + do_check_true(download.hasPartialData); + do_check_true(yield OS.File.exists(download.target.partFilePath)); + + // Clean up. + yield download.removePartialData(); + + // Check finalization while removing partial data. + download = yield promiseStartDownload_tryToKeepPartialData(); + yield download.finalize(true); + + do_check_false(download.hasPartialData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); +}); + +/** + * Checks that whenSucceeded returns a promise that is resolved after a restart. + */ +add_task(function* test_whenSucceeded_after_restart() +{ + mustInterruptResponses(); + + let promiseSucceeded; + + let download; + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we have control over the download, thus + // we can verify getting a reference before the first download attempt. + download = yield promiseNewDownload(httpUrl("interruptible.txt")); + promiseSucceeded = download.whenSucceeded(); + download.start().catch(() => {}); + } else { + // When testing DownloadLegacySaver, the download is already started when it + // is created, thus we cannot get the reference before the first attempt. + download = yield promiseStartLegacyDownload(httpUrl("interruptible.txt")); + promiseSucceeded = download.whenSucceeded(); + } + + // Cancel the first download attempt. + yield download.cancel(); + + // The second request is allowed to complete. + continueResponses(); + download.start().catch(() => {}); + + // Wait for the download to finish by waiting on the whenSucceeded promise. + yield promiseSucceeded; + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); +}); + +/** + * Ensures download error details are reported on network failures. + */ +add_task(function* test_error_source() +{ + let serverSocket = startFakeServer(); + try { + let sourceUrl = "http://localhost:" + serverSocket.port + "/source.txt"; + + let download; + try { + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we want to check that the promise + // returned by the "start" method is rejected. + download = yield promiseNewDownload(sourceUrl); + + do_check_true(download.error === null); + + yield download.start(); + } else { + // When testing DownloadLegacySaver, we cannot be sure whether we are + // testing the promise returned by the "start" method or we are testing + // the "error" property checked by promiseDownloadStopped. This happens + // because we don't have control over when the download is started. + download = yield promiseStartLegacyDownload(sourceUrl); + yield promiseDownloadStopped(download); + } + do_throw("The download should have failed."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseSourceFailed) { + throw ex; + } + // A specific error object is thrown when reading from the source fails. + } + + // Check the properties now that the download stopped. + do_check_true(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error !== null); + do_check_true(download.error.becauseSourceFailed); + do_check_false(download.error.becauseTargetFailed); + + do_check_false(yield OS.File.exists(download.target.path)); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + } finally { + serverSocket.close(); + } +}); + +/** + * Ensures a download error is reported when receiving less bytes than what was + * specified in the Content-Length header. + */ +add_task(function* test_error_source_partial() +{ + let sourceUrl = httpUrl("shorter-than-content-length-http-1-1.txt"); + + let enforcePref = Services.prefs.getBoolPref("network.http.enforce-framing.http1"); + Services.prefs.setBoolPref("network.http.enforce-framing.http1", true); + + function cleanup() { + Services.prefs.setBoolPref("network.http.enforce-framing.http1", enforcePref); + } + do_register_cleanup(cleanup); + + let download; + try { + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we want to check that the promise + // returned by the "start" method is rejected. + download = yield promiseNewDownload(sourceUrl); + + do_check_true(download.error === null); + + yield download.start(); + } else { + // When testing DownloadLegacySaver, we cannot be sure whether we are + // testing the promise returned by the "start" method or we are testing + // the "error" property checked by promiseDownloadStopped. This happens + // because we don't have control over when the download is started. + download = yield promiseStartLegacyDownload(sourceUrl); + yield promiseDownloadStopped(download); + } + do_throw("The download should have failed."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseSourceFailed) { + throw ex; + } + // A specific error object is thrown when reading from the source fails. + } + + // Check the properties now that the download stopped. + do_check_true(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error !== null); + do_check_true(download.error.becauseSourceFailed); + do_check_false(download.error.becauseTargetFailed); + do_check_eq(download.error.result, Cr.NS_ERROR_NET_PARTIAL_TRANSFER); + + do_check_false(yield OS.File.exists(download.target.path)); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); +}); + +/** + * Ensures download error details are reported on local writing failures. + */ +add_task(function* test_error_target() +{ + // Create a file without write access permissions before downloading. + let targetFile = getTempFile(TEST_TARGET_FILE_NAME); + targetFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, 0); + try { + let download; + try { + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we want to check that the promise + // returned by the "start" method is rejected. + download = yield Downloads.createDownload({ + source: httpUrl("source.txt"), + target: targetFile, + }); + yield download.start(); + } else { + // When testing DownloadLegacySaver, we cannot be sure whether we are + // testing the promise returned by the "start" method or we are testing + // the "error" property checked by promiseDownloadStopped. This happens + // because we don't have control over when the download is started. + download = yield promiseStartLegacyDownload(null, + { targetFile: targetFile }); + yield promiseDownloadStopped(download); + } + do_throw("The download should have failed."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseTargetFailed) { + throw ex; + } + // A specific error object is thrown when writing to the target fails. + } + + // Check the properties now that the download stopped. + do_check_true(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error !== null); + do_check_true(download.error.becauseTargetFailed); + do_check_false(download.error.becauseSourceFailed); + } finally { + // Restore the default permissions to allow deleting the file on Windows. + if (targetFile.exists()) { + targetFile.permissions = FileUtils.PERMS_FILE; + targetFile.remove(false); + } + } +}); + +/** + * Restarts a failed download. + */ +add_task(function* test_error_restart() +{ + let download; + + // Create a file without write access permissions before downloading. + let targetFile = getTempFile(TEST_TARGET_FILE_NAME); + targetFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, 0); + try { + // Use DownloadCopySaver or DownloadLegacySaver based on the test run, + // specifying the target file we created. + if (!gUseLegacySaver) { + download = yield Downloads.createDownload({ + source: httpUrl("source.txt"), + target: targetFile, + }); + download.start().catch(() => {}); + } else { + download = yield promiseStartLegacyDownload(null, + { targetFile: targetFile }); + } + yield promiseDownloadStopped(download); + do_throw("The download should have failed."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseTargetFailed) { + throw ex; + } + // A specific error object is thrown when writing to the target fails. + } finally { + // Restore the default permissions to allow deleting the file on Windows. + if (targetFile.exists()) { + targetFile.permissions = FileUtils.PERMS_FILE; + + // Also for Windows, rename the file before deleting. This makes the + // current file name available immediately for a new file, while deleting + // in place prevents creation of a file with the same name for some time. + targetFile.moveTo(null, targetFile.leafName + ".delete.tmp"); + targetFile.remove(false); + } + } + + // Restart the download and wait for completion. + yield download.start(); + + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.canceled); + do_check_true(download.error === null); + do_check_eq(download.progress, 100); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); +}); + +/** + * Executes download in both public and private modes. + */ +add_task(function* test_public_and_private() +{ + let sourcePath = "/test_public_and_private.txt"; + let sourceUrl = httpUrl("test_public_and_private.txt"); + let testCount = 0; + + // Apply pref to allow all cookies. + Services.prefs.setIntPref("network.cookie.cookieBehavior", 0); + + function cleanup() { + Services.prefs.clearUserPref("network.cookie.cookieBehavior"); + Services.cookies.removeAll(); + gHttpServer.registerPathHandler(sourcePath, null); + } + do_register_cleanup(cleanup); + + gHttpServer.registerPathHandler(sourcePath, function (aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + + if (testCount == 0) { + // No cookies should exist for first public download. + do_check_false(aRequest.hasHeader("Cookie")); + aResponse.setHeader("Set-Cookie", "foobar=1", false); + testCount++; + } else if (testCount == 1) { + // The cookie should exists for second public download. + do_check_true(aRequest.hasHeader("Cookie")); + do_check_eq(aRequest.getHeader("Cookie"), "foobar=1"); + testCount++; + } else if (testCount == 2) { + // No cookies should exist for first private download. + do_check_false(aRequest.hasHeader("Cookie")); + } + }); + + let targetFile = getTempFile(TEST_TARGET_FILE_NAME); + yield Downloads.fetch(sourceUrl, targetFile); + yield Downloads.fetch(sourceUrl, targetFile); + + if (!gUseLegacySaver) { + let download = yield Downloads.createDownload({ + source: { url: sourceUrl, isPrivate: true }, + target: targetFile, + }); + yield download.start(); + } else { + let download = yield promiseStartLegacyDownload(sourceUrl, + { isPrivate: true }); + yield promiseDownloadStopped(download); + } + + cleanup(); +}); + +/** + * Checks the startTime gets updated even after a restart. + */ +add_task(function* test_cancel_immediately_restart_and_check_startTime() +{ + let download = yield promiseStartDownload(); + + let startTime = download.startTime; + do_check_true(isValidDate(download.startTime)); + + yield download.cancel(); + do_check_eq(download.startTime.getTime(), startTime.getTime()); + + // Wait for a timeout. + yield promiseTimeout(10); + + yield download.start(); + do_check_true(download.startTime.getTime() > startTime.getTime()); +}); + +/** + * Executes download with content-encoding. + */ +add_task(function* test_with_content_encoding() +{ + let sourcePath = "/test_with_content_encoding.txt"; + let sourceUrl = httpUrl("test_with_content_encoding.txt"); + + function cleanup() { + gHttpServer.registerPathHandler(sourcePath, null); + } + do_register_cleanup(cleanup); + + gHttpServer.registerPathHandler(sourcePath, function (aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + aResponse.setHeader("Content-Encoding", "gzip", false); + aResponse.setHeader("Content-Length", + "" + TEST_DATA_SHORT_GZIP_ENCODED.length, false); + + let bos = new BinaryOutputStream(aResponse.bodyOutputStream); + bos.writeByteArray(TEST_DATA_SHORT_GZIP_ENCODED, + TEST_DATA_SHORT_GZIP_ENCODED.length); + }); + + let download = yield promiseStartDownload(sourceUrl); + yield promiseDownloadStopped(download); + + do_check_eq(download.progress, 100); + do_check_eq(download.totalBytes, TEST_DATA_SHORT_GZIP_ENCODED.length); + + // Ensure the content matches the decoded test data. + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); + + cleanup(); +}); + +/** + * Checks that the file is not decoded if the extension matches the encoding. + */ +add_task(function* test_with_content_encoding_ignore_extension() +{ + let sourcePath = "/test_with_content_encoding_ignore_extension.gz"; + let sourceUrl = httpUrl("test_with_content_encoding_ignore_extension.gz"); + + function cleanup() { + gHttpServer.registerPathHandler(sourcePath, null); + } + do_register_cleanup(cleanup); + + gHttpServer.registerPathHandler(sourcePath, function (aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + aResponse.setHeader("Content-Encoding", "gzip", false); + aResponse.setHeader("Content-Length", + "" + TEST_DATA_SHORT_GZIP_ENCODED.length, false); + + let bos = new BinaryOutputStream(aResponse.bodyOutputStream); + bos.writeByteArray(TEST_DATA_SHORT_GZIP_ENCODED, + TEST_DATA_SHORT_GZIP_ENCODED.length); + }); + + let download = yield promiseStartDownload(sourceUrl); + yield promiseDownloadStopped(download); + + do_check_eq(download.progress, 100); + do_check_eq(download.totalBytes, TEST_DATA_SHORT_GZIP_ENCODED.length); + do_check_eq(download.target.size, TEST_DATA_SHORT_GZIP_ENCODED.length); + + // Ensure the content matches the encoded test data. We convert the data to a + // string before executing the content check. + yield promiseVerifyTarget(download.target, + String.fromCharCode.apply(String, TEST_DATA_SHORT_GZIP_ENCODED)); + + cleanup(); +}); + +/** + * Cancels and restarts a download sequentially with content-encoding. + */ +add_task(function* test_cancel_midway_restart_with_content_encoding() +{ + mustInterruptResponses(); + + let download = yield promiseStartDownload(httpUrl("interruptible_gzip.txt")); + + // The first time, cancel the download midway. + let deferCancel = Promise.defer(); + let onchange = function () { + if (!download.stopped && !download.canceled && + download.currentBytes == TEST_DATA_SHORT_GZIP_ENCODED_FIRST.length) { + deferCancel.resolve(download.cancel()); + } + }; + + // Register for the notification, but also call the function directly in + // case the download already reached the expected progress. + download.onchange = onchange; + onchange(); + + yield deferCancel.promise; + + do_check_true(download.stopped); + + // The second time, we'll provide the entire interruptible response. + continueResponses(); + download.onchange = null; + yield download.start(); + + do_check_eq(download.progress, 100); + do_check_eq(download.totalBytes, TEST_DATA_SHORT_GZIP_ENCODED.length); + + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT); +}); + +/** + * Download with parental controls enabled. + */ +add_task(function* test_blocked_parental_controls() +{ + let blockFn = base => ({ + shouldBlockForParentalControls: () => Promise.resolve(true), + }); + + Integration.downloads.register(blockFn); + function cleanup() { + Integration.downloads.unregister(blockFn); + } + do_register_cleanup(cleanup); + + let download; + try { + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we want to check that the promise + // returned by the "start" method is rejected. + download = yield promiseNewDownload(); + yield download.start(); + } else { + // When testing DownloadLegacySaver, we cannot be sure whether we are + // testing the promise returned by the "start" method or we are testing + // the "error" property checked by promiseDownloadStopped. This happens + // because we don't have control over when the download is started. + download = yield promiseStartLegacyDownload(); + yield promiseDownloadStopped(download); + } + do_throw("The download should have blocked."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseBlocked) { + throw ex; + } + do_check_true(ex.becauseBlockedByParentalControls); + do_check_true(download.error.becauseBlockedByParentalControls); + } + + // Now that the download stopped, the target file should not exist. + do_check_false(yield OS.File.exists(download.target.path)); + + cleanup(); +}); + +/** + * Test a download that will be blocked by Windows parental controls by + * resulting in an HTTP status code of 450. + */ +add_task(function* test_blocked_parental_controls_httpstatus450() +{ + let download; + try { + if (!gUseLegacySaver) { + download = yield promiseNewDownload(httpUrl("parentalblocked.zip")); + yield download.start(); + } + else { + download = yield promiseStartLegacyDownload(httpUrl("parentalblocked.zip")); + yield promiseDownloadStopped(download); + } + do_throw("The download should have blocked."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseBlocked) { + throw ex; + } + do_check_true(ex.becauseBlockedByParentalControls); + do_check_true(download.error.becauseBlockedByParentalControls); + do_check_true(download.stopped); + } + + do_check_false(yield OS.File.exists(download.target.path)); +}); + +/** + * Download with runtime permissions + */ +add_task(function* test_blocked_runtime_permissions() +{ + let blockFn = base => ({ + shouldBlockForRuntimePermissions: () => Promise.resolve(true), + }); + + Integration.downloads.register(blockFn); + function cleanup() { + Integration.downloads.unregister(blockFn); + } + do_register_cleanup(cleanup); + + let download; + try { + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we want to check that the promise + // returned by the "start" method is rejected. + download = yield promiseNewDownload(); + yield download.start(); + } else { + // When testing DownloadLegacySaver, we cannot be sure whether we are + // testing the promise returned by the "start" method or we are testing + // the "error" property checked by promiseDownloadStopped. This happens + // because we don't have control over when the download is started. + download = yield promiseStartLegacyDownload(); + yield promiseDownloadStopped(download); + } + do_throw("The download should have blocked."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseBlocked) { + throw ex; + } + do_check_true(ex.becauseBlockedByRuntimePermissions); + do_check_true(download.error.becauseBlockedByRuntimePermissions); + } + + // Now that the download stopped, the target file should not exist. + do_check_false(yield OS.File.exists(download.target.path)); + + cleanup(); +}); + +/** + * Check that DownloadCopySaver can always retrieve the hash. + * DownloadLegacySaver can only retrieve the hash when + * nsIExternalHelperAppService is invoked. + */ +add_task(function* test_getSha256Hash() +{ + if (!gUseLegacySaver) { + let download = yield promiseStartDownload(httpUrl("source.txt")); + yield promiseDownloadStopped(download); + do_check_true(download.stopped); + do_check_eq(32, download.saver.getSha256Hash().length); + } +}); + +/** + * Create a download which will be reputation blocked. + * + * @param options + * { + * keepPartialData: bool, + * keepBlockedData: bool, + * } + * @return {Promise} + * @resolves The reputation blocked download. + * @rejects JavaScript exception. + */ +var promiseBlockedDownload = Task.async(function* (options) { + let blockFn = base => ({ + shouldBlockForReputationCheck: () => Promise.resolve({ + shouldBlock: true, + verdict: Downloads.Error.BLOCK_VERDICT_UNCOMMON, + }), + shouldKeepBlockedData: () => Promise.resolve(options.keepBlockedData), + }); + + Integration.downloads.register(blockFn); + function cleanup() { + Integration.downloads.unregister(blockFn); + } + do_register_cleanup(cleanup); + + let download; + + try { + if (options.keepPartialData) { + download = yield promiseStartDownload_tryToKeepPartialData(); + continueResponses(); + } else if (gUseLegacySaver) { + download = yield promiseStartLegacyDownload(); + } else { + download = yield promiseNewDownload(); + yield download.start(); + do_throw("The download should have blocked."); + } + + yield promiseDownloadStopped(download); + do_throw("The download should have blocked."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseBlocked) { + throw ex; + } + do_check_true(ex.becauseBlockedByReputationCheck); + do_check_eq(ex.reputationCheckVerdict, + Downloads.Error.BLOCK_VERDICT_UNCOMMON); + do_check_true(download.error.becauseBlockedByReputationCheck); + do_check_eq(download.error.reputationCheckVerdict, + Downloads.Error.BLOCK_VERDICT_UNCOMMON); + } + + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_false(yield OS.File.exists(download.target.path)); + + cleanup(); + return download; +}); + +/** + * Checks that application reputation blocks the download and the target file + * does not exist. + */ +add_task(function* test_blocked_applicationReputation() +{ + let download = yield promiseBlockedDownload({ + keepPartialData: false, + keepBlockedData: false, + }); + + // Now that the download is blocked, the target file should not exist. + do_check_false(yield OS.File.exists(download.target.path)); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); + + // There should also be no blocked data in this case + do_check_false(download.hasBlockedData); +}); + +/** + * Checks that if a download restarts while processing an application reputation + * request, the status is handled correctly. + */ +add_task(function* test_blocked_applicationReputation_race() +{ + let isFirstShouldBlockCall = true; + + let blockFn = base => ({ + shouldBlockForReputationCheck(download) { + if (isFirstShouldBlockCall) { + isFirstShouldBlockCall = false; + + // 2. Cancel and restart the download before the first attempt has a + // chance to finish. + download.cancel(); + download.removePartialData(); + download.start(); + + // 3. Allow the first attempt to finish with a blocked response. + return Promise.resolve({ + shouldBlock: true, + verdict: Downloads.Error.BLOCK_VERDICT_UNCOMMON, + }); + } + + // 4/5. Don't block the download the second time. The race condition would + // occur with the first attempt regardless of whether the second one + // is blocked, but not blocking here makes the test simpler. + return Promise.resolve({ + shouldBlock: false, + verdict: "", + }); + }, + shouldKeepBlockedData: () => Promise.resolve(true), + }); + + Integration.downloads.register(blockFn); + function cleanup() { + Integration.downloads.unregister(blockFn); + } + do_register_cleanup(cleanup); + + let download; + + try { + // 1. Start the download and get a reference to the promise asociated with + // the first attempt, before allowing the response to continue. + download = yield promiseStartDownload_tryToKeepPartialData(); + let firstAttempt = promiseDownloadStopped(download); + continueResponses(); + + // 4/5. Wait for the first attempt to be completed. The result of this + // should appear as a cancellation. + yield firstAttempt; + + do_throw("The first attempt should have been canceled."); + } catch (ex) { + // The "becauseBlocked" property should be false. + if (!(ex instanceof Downloads.Error) || ex.becauseBlocked) { + throw ex; + } + } + + // 6. Wait for the second attempt to be completed. + yield promiseDownloadStopped(download); + + // 7. At this point, "hasBlockedData" should be false. + do_check_false(download.hasBlockedData); + + cleanup(); +}); + +/** + * Checks that application reputation blocks the download but maintains the + * blocked data, which will be deleted when the block is confirmed. + */ +add_task(function* test_blocked_applicationReputation_confirmBlock() +{ + let download = yield promiseBlockedDownload({ + keepPartialData: true, + keepBlockedData: true, + }); + + do_check_true(download.hasBlockedData); + do_check_true(yield OS.File.exists(download.target.partFilePath)); + + yield download.confirmBlock(); + + // After confirming the block the download should be in a failed state and + // have no downloaded data left on disk. + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_false(download.hasBlockedData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + do_check_false(yield OS.File.exists(download.target.path)); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); +}); + +/** + * Checks that application reputation blocks the download but maintains the + * blocked data, which will be used to complete the download when unblocking. + */ +add_task(function* test_blocked_applicationReputation_unblock() +{ + let download = yield promiseBlockedDownload({ + keepPartialData: true, + keepBlockedData: true, + }); + + do_check_true(download.hasBlockedData); + do_check_true(yield OS.File.exists(download.target.partFilePath)); + + yield download.unblock(); + + // After unblocking the download should have succeeded and be + // present at the final path. + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.hasBlockedData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + yield promiseVerifyTarget(download.target, TEST_DATA_SHORT + TEST_DATA_SHORT); + + // The only indication the download was previously blocked is the + // existence of the error, so we make sure it's still set. + do_check_true(download.error instanceof Downloads.Error); + do_check_true(download.error.becauseBlocked); + do_check_true(download.error.becauseBlockedByReputationCheck); +}); + +/** + * Check that calling cancel on a blocked download will not cause errors + */ +add_task(function* test_blocked_applicationReputation_cancel() +{ + let download = yield promiseBlockedDownload({ + keepPartialData: true, + keepBlockedData: true, + }); + + // This call should succeed on a blocked download. + yield download.cancel(); + + // Calling cancel should not have changed the current state, the download + // should still be blocked. + do_check_true(download.error.becauseBlockedByReputationCheck); + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_true(download.hasBlockedData); +}); + +/** + * Checks that unblock and confirmBlock cannot race on a blocked download + */ +add_task(function* test_blocked_applicationReputation_decisionRace() +{ + let download = yield promiseBlockedDownload({ + keepPartialData: true, + keepBlockedData: true, + }); + + let unblockPromise = download.unblock(); + let confirmBlockPromise = download.confirmBlock(); + + yield confirmBlockPromise.then(() => { + do_throw("confirmBlock should have failed."); + }, () => {}); + + yield unblockPromise; + + // After unblocking the download should have succeeded and be + // present at the final path. + do_check_true(download.stopped); + do_check_true(download.succeeded); + do_check_false(download.hasBlockedData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + do_check_true(yield OS.File.exists(download.target.path)); + + download = yield promiseBlockedDownload({ + keepPartialData: true, + keepBlockedData: true, + }); + + confirmBlockPromise = download.confirmBlock(); + unblockPromise = download.unblock(); + + yield unblockPromise.then(() => { + do_throw("unblock should have failed."); + }, () => {}); + + yield confirmBlockPromise; + + // After confirming the block the download should be in a failed state and + // have no downloaded data left on disk. + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_false(download.hasBlockedData); + do_check_false(yield OS.File.exists(download.target.partFilePath)); + do_check_false(yield OS.File.exists(download.target.path)); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); +}); + +/** + * Checks that unblocking a blocked download fails if the blocked data has been + * removed. + */ +add_task(function* test_blocked_applicationReputation_unblock() +{ + let download = yield promiseBlockedDownload({ + keepPartialData: true, + keepBlockedData: true, + }); + + do_check_true(download.hasBlockedData); + do_check_true(yield OS.File.exists(download.target.partFilePath)); + + // Remove the blocked data without telling the download. + yield OS.File.remove(download.target.partFilePath); + + let unblockPromise = download.unblock(); + yield unblockPromise.then(() => { + do_throw("unblock should have failed."); + }, () => {}); + + // Even though unblocking failed the download state should have been updated + // to reflect the lack of blocked data. + do_check_false(download.hasBlockedData); + do_check_true(download.stopped); + do_check_false(download.succeeded); + do_check_false(download.target.exists); + do_check_eq(download.target.size, 0); +}); + +/** + * download.showContainingDirectory() action + */ +add_task(function* test_showContainingDirectory() { + let targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + + let download = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt") }, + target: "" + }); + + let promiseDirectoryShown = waitForDirectoryShown(); + yield download.showContainingDirectory(); + let path = yield promiseDirectoryShown; + try { + new FileUtils.File(path); + do_throw("Should have failed because of an invalid path."); + } catch (ex) { + if (!(ex instanceof Components.Exception)) { + throw ex; + } + // Invalid paths on Windows are reported with NS_ERROR_FAILURE, + // but with NS_ERROR_FILE_UNRECOGNIZED_PATH on Mac/Linux + let validResult = ex.result == Cr.NS_ERROR_FILE_UNRECOGNIZED_PATH || + ex.result == Cr.NS_ERROR_FAILURE; + do_check_true(validResult); + } + + download = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt") }, + target: targetPath + }); + + promiseDirectoryShown = waitForDirectoryShown(); + download.showContainingDirectory(); + yield promiseDirectoryShown; +}); + +/** + * download.launch() action + */ +add_task(function* test_launch() { + let customLauncher = getTempFile("app-launcher"); + + // Test both with and without setting a custom application. + for (let launcherPath of [null, customLauncher.path]) { + let download; + if (!gUseLegacySaver) { + // When testing DownloadCopySaver, we have control over the download, thus + // we can test that file is not launched if download.succeeded is not set. + download = yield Downloads.createDownload({ + source: httpUrl("source.txt"), + target: getTempFile(TEST_TARGET_FILE_NAME).path, + launcherPath: launcherPath, + launchWhenSucceeded: true + }); + + try { + yield download.launch(); + do_throw("Can't launch download file as it has not completed yet"); + } catch (ex) { + do_check_eq(ex.message, + "launch can only be called if the download succeeded"); + } + + yield download.start(); + } else { + // When testing DownloadLegacySaver, the download is already started when + // it is created, thus we don't test calling "launch" before starting. + download = yield promiseStartLegacyDownload( + httpUrl("source.txt"), + { launcherPath: launcherPath, + launchWhenSucceeded: true }); + yield promiseDownloadStopped(download); + } + + do_check_true(download.launchWhenSucceeded); + + let promiseFileLaunched = waitForFileLaunched(); + download.launch(); + let result = yield promiseFileLaunched; + + // Verify that the results match the test case. + if (!launcherPath) { + // This indicates that the default handler has been chosen. + do_check_true(result === null); + } else { + // Check the nsIMIMEInfo instance that would have been used for launching. + do_check_eq(result.preferredAction, Ci.nsIMIMEInfo.useHelperApp); + do_check_true(result.preferredApplicationHandler + .QueryInterface(Ci.nsILocalHandlerApp) + .executable.equals(customLauncher)); + } + } +}); + +/** + * Test passing an invalid path as the launcherPath property. + */ +add_task(function* test_launcherPath_invalid() { + let download = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt") }, + target: { path: getTempFile(TEST_TARGET_FILE_NAME).path }, + launcherPath: " " + }); + + let promiseDownloadLaunched = new Promise(resolve => { + let waitFn = base => ({ + __proto__: base, + launchDownload() { + Integration.downloads.unregister(waitFn); + let superPromise = super.launchDownload(...arguments); + resolve(superPromise); + return superPromise; + }, + }); + Integration.downloads.register(waitFn); + }); + + yield download.start(); + try { + download.launch(); + yield promiseDownloadLaunched; + do_throw("Can't launch file with invalid custom launcher") + } catch (ex) { + if (!(ex instanceof Components.Exception)) { + throw ex; + } + // Invalid paths on Windows are reported with NS_ERROR_FAILURE, + // but with NS_ERROR_FILE_UNRECOGNIZED_PATH on Mac/Linux + let validResult = ex.result == Cr.NS_ERROR_FILE_UNRECOGNIZED_PATH || + ex.result == Cr.NS_ERROR_FAILURE; + do_check_true(validResult); + } +}); + +/** + * Tests that download.launch() is automatically called after + * the download finishes if download.launchWhenSucceeded = true + */ +add_task(function* test_launchWhenSucceeded() { + let customLauncher = getTempFile("app-launcher"); + + // Test both with and without setting a custom application. + for (let launcherPath of [null, customLauncher.path]) { + let promiseFileLaunched = waitForFileLaunched(); + + if (!gUseLegacySaver) { + let download = yield Downloads.createDownload({ + source: httpUrl("source.txt"), + target: getTempFile(TEST_TARGET_FILE_NAME).path, + launchWhenSucceeded: true, + launcherPath: launcherPath, + }); + yield download.start(); + } else { + let download = yield promiseStartLegacyDownload( + httpUrl("source.txt"), + { launcherPath: launcherPath, + launchWhenSucceeded: true }); + yield promiseDownloadStopped(download); + } + + let result = yield promiseFileLaunched; + + // Verify that the results match the test case. + if (!launcherPath) { + // This indicates that the default handler has been chosen. + do_check_true(result === null); + } else { + // Check the nsIMIMEInfo instance that would have been used for launching. + do_check_eq(result.preferredAction, Ci.nsIMIMEInfo.useHelperApp); + do_check_true(result.preferredApplicationHandler + .QueryInterface(Ci.nsILocalHandlerApp) + .executable.equals(customLauncher)); + } + } +}); + +/** + * Tests that the proper content type is set for a normal download. + */ +add_task(function* test_contentType() { + let download = yield promiseStartDownload(httpUrl("source.txt")); + yield promiseDownloadStopped(download); + + do_check_eq("text/plain", download.contentType); +}); + +/** + * Tests that the serialization/deserialization of the startTime Date + * object works correctly. + */ +add_task(function* test_toSerializable_startTime() +{ + let download1 = yield promiseStartDownload(httpUrl("source.txt")); + yield promiseDownloadStopped(download1); + + let serializable = download1.toSerializable(); + let reserialized = JSON.parse(JSON.stringify(serializable)); + + let download2 = yield Downloads.createDownload(reserialized); + + do_check_eq(download1.startTime.constructor.name, "Date"); + do_check_eq(download2.startTime.constructor.name, "Date"); + do_check_eq(download1.startTime.toJSON(), download2.startTime.toJSON()); +}); + +/** + * Checks that downloads are added to browsing history when they start. + */ +add_task(function* test_history() +{ + mustInterruptResponses(); + + // We will wait for the visit to be notified during the download. + yield PlacesTestUtils.clearHistory(); + let promiseVisit = promiseWaitForVisit(httpUrl("interruptible.txt")); + + // Start a download that is not allowed to finish yet. + let download = yield promiseStartDownload(httpUrl("interruptible.txt")); + + // The history notifications should be received before the download completes. + let [time, transitionType] = yield promiseVisit; + do_check_eq(time, download.startTime.getTime() * 1000); + do_check_eq(transitionType, Ci.nsINavHistoryService.TRANSITION_DOWNLOAD); + + // Restart and complete the download after clearing history. + yield PlacesTestUtils.clearHistory(); + download.cancel(); + continueResponses(); + yield download.start(); + + // The restart should not have added a new history visit. + do_check_false(yield promiseIsURIVisited(httpUrl("interruptible.txt"))); +}); + +/** + * Checks that downloads started by nsIHelperAppService are added to the + * browsing history when they start. + */ +add_task(function* test_history_tryToKeepPartialData() +{ + // We will wait for the visit to be notified during the download. + yield PlacesTestUtils.clearHistory(); + let promiseVisit = + promiseWaitForVisit(httpUrl("interruptible_resumable.txt")); + + // Start a download that is not allowed to finish yet. + let beforeStartTimeMs = Date.now(); + let download = yield promiseStartDownload_tryToKeepPartialData(); + + // The history notifications should be received before the download completes. + let [time, transitionType] = yield promiseVisit; + do_check_eq(transitionType, Ci.nsINavHistoryService.TRANSITION_DOWNLOAD); + + // The time set by nsIHelperAppService may be different than the start time in + // the download object, thus we only check that it is a meaningful time. Note + // that we subtract one second from the earliest time to account for rounding. + do_check_true(time >= beforeStartTimeMs * 1000 - 1000000); + + // Complete the download before finishing the test. + continueResponses(); + yield promiseDownloadStopped(download); +}); + +/** + * Tests that the temp download files are removed on exit and exiting private + * mode after they have been launched. + */ +add_task(function* test_launchWhenSucceeded_deleteTempFileOnExit() { + let customLauncherPath = getTempFile("app-launcher").path; + let autoDeleteTargetPathOne = getTempFile(TEST_TARGET_FILE_NAME).path; + let autoDeleteTargetPathTwo = getTempFile(TEST_TARGET_FILE_NAME).path; + let noAutoDeleteTargetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + + let autoDeleteDownloadOne = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt"), isPrivate: true }, + target: autoDeleteTargetPathOne, + launchWhenSucceeded: true, + launcherPath: customLauncherPath, + }); + yield autoDeleteDownloadOne.start(); + + Services.prefs.setBoolPref(kDeleteTempFileOnExit, true); + let autoDeleteDownloadTwo = yield Downloads.createDownload({ + source: httpUrl("source.txt"), + target: autoDeleteTargetPathTwo, + launchWhenSucceeded: true, + launcherPath: customLauncherPath, + }); + yield autoDeleteDownloadTwo.start(); + + Services.prefs.setBoolPref(kDeleteTempFileOnExit, false); + let noAutoDeleteDownload = yield Downloads.createDownload({ + source: httpUrl("source.txt"), + target: noAutoDeleteTargetPath, + launchWhenSucceeded: true, + launcherPath: customLauncherPath, + }); + yield noAutoDeleteDownload.start(); + + Services.prefs.clearUserPref(kDeleteTempFileOnExit); + + do_check_true(yield OS.File.exists(autoDeleteTargetPathOne)); + do_check_true(yield OS.File.exists(autoDeleteTargetPathTwo)); + do_check_true(yield OS.File.exists(noAutoDeleteTargetPath)); + + // Simulate leaving private browsing mode + Services.obs.notifyObservers(null, "last-pb-context-exited", null); + do_check_false(yield OS.File.exists(autoDeleteTargetPathOne)); + + // Simulate browser shutdown + let expire = Cc["@mozilla.org/uriloader/external-helper-app-service;1"] + .getService(Ci.nsIObserver); + expire.observe(null, "profile-before-change", null); + do_check_false(yield OS.File.exists(autoDeleteTargetPathTwo)); + do_check_true(yield OS.File.exists(noAutoDeleteTargetPath)); +}); diff --git a/toolkit/components/jsdownloads/test/unit/head.js b/toolkit/components/jsdownloads/test/unit/head.js new file mode 100644 index 000000000..f322244c4 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/head.js @@ -0,0 +1,843 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Provides infrastructure for automated download components tests. + */ + +"use strict"; + +// Globals + +var Cc = Components.classes; +var Ci = Components.interfaces; +var Cu = Components.utils; +var Cr = Components.results; + +Cu.import("resource://gre/modules/Integration.jsm"); +Cu.import("resource://gre/modules/XPCOMUtils.jsm"); + +XPCOMUtils.defineLazyModuleGetter(this, "DownloadPaths", + "resource://gre/modules/DownloadPaths.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Downloads", + "resource://gre/modules/Downloads.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "FileUtils", + "resource://gre/modules/FileUtils.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "HttpServer", + "resource://testing-common/httpd.js"); +XPCOMUtils.defineLazyModuleGetter(this, "NetUtil", + "resource://gre/modules/NetUtil.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "PlacesTestUtils", + "resource://testing-common/PlacesTestUtils.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "PlacesUtils", + "resource://gre/modules/PlacesUtils.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Promise", + "resource://gre/modules/Promise.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Services", + "resource://gre/modules/Services.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "Task", + "resource://gre/modules/Task.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "MockRegistrar", + "resource://testing-common/MockRegistrar.jsm"); + +XPCOMUtils.defineLazyServiceGetter(this, "gExternalHelperAppService", + "@mozilla.org/uriloader/external-helper-app-service;1", + Ci.nsIExternalHelperAppService); + +Integration.downloads.defineModuleGetter(this, "DownloadIntegration", + "resource://gre/modules/DownloadIntegration.jsm"); + +const ServerSocket = Components.Constructor( + "@mozilla.org/network/server-socket;1", + "nsIServerSocket", + "init"); +const BinaryOutputStream = Components.Constructor( + "@mozilla.org/binaryoutputstream;1", + "nsIBinaryOutputStream", + "setOutputStream") + +XPCOMUtils.defineLazyServiceGetter(this, "gMIMEService", + "@mozilla.org/mime;1", + "nsIMIMEService"); + +const TEST_TARGET_FILE_NAME = "test-download.txt"; +const TEST_STORE_FILE_NAME = "test-downloads.json"; + +const TEST_REFERRER_URL = "http://www.example.com/referrer.html"; + +const TEST_DATA_SHORT = "This test string is downloaded."; +// Generate using gzipCompressString in TelemetryController.jsm. +const TEST_DATA_SHORT_GZIP_ENCODED_FIRST = [ + 31, 139, 8, 0, 0, 0, 0, 0, 0, 3, 11, 201, 200, 44, 86, 40, 73, 45, 46, 81, 40, 46, 41, 202, 204 +]; +const TEST_DATA_SHORT_GZIP_ENCODED_SECOND = [ + 75, 87, 0, 114, 83, 242, 203, 243, 114, 242, 19, 83, 82, 83, 244, 0, 151, 222, 109, 43, 31, 0, 0, 0 +]; +const TEST_DATA_SHORT_GZIP_ENCODED = + TEST_DATA_SHORT_GZIP_ENCODED_FIRST.concat(TEST_DATA_SHORT_GZIP_ENCODED_SECOND); + +/** + * All the tests are implemented with add_task, this starts them automatically. + */ +function run_test() +{ + do_get_profile(); + run_next_test(); +} + +// Support functions + +/** + * HttpServer object initialized before tests start. + */ +var gHttpServer; + +/** + * Given a file name, returns a string containing an URI that points to the file + * on the currently running instance of the test HTTP server. + */ +function httpUrl(aFileName) { + return "http://localhost:" + gHttpServer.identity.primaryPort + "/" + + aFileName; +} + +// While the previous test file should have deleted all the temporary files it +// used, on Windows these might still be pending deletion on the physical file +// system. Thus, start from a new base number every time, to make a collision +// with a file that is still pending deletion highly unlikely. +var gFileCounter = Math.floor(Math.random() * 1000000); + +/** + * Returns a reference to a temporary file, that is guaranteed not to exist, and + * to have never been created before. + * + * @param aLeafName + * Suggested leaf name for the file to be created. + * + * @return nsIFile pointing to a non-existent file in a temporary directory. + * + * @note It is not enough to delete the file if it exists, or to delete the file + * after calling nsIFile.createUnique, because on Windows the delete + * operation in the file system may still be pending, preventing a new + * file with the same name to be created. + */ +function getTempFile(aLeafName) +{ + // Prepend a serial number to the extension in the suggested leaf name. + let [base, ext] = DownloadPaths.splitBaseNameAndExtension(aLeafName); + let leafName = base + "-" + gFileCounter + ext; + gFileCounter++; + + // Get a file reference under the temporary directory for this test file. + let file = FileUtils.getFile("TmpD", [leafName]); + do_check_false(file.exists()); + + do_register_cleanup(function () { + try { + file.remove(false) + } catch (e) { + if (!(e instanceof Components.Exception && + (e.result == Cr.NS_ERROR_FILE_ACCESS_DENIED || + e.result == Cr.NS_ERROR_FILE_TARGET_DOES_NOT_EXIST || + e.result == Cr.NS_ERROR_FILE_NOT_FOUND))) { + throw e; + } + // On Windows, we may get an access denied error if the file existed before, + // and was recently deleted. + // Don't bother checking file.exists() as that may also cause an access + // denied error. + } + }); + + return file; +} + +/** + * Waits for pending events to be processed. + * + * @return {Promise} + * @resolves When pending events have been processed. + * @rejects Never. + */ +function promiseExecuteSoon() +{ + let deferred = Promise.defer(); + do_execute_soon(deferred.resolve); + return deferred.promise; +} + +/** + * Waits for a pending events to be processed after a timeout. + * + * @return {Promise} + * @resolves When pending events have been processed. + * @rejects Never. + */ +function promiseTimeout(aTime) +{ + let deferred = Promise.defer(); + do_timeout(aTime, deferred.resolve); + return deferred.promise; +} + +/** + * Waits for a new history visit to be notified for the specified URI. + * + * @param aUrl + * String containing the URI that will be visited. + * + * @return {Promise} + * @resolves Array [aTime, aTransitionType] from nsINavHistoryObserver.onVisit. + * @rejects Never. + */ +function promiseWaitForVisit(aUrl) +{ + let deferred = Promise.defer(); + + let uri = NetUtil.newURI(aUrl); + + PlacesUtils.history.addObserver({ + QueryInterface: XPCOMUtils.generateQI([Ci.nsINavHistoryObserver]), + onBeginUpdateBatch: function () {}, + onEndUpdateBatch: function () {}, + onVisit: function (aURI, aVisitID, aTime, aSessionID, aReferringID, + aTransitionType, aGUID, aHidden) { + if (aURI.equals(uri)) { + PlacesUtils.history.removeObserver(this); + deferred.resolve([aTime, aTransitionType]); + } + }, + onTitleChanged: function () {}, + onDeleteURI: function () {}, + onClearHistory: function () {}, + onPageChanged: function () {}, + onDeleteVisits: function () {}, + }, false); + + return deferred.promise; +} + +/** + * Check browsing history to see whether the given URI has been visited. + * + * @param aUrl + * String containing the URI that will be visited. + * + * @return {Promise} + * @resolves Boolean indicating whether the URI has been visited. + * @rejects JavaScript exception. + */ +function promiseIsURIVisited(aUrl) { + let deferred = Promise.defer(); + + PlacesUtils.asyncHistory.isURIVisited(NetUtil.newURI(aUrl), + function (aURI, aIsVisited) { + deferred.resolve(aIsVisited); + }); + + return deferred.promise; +} + +/** + * Creates a new Download object, setting a temporary file as the target. + * + * @param aSourceUrl + * String containing the URI for the download source, or null to use + * httpUrl("source.txt"). + * + * @return {Promise} + * @resolves The newly created Download object. + * @rejects JavaScript exception. + */ +function promiseNewDownload(aSourceUrl) { + return Downloads.createDownload({ + source: aSourceUrl || httpUrl("source.txt"), + target: getTempFile(TEST_TARGET_FILE_NAME), + }); +} + +/** + * Starts a new download using the nsIWebBrowserPersist interface, and controls + * it using the legacy nsITransfer interface. + * + * @param aSourceUrl + * String containing the URI for the download source, or null to use + * httpUrl("source.txt"). + * @param aOptions + * An optional object used to control the behavior of this function. + * You may pass an object with a subset of the following fields: + * { + * isPrivate: Boolean indicating whether the download originated from a + * private window. + * targetFile: nsIFile for the target, or null to use a temporary file. + * outPersist: Receives a reference to the created nsIWebBrowserPersist + * instance. + * launchWhenSucceeded: Boolean indicating whether the target should + * be launched when it has completed successfully. + * launcherPath: String containing the path of the custom executable to + * use to launch the target of the download. + * } + * + * @return {Promise} + * @resolves The Download object created as a consequence of controlling the + * download through the legacy nsITransfer interface. + * @rejects Never. The current test fails in case of exceptions. + */ +function promiseStartLegacyDownload(aSourceUrl, aOptions) { + let sourceURI = NetUtil.newURI(aSourceUrl || httpUrl("source.txt")); + let targetFile = (aOptions && aOptions.targetFile) + || getTempFile(TEST_TARGET_FILE_NAME); + + let persist = Cc["@mozilla.org/embedding/browser/nsWebBrowserPersist;1"] + .createInstance(Ci.nsIWebBrowserPersist); + if (aOptions) { + aOptions.outPersist = persist; + } + + let fileExtension = null, mimeInfo = null; + let match = sourceURI.path.match(/\.([^.\/]+)$/); + if (match) { + fileExtension = match[1]; + } + + if (fileExtension) { + try { + mimeInfo = gMIMEService.getFromTypeAndExtension(null, fileExtension); + mimeInfo.preferredAction = Ci.nsIMIMEInfo.saveToDisk; + } catch (ex) { } + } + + if (aOptions && aOptions.launcherPath) { + do_check_true(mimeInfo != null); + + let localHandlerApp = Cc["@mozilla.org/uriloader/local-handler-app;1"] + .createInstance(Ci.nsILocalHandlerApp); + localHandlerApp.executable = new FileUtils.File(aOptions.launcherPath); + + mimeInfo.preferredApplicationHandler = localHandlerApp; + mimeInfo.preferredAction = Ci.nsIMIMEInfo.useHelperApp; + } + + if (aOptions && aOptions.launchWhenSucceeded) { + do_check_true(mimeInfo != null); + + mimeInfo.preferredAction = Ci.nsIMIMEInfo.useHelperApp; + } + + // Apply decoding if required by the "Content-Encoding" header. + persist.persistFlags &= ~Ci.nsIWebBrowserPersist.PERSIST_FLAGS_NO_CONVERSION; + persist.persistFlags |= + Ci.nsIWebBrowserPersist.PERSIST_FLAGS_AUTODETECT_APPLY_CONVERSION; + + let transfer = Cc["@mozilla.org/transfer;1"].createInstance(Ci.nsITransfer); + + let deferred = Promise.defer(); + + Downloads.getList(Downloads.ALL).then(function (aList) { + // Temporarily register a view that will get notified when the download we + // are controlling becomes visible in the list of downloads. + aList.addView({ + onDownloadAdded: function (aDownload) { + aList.removeView(this).then(null, do_report_unexpected_exception); + + // Remove the download to keep the list empty for the next test. This + // also allows the caller to register the "onchange" event directly. + let promise = aList.remove(aDownload); + + // When the download object is ready, make it available to the caller. + promise.then(() => deferred.resolve(aDownload), + do_report_unexpected_exception); + }, + }).then(null, do_report_unexpected_exception); + + let isPrivate = aOptions && aOptions.isPrivate; + + // Initialize the components so they reference each other. This will cause + // the Download object to be created and added to the public downloads. + transfer.init(sourceURI, NetUtil.newURI(targetFile), null, mimeInfo, null, + null, persist, isPrivate); + persist.progressListener = transfer; + + // Start the actual download process. + persist.savePrivacyAwareURI(sourceURI, null, null, 0, null, null, targetFile, + isPrivate); + }.bind(this)).then(null, do_report_unexpected_exception); + + return deferred.promise; +} + +/** + * Starts a new download using the nsIHelperAppService interface, and controls + * it using the legacy nsITransfer interface. The source of the download will + * be "interruptible_resumable.txt" and partially downloaded data will be kept. + * + * @param aSourceUrl + * String containing the URI for the download source, or null to use + * httpUrl("interruptible_resumable.txt"). + * + * @return {Promise} + * @resolves The Download object created as a consequence of controlling the + * download through the legacy nsITransfer interface. + * @rejects Never. The current test fails in case of exceptions. + */ +function promiseStartExternalHelperAppServiceDownload(aSourceUrl) { + let sourceURI = NetUtil.newURI(aSourceUrl || + httpUrl("interruptible_resumable.txt")); + + let deferred = Promise.defer(); + + Downloads.getList(Downloads.PUBLIC).then(function (aList) { + // Temporarily register a view that will get notified when the download we + // are controlling becomes visible in the list of downloads. + aList.addView({ + onDownloadAdded: function (aDownload) { + aList.removeView(this).then(null, do_report_unexpected_exception); + + // Remove the download to keep the list empty for the next test. This + // also allows the caller to register the "onchange" event directly. + let promise = aList.remove(aDownload); + + // When the download object is ready, make it available to the caller. + promise.then(() => deferred.resolve(aDownload), + do_report_unexpected_exception); + }, + }).then(null, do_report_unexpected_exception); + + let channel = NetUtil.newChannel({ + uri: sourceURI, + loadUsingSystemPrincipal: true + }); + + // Start the actual download process. + channel.asyncOpen2({ + contentListener: null, + + onStartRequest: function (aRequest, aContext) + { + let requestChannel = aRequest.QueryInterface(Ci.nsIChannel); + this.contentListener = gExternalHelperAppService.doContent( + requestChannel.contentType, aRequest, null, true); + this.contentListener.onStartRequest(aRequest, aContext); + }, + + onStopRequest: function (aRequest, aContext, aStatusCode) + { + this.contentListener.onStopRequest(aRequest, aContext, aStatusCode); + }, + + onDataAvailable: function (aRequest, aContext, aInputStream, aOffset, + aCount) + { + this.contentListener.onDataAvailable(aRequest, aContext, aInputStream, + aOffset, aCount); + }, + }); + }.bind(this)).then(null, do_report_unexpected_exception); + + return deferred.promise; +} + +/** + * Waits for a download to reach half of its progress, in case it has not + * reached the expected progress already. + * + * @param aDownload + * The Download object to wait upon. + * + * @return {Promise} + * @resolves When the download has reached half of its progress. + * @rejects Never. + */ +function promiseDownloadMidway(aDownload) { + let deferred = Promise.defer(); + + // Wait for the download to reach half of its progress. + let onchange = function () { + if (!aDownload.stopped && !aDownload.canceled && aDownload.progress == 50) { + aDownload.onchange = null; + deferred.resolve(); + } + }; + + // Register for the notification, but also call the function directly in + // case the download already reached the expected progress. + aDownload.onchange = onchange; + onchange(); + + return deferred.promise; +} + +/** + * Waits for a download to finish, in case it has not finished already. + * + * @param aDownload + * The Download object to wait upon. + * + * @return {Promise} + * @resolves When the download has finished successfully. + * @rejects JavaScript exception if the download failed. + */ +function promiseDownloadStopped(aDownload) { + if (!aDownload.stopped) { + // The download is in progress, wait for the current attempt to finish and + // report any errors that may occur. + return aDownload.start(); + } + + if (aDownload.succeeded) { + return Promise.resolve(); + } + + // The download failed or was canceled. + return Promise.reject(aDownload.error || new Error("Download canceled.")); +} + +/** + * Returns a new public or private DownloadList object. + * + * @param aIsPrivate + * True for the private list, false or undefined for the public list. + * + * @return {Promise} + * @resolves The newly created DownloadList object. + * @rejects JavaScript exception. + */ +function promiseNewList(aIsPrivate) +{ + // We need to clear all the internal state for the list and summary objects, + // since all the objects are interdependent internally. + Downloads._promiseListsInitialized = null; + Downloads._lists = {}; + Downloads._summaries = {}; + + return Downloads.getList(aIsPrivate ? Downloads.PRIVATE : Downloads.PUBLIC); +} + +/** + * Ensures that the given file contents are equal to the given string. + * + * @param aPath + * String containing the path of the file whose contents should be + * verified. + * @param aExpectedContents + * String containing the octets that are expected in the file. + * + * @return {Promise} + * @resolves When the operation completes. + * @rejects Never. + */ +function promiseVerifyContents(aPath, aExpectedContents) +{ + return Task.spawn(function* () { + let file = new FileUtils.File(aPath); + + if (!(yield OS.File.exists(aPath))) { + do_throw("File does not exist: " + aPath); + } + + if ((yield OS.File.stat(aPath)).size == 0) { + do_throw("File is empty: " + aPath); + } + + let deferred = Promise.defer(); + NetUtil.asyncFetch( + { uri: NetUtil.newURI(file), loadUsingSystemPrincipal: true }, + function(aInputStream, aStatus) { + do_check_true(Components.isSuccessCode(aStatus)); + let contents = NetUtil.readInputStreamToString(aInputStream, + aInputStream.available()); + if (contents.length > TEST_DATA_SHORT.length * 2 || + /[^\x20-\x7E]/.test(contents)) { + // Do not print the entire content string to the test log. + do_check_eq(contents.length, aExpectedContents.length); + do_check_true(contents == aExpectedContents); + } else { + // Print the string if it is short and made of printable characters. + do_check_eq(contents, aExpectedContents); + } + deferred.resolve(); + }); + + yield deferred.promise; + }); +} + +/** + * Starts a socket listener that closes each incoming connection. + * + * @returns nsIServerSocket that listens for connections. Call its "close" + * method to stop listening and free the server port. + */ +function startFakeServer() +{ + let serverSocket = new ServerSocket(-1, true, -1); + serverSocket.asyncListen({ + onSocketAccepted: function (aServ, aTransport) { + aTransport.close(Cr.NS_BINDING_ABORTED); + }, + onStopListening: function () { }, + }); + return serverSocket; +} + +/** + * This is an internal reference that should not be used directly by tests. + */ +var _gDeferResponses = Promise.defer(); + +/** + * Ensures that all the interruptible requests started after this function is + * called won't complete until the continueResponses function is called. + * + * Normally, the internal HTTP server returns all the available data as soon as + * a request is received. In order for some requests to be served one part at a + * time, special interruptible handlers are registered on the HTTP server. This + * allows testing events or actions that need to happen in the middle of a + * download. + * + * For example, the handler accessible at the httpUri("interruptible.txt") + * address returns the TEST_DATA_SHORT text, then it may block until the + * continueResponses method is called. At this point, the handler sends the + * TEST_DATA_SHORT text again to complete the response. + * + * If an interruptible request is started before the function is called, it may + * or may not be blocked depending on the actual sequence of events. + */ +function mustInterruptResponses() +{ + // If there are pending blocked requests, allow them to complete. This is + // done to prevent requests from being blocked forever, but should not affect + // the test logic, since previously started requests should not be monitored + // on the client side anymore. + _gDeferResponses.resolve(); + + do_print("Interruptible responses will be blocked midway."); + _gDeferResponses = Promise.defer(); +} + +/** + * Allows all the current and future interruptible requests to complete. + */ +function continueResponses() +{ + do_print("Interruptible responses are now allowed to continue."); + _gDeferResponses.resolve(); +} + +/** + * Registers an interruptible response handler. + * + * @param aPath + * Path passed to nsIHttpServer.registerPathHandler. + * @param aFirstPartFn + * This function is called when the response is received, with the + * aRequest and aResponse arguments of the server. + * @param aSecondPartFn + * This function is called with the aRequest and aResponse arguments of + * the server, when the continueResponses function is called. + */ +function registerInterruptibleHandler(aPath, aFirstPartFn, aSecondPartFn) +{ + gHttpServer.registerPathHandler(aPath, function (aRequest, aResponse) { + do_print("Interruptible request started."); + + // Process the first part of the response. + aResponse.processAsync(); + aFirstPartFn(aRequest, aResponse); + + // Wait on the current deferred object, then finish the request. + _gDeferResponses.promise.then(function RIH_onSuccess() { + aSecondPartFn(aRequest, aResponse); + aResponse.finish(); + do_print("Interruptible request finished."); + }).then(null, Cu.reportError); + }); +} + +/** + * Ensure the given date object is valid. + * + * @param aDate + * The date object to be checked. This value can be null. + */ +function isValidDate(aDate) { + return aDate && aDate.getTime && !isNaN(aDate.getTime()); +} + +/** + * Position of the first byte served by the "interruptible_resumable.txt" + * handler during the most recent response. + */ +var gMostRecentFirstBytePos; + +// Initialization functions common to all tests + +add_task(function test_common_initialize() +{ + // Start the HTTP server. + gHttpServer = new HttpServer(); + gHttpServer.registerDirectory("/", do_get_file("../data")); + gHttpServer.start(-1); + do_register_cleanup(() => { + return new Promise(resolve => { + // Ensure all the pending HTTP requests have a chance to finish. + continueResponses(); + // Stop the HTTP server, calling resolve when it's done. + gHttpServer.stop(resolve); + }); + }); + + // Cache locks might prevent concurrent requests to the same resource, and + // this may block tests that use the interruptible handlers. + Services.prefs.setBoolPref("browser.cache.disk.enable", false); + Services.prefs.setBoolPref("browser.cache.memory.enable", false); + do_register_cleanup(function () { + Services.prefs.clearUserPref("browser.cache.disk.enable"); + Services.prefs.clearUserPref("browser.cache.memory.enable"); + }); + + registerInterruptibleHandler("/interruptible.txt", + function firstPart(aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + aResponse.setHeader("Content-Length", "" + (TEST_DATA_SHORT.length * 2), + false); + aResponse.write(TEST_DATA_SHORT); + }, function secondPart(aRequest, aResponse) { + aResponse.write(TEST_DATA_SHORT); + }); + + registerInterruptibleHandler("/interruptible_resumable.txt", + function firstPart(aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + + // Determine if only part of the data should be sent. + let data = TEST_DATA_SHORT + TEST_DATA_SHORT; + if (aRequest.hasHeader("Range")) { + var matches = aRequest.getHeader("Range") + .match(/^\s*bytes=(\d+)?-(\d+)?\s*$/); + var firstBytePos = (matches[1] === undefined) ? 0 : matches[1]; + var lastBytePos = (matches[2] === undefined) ? data.length - 1 + : matches[2]; + if (firstBytePos >= data.length) { + aResponse.setStatusLine(aRequest.httpVersion, 416, + "Requested Range Not Satisfiable"); + aResponse.setHeader("Content-Range", "*/" + data.length, false); + aResponse.finish(); + return; + } + + aResponse.setStatusLine(aRequest.httpVersion, 206, "Partial Content"); + aResponse.setHeader("Content-Range", firstBytePos + "-" + + lastBytePos + "/" + + data.length, false); + + data = data.substring(firstBytePos, lastBytePos + 1); + + gMostRecentFirstBytePos = firstBytePos; + } else { + gMostRecentFirstBytePos = 0; + } + + aResponse.setHeader("Content-Length", "" + data.length, false); + + aResponse.write(data.substring(0, data.length / 2)); + + // Store the second part of the data on the response object, so that it + // can be used by the secondPart function. + aResponse.secondPartData = data.substring(data.length / 2); + }, function secondPart(aRequest, aResponse) { + aResponse.write(aResponse.secondPartData); + }); + + registerInterruptibleHandler("/interruptible_gzip.txt", + function firstPart(aRequest, aResponse) { + aResponse.setHeader("Content-Type", "text/plain", false); + aResponse.setHeader("Content-Encoding", "gzip", false); + aResponse.setHeader("Content-Length", "" + TEST_DATA_SHORT_GZIP_ENCODED.length); + + let bos = new BinaryOutputStream(aResponse.bodyOutputStream); + bos.writeByteArray(TEST_DATA_SHORT_GZIP_ENCODED_FIRST, + TEST_DATA_SHORT_GZIP_ENCODED_FIRST.length); + }, function secondPart(aRequest, aResponse) { + let bos = new BinaryOutputStream(aResponse.bodyOutputStream); + bos.writeByteArray(TEST_DATA_SHORT_GZIP_ENCODED_SECOND, + TEST_DATA_SHORT_GZIP_ENCODED_SECOND.length); + }); + + gHttpServer.registerPathHandler("/shorter-than-content-length-http-1-1.txt", + function (aRequest, aResponse) { + aResponse.processAsync(); + aResponse.setStatusLine("1.1", 200, "OK"); + aResponse.setHeader("Content-Type", "text/plain", false); + aResponse.setHeader("Content-Length", "" + (TEST_DATA_SHORT.length * 2), + false); + aResponse.write(TEST_DATA_SHORT); + aResponse.finish(); + }); + + // This URL will emulate being blocked by Windows Parental controls + gHttpServer.registerPathHandler("/parentalblocked.zip", + function (aRequest, aResponse) { + aResponse.setStatusLine(aRequest.httpVersion, 450, + "Blocked by Windows Parental Controls"); + }); + + // During unit tests, most of the functions that require profile access or + // operating system features will be disabled. Individual tests may override + // them again to check for specific behaviors. + Integration.downloads.register(base => ({ + __proto__: base, + loadPublicDownloadListFromStore: () => Promise.resolve(), + shouldKeepBlockedData: () => Promise.resolve(false), + shouldBlockForParentalControls: () => Promise.resolve(false), + shouldBlockForRuntimePermissions: () => Promise.resolve(false), + shouldBlockForReputationCheck: () => Promise.resolve({ + shouldBlock: false, + verdict: "", + }), + confirmLaunchExecutable: () => Promise.resolve(), + launchFile: () => Promise.resolve(), + showContainingDirectory: () => Promise.resolve(), + // This flag allows re-enabling the default observers during their tests. + allowObservers: false, + addListObservers() { + return this.allowObservers ? super.addListObservers(...arguments) + : Promise.resolve(); + }, + // This flag allows re-enabling the download directory logic for its tests. + _allowDirectories: false, + set allowDirectories(value) { + this._allowDirectories = value; + // We have to invalidate the previously computed directory path. + this._downloadsDirectory = null; + }, + _getDirectory(name) { + return super._getDirectory(this._allowDirectories ? name : "TmpD"); + }, + })); + + // Make sure that downloads started using nsIExternalHelperAppService are + // saved to disk without asking for a destination interactively. + let mock = { + QueryInterface: XPCOMUtils.generateQI([Ci.nsIHelperAppLauncherDialog]), + promptForSaveToFileAsync(aLauncher, + aWindowContext, + aDefaultFileName, + aSuggestedFileExtension, + aForcePrompt) { + // The dialog should create the empty placeholder file. + let file = getTempFile(TEST_TARGET_FILE_NAME); + file.create(Ci.nsIFile.NORMAL_FILE_TYPE, FileUtils.PERMS_FILE); + aLauncher.saveDestinationAvailable(file); + }, + }; + + let cid = MockRegistrar.register("@mozilla.org/helperapplauncherdialog;1", mock); + do_register_cleanup(() => { + MockRegistrar.unregister(cid); + }); +}); diff --git a/toolkit/components/jsdownloads/test/unit/test_DownloadCore.js b/toolkit/components/jsdownloads/test/unit/test_DownloadCore.js new file mode 100644 index 000000000..6e32c63d3 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_DownloadCore.js @@ -0,0 +1,87 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the main download interfaces using DownloadCopySaver. + */ + +"use strict"; + +XPCOMUtils.defineLazyModuleGetter(this, "DownloadError", + "resource://gre/modules/DownloadCore.jsm"); + +// Execution of common tests + +var gUseLegacySaver = false; + +var scriptFile = do_get_file("common_test_Download.js"); +Services.scriptloader.loadSubScript(NetUtil.newURI(scriptFile).spec); + +// Tests + +/** + * Tests the DownloadError object. + */ +add_task(function test_DownloadError() +{ + let error = new DownloadError({ result: Cr.NS_ERROR_NOT_RESUMABLE, + message: "Not resumable."}); + do_check_eq(error.result, Cr.NS_ERROR_NOT_RESUMABLE); + do_check_eq(error.message, "Not resumable."); + do_check_false(error.becauseSourceFailed); + do_check_false(error.becauseTargetFailed); + do_check_false(error.becauseBlocked); + do_check_false(error.becauseBlockedByParentalControls); + + error = new DownloadError({ message: "Unknown error."}); + do_check_eq(error.result, Cr.NS_ERROR_FAILURE); + do_check_eq(error.message, "Unknown error."); + + error = new DownloadError({ result: Cr.NS_ERROR_NOT_RESUMABLE }); + do_check_eq(error.result, Cr.NS_ERROR_NOT_RESUMABLE); + do_check_true(error.message.indexOf("Exception") > 0); + + // becauseSourceFailed will be set, but not the unknown property. + error = new DownloadError({ message: "Unknown error.", + becauseSourceFailed: true, + becauseUnknown: true }); + do_check_true(error.becauseSourceFailed); + do_check_false("becauseUnknown" in error); + + error = new DownloadError({ result: Cr.NS_ERROR_MALFORMED_URI, + inferCause: true }); + do_check_eq(error.result, Cr.NS_ERROR_MALFORMED_URI); + do_check_true(error.becauseSourceFailed); + do_check_false(error.becauseTargetFailed); + do_check_false(error.becauseBlocked); + do_check_false(error.becauseBlockedByParentalControls); + + // This test does not set inferCause, so becauseSourceFailed will not be set. + error = new DownloadError({ result: Cr.NS_ERROR_MALFORMED_URI }); + do_check_eq(error.result, Cr.NS_ERROR_MALFORMED_URI); + do_check_false(error.becauseSourceFailed); + + error = new DownloadError({ result: Cr.NS_ERROR_FILE_INVALID_PATH, + inferCause: true }); + do_check_eq(error.result, Cr.NS_ERROR_FILE_INVALID_PATH); + do_check_false(error.becauseSourceFailed); + do_check_true(error.becauseTargetFailed); + do_check_false(error.becauseBlocked); + do_check_false(error.becauseBlockedByParentalControls); + + error = new DownloadError({ becauseBlocked: true }); + do_check_eq(error.message, "Download blocked."); + do_check_false(error.becauseSourceFailed); + do_check_false(error.becauseTargetFailed); + do_check_true(error.becauseBlocked); + do_check_false(error.becauseBlockedByParentalControls); + + error = new DownloadError({ becauseBlockedByParentalControls: true }); + do_check_eq(error.message, "Download blocked."); + do_check_false(error.becauseSourceFailed); + do_check_false(error.becauseTargetFailed); + do_check_true(error.becauseBlocked); + do_check_true(error.becauseBlockedByParentalControls); +}); diff --git a/toolkit/components/jsdownloads/test/unit/test_DownloadImport.js b/toolkit/components/jsdownloads/test/unit/test_DownloadImport.js new file mode 100644 index 000000000..388870f00 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_DownloadImport.js @@ -0,0 +1,701 @@ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the DownloadImport object. + */ + +"use strict"; + +// Globals + +XPCOMUtils.defineLazyModuleGetter(this, "Sqlite", + "resource://gre/modules/Sqlite.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "DownloadImport", + "resource://gre/modules/DownloadImport.jsm"); + +// Importable states +const DOWNLOAD_NOTSTARTED = -1; +const DOWNLOAD_DOWNLOADING = 0; +const DOWNLOAD_PAUSED = 4; +const DOWNLOAD_QUEUED = 5; + +// Non importable states +const DOWNLOAD_FAILED = 2; +const DOWNLOAD_CANCELED = 3; +const DOWNLOAD_BLOCKED_PARENTAL = 6; +const DOWNLOAD_SCANNING = 7; +const DOWNLOAD_DIRTY = 8; +const DOWNLOAD_BLOCKED_POLICY = 9; + +// The TEST_DATA_TAINTED const is a version of TEST_DATA_SHORT in which the +// beginning of the data was changed (with the TEST_DATA_REPLACEMENT value). +// We use this to test that the entityID is properly imported and the download +// can be resumed from where it was paused. +// For simplification purposes, the test requires that TEST_DATA_SHORT and +// TEST_DATA_TAINTED have the same length. +const TEST_DATA_REPLACEMENT = "-changed- "; +const TEST_DATA_TAINTED = TEST_DATA_REPLACEMENT + + TEST_DATA_SHORT.substr(TEST_DATA_REPLACEMENT.length); +const TEST_DATA_LENGTH = TEST_DATA_SHORT.length; + +// The length of the partial file that we'll write to disk as an existing +// ongoing download. +const TEST_DATA_PARTIAL_LENGTH = TEST_DATA_REPLACEMENT.length; + +// The value of the "maxBytes" column stored in the DB about the downloads. +// It's intentionally different than TEST_DATA_LENGTH to test that each value +// is seen when expected. +const MAXBYTES_IN_DB = TEST_DATA_LENGTH - 10; + +var gDownloadsRowToImport; +var gDownloadsRowNonImportable; + +/** + * Creates a database with an empty moz_downloads table and leaves an + * open connection to it. + * + * @param aPath + * String containing the path of the database file to be created. + * @param aSchemaVersion + * Number with the version of the database schema to set. + * + * @return {Promise} + * @resolves The open connection to the database. + * @rejects If an error occurred during the database creation. + */ +function promiseEmptyDatabaseConnection({aPath, aSchemaVersion}) { + return Task.spawn(function* () { + let connection = yield Sqlite.openConnection({ path: aPath }); + + yield connection.execute("CREATE TABLE moz_downloads (" + + "id INTEGER PRIMARY KEY," + + "name TEXT," + + "source TEXT," + + "target TEXT," + + "tempPath TEXT," + + "startTime INTEGER," + + "endTime INTEGER," + + "state INTEGER," + + "referrer TEXT," + + "entityID TEXT," + + "currBytes INTEGER NOT NULL DEFAULT 0," + + "maxBytes INTEGER NOT NULL DEFAULT -1," + + "mimeType TEXT," + + "preferredApplication TEXT," + + "preferredAction INTEGER NOT NULL DEFAULT 0," + + "autoResume INTEGER NOT NULL DEFAULT 0," + + "guid TEXT)"); + + yield connection.setSchemaVersion(aSchemaVersion); + + return connection; + }); +} + +/** + * Inserts a new entry in the database with the given columns' values. + * + * @param aConnection + * The database connection. + * @param aDownloadRow + * An object representing the values for each column of the row + * being inserted. + * + * @return {Promise} + * @resolves When the operation completes. + * @rejects If there's an error inserting the row. + */ +function promiseInsertRow(aConnection, aDownloadRow) { + // We can't use the aDownloadRow obj directly in the execute statement + // because the obj bind code in Sqlite.jsm doesn't allow objects + // with extra properties beyond those being binded. So we might as well + // use an array as it is simpler. + let values = [ + aDownloadRow.source, aDownloadRow.target, aDownloadRow.tempPath, + aDownloadRow.startTime.getTime() * 1000, aDownloadRow.state, + aDownloadRow.referrer, aDownloadRow.entityID, aDownloadRow.maxBytes, + aDownloadRow.mimeType, aDownloadRow.preferredApplication, + aDownloadRow.preferredAction, aDownloadRow.autoResume + ]; + + return aConnection.execute("INSERT INTO moz_downloads (" + + "name, source, target, tempPath, startTime," + + "endTime, state, referrer, entityID, currBytes," + + "maxBytes, mimeType, preferredApplication," + + "preferredAction, autoResume, guid)" + + "VALUES (" + + "'', ?, ?, ?, ?, " // name, + + "0, ?, ?, ?, 0, " // endTime, currBytes + + " ?, ?, ?, " // + + " ?, ?, '')", // and guid are not imported + values); +} + +/** + * Retrieves the number of rows in the moz_downloads table of the + * database. + * + * @param aConnection + * The database connection. + * + * @return {Promise} + * @resolves With the number of rows. + * @rejects Never. + */ +function promiseTableCount(aConnection) { + return aConnection.execute("SELECT COUNT(*) FROM moz_downloads") + .then(res => res[0].getResultByName("COUNT(*)")) + .then(null, Cu.reportError); +} + +/** + * Briefly opens a network channel to a given URL to retrieve + * the entityID of this url, as generated by the network code. + * + * @param aUrl + * The URL to retrieve the entityID. + * + * @return {Promise} + * @resolves The EntityID of the given URL. + * @rejects When there's a problem accessing the URL. + */ +function promiseEntityID(aUrl) { + let deferred = Promise.defer(); + let entityID = ""; + let channel = NetUtil.newChannel({ + uri: NetUtil.newURI(aUrl), + loadUsingSystemPrincipal: true + }); + + channel.asyncOpen2({ + onStartRequest: function (aRequest) { + if (aRequest instanceof Ci.nsIResumableChannel) { + entityID = aRequest.entityID; + } + aRequest.cancel(Cr.NS_BINDING_ABORTED); + }, + + onStopRequest: function (aRequest, aContext, aStatusCode) { + if (aStatusCode == Cr.NS_BINDING_ABORTED) { + deferred.resolve(entityID); + } else { + deferred.reject("Unexpected status code received"); + } + }, + + onDataAvailable: function () {} + }); + + return deferred.promise; +} + +/** + * Gets a file path to a temporary writeable download target, in the + * correct format as expected to be stored in the downloads database, + * which is file:///absolute/path/to/file + * + * @param aLeafName + * A hint leaf name for the file. + * + * @return String The path to the download target. + */ +function getDownloadTarget(aLeafName) { + return NetUtil.newURI(getTempFile(aLeafName)).spec; +} + +/** + * Generates a temporary partial file to use as an in-progress + * download. The file is written to disk with a part of the total expected + * download content pre-written. + * + * @param aLeafName + * A hint leaf name for the file. + * @param aTainted + * A boolean value. When true, the partial content of the file + * will be different from the expected content of the original source + * file. See the declaration of TEST_DATA_TAINTED for more information. + * + * @return {Promise} + * @resolves When the operation completes, and returns a string with the path + * to the generated file. + * @rejects If there's an error writing the file. + */ +function getPartialFile(aLeafName, aTainted = false) { + let tempDownload = getTempFile(aLeafName); + let partialContent = aTainted + ? TEST_DATA_TAINTED.substr(0, TEST_DATA_PARTIAL_LENGTH) + : TEST_DATA_SHORT.substr(0, TEST_DATA_PARTIAL_LENGTH); + + return OS.File.writeAtomic(tempDownload.path, partialContent, + { tmpPath: tempDownload.path + ".tmp", + flush: true }) + .then(() => tempDownload.path); +} + +/** + * Generates a Date object to be used as the startTime for the download rows + * in the DB. A date that is obviously different from the current time is + * generated to make sure this stored data and a `new Date()` can't collide. + * + * @param aOffset + * A offset from the base generated date is used to differentiate each + * row in the database. + * + * @return A Date object. + */ +function getStartTime(aOffset) { + return new Date(1000000 + (aOffset * 10000)); +} + +/** + * Performs various checks on an imported Download object to make sure + * all properties are properly set as expected from the import procedure. + * + * @param aDownload + * The Download object to be checked. + * @param aDownloadRow + * An object that represents a row from the original database table, + * with extra properties describing expected values that are not + * explictly part of the database. + * + * @return {Promise} + * @resolves When the operation completes + * @rejects Never + */ +function checkDownload(aDownload, aDownloadRow) { + return Task.spawn(function*() { + do_check_eq(aDownload.source.url, aDownloadRow.source); + do_check_eq(aDownload.source.referrer, aDownloadRow.referrer); + + do_check_eq(aDownload.target.path, + NetUtil.newURI(aDownloadRow.target) + .QueryInterface(Ci.nsIFileURL).file.path); + + do_check_eq(aDownload.target.partFilePath, aDownloadRow.tempPath); + + if (aDownloadRow.expectedResume) { + do_check_true(!aDownload.stopped || aDownload.succeeded); + yield promiseDownloadStopped(aDownload); + + do_check_true(aDownload.succeeded); + do_check_eq(aDownload.progress, 100); + // If the download has resumed, a new startTime will be set. + // By calling toJSON we're also testing that startTime is a Date object. + do_check_neq(aDownload.startTime.toJSON(), + aDownloadRow.startTime.toJSON()); + } else { + do_check_false(aDownload.succeeded); + do_check_eq(aDownload.startTime.toJSON(), + aDownloadRow.startTime.toJSON()); + } + + do_check_eq(aDownload.stopped, true); + + let serializedSaver = aDownload.saver.toSerializable(); + if (typeof(serializedSaver) == "object") { + do_check_eq(serializedSaver.type, "copy"); + } else { + do_check_eq(serializedSaver, "copy"); + } + + if (aDownloadRow.entityID) { + do_check_eq(aDownload.saver.entityID, aDownloadRow.entityID); + } + + do_check_eq(aDownload.currentBytes, aDownloadRow.expectedCurrentBytes); + do_check_eq(aDownload.totalBytes, aDownloadRow.expectedTotalBytes); + + if (aDownloadRow.expectedContent) { + let fileToCheck = aDownloadRow.expectedResume + ? aDownload.target.path + : aDownload.target.partFilePath; + yield promiseVerifyContents(fileToCheck, aDownloadRow.expectedContent); + } + + do_check_eq(aDownload.contentType, aDownloadRow.expectedContentType); + do_check_eq(aDownload.launcherPath, aDownloadRow.preferredApplication); + + do_check_eq(aDownload.launchWhenSucceeded, + aDownloadRow.preferredAction != Ci.nsIMIMEInfo.saveToDisk); + }); +} + +// Preparation tasks + +/** + * Prepares the list of downloads to be added to the database that should + * be imported by the import procedure. + */ +add_task(function* prepareDownloadsToImport() { + + let sourceUrl = httpUrl("source.txt"); + let sourceEntityId = yield promiseEntityID(sourceUrl); + + gDownloadsRowToImport = [ + // Paused download with autoResume and a partial file. By + // setting the correct entityID the download can resume from + // where it stopped, and to test that this works properly we + // intentionally set different data in the beginning of the + // partial file to make sure it was not replaced. + { + source: sourceUrl, + target: getDownloadTarget("inprogress1.txt"), + tempPath: yield getPartialFile("inprogress1.txt.part", true), + startTime: getStartTime(1), + state: DOWNLOAD_PAUSED, + referrer: httpUrl("referrer1"), + entityID: sourceEntityId, + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType1", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication1", + autoResume: 1, + + // Even though the information stored in the DB said + // maxBytes was MAXBYTES_IN_DB, the download turned out to be + // a different length. Here we make sure the totalBytes property + // was correctly set with the actual value. The same consideration + // applies to the contentType. + expectedCurrentBytes: TEST_DATA_LENGTH, + expectedTotalBytes: TEST_DATA_LENGTH, + expectedResume: true, + expectedContentType: "text/plain", + expectedContent: TEST_DATA_TAINTED, + }, + + // Paused download with autoResume and a partial file, + // but missing entityID. This means that the download will + // start from beginning, and the entire original content of the + // source file should replace the different data that was stored + // in the partial file. + { + source: sourceUrl, + target: getDownloadTarget("inprogress2.txt"), + tempPath: yield getPartialFile("inprogress2.txt.part", true), + startTime: getStartTime(2), + state: DOWNLOAD_PAUSED, + referrer: httpUrl("referrer2"), + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType2", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication2", + autoResume: 1, + + expectedCurrentBytes: TEST_DATA_LENGTH, + expectedTotalBytes: TEST_DATA_LENGTH, + expectedResume: true, + expectedContentType: "text/plain", + expectedContent: TEST_DATA_SHORT + }, + + // Paused download with no autoResume and a partial file. + { + source: sourceUrl, + target: getDownloadTarget("inprogress3.txt"), + tempPath: yield getPartialFile("inprogress3.txt.part"), + startTime: getStartTime(3), + state: DOWNLOAD_PAUSED, + referrer: httpUrl("referrer3"), + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType3", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication3", + autoResume: 0, + + // Since this download has not been resumed, the actual data + // about its total size and content type is not known. + // Therefore, we're going by the information imported from the DB. + expectedCurrentBytes: TEST_DATA_PARTIAL_LENGTH, + expectedTotalBytes: MAXBYTES_IN_DB, + expectedResume: false, + expectedContentType: "mimeType3", + expectedContent: TEST_DATA_SHORT.substr(0, TEST_DATA_PARTIAL_LENGTH), + }, + + // Paused download with autoResume and no partial file. + { + source: sourceUrl, + target: getDownloadTarget("inprogress4.txt"), + tempPath: "", + startTime: getStartTime(4), + state: DOWNLOAD_PAUSED, + referrer: httpUrl("referrer4"), + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "text/plain", + preferredAction: Ci.nsIMIMEInfo.useHelperApp, + preferredApplication: "prerredApplication4", + autoResume: 1, + + expectedCurrentBytes: TEST_DATA_LENGTH, + expectedTotalBytes: TEST_DATA_LENGTH, + expectedResume: true, + expectedContentType: "text/plain", + expectedContent: TEST_DATA_SHORT + }, + + // Paused download with no autoResume and no partial file. + { + source: sourceUrl, + target: getDownloadTarget("inprogress5.txt"), + tempPath: "", + startTime: getStartTime(5), + state: DOWNLOAD_PAUSED, + referrer: httpUrl("referrer4"), + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "text/plain", + preferredAction: Ci.nsIMIMEInfo.useSystemDefault, + preferredApplication: "prerredApplication5", + autoResume: 0, + + expectedCurrentBytes: 0, + expectedTotalBytes: MAXBYTES_IN_DB, + expectedResume: false, + expectedContentType: "text/plain", + }, + + // Queued download with no autoResume and no partial file. + // Even though autoResume=0, queued downloads always autoResume. + { + source: sourceUrl, + target: getDownloadTarget("inprogress6.txt"), + tempPath: "", + startTime: getStartTime(6), + state: DOWNLOAD_QUEUED, + referrer: httpUrl("referrer6"), + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "text/plain", + preferredAction: Ci.nsIMIMEInfo.useHelperApp, + preferredApplication: "prerredApplication6", + autoResume: 0, + + expectedCurrentBytes: TEST_DATA_LENGTH, + expectedTotalBytes: TEST_DATA_LENGTH, + expectedResume: true, + expectedContentType: "text/plain", + expectedContent: TEST_DATA_SHORT + }, + + // Notstarted download with no autoResume and no partial file. + // Even though autoResume=0, notstarted downloads always autoResume. + { + source: sourceUrl, + target: getDownloadTarget("inprogress7.txt"), + tempPath: "", + startTime: getStartTime(7), + state: DOWNLOAD_NOTSTARTED, + referrer: httpUrl("referrer7"), + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "text/plain", + preferredAction: Ci.nsIMIMEInfo.useHelperApp, + preferredApplication: "prerredApplication7", + autoResume: 0, + + expectedCurrentBytes: TEST_DATA_LENGTH, + expectedTotalBytes: TEST_DATA_LENGTH, + expectedResume: true, + expectedContentType: "text/plain", + expectedContent: TEST_DATA_SHORT + }, + + // Downloading download with no autoResume and a partial file. + // Even though autoResume=0, downloading downloads always autoResume. + { + source: sourceUrl, + target: getDownloadTarget("inprogress8.txt"), + tempPath: yield getPartialFile("inprogress8.txt.part", true), + startTime: getStartTime(8), + state: DOWNLOAD_DOWNLOADING, + referrer: httpUrl("referrer8"), + entityID: sourceEntityId, + maxBytes: MAXBYTES_IN_DB, + mimeType: "text/plain", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication8", + autoResume: 0, + + expectedCurrentBytes: TEST_DATA_LENGTH, + expectedTotalBytes: TEST_DATA_LENGTH, + expectedResume: true, + expectedContentType: "text/plain", + expectedContent: TEST_DATA_TAINTED + }, + ]; +}); + +/** + * Prepares the list of downloads to be added to the database that should + * *not* be imported by the import procedure. + */ +add_task(function* prepareNonImportableDownloads() +{ + gDownloadsRowNonImportable = [ + // Download with no source (should never happen in normal circumstances). + { + source: "", + target: "nonimportable1.txt", + tempPath: "", + startTime: getStartTime(1), + state: DOWNLOAD_PAUSED, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType1", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication1", + autoResume: 1 + }, + + // state = DOWNLOAD_FAILED + { + source: httpUrl("source.txt"), + target: "nonimportable2.txt", + tempPath: "", + startTime: getStartTime(2), + state: DOWNLOAD_FAILED, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType2", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication2", + autoResume: 1 + }, + + // state = DOWNLOAD_CANCELED + { + source: httpUrl("source.txt"), + target: "nonimportable3.txt", + tempPath: "", + startTime: getStartTime(3), + state: DOWNLOAD_CANCELED, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType3", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication3", + autoResume: 1 + }, + + // state = DOWNLOAD_BLOCKED_PARENTAL + { + source: httpUrl("source.txt"), + target: "nonimportable4.txt", + tempPath: "", + startTime: getStartTime(4), + state: DOWNLOAD_BLOCKED_PARENTAL, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType4", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication4", + autoResume: 1 + }, + + // state = DOWNLOAD_SCANNING + { + source: httpUrl("source.txt"), + target: "nonimportable5.txt", + tempPath: "", + startTime: getStartTime(5), + state: DOWNLOAD_SCANNING, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType5", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication5", + autoResume: 1 + }, + + // state = DOWNLOAD_DIRTY + { + source: httpUrl("source.txt"), + target: "nonimportable6.txt", + tempPath: "", + startTime: getStartTime(6), + state: DOWNLOAD_DIRTY, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType6", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication6", + autoResume: 1 + }, + + // state = DOWNLOAD_BLOCKED_POLICY + { + source: httpUrl("source.txt"), + target: "nonimportable7.txt", + tempPath: "", + startTime: getStartTime(7), + state: DOWNLOAD_BLOCKED_POLICY, + referrer: "", + entityID: "", + maxBytes: MAXBYTES_IN_DB, + mimeType: "mimeType7", + preferredAction: Ci.nsIMIMEInfo.saveToDisk, + preferredApplication: "prerredApplication7", + autoResume: 1 + }, + ]; +}); + +// Test + +/** + * Creates a temporary Sqlite database with download data and perform an + * import of that data to the new Downloads API to verify that the import + * worked correctly. + */ +add_task(function* test_downloadImport() +{ + let connection = null; + let downloadsSqlite = getTempFile("downloads.sqlite").path; + + try { + // Set up the database. + connection = yield promiseEmptyDatabaseConnection({ + aPath: downloadsSqlite, + aSchemaVersion: 9 + }); + + // Insert both the importable and non-importable + // downloads together. + for (let downloadRow of gDownloadsRowToImport) { + yield promiseInsertRow(connection, downloadRow); + } + + for (let downloadRow of gDownloadsRowNonImportable) { + yield promiseInsertRow(connection, downloadRow); + } + + // Check that every item was inserted. + do_check_eq((yield promiseTableCount(connection)), + gDownloadsRowToImport.length + + gDownloadsRowNonImportable.length); + } finally { + // Close the connection so that DownloadImport can open it. + yield connection.close(); + } + + // Import items. + let list = yield promiseNewList(false); + yield new DownloadImport(list, downloadsSqlite).import(); + let items = yield list.getAll(); + + do_check_eq(items.length, gDownloadsRowToImport.length); + + for (let i = 0; i < gDownloadsRowToImport.length; i++) { + yield checkDownload(items[i], gDownloadsRowToImport[i]); + } +}) diff --git a/toolkit/components/jsdownloads/test/unit/test_DownloadIntegration.js b/toolkit/components/jsdownloads/test/unit/test_DownloadIntegration.js new file mode 100644 index 000000000..31dd7c7a4 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_DownloadIntegration.js @@ -0,0 +1,432 @@ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the DownloadIntegration object. + */ + +"use strict"; + +// Globals + +/** + * Notifies the prompt observers and verify the expected downloads count. + * + * @param aIsPrivate + * Flag to know is test private observers. + * @param aExpectedCount + * the expected downloads count for quit and offline observers. + * @param aExpectedPBCount + * the expected downloads count for private browsing observer. + */ +function notifyPromptObservers(aIsPrivate, aExpectedCount, aExpectedPBCount) { + let cancelQuit = Cc["@mozilla.org/supports-PRBool;1"]. + createInstance(Ci.nsISupportsPRBool); + + // Notify quit application requested observer. + DownloadIntegration._testPromptDownloads = -1; + Services.obs.notifyObservers(cancelQuit, "quit-application-requested", null); + do_check_eq(DownloadIntegration._testPromptDownloads, aExpectedCount); + + // Notify offline requested observer. + DownloadIntegration._testPromptDownloads = -1; + Services.obs.notifyObservers(cancelQuit, "offline-requested", null); + do_check_eq(DownloadIntegration._testPromptDownloads, aExpectedCount); + + if (aIsPrivate) { + // Notify last private browsing requested observer. + DownloadIntegration._testPromptDownloads = -1; + Services.obs.notifyObservers(cancelQuit, "last-pb-context-exiting", null); + do_check_eq(DownloadIntegration._testPromptDownloads, aExpectedPBCount); + } + + delete DownloadIntegration._testPromptDownloads; +} + +// Tests + +/** + * Allows re-enabling the real download directory logic during one test. + */ +function allowDirectoriesInTest() { + DownloadIntegration.allowDirectories = true; + function cleanup() { + DownloadIntegration.allowDirectories = false; + } + do_register_cleanup(cleanup); + return cleanup; +} + +XPCOMUtils.defineLazyGetter(this, "gStringBundle", function() { + return Services.strings. + createBundle("chrome://mozapps/locale/downloads/downloads.properties"); +}); + +/** + * Tests that getSystemDownloadsDirectory returns an existing directory or + * creates a new directory depending on the platform. Instead of the real + * directory, this test is executed in the temporary directory so we can safely + * delete the created folder to check whether it is created again. + */ +add_task(function* test_getSystemDownloadsDirectory_exists_or_creates() +{ + let tempDir = Services.dirsvc.get("TmpD", Ci.nsIFile); + let downloadDir; + + // OSX / Linux / Windows but not XP/2k + if (Services.appinfo.OS == "Darwin" || + Services.appinfo.OS == "Linux" || + (Services.appinfo.OS == "WINNT" && + parseFloat(Services.sysinfo.getProperty("version")) >= 6)) { + downloadDir = yield DownloadIntegration.getSystemDownloadsDirectory(); + do_check_eq(downloadDir, tempDir.path); + do_check_true(yield OS.File.exists(downloadDir)); + + let info = yield OS.File.stat(downloadDir); + do_check_true(info.isDir); + } else { + let targetPath = OS.Path.join(tempDir.path, + gStringBundle.GetStringFromName("downloadsFolder")); + try { + yield OS.File.removeEmptyDir(targetPath); + } catch (e) {} + downloadDir = yield DownloadIntegration.getSystemDownloadsDirectory(); + do_check_eq(downloadDir, targetPath); + do_check_true(yield OS.File.exists(downloadDir)); + + let info = yield OS.File.stat(downloadDir); + do_check_true(info.isDir); + yield OS.File.removeEmptyDir(targetPath); + } +}); + +/** + * Tests that the real directory returned by getSystemDownloadsDirectory is not + * the one that is used during unit tests. Since this is the actual downloads + * directory of the operating system, we don't try to delete it afterwards. + */ +add_task(function* test_getSystemDownloadsDirectory_real() +{ + let fakeDownloadDir = yield DownloadIntegration.getSystemDownloadsDirectory(); + + let cleanup = allowDirectoriesInTest(); + let realDownloadDir = yield DownloadIntegration.getSystemDownloadsDirectory(); + cleanup(); + + do_check_neq(fakeDownloadDir, realDownloadDir); +}); + +/** + * Tests that the getPreferredDownloadsDirectory returns a valid download + * directory string path. + */ +add_task(function* test_getPreferredDownloadsDirectory() +{ + let cleanupDirectories = allowDirectoriesInTest(); + + let folderListPrefName = "browser.download.folderList"; + let dirPrefName = "browser.download.dir"; + function cleanupPrefs() { + Services.prefs.clearUserPref(folderListPrefName); + Services.prefs.clearUserPref(dirPrefName); + } + do_register_cleanup(cleanupPrefs); + + // Should return the system downloads directory. + Services.prefs.setIntPref(folderListPrefName, 1); + let systemDir = yield DownloadIntegration.getSystemDownloadsDirectory(); + let downloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_neq(downloadDir, ""); + do_check_eq(downloadDir, systemDir); + + // Should return the desktop directory. + Services.prefs.setIntPref(folderListPrefName, 0); + downloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_neq(downloadDir, ""); + do_check_eq(downloadDir, Services.dirsvc.get("Desk", Ci.nsIFile).path); + + // Should return the system downloads directory because the dir preference + // is not set. + Services.prefs.setIntPref(folderListPrefName, 2); + downloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_neq(downloadDir, ""); + do_check_eq(downloadDir, systemDir); + + // Should return the directory which is listed in the dir preference. + let time = (new Date()).getTime(); + let tempDir = Services.dirsvc.get("TmpD", Ci.nsIFile); + tempDir.append(time); + Services.prefs.setComplexValue("browser.download.dir", Ci.nsIFile, tempDir); + downloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_neq(downloadDir, ""); + do_check_eq(downloadDir, tempDir.path); + do_check_true(yield OS.File.exists(downloadDir)); + yield OS.File.removeEmptyDir(tempDir.path); + + // Should return the system downloads directory beacause the path is invalid + // in the dir preference. + tempDir = Services.dirsvc.get("TmpD", Ci.nsIFile); + tempDir.append("dir_not_exist"); + tempDir.append(time); + Services.prefs.setComplexValue("browser.download.dir", Ci.nsIFile, tempDir); + downloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_eq(downloadDir, systemDir); + + // Should return the system downloads directory because the folderList + // preference is invalid + Services.prefs.setIntPref(folderListPrefName, 999); + downloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_eq(downloadDir, systemDir); + + cleanupPrefs(); + cleanupDirectories(); +}); + +/** + * Tests that the getTemporaryDownloadsDirectory returns a valid download + * directory string path. + */ +add_task(function* test_getTemporaryDownloadsDirectory() +{ + let cleanup = allowDirectoriesInTest(); + + let downloadDir = yield DownloadIntegration.getTemporaryDownloadsDirectory(); + do_check_neq(downloadDir, ""); + + if ("nsILocalFileMac" in Ci) { + let preferredDownloadDir = yield DownloadIntegration.getPreferredDownloadsDirectory(); + do_check_eq(downloadDir, preferredDownloadDir); + } else { + let tempDir = Services.dirsvc.get("TmpD", Ci.nsIFile); + do_check_eq(downloadDir, tempDir.path); + } + + cleanup(); +}); + +// Tests DownloadObserver + +/** + * Re-enables the default observers for the following tests. + * + * This takes effect the first time a DownloadList object is created, and lasts + * until this test file has completed. + */ +add_task(function* test_observers_setup() +{ + DownloadIntegration.allowObservers = true; + do_register_cleanup(function () { + DownloadIntegration.allowObservers = false; + }); +}); + +/** + * Tests notifications prompts when observers are notified if there are public + * and private active downloads. + */ +add_task(function* test_notifications() +{ + for (let isPrivate of [false, true]) { + mustInterruptResponses(); + + let list = yield promiseNewList(isPrivate); + let download1 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let download2 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let download3 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let promiseAttempt1 = download1.start(); + let promiseAttempt2 = download2.start(); + download3.start().catch(() => {}); + + // Add downloads to list. + yield list.add(download1); + yield list.add(download2); + yield list.add(download3); + // Cancel third download + yield download3.cancel(); + + notifyPromptObservers(isPrivate, 2, 2); + + // Allow the downloads to complete. + continueResponses(); + yield promiseAttempt1; + yield promiseAttempt2; + + // Clean up. + yield list.remove(download1); + yield list.remove(download2); + yield list.remove(download3); + } +}); + +/** + * Tests that notifications prompts observers are not notified if there are no + * public or private active downloads. + */ +add_task(function* test_no_notifications() +{ + for (let isPrivate of [false, true]) { + let list = yield promiseNewList(isPrivate); + let download1 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let download2 = yield promiseNewDownload(httpUrl("interruptible.txt")); + download1.start().catch(() => {}); + download2.start().catch(() => {}); + + // Add downloads to list. + yield list.add(download1); + yield list.add(download2); + + yield download1.cancel(); + yield download2.cancel(); + + notifyPromptObservers(isPrivate, 0, 0); + + // Clean up. + yield list.remove(download1); + yield list.remove(download2); + } +}); + +/** + * Tests notifications prompts when observers are notified if there are public + * and private active downloads at the same time. + */ +add_task(function* test_mix_notifications() +{ + mustInterruptResponses(); + + let publicList = yield promiseNewList(); + let privateList = yield Downloads.getList(Downloads.PRIVATE); + let download1 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let download2 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let promiseAttempt1 = download1.start(); + let promiseAttempt2 = download2.start(); + + // Add downloads to lists. + yield publicList.add(download1); + yield privateList.add(download2); + + notifyPromptObservers(true, 2, 1); + + // Allow the downloads to complete. + continueResponses(); + yield promiseAttempt1; + yield promiseAttempt2; + + // Clean up. + yield publicList.remove(download1); + yield privateList.remove(download2); +}); + +/** + * Tests suspending and resuming as well as going offline and then online again. + * The downloads should stop when suspending and start again when resuming. + */ +add_task(function* test_suspend_resume() +{ + // The default wake delay is 10 seconds, so set the wake delay to be much + // faster for these tests. + Services.prefs.setIntPref("browser.download.manager.resumeOnWakeDelay", 5); + + let addDownload = function(list) + { + return Task.spawn(function* () { + let download = yield promiseNewDownload(httpUrl("interruptible.txt")); + download.start().catch(() => {}); + list.add(download); + return download; + }); + } + + let publicList = yield promiseNewList(); + let privateList = yield promiseNewList(true); + + let download1 = yield addDownload(publicList); + let download2 = yield addDownload(publicList); + let download3 = yield addDownload(privateList); + let download4 = yield addDownload(privateList); + let download5 = yield addDownload(publicList); + + // First, check that the downloads are all canceled when going to sleep. + Services.obs.notifyObservers(null, "sleep_notification", null); + do_check_true(download1.canceled); + do_check_true(download2.canceled); + do_check_true(download3.canceled); + do_check_true(download4.canceled); + do_check_true(download5.canceled); + + // Remove a download. It should not be started again. + publicList.remove(download5); + do_check_true(download5.canceled); + + // When waking up again, the downloads start again after the wake delay. To be + // more robust, don't check after a delay but instead just wait for the + // downloads to finish. + Services.obs.notifyObservers(null, "wake_notification", null); + yield download1.whenSucceeded(); + yield download2.whenSucceeded(); + yield download3.whenSucceeded(); + yield download4.whenSucceeded(); + + // Downloads should no longer be canceled. However, as download5 was removed + // from the public list, it will not be restarted. + do_check_false(download1.canceled); + do_check_true(download5.canceled); + + // Create four new downloads and check for going offline and then online again. + + download1 = yield addDownload(publicList); + download2 = yield addDownload(publicList); + download3 = yield addDownload(privateList); + download4 = yield addDownload(privateList); + + // Going offline should cancel the downloads. + Services.obs.notifyObservers(null, "network:offline-about-to-go-offline", null); + do_check_true(download1.canceled); + do_check_true(download2.canceled); + do_check_true(download3.canceled); + do_check_true(download4.canceled); + + // Going back online should start the downloads again. + Services.obs.notifyObservers(null, "network:offline-status-changed", "online"); + yield download1.whenSucceeded(); + yield download2.whenSucceeded(); + yield download3.whenSucceeded(); + yield download4.whenSucceeded(); + + Services.prefs.clearUserPref("browser.download.manager.resumeOnWakeDelay"); +}); + +/** + * Tests both the downloads list and the in-progress downloads are clear when + * private browsing observer is notified. + */ +add_task(function* test_exit_private_browsing() +{ + mustInterruptResponses(); + + let privateList = yield promiseNewList(true); + let download1 = yield promiseNewDownload(httpUrl("source.txt")); + let download2 = yield promiseNewDownload(httpUrl("interruptible.txt")); + let promiseAttempt1 = download1.start(); + download2.start(); + + // Add downloads to list. + yield privateList.add(download1); + yield privateList.add(download2); + + // Complete the download. + yield promiseAttempt1; + + do_check_eq((yield privateList.getAll()).length, 2); + + // Simulate exiting the private browsing. + yield new Promise(resolve => { + DownloadIntegration._testResolveClearPrivateList = resolve; + Services.obs.notifyObservers(null, "last-pb-context-exited", null); + }); + delete DownloadIntegration._testResolveClearPrivateList; + + do_check_eq((yield privateList.getAll()).length, 0); + + continueResponses(); +}); diff --git a/toolkit/components/jsdownloads/test/unit/test_DownloadLegacy.js b/toolkit/components/jsdownloads/test/unit/test_DownloadLegacy.js new file mode 100644 index 000000000..dc6c18623 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_DownloadLegacy.js @@ -0,0 +1,17 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the integration with legacy interfaces for downloads. + */ + +"use strict"; + +// Execution of common tests + +var gUseLegacySaver = true; + +var scriptFile = do_get_file("common_test_Download.js"); +Services.scriptloader.loadSubScript(NetUtil.newURI(scriptFile).spec); diff --git a/toolkit/components/jsdownloads/test/unit/test_DownloadList.js b/toolkit/components/jsdownloads/test/unit/test_DownloadList.js new file mode 100644 index 000000000..71e880741 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_DownloadList.js @@ -0,0 +1,564 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the DownloadList object. + */ + +"use strict"; + +// Globals + +/** + * Returns a PRTime in the past usable to add expirable visits. + * + * @note Expiration ignores any visit added in the last 7 days, but it's + * better be safe against DST issues, by going back one day more. + */ +function getExpirablePRTime() +{ + let dateObj = new Date(); + // Normalize to midnight + dateObj.setHours(0); + dateObj.setMinutes(0); + dateObj.setSeconds(0); + dateObj.setMilliseconds(0); + dateObj = new Date(dateObj.getTime() - 8 * 86400000); + return dateObj.getTime() * 1000; +} + +/** + * Adds an expirable history visit for a download. + * + * @param aSourceUrl + * String containing the URI for the download source, or null to use + * httpUrl("source.txt"). + * + * @return {Promise} + * @rejects JavaScript exception. + */ +function promiseExpirableDownloadVisit(aSourceUrl) +{ + let deferred = Promise.defer(); + PlacesUtils.asyncHistory.updatePlaces( + { + uri: NetUtil.newURI(aSourceUrl || httpUrl("source.txt")), + visits: [{ + transitionType: Ci.nsINavHistoryService.TRANSITION_DOWNLOAD, + visitDate: getExpirablePRTime(), + }] + }, + { + handleError: function handleError(aResultCode, aPlaceInfo) { + let ex = new Components.Exception("Unexpected error in adding visits.", + aResultCode); + deferred.reject(ex); + }, + handleResult: function () {}, + handleCompletion: function handleCompletion() { + deferred.resolve(); + } + }); + return deferred.promise; +} + +// Tests + +/** + * Checks the testing mechanism used to build different download lists. + */ +add_task(function* test_construction() +{ + let downloadListOne = yield promiseNewList(); + let downloadListTwo = yield promiseNewList(); + let privateDownloadListOne = yield promiseNewList(true); + let privateDownloadListTwo = yield promiseNewList(true); + + do_check_neq(downloadListOne, downloadListTwo); + do_check_neq(privateDownloadListOne, privateDownloadListTwo); + do_check_neq(downloadListOne, privateDownloadListOne); +}); + +/** + * Checks the methods to add and retrieve items from the list. + */ +add_task(function* test_add_getAll() +{ + let list = yield promiseNewList(); + + let downloadOne = yield promiseNewDownload(); + yield list.add(downloadOne); + + let itemsOne = yield list.getAll(); + do_check_eq(itemsOne.length, 1); + do_check_eq(itemsOne[0], downloadOne); + + let downloadTwo = yield promiseNewDownload(); + yield list.add(downloadTwo); + + let itemsTwo = yield list.getAll(); + do_check_eq(itemsTwo.length, 2); + do_check_eq(itemsTwo[0], downloadOne); + do_check_eq(itemsTwo[1], downloadTwo); + + // The first snapshot should not have been modified. + do_check_eq(itemsOne.length, 1); +}); + +/** + * Checks the method to remove items from the list. + */ +add_task(function* test_remove() +{ + let list = yield promiseNewList(); + + yield list.add(yield promiseNewDownload()); + yield list.add(yield promiseNewDownload()); + + let items = yield list.getAll(); + yield list.remove(items[0]); + + // Removing an item that was never added should not raise an error. + yield list.remove(yield promiseNewDownload()); + + items = yield list.getAll(); + do_check_eq(items.length, 1); +}); + +/** + * Tests that the "add", "remove", and "getAll" methods on the global + * DownloadCombinedList object combine the contents of the global DownloadList + * objects for public and private downloads. + */ +add_task(function* test_DownloadCombinedList_add_remove_getAll() +{ + let publicList = yield promiseNewList(); + let privateList = yield Downloads.getList(Downloads.PRIVATE); + let combinedList = yield Downloads.getList(Downloads.ALL); + + let publicDownload = yield promiseNewDownload(); + let privateDownload = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt"), isPrivate: true }, + target: getTempFile(TEST_TARGET_FILE_NAME).path, + }); + + yield publicList.add(publicDownload); + yield privateList.add(privateDownload); + + do_check_eq((yield combinedList.getAll()).length, 2); + + yield combinedList.remove(publicDownload); + yield combinedList.remove(privateDownload); + + do_check_eq((yield combinedList.getAll()).length, 0); + + yield combinedList.add(publicDownload); + yield combinedList.add(privateDownload); + + do_check_eq((yield publicList.getAll()).length, 1); + do_check_eq((yield privateList.getAll()).length, 1); + do_check_eq((yield combinedList.getAll()).length, 2); + + yield publicList.remove(publicDownload); + yield privateList.remove(privateDownload); + + do_check_eq((yield combinedList.getAll()).length, 0); +}); + +/** + * Checks that views receive the download add and remove notifications, and that + * adding and removing views works as expected, both for a normal and a combined + * list. + */ +add_task(function* test_notifications_add_remove() +{ + for (let isCombined of [false, true]) { + // Force creating a new list for both the public and combined cases. + let list = yield promiseNewList(); + if (isCombined) { + list = yield Downloads.getList(Downloads.ALL); + } + + let downloadOne = yield promiseNewDownload(); + let downloadTwo = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt"), isPrivate: true }, + target: getTempFile(TEST_TARGET_FILE_NAME).path, + }); + yield list.add(downloadOne); + yield list.add(downloadTwo); + + // Check that we receive add notifications for existing elements. + let addNotifications = 0; + let viewOne = { + onDownloadAdded: function (aDownload) { + // The first download to be notified should be the first that was added. + if (addNotifications == 0) { + do_check_eq(aDownload, downloadOne); + } else if (addNotifications == 1) { + do_check_eq(aDownload, downloadTwo); + } + addNotifications++; + }, + }; + yield list.addView(viewOne); + do_check_eq(addNotifications, 2); + + // Check that we receive add notifications for new elements. + yield list.add(yield promiseNewDownload()); + do_check_eq(addNotifications, 3); + + // Check that we receive remove notifications. + let removeNotifications = 0; + let viewTwo = { + onDownloadRemoved: function (aDownload) { + do_check_eq(aDownload, downloadOne); + removeNotifications++; + }, + }; + yield list.addView(viewTwo); + yield list.remove(downloadOne); + do_check_eq(removeNotifications, 1); + + // We should not receive remove notifications after the view is removed. + yield list.removeView(viewTwo); + yield list.remove(downloadTwo); + do_check_eq(removeNotifications, 1); + + // We should not receive add notifications after the view is removed. + yield list.removeView(viewOne); + yield list.add(yield promiseNewDownload()); + do_check_eq(addNotifications, 3); + } +}); + +/** + * Checks that views receive the download change notifications, both for a + * normal and a combined list. + */ +add_task(function* test_notifications_change() +{ + for (let isCombined of [false, true]) { + // Force creating a new list for both the public and combined cases. + let list = yield promiseNewList(); + if (isCombined) { + list = yield Downloads.getList(Downloads.ALL); + } + + let downloadOne = yield promiseNewDownload(); + let downloadTwo = yield Downloads.createDownload({ + source: { url: httpUrl("source.txt"), isPrivate: true }, + target: getTempFile(TEST_TARGET_FILE_NAME).path, + }); + yield list.add(downloadOne); + yield list.add(downloadTwo); + + // Check that we receive change notifications. + let receivedOnDownloadChanged = false; + yield list.addView({ + onDownloadChanged: function (aDownload) { + do_check_eq(aDownload, downloadOne); + receivedOnDownloadChanged = true; + }, + }); + yield downloadOne.start(); + do_check_true(receivedOnDownloadChanged); + + // We should not receive change notifications after a download is removed. + receivedOnDownloadChanged = false; + yield list.remove(downloadTwo); + yield downloadTwo.start(); + do_check_false(receivedOnDownloadChanged); + } +}); + +/** + * Checks that the reference to "this" is correct in the view callbacks. + */ +add_task(function* test_notifications_this() +{ + let list = yield promiseNewList(); + + // Check that we receive change notifications. + let receivedOnDownloadAdded = false; + let receivedOnDownloadChanged = false; + let receivedOnDownloadRemoved = false; + let view = { + onDownloadAdded: function () { + do_check_eq(this, view); + receivedOnDownloadAdded = true; + }, + onDownloadChanged: function () { + // Only do this check once. + if (!receivedOnDownloadChanged) { + do_check_eq(this, view); + receivedOnDownloadChanged = true; + } + }, + onDownloadRemoved: function () { + do_check_eq(this, view); + receivedOnDownloadRemoved = true; + }, + }; + yield list.addView(view); + + let download = yield promiseNewDownload(); + yield list.add(download); + yield download.start(); + yield list.remove(download); + + // Verify that we executed the checks. + do_check_true(receivedOnDownloadAdded); + do_check_true(receivedOnDownloadChanged); + do_check_true(receivedOnDownloadRemoved); +}); + +/** + * Checks that download is removed on history expiration. + */ +add_task(function* test_history_expiration() +{ + mustInterruptResponses(); + + function cleanup() { + Services.prefs.clearUserPref("places.history.expiration.max_pages"); + } + do_register_cleanup(cleanup); + + // Set max pages to 0 to make the download expire. + Services.prefs.setIntPref("places.history.expiration.max_pages", 0); + + let list = yield promiseNewList(); + let downloadOne = yield promiseNewDownload(); + let downloadTwo = yield promiseNewDownload(httpUrl("interruptible.txt")); + + let deferred = Promise.defer(); + let removeNotifications = 0; + let downloadView = { + onDownloadRemoved: function (aDownload) { + if (++removeNotifications == 2) { + deferred.resolve(); + } + }, + }; + yield list.addView(downloadView); + + // Work with one finished download and one canceled download. + yield downloadOne.start(); + downloadTwo.start().catch(() => {}); + yield downloadTwo.cancel(); + + // We must replace the visits added while executing the downloads with visits + // that are older than 7 days, otherwise they will not be expired. + yield PlacesTestUtils.clearHistory(); + yield promiseExpirableDownloadVisit(); + yield promiseExpirableDownloadVisit(httpUrl("interruptible.txt")); + + // After clearing history, we can add the downloads to be removed to the list. + yield list.add(downloadOne); + yield list.add(downloadTwo); + + // Force a history expiration. + Cc["@mozilla.org/places/expiration;1"] + .getService(Ci.nsIObserver).observe(null, "places-debug-start-expiration", -1); + + // Wait for both downloads to be removed. + yield deferred.promise; + + cleanup(); +}); + +/** + * Checks all downloads are removed after clearing history. + */ +add_task(function* test_history_clear() +{ + let list = yield promiseNewList(); + let downloadOne = yield promiseNewDownload(); + let downloadTwo = yield promiseNewDownload(); + yield list.add(downloadOne); + yield list.add(downloadTwo); + + let deferred = Promise.defer(); + let removeNotifications = 0; + let downloadView = { + onDownloadRemoved: function (aDownload) { + if (++removeNotifications == 2) { + deferred.resolve(); + } + }, + }; + yield list.addView(downloadView); + + yield downloadOne.start(); + yield downloadTwo.start(); + + yield PlacesTestUtils.clearHistory(); + + // Wait for the removal notifications that may still be pending. + yield deferred.promise; +}); + +/** + * Tests the removeFinished method to ensure that it only removes + * finished downloads. + */ +add_task(function* test_removeFinished() +{ + let list = yield promiseNewList(); + let downloadOne = yield promiseNewDownload(); + let downloadTwo = yield promiseNewDownload(); + let downloadThree = yield promiseNewDownload(); + let downloadFour = yield promiseNewDownload(); + yield list.add(downloadOne); + yield list.add(downloadTwo); + yield list.add(downloadThree); + yield list.add(downloadFour); + + let deferred = Promise.defer(); + let removeNotifications = 0; + let downloadView = { + onDownloadRemoved: function (aDownload) { + do_check_true(aDownload == downloadOne || + aDownload == downloadTwo || + aDownload == downloadThree); + do_check_true(removeNotifications < 3); + if (++removeNotifications == 3) { + deferred.resolve(); + } + }, + }; + yield list.addView(downloadView); + + // Start three of the downloads, but don't start downloadTwo, then set + // downloadFour to have partial data. All downloads except downloadFour + // should be removed. + yield downloadOne.start(); + yield downloadThree.start(); + yield downloadFour.start(); + downloadFour.hasPartialData = true; + + list.removeFinished(); + yield deferred.promise; + + let downloads = yield list.getAll() + do_check_eq(downloads.length, 1); +}); + +/** + * Tests the global DownloadSummary objects for the public, private, and + * combined download lists. + */ +add_task(function* test_DownloadSummary() +{ + mustInterruptResponses(); + + let publicList = yield promiseNewList(); + let privateList = yield Downloads.getList(Downloads.PRIVATE); + + let publicSummary = yield Downloads.getSummary(Downloads.PUBLIC); + let privateSummary = yield Downloads.getSummary(Downloads.PRIVATE); + let combinedSummary = yield Downloads.getSummary(Downloads.ALL); + + // Add a public download that has succeeded. + let succeededPublicDownload = yield promiseNewDownload(); + yield succeededPublicDownload.start(); + yield publicList.add(succeededPublicDownload); + + // Add a public download that has been canceled midway. + let canceledPublicDownload = + yield promiseNewDownload(httpUrl("interruptible.txt")); + canceledPublicDownload.start().catch(() => {}); + yield promiseDownloadMidway(canceledPublicDownload); + yield canceledPublicDownload.cancel(); + yield publicList.add(canceledPublicDownload); + + // Add a public download that is in progress. + let inProgressPublicDownload = + yield promiseNewDownload(httpUrl("interruptible.txt")); + inProgressPublicDownload.start().catch(() => {}); + yield promiseDownloadMidway(inProgressPublicDownload); + yield publicList.add(inProgressPublicDownload); + + // Add a private download that is in progress. + let inProgressPrivateDownload = yield Downloads.createDownload({ + source: { url: httpUrl("interruptible.txt"), isPrivate: true }, + target: getTempFile(TEST_TARGET_FILE_NAME).path, + }); + inProgressPrivateDownload.start().catch(() => {}); + yield promiseDownloadMidway(inProgressPrivateDownload); + yield privateList.add(inProgressPrivateDownload); + + // Verify that the summary includes the total number of bytes and the + // currently transferred bytes only for the downloads that are not stopped. + // For simplicity, we assume that after a download is added to the list, its + // current state is immediately propagated to the summary object, which is + // true in the current implementation, though it is not guaranteed as all the + // download operations may happen asynchronously. + do_check_false(publicSummary.allHaveStopped); + do_check_eq(publicSummary.progressTotalBytes, TEST_DATA_SHORT.length * 2); + do_check_eq(publicSummary.progressCurrentBytes, TEST_DATA_SHORT.length); + + do_check_false(privateSummary.allHaveStopped); + do_check_eq(privateSummary.progressTotalBytes, TEST_DATA_SHORT.length * 2); + do_check_eq(privateSummary.progressCurrentBytes, TEST_DATA_SHORT.length); + + do_check_false(combinedSummary.allHaveStopped); + do_check_eq(combinedSummary.progressTotalBytes, TEST_DATA_SHORT.length * 4); + do_check_eq(combinedSummary.progressCurrentBytes, TEST_DATA_SHORT.length * 2); + + yield inProgressPublicDownload.cancel(); + + // Stopping the download should have excluded it from the summary. + do_check_true(publicSummary.allHaveStopped); + do_check_eq(publicSummary.progressTotalBytes, 0); + do_check_eq(publicSummary.progressCurrentBytes, 0); + + do_check_false(privateSummary.allHaveStopped); + do_check_eq(privateSummary.progressTotalBytes, TEST_DATA_SHORT.length * 2); + do_check_eq(privateSummary.progressCurrentBytes, TEST_DATA_SHORT.length); + + do_check_false(combinedSummary.allHaveStopped); + do_check_eq(combinedSummary.progressTotalBytes, TEST_DATA_SHORT.length * 2); + do_check_eq(combinedSummary.progressCurrentBytes, TEST_DATA_SHORT.length); + + yield inProgressPrivateDownload.cancel(); + + // All the downloads should be stopped now. + do_check_true(publicSummary.allHaveStopped); + do_check_eq(publicSummary.progressTotalBytes, 0); + do_check_eq(publicSummary.progressCurrentBytes, 0); + + do_check_true(privateSummary.allHaveStopped); + do_check_eq(privateSummary.progressTotalBytes, 0); + do_check_eq(privateSummary.progressCurrentBytes, 0); + + do_check_true(combinedSummary.allHaveStopped); + do_check_eq(combinedSummary.progressTotalBytes, 0); + do_check_eq(combinedSummary.progressCurrentBytes, 0); +}); + +/** + * Checks that views receive the summary change notification. This is tested on + * the combined summary when adding a public download, as we assume that if we + * pass the test in this case we will also pass it in the others. + */ +add_task(function* test_DownloadSummary_notifications() +{ + let list = yield promiseNewList(); + let summary = yield Downloads.getSummary(Downloads.ALL); + + let download = yield promiseNewDownload(); + yield list.add(download); + + // Check that we receive change notifications. + let receivedOnSummaryChanged = false; + yield summary.addView({ + onSummaryChanged: function () { + receivedOnSummaryChanged = true; + }, + }); + yield download.start(); + do_check_true(receivedOnSummaryChanged); +}); diff --git a/toolkit/components/jsdownloads/test/unit/test_DownloadStore.js b/toolkit/components/jsdownloads/test/unit/test_DownloadStore.js new file mode 100644 index 000000000..3a23dfbe3 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_DownloadStore.js @@ -0,0 +1,315 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the DownloadStore object. + */ + +"use strict"; + +// Globals + +XPCOMUtils.defineLazyModuleGetter(this, "DownloadStore", + "resource://gre/modules/DownloadStore.jsm"); +XPCOMUtils.defineLazyModuleGetter(this, "OS", + "resource://gre/modules/osfile.jsm") + +/** + * Returns a new DownloadList object with an associated DownloadStore. + * + * @param aStorePath + * String pointing to the file to be associated with the DownloadStore, + * or undefined to use a non-existing temporary file. In this case, the + * temporary file is deleted when the test file execution finishes. + * + * @return {Promise} + * @resolves Array [ Newly created DownloadList , associated DownloadStore ]. + * @rejects JavaScript exception. + */ +function promiseNewListAndStore(aStorePath) +{ + return promiseNewList().then(function (aList) { + let path = aStorePath || getTempFile(TEST_STORE_FILE_NAME).path; + let store = new DownloadStore(aList, path); + return [aList, store]; + }); +} + +// Tests + +/** + * Saves downloads to a file, then reloads them. + */ +add_task(function* test_save_reload() +{ + let [listForSave, storeForSave] = yield promiseNewListAndStore(); + let [listForLoad, storeForLoad] = yield promiseNewListAndStore( + storeForSave.path); + + listForSave.add(yield promiseNewDownload(httpUrl("source.txt"))); + listForSave.add(yield Downloads.createDownload({ + source: { url: httpUrl("empty.txt"), + referrer: TEST_REFERRER_URL }, + target: getTempFile(TEST_TARGET_FILE_NAME), + })); + + // This PDF download should not be serialized because it never succeeds. + let pdfDownload = yield Downloads.createDownload({ + source: { url: httpUrl("empty.txt"), + referrer: TEST_REFERRER_URL }, + target: getTempFile(TEST_TARGET_FILE_NAME), + saver: "pdf", + }); + listForSave.add(pdfDownload); + + // If we used a callback to adjust the channel, the download should + // not be serialized because we can't recreate it across sessions. + let adjustedDownload = yield Downloads.createDownload({ + source: { url: httpUrl("empty.txt"), + adjustChannel: () => Promise.resolve() }, + target: getTempFile(TEST_TARGET_FILE_NAME), + }); + listForSave.add(adjustedDownload); + + let legacyDownload = yield promiseStartLegacyDownload(); + yield legacyDownload.cancel(); + listForSave.add(legacyDownload); + + yield storeForSave.save(); + yield storeForLoad.load(); + + // Remove the PDF and adjusted downloads because they should not appear here. + listForSave.remove(adjustedDownload); + listForSave.remove(pdfDownload); + + let itemsForSave = yield listForSave.getAll(); + let itemsForLoad = yield listForLoad.getAll(); + + do_check_eq(itemsForSave.length, itemsForLoad.length); + + // Downloads should be reloaded in the same order. + for (let i = 0; i < itemsForSave.length; i++) { + // The reloaded downloads are different objects. + do_check_neq(itemsForSave[i], itemsForLoad[i]); + + // The reloaded downloads have the same properties. + do_check_eq(itemsForSave[i].source.url, + itemsForLoad[i].source.url); + do_check_eq(itemsForSave[i].source.referrer, + itemsForLoad[i].source.referrer); + do_check_eq(itemsForSave[i].target.path, + itemsForLoad[i].target.path); + do_check_eq(itemsForSave[i].saver.toSerializable(), + itemsForLoad[i].saver.toSerializable()); + } +}); + +/** + * Checks that saving an empty list deletes any existing file. + */ +add_task(function* test_save_empty() +{ + let [, store] = yield promiseNewListAndStore(); + + let createdFile = yield OS.File.open(store.path, { create: true }); + yield createdFile.close(); + + yield store.save(); + + do_check_false(yield OS.File.exists(store.path)); + + // If the file does not exist, saving should not generate exceptions. + yield store.save(); +}); + +/** + * Checks that loading from a missing file results in an empty list. + */ +add_task(function* test_load_empty() +{ + let [list, store] = yield promiseNewListAndStore(); + + do_check_false(yield OS.File.exists(store.path)); + + yield store.load(); + + let items = yield list.getAll(); + do_check_eq(items.length, 0); +}); + +/** + * Loads downloads from a string in a predefined format. The purpose of this + * test is to verify that the JSON format used in previous versions can be + * loaded, assuming the file is reloaded on the same platform. + */ +add_task(function* test_load_string_predefined() +{ + let [list, store] = yield promiseNewListAndStore(); + + // The platform-dependent file name should be generated dynamically. + let targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + let filePathLiteral = JSON.stringify(targetPath); + let sourceUriLiteral = JSON.stringify(httpUrl("source.txt")); + let emptyUriLiteral = JSON.stringify(httpUrl("empty.txt")); + let referrerUriLiteral = JSON.stringify(TEST_REFERRER_URL); + + let string = "{\"list\":[{\"source\":" + sourceUriLiteral + "," + + "\"target\":" + filePathLiteral + "}," + + "{\"source\":{\"url\":" + emptyUriLiteral + "," + + "\"referrer\":" + referrerUriLiteral + "}," + + "\"target\":" + filePathLiteral + "}]}"; + + yield OS.File.writeAtomic(store.path, + new TextEncoder().encode(string), + { tmpPath: store.path + ".tmp" }); + + yield store.load(); + + let items = yield list.getAll(); + + do_check_eq(items.length, 2); + + do_check_eq(items[0].source.url, httpUrl("source.txt")); + do_check_eq(items[0].target.path, targetPath); + + do_check_eq(items[1].source.url, httpUrl("empty.txt")); + do_check_eq(items[1].source.referrer, TEST_REFERRER_URL); + do_check_eq(items[1].target.path, targetPath); +}); + +/** + * Loads downloads from a well-formed JSON string containing unrecognized data. + */ +add_task(function* test_load_string_unrecognized() +{ + let [list, store] = yield promiseNewListAndStore(); + + // The platform-dependent file name should be generated dynamically. + let targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + let filePathLiteral = JSON.stringify(targetPath); + let sourceUriLiteral = JSON.stringify(httpUrl("source.txt")); + + let string = "{\"list\":[{\"source\":null," + + "\"target\":null}," + + "{\"source\":{\"url\":" + sourceUriLiteral + "}," + + "\"target\":{\"path\":" + filePathLiteral + "}," + + "\"saver\":{\"type\":\"copy\"}}]}"; + + yield OS.File.writeAtomic(store.path, + new TextEncoder().encode(string), + { tmpPath: store.path + ".tmp" }); + + yield store.load(); + + let items = yield list.getAll(); + + do_check_eq(items.length, 1); + + do_check_eq(items[0].source.url, httpUrl("source.txt")); + do_check_eq(items[0].target.path, targetPath); +}); + +/** + * Loads downloads from a malformed JSON string. + */ +add_task(function* test_load_string_malformed() +{ + let [list, store] = yield promiseNewListAndStore(); + + let string = "{\"list\":[{\"source\":null,\"target\":null}," + + "{\"source\":{\"url\":\"about:blank\"}}}"; + + yield OS.File.writeAtomic(store.path, new TextEncoder().encode(string), + { tmpPath: store.path + ".tmp" }); + + try { + yield store.load(); + do_throw("Exception expected when JSON data is malformed."); + } catch (ex) { + if (ex.name != "SyntaxError") { + throw ex; + } + do_print("The expected SyntaxError exception was thrown."); + } + + let items = yield list.getAll(); + + do_check_eq(items.length, 0); +}); + +/** + * Saves downloads with unknown properties to a file and then reloads + * them to ensure that these properties are preserved. + */ +add_task(function* test_save_reload_unknownProperties() +{ + let [listForSave, storeForSave] = yield promiseNewListAndStore(); + let [listForLoad, storeForLoad] = yield promiseNewListAndStore( + storeForSave.path); + + let download1 = yield promiseNewDownload(httpUrl("source.txt")); + // startTime should be ignored as it is a known property, and error + // is ignored by serialization + download1._unknownProperties = { peanut: "butter", + orange: "marmalade", + startTime: 77, + error: { message: "Passed" } }; + listForSave.add(download1); + + let download2 = yield promiseStartLegacyDownload(); + yield download2.cancel(); + download2._unknownProperties = { number: 5, object: { test: "string" } }; + listForSave.add(download2); + + let download3 = yield Downloads.createDownload({ + source: { url: httpUrl("empty.txt"), + referrer: TEST_REFERRER_URL, + source1: "download3source1", + source2: "download3source2" }, + target: { path: getTempFile(TEST_TARGET_FILE_NAME).path, + target1: "download3target1", + target2: "download3target2" }, + saver : { type: "copy", + saver1: "download3saver1", + saver2: "download3saver2" }, + }); + listForSave.add(download3); + + yield storeForSave.save(); + yield storeForLoad.load(); + + let itemsForSave = yield listForSave.getAll(); + let itemsForLoad = yield listForLoad.getAll(); + + do_check_eq(itemsForSave.length, itemsForLoad.length); + + do_check_eq(Object.keys(itemsForLoad[0]._unknownProperties).length, 2); + do_check_eq(itemsForLoad[0]._unknownProperties.peanut, "butter"); + do_check_eq(itemsForLoad[0]._unknownProperties.orange, "marmalade"); + do_check_false("startTime" in itemsForLoad[0]._unknownProperties); + do_check_false("error" in itemsForLoad[0]._unknownProperties); + + do_check_eq(Object.keys(itemsForLoad[1]._unknownProperties).length, 2); + do_check_eq(itemsForLoad[1]._unknownProperties.number, 5); + do_check_eq(itemsForLoad[1]._unknownProperties.object.test, "string"); + + do_check_eq(Object.keys(itemsForLoad[2].source._unknownProperties).length, 2); + do_check_eq(itemsForLoad[2].source._unknownProperties.source1, + "download3source1"); + do_check_eq(itemsForLoad[2].source._unknownProperties.source2, + "download3source2"); + + do_check_eq(Object.keys(itemsForLoad[2].target._unknownProperties).length, 2); + do_check_eq(itemsForLoad[2].target._unknownProperties.target1, + "download3target1"); + do_check_eq(itemsForLoad[2].target._unknownProperties.target2, + "download3target2"); + + do_check_eq(Object.keys(itemsForLoad[2].saver._unknownProperties).length, 2); + do_check_eq(itemsForLoad[2].saver._unknownProperties.saver1, + "download3saver1"); + do_check_eq(itemsForLoad[2].saver._unknownProperties.saver2, + "download3saver2"); +}); diff --git a/toolkit/components/jsdownloads/test/unit/test_Downloads.js b/toolkit/components/jsdownloads/test/unit/test_Downloads.js new file mode 100644 index 000000000..2027beee1 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_Downloads.js @@ -0,0 +1,194 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * Tests the functions located directly in the "Downloads" object. + */ + +"use strict"; + +// Tests + +/** + * Tests that the createDownload function exists and can be called. More + * detailed tests are implemented separately for the DownloadCore module. + */ +add_task(function* test_createDownload() +{ + // Creates a simple Download object without starting the download. + yield Downloads.createDownload({ + source: { url: "about:blank" }, + target: { path: getTempFile(TEST_TARGET_FILE_NAME).path }, + saver: { type: "copy" }, + }); +}); + +/** + * Tests createDownload for private download. + */ +add_task(function* test_createDownload_private() +{ + let download = yield Downloads.createDownload({ + source: { url: "about:blank", isPrivate: true }, + target: { path: getTempFile(TEST_TARGET_FILE_NAME).path }, + saver: { type: "copy" } + }); + do_check_true(download.source.isPrivate); +}); + +/** + * Tests createDownload for normal (public) download. + */ +add_task(function* test_createDownload_public() +{ + let tempPath = getTempFile(TEST_TARGET_FILE_NAME).path; + let download = yield Downloads.createDownload({ + source: { url: "about:blank", isPrivate: false }, + target: { path: tempPath }, + saver: { type: "copy" } + }); + do_check_false(download.source.isPrivate); + + download = yield Downloads.createDownload({ + source: { url: "about:blank" }, + target: { path: tempPath }, + saver: { type: "copy" } + }); + do_check_false(download.source.isPrivate); +}); + +/** + * Tests createDownload for a pdf saver throws if only given a url. + */ +add_task(function* test_createDownload_pdf() +{ + let download = yield Downloads.createDownload({ + source: { url: "about:blank" }, + target: { path: getTempFile(TEST_TARGET_FILE_NAME).path }, + saver: { type: "pdf" }, + }); + + try { + yield download.start(); + do_throw("The download should have failed."); + } catch (ex) { + if (!(ex instanceof Downloads.Error) || !ex.becauseSourceFailed) { + throw ex; + } + } + + do_check_false(download.succeeded); + do_check_true(download.stopped); + do_check_false(download.canceled); + do_check_true(download.error !== null); + do_check_true(download.error.becauseSourceFailed); + do_check_false(download.error.becauseTargetFailed); + do_check_false(yield OS.File.exists(download.target.path)); +}); + +/** + * Tests "fetch" with nsIURI and nsIFile as arguments. + */ +add_task(function* test_fetch_uri_file_arguments() +{ + let targetFile = getTempFile(TEST_TARGET_FILE_NAME); + yield Downloads.fetch(NetUtil.newURI(httpUrl("source.txt")), targetFile); + yield promiseVerifyContents(targetFile.path, TEST_DATA_SHORT); +}); + +/** + * Tests "fetch" with DownloadSource and DownloadTarget as arguments. + */ +add_task(function* test_fetch_object_arguments() +{ + let targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + yield Downloads.fetch({ url: httpUrl("source.txt") }, { path: targetPath }); + yield promiseVerifyContents(targetPath, TEST_DATA_SHORT); +}); + +/** + * Tests "fetch" with string arguments. + */ +add_task(function* test_fetch_string_arguments() +{ + let targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + yield Downloads.fetch(httpUrl("source.txt"), targetPath); + yield promiseVerifyContents(targetPath, TEST_DATA_SHORT); + + targetPath = getTempFile(TEST_TARGET_FILE_NAME).path; + yield Downloads.fetch(new String(httpUrl("source.txt")), + new String(targetPath)); + yield promiseVerifyContents(targetPath, TEST_DATA_SHORT); +}); + +/** + * Tests that the getList function returns the same list when called multiple + * times with the same argument, but returns different lists when called with + * different arguments. More detailed tests are implemented separately for the + * DownloadList module. + */ +add_task(function* test_getList() +{ + let publicListOne = yield Downloads.getList(Downloads.PUBLIC); + let privateListOne = yield Downloads.getList(Downloads.PRIVATE); + + let publicListTwo = yield Downloads.getList(Downloads.PUBLIC); + let privateListTwo = yield Downloads.getList(Downloads.PRIVATE); + + do_check_eq(publicListOne, publicListTwo); + do_check_eq(privateListOne, privateListTwo); + + do_check_neq(publicListOne, privateListOne); +}); + +/** + * Tests that the getSummary function returns the same summary when called + * multiple times with the same argument, but returns different summaries when + * called with different arguments. More detailed tests are implemented + * separately for the DownloadSummary object in the DownloadList module. + */ +add_task(function* test_getSummary() +{ + let publicSummaryOne = yield Downloads.getSummary(Downloads.PUBLIC); + let privateSummaryOne = yield Downloads.getSummary(Downloads.PRIVATE); + + let publicSummaryTwo = yield Downloads.getSummary(Downloads.PUBLIC); + let privateSummaryTwo = yield Downloads.getSummary(Downloads.PRIVATE); + + do_check_eq(publicSummaryOne, publicSummaryTwo); + do_check_eq(privateSummaryOne, privateSummaryTwo); + + do_check_neq(publicSummaryOne, privateSummaryOne); +}); + +/** + * Tests that the getSystemDownloadsDirectory returns a non-empty download + * directory string. + */ +add_task(function* test_getSystemDownloadsDirectory() +{ + let downloadDir = yield Downloads.getSystemDownloadsDirectory(); + do_check_neq(downloadDir, ""); +}); + +/** + * Tests that the getPreferredDownloadsDirectory returns a non-empty download + * directory string. + */ +add_task(function* test_getPreferredDownloadsDirectory() +{ + let downloadDir = yield Downloads.getPreferredDownloadsDirectory(); + do_check_neq(downloadDir, ""); +}); + +/** + * Tests that the getTemporaryDownloadsDirectory returns a non-empty download + * directory string. + */ +add_task(function* test_getTemporaryDownloadsDirectory() +{ + let downloadDir = yield Downloads.getTemporaryDownloadsDirectory(); + do_check_neq(downloadDir, ""); +}); diff --git a/toolkit/components/jsdownloads/test/unit/test_PrivateTemp.js b/toolkit/components/jsdownloads/test/unit/test_PrivateTemp.js new file mode 100644 index 000000000..1308e9782 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/test_PrivateTemp.js @@ -0,0 +1,24 @@ +/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +"use strict"; + +/* + * The temporary directory downloads saves to, should be only readable + * for the current user. + */ +add_task(function* test_private_temp() { + + let download = yield promiseStartExternalHelperAppServiceDownload( + httpUrl("empty.txt")); + + yield promiseDownloadStopped(download); + + var targetFile = Cc['@mozilla.org/file/local;1'].createInstance(Ci.nsIFile); + targetFile.initWithPath(download.target.path); + + // 488 is the decimal value of 0o700. + equal(targetFile.parent.permissions, 448); +}); diff --git a/toolkit/components/jsdownloads/test/unit/xpcshell.ini b/toolkit/components/jsdownloads/test/unit/xpcshell.ini new file mode 100644 index 000000000..8de554540 --- /dev/null +++ b/toolkit/components/jsdownloads/test/unit/xpcshell.ini @@ -0,0 +1,19 @@ +[DEFAULT] +head = head.js +tail = +skip-if = toolkit == 'android' + +# Note: The "tail.js" file is not defined in the "tail" key because it calls +# the "add_test_task" function, that does not work properly in tail files. +support-files = + common_test_Download.js + +[test_DownloadCore.js] +[test_DownloadImport.js] +[test_DownloadIntegration.js] +[test_DownloadLegacy.js] +[test_DownloadList.js] +[test_Downloads.js] +[test_DownloadStore.js] +[test_PrivateTemp.js] +skip-if = os != 'linux' |