viewo-api 1.0.0__tar.gz

viewo_api-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Helmut Konrad Schewe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

viewo_api-1.0.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: viewo_api
+Version: 1.0.0
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/viewo_api
+Project-URL: Repository, https://github.com/anaticulae/viewo_api
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask<4.0.0,>=3.1.3
+Requires-Dist: flask-login<1.0.0,>=0.6.3
+Requires-Dist: flask-mail<1.0.0,>=0.10.0
+Requires-Dist: utilo<3.0.0,>=2.112.1
+Requires-Dist: configos<2.0.0,>=1.0.4
+Provides-Extra: dev
+Requires-Dist: utilotest<2.0.0,>=1.1.1; extra == "dev"
+Requires-Dist: pytest-localserver<2.0.0,>=0.10.0; extra == "dev"
+Requires-Dist: aiosmtpd==1.4.6; extra == "dev"
+Dynamic: license-file
+
+# viewo_api

viewo_api-1.0.0/README

@@ -0,0 +1 @@
+# viewo_api

viewo_api-1.0.0/pyproject.toml

@@ -0,0 +1,89 @@
+[project]
+name = "viewo_api"
+version = "1.0.0"
+description = ""
+requires-python = ">=3.12"
+authors = [
+    { name = "Helmut Konrad Schewe", email = "helmutus@outlook.com" },
+]
+dependencies = [
+    "flask>=3.1.3,<4.0.0",
+    "flask-login>=0.6.3,<1.0.0",
+    "flask-mail>=0.10.0,<1.0.0",
+    "utilo>=2.112.1,<3.0.0",
+    "configos>=1.0.4,<2.0.0",
+]
+keywords = []
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+
+[project.readme]
+file = "README"
+content-type = "text/markdown"
+
+[project.optional-dependencies]
+dev = [
+    "utilotest>=1.1.1,<2.0.0",
+    "pytest-localserver>=0.10.0,<2.0.0",
+    "aiosmtpd==1.4.6",
+]
+
+[project.urls]
+Homepage = "https://github.com/anaticulae/viewo_api"
+Repository = "https://github.com/anaticulae/viewo_api"
+
+[project.scripts]
+viewo_api = "viewo_api.cli:main"
+
+[build-system]
+requires = [
+    "setuptools>=82.0.1",
+    "wheel>=0.46.3",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+
+[tool.semantic_release.changelog]
+mode = "init"
+output_format = "md"
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG"
+
+[tool.semantic_release.commit_parser_options]
+patch_tags = [
+    "fix",
+    "perf",
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "style",
+    "refactor",
+    "test",
+    "deps",
+]
+
+[tool.setuptools.packages.find]
+where = [
+    ".",
+]
+include = [
+    "viewo_api",
+    "viewo_api.mail",
+    "viewo_api.user",
+]
+exclude = [
+    "tests/*",
+]

viewo_api-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

viewo_api-1.0.0/tests/test_login.py

@@ -0,0 +1,58 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import http
+
+import utilotest
+
+import viewo_api
+import viewo_api.user.state
+
+PASSWORD = 'helmut1337'  # nosec
+MAIL = 'modern@modern.com'
+
+
+def test_login_logout(client):  # pylint:disable=W0613
+    user = viewo_api.create_user(password=PASSWORD)
+    utilotest.apipost(
+        client,
+        '/login',
+        data={
+            'user': user.userid,
+            'password': PASSWORD,
+        },
+    )
+    utilotest.apicall(client, '/logout')
+
+
+def test_login_wrong_password(client):  # pylint:disable=W0613
+    user = viewo_api.create_user(password=PASSWORD)
+    utilotest.apipost(
+        client,
+        '/login',
+        data={
+            'user': user.userid,
+            'password': 'wrong'
+        },  # nosec
+        expected=http.HTTPStatus.FORBIDDEN,
+    )
+
+
+def test_login_withmail(client):  # pylint:disable=W0613
+    user = viewo_api.create_user(password=PASSWORD)
+    assert viewo_api.user_email_update(email=MAIL, userid=user.userid)
+    utilotest.apipost(
+        client,
+        '/login',
+        data={
+            'user': MAIL,
+            'password': PASSWORD,
+        },
+    )
+    utilotest.apicall(client, '/logout')

viewo_api-1.0.0/tests/test_visitor.py

@@ -0,0 +1,18 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import utilotest
+
+
+def test_request(client):  # pylint:disable=W0621
+    response = utilotest.decode(client.get('/return_request'))
+    assert 'Env(hashed=' in response
+    # assert "agent='Werkzeug/3.1.8', method='GET', path='/return_request'" in response
+    assert "agent='Werkzeug/" in response
+    assert "', method='GET', path='/return_request'" in response

viewo_api-1.0.0/viewo_api/__init__.py

@@ -0,0 +1,46 @@
+#==============================================================================
+# C O P Y R I G H T
+#------------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+#==============================================================================
+
+import importlib.metadata
+import os
+
+from viewo_api.mail.send import send_mail
+from viewo_api.mail.tech import send_upload_info
+from viewo_api.message import bad
+from viewo_api.message import internal
+from viewo_api.message import notfound
+from viewo_api.message import success
+from viewo_api.user.config import userspath
+from viewo_api.user.create import create_user
+from viewo_api.user.data import FlaskUser
+from viewo_api.user.data import User
+from viewo_api.user.data import hash_email
+from viewo_api.user.data import user_fromid
+from viewo_api.user.data import userlist_raw
+from viewo_api.user.data import userpublic_fromid
+from viewo_api.user.password import password_generate
+from viewo_api.user.password import password_public_set
+from viewo_api.user.password import password_valid
+from viewo_api.user.password import password_verify
+from viewo_api.user.password import username_valid
+from viewo_api.user.state import login
+from viewo_api.user.state import logout
+from viewo_api.user.update import user_append_document
+from viewo_api.user.update import user_email_update
+from viewo_api.user.update import user_update
+from viewo_api.utils import json
+from viewo_api.visitor import access
+from viewo_api.visitor import oneline
+from viewo_api.visitor import request
+from viewo_api.visitor import user_current
+from viewo_api.visitor import user_hash
+
+__version__ = importlib.metadata.version('viewo_api')
+
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))

viewo_api-1.0.0/viewo_api/config.py

@@ -0,0 +1,49 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import configos
+import flask
+
+PASSWORD_SALT = configos.HV_STR(default='THISISSALT')
+
+PASSWORD_DIGITS = configos.HV_INT_PLUS(default=64)
+
+PASSWORD_RANDOM_LENGTH = configos.HV_INT_PLUS(default=16)
+
+PASSWORD_MIN_LENGTH = configos.HV_INT_PLUS(default=8)
+PASSWORD_MAX_LENGTH = configos.HV_INT_PLUS(default=64)
+
+USER_LENGTH = configos.HV_INT_PLUS(default=16)
+
+EMAIL_SALT = configos.HV_STR(default='EMAILNOGMAIL')
+
+EMAIL_DIGITS = configos.HV_INT_PLUS(default=64)
+
+EMAIL_NO_AUTHOR = configos.HV_STR(default='postkasten@checkitweg.de')
+
+EMAIL_SERVER = configos.HV_STR(default='guardian@checkitweg.de')
+# inform admin about new customer
+EMAIL_CUSTOMER_NEW = configos.env('CHANIA_CUSTOMER_NEW', default=None)
+
+
+def common():
+    return flask.current_app.config['COMMON']
+
+
+def todo():
+    return flask.current_app.config['TODO']
+
+
+def ready():
+    return flask.current_app.config['READY']
+
+
+configos.todo = todo
+configos.ready = ready
+configos.share = common

viewo_api-1.0.0/viewo_api/mail/__init__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================

viewo_api-1.0.0/viewo_api/mail/app.py

@@ -0,0 +1,33 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+import flask_mail
+
+
+def register(app):
+    mail = flask_mail.Mail(app)
+    app.mail = mail
+
+
+def configure(
+    server,
+    user=None,
+    password=None,
+    tls: bool = False,
+    port: int = 587,
+):
+    config = flask.current_app.config
+    config['MAIL_SERVER'] = server
+    config['MAIL_PORT'] = port
+    config['MAIL_USERNAME'] = user
+    config['MAIL_PASSWORD'] = password
+    config['MAIL_USE_TLS'] = tls
+    config['MAIL_SUPPRESS_SEND'] = False
+    flask.current_app.mail.init_app(flask.current_app)

viewo_api-1.0.0/viewo_api/mail/send.py

@@ -0,0 +1,37 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+import flask_mail
+
+import viewo_api.config
+
+
+def send_mail(
+    recipient: str,
+    subject: str,
+    body: str,
+    author: str = viewo_api.config.EMAIL_NO_AUTHOR,
+):
+    msg = flask_mail.Message(
+        recipients=[recipient],
+        subject=subject,
+        body=body,
+        sender=author.value,
+    )
+    flask.current_app.mail.send(msg)
+    # threading.Thread(
+    #     target=send_async,
+    #     args=[flask.current_app, msg],
+    # ).start()
+
+
+# def send_async( msg):
+#     with app.app_context():
+#         app.mail.send(msg)

viewo_api-1.0.0/viewo_api/mail/tech.py

@@ -0,0 +1,42 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import utilo
+
+import viewo_api
+import viewo_api.config
+
+MESSAGE_NEW_SUBJECT = 'New Customer'
+MESSAGE_NEW_BODY = """\
+New customer on the line!
+
+{data}
+"""
+
+
+def send_upload_info(data: dict = None):
+    if viewo_api.config.EMAIL_CUSTOMER_NEW is None:
+        msg = 'CONFIGURE: CHANIA_CUSTOMER_NEW could not send_upload_info'
+        utilo.error(msg)
+        return
+    data = utilo.dict_dump(data) if data else ''
+    body = MESSAGE_NEW_BODY.format(data=data)
+    viewo_api.send_mail(
+        recipient=viewo_api.config.EMAIL_CUSTOMER_NEW,
+        subject=MESSAGE_NEW_SUBJECT,
+        body=body,
+    )
+
+
+def send_server_status():
+    pass
+
+
+def send_login_request():
+    """Send token before login into admin area."""

viewo_api-1.0.0/viewo_api/mail/user.py

@@ -0,0 +1,19 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+# import viewo_api.mail.send
+
+# TEMPLATE = """\
+# Änderung erfordert Bestätigung
+
+# """
+
+# def verify_change(email: str, token: str, title: str, message: str):
+#     """Send E-Mail to user to verify user action."""
+#     # viewo_api.email.send.email()

viewo_api-1.0.0/viewo_api/message.py

@@ -0,0 +1,48 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+
+import viewo_api
+
+
+def success(message: str = 'completed', **args):
+    result = viewo_api.json({
+        'message': message,
+        **args,
+    })
+    return result, 200
+
+
+def notfound(message: str):
+    result = viewo_api.json({
+        'error': 'not found',
+        'message': message,
+    })
+    return result, 404
+
+
+def bad(message: str):
+    result = viewo_api.json({
+        'error': 'bad request',
+        'message': message,
+    })
+    return result, 400
+
+
+def internal(message: str):
+    result = viewo_api.json({
+        'error': 'internal',
+        'message': message,
+    })
+    return result, 500
+
+
+def flash(message: str):
+    flask.flash(message)

viewo_api-1.0.0/viewo_api/user/__init__.py

@@ -0,0 +1,14 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Users
+=====
+
+* public user: open browser and view page
+* private user: account which is logged in via login form
+"""

viewo_api-1.0.0/viewo_api/user/config.py

@@ -0,0 +1,18 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import os
+
+import viewo_api.config
+
+
+def userspath():
+    result = os.path.join(viewo_api.config.common(), 'users')
+    os.makedirs(result, exist_ok=True)
+    return result

viewo_api-1.0.0/viewo_api/user/create.py

@@ -0,0 +1,31 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import os
+
+import utilo
+
+import viewo_api.config
+import viewo_api.user.data
+import viewo_api.user.password
+import viewo_api.user.update
+
+
+def create_user(password: str, userid: str = None):
+    # validate password
+    password = viewo_api.user.password.hashed(password)
+    # generate new random user name
+    if not userid:
+        userid = utilo.tmpname(viewo_api.config.USER_LENGTH)
+        while os.path.exists(viewo_api.user.data.userpath(userid, False)):
+            userid = utilo.tmpname(viewo_api.config.USER_LENGTH)
+    new = viewo_api.user.data.User(userid=userid, password=password)
+    # write to user database
+    viewo_api.user.update.user_update(new)
+    return new

viewo_api-1.0.0/viewo_api/user/data.py

@@ -0,0 +1,129 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import dataclasses
+import os
+
+import flask_login
+import utilo
+
+import viewo_api.user.config
+import viewo_api.user.password
+import viewo_api.user.serialize
+
+
+@dataclasses.dataclass(unsafe_hash=True)
+class User:
+    email: str = None
+    password: str = None
+    documents: list = dataclasses.field(default_factory=list)
+    payed: int = None
+    userid: str = None
+
+    def append_document(self, documentid: str):
+        assert documentid not in self.documents  # pylint:disable=E1135
+        self.documents.append(documentid)  # pylint:disable=E1101
+
+    def __getitem__(self, index):
+        return self.documents[index]  # pylint:disable=E1136
+
+
+Users = list[User]
+
+
+def user_fromid(userid: str) -> User:
+    path = userpath(userid, verify=True)
+    if not path:
+        # try to find user via email
+        user = user_from_email(userid)
+        return user
+    if not path:
+        return None
+    loaded = viewo_api.user.serialize.load_user(path)
+    return loaded
+
+
+def user_from_email(email: str) -> User:
+    email = hash_email(email)
+    for user in users():
+        if user.email != email:
+            continue
+        return user
+    return None
+
+
+def userpath(userid: int, verify: bool = False) -> str:
+    result = os.path.join(viewo_api.user.config.userspath(), userid)
+    if verify and not os.path.exists(result):
+        return None
+    return result
+
+
+def users():
+    upath = viewo_api.user.config.userspath()
+    common_user = viewo_api.user.serialize.load_users(upath)
+    return common_user
+
+
+def userlist_raw():
+    upath = viewo_api.user.config.userspath()
+    common_user = viewo_api.user.serialize.load_users(upath)
+    raw = [viewo_api.user.serialize.user_raw(item) for item in common_user]
+    return raw
+
+
+def userpublic_fromid(userid: str) -> dict:
+    """Returns public data which are not security/data privacy
+    relevant."""
+    user = user_fromid(userid)
+    if not user:
+        return None
+    result = {
+        'user': userid,
+        'documents': list(user.documents),
+    }
+    if user.email:
+        # TODO: IS THIS A GOOD IDEA?
+        # TODO: VERIFY BEFORE RELEASE XXX
+        result['email'] = user.email
+    if user.payed is not None:
+        result['payed'] = user.payed
+    return result
+
+
+def hash_email(email: str):
+    """\
+    >>> hash_email('toy@roy.com')
+    '...'
+    """
+    email = utilo.secure_hash(
+        email,
+        salt=viewo_api.config.EMAIL_SALT,
+        digits=viewo_api.config.EMAIL_DIGITS,
+    )
+    return email
+
+
+@dataclasses.dataclass
+class FlaskUser(flask_login.UserMixin):
+    identifier: str = None
+
+    def get_id(self):
+        return self.identifier
+
+    @property
+    def payed(self):
+        user = user_fromid(self.identifier)
+        if not user:
+            return 0
+        return user.payed
+
+    @property
+    def is_admin(self):
+        return False

viewo_api-1.0.0/viewo_api/user/password.py

@@ -0,0 +1,101 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+import utilo
+
+import viewo_api.config
+import viewo_api.user
+
+
+class PasswordError(ValueError):
+    pass
+
+
+class PasswordTooShort(PasswordError):
+    pass
+
+
+class PasswordTooLong(PasswordError):
+    pass
+
+
+def password_valid(password: str) -> bool:
+    """\
+    >>> password_valid('short')
+    Traceback (most recent call last):
+        ...
+    viewo_api.user.password.PasswordTooShort
+
+    >>> password_valid('VeryLongPassword1337')
+    True
+    """
+    if password is None:
+        return False
+    password = str(password)
+    if len(password) < viewo_api.config.PASSWORD_MIN_LENGTH:
+        raise PasswordTooShort
+    if len(password) > viewo_api.config.PASSWORD_MAX_LENGTH:
+        raise PasswordTooLong
+    return True
+
+
+def hashed(password: str) -> str:
+    """\
+    >>> len(hashed('nononono'))
+    64
+    """
+    password_valid(password)
+    password = utilo.secure_hash(
+        password,
+        salt=viewo_api.config.PASSWORD_SALT,
+        digits=viewo_api.config.PASSWORD_DIGITS,
+    )
+    return password
+
+
+def password_generate(length=viewo_api.config.PASSWORD_RANDOM_LENGTH) -> str:
+    """\
+    >>> assert len(password_generate(10)) == 10
+    """
+    random = utilo.tmpname(length)
+    return random
+
+
+def password_verify(userid: str, password: str) -> bool:
+    user = viewo_api.user.data.user_fromid(userid)
+    if not user:
+        # try to select user via email
+        user = viewo_api.user.data.user_from_email(userid)
+    if not user:
+        return False
+    try:
+        password = viewo_api.user.password.hashed(password)
+    except viewo_api.user.password.PasswordError:
+        return False
+    return password == user.password
+
+
+def password_public_set(password: str):
+    # TODO: CHECK FOR SECURITY ISSUES
+    flask.globals.session['password_raw'] = password
+
+
+def username_valid(name) -> False:
+    """\
+    >>> username_valid('not a valid user')
+    False
+    >>> username_valid('012ABxxF012ABxxF')
+    True
+    >>> username_valid(' 12  xxx')
+    False
+    """
+    if not len(name) == viewo_api.config.USER_LENGTH:
+        return False
+    return all(item.isalnum() for item in name)

viewo_api-1.0.0/viewo_api/user/serialize.py

@@ -0,0 +1,51 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import os
+
+import utilo
+
+import viewo_api.user.data
+
+
+def user_raw(user: 'User') -> dict:
+    result = {
+        'documents': user.documents,
+        'userid': user.userid,
+        'payed': user.payed,
+    }
+    return result
+
+
+def dump_users(users: 'Users', path: str):
+    assert os.path.exists(path), path
+    for user in users:
+        dumped = dump_user(user)
+        outpath = os.path.join(path, user.userid)
+        utilo.file_replace(outpath, dumped)
+
+
+def load_users(path: str) -> 'Users':
+    assert os.path.exists(path), path
+    files = utilo.file_list(path)
+    files = utilo.files_sort(files)
+    loaded = [load_user(os.path.join(path, item)) for item in files]
+    return loaded
+
+
+def dump_user(user: 'User') -> str:
+    raw = vars(user)
+    dumped = utilo.yaml_dump(raw)
+    return dumped
+
+
+def load_user(path: str) -> 'User':
+    loaded = utilo.yaml_load(path)
+    result = viewo_api.user.data.User(**loaded)
+    return result

viewo_api-1.0.0/viewo_api/user/state.py

@@ -0,0 +1,30 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask_login
+
+import viewo_api.message
+import viewo_api.user.data
+
+
+def login(userid: str, password: str, publicpassword: bool = False):
+    if not viewo_api.password_verify(userid, password):
+        return False
+    flask_login.login_user(viewo_api.FlaskUser(userid))
+    if publicpassword:
+        viewo_api.password_public_set(password)
+    viewo_api.message.flash('Login erfolgreich.')
+    return True
+
+
+def logout():
+    flask_login.logout_user()
+    # remove public password
+    viewo_api.password_public_set('')
+    viewo_api.message.flash('Logout erfolgreich.')

viewo_api-1.0.0/viewo_api/user/token.py

@@ -0,0 +1,10 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+# TODO: SEE MAIL.USER

viewo_api-1.0.0/viewo_api/user/update.py

@@ -0,0 +1,49 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import utilo
+
+import viewo_api
+import viewo_api.user.data
+import viewo_api.user.serialize
+
+
+def user_update(user: 'User', verify=False) -> bool:
+    path = viewo_api.user.data.userpath(user.userid, verify=verify)
+    if not path:
+        return False
+    dumped = viewo_api.user.serialize.dump_user(user)
+    # TODO: NOT THREAD SAFE
+    utilo.file_replace(path, dumped)
+    return True
+
+
+PUBLIC_OWNER = '00000000'
+
+
+def user_append_document(userid: str, documentid: str) -> bool:
+    # TODO: REPLACE LATER
+    if userid == PUBLIC_OWNER:
+        # if userid == link.PUBLIC_OWNER:
+        # do not add public document to public user
+        return False
+    user = viewo_api.user.data.user_fromid(userid)
+    user.append_document(documentid)
+    user_update(user)
+    return True
+
+
+def user_email_update(email: str, userid: str = None) -> bool:
+    user = viewo_api.user.data.user_fromid(userid)
+    if not user:
+        return False
+    user.email = viewo_api.hash_email(email)
+    # write to user database
+    user_update(user)
+    return True

viewo_api-1.0.0/viewo_api/utils.py

@@ -0,0 +1,14 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+
+
+def json(content) -> dict:
+    return flask.jsonify(content)

viewo_api-1.0.0/viewo_api/visitor.py

@@ -0,0 +1,68 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import collections
+
+import flask
+import utilo
+
+Access = collections.namedtuple('Access', 'ip, agent')
+Env = collections.namedtuple(
+    'Env',
+    'hashed, time, ip, agent, method, path, data, dictum',
+)
+
+
+def request() -> Env:
+    env = flask.request.environ
+    if not env:
+        return None
+    ip = env.get('REMOTE_ADDR', 'NO_REMOTE_ADDR')
+    agent = env.get('HTTP_USER_AGENT', 'NO_HTTP_USER_AGENT')
+    hashed = user_hash(ip, agent)
+    method = env.get('REQUEST_METHOD', 'NO_USER_AGENT')
+    path = env.get('PATH_INFO', 'NO_PATH_INFO')
+    data = env.get('QUERY_STRING', 'NO_QUERY_STRING')
+    data = oneline(data)
+    time = utilo.now()
+    try:
+        dictum = flask.request.form.to_dict()
+    except OSError:
+        utilo.error(f'invalid/incomplete request: {flask.request}')
+        utilo.debug(vars(flask.request))
+        dictum = {}
+    return Env(hashed, time, ip, agent, method, path, data, dictum)
+
+
+def user_hash(ip, agent) -> int:
+    return hash(f'{ip}:{agent}')
+
+
+def access(env: Env):
+    return Access(env.ip, env.agent)
+
+
+def user_current() -> int:
+    current = request()
+    hashed = user_hash(current.ip, current.agent)
+    return hashed
+
+
+def oneline(data, limit: int = 256):
+    r"""Remove newlines and shrink content to `limit` to avoid logging to
+    mutch data.
+
+    >>> oneline('first\nnewline')
+    'first%NL%newline'
+    """
+    data = data.replace('\r\n', '%WNL%')
+    data = data.replace('\n', '%NL%')
+    data = data.replace(' ', '%WS%')
+    data = data[0:limit]
+    return data

viewo_api-1.0.0/viewo_api.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: viewo_api
+Version: 1.0.0
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/viewo_api
+Project-URL: Repository, https://github.com/anaticulae/viewo_api
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask<4.0.0,>=3.1.3
+Requires-Dist: flask-login<1.0.0,>=0.6.3
+Requires-Dist: flask-mail<1.0.0,>=0.10.0
+Requires-Dist: utilo<3.0.0,>=2.112.1
+Requires-Dist: configos<2.0.0,>=1.0.4
+Provides-Extra: dev
+Requires-Dist: utilotest<2.0.0,>=1.1.1; extra == "dev"
+Requires-Dist: pytest-localserver<2.0.0,>=0.10.0; extra == "dev"
+Requires-Dist: aiosmtpd==1.4.6; extra == "dev"
+Dynamic: license-file
+
+# viewo_api

viewo_api-1.0.0/viewo_api.egg-info/SOURCES.txt

@@ -0,0 +1,30 @@
+LICENSE
+README
+pyproject.toml
+tests/test_login.py
+tests/test_visitor.py
+viewo_api/__init__.py
+viewo_api/config.py
+viewo_api/message.py
+viewo_api/utils.py
+viewo_api/visitor.py
+viewo_api.egg-info/PKG-INFO
+viewo_api.egg-info/SOURCES.txt
+viewo_api.egg-info/dependency_links.txt
+viewo_api.egg-info/entry_points.txt
+viewo_api.egg-info/requires.txt
+viewo_api.egg-info/top_level.txt
+viewo_api/mail/__init__.py
+viewo_api/mail/app.py
+viewo_api/mail/send.py
+viewo_api/mail/tech.py
+viewo_api/mail/user.py
+viewo_api/user/__init__.py
+viewo_api/user/config.py
+viewo_api/user/create.py
+viewo_api/user/data.py
+viewo_api/user/password.py
+viewo_api/user/serialize.py
+viewo_api/user/state.py
+viewo_api/user/token.py
+viewo_api/user/update.py

viewo_api-1.0.0/viewo_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

viewo_api-1.0.0/viewo_api.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+viewo_api = viewo_api.cli:main

viewo_api-1.0.0/viewo_api.egg-info/requires.txt

@@ -0,0 +1,10 @@
+flask<4.0.0,>=3.1.3
+flask-login<1.0.0,>=0.6.3
+flask-mail<1.0.0,>=0.10.0
+utilo<3.0.0,>=2.112.1
+configos<2.0.0,>=1.0.4
+
+[dev]
+utilotest<2.0.0,>=1.1.1
+pytest-localserver<2.0.0,>=0.10.0
+aiosmtpd==1.4.6

viewo_api-1.0.0/viewo_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+viewo_api