Merge pull request #197 from forfin/php-redis-session-abstract_v2

Upgrade php-redis-session-abstract to v2

Author: colinmollenhour

.gitignore

@@ -1 +1,3 @@
 .basedir
+vendor
+composer.lock

README.md

@@ -84,6 +84,22 @@ The Magento Compiler feature is currently not supported.
             <min_lifetime>60</min_lifetime>                      <!-- Set the minimum session lifetime -->
             <max_lifetime>2592000</max_lifetime>                 <!-- Set the maximum session lifetime -->
             <log_exceptions>0</log_exceptions>                   <!-- Log connection failure and concurrent connection exceptions in exception.log. -->
+            <retries>0</retries>                                 <!-- Connection retries for sentinels -->
+            <username></username>                                <!-- Optional: username -->
+            <!-- 
+             Note for TLS options: If the cluster seeds start with "ssl:// or tls://", 
+             it will connect to the seeds via TLS, but the subsequent connections will connect without TLS if this value is null.
+             So, if your nodes require TLS, this value must be an array, even if empty.
+             https://github.com/phpredis/phpredis/blob/6.2.0/cluster.md#declaring-a-cluster-with-an-array-of-seeds
+            -->
+            <tls_options></tls_options>                          <!-- Optional: For example <tls_options><verify_peer>1</verify_peer></tls_options>, See https://www.php.net/manual/en/context.ssl.php -->
+            <use_default_tls_options></use_default_tls_options>  <!-- Optional: Always set tls_options to empty array if value is Truthy -->
+            <sentinel_password></sentinel_password>              <!-- Optional: Redis Sentinel password -->
+            <cluster>                                            <!-- Optional: Ignore <host/> and <port/> when set and change client to cluster mode -->
+                <seeds></seeds>                                  <!-- Optional: Comma separate host and port seed nodes, For example <seeds>tls://redis-1:6379,tls://redis-2:6379</seeds> -->
+                <name></name>                                    <!-- Optional: Name for cluster as read in redis.ini; See https://github.com/phpredis/phpredis/blob/6.2.0/cluster.md#loading-a-cluster-configuration-by-name -->
+                <persistent></persistent>                        <!-- Optional: Should we use persistent connection? -->
+            </cluster>
         </redis_session>
         ...
     </global>

app/code/community/Cm/RedisSession/Model/Session.php

@@ -48,7 +48,7 @@ class Cm_RedisSession_Model_Session implements SessionHandlerInterface
     public function __construct($config = array())
     {
         $this->sessionHandler = new \Cm\RedisSession\Handler(
-            new Cm_RedisSession_Model_Session_Config($config['session_name'] ?? 'default'),
+            Cm_RedisSession_Model_Session_Config::create($config['session_name'] ?? 'default'),
             new Cm_RedisSession_Model_Session_Logger(),
             Mage::registry('controller')
               && Mage::app()->getFrontController()->getAction()

app/code/community/Cm/RedisSession/Model/Session/ClusterConfig.php

@@ -0,0 +1,83 @@
+<?php
+/*
+==New BSD License==
+
+Copyright (c) 2013, Colin Mollenhour
+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.
+    * The name of Colin Mollenhour may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+    * Redistributions in any form must not change the Cm_RedisSession namespace.
+
+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 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.
+ */
+
+class Cm_RedisSession_Model_Session_ClusterConfig extends Cm_RedisSession_Model_Session_Config implements \Cm\RedisSession\Handler\ClusterConfigInterface
+{
+
+    /**
+     * @var Varien_Object
+     */
+    protected $clusterConfig = null;
+
+    public function __construct(string $sessionName, Mage_Core_Model_Config_Element $clusterConfig)
+    {
+        parent::__construct($sessionName);
+
+        $seeds = preg_split('/\s*,\s*/', trim((string) $clusterConfig->descend('seeds')), -1, PREG_SPLIT_NO_EMPTY);
+        $this->clusterConfig = new Varien_Object([
+            'name' => $clusterConfig->descend('name') ? $clusterConfig->descend('name') : null,
+            'seeds' => $seeds,
+            'persistent' => (bool) $clusterConfig->descend('persistent'),
+        ]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function isCluster(): bool
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getClusterName(): ?string
+    {
+        return $this->clusterConfig->getData('name');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getClusterSeeds(): ?array
+    {
+        return $this->clusterConfig->getData('seeds');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getClusterUsePersistentConnection(): bool
+    {
+        return $this->clusterConfig->getData('persistent');
+    }
+}

app/code/community/Cm/RedisSession/Model/Session/Config.php

@@ -29,7 +29,11 @@
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-class Cm_RedisSession_Model_Session_Config implements \Cm\RedisSession\Handler\ConfigInterface
+class Cm_RedisSession_Model_Session_Config implements
+    \Cm\RedisSession\Handler\ConfigInterface,
+    \Cm\RedisSession\Handler\UsernameConfigInterface,
+    \Cm\RedisSession\Handler\TlsOptionsConfigInterface,
+    \Cm\RedisSession\Handler\ConfigSentinelPasswordInterface
 {
     /**
      * @var Varien_Object
@@ -64,9 +68,22 @@ public function __construct(string $sessionName)
             'sentinel_verify_master' => $config->is('sentinel_verify_master'),
             'sentinel_connect_retries' => (int) $config->descend('sentinel_connect_retries'),
             'break_after' => (int) $config->descend('break_after_' . $sessionName),
+            'retries' => (int) $config->descend('retries'),
+            'username' => $config->descend('username') ? (string) $config->descend('username') : null,
+            'tls_options' => $config->descend('use_default_tls_options') ? [] : ($config->descend('tls_options') ? (array) $config->descend('tls_options') : null),
+            'sentinel_password' => $config->descend('sentinel_password') ? (string) $config->descend('sentinel_password') : (string) $config->descend('password'),
         ]);
     }
 
+    public static function create(string $sessionName)
+    {
+        $clusterConfig = Mage::getConfig()->getNode('global/redis_session/cluster') ?: new Mage_Core_Model_Config_Element('<root></root>');
+        if ($clusterConfig->hasChildren()) {
+            return new Cm_RedisSession_Model_Session_ClusterConfig($sessionName, $clusterConfig);
+        }
+        return new self($sessionName);
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -252,4 +269,36 @@ public function getSentinelConnectRetries()
     {
         return $this->config->getData('sentinel_connect_retries');
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getRetries()
+    {
+        return $this->config->getData('retries');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getUsername(): ?string
+    {
+        return $this->config->getData('username');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getTlsOptions(): ?array
+    {
+        return $this->config->getData('tls_options');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getSentinelPassword(): ?string
+    {
+        return $this->config->getData('sentinel_password');
+    }
 }

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
       "colinmollenhour/credis": "*",
-      "colinmollenhour/php-redis-session-abstract": "~1.4"
+      "colinmollenhour/php-redis-session-abstract": "~2.1"
     },
     "suggest":{
         "magento-hackathon/magento-composer-installer":"Makes it possible to manage this package as a dependency"