Initialisierung: Übertragung aus altem Repository

.gitignore

@@ -0,0 +1,8 @@
+/NateMan.egg-info/
+/build/
+/dist/
+/instance/
+/venv/
+
+# pycache-Verzeichnisse überall ignorieren
+__pycache__/

MANIFEST.in

@@ -0,0 +1,5 @@
+include wsgi.py
+graft nateman/resources
+graft nateman/static
+graft nateman/templates
+global-exclude *.pyc

README.md

@@ -0,0 +1,20 @@
+# NateMan
+
+NateMan (**Na**chschreib**te**rmin-**Man**ager) ist eine Webanwendung zur Koordination von Klausuren gymnasialer Oberstufen. Klausurpläne können aus verschiedenen Formaten (z.B. Kurs42, bald auch UNTIS) importiert oder direkt im Webinterface erstellt werden und sind anschließend öffentlich einsehbar. Über eigene Lehrerkonten können Klausuraufsichten nach einer Klausur Versäumnisse eintragen. Beratungslehrer und Oberstufenkoordinatoren können diese Bearbeitungen einsehen, bei Bedarf ändern und Atteste für Versäumnisse eintragen.
+
+![Klausurliste in NateMan](./screenshots/klausurliste.png)
+
+## Funktionen
+* Import und Bearbeitung von Klausurlisten (aus Kurs42, bald auch UNTIS)
+* administrierbares Anmeldesystem für Lehrkräfte
+* Eintragung von Klausurversäumnissen und Attesten
+* Einsicht und Export (Excel) von Versäumnislisten
+* Klausurerinnerungen per E-Mail
+* öffentlich einsehbare Klausurpläne
+
+## Installation
+NateMan kann wie jede andere Flask-App installiert werden.
+
+Nach dem ersten Start wird automatisch eine ausführlich kommentierte Konfigurationsdatei `config.yml` angelegt. Hier müssen die Einträge `server-name` sowie `uses-ssl` entsprechend angepasst werden. Für die Nutzung des E-Mail-Versands müssen auch die Einträge unter `mail` geändert werden.
+
+Die erste Einrichtung erfolgt über den CLI-Befehl `nateman`. Um ein neues Lehrerkonto mit Administratorrechten anzulegen, führen Sie `nateman add-lehrer --admin <KÜRZEL>` aus. Mit diesem Konto können Sie sich anschließend im Webinterface anmelden.

nateman/__init__.py

@@ -0,0 +1,166 @@
+# NateMan – Nachschreibtermin-Manager
+# __init__.py
+# Copyright © 2020  Niklas Elsbrock
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""
+Enthält die Initialisierungsfunktion der NateMan-Webapp.
+"""
+
+import locale
+import logging.handlers
+import os
+import sys
+from datetime import datetime
+
+import sqlalchemy
+from flask import abort, Flask, request, send_from_directory
+from flask.logging import default_handler
+from werkzeug.utils import find_modules, import_string
+
+from . import util
+from .config_manager import config_file_exists, create_config_file, config
+from .config_manager import read_config_file
+from .models import Klausur, Klausurteilnahme, Koopschule, Lehrer, Schueler, Stufe, db
+
+
+def create_app() -> Flask:
+    """Initialisiert die NateMan-Webapp"""
+
+    app: Flask = Flask(__name__, instance_relative_config=True)
+
+    # Sprache festlegen
+    locale.setlocale(locale.LC_ALL, "")
+
+    setup_logging(app)
+
+    # falls nötig, instance-Ordner anlegen
+    os.makedirs(app.instance_path, exist_ok=True)
+
+    load_config(app)
+
+    secret_key = read_or_generate_secret_key(app)
+
+    configure_jinja(app)
+
+    # Falls in der Konfiguration aktiviert, Datei-Logging einrichten
+    if config["logging"].get("syslog", False):
+        setup_syslog(app)
+
+    # Logging-Level ändern
+    app.logger.setLevel(config["logging"]["level"])
+
+    # Flask und Flask-SQLAlchemy konfigurieren
+    app.config.from_mapping(
+        SERVER_NAME=config["server-name"],
+        SECRET_KEY=secret_key,
+        PREFERRED_URL_SCHEME="https" if config["uses-ssl"] else "http",
+        SESSION_COOKIE_SECURE=config["uses-ssl"],
+        MAX_CONTENT_LENGTH=16 * 1024 * 1024,  # 16 MiB upload limit
+        SQLALCHEMY_DATABASE_URI="sqlite:///" + os.path.join(app.instance_path, "nateman.sqlite3"),
+        SQLALCHEMY_TRACK_MODIFICATIONS=False
+    )
+
+    db.init_app(app)
+    db.create_all(app=app)
+
+    # Blueprints registrieren
+    register_blueprints(app)
+
+    return app
+
+
+def setup_logging(app: Flask):
+    stdout_handler = logging.StreamHandler(sys.stdout)
+    formatter = logging.Formatter(
+        fmt="[%(asctime)s | %(levelname)s]: %(message)s"
+    )
+    stdout_handler.setFormatter(formatter)
+    app.logger.removeHandler(default_handler)
+    app.logger.addHandler(stdout_handler)
+
+
+def load_config(app: Flask):
+    """
+    Liest die Konfigurationsdatei.
+    Falls keine vorhanden ist, erstellt eine und beendet anschließend NateMan.
+    """
+    if not config_file_exists(app):
+        app.logger.critical("Die Konfigurationsdatei konnte nicht gefunden werden, erstellt eine neue...")
+        config_path = create_config_file(app)
+        app.logger.critical(f"Da die Konfigurationsdatei nicht gefunden werden konnte, "
+                            f"wurde eine neue erstellt ({config_path}). NateMan wird nun beendet.")
+        sys.exit(1)
+
+    # Konfigurationsdatei laden
+    read_config_file(app)
+
+
+def read_or_generate_secret_key(app: Flask) -> bytes:
+    """ Liest den Secret Key aus bzw. generiert ihn, falls noch keiner vorhanden ist. """
+    secret_key_path = os.path.join(app.instance_path, "SECRET_KEY")
+
+    if not os.path.isfile(secret_key_path):
+        with open(os.open(secret_key_path, os.O_WRONLY | os.O_CREAT, mode=0o600), "wb") as file:
+            secret_key = os.urandom(128)
+            file.write(secret_key)
+    else:
+        with open(secret_key_path, "rb") as file:
+            secret_key = file.read()
+
+    return secret_key
+
+
+def configure_jinja(app: Flask):
+    app.jinja_env.globals.update(
+        nateman_config=config,
+        util=util,
+        sqlalchemy=sqlalchemy,
+        datetime=datetime,
+        db=db,
+        Klausurteilnahme=Klausurteilnahme,
+        Stufe=Stufe,
+        Schueler=Schueler,
+        Lehrer=Lehrer,
+        Klausur=Klausur,
+        Koopschule=Koopschule
+    )
+    app.jinja_env.trim_blocks = True
+    app.jinja_env.lstrip_blocks = True
+    app.jinja_env.strip_trailing_newlines = False
+
+
+def setup_syslog(app: Flask):
+    """ Erstellt Logging-Handler zum loggen in Syslog. """
+    file_handler = logging.handlers.SysLogHandler(address="/dev/log")
+    file_formatter = logging.Formatter(fmt="nateman: [%(levelname)s] %(message)s")
+    file_handler.setFormatter(file_formatter)
+    app.logger.addHandler(file_handler)
+
+
+def register_blueprints(app: Flask):
+    """ Registriert die Flask-Blueprints """
+    from . import blueprints
+    from .blueprints import admin, auth, error, fileio, info, klausuren, schueler
+    from .blueprints.admin import lehrer as admin_lehrer
+    app.register_blueprint(blueprints.bp)
+    app.register_blueprint(admin.bp)
+    app.register_blueprint(admin_lehrer.bp, name="admin.lehrer")
+    app.register_blueprint(auth.bp)
+    app.register_blueprint(error.bp)
+    app.register_blueprint(fileio.bp)
+    app.register_blueprint(info.bp)
+    app.register_blueprint(klausuren.bp)
+    app.register_blueprint(schueler.bp)