[PALEMOON] Bug 1115983 - Keep only minimal state information in the DataItem

2 files changed, 86 insertions, 69 deletions

diff --git a/application/palemoon/components/downloads/content/allDownloadsViewOverlay.js b/application/palemoon/components/downloads/content/allDownloadsViewOverlay.js
index 580cf6c61..4983c422d 100644
--- a/application/palemoon/components/downloads/content/allDownloadsViewOverlay.js
+++ b/application/palemoon/components/downloads/content/allDownloadsViewOverlay.js
@@ -137,7 +137,7 @@ DownloadElementShell.prototype = {
   // The download uri (as a string)
   get downloadURI() {
     if (this._dataItem)
-     return this._dataItem.uri;
+     return this._dataItem.download.source.url;
     if (this._placesNode)
       return this._placesNode.uri;
     throw new Error("Unexpected download element state");
@@ -246,21 +246,22 @@ DownloadElementShell.prototype = {
   getDownloadMetaData: function DES_getDownloadMetaData() {
     if (!this._metaData) {
       if (this._dataItem) {
+        let leafName = OS.Path.basename(this._dataItem.download.target.path);
         let s = DownloadsCommon.strings;
-        let referrer = this._dataItem.referrer || this._dataItem.uri;
+        let referrer = this.dataItem.download.source.referrer ||
+                       this.dataItem.download.source.url;
         let [displayHost, fullHost] = DownloadUtils.getURIHost(referrer);
         this._metaData = {
           state:                  this._dataItem.state,
           endTime:                this._dataItem.endTime,
-          fileName:               this._dataItem.target,
-          displayName:            this._dataItem.target,
-          extendedDisplayName:    s.statusSeparator(this._dataItem.target, displayHost),
-          extendedDisplayNameTip: s.statusSeparator(this._dataItem.target, fullHost)
+          fileName:               leafName,
+          displayName:            leafName,
+          extendedDisplayName:    s.statusSeparator(leafName, displayHost),
+          extendedDisplayNameTip: s.statusSeparator(leafName, fullHost)
         };
         if (this._dataItem.done)
           this._metaData.fileSize = this._dataItem.maxBytes;
-        if (this._dataItem.localFile)
-          this._metaData.filePath = this._dataItem.localFile.path;
+        this._metaData.filePath = this._dataItem.download.target.path;
       }
       else {
         try {
@@ -304,7 +305,7 @@ DownloadElementShell.prototype = {
     if (this._dataItem && this._dataItem.inProgress) {
       if (this._dataItem.paused) {
         let transfer =
-          DownloadUtils.getTransferTotal(this._dataItem.currBytes,
+          DownloadUtils.getTransferTotal(this._dataItem.download.currentBytes,
                                          this._dataItem.maxBytes);
 
         // We use the same XUL label to display both the state and the amount
@@ -313,9 +314,9 @@ DownloadElementShell.prototype = {
       }
       if (this._dataItem.state == nsIDM.DOWNLOAD_DOWNLOADING) {
         let [status, newEstimatedSecondsLeft] =
-          DownloadUtils.getDownloadStatus(this.dataItem.currBytes,
+          DownloadUtils.getDownloadStatus(this.dataItem.download.currentBytes,
                                           this.dataItem.maxBytes,
-                                          this.dataItem.speed,
+                                          this.dataItem.download.speed,
                                           this._lastEstimatedSecondsLeft || Infinity);
         this._lastEstimatedSecondsLeft = newEstimatedSecondsLeft;
         return status;
@@ -365,7 +366,7 @@ DownloadElementShell.prototype = {
     }
 
     // TODO (bug 829201): history downloads should get the referrer from Places.
-    let referrer = this._dataItem && this._dataItem.referrer ||
+    let referrer = this._dataItem && this._dataItem.download.source.referrer ||
                    this.downloadURI;
     let [displayHost, fullHost] = DownloadUtils.getURIHost(referrer);
 
@@ -488,10 +489,10 @@ DownloadElementShell.prototype = {
       return false;
     switch (aCommand) {
       case "downloadsCmd_open": {
-        // We cannot open a session download file unless it's done ("openable").
-        // If it's finished, we need to make sure the file was not removed,
+        // We cannot open a session download file unless it's succeeded.
+        // If it's succeeded, we need to make sure the file was not removed,
         // as we do for past downloads.
-        if (this._dataItem && !this._dataItem.openable)
+        if (this._dataItem && !this._dataItem.download.succeeded) {
           return false;
 
         if (this._targetFileInfoFetched)
@@ -515,12 +516,13 @@ DownloadElementShell.prototype = {
         return this.getDownloadMetaData().state == nsIDM.DOWNLOAD_FINISHED;
       }
       case "downloadsCmd_pauseResume":
-        return this._dataItem && this._dataItem.inProgress && this._dataItem.resumable;
+        return this._dataItem && this._dataItem.inProgress &&
+               this._dataItem.download.hasPartialData;
       case "downloadsCmd_retry":
         // An history download can always be retried.
         return !this._dataItem || this._dataItem.canRetry;
       case "downloadsCmd_openReferrer":
-        return this._dataItem && !!this._dataItem.referrer;
+        return this._dataItem && !!this._dataItem.download.source.referrer;
       case "cmd_delete":
         // The behavior in this case is somewhat unexpected, so we disallow that.
         if (this._placesNode && this._dataItem && this._dataItem.inProgress)
@@ -546,36 +548,35 @@ DownloadElementShell.prototype = {
   doCommand: function DES_doCommand(aCommand) {
     switch (aCommand) {
       case "downloadsCmd_open": {
-        let file = this._dataItem ?
-          this.dataItem.localFile :
-          new FileUtils.File(this.getDownloadMetaData().filePath);
+        let file = new FileUtils.File(this._dataItem
+                                      ? this._dataItem.download.target.path
+                                      : this.getDownloadMetaData().filePath);
 
         DownloadsCommon.openDownloadedFile(file, null, window);
         break;
       }
       case "downloadsCmd_show": {
-        if (this._dataItem) {
-          this._dataItem.showLocalFile();
-        }
-        else {
-          let file = new FileUtils.File(this.getDownloadMetaData().filePath);
-          DownloadsCommon.showDownloadedFile(file);
-        }
+        let file = new FileUtils.File(this._dataItem
+                                      ? this._dataItem.download.target.path
+                                      : this.getDownloadMetaData().filePath);
+
+        DownloadsCommon.showDownloadedFile(file);
         break;
       }
       case "downloadsCmd_openReferrer": {
-        openURL(this._dataItem.referrer);
+        openURL(this._dataItem.download.source.referrer);
         break;
       }
       case "downloadsCmd_cancel": {
-        this._dataItem.cancel();
+        this._dataItem.download.cancel().catch(() => {});
+        this._dataItem.download.removePartialData().catch(Cu.reportError);
         break;
       }
       case "cmd_delete": {
         if (this._dataItem)
           Downloads.getList(Downloads.ALL)
-                   .then(list => list.remove(this._dataItem._download))
-                   .then(() => this._dataItem._download.finalize(true))
+                   .then(list => list.remove(this._dataItem.download))
+                   .then(() => this._dataItem.download.finalize(true))
                    .catch(Cu.reportError);
         if (this._placesNode)
           PlacesUtils.bhistory.removePage(this._downloadURIObj);
@@ -583,13 +584,17 @@ DownloadElementShell.prototype = {
        }
       case "downloadsCmd_retry": {
         if (this._dataItem)
-          this._dataItem.retry();
+          this._dataItem.download.start().catch(() => {});
         else
           this._retryAsHistoryDownload();
         break;
       }
       case "downloadsCmd_pauseResume": {
-        this._dataItem.togglePauseResume();
+        if (this._dataItem.download.stopped) {
+          this._dataItem.download.start();
+        } else {
+          this._dataItem.download.cancel();
+        }
         break;
       }
     }
@@ -836,7 +841,8 @@ DownloadsPlacesView.prototype = {
   _addDownloadData:
   function DPV_addDownloadData(aDataItem, aPlacesNode, aNewest = false,
                                aDocumentFragment = null) {
-    let downloadURI = aPlacesNode ? aPlacesNode.uri : aDataItem.uri;
+    let downloadURI = aPlacesNode ? aPlacesNode.uri
+                                  : aDataItem.download.source.url;
     let shellsForURI = this._downloadElementsShellsForURI.get(downloadURI);
     if (!shellsForURI) {
       shellsForURI = new Set();
@@ -989,7 +995,8 @@ DownloadsPlacesView.prototype = {
 
   _removeSessionDownloadFromView:
   function DPV__removeSessionDownloadFromView(aDataItem) {
-    let shells = this._downloadElementsShellsForURI.get(aDataItem.uri);
+    let shells = this._downloadElementsShellsForURI
+                     .get(aDataItem.download.source.url);
     if (shells.size == 0)
       throw new Error("Should have had at leaat one shell for this uri");
 
@@ -1005,7 +1012,7 @@ DownloadsPlacesView.prototype = {
       this._removeElement(shell.element);
       shells.delete(shell);
       if (shells.size == 0)
-        this._downloadElementsShellsForURI.delete(aDataItem.uri);
+        this._downloadElementsShellsForURI.delete(aDataItem.download.source.url);
     }
     else {
       // We have one download element shell containing both a session download
diff --git a/application/palemoon/components/downloads/content/downloads.js b/application/palemoon/components/downloads/content/downloads.js
index 44457e711..fb63f4b17 100644
--- a/application/palemoon/components/downloads/content/downloads.js
+++ b/application/palemoon/components/downloads/content/downloads.js
@@ -1071,12 +1071,14 @@ function DownloadsViewItem(aDataItem, aElement)
   // as bug 239948 comment 12 is handled, the "file" property will be always a
   // file URL rather than a file name.  At that point we should remove the "//"
   // (double slash) from the icon URI specification (see test_moz_icon_uri.js).
-  this.image = "moz-icon://" + this.dataItem.file + "?size=32";
+  this.image = "moz-icon://" + this.dataItem.download.target.path + "?size=32";
 
   let s = DownloadsCommon.strings;
   let [displayHost, fullHost] =
-    DownloadUtils.getURIHost(this.dataItem.referrer || this.dataItem.uri);
+    DownloadUtils.getURIHost(this.dataItem.download.source.referrer ||
+                             this.dataItem.download.source.url);
 
+  let target = OS.Path.basename(this.dataItem.download.target.path);
   let attributes = {
     "type": "download",
     "class": "download-state",
@@ -1084,9 +1086,9 @@ function DownloadsViewItem(aDataItem, aElement)
     "downloadGuid": this.dataItem.downloadGuid,
     "state": this.dataItem.state,
     "progress": this.dataItem.inProgress ? this.dataItem.percentComplete : 100,
-    "displayName": this.dataItem.target,
-    "extendedDisplayName": s.statusSeparator(this.dataItem.target, displayHost),
-    "extendedDisplayNameTip": s.statusSeparator(this.dataItem.target, fullHost),
+    "displayName": target,
+    "extendedDisplayName": s.statusSeparator(target, displayHost),
+    "extendedDisplayNameTip": s.statusSeparator(target, fullHost),
     "image": this.image
   };
 
@@ -1203,7 +1205,7 @@ DownloadsViewItem.prototype = {
     let statusTip = "";
 
     if (this.dataItem.paused) {
-      let transfer = DownloadUtils.getTransferTotal(this.dataItem.currBytes,
+      let transfer = DownloadUtils.getTransferTotal(this.dataItem.download.currentBytes,
                                                     this.dataItem.maxBytes);
 
       // We use the same XUL label to display both the state and the amount
@@ -1216,17 +1218,17 @@ DownloadsViewItem.prototype = {
       // The remaining time per download is likely enough information for the
       // panel.
       [status] =
-        DownloadUtils.getDownloadStatusNoRate(this.dataItem.currBytes,
+        DownloadUtils.getDownloadStatusNoRate(this.dataItem.download.currentBytes,
                                               this.dataItem.maxBytes,
-                                              this.dataItem.speed,
+                                              this.dataItem.download.speed,
                                               this.lastEstimatedSecondsLeft);
 
       // We are, however, OK with displaying the rate in the tooltip.
       let newEstimatedSecondsLeft;
       [statusTip, newEstimatedSecondsLeft] =
-        DownloadUtils.getDownloadStatus(this.dataItem.currBytes,
+        DownloadUtils.getDownloadStatus(this.dataItem.download.currentBytes,
                                         this.dataItem.maxBytes,
-                                        this.dataItem.speed,
+                                        this.dataItem.download.speed,
                                         this.lastEstimatedSecondsLeft);
       this.lastEstimatedSecondsLeft = newEstimatedSecondsLeft;
     } else if (this.dataItem.starting) {
@@ -1248,7 +1250,8 @@ DownloadsViewItem.prototype = {
       }.apply(this);
 
       let [displayHost, fullHost] =
-        DownloadUtils.getURIHost(this.dataItem.referrer || this.dataItem.uri);
+        DownloadUtils.getURIHost(this.dataItem.download.source.referrer ||
+                                 this.dataItem.download.source.url);
 
       let end = new Date(this.dataItem.endTime);
       let [displayDate, fullDate] = DownloadUtils.getReadableDates(end);
@@ -1294,18 +1297,17 @@ DownloadsViewItem.prototype = {
    */
   verifyTargetExists: function DVI_verifyTargetExists() {
     // We don't need to check if the download is not finished successfully.
-    if (!this.dataItem.openable) {
+    if (!this.dataItem.download.succeeded) {
       return;
     }
 
-    OS.File.exists(this.dataItem.localFile.path).then(
-      function DVI_RTE_onSuccess(aExists) {
-        if (aExists) {
-          this._element.setAttribute("exists", "true");
-        } else {
-          this._element.removeAttribute("exists");
-        }
-      }.bind(this), Cu.reportError);
+    OS.File.exists(this.dataItem.download.target.path).then(aExists => {
+      if (aExists) {
+        this._element.setAttribute("exists", "true");
+      } else {
+        this._element.removeAttribute("exists");
+      }
+    }).catch(Cu.reportError);
   },
 };
 
@@ -1434,18 +1436,20 @@ DownloadsViewItemController.prototype = {
   {
     switch (aCommand) {
       case "downloadsCmd_open": {
-        return this.dataItem.openable && this.dataItem.localFile.exists();
+        return this.dataItem.download.succeeded &&
+               this.dataItem.localFile.exists();
       }
       case "downloadsCmd_show": {
         return this.dataItem.localFile.exists() ||
                this.dataItem.partFile.exists();
       }
       case "downloadsCmd_pauseResume":
-        return this.dataItem.inProgress && this.dataItem.resumable;
+        return this.dataItem.inProgress &&
+               this.dataItem.download.hasPartialData;
       case "downloadsCmd_retry":
         return this.dataItem.canRetry;
       case "downloadsCmd_openReferrer":
-        return !!this.dataItem.referrer;
+        return !!this.dataItem.download.source.referrer;
       case "cmd_delete":
       case "downloadsCmd_cancel":
       case "downloadsCmd_copyLocation":
@@ -1474,20 +1478,22 @@ DownloadsViewItemController.prototype = {
     cmd_delete: function DVIC_cmd_delete()
     {
       Downloads.getList(Downloads.ALL)
-               .then(list => list.remove(this.dataItem._download))
-               .then(() => this.dataItem._download.finalize(true))
+               .then(list => list.remove(this.dataItem.download))
+               .then(() => this.dataItem.download.finalize(true))
                .catch(Cu.reportError);
-      PlacesUtils.bhistory.removePage(NetUtil.newURI(this.dataItem.uri));
+      PlacesUtils.bhistory.removePage(
+                             NetUtil.newURI(this.dataItem.download.source.url));
     },
 
     downloadsCmd_cancel: function DVIC_downloadsCmd_cancel()
     {
-      this.dataItem.cancel();
+      this.dataItem.download.cancel().catch(() => {});
+      this.dataItem.download.removePartialData().catch(Cu.reportError);
     },
 
     downloadsCmd_open: function DVIC_downloadsCmd_open()
     {
-      this.dataItem.openLocalFile(window);
+      this.dataItem.download.launch().catch(Cu.reportError);
       // We explicitly close the panel here to give the user the feedback that
       // their click has been received, and we're handling the action.
       // Otherwise, we'd have to wait for the file-type handler to execute
@@ -1498,7 +1504,7 @@ DownloadsViewItemController.prototype = {
 
     downloadsCmd_show: function DVIC_downloadsCmd_show()
     {
-      this.dataItem.showLocalFile();
+      DownloadsCommon.showDownloadedFile(this.dataItem.localFile);
 
       // We explicitly close the panel here to give the user the feedback that
       // their click has been received, and we're handling the action.
@@ -1510,24 +1516,28 @@ DownloadsViewItemController.prototype = {
 
     downloadsCmd_pauseResume: function DVIC_downloadsCmd_pauseResume()
     {
-      this.dataItem.togglePauseResume();
+      if (this.dataItem.download.stopped) {
+        this.dataItem.download.start();
+      } else {
+        this.dataItem.download.cancel();
+      }
     },
 
     downloadsCmd_retry: function DVIC_downloadsCmd_retry()
     {
-      this.dataItem.retry();
+      this.dataItem.download.start().catch(() => {});
     },
 
     downloadsCmd_openReferrer: function DVIC_downloadsCmd_openReferrer()
     {
-      openURL(this.dataItem.referrer);
+      openURL(this.dataItem.download.source.referrer);
     },
 
     downloadsCmd_copyLocation: function DVIC_downloadsCmd_copyLocation()
     {
       let clipboard = Cc["@mozilla.org/widget/clipboardhelper;1"]
                       .getService(Ci.nsIClipboardHelper);
-      clipboard.copyString(this.dataItem.uri, document);
+      clipboard.copyString(this.dataItem.download.source.url, document);
     },
 
     downloadsCmd_doDefault: function DVIC_downloadsCmd_doDefault()