Additional cluster based session additions

michael-grunder · michael-grunder · commit 716536452db4 · 2015-06-20T16:05:38.000-07:00
* Initial documentation for cluster based session handler
* Updated how we handle persistent option (so we can use 1/yes/true)
diff --git a/cluster.markdown b/cluster.markdown
@@ -14,8 +14,15 @@ $obj_cluster = new RedisCluster(NULL, Array('host:7000', 'host:7001', 'host:7003
 
 // Connect and specify timeout and read_timeout
 $obj_cluster = new RedisCluster(
-    NULL, Array("host:7000", "host:7001", 1.5, 1.5);
+    NULL, Array("host:7000", "host:7001"), 1.5, 1.5
 );
+
+// Connect with read/write timeout as well as specify that phpredis should use
+// persistent connections to each node.
+$obj_cluster = new RedisCluster(
+    NULL, Array("host:7000", "host:7001"), 1.5, 1.5, true
+);
+
 </pre>
 
 #### Loading a cluster configuration by name
@@ -146,3 +153,26 @@ In the case of all commands which need to be directed at a node, the calling con
 14.  RANDOMKEY
 15.  PING
 
+## Session Handler
+You can use the cluster functionality of phpredis to store PHP session information in a Redis cluster as you can with a non cluster-enabled Redis instance.
+
+To do this, you must configure your `session.save_handler` and `session.save_path` INI variables to give phpredis enough information to communicate with the cluster.
+
+~~~
+session.save_handler = rediscluster
+session.save_path = "seed[]=host1:port1&seed[]=host2:port2&seed[]=hostN:portN&timeout=2&read_timeout=2&failover=error&persistent=1"
+~~~
+
+### session.session_handler
+Set this variable to "rediscluster" to inform phpredis that this is a cluster instance.
+
+### session.save_path
+The save path for cluster based session storage takes the form of a PHP GET request, and requires that you specify at least on `seed` node.  Other options you can specify are as follows:
+
+* _timeout (double)_:  The amount of time phpredis will wait when connecting or writing to the cluster.
+* _read_timeout (double)_: The amount of time phpredis will wait for a result from the cluster.
+* _persistent_: Tells phpredis whether persistent connections should be used.
+* _distribute_: phpredis will randomly distribute session reads between masters and any attached slaves (load balancing).
+* _failover (string)_:  How phpredis should distribute session reads between master and slave nodes.
+* * _none_ : phpredis will only communicate with master nodes
+* * _error_: phpredis will communicate with master nodes unless one failes, in which case an attempt will be made to read session information from a slave. 
diff --git a/redis_session.c b/redis_session.c
@@ -477,6 +477,29 @@ static void session_conf_timeout(HashTable *ht_conf, const char *key, int key_le
     }
 }
 
+/* Simple helper to retreive a boolean (0 or 1) value from a string stored in our
+ * session.save_path variable.  This is so the user can use 0, 1, or 'true', 
+ * 'false' */
+static void session_conf_bool(HashTable *ht_conf, char *key, int keylen,
+                              int *retval) {
+    zval **z_val;
+    char *str;
+    int strlen;
+
+    /* See if we have the option, and it's a string */   
+    if (zend_hash_find(ht_conf, key, keylen, (void**)&z_val) == SUCCESS &&
+        Z_TYPE_PP(z_val) == IS_STRING)
+    {
+        str = Z_STRVAL_PP(z_val);
+        strlen = Z_STRLEN_PP(z_val);
+
+        /* true/yes/1 are treated as true.  Everything else is false */
+        *retval = (strlen == 4 && !strncasecmp(str, "true", 4)) ||
+                  (strlen == 3 && !strncasecmp(str, "yes", 3)) ||
+                  (strlen == 1 && !strncasecmp(str, "1", 1));
+    }
+}
+
 /* Prefix a session key */
 static char *cluster_session_key(redisCluster *c, const char *key, int keylen, 
                                  int *skeylen, short *slot) {
@@ -524,6 +547,9 @@ PS_OPEN_FUNC(rediscluster) {
     session_conf_timeout(ht_conf, "timeout", sizeof("timeout"), &timeout);
     session_conf_timeout(ht_conf, "read_timeout", sizeof("read_timeout"), &read_timeout);
 
+    /* Grab persistent option */
+    session_conf_bool(ht_conf, "persistent", sizeof("persistent"), &persistent);
+    
     /* Sanity check on our timeouts */
     if (timeout < 0 || read_timeout < 0) {
         php_error_docref(NULL TSRMLS_CC, E_WARNING,
@@ -555,13 +581,6 @@ PS_OPEN_FUNC(rediscluster) {
         }
     }
 
-    /* Check for persistent option */
-    if (zend_hash_find(ht_conf, "persistent", sizeof("persistent"), (void **)&z_val) == SUCCESS &&
-        Z_TYPE_PP(z_val) == IS_STRING)
-    {
-        persistent = atoi(z_val);
-    }
-
     c = cluster_create(timeout, read_timeout, failover, persistent);
     if (!cluster_init_seeds(c, ht_seeds) && !cluster_map_keyspace(c TSRMLS_CC)) {
         /* Set up our prefix */
