Files
TimeTracker/app/utils/config_manager.py
T
Dries Peeters b4486a627f fix: CI tests, code quality, and duplicate DB indexes
- Webhook models: remove duplicate index definitions so db.create_all()
  no longer raises 'index already exists' (columns already have index=True)
- ImportService: fix circular import by late-importing ClientService,
  ProjectService, TimeTrackingService in __init__
- reports: fix F823 by renaming unpack variable _ to _entry_count to avoid
  shadowing gettext _ in export_task_excel()
- Code quality: add .flake8 with extend-ignore so flake8 CI passes;
  simplify pyproject.toml isort config (drop unsupported options)
- Format: run black and isort on app/
- tests: restore minimal app fixture in test_import_export_models
2026-03-15 10:51:52 +01:00

138 lines
4.7 KiB
Python

"""
Configuration management utilities.
"""
import os
from typing import Any, Dict, Optional
from flask import current_app
from app.models import Settings
class ConfigManager:
"""Utility for managing application configuration"""
@staticmethod
def get_setting(key: str, default: Any = None) -> Any:
"""
Get a setting value.
Checks in order:
1. Settings model (WebUI changes have highest priority)
2. Environment variable (.env file - used as initial values)
3. App config
4. Default value
Args:
key: Setting key
default: Default value if not found
Returns:
Setting value
"""
# Demo mode: self-registration is always disabled
if key == "allow_self_register" and current_app and current_app.config.get("DEMO_MODE"):
return False
# Check Settings model first (WebUI changes have highest priority)
# Only use values from persisted Settings instances (those with an id)
# to avoid using fallback instances initialized from .env file
try:
settings = Settings.get_settings()
if settings and hasattr(settings, key):
# Only use Settings value if instance is persisted in database (has an id)
# This ensures we're reading from the database, not a fallback instance
if hasattr(settings, "id") and settings.id is not None:
value = getattr(settings, key, None)
# For boolean values, explicitly check False vs None
# For string values, check empty string vs None
# For integer values, check 0 vs None
if value is not None:
# If value is explicitly set (even if False, 0, or ""), use it
return value
# If value is None, check if it's a required field that should have a default
# For now, if value is None in persisted instance, fall back to env/default
except Exception as e:
# Log error but continue to fallback values
import logging
logger = logging.getLogger(__name__)
logger.debug(f"Error retrieving setting '{key}' from Settings model: {e}")
pass
# Check environment variable second (.env file - used as initial values)
env_value = os.getenv(key.upper())
if env_value is not None:
# Convert string booleans to actual booleans for consistency
if isinstance(env_value, str):
lower_val = env_value.lower().strip()
if lower_val in ("true", "1", "yes", "on"):
return True
elif lower_val in ("false", "0", "no", "off", ""):
return False
return env_value
# Check app config
if current_app:
value = current_app.config.get(key, default)
if value is not None:
return value
return default
@staticmethod
def set_setting(key: str, value: Any) -> bool:
"""
Set a setting value in the Settings model.
Args:
key: Setting key
value: Setting value
Returns:
True if successful
"""
try:
settings = Settings.get_settings()
if settings and hasattr(settings, key):
setattr(settings, key, value)
from app import db
db.session.commit()
return True
except Exception:
pass
return False
@staticmethod
def validate_config() -> Dict[str, Any]:
"""
Validate application configuration.
Returns:
dict with validation results
"""
errors = []
warnings = []
# Check required settings
required_settings = ["SECRET_KEY", "SQLALCHEMY_DATABASE_URI"]
for setting in required_settings:
value = ConfigManager.get_setting(setting)
if not value:
errors.append(f"Missing required setting: {setting}")
# Check secret key strength
secret_key = ConfigManager.get_setting("SECRET_KEY")
if secret_key and len(secret_key) < 32:
warnings.append("SECRET_KEY is too short (should be at least 32 characters)")
# Check database URL
db_url = ConfigManager.get_setting("SQLALCHEMY_DATABASE_URI")
if db_url and "dev-secret-key" in str(db_url):
warnings.append("Using default database configuration")
return {"valid": len(errors) == 0, "errors": errors, "warnings": warnings}