nopaque/app/__init__.py

from apifairy import APIFairy
from config import Config
from docker import DockerClient
from flask import Flask
from flask_apscheduler import APScheduler
from flask_assets import Environment
from flask_login import LoginManager
from flask_mail import Mail
from flask_marshmallow import Marshmallow
from flask_migrate import Migrate
from flask_paranoid import Paranoid
from flask_socketio import SocketIO
from flask_sqlalchemy import SQLAlchemy
from flask_hashids import Hashids


docker_client = DockerClient.from_env()

apifairy = APIFairy()
assets = Environment()
db = SQLAlchemy()
hashids = Hashids()
login = LoginManager()
ma = Marshmallow()
mail = Mail()
migrate = Migrate(compare_type=True)
paranoid = Paranoid()
scheduler = APScheduler()
socketio = SocketIO()


def create_app(config: Config = Config) -> Flask:
    ''' Creates an initialized Flask object. '''

    app = Flask(__name__)
    app.config.from_object(config)

    _configure_logging(app)
    _configure_middlewares(app)
    _init_docker_client(app)
    _init_extensions(app)
    _register_blueprints(app)
    _register_socketio_namespaces(app)
    _register_db_event_listeners(app)

    return app


def _configure_logging(app: Flask):
    from flask.logging import default_handler
    from logging import Formatter, StreamHandler

    log_date_format: str = app.config['NOPAQUE_LOG_DATE_FORMAT']
    log_format: str = app.config['NOPAQUE_LOG_FORMAT']
    log_level: str = app.config['NOPAQUE_LOG_LEVEL']

    formatter = Formatter(fmt=log_format, datefmt=log_date_format)
    handler = StreamHandler()
    handler.setFormatter(formatter)
    handler.setLevel(log_level)

    app.logger.removeHandler(default_handler)
    app.logger.addHandler(handler)


def _configure_middlewares(app: Flask):
    from werkzeug.middleware.proxy_fix import ProxyFix

    if app.config['NOPAQUE_PROXY_FIX_ENABLED']:
        app.wsgi_app = ProxyFix(
            app.wsgi_app,
            x_for=app.config['NOPAQUE_PROXY_FIX_X_FOR'],
            x_host=app.config['NOPAQUE_PROXY_FIX_X_HOST'],
            x_port=app.config['NOPAQUE_PROXY_FIX_X_PORT'],
            x_prefix=app.config['NOPAQUE_PROXY_FIX_X_PREFIX'],
            x_proto=app.config['NOPAQUE_PROXY_FIX_X_PROTO']
        )


def _init_docker_client(app: Flask):
    registry: str = app.config['NOPAQUE_DOCKER_REGISTRY']
    username: str = app.config['NOPAQUE_DOCKER_REGISTRY_USERNAME']
    password: str = app.config['NOPAQUE_DOCKER_REGISTRY_PASSWORD']

    docker_client.login(
        username,
        password=password,
        registry=registry
    )


def _init_extensions(app: Flask):
    from typing import Callable
    from .daemon import daemon
    from .models import AnonymousUser, User

    is_primary_instance: bool = app.config['NOPAQUE_IS_PRIMARY_INSTANCE']
    socketio_message_queue_uri: str = app.config['NOPAQUE_SOCKETIO_MESSAGE_QUEUE_URI']
    login_user_loader_callback: Callable[[int], User | None] = lambda user_id: User.query.get(int(user_id))

    apifairy.init_app(app)
    assets.init_app(app)
    db.init_app(app)
    hashids.init_app(app)
    login.init_app(app)
    login.anonymous_user = AnonymousUser
    login.login_view = 'auth.login'
    login.user_loader(login_user_loader_callback)
    ma.init_app(app)
    mail.init_app(app)
    migrate.init_app(app, db)
    paranoid.init_app(app)
    paranoid.redirect_view = '/'
    scheduler.init_app(app)
    if is_primary_instance:
        scheduler.add_job('daemon', daemon, args=(app,), seconds=3, trigger='interval')
    socketio.init_app(app, message_queue=socketio_message_queue_uri)


def _register_blueprints(app: Flask):
    from .admin import bp as admin_blueprint
    from .api import bp as api_blueprint
    from .auth import bp as auth_blueprint
    from .contributions import bp as contributions_blueprint
    from .corpora import bp as corpora_blueprint
    from .errors import bp as errors_bp
    from .jobs import bp as jobs_blueprint
    from .main import bp as main_blueprint
    from .services import bp as services_blueprint
    from .settings import bp as settings_blueprint
    from .users import bp as users_blueprint
    from .workshops import bp as workshops_blueprint

    app.register_blueprint(admin_blueprint, url_prefix='/admin')
    app.register_blueprint(api_blueprint, url_prefix='/api')
    app.register_blueprint(auth_blueprint)
    app.register_blueprint(contributions_blueprint, url_prefix='/contributions')
    app.register_blueprint(corpora_blueprint, cli_group='corpus', url_prefix='/corpora')
    app.register_blueprint(errors_bp)
    app.register_blueprint(jobs_blueprint, url_prefix='/jobs')
    app.register_blueprint(main_blueprint, cli_group=None)
    app.register_blueprint(services_blueprint, url_prefix='/services')
    app.register_blueprint(settings_blueprint, url_prefix='/settings')
    app.register_blueprint(users_blueprint, cli_group='user', url_prefix='/users')
    app.register_blueprint(workshops_blueprint, url_prefix='/workshops')


def _register_socketio_namespaces(app: Flask):
    from .corpora.cqi_over_sio import CQiOverSocketIO

    socketio.on_namespace(CQiOverSocketIO('/cqi_over_sio'))


def _register_db_event_listeners(app: Flask):
    from .models.event_listeners import register_event_listeners

    register_event_listeners()