Initial commit for redis:// scheme support

michael-grunder · michael-grunder · commit 259f10356d9c · 2015-08-04T20:08:14.000-07:00
This commit adds support for using the redis:// scheme protocol to connect to a redis server, described here: http://www.iana.org/assignments/uri-schemes/prov/redis There are multiple ways to specify password and database number (both in the uri prefix) as well as in the query arguments, and the spec is ambiguous here so phpredis will just use whichever one we parse last (which for us is the query arguments). In addition, this commit changes $redis->connect() such that it can now be called with no arguments, in which case phpredis will attempt to connect to a localhost instance of Redis at the default port of 6379. I made this change because that's how the redis:// scheme protocol is designed to work, and it should be consistent.
diff --git a/common.h b/common.h
@@ -247,6 +247,14 @@ typedef enum _PUBSUB_TYPE {
 #define IS_LEX_ARG(s,l) \
     (l>0 && (*s=='(' || *s=='[' || (l==1 && (*s=='+' || *s=='-'))))
 
+/* Determine if a string starts with the reids scheme prefix */
+#define IS_SCHEME_PREFIX(s,l) \
+    (l >= sizeof("redis://") && !strncasecmp(s, "redis://", sizeof("redis://")-1))
+
+/* Simple helper macro for calling zend_hash_find with a static string */
+#define ZEND_HASH_FIND_STATIC(ht_arr, key, retval) \
+    zend_hash_find(ht_arr, key, sizeof(key), (void**)&retval)
+
 typedef enum {ATOMIC, MULTI, PIPELINE} redis_mode;
 
 typedef struct fold_item {
diff --git a/library.c b/library.c
@@ -40,35 +40,35 @@ extern zend_class_entry *redis_ce;
 extern zend_class_entry *redis_exception_ce;
 extern zend_class_entry *spl_ce_RuntimeException;
 
-/* Helper to reselect the proper DB number when we reconnect */
-static int reselect_db(RedisSock *redis_sock TSRMLS_DC) {
+/* Helper to select the proper DB number when we connect or reconnect */
+PHP_REDIS_API int redis_send_select(RedisSock *redis_sock TSRMLS_DC) {
     char *cmd, *response;
     int cmd_len, response_len;
 
     cmd_len = redis_cmd_format_static(&cmd, "SELECT", "d", redis_sock->dbNumber);
 
     if (redis_sock_write(redis_sock, cmd, cmd_len TSRMLS_CC) < 0) {
         efree(cmd);
-        return -1;
+        return FAILURE;
     }
 
     efree(cmd);
 
     if ((response = redis_sock_read(redis_sock, &response_len TSRMLS_CC)) == NULL) {
-        return -1;
+        return FAILURE;
     }
 
     if (strncmp(response, "+OK", 3)) {
         efree(response);
-        return -1;
+        return FAILURE;
     }
 
     efree(response);
-    return 0;
+    return SUCCESS;
 }
 
-/* Helper to resend AUTH <password> in the case of a reconnect */
-static int resend_auth(RedisSock *redis_sock TSRMLS_DC) {
+/* Helper to send or resend AUTH <password> on connect or reconnect */
+PHP_REDIS_API int redis_send_auth(RedisSock *redis_sock TSRMLS_DC) {
     char *cmd, *response;
     int cmd_len, response_len;
 
@@ -77,23 +77,23 @@ static int resend_auth(RedisSock *redis_sock TSRMLS_DC) {
 
     if (redis_sock_write(redis_sock, cmd, cmd_len TSRMLS_CC) < 0) {
         efree(cmd);
-        return -1;
+        return FAILURE;
     }
 
     efree(cmd);
 
     response = redis_sock_read(redis_sock, &response_len TSRMLS_CC);
     if (response == NULL) {
-        return -1;
+        return FAILURE;
     }
 
     if (strncmp(response, "+OK", 3)) {
         efree(response);
-        return -1;
+        return FAILURE;
     }
 
     efree(response);
-    return 0;
+    return SUCCESS;
 }
 
 /* Helper function that will throw an exception for a small number of ERR codes
@@ -178,12 +178,12 @@ PHP_REDIS_API int redis_check_eof(RedisSock *redis_sock, int no_throw TSRMLS_DC)
     /* We've connected if we have a count */
     if (count) {
         /* If we're using a password, attempt a reauthorization */
-        if (redis_sock->auth && resend_auth(redis_sock TSRMLS_CC) != 0) {
+        if (redis_sock->auth && redis_send_auth(redis_sock TSRMLS_CC) != SUCCESS) {
             return -1;
         }
 
         /* If we're using a non-zero db, reselect it */
-        if (redis_sock->dbNumber && reselect_db(redis_sock TSRMLS_CC) != 0) {
+        if (redis_sock->dbNumber && redis_send_select(redis_sock TSRMLS_CC) != SUCCESS) {
             return -1;
         }
     }
@@ -1546,7 +1546,16 @@ redis_sock_create(char *host, int host_len, unsigned short port, double timeout,
     RedisSock *redis_sock;
 
     redis_sock         = ecalloc(1, sizeof(RedisSock));
-    redis_sock->host   = estrndup(host, host_len);
+    
+    /* If an empty host is provided, default to "localhost".  This conforms
+     * with other Redis libraries and is how the redis:// scheme works. */
+    if(host && host_len) {
+        redis_sock->host = estrndup(host, host_len);
+    } else {
+        redis_sock->host = estrndup("localhost", sizeof("localhost")-1);
+    }
+
+    //redis_sock->host   = estrndup(host, host_len);
     redis_sock->stream = NULL;
     redis_sock->status = REDIS_SOCK_STATUS_DISCONNECTED;
     redis_sock->watching = 0;
@@ -1563,9 +1572,6 @@ redis_sock_create(char *host, int host_len, unsigned short port, double timeout,
         redis_sock->persistent_id = NULL;
     }
 
-    memcpy(redis_sock->host, host, host_len);
-    redis_sock->host[host_len] = '\0';
-
     redis_sock->port    = port;
     redis_sock->timeout = timeout;
     redis_sock->read_timeout = timeout;
@@ -1614,8 +1620,7 @@ PHP_REDIS_API int redis_sock_connect(RedisSock *redis_sock TSRMLS_DC)
     if(redis_sock->host[0] == '/' && redis_sock->port < 1) {
         host_len = spprintf(&host, 0, "unix://%s", redis_sock->host);
     } else {
-        if(redis_sock->port == 0)
-            redis_sock->port = 6379;
+        if(redis_sock->port == 0) redis_sock->port = 6379;
         host_len = spprintf(&host, 0, "%s:%d", redis_sock->host, 
             redis_sock->port);
     }
diff --git a/library.h b/library.h
@@ -69,6 +69,8 @@ redis_unserialize(RedisSock *redis_sock, const char *val, int val_len, zval **re
 
 PHP_REDIS_API void redis_free_socket(RedisSock *redis_sock);
 PHP_REDIS_API void redis_send_discard(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock);
+PHP_REDIS_API int redis_send_auth(RedisSock *redis_sock TSRMLS_DC);
+PHP_REDIS_API int redis_send_select(RedisSock *redis_sock TSRMLS_DC);
 PHP_REDIS_API int redis_sock_set_err(RedisSock *redis_sock, const char *msg, int msg_len);
 
 
diff --git a/redis.c b/redis.c
