The first commit

Author: kodeart

.gitattributes

@@ -0,0 +1,5 @@
+*.php diff=php
+
+/Tests     export-ignore
+/phpunit.* export-ignore
+/*.yml     export-ignore

.gitignore

@@ -0,0 +1,8 @@
+build
+vendor
+.DS_Store
+.idea
+composer.lock
+phpunit.phar
+*.yml
+!.travis.yml

.travis.yml

@@ -0,0 +1,29 @@
+language: php
+
+sudo: false
+
+php:
+  - 7.1
+  - 7.2
+
+services:
+  - memcached
+  - redis-server
+
+env:
+  - REDIS_SERVER_HOST=127.0.0.1 REDIS_SERVER_PORT=6379 MEMCACHED_POOL=[["127.0.0.1",11211]]
+
+matrix:
+  fast_finish: true
+
+before_script:
+  - composer selfupdate
+  - composer update -o --no-interaction --prefer-stable
+  - echo "extension=memcached.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - echo "extension=redis.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+
+script:
+  - vendor/bin/phpunit
+
+after_success:
+  - vendor/bin/coveralls

Handler/FilesHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <mihail@kodeart.com>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Session\Handler;
+
+use Koded\Session\SessionConfiguration;
+use SessionHandler;
+
+
+final class FilesHandler extends SessionHandler
+{
+
+    public function __construct(SessionConfiguration $settings)
+    {
+        ini_set('session.save_handler', 'files');
+        ini_set('session.save_path', $settings->get('save_path', session_save_path()));
+        ini_set('session.serialize_handler', $settings->get('serialize_handler', 'php'));
+    }
+}

Handler/MemcachedHandler.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <mihail@kodeart.com>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Session\Handler;
+
+use Koded\Caching\Client\MemcachedClient;
+use Koded\Caching\Configuration\MemcachedConfiguration;
+use Koded\Session\SessionConfiguration;
+use Memcached;
+use SessionHandlerInterface;
+
+
+final class MemcachedHandler implements SessionHandlerInterface
+{
+
+    /**
+     * @var int
+     */
+    protected $ttl;
+
+    /**
+     * @var Memcached
+     */
+    private $client;
+
+    public function __construct(SessionConfiguration $settings)
+    {
+        $this->ttl    = (int)$settings->get('gc_maxlifetime', ini_get('session.gc_maxlifetime'));
+        $this->client = (new MemcachedClient(new Memcached, $this->configuration($settings)))->client();
+    }
+
+    public function close(): bool
+    {
+        return true;
+    }
+
+    public function destroy($sessionId): bool
+    {
+        return $this->client->delete($sessionId);
+    }
+
+    public function open($savePath, $sessionId): bool
+    {
+        return true;
+    }
+
+    public function read($sessionId): string
+    {
+        return $this->client->get($sessionId) ?: '';
+    }
+
+    public function write($sessionId, $sessionData): bool
+    {
+        return $this->client->set($sessionId, $sessionData, $this->ttl + time());
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function gc($maxLifetime): bool
+    {
+        return true;
+    }
+
+    private function configuration(SessionConfiguration $settings): MemcachedConfiguration
+    {
+        return new MemcachedConfiguration([
+            'id'      => $settings->get('id', $settings->get('name', ini_get('session.name'))),
+            'servers' => $settings->get('servers', []),
+            'options' => $settings->get('options', []) + [
+                    Memcached::OPT_PREFIX_KEY => $settings->prefix ?? 'session.'
+                ]
+        ]);
+    }
+}

Handler/RedisHandler.php

@@ -0,0 +1,89 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <mihail@kodeart.com>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Session\Handler;
+
+use Koded\Caching\Client\RedisClient;
+use Koded\Caching\Configuration\RedisConfiguration;
+use Koded\Session\SessionConfiguration;
+use Redis;
+use SessionHandlerInterface;
+
+
+final class RedisHandler implements SessionHandlerInterface
+{
+
+    /**
+     * @var int
+     */
+    protected $ttl;
+
+    /**
+     * @var Redis
+     */
+    private $client;
+
+    public function __construct(SessionConfiguration $settings)
+    {
+        $this->ttl    = (int)$settings->get('gc_maxlifetime', ini_get('session.gc_maxlifetime'));
+        $this->client = (new RedisClient(new Redis, $this->configuration($settings)))->client();
+    }
+
+    public function close(): bool
+    {
+        return true;
+    }
+
+    public function destroy($sessionId): bool
+    {
+        return $this->client->del($sessionId) > 0;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function gc($maxLifetime): bool
+    {
+        return true;
+    }
+
+    public function read($sessionId): string
+    {
+        return $this->client->get($sessionId) ?: '';
+    }
+
+    public function write($sessionId, $sessionData): bool
+    {
+        if ($this->ttl > 0) {
+            return $this->client->setex($sessionId, $this->ttl, $sessionData);
+        }
+
+        return $this->client->set($sessionId, $sessionData, $this->ttl);
+    }
+
+    public function open($savePath, $sessionId): bool
+    {
+        return true;
+    }
+
+    private function configuration(SessionConfiguration $settings): RedisConfiguration
+    {
+        return new RedisConfiguration([
+            'prefix'  => (string)$settings->get('prefix', 'session:'),
+            'host'    => (string)$settings->get('host'),
+            'port'    => (int)$settings->get('port', 6379),
+            'timeout' => (float)$settings->get('timeout', 0.0),
+            'retry'   => (int)$settings->get('retry', 0),
+            'db'      => (int)$settings->get('db', 0),
+        ]);
+    }
+}

LICENSE

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Koded - Session library
+Copyright (c) 2018, Mihail Binev
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

NotAuthenticatedMiddleware.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <mihail@kodeart.com>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Session;
+
+use Koded\Http\{StatusCode, ServerResponse};
+use Koded\Stdlib\Interfaces\ConfigurationFactory;
+use Psr\Http\Message\{ResponseInterface, ServerRequestInterface};
+use Psr\Http\Server\{MiddlewareInterface, RequestHandlerInterface};
+
+
+class NotAuthenticatedMiddleware implements MiddlewareInterface
+{
+
+    public const SESSION_AUTHENTICATED = 'authenticated';
+    public const SESSION_REDIRECT_TO   = 'login_uri';
+
+    private $redirectTo = '/';
+
+    public function __construct(ConfigurationFactory $configuration)
+    {
+        $this->redirectTo = $configuration->get(self::SESSION_REDIRECT_TO, '/');
+    }
+
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        if (true !== $_SESSION[self::SESSION_AUTHENTICATED]) {
+            // Ajax requests should be handled in the browser
+            if (strtoupper($_SERVER['HTTP_X_REQUESTED_WITH'] ?? '') === 'XMLHTTPREQUEST') {
+                return (new ServerResponse(json_encode([
+                    'location' => $this->redirectTo,
+                    'status'   => StatusCode::UNAUTHORIZED
+                ], JSON_UNESCAPED_SLASHES), StatusCode::UNAUTHORIZED));
+            }
+
+            return (new ServerResponse(null, StatusCode::TEMPORARY_REDIRECT))
+                ->withHeader('Location', $this->redirectTo);
+        }
+
+        return $handler->handle($request);
+    }
+}

README.md

@@ -0,0 +1,56 @@
+Koded Session
+=============
+
+The library relies on the `php.ini` settings.
+Every session ini directive can be reset in the
+configuration object.
+
+Refer to session php.ini directives:
+
+
+Usage
+-----
+
+The session is started automatically by using one of the 2 methods:
+
+### app configuration
+```php
+[
+    'session' => [
+        // your ini "session." overwrites (without "session." prefix)
+    ]
+]
+```
+
+### or using a `SessionMiddleware`
+include this middleware class in your middleware stack
+
+```php
+// your middleware stack
+$middleware = [
+    SessionMiddleware::class
+];
+```
+
+Session class and function
+--------------------------
+
+```php
+session()->get('key');
+session()->set('key', 'value');
+// etc.
+```
+
+The session class can be instantiated and used, but function `session()`
+is much preferred instead an instance of `Session` class.
+
+Redis configuration
+-------------------
+
+```php
+[
+    'session' => [
+        'save_handler' => 'redis'
+    ]
+]
+```