flaschengeist/alembic/migrations/255b93b6beed_flaschengeist_initial.py

@@ -1,8 +1,8 @@
-"""Initial core db
+"""Flaschengeist: Initial
 
-Revision ID: 20482a003db8
+Revision ID: 255b93b6beed
 Revises: 
-Create Date: 2022-08-25 15:13:34.900996
+Create Date: 2022-02-23 14:33:02.851388
 
 """
 from alembic import op
@@ -11,17 +11,24 @@ import flaschengeist
 
 
 # revision identifiers, used by Alembic.
-revision = "20482a003db8"
+revision = "255b93b6beed"
 down_revision = None
 branch_labels = ("flaschengeist",)
 depends_on = None
 
 
 def upgrade():
-    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "plugin_setting",
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
+        sa.Column("plugin", sa.String(length=127), nullable=True),
+        sa.Column("name", sa.String(length=127), nullable=False),
+        sa.Column("value", sa.PickleType(protocol=4), nullable=True),
+        sa.PrimaryKeyConstraint("id", name=op.f("pk_plugin_setting")),
+    )
     op.create_table(
         "image",
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
         sa.Column("filename", sa.String(length=255), nullable=False),
         sa.Column("mimetype", sa.String(length=127), nullable=False),
         sa.Column("thumbnail", sa.String(length=255), nullable=True),
@@ -29,37 +36,27 @@ def upgrade():
         sa.PrimaryKeyConstraint("id", name=op.f("pk_image")),
     )
     op.create_table(
-        "plugin",
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("name", sa.String(length=127), nullable=False),
-        sa.Column("version", sa.String(length=30), nullable=False),
-        sa.Column("enabled", sa.Boolean(), nullable=True),
-        sa.PrimaryKeyConstraint("id", name=op.f("pk_plugin")),
+        "permission",
+        sa.Column("name", sa.String(length=30), nullable=True),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
+        sa.PrimaryKeyConstraint("id", name=op.f("pk_permission")),
+        sa.UniqueConstraint("name", name=op.f("uq_permission_name")),
     )
     op.create_table(
         "role",
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
         sa.Column("name", sa.String(length=30), nullable=True),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_role")),
         sa.UniqueConstraint("name", name=op.f("uq_role_name")),
     )
     op.create_table(
-        "permission",
-        sa.Column("name", sa.String(length=30), nullable=True),
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("plugin", flaschengeist.database.types.Serial(), nullable=True),
-        sa.ForeignKeyConstraint(["plugin"], ["plugin.id"], name=op.f("fk_permission_plugin_plugin")),
-        sa.PrimaryKeyConstraint("id", name=op.f("pk_permission")),
-        sa.UniqueConstraint("name", name=op.f("uq_permission_name")),
-    )
-    op.create_table(
-        "plugin_setting",
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("plugin", flaschengeist.database.types.Serial(), nullable=True),
-        sa.Column("name", sa.String(length=127), nullable=False),
-        sa.Column("value", sa.PickleType(), nullable=True),
-        sa.ForeignKeyConstraint(["plugin"], ["plugin.id"], name=op.f("fk_plugin_setting_plugin_plugin")),
-        sa.PrimaryKeyConstraint("id", name=op.f("pk_plugin_setting")),
+        "role_x_permission",
+        sa.Column("role_id", flaschengeist.models.Serial(), nullable=True),
+        sa.Column("permission_id", flaschengeist.models.Serial(), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["permission_id"], ["permission.id"], name=op.f("fk_role_x_permission_permission_id_permission")
+        ),
+        sa.ForeignKeyConstraint(["role_id"], ["role.id"], name=op.f("fk_role_x_permission_role_id_role")),
     )
     op.create_table(
         "user",
@@ -70,58 +67,48 @@ def upgrade():
         sa.Column("deleted", sa.Boolean(), nullable=True),
         sa.Column("birthday", sa.Date(), nullable=True),
         sa.Column("mail", sa.String(length=60), nullable=True),
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("avatar", flaschengeist.database.types.Serial(), nullable=True),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
+        sa.Column("avatar", flaschengeist.models.Serial(), nullable=True),
         sa.ForeignKeyConstraint(["avatar"], ["image.id"], name=op.f("fk_user_avatar_image")),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_user")),
         sa.UniqueConstraint("userid", name=op.f("uq_user_userid")),
     )
     op.create_table(
         "notification",
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
+        sa.Column("plugin", sa.String(length=127), nullable=False),
         sa.Column("text", sa.Text(), nullable=True),
         sa.Column("data", sa.PickleType(), nullable=True),
-        sa.Column("time", flaschengeist.database.types.UtcDateTime(), nullable=False),
-        sa.Column("user", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("plugin", flaschengeist.database.types.Serial(), nullable=False),
-        sa.ForeignKeyConstraint(["plugin"], ["plugin.id"], name=op.f("fk_notification_plugin_plugin")),
-        sa.ForeignKeyConstraint(["user"], ["user.id"], name=op.f("fk_notification_user_user")),
+        sa.Column("time", flaschengeist.models.UtcDateTime(), nullable=False),
+        sa.Column("user_id", flaschengeist.models.Serial(), nullable=False),
+        sa.ForeignKeyConstraint(["user_id"], ["user.id"], name=op.f("fk_notification_user_id_user")),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_notification")),
     )
     op.create_table(
         "password_reset",
-        sa.Column("user", flaschengeist.database.types.Serial(), nullable=False),
+        sa.Column("user", flaschengeist.models.Serial(), nullable=False),
         sa.Column("token", sa.String(length=32), nullable=True),
-        sa.Column("expires", flaschengeist.database.types.UtcDateTime(), nullable=True),
+        sa.Column("expires", flaschengeist.models.UtcDateTime(), nullable=True),
         sa.ForeignKeyConstraint(["user"], ["user.id"], name=op.f("fk_password_reset_user_user")),
         sa.PrimaryKeyConstraint("user", name=op.f("pk_password_reset")),
     )
-    op.create_table(
-        "role_x_permission",
-        sa.Column("role_id", flaschengeist.database.types.Serial(), nullable=True),
-        sa.Column("permission_id", flaschengeist.database.types.Serial(), nullable=True),
-        sa.ForeignKeyConstraint(
-            ["permission_id"], ["permission.id"], name=op.f("fk_role_x_permission_permission_id_permission")
-        ),
-        sa.ForeignKeyConstraint(["role_id"], ["role.id"], name=op.f("fk_role_x_permission_role_id_role")),
-    )
     op.create_table(
         "session",
-        sa.Column("expires", flaschengeist.database.types.UtcDateTime(), nullable=True),
+        sa.Column("expires", flaschengeist.models.UtcDateTime(), nullable=True),
         sa.Column("token", sa.String(length=32), nullable=True),
         sa.Column("lifetime", sa.Integer(), nullable=True),
-        sa.Column("browser", sa.String(length=127), nullable=True),
-        sa.Column("platform", sa.String(length=64), nullable=True),
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("user_id", flaschengeist.database.types.Serial(), nullable=True),
+        sa.Column("browser", sa.String(length=30), nullable=True),
+        sa.Column("platform", sa.String(length=30), nullable=True),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
+        sa.Column("user_id", flaschengeist.models.Serial(), nullable=True),
         sa.ForeignKeyConstraint(["user_id"], ["user.id"], name=op.f("fk_session_user_id_user")),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_session")),
         sa.UniqueConstraint("token", name=op.f("uq_session_token")),
     )
     op.create_table(
         "user_attribute",
-        sa.Column("id", flaschengeist.database.types.Serial(), nullable=False),
-        sa.Column("user", flaschengeist.database.types.Serial(), nullable=False),
+        sa.Column("id", flaschengeist.models.Serial(), nullable=False),
+        sa.Column("user", flaschengeist.models.Serial(), nullable=False),
         sa.Column("name", sa.String(length=30), nullable=True),
         sa.Column("value", sa.PickleType(), nullable=True),
         sa.ForeignKeyConstraint(["user"], ["user.id"], name=op.f("fk_user_attribute_user_user")),
@@ -129,8 +116,8 @@ def upgrade():
     )
     op.create_table(
         "user_x_role",
-        sa.Column("user_id", flaschengeist.database.types.Serial(), nullable=True),
-        sa.Column("role_id", flaschengeist.database.types.Serial(), nullable=True),
+        sa.Column("user_id", flaschengeist.models.Serial(), nullable=True),
+        sa.Column("role_id", flaschengeist.models.Serial(), nullable=True),
         sa.ForeignKeyConstraint(["role_id"], ["role.id"], name=op.f("fk_user_x_role_role_id_role")),
         sa.ForeignKeyConstraint(["user_id"], ["user.id"], name=op.f("fk_user_x_role_user_id_user")),
     )
@@ -142,13 +129,11 @@ def downgrade():
     op.drop_table("user_x_role")
     op.drop_table("user_attribute")
     op.drop_table("session")
-    op.drop_table("role_x_permission")
     op.drop_table("password_reset")
     op.drop_table("notification")
     op.drop_table("user")
-    op.drop_table("plugin_setting")
-    op.drop_table("permission")
+    op.drop_table("role_x_permission")
     op.drop_table("role")
-    op.drop_table("plugin")
+    op.drop_table("permission")
     op.drop_table("image")
     # ### end Alembic commands ###

flaschengeist/app.py

@@ -4,7 +4,7 @@ from flask import Flask
 from flask_cors import CORS
 from datetime import datetime, date
 from flask.json import JSONEncoder, jsonify
-from sqlalchemy.exc import OperationalError
+from importlib.metadata import entry_points
 from werkzeug.exceptions import HTTPException
 
 from flaschengeist import logger
@@ -37,16 +37,19 @@ class CustomJSONEncoder(JSONEncoder):
 @Hook("plugins.loaded")
 def load_plugins(app: Flask):
     app.config["FG_PLUGINS"] = {}
+    all_plugins = entry_points(group="flaschengeist.plugins")
 
     for plugin in pluginController.get_enabled_plugins():
         logger.debug(f"Searching for enabled plugin {plugin.name}")
+        entry_point = all_plugins.select(name=plugin.name)
+        if not entry_point:
+            logger.error(
+                f"Plugin {plugin.name} was enabled, but could not be found.",
+                exc_info=True,
+            )
+            continue
         try:
-            # Load class
-            cls = plugin.entry_point.load()
-            plugin = cls.query.get(plugin.id) if plugin.id is not None else plugin
-            # Custom loading tasks
-            plugin.load()
-            # Register blueprint
+            loaded = entry_point[0].load()(entry_point[0])
             if hasattr(plugin, "blueprint") and plugin.blueprint is not None:
                 app.register_blueprint(plugin.blueprint)
         except:
@@ -56,7 +59,8 @@ def load_plugins(app: Flask):
             )
             continue
         logger.info(f"Loaded plugin: {plugin.name}")
-        app.config["FG_PLUGINS"][plugin.name] = plugin
+        app.config["FG_PLUGINS"][plugin.name] = loaded
+
 
 def create_app(test_config=None, cli=False):
     app = Flask("flaschengeist")
@@ -75,7 +79,7 @@ def create_app(test_config=None, cli=False):
     def __get_state():
         from . import __version__ as version
 
-        return jsonify({"plugins": pluginController.get_loaded_plugins(), "version": version})
+        return jsonify({"plugins": app.config["FG_PLUGINS"], "version": version})
 
     @app.errorhandler(Exception)
     def handle_exception(e):

flaschengeist/cli/install_cmd.py

@@ -3,7 +3,8 @@ from click.decorators import pass_context
 from flask.cli import with_appcontext
 from flask_migrate import upgrade
 
-from flaschengeist.controller import pluginController
+from flaschengeist.alembic import alembic_migrations_path
+from flaschengeist.cli.plugin_cmd import install_plugin_command
 from flaschengeist.utils.hook import Hook
 
 
@@ -11,13 +12,9 @@ from flaschengeist.utils.hook import Hook
 @with_appcontext
 @pass_context
 @Hook("plugins.installed")
-def install(ctx: click.Context):
-    plugins = pluginController.get_enabled_plugins()
-
+def install(ctx):
     # Install database
-    upgrade(revision="flaschengeist@head")
+    upgrade(alembic_migrations_path, revision="heads")
 
     # Install plugins
-    for plugin in plugins:
-        plugin = pluginController.install_plugin(plugin.name)
-        pluginController.enable_plugin(plugin.id)
+    install_plugin_command(ctx, [], True)

flaschengeist/cli/plugin_cmd.py

@@ -1,13 +1,12 @@
-import traceback
 import click
 from click.decorators import pass_context
 from flask import current_app
 from flask.cli import with_appcontext
 from importlib.metadata import EntryPoint, entry_points
 
-from flaschengeist import logger
-from flaschengeist.controller import pluginController
-from werkzeug.exceptions import NotFound
+from flaschengeist.database import db
+from flaschengeist.config import config
+from flaschengeist.models import Permission
 
 
 @click.group()
@@ -15,34 +14,33 @@ def plugin():
     pass
 
 
-@plugin.command()
-@click.argument("plugin", nargs=-1, required=True, type=str)
-@with_appcontext
-@pass_context
-def enable(ctx, plugin):
-    """Enable one or more plugins"""
-    for name in plugin:
-        click.echo(f"Enabling {name}{'.'*(20-len(name))}", nl=False)
-        try:
-            pluginController.enable_plugin(name)
-            click.secho(" ok", fg="green")
-        except NotFound:
-            click.secho(" not installed / not found", fg="red")
+def install_plugin_command(ctx, plugin, all):
+    """Install one or more plugins"""
+    if not all and len(plugin) == 0:
+        ctx.fail("At least one plugin must be specified, or use `--all` flag.")
 
-
-@plugin.command()
-@click.argument("plugin", nargs=-1, required=True, type=str)
-@with_appcontext
-@pass_context
-def disable(ctx, plugin):
-    """Disable one or more plugins"""
-    for name in plugin:
-        click.echo(f"Disabling {name}{'.'*(20-len(name))}", nl=False)
+    if all:
+        plugins = current_app.config["FG_PLUGINS"]
+    else:
         try:
-            pluginController.disable_plugin(name)
-            click.secho(" ok", fg="green")
-        except NotFound:
-            click.secho(" not installed / not found", fg="red")
+            plugins = {plugin_name: current_app.config["FG_PLUGINS"][plugin_name] for plugin_name in plugin}
+        except KeyError as e:
+            ctx.fail(f"Invalid plugin name, could not find >{e.args[0]}<")
+
+    for name, plugin in plugins.items():
+        click.echo(f"Installing {name}{'.'*(20-len(name))}", nl=False)
+        # Install permissions
+        if plugin.permissions:
+            cur_perm = set(x.name for x in Permission.query.filter(Permission.name.in_(plugin.permissions)).all())
+            all_perm = set(plugin.permissions)
+
+            add = all_perm - cur_perm
+            if add:
+                db.session.bulk_save_objects([Permission(name=x) for x in all_perm])
+                db.session.commit()
+        # Custom installation steps
+        plugin.install()
+        click.secho(" ok", fg="green")
 
 
 @plugin.command()
@@ -50,62 +48,42 @@ def disable(ctx, plugin):
 @click.option("--all", help="Install all enabled plugins", is_flag=True)
 @with_appcontext
 @pass_context
-def install(ctx: click.Context, plugin, all):
+def install(ctx, plugin, all):
     """Install one or more plugins"""
-    all_plugins = entry_points(group="flaschengeist.plugins")
-
-    if all:
-        plugins = [ep.name for ep in all_plugins]
-    elif len(plugin) > 0:
-        plugins = plugin
-        for name in plugin:
-            if not all_plugins.select(name=name):
-                ctx.fail(f"Invalid plugin name, could not find >{name}<")
-    else:
-        ctx.fail("At least one plugin must be specified, or use `--all` flag.")
-
-    for name in plugins:
-        click.echo(f"Installing {name}{'.'*(20-len(name))}", nl=False)
-        try:
-            pluginController.install_plugin(name)
-        except Exception as e:
-            click.secho(" failed", fg="red")
-            if logger.getEffectiveLevel() > 10:
-                ctx.fail(f"[{e.__class__.__name__}] {e}")
-            else:
-                ctx.fail(traceback.format_exc())
-        else:
-            click.secho(" ok", fg="green")
+    return install_plugin_command(ctx, plugin, all)
 
 
 @plugin.command()
-@click.argument("plugin", nargs=-1, required=True, type=str)
+@click.argument("plugin", nargs=-1, type=str)
 @with_appcontext
 @pass_context
 def uninstall(ctx: click.Context, plugin):
     """Uninstall one or more plugins"""
 
-    plugins = {plg.name: plg for plg in pluginController.get_installed_plugins() if plg.name in plugin}
+    if len(plugin) == 0:
+        ctx.fail("At least one plugin must be specified")
+
     try:
-        for name in plugin:
-            pluginController.disable_plugin(plugins[name])
-            if (
-                click.prompt(
-                    "You are going to uninstall:\n\n"
-                    f"\t{', '.join([plugin_name for plugin_name in plugins.keys()])}\n\n"
-                    "Are you sure?",
-                    default="n",
-                    show_choices=True,
-                    type=click.Choice(["y", "N"], False),
-                ).lower()
-                != "y"
-            ):
-                ctx.exit()
-            click.echo(f"Uninstalling {name}{'.'*(20-len(name))}", nl=False)
-            pluginController.uninstall_plugin(plugins[name])
-            click.secho(" ok", fg="green")
-    except KeyError:
-        ctx.fail(f"Invalid plugin ID, could not find >{name}<")
+        plugins = {plugin_name: current_app.config["FG_PLUGINS"][plugin_name] for plugin_name in plugin}
+    except KeyError as e:
+        ctx.fail(f"Invalid plugin ID, could not find >{e.args[0]}<")
+
+    if (
+        click.prompt(
+            "You are going to uninstall:\n\n"
+            f"\t{', '.join([plugin_name for plugin_name in plugins.keys()])}\n\n"
+            "Are you sure?",
+            default="n",
+            show_choices=True,
+            type=click.Choice(["y", "N"], False),
+        ).lower()
+        != "y"
+    ):
+        ctx.exit()
+    for name, plugin in plugins.items():
+        click.echo(f"Uninstalling {name}{'.'*(20-len(name))}", nl=False)
+        plugin.uninstall()
+        click.secho(" ok", fg="green")
 
 
 @plugin.command()
@@ -119,27 +97,21 @@ def ls(enabled, no_header):
         return p.version
 
     plugins = entry_points(group="flaschengeist.plugins")
-    installed_plugins = {plg.name: plg for plg in pluginController.get_installed_plugins()}
+    enabled_plugins = [key for key, value in config.items() if "enabled" in value and value["enabled"]] + [
+        config["FLASCHENGEIST"]["auth"]
+    ]
     loaded_plugins = current_app.config["FG_PLUGINS"].keys()
 
     if not no_header:
-        print(f"{' '*13}{'name': <20}|   version   | {' ' * 8} state")
-        print("-" * 63)
+        print(f"{' '*13}{'name': <20}|{'version': >10}")
+        print("-" * 46)
     for plugin in plugins:
-        is_installed = plugin.name in installed_plugins.keys()
-        is_enabled = is_installed and installed_plugins[plugin.name].enabled
-        if enabled and is_enabled:
+        if enabled and plugin.name not in enabled_plugins:
             continue
-        print(f"{plugin.name: <33}|{plugin_version(plugin): >12} |  ", end="")
-        if is_enabled:
-            if plugin.name in loaded_plugins:
-                print(click.style("      enabled", fg="green"))
-            else:
-                print(click.style("(failed to load)", fg="red"))
-        elif is_installed:
-            print(click.style("     disabled", fg="yellow"))
-        else:
-            print("not installed")
-    for name, plugin in installed_plugins.items():
-        if plugin.enabled and name not in loaded_plugins:
-            print(f"{name: <33}|{'': >12} |" f"{click.style(' failed to load', fg='red')}")
+        print(
+            f"{plugin.name: <33}|{plugin_version(plugin): >12}"
+            f"{click.style(' (enabled)', fg='green') if plugin.name in enabled_plugins else ' (disabled)'}"
+        )
+
+    for plugin in [value for value in enabled_plugins if value not in loaded_plugins]:
+        print(f"{plugin: <33}|{' '*12}" f"{click.style(' (not found)', fg='red')}")

flaschengeist/controller/pluginController.py

@@ -3,59 +3,84 @@
 Used by plugins for setting and notification functionality.
 """
 
+import sqlalchemy
+
 from typing import Union
 from flask import current_app
-from werkzeug.exceptions import NotFound, BadRequest
+from werkzeug.exceptions import NotFound
 from sqlalchemy.exc import OperationalError
-from flask_migrate import upgrade as database_upgrade
 from importlib.metadata import entry_points
 
-from flaschengeist import version as flaschengeist_version
-
 from .. import logger
 from ..database import db
 from ..utils.hook import Hook
-from ..plugins import Plugin, AuthPlugin
-from ..models import Notification
+from ..models import Plugin, PluginSetting, Notification
 
 
-__required_plugins = ["users", "roles", "scheduler", "auth"]
-
-
-def get_authentication_provider():
-    return [plugin for plugin in get_loaded_plugins().values() if isinstance(plugin, AuthPlugin)]
-
-
-def get_loaded_plugins(plugin_name: str = None):
-    """Get loaded plugin(s)"""
-    plugins = current_app.config["FG_PLUGINS"]
-    if plugin_name is not None:
-        plugins = [plugins[plugin_name]]
-    return {name: db.session.merge(plugins[name], load=False) for name in plugins}
-
-
-def get_installed_plugins() -> list[Plugin]:
-    """Get all installed plugins"""
-    return Plugin.query.all()
-
-
-def get_enabled_plugins() -> list[Plugin]:
-    """Get all installed and enabled plugins"""
+def get_enabled_plugins():
     try:
         enabled_plugins = Plugin.query.filter(Plugin.enabled == True).all()
     except OperationalError as e:
+
+        class PluginStub:
+            def __init__(self, name) -> None:
+                self.name = name
+                self.version = "?"
+
         logger.error("Could not connect to database or database not initialized! No plugins enabled!")
         logger.debug("Can not query enabled plugins", exc_info=True)
-        # Fake load required plugins so the database can at least be installed
         enabled_plugins = [
-            entry_points(group="flaschengeist.plugins", name=name)[0].load()(
-                name=name, enabled=True, installed_version=flaschengeist_version
-            )
-            for name in __required_plugins
+            PluginStub("auth"),
+            PluginStub("roles"),
+            PluginStub("users"),
+            PluginStub("scheduler"),
         ]
     return enabled_plugins
 
 
+def get_setting(plugin_id: str, name: str, **kwargs):
+    """Get plugin setting from database
+
+    Args:
+        plugin_id: ID of the plugin
+        name: string identifying the setting
+        default: Default value
+    Returns:
+        Value stored in database (native python)
+    Raises:
+        `KeyError` if no such setting exists in the database
+    """
+    try:
+        setting = PluginSetting.query.filter(PluginSetting.plugin == plugin_id).filter(PluginSetting.name == name).one()
+        return setting.value
+    except sqlalchemy.orm.exc.NoResultFound:
+        if "default" in kwargs:
+            return kwargs["default"]
+        else:
+            raise KeyError
+
+
+def set_setting(plugin_id: str, name: str, value):
+    """Save setting in database
+
+    Args:
+        plugin_id: ID of the plugin
+        name: String identifying the setting
+        value: Value to be stored
+    """
+    setting = (
+        PluginSetting.query.filter(PluginSetting.plugin == plugin_id).filter(PluginSetting.name == name).one_or_none()
+    )
+    if setting is not None:
+        if value is None:
+            db.session.delete(setting)
+        else:
+            setting.value = value
+    else:
+        db.session.add(PluginSetting(plugin=plugin_id, name=name, value=value))
+    db.session.commit()
+
+
 def notify(plugin_id: str, user, text: str, data=None):
     """Create a new notification for an user
 
@@ -83,72 +108,55 @@ def install_plugin(plugin_name: str):
     if not entry_point:
         raise NotFound
 
-    cls = entry_point[0].load()
-    plugin: Plugin = cls.query.filter(Plugin.name == plugin_name).one_or_none()
-    if plugin is None:
-        plugin = cls(name=plugin_name, installed_version=entry_point[0].dist.version)
-        db.session.add(plugin)
+    plugin = entry_point[0].load()(entry_point[0])
+    entity = Plugin(name=plugin.name, version=plugin.version)
+    db.session.add(entity)
     db.session.commit()
-    # Custom installation steps
-    plugin.install()
-    # Check migrations
-    directory = entry_point[0].dist.locate_file("")
-    for loc in entry_point[0].module.split(".") + ["migrations"]:
-        directory /= loc
-    if directory.exists():
-        database_upgrade(revision=f"{plugin_name}@head")
-
-    return plugin
+    return entity
 
 
 @Hook("plugin.uninstalled")
-def uninstall_plugin(plugin_id: Union[str, int, Plugin]):
+def uninstall_plugin(plugin_id: Union[str, int]):
     plugin = disable_plugin(plugin_id)
     logger.debug(f"Uninstall plugin {plugin.name}")
-    plugin.uninstall()
+
+    entity = current_app.config["FG_PLUGINS"][plugin.name]
+    entity.uninstall()
+    del current_app.config["FG_PLUGINS"][plugin.name]
     db.session.delete(plugin)
     db.session.commit()
 
 
 @Hook("plugins.enabled")
-def enable_plugin(plugin_id: Union[str, int]) -> Plugin:
+def enable_plugin(plugin_id: Union[str, int]):
     logger.debug(f"Enabling plugin {plugin_id}")
-    plugin = Plugin.query
+    plugin: Plugin = Plugin.query
     if isinstance(plugin_id, str):
         plugin = plugin.filter(Plugin.name == plugin_id).one_or_none()
-    elif isinstance(plugin_id, int):
-        plugin = plugin.get(plugin_id)
+        if plugin is None:
+            logger.debug("Plugin not installed, trying to install")
+            plugin = install_plugin(plugin_id)
     else:
-        raise TypeError
-    if plugin is None:
-        raise NotFound
+        plugin = plugin.get(plugin_id)
+        if plugin is None:
+            raise NotFound
     plugin.enabled = True
     db.session.commit()
-    plugin = plugin.entry_point.load().query.get(plugin.id)
-    current_app.config["FG_PLUGINS"][plugin.name] = plugin
+
     return plugin
 
 
 @Hook("plugins.disabled")
-def disable_plugin(plugin_id: Union[str, int, Plugin]):
+def disable_plugin(plugin_id: Union[str, int]):
     logger.debug(f"Disabling plugin {plugin_id}")
     plugin: Plugin = Plugin.query
     if isinstance(plugin_id, str):
         plugin = plugin.filter(Plugin.name == plugin_id).one_or_none()
-    elif isinstance(plugin_id, int):
-        plugin = plugin.get(plugin_id)
-    elif isinstance(plugin_id, Plugin):
-        plugin = plugin_id
     else:
-        raise TypeError
+        plugin = plugin.get(plugin_id)
     if plugin is None:
         raise NotFound
-    if plugin.name in __required_plugins:
-        raise BadRequest
     plugin.enabled = False
     db.session.commit()
 
-    if plugin.name in current_app.config["FG_PLUGINS"].keys():
-        del current_app.config["FG_PLUGINS"][plugin.name]
-
     return plugin

flaschengeist/controller/sessionController.py

@@ -13,15 +13,15 @@ lifetime = 1800
 
 def __get_user_agent_platform(ua: str):
     if "Win" in ua:
-        return "windows"
+        return "Windows"
     if "Mac" in ua:
-        return "macintosh"
+        return "Macintosh"
     if "Linux" in ua:
-        return "linux"
+        return "Linux"
     if "Android" in ua:
-        return "android"
+        return "Android"
     if "like Mac" in ua:
-        return "ios"
+        return "iOS"
     return "unknown"
 
 
@@ -84,12 +84,12 @@ def validate_token(token, request_headers, permission):
     raise Unauthorized
 
 
-def create(user, request_headers=None) -> Session:
+def create(user, user_agent=None) -> Session:
     """Create a Session
 
     Args:
         user: For which User is to create a Session
-        request_headers: Headers to validate user agent of browser
+        user_agent: User agent to identify session
 
     Returns:
             Session: A created Token for User
@@ -100,10 +100,8 @@ def create(user, request_headers=None) -> Session:
         token=token_str,
         user_=user,
         lifetime=lifetime,
-        platform=request_headers.get("Sec-CH-UA-Platform", None)
-        or __get_user_agent_platform(request_headers.get("User-Agent", "")),
-        browser=request_headers.get("Sec-CH-UA", None)
-        or __get_user_agent_browser(request_headers.get("User-Agent", "")),
+        browser=user_agent.browser,
+        platform=user_agent.platform,
     )
     session.refresh()
     db.session.add(session)

flaschengeist/controller/userController.py

@@ -3,7 +3,7 @@ import secrets
 
 from io import BytesIO
 from sqlalchemy import exc
-from sqlalchemy_utils import merge_references
+from flask import current_app
 from datetime import datetime, timedelta, timezone
 from flask.helpers import send_file
 from werkzeug.exceptions import NotFound, BadRequest, Forbidden
@@ -15,8 +15,8 @@ from ..models import Notification, User, Role
 from ..models.user import _PasswordReset
 from ..utils.hook import Hook
 from ..utils.datetime import from_iso_format
-from ..controller import imageController, messageController, pluginController, sessionController
-from ..plugins import AuthPlugin
+from ..utils.foreign_keys import merge_references
+from ..controller import imageController, messageController, sessionController
 
 
 def __active_users():
@@ -41,33 +41,17 @@ def _generate_password_reset(user):
     return reset
 
 
-def get_provider(userid: str):
-    return [p for p in pluginController.get_authentication_provider() if p.user_exists(userid)][0]
-
-
-@Hook
-def update_user(user: User, backend: AuthPlugin):
-    """Update user data from backend
-
-    This is seperate function to provide a hook"""
-    backend.update_user(user)
-    if not user.display_name:
-        user.display_name = "{} {}.".format(user.firstname, user.lastname[0])
-    db.session.commit()
-
-
 def login_user(username, password):
     logger.info("login user {{ {} }}".format(username))
-    for provider in pluginController.get_authentication_provider():
-        uid = provider.login(username, password)
-        if isinstance(uid, str):
-            user = get_user(uid)
-            if not user:
-                logger.debug("User not found in Database.")
-                user = User(userid=uid)
-                db.session.add(user)
-            update_user(user, provider)
-            return user
+
+    user = find_user(username)
+    if not user:
+        logger.debug("User not found in Database.")
+        user = User(userid=username)
+        db.session.add(user)
+    if current_app.config["FG_AUTH_BACKEND"].login(user, password):
+        update_user(user)
+        return user
     return None
 
 
@@ -100,6 +84,14 @@ def reset_password(token: str, password: str):
     db.session.commit()
 
 
+@Hook
+def update_user(user):
+    current_app.config["FG_AUTH_BACKEND"].update_user(user)
+    if not user.display_name:
+        user.display_name = "{} {}.".format(user.firstname, user.lastname[0])
+    db.session.commit()
+
+
 def set_roles(user: User, roles: list[str], create=False):
     """Set roles of user
 
@@ -123,7 +115,7 @@ def set_roles(user: User, roles: list[str], create=False):
     user.roles_ = fetched
 
 
-def modify_user(user: User, password: str, new_password: str = None):
+def modify_user(user, password, new_password=None):
     """Modify given user on the backend
 
     Args:
@@ -135,8 +127,7 @@ def modify_user(user: User, password: str, new_password: str = None):
         NotImplemented: If backend is not capable of this operation
         BadRequest: Password is wrong or other logic issues
     """
-    provider = get_provider(user.userid)
-    provider.modify_user(user, password, new_password)
+    current_app.config["FG_AUTH_BACKEND"].modify_user(user, password, new_password)
 
     if new_password:
         logger.debug(f"Password changed for user {user.userid}")
@@ -174,13 +165,37 @@ def get_user(uid, deleted=False) -> User:
     return user
 
 
+def find_user(uid_mail):
+    """Finding an user by userid or mail in database or auth-backend
+    Args:
+        uid_mail: userid and or mail to search for
+    Returns:
+        User if found or None
+    """
+    mail = uid_mail.split("@")
+    mail = len(mail) == 2 and len(mail[0]) > 0 and len(mail[1]) > 0
+
+    query = User.userid == uid_mail
+    if mail:
+        query |= User.mail == uid_mail
+    user = User.query.filter(query).one_or_none()
+    if user:
+        update_user(user)
+    else:
+        user = current_app.config["FG_AUTH_BACKEND"].find_user(uid_mail, uid_mail if mail else None)
+        if user:
+            if not user.display_name:
+                user.display_name = "{} {}.".format(user.firstname, user.lastname[0])
+            db.session.add(user)
+            db.session.commit()
+    return user
+
+
 @Hook
 def delete_user(user: User):
     """Delete given user"""
     # First let the backend delete the user, as this might fail
-    provider = get_provider(user.userid)
-    provider.delete_user(user)
-
+    current_app.config["FG_AUTH_BACKEND"].delete_user(user)
     # Clear all easy relationships
     user.avatar_ = None
     user._attributes.clear()
@@ -232,14 +247,10 @@ def register(data, passwd=None):
     set_roles(user, roles)
 
     password = passwd if passwd else secrets.token_urlsafe(16)
+    current_app.config["FG_AUTH_BACKEND"].create_user(user, password)
     try:
-        provider = [p for p in pluginController.get_authentication_provider() if p.can_register()][0]
-        provider.create_user(user, password)
         db.session.add(user)
         db.session.commit()
-    except IndexError as e:
-        logger.error("No authentication backend, allowing registering new users, found.")
-        raise e
     except exc.IntegrityError:
         raise BadRequest("userid already in use")
 
@@ -254,7 +265,7 @@ def register(data, passwd=None):
         )
         messageController.send_message(messageController.Message(user, text, subject))
 
-    provider.update_user(user)
+    find_user(user.userid)
 
     return user
 
@@ -263,20 +274,19 @@ def load_avatar(user: User):
     if user.avatar_ is not None:
         return imageController.send_image(image=user.avatar_)
     else:
-        provider = get_provider(user.userid)
-        avatar = provider.get_avatar(user)
+        avatar = current_app.config["FG_AUTH_BACKEND"].get_avatar(user)
         if len(avatar.binary) > 0:
             return send_file(BytesIO(avatar.binary), avatar.mimetype)
     raise NotFound
 
 
 def save_avatar(user, file):
-    get_provider(user.userid).set_avatar(user, file)
+    current_app.config["FG_AUTH_BACKEND"].set_avatar(user, file)
     db.session.commit()
 
 
 def delete_avatar(user):
-    get_provider(user.userid).delete_avatar(user)
+    current_app.config["FG_AUTH_BACKEND"].delete_avatar(user)
     db.session.commit()
 
 

flaschengeist/database/__init__.py

@@ -39,7 +39,11 @@ def configure_alembic(config: Config):
     migrations = [config.get_main_option("script_location") + "/migrations"]
 
     # Gather all migration paths
-    for entry_point in entry_points(group="flaschengeist.plugins"):
+    all_plugins = entry_points(group="flaschengeist.plugins")
+    for plugin in pluginController.get_enabled_plugins():
+        entry_point = all_plugins.select(name=plugin.name)
+        if not entry_point:
+            continue
         try:
             directory = entry_point.dist.locate_file("")
             for loc in entry_point.module.split(".") + ["migrations"]:
@@ -48,7 +52,7 @@ def configure_alembic(config: Config):
                 logger.debug(f"Adding migration version path {directory}")
                 migrations.append(str(directory.resolve()))
         except:
-            logger.warning(f"Could not load migrations of plugin {entry_point.name} for database migration.")
+            logger.warning(f"Could not load migrations of plugin {plugin.name} for database migration.")
             logger.debug("Plugin loading failed", exc_info=True)
 
     # write back seperator (we changed it if neither seperator nor locations were specified)

flaschengeist/database/types.py

@@ -1,4 +1,4 @@
-from importlib import import_module
+import sys
 import datetime
 
 from sqlalchemy import BigInteger, util
@@ -12,11 +12,12 @@ class ModelSerializeMixin:
     """
 
     def __is_optional(self, param):
+        if sys.version_info < (3, 8):
+            return False
+
         import typing
 
-        module = import_module("flaschengeist.models").__dict__
-
-        hint = typing.get_type_hints(self.__class__, globalns=module)[param]
+        hint = typing.get_type_hints(self.__class__)[param]
         if (
             typing.get_origin(hint) is typing.Union
             and len(typing.get_args(hint)) == 2

flaschengeist/models/plugin.py

@@ -1,72 +1,26 @@
 from __future__ import annotations  # TODO: Remove if python requirement is >= 3.12 (? PEP 563 is defered)
 
 from typing import Any
-from sqlalchemy.orm.collections import attribute_mapped_collection
 
 from ..database import db
 from ..database.types import Serial
 
 
+class Plugin(db.Model):
+    __tablename__ = "plugin"
+    id: int = db.Column("id", Serial, primary_key=True)
+    name: str = db.Column(db.String(127), nullable=False)
+    version: str = db.Column(db.String(30), nullable=False)
+    """The latest installed version"""
+    enabled: bool = db.Column(db.Boolean, default=False)
+
+    settings_ = db.relationship("PluginSetting", cascade="all, delete")
+    permissions_ = db.relationship("Permission", cascade="all, delete")
+
+
 class PluginSetting(db.Model):
     __tablename__ = "plugin_setting"
     id = db.Column("id", Serial, primary_key=True)
     plugin_id: int = db.Column("plugin", Serial, db.ForeignKey("plugin.id"))
     name: str = db.Column(db.String(127), nullable=False)
     value: Any = db.Column(db.PickleType(protocol=4))
-
-
-class BasePlugin(db.Model):
-    __tablename__ = "plugin"
-    id: int = db.Column("id", Serial, primary_key=True)
-    name: str = db.Column(db.String(127), nullable=False)
-    """Name of the plugin, loaded from distribution"""
-    installed_version: str = db.Column("version", db.String(30), nullable=False)
-    """The latest installed version"""
-    enabled: bool = db.Column(db.Boolean, default=False)
-    """Enabled state of the plugin"""
-    permissions: list = db.relationship(
-        "Permission", cascade="all, delete, delete-orphan", back_populates="plugin_", lazy="select"
-    )
-    """Optional list of custom permissions used by the plugin
-    
-    A good style is to name the permissions with a prefix related to the plugin name,
-    to prevent clashes with other plugins. E. g. instead of *delete* use *plugin_delete*.
-    """
-
-    __settings: dict[str, "PluginSetting"] = db.relationship(
-        "PluginSetting",
-        collection_class=attribute_mapped_collection("name"),
-        cascade="all, delete, delete-orphan",
-        lazy="select",
-    )
-
-    def get_setting(self, name: str, **kwargs):
-        """Get plugin setting
-
-        Args:
-            name: string identifying the setting
-            default: Default value
-        Returns:
-            Value stored in database (native python)
-        Raises:
-            `KeyError` if no such setting exists in the database
-        """
-        try:
-            return self.__settings[name].value
-        except KeyError as e:
-            if "default" in kwargs:
-                return kwargs["default"]
-            raise e
-
-    def set_setting(self, name: str, value):
-        """Save setting in database
-
-        Args:
-            name: String identifying the setting
-            value: Value to be stored
-        """
-        if value is None and name in self.__settings.keys():
-            del self.__settings[name]
-        else:
-            setting = self.__settings.setdefault(name, PluginSetting(plugin_id=self.id, name=name, value=None))
-            setting.value = value

flaschengeist/models/user.py

@@ -24,9 +24,8 @@ class Permission(db.Model, ModelSerializeMixin):
     __tablename__ = "permission"
     name: str = db.Column(db.String(30), unique=True)
 
-    id_ = db.Column("id", Serial, primary_key=True)
-    plugin_id_: int = db.Column("plugin", Serial, db.ForeignKey("plugin.id"))
-    plugin_ = db.relationship("Plugin", lazy="select", back_populates="permissions", enable_typechecks=False)
+    _id = db.Column("id", Serial, primary_key=True)
+    _plugin_id: int = db.Column("plugin", Serial, db.ForeignKey("plugin.id"))
 
 
 class Role(db.Model, ModelSerializeMixin):
@@ -65,7 +64,9 @@ class User(db.Model, ModelSerializeMixin):
     # Protected stuff for backend use only
     id_ = db.Column("id", Serial, primary_key=True)
     roles_: list[Role] = db.relationship("Role", secondary=association_table, cascade="save-update, merge")
-    sessions_: list[Session] = db.relationship("Session", back_populates="user_", cascade="all, delete, delete-orphan")
+    sessions_: list[Session] = db.relationship(
+        "Session", back_populates="user_", cascade="all, delete, delete-orphan"
+    )
     avatar_: Optional[Image] = db.relationship("Image", cascade="all, delete, delete-orphan", single_parent=True)
     reset_requests_: list["_PasswordReset"] = db.relationship("_PasswordReset", cascade="all, delete, delete-orphan")
 

flaschengeist/plugins/__init__.py

@@ -4,13 +4,13 @@
 
 """
 
-from typing import Union
-from importlib.metadata import entry_points
-from werkzeug.exceptions import NotFound
+from typing import Optional
+from importlib.metadata import Distribution, EntryPoint
+from werkzeug.exceptions import MethodNotAllowed, NotFound
 from werkzeug.datastructures import FileStorage
 
-from flaschengeist.models.plugin import BasePlugin
-from flaschengeist.models.user import _Avatar, Permission
+from flaschengeist.models import User
+from flaschengeist.models.user import _Avatar
 from flaschengeist.utils.hook import HookBefore, HookAfter
 
 __all__ = [
@@ -20,7 +20,7 @@ __all__ = [
     "before_role_updated",
     "before_update_user",
     "after_role_updated",
-    "Plugin",
+    "BasePlugin",
     "AuthPlugin",
 ]
 
@@ -71,7 +71,7 @@ Passed args:
 """
 
 
-class Plugin(BasePlugin):
+class BasePlugin:
     """Base class for all Plugins
 
     All plugins must derived from this class.
@@ -82,30 +82,47 @@ class Plugin(BasePlugin):
         - *models*: Your models, used for API export
     """
 
+    name: str
+    """Name of the plugin, loaded from EntryPoint"""
+
+    version: str
+    """Version of the plugin, loaded from Distribution"""
+
+    dist: Distribution
+    """Distribution of this plugin"""
+
     blueprint = None
     """Optional `flask.blueprint` if the plugin uses custom routes"""
 
+    permissions: list[str] = []
+    """Optional list of custom permissions used by the plugin
+    
+    A good style is to name the permissions with a prefix related to the plugin name,
+    to prevent clashes with other plugins. E. g. instead of *delete* use *plugin_delete*.
+    """
+
     models = None
     """Optional module containing the SQLAlchemy models used by the plugin"""
 
-    @property
-    def version(self) -> str:
-        """Version of the plugin, loaded from Distribution"""
-        return self.dist.version
+    migrations: Optional[tuple[str, str]] = None
+    """Optional identifiers of the migration versions
+    
+    If custom database tables are used migrations must be provided and the
+    head and removal versions had to be defined, e.g.
+    
+    ```
+    migrations = ("head_hash", "removal_hash")
+    ```
+    """
 
-    @property
-    def dist(self):
-        """Distribution of this plugin"""
-        return self.entry_point.dist
-
-    @property
-    def entry_point(self):
-        ep = entry_points(group="flaschengeist.plugins", name=self.name)
-        return ep[0]
-
-    def load(self):
-        """__init__ like function that is called when the plugin is initially loaded"""
-        pass
+    def __init__(self, entry_point: EntryPoint):
+        """Constructor called by create_app
+        Args:
+            entry_point: EntryPoint from which this plugin was loaded
+        """
+        self.version = entry_point.dist.version
+        self.name = entry_point.name
+        self.dist = entry_point.dist
 
     def install(self):
         """Installation routine
@@ -128,6 +145,40 @@ class Plugin(BasePlugin):
         """
         pass
 
+    @property
+    def installed_version(self):
+        """Installed version of the plugin"""
+        from ..controller import pluginController
+
+        self.__installed_version = pluginController.get_installed_version(self.name)
+        return self.__installed_version
+
+    def get_setting(self, name: str, **kwargs):
+        """Get plugin setting from database
+
+        Args:
+            name: string identifying the setting
+            default: Default value
+        Returns:
+            Value stored in database (native python)
+        Raises:
+            `KeyError` if no such setting exists in the database
+        """
+        from ..controller import pluginController
+
+        return pluginController.get_setting(self.name, name, **kwargs)
+
+    def set_setting(self, name: str, value):
+        """Save setting in database
+
+        Args:
+            name: String identifying the setting
+            value: Value to be stored
+        """
+        from ..controller import pluginController
+
+        return pluginController.set_setting(self.name, name, value)
+
     def notify(self, user, text: str, data=None):
         """Create a new notification for an user
 
@@ -152,53 +203,40 @@ class Plugin(BasePlugin):
         """
         return {"version": self.version, "permissions": self.permissions}
 
-    def install_permissions(self, permissions: list[str]):
-        """Helper for installing a list of strings as permissions
 
-        Args:
-            permissions: List of permissions to install
-        """
-        cur_perm = set(x.name for x in self.permissions)
-        all_perm = set(permissions)
-
-        new_perms = all_perm - cur_perm
-        self.permissions = list(filter(lambda x: x.name in permissions, self.permissions)) + [
-            Permission(name=x, plugin_=self) for x in new_perms
-        ]
-
-
-class AuthPlugin(Plugin):
+class AuthPlugin(BasePlugin):
     """Base class for all authentification plugins
 
-    See also `Plugin`
+    See also `BasePlugin`
     """
 
-    def login(self, login_name, password) -> Union[bool, str]:
+    def login(self, user, pw):
         """Login routine, MUST BE IMPLEMENTED!
 
         Args:
-            login_name: The name the user entered
-            password: The password the user used to log in
+            user: User class containing at least the uid
+            pw: given password
         Returns:
-            Must return False if not found or invalid credentials, otherwise the UID is returned
+            Must return False if not found or invalid credentials, True if success
         """
         raise NotImplemented
 
-    def update_user(self, user: "User"):
+    def update_user(self, user):
         """If backend is using external data, then update this user instance with external data
         Args:
             user: User object
         """
         pass
 
-    def user_exists(self, userid) -> bool:
-        """Check if user exists on this backend
+    def find_user(self, userid, mail=None):
+        """Find an user by userid or mail
         Args:
             userid: Userid to search
+            mail: If set, mail to search
         Returns:
-            True or False
+            None or User
         """
-        raise NotImplemented
+        return None
 
     def modify_user(self, user, password, new_password=None):
         """If backend is using (writeable) external data, then update the external database with the user provided.
@@ -209,14 +247,11 @@ class AuthPlugin(Plugin):
             password: Password (some backends need the current password for changes) if None force edit (admin)
             new_password: If set a password change is requested
         Raises:
+            NotImplemented: If backend does not support this feature (or no password change)
             BadRequest: Logic error, e.g. password is wrong.
             Error: Other errors if backend went mad (are not handled and will result in a 500 error)
         """
-        pass
-
-    def can_register(self):
-        """Check if this backend allows to register new users"""
-        return False
+        raise NotImplemented
 
     def create_user(self, user, password):
         """If backend is using (writeable) external data, then create a new user on the external database.
@@ -226,7 +261,7 @@ class AuthPlugin(Plugin):
             password: string
 
         """
-        raise NotImplementedError
+        raise MethodNotAllowed
 
     def delete_user(self, user):
         """If backend is using (writeable) external data, then delete the user from external database.
@@ -235,9 +270,9 @@ class AuthPlugin(Plugin):
             user: User object
 
         """
-        raise NotImplementedError
+        raise MethodNotAllowed
 
-    def get_avatar(self, user) -> _Avatar:
+    def get_avatar(self, user):
         """Retrieve avatar for given user (if supported by auth backend)
 
         Default behavior is to use native Image objects,

flaschengeist/plugins/auth/__init__.py

@@ -6,13 +6,13 @@ from flask import Blueprint, request, jsonify
 from werkzeug.exceptions import Forbidden, BadRequest, Unauthorized
 
 from flaschengeist import logger
-from flaschengeist.plugins import Plugin
+from flaschengeist.plugins import BasePlugin
 from flaschengeist.utils.HTTP import no_content, created
 from flaschengeist.utils.decorators import login_required
 from flaschengeist.controller import sessionController, userController
 
 
-class AuthRoutePlugin(Plugin):
+class AuthRoutePlugin(BasePlugin):
     blueprint = Blueprint("auth", __name__)
 
 
@@ -40,7 +40,7 @@ def login():
     user = userController.login_user(userid, password)
     if not user:
         raise Unauthorized
-    session = sessionController.create(user, request_headers=request.headers)
+    session = sessionController.create(user, user_agent=request.user_agent)
     logger.debug(f"token is {session.token}")
     logger.info(f"User {userid} logged in.")
 

flaschengeist/plugins/auth_plain/__init__.py

@@ -7,25 +7,42 @@ import os
 import hashlib
 import binascii
 from werkzeug.exceptions import BadRequest
-from flaschengeist.plugins import AuthPlugin
+from flaschengeist.plugins import AuthPlugin, plugins_installed
 from flaschengeist.models import User, Role, Permission
 from flaschengeist.database import db
 from flaschengeist import logger
 
 
 class AuthPlain(AuthPlugin):
-    def can_register(self):
-        return True
+    def install(self):
+        plugins_installed(self.post_install)
 
-    def login(self, login_name, password):
-        users: list[User] = (
-            User.query.filter((User.userid == login_name) | (User.mail == login_name))
-            .filter(User._attributes.any(name="password"))
-            .all()
-        )
-        for user in users:
-            if AuthPlain._verify_password(user.get_attribute("password"), password):
-                return user.userid
+    def post_install(self, *args, **kwargs):
+        if User.query.filter(User.deleted == False).count() == 0:
+            logger.info("Installing admin user")
+            role = Role.query.filter(Role.name == "Superuser").first()
+            if role is None:
+                role = Role(name="Superuser", permissions=Permission.query.all())
+            admin = User(
+                userid="admin",
+                firstname="Admin",
+                lastname="Admin",
+                mail="",
+                roles_=[role],
+            )
+            self.modify_user(admin, None, "admin")
+            db.session.add(admin)
+            db.session.commit()
+            logger.warning(
+                "New administrator user was added, please change the password or remove it before going into"
+                "production mode. Initial credentials:\n"
+                "name: admin\n"
+                "password: admin"
+            )
+
+    def login(self, user: User, password: str):
+        if user.has_attribute("password"):
+            return AuthPlain._verify_password(user.get_attribute("password"), password)
         return False
 
     def modify_user(self, user, password, new_password=None):
@@ -34,12 +51,6 @@ class AuthPlain(AuthPlugin):
         if new_password:
             user.set_attribute("password", AuthPlain._hash_password(new_password))
 
-    def user_exists(self, userid) -> bool:
-        return (
-            db.session.query(User.id_).filter(User.userid == userid, User._attributes.any(name="password")).first()
-            is not None
-        )
-
     def create_user(self, user, password):
         if not user.userid:
             raise BadRequest("userid is missing for new user")
@@ -57,7 +68,7 @@ class AuthPlain(AuthPlugin):
         return (salt + pass_hash).decode("ascii")
 
     @staticmethod
-    def _verify_password(stored_password: str, provided_password: str):
+    def _verify_password(stored_password, provided_password):
         salt = stored_password[:64]
         stored_password = stored_password[64:]
         pass_hash = hashlib.pbkdf2_hmac("sha3-512", provided_password.encode("utf-8"), salt.encode("ascii"), 100000)

flaschengeist/plugins/message_mail.py

@@ -4,13 +4,13 @@ from email.mime.multipart import MIMEMultipart
 
 from flaschengeist import logger
 from flaschengeist.models import User
-from flaschengeist.plugins import Plugin
+from flaschengeist.plugins import BasePlugin
 from flaschengeist.utils.hook import HookAfter
 from flaschengeist.controller import userController
 from flaschengeist.controller.messageController import Message
 
 
-class MailMessagePlugin(Plugin):
+class MailMessagePlugin(BasePlugin):
     def __init__(self, entry_point, config):
         super().__init__(entry_point, config)
         self.server = config["SERVER"]

flaschengeist/plugins/roles/__init__.py

@@ -6,7 +6,7 @@ Provides routes used to configure roles and permissions of users / roles.
 from werkzeug.exceptions import BadRequest
 from flask import Blueprint, request, jsonify
 
-from flaschengeist.plugins import Plugin
+from flaschengeist.plugins import BasePlugin
 from flaschengeist.controller import roleController
 from flaschengeist.utils.HTTP import created, no_content
 from flaschengeist.utils.decorators import login_required
@@ -14,11 +14,9 @@ from flaschengeist.utils.decorators import login_required
 from . import permissions
 
 
-class RolesPlugin(Plugin):
+class RolesPlugin(BasePlugin):
     blueprint = Blueprint("roles", __name__)
-
-    def install(self):
-        self.install_permissions(permissions.permissions)
+    permissions = permissions.permissions
 
 
 @RolesPlugin.blueprint.route("/roles", methods=["GET"])

flaschengeist/plugins/scheduler.py

@@ -3,7 +3,7 @@ from datetime import datetime, timedelta
 
 from flaschengeist import logger
 from flaschengeist.config import config
-from flaschengeist.plugins import Plugin
+from flaschengeist.plugins import BasePlugin
 from flaschengeist.utils.HTTP import no_content
 
 
@@ -38,10 +38,11 @@ def scheduled(id: str, replace=False, **kwargs):
     return real_decorator
 
 
-class SchedulerPlugin(Plugin):
-    blueprint = Blueprint("scheduler", __name__)
+class SchedulerPlugin(BasePlugin):
+    def __init__(self, entry_point):
+        super().__init__(entry_point)
+        self.blueprint = Blueprint(self.name, __name__)
 
-    def load(self):
         def __view_func():
             self.run_tasks()
             return no_content()
@@ -60,9 +61,6 @@ class SchedulerPlugin(Plugin):
             self.blueprint.add_url_rule("/cron", view_func=__view_func)
 
     def run_tasks(self):
-        from ..database import db
-        self = db.session.merge(self)
-
         changed = False
         now = datetime.now()
         status = self.get_setting("status", default=dict())

flaschengeist/plugins/users/__init__.py

@@ -9,7 +9,7 @@ from werkzeug.exceptions import BadRequest, Forbidden, MethodNotAllowed
 from . import permissions
 from flaschengeist import logger
 from flaschengeist.config import config
-from flaschengeist.plugins import Plugin
+from flaschengeist.plugins import BasePlugin
 from flaschengeist.models import User
 from flaschengeist.utils.decorators import login_required, extract_session, headers
 from flaschengeist.controller import userController
@@ -17,11 +17,9 @@ from flaschengeist.utils.HTTP import created, no_content
 from flaschengeist.utils.datetime import from_iso_format
 
 
-class UsersPlugin(Plugin):
+class UsersPlugin(BasePlugin):
     blueprint = Blueprint("users", __name__)
-
-    def install(self):
-        self.install_permissions(permissions.permissions)
+    permissions = permissions.permissions
 
 
 @UsersPlugin.blueprint.route("/users", methods=["POST"])

flaschengeist/plugins/users/cli.py

@@ -1,8 +1,6 @@
 import click
 from flask.cli import with_appcontext
-from werkzeug.exceptions import NotFound
-
-from flaschengeist.database import db
+from werkzeug.exceptions import BadRequest, Conflict, NotFound
 from flaschengeist.controller import roleController, userController
 
 
@@ -30,52 +28,23 @@ def user(ctx, param, value):
 
 
 @click.command()
-@click.option("--create", help="Add new role", is_flag=True)
-@click.option("--delete", help="Delete role", is_flag=True)
-@click.option("--set-admin", is_flag=True, help="Make a role an admin role, adding all permissions", type=str)
-@click.argument("role", nargs=-1, required=True, type=str)
-def role(create, delete, set_admin, role):
-    """Manage roles"""
-    ctx = click.get_current_context()
-
-    if (create and delete) or (set_admin and delete):
-        ctx.fail("Do not mix --delete with --create or --set-admin")
-
-    for role_name in role:
-        if create:
-            r = roleController.create_role(role_name)
-        else:
-            r = roleController.get(role_name)
-        if delete:
-            roleController.delete(r)
-        if set_admin:
-            r.permissions = roleController.get_permissions()
-            db.session.commit()
-
-
-@click.command()
-@click.option("--add-role", help="Add a role to an user", type=str)
-@click.option("--create", help="Create new user interactivly", callback=user, is_flag=True, expose_value=False)
-@click.option("--delete", help="Delete a user", is_flag=True)
-@click.argument("user", nargs=-1, type=str)
+@click.option("--add-role", help="Add new role", type=str)
+@click.option("--set-admin", help="Make a role an admin role, adding all permissions", type=str)
+@click.option("--add-user", help="Add new user interactivly", callback=user, is_flag=True, expose_value=False)
 @with_appcontext
-def user(add_role, delete, user):
-    """Manage users"""
+def users(add_role, set_admin):
     from flaschengeist.database import db
 
     ctx = click.get_current_context()
 
     try:
+        if add_role:
+            roleController.create_role(add_role)
+        if set_admin:
+            role = roleController.get(set_admin)
+            role.permissions = roleController.get_permissions()
+            db.session.commit()
         if USER_KEY in ctx.meta:
             userController.register(ctx.meta[USER_KEY], ctx.meta[USER_KEY]["password"])
-        else:
-            for uid in user:
-                user = userController.get_user(uid)
-                if delete:
-                    userController.delete_user(user)
-                elif add_role:
-                    role = roleController.get(add_role)
-                    user.roles_.append(role)
-                    db.session.commit()
-    except NotFound:
-        ctx.fail(f"User not found {uid}")
+    except (BadRequest, NotFound) as e:
+        ctx.fail(e.description)

flaschengeist/utils/foreign_keys.py

@@ -0,0 +1,51 @@
+# Borrowed from https://github.com/kvesteri/sqlalchemy-utils
+# Modifications see: https://github.com/kvesteri/sqlalchemy-utils/issues/561
+# LICENSED under the BSD license, see upstream https://github.com/kvesteri/sqlalchemy-utils/blob/master/LICENSE
+
+import sqlalchemy as sa
+from sqlalchemy.orm import object_session
+
+
+def get_foreign_key_values(fk, obj):
+    mapper = sa.inspect(obj.__class__)
+    return dict(
+        (
+            fk.constraint.columns.values()[index],
+            getattr(obj, element.column.key)
+            if hasattr(obj, element.column.key)
+            else getattr(obj, mapper.get_property_by_column(element.column).key),
+        )
+        for index, element in enumerate(fk.constraint.elements)
+    )
+
+
+def get_referencing_foreign_keys(mixed):
+    tables = [mixed]
+    referencing_foreign_keys = set()
+
+    for table in mixed.metadata.tables.values():
+        if table not in tables:
+            for constraint in table.constraints:
+                if isinstance(constraint, sa.sql.schema.ForeignKeyConstraint):
+                    for fk in constraint.elements:
+                        if any(fk.references(t) for t in tables):
+                            referencing_foreign_keys.add(fk)
+    return referencing_foreign_keys
+
+
+def merge_references(from_, to, foreign_keys=None):
+    """
+    Merge the references of an entity into another entity.
+    """
+    if from_.__tablename__ != to.__tablename__:
+        raise TypeError("The tables of given arguments do not match.")
+
+    session = object_session(from_)
+    foreign_keys = get_referencing_foreign_keys(from_.__table__)
+
+    for fk in foreign_keys:
+        old_values = get_foreign_key_values(fk, from_)
+        new_values = get_foreign_key_values(fk, to)
+        session.query(from_.__mapper__).filter(*[k == old_values[k] for k in old_values]).update(
+            new_values, synchronize_session=False
+        )

setup.cfg

@@ -28,7 +28,6 @@ install_requires =
     flask_migrate>=3.1.0
     flask_sqlalchemy>=2.5.1
     sqlalchemy>=1.4.40
-    sqlalchemy_utils>=0.38.3
     toml
     werkzeug>=2.2.2
 
@@ -48,8 +47,7 @@ console_scripts =
     flaschengeist = flaschengeist.cli:main
 flask.commands =
     ldap = flaschengeist.plugins.auth_ldap.cli:ldap
-    user = flaschengeist.plugins.users.cli:user
-    role = flaschengeist.plugins.users.cli:role
+    users = flaschengeist.plugins.users.cli:users
 flaschengeist.plugins =
     # Authentication providers
     auth_plain = flaschengeist.plugins.auth_plain:AuthPlain