Merge pull request 'DatabaseUserManager' (#25) from DatabaseUserManager into dev

Reviewed-on: #25
Reviewed-by: niklas.ortmann <ortmann.niklas@yahoo.de>

.idea/dataSources/315cb5c9-2b0f-435b-b602-59823b160908/storage_v2/_src_/schema/main.uQUzAA.meta

@@ -1,2 +0,0 @@
-#n:main
-!<md> [0, 0, null, null, -2147483648, -2147483648]

content/deleteAccount.php

@@ -1,19 +0,0 @@
-<?php
-require_once "php/model/LocalUserManager.php";
-
-$dao = new LocalUserManager();
-
-/*
-    Deregistrierung
-    Funktion: Entfernt User aus Dummy-Daten und beendet Session
-*/
-
-if (isset($_SESSION["user_email"])) {
-    $dao->deleteUser($_SESSION["user_email"]);
-}
-
-$_SESSION = [];
-session_destroy();
-
-header("Location: index.php");
-exit();

index.php

@@ -17,12 +17,12 @@ if ($pfad === "register") {
 }
 
 if ($pfad === "logout") {
-    include_once "content/logout.php";
+    include_once "content/logout-controller.php";
     exit();
 }
 
 if ($pfad === "deleteAccount") {
-    include_once "content/deleteAccount.php";
+    include_once "content/deleteAccount-controller.php";
     exit();
 }
 ?>

php/controller/createArticle-controller.php

@@ -3,7 +3,6 @@ SESSION_START();
 require_once '../model/LocalArticleManager.php';
 require_once '../model/ArticleManager.php';
 require_once '../validator/article-validator.php';
-require_once "../model/LocalUserManager.php";
 
     if ($_SERVER["REQUEST_METHOD"] === "POST") {
         $_SESSION["old_title"]    = $_POST["title"] ?? '';

php/controller/deleteAccount-controller.php

@@ -0,0 +1,30 @@
+<?php
+
+require_once "php/model/UserManager.php";
+
+/*
+    Deregistrierung
+    Funktion: Entfernt User aus der Datenbank und beendet die Session
+*/
+
+try {
+
+    $dao = UserManager::getInstance();
+
+    if (isset($_SESSION["user_email"])) {
+        $dao->deleteUser($_SESSION["user_email"]);
+    }
+
+    $_SESSION = [];
+    session_destroy();
+
+    header("Location: index.php");
+    exit();
+
+} catch (Exception $e) {
+
+    $_SESSION["message"] = "internal_error";
+
+    header("Location: index.php?pfad=profile");
+    exit();
+}

php/controller/login-controller.php

@@ -1,8 +1,7 @@
 <?php
 
-require_once "php/model/LocalUserManager.php";
+require_once "php/model/UserManager.php";
 
-$dao = new LocalUserManager();
 $error = null;
 
 /*
@@ -11,25 +10,28 @@ $error = null;
 */
 if ($_SERVER["REQUEST_METHOD"] === "POST") {
 
-    $email = $_POST["email"] ?? "";
+    try {
-    $password = $_POST["password"] ?? "";
 
-    $user = $dao->findUser($email);
+        $dao = UserManager::getInstance();
 
-    if ($user && password_verify($password, $user["password"])) {
+        $email = $_POST["email"] ?? "";
+        $password = $_POST["password"] ?? "";
+
+        $user = $dao->findUser($email);
+
+        if ($user && password_verify($password, $user["password"])) {
 
-        if (isset($user["vorname"]) && isset($user["nachname"])) {
             $_SESSION["user"] = $user["vorname"] . " " . $user["nachname"];
+            $_SESSION["user_email"] = $user["email"];
+
+            header("Location: index.php");
+            exit();
+
         } else {
-            $_SESSION["user"] = $user["username"] ?? "";
+            $error = "Login fehlgeschlagen. Bitte überprüfe deine Eingaben.";
         }
 
-        $_SESSION["user_email"] = $user["email"];
+    } catch (Exception $e) {
-
+        $error = "Es ist ein interner Fehler aufgetreten. Bitte versuche es erneut.";
-        header("Location: index.php");
-        exit();
-
-    } else {
-        $error = "Login fehlgeschlagen. Bitte überprüfe deine Eingaben.";
     }
 }

php/controller/profile-controller.php

@@ -1,6 +1,6 @@
 <?php
 
-require_once "php/model/LocalUserManager.php";
+require_once "php/model/UserManager.php";
 require_once "php/model/Article.php";
 require_once "php/model/ArticleManager.php";
 require_once "php/validator/user-validator.php";
@@ -13,7 +13,7 @@ if (!isset($_SESSION["user"])) {
 }
 
 try {
-    $dao = new LocalUserManager();
+    $dao = UserManager::getInstance();
 
     $user = $dao->findUser($_SESSION["user_email"] ?? "");
 
@@ -38,15 +38,15 @@ try {
             $_GET["edit"] = "1";
 
         } elseif (!userNameValidator($vorname)) {
-            $error = "Der Vorname muss 2 bis 50 Zeichen lang sein und darf nur Buchstaben, Leerzeichen und Bindestriche enthalten.";
+            $error = "Der Vorname muss 2 bis 20 Zeichen lang sein und darf nur Buchstaben, Leerzeichen und Bindestriche enthalten.";
             $_GET["edit"] = "1";
 
         } elseif (!userNameValidator($nachname)) {
-            $error = "Der Nachname muss 2 bis 50 Zeichen lang sein und darf nur Buchstaben, Leerzeichen und Bindestriche enthalten.";
+            $error = "Der Nachname muss 2 bis 20 Zeichen lang sein und darf nur Buchstaben, Leerzeichen und Bindestriche enthalten.";
             $_GET["edit"] = "1";
 
         } elseif (!userOptionalPasswordValidator($password)) {
-            $error = "Das Passwort muss 8 bis 72 Zeichen lang sein.";
+            $error = "Das Passwort muss 5 bis 12 Zeichen lang sein.";
             $_GET["edit"] = "1";
 
         } else {

php/controller/profileArticles-controller.php

@@ -5,10 +5,10 @@
 
 require_once 'php/model/Article.php';
 require_once 'php/model/ArticleManager.php';
-require_once "../model/LocalUserManager.php";
+require_once "php/model/UserManager.php";
 
 try {
-    $dao = new LocalUserManager();
+    $dao = UserManager::getInstance();
     $user = $dao->findUser($_SESSION["user_email"] ?? "");
 
     $author = $user["email"];

php/controller/register-controller.php

@@ -1,6 +1,6 @@
 <?php
 
-require_once "php/model/LocalUserManager.php";
+require_once "php/model/UserManager.php";
 require_once "php/validator/user-validator.php";
 
 $error = null;
@@ -15,14 +15,14 @@ if ($_SERVER["REQUEST_METHOD"] === "POST") {
     if (!userEmailValidator($email)) {
         $error = "Bitte gib eine gültige E-Mail-Adresse ein.";
     } elseif (!userNameValidator($vorname)) {
-        $error = "Der Vorname muss 2 bis 50 Zeichen lang sein und darf nur Buchstaben, Umlaute, Leerzeichen und Bindestriche enthalten.";
+        $error = "Der Vorname muss 2 bis 20 Zeichen lang sein und darf nur Buchstaben, Umlaute, Leerzeichen und Bindestriche enthalten.";
     } elseif (!userNameValidator($nachname)) {
-        $error = "Der Nachname muss 2 bis 50 Zeichen lang sein und darf nur Buchstaben, Umlaute, Leerzeichen und Bindestriche enthalten.";
+        $error = "Der Nachname muss 2 bis 20 Zeichen lang sein und darf nur Buchstaben, Umlaute, Leerzeichen und Bindestriche enthalten.";
     } elseif (!userPasswordValidator($plainPassword)) {
-        $error = "Das Passwort muss 8 bis 72 Zeichen lang sein.";
+        $error = "Das Passwort muss 5 bis 12 Zeichen lang sein.";
     } else {
         try {
-            $dao = new LocalUserManager();
+            $dao = UserManager::getInstance();
 
             $password = password_hash($plainPassword, PASSWORD_DEFAULT);
 

php/model/DatabaseUserManager.php

@@ -1,26 +1,261 @@
 <?php
+
 require_once "UserManagerDAO.php";
 
+/**
+ * Klasse für den Zugriff auf Benutzerdaten über eine SQLite-Datenbank.
+ *
+ * Diese Klasse verwendet PDO, Prepared Statements und speichert
+ * Benutzerdaten in der Datei db/users.db.
+ */
 class DatabaseUserManager implements UserManagerDAO {
 
+    private static $instance = null;
+
+    /**
+     * Konstruktor.
+     *
+     * Erstellt die Benutzerdatenbank und die Tabelle users,
+     * falls diese noch nicht existieren.
+     *
+     * @throws RuntimeException wenn die Datenbank nicht erstellt werden kann
+     */
+    public function __construct()
+    {
+        try {
+            $db = $this->getConnection();
+
+            $db->exec("
+                CREATE TABLE IF NOT EXISTS users (
+                    email TEXT PRIMARY KEY,
+                    vorname TEXT NOT NULL,
+                    nachname TEXT NOT NULL,
+                    password TEXT NOT NULL
+                );
+            ");
+
+            unset($db);
+
+        } catch (PDOException $e) {
+            throw new RuntimeException("Benutzerdatenbank konnte nicht erstellt werden.");
+        }
+    }
+
+    /**
+     * Baut eine Verbindung zur SQLite-Datenbank auf.
+     *
+     * @return PDO Datenbankverbindung
+     *
+     * @throws RuntimeException wenn keine Verbindung hergestellt werden kann
+     */
+    private function getConnection()
+    {
+        try {
+            $dsn = 'sqlite:' . __DIR__ . '/../../db/users.db';
+
+            $db = new PDO($dsn, null, null);
+            $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+
+            return $db;
+
+        } catch (PDOException $e) {
+            throw new RuntimeException("Verbindung zur Benutzerdatenbank fehlgeschlagen.");
+        }
+    }
+
+    /**
+     * Gibt die Singleton-Instanz des DatabaseUserManagers zurück.
+     *
+     * @return DatabaseUserManager Instanz des DatabaseUserManagers
+     */
+    public static function getInstance()
+    {
+        if (self::$instance == null) {
+            self::$instance = new DatabaseUserManager();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Sucht einen Benutzer anhand seiner E-Mail-Adresse.
+     *
+     * @param string $email E-Mail-Adresse des Benutzers
+     *
+     * @return array|null Benutzerdaten als Array oder null,
+     *                    wenn kein Benutzer gefunden wurde
+     *
+     * @throws RuntimeException wenn der Benutzer nicht geladen werden kann
+     */
     public function findUser($email)
     {
-        // TODO: Implement findUser() method.
+        try {
+            $db = $this->getConnection();
+
+            $sql = "SELECT * FROM users WHERE email = :email";
+            $command = $db->prepare($sql);
+
+            $command->execute([
+                ":email" => $email
+            ]);
+
+            $user = $command->fetch(PDO::FETCH_ASSOC);
+
+            return $user ?: null;
+
+        } catch (PDOException $e) {
+            throw new RuntimeException("Benutzer konnte nicht geladen werden.");
+        }
     }
 
+    /**
+     * Fügt einen neuen Benutzer in die Datenbank ein.
+     *
+     * Die Speicherung erfolgt innerhalb einer Transaktion.
+     * Doppelte E-Mail-Adressen werden durch den Primary Key verhindert.
+     *
+     * @param string $email E-Mail-Adresse des Benutzers
+     * @param string $vorname Vorname des Benutzers
+     * @param string $nachname Nachname des Benutzers
+     * @param string $password Passwort-Hash des Benutzers
+     *
+     * @return void
+     *
+     * @throws InvalidArgumentException wenn die E-Mail-Adresse bereits verwendet wird
+     * @throws RuntimeException wenn der Benutzer nicht gespeichert werden kann
+     */
     public function addUser($email, $vorname, $nachname, $password)
     {
-        // TODO: Implement addUser() method.
+        try {
+            $db = $this->getConnection();
+            $db->beginTransaction();
+
+            $sql = "
+                INSERT INTO users (email, vorname, nachname, password)
+                VALUES (:email, :vorname, :nachname, :password)
+            ";
+
+            $command = $db->prepare($sql);
+
+            $command->execute([
+                ":email" => $email,
+                ":vorname" => $vorname,
+                ":nachname" => $nachname,
+                ":password" => $password
+            ]);
+
+            $db->commit();
+
+        } catch (PDOException $e) {
+            if (isset($db) && $db->inTransaction()) {
+                $db->rollBack();
+            }
+
+            if ($e->getCode() === "23000") {
+                throw new InvalidArgumentException("Diese E-Mail-Adresse wird bereits verwendet.");
+            }
+
+            throw new RuntimeException("Benutzer konnte nicht gespeichert werden.");
+        }
     }
 
+    /**
+     * Aktualisiert die Daten eines bestehenden Benutzers.
+     *
+     * Optional kann zusätzlich das Passwort geändert werden.
+     * Wenn kein neues Passwort übergeben wird, bleibt das alte Passwort erhalten.
+     *
+     * @param string $oldEmail Aktuelle E-Mail-Adresse des Benutzers
+     * @param string $newEmail Neue E-Mail-Adresse des Benutzers
+     * @param string $vorname Neuer Vorname des Benutzers
+     * @param string $nachname Neuer Nachname des Benutzers
+     * @param string|null $password Neues Passwort oder null
+     *
+     * @return bool true, wenn der Benutzer aktualisiert wurde,
+     *              sonst false
+     *
+     * @throws InvalidArgumentException wenn die neue E-Mail-Adresse bereits verwendet wird
+     * @throws RuntimeException wenn der Benutzer nicht aktualisiert werden kann
+     */
     public function updateUser($oldEmail, $newEmail, $vorname, $nachname, $password = null)
     {
-        // TODO: Implement updateUser() method.
+        try {
+            $db = $this->getConnection();
+
+            if (!empty($password)) {
+                $sql = "
+                    UPDATE users
+                    SET email = :newEmail,
+                        vorname = :vorname,
+                        nachname = :nachname,
+                        password = :password
+                    WHERE email = :oldEmail
+                ";
+
+                $params = [
+                    ":newEmail" => $newEmail,
+                    ":vorname" => $vorname,
+                    ":nachname" => $nachname,
+                    ":password" => password_hash($password, PASSWORD_DEFAULT),
+                    ":oldEmail" => $oldEmail
+                ];
+            } else {
+                $sql = "
+                    UPDATE users
+                    SET email = :newEmail,
+                        vorname = :vorname,
+                        nachname = :nachname
+                    WHERE email = :oldEmail
+                ";
+
+                $params = [
+                    ":newEmail" => $newEmail,
+                    ":vorname" => $vorname,
+                    ":nachname" => $nachname,
+                    ":oldEmail" => $oldEmail
+                ];
+            }
+
+            $command = $db->prepare($sql);
+            $command->execute($params);
+
+            return $command->rowCount() > 0;
+
+        } catch (PDOException $e) {
+            if ($e->getCode() === "23000") {
+                throw new InvalidArgumentException("Diese E-Mail-Adresse wird bereits verwendet.");
+            }
+
+            throw new RuntimeException("Benutzer konnte nicht aktualisiert werden.");
+        }
     }
 
+    /**
+     * Löscht einen Benutzer anhand seiner E-Mail-Adresse.
+     *
+     * @param string $email E-Mail-Adresse des zu löschenden Benutzers
+     *
+     * @return bool true, wenn der Benutzer gelöscht wurde,
+     *              sonst false
+     *
+     * @throws RuntimeException wenn der Benutzer nicht gelöscht werden kann
+     */
     public function deleteUser($email)
     {
-        // TODO: Implement deleteUser() method.
+        try {
-    }
+            $db = $this->getConnection();
 
+            $sql = "DELETE FROM users WHERE email = :email";
+            $command = $db->prepare($sql);
+
+            $command->execute([
+                ":email" => $email
+            ]);
+
+            return $command->rowCount() > 0;
+
+        } catch (PDOException $e) {
+            throw new RuntimeException("Benutzer konnte nicht gelöscht werden.");
+        }
+    }
 }

php/model/UserManager.php

@@ -1,10 +1,32 @@
 <?php
-require_once "UserManagerDAO.php";
 
-class UserManager extends LocalUserManager{
+require_once "LocalUserManager.php";
+require_once "DatabaseUserManager.php";
 
-    public static function getInstance(){
+/**
-        // TODO: implement this.
+ * Zentrale Klasse für den Zugriff auf Benutzerdaten.
-        // TODO: dummy-user anlegen: - `max.mustermann, test123, mustermann@web.de` (analog zu ArticleManager)
+ *
+ * Hier kann zwischen lokaler Speicherung und Datenbankspeicherung
+ * gewechselt werden.
+ */
+class UserManager {
+
+    public static function getInstance() {
+        $userManager = DatabaseUserManager::getInstance();
+
+        /*
+         * Dummy-User anlegen, falls er noch nicht existiert.
+         * Passwort: test123
+         */
+        if ($userManager->findUser("mustermann@web.de") == null) {
+            $userManager->addUser(
+                "mustermann@web.de",
+                "Max",
+                "Mustermann",
+                password_hash("test12345", PASSWORD_DEFAULT)
+            );
+        }
+
+        return $userManager;
     }
 }

php/validator/user-validator.php

@@ -1,13 +1,33 @@
 <?php
 
+/**
+ * Prüft, ob ein Vor- oder Nachname gültig ist.
+ *
+ * Erlaubt werden Buchstaben, Umlaute, Leerzeichen und Bindestriche.
+ * Die Länge muss zwischen 2 und 20 Zeichen liegen.
+ *
+ * @param string $name Zu prüfender Name
+ *
+ * @return bool true wenn der Name gültig ist, sonst false
+ */
 function userNameValidator($name)
 {
     $name = trim($name);
-    $namePattern = '/^[a-zA-ZäöüÄÖÜß\s-]{2,50}$/u';
+    $namePattern = '/^[a-zA-ZäöüÄÖÜß\s-]{2,20}$/u';
 
     return preg_match($namePattern, $name) === 1;
 }
 
+/**
+ * Prüft, ob eine E-Mail-Adresse gültig ist.
+ *
+ * Die E-Mail-Adresse muss dem Standardformat entsprechen
+ * und darf höchstens 100 Zeichen lang sein.
+ *
+ * @param string $email Zu prüfende E-Mail-Adresse
+ *
+ * @return bool true wenn die E-Mail-Adresse gültig ist, sonst false
+ */
 function userEmailValidator($email)
 {
     $email = trim($email);
@@ -16,13 +36,35 @@ function userEmailValidator($email)
         && mb_strlen($email) <= 100;
 }
 
+/**
+ * Prüft, ob ein Passwort die Längenanforderungen erfüllt.
+ *
+ * Das Passwort muss zwischen 5 und 12 Zeichen lang sein.
+ *
+ * @param string $password Zu prüfendes Passwort
+ *
+ * @return bool true wenn das Passwort gültig ist, sonst false
+ */
 function userPasswordValidator($password)
 {
     $zeichenAnzahl = mb_strlen($password);
 
-    return $zeichenAnzahl >= 8 && $zeichenAnzahl <= 72;
+    return $zeichenAnzahl >= 5 && $zeichenAnzahl <= 12;
 }
 
+/**
+ * Prüft ein optionales Passwort.
+ *
+ * Ein leeres Passwort ist erlaubt und bedeutet,
+ * dass das bestehende Passwort unverändert bleibt.
+ * Falls ein Passwort angegeben wurde, wird es
+ * mit den normalen Passwortregeln geprüft.
+ *
+ * @param string|null $password Zu prüfendes Passwort
+ *
+ * @return bool true wenn das Passwort gültig oder leer ist,
+ *              sonst false
+ */
 function userOptionalPasswordValidator($password)
 {
     if (!isset($password) || $password === '') {