Fix #41 - Add cancelDownload function to DownloadManager

README.md

@@ -195,6 +195,18 @@ Emitted when an authenticating proxy is asking for user credentials.
 
 > Please see [Class ClientRequest's 'login' event](http://electronjs.org/docs/api/client-request#event-login) for detail.
 
+#### username
+Type: `string`<br>
+Default: `""`
+
+Except using onLogin callback, you can use username and password attributes to let DownloadManager do user credentials automatically.
+
+#### password
+Type: `string`<br>
+Default: `""`
+
+See previous please.
+
 #### onProgress(progress, item)
 Type: `function`<br>
 
@@ -229,6 +241,20 @@ if the download was successful the callback's error will be `null`, otherwise it
 `url` returns the url of the downloaded file<br>
 `filePath` location of where the file was saved
 
+
+### DownloadManager.cancelDownload(url)
+
+Cancel the downloaing task according to the url.
+
+### url
+
+Type: `string`<br>
+
+The resource url passed to download() function previously.
+
+Return true if the specific url download item is found and cancelled ok. Otherwise, return false.
+
+
 ### DownloadManager.bulkDownload(options, callback(error, finished, failed))
 
 ### options

index.js

@@ -9,6 +9,7 @@ let downloadFolder = app.getPath('downloads');
 let lastWindowCreated;
 
 const queue = [];
+const downloadingItems = {};
 
 const _popQueueItem = (url) => {
     let queueItem = queue.find(item => item.url === url);
@@ -59,6 +60,9 @@ function _registerListener(win, opts = {}) {
 
             item.setSavePath(filePath);
 
+            // keep tracking to download task
+            downloadingItems[itemUrl] = {queueItem, downloadItem: item};
+
             // Resuming an interrupted download
             if (item.getState() === 'interrupted') {
                 item.resume();
@@ -91,6 +95,8 @@ function _registerListener(win, opts = {}) {
             });
 
             item.on('done', (e, state) => {
+                // release tracking
+                delete downloadingItems[itemUrl];
 
                 let finishedDownloadCallback = queueItem.callback || function () {};
 
@@ -160,6 +166,10 @@ const download = (options, callback) => {
 
     if (typeof options.onLogin === 'function') {
         request.on('login', options.onLogin)
+    } else if (options.username && options.password) {
+        request.on('login', (authInfo, callback) => {
+            callback(options.username, options.password)
+        })
     }
 
     request.on('error', function (error) {
@@ -223,6 +233,24 @@ const download = (options, callback) => {
     request.end();
 };
 
+const cancelDownload = (url) => {
+    // remove from queue first
+    const queueItem = _popQueueItem(url);
+    if (queueItem) {
+        return true;
+    }
+
+    // remove from downloading tasks
+    const item = downloadingItems[url];
+    if (item) {
+        item.downloadItem.cancel();
+        delete downloadingItems[url];
+        return true;
+    }
+
+    return false;
+}
+
 const bulkDownload = (options, callback) => {
 
     options = Object.assign({}, { urls: [], path: '' }, options);
@@ -261,5 +289,6 @@ const bulkDownload = (options, callback) => {
 module.exports = {
     register,
     download,
+    cancelDownload,
     bulkDownload
 };