Unit3DwebUp 0.0.25__tar.gz → 0.0.27__tar.gz

{unit3dwebup-0.0.25 → unit3dwebup-0.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Unit3DwebUp
-Version: 0.0.25
+Version: 0.0.27
 Summary: A Unit3D uploader with a web interface
 Author: Parzival
 License-Expression: GPL-3.0-only
@@ -9,6 +9,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 Requires-Dist: aiohttp==3.13.3
 Requires-Dist: fastapi==0.129.0
+Requires-Dist: slowapi==0.1.9
 Requires-Dist: guessit==3.8.0
 Requires-Dist: numpy==2.4.2
 Requires-Dist: pathvalidate==3.3.1

{unit3dwebup-0.0.25 → unit3dwebup-0.0.27}/Unit3DwebUp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Unit3DwebUp
-Version: 0.0.25
+Version: 0.0.27
 Summary: A Unit3D uploader with a web interface
 Author: Parzival
 License-Expression: GPL-3.0-only
@@ -9,6 +9,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 Requires-Dist: aiohttp==3.13.3
 Requires-Dist: fastapi==0.129.0
+Requires-Dist: slowapi==0.1.9
 Requires-Dist: guessit==3.8.0
 Requires-Dist: numpy==2.4.2
 Requires-Dist: pathvalidate==3.3.1

{unit3dwebup-0.0.25 → unit3dwebup-0.0.27}/Unit3DwebUp.egg-info/SOURCES.txt

@@ -7,12 +7,16 @@ Unit3DwebUp.egg-info/entry_points.txt
 Unit3DwebUp.egg-info/requires.txt
 Unit3DwebUp.egg-info/top_level.txt
 unit3dwup/__init__.py
+unit3dwup/lifespan.py
+unit3dwup/schemas.py
 unit3dwup/start.py
+unit3dwup/start_backup.py
 unit3dwup/config/__init__.py
 unit3dwup/config/api_data.py
 unit3dwup/config/constants.py
 unit3dwup/config/host_data.py
 unit3dwup/config/itt.py
+unit3dwup/config/limiter.py
 unit3dwup/config/logger.py
 unit3dwup/config/settings.py
 unit3dwup/config/sis.py
@@ -36,6 +40,15 @@ unit3dwup/repositories/db_online.py
 unit3dwup/repositories/interfaces.py
 unit3dwup/repositories/job_repos.py
 unit3dwup/repositories/media_info_factory.py
+unit3dwup/routers/__init__.py
+unit3dwup/routers/dependencies.py
+unit3dwup/routers/jobs.py
+unit3dwup/routers/posters.py
+unit3dwup/routers/process.py
+unit3dwup/routers/scan.py
+unit3dwup/routers/search.py
+unit3dwup/routers/settings.py
+unit3dwup/routers/ws.py
 unit3dwup/services/__init__.py
 unit3dwup/services/auto_async_service.py
 unit3dwup/services/create_torrent_service.py

{unit3dwebup-0.0.25 → unit3dwebup-0.0.27}/Unit3DwebUp.egg-info/requires.txt

@@ -1,5 +1,6 @@
 aiohttp==3.13.3
 fastapi==0.129.0
+slowapi==0.1.9
 guessit==3.8.0
 numpy==2.4.2
 pathvalidate==3.3.1

{unit3dwebup-0.0.25 → unit3dwebup-0.0.27}/pyproject.toml

@@ -7,6 +7,7 @@ dynamic = []
 dependencies = [
     "aiohttp==3.13.3",
     "fastapi==0.129.0",
+    "slowapi==0.1.9",
     "guessit==3.8.0",
     "numpy==2.4.2",
     "pathvalidate==3.3.1",
@@ -24,7 +25,7 @@ dependencies = [
     "uvicorn[standard]==0.40.0"
 ]
 name = "Unit3DwebUp"
-version = "0.0.25"
+version = "0.0.27"
 
 description = "A Unit3D uploader with a web interface"
 readme = { file = "README.md", content-type = "text/markdown" }

{unit3dwebup-0.0.25 → unit3dwebup-0.0.27}/unit3dwup/config/__init__.py

@@ -3,8 +3,8 @@ from .sis import sis_data
 
 tracker_list = {'ITT': itt_data, 'SIS': sis_data}
 
-from .settings import get_settings
+from .settings import get_settings,Settings
 from .constants import MediaStatus
 from .logger import get_logger
 
-__version__ = "0.0.25"
+__version__ = "0.0.27"

unit3dwebup-0.0.27/unit3dwup/config/limiter.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+from slowapi import Limiter
+from slowapi.util import get_remote_address
+
+limiter = Limiter(key_func=get_remote_address)

unit3dwebup-0.0.27/unit3dwup/lifespan.py

@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+import asyncio
+import os
+
+from contextlib import asynccontextmanager
+from pathlib import Path
+
+from unit3dwup.config import get_settings
+from unit3dwup.config import get_logger
+
+from unit3dwup.repositories.job_repos import JobRedisRepo
+
+from unit3dwup.services.lifespan_service import update_mounted_paths, checking_env_file
+
+from unit3dwup.external.websocket import WebSocketManager
+
+from fastapi import FastAPI
+
+from watchdog.observers import Observer
+from watchdog.events import FileSystemEventHandler
+
+
+class RedisEventHandler(FileSystemEventHandler):
+    """
+        Watch only a specific folder
+        This event is shared by app.state FastApi
+        it uses a queue 'redis_event'
+     """
+
+    def __init__(self, app):
+        self.app = app
+
+    def on_created(self, event):
+        self.app.state.redis_events.put_nowait({
+            "type": "created",
+            "path": event.src_path,
+        })
+
+    def on_deleted(self, event):
+        self.app.state.redis_events.put_nowait({
+            "type": "deleted",
+            "path": event.src_path,
+        })
+
+
+async def redis_event_consumer(app: FastAPI):
+    """
+    :param app: it is mr FastApi
+    :return: None
+
+    It is a consumer. Wait for any news from the queue and extract the new path created or deleted
+    """
+
+    # > The queue :|
+    queue = app.state.redis_events
+
+    # Logger
+    logger = get_logger("settings_logger")
+
+    while True:
+        event = await queue.get()
+        try:
+            app.state.folder_event = event
+            relative = Path(app.state.folder_event['path']).relative_to(Path(app.state.watcher_path))
+            new_path = Path(app.state.settings.prefs.WATCHER_PATH) / relative.parts[0]
+
+            # Send logs to the client
+            await app.state.ws_manager.broadcast({
+                "type": "log",
+                "level": "info",
+                "message": f"{app.state.folder_event['type']} {new_path}",
+            })
+        except Exception as e:
+            logger.debug("Consumer Folder error", e)
+        finally:
+            queue.task_done()
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    """
+    Lifespan initialize DB and app configuration
+    We need to shared state
+    https://fastapi.tiangolo.com/advanced/events/
+
+    :param app: FastAPI
+    :return: None
+    """
+    # Load the configuration file
+    settings = get_settings()
+    app.state.settings = settings
+
+    # Check configuration file
+    await checking_env_file(app=app)
+
+    # Create a new state for the watcher queue
+    app.state.redis_events = asyncio.Queue()
+
+    # Environment variabile in the container backend
+    redis_host = os.getenv("REDIS_HOST", "localhost")
+    redis_port = int(os.getenv("REDIS_PORT", 6379))
+
+    # Build redis url
+    REDIS_URL = f"redis://{redis_host}:{redis_port}"
+
+    # Connect to redis
+    job = JobRedisRepo(url=REDIS_URL)
+    await job.connect(app=app)
+
+    # Store the job reference to app.state
+    app.state.job = job
+
+    # RestartDocker notify
+    # Set flag to true when setEnv is called from the frontend
+    app.state.restart_docker = False
+
+    # Create a new profile from user_preferences Job_id is '0'
+    # Later will be recalled from the setting endpoint
+    await job.create_profile(dict(settings.prefs))
+
+    # The WebSocket. Send to client progress bar value( Torrent creation) and short log message
+    app.state.ws_manager = WebSocketManager()
+
+    # Update mounted paths string
+    await update_mounted_paths(app=app)
+
+    # Watcher zone
+    # Shared event
+    app.state.folder_event = None
+
+    # back to watcher
+    observer = Observer()
+
+    # Callback
+    handler = RedisEventHandler(app)
+
+    # Start to watch
+    observer.schedule(handler, app.state.watcher_path, recursive=True)
+    if app.state.settings.prefs.WATCHER_DESTINATION_PATH != os.getcwd():
+        observer.start()
+
+    # Create a consumer that works in the background
+    consumer_task = asyncio.create_task(redis_event_consumer(app))
+
+    # Goes..
+    yield
+
+    # Come back to clean and close
+    if app.state.settings.prefs.WATCHER_DESTINATION_PATH != os.getcwd():
+        observer.stop()
+        observer.join()
+
+    consumer_task.cancel()
+    await job.close()

unit3dwebup-0.0.27/unit3dwup/routers/dependencies.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+from fastapi import Request
+
+from unit3dwup.config.settings import Settings
+from unit3dwup.external.websocket import WebSocketManager
+from unit3dwup.repositories.job_repos import JobRedisRepo
+
+
+def load_settings(request: Request) -> Settings:
+    return request.app.state.settings
+
+
+def get_job_repo(request: Request) -> JobRedisRepo:
+    return request.app.state.job
+
+
+def get_ws_manager(request: Request) -> WebSocketManager:
+    return request.app.state.ws_manager
+
+
+def get_restart_docker(request: Request) -> bool:
+    return request.app.state.restart_docker

unit3dwebup-0.0.27/unit3dwup/routers/jobs.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+import inspect
+import json
+
+from fastapi import APIRouter, Depends, Request
+
+from unit3dwup.config import get_logger
+from unit3dwup.config.limiter import limiter
+
+from unit3dwup.schemas import ClearJobListRequest
+
+from unit3dwup.external.websocket import WebSocketManager
+from unit3dwup.routers.dependencies import (
+    get_job_repo,
+    get_ws_manager,
+)
+
+router = APIRouter()
+
+
+@router.post("/cjoblist")
+@limiter.limit("5/minute")
+async def clear_job_list_id(payload: ClearJobListRequest, request: Request,
+                            job_repo=Depends(get_job_repo),
+                            ws_manager: WebSocketManager = Depends(get_ws_manager),
+                            ):
+    """
+        This endpoint deletes a job list and all related posters
+
+        Required:
+        - job_list_id: identifier of the job list
+
+        Returns:
+        - status: operation result
+        """
+
+    # Load the job list
+    # Carica la joblist per ottenere il percorso e inviarlo a log. Mi sembra troppo per una stampa
+    job_list = await job_repo.job.get_job_list(job_id=payload.job_list_id)
+    results = [json.loads(await job_repo.get_job(job_id)) for job_id in job_list]
+
+    # Logger
+    frame = inspect.currentframe()
+    logger = get_logger(frame.f_code.co_name)
+
+    # Delete the job list
+    # TODO: delete all job ids
+    await job_repo.delete_job_list(job_id=payload.job_list_id)
+
+    if results:
+        await ws_manager.broadcast({
+            "type": "log",
+            "level": "success",
+            "message": f"Clear JobList {payload.job_list_id} {results[0]['folder']}",
+        })
+        logger.info(f"-> Clear JobList ID° {payload.job_list_id} {results[0]['folder']}\n")
+    else:
+        await ws_manager.broadcast({
+            "type": "log",
+            "level": "error",
+            "message": f"Clear JobList : JobList id not found",
+        })
+        logger.info(f"-> Clear JobList : JobList ID non trovato\n")

unit3dwebup-0.0.27/unit3dwup/routers/posters.py

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+import inspect
+
+from fastapi import APIRouter, Request
+
+from unit3dwup.config import MediaStatus
+from unit3dwup.config import get_logger
+from unit3dwup.config.limiter import limiter
+
+from unit3dwup.schemas import UpdatePosterRequest
+
+router = APIRouter()
+
+
+async def update_poster(app, msg: str, job_id: str, field_id: str, new_id: str):
+    # Fix the DB ID with the received one
+    await app.state.job.update_job(job_id=job_id, new_data={field_id: new_id})
+
+    # Update the Media status
+    await app.state.job.update_job(job_id=job_id, new_data={'status': str(MediaStatus.DB_IDENTIFIED)})
+
+    # Logger
+    frame = inspect.currentframe()
+    logger = get_logger(frame.f_code.co_name)
+
+    # Console message
+    logger.info(f"-> Update {msg} JOB_ID: {job_id}\n")
+
+    # Send log to the client
+    await app.state.ws_manager.broadcast({
+        "type": "log",
+        "level": "success",
+        "message": f"Update {msg} JOB_ID {job_id}",
+    })
+
+
+@router.post("/settmdbid")
+@limiter.limit("5/minute")
+async def set_poster_id(payload: UpdatePosterRequest, request: Request):
+    """
+    Set a Tmdb id for example when tmdb returns an empty result
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+
+    await update_poster(request.app, msg="TMDB", job_id=payload.job_id, field_id=payload.field_id, new_id=payload.new_id)
+
+
+@router.post("/settvdbid")
+@limiter.limit("5/minute")
+async def set_tvdb_id(payload: UpdatePosterRequest, request: Request):
+    """
+    Set a TVdb id for example when tvdb returns an empty result
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+
+    await update_poster(request.app, msg="TVDB", job_id=payload.job_id, field_id=payload.field_id, new_id=payload.new_id)
+
+
+@router.post("/setimdbid")
+@limiter.limit("5/minute")
+async def set_imdb_id(payload: UpdatePosterRequest, request: Request):
+    """
+    Set an Imdb id for example when the remote list of tvdb is empty
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+
+    await update_poster(request.app, msg="IMDB", job_id=payload.job_id, field_id=payload.field_id, new_id=payload.new_id)
+
+
+@router.post("/setposterurl")
+@limiter.limit("5/minute")
+async def set_poster_url(payload: UpdatePosterRequest, request: Request):
+    """
+    Set a poster url for example when tmdb returns an empty result only for frontend
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+
+    await update_poster(request.app, msg="TMDB Poster Url", job_id=payload.job_id, field_id=payload.field_id, new_id=payload.new_id)
+
+
+@router.post("/setposterdname")
+@limiter.limit("5/minute")
+async def set_poster_dname(payload: UpdatePosterRequest, request: Request):
+    """
+    Set a poster display name for example if you dont like it
+    Display name is the name shown on the dedicated torrent page
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+
+    await update_poster(request.app, msg="Update DisplayName", job_id=payload.job_id, field_id=payload.field_id,
+                        new_id=payload.new_id)

unit3dwebup-0.0.27/unit3dwup/routers/process.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+from fastapi import APIRouter, Request, Depends
+from fastapi.responses import JSONResponse
+
+from unit3dwup.config import Settings
+from unit3dwup.config.limiter import limiter
+
+from unit3dwup.use_case.process_all_usecase import ProcessAllUseCase
+from unit3dwup.use_case.upload_usecase import UploadUseCase
+from unit3dwup.use_case.seed_usecase import SeedUseCase
+from unit3dwup.use_case.make_torrent_usecase import MakeTorrentUseCase
+
+from unit3dwup.schemas import ProcessAllRequest, JobRequest
+
+from unit3dwup.routers.dependencies import (
+    load_settings,
+)
+
+router = APIRouter()
+
+
+@router.post("/processall")
+@limiter.limit("5/minute")
+async def process_all(payload: ProcessAllRequest, request: Request,
+                      settings: Settings = Depends(load_settings),
+                      ):
+    """
+    Start a chain load the joblist filter for existing torrent create torrent upload the complete joblist
+
+    Required
+    - job_list_id identifies the list created by the scan endpoint
+
+    Prerequisite
+    - valid description status media class attribute
+
+    Return
+    - none
+    """
+
+    app = request.app
+
+    use_case = ProcessAllUseCase(app=app, job_list_id=payload.job_list_id,
+                                 torrent_client_name=settings.torrent.TORRENT_CLIENT)
+    await use_case.execute()
+
+
+@router.post("/maketorrent")
+@limiter.limit("5/minute")
+async def make(payload: JobRequest, request: Request):
+    """
+    Create one or more torrent files
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+    app = request.app
+
+    torrent_service = MakeTorrentUseCase(app=app, job_id=payload.job_id)
+    await torrent_service.execute()
+
+
+@router.post("/upload")
+@limiter.limit("5/minute")
+async def upload(payload: JobRequest, request: Request):
+    """
+    Upload a single torrent file
+
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+
+    WebSocket events emitted
+    - posterLogMessage: sent for each uploaded torrent
+    - job_id: media identifier
+    - message: upload result message
+    """
+
+    app = request.app
+
+    upload_service = UploadUseCase(app=app, job_id=payload.job_id)
+    await upload_service.execute()
+
+
+@router.post("/seed")
+@limiter.limit("5/minute")
+async def seed(payload: JobRequest, request: Request,
+               settings: Settings = Depends(load_settings),
+               ) -> JSONResponse:
+    """
+    Required
+    - job_id identifies each poster corresponds to Media.job_id
+
+    Return
+    - none
+    """
+
+    app = request.app
+
+    use_case = SeedUseCase(app=app, client=settings.torrent.TORRENT_CLIENT, job_id=payload.job_id)
+    return await use_case.execute()