moved methods to the rigth blueprint path and added description to the blueprints.

Author: JanEisermann

mslib/mscolab/app/__init__.py

@@ -29,17 +29,17 @@
 import sqlalchemy
 
 from flask_migrate import Migrate
-from flask import Flask, Blueprint
+from flask import Flask
 
 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.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.file_exists import file_exists
-from mslib.utils.get_content import get_content
 from xstatic.main import XStatic
 
 
@@ -51,12 +51,6 @@
 # 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', '/')
 
-DOCS_BP = Blueprint(
-    "docs",
-    __name__,
-    template_folder=os.path.join(DOCS_TEMPLATES_DIR)
-)
-
 
 message, update = release_info.check_for_new_release()
 if update:
@@ -103,82 +97,6 @@ def create_app(imprint=None, gdpr=None):
     APP.jinja_env.globals["gdpr"] = gdpr_file
     APP.jinja_env.globals.update(get_topmenu=get_topmenu)
 
-    @DOCS_BP.route('/xstatic/<name>/<path:filename>')
-    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)
-
-    @DOCS_BP.route('/mss_theme/img/<path:filename>')
-    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("/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 = ('<img alt="image" src="/mss/overview.png" />',
-                          '<img class="mx-auto d-block img-fluid" alt="image" src="/mss/overview.png" />')
-        content = get_content(_file, md_overrides=md_overrides, html_overrides=html_overrides)
-        return render_template("/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("/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 = ('<img alt="Waypoint Tutorial" '
-                          'src="https://mss.readthedocs.io/en/stable/_images/tutorial_waypoints.gif" />',
-                          '<img  class="mx-auto d-block img-fluid" alt="Waypoint Tutorial" '
-                          'src="https://mss.readthedocs.io/en/stable/_images/tutorial_waypoints.gif" />')
-        content = get_content(_file, html_overrides=html_overrides)
-        return render_template("/content.html", act="help", content=content)
-
-    @DOCS_BP.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 ""
-
-    @DOCS_BP.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 ""
-
-    @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)
     APP.register_blueprint(DOCS_BP)
     return APP
 

mslib/mscolab/blueprints/auth/auth.py

@@ -1,18 +1,38 @@
+# -*- coding: utf-8 -*-
+"""
+
+    mslib.mscolab.blueprints.auth.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 functools
 import json
 import logging
 import secrets
 
-import sqlalchemy
-import email_validator
-# Todo use the name email_validator
-from email_validator import validate_email
-from flask import Blueprint, request, url_for, render_template, jsonify, flash, redirect, abort, g
+from flask import Blueprint, request, url_for, render_template, jsonify, flash, redirect
 from flask_httpauth import HTTPBasicAuth
-from flask_mail import Message
 from flask.wrappers import Response
-from itsdangerous import URLSafeTimedSerializer, BadSignature
 from saml2 import BINDING_HTTP_REDIRECT, BINDING_HTTP_POST
 from saml2.metadata import create_metadata_string
 
@@ -21,148 +41,8 @@
 from mslib.mscolab.models import User
 from mslib.mscolab.app import APP
 from mslib.utils import conditional_decorator
-
-
-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
-        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
-
+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__)
 auth_basic_auth = HTTPBasicAuth()