From 00d8cbc5eaa211bd78992897ce54c57aa7af0ea0 Mon Sep 17 00:00:00 2001 From: Lazlo Westerhof Date: Fri, 25 Oct 2024 15:40:02 +0200 Subject: [PATCH] PoC with response and API caching --- admin/admin.py | 3 + api.py | 139 +++++-- app.py | 5 + cache_config.py | 196 ++++++++++ deposit/deposit.py | 3 + general/general.py | 3 + general/templates/general/base.html | 2 + general/templates/general/user.html | 4 +- group_manager/group_manager.py | 42 +- .../static/group_manager/js/group_manager.js | 359 ++++++------------ .../templates/group_manager/index.html | 12 +- requirements.txt | 2 + research/research.py | 11 +- research/templates/research/browse.html | 4 - setup.cfg | 2 +- static/js/yoda.js | 10 + stats/stats.py | 4 +- user/static/user/js/data_access.js | 14 + user/static/user/js/notifications.js | 25 +- user/templates/user/data_access.html | 9 +- user/templates/user/notifications.html | 22 +- user/user.py | 86 +++-- vault/templates/vault/browse.html | 5 - vault/vault.py | 11 +- 24 files changed, 570 insertions(+), 403 deletions(-) create mode 100644 cache_config.py diff --git a/admin/admin.py b/admin/admin.py index 1d9368f6..f534076d 100644 --- a/admin/admin.py +++ b/admin/admin.py @@ -30,6 +30,7 @@ from werkzeug.utils import secure_filename import api +from cache_config import clear_api_cache_keys, clear_view_cache_keys from util import get_theme_directories, length_check # Blueprint configuration @@ -175,6 +176,8 @@ def save_settings(settings: Dict[str, Any], flash_msg: str) -> Response: # Load the theme template if the current theme is changed set_theme_loader(app, remove_cache=True) + clear_view_cache_keys(all_users=True) + clear_api_cache_keys("admin_save_settings") flash(flash_msg, 'success') return redirect(url_for("admin_bp.index")) diff --git a/api.py b/api.py index b16463dc..ef830a0c 100644 --- a/api.py +++ b/api.py @@ -4,6 +4,7 @@ __license__ = 'GPLv3, see LICENSE' import base64 +import hashlib import json import re import sys @@ -15,6 +16,7 @@ from flask import current_app as app from irods import message, rule +from cache_config import cache, clear_api_cache_keys, get_api_cache_timeout, make_key from errors import InvalidAPIError, UnauthorizedAPIAccessError from util import log_error @@ -23,51 +25,116 @@ @api_bp.route('/', methods=['POST']) def _call(fn: str) -> Response: + """Handle API calls to specified function. + + :param fn: The name of the API function to call + + :returns: JSON response containing the result of the API call + + :raises UnauthorizedAPIAccessError: If the user is not authenticated + :raises InvalidAPIError: If the function name is invalid + """ if not authenticated(): raise UnauthorizedAPIAccessError - if not re.match("^([a-z_]+)$", fn): + if not re.match(r"^[a-z_]+$", fn): raise InvalidAPIError - data: Dict[str, Any] = {} - if 'data' in request.form: - data = json.loads(request.form['data']) + data = json.loads(request.form.get('data', '{}')) + result = call(fn, data) + return jsonify(result), get_response_code(result) - result: Dict[str, Any] = call(fn, data) - code: int = 200 - if result['status'] == 'error_internal': - code = 500 - elif result['status'] != 'ok': - code = 400 +def get_response_code(result: Dict[str, Any]) -> int: + """Determine the HTTP response code based on the result status. - response = jsonify(result) - response.status_code = code - return response + :param result: The result dictionary from the API call + + :returns: HTTP status code + """ + if result['status'] == 'error_internal': + return 500 + return 400 if result['status'] != 'ok' else 200 def call(fn: str, data: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: + """Call the specified API function with the provided data. + + :param fn: The name of the API function to call + :param data: Optional dictionary of data to pass to the function + + :returns: The result of the API call as a dictionary + """ + if app.config.get('LOG_API_CALL_DURATION', False): + begintime = timer() + + if data is None: + data = {} + + params = json.dumps(data) + encoded_params = hashlib.shake_256(params.encode('utf-8')).hexdigest(20) + + # Clear API cache keys if the API function called impacts keys. + clear_api_cache_keys(fn) + + timeout = get_api_cache_timeout(fn) + cached_result = None + if timeout > 0: + cached_result = cache.get(make_key(f"{fn}-{encoded_params}")) + + # Execute rule if there is no cached result. + if cached_result is None: + result = execute_rule(fn, params) + + # Cache result if a timeout is specified for this API. + if timeout > 0: + cache.set(make_key(f"{fn}-{encoded_params}"), result, timeout=timeout) + else: + result = cached_result + + if app.config.get('LOG_API_CALL_DURATION', False): + endtime = timer() + callduration = round((endtime - begintime) * 1000) + log_message = f"DEBUG: {callduration:4d}ms api_{fn} {params}" + if cached_result is not None: + log_message += " (from cache)" + print(log_message, file=sys.stderr) + + return json.loads(result) + + +def execute_rule(fn: str, params: str) -> str: + """Execute the specified iRODS rule with the given parameters. + + :param fn: The name of the API function to execute + :param params: The parameters to pass to the rule + + :returns: The output of the rule execution as a string. + """ def bytesbuf_to_str(s: message.BinBytesBuf) -> str: + """Convert a BinBytesBuf to a string, handling null termination.""" s = s.buf[:s.buflen] i = s.find(b'\x00') return s if i < 0 else s[:i] def escape_quotes(s: str) -> str: + """Escape quotes in a string for safe inclusion in rules.""" return s.replace('\\', '\\\\').replace('"', '\\"') def break_strings(N: int, m: int) -> int: + """Calculate the number of segments needed to break a string.""" return (N - 1) // m + 1 def nrep_string_expr(s: str, m: int = 64) -> str: - return '++\n'.join(f'"{escape_quotes(s[i * m:i * m + m])}"' for i in range(break_strings(len(s), m) + 1)) + """Break up the string literal to work around limits for both parameter strings + and literal string constants in the iRODS core code. - if app.config.get('LOG_API_CALL_DURATION', False): - begintime = timer() - - if data is None: - data = {} + :param s: The string to be broken + :param m: The maximum length of each segment - params = json.dumps(data) + :returns: A string formatted for iRODS rule input + """ + return '++\n'.join(f'"{escape_quotes(s[i * m:i * m + m])}"' for i in range(break_strings(len(s), m) + 1)) # Compress params and encode as base64 to reduce size (max rule length in iRODS is 20KB) compressed_params = zlib.compress(params.encode()) @@ -91,35 +158,36 @@ def nrep_string_expr(s: str, m: int = 64) -> str: g.irods.cleanup() x = x.execute(session_cleanup=False) - x = bytesbuf_to_str(x._values['MsParam_PI'][0]._values['inOutStruct']._values['stdoutBuf']) - - result = x.decode() - - if app.config.get('LOG_API_CALL_DURATION', False): - endtime = timer() - callduration = round((endtime - begintime) * 1000) - print(f"DEBUG: {callduration:4d}ms api_{fn} {params}", file=sys.stderr) - - return json.loads(result) + return bytesbuf_to_str(x._values['MsParam_PI'][0]._values['inOutStruct']._values['stdoutBuf']) def authenticated() -> bool: + """Check if the user is authenticated. + + :returns: True if the user is authenticated, False otherwise + """ return g.get('user') is not None and g.get('irods') is not None @api_bp.errorhandler(Exception) def api_error_handler(error: Exception) -> Response: + """Handle exceptions raised during API calls. + + :param error: The exception that was raised + + :returns: A JSON response containing the error details and HTTP status code + """ log_error(f'API Error: {error}', True) status = "internal_error" status_info = "Something went wrong" data: Dict[str, Any] = {} - code = 500 + code = 500 # Default to internal server error. - if type(error) is InvalidAPIError: + # Determine specific error types and set appropriate response details. + if isinstance(error, InvalidAPIError): code = 400 status_info = "Bad API request" - - if type(error) is UnauthorizedAPIAccessError: + elif isinstance(error, UnauthorizedAPIAccessError): code = 401 status_info = "Not authorized to use the API" @@ -128,4 +196,5 @@ def api_error_handler(error: Exception) -> Response: "status": status, "status_info": status_info, "data": data - }), code + } + ), code diff --git a/app.py b/app.py index a2154adc..34b1227d 100644 --- a/app.py +++ b/app.py @@ -14,6 +14,7 @@ from admin.admin import admin_bp, set_theme_loader from api import api_bp +from cache_config import cache from datarequest.datarequest import datarequest_bp from deposit.deposit import deposit_bp from fileviewer.fileviewer import fileviewer_bp @@ -29,6 +30,7 @@ from util import get_validated_static_path, log_error from vault.vault import vault_bp + app = Flask(__name__, static_folder='assets') app.json.sort_keys = False @@ -128,6 +130,9 @@ def load_admin_setting() -> Dict[str, Any]: # Start Flask-Session Session(app) +# Initialize the cache. +cache.init_app(app) + # Start monitoring thread for extracting tech support information # Monitor signal file can be set to empty to completely disable monitor thread monitor_enabled: bool = app.config.get("MONITOR_SIGNAL_FILE", "/var/www/yoda/show-tech.sig") != "" diff --git a/cache_config.py b/cache_config.py new file mode 100644 index 00000000..e8261415 --- /dev/null +++ b/cache_config.py @@ -0,0 +1,196 @@ +#!/usr/bin/env python3 + +__copyright__ = 'Copyright (c) 2024, Utrecht University' +__license__ = 'GPLv3, see LICENSE' + +import hashlib +import json +from concurrent.futures import ThreadPoolExecutor +from typing import List, Optional + +from flask import current_app as app, g, request, session +from flask_caching import Cache + +import api +from util import log_error + +# Create a global ThreadPoolExecutor. +executor = ThreadPoolExecutor(max_workers=2) + +# Configuration for caching. +config = { + "CACHE_TYPE": "RedisCache", + "CACHE_KEY_PREFIX": "yoda_portal_cache_", + "CACHE_DEFAULT_TIMEOUT": 60 * 60, + "CACHE_REDIS_HOST": "localhost", + "CACHE_REDIS_PORT": 6379, + "CACHE_REDIS_DB": 1, + "CACHE_OPTIONS": {"socket_timeout": 2, "retry_on_timeout": True}, +} + +# API cache timeouts configuration. +API_CACHE_TIMEOUTS = { + "group_data": {"timeout": 3600}, + "notifications_load": {"timeout": 120}, + "resource_browse_group_data": {"timeout": 3600}, + "resource_category_stats": {"timeout": 3600}, + "resource_monthly_category_stats": {"timeout": 3600}, + "schema_get_schemas": {"timeout": 3600}, + "settings_load": {"timeout": 3600}, + "token_load": {"timeout": 3600}, + "vault_get_publication_terms": {"timeout": 3600}, + "vault_preservable_formats_lists": {"timeout": 3600}, +} + +# API cache default parameters configuration. +API_CACHE_PARAMS = { + "resource_browse_group_data": { + "default_params": {"offset": 0, "limit": 200, "sort_order": "asc", "sort_on": "name", "search_groups": ""} + }, +} + +# API cache clear configuration. +API_CACHE_CLEAR = { + "admin_save_settings": {"type": "global", "endpoints": ["vault_get_publication_terms", + "vault_preservable_formats_lists"]}, + "group_create": {"type": "global", "endpoints": ["group_data"]}, + "group_update": {"type": "global", "endpoints": ["group_data"]}, + "group_delete": {"type": "global", "endpoints": ["group_data"]}, + "group_user_add": {"type": "global", "endpoints": ["group_data"]}, + "group_user_update_role": {"type": "global", "endpoints": ["group_data"]}, + "group_remove_user_from_group": {"type": "global", "endpoints": ["group_data"]}, + "notifications_dismiss": {"type": "user", "endpoints": ["notifications_load"]}, + "notifications_dismiss_all": {"type": "user", "endpoints": ["notifications_load"]}, + "settings_save": {"type": "user", "endpoints": ["settings_load"]}, + "token_generate": {"type": "user", "endpoints": ["token_load"]}, + "token_delete": {"type": "user", "endpoints": ["token_load"]}, +} + + +def authenticated() -> bool: + """Check if the user is authenticated. + + :returns: True if the user is authenticated, False otherwise + """ + return g.get("user") is not None and g.get("irods") is not None + + +def make_key(api_key: Optional[str] = None) -> str: + """Generate a cache key based on the request and authentication status. + + :param api_key: Optional custom key indentifying API endpoint. If None, defaults to request endpoint and method + + :returns: A string representing the cache key + """ + if api_key is None: + key = f"view-{session.sid}-{request.endpoint}_{request.method}" + else: + key = f"api-{api_key}" + + if authenticated(): + user = g.get('user') + is_development = app.config.get("YODA_ENVIRONMENT") == "development" + user_identifier = user if is_development else hashlib.shake_256(user.encode("utf-8")).hexdigest(20) + else: + user_identifier = "unauthenticated" + + return f"{user_identifier}-{key}" + + +def get_api_cache_functions() -> list: + """Return a list of function names from the API_CACHE_TIMEOUTS configuration.""" + return list(API_CACHE_TIMEOUTS.keys()) + + +def get_api_cache_timeout(fn: str) -> int: + """Retrieve the cache timeout for a specific API function. + + :param fn: The name of the API function + + :returns: The cache timeout in seconds, or 0 if not found + """ + return API_CACHE_TIMEOUTS.get(fn, {"timeout": 0})["timeout"] + + +def filter_cache_keys(substring: str) -> List[str]: + """Retrieve cache keys that contain a specified substring. + + :param substring: The substring to search for in cache key names + + :returns: A list of matching cache keys + """ + prefix = cache.cache.key_prefix + keys = cache.cache._write_client.keys(f"*{substring}*") + return [bs.decode("utf-8")[len(prefix):] for bs in keys] + + +def clear_view_cache_keys(all_users: bool = False) -> None: + """Clear view cache keys associated with the current user or all users. + + :param all_users: If True, clear view cache keys for all users + """ + if all_users: + filter_key = "-view-" + else: + user = g.get('user') + is_development = app.config.get("YODA_ENVIRONMENT") == "development" + user_identifier = user if is_development else hashlib.shake_256(user.encode("utf-8")).hexdigest(20) + filter_key = f"{user_identifier}-view-" + + # Get the keys to delete. + keys_to_delete = [key for key in filter_cache_keys(filter_key)] + + # Attempt to delete the keys from the cache. + try: + cache.delete_many(*keys_to_delete) + except Exception: + log_error(f"Error deleting view cache keys: {keys_to_delete}", True) + + +def clear_api_cache_keys(fn: str) -> None: + """Clear API cache keys associated with a specified API function. + + :param fn: The name of the API function + """ + if fn in API_CACHE_CLEAR: + for endpoint in API_CACHE_CLEAR[fn]["endpoints"]: + # Determine the key to filter based on the type. + if API_CACHE_CLEAR[fn]["type"] == "user": + filter_key = make_key(endpoint) + else: + filter_key = endpoint + + # Get the keys to delete. + keys_to_delete = [key for key in filter_cache_keys(filter_key)] + + # Attempt to delete the keys from the cache. + try: + cache.delete_many(*keys_to_delete) + except Exception: + log_error(f"Error deleting API cache keys: {keys_to_delete}", True) + + +def populate_api_cache(fn: str, user: str, irods: str, session_id: str) -> None: + """Function to prepopulate the API cache for specified function.""" + # Set and session context. + g.user = user + g.irods = irods + session.sid = session_id + + if authenticated(): + data = {} + if fn in API_CACHE_PARAMS: + data = API_CACHE_PARAMS[fn]["default_params"] + + params = json.dumps(data) + encoded_params = hashlib.shake_256(params.encode("utf-8")).hexdigest(20) + cache_key = make_key(f"{fn}-{encoded_params}") + if cache.get(cache_key) is None: + try: + api.call(fn, data) + except Exception as e: + log_error(f"Error prepopulating cache {fn}: {e}", True) + + +# Create a Cache instance. +cache = Cache(config=config) diff --git a/deposit/deposit.py b/deposit/deposit.py index f0867533..488d9ab4 100644 --- a/deposit/deposit.py +++ b/deposit/deposit.py @@ -24,6 +24,7 @@ import api import connman +from cache_config import cache, make_key deposit_bp = Blueprint('deposit_bp', __name__, template_folder='templates', @@ -41,6 +42,7 @@ @deposit_bp.route('/') @deposit_bp.route('/browse') +@cache.cached(make_cache_key=make_key) def index() -> Response: """Deposit overview""" return render_template('deposit/overview.html', @@ -166,6 +168,7 @@ def submit() -> Response: @deposit_bp.route('/thank-you') +@cache.cached(make_cache_key=make_key) def thankyou() -> Response: """Step 4: Thank you""" return render_template('deposit/thank-you.html') diff --git a/general/general.py b/general/general.py index 20cad295..0a96b94c 100644 --- a/general/general.py +++ b/general/general.py @@ -6,6 +6,8 @@ from flask import Blueprint, redirect, render_template, Response, url_for from flask_wtf.csrf import CSRFError +from cache_config import cache, make_key + general_bp = Blueprint('general_bp', __name__, template_folder='templates/general', static_folder='static/general', @@ -13,6 +15,7 @@ @general_bp.route('/') +@cache.cached(make_cache_key=make_key) def index() -> Response: return render_template('index.html') diff --git a/general/templates/general/base.html b/general/templates/general/base.html index bf919047..b935f7ab 100644 --- a/general/templates/general/base.html +++ b/general/templates/general/base.html @@ -29,6 +29,7 @@ Yoda.user = { username: '{{ g.user }}', }; + Yoda.notifications() {% endif %} {% if g.settings %} Yoda.settings = {{ g.settings | tojson}} @@ -38,6 +39,7 @@ {% else %} Yoda.set_color_mode_auto() {% endif %} + {% block scripts %}{% endblock scripts %} {% endblock head %} diff --git a/general/templates/general/user.html b/general/templates/general/user.html index 865de333..ccdd9b8b 100644 --- a/general/templates/general/user.html +++ b/general/templates/general/user.html @@ -1,11 +1,11 @@ {% if g.user %}
- Notifications {% if g.notifications %}{{ g.notifications }}{% endif %} + Notifications Settings {% if config.get('TOKENS_ENABLED') %} diff --git a/group_manager/group_manager.py b/group_manager/group_manager.py index ec5e7132..11505191 100644 --- a/group_manager/group_manager.py +++ b/group_manager/group_manager.py @@ -6,6 +6,7 @@ from flask import Blueprint, make_response, render_template, request, Response import api +from cache_config import cache, make_key group_manager_bp = Blueprint('group_manager_bp', __name__, template_folder='templates', @@ -67,6 +68,7 @@ def get_subcategories() -> Response: @group_manager_bp.route('/get_schemas', methods=['POST']) +@cache.cached(make_cache_key=make_key) def get_schemas() -> Response: response = api.call('schema_get_schemas', data={}) @@ -130,43 +132,3 @@ def group_update() -> Response: output = make_response({'status': 0 if response['status'] == 'ok' else 1, 'message': response['status_info']}) output.headers["Content-type"] = "application/json" return output - - -@group_manager_bp.route('/group_delete', methods=['POST']) -def group_delete() -> Response: - response = api.call('group_delete', data={'group_name': request.form['group_name']}) - - output = make_response({'status': 0 if response['status'] == 'ok' else 1, 'message': response['status_info']}) - output.headers["Content-type"] = "application/json" - return output - - -@group_manager_bp.route('/user_create', methods=['POST']) -def user_create() -> Response: - response = api.call('group_user_add', data={'username': request.form['user_name'], - 'group_name': request.form['group_name']}) - - output = make_response({'status': 0 if response['status'] == 'ok' else 1, 'message': response['status_info']}) - output.headers["Content-type"] = "application/json" - return output - - -@group_manager_bp.route('/user_update', methods=['POST']) -def user_update() -> Response: - response = api.call('group_user_update_role', data={'username': request.form['user_name'], - 'group_name': request.form['group_name'], - 'new_role': request.form['new_role']}) - - output = make_response({'status': 0 if response['status'] == 'ok' else 1, 'message': response['status_info']}) - output.headers["Content-type"] = "application/json" - return output - - -@group_manager_bp.route('/user_delete', methods=['POST']) -def user_delete() -> Response: - response = api.call('group_remove_user_from_group', data={'username': request.form['user_name'], - 'group_name': request.form['group_name']}) - - output = make_response({'status': 0 if response['status'] == 'ok' else 1, 'message': response['status_info']}) - output.headers["Content-type"] = "application/json" - return output diff --git a/group_manager/static/group_manager/js/group_manager.js b/group_manager/static/group_manager/js/group_manager.js index 0a145d4a..224bd78d 100644 --- a/group_manager/static/group_manager/js/group_manager.js +++ b/group_manager/static/group_manager/js/group_manager.js @@ -502,113 +502,86 @@ async function processImportedRow (row) { } } -async function processUserroleChange (row, actionUrl, newRole, groupName) { +async function processUserroleChange (row, newRole, groupName) { // Process one user at a time to change userrole. const userName = row.attr('data-name') - $.ajax({ - url: actionUrl, - type: 'post', - dataType: 'json', - data: { - group_name: groupName, - user_name: userName, - new_role: newRole - } - }).done(function (result) { - if ('status' in result) { - console.log('User update completed with status ' + result.status) - } - if ('status' in result && result.status === 0) { - // Keep track of which rows have been - row.addClass('update-done') - - // Set the internal administration with latest situation without having to reach for the dbs - Yoda.groupManager.groups[groupName].members[userName].access = newRole - - // when update-done length is equal to active length, all has been dealt with. - // => Data must be reloaded - if ($('#user-list .active').length === $('#user-list .update-done').length) { - // Force-regenerate the user list after completion of the entire process - Yoda.groupManager.deselectGroup() - Yoda.groupManager.selectGroup(groupName) + const result = await Yoda.call('group_user_update_role', { + username: userName, + group_name: groupName, + new_role: newRole + }, { quiet: true, rawResult: true }) - Yoda.set_message('success', 'User roles were updated successfully.') - } - } else { - // Something went wrong - $('#user-list .user.update-pending[data-name="' + Yoda.escapeQuotes(userName) + '"]') - .removeClass('update-pending disabled') - .attr('title', '') - - if ('message' in result) { window.alert(result.message) } else { - window.alert( - 'Error: Could not change the role for the selected member due to an internal error.\n' + - 'Please contact a Yoda administrator' - ) - } + if (result.status === 'ok') { + // Keep track of which rows have been + row.addClass('update-done') + + // Set the internal administration with latest situation without having to reach for the dbs + Yoda.groupManager.groups[groupName].members[userName].access = newRole + + // when update-done length is equal to active length, all has been dealt with. + // => Data must be reloaded + if ($('#user-list .active').length === $('#user-list .update-done').length) { + // Force-regenerate the user list after completion of the entire process + Yoda.groupManager.deselectGroup() + Yoda.groupManager.selectGroup(groupName) + + Yoda.set_message('success', 'User roles were updated successfully.') } - }).fail(function (result) { - Yoda.groupManager.ifRequestNotAborted(result, function () { - window.alert('Error: Could not change the role for the selected member due to an internal error.\nPlease contact a Yoda administrator') - }) - }) + } else { + // Something went wrong + $('#user-list .user.update-pending[data-name="' + Yoda.escapeQuotes(userName) + '"]') + .removeClass('update-pending disabled') + .attr('title', '') + + // Handle error + const errorMessage = result.message || + 'Error: Could not change the role for the selected member due to an internal error.\n' + + 'Please contact a Yoda administrator' + window.alert(errorMessage) + } } -async function removeUserFromGroup (row, actionUrl, groupName) { - // Remove a user from the indicated group as part of mutiple selection of users. +async function removeUserFromGroup (row, groupName) { + // Remove a user from the indicated group as part of multiple selection of users. const userName = row.attr('data-name') - $.ajax({ - url: actionUrl, - type: 'post', - dataType: 'json', - data: { - group_name: groupName, - user_name: userName - } - }).done(function (result) { - if ('status' in result) { console.log('User remove completed with status ' + result.status) } - if ('status' in result && result.status === 0) { - // Mark row as done - row.addClass('remove-done') - - // Update internal administration - delete Yoda.groupManager.groups[groupName].members[userName] - - if ($('#user-list .active').length === $('#user-list .remove-done').length) { - // Force-regenerate the user list after completion of entire process - Yoda.groupManager.deselectGroup() - Yoda.groupManager.selectGroup(groupName) + const result = await Yoda.call('group_remove_user_from_group', { + username: userName, + group_name: groupName + }, { quiet: true, rawResult: true }) - Yoda.set_message('success', 'Users were removed successfully.') - } - } else { - // Something went wrong - if ('message' in result) { window.alert(result.message) } else { - window.alert( - 'Error: Could not remove the selected member from the group due to an internal error.\n' + - 'Please contact a Yoda administrator' - ) - } + if (result.status === 'ok') { + // Mark row as done + row.addClass('remove-done') + + // Update internal administration + delete Yoda.groupManager.groups[groupName].members[userName] + + if ($('#user-list .active').length === $('#user-list .remove-done').length) { + // Force-regenerate the user list after completion of entire process + Yoda.groupManager.deselectGroup() + Yoda.groupManager.selectGroup(groupName) + Yoda.set_message('success', 'Users were removed successfully.') } - }).fail(function (result) { - Yoda.groupManager.ifRequestNotAborted(result, function () { - window.alert('Error: Could not remove the selected member from the group due to an internal error.\nPlease contact a Yoda administrator') - }) - }) + } else { + // Handle error + const errorMessage = result.message || + 'Error: Could not remove the selected member from the group due to an internal error.\n' + + 'Please contact a Yoda administrator' + window.alert(errorMessage) + } } $(function () { // Multiple user role change $('.users.card .update-button').on('click', function (e) { const newRole = $(this).attr('data-target-role') - const actionUrl = $(this).attr('data-action') const groupName = $('#group-list .group.active').attr('data-name') // Step through selected users and update per row $('#user-list .active.user').each(function myFunction () { - processUserroleChange($(this), actionUrl, newRole, groupName) + processUserroleChange($(this), newRole, groupName) }) }) @@ -633,12 +606,11 @@ $(function () { // that.onClickUserDelete($('.users.card .delete-button')[0]); $('#modal-user-delete').modal('hide') - const actionUrl = $('#btn-remove-user-from-group').attr('data-action') const groupName = $('#group-list .group.active').attr('data-name') // Step through selected users and update per row $('#user-list .active.user').each(function myFunction () { - removeUserFromGroup($(this), actionUrl, groupName) + removeUserFromGroup($(this), groupName) }) }) @@ -1924,7 +1896,7 @@ $(function () { /** * \brief Handle a group delete button click event. */ - onClickGroupDelete: function (el) { + onClickGroupDelete: async function (el) { const groupName = $('#group-list .group.active').attr('data-name') const nextGroupName = $('#result-user-search-groups .user-search-result-group.table-active').next().attr('user-search-result-group') @@ -1933,51 +1905,40 @@ $(function () { .attr('title', 'Removal pending') this.deselectGroup() - const that = this + const result = await Yoda.call('group_delete', { + group_name: groupName + }, { quiet: true, rawResult: true }) - $.ajax({ - url: $(el).attr('data-action'), - type: 'post', - dataType: 'json', - data: { - group_name: groupName - } - }).done(function (result) { - if ('status' in result && result.status === 0) { - // Give the user some feedback. - Yoda.storage.session.set('messages', - Yoda.storage.session.get('messages', []).concat({ - type: 'success', - message: 'Removed group ' + groupName + '.' - }) - ) + if (result.status === 'ok') { + // Give the user some feedback. + Yoda.storage.session.set('messages', + Yoda.storage.session.get('messages', []).concat({ + type: 'success', + message: 'Removed group ' + groupName + '.' + }) + ) - if (nextGroupName) { - Yoda.storage.session.set('selected-group', nextGroupName) - } + if (nextGroupName) { + Yoda.storage.session.set('selected-group', nextGroupName) + } - $(window).on('beforeunload', function () { - $(window).scrollTop(0) - }) - window.location.reload(true) - } else { - // Something went wrong. + $(window).on('beforeunload', function () { + $(window).scrollTop(0) + }) + window.location.reload(true) + } else { + // Something went wrong. - // Re-enable group list entry. - $('#group-list .group.delete-pending[data-name="' + Yoda.escapeQuotes(groupName) + '"]').removeClass('delete-pending disabled').attr('title', '') + // Re-enable group list entry. + $('#group-list .group.delete-pending[data-name="' + Yoda.escapeQuotes(groupName) + '"]').removeClass('delete-pending disabled').attr('title', '') - if ('message' in result) { window.alert(result.message) } else { - window.alert( - 'Error: Could not remove the selected group due to an internal error.\n' + - 'Please contact a Yoda administrator' - ) - } + if ('message' in result) { window.alert(result.message) } else { + window.alert( + 'Error: Could not remove the selected group due to an internal error.\n' + + 'Please contact a Yoda administrator' + ) } - }).fail(function (result) { - that.ifRequestNotAborted(result, function () { - window.alert('Error: Could not remove the selected group due to an internal error.\nPlease contact a Yoda administrator') - }) - }) + } }, /** @@ -1991,7 +1952,7 @@ $(function () { * \param el the form element * \param e a submit event */ - onSubmitUserCreate: function (el, e) { + onSubmitUserCreate: async function (el, e) { e.preventDefault() if ($(el).find('input[type="submit"]').hasClass('disabled')) { return } @@ -2017,124 +1978,46 @@ $(function () { const that = this - $.ajax({ - url: $(el).attr('action'), - type: 'post', - dataType: 'json', - data: { - group_name: groupName, - user_name: userName - } - }).done(function (result) { - if ('status' in result) { console.log('User add completed with status ' + result.status) } - if ('status' in result && result.status === 0) { - that.groups[groupName].members[userName] = { - // XXX - access: 'normal' - } - - $(el).find('#f-user-create-name').val(null).trigger('change') - - that.deselectGroup() - that.selectGroup(groupName) - - const $userList = $('#user-list') - const $user = $userList.find('.user[data-name="' + Yoda.escapeQuotes(userName) + '"]') - - // that.selectUser(userName); - that.selectUser($user) - - // Give a visual hint that the user was added. - $('#user-list .user[data-name="' + Yoda.escapeQuotes(userName) + '"]')[0].scrollIntoView({ - block: 'center', - behavior: 'smooth' - }) - $('#user-list .user[data-name="' + Yoda.escapeQuotes(userName) + '"]').addClass('blink-once') + const result = await Yoda.call('group_user_add', { + username: userName, + group_name: groupName + }, { quiet: true, rawResult: true }) - // open the select-user select2 for ease of use - $('.selectify-user-name').trigger('select2:open') - } else { - // Something went wrong. :( - if ('message' in result) { window.alert(result.message) } else { - window.alert( - 'Error: Could not add a member due to an internal error.\n' + - 'Please contact a Yoda administrator' - ) - } + if (result.status === 'ok') { + that.groups[groupName].members[userName] = { + // XXX + access: 'normal' } - $(el).find('input[type="submit"]').removeClass('disabled').val('Add') - }).fail(function (result) { - that.ifRequestNotAborted(result, function () { - window.alert('Error: Could not add a member due to an internal error.\nPlease contact a Yoda administrator') - $(el).find('input[type="submit"]').removeClass('disabled').val('Add') - }) - }) - }, - /** - * \brief Handle a change role button click event. - * - * `this` is assumed to be the groupManager object, not the form element - * that was submitted. - * - * \param el - * \param e - */ - onClickUserUpdate: function (el, e) { - const that = this - - const groupName = $('#group-list .group.active').attr('data-name') - const userName = $('#user-list .user.active').attr('data-name') - - $('#user-list .user.active') - .addClass('update-pending disabled') - .attr('title', 'Update pending') + $(el).find('#f-user-create-name').val(null).trigger('change') - // Get the new role name from the button element before we deselect the user. - const newRole = $(el).attr('data-target-role') - - this.deselectUser() - - $.ajax({ - url: $(el).attr('data-action'), - type: 'post', - dataType: 'json', - data: { - group_name: groupName, - user_name: userName, - new_role: newRole - } - }).done(function (result) { - if ('status' in result) { console.log('User update completed with status ' + result.status) } - if ('status' in result && result.status === 0) { - // Update user role. - that.groups[groupName].members[userName].access = newRole + that.deselectGroup() + that.selectGroup(groupName) - // Force-regenerate the user list. - that.deselectGroup() - that.selectGroup(groupName) + const $userList = $('#user-list') + const $user = $userList.find('.user[data-name="' + Yoda.escapeQuotes(userName) + '"]') - // Give a visual hint that the user was updated. - $('#user-list .user[data-name="' + Yoda.escapeQuotes(userName) + '"]').addClass('blink-once') - } else { - // Something went wrong. :( + // that.selectUser(userName); + that.selectUser($user) - $('#user-list .user.update-pending[data-name="' + Yoda.escapeQuotes(userName) + '"]') - .removeClass('update-pending disabled') - .attr('title', '') + // Give a visual hint that the user was added. + $('#user-list .user[data-name="' + Yoda.escapeQuotes(userName) + '"]')[0].scrollIntoView({ + block: 'center', + behavior: 'smooth' + }) + $('#user-list .user[data-name="' + Yoda.escapeQuotes(userName) + '"]').addClass('blink-once') - if ('message' in result) { window.alert(result.message) } else { - window.alert( - 'Error: Could not change the role for the selected member due to an internal error.\n' + - 'Please contact a Yoda administrator' - ) - } + // open the select-user select2 for ease of use + $('.selectify-user-name').trigger('select2:open') + } else { + // Something went wrong. :( + if ('message' in result) { window.alert(result.message) } else { + window.alert( + 'Error: Could not add a member due to an internal error.\n' + + 'Please contact a Yoda administrator' + ) } - }).fail(function (result) { - that.ifRequestNotAborted(result, function () { - window.alert('Error: Could not change the role for the selected member due to an internal error.\nPlease contact a Yoda administrator') - }) - }) + } }, /** diff --git a/group_manager/templates/group_manager/index.html b/group_manager/templates/group_manager/index.html index 643db1c1..359a6d66 100644 --- a/group_manager/templates/group_manager/index.html +++ b/group_manager/templates/group_manager/index.html @@ -302,7 +302,7 @@

Group manager

- +
@@ -323,7 +323,7 @@

Group manager