move TASK_CONFIG to separate module

tubearchivist/api/views.py

@@ -32,10 +32,10 @@ from home.src.ta.notify import Notifications, get_all_notifications
 from home.src.ta.settings import EnvironmentSettings
 from home.src.ta.ta_redis import RedisArchivist
 from home.src.ta.task_manager import TaskCommand, TaskManager
+from home.src.ta.task_config import TASK_CONFIG
 from home.src.ta.urlparser import Parser
 from home.src.ta.users import UserConfig
 from home.tasks import (
-    BaseTask,
     check_reindex,
     download_pending,
     extrac_dl,
@@ -913,7 +913,7 @@ class TaskNameListView(ApiBaseView):
     def get(self, request, task_name):
         """handle get request"""
         # pylint: disable=unused-argument
-        if task_name not in BaseTask.TASK_CONFIG:
+        if task_name not in TASK_CONFIG:
             message = {"message": "invalid task name"}
             return Response(message, status=404)
 
@@ -928,12 +928,12 @@ class TaskNameListView(ApiBaseView):
         400 if task can't be started here without argument
         """
         # pylint: disable=unused-argument
-        task_config = BaseTask.TASK_CONFIG.get(task_name)
+        task_config = TASK_CONFIG.get(task_name)
         if not task_config:
             message = {"message": "invalid task name"}
             return Response(message, status=404)
 
-        if not task_config.get("api-start"):
+        if not task_config.get("api_start"):
             message = {"message": "can not start task through this endpoint"}
             return Response(message, status=400)
 
@@ -972,16 +972,16 @@ class TaskIDView(ApiBaseView):
             message = {"message": "task id not found"}
             return Response(message, status=404)
 
-        task_conf = BaseTask.TASK_CONFIG.get(task_result.get("name"))
+        task_conf = TASK_CONFIG.get(task_result.get("name"))
         if command == "stop":
-            if not task_conf.get("api-stop"):
+            if not task_conf.get("api_stop"):
                 message = {"message": "task can not be stopped"}
                 return Response(message, status=400)
 
             message_key = self._build_message_key(task_conf, task_id)
             TaskCommand().stop(task_id, message_key)
         if command == "kill":
-            if not task_conf.get("api-stop"):
+            if not task_conf.get("api_stop"):
                 message = {"message": "task can not be killed"}
                 return Response(message, status=400)
 
@@ -1032,7 +1032,7 @@ class ScheduleNotification(ApiBaseView):
         task_name = request.data.get("task_name")
         url = request.data.get("url")
 
-        if not BaseTask.TASK_CONFIG.get(task_name):
+        if not TASK_CONFIG.get(task_name):
             message = {"message": "task_name not found"}
             return Response(message, status=404)
 

tubearchivist/config/management/commands/ta_startup.py

@@ -20,9 +20,9 @@ from home.src.ta.helper import clear_dl_cache
 from home.src.ta.notify import Notifications
 from home.src.ta.settings import EnvironmentSettings
 from home.src.ta.ta_redis import RedisArchivist
+from home.src.ta.task_config import TASK_CONFIG
 from home.src.ta.task_manager import TaskManager
 from home.src.ta.users import UserConfig
-from home.tasks import BaseTask
 
 TOPIC = """
 
@@ -342,7 +342,7 @@ class Command(BaseCommand):
 
     def _create_task(self, task_name, schedule, task_config=False):
         """create task"""
-        description = BaseTask.TASK_CONFIG[task_name].get("title")
+        description = TASK_CONFIG[task_name].get("title")
         schedule, _ = CrontabSchedule.objects.get_or_create(**schedule)
         schedule.timezone = settings.TIME_ZONE
         schedule.save()

tubearchivist/home/src/ta/config_schedule.py

@@ -7,7 +7,7 @@ from django_celery_beat.models import CrontabSchedule
 from home.models import CustomPeriodicTask
 from home.src.ta.config import AppConfig
 from home.src.ta.settings import EnvironmentSettings
-from home.tasks import BaseTask
+from home.src.ta.task_config import TASK_CONFIG
 
 
 class ScheduleBuilder:
@@ -54,7 +54,7 @@ class ScheduleBuilder:
         try:
             task = CustomPeriodicTask.objects.get(name=task_name)
         except CustomPeriodicTask.DoesNotExist:
-            description = BaseTask.TASK_CONFIG[task_name].get("title")
+            description = TASK_CONFIG[task_name].get("title")
             task = CustomPeriodicTask(
                 name=task_name,
                 task=task_name,

tubearchivist/home/src/ta/notify.py

@@ -3,6 +3,7 @@
 import apprise
 from home.src.es.connect import ElasticWrap
 from home.src.ta import task_manager  # partial import
+from home.src.ta.task_config import TASK_CONFIG
 
 
 class Notifications:
@@ -123,7 +124,6 @@ def get_all_notifications() -> dict[str, list[str]]:
         return {}
 
     notifications: dict = {}
-    task_config: dict = task_manager.ta_tasks.BaseTask.TASK_CONFIG
     source = response.get("_source")
     if not source:
         return notifications
@@ -133,7 +133,7 @@ def get_all_notifications() -> dict[str, list[str]]:
             {
                 task_id: {
                     "urls": urls,
-                    "title": task_config[task_id]["title"],
+                    "title": TASK_CONFIG[task_id]["title"],
                 }
             }
         )

tubearchivist/home/src/ta/task_config.py

@@ -0,0 +1,125 @@
+"""
+Functionality:
+- Static Task config values
+- Type definitions
+- separate to avoid circular imports
+"""
+
+from typing import TypedDict
+
+
+class TaskItemConfig(TypedDict):
+    """describes a task item config"""
+
+    title: str
+    group: str
+    api_start: bool
+    api_stop: bool
+
+
+UPDATE_SUBSCRIBED: TaskItemConfig = {
+    "title": "Rescan your Subscriptions",
+    "group": "download:scan",
+    "api_start": True,
+    "api_stop": True,
+}
+
+DOWNLOAD_PENDING: TaskItemConfig = {
+    "title": "Downloading",
+    "group": "download:run",
+    "api_start": True,
+    "api_stop": True,
+}
+
+EXTRACT_DOWNLOAD: TaskItemConfig = {
+    "title": "Add to download queue",
+    "group": "download:add",
+    "api_start": False,
+    "api_stop": True,
+}
+
+CHECK_REINDEX: TaskItemConfig = {
+    "title": "Reindex Documents",
+    "group": "reindex:run",
+    "api_start": False,
+    "api_stop": False,
+}
+
+MANUAL_IMPORT: TaskItemConfig = {
+    "title": "Manual video import",
+    "group": "setting:import",
+    "api_start": True,
+    "api_stop": False,
+}
+
+RUN_BACKUP: TaskItemConfig = {
+    "title": "Index Backup",
+    "group": "setting:backup",
+    "api_start": True,
+    "api_stop": False,
+}
+
+RESTORE_BACKUP: TaskItemConfig = {
+    "title": "Restore Backup",
+    "group": "setting:restore",
+    "api_start": False,
+    "api_stop": False,
+}
+
+RESCAN_FILESYSTEM: TaskItemConfig = {
+    "title": "Rescan your Filesystem",
+    "group": "setting:filesystemscan",
+    "api_start": True,
+    "api_stop": False,
+}
+
+THUMBNAIL_CHECK: TaskItemConfig = {
+    "title": "Check your Thumbnails",
+    "group": "setting:thumbnailcheck",
+    "api_start": True,
+    "api_stop": False,
+}
+
+RESYNC_THUMBS: TaskItemConfig = {
+    "title": "Sync Thumbnails to Media Files",
+    "group": "setting:thumbnailsync",
+    "api_start": True,
+    "api_stop": False,
+}
+
+INDEX_PLAYLISTS: TaskItemConfig = {
+    "title": "Index Channel Playlist",
+    "group": "channel:indexplaylist",
+    "api_start": False,
+    "api_stop": False,
+}
+
+SUBSCRIBE_TO: TaskItemConfig = {
+    "title": "Add Subscription",
+    "group": "subscription:add",
+    "api_start": False,
+    "api_stop": False,
+}
+
+VERSION_CHECK: TaskItemConfig = {
+    "title": "Look for new Version",
+    "group": "",
+    "api_start": False,
+    "api_stop": False,
+}
+
+TASK_CONFIG: dict[str, TaskItemConfig] = {
+    "update_subscribed": UPDATE_SUBSCRIBED,
+    "download_pending": DOWNLOAD_PENDING,
+    "extract_download": EXTRACT_DOWNLOAD,
+    "check_reindex": CHECK_REINDEX,
+    "manual_import": MANUAL_IMPORT,
+    "run_backup": RUN_BACKUP,
+    "restore_backup": RESTORE_BACKUP,
+    "rescan_filesystem": RESCAN_FILESYSTEM,
+    "thumbnail_check": THUMBNAIL_CHECK,
+    "resync_thumbs": RESYNC_THUMBS,
+    "index_playlists": INDEX_PLAYLISTS,
+    "subscribe_to": SUBSCRIBE_TO,
+    "version_check": VERSION_CHECK,
+}

tubearchivist/home/src/ta/task_manager.py

@@ -4,9 +4,9 @@ functionality:
 - handle threads and locks
 """
 
-from home import tasks as ta_tasks
 from home.celery import app as celery_app
 from home.src.ta.ta_redis import RedisArchivist, TaskRedis
+from home.src.ta.task_config import TASK_CONFIG
 
 
 class TaskManager:
@@ -105,7 +105,7 @@ class TaskCommand:
         handler = TaskRedis()
 
         task = handler.get_single(task_id)
-        if not task["name"] in ta_tasks.BaseTask.TASK_CONFIG:
+        if not task["name"] in TASK_CONFIG:
             raise ValueError
 
         handler.set_command(task_id, "STOP")

tubearchivist/home/tasks.py

@@ -24,6 +24,7 @@ from home.src.ta import notify  # partial
 from home.src.ta import task_manager  # partial
 from home.src.ta.config import ReleaseVersion
 from home.src.ta.ta_redis import RedisArchivist
+from home.src.ta.task_config import TASK_CONFIG
 from home.src.ta.urlparser import Parser
 
 
@@ -32,68 +33,6 @@ class BaseTask(Task):
 
     # pylint: disable=abstract-method
 
-    TASK_CONFIG = {
-        "update_subscribed": {
-            "title": "Rescan your Subscriptions",
-            "group": "download:scan",
-            "api-start": True,
-            "api-stop": True,
-        },
-        "download_pending": {
-            "title": "Downloading",
-            "group": "download:run",
-            "api-start": True,
-            "api-stop": True,
-        },
-        "extract_download": {
-            "title": "Add to download queue",
-            "group": "download:add",
-            "api-stop": True,
-        },
-        "check_reindex": {
-            "title": "Reindex Documents",
-            "group": "reindex:run",
-        },
-        "manual_import": {
-            "title": "Manual video import",
-            "group": "setting:import",
-            "api-start": True,
-        },
-        "run_backup": {
-            "title": "Index Backup",
-            "group": "setting:backup",
-            "api-start": True,
-        },
-        "restore_backup": {
-            "title": "Restore Backup",
-            "group": "setting:restore",
-        },
-        "rescan_filesystem": {
-            "title": "Rescan your Filesystem",
-            "group": "setting:filesystemscan",
-            "api-start": True,
-        },
-        "thumbnail_check": {
-            "title": "Check your Thumbnails",
-            "group": "setting:thumbnailcheck",
-            "api-start": True,
-        },
-        "resync_thumbs": {
-            "title": "Sync Thumbnails to Media Files",
-            "group": "setting:thumbnailsync",
-            "api-start": True,
-        },
-        "index_playlists": {
-            "title": "Index Channel Playlist",
-            "group": "channel:indexplaylist",
-        },
-        "subscribe_to": {
-            "title": "Add Subscription",
-            "group": "subscription:add",
-        },
-        "version_check": {"title": "Look for new Version"},
-    }
-
     def on_failure(self, exc, task_id, args, kwargs, einfo):
         """callback for task failure"""
         print(f"{task_id} Failed callback")
@@ -118,7 +57,7 @@ class BaseTask(Task):
     def after_return(self, status, retval, task_id, args, kwargs, einfo):
         """callback after task returns"""
         print(f"{task_id} return callback")
-        task_title = self.TASK_CONFIG.get(self.name).get("title")
+        task_title = TASK_CONFIG.get(self.name).get("title")
         notify.Notifications(self.name).send(task_id, task_title)
 
     def send_progress(self, message_lines, progress=False, title=False):
@@ -138,7 +77,7 @@ class BaseTask(Task):
     def _build_message(self, level="info"):
         """build message dict"""
         task_id = self.request.id
-        message = self.TASK_CONFIG.get(self.name).copy()
+        message = TASK_CONFIG.get(self.name).copy()
         message.update({"level": level, "id": task_id})
         task_result = task_manager.TaskManager().get_task(task_id)
         if task_result:

tubearchivist/requirements.txt

@@ -1,14 +1,14 @@
-apprise==1.7.5
-celery==5.3.6
+apprise==1.7.6
+celery==5.4.0
 Django==5.0.4
 django-auth-ldap==4.8.0
-django-celery-beat==2.5.0
+django-celery-beat==2.6.0
 django-cors-headers==4.3.1
 djangorestframework==3.15.1
 Pillow==10.3.0
-redis==5.0.0
+redis==5.0.3
 requests==2.31.0
 ryd-client==0.0.6
-uWSGI==2.0.24
+uWSGI==2.0.25.1
 whitenoise==6.6.0
 yt-dlp==2024.4.9

tubearchivist/static/progress.js

@@ -79,7 +79,7 @@ function updateMessageBox(messageData) {
   children[1].innerHTML = messageData.messages.join('<br>');
   if (
     !messageBox.querySelector('#stop-icon') &&
-    messageData['api-stop'] &&
+    messageData['api_stop'] &&
     messageData.command !== 'STOP'
   ) {
     children[2].appendChild(buildStopIcon(messageData.id));