Add support for restarting failed or canceled downloads

m4heshd · Oct 28, 2023 · 0bdba15 · 0bdba15
1 parent 763c16b
commit 0bdba15
Show file tree

Hide file tree

Showing 7 changed files with 77 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -191,7 +191,7 @@ That's it. Now you're ready to go.
 
 - [x] Migrate to Vite (dev)
 - [x] Support for concurrent multi-fragment download
-- [ ] Ability to restart failed downloads
+- [x] Ability to restart failed/canceled downloads
 - [ ] Support for more architectures, including ARM-based systems
 - [ ] Mobile-responsive Web UI
 - [ ] Make completed files downloadable right from the UFC Ripper Web UI (hosted)

diff --git a/server-modules/bin-util.js b/server-modules/bin-util.js
@@ -42,7 +42,7 @@ function validateBins(cb) {
     }
 }
 
-function openDLSession(VOD, cb) {
+function openDLSession(VOD, isRestart, cb) {
     const {qID, title, hls, vodURL} = VOD;
     const {
         vidQuality,
@@ -62,7 +62,7 @@ function openDLSession(VOD, cb) {
     } = getConfig();
 
     // Download configuration
-    const fullTitle = `${numberFiles ? `${curNumber}. ` : ''}${title}`;
+    const fullTitle = isRestart ? title : `${numberFiles ? `${curNumber}. ` : ''}${title}`;
     const progressTemplate = JSON.stringify({
         status: '%(progress.status)s',
         progress: '%(progress._percent_str)s',
@@ -93,20 +93,25 @@ function openDLSession(VOD, cb) {
     };
 
     // Begin download process
-    console.log(clr.yellowBright.bgBlack.bold.underline(`Downloading "${fullTitle}"`));
+    console.log(clr.yellowBright.bgBlack.bold.underline(`${isRestart ? 'Restarting' : 'Downloading'} "${fullTitle}"`));
     console.log(clr.dim(`${vodURL}\n`));
 
-    incFileNumber();
-    sendVODDownload({
-        ...VOD,
-        title: fullTitle,
-        task: 'prepare',
-        status: 'downloading',
-        progress: 0,
-        size: 'N/A',
-        speed: 'N/A',
-        eta: 'N/A'
-    }, cb);
+    if (!isRestart) incFileNumber();
+
+    sendVODDownload(
+        {
+            ...VOD,
+            title: fullTitle,
+            task: 'prepare',
+            status: 'downloading',
+            progress: 0,
+            size: 'N/A',
+            speed: 'N/A',
+            eta: 'N/A'
+        },
+        isRestart,
+        cb
+    );
 
     // Launch and handle yt-dlp process
     const dlArgsAll = [

diff --git a/server-modules/io-util.js b/server-modules/io-util.js
@@ -69,12 +69,16 @@ async function verifyVOD(url, cb) {
     }
 }
 
-async function downloadVOD(VOD, cb) {
+async function downloadVOD(VOD, isRestart, cb) {
     try {
-        require('./bin-util').openDLSession({
-            ...VOD,
-            hls: await getVODStream(VOD.id)
-        }, cb);
+        require('./bin-util').openDLSession(
+            {
+                ...VOD,
+                hls: await getVODStream(VOD.id)
+            },
+            isRestart,
+            cb
+        );
     } catch (error) {
         sendError(error, cb);
     }
@@ -145,10 +149,10 @@ function sendVODMeta(VOD, cb) {
     });
 }
 
-function sendVODDownload(VOD, cb) {
+function sendVODDownload(VOD, isRestart, cb) {
     DLQ[VOD.qID] = {
         ...VOD,
-        idx: Object.values(DLQ).length + 1
+        idx: isRestart ? VOD.idx : Object.values(DLQ).length + 1
     };
 
     cb(VOD);

diff --git a/src/components/VODCard.vue b/src/components/VODCard.vue
@@ -56,7 +56,20 @@
             </button>
             <span>{{ `${vVODData.progress}%` }}</span>
           </div>
-          <i v-else>{{ statusIcons[vVODData.status] }}</i>
+          <div
+              v-else
+              class="center-content vod-card__details__status__post-action"
+          >
+            <button
+                v-if="isFailed"
+                class="square round fill small"
+                title="Retry download"
+                @click="$emit('retryDL',vVODData)"
+            >
+              <i>refresh</i>
+            </button>
+            <i>{{ statusIcons[vVODData.status] }}</i>
+          </div>
         </div>
       </div>
     </div>
@@ -75,7 +88,8 @@ const props = defineProps({
 });
 
 defineEmits([
-  'cancelDL'
+  'cancelDL',
+  'retryDL'
 ]);
 
 // Status and progress
@@ -177,8 +191,13 @@ const taskDescs = {
         }
       }
 
-      & > i {
-        cursor: default;
+      &__post-action {
+        flex-direction: column;
+        gap: 12px;
+
+        & > i {
+          cursor: default;
+        }
       }
     }
   }

diff --git a/src/modules/ws-util.js b/src/modules/ws-util.js
@@ -103,8 +103,8 @@ export function useWSUtil() {
         return emitPromise('verify-url', url);
     }
 
-    function downloadVOD(VOD) {
-        return emitPromise('download', VOD);
+    function downloadVOD(VOD, isRestart) {
+        return emitPromise('download', VOD, isRestart);
     }
 
     function cancelDownload(VOD) {

diff --git a/src/pages/Landing.vue b/src/pages/Landing.vue
@@ -71,6 +71,7 @@
             :vShowThumb="store.config.showThumb"
             :vShowDesc="store.config.showDesc"
             @cancelDL="onDownloadCancel"
+            @retryDL="onDownloadRetry"
         ></VODCard>
       </div>
     </article>
@@ -154,6 +155,14 @@ function onDownloadCancel(VOD) {
       .catch(store.popError);
 }
 
+function onDownloadRetry(VOD) {
+  store.setDownloadRestart(VOD);
+  store.popInfo('Download restarted');
+
+  downloadVOD(VOD, true)
+      .catch(store.popError);
+}
+
 // Lifecycle hooks
 onMounted(() => nextTick(() => {
   window.ui();
@@ -163,7 +172,7 @@ onMounted(() => nextTick(() => {
 function download(VOD) {
   switchBusyState();
 
-  downloadVOD(VOD)
+  downloadVOD(VOD, false)
       .then((res) => {
         store.addDownload(res);
         store.popInfo('Download started');

diff --git a/src/store/index.js b/src/store/index.js
@@ -75,6 +75,17 @@ export const useAppStore = defineStore('app', {
                 idx: this.downloadQueue.length + 1
             };
         },
+        setDownloadRestart(VOD) {
+            this.downloads[VOD.qID] = {
+                ...VOD,
+                task: 'prepare',
+                status: 'downloading',
+                progress: 0,
+                size: 'N/A',
+                speed: 'N/A',
+                eta: 'N/A'
+            };
+        },
         setDownloadCancelled(qID) {
             this.downloads[qID].status = 'cancelled';
         }