Merge pull request #118 from zurdi15/develop

v1.6.1

Author: zurdi15

backend/src/config/__init__.py

@@ -7,18 +7,17 @@
 DEV_HOST: str = "0.0.0.0"
 
 # PATHS
-LIBRARY_BASE_PATH: str = "/library"
+LIBRARY_BASE_PATH: str = "/romm/library"
+ROMM_USER_CONFIG_PATH: str = "/romm/config.yml"
+SQLITE_DB_BASE_PATH: str = "/romm/database"
 HIGH_PRIO_STRUCTURE_PATH: str = f"{LIBRARY_BASE_PATH}/roms"
-ROMM_USER_CONFIG_PATH: str = f"/romm/config.yml"
-
-# ROMM RESERVED FOLDERS
-RESERVED_FOLDERS: list = ['resources', 'database']
+RESOURCES_BASE_PATH: str = "/romm/resources"
 
 # DEFAULT RESOURCES
 DEFAULT_URL_COVER_L: str = "https://images.igdb.com/igdb/image/upload/t_cover_big/nocover.png"
-DEFAULT_PATH_COVER_L: str = f"/assets/library/resources/default/cover_l.png"
+DEFAULT_PATH_COVER_L: str = f"{RESOURCES_BASE_PATH}/default/cover_l.png"
 DEFAULT_URL_COVER_S: str = "https://images.igdb.com/igdb/image/upload/t_cover_small/nocover.png"
-DEFAULT_PATH_COVER_S: str = f"/assets/library/resources/default/cover_s.png"
+DEFAULT_PATH_COVER_S: str = f"{RESOURCES_BASE_PATH}/default/cover_s.png"
 
 # IGDB
 CLIENT_ID: str = os.getenv('CLIENT_ID')

backend/src/config/config_loader.py

@@ -2,7 +2,7 @@
 import sys
 from urllib.parse import quote_plus
 
-from config import ROMM_DB_DRIVER, SUPPORTED_DB_DRIVERS, LIBRARY_BASE_PATH
+from config import ROMM_DB_DRIVER, SUPPORTED_DB_DRIVERS, SQLITE_DB_BASE_PATH
 from logger.logger import log
 
 
@@ -23,9 +23,8 @@ def get_db_engine():
             return f"mariadb+mariadbconnector://{DB_USER}:%s@{DB_HOST}:{DB_PORT}/{DB_NAME}" % quote_plus(DB_PASSWD)
 
         elif ROMM_DB_DRIVER == 'sqlite':
-            SQLITE_PATH: str = f"{LIBRARY_BASE_PATH}/database"
-            if not os.path.exists(SQLITE_PATH): os.makedirs(SQLITE_PATH)
-            return f"sqlite:////{SQLITE_PATH}/romm.db"
+            if not os.path.exists(SQLITE_DB_BASE_PATH): os.makedirs(SQLITE_DB_BASE_PATH)
+            return f"sqlite:////{SQLITE_DB_BASE_PATH}/romm.db"
 
     else:
         log.critical(f"Not supported {ROMM_DB_DRIVER} database")

backend/src/utils/fs.py

@@ -6,9 +6,7 @@
 import requests
 from fastapi import HTTPException
 
-from config import user_config, LIBRARY_BASE_PATH, HIGH_PRIO_STRUCTURE_PATH, RESERVED_FOLDERS, DEFAULT_URL_COVER_L, DEFAULT_PATH_COVER_L, DEFAULT_URL_COVER_S, DEFAULT_PATH_COVER_S
-from models.platform import Platform
-from models.rom import Rom
+from config import user_config, LIBRARY_BASE_PATH, HIGH_PRIO_STRUCTURE_PATH, RESOURCES_BASE_PATH, DEFAULT_URL_COVER_L, DEFAULT_PATH_COVER_L, DEFAULT_URL_COVER_S, DEFAULT_PATH_COVER_S
 from handler import dbh
 from logger.logger import log
 
@@ -38,7 +36,6 @@ def get_platforms() -> list[str]:
             platforms: list[str] = list(os.walk(f"{LIBRARY_BASE_PATH}/roms"))[0][1]
         else:
             platforms: list[str] = list(os.walk(LIBRARY_BASE_PATH))[0][1]
-        [platforms.remove(reserved) for reserved in RESERVED_FOLDERS if reserved in platforms]
         try:
             excluded_folders: list = user_config['exclude']['folders']
             try:
@@ -159,19 +156,19 @@ def _cover_exists(p_slug: str, file_name: str, size: str) -> bool:
     Returns
         True if cover exists in filesystem else False
     """
-    logo_path: str = f"{LIBRARY_BASE_PATH}/resources/{p_slug}/{file_name}_{size}.png"
+    logo_path: str = f"{RESOURCES_BASE_PATH}/{p_slug}/{file_name}_{size}.png"
     return True if os.path.exists(logo_path) else False
 
 
 def _get_cover_path(p_slug: str, file_name: str, size: str) -> str:
-    """Returns platform logo filesystem path
+    """Returns rom cover filesystem path adapted to frontend folder structure
     
     Args:
         p_slug: short name of the platform
         file_name: name of rom file
         size: size of the cover -> big as 'l' | small as 's'
     """
-    return f"/assets/library/resources/{p_slug}/{file_name}_{size}.png"
+    return f"{RESOURCES_BASE_PATH}/{p_slug}/{file_name}_{size}.png"
 
 
 def _store_cover(p_slug: str, file_name: str, url_cover: str, size: str) -> None:
@@ -184,7 +181,7 @@ def _store_cover(p_slug: str, file_name: str, url_cover: str, size: str) -> None
         size: size of the cover -> big as 'l' | small as 's'
     """
     cover_file: str = f"{file_name}_{size}.png"
-    cover_path: str = f"{LIBRARY_BASE_PATH}/resources/{p_slug}/"
+    cover_path: str = f"{RESOURCES_BASE_PATH}/{p_slug}/"
     sizes: dict = {'l': 'big', 's': 'small'}
     res = requests.get(url_cover.replace('t_thumb', f't_cover_{sizes[size]}'), stream=True)
     if res.status_code == 200:

changelog.md

@@ -10,7 +10,9 @@ RUN npm run build
 FROM ubuntu/nginx:1.18-22.04_edge as production-stage
 COPY --from=front-build-stage /front/dist /var/www/html
 COPY ./frontend/assets/platforms /var/www/html/assets/platforms
-RUN ln -s /library /var/www/html/assets/library
+RUN mkdir -p /var/www/html/assets/romm
+RUN ln -s /romm/library /var/www/html/assets/romm/library
+RUN ln -s /romm/resources /var/www/html/assets/romm/resources
 
 # setup backend
 RUN apt update 

docker/Dockerfile

@@ -14,8 +14,10 @@ services:
       - CLIENT_SECRET=<IGDB client secret>
       - STEAMGRIDDB_API_KEY=WIP
     volumes:
-      - '/path/to/library:/library'
+      - '/path/to/library:/romm/library'
+      - '/path/to/resources:/romm/resources'
       - '/path/to/config.yml:/romm/config.yml'
+      - '/path/to/database:/romm/database' # Only if ROMM_DB_DRIVER='sqlite' or ROMM_DB_DRIVER not exists 
     ports:
       - '80:80'
     depends_on:

docker/docker-compose.example.yml

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 cd /back
-uvicorn main:app --proxy-headers --host 0.0.0.0 --port 5000 --workers 2
+uvicorn main:app --proxy-headers --host 0.0.0.0 --port 5000 --workers 3