Merge pull request #566 from arabcoders/dev

fix: improve exception handling in status tracker

Author: arabcoders

.vscode/settings.json

@@ -124,6 +124,7 @@
     "Microformat",
     "microformats",
     "mkvtoolsnix",
+    "MMDD",
     "movflags",
     "mpegts",
     "msvideo",
@@ -264,5 +265,7 @@
       "url": "./app/schema/tasks.json"
     }
   ],
-  "python.testing.cwd": "app/tests"
+  "python.testing.pytestArgs": [
+    "app"
+  ]
 }

API.md

@@ -31,6 +31,7 @@ This document describes the available endpoints and their usage. All endpoints r
     - [POST /api/history/cancel](#post-apihistorycancel)
     - [DELETE /api/history/{id}/archive](#delete-apihistoryidarchive)
     - [POST /api/history/{id}/archive](#post-apihistoryidarchive)
+    - [POST /api/history/{id}/nfo](#post-apihistoryidnfo)
     - [GET /api/archiver](#get-apiarchiver)
     - [POST /api/archiver](#post-apiarchiver)
     - [DELETE /api/archiver](#delete-apiarchiver)
@@ -770,6 +771,58 @@ or an error:
 
 ---
 
+### POST /api/history/{id}/nfo
+**Purpose**: Generate an NFO metadata file for a completed download.
+
+**Path Parameter**:
+- `id`: Item ID from the history.
+
+**Body** (optional):
+```json
+{
+  "type": "tv",
+  "overwrite": false
+}
+```
+
+**Body Parameters**:
+- `type` (string, optional): NFO format type. Either `"tv"` or `"movie"`. Default: `"tv"`.
+- `overwrite` (boolean, optional): Overwrite existing NFO file. Default: `false`.
+
+**Response** (success):
+```json
+{
+  "message": "NFO file created",
+  "nfo_file": "/path/to/file.nfo"
+}
+```
+
+**Response** (NFO already exists):
+```json
+{
+  "error": "NFO file already exists."
+}
+```
+
+**Error Responses**:
+- `400 Bad Request` if:
+  - Item has no downloaded file
+  - `type` is not `"tv"` or `"movie"`
+  - Failed to collect NFO data (e.g., invalid/no date)
+- `404 Not Found` if the item or media file doesn't exist
+- `409 Conflict` if NFO file already exists and `overwrite` is `false`
+- `500 Internal Server Error` if failed to extract metadata from URL
+
+**Notes**:
+- Fetches fresh metadata from the source URL using yt-dlp
+- Creates NFO file in the same directory as the media file with `.nfo` extension
+- Requires a valid upload/release date in the metadata to create NFO
+- The NFO format follows Kodi/Jellyfin/Emby compatible structure
+- TV mode generates `<episodedetails>` XML
+- Movie mode generates `<movie>` XML
+
+---
+
 ### GET /api/archiver
 **Purpose**: Read entries from the download archive associated with a preset.
 
@@ -1523,6 +1576,13 @@ Binary image data with the appropriate `Content-Type`.
 **Path Parameter**:
 - `path` = Relative path within the download directory (URL-encoded).
 
+**Query Parameters**:
+- `page` (optional): Page number (1-indexed). Default: `1`.
+- `per_page` (optional): Items per page. Default: `config.default_pagination`, Max: `1000`.
+- `sort_by` (optional): Sort field. Options: `name`, `size`, `date`, `type`. Default: `name`.
+- `sort_order` (optional): Sort direction. Options: `asc`, `desc`. Default: `asc`.
+- `search` (optional): Filter by filename (case-insensitive).
+
 **Response**:
 ```json
 {
@@ -1534,12 +1594,12 @@ Binary image data with the appropriate `Content-Type`.
       "name": "filename.mp4",
       "path": "/filename.mp4",
       "size": 123456789,
-      "mimetype": "mime/type",
+      "mime": "mime/type",
       "mtime": "2023-01-01T12:00:00Z",
       "ctime": "2023-01-01T12:00:00Z",
       "is_dir": true|false,
       "is_file": true|false,
-      ...
+      "is_symlink": true|false
     },
     {
       "type": "dir",
@@ -1548,11 +1608,36 @@ Binary image data with the appropriate `Content-Type`.
       "path": "/Season 2025",
       ...
     }
-  ]
+  ],
+  "pagination": {
+    "page": 1,
+    "per_page": 50,
+    "total": 123,
+    "total_pages": 3,
+    "has_next": true,
+    "has_prev": false
+  }
 }
 ```
+
+**Examples**:
+```bash
+# Get first page of root directory
+GET /api/file/browser/
+
+# Get second page of videos folder, sorted by size descending
+GET /api/file/browser/videos?page=2&sort_by=size&sort_order=desc
+
+# Search for mp4 files
+GET /api/file/browser/videos?search=mp4
+
+# Sort by date, newest first
+GET /api/file/browser/videos?sort_by=date&sort_order=desc
+```
+
 - Returns `403 Forbidden` if file browser is disabled.
 - Returns `404 Not Found` if the path doesn't exist.
+- Returns `400 Bad Request` if the path is not a directory.
 
 ---
 

app/library/Utils.py

@@ -814,16 +814,29 @@ def get(
     return data
 
 
-def get_files(base_path: Path | str, dir: str | None = None):
+def get_files(
+    base_path: Path | str,
+    dir: str | None = None,
+    page: int = 1,
+    per_page: int = 0,
+    sort_by: str = "name",
+    sort_order: str = "asc",
+    search: str | None = None,
+) -> tuple[list, int]:
     """
-    Get directory contents.
+    Get directory contents with optional pagination, sorting, and search.
 
     Args:
         base_path (Path|str): Base download path.
         dir (str): Directory to check.
+        page (int): Page number (1-indexed). Ignored if per_page is 0.
+        per_page (int): Items per page. If 0, returns all items.
+        sort_by (str): Sort field: name, size, date, type.
+        sort_order (str): Sort direction: asc, desc.
+        search (str|None): Filter by filename (case-insensitive).
 
     Returns:
-        list: List of files and directories.
+        tuple[list, int]: List of file/directory dicts and total count (before pagination).
 
     Raises:
         OSError: If the directory is invalid or not a directory.
@@ -909,7 +922,26 @@ def get_files(base_path: Path | str, dir: str | None = None):
             }
         )
 
-    return contents
+    total: int = len(contents)
+
+    if search:
+        search_lower: str = search.lower()
+        contents = [c for c in contents if search_lower in c["name"].lower()]
+
+    if sort_by == "name":
+        contents.sort(key=lambda x: x["name"].lower(), reverse=(sort_order.lower() == "desc"))
+    elif sort_by == "size":
+        contents.sort(key=lambda x: x["size"], reverse=(sort_order.lower() == "desc"))
+    elif sort_by == "date":
+        contents.sort(key=lambda x: x["mtime"], reverse=(sort_order.lower() == "desc"))
+    elif sort_by == "type":
+        contents.sort(key=lambda x: x["content_type"], reverse=(sort_order.lower() == "desc"))
+
+    if per_page > 0:
+        offset: int = (page - 1) * per_page
+        contents = contents[offset : offset + per_page]
+
+    return contents, total
 
 
 def clean_item(item: dict, keys: list | tuple) -> tuple[dict, bool]:

app/library/downloads/core.py

@@ -301,7 +301,6 @@ async def start(self) -> int | None:
                 self.info.status = "cancelled"
             return ret
 
-        self._status_tracker.put_terminator()
         await self._status_tracker.drain_queue()
 
         return ret

app/library/downloads/hooks.py

@@ -46,6 +46,18 @@ def progress_hook(self, data: dict[str, Any]) -> None:
         )
 
     def postprocessor_hook(self, data: dict[str, Any]) -> None:
+        info_dict = data.get("info_dict", {})
+        filepath = info_dict.get("filepath")
+
+        status: dict[str, Any] = {
+            "id": self.id,
+            "action": "postprocessing",
+            **{k: v for k, v in data.items() if k in YTDLP_PROGRESS_FIELDS},
+            "status": "postprocessing",
+        }
+        if filepath:
+            status["filepath"] = filepath
+
         if self.debug:
             try:
                 d_safe = create_debug_safe_dict(data)
@@ -54,14 +66,7 @@ def postprocessor_hook(self, data: dict[str, Any]) -> None:
             except Exception as e:
                 self.logger.debug(f"PP Hook: Error creating debug info: {e}")
 
-        self.status_queue.put(
-            {
-                "id": self.id,
-                "action": "postprocessing",
-                **{k: v for k, v in data.items() if k in YTDLP_PROGRESS_FIELDS},
-                "status": "postprocessing",
-            }
-        )
+        self.status_queue.put(status)
 
     def post_hook(self, filename: str) -> None:
         self.status_queue.put({"id": self.id, "status": "finished", "final_name": filename})