Source code for timApp.admin.routes

import os
from dataclasses import dataclass

from flask import flash, url_for, Blueprint, Response

from timApp.auth.accesshelper import verify_admin
from timApp.timdb.sqa import db
from timApp.user.user import User
from timApp.user.usergroup import UserGroup
from timApp.util.flask.requesthelper import use_model
from timApp.util.flask.responsehelper import safe_redirect, json_response

admin_bp = Blueprint("admin", __name__, url_prefix="")


[docs]@dataclass
class ExceptionRouteModel:
    db_error: bool = False


[docs]@admin_bp.route("/exception", methods=["GET", "POST", "PUT", "DELETE"])
@use_model(ExceptionRouteModel)
def throw_ex(m: ExceptionRouteModel) -> Response:
    verify_admin()
    if m.db_error:
        db.session.add(UserGroup(name="test"))
        db.session.add(UserGroup(name="test"))
        db.session.flush()
        raise Exception("Flush should have raised an exception!")
    raise Exception(
        "This route throws an exception intentionally for testing purposes."
    )


gunicorn_pid_path = "/var/run/gunicorn/gunicorn.pid"


[docs]@admin_bp.get("/restart")
def restart_server() -> Response:
    """Restarts the server by sending HUP signal to Gunicorn."""
    verify_admin()
    if os.path.exists(gunicorn_pid_path):
        os.system(f"kill -HUP $(cat {gunicorn_pid_path})")
        flash("Restart signal was sent to Gunicorn.")
    else:
        flash(
            "Gunicorn PID file was not found. TIM was probably not started with Gunicorn."
        )
    return safe_redirect(url_for("start_page"))


[docs]@admin_bp.get("/users/search/<term>")
def search_users(term: str) -> Response:
    verify_admin()
    result = (
        User.query.filter(
            User.name.ilike(f"%{term}%")
            | User.real_name.ilike(f"%{term}%")
            | User.email.ilike(f"%{term}%")
        )
        .order_by(User.id)
        .all()
    )
    return json_response([u.to_json(contacts=True) for u in result])
TIM documentation

Source code for timApp.admin.routes
