mia-accounting/tests/test_site/auth.py

101 lines
2.8 KiB
Python

# The Mia! Accounting Flask Demonstration Website.
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/1/27
# Copyright (c) 2023 imacat.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""The authentication for the Mia! Accounting Flask demonstration website.
"""
from flask import Blueprint, render_template, Flask, redirect, url_for, \
session, request, g
from . import db
bp: Blueprint = Blueprint("auth", __name__, url_prefix="/")
class User(db.Model):
"""A user."""
__tablename__ = "users"
"""The table name."""
id = db.Column(db.Integer, nullable=False, primary_key=True,
autoincrement=True)
"""The ID"""
username = db.Column(db.String, nullable=False, unique=True)
"""The username."""
def __str__(self) -> str:
"""Returns the string representation of the user.
:return: The string representation of the user.
"""
return self.username
@bp.get("login", endpoint="login-form")
def show_login_form() -> str:
"""Shows the login form.
:return: The login form.
"""
return render_template("login.html")
@bp.post("login", endpoint="login")
def login() -> redirect:
"""Logs in the user.
:return: The redirection to the home page.
"""
if request.form.get("username") not in ["viewer", "editor", "editor2",
"nobody"]:
return redirect(url_for("auth.login"))
session["user"] = request.form.get("username")
return redirect(url_for("home.home"))
@bp.post("logout", endpoint="logout")
def logout() -> redirect:
"""Logs out the user.
:return: The redirection to the home page.
"""
if "user" in session:
del session["user"]
return redirect(url_for("home.home"))
def current_user() -> User | None:
"""Returns the current user.
:return: The current user, or None if the user did not log in.
"""
if not hasattr(g, "user"):
if "user" not in session:
g.user = None
else:
g.user = User.query.filter(
User.username == session["user"]).first()
return g.user
def init_app(app: Flask) -> None:
"""Initialize the localization.
:param app: The Flask application.
:return: None.
"""
app.register_blueprint(bp)
app.jinja_env.globals["current_user"] = current_user