MDL-66546 caching: Add support to unix:// connections to redis.

ralferlebach · Nov 2, 2023 · 63a7ce5 · 63a7ce5
1 parent e4d1369
commit 63a7ce5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/cache/stores/redis/addinstanceform.php b/cache/stores/redis/addinstanceform.php
@@ -43,6 +43,7 @@ protected function configuration_definition() {
         $form->setType('server', PARAM_TEXT);
         $form->addHelpButton('server', 'server', 'cachestore_redis');
         $form->addRule('server', get_string('required'), 'required');
+        $form->addElement('static', 'server_desc', '',  get_string('server_desc', 'cachestore_redis'));
 
         $form->addElement('advcheckbox', 'encryption', get_string('encrypt_connection', 'cachestore_redis'));
         $form->setType('encryption', PARAM_BOOL);

diff --git a/cache/stores/redis/lang/en/cachestore_redis.php b/cache/stores/redis/lang/en/cachestore_redis.php
@@ -42,12 +42,13 @@
 $string['serializer_igbinary'] = 'The igbinary serializer.';
 $string['serializer_php'] = 'The default PHP serializer.';
 $string['server'] = 'Server';
-$string['server_help'] = 'This sets the hostname or IP address of the Redis server to use.';
+$string['server_desc'] = 'For Unix socket usage, use the format <strong>/var/redis.sock</strong> or <strong>unix:///var/redis.sock</strong>';
+$string['server_help'] = 'This sets the hostname, IP address or Unix socket path of the Redis server to use.';
 $string['password'] = 'Password';
 $string['password_help'] = 'This sets the password of the Redis server.';
 $string['task_ttl'] = 'Free up memory used by expired entries in Redis caches';
 $string['test_server'] = 'Test server';
-$string['test_server_desc'] = 'Redis server to use for testing.';
+$string['test_server_desc'] = 'Redis server to use for testing.<br>For Unix socket usage, use the format <strong>/var/redis.sock</strong> or <strong>unix:///var/redis.sock</strong>';
 $string['test_password'] = 'Test server password';
 $string['test_password_desc'] = 'Redis test server password.';
 $string['test_serializer'] = 'Serializer';

diff --git a/cache/stores/redis/lib.php b/cache/stores/redis/lib.php
@@ -217,7 +217,8 @@ protected function new_redis(array $configuration): \Redis {
         // Check if it isn't a Unix socket to set default port.
         $port = null;
         $opts = [];
-        if ($server[0] === '/') {
+        // Unix sockets can start with / or with unix://.
+        if ($server[0] === '/' || strpos($server, 'unix://') === 0) {
             $port = 0;
         } else {
             $port = 6379; // No Unix socket so set default port.