Source code for kadi.modules.accounts.utils

# Copyright 2020 Karlsruhe Institute of Technology
# 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
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
from uuid import uuid4

from flask import current_app
from flask_login import current_user
from flask_login import login_user as _login_user
from flask_login import logout_user as _logout_user

import kadi.lib.constants as const
from .models import User
from .models import UserState
from .providers import ShibProvider
from .schemas import UserSchema
from kadi.ext.db import db
from kadi.lib.db import escape_like
from import delete_thumbnail
from import save_as_thumbnail
from kadi.lib.utils import compact_json
from kadi.lib.web import url_for

[docs]def login_user(identity): """Log in a user by their identity. Wraps Flask-Login's ``login_user`` function but also ensures that the user's latest identity is updated. Note that this function requires an active request context. :param identity: The identity to log in with. :return: ``True`` if the login was successful, ``False`` otherwise. """ user = identity.user user.identity = identity return _login_user(user, force=True)
[docs]def logout_user(): """Log out the current user. Wraps Flask-Login's ``logout_user`` function. Note that this function requires an active request context. :return: The URL to redirect the user to after logging out, depending on their latest identity. """ redirect_url = url_for("main.index") if ( current_user.is_authenticated and current_user.identity is not None and current_user.identity.type == const.AUTH_PROVIDER_TYPE_SHIB and ShibProvider.is_registered() ): redirect_url = ShibProvider.get_logout_initiator(redirect_url) _logout_user() return redirect_url
[docs]def save_user_image(user, file_object): """Set an image file as a user's profile image. Uses :func:`` to create and save a thumbnail of the given image. Any previous image will be deleted beforehand using :func:`delete_user_image`, which will also be called if the image cannot be saved. :param user: The user to set the new profile image for. :param file_object: The image file object. """ delete_user_image(user) user.image_name = uuid4() if not save_as_thumbnail(str(user.image_name), file_object): delete_user_image(user)
[docs]def delete_user_image(user): """Delete a user's profile image if one exists. Uses :func:`` to delete the actual thumbnail file. :param user: The user whose profile image should be deleted. """ if user.image_name: delete_thumbnail(str(user.image_name)) user.image_name = None
[docs]def json_user(user): """Convert a user into a JSON representation for use in HTML templates. :param user: The user to convert. :return: The converted user. """ json_data = UserSchema(_internal=True).dump(user) return compact_json(json_data, ensure_ascii=True, sort_keys=False)
[docs]def get_filtered_user_ids(filter_term): """Get all IDs of users filtered by the given term. Convenience function to filter users based on their identities. Note that users with multiple identities are only returned once and merged users are always excluded, as they do not have any identities anymore. :param filter_term: A (case insensitive) term to filter the users by their username or display name. :return: The filtered user IDs as query. """ filter_term = escape_like(filter_term) identity_queries = [] for provider_config in current_app.config["AUTH_PROVIDERS"].values(): model = provider_config["identity_class"] identities_query = model.query.filter( db.or_( model.displayname.ilike(f"%{filter_term}%"), model.username.ilike(f"%{filter_term}%"), ), ).with_entities(model.user_id.label("id")) identity_queries.append(identities_query) return identity_queries[0].union(*identity_queries[1:])
[docs]def clean_users(inside_task=False): """Clean all deleted users. Note that this function may issue one or more database commits. :param inside_task: (optional) A flag indicating whether the function is executed in a task. In that case, additional information will be logged. """ from .core import purge_user users = User.query.filter(User.state == UserState.DELETED) if inside_task and users.count() > 0:"Cleaning {users.count()} deleted user(s).") for user in users: purge_user(user)