config.example.py

"""
Application configuration reference for CIIMS.

config.py (tracked in this repository) already ships with safe,
environment-driven defaults, so you normally do NOT need to copy this
file over it. Use this file as documentation of every supported setting;
override any value via environment variables or a local .env file
(see the README's Configuration section).
"""

import os
from dotenv import load_dotenv
from utils.logging_config import get_logger

# Load environment variables
load_dotenv()

logger = get_logger(__name__)


class Config:
    """Application configuration class"""

    # Database configuration
    DB_HOST = os.getenv("DB_HOST", "localhost")
    DB_USER = os.getenv("DB_USER", "root")
    DB_PASSWORD = os.getenv("DB_PASSWORD", "your_database_password")
    DB_DATABASE = os.getenv("DB_DATABASE", "campus_system")
    DB_CHARSET = os.getenv("DB_CHARSET", "utf8mb4")

    # Database pool configuration
    DB_POOL_NAME = "ciims_pool"
    DB_POOL_SIZE = int(os.getenv("DB_POOL_SIZE", "5"))

    # Face recognition configuration (optional)
    FACE_RECOGNITION_MODEL_PATH = os.getenv(
        "FACE_RECOGNITION_MODEL_PATH", "model/trainer.yml"
    )
    FACE_RECOGNITION_HAAR_CASCADE_PATH = os.getenv(
        "FACE_RECOGNITION_HAAR_CASCADE_PATH", "haarcascade_frontalface_default.xml"
    )
    FACE_RECOGNITION_CONFIDENCE_THRESHOLD = float(
        os.getenv("FACE_RECOGNITION_CONFIDENCE_THRESHOLD", "50")
    )
    FACE_RECOGNITION_PREDICTION_THRESHOLD = int(
        os.getenv("FACE_RECOGNITION_PREDICTION_THRESHOLD", "70")
    )
    FACE_RECOGNITION_TIMEOUT_SECONDS = int(
        os.getenv("FACE_RECOGNITION_TIMEOUT_SECONDS", "30")
    )

    # Logging configuration
    LOG_LEVEL = os.getenv("LOG_LEVEL", "INFO")
    LOG_DIR = os.getenv("LOG_DIR", "logs")
    LOG_MAX_BYTES = int(os.getenv("LOG_MAX_BYTES", "10485760"))  # 10MB
    LOG_BACKUP_COUNT = int(os.getenv("LOG_BACKUP_COUNT", "5"))

    # Application configuration
    APP_NAME = os.getenv("APP_NAME", "CIIMS")
    APP_VERSION = os.getenv("APP_VERSION", "1.0.0")
    DEBUG = os.getenv("DEBUG", "False").lower() == "true"

    # AI assistant configuration (optional - leave empty to disable)
    OPENROUTER_BASE_URL = os.getenv(
        "OPENROUTER_BASE_URL", "https://openrouter.ai/api/v1"
    )
    OPENROUTER_API_KEY = os.getenv("OPENROUTER_API_KEY", "your_api_key_here")
    OPENROUTER_MODEL = os.getenv("OPENROUTER_MODEL", "deepseek/deepseek-chat")
    OPENROUTER_REFERER = os.getenv("OPENROUTER_REFERER", "")
    OPENROUTER_TITLE = os.getenv("OPENROUTER_TITLE", "CIIMS In-App Assistant")
    PROXY_URL = os.getenv("CIIMS_PROXY_URL", "")

    # Security configuration
    PASSWORD_HASH_ROUNDS = int(os.getenv("PASSWORD_HASH_ROUNDS", "12"))

    @classmethod
    def get_db_config(cls):
        """Get database configuration as dictionary"""
        return {
            "host": cls.DB_HOST,
            "user": cls.DB_USER,
            "password": cls.DB_PASSWORD,
            "database": cls.DB_DATABASE,
            "charset": cls.DB_CHARSET,
        }

    @classmethod
    def validate_config(cls):
        """Validate configuration settings"""
        errors = []

        # Validate database configuration
        if not cls.DB_HOST:
            errors.append("DB_HOST is required")
        if not cls.DB_USER:
            errors.append("DB_USER is required")
        if not cls.DB_DATABASE:
            errors.append("DB_DATABASE is required")

        # Skip face recognition validation for public release
        logger.info("Face recognition validation skipped for public release")

        if errors:
            for error in errors:
                logger.error("Configuration validation error: %s", error)
            return False

        logger.info("Configuration validation passed")
        return True