Merge pull request 'iterate in $data until fields for empty relation are over' (#22) from bugfix/fix-model-loading-when-left-join-is-empty into master

Reviewed-on: #22

composer.json

@@ -6,7 +6,8 @@
   "require": {
     "vlucas/phpdotenv": "^5.5",
     "symfony/console": "^5.4",
-    "phpmailer/phpmailer": "^6.8"
+    "phpmailer/phpmailer": "^6.8",
+    "cocur/slugify": "^4.3"
   },
   "require-dev": {
     "phpunit/phpunit": "^9.6",

composer.lock

@@ -4,8 +4,82 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "079e8a8443fdc25cbe3b03322494b73b",
+    "content-hash": "d873b245eaaf660d70c21e06ee4bcf0a",
     "packages": [
+        {
+            "name": "cocur/slugify",
+            "version": "v4.3.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/cocur/slugify.git",
+                "reference": "652234ef5f1be844a2ae1c36ad1b4c88b05160f9"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/cocur/slugify/zipball/652234ef5f1be844a2ae1c36ad1b4c88b05160f9",
+                "reference": "652234ef5f1be844a2ae1c36ad1b4c88b05160f9",
+                "shasum": ""
+            },
+            "require": {
+                "ext-mbstring": "*",
+                "php": "^7.1 || ~8.0.0 || ~8.1.0 || ~8.2.0"
+            },
+            "conflict": {
+                "symfony/config": "<3.4 || >=4,<4.3",
+                "symfony/dependency-injection": "<3.4 || >=4,<4.3",
+                "symfony/http-kernel": "<3.4 || >=4,<4.3",
+                "twig/twig": "<2.12.1"
+            },
+            "require-dev": {
+                "laravel/framework": "^5.0|^6.0|^7.0|^8.0",
+                "latte/latte": "~2.2",
+                "league/container": "^2.2.0",
+                "mikey179/vfsstream": "~1.6.8",
+                "mockery/mockery": "^1.3",
+                "nette/di": "~2.4",
+                "pimple/pimple": "~1.1",
+                "plumphp/plum": "~0.1",
+                "symfony/config": "^3.4 || ^4.3 || ^5.0 || ^6.0",
+                "symfony/dependency-injection": "^3.4 || ^4.3 || ^5.0 || ^6.0",
+                "symfony/http-kernel": "^3.4 || ^4.3 || ^5.0 || ^6.0",
+                "symfony/phpunit-bridge": "^5.4 || ^6.0",
+                "twig/twig": "^2.12.1 || ~3.0",
+                "zendframework/zend-modulemanager": "~2.2",
+                "zendframework/zend-servicemanager": "~2.2",
+                "zendframework/zend-view": "~2.2"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Cocur\\Slugify\\": "src"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Florian Eckerstorfer",
+                    "email": "florian@eckerstorfer.co",
+                    "homepage": "https://florian.ec"
+                },
+                {
+                    "name": "Ivo Bathke",
+                    "email": "ivo.bathke@gmail.com"
+                }
+            ],
+            "description": "Converts a string into a slug.",
+            "keywords": [
+                "slug",
+                "slugify"
+            ],
+            "support": {
+                "issues": "https://github.com/cocur/slugify/issues",
+                "source": "https://github.com/cocur/slugify/tree/v4.3.0"
+            },
+            "time": "2022-12-07T19:48:48+00:00"
+        },
         {
             "name": "graham-campbell/result-type",
             "version": "v1.1.1",

src/Database/Query/Select.php

@@ -276,13 +276,12 @@ class Select
             return [(string) $table, $params];
         }
 
-        if ($table instanceof Select)
-        {
+        if ($table instanceof Select) {
             return $table->generateQuery();
         }
 
         if (isset($this->tableAliases[$table])) {
-            $queryString = ($defineAlias ? Utils::backtick($this->tableAliases[$table]) . ' ' . Utils::backtick($table) : Utils::backtick($table));
+            $queryString = $defineAlias ? Utils::backtick($this->tableAliases[$table]) . ' ' . Utils::backtick($table) : Utils::backtick($table);
             return [$queryString, $params];
         }
 
@@ -295,24 +294,17 @@ class Select
             return (string) $column;
         }
 
-        if (is_array($column)) {
-            $out = '';
-
-            if ($column[0]) {
-                list($tableName, $params) = $this->generateTable($column[0]);
-                $out .= $tableName . '.';
-            }
-
-            $out .= Utils::backtick($column[1]);
-
-            if (!empty($column[2])) {
-                $out .= ' ' . Utils::backtick($column[2]);
-            }
-
-            return $out;
-        } else {
-            return Utils::backtick($column);
+        if (!is_array($column)) {
+            $column = [$this->table, $column];
         }
+
+        list($tableName, $params) = $this->generateTable($column[0]);
+        $out = $tableName . '.' . Utils::backtick($column[1]);
+        if (!empty($column[2])) {
+            $out .= ' ' . Utils::backtick($column[2]);
+        }
+
+        return $out;
     }
 
     private function generateColumns(): string

src/Interfaces/PersistentData/IPersistentDataManager.php

@@ -10,9 +10,11 @@ interface IPersistentDataManager
 
     public function selectMultipleFromDb(Select $select, string $type, bool $useRelations = false, array $withRelations = []): Generator;
 
-    public function selectFromDbById($id, string $type, bool $useRelations = false);
+    public function selectFromDbById($id, string $type, bool $useRelations = false, array $withRelations = []);
 
-    public function loadRelationsFromDb(Model $model, bool $recursive): void;
+    public function selectFromDbBySlug(string $slug, string $type, bool $useRelations = false, array $withRelations = []);
+
+    public function loadRelationsFromDb(Model $model, bool $recursive = false, array $withRelations = []): void;
 
     public function saveToDb(Model $model): void;
 

src/Interfaces/Request/IRequest.php

@@ -4,7 +4,7 @@ use SokoWeb\Interfaces\Authentication\IUser;
 
 interface IRequest
 {
-    public function setParsedRouteParams(array &$routeParams): void;
+    public function setParsedRouteParams(array $routeParams): void;
 
     public function getBase(): string;
 

src/PersistentData/Model/Model.php

@@ -41,7 +41,7 @@ abstract class Model
     {
         $array = [];
 
-        foreach (self::getFields() as $key) {
+        foreach (static::getFields() as $key) {
             $method = 'get' . str_replace('_', '', ucwords($key, '_'));
 
             if (method_exists($this, $method)) {

src/PersistentData/Model/ModelWithSlug.php

@@ -0,0 +1,32 @@
+<?php namespace SokoWeb\PersistentData\Model;
+
+use Cocur\Slugify\Slugify;
+
+abstract class ModelWithSlug extends Model
+{
+    protected static string $slugSource;
+
+    protected ?string $slug = null;
+
+    public static function getFields(): array
+    {
+        return array_merge(['id', 'slug'], static::$fields);
+    }
+
+    public function setSlug(?string $slug): void
+    {
+        $this->slug = $slug;
+    }
+
+    public function getSlug(): ?string
+    {
+        return $this->slug;
+    }
+
+    public function generateSlug(): string
+    {
+        $slugSourceGetMethod = 'get' . str_replace('_', '', ucwords(static::$slugSource, '_'));
+        $this->slug = Slugify::create()->slugify($this->$slugSourceGetMethod());
+        return $this->slug;
+    }
+}

src/PersistentData/PersistentDataManager.php

@@ -8,9 +8,12 @@ use SokoWeb\Interfaces\Database\IAuditLogger;
 use SokoWeb\Interfaces\Database\IResultSet;
 use SokoWeb\Interfaces\PersistentData\IPersistentDataManager;
 use SokoWeb\PersistentData\Model\Model;
+use SokoWeb\PersistentData\Model\ModelWithSlug;
 
 class PersistentDataManager implements IPersistentDataManager
 {
+    const SLUG_MAX_LENGTH = 255;
+
     private IConnection $dbConnection;
 
     private ?IAuditLogger $auditLogger;
@@ -50,64 +53,30 @@ class PersistentDataManager implements IPersistentDataManager
         }
     }
 
-    public function selectFromDbById($id, string $type, bool $useRelations = false)
+    public function selectFromDbById($id, string $type, bool $useRelations = false, array $withRelations = [])
     {
         $select = new Select($this->dbConnection);
         $select->whereId($id);
 
-        return $this->selectFromDb($select, $type, $useRelations);
+        return $this->selectFromDb($select, $type, $useRelations, $withRelations);
     }
 
-    public function fillWithData(array &$data, Model $model, array $withRelations = [], ?string $modelKey = null): void
+    public function selectFromDbBySlug(string $slug, string $type, bool $useRelations = false, array $withRelations = [])
+    {
+        $select = new Select($this->dbConnection);
+        $select->where('slug', '=', $slug);
+
+        return $this->selectFromDb($select, $type, $useRelations, $withRelations);
+    }
+
+    public function loadRelationsFromDb(Model $model, bool $recursive = false, array $withRelations = []): void
     {
         $relations = $model::getRelations();
         if (count($withRelations)) {
-            $relations = array_intersect($relations, $withRelations);
+            $relations = array_intersect_key($relations, array_flip($withRelations));
         }
 
-        while (key($data)) {
-            $key = key($data);
-            $value = current($data);
-            $relation = key($relations);
-
-            if (strpos($key, '__') === false) {
-                $method = 'set' . str_replace('_', '', ucwords($key, '_'));
-
-                if (method_exists($model, $method) && isset($value)) {
-                    $model->$method($value);
-                }
-
-                next($data);
-            } else if (isset($modelKey) && substr($key, 0, strlen($modelKey . '__')) === $modelKey . '__') {
-                $key = substr($key, strlen($modelKey) + 2);
-
-                $method = 'set' . str_replace('_', '', ucwords($key, '_'));
-
-                if (method_exists($model, $method) && isset($value)) {
-                    $model->$method($value);
-                }
-
-                next($data);
-            } else if (substr($key, 0, strlen($relation . '__')) === $relation . '__') {
-                $relationType = current($relations);
-                $relationModel = new $relationType();
-                $this->fillWithData($data, $relationModel, $withRelations, $relation);
-
-                $method = 'set' . str_replace('_', '', ucwords($relation, '_'));
-                $model->$method($relationModel);
-
-                next($relations);
-            } else {
-                return;
-            }
-        }
-
-        $model->saveSnapshot();
-    }
-
-    public function loadRelationsFromDb(Model $model, bool $recursive): void
-    {
-        foreach ($model::getRelations() as $relation => $relationType) {
+        foreach ($relations as $relation => $relationType) {
             $camel = str_replace('_', '', ucwords($relation, '_'));
 
             $methodGet = 'get' . $camel . 'Id';
@@ -116,7 +85,7 @@ class PersistentDataManager implements IPersistentDataManager
             $relationId = $model->$methodGet();
 
             if ($relationId !== null) {
-                $relationModel = $this->selectFromDbById($relationId, $relationType, $recursive);
+                $relationModel = $this->selectFromDbById($relationId, $relationType, $recursive, $withRelations);
 
                 $model->$methodSet($relationModel);
             }
@@ -145,12 +114,21 @@ class PersistentDataManager implements IPersistentDataManager
             }
 
             if (count($modified) > 0) {
+                if ($model instanceof ModelWithSlug && isset($modified['slug'])) {
+                    $diff['slug']['new'] = $modified['slug'] = $this->generateUniqueSlug($model, $modified['slug']);
+                }
+
                 $modify->setId($id);
                 $modify->setDiff($diff);
                 $modify->fill($modified);
                 $modify->save();
             }
         } else {
+            if ($model instanceof ModelWithSlug) {
+                $slug = $model->generateSlug();
+                $modified['slug'] = $this->generateUniqueSlug($model, $slug);
+            }
+
             $modify->fill($modified);
             $modify->save();
 
@@ -171,6 +149,29 @@ class PersistentDataManager implements IPersistentDataManager
         $model->resetSnapshot();
     }
 
+    private function generateUniqueSlug(ModelWithSlug $model, string $notUniqueSlug): string
+    {
+        $numbered = 1;
+
+        do {
+            if ($numbered > 1) {
+                $slug = substr($notUniqueSlug, 0, static::SLUG_MAX_LENGTH - (strlen((string)$numbered) + 1));
+                $slug = $notUniqueSlug . '_' . (string)$numbered;
+            } else {
+                $slug = substr($notUniqueSlug, 0, static::SLUG_MAX_LENGTH);
+            }
+
+            $select = new Select($this->dbConnection, $model::getTable());
+            $select->where('slug', '=', $slug);
+
+            $numbered++;
+        } while ($select->count() != 0);
+
+        $model->setSlug($slug);
+
+        return $slug;
+    }
+
     private function createSelect(Select $select, string $type, bool $useRelations = false, array $withRelations = []): Select
     {
         $table = call_user_func([$type, 'getTable']);
@@ -187,12 +188,12 @@ class PersistentDataManager implements IPersistentDataManager
         if ($useRelations) {
             $relations = call_user_func([$type, 'getRelations']);
             if (count($withRelations)) {
-                $relations = array_intersect($relations, $withRelations);
+                $relations = array_intersect_key($relations, array_flip($withRelations));
             }
 
-            $columns = array_merge($columns, $this->getRelationColumns($relations, $withRelations));
+            $columns = array_merge($columns, $this->getRelationColumns($table, $relations, $withRelations));
 
-            $this->leftJoinRelations($select, $table, $relations, $withRelations);
+            $this->leftJoinRelations($select, $table, $table, $relations, $withRelations);
             $select->columns($columns);
         } else {
             $select->columns($columns);
@@ -201,40 +202,97 @@ class PersistentDataManager implements IPersistentDataManager
         return $select;
     }
 
-    private function getRelationColumns(array $relations, array $withRelations): array
+    private function getRelationColumns(string $table, array $relations, array $withRelations): array
     {
         $columns = [];
 
         foreach ($relations as $relation => $relationType) {
+            $relationTableAlias = $table . '__' . $relation;
             $relationTable = call_user_func([$relationType, 'getTable']);
             foreach (call_user_func([$relationType, 'getFields']) as $relationField) {
-                $columns[] = [$relationTable, $relationField, $relation . '__' . $relationField];
+                $columns[] = [$relationTableAlias, $relationField, $relation . '__' . $relationField];
             }
 
-            $nextOrderRelations = call_user_func([$relationType, 'getRelations']);
+            $relationsOfRelation = call_user_func([$relationType, 'getRelations']);
             if (count($withRelations)) {
-                $nextOrderRelations = array_intersect($nextOrderRelations, $withRelations);
+                $relationsOfRelation = array_intersect_key($relationsOfRelation, array_flip($withRelations));
             }
-            $columns = array_merge($columns, $this->getRelationColumns($nextOrderRelations, $withRelations));
+            $columns = array_merge($columns, $this->getRelationColumns($relationTable, $relationsOfRelation, $withRelations));
         }
 
         return $columns;
     }
 
-    private function leftJoinRelations(Select $select, string $table, array $relations, array $withRelations): void
+    private function leftJoinRelations(Select $select, string $table, string $tableAlias, array $relations, array $withRelations): void
     {
         foreach ($relations as $relation => $relationType) {
+            $relationTableAlias = $table . '__' . $relation;
             $relationTable = call_user_func([$relationType, 'getTable']);
-            $select->leftJoin($relationTable, [$relationTable, 'id'], '=', [$table, $relation . '_id']);
+            $select->setTableAliases([$relationTableAlias => $relationTable]);
+            $select->leftJoin($relationTableAlias, [$relationTableAlias, 'id'], '=', [$tableAlias, $relation . '_id']);
 
-            $nextOrderRelations = call_user_func([$relationType, 'getRelations']);
+            $relationsOfRelation = call_user_func([$relationType, 'getRelations']);
             if (count($withRelations)) {
-                $nextOrderRelations = array_intersect($nextOrderRelations, $withRelations);
+                $relationsOfRelation = array_intersect_key($relationsOfRelation, array_flip($withRelations));
             }
-            $this->leftJoinRelations($select, $relationTable, $nextOrderRelations, $withRelations);
+            $this->leftJoinRelations($select, $relationTable, $relationTableAlias, $relationsOfRelation, $withRelations);
         }
     }
 
+    private function fillWithData(array &$data, Model $model, array $withRelations = [], ?string $modelKey = null): void
+    {
+        $relations = $model::getRelations();
+        if (count($withRelations)) {
+            $relations = array_intersect_key($relations, array_flip($withRelations));
+        }
+
+        while (key($data)) {
+            $key = key($data);
+            $value = current($data);
+            $relation = key($relations);
+
+            if (strpos($key, '__') === false) {
+                $method = 'set' . str_replace('_', '', ucwords($key, '_'));
+
+                if (method_exists($model, $method) && isset($value)) {
+                    $model->$method($value);
+                }
+
+                next($data);
+            } else if (isset($modelKey) && substr($key, 0, strlen($modelKey . '__')) === $modelKey . '__') {
+                $key = substr($key, strlen($modelKey) + 2);
+
+                $method = 'set' . str_replace('_', '', ucwords($key, '_'));
+
+                if (method_exists($model, $method) && isset($value)) {
+                    $model->$method($value);
+                }
+
+                next($data);
+            } else if (substr($key, 0, strlen($relation . '__')) === $relation . '__') {
+                if ($data[$relation . '__id'] !== null) {
+                    $relationType = current($relations);
+                    $relationModel = new $relationType();
+                    $this->fillWithData($data, $relationModel, $withRelations, $relation);
+
+                    $method = 'set' . str_replace('_', '', ucwords($relation, '_'));
+                    $model->$method($relationModel);
+                } else {
+                    while (substr($key, 0, strlen($relation . '__')) === $relation . '__') {
+                        next($data);
+                        $key = key($data);
+                    }
+                }
+
+                next($relations);
+            } else {
+                return;
+            }
+        }
+
+        $model->saveSnapshot();
+    }
+
     private function syncRelations(Model $model): void
     {
         foreach ($model::getRelations() as $relation => $relationType) {
@@ -247,6 +305,8 @@ class PersistentDataManager implements IPersistentDataManager
 
             if ($relationModel !== null) {
                 $model->$methodSet($relationModel->getId());
+            } else {
+                $model->$methodSet(null);
             }
         }
     }

src/Request/Request.php

@@ -17,23 +17,23 @@ class Request implements IRequest
 
     private array $headers;
 
-    private Session $session;
+    private ISession $session;
 
     private ?IUser $user = null;
 
     public function __construct(
         string $base,
-        array &$get,
-        array &$post,
+        array $get,
+        array $post,
         array $headers,
-        array &$session,
+        ISession $session,
         IUserRepository $userRepository)
     {
         $this->base = $base;
-        $this->get = &$get;
-        $this->post = &$post;
+        $this->get = $get;
+        $this->post = $post;
         $this->headers = $headers;
-        $this->session = new Session($session);
+        $this->session = $session;
 
         $userId = $this->session->get('userId');
         if ($userId !== null) {
@@ -41,9 +41,9 @@ class Request implements IRequest
         }
     }
 
-    public function setParsedRouteParams(array &$routeParams): void
+    public function setParsedRouteParams(array $routeParams): void
     {
-        $this->routeParams = &$routeParams;
+        $this->routeParams = $routeParams;
     }
 
     public function getBase(): string

src/Session/DatabaseSessionHandler.php

@@ -11,13 +11,19 @@ class DatabaseSessionHandler implements ISessionHandler
 {
     private IConnection $dbConnection;
 
+    private string $table;
+
+    private DateTime $shouldBeNewerThan;
+
     private bool $exists = false;
 
     private bool $written = false;
 
-    public function __construct(IConnection $dbConnection)
+    public function __construct(IConnection $dbConnection, string $table, DateTime $shouldBeNewerThan)
     {
         $this->dbConnection = $dbConnection;
+        $this->table = $table;
+        $this->shouldBeNewerThan = $shouldBeNewerThan;
     }
 
     public function open($savePath, $sessionName): bool
@@ -32,24 +38,27 @@ class DatabaseSessionHandler implements ISessionHandler
 
     public function read($id): string
     {
-        $select = new Select($this->dbConnection, 'sessions');
-        $select->columns(['data']);
+        $select = new Select($this->dbConnection, $this->table);
+        $select->columns(['data', 'updated']);
         $select->whereId(substr($id, 0, 32));
 
         $result = $select->execute()->fetch(IResultSet::FETCH_ASSOC);
-
         if ($result === null) {
             return '';
         }
 
         $this->exists = true;
 
+        if (new DateTime($result['updated']) < $this->shouldBeNewerThan) {
+            return '';
+        }
+
         return $result['data'];
     }
 
     public function write($id, $data): bool
     {
-        $modify = new Modify($this->dbConnection, 'sessions');
+        $modify = new Modify($this->dbConnection, $this->table);
 
         if ($this->exists) {
             $modify->setId(substr($id, 0, 32));
@@ -68,7 +77,7 @@ class DatabaseSessionHandler implements ISessionHandler
 
     public function destroy($id): bool
     {
-        $modify = new Modify($this->dbConnection, 'sessions');
+        $modify = new Modify($this->dbConnection, $this->table);
         $modify->setId(substr($id, 0, 32));
         $modify->delete();
 
@@ -101,7 +110,7 @@ class DatabaseSessionHandler implements ISessionHandler
             return true;
         }
 
-        $modify = new Modify($this->dbConnection, 'sessions');
+        $modify = new Modify($this->dbConnection, $this->table);
 
         $modify->setId(substr($id, 0, 32));
         $modify->set('updated', (new DateTime())->format('Y-m-d H:i:s'));

src/View/Linker.php

@@ -97,7 +97,12 @@ class Linker
 
         fwrite($outputFileHandle, $extra[0]);
         while (($line = fgets($inputFileHandle)) !== false) {
-            fwrite($outputFileHandle, $line);
+            if (preg_match('/^\s*@include\((.*)\)\s*$/', $line, $matches) === 1) {
+                $include = file_get_contents(ROOT . '/views/' . $matches[1] . '.php');
+                fwrite($outputFileHandle, $include);
+            } else {
+                fwrite($outputFileHandle, $line);
+            }
         }
         fwrite($outputFileHandle, $extra[1]);
 

templates/web.php.tpl

@@ -14,7 +14,7 @@ Container::$routeCollection = new SokoWeb\Routing\RouteCollection();
 Container::$routeCollection->get('index', '', [{app}\Controller\HomeController::class, 'getIndex']);
 
 if (isset($_COOKIE['COOKIES_CONSENT'])) {
-    Container::$sessionHandler = new SokoWeb\Session\DatabaseSessionHandler(Container::$dbConnection);
+    Container::$sessionHandler = new SokoWeb\Session\DatabaseSessionHandler(Container::$dbConnection, 'sessions');
 
     session_set_save_handler(Container::$sessionHandler, true);
     session_start([