Косметические изменения

.gitignore

@@ -1 +1,3 @@
-/vendor/
+!.gitignore
+composer.phar
+vendor

composer.json

@@ -1,26 +1,36 @@
 {
-    "name": "mirzaev/yii2-arangodb-sessions",
-    "description": "Yii\\web\\DbSession implementation for use with ArangoDB",
+    "name": "mirzaev/yii2-sessions-arangodb",
+    "description": "Module with yii\\web\\DbSession implementation for use with ArangoDB",
     "keywords": [
         "Yii2",
         "ArangoDB",
         "DbSession"
     ],
     "type": "yii2-extension",
-    "license": "AGPL-3.0-or-later",
-    "homepage": "https://git.hood.su/mirzaev/yii2/arangodb/sessions",
+    "license": "WTFPL",
+    "homepage": "https://git.mirzaev.sexy/mirzaev/yii2-sessions-arangodb",
     "authors": [
         {
             "name": "Arsen Mirzaev Tatyano-Muradovich",
-            "email": "red@hood.su",
-            "homepage": "https://hood.su/mirzaev",
-            "role": "Developer"
+            "email": "arsen@mirzaev.sexy",
+            "homepage": "https://mirzaev.sexy",
+            "role": "Programmer"
+        }
+    ],
+    "support": {
+        "email": "arsen@mirzaev.sexy",
+        "wiki": "https://git.mirzaev.sexy/mirzaev/yii2-sessions-arangodb/wiki",
+        "issues": "https://git.mirzaev.sexy/mirzaev/yii2-sessions-arangodb/issues"
+    },
+    "funding": [
+        {
+            "type": "funding",
+            "url": "https://fund.mirzaev.sexy"
         }
     ],
     "require": {
-        "php": "^8.0.0",
+        "php": "^8.0",
         "yiisoft/yii2": "2.*",
-        "triagens/arangodb": "~3.2",
         "mirzaev/yii2-arangodb": "~2.1.x-dev"
     },
     "require-dev": {
@@ -28,12 +38,12 @@
     },
     "autoload": {
         "psr-4": {
-            "mirzaev\\yii2\\arangodb\\sessions\\": "mirzaev/yii2/arangodb/sessions"
+            "mirzaev\\yii2\\arangodb\\sessions\\": "mirzaev/yii2/sessions/arangodb/system"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "mirzaev\\yii2\\arangodb\\sessions\\tests\\": "mirzaev/yii2/arangodb/sessions/tests"
+            "mirzaev\\yii2\\arangodb\\sessions\\tests\\": "mirzaev/yii2/sessions/arangodb/tests"
         }
     }
 }

mirzaev/yii2/sessions/arangodb/system/ArangoDbSession.php

@@ -2,21 +2,24 @@
 
 declare(strict_types=1);
 
-namespace mirzaev\yii2\arangodb\sessions;
+namespace mirzaev\yii2\sessions\arangodb;
 
+// Фреймворк Yii
 use yii;
 use yii\di\Instance;
 use yii\base\InvalidConfigException;
 
-use mirzaev\yii2\arangodb\Connection;
-use mirzaev\yii2\arangodb\Query;
+// Модуль ArangoDB для фреймворка Yii
+use mirzaev\yii2\arangodb\Connection,
+    mirzaev\yii2\arangodb\Query;
 
+// Встроенные библиотеки
 use Exception;
 
 /**
  * Реализация DbSession под ArangoDB
  *
- * @property Connection|array|string $database Идентификатор компонента (Component ID)
+ * @property Connection|array|string $database Идентификатор компонента с базой данных (Component ID)
  * @property string $document Название документа для хранения данных сеанса (Document name for storing session data)
  * @property array $buffer Буфер данных для записи в документ сессии (Data buffer for write to session document)
  *
@@ -31,6 +34,7 @@ use Exception;
  * @method public destroySession() Удалить сессию (Delete session)
  * @method public gcSession() Удалить неиспользуемые данные (Delete garbage)
  * @method protected getReadQuery() Генерация запроса для чтения сеанса (Generating a query to read a session)
+ * @method protected genBuffer() Генерация массива данных для записи (Generating an array of data to writing)
  * @method protected typecastFields() Конвертация для отправки в PDO (Convertation  for sending to PDO)
  *
  * @example ./Migrations/create_sessions_collection.php
@@ -43,14 +47,16 @@ use Exception;
  *
  * @see yii\web\DbSession Наследует, копирует (Inherit, copy)
  *
- * @package yii2\ArangoDB
- * @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
+ * @package mirzaev\yii2\sessions\arangodb
+ * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
+ *
+ * @since 2.0
  */
 final class ArangoDbSession extends MultiFieldSession
 {
 
     /**
-     * Идентификатор компонента (Component ID)
+     * Идентификатор компонента с базой данных (Component ID)
      */
     public Connection|array|string $database = 'arangodb';
 
@@ -141,7 +147,7 @@ final class ArangoDbSession extends MultiFieldSession
             return;
         }
 
-        // parent::regenerateID(false);
+        parent::regenerateID(false);
 
         $newID = session_id();
 
@@ -153,9 +159,9 @@ final class ArangoDbSession extends MultiFieldSession
         }
 
         $row = (new Query())
-                ->in($this->document)
-                ->where(['hash' => $oldID])
-                ->one($this->database);
+            ->in($this->document)
+            ->where(['hash' => $oldID])
+            ->one($this->database);
 
         if ($row) {
             if ($rewrite) {
@@ -163,20 +169,28 @@ final class ArangoDbSession extends MultiFieldSession
 
                 (new Query())
                     ->in($this->document)
-                    ->where(['hash' => $newID])
-                    ->update(['hash' => $oldID], db: $this->database);
+                    ->where(['hash' => $oldID])
+                    ->update($this->genBuffer($newID), db: $this->database);
             } else {
                 // Создать
 
+                // Инициализация
+                $new = $row;
+                $new['id'] = $newID;
+
                 (new Query())
                     ->in($this->document)
-                    ->insert(['hash' => $newID], db: $this->database);
+                    ->insert($new, db: $this->database);
             }
         } else {
             // shouldn't reach here normally
             (new Query())
                 ->in($this->document)
-                ->insert($this->composeFields($newID, ''), db: $this->database);
+                ->insert($this->genBuffer($newID), db: $this->database);
+
+            // (new Query())
+            //     ->in($this->document)
+            //     ->insert($this->composeFields($newID, ''), db: $this->database); !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
         }
     }
 
@@ -187,11 +201,10 @@ final class ArangoDbSession extends MultiFieldSession
      *
      * @return string Данные сессии (The session data)
      */
-    public function readSession($id): string
-    // public function readSession(string $id): string
+    public function readSession($hash): string
+    // public function readSession(string $hash): string
     {
-        $query = $this->getReadQuery($id);
-
+        $query = $this->getReadQuery($hash);
 
         if ($this->readCallback !== null) {
             $data = $query->one($this->database);
@@ -207,15 +220,22 @@ final class ArangoDbSession extends MultiFieldSession
     /**
      * Найти сессию (Search session)
      *
-     * @param string $id Идентификатор сессии (Session ID)
+     * @param string $hash Идентификатор сессии (Session ID)
      *
      * @return array|null Сессия, если найдена (Session, if founded)
      */
-    public function searchSession(string $id): ?array
+    public function searchSession(string $hash): ?array
     {
+        if (empty($hash)) {
+            return false;
+        }
+
         $session = (new Query())
             ->in($this->document)
-            ->where(['hash' => $id])
+            ->where([
+                'hash' => $hash,
+                'status' => 'active'
+            ])
             ->one($this->database);
 
         return $session ? $session : null;
@@ -224,15 +244,35 @@ final class ArangoDbSession extends MultiFieldSession
     /**
      * Инициализировать сессию (Initialize session)
      *
-     * @param string $id Идентификатор сессии (Session ID)
+     * @param string $hash Идентификатор сессии (Session ID)
+     * @param string|null $data Данные сессии (Session data)
      *
-     * @return array Сессия (Session)
+     * @return array Сессия или статус обновления (Session or update status)
      */
-    public function initSession(string $id): array
+    public function initSession(string $hash, string|null $data = null): array|bool|null
     {
-        return $this->searchSession($id) ?? (new Query())
+        if (empty($hash)) {
+            return null;
+        }
+
+        if ($session = $this->searchSession($hash)) {
+            if (isset($data, $session['data']) && $session['data'] !== $data) {
+                // Необходима синхронизация (данные не идентичны)
+
+                return (new Query())
+                    ->in($this->document)
+                    ->where(['hash' => $session['hash']])
+                    ->update(['data' => $data], db: $this->database);
+            }
+
+            return $session;
+        }
+
+        $query = (new Query())
             ->in($this->document)
-            ->insert($this->buffer, db: $this->database);
+            ->insert($this->genBuffer($hash, $data), db: $this->database);
+
+        return $query ? $query : null;
     }
 
     /**
@@ -248,6 +288,7 @@ final class ArangoDbSession extends MultiFieldSession
     {
         if ($this->getUseStrictMode() && $id === $this->_forceRegenerateId) {
             //Ignore write when forceRegenerate is active for this id
+
             return true;
         }
 
@@ -261,25 +302,20 @@ final class ArangoDbSession extends MultiFieldSession
 
             // ensure data consistency
             if (isset($this->buffer['data'])) {
+
                 $_SESSION = $this->buffer['data'];
             } else {
+
                 $this->buffer['data'] = $data;
             }
 
-            $this->buffer = array_merge($this->buffer, [
-                'hash' => $id,
-                'from' => time(),
-                'to' => time() + $this->getTimeout(),
-            ]);
+            $this->genBuffer($id, $data);
 
             // Конвертация или сериализация, не пойму
             $this->buffer = $this->typecastFields($this->buffer);
 
             // Инициализация сессии
-            $this->initSession($id);
-
-            // Деинициализация буфера данных сессии
-            $this->buffer = [];
+            $this->initSession($id, $data);
         } catch (Exception $e) {
             yii::$app->errorHandler->handleException($e);
 
@@ -289,21 +325,45 @@ final class ArangoDbSession extends MultiFieldSession
         return true;
     }
 
+    /**
+     * Закрыть сессию (Close session)
+     *
+     * @return bool Статус закрытия сессии (Session closing status)
+     *
+     * @todo Разобраться почему вызывается destroySession и избавиться от перезаписи (сделать обновление существующей)
+     */
+    public function closeSession(): bool
+    {
+        // try {
+        //     $this->buffer['status'] = 'inactive';
+
+        //     (new Query())
+        //         ->in($this->document)
+        //         ->insert($this->buffer, db: $this->database);
+        // } catch (Exception $e) {
+        //     yii::$app->errorHandler->handleException($e);
+
+        //     return false;
+        // }
+
+        return true;
+    }
+
+
+
     /**
      * Удалить сессию (Delete session)
      *
-     * @param string $id Идентификатор сессии (Session ID)
+     * @param string $hash Идентификатор сессии (Session ID)
      *
      * @return bool Статус удаления сессии (Session deleting status)
      */
-    public function destroySession($id): bool
-    // public function destroySession(string $id): bool
+    public function destroySession($hash): bool
+    // public function destroySession(string $hash): bool
     {
         return (new Query())
             ->in($this->document)
-            ->where([
-                'hash' => $id
-            ])
+            ->where(['hash' => $hash])
             ->remove(db: $this->database);
     }
 
@@ -327,20 +387,20 @@ final class ArangoDbSession extends MultiFieldSession
                     [
                         'to' => time()
                     ],
-                    'operator' => '>='
+                    'operator' => '<='
                 ]
             ])
             ->remove(db: $this->database);
     }
 
     /**
-     * Генерация запроса для чтения сеанса (Generating a query to read a session)
+     * Генерация запроса для чтения сессии (Generating a query to read a session)
      *
-     * @param string $id Идентификатор сессии (Session ID)
+     * @param string $hash Идентификатор сессии (Session ID)
      *
      * @return Query Инстанция запроса на чтение (Read query instance)
      */
-    protected function getReadQuery(string $id): Query
+    protected function getReadQuery(string $hash): Query
     {
         return (new Query())
             ->in($this->document)
@@ -349,21 +409,40 @@ final class ArangoDbSession extends MultiFieldSession
                     [
                         'to' => time()
                     ],
-                    'operator' => '<='
-                ]
-            ])
-            ->where([
-                [
-                    'to' => null
-                ]
-            ], 'OR')
-            ->where([
-                [
-                    'hash' => $id,
+                    'operator' => '>='
                 ],
+                [
+                    [
+                        'hash' => $hash,
+                    ],
+                    [
+                        'status' => 'active'
+                    ]
+                ]
             ]);
     }
 
+    /**
+     * Генерация массива данных для записи (Generating an array of data to writing)
+     *
+     * @param string $hash Идентификатор сессии (Session ID)
+     * @param string $data Данные сессии (Session data)
+     *
+     * @return array Обработанный буфер (Handled buffer)
+     */
+    protected function genBuffer(string $hash, string|null $data = null): array
+    {
+        return $this->buffer = array_merge(
+            $this->buffer,
+            $this->composeFields($hash, $data),
+            [
+                'from' => time(),
+                'to' => time() + $this->getTimeout(),
+                'status' => 'active'
+            ]
+        );
+    }
+
     /**
      * Конвертация для отправки в PDO (Convertation  for sending to PDO)
      *

mirzaev/yii2/sessions/arangodb/system/Migrations/create_sessions_collection.php

@@ -1,7 +1,14 @@
 <?php
 
+// Модуль ArangoDB для фреймворка Yii
 use mirzaev\yii2\arangodb\Migration;
 
+/**
+ * Создание коллекции для хранения сессий
+ *
+ * @package mirzaev\yii2\sessions\arangodb
+ * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
+ */
 class create_sessions_collection extends Migration
 {
     public function up()

mirzaev/yii2/sessions/arangodb/system/MultiFieldSession.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace mirzaev\yii2\arangodb\sessions;
+namespace mirzaev\yii2\sessions\arangodb;
 
-use yii;
-
-use yii\web\Session;
+// Фреймворк Yii
+use yii,
+    yii\web\Session;
 
 /**
  * Базовый класс для реализации хранилища сессий
@@ -15,7 +15,8 @@ use yii\web\Session;
  *
  * @property-read bool $useCustomStorage Разрешение использовать своё хранилища (Whether to use custom storage)
  *
- * @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
+ * @package mirzaev\yii2\sessions\arangodb
+ * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
  * @author Paul Klimov <klimov.paul@gmail.com>
  */
 abstract class MultiFieldSession extends Session
@@ -82,22 +83,17 @@ abstract class MultiFieldSession extends Session
     /**
      * Composes storage field set for session writing.
      *
-     * @param string $id Optional session id
-     * @param string $data Optional session data
+     * @param string $hash Session id
+     * @param string $data Session data
      *
      * @return array storage fields
      */
-    protected function composeFields($id = null, $data = null): array
+    protected function composeFields($hash = null, $data = null): array
     {
         $buffer = $this->writeCallback ? call_user_func($this->writeCallback, $this) : [];
 
-        if ($id !== null) {
-            $buffer['hash'] = $id;
-        }
-
-        if ($data !== null) {
-            $buffer['data'] = $data;
-        }
+        isset($hash) and $buffer['hash'] = $hash;
+        isset($data) and $buffer['data'] = $data;
 
         return $buffer;
     }