Merge tag '5.3.0' into develop

phpredis 5.3.0

  This release contains initial support for Redis 6 ACLs, LZ4 compression,
  and many more fixes and improvements.

  You can find a detailed list of changes in Changelog.md and package.xml

  A special thanks to BlueHost for sponsoring ACL support \o/

  * Sponsors
    ~ Audiomack - https://audiomack.com
    ~ BlueHost - https://bluehost.com
    ~ Redis Cache Pro for WordPress - https://wprediscache.com
    ~ Avtandil Kikabidze - https://github.com/akalongman

Author: michael-grunder

.travis.yml

@@ -30,11 +30,13 @@ addons:
     packages:
     - clang
     - libzstd1-dev
+    - liblz4-dev
+    - pkg-config
     - valgrind
     - stunnel
 before_install:
   - phpize
-  - CFGARGS="--enable-redis-lzf --enable-redis-zstd"
+  - CFGARGS="--enable-redis-lzf --enable-redis-zstd --enable-redis-lz4 --with-liblz4"
   - pecl install igbinary && CFGARGS="$CFGARGS --enable-redis-igbinary"
   - pecl install msgpack && CFGARGS="$CFGARGS --enable-redis-msgpack"
   - ./configure $CFGARGS

Changelog.md

@@ -5,28 +5,156 @@ All changes to phpredis will be documented in this file.
 We're basing this format on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and PhpRedis adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [5.3.0] - 2020-06-30 ([GitHub](https://github.com/phpredis/phpredis/releases/tag/5.3.0), [PECL](https://pecl.php.net/package/redis/5.3.0))
+
+### Sponsors :sparkling_heart:
+
+- [Audiomack](https://audiomack.com)
+- [BlueHost](https://bluehost.com)
+- [Redis Cache Pro for WordPress](https://wprediscache.com)
+- [Avtandil Kikabidze](https://github.com/akalongman)
+
+*There were no changes between 5.3.0RC2 and 5.3.0*
+
+## [5.3.0RC2] - 2020-06-26 ([GitHub](https://github.com/phpredis/phpredis/releases/tag/5.3.0RC2), [PECL](https://pecl.php.net/package/redis/5.3.0RC2))
+
+### Sponsors :sparkling_heart:
+
+- [Audiomack](https://audiomack.com)
+- [BlueHost](https://bluehost.com)
+- [Redis Cache Pro for WordPress](https://wprediscache.com/)
+- [Avtandil Kikabidze](https://github.com/akalongman)
+
+### Fixed
+
+- Fix LZ4 configuration and use pkg-config if we have it
+  [df398cb0](https://github.com/phpredis/phpredis/commit/df398cb07cd10d870c6805d5834703dc39590b0f)
+  ([Remi Collet](https://github.com/remicollet))
+
+- Make sure persistent pool ID is NULL terminated
+  [0838b5bd](https://github.com/phpredis/phpredis/commit/0838b5bde7ef25d419868c7e705bf6c70d68ea20),
+  [57bb95bf](https://github.com/phpredis/phpredis/commit/57bb95bf5a01a2adb74e2bf73bb285488e0d1586)
+  ([Michael Grunder](https://github.com/michael-grunder))
+
+### Changed
+
+- Run LZ4 tests in Travis
+  [3ba3f06d](https://github.com/phpredis/phpredis/commit/3ba3f06d51ff126eb51dd697381c0e56b38bbcf3)
+  ([Michael Grunder](https://github.com/michael-grunder))
+
+## [5.3.0RC1]
 
 ### Sponsors :sparkling_heart:
 
 - [Audiomack.com](https://audiomack.com)
-- [Till Krüss](https://github.com/tillkruss)
+- [BlueHost](https://bluehost.com)
+- [Redis Cache Pro for WordPress](https://wprediscache.com/)
+- [Avtandil Kikabidze](https://github.com/akalongman)
+
+### Added
+
+- Support for Redis 6 ACLs
+  [a311cc4e](https://github.com/phpredis/phpredis/commit/a311cc4ec3cecdbaf83ba66985efa82137e37cc0)
+  ([Michael Grunder](https://github.com/michael-grunder))
+
+- LZ4 Compression
+  [04def9fb](https://github.com/phpredis/phpredis/commit/04def9fbe2194b3b711362de57260a6cd5216e69)
+  ([Ilia Alshanetsky](https://github.com/iliaal),
+   [Michael Grunder](https://github.com/michael-grunder))
+
+- Support for new Redis 6 arguments (XINFO FULL, SET KEEPTTL)
+  [a0c53e0b](https://github.com/phpredis/phpredis/commit/a0c53e0b30e0c6af15cc137415e7d65f6d1867f7),
+  [f9c7bb57](https://github.com/phpredis/phpredis/commit/f9c7bb5788c39614c23e3bb9ec42ec8d6d5bbaa1)
+  ([Victor Kislov](https://github.com/vityank),
+   [Michael Grunder](https://github.com/michael-grunder))
+
+- Support for TLS connections
+  [890ee0e6](https://github.com/phpredis/phpredis/commit/890ee0e656e545b18179cf247db94a33179ce1ab),
+  [b0671296](https://github.com/phpredis/phpredis/commit/b067129678264fc1c5c0f611ce1b192e05c14669)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- New option Redis::SCAN_PREFIX, Redis::SCAN_NOPREFIX
+  [e80600e2](https://github.com/phpredis/phpredis/commit/e80600e244b8442cb7c86e99b067966cd59bf2ee)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- Configurable unit test authentication arguments
+  [e37f38a3](https://github.com/phpredis/phpredis/commit/e37f38a39eb4bece8f49ebd0652112dc992084a0),
+  [201a9759](https://github.com/phpredis/phpredis/commit/201a97599953a9621bb8eb02dc8d5f08d16499a3)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko),
+   [Michael Grunder](https://github.com/michael-grunder))
+
+### Fixed
+
+- Improved cluster slot caching mechanism to fix a couple of bugs and make it more efficient.
+  [5ca4141c](https://github.com/phpredis/phpredis/commit/5ca4141c72e23816f146b49877a6a4b8098b34c6)
+  ([Michael Grunder](https://github.com/michael-grunder))
+
+- Stop calling Redis constructor when creating a RedisArray
+  [e41e19a8](https://github.com/phpredis/phpredis/commit/e41e19a8342212ee9cfe35f622804c9870d05ec2)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- Use ZEND_LONG_FMT instead of system `long`
+  [5bf88124](https://github.com/phpredis/phpredis/commit/5bf881244dd30b5310fcfcaf5bcd8f9e2675bb01)
+  ([Michael Grunder](https://github.com/michael-grunder))
+
+- Use long for SCAN iteration to fix potential overflow
+  [f13f9b7c](https://github.com/phpredis/phpredis/commit/f13f9b7c7f5e3a7d286b412541199a408a0a98bd)
+  ([Victor Kislov](https://github.com/vityank))
+
+- Fix config.m4 to test for the variable $PHP_REDIS_JSON and not the literal PHP_REDIS_JSON
+  [20a3dc72](https://github.com/phpredis/phpredis/commit/20a3dc7251cb0bf450ef2a1cfeeeaeaa10355cd2)
+  ([Mizuki Nakano](https://github.com/mi-nakano))
+
+- Fix compiler warnings
+  [b9b383f4](https://github.com/phpredis/phpredis/commit/b9b383f49939484dcddf1a5edefdb9d753baa7f8),
+  [215828e](https://github.com/phpredis/phpredis/commit/215828e3474dfd9ea72fdc6da67aa6bee2d95ddf)
+  ([Remi Collet](https://github.com/remicollet), [Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- Avoid use-after-free of RediSock
+  [8c45816d](https://github.com/phpredis/phpredis/commit/8c45816dbf4746f6557f83332be874bd78b5ce34)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- Fixed ZADD arginfo
+  [a8e2b021](https://github.com/phpredis/phpredis/commit/a8e2b021f9eb51ad3ed0cc89064e2f004c56f8ba)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
 
 ### Changed
 
-- Use the portable `ZEND_LONG_FORMAT` family instead of C format specifiers
-  [b9b383f4](https://github.com/phpredis/phpredis/commit/b9b383f4)
-  ([Remi Collet](https://github.com/remicollet))
+- Store AUTH information in flags RedisSock rather than duplicating information.
+  [58dab564](https://github.com/phpredis/phpredis/commit/58dab5649fcc2cc63f5a29df83f783e154d7fa22)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
 
-- Make unit test authentication configurable
-  [201a9759](https://github.com/phpredis/phpredis/commit/201a9759)
-  ([Michel Grunder](https://github.com/michael-grunder))
+- Refactor redis_sock_get_connection_pool logic.
+  [73212e1](https://github.com/phpredis/phpredis/commit/73212e141403ec47441142fe1c7fd5fad24f6720)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- Updated documentation to show LPUSH and RPUSH are variadic and fixed DEL documentation.
+  [92f8dde1](https://github.com/phpredis/phpredis/commit/92f8dde1c996d4e1c3d79226b888119307612c40)
+  ([Michael Grunder](https://github.com/michael-grunder))
+
+- Authenticate in redis_server_sock_open
+  [4ef465b5](https://github.com/phpredis/phpredis/commit/4ef465b57325d2d93234fd66af06a7091ce7d1ea)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
+
+- Dynamically include json.so in unit tests based on configuration
+  [0ce7ca2f](https://github.com/phpredis/phpredis/commit/0ce7ca2fb1eb2f3c445487957a49b70ad8d4ecb6)
+  (([Michael Grunder](https://github.com/michael-grunder))
+
+- Update save_path logic in Redis Cluster session unit tests
+  [dd66fce](https://github.com/phpredis/phpredis/commit/dd66fceeb232f9e1fb0a26373949e810180dc5fc)
+  ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
 
-- Various small changes in library and cluster_library
-  [73212e14](https://github.com/phpredis/phpredis/commit/73212e14),
-  [460c8f29](https://github.com/phpredis/phpredis/commit/460c8f29)
+- Refactoring various bits of logic
+  [bbcf32a3](https://github.com/phpredis/phpredis/commit/bbcf32a37fa856ba0b50b489ba05bd3d43800fcc),
+  [a42cf189](https://github.com/phpredis/phpredis/commit/a42cf189a776fc43acf47ca519f1d7385cc27f2f),
+  [460c8f29](https://github.com/phpredis/phpredis/commit/460c8f29239c263e15a093c9bcdb6fb24587ec7d),
+  [b7f9df75](https://github.com/phpredis/phpredis/commit/b7f9df758b30187864012d5cd831dbbc5fa053d0),
   ([Pavlo Yatsukhnenko](https://github.com/yatsukhnenko))
 
+- Use the portable `ZEND_LONG_FORMAT` family instead of C format specifiers
+  [b9b383f4](https://github.com/phpredis/phpredis/commit/b9b383f4)
+  ([Remi Collet](https://github.com/remicollet))
+
 - PHP 8 compatibility
   [9ee94ca4](https://github.com/phpredis/phpredis/commit/9ee94ca4),
   [7e4c7b3e](https://github.com/phpredis/phpredis/commit/7e4c7b3e)

README.markdown

@@ -20,10 +20,7 @@ You can also make a one-time contribution with one of the links below.
 [![Ethereum](https://en.cryptobadges.io/badge/micro/0x43D54E32357B96f68dFF0a6B46976d014Bd603E1)](https://en.cryptobadges.io/donate/0x43D54E32357B96f68dFF0a6B46976d014Bd603E1)
 
 ## Sponsors
-
-<a href="https://audiomack.com">
-    <img src="https://styleguide.audiomack.com/styleguide/assets/dl/inline-orange-large.png" alt="Audiomack.com" width="150">
-</a>
+<a href="https://audiomack.com"><img src="https://styleguide.audiomack.com/styleguide/assets/dl/inline-orange-large.png" alt="Audiomack.com" width="150"></a><a href="https://bluehost.com"><img src="https://upload.wikimedia.org/wikipedia/commons/2/22/Bluehost-logo.png" alt="Bluehost.com" width="150"></a>
 
 # Table of contents
 -----
@@ -221,6 +218,9 @@ $redis->connect('tls://127.0.0.1'); // enable transport level security, port 637
 $redis->connect('127.0.0.1', 6379, 2.5); // 2.5 sec timeout.
 $redis->connect('/tmp/redis.sock'); // unix domain socket.
 $redis->connect('127.0.0.1', 6379, 1, NULL, 100); // 1 sec timeout, 100ms delay between reconnection attempts.
+
+/* With PhpRedis >= 5.3.0 you can specify authentication information on connect */
+$redis->connect('127.0.0.1', 6379, 1, NULL, 0, 0, ['auth' => ['phpredis', 'phpredis']]);
 ~~~
 
 **Note:** `open` is an alias for `connect` and will be removed in future versions of phpredis.
@@ -291,6 +291,10 @@ $redis->auth(['phpredis', 'haxx00r']);
 
 /* Authenticate with the password 'foobared' */
 $redis->auth(['foobared']);
+
+/* You can also use an associative array specifying user and pass */
+$redis->auth(['user' => 'phpredis', 'pass' => 'phpredis]);
+$redis->auth(['pass' => 'phpredis']);
 ~~~
 
 ### select
@@ -4327,10 +4331,10 @@ using a persistent ID, and FALSE if we're not connected
 
 ### getAuth
 -----
-_**Description**_:  Get the password used to authenticate the phpredis connection
+_**Description**_:  Get the password (or username and password if using Redis 6 ACLs) used to authenticate the connection.
 
 ### *Parameters*
 None
 
 ### *Return value*
-*Mixed*  Returns the password used to authenticate a phpredis session or NULL if none was used, and FALSE if we're not connected
+*Mixed*  Returns NULL if no username/password are set, the password string if a password is set, and a `[username, password]` array if authenticated with a username and password.

library.c

@@ -777,8 +777,10 @@ redis_pool_spprintf(RedisSock *redis_sock, char *fmt, ...) {
     smart_str_append_long(&str, (zend_long)redis_sock->port);
 
     /* Short circuit if we don't have a pattern */
-    if (fmt == NULL)
+    if (fmt == NULL) {
+        smart_str_0(&str);
         return str.s;
+    }
 
     while (*fmt) {
         switch (*fmt) {
@@ -808,6 +810,7 @@ redis_pool_spprintf(RedisSock *redis_sock, char *fmt, ...) {
         fmt++;
     }
 
+    smart_str_0(&str);
     return str.s;
 }
 
@@ -2118,13 +2121,26 @@ static int redis_uniqid(char *buf, size_t buflen) {
                     (long)tv.tv_sec, (long)tv.tv_usec, (long)php_rand());
 }
 
+static int redis_stream_liveness_check(php_stream *stream) {
+    return php_stream_set_option(stream, PHP_STREAM_OPTION_CHECK_LIVENESS,
+                                 0, NULL) == PHP_STREAM_OPTION_RETURN_OK ?
+                                 SUCCESS : FAILURE;
+}
+
 static int
 redis_sock_check_liveness(RedisSock *redis_sock)
 {
     char id[64], ok;
     int idlen, auth;
     smart_string cmd = {0};
 
+    /* Short circuit if we detect the stream has gone bad or if the user has
+     * configured persistent connection "YOLO mode". */
+    if (redis_stream_liveness_check(redis_sock->stream) != SUCCESS)
+        return FAILURE;
+    else if (!INI_INT("redis.pconnect.echo_check_liveness"))
+        return SUCCESS;
+
     /* AUTH (if we need it) */
     auth = redis_sock_append_auth(redis_sock, &cmd);