diff --git a/AUTHORS b/AUTHORS index db108ce63..c6c6c7b5a 100644 --- a/AUTHORS +++ b/AUTHORS @@ -12,6 +12,7 @@ in alphabetic order by first name - Debajyoti Dasgupta - Hrithik Kumar Verma - Isabell Krisch +- Jan Eisermann - Jatin Jain - Jens-Uwe Grooß - Jörn Ungermann diff --git a/mslib/mscolab/app/__init__.py b/mslib/mscolab/app/__init__.py index 2387c8422..67e4341d1 100644 --- a/mslib/mscolab/app/__init__.py +++ b/mslib/mscolab/app/__init__.py @@ -29,49 +29,43 @@ import sqlalchemy from flask_migrate import Migrate -from flask import Flask +from flask import Flask, current_app import mslib -from flask import render_template, send_from_directory, send_file, url_for, abort +from flask import url_for from flask_sqlalchemy import SQLAlchemy + +from mslib.mscolab.blueprints.docs import DOCS_BP from mslib.mscolab.conf import mscolab_settings from mslib.utils import prefix_route, release_info -from mslib.msui.icons import icons -from mslib.utils.get_content import get_content +from mslib.utils.file_exists import file_exists from xstatic.main import XStatic -message, update = release_info.check_for_new_release() -if update: - logging.warning(message) - - -def file_exists(filepath=None): - try: - return os.path.isfile(filepath) - except TypeError: - return False - DOCS_SERVER_PATH = os.path.dirname(os.path.abspath(mslib.__file__)) -DOCS_STATIC_DIR = os.path.join(DOCS_SERVER_PATH, 'static') +DOCS_BLUEPRINTS_DIR = os.path.join(DOCS_SERVER_PATH, 'blueprints') +DOCS_STATIC_DIR = os.path.join(DOCS_BLUEPRINTS_DIR, 'static') DOCS_IMG_DIR = os.path.join(DOCS_STATIC_DIR, 'img') DOCS_DOCS_DIR = os.path.join(DOCS_STATIC_DIR, 'docs') +DOCS_TEMPLATES_DIR = os.path.join(DOCS_STATIC_DIR, 'templates') # This can be used to set a location by SCRIPT_NAME for testing. e.g. export SCRIPT_NAME=/demo/ SCRIPT_NAME = os.environ.get('SCRIPT_NAME', '/') + +message, update = release_info.check_for_new_release() +if update: + logging.warning(message) + + # in memory database for testing # app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' -APP = Flask(__name__, template_folder=os.path.join(DOCS_STATIC_DIR, 'templates')) +APP = Flask(__name__, template_folder=os.path.join(DOCS_TEMPLATES_DIR)) APP.config.from_object(mscolab_settings) # Expose docs path for callers/tests and make it part of Flask config for consistency. APP.config['DOCS_SERVER_PATH'] = DOCS_SERVER_PATH APP.route = prefix_route(APP.route, SCRIPT_NAME) -APP.jinja_env.globals.update(file_exists=file_exists) -APP.jinja_env.globals["imprint"] = APP.config['IMPRINT'] -APP.jinja_env.globals["gdpr"] = APP.config['GDPR'] - def _xstatic(name): mod_names = [ @@ -102,86 +96,9 @@ def create_app(imprint=None, gdpr=None): APP.jinja_env.globals.update(file_exists=file_exists) APP.jinja_env.globals["imprint"] = imprint_file APP.jinja_env.globals["gdpr"] = gdpr_file - - @APP.route('/xstatic//') - def files(name, filename): - base_path = _xstatic(name) - if base_path is None: - abort(404) - if not filename: - abort(404) - return send_from_directory(base_path, filename) - - @APP.route('/mss_theme/img/') - def mss_theme(filename): - base_path = os.path.join(DOCS_IMG_DIR) - return send_from_directory(base_path, filename) - APP.jinja_env.globals.update(get_topmenu=get_topmenu) - @APP.route("/index") - def index(): - return render_template("/index.html") - - @APP.route("/mss/about") - @APP.route("/mss") - def about(): - _file = os.path.join(DOCS_DOCS_DIR, 'about.md') - img_url = url_for('overview') - md_overrides = ('![image](/mss/overview.png)', f'![image]({img_url})') - - html_overrides = ('image', - 'image') - content = get_content(_file, md_overrides=md_overrides, html_overrides=html_overrides) - return render_template("/content.html", act="about", content=content) - - @APP.route("/mss/install") - def install(): - _file = os.path.join(DOCS_DOCS_DIR, 'installation.md') - content = get_content(_file) - return render_template("/content.html", act="install", content=content) - - @APP.route("/mss/help") - def help(): # noqa: A001 - _file = os.path.join(DOCS_DOCS_DIR, 'help.md') - html_overrides = ('Waypoint Tutorial', - 'Waypoint Tutorial') - content = get_content(_file, html_overrides=html_overrides) - return render_template("/content.html", act="help", content=content) - - @APP.route("/mss/imprint") - def imprint(): - if file_exists(imprint_file): - content = get_content(imprint_file) - return render_template("/content.html", act="imprint", content=content) - else: - return "" - - @APP.route("/mss/gdpr") - def gdpr(): - if file_exists(gdpr_file): - content = get_content(gdpr_file) - return render_template("/content.html", act="gdpr", content=content) - else: - return "" - - @APP.route('/mss/favicon.ico') - def favicons(): - base_path = icons("16x16", "favicon.ico") - return send_file(base_path) - - @APP.route('/mss/logo.png') - def logo(): - base_path = icons("64x64", "mss-logo.png") - return send_file(base_path) - - @APP.route('/mss/overview.png') - def overview(): - base_path = os.path.join(DOCS_IMG_DIR, 'wise12_overview.png') - return send_file(base_path) - + APP.register_blueprint(DOCS_BP) return APP @@ -205,10 +122,10 @@ def overview(): def get_topmenu(): menu = [ - (url_for('index'), 'Mission Support System', - ((url_for('about'), 'About'), - (url_for('install'), 'Install'), - (url_for('help'), 'Help'), + (url_for('docs.index'), 'Mission Support System', + ((url_for('docs.about'), 'About'), + (url_for('docs.install'), 'Install'), + (url_for('docs.help'), 'Help'), )), ] return menu diff --git a/mslib/mscolab/blueprints/auth/__init__.py b/mslib/mscolab/blueprints/auth/__init__.py new file mode 100644 index 000000000..f7b38698f --- /dev/null +++ b/mslib/mscolab/blueprints/auth/__init__.py @@ -0,0 +1,358 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mscolab.blueprints.auth + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Auth Blueprint for server for mscolab module + + This file is part of MSS. + + :copyright: Copyright 2019 Shivashis Padhi + :copyright: Copyright 2019-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" + +import datetime +import json +import logging +import secrets + +from flask import Blueprint, request, url_for, render_template, jsonify, flash, redirect +from flask_httpauth import HTTPBasicAuth +from flask.wrappers import Response +from saml2 import BINDING_HTTP_REDIRECT, BINDING_HTTP_POST +from saml2.metadata import create_metadata_string + +from mslib.mscolab.conf import setup_saml2_backend +from mslib.mscolab.forms import ResetPasswordForm, ResetRequestForm +from mslib.mscolab.models import User +from mslib.mscolab.app import APP +from mslib.utils import conditional_decorator +from mslib.utils.auth import check_login, register_user, generate_confirmation_token, send_email, confirm_token, \ + get_idp_entity_id, create_or_update_idp_user + +AUTH_BP = Blueprint('auth', __name__, template_folder='templates') + +auth_basic_auth = HTTPBasicAuth() + + +@AUTH_BP.route("/status") +@conditional_decorator(auth_basic_auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) +def hello(): + if request.authorization is not None: + if APP.__dict__.get('enable_basic_http_authentication', False): + auth_basic_auth.login_required() + return json.dumps({ + 'message': "Mscolab server", + 'use_saml2': APP.config['USE_SAML2'], + 'direct_login': APP.DIRECT_LOGIN + }) + return json.dumps({ + 'message': "Mscolab server", + 'use_saml2': APP.config['USE_SAML2'], + 'direct_login': APP.config['DIRECT_LOGIN'] + }) + else: + return json.dumps({ + 'message': "Mscolab server", + 'use_saml2': APP.config['USE_SAML2'], + 'direct_login': APP.config['DIRECT_LOGIN'] + }) + + +@AUTH_BP.route('/token', methods=["POST"]) +@conditional_decorator(auth_basic_auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) +def get_auth_token(): + emailid = request.form['email'] + password = request.form['password'] + user = check_login(emailid, password) + if user is not False: + if APP.config['MAIL_ENABLED']: + if user.confirmed: + token = user.generate_auth_token() + return json.dumps({ + 'token': token, + 'user': {'username': user.username, 'id': user.id, 'fullname': user.fullname}}) + else: + return "False" + else: + token = user.generate_auth_token() + return json.dumps({ + 'token': token, + 'user': {'username': user.username, 'id': user.id, 'fullname': user.fullname}}) + else: + logging.debug("Unauthorized user: %s", emailid) + return "False" + + +@AUTH_BP.route('/test_authorized') +def authorized(): + token = request.args.get('token', request.form.get('token')) + user = User.verify_auth_token(token) + if user is not None: + if APP.config['MAIL_ENABLED']: + if user.confirmed is False: + return "False" + else: + return "True" + else: + return "True" + else: + return "False" + + +@AUTH_BP.route("/register", methods=["POST"]) +@conditional_decorator(auth_basic_auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) +def user_register_handler(): + email = request.form['email'] + password = request.form['password'] + username = request.form['username'] + fullname = request.form['fullname'] + result = register_user(email, password, username, fullname) + status_code = 200 + try: + if result["success"]: + status_code = 201 + if APP.config['MAIL_ENABLED']: + status_code = 204 + token = generate_confirmation_token(email) + confirm_url = url_for('auth.user.confirm_email', token=token, _external=True) + html = render_template('auth/user/activate.html', username=username, confirm_url=confirm_url) + subject = "MSColab Please confirm your email" + send_email(email, subject, html) + except TypeError: + result, status_code = {"success": False}, 401 + return jsonify(result), status_code + + +@AUTH_BP.route('/confirm/') +def confirm_email(token): + if APP.config['MAIL_ENABLED']: + try: + email = confirm_token(token) + except TypeError: + return jsonify({"success": False}), 401 + if email is False: + return jsonify({"success": False}), 401 + user = User.query.filter_by(emailid=email).first_or_404() + if user.confirmed: + return render_template('auth/user/confirmed.html', username=user.username) + else: + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + fm.modify_user(user, attribute="confirmed_on", value=datetime.datetime.now(tz=datetime.timezone.utc)) + fm.modify_user(user, attribute="confirmed", value=True) + return render_template('auth/user/confirmed.html', username=user.username) + else: + logging.warning("To send emails, the value of MAIL_ENABLED in conf.py should be set to True.") + return render_template('auth/errors/403.html'), 403 + +@AUTH_BP.route('/reset_password/', methods=['GET', 'POST']) +def reset_password(token): + try: + email = confirm_token(token, expiration=86400) + except TypeError: + return jsonify({"success": False}), 401 + if email is False: + flash("Sorry, your token has expired or is invalid! We will need to resend your authentication email", + 'category_info') + return render_template('auth/user/status_password.html', uri={"path": "reset_request", "name": "Resend " + "authentication " + "email"}) + user = User.query.filter_by(emailid=email).first_or_404() + form = ResetPasswordForm() + if form.validate_on_submit(): + try: + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + user.hash_password(form.confirm_password.data) + fm.modify_user(user, "confirmed", True) + flash('Password reset Success. Please login by the user interface.', 'category_success') + return render_template('auth/user/status_password.html') + except IOError: + flash('Password reset failed. Please try again later', 'category_danger') + return render_template('auth/user/reset_password.html', form=form) + + +@AUTH_BP.route("/reset_request", methods=['GET', 'POST']) +def reset_request(): + if APP.config['MAIL_ENABLED']: + form = ResetRequestForm() + if form.validate_on_submit(): + # Check whether user exists or not based on the db + user = User.query.filter_by(emailid=form.email.data).first() + if user: + try: + username = user.username + token = generate_confirmation_token(form.email.data) + reset_password_url = url_for('auth.user.reset_password', token=token, _external=True) + html = render_template('auth/user/reset_confirmation.html', + reset_password_url=reset_password_url, username=username) + subject = "MSColab Password reset request" + send_email(form.email.data, subject, html) + flash('An email was sent if this user account exists', 'category_success') + return render_template('auth/user/status_password.html') + except IOError: + flash('''We apologize, but it seems that there was an issue sending + your request email. Please try again later.''', 'category_info') + else: + flash('An email was sent if this user account exists', 'category_success') + return render_template('auth/user/status_password.html') + return render_template('auth/user/reset_request.html', form=form) + else: + logging.warning("To send emails, the value of `MAIL_ENABLED` in `conf.py` should be set to True.") + return render_template('auth/errors/403.html'), 403 + + +if APP.config['USE_SAML2']: + # setup idp login config + setup_saml2_backend() + + # set routes for SSO + @AUTH_BP.route('/available_idps/', methods=['GET']) + def available_idps(): + """ + This function checks if IDP (Identity Provider) is enabled in the mscolab_settings module. + If IDP is enabled, it retrieves the configured IDPs from setup_saml2_backend.CONFIGURED_IDPS + and renders the 'idp/available_idps.html' template with the list of configured IDPs. + """ + configured_idps = setup_saml2_backend.CONFIGURED_IDPS + return render_template('auth/idp/available_idps.html', configured_idps=configured_idps), 200 + + @AUTH_BP.route("/idp_login/", methods=['POST']) + def idp_login(): + """Handle the login process for the user by selected IDP""" + selected_idp = request.form.get('selectedIdentityProvider') + sp_config = None + for config in setup_saml2_backend.CONFIGURED_IDPS: + if selected_idp == config['idp_identity_name']: + sp_config = config['idp_data']['saml2client'] + break + + try: + _, response_binding = sp_config.config.getattr("endpoints", "sp")[ + "assertion_consumer_service" + ][0] + entity_id = get_idp_entity_id(selected_idp) + _, binding, http_args = sp_config.prepare_for_negotiated_authenticate( + entityid=entity_id, + response_binding=response_binding, + ) + if binding == BINDING_HTTP_REDIRECT: + headers = dict(http_args["headers"]) + return redirect(str(headers["Location"]), code=303) + return Response(http_args["data"], headers=http_args["headers"]) + except (NameError, AttributeError): + return render_template('auth/errors/403.html'), 403 + + def create_acs_post_handler(config): + """ + Create acs_post_handler function for the given idp_config. + """ + def acs_post_handler(): + """ + Function to handle SAML authentication response. + """ + try: + outstanding_queries = {} + binding = BINDING_HTTP_POST + authn_response = config['idp_data']['saml2client'].parse_authn_request_response( + request.form["SAMLResponse"], binding, outstanding=outstanding_queries + ) + email = None + username = None + + try: + email = authn_response.ava["email"][0] + username = authn_response.ava["givenName"][0] + token = generate_confirmation_token(email) + except (NameError, AttributeError, KeyError): + try: + # Initialize an empty dictionary to store attribute values + attributes = {} + + # Loop through attribute statements + for attribute_statement in authn_response.assertion.attribute_statement: + for attribute in attribute_statement.attribute: + attribute_name = attribute.name + attribute_value = \ + attribute.attribute_value[0].text if attribute.attribute_value else None + attributes[attribute_name] = attribute_value + + # Extract the email and givenname attributes + email = attributes["email"] + username = attributes["givenName"] + token = generate_confirmation_token(email) + except (NameError, AttributeError, KeyError): + return render_template('auth/errors/403.html'), 403 + + if email is not None and username is not None: + idp_user_db_state = create_or_update_idp_user(email, + username, token, idp_config['idp_identity_name']) + if idp_user_db_state: + return render_template('auth/idp/idp_login_success.html', token=token), 200 + return render_template('auth/errors/500.html'), 500 + return render_template('auth/errors/500.html'), 500 + except (NameError, AttributeError, KeyError): + return render_template('auth/errors/403.html'), 403 + return acs_post_handler + + # Implementation for handling configured SAML assertion consumer endpoints + for idp_config in setup_saml2_backend.CONFIGURED_IDPS: + try: + for assertion_consumer_endpoint in idp_config['idp_data']['assertion_consumer_endpoints']: + # Dynamically add the route for the current endpoint + APP.add_url_rule(f'/{assertion_consumer_endpoint}/', assertion_consumer_endpoint, + create_acs_post_handler(idp_config), methods=['POST']) + except (NameError, AttributeError, KeyError) as ex: + logging.warning("USE_SAML2 is %s, Failure is: %s", APP.config['USE_SAML2'], ex) + + @AUTH_BP.route('/idp_login_auth/', methods=['POST']) + def idp_login_auth(): + """Handle the SAML authentication validation of client application.""" + try: + data = request.get_json() + token = data.get('token') + email = confirm_token(token, expiration=1200) + if email: + user = check_login(email, token) + if user: + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + random_token = secrets.token_hex(16) + user.hash_password(random_token) + fm.modify_user(user, action="update_idp_user") + return json.dumps({ + "success": True, + 'token': random_token, + 'user': {'username': user.username, 'id': user.id, 'emailid': user.emailid} + }) + return jsonify({"success": False}), 401 + return jsonify({"success": False}), 401 + except TypeError: + return jsonify({"success": False}), 401 + + @AUTH_BP.route("/metadata/", methods=['GET']) + def metadata(idp_identity_name): + """Return the SAML metadata XML for the requested IDP""" + for config in setup_saml2_backend.CONFIGURED_IDPS: + if idp_identity_name == config['idp_identity_name']: + sp_config = config['idp_data']['saml2client'] + metadata_string = create_metadata_string( + None, sp_config.config, 4, None, None, None, None, None + ).decode("utf-8") + return Response(metadata_string, mimetype="text/xml") + return render_template('auth/errors/404.html'), 404 diff --git a/mslib/static/templates/errors/403.html b/mslib/mscolab/blueprints/auth/templates/auth/errors/403.html similarity index 100% rename from mslib/static/templates/errors/403.html rename to mslib/mscolab/blueprints/auth/templates/auth/errors/403.html diff --git a/mslib/static/templates/errors/404.html b/mslib/mscolab/blueprints/auth/templates/auth/errors/404.html similarity index 100% rename from mslib/static/templates/errors/404.html rename to mslib/mscolab/blueprints/auth/templates/auth/errors/404.html diff --git a/mslib/static/templates/errors/500.html b/mslib/mscolab/blueprints/auth/templates/auth/errors/500.html similarity index 100% rename from mslib/static/templates/errors/500.html rename to mslib/mscolab/blueprints/auth/templates/auth/errors/500.html diff --git a/mslib/static/templates/idp/available_idps.html b/mslib/mscolab/blueprints/auth/templates/auth/idp/available_idps.html similarity index 100% rename from mslib/static/templates/idp/available_idps.html rename to mslib/mscolab/blueprints/auth/templates/auth/idp/available_idps.html diff --git a/mslib/static/templates/idp/idp_login_success.html b/mslib/mscolab/blueprints/auth/templates/auth/idp/idp_login_success.html similarity index 100% rename from mslib/static/templates/idp/idp_login_success.html rename to mslib/mscolab/blueprints/auth/templates/auth/idp/idp_login_success.html diff --git a/mslib/static/templates/user/activate.html b/mslib/mscolab/blueprints/auth/templates/auth/user/activate.html similarity index 100% rename from mslib/static/templates/user/activate.html rename to mslib/mscolab/blueprints/auth/templates/auth/user/activate.html diff --git a/mslib/static/templates/user/confirmed.html b/mslib/mscolab/blueprints/auth/templates/auth/user/confirmed.html similarity index 100% rename from mslib/static/templates/user/confirmed.html rename to mslib/mscolab/blueprints/auth/templates/auth/user/confirmed.html diff --git a/mslib/static/templates/user/reset_confirmation.html b/mslib/mscolab/blueprints/auth/templates/auth/user/reset_confirmation.html similarity index 100% rename from mslib/static/templates/user/reset_confirmation.html rename to mslib/mscolab/blueprints/auth/templates/auth/user/reset_confirmation.html diff --git a/mslib/static/templates/user/reset_password.html b/mslib/mscolab/blueprints/auth/templates/auth/user/reset_password.html similarity index 100% rename from mslib/static/templates/user/reset_password.html rename to mslib/mscolab/blueprints/auth/templates/auth/user/reset_password.html diff --git a/mslib/static/templates/user/reset_request.html b/mslib/mscolab/blueprints/auth/templates/auth/user/reset_request.html similarity index 100% rename from mslib/static/templates/user/reset_request.html rename to mslib/mscolab/blueprints/auth/templates/auth/user/reset_request.html diff --git a/mslib/static/templates/user/status.html b/mslib/mscolab/blueprints/auth/templates/auth/user/status_password.html similarity index 94% rename from mslib/static/templates/user/status.html rename to mslib/mscolab/blueprints/auth/templates/auth/user/status_password.html index 37f14b586..04c3b03c6 100644 --- a/mslib/static/templates/user/status.html +++ b/mslib/mscolab/blueprints/auth/templates/auth/user/status_password.html @@ -32,7 +32,7 @@

Reset Password

{% if uri is defined %}

Click here to - {{uri.name}} + {{uri.name}}

{% endif %} diff --git a/mslib/mscolab/blueprints/chat/__init__.py b/mslib/mscolab/blueprints/chat/__init__.py new file mode 100644 index 000000000..e79a4771a --- /dev/null +++ b/mslib/mscolab/blueprints/chat/__init__.py @@ -0,0 +1,94 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mscolab.blueprints.chat + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Chat Blueprint for server for mscolab module + + This file is part of MSS. + + :copyright: Copyright 2019 Shivashis Padhi + :copyright: Copyright 2019-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" + +import json + +import werkzeug +from flask import Blueprint, request, g, jsonify, abort, send_from_directory + +from mslib.mscolab.app import APP +from mslib.mscolab.message_type import MessageType +from mslib.mscolab.utils import get_message_dict +from mslib.utils.auth import verify_user + +CHAT_BP = Blueprint('chat', __name__) + + +@CHAT_BP.route("/messages", methods=["GET"]) +@verify_user +def messages(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + user = g.user + op_id = request.args.get("op_id", request.form.get("op_id", None)) + + if fm.is_member(user.id, op_id): + cm = getConfig()[2] + timestamp = request.args.get("timestamp", request.form.get("timestamp", "1970-01-01T00:00:00+00:00")) + chat_messages = cm.get_messages(op_id, timestamp) + return jsonify({"messages": chat_messages}) + return "False" + + +@CHAT_BP.route("/message_attachment", methods=["POST"]) +@verify_user +def message_attachment(): + user = g.user + op_id = request.form.get("op_id", None) + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + if fm.is_member(user.id, op_id): + file = request.files['file'] + message_type = MessageType(int(request.form.get("message_type"))) + user = g.user + users = fm.fetch_users_without_permission(int(op_id), user.id) + if users is False: + return jsonify({"success": False, "message": "Could not send message. No file uploaded."}) + if file is not None: + static_file_path = fm.upload_file(file, subfolder=str(op_id), include_prefix=True) + if static_file_path is not None: + cm = getConfig()[2] + sockio = getConfig()[1] + new_message = cm.add_message(user, static_file_path, op_id, message_type) + new_message_dict = get_message_dict(new_message) + sockio.emit('chat-message-client', json.dumps(new_message_dict)) + return jsonify({"success": True, "path": static_file_path}) + else: + return "False" + return jsonify({"success": False, "message": "Could not send message. No file uploaded."}) + # normal use case never gets to this + return "False" + + +@CHAT_BP.route('/uploads//', methods=["GET"]) +def uploads(name=None, filename=None): + base_path = APP.config['UPLOAD_FOLDER'] + if name is None: + abort(404) + if filename is None: + abort(404) + return send_from_directory(base_path, werkzeug.security.safe_join("", name, filename)) diff --git a/mslib/mscolab/blueprints/docs/__init__.py b/mslib/mscolab/blueprints/docs/__init__.py new file mode 100644 index 000000000..333b69a80 --- /dev/null +++ b/mslib/mscolab/blueprints/docs/__init__.py @@ -0,0 +1,150 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mscolab.blueprints.docs + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Docs Blueprint for app module of mscolab + + This file is part of MSS. + + :copyright: Copyright 2016-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" + +import os +from functools import wraps + +from flask import Blueprint, abort, send_from_directory, render_template, url_for, send_file, current_app +from flask_httpauth import HTTPBasicAuth + +from mslib.msui.icons import icons +from mslib.utils.file_exists import file_exists +from mslib.utils.get_content import get_content + +DOCS_SERVER_PATH = os.path.dirname(os.path.abspath(__file__)) +DOCS_STATIC_DIR = os.path.join(DOCS_SERVER_PATH, 'static') +DOCS_IMG_DIR = os.path.join(DOCS_STATIC_DIR, 'img') +DOCS_DOCS_DIR = os.path.join(DOCS_STATIC_DIR, 'docs') + +DOCS_BP = Blueprint("docs", __name__, template_folder='templates', static_folder='static', static_url_path='/static') +auth_basic_auth = HTTPBasicAuth() + + +def optional_auth(f): + @wraps(f) + def decorated(*args, **kwargs): + if current_app.config.get('enable_basic_http_authentication', False): + return auth_basic_auth.login_required(f)(*args, **kwargs) + return f(*args, **kwargs) + + return decorated + + +@DOCS_BP.route('/') +@optional_auth +def home(): + return render_template("docs/index.html") + + +@DOCS_BP.route('/xstatic//') +def files(name, filename): + from mslib.mscolab.app import _xstatic + base_path = _xstatic(name) + if base_path is None: + abort(404) + if not filename: + abort(404) + return send_from_directory(base_path, filename) + + +@DOCS_BP.route('/mss_theme/img/') +def mss_theme(filename): + base_path = os.path.join(DOCS_IMG_DIR) + return send_from_directory(base_path, filename) + + +@DOCS_BP.route("/index") +def index(): + return render_template("docs/index.html") + + +@DOCS_BP.route("/mss/about") +@DOCS_BP.route("/mss") +def about(): + _file = os.path.join(DOCS_DOCS_DIR, 'about.md') + img_url = url_for('docs.overview') + md_overrides = ('![image](/mss/overview.png)', f'![image]({img_url})') + + html_overrides = ('image', + 'image') + content = get_content(_file, md_overrides=md_overrides, html_overrides=html_overrides) + return render_template("docs/content.html", act="about", content=content) + + +@DOCS_BP.route("/mss/install") +def install(): + _file = os.path.join(DOCS_DOCS_DIR, 'installation.md') + content = get_content(_file) + return render_template("docs/content.html", act="install", content=content) + + +@DOCS_BP.route("/mss/help") +def help(): # noqa: A001 + _file = os.path.join(DOCS_DOCS_DIR, 'help.md') + html_overrides = ('Waypoint Tutorial', + 'Waypoint Tutorial') + content = get_content(_file, html_overrides=html_overrides) + return render_template("docs/content.html", act="help", content=content) + + +@DOCS_BP.route("/mss/imprint") +def imprint(): + imprint_file = current_app.config.get('IMPRINT', None) + if imprint_file is not None and file_exists(imprint_file): + content = get_content(imprint_file) + return render_template("docs/content.html", act="imprint", content=content) + else: + return "" + + +@DOCS_BP.route("/mss/gdpr") +def gdpr(): + gdpr_file = current_app.config.get('GDPR', None) + if gdpr_file is not None and file_exists(gdpr_file): + content = get_content(gdpr_file) + return render_template("docs/content.html", act="gdpr", content=content) + else: + return "" + + +@DOCS_BP.route('/mss/favicon.ico') +def favicons(): + base_path = icons("16x16", "favicon.ico") + return send_file(base_path) + + +@DOCS_BP.route('/mss/logo.png') +def logo(): + base_path = icons("64x64", "mss-logo.png") + return send_file(base_path) + + +@DOCS_BP.route('/mss/overview.png') +def overview(): + base_path = os.path.join(DOCS_IMG_DIR, 'wise12_overview.png') + return send_file(base_path) diff --git a/mslib/static/docs/about.md b/mslib/mscolab/blueprints/docs/static/docs/about.md similarity index 100% rename from mslib/static/docs/about.md rename to mslib/mscolab/blueprints/docs/static/docs/about.md diff --git a/mslib/static/docs/help.md b/mslib/mscolab/blueprints/docs/static/docs/help.md similarity index 100% rename from mslib/static/docs/help.md rename to mslib/mscolab/blueprints/docs/static/docs/help.md diff --git a/mslib/static/docs/installation.md b/mslib/mscolab/blueprints/docs/static/docs/installation.md similarity index 100% rename from mslib/static/docs/installation.md rename to mslib/mscolab/blueprints/docs/static/docs/installation.md diff --git a/mslib/static/img/README b/mslib/mscolab/blueprints/docs/static/img/README similarity index 100% rename from mslib/static/img/README rename to mslib/mscolab/blueprints/docs/static/img/README diff --git a/mslib/static/img/cirrus_hl_2021.png b/mslib/mscolab/blueprints/docs/static/img/cirrus_hl_2021.png similarity index 100% rename from mslib/static/img/cirrus_hl_2021.png rename to mslib/mscolab/blueprints/docs/static/img/cirrus_hl_2021.png diff --git a/mslib/static/img/emerge_2017.jpeg b/mslib/mscolab/blueprints/docs/static/img/emerge_2017.jpeg similarity index 100% rename from mslib/static/img/emerge_2017.jpeg rename to mslib/mscolab/blueprints/docs/static/img/emerge_2017.jpeg diff --git a/mslib/static/img/phileas_2023.jpeg b/mslib/mscolab/blueprints/docs/static/img/phileas_2023.jpeg similarity index 100% rename from mslib/static/img/phileas_2023.jpeg rename to mslib/mscolab/blueprints/docs/static/img/phileas_2023.jpeg diff --git a/mslib/static/img/polstracc_2016.jpeg b/mslib/mscolab/blueprints/docs/static/img/polstracc_2016.jpeg similarity index 100% rename from mslib/static/img/polstracc_2016.jpeg rename to mslib/mscolab/blueprints/docs/static/img/polstracc_2016.jpeg diff --git a/mslib/static/img/publicpreview.jpeg b/mslib/mscolab/blueprints/docs/static/img/publicpreview.jpeg similarity index 100% rename from mslib/static/img/publicpreview.jpeg rename to mslib/mscolab/blueprints/docs/static/img/publicpreview.jpeg diff --git a/mslib/static/img/southtrac_2019.jpeg b/mslib/mscolab/blueprints/docs/static/img/southtrac_2019.jpeg similarity index 100% rename from mslib/static/img/southtrac_2019.jpeg rename to mslib/mscolab/blueprints/docs/static/img/southtrac_2019.jpeg diff --git a/mslib/static/img/stratoclim_2017.jpeg b/mslib/mscolab/blueprints/docs/static/img/stratoclim_2017.jpeg similarity index 100% rename from mslib/static/img/stratoclim_2017.jpeg rename to mslib/mscolab/blueprints/docs/static/img/stratoclim_2017.jpeg diff --git a/mslib/static/img/wise12_overview.png b/mslib/mscolab/blueprints/docs/static/img/wise12_overview.png similarity index 100% rename from mslib/static/img/wise12_overview.png rename to mslib/mscolab/blueprints/docs/static/img/wise12_overview.png diff --git a/mslib/static/img/wise_2017.jpeg b/mslib/mscolab/blueprints/docs/static/img/wise_2017.jpeg similarity index 100% rename from mslib/static/img/wise_2017.jpeg rename to mslib/mscolab/blueprints/docs/static/img/wise_2017.jpeg diff --git a/mslib/static/templates/content.html b/mslib/mscolab/blueprints/docs/templates/docs/content.html similarity index 100% rename from mslib/static/templates/content.html rename to mslib/mscolab/blueprints/docs/templates/docs/content.html diff --git a/mslib/static/templates/index.html b/mslib/mscolab/blueprints/docs/templates/docs/index.html similarity index 100% rename from mslib/static/templates/index.html rename to mslib/mscolab/blueprints/docs/templates/docs/index.html diff --git a/mslib/static/templates/footer.html b/mslib/mscolab/blueprints/docs/templates/footer.html similarity index 92% rename from mslib/static/templates/footer.html rename to mslib/mscolab/blueprints/docs/templates/footer.html index b80c0fd98..7dcda2063 100644 --- a/mslib/static/templates/footer.html +++ b/mslib/mscolab/blueprints/docs/templates/footer.html @@ -17,13 +17,13 @@
{% if file_exists(imprint) %} -
+

Imprint
{% endif %} {% if file_exists(gdpr) %} -
+

GDPR
{% endif %} diff --git a/mslib/static/templates/theme.html b/mslib/mscolab/blueprints/docs/templates/theme.html similarity index 70% rename from mslib/static/templates/theme.html rename to mslib/mscolab/blueprints/docs/templates/theme.html index d094472b4..05226bb30 100644 --- a/mslib/static/templates/theme.html +++ b/mslib/mscolab/blueprints/docs/templates/theme.html @@ -8,9 +8,9 @@ - + Mission Support System Collaboration Platform - +
@@ -19,11 +19,12 @@
  • - logo Mission Support System + logo Mission Support System
  • {% for href, caption, submenu in get_topmenu(): %} {% if submenu[0] %}
  • - {{ caption }} +
    • {% for href, caption in submenu: %}
    • @@ -55,19 +56,17 @@ ================================================== --> - - diff --git a/mslib/mscolab/blueprints/operation/__init__.py b/mslib/mscolab/blueprints/operation/__init__.py new file mode 100644 index 000000000..d42df74c9 --- /dev/null +++ b/mslib/mscolab/blueprints/operation/__init__.py @@ -0,0 +1,356 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mscolab.blueprints.operation + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Operation Blueprint for server for mscolab module + + This file is part of MSS. + + :copyright: Copyright 2019 Shivashis Padhi + :copyright: Copyright 2019-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" + +import datetime +import json + +from flask import Blueprint, request, g, jsonify + +from mslib.mscolab.models import Change +from mslib.utils.auth import verify_user + +OPERATION_BP = Blueprint('operation', __name__) + + +@OPERATION_BP.route('/create_operation', methods=["POST"]) +@verify_user +def create_operation(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + path = request.form['path'] + content = request.form.get('content', None) + description = request.form.get('description', None) + category = request.form.get('category', "default") + active = (request.form.get('active', "True") == "True") + last_used = datetime.datetime.now(tz=datetime.timezone.utc) + user = g.user + r = str(fm.create_operation(path, description, user, last_used, content=content, category=category, active=active)) + if r == "True": + sockio = getConfig()[1] + token = request.args.get('token', request.form.get('token', False)) + json_config = {"token": token} + sockio.sm.update_operation_list(json_config) + return r + + +@OPERATION_BP.route('/get_operation_by_id', methods=['GET']) +@verify_user +def get_operation_by_id(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + user = g.user + result = fm.get_file(int(op_id), user) + if result is False: + return "False" + return json.dumps({"content": result}) + + +@OPERATION_BP.route('/get_all_changes', methods=['GET']) +@verify_user +def get_all_changes(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + named_version = request.args.get('named_version') == "True" + user = g.user + result = fm.get_all_changes(int(op_id), user, named_version) + if result is False: + jsonify({"success": False, "message": "Some error occurred!"}) + return jsonify({"success": True, "changes": result}) + + +@OPERATION_BP.route('/get_change_content', methods=['GET']) +@verify_user +def get_change_content(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + ch_id = int(request.args.get('ch_id', request.form.get('ch_id', 0))) + user = g.user + result = fm.get_change_content(ch_id, user) + if result is False: + return "False" + return jsonify({"content": result}) + + +@OPERATION_BP.route('/set_version_name', methods=['POST']) +@verify_user +def set_version_name(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + ch_id = int(request.form.get('ch_id', 0)) + op_id = int(request.form.get('op_id', 0)) + version_name = request.form.get('version_name', None) + u_id = g.user.id + success = fm.set_version_name(ch_id, op_id, u_id, version_name) + if success is False: + return jsonify({"success": False, "message": "Some error occurred!"}) + + return jsonify({"success": True, "message": "Successfully set version name"}) + + +@OPERATION_BP.route('/authorized_users', methods=['GET']) +@verify_user +def authorized_users(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + return json.dumps({"users": fm.get_authorized_users(int(op_id))}) + + +@OPERATION_BP.route('/active_users', methods=["GET"]) +@verify_user +def active_users(): + from mslib.mscolab.server import getConfig + sockio = getConfig()[1] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + return jsonify(active_users=list(sockio.sm.active_users_per_operation[int(op_id)])) + + +@OPERATION_BP.route('/operations', methods=['GET']) +@verify_user +def get_operations(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + skip_archived = (request.args.get('skip_archived', request.form.get('skip_archived', "False")) == "True") + user = g.user + return json.dumps({"operations": fm.list_operations(user, skip_archived=skip_archived)}) + + +@OPERATION_BP.route('/delete_operation', methods=["POST"]) +@verify_user +def delete_operation(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = int(request.form.get('op_id', 0)) + user = g.user + success = fm.delete_operation(op_id, user) + if success is False: + return jsonify({"success": False, "message": "You don't have access for this operation!"}) + sockio = getConfig()[1] + sockio.sm.emit_operation_delete(op_id) + return jsonify({"success": True, "message": "Operation was successfully deleted!"}) + + +@OPERATION_BP.route('/update_operation', methods=['POST']) +@verify_user +def update_operation(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.form.get('op_id', None) + attribute = request.form['attribute'] + value = request.form['value'] + user = g.user + r = fm.update_operation(int(op_id), attribute, value, user) + if r is True: + sockio = getConfig()[1] + token = request.args.get('token', request.form.get('token', False)) + json_config = {"token": token} + sockio.sm.update_operation_list(json_config) + return str(r) + + +@OPERATION_BP.route('/operation_details', methods=["GET"]) +@verify_user +def get_operation_details(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + user = g.user + result = fm.get_operation_details(int(op_id), user) + if result is False: + return "False" + return json.dumps(result) + + +@OPERATION_BP.route('/set_last_used', methods=["POST"]) +@verify_user +def set_last_used(): + op_id = request.form.get('op_id', None) + user = g.user + days_ago = int(request.form.get('days', 0)) + if days_ago > 99999: + days_ago = 99999 + elif days_ago < -99999: + days_ago = -99999 + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + fm.update_operation(int(op_id), 'last_used', + datetime.datetime.now(tz=datetime.timezone.utc) - datetime.timedelta(days=days_ago), + user) + return jsonify({"success": True}), 200 + + +@OPERATION_BP.route('/undo_changes', methods=["POST"]) +@verify_user +def undo_changes(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + ch_id = request.form.get('ch_id', -1) + ch_id = int(ch_id) + user = g.user + result = fm.undo_changes(ch_id, user) + # get op_id from change + ch = Change.query.filter_by(id=ch_id).first() + if result is True: + sockio = getConfig()[1] + sockio.sm.emit_file_change(ch.op_id) + return str(result) + + +@OPERATION_BP.route("/creator_of_operation", methods=["GET"]) +@verify_user +def get_creator_of_operation(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + u_id = g.user.id + creator_name = fm.fetch_operation_creator(op_id, u_id) + if creator_name is False: + return jsonify({"success": False, "message": "You don't have access to this data"}), 403 + return jsonify({"success": True, "username": creator_name}), 200 + + +@OPERATION_BP.route("/users_without_permission", methods=["GET"]) +@verify_user +def get_users_without_permission(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + u_id = g.user.id + users = fm.fetch_users_without_permission(int(op_id), u_id) + if users is False: + return jsonify({"success": False, "message": "You don't have access to this data"}), 403 + + return jsonify({"success": True, "users": users}), 200 + + +@OPERATION_BP.route("/users_with_permission", methods=["GET"]) +@verify_user +def get_users_with_permission(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = request.args.get('op_id', request.form.get('op_id', None)) + u_id = g.user.id + users = fm.fetch_users_with_permission(int(op_id), u_id) + if users is False: + return jsonify({"success": False, "message": "You don't have access to this data"}), 403 + + return jsonify({"success": True, "users": users}), 200 + + +@OPERATION_BP.route("/add_bulk_permissions", methods=["POST"]) +@verify_user +def add_bulk_permissions(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = int(request.form.get('op_id')) + new_u_ids = json.loads(request.form.get('selected_userids', [])) + access_level = request.form.get('selected_access_level') + user = g.user + success = fm.add_bulk_permission(op_id, user, new_u_ids, access_level) + if success: + from mslib.mscolab.server import getConfig + sockio = getConfig()[1] + for u_id in new_u_ids: + sockio.sm.emit_new_permission(u_id, op_id) + sockio.sm.emit_operation_permissions_updated(user.id, op_id) + return jsonify({"success": True, "message": "Users successfully added!"}) + + return jsonify({"success": False, "message": "Some error occurred. Please try again."}) + + +@OPERATION_BP.route("/modify_bulk_permissions", methods=["POST"]) +@verify_user +def modify_bulk_permissions(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = int(request.form.get('op_id')) + u_ids = json.loads(request.form.get('selected_userids', [])) + new_access_level = request.form.get('selected_access_level') + user = g.user + success = fm.modify_bulk_permission(op_id, user, u_ids, new_access_level) + if success: + from mslib.mscolab.server import getConfig + sockio = getConfig()[1] + for u_id in u_ids: + sockio.sm.emit_update_permission(u_id, op_id, access_level=new_access_level) + sockio.sm.emit_operation_permissions_updated(user.id, op_id) + return jsonify({"success": True, "message": "User permissions successfully updated!"}) + + return jsonify({"success": False, "message": "Some error occurred. Please try again."}) + + +@OPERATION_BP.route("/delete_bulk_permissions", methods=["POST"]) +@verify_user +def delete_bulk_permissions(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + op_id = int(request.form.get('op_id')) + u_ids = json.loads(request.form.get('selected_userids', [])) + user = g.user + success = fm.delete_bulk_permission(op_id, user, u_ids) + if success: + sockio = getConfig()[1] + for u_id in u_ids: + sockio.sm.remove_active_user_id_from_specific_operation(u_id, op_id) + sockio.sm.emit_revoke_permission(u_id, op_id) + sockio.sm.emit_operation_permissions_updated(user.id, op_id) + return jsonify({"success": True, "message": "User permissions successfully deleted!"}) + + return jsonify({"success": False, "message": "Some error occurred. Please try again."}) + + +@OPERATION_BP.route('/import_permissions', methods=['POST']) +@verify_user +def import_permissions(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + import_op_id = int(request.form.get('import_op_id')) + current_op_id = int(request.form.get('current_op_id')) + user = g.user + success, users, message = fm.import_permissions(import_op_id, current_op_id, user.id) + if success: + sockio = getConfig()[1] + for u_id in users["add_users"]: + sockio.sm.emit_new_permission(u_id, current_op_id) + for u_id in users["modify_users"]: + # changes navigation for viewer/collaborator + sockio.sm.emit_update_permission(u_id, current_op_id) + for u_id in users["delete_users"]: + # invalidate waypoint table, title of windows + sockio.sm.emit_revoke_permission(u_id, current_op_id) + + token = request.args.get('token', request.form.get('token', False)) + json_config = {"token": token} + sockio.sm.update_operation_list(json_config) + + sockio.sm.emit_operation_permissions_updated(user.id, current_op_id) + return jsonify({"success": True}) + + return jsonify({"success": False, + "message": message}) diff --git a/mslib/mscolab/blueprints/user/__init__.py b/mslib/mscolab/blueprints/user/__init__.py new file mode 100644 index 000000000..7604f3413 --- /dev/null +++ b/mslib/mscolab/blueprints/user/__init__.py @@ -0,0 +1,89 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mscolab.blueprints.user + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + User Blueprint for server for mscolab module + + This file is part of MSS. + + :copyright: Copyright 2019 Shivashis Padhi + :copyright: Copyright 2019-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" + +import json +from pathlib import Path + +from flask import Blueprint, g, request, jsonify, send_from_directory + +from mslib.mscolab.app import APP +from mslib.utils.auth import verify_user + +USER_BP = Blueprint('user', __name__) + + +@USER_BP.route('/user', methods=["GET"]) +@verify_user +def get_user(): + return json.dumps({'user': {'id': g.user.id, 'username': g.user.username, 'fullname': g.user.fullname}}) + + +@USER_BP.route('/upload_profile_image', methods=["POST"]) +@verify_user +def upload_profile_image(): + user_id = g.user.id + file = request.files['image'] + if not file: + return jsonify({'message': 'No file provided or invalid file type'}), 400 + if not file.mimetype.startswith('image/'): + return jsonify({'message': 'Invalid file type'}), 400 + if file.content_length > APP.config['MAX_UPLOAD_SIZE']: + return jsonify({'message': 'File too large'}), 413 + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + success, message = fm.save_user_profile_image(user_id, file) + if success: + return jsonify({'message': message}), 200 + else: + return jsonify({'message': message}), 400 + + +@USER_BP.route('/fetch_profile_image', methods=["GET"]) +@verify_user +def fetch_profile_image(): + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + user_id = request.form['user_id'] + success, filename = fm.get_user_profile_image(user_id) + if success: + base_path = APP.config['UPLOAD_FOLDER'] + return send_from_directory(Path(base_path), filename) + else: + return jsonify({'message': 'User or profile image not found'}), 404 + + +@USER_BP.route("/delete_own_account", methods=["POST"]) +@verify_user +def delete_own_account(): + """ + delete own account + """ + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + user = g.user + result = fm.modify_user(user, action="delete") + return jsonify({"success": result}), 200 diff --git a/mslib/mscolab/conf.py b/mslib/mscolab/conf.py index 3618b3184..1be7f8044 100644 --- a/mslib/mscolab/conf.py +++ b/mslib/mscolab/conf.py @@ -99,7 +99,14 @@ class DefaultSettings: enable_basic_http_authentication = False # enable verification by Mail - MAIL_ENABLED = False + MAIL_ENABLED = True + + # mail accounts + MAIL_DEFAULT_SENDER = 'mss-mscolab@fz-juelich.de' + # mail settings + MAIL_SERVER = 'mail.fz-juelich.de' + MAIL_PORT = 25 + IMPRINT = '/home/user/imprint/imprint.md' # mail settings # MAIL_SERVER = 'localhost' @@ -114,7 +121,7 @@ class DefaultSettings: # mail accounts # MAIL_DEFAULT_SENDER = 'MSS@localhost' # filepath to md file with imprint - IMPRINT = None + #IMPRINT = None # filepath to md file with gdpr GDPR = None diff --git a/mslib/mscolab/server.py b/mslib/mscolab/server.py index 483f72852..d2875a762 100644 --- a/mslib/mscolab/server.py +++ b/mslib/mscolab/server.py @@ -25,35 +25,26 @@ limitations under the License. """ import sys -import functools -import json import logging import datetime -import secrets import socketio import sqlalchemy.exc -import werkzeug import flask_migrate -from pathlib import Path -from itsdangerous import URLSafeTimedSerializer, BadSignature -from flask import g, jsonify, request, render_template, flash -from flask import send_from_directory, abort, url_for, redirect -from flask_mail import Mail, Message + +from flask import jsonify, request +from flask_mail import Mail from flask_cors import CORS from flask_httpauth import HTTPBasicAuth -from validate_email import validate_email -from saml2.metadata import create_metadata_string -from saml2 import BINDING_HTTP_REDIRECT, BINDING_HTTP_POST -from flask.wrappers import Response -from mslib.mscolab.conf import setup_saml2_backend +from mslib.mscolab.blueprints.auth import AUTH_BP +from mslib.mscolab.blueprints.chat import CHAT_BP +from mslib.mscolab.blueprints.operation import OPERATION_BP +from mslib.mscolab.blueprints.user import USER_BP from mslib.mscolab.app import create_app, APP -from mslib.mscolab.models import Change, MessageType, User +from mslib.mscolab.models import User from mslib.mscolab.sockets_manager import _setup_managers -from mslib.mscolab.utils import create_files, get_message_dict -from mslib.utils import conditional_decorator -from mslib.mscolab.forms import ResetRequestForm, ResetPasswordForm +from mslib.mscolab.utils import create_files from mslib.mscolab import migrations @@ -185,40 +176,6 @@ def verify_pw(username, password): return authfunc(username, password) -def send_email(to, subject, template): - if APP.config['MAIL_DEFAULT_SENDER'] is not None: - msg = Message( - subject, - recipients=[to], - html=template, - sender=APP.config['MAIL_DEFAULT_SENDER'] - ) - try: - mail.send(msg) - except IOError: - logging.error("Can't send email to %s", to) - else: - logging.debug("setup user verification by email") - - -def generate_confirmation_token(email): - serializer = URLSafeTimedSerializer(APP.config['SECRET_KEY']) - return serializer.dumps(email, salt=APP.config['SECURITY_PASSWORD_SALT']) - - -def confirm_token(token, expiration=3600): - serializer = URLSafeTimedSerializer(APP.config['SECRET_KEY']) - try: - email = serializer.loads( - token, - salt=APP.config['SECURITY_PASSWORD_SALT'], - max_age=expiration - ) - except (IOError, BadSignature): - return False - return email - - def _initialize_managers(app): sockio, cm, fm = _setup_managers(app) # initializing socketio and db @@ -248,296 +205,8 @@ def check_login(emailid, password): return False -def register_user(email, password, username, fullname): - if len(str(email.strip())) == 0 or len(str(username.strip())) == 0: - return {"success": False, "message": "Your username or email cannot be empty"} - is_valid_username = True if username.find("@") == -1 else False - is_valid_email = validate_email(email) - if not is_valid_email: - return {"success": False, "message": "Your email ID is not valid!"} - if not is_valid_username: - return {"success": False, "message": "Your username cannot contain @ symbol!"} - user_exists = User.query.filter_by(emailid=str(email)).first() - if user_exists: - return {"success": False, "message": "This email ID is already taken!"} - user_exists = User.query.filter_by(username=str(username)).first() - if user_exists: - return {"success": False, "message": "This username is already registered"} - user = User(email, username, password, fullname) - result = fm.modify_user(user, action="create") - return {"success": result} - - -def verify_user(func): - @functools.wraps(func) - def wrapper(*args, **kwargs): - try: - user = User.verify_auth_token(request.args.get('token', request.form.get('token', False))) - except TypeError: - logging.debug("no token in request form") - abort(404) - if not user: - return "False" - else: - # saving user details in flask.g - if APP.config['MAIL_ENABLED']: - if user.confirmed: - g.user = user - return func(*args, **kwargs) - else: - return "False" - else: - g.user = user - return func(*args, **kwargs) - return wrapper - - -def get_idp_entity_id(selected_idp): - """ - Finds the entity_id from the configured IDPs - :return: the entity_id of the idp or None - """ - for config in setup_saml2_backend.CONFIGURED_IDPS: - if selected_idp == config['idp_identity_name']: - idps = config['idp_data']['saml2client'].metadata.identity_providers() - only_idp = idps[0] - entity_id = only_idp - return entity_id - return None - - -def create_or_update_idp_user(email, username, token, authentication_backend): - """ - Creates or updates an idp user in the system based on the provided email, - username, token, and authentication backend. - :param email: idp users email - :param username: idp users username - :param token: authentication token - :param authentication_backend: authenticated identity providers name - :return: bool : query success or not - """ - user = User.query.filter_by(emailid=email).first() - if not user: - # using an IDP for a new account/profile, e-mail is already verified by the IDP - confirm_time = datetime.datetime.now(tz=datetime.timezone.utc) + datetime.timedelta(seconds=1) - user = User(email, username, password=token, confirmed=True, confirmed_on=confirm_time, - authentication_backend=authentication_backend) - result = fm.modify_user(user, action="create") - else: - user.authentication_backend = authentication_backend - user.hash_password(token) - result = fm.modify_user(user, action="update_idp_user") - return result - - -@APP.route('/') -@conditional_decorator(auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) -def home(): - return render_template("/index.html") - - -@APP.route("/status") -@conditional_decorator(auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) -def hello(): - if request.authorization is not None: - if APP.__dict__.get('enable_basic_http_authentication', False): - auth.login_required() - return json.dumps({ - 'message': "Mscolab server", - 'use_saml2': APP.config['USE_SAML2'], - 'direct_login': APP.DIRECT_LOGIN - }) - return json.dumps({ - 'message': "Mscolab server", - 'use_saml2': APP.config['USE_SAML2'], - 'direct_login': APP.config['DIRECT_LOGIN'] - }) - else: - return json.dumps({ - 'message': "Mscolab server", - 'use_saml2': APP.config['USE_SAML2'], - 'direct_login': APP.config['DIRECT_LOGIN'] - }) - - -@APP.route('/token', methods=["POST"]) -@conditional_decorator(auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) -def get_auth_token(): - emailid = request.form['email'] - password = request.form['password'] - user = check_login(emailid, password) - if user is not False: - if APP.config['MAIL_ENABLED']: - if user.confirmed: - token = user.generate_auth_token() - return json.dumps({ - 'token': token, - 'user': {'username': user.username, 'id': user.id, 'fullname': user.fullname}}) - else: - return "False" - else: - token = user.generate_auth_token() - return json.dumps({ - 'token': token, - 'user': {'username': user.username, 'id': user.id, 'fullname': user.fullname}}) - else: - logging.debug("Unauthorized user: %s", emailid) - return "False" - - -@APP.route('/test_authorized') -def authorized(): - token = request.args.get('token', request.form.get('token')) - user = User.verify_auth_token(token) - if user is not None: - if APP.config['MAIL_ENABLED']: - if user.confirmed is False: - return "False" - else: - return "True" - else: - return "True" - else: - return "False" - - -@APP.route("/register", methods=["POST"]) -@conditional_decorator(auth.login_required, APP.__dict__.get('enable_basic_http_authentication', False)) -def user_register_handler(): - email = request.form['email'] - password = request.form['password'] - username = request.form['username'] - fullname = request.form['fullname'] - result = register_user(email, password, username, fullname) - status_code = 200 - try: - if result["success"]: - status_code = 201 - if APP.config['MAIL_ENABLED']: - status_code = 204 - token = generate_confirmation_token(email) - confirm_url = url_for('confirm_email', token=token, _external=True) - html = render_template('user/activate.html', username=username, confirm_url=confirm_url) - subject = "MSColab Please confirm your email" - send_email(email, subject, html) - except TypeError: - result, status_code = {"success": False}, 401 - return jsonify(result), status_code - - -@APP.route('/confirm/') -def confirm_email(token): - if APP.config['MAIL_ENABLED']: - try: - email = confirm_token(token) - except TypeError: - return jsonify({"success": False}), 401 - if email is False: - return jsonify({"success": False}), 401 - user = User.query.filter_by(emailid=email).first_or_404() - if user.confirmed: - return render_template('user/confirmed.html', username=user.username) - else: - fm.modify_user(user, attribute="confirmed_on", value=datetime.datetime.now(tz=datetime.timezone.utc)) - fm.modify_user(user, attribute="confirmed", value=True) - return render_template('user/confirmed.html', username=user.username) - - -@APP.route('/user', methods=["GET"]) -@verify_user -def get_user(): - return json.dumps({'user': {'id': g.user.id, 'username': g.user.username, 'fullname': g.user.fullname}}) - - -@APP.route('/upload_profile_image', methods=["POST"]) -@verify_user -def upload_profile_image(): - user_id = g.user.id - file = request.files['image'] - if not file: - return jsonify({'message': 'No file provided or invalid file type'}), 400 - if not file.mimetype.startswith('image/'): - return jsonify({'message': 'Invalid file type'}), 400 - if file.content_length > APP.config['MAX_UPLOAD_SIZE']: - return jsonify({'message': 'File too large'}), 413 - - success, message = fm.save_user_profile_image(user_id, file) - if success: - return jsonify({'message': message}), 200 - else: - return jsonify({'message': message}), 400 - - -@APP.route('/fetch_profile_image', methods=["GET"]) -@verify_user -def fetch_profile_image(): - user_id = request.form['user_id'] - success, filename = fm.get_user_profile_image(user_id) - if success: - base_path = APP.config['UPLOAD_FOLDER'] - return send_from_directory(Path(base_path), filename) - else: - return jsonify({'message': 'User or profile image not found'}), 404 - - -@APP.route("/delete_own_account", methods=["POST"]) -@verify_user -def delete_own_account(): - """ - delete own account - """ - user = g.user - result = fm.modify_user(user, action="delete") - return jsonify({"success": result}), 200 - - -# Chat related routes -@APP.route("/messages", methods=["GET"]) -@verify_user -def messages(): - user = g.user - op_id = request.args.get("op_id", request.form.get("op_id", None)) - if fm.is_member(user.id, op_id): - timestamp = request.args.get("timestamp", request.form.get("timestamp", "1970-01-01T00:00:00+00:00")) - chat_messages = cm.get_messages(op_id, timestamp) - return jsonify({"messages": chat_messages}) - return "False" - - -@APP.route("/message_attachment", methods=["POST"]) -@verify_user -def message_attachment(): - user = g.user - op_id = request.form.get("op_id", None) - if fm.is_member(user.id, op_id): - file = request.files['file'] - message_type = MessageType(int(request.form.get("message_type"))) - user = g.user - users = fm.fetch_users_without_permission(int(op_id), user.id) - if users is False: - return jsonify({"success": False, "message": "Could not send message. No file uploaded."}) - if file is not None: - static_file_path = fm.upload_file(file, subfolder=str(op_id), include_prefix=True) - if static_file_path is not None: - new_message = cm.add_message(user, static_file_path, op_id, message_type) - new_message_dict = get_message_dict(new_message) - sockio.emit('chat-message-client', json.dumps(new_message_dict)) - return jsonify({"success": True, "path": static_file_path}) - else: - return "False" - return jsonify({"success": False, "message": "Could not send message. No file uploaded."}) - # normal use case never gets to this - return "False" - - -@APP.route('/uploads//', methods=["GET"]) -def uploads(name=None, filename=None): - base_path = APP.config['UPLOAD_FOLDER'] - if name is None: - abort(404) - if filename is None: - abort(404) - return send_from_directory(base_path, werkzeug.security.safe_join("", name, filename)) +def getConfig(): + return _app, sockio, cm, fm, mail # 413: Payload Too Large @@ -547,470 +216,6 @@ def error413(error): return jsonify({"success": False, "message": f"File size too large. Upload limit is {upload_limit}MB"}), 413 -# File related routes -@APP.route('/create_operation', methods=["POST"]) -@verify_user -def create_operation(): - path = request.form['path'] - content = request.form.get('content', None) - description = request.form.get('description', None) - category = request.form.get('category', "default") - active = (request.form.get('active', "True") == "True") - last_used = datetime.datetime.now(tz=datetime.timezone.utc) - user = g.user - r = str(fm.create_operation(path, description, user, last_used, content=content, category=category, active=active)) - if r == "True": - token = request.args.get('token', request.form.get('token', False)) - json_config = {"token": token} - sockio.sm.update_operation_list(json_config) - return r - - -@APP.route('/get_operation_by_id', methods=['GET']) -@verify_user -def get_operation_by_id(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - user = g.user - result = fm.get_file(int(op_id), user) - if result is False: - return "False" - return json.dumps({"content": result}) - - -@APP.route('/get_all_changes', methods=['GET']) -@verify_user -def get_all_changes(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - named_version = request.args.get('named_version') == "True" - user = g.user - result = fm.get_all_changes(int(op_id), user, named_version) - if result is False: - jsonify({"success": False, "message": "Some error occurred!"}) - return jsonify({"success": True, "changes": result}) - - -@APP.route('/get_change_content', methods=['GET']) -@verify_user -def get_change_content(): - ch_id = int(request.args.get('ch_id', request.form.get('ch_id', 0))) - user = g.user - result = fm.get_change_content(ch_id, user) - if result is False: - return "False" - return jsonify({"content": result}) - - -@APP.route('/set_version_name', methods=['POST']) -@verify_user -def set_version_name(): - ch_id = int(request.form.get('ch_id', 0)) - op_id = int(request.form.get('op_id', 0)) - version_name = request.form.get('version_name', None) - u_id = g.user.id - success = fm.set_version_name(ch_id, op_id, u_id, version_name) - if success is False: - return jsonify({"success": False, "message": "Some error occurred!"}) - - return jsonify({"success": True, "message": "Successfully set version name"}) - - -@APP.route('/authorized_users', methods=['GET']) -@verify_user -def authorized_users(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - return json.dumps({"users": fm.get_authorized_users(int(op_id))}) - - -@APP.route('/active_users', methods=["GET"]) -@verify_user -def active_users(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - return jsonify(active_users=list(sockio.sm.active_users_per_operation[int(op_id)])) - - -@APP.route('/operations', methods=['GET']) -@verify_user -def get_operations(): - skip_archived = (request.args.get('skip_archived', request.form.get('skip_archived', "False")) == "True") - user = g.user - return json.dumps({"operations": fm.list_operations(user, skip_archived=skip_archived)}) - - -@APP.route('/delete_operation', methods=["POST"]) -@verify_user -def delete_operation(): - op_id = int(request.form.get('op_id', 0)) - user = g.user - success = fm.delete_operation(op_id, user) - if success is False: - return jsonify({"success": False, "message": "You don't have access for this operation!"}) - - sockio.sm.emit_operation_delete(op_id) - return jsonify({"success": True, "message": "Operation was successfully deleted!"}) - - -@APP.route('/update_operation', methods=['POST']) -@verify_user -def update_operation(): - op_id = request.form.get('op_id', None) - attribute = request.form['attribute'] - value = request.form['value'] - user = g.user - r = fm.update_operation(int(op_id), attribute, value, user) - if r is True: - token = request.args.get('token', request.form.get('token', False)) - json_config = {"token": token} - sockio.sm.update_operation_list(json_config) - return str(r) - - -@APP.route('/operation_details', methods=["GET"]) -@verify_user -def get_operation_details(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - user = g.user - result = fm.get_operation_details(int(op_id), user) - if result is False: - return "False" - return json.dumps(result) - - -@APP.route('/set_last_used', methods=["POST"]) -@verify_user -def set_last_used(): - op_id = request.form.get('op_id', None) - user = g.user - days_ago = int(request.form.get('days', 0)) - if days_ago > 99999: - days_ago = 99999 - elif days_ago < -99999: - days_ago = -99999 - fm.update_operation(int(op_id), 'last_used', - datetime.datetime.now(tz=datetime.timezone.utc) - datetime.timedelta(days=days_ago), - user) - return jsonify({"success": True}), 200 - - -@APP.route('/undo_changes', methods=["POST"]) -@verify_user -def undo_changes(): - ch_id = request.form.get('ch_id', -1) - ch_id = int(ch_id) - user = g.user - result = fm.undo_changes(ch_id, user) - # get op_id from change - ch = Change.query.filter_by(id=ch_id).first() - if result is True: - sockio.sm.emit_file_change(ch.op_id) - return str(result) - - -@APP.route("/creator_of_operation", methods=["GET"]) -@verify_user -def get_creator_of_operation(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - u_id = g.user.id - creator_name = fm.fetch_operation_creator(op_id, u_id) - if creator_name is False: - return jsonify({"success": False, "message": "You don't have access to this data"}), 403 - return jsonify({"success": True, "username": creator_name}), 200 - - -@APP.route("/users_without_permission", methods=["GET"]) -@verify_user -def get_users_without_permission(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - u_id = g.user.id - users = fm.fetch_users_without_permission(int(op_id), u_id) - if users is False: - return jsonify({"success": False, "message": "You don't have access to this data"}), 403 - - return jsonify({"success": True, "users": users}), 200 - - -@APP.route("/users_with_permission", methods=["GET"]) -@verify_user -def get_users_with_permission(): - op_id = request.args.get('op_id', request.form.get('op_id', None)) - u_id = g.user.id - users = fm.fetch_users_with_permission(int(op_id), u_id) - if users is False: - return jsonify({"success": False, "message": "You don't have access to this data"}), 403 - - return jsonify({"success": True, "users": users}), 200 - - -@APP.route("/add_bulk_permissions", methods=["POST"]) -@verify_user -def add_bulk_permissions(): - op_id = int(request.form.get('op_id')) - new_u_ids = json.loads(request.form.get('selected_userids', [])) - access_level = request.form.get('selected_access_level') - user = g.user - success = fm.add_bulk_permission(op_id, user, new_u_ids, access_level) - if success: - for u_id in new_u_ids: - sockio.sm.emit_new_permission(u_id, op_id) - sockio.sm.emit_operation_permissions_updated(user.id, op_id) - return jsonify({"success": True, "message": "Users successfully added!"}) - - return jsonify({"success": False, "message": "Some error occurred. Please try again."}) - - -@APP.route("/modify_bulk_permissions", methods=["POST"]) -@verify_user -def modify_bulk_permissions(): - op_id = int(request.form.get('op_id')) - u_ids = json.loads(request.form.get('selected_userids', [])) - new_access_level = request.form.get('selected_access_level') - user = g.user - success = fm.modify_bulk_permission(op_id, user, u_ids, new_access_level) - if success: - for u_id in u_ids: - sockio.sm.emit_update_permission(u_id, op_id, access_level=new_access_level) - sockio.sm.emit_operation_permissions_updated(user.id, op_id) - return jsonify({"success": True, "message": "User permissions successfully updated!"}) - - return jsonify({"success": False, "message": "Some error occurred. Please try again."}) - - -@APP.route("/delete_bulk_permissions", methods=["POST"]) -@verify_user -def delete_bulk_permissions(): - op_id = int(request.form.get('op_id')) - u_ids = json.loads(request.form.get('selected_userids', [])) - user = g.user - success = fm.delete_bulk_permission(op_id, user, u_ids) - if success: - for u_id in u_ids: - sockio.sm.remove_active_user_id_from_specific_operation(u_id, op_id) - sockio.sm.emit_revoke_permission(u_id, op_id) - sockio.sm.emit_operation_permissions_updated(user.id, op_id) - return jsonify({"success": True, "message": "User permissions successfully deleted!"}) - - return jsonify({"success": False, "message": "Some error occurred. Please try again."}) - - -@APP.route('/import_permissions', methods=['POST']) -@verify_user -def import_permissions(): - import_op_id = int(request.form.get('import_op_id')) - current_op_id = int(request.form.get('current_op_id')) - user = g.user - success, users, message = fm.import_permissions(import_op_id, current_op_id, user.id) - if success: - for u_id in users["add_users"]: - sockio.sm.emit_new_permission(u_id, current_op_id) - for u_id in users["modify_users"]: - # changes navigation for viewer/collaborator - sockio.sm.emit_update_permission(u_id, current_op_id) - for u_id in users["delete_users"]: - # invalidate waypoint table, title of windows - sockio.sm.emit_revoke_permission(u_id, current_op_id) - - token = request.args.get('token', request.form.get('token', False)) - json_config = {"token": token} - sockio.sm.update_operation_list(json_config) - - sockio.sm.emit_operation_permissions_updated(user.id, current_op_id) - return jsonify({"success": True}) - - return jsonify({"success": False, - "message": message}) - - -@APP.route('/reset_password/', methods=['GET', 'POST']) -def reset_password(token): - try: - email = confirm_token(token, expiration=86400) - except TypeError: - return jsonify({"success": False}), 401 - if email is False: - flash("Sorry, your token has expired or is invalid! We will need to resend your authentication email", - 'category_info') - return render_template('user/status.html', uri={"path": "reset_request", "name": "Resend authentication email"}) - user = User.query.filter_by(emailid=email).first_or_404() - form = ResetPasswordForm() - if form.validate_on_submit(): - try: - user.hash_password(form.confirm_password.data) - fm.modify_user(user, "confirmed", True) - flash('Password reset Success. Please login by the user interface.', 'category_success') - return render_template('user/status.html') - except IOError: - flash('Password reset failed. Please try again later', 'category_danger') - return render_template('user/reset_password.html', form=form) - - -@APP.route("/reset_request", methods=['GET', 'POST']) -def reset_request(): - if APP.config['MAIL_ENABLED']: - form = ResetRequestForm() - if form.validate_on_submit(): - # Check whether user exists or not based on the db - user = User.query.filter_by(emailid=form.email.data).first() - if user: - try: - username = user.username - token = generate_confirmation_token(form.email.data) - reset_password_url = url_for('reset_password', token=token, _external=True) - html = render_template('user/reset_confirmation.html', - reset_password_url=reset_password_url, username=username) - subject = "MSColab Password reset request" - send_email(form.email.data, subject, html) - flash('An email was sent if this user account exists', 'category_success') - return render_template('user/status.html') - except IOError: - flash('''We apologize, but it seems that there was an issue sending - your request email. Please try again later.''', 'category_info') - else: - flash('An email was sent if this user account exists', 'category_success') - return render_template('user/status.html') - return render_template('user/reset_request.html', form=form) - else: - logging.warning("To send emails, the value of `MAIL_ENABLED` in `conf.py` should be set to True.") - return render_template('errors/403.html'), 403 - - -if APP.config['USE_SAML2']: - # setup idp login config - setup_saml2_backend() - - # set routes for SSO - @APP.route('/available_idps/', methods=['GET']) - def available_idps(): - """ - This function checks if IDP (Identity Provider) is enabled in the mscolab_settings module. - If IDP is enabled, it retrieves the configured IDPs from setup_saml2_backend.CONFIGURED_IDPS - and renders the 'idp/available_idps.html' template with the list of configured IDPs. - """ - configured_idps = setup_saml2_backend.CONFIGURED_IDPS - return render_template('idp/available_idps.html', configured_idps=configured_idps), 200 - - @APP.route("/idp_login/", methods=['POST']) - def idp_login(): - """Handle the login process for the user by selected IDP""" - selected_idp = request.form.get('selectedIdentityProvider') - sp_config = None - for config in setup_saml2_backend.CONFIGURED_IDPS: - if selected_idp == config['idp_identity_name']: - sp_config = config['idp_data']['saml2client'] - break - - try: - _, response_binding = sp_config.config.getattr("endpoints", "sp")[ - "assertion_consumer_service" - ][0] - entity_id = get_idp_entity_id(selected_idp) - _, binding, http_args = sp_config.prepare_for_negotiated_authenticate( - entityid=entity_id, - response_binding=response_binding, - ) - if binding == BINDING_HTTP_REDIRECT: - headers = dict(http_args["headers"]) - return redirect(str(headers["Location"]), code=303) - return Response(http_args["data"], headers=http_args["headers"]) - except (NameError, AttributeError): - return render_template('errors/403.html'), 403 - - def create_acs_post_handler(config): - """ - Create acs_post_handler function for the given idp_config. - """ - def acs_post_handler(): - """ - Function to handle SAML authentication response. - """ - try: - outstanding_queries = {} - binding = BINDING_HTTP_POST - authn_response = config['idp_data']['saml2client'].parse_authn_request_response( - request.form["SAMLResponse"], binding, outstanding=outstanding_queries - ) - email = None - username = None - - try: - email = authn_response.ava["email"][0] - username = authn_response.ava["givenName"][0] - token = generate_confirmation_token(email) - except (NameError, AttributeError, KeyError): - try: - # Initialize an empty dictionary to store attribute values - attributes = {} - - # Loop through attribute statements - for attribute_statement in authn_response.assertion.attribute_statement: - for attribute in attribute_statement.attribute: - attribute_name = attribute.name - attribute_value = \ - attribute.attribute_value[0].text if attribute.attribute_value else None - attributes[attribute_name] = attribute_value - - # Extract the email and givenname attributes - email = attributes["email"] - username = attributes["givenName"] - token = generate_confirmation_token(email) - except (NameError, AttributeError, KeyError): - return render_template('errors/403.html'), 403 - - if email is not None and username is not None: - idp_user_db_state = create_or_update_idp_user(email, - username, token, idp_config['idp_identity_name']) - if idp_user_db_state: - return render_template('idp/idp_login_success.html', token=token), 200 - return render_template('errors/500.html'), 500 - return render_template('errors/500.html'), 500 - except (NameError, AttributeError, KeyError): - return render_template('errors/403.html'), 403 - return acs_post_handler - - # Implementation for handling configured SAML assertion consumer endpoints - for idp_config in setup_saml2_backend.CONFIGURED_IDPS: - try: - for assertion_consumer_endpoint in idp_config['idp_data']['assertion_consumer_endpoints']: - # Dynamically add the route for the current endpoint - APP.add_url_rule(f'/{assertion_consumer_endpoint}/', assertion_consumer_endpoint, - create_acs_post_handler(idp_config), methods=['POST']) - except (NameError, AttributeError, KeyError) as ex: - logging.warning("USE_SAML2 is %s, Failure is: %s", APP.config['USE_SAML2'], ex) - - @APP.route('/idp_login_auth/', methods=['POST']) - def idp_login_auth(): - """Handle the SAML authentication validation of client application.""" - try: - data = request.get_json() - token = data.get('token') - email = confirm_token(token, expiration=1200) - if email: - user = check_login(email, token) - if user: - random_token = secrets.token_hex(16) - user.hash_password(random_token) - fm.modify_user(user, action="update_idp_user") - return json.dumps({ - "success": True, - 'token': random_token, - 'user': {'username': user.username, 'id': user.id, 'emailid': user.emailid} - }) - return jsonify({"success": False}), 401 - return jsonify({"success": False}), 401 - except TypeError: - return jsonify({"success": False}), 401 - - @APP.route("/metadata/", methods=['GET']) - def metadata(idp_identity_name): - """Return the SAML metadata XML for the requested IDP""" - for config in setup_saml2_backend.CONFIGURED_IDPS: - if idp_identity_name == config['idp_identity_name']: - sp_config = config['idp_data']['saml2client'] - metadata_string = create_metadata_string( - None, sp_config.config, 4, None, None, None, None, None - ).decode("utf-8") - return Response(metadata_string, mimetype="text/xml") - return render_template('errors/404.html'), 404 - - def start_server(app, sockio, cm, fm, port=8083): create_files() sockio.run(app, port=port, debug=APP.config['DEBUG']) @@ -1023,5 +228,9 @@ def main(): # for wsgi application = socketio.WSGIApp(sockio) +APP.register_blueprint(AUTH_BP) +APP.register_blueprint(CHAT_BP) +APP.register_blueprint(USER_BP) +APP.register_blueprint(OPERATION_BP) if __name__ == '__main__': main() diff --git a/mslib/mswms/app/__init__.py b/mslib/mswms/app/__init__.py index 518e9569c..1d925823d 100644 --- a/mslib/mswms/app/__init__.py +++ b/mslib/mswms/app/__init__.py @@ -28,13 +28,22 @@ import logging import mslib -from flask import Flask, url_for, render_template, send_from_directory, send_file, abort +from flask import Flask, url_for, current_app from xstatic.main import XStatic -from mslib.msui.icons import icons +from mslib.mswms.blueprints.docs import DOCS_BP +from mslib.mswms.blueprints.gallery import GALLERY_BP from mslib.mswms.gallery_builder import STATIC_LOCATION from mslib.utils import prefix_route, release_info -from mslib.utils.get_content import get_content +from mslib.utils.file_exists import file_exists + +DOCS_SERVER_PATH = os.path.dirname(os.path.abspath(mslib.__file__)) +DOCS_STATIC_DIR = os.path.join(DOCS_SERVER_PATH, 'static') +DOCS_IMG_DIR = os.path.join(DOCS_STATIC_DIR, 'img') +DOCS_DOCS_DIR = os.path.join(DOCS_STATIC_DIR, 'docs') +DOCS_TEMPLATES_DIR = os.path.join(DOCS_STATIC_DIR, 'templates') +# This can be used to set a location by SCRIPT_NAME for testing. e.g. export SCRIPT_NAME=/demo/ +SCRIPT_NAME = os.environ.get('SCRIPT_NAME', '/') class default_mswms_settings: @@ -73,18 +82,16 @@ class default_mswms_settings: logging.warning(message) -DOCS_SERVER_PATH = os.path.dirname(os.path.abspath(mslib.__file__)) -# This can be used to set a location by SCRIPT_NAME for testing. e.g. export SCRIPT_NAME=/demo/ -SCRIPT_NAME = os.environ.get('SCRIPT_NAME', '/') - # in memory database for testing # app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' -APP = Flask(__name__, template_folder=os.path.join(DOCS_SERVER_PATH, 'static', 'templates'), +APP = Flask(__name__, template_folder=os.path.join(DOCS_TEMPLATES_DIR), static_url_path="/static", static_folder=STATIC_LOCATION) APP.config.from_object(default_mswms_settings) APP.route = prefix_route(APP.route, SCRIPT_NAME) +APP.jinja_env.globals.update(file_exists=file_exists) + def _xstatic(name): mod_names = [ @@ -104,20 +111,13 @@ def _xstatic(name): return None -def file_exists(filepath=None): - try: - return os.path.isfile(filepath) - except TypeError: - return False - - def get_topmenu(): menu = [ - (url_for('index'), 'Mission Support System', - ((url_for('about'), 'About'), - (url_for('install'), 'Install'), - (url_for("plots"), 'Gallery'), - (url_for('help'), 'Help'), + (url_for('docs.index'), 'Mission Support System', + ((url_for('docs.about'), 'About'), + (url_for('docs.install'), 'Install'), + (url_for("gallery.plots"), 'Gallery'), + (url_for('docs.help'), 'Help'), )), ] @@ -133,81 +133,6 @@ def create_app(name="", imprint=None, gdpr=None): APP.jinja_env.globals["gdpr"] = gdpr_file APP.jinja_env.globals.update(get_topmenu=get_topmenu) - @APP.route('/xstatic//') - def files(name, filename): - base_path = _xstatic(name) - if base_path is None: - abort(404) - if not filename: - abort(404) - return send_from_directory(base_path, filename) - - @APP.route('/mss_theme/img/') - def mss_theme(filename): - base_path = os.path.join(DOCS_SERVER_PATH, 'static', 'img') - return send_from_directory(base_path, filename) - - @APP.route("/index") - def index(): - return render_template("/index.html") - - @APP.route("/mss/about") - @APP.route("/mss") - def about(): - _file = os.path.join(DOCS_SERVER_PATH, 'static', 'docs', 'about.md') - img_url = url_for('overview') - md_overrides = ('![image](/mss/overview.png)', f'![image]({img_url})') - - html_overrrides = ('image', - 'image') - content = get_content(_file, md_overrides=md_overrides, html_overrides=html_overrrides) - return render_template("/content.html", act="about", content=content) - - @APP.route("/mss/install") - def install(): - _file = os.path.join(DOCS_SERVER_PATH, 'static', 'docs', 'installation.md') - content = get_content(_file) - return render_template("/content.html", act="install", content=content) - - @APP.route("/mss/help") - def help(): # noqa: A001 - _file = os.path.join(DOCS_SERVER_PATH, 'static', 'docs', 'help.md') - html_overrides = ('Waypoint Tutorial', - 'Waypoint Tutorial') - content = get_content(_file, html_overrides=html_overrides) - return render_template("/content.html", act="help", content=content) - - @APP.route("/mss/imprint") - def imprint(): - if file_exists(imprint_file): - content = get_content(imprint_file) - return render_template("/content.html", act="imprint", content=content) - else: - return "" - - @APP.route("/mss/gdpr") - def gdpr(): - if file_exists(gdpr_file): - content = get_content(gdpr_file) - return render_template("/content.html", act="gdpr", content=content) - else: - return "" - - @APP.route('/mss/favicon.ico') - def favicons(): - base_path = icons("16x16", "favicon.ico") - return send_file(base_path) - - @APP.route('/mss/logo.png') - def logo(): - base_path = icons("64x64", "mss-logo.png") - return send_file(base_path) - - @APP.route('/mss/overview.png') - def overview(): - base_path = os.path.join(DOCS_SERVER_PATH, 'static', 'img', 'wise12_overview.png') - return send_file(base_path) - + APP.register_blueprint(DOCS_BP) + APP.register_blueprint(GALLERY_BP) return APP diff --git a/mslib/mswms/blueprints/docs/__init__.py b/mslib/mswms/blueprints/docs/__init__.py new file mode 100644 index 000000000..9250fcbff --- /dev/null +++ b/mslib/mswms/blueprints/docs/__init__.py @@ -0,0 +1,198 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mswms.blueprints.docs + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Docs Blueprint for app module of mswms + + This file is part of MSS. + + :copyright: Copyright 2016-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" +import logging +import os +import traceback +import urllib.parse + +from flask import Blueprint, abort, send_from_directory, render_template, url_for, send_file, request, make_response, \ + current_app +from flask_httpauth import HTTPBasicAuth +from multidict import CIMultiDict + +from mslib.msui.icons import icons +from mslib.utils import conditional_decorator +from mslib.utils.file_exists import file_exists +from mslib.utils.get_content import get_content + +DOCS_SERVER_PATH = os.path.dirname(os.path.abspath(__file__)) +DOCS_STATIC_DIR = os.path.join(DOCS_SERVER_PATH, 'static') +DOCS_IMG_DIR = os.path.join(DOCS_STATIC_DIR, 'img') +DOCS_DOCS_DIR = os.path.join(DOCS_STATIC_DIR, 'docs') +DOCS_TEMPLATES_DIR = os.path.join(DOCS_STATIC_DIR, 'templates') + +DOCS_BP = Blueprint("docs", __name__, template_folder='templates', static_folder='static', static_url_path='/static') +auth_basic_auth = HTTPBasicAuth() + + +@DOCS_BP.route('/') +def application(): + from mslib.mswms.app import mswms_settings + view_func = conditional_decorator(auth_basic_auth.login_required, + mswms_settings.enable_basic_http_authentication)(_application_impl) + return view_func() + + +def _application_impl(): + try: + # Request info + query = CIMultiDict(request.args) + # Processing + # ToDo Refactor + request_type = query.get('request') + if request_type is None: # request_type may *actually* be set to None + request_type = '' + request_type = request_type.lower() + request_service = query.get('service', '') + request_service = request_service.lower() + request_version = query.get('version', '') + + url = request.url + server_url = urllib.parse.urljoin(url, urllib.parse.urlparse(url).path) + + from mslib.mswms.wms import server + if (request_type in ('getcapabilities', 'capabilities') and + request_service == 'wms' and request_version in ('1.1.1', '1.3.0', '')): + return_data, mime_type = server.get_capabilities(query, server_url) + elif request_type in ('getmap', 'getvsec', 'getlsec') and request_version in ('1.1.1', '1.3.0', ''): + return_data, mime_type = server.produce_plot(query, request_type) + else: + logging.debug("Request type '%s' is not valid.", request) + raise RuntimeError("Request type is not valid.") + + res = make_response(return_data, 200) + response_headers = [('Content-type', mime_type), ('Content-Length', str(len(return_data)))] + for response_header in response_headers: + res.headers[response_header[0]] = response_header[1] + + return res + + except Exception as ex: + # without query parameter show index page + query = request.args + if len(query) == 0: + return render_template("docs/index.html") + + # communicate request errors back to client user + logging.error("Unexpected error: %s: %s\nTraceback:\n%s", + type(ex), ex, traceback.format_exc()) + error_message = "{}: {}\n".format(type(ex), ex) + response_headers = [('Content-type', 'text/plain'), ('Content-Length', str(len(error_message)))] + res = make_response(error_message, 404) + for response_header in response_headers: + res.headers[response_header[0]] = response_header[1] + return res + + +@DOCS_BP.route('/xstatic//') +def files(name, filename): + from mslib.mswms.app import _xstatic + base_path = _xstatic(name) + if base_path is None: + abort(404) + if not filename: + abort(404) + return send_from_directory(base_path, filename) + + +@DOCS_BP.route('/mss_theme/img/') +def mss_theme(filename): + base_path = os.path.join(DOCS_IMG_DIR) + return send_from_directory(base_path, filename) + + +@DOCS_BP.route("/index") +def index(): + return render_template("docs/index.html") + + +@DOCS_BP.route("/mss/about") +@DOCS_BP.route("/mss") +def about(): + _file = os.path.join(DOCS_DOCS_DIR, 'about.md') + img_url = url_for('docs.overview') + md_overrides = ('![image](/mss/overview.png)', f'![image]({img_url})') + + html_overrrides = ('image', + 'image') + content = get_content(_file, md_overrides=md_overrides, html_overrides=html_overrrides) + return render_template("docs/content.html", act="about", content=content) + + +@DOCS_BP.route("/mss/install") +def install(): + _file = os.path.join(DOCS_DOCS_DIR, 'installation.md') + content = get_content(_file) + return render_template("docs/content.html", act="install", content=content) + + +@DOCS_BP.route("/mss/help") +def help(): # noqa: A001 + _file = os.path.join(DOCS_DOCS_DIR, 'help.md') + md_overrides = ('![Waypoint Tutorial](https://mss.readthedocs.io/en/stable/_images/tutorial_waypoints.mp4)', + '') + content = get_content(_file, md_overrides=md_overrides) + return render_template("docs/content.html", act="help", content=content) + + +@DOCS_BP.route("/mss/imprint") +def imprint(): + imprint_file = current_app.config.get('IMPRINT', None) + if imprint_file is not None and file_exists(imprint_file): + content = get_content(imprint_file) + return render_template("docs/content.html", act="imprint", content=content) + else: + return "" + + +@DOCS_BP.route("/mss/gdpr") +def gdpr(gdpr_file=None): + gdpr_file = current_app.config.get('GDPR', None) + if gdpr_file is not None and file_exists(gdpr_file): + content = get_content(gdpr_file) + return render_template("docs/content.html", act="gdpr", content=content) + else: + return "" + + +@DOCS_BP.route('/mss/favicon.ico') +def favicons(): + base_path = icons("16x16", "favicon.ico") + return send_file(base_path) + + +@DOCS_BP.route('/mss/logo.png') +def logo(): + base_path = icons("64x64", "mss-logo.png") + return send_file(base_path) + + +@DOCS_BP.route('/mss/overview.png') +def overview(): + base_path = os.path.join(DOCS_IMG_DIR, 'wise12_overview.png') + return send_file(base_path) diff --git a/mslib/mswms/blueprints/docs/static/docs/about.md b/mslib/mswms/blueprints/docs/static/docs/about.md new file mode 100644 index 000000000..7b772c4e5 --- /dev/null +++ b/mslib/mswms/blueprints/docs/static/docs/about.md @@ -0,0 +1,63 @@ +# About + + +The Mission Support System (MSS) is a software that is written by +scientists in the field of atmospheric science. The purpose is to have a +tool that simplifies the process for planning a scientific flight in +which parameters of the atmosphere are measured. The research aircraft +typically carry a comprehensive scientific payload comprised of data +acquisition instruments by different companies and research institutions. +The measurement of relevant parameters, for example the chemical +composition of trace gases, temperature or aerosol particle +characteristics, are needed to improve the scientific understanding of +the processes in the atmosphere. This is of significant importance for +the understanding for example of climate change or the recovery of the +ozone hole. + +Typically, scientific research flights are conducted to answer different +scientific questions. Forecasts of relevant parameters by a model +simulation for a specific location give hints where to fly, to answer +the scientific questions by measurements. A lot of other conditions +apply to research flights, that concern flight altitude and range, +ambient temperature, flight permissions in different flight information +regions and aircraft traffic routes. + +> ![image](/mss/overview.png) + +MSS helps to optimize the scientific outcome of the research flights by +displaying the planned flight route and the corresponding model +parameters in the same platform for many discussed options. It does +therefore reduce somehow the amount of flight hours that is needed to +answer a scientific question and thus saves in the end taxpayers money. +In detail, this software helps to review a big amount of meteorological +and model data by viewing the forecasted parameters of interest along +possible regions of a proposed flight path. Data and possible flight +paths can be displayed on a horizontal view (map projection) or on a +vertical view (along the proposed flight path). Flight paths can be +constructed and modified on these views. Exchange through a waypoint +table is also possible. + +MSS is a client/server application written in the language **Python**. +This is used to create flight plans and discuss these with pilots of +research aircraft. The flight path is designed by local and remote +scientists based on meteorologic forecast data on the QT5 MSS gui +application. Two publications are available, one by [Bauer et al.](https://gmd.copernicus.org/articles/15/8983/2022/gmd-15-8983-2022.pdf) +and the other by [Rautenhaus et al](http://www.geosci-model-dev.net/5/55/2012/gmd-5-55-2012.pdf), +which summarizes the principle of this software. On the EuroPython conference +a [overview +talk](https://pyvideo.org/europython-2017/mss-software-for-planning-research-aircraft-missions.html) +about MSS was held. + +The MSS software includes a template for a Webmap server providing own +model data, but it can also connect to several Open Web Service (OWS) +data providers. The architecture of the software package enables its use +in countries with a poor internet connection. For our atmospheric +measurements, one often has to go to remote regions that lack high speed +internet. + +MSS is developed and used mainly by scientists of various institutions +involved in scientific aircraft based missions, including universities +and the German research institutions DLR, KIT, and Forschungszentrum +Jülich. Improving the software will improve the quality of the research +flights and will also enable its use for other scientific areas, e.g. +planning of ship routes. diff --git a/mslib/mswms/blueprints/docs/static/docs/help.md b/mslib/mswms/blueprints/docs/static/docs/help.md new file mode 100644 index 000000000..c0a2c0777 --- /dev/null +++ b/mslib/mswms/blueprints/docs/static/docs/help.md @@ -0,0 +1,15 @@ +# Help + + +The Mission Support System (MSS) is a software that is written by +scientists in the field of atmospheric science. The purpose is to have a +software that simplifies the process for planning a scientific flight. + +# Drawing waypoints in the MSUI Topview +The example shows defining of waypoints for a flight path, moved and deleted. + +![Waypoint Tutorial](https://mss.readthedocs.io/en/stable/_images/tutorial_waypoints.mp4) + + +Further tutorials about the Mission Support System Software on: +[https://mss.readthedocs.io/en/stable/tutorial.html](https://mss.readthedocs.io/en/stable/tutorial.html) diff --git a/mslib/mswms/blueprints/docs/static/docs/installation.md b/mslib/mswms/blueprints/docs/static/docs/installation.md new file mode 100644 index 000000000..b31e57473 --- /dev/null +++ b/mslib/mswms/blueprints/docs/static/docs/installation.md @@ -0,0 +1,90 @@ +# Installation + + +## Install distributed version by mamba + +The Mission Support System (MSS) including a Web Map Service a Collaboration Server and a Graphical User Interface is available as +[conda-forge](https://anaconda.org/conda-forge/mss) package. + + +We strongly recommend to start from [Miniforge3](https://github.com/conda-forge/miniforge?tab=readme-ov-file#miniforge3) +a community project of the conda-forge community. + +You can install it either automatically with the help of a script or manually. + +### Automatically + + +* For **Windows**, use [Windows.bat](https://github.com/Open-MSS/mss-install/blob/main/Windows.bat?raw=1) + + 1. Right click on the webpage and select "Save as..." to download the file + 1. Double click the downloaded file and follow further instructions + * For fully automatic installation, open cmd and execute it with `/Path/To/Windows.bat -a` + +* For **Linux/Mac**, use [LinuxMac.sh](https://github.com/Open-MSS/mss-install/blob/main/LinuxMac.sh?raw=1) + + 1. Right click on the webpage and select "Save as..." to download the file + 1. Make it executable via `chmod +x LinuxMac.sh` + 1. Execute it and follow further instructions `./LinuxMac.sh` + * For fully automatic installation, run it with the -a parameter `./LinuxMac.sh -a` + + +### Manually + +As **Beginner** start with an installation of Miniforge3 +Get [Miniforge3](https://github.com/conda-forge/miniforge?tab=readme-ov-file#miniforge3) for your Operation System + + +You must install mss into a new environment to ensure the most recent +versions for dependencies (On the Anaconda Prompt on Windows, you have +to leave out the 'source' here and below). + +``` + $ mamba create -n mssenv + $ mamba activate mssenv + $ mamba install mss python +``` +For updating an existing MSS installation to the current version, it is +best to install it into a new environment. If an existing environment +shall be updated, it is important to update all packages in this +environment. + +``` + $ mamba activate mssenv + $ msui --update +``` + + +### Server based installation + + +For a wms server setup or mscolab setup you may want to have a dedicated +user for the apache2 wsgi script. We suggest to create a mss user. + +- create a mss user on your system +- login as mss user +- create a *src* directory in /home/mss +- cd src +- get [Miniforge3](https://github.com/conda-forge/miniforge?tab=readme-ov-file#miniforge3) +- set execute bit on install script +- execute script, enable environment in .bashrc +- start your shell again (new login) +- python --version should tell Python 3.X.X +- mamba create -n mssenv +- mamba activate mssenv +- mamba install mss python + +For a simple test you could start the builtin standalone *mswms* and +*mscolab* server: + +``` + $ mswms & + $ mscolab start +``` + +Point a browser for the verification of both servers installed on + + - + - + +Further details in the components section on diff --git a/mslib/mswms/blueprints/docs/static/img/README b/mslib/mswms/blueprints/docs/static/img/README new file mode 100644 index 000000000..b3b29afb5 --- /dev/null +++ b/mslib/mswms/blueprints/docs/static/img/README @@ -0,0 +1 @@ +The files in the img directory are logos from scientific campaigns using MSS. diff --git a/mslib/mswms/blueprints/docs/static/img/cirrus_hl_2021.png b/mslib/mswms/blueprints/docs/static/img/cirrus_hl_2021.png new file mode 100644 index 000000000..af8179419 Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/cirrus_hl_2021.png differ diff --git a/mslib/mswms/blueprints/docs/static/img/emerge_2017.jpeg b/mslib/mswms/blueprints/docs/static/img/emerge_2017.jpeg new file mode 100644 index 000000000..cc225d1fa Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/emerge_2017.jpeg differ diff --git a/mslib/mswms/blueprints/docs/static/img/phileas_2023.jpeg b/mslib/mswms/blueprints/docs/static/img/phileas_2023.jpeg new file mode 100644 index 000000000..555eeb4c5 Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/phileas_2023.jpeg differ diff --git a/mslib/mswms/blueprints/docs/static/img/polstracc_2016.jpeg b/mslib/mswms/blueprints/docs/static/img/polstracc_2016.jpeg new file mode 100644 index 000000000..484b2b56b Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/polstracc_2016.jpeg differ diff --git a/mslib/mswms/blueprints/docs/static/img/publicpreview.jpeg b/mslib/mswms/blueprints/docs/static/img/publicpreview.jpeg new file mode 100644 index 000000000..36ba05348 Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/publicpreview.jpeg differ diff --git a/mslib/mswms/blueprints/docs/static/img/southtrac_2019.jpeg b/mslib/mswms/blueprints/docs/static/img/southtrac_2019.jpeg new file mode 100644 index 000000000..45142d84a Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/southtrac_2019.jpeg differ diff --git a/mslib/mswms/blueprints/docs/static/img/stratoclim_2017.jpeg b/mslib/mswms/blueprints/docs/static/img/stratoclim_2017.jpeg new file mode 100644 index 000000000..4bd108a42 Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/stratoclim_2017.jpeg differ diff --git a/mslib/mswms/blueprints/docs/static/img/wise12_overview.png b/mslib/mswms/blueprints/docs/static/img/wise12_overview.png new file mode 100644 index 000000000..2cf7615b6 Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/wise12_overview.png differ diff --git a/mslib/mswms/blueprints/docs/static/img/wise_2017.jpeg b/mslib/mswms/blueprints/docs/static/img/wise_2017.jpeg new file mode 100644 index 000000000..bc9ca531e Binary files /dev/null and b/mslib/mswms/blueprints/docs/static/img/wise_2017.jpeg differ diff --git a/mslib/mswms/blueprints/docs/templates/docs/content.html b/mslib/mswms/blueprints/docs/templates/docs/content.html new file mode 100644 index 000000000..0d1c7dcd2 --- /dev/null +++ b/mslib/mswms/blueprints/docs/templates/docs/content.html @@ -0,0 +1,13 @@ + {% extends "theme.html" %} {% block body %} +
      + +
      + {{ content|safe }}
      +
      +
      {% endblock %} diff --git a/mslib/mswms/blueprints/docs/templates/docs/index.html b/mslib/mswms/blueprints/docs/templates/docs/index.html new file mode 100644 index 000000000..e4aaae855 --- /dev/null +++ b/mslib/mswms/blueprints/docs/templates/docs/index.html @@ -0,0 +1,55 @@ +{% extends "theme.html" %} {% block body %} +
      +
      + +
      +
      +

      + Welcome to the

      +

      + Mission Support System Collaboration Platform

      +
      +
      + +
      {% endblock %} +
      diff --git a/mslib/mswms/blueprints/docs/templates/footer.html b/mslib/mswms/blueprints/docs/templates/footer.html new file mode 100644 index 000000000..7dcda2063 --- /dev/null +++ b/mslib/mswms/blueprints/docs/templates/footer.html @@ -0,0 +1,35 @@ + diff --git a/mslib/mswms/blueprints/docs/templates/theme.html b/mslib/mswms/blueprints/docs/templates/theme.html new file mode 100644 index 000000000..05226bb30 --- /dev/null +++ b/mslib/mswms/blueprints/docs/templates/theme.html @@ -0,0 +1,72 @@ + + + + + + + + + + + + Mission Support System Collaboration Platform + + + +
      +
      + +
      +
      +
      + {% block body %}{% endblock %} +
      + + {% include "footer.html" %} + + + + + + + diff --git a/mslib/mswms/blueprints/gallery/__init__.py b/mslib/mswms/blueprints/gallery/__init__.py new file mode 100644 index 000000000..5f796abc7 --- /dev/null +++ b/mslib/mswms/blueprints/gallery/__init__.py @@ -0,0 +1,69 @@ +# -*- coding: utf-8 -*- +""" + + mslib.mswms.blueprints.gallery + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Gallery Blueprint for app module of mswms + + This file is part of MSS. + + :copyright: Copyright 2016-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" + +import os + +import werkzeug +from flask import Blueprint, render_template, request, abort, Response + +from mslib.mswms.gallery_builder import STATIC_LOCATION +from mslib.utils.get_content import get_content + +GALLERY_BP = Blueprint('gallery', __name__, template_folder='templates', static_url_path='/static', static_folder=STATIC_LOCATION) + + +@GALLERY_BP.route("/mss/plots") +def plots(): + if STATIC_LOCATION != "" and os.path.exists(os.path.join(STATIC_LOCATION, 'plots.html')): + _file = os.path.join(STATIC_LOCATION, 'plots.html') + content = get_content(_file) + else: + content = "Gallery was not generated for this server.
      " \ + "For further info on how to generate it, run the " \ + "gallery --help command line parameter of mswms.
      " \ + "An example of the gallery can be seen " \ + "here" + return render_template("gallery/content.html", act="plots", content=content) + + +@GALLERY_BP.route("/mss/code/") +def code(filename): + download = request.args.get("download", False) + _file = werkzeug.security.safe_join(STATIC_LOCATION, "code", filename) + if _file is None: + abort(404) + content = get_content(_file) + if not download: + return render_template("gallery/content.html", act="code", content=content) + else: + if not os.path.isfile(_file): + abort(404) + with open(_file) as f: + text = f.read() + return Response("".join([s.replace("\t", "", 1) for s in text.split("```python")[-1] + .splitlines(keepends=True)][1:-2]), + mimetype="text/plain", + headers={"Content-disposition": f"attachment; filename={filename.split('-')[0]}.py"}) diff --git a/mslib/mswms/blueprints/gallery/templates/gallery/content.html b/mslib/mswms/blueprints/gallery/templates/gallery/content.html new file mode 100644 index 000000000..0d1c7dcd2 --- /dev/null +++ b/mslib/mswms/blueprints/gallery/templates/gallery/content.html @@ -0,0 +1,13 @@ + {% extends "theme.html" %} {% block body %} +
      + +
      + {{ content|safe }}
      +
      +
      {% endblock %} diff --git a/mslib/mswms/gallery_builder.py b/mslib/mswms/gallery_builder.py index 1b1ec8766..a86fc304b 100644 --- a/mslib/mswms/gallery_builder.py +++ b/mslib/mswms/gallery_builder.py @@ -434,23 +434,28 @@ def write_code_pages(path, sphinx=False, url_prefix=None): def write_html(path, sphinx=False, plot_types=None): if plot_types is None: - plot_types = plots.keys() + plot_types = list(plots.keys()) + else: + plot_types = list(plot_types) """ Writes the plots.html file containing the gallery """ section = [] - for name in plot_types: - section.append(f""""""") - section = ".\n".join(section) + for index, name in enumerate(plot_types): + classes = "tablinks active" if index == 0 else "tablinks" + section.append( + f"""""" + ) + section = "\n".join(section) html = begin.format(section=section) if sphinx: html = html.replace("

      Plot Gallery

      ", "") + default_plot_type = plot_types[0] if len(plot_types) > 0 else None for l_type in plots: if l_type in plot_types: style = "" - if l_type == "Top": + if l_type == default_plot_type: style = "style=\"display: block;\"" html += f"
      " html += "\n".join(plots[l_type]) @@ -706,8 +711,9 @@ def add_image(path, plot, plot_object, generate_code=False, sphinx=False, url_pr end = end.replace("files = [", f"files = [\"{filename}.png\",")\ .replace(",];", "];") + static_prefix = url_prefix if url_prefix else SCRIPT_NAME.rstrip("/") img_path = f"../_static/{filename}.png" if sphinx \ - else f"{url_prefix}/static/plots/{filename}.png" + else f"{static_prefix}/static/plots/{filename}.png" code_path = f"code/{l_type}_{dataset}{plot_object.name}.html" if sphinx \ else f"{url_prefix if url_prefix else ''}{SCRIPT_NAME}mss/code/{l_type}_{dataset}{plot_object.name}.md" diff --git a/mslib/mswms/mss_plot_driver.py b/mslib/mswms/mss_plot_driver.py index e612c2e98..6ea07536f 100644 --- a/mslib/mswms/mss_plot_driver.py +++ b/mslib/mswms/mss_plot_driver.py @@ -486,7 +486,7 @@ def _load_interpolate_timestep(self): logging.debug("\tInterpolating to cross-section path.") # Re-arange longitude dimension in the data field. var_data = var_data[:, :, lon_indices] - if jump: + if jump.size > 0: logging.debug("\tsetting jump data to NaN at %s", jump) var_data = var_data.copy() var_data[:, :, jump] = np.nan @@ -829,7 +829,7 @@ def _load_interpolate_timestep(self): logging.debug("\tInterpolating to cross-section path.") # Re-arange longitude dimension in the data field. var_data = var_data[:, :, lon_indices] - if jump: + if jump.size > 0: logging.debug("\tsetting jump data to NaN at %s", jump) var_data = var_data.copy() var_data[:, :, jump] = np.nan diff --git a/mslib/mswms/wms.py b/mslib/mswms/wms.py index a3a90e312..a001f353d 100644 --- a/mslib/mswms/wms.py +++ b/mslib/mswms/wms.py @@ -49,22 +49,17 @@ import shutil import tempfile import traceback -import werkzeug -import urllib.parse from defusedxml import ElementTree from chameleon import PageTemplateLoader from owslib.crs import axisorder_yx from PIL import Image import numpy as np -from flask import request, make_response, render_template, Response, abort +from flask import request from flask_httpauth import HTTPBasicAuth -from multidict import CIMultiDict from mslib.mswms.app import create_app from mslib.mswms.app import mswms_settings -from mslib.utils import conditional_decorator -from mslib.utils.get_content import get_content from mslib.utils.time import parse_iso_datetime from mslib.mswms.gallery_builder import add_image, write_html, add_levels, add_times, \ write_doc_index, write_code_pages, STATIC_LOCATION, DOCS_LOCATION @@ -401,12 +396,15 @@ def generate_gallery(self, create=False, clear=False, generate_code=False, sphin if clear and os.path.exists(os.path.join(path, "plots")): shutil.rmtree(os.path.join(path, "plots")) + os.makedirs(os.path.join(path, "plots")) if os.path.exists(os.path.join(path, "plots")): for fn in glob.glob(os.path.join(tmp_path, "plots", "*")): if not os.path.exists(os.path.join(path, "plots", os.path.basename(fn))): shutil.move(fn, os.path.join(path, "plots")) else: - shutil.move(os.path.join(tmp_path, "plots"), path) + if not os.path.exists(path): + os.makedirs(path) + shutil.move(os.path.join(tmp_path, "plots"), os.path.join(path, "plots")) if os.path.exists(os.path.join(path, "code")): shutil.rmtree(os.path.join(path, "code")) if os.path.exists(os.path.join(tmp_path, "code")): @@ -918,89 +916,3 @@ def produce_plot(self, query, mode): server = WMSServer() - - -@APP.route('/') -@conditional_decorator(auth.login_required, mswms_settings.enable_basic_http_authentication) -def application(): - try: - # Request info - query = CIMultiDict(request.args) - # Processing - # ToDo Refactor - request_type = query.get('request') - if request_type is None: # request_type may *actually* be set to None - request_type = '' - request_type = request_type.lower() - request_service = query.get('service', '') - request_service = request_service.lower() - request_version = query.get('version', '') - - url = request.url - server_url = urllib.parse.urljoin(url, urllib.parse.urlparse(url).path) - - if (request_type in ('getcapabilities', 'capabilities') and - request_service == 'wms' and request_version in ('1.1.1', '1.3.0', '')): - return_data, mime_type = server.get_capabilities(query, server_url) - elif request_type in ('getmap', 'getvsec', 'getlsec') and request_version in ('1.1.1', '1.3.0', ''): - return_data, mime_type = server.produce_plot(query, request_type) - else: - logging.debug("Request type '%s' is not valid.", request) - raise RuntimeError("Request type is not valid.") - - res = make_response(return_data, 200) - response_headers = [('Content-type', mime_type), ('Content-Length', str(len(return_data)))] - for response_header in response_headers: - res.headers[response_header[0]] = response_header[1] - - return res - - except Exception as ex: - # without query parameter show index page - query = request.args - if len(query) == 0: - return render_template("/index.html") - - # communicate request errors back to client user - logging.error("Unexpected error: %s: %s\nTraceback:\n%s", - type(ex), ex, traceback.format_exc()) - error_message = "{}: {}\n".format(type(ex), ex) - response_headers = [('Content-type', 'text/plain'), ('Content-Length', str(len(error_message)))] - res = make_response(error_message, 404) - for response_header in response_headers: - res.headers[response_header[0]] = response_header[1] - return res - - -@APP.route("/mss/plots") -def plots(): - if STATIC_LOCATION != "" and os.path.exists(os.path.join(STATIC_LOCATION, 'plots.html')): - _file = os.path.join(STATIC_LOCATION, 'plots.html') - content = get_content(_file) - else: - content = "Gallery was not generated for this server.
      " \ - "For further info on how to generate it, run the " \ - "gallery --help command line parameter of mswms.
      " \ - "An example of the gallery can be seen " \ - "here" - return render_template("/content.html", act="plots", content=content) - - -@APP.route("/mss/code/") -def code(filename): - download = request.args.get("download", False) - _file = werkzeug.security.safe_join(STATIC_LOCATION, "code", filename) - if _file is None: - abort(404) - content = get_content(_file) - if not download: - return render_template("/content.html", act="code", content=content) - else: - if not os.path.isfile(_file): - abort(404) - with open(_file) as f: - text = f.read() - return Response("".join([s.replace("\t", "", 1) for s in text.split("```python")[-1] - .splitlines(keepends=True)][1:-2]), - mimetype="text/plain", - headers={"Content-disposition": f"attachment; filename={filename.split('-')[0]}.py"}) diff --git a/mslib/utils/auth.py b/mslib/utils/auth.py index a906ceb43..34e616166 100644 --- a/mslib/utils/auth.py +++ b/mslib/utils/auth.py @@ -29,10 +29,20 @@ See the License for the specific language governing permissions and limitations under the License. """ - +import datetime +import functools import logging + +import email_validator import keyring +import sqlalchemy +from flask import request, abort, g +from flask_mail import Message +from itsdangerous import URLSafeTimedSerializer, BadSignature +from mslib.mscolab.app import APP +from mslib.mscolab.conf import setup_saml2_backend +from mslib.mscolab.models import User try: from jeepney.wrappers import DBusErrorResponse @@ -111,3 +121,144 @@ def get_auth_from_url_and_name(server_url, http_auth, overwrite_login_cache=True name = None auth = constants.AUTH_LOGIN_CACHE.get(server_url, (name, None)) return auth + + +def check_login(emailid, password): + try: + user = User.query.filter_by(emailid=str(emailid)).first() + except sqlalchemy.exc.OperationalError as ex: + logging.debug("Problem in the database (%ex), likely version client different", ex) + return False + if user is not None: + if APP.config['MAIL_ENABLED']: + if user.confirmed: + if user.verify_password(password): + return user + else: + if user.verify_password(password): + return user + return False + + +def register_user(email, password, username, fullname): + if len(str(email.strip())) == 0 or len(str(username.strip())) == 0: + return {"success": False, "message": "Your username or email cannot be empty"} + is_valid_username = True if username.find("@") == -1 else False + try: + # ToDo verify what changed for check_deliverability + email_validator.validate_email(email, check_deliverability=APP.config['MAIL_ENABLED']) + except (email_validator.exceptions.EmailSyntaxError): + return {"success": False, "message": "Your email ID is not valid!"} + if not is_valid_username: + return {"success": False, "message": "Your username cannot contain @ symbol!"} + user_exists = User.query.filter_by(emailid=str(email)).first() + if user_exists: + return {"success": False, "message": "This email ID is already taken!"} + user_exists = User.query.filter_by(username=str(username)).first() + if user_exists: + return {"success": False, "message": "This username is already registered"} + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + user = User(email, username, password, fullname) + result = fm.modify_user(user, action="create") + return {"success": result} + + +def generate_confirmation_token(email): + serializer = URLSafeTimedSerializer(APP.config['SECRET_KEY']) + return serializer.dumps(email, salt=APP.config['SECURITY_PASSWORD_SALT']) + + +def send_email(to, subject, template): + if APP.config['MAIL_DEFAULT_SENDER'] is not None: + msg = Message( + subject, + recipients=[to], + html=template, + sender=APP.config['MAIL_DEFAULT_SENDER'] + ) + try: + from mslib.mscolab.server import getConfig + mail = getConfig()[4] + mail.send(msg) + except IOError: + logging.error("Can't send email to %s", to) + else: + logging.debug("setup user verification by email") + + +def confirm_token(token, expiration=3600): + serializer = URLSafeTimedSerializer(APP.config['SECRET_KEY']) + try: + email = serializer.loads( + token, + salt=APP.config['SECURITY_PASSWORD_SALT'], + max_age=expiration + ) + except (IOError, BadSignature): + return False + return email + + +def get_idp_entity_id(selected_idp): + """ + Finds the entity_id from the configured IDPs + :return: the entity_id of the idp or None + """ + for config in setup_saml2_backend.CONFIGURED_IDPS: + if selected_idp == config['idp_identity_name']: + idps = config['idp_data']['saml2client'].metadata.identity_providers() + only_idp = idps[0] + entity_id = only_idp + return entity_id + return None + + +def create_or_update_idp_user(email, username, token, authentication_backend): + """ + Creates or updates an idp user in the system based on the provided email, + username, token, and authentication backend. + :param email: idp users email + :param username: idp users username + :param token: authentication token + :param authentication_backend: authenticated identity providers name + :return: bool : query success or not + """ + from mslib.mscolab.server import getConfig + fm = getConfig()[3] + user = User.query.filter_by(emailid=email).first() + if not user: + # using an IDP for a new account/profile, e-mail is already verified by the IDP + confirm_time = datetime.datetime.now(tz=datetime.timezone.utc) + datetime.timedelta(seconds=1) + user = User(email, username, password=token, confirmed=True, confirmed_on=confirm_time, + authentication_backend=authentication_backend) + result = fm.modify_user(user, action="create") + else: + user.authentication_backend = authentication_backend + user.hash_password(token) + result = fm.modify_user(user, action="update_idp_user") + return result + + +def verify_user(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + try: + user = User.verify_auth_token(request.args.get('token', request.form.get('token', False))) + except TypeError: + logging.debug("no token in request form") + abort(404) + if not user: + return "False" + else: + # saving user details in flask.g + if APP.config['MAIL_ENABLED']: + if user.confirmed: + g.user = user + return func(*args, **kwargs) + else: + return "False" + else: + g.user = user + return func(*args, **kwargs) + return wrapper diff --git a/mslib/utils/file_exists.py b/mslib/utils/file_exists.py new file mode 100644 index 000000000..503801620 --- /dev/null +++ b/mslib/utils/file_exists.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +""" + + mslib.utils.file_exists + ~~~~~~~~~~~~~~~~~~~~~~~ + + verifies a given filepath is a file + + This file is part of MSS. + + :copyright: Copyright 2021-2026 by the MSS team, see AUTHORS. + :license: APACHE-2.0, see LICENSE for details. + + 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. +""" +import os + + +def file_exists(filepath=None): + try: + return os.path.isfile(filepath) + except TypeError: + return False diff --git a/tests/_test_mscolab/test_models.py b/tests/_test_mscolab/test_models.py index ebaad8c57..a185e3279 100644 --- a/tests/_test_mscolab/test_models.py +++ b/tests/_test_mscolab/test_models.py @@ -29,8 +29,8 @@ import textwrap from zoneinfo import ZoneInfo -from mslib.mscolab.server import register_user from mslib.mscolab.models import AwareDateTime, User, Permission, Operation, Message, MessageType, Change +from mslib.utils.auth import register_user def test_aware_datetime_conversion(): @@ -112,7 +112,7 @@ def test_change_creation(): class Test_User: @pytest.fixture(autouse=True) def setup(self, mscolab_app): - self.userdata = 'UV10@uv10', 'UV10', 'uv10', 'User UV' + self.userdata = 'UV10@uv10.de', 'UV10', 'uv10.de', 'User UV' with mscolab_app.app_context(): result = register_user(self.userdata[0], self.userdata[1], self.userdata[2], self.userdata[3]) assert result["success"] is True diff --git a/tests/_test_mscolab/test_server.py b/tests/_test_mscolab/test_server.py index b190bcc1e..fc5f966d6 100644 --- a/tests/_test_mscolab/test_server.py +++ b/tests/_test_mscolab/test_server.py @@ -33,10 +33,12 @@ from PIL import Image from mslib.mscolab.app import APP + from mslib.mscolab.models import User, Operation -from mslib.mscolab.server import check_login, register_user + from mslib.mscolab.file_manager import FileManager from mslib.mscolab.seed import add_user, get_user +from mslib.utils.auth import register_user, check_login from tests.utils import XML_CONTENT1, XML_CONTENT2 from mslib.mscolab.seed import XML_CONTENT_INIT @@ -46,7 +48,7 @@ class Test_Server: def setup(self, mscolab_app, mscolab_managers): self.app = mscolab_app self.sockio, _, self.fm = mscolab_managers - self.userdata = 'UV10@uv10', 'UV10', 'uv10', 'User UV' + self.userdata = 'UV10@uv10.de', 'UV10', 'uv10.de', 'User UV' with self.app.app_context(): yield @@ -101,7 +103,7 @@ def test_check_login(self): user = User.query.filter_by(emailid=str(self.userdata[0])).first() assert user is not None assert result == user - result = check_login('UV20@uv20', self.userdata[1]) + result = check_login('UV20@uv20.de', self.userdata[1]) assert result is False def test_get_auth_token(self): diff --git a/tests/_test_mscolab/test_server_auth_required.py b/tests/_test_mscolab/test_server_auth_required.py index bf19cbac7..cb35fda7e 100644 --- a/tests/_test_mscolab/test_server_auth_required.py +++ b/tests/_test_mscolab/test_server_auth_required.py @@ -30,7 +30,9 @@ mscolab_settings.enable_basic_http_authentication = True try: - from mslib.mscolab.server import authfunc, verify_pw, initialize_managers, get_auth_token, register_user + from mslib.mscolab.server import authfunc, verify_pw, initialize_managers + from mslib.mscolab.blueprints.auth import get_auth_token + from mslib.utils.auth import register_user except ImportError: pytest.skip("this test runs only by an explicit call " "e.g. pytest tests/_test_mscolab/test_server_auth_required.py", allow_module_level=True) diff --git a/tests/_test_msui/test_satellite_dockwidget.py b/tests/_test_msui/test_satellite_dockwidget.py index 5d2e9ea92..46b65f75c 100644 --- a/tests/_test_msui/test_satellite_dockwidget.py +++ b/tests/_test_msui/test_satellite_dockwidget.py @@ -55,10 +55,11 @@ def test_load(self): @mock.patch("PyQt5.QtWidgets.QMessageBox.critical") def test_load_no_file(self, mockbox): + self.window.leFile.setText(".") QtTest.QTest.mouseClick(self.window.btLoadFile, QtCore.Qt.LeftButton) assert self.window.cbSatelliteOverpasses.count() == 0 - mockbox.assert_called_once_with( - self.window, - 'Satellite Overpass Tool', - "ERROR:\n\n[Errno 21] Is a directory: '.'" - ) + mockbox.assert_called_once() + args = mockbox.call_args[0] + assert args[0] == self.window + assert args[1] == 'Satellite Overpass Tool' + assert "" in args[2] diff --git a/tests/utils.py b/tests/utils.py index 53f7be29f..3b56243d7 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -28,8 +28,10 @@ import requests from urllib.parse import urljoin -from mslib.mscolab.server import register_user + from flask import json + +from mslib.mscolab.blueprints.auth import register_user from tests.constants import MSUI_CONFIG_FILE_PATH from mslib.mscolab.seed import XML_CONTENT_INIT