Use flask-sqlalchemy (#359)

Author: DavidMStraub

gramps_webapi/__main__.py

@@ -32,7 +32,7 @@
 from .api.util import get_db_manager, get_search_indexer, list_trees
 from .dbmanager import WebDbManager
 from .app import create_app
-from .auth import SQLAuth
+from .auth import add_user, delete_user, fill_tree, user_db
 from .const import ENV_CONFIG_FILE
 
 logging.basicConfig()
@@ -68,7 +68,6 @@ def run(ctx, port, tree):
 @click.pass_context
 def user(ctx):
     app = ctx.obj["app"]
-    ctx.obj["auth"] = SQLAuth(db_uri=app.config["USER_DB_URI"])
 
 
 @user.command("add")
@@ -81,39 +80,42 @@ def user(ctx):
 @click.pass_context
 def user_add(ctx, name, password, fullname, email, role, tree):
     """Add a user."""
-    LOG.error("Adding user {} ...".format(name))
-    auth = ctx.obj["auth"]
-    auth.create_table()
-    auth.add_user(name, password, fullname, email, role, tree)
+    LOG.error(f"Adding user {name} ...")
+    app = ctx.obj["app"]
+    with app.app_context():
+        user_db.create_all()
+        add_user(name, password, fullname, email, role, tree)
 
 
 @user.command("delete")
 @click.argument("name")
 @click.pass_context
 def user_del(ctx, name):
     """Delete a user."""
-    LOG.info("Deleting user {} ...".format(name))
-    auth = ctx.obj["auth"]
-    auth.delete_user(name)
+    LOG.info(f"Deleting user {name} ...")
+    app = ctx.obj["app"]
+    with app.app_context():
+        delete_user(name)
 
 
 @user.command("fill-tree")
 @click.argument("tree")
 @click.pass_context
-def fill_tree(ctx, tree):
+def cmd_fill_tree(ctx, tree):
     """Set the Tree ID for users where it is missing."""
-    auth = ctx.obj["auth"]
-    auth.fill_tree(tree)
+    app = ctx.obj["app"]
+    with app.app_context():
+        fill_tree(tree)
 
 
 @user.command("migrate")
 @click.pass_context
 def migrate_db(ctx):
     """Upgrade the user database schema, if required."""
-    auth = ctx.obj["auth"]
+    app = ctx.obj["app"]
     cmd = [sys.executable, "-m", "alembic", "upgrade", "head"]
     env = os.environ.copy()
-    env["GRAMPSWEB_USER_DB_URI"] = auth.db_uri
+    env["GRAMPSWEB_USER_DB_URI"] = app.config["USER_DB_URI"]
     subprocess.run(cmd, env=env, check=True)
 
 

gramps_webapi/api/resources/config.py

@@ -23,6 +23,7 @@
 from flask import abort, current_app, jsonify
 from webargs import fields
 
+from ...auth import config_delete, config_get, config_get_all, config_set
 from ...auth.const import PERM_EDIT_SETTINGS, PERM_VIEW_SETTINGS
 from ...const import DB_CONFIG_ALLOWED_KEYS
 from ..auth import require_permissions
@@ -36,8 +37,7 @@ class ConfigsResource(ProtectedResource):
     def get(self):
         """Get all config settings."""
         require_permissions([PERM_VIEW_SETTINGS])
-        auth_provider = current_app.config.get("AUTH_PROVIDER")
-        return jsonify(auth_provider.config_get_all()), 200
+        return jsonify(config_get_all()), 200
 
 
 class ConfigResource(ProtectedResource):
@@ -46,10 +46,9 @@ class ConfigResource(ProtectedResource):
     def get(self, key: str):
         """Get a config setting."""
         require_permissions([PERM_VIEW_SETTINGS])
-        auth_provider = current_app.config.get("AUTH_PROVIDER")
         if key not in DB_CONFIG_ALLOWED_KEYS:
             abort(404)
-        val = auth_provider.config_get(key)
+        val = config_get(key)
         if val is None:
             abort(404)
         return jsonify(val), 200
@@ -63,21 +62,19 @@ def get(self, key: str):
     def put(self, args, key: str):
         """Update a config setting."""
         require_permissions([PERM_EDIT_SETTINGS])
-        auth_provider = current_app.config.get("AUTH_PROVIDER")
         try:
-            auth_provider.config_set(key=key, value=args["value"])
+            config_set(key=key, value=args["value"])
         except ValueError:
             abort(404)  # key not allowed
         return "", 200
 
     def delete(self, key: str):
         """Delete a config setting."""
         require_permissions([PERM_EDIT_SETTINGS])
-        auth_provider = current_app.config.get("AUTH_PROVIDER")
         try:
-            if auth_provider.config_get(key=key) is None:
+            if config_get(key=key) is None:
                 abort(404)
         except ValueError:
             abort(404)
-        auth_provider.config_delete(key=key)
+        config_delete(key=key)
         return "", 200

gramps_webapi/api/resources/token.py

@@ -29,7 +29,13 @@
 )
 from webargs import fields, validate
 
-from ...auth import SQLAuth
+from ...auth import (
+    get_all_user_details,
+    get_permissions,
+    get_guid,
+    authorized,
+    get_name,
+)
 from ...auth.const import CLAIM_LIMITED_SCOPE, SCOPE_CREATE_ADMIN
 from ..ratelimiter import limiter
 from ..util import get_tree_id, use_args
@@ -69,13 +75,12 @@ class TokenResource(Resource):
     )
     def post(self, args):
         """Post username and password to fetch a token."""
-        auth_provider = current_app.config.get("AUTH_PROVIDER")
         if "username" not in args or "password" not in args:
             abort(401)
-        if not auth_provider.authorized(args.get("username"), args.get("password")):
+        if not authorized(args.get("username"), args.get("password")):
             abort(403)
-        permissions = auth_provider.get_permissions(args["username"])
-        user_id = auth_provider.get_guid(args["username"])
+        permissions = get_permissions(args["username"])
+        user_id = get_guid(args["username"])
         tree_id = get_tree_id(user_id)
         return get_tokens(
             user_id=user_id,
@@ -91,13 +96,12 @@ class TokenRefreshResource(RefreshProtectedResource):
     @limiter.limit("1/second")
     def post(self):
         """Fetch a fresh token."""
-        auth_provider = current_app.config.get("AUTH_PROVIDER")
         user_id = get_jwt_identity()
         try:
-            username = auth_provider.get_name(user_id)
+            username = get_name(user_id)
         except ValueError:
             abort(401)
-        permissions = auth_provider.get_permissions(username)
+        permissions = get_permissions(username)
         tree_id = get_tree_id(user_id)
         return get_tokens(
             user_id=user_id,
@@ -113,8 +117,7 @@ class TokenCreateOwnerResource(Resource):
     @limiter.limit("1/second")
     def get(self):
         """Get a token."""
-        auth_provider: SQLAuth = current_app.config.get("AUTH_PROVIDER")
-        if auth_provider.get_all_user_details(tree=None):
+        if get_all_user_details(tree=None):
             # users already exist!
             abort(405)
         token = create_access_token(