aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/__init__.py
blob: 223f35d8e85c28ad1be336ee1d659b0e411a70ce (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# 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 AUTH
from .cli import DB_CLI, MAIL_CLI, USERS_CLI
from .config import DefaultConfig, DevelopmentConfig, ProductionConfig, validate_config
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 root_page


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(validate_config(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["LOGFILE_MAX_BYTES"],
        backupCount=app.config["LOGFILE_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",
    )
    csrf.init_app(app)
    limiter.init_app(app)
    mail.init_app(app)

    AUTH.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(root_page)

    app.cli.add_command(USERS_CLI)

    app.cli.add_command(MAIL_CLI)

    app.cli.add_command(DB_CLI)

    return app