Rework ZRANGE argument handling.

michael-grunder · michael-grunder · commit aa0938a4e215 · 2022-12-10T12:00:09.000-08:00
Rework argument parsing for `ZRANGE` so we can pass either a string or an integer so everything will work even when using strict types. Additionally update our docs to use the correct mechanism for adding the `BYSCORE` option. Fixes #2291
diff --git a/library.c b/library.c
@@ -1073,16 +1073,23 @@ redis_cmd_append_sstr_dbl(smart_string *str, double value)
     return redis_cmd_append_sstr(str, tmp, len);
 }
 
-/* Append a zval to a redis command.  The value will be serialized if we are
- * configured to do that */
+/* Append a zval to a redis command.  If redis_sock is passed as non-null we will
+ * the value may be serialized, if we're configured to do that. */
 int redis_cmd_append_sstr_zval(smart_string *str, zval *z, RedisSock *redis_sock) {
-    char *val;
-    size_t vallen;
     int valfree, retval;
+    zend_string *zstr;
+    size_t vallen;
+    char *val;
 
-    valfree = redis_pack(redis_sock, z, &val, &vallen);
-    retval = redis_cmd_append_sstr(str, val, vallen);
-    if (valfree) efree(val);
+    if (redis_sock != NULL) {
+        valfree = redis_pack(redis_sock, z, &val, &vallen);
+        retval = redis_cmd_append_sstr(str, val, vallen);
+        if (valfree) efree(val);
+    } else {
+        zstr = zval_get_string(z);
+        retval = redis_cmd_append_sstr_zstr(str, zstr);
+        zend_string_release(zstr);
+    }
 
     return retval;
 }
diff --git a/redis.stub.php b/redis.stub.php
@@ -4108,9 +4108,9 @@ public function zPopMin(string $key, int $count = null): Redis|array|false;
      * @category zset
      *
      * @example $redis->zRange('zset', 0, -1);
-     * @example $redis->zRange('zset', '-inf', 'inf', ['byscore' => true]);
+     * @example $redis->zRange('zset', '-inf', 'inf', ['byscore']);
      */
-    public function zRange(string $key, mixed $start, mixed $end, array|bool|null $options = null): Redis|array|false;
+    public function zRange(string $key, string|int $start, string|int $end, array|bool|null $options = null): Redis|array|false;
 
     /**
      * Retrieve a range of elements from a sorted set by legographical range.
diff --git a/redis_arginfo.h b/redis_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 2d2bd3a96ba44622f4157ee2e06695ffb87a4949 */
+ * Stub hash: b0d5c56084a89230807e6ba582d2fab536d2e897 */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, options, IS_ARRAY, 0, "null")
@@ -1028,8 +1028,8 @@ ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_Redis_zRange, 0, 3, Redis, MAY_BE_ARRAY|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, key, IS_STRING, 0)
-	ZEND_ARG_TYPE_INFO(0, start, IS_MIXED, 0)
-	ZEND_ARG_TYPE_INFO(0, end, IS_MIXED, 0)
+	ZEND_ARG_TYPE_MASK(0, start, MAY_BE_STRING|MAY_BE_LONG, NULL)
+	ZEND_ARG_TYPE_MASK(0, end, MAY_BE_STRING|MAY_BE_LONG, NULL)
 	ZEND_ARG_TYPE_MASK(0, options, MAY_BE_ARRAY|MAY_BE_BOOL|MAY_BE_NULL, "null")
 ZEND_END_ARG_INFO()
 
diff --git a/redis_commands.c b/redis_commands.c
@@ -746,20 +746,23 @@ static int redis_get_zcmd_flags(const char *kw) {
 }
 
 /* Validate ZLEX* min/max argument strings */
-#define validate_zlex_arg_zstr(zs_) validate_zlex_arg(ZSTR_VAL((zs_)), ZSTR_LEN((zs_)))
-static int validate_zlex_arg(const char *arg, size_t len) {
-    return (len  > 1 && (*arg == '[' || *arg == '(')) ||
-           (len == 1 && (*arg == '+' || *arg == '-'));
+static int validate_zlex_arg(const char *str, size_t len) {
+    return (len  > 1 && (*str == '[' || *str == '(')) ||
+           (len == 1 && (*str == '+' || *str == '-'));
+}
+
+static int validate_zlex_arg_zval(zval *z) {
+    return Z_TYPE_P(z) == IS_STRING && validate_zlex_arg(Z_STRVAL_P(z), Z_STRLEN_P(z));
 }
 
 int redis_zrange_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
                      char *kw, char **cmd, int *cmd_len, short *slot,
                      void **ctx)
 {
-    zend_string *dst = NULL, *src = NULL, *sstart = NULL, *send = NULL;
+    zval *zoptions = NULL, *zstart, *zend;
+    zend_string *dst = NULL, *src = NULL;
     zend_long start = 0, end = 0;
     smart_string cmdstr = {0};
-    zval *zoptions = NULL;
     redisZcmdOptions opt;
     int min_argc, flags;
     short slot2;
@@ -776,8 +779,8 @@ int redis_zrange_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
             Z_PARAM_LONG(start)
             Z_PARAM_LONG(end)
         } else {
-            Z_PARAM_STR(sstart)
-            Z_PARAM_STR(send)
+            Z_PARAM_ZVAL(zstart)
+            Z_PARAM_ZVAL(zend)
         }
         Z_PARAM_OPTIONAL
         Z_PARAM_ZVAL_OR_NULL(zoptions)
@@ -787,7 +790,7 @@ int redis_zrange_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
 
     if (opt.bylex) {
         ZEND_ASSERT(!(flags & REDIS_ZCMD_INT_RANGE));
-        if (!validate_zlex_arg_zstr(sstart) || !validate_zlex_arg_zstr(send)) {
+        if (!validate_zlex_arg_zval(zstart) || !validate_zlex_arg_zval(zend)) {
             php_error_docref(NULL, E_WARNING, "Legographical args must start with '[' or '(' or be '+' or '-'");
             return FAILURE;
         }
@@ -812,8 +815,8 @@ int redis_zrange_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
         redis_cmd_append_sstr_long(&cmdstr, start);
         redis_cmd_append_sstr_long(&cmdstr, end);
     } else {
-        redis_cmd_append_sstr_zstr(&cmdstr, sstart);
-        redis_cmd_append_sstr_zstr(&cmdstr, send);
+        redis_cmd_append_sstr_zval(&cmdstr, zstart, NULL);
+        redis_cmd_append_sstr_zval(&cmdstr, zend, NULL);
     }
 
     REDIS_CMD_APPEND_SSTR_OPT_STATIC(&cmdstr, opt.byscore, "BYSCORE");
diff --git a/redis_legacy_arginfo.h b/redis_legacy_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 2d2bd3a96ba44622f4157ee2e06695ffb87a4949 */
+ * Stub hash: b0d5c56084a89230807e6ba582d2fab536d2e897 */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0)
 	ZEND_ARG_INFO(0, options)
