feat(gui): add progress label and cancel download functionality, add new strings

Author: YisusChrist

spankbang_dl/gui.py

@@ -1,4 +1,5 @@
 # 写UI
+import time
 import tkinter as tk
 from datetime import date
 from pathlib import Path
@@ -123,9 +124,23 @@ def __init__(self, selected_language: str = "en") -> None:
         self.progress_bar = ttk.Progressbar(
             main_frame, orient="horizontal", length=400, mode="determinate"
         )
-        self.progress_bar.grid(column=0, row=4, columnspan=2, padx=10, pady=10)
+        self.progress_bar.grid(column=0, row=4, columnspan=2, padx=10, pady=(10, 0))
         logger.debug("Progress bar created")
 
+        # Percentage label
+        self.progress_label = ttk.Label(main_frame, text="0%")
+        self.progress_label.grid(column=0, row=5, columnspan=2)
+        logger.debug("Progress label created")
+
+        # Cancel button
+        self.cancel_download = False  # flag to signal cancellation
+        cancel_button = ttk.Button(
+            main_frame,
+            text=self.translations["cancel_button"],
+            command=self._cancel_download,
+        )
+        cancel_button.grid(column=0, row=6, columnspan=2, pady=(5, 10))
+
         # Create a menu bar
         menuBar = tk.Menu(self.win)
         self.win.config(menu=menuBar)
@@ -227,6 +242,12 @@ def download_video_and_display_progress(self, resp: requests.Response) -> None:
             logger.error("Invalid URL: %s", resp.url)
             return
 
+        self.scr.insert(
+            tk.INSERT,
+            self.translations["total_size_message"].format(content_size) + "\n",
+        )
+        logger.debug("Total size of the video: {:.2f} MB".format(content_size))
+
         # Extract the media extension from the URL path
         file_extension: str = parsed_url.path.split(".")[-1]
         file_name: str = parsed_url.path.split("/")[-1] or f"video.{file_extension}"
@@ -236,21 +257,36 @@ def download_video_and_display_progress(self, resp: requests.Response) -> None:
         # Set up progress bar
         self.progress_bar["maximum"] = content_size
         self.progress_bar["value"] = 0
+        self.progress_label.config(text="0%")
+        self.cancel_download = False  # reset cancel flag
         self.win.update_idletasks()  # Ensure initial draw
 
+        downloaded = 0
+        start_time: float = time.time()
+
         with open(file_path, mode="wb") as f:
-            self.scr.insert(
-                tk.INSERT,
-                self.translations["total_size_message"].format(content_size) + "\n",
-            )
-            logger.debug("Total size of the video: {:.2f} MB".format(content_size))
-            downloaded = 0.0
             for chunk in resp.iter_content(MB):
+                if self.cancel_download:
+                    self.scr.insert(
+                        tk.INSERT, self.translations["cancelled_message"] + "\n"
+                    )
+                    logger.info("Download cancelled by user.")
+                    return
+
                 if not chunk:
                     continue
+
                 f.write(chunk)
                 downloaded += 1
+
+                percent: float = (downloaded / content_size) * 100
+                elapsed: float = time.time() - start_time
+                rate: float = downloaded / elapsed if elapsed > 0 else 0
+                remaining: float = (content_size - downloaded) / rate if rate > 0 else 0
+                eta: str = time.strftime("%M:%S", time.gmtime(remaining))
+
                 self.progress_bar["value"] = downloaded
+                self.progress_label.config(text=f"{percent:.1f}%  ETA: {eta}")
                 self.win.update_idletasks()  # Refresh GUI
 
         self.scr.insert(
@@ -343,6 +379,11 @@ def _help(self) -> None:
             self.translations["help_button"], self.translations["help_message"]
         )
 
+    def _cancel_download(self) -> None:
+        """Sets the cancel flag to True."""
+        logger.debug("Cancel download button clicked")
+        self.cancel_download = True
+
     def run(self) -> None:
         """Run the program."""
         logger.debug("Starting the main loop of the GUI")

spankbang_dl/strings/strings_en.json

@@ -3,6 +3,7 @@
     "failure_message": "Web content fetch failed! Status code: {}",
     "warning_title": "Warning",
     "empty_url_message": "No URL provided for download!",
+    "invalid_url_message": "Invalid URL provided for download!",
     "download_prompt": "Do you want to download {} (this video) [y/n]:",
     "downloading_video": "Preparing to download video: {}",
     "total_size_message": "Total size is: {:.2f} MB, starting...",
@@ -16,10 +17,12 @@
     "quit_button": "Quit",
     "about_button": "About",
     "help_button": "Help",
+    "cancel_button": "Cancel download",
     "video_title_label": "Video Title:",
     "video_url_label": "Video URL:",
     "download_complete_message": "Video download completed!",
     "download_failed_message": "Download failed! Error: {}",
+    "cancelled_message": "Download cancelled by user",
     "about_message": "Author: {}\nVersion: {}\nUpdated: {}",
     "help_message": "1. Enter Spankbang video URL\n2. Click Download\n3. Wait for the download to complete",
     "download_video_message": "Downloading video: {}",

spankbang_dl/strings/strings_es.json

@@ -3,6 +3,7 @@
     "failure_message": "¡Fallo al descargar el contenido web! Código de estado: {}",
     "warning_title": "Advertencia",
     "empty_url_message": "¡No se proporcionó ninguna URL para descargar!",
+    "invalid_url_message": "¡URL proporcionada para descargar no válida!",
     "download_prompt": "¿Quieres descargar {} (este video) [s/n]:",
     "downloading_video": "Preparando para descargar el video: {}",
     "total_size_message": "Tamaño total: {:.2f} MB, comenzando...",
@@ -16,10 +17,12 @@
     "quit_button": "Salir",
     "about_button": "Acerca de",
     "help_button": "Ayuda",
+    "cancel_button": "Cancelar descarga",
     "video_title_label": "Título del video:",
     "video_url_label": "URL del video:",
     "download_complete_message": "¡Descarga del video completada!",
     "download_failed_message": "¡Descarga fallida! Error: {}",
+    "cancelled_message": "Descarga cancelada por el usuario",
     "about_message": "Autor: {}\nVersión: {}\nActualizado: {}",
     "help_message": "1. Introduce la URL del video de Spankbang\n2. Haz clic en Descargar\n3. Espera a que se complete la descarga",
     "download_video_message": "Descargando video: {}",

spankbang_dl/strings/strings_zh.json

@@ -3,6 +3,7 @@
     "failure_message": "网页内容抓取失败！状态码:",
     "warning_title": "警告",
     "empty_url_message": "未提供下载网址",
+    "invalid_url_message": "提供的下载网址无效",
     "download_prompt": "是否要下载{}（此视频）[y/n]:",
     "downloading_video": "准备下载视频：{}",
     "total_size_message": "总大小是：{:.2f} MB, 开始...",
@@ -16,10 +17,12 @@
     "quit_button": "退出",
     "about_button": "关于",
     "help_button": "帮助",
+    "cancel_button": "取消下载",
     "video_title_label": "视频标题：",
     "video_url_label": "视频地址：",
     "download_complete_message": "视频下载完成！",
     "download_failed_message": "下载失败！错误：{}",
+    "cancelled_message": "用户取消了下载",
     "about_message": "作者：{}\n版本: {}\n更新时间: {}",
     "help_message": "1. 输入Spankbang视频地址\n2. 点击下载\n3. 等待下载完成",
     "download_video_message": "正在下载视频：{}",