Merge branch '5.x-dev' into resolve-aikido-12726180

Author: AltamashShaikh

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Changelog
 
 5.1.3 - 2025-09-01
+- Add support for Sentinel password
 - Security hardening
 
 5.1.2 - 2025-07-07

Queue/Backend/Sentinel.php

@@ -22,6 +22,11 @@ class Sentinel extends Redis
 {
     private $masterName = '';
 
+    /*
+     * @var bool
+     */
+    private $usePasswordForSentinelInstances = false;
+
     protected function connect()
     {
         $hosts = explode(',', $this->host);
@@ -36,6 +41,9 @@ protected function connect()
                 $configuredClient = new \Credis_Client($host, $ports[$index], $timeout = 0.5, $persistent = false);
                 $configuredClient->forceStandalone();
                 $configuredClient->connect();
+                if ($this->usePasswordForSentinelInstances && !empty($this->password)) {
+                    $configuredClient->auth($this->password);
+                }
                 $configuredSentinel = new \Credis_Sentinel($configuredClient);
                 $master = $configuredSentinel->getMasterAddressByName($this->masterName);
 
@@ -64,6 +72,11 @@ public function setSentinelMasterName($name)
         $this->masterName = $name;
     }
 
+    public function setUsePasswordForSentinelInstances(bool $usePasswordForSentinelInstances)
+    {
+        $this->usePasswordForSentinelInstances = $usePasswordForSentinelInstances;
+    }
+
     protected function evalScript($script, $keys, $args)
     {
         return $this->redis->eval($script, $keys, $args);

Queue/Factory.php

@@ -72,6 +72,9 @@ public static function makeBackendFromSettings(SystemSettings $settings)
                 $redis = new Queue\Backend\Sentinel();
                 $redis->setSentinelMasterName($masterName);
                 $redis->setDatabase($database);
+                if (!empty($settings->getUsePasswordForSentinelInstances())) {
+                    $redis->setUsePasswordForSentinelInstances(true);
+                }
             }
         } elseif ($settings->isUsingClusterBackend()) {
             $redis = new Queue\Backend\RedisCluster();

SystemSettings.php

@@ -60,6 +60,9 @@ class SystemSettings extends \Piwik\Settings\Plugin\SystemSettings
     /** @var Setting */
     public $sentinelMasterName;
 
+    /** @var Setting */
+    public $usePasswordForSentinelInstances;
+
     public function getAvailableRedisBackendTypes()
     {
         return array(
@@ -83,6 +86,7 @@ protected function init()
         $this->backend = $this->createBackendSetting();
         $this->useWhatRedisBackendType = $this->createUseWhatRedisBackendType();
         $this->sentinelMasterName = $this->createSetSentinelMasterName();
+        $this->usePasswordForSentinelInstances = $this->createUsePasswordForSentinelInstances();
         $this->redisHost = $this->createRedisHostSetting();
         $this->redisPort = $this->createRedisPortSetting();
         $this->redisTimeout = $this->createRedisTimeoutSetting();
@@ -114,6 +118,11 @@ public function getSentinelMasterName()
         return $this->sentinelMasterName->getValue();
     }
 
+    public function getUsePasswordForSentinelInstances()
+    {
+        return $this->usePasswordForSentinelInstances->getValue();
+    }
+
     public function isUsingUnixSocket()
     {
         return substr($this->redisHost->getValue(), 0, 1) === '/';
@@ -373,6 +382,16 @@ private function createSetSentinelMasterName()
         });
     }
 
+    private function createUsePasswordForSentinelInstances()
+    {
+        return $this->makeSetting('usePasswordForSentinelInstances', $default = false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
+            $field->title = Piwik::translate('QueuedTracking_UsePasswordForSentinelsTitle');
+            $field->condition = 'backend=="redis"';
+            $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
+            $field->inlineHelp = Piwik::translate('QueuedTracking_UsePasswordForSentinelsHelp', ['</br></br>']) . '</br>';
+        });
+    }
+
     public function checkMatchHostsAndPorts()
     {
         $hosts = $this->redisHost->getValue();

lang/el.json

@@ -31,6 +31,8 @@
         "RedisPortFieldTitle": "Θύρα Redis",
         "RedisTimeoutFieldHelp": "Ο χρόνος λήξης απόκρισης του Redis σε δευτερόλεπτα. Το \"0.0\" σημαίνει χωρίς όριο. Μπορεί να είναι δεκαδικός αριθμός, πχ \"2.5\" για χρόνο λήξης απόκρισης 2.5 δευτερόλεπτα.",
         "RedisTimeoutFieldTitle": "Χρόνος λήξης απόκρισης του Redis",
+        "UsePasswordForSentinelsHelp": "Σχετικό μόνο αν το Sentinel είναι ενεργό. %1$sΑν είναι ενεργό, το συνθηματικό του Redis θα χρησιμοποιείται επίσης κατά την αυθεντικοποίηση με τα στιγμιότυπα του Sentinel για να γίνει λήψη των πληροφοριών κύριας σύνδεσης. Εναλλακτικά, το συνθηματικό χρησιμοποιείται μόνο κατά την αυθεντικοποίηση με τον κύριο Redis.",
+        "UsePasswordForSentinelsTitle": "Χρήση του συνθηματικού με το Redis Sentinels",
         "UseSentinelFieldHelp": "Αν είναι ενεργό, θα χρησιμοποιηθεί το χαρακτηριστικό Redis Sentinel. Βεβαιωθείτε να ενημερώσετε το όνομα διακομιστή και τη θύρα αν απαιτηθεί. Από τη στιγμή που θα το ενεργοποιήσετε και αποθηκεύσετε την αλλαγή, θα μπορείτε να καθορίζετε πολλαπλούς διακομιστές και θύρες χωρισμένα με κόμμα.",
         "UseSentinelFieldTitle": "Ενεργοποίηση του Redis Sentinel",
         "WhatRedisBackEndType": "Επιλέξτε ποιο τύπο redis θα χρησιμοποιήσετε. Βεβαιωθείτε να ενημερώσετε το διακομιστή και θύρα αν χρειάζεται. Αφού έχετε κάνει και αποθηκεύσει την αλλαγή, θα μπορείτε να καθορίσετε πολλαπλούς διακομιστές και θύρες με λίστες και χρήση του κόμματος ως διαχωριστή μόνο για τους τύπους \"Sentinel\" και \"Cluster\"."

lang/en.json

@@ -33,6 +33,8 @@
         "MasterNameFieldTitle": "Redis Sentinel Master name",
         "MasterNameFieldHelp": "The sentinel master name only needs to be configured if Sentinel is enabled.",
         "NumHostsNotMatchNumPorts": "The number of configured hosts doesn't match the number of configured ports.",
-        "MultipleServersOnlyConfigurableIfSentinelEnabled": "Multiple hosts or ports can be only configured when Redis Sentinel is on. The plugin README will tell you how to do so."
+        "MultipleServersOnlyConfigurableIfSentinelEnabled": "Multiple hosts or ports can be only configured when Redis Sentinel is on. The plugin README will tell you how to do so.",
+        "UsePasswordForSentinelsTitle": "Use password with Redis Sentinels",
+        "UsePasswordForSentinelsHelp": "Only relevant if Sentinel is enabled.%1$sIf enabled, the Redis password will also be used when authenticating with Sentinel instances to obtain the master connection information. Otherwise, the password is only used to authenticate with the Redis master."
     }
 }

lang/ga.json

@@ -31,6 +31,8 @@
         "RedisPortFieldTitle": "Redis port",
         "RedisTimeoutFieldHelp": "Redis am istigh ceangail i soicindí. Ciallaíonn “0.0” gan teorainn. Is féidir leis a bheith ina snámhán m.sh. “2.5” le haghaidh teorainn ama ceangail 2.5 soicind.",
         "RedisTimeoutFieldTitle": "Teorainn ama Redis",
+        "UsePasswordForSentinelsHelp": "Ní bhaineann sé seo ach amháin má tá Sentinel cumasaithe.%1$sMá tá sé cumasaithe, úsáidfear an focal faire Redis freisin agus fíordheimhniú á dhéanamh le cásanna Sentinel chun an fhaisnéis nasc máistir a fháil. Seachas sin, ní úsáidtear an focal faire ach chun fíordheimhniú a dhéanamh leis an máistir Redis.",
+        "UsePasswordForSentinelsTitle": "Úsáid pasfhocal le Redis Sentinels",
         "UseSentinelFieldHelp": "Má tá sé cumasaithe, úsáidfear an ghné Redis Sentinel. Déan cinnte an t-óstach agus an port a nuashonrú más gá. Nuair a bheidh an t-athrú cumasaithe agus sábháilte agat, beidh tú in ann óstach iolrach agus port scartha le camóga a shonrú.",
         "UseSentinelFieldTitle": "Cumasaigh Redis Sentinel",
         "WhatRedisBackEndType": "Roghnaigh cén cineál redis a úsáidfear. Déan cinnte an t-óstach agus an port a nuashonrú más gá. Nuair a bheidh an t-athrú roghnaithe agus sábháilte agat, beidh tú in ann óstaigh agus poirt iolracha a shonrú ag baint úsáide as liostaí scartha le camóg don chineál “Sentinel” agus “Cnuasach” amháin."