mirzaev
/
yii2-sessions-arangodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Compare commits

base: mirzaev:stable
Branches Tags
mirzaev:stable
mirzaev:1.1.x
mirzaev:0.1.x
mirzaev:2.2.0
mirzaev:2.1.0
mirzaev:2.0.0
mirzaev:1.0.0
..
compare: mirzaev:0.1.x
Branches Tags
mirzaev:stable
mirzaev:1.1.x
mirzaev:0.1.x
mirzaev:2.2.0
mirzaev:2.1.0
mirzaev:2.0.0
mirzaev:1.0.0

No commits in common. "stable" and "0.1.x" have entirely different histories.
stable ... 0.1.x

5 changed files with 85 additions and 179 deletions
Show Stats Expand all files Collapse all files

4
.gitignore vendored
View File

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

32
composer.json
View File

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

193
mirzaev/yii2/sessions/arangodb/system/ArangoDbSession.php → mirzaev/yii2/arangodb/sessions/ArangoDbSession.php
View File

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

9
mirzaev/yii2/sessions/arangodb/system/Migrations/create_sessions_collection.php → mirzaev/yii2/arangodb/sessions/Migrations/create_sessions_collection.php
View File

@ -1,14 +1,7 @@
<?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()
@ -24,4 +17,4 @@ class create_sessions_collection extends Migration
{
$this->dropCollection('sessions');
}
}
}

26
mirzaev/yii2/sessions/arangodb/system/MultiFieldSession.php → mirzaev/yii2/arangodb/sessions/MultiFieldSession.php
View File

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