# SPDX-FileCopyrightText: 2026 Dennis Fink # # SPDX-License-Identifier: BSD-3-Clause """Initialize the Flask application and its shared extensions.""" import logging import logging.handlers import os from pathlib import Path import coloredlogs from flask import Flask from werkzeug.middleware.proxy_fix import ProxyFix from .auth import login_manager from .cli import DB_CLI, MAIL_CLI, USERS_CLI from .config import ( DefaultConfig, DevelopmentConfig, ProductionConfig, validated_config_overrides, ) from .extensions import bootstrap, csrf, db, huey, limiter, mail, migrate from .net import is_http_url from .version import APP_NAME as APP_NAME from .version import VERSION from .views import webmentions_bp def create_app(config_class: type[DefaultConfig] | None = None) -> Flask: """Create and configure the Flask application. The application configuration is selected based on the development environment unless an explicit configuration class is provided. Logging, extensions, authentication, Huey, blueprints, and CLI commands are then initialized. :param config_class: Configuration class to use, or ``None`` to select the development or production configuration automatically. :returns: Configured Flask application. """ development = os.environ.get("WEBMENTIONS_SSG_DEV", "").lower() in { "1", "true", "yes", "on", } if config_class is None: config_class = DevelopmentConfig if development else ProductionConfig app = Flask( __name__, instance_path=( str(Path("testing").absolute()) if issubclass(config_class, DevelopmentConfig) else None ), ) app.config.from_object(config_class) if not app.testing: # Local development may omit its config file; production must not. app.config.from_pyfile(app.config["CONFIG_FILE"], silent=app.debug) app.config.from_prefixed_env(prefix="FLASK") app.config.from_prefixed_env(prefix="WEBMENTIONS_SSG") app.config.update(validated_config_overrides(app.config, config_class=config_class)) if proxy_hops := app.config["PROXY_FIX_TRUSTED_HOPS"]: # Do not trust forwarded host, port, or URL prefixes. app.wsgi_app = ProxyFix(app.wsgi_app, x_for=proxy_hops, x_proto=proxy_hops) if app.debug or app.testing: Path(app.instance_path).mkdir(parents=True, exist_ok=True) Path(app.config["LOG_FILE"]).parent.mkdir(parents=True, exist_ok=True) default_logging_formatter = logging.Formatter(app.config["LOG_FORMAT"]) log_file_handler = logging.handlers.RotatingFileHandler( app.config["LOG_FILE"], maxBytes=app.config["LOG_FILE_MAX_BYTES"], backupCount=app.config["LOG_FILE_BACKUP_COUNT"], ) log_file_handler.setLevel(app.config["LOG_LEVEL"]) log_file_handler.setFormatter(default_logging_formatter) logging.basicConfig(level=logging.DEBUG, handlers=[logging.NullHandler()]) app.logger.handlers.clear() app.logger.setLevel(app.config["LOG_LEVEL"]) app.logger.addHandler(log_file_handler) werkzeug_logger = logging.getLogger("werkzeug") werkzeug_logger.setLevel(app.config["LOG_LEVEL"]) werkzeug_logger.addHandler(log_file_handler) coloredlogs.install( level=app.config["LOG_LEVEL"], logger=app.logger, fmt=app.config["LOG_FORMAT"] ) coloredlogs.install( level=app.config["LOG_LEVEL"], logger=werkzeug_logger, fmt=app.config["LOG_FORMAT"], ) db.init_app(app) migrate.init_app( app, db=db, directory=str(Path(__file__).resolve().parent / "migrations"), command="migrate", ) # Flask-Migrate always registers its CLI group. Keep its API available for # the guarded `flask db` commands, but hide the unrestricted CLI outside DEV. if not development: app.cli.commands.pop("migrate", None) csrf.init_app(app) limiter.init_app(app) mail.init_app(app) login_manager.init_app(app) bootstrap.init_app(app) huey.init_app(app) @app.context_processor def inject_version(): """Add the application version to the template context. :returns: Template context containing the application version. """ return {"VERSION": VERSION} app.add_template_filter(is_http_url) app.register_blueprint(webmentions_bp) app.cli.add_command(USERS_CLI) app.cli.add_command(MAIL_CLI) app.cli.add_command(DB_CLI) return app