Major Improvements: Subpath, Database Support & Logging (#115)

Features 🚀
SUBPATH Configuration: Added support for subpath configuration and updated routing logic.
Database Support: Introduced support for MySQL and PostgreSQL, with error handling and configuration improvements.
Toast Notifications: Implemented notifications for configuration save success.
UI Refactoring: Updated configuration forms to use v-slot in router-view.
Improvements 🔧
Docker: Refactored Dockerfile to simplify user and permission management.
Logging: Enhanced logging system and added log level configuration via environment variable.
Error Handling: Improved robustness in database error handling and media request processing.
README & UI: Updated documentation, added Discord link to the footer, and improved UX.
Fixes 🛠️
Fixed incorrect logging statement in the save_metadata method.
Added duplicate request handling in media requests.

Author: giuseppe99barchetta

.github/FUNDING.yml

@@ -1,7 +1,7 @@
 # These are supported funding model platforms
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
+patreon: suggestarr
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

README.md

@@ -10,13 +10,10 @@
 ![Platform Support](https://img.shields.io/badge/platforms-linux%2Famd64%20|%20linux%2Farm64-blue?logo=linux)
 ![Docker Pulls](https://img.shields.io/docker/pulls/ciuse99/suggestarr?label=Docker%20Pulls&logo=docker)
 
-[![GitHub Discussions](https://img.shields.io/badge/Community-GitHub%20Discussions-blue?logo=github)](https://github.com/giuseppe99barchetta/suggestarr/discussions)
-![GitHub Stars](https://img.shields.io/github/stars/giuseppe99barchetta/suggestarr?label=Stars&logo=github)
-![Contributors](https://img.shields.io/github/contributors/giuseppe99barchetta/suggestarr?label=Contributors&logo=github)
 [![Buy Me a Coffee](https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-orange?logo=buy-me-a-coffee)](https://buymeacoffee.com/suggestarr)
 [![Reddit Upvotes](https://img.shields.io/badge/Reddit-Upvotes-ff4500?logo=reddit)](https://www.reddit.com/r/selfhosted/comments/1gb4swg/release_major_update_for_suggestarr_now/)
 ![Last Commit](https://img.shields.io/github/last-commit/giuseppe99barchetta/suggestarr?label=Last%20Commit&logo=github)
-
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/JXwFd3PnXY?style=flat)](https://discord.gg/JXwFd3PnXY)
 </div>
 
 SuggestArr is a project designed to automate media content recommendations and download requests based on user activity in media servers like **Jellyfin**, **Plex**, and now **Emby**. It retrieves recently watched content, searches for similar titles using the TMDb API, and sends automated download requests to **Jellyseer** or **Overseer**.
@@ -30,12 +27,15 @@ SuggestArr is a project designed to automate media content recommendations and d
 - **User Selection**: Choose specific users to initiate requests, allowing management and approval of auto-requested content.
 - **Cron Job Management**: Update the cron job schedule directly from the web interface.
 - **Configuration Pre-testing**: Automatically validates API keys and URLs during setup.
+- **Content Filtering**: Exclude requests for content already available on streaming platforms in your country.
+- **External Database Support**: Use external databases (PostgreSQL, MySQL) in addition to SQLite for improved scalability and performance.
 
 ## Prerequisites
 - **Python 3.x** or **Docker**
 - **[TMDb API Key](https://www.themoviedb.org/documentation/api)**
 - Configured **[Jellyfin](https://jellyfin.org/)**, **[Plex](https://www.plex.tv/)**, or **[Emby](https://emby.media/)**
 - Configured **[Jellyseer](https://github.com/Fallenbagel/jellyseerr)** or **[Overseer](https://github.com/sct/overseerr)**
+- (Optional) External database (PostgreSQL or MySQL) for improved performance
 
 ## Docker Usage
 
@@ -53,6 +53,9 @@ services:
       - "5000:5000"
     volumes:
       - ./config_files:/app/config/config_files
+    environment:
+      # Optional: Only needed if something goes wrong and you need to inspect deeper
+      - LOG_LEVEL=${LOG_LEVEL:-info}
 ```
 To start the container with Docker Compose:
 
@@ -77,22 +80,10 @@ If you'd like to use a specific Jellyseer user to make media requests, follow th
 Note: Currently, only local Jellyseer users are supported.
 
 ## Running Without Docker
-You can also run the project locally by installing the dependencies and setting the environment variables.
-
-### Steps:
-1. Install Python dependencies:
-
-```bash
-pip install -r requirements.txt
-```
-2. Run the project:
-
-```bash
-python app.py
-```
+For detailed instructions on setting up SuggestArr withouth Docker or as a system service, please refer to our [Installation Guide](https://github.com/giuseppe99barchetta/SuggestArr/wiki/Installation#documentation-to-run-the-project-without-docker).
 
-3. Access to the web interface
-The web interface will be available at: [http://localhost:5000](http://localhost:5000).
+## Join Our Discord Community
+Feel free to join our Discord community to share ideas, ask questions, or get help with SuggestArr: [Join here](https://discord.gg/cpjBJ5sK).
 
 ## Contribute
 Contributions are highly welcome! Feel free to open issues, submit pull requests, or provide any feedback that can improve the project. Whether you're fixing bugs, improving documentation, or adding new features, all contributions are greatly appreciated.

api_service/app.py

@@ -11,6 +11,7 @@
 
 from api_service.utils.utils import AppUtils
 from api_service.config.logger_manager import LoggerManager
+from api_service.config.config import load_env_vars
 
 from api_service.blueprints.jellyfin.routes import jellyfin_bp
 from api_service.blueprints.seer.routes import seer_bp
@@ -20,7 +21,8 @@
 from api_service.blueprints.config.routes import config_bp
 
 executor = ThreadPoolExecutor(max_workers=3)
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager.get_logger("APP") 
+logger.info(f"Current log level: {logging.getLevelName(logger.getEffectiveLevel())}")
 
 # App Factory Pattern for modularity and testability
 def create_app():
@@ -69,6 +71,10 @@ def serve_frontend(path):
 
 app = create_app()
 asgi_app = WsgiToAsgi(app)
+env_vars = load_env_vars()
+if env_vars.get('CRON_TIMES'):
+    from api_service.config.cron_jobs import start_cron_job
+    start_cron_job(env_vars)
 
 def close_log_handlers():
     for handler in logging.root.handlers[:]:

api_service/automate_process.py

@@ -1,5 +1,3 @@
-import asyncio
-
 from api_service.config.config import load_env_vars
 from api_service.config.logger_manager import LoggerManager
 from api_service.handler.jellyfin_handler import JellyfinHandler

api_service/blueprints/automation/routes.py

@@ -3,7 +3,7 @@
 from api_service.config.logger_manager import LoggerManager
 from api_service.db.database_manager import DatabaseManager
 
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager().get_logger("AutomationRoute")
 automation_bp = Blueprint('automation', __name__)
 
 @automation_bp.route('/force_run', methods=['POST'])

api_service/blueprints/config/routes.py

@@ -1,8 +1,11 @@
+import os
 from flask import Blueprint, request, jsonify
+import yaml
 from api_service.config.config import load_env_vars, save_env_vars, clear_env_vars
 from api_service.config.logger_manager import LoggerManager
+from api_service.db.database_manager import DatabaseManager
 
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager().get_logger("ConfigRoute")
 config_bp = Blueprint('config', __name__)
 
 @config_bp.route('/fetch', methods=['GET'])
@@ -25,6 +28,7 @@ def save_config():
     try:
         config_data = request.json
         save_env_vars(config_data)
+        DatabaseManager().initialize_db()
         return jsonify({'message': 'Configuration saved successfully!', 'status': 'success'}), 200
     except Exception as e:
         logger.error(f'Error saving configuration: {str(e)}')
@@ -41,3 +45,30 @@ def reset_config():
     except Exception as e:
         logger.error(f'Error clearing configuration: {str(e)}')
         return jsonify({'message': f'Error clearing configuration: {str(e)}', 'status': 'error'}), 500
+
+@config_bp.route('/test-db-connection', methods=['POST'])
+def test_db_connection():
+    """
+    Test database connection.
+    """
+    try:
+        # Extract DB configuration data from the request
+        db_config = request.json
+
+        # Check if the necessary data has been provided
+        required_keys = ['DB_TYPE', 'DB_HOST', 'DB_PORT', 'DB_USER', 'DB_PASSWORD', 'DB_NAME']
+        if any(key not in db_config for key in required_keys):
+            return jsonify({'message': 'Missing required database configuration parameters.', 'status': 'error'}), 400
+
+        # Create an instance of the DatabaseManager
+        db_manager = DatabaseManager()
+
+        # Call the connection test method
+        result = db_manager.test_connection(db_config)
+
+        # Respond with the test result
+        return jsonify(result), 200 if result['status'] == 'success' else 500
+
+    except Exception as e:
+        logger.error(f'Error testing database connection: {str(e)}')
+        return jsonify({'message': f'Error testing database connection: {str(e)}', 'status': 'error'}), 500

api_service/blueprints/jellyfin/routes.py

@@ -2,7 +2,7 @@
 from api_service.services.jellyfin.jellyfin_client import JellyfinClient
 from api_service.config.logger_manager import LoggerManager
 
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager().get_logger("JellyfinRoute")
 jellyfin_bp = Blueprint('jellyfin', __name__)
 
 @jellyfin_bp.route('/libraries', methods=['POST'])

api_service/blueprints/logs/routes.py

@@ -1,7 +1,7 @@
 from flask import Blueprint, jsonify
 from api_service.config.logger_manager import LoggerManager
 
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager().get_logger("LogsRoute")
 logs_bp = Blueprint('logs', __name__)
 
 @logs_bp.route('/logs', methods=['GET'])

api_service/blueprints/plex/routes.py

@@ -5,7 +5,7 @@
 from api_service.services.plex.plex_client import PlexClient
 from api_service.config.logger_manager import LoggerManager
 
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager().get_logger("PlexRoute")
 plex_bp = Blueprint('plex', __name__)
 client_id = os.getenv('PLEX_CLIENT_ID', str(uuid.uuid4()))
 

api_service/blueprints/seer/routes.py

@@ -2,7 +2,7 @@
 from api_service.services.jellyseer.seer_client import SeerClient
 from api_service.config.logger_manager import LoggerManager
 
-logger = LoggerManager().get_logger(__name__)
+logger = LoggerManager().get_logger("SeerRoute")
 seer_bp = Blueprint('seer', __name__)
 
 @seer_bp.route('/get_users', methods=['POST'])