WebSVN – Moodle – Diff – /lib/dml/moodle_read_slave_trait.php

+ *
  * @package    core
  * @category   dml
  * @copyright  2018 Srdjan Janković, Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @deprecated Since Moodle 5.0. See MDL-71257.
+ * @todo       Final deprecation in Moodle 6.0. See MDL-83171.
  */
+#[\core\attribute\deprecated(
+    replacement: moodle_read_replica_trait::class,
+    since: '5.0',
+    mdl: 'MDL-71257',
+    reason: 'Renamed'
+)]
-defined('MOODLE_INTERNAL') || die();
 /**
  * Trait to wrap connect() method of database driver classes that gives
  * ability to use read only slave instances for SELECT queries. For the
      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
      * @param array $dboptions driver specific options
      * @return bool true
      * @throws dml_connection_exception if error
      */
-    abstract protected function raw_connect(string $dbhost, string $dbuser, string $dbpass, string $dbname, $prefix, array $dboptions = null): bool;
+    abstract protected function raw_connect(string $dbhost, string $dbuser, string $dbpass, string $dbname, $prefix, ?array $dboptions = null): bool;
     /**
      * Connect to db
      * The connection parameters processor that sets up stage for master write and slave readonly handles.
      * @param string $dbname The name of the database being connected to.
      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
      * @param array $dboptions driver specific options
      * @return bool true
      * @throws dml_connection_exception if error
+     * @deprecated Since Moodle 5.0. See MDL-71257.
+     * @todo Final deprecation in Moodle 6.0. See MDL-83171.
      */
+    #[\core\attribute\deprecated(
+        replacement: 'moodle_read_replica_trait::connect',
+        since: '5.0',
+        mdl: 'MDL-71257',
+        reason: 'Renamed trait'
+    )]
-    public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions = null) {
+    public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, ?array $dboptions = null) {
+        \core\deprecation::emit_deprecation(__FUNCTION__);
         $this->pdbhost = $dbhost;
         $this->pdbuser = $dbuser;
         $this->pdbpass = $dbpass;
         $this->pdbname = $dbname;
         $this->pprefix = $prefix;
         $this->pdboptions = $dboptions;
         $logconnection = false;
         if ($dboptions) {
             if (isset($dboptions['readonly'])) {
                 $this->wantreadslave = true;
                 if (!is_array($slaves) || !isset($slaves[0])) {
                     $slaves = [$slaves];
+                }
+                if (count($slaves) > 1) {
+                    // Don't shuffle for unit tests as order is important for them to pass.
-                if (count($slaves) > 1) {
+                    if (!PHPUNIT_TEST) {
-                    // Randomise things a bit.
+                        // Randomise things a bit.
+                        shuffle($slaves);
                     shuffle($slaves);
+                }
                 // Find first connectable readonly slave.
                     $dboptions['dbport'] = isset($slave['dbport']) ? $slave['dbport'] : $dbport;
                     try {
                         $this->raw_connect($rodb['dbhost'], $rodb['dbuser'], $rodb['dbpass'], $dbname, $prefix, $dboptions);
+                        $this->dbhreadonly = $this->get_db_handle();
+                        if ($logconnection) {
+                            debugging(
+                                "Readonly db connection succeeded for host {$rodb['dbhost']}"
+                            );
                         $this->dbhreadonly = $this->get_db_handle();
                         break;
+                    } catch (dml_connection_exception $e) {
-                    } catch (dml_connection_exception $e) { // phpcs:ignore
+                        debugging(
+                            "Readonly db connection failed for host {$rodb['dbhost']}: {$e->debuginfo}"
+                        );
-                        // If readonly slave is not connectable we'll have to do without it.
+                        $logconnection = true;
+                    }
+                }
                 // ... lock_db queries always go to master.
                 // Since it is a lock and as such marshalls concurrent connections,
                 // ... and sessions.
                 $this->readexclude[] = 'sessions';
+            }
+        }
         if (!$this->dbhreadonly) {
+            try {
-            $this->set_dbhwrite();
+                $this->set_dbhwrite();
+            } catch (dml_connection_exception $e) {
+                debugging(
+                    "Readwrite db connection failed for host {$this->pdbhost}: {$e->debuginfo}"
+                );
+                throw $e;
+            }
+            if ($logconnection) {
+                debugging(
+                    "Readwrite db connection succeeded for host {$this->pdbhost}"
+                );
+            }
+        }
         return true;
+    }
     /**
      * Returns whether we want to connect to slave database for read queries.
+     * @return bool Want read only connection
+     * @deprecated Since Moodle 5.0. See MDL-71257.
-     * @return bool Want read only connection
+     * @todo Final deprecation in Moodle 6.0. See MDL-83171.
+     */
+    #[\core\attribute\deprecated(
+        replacement: 'moodle_read_replica_trait::want_read_replica',
+        since: '5.0',
+        mdl: 'MDL-71257',
+        reason: 'Renamed trait'
-     */
+    )]
+    public function want_read_slave(): bool {
-    public function want_read_slave(): bool {
+        \core\deprecation::emit_deprecation(__FUNCTION__);
         return $this->wantreadslave;
+    }
     /**
+     * Returns the number of reads done by the read only database.
+     * @return int Number of reads.
-     * Returns the number of reads done by the read only database.
+     * @deprecated Since Moodle 5.0. See MDL-71257.
+     * @todo Final deprecation in Moodle 6.0. See MDL-83171.
+     */
+    #[\core\attribute\deprecated(
+        replacement: 'moodle_read_replica_trait::perf_get_reads_replica',
+        since: '5.0',
+        mdl: 'MDL-71257',
-     * @return int Number of reads.
+        reason: 'Renamed trait'
+    )]
-     */
+    public function perf_get_reads_slave(): int {
-    public function perf_get_reads_slave(): int {
+        \core\deprecation::emit_deprecation(__FUNCTION__);
         return $this->readsslave;
+    }
+    /**
+     * On DBs that support it, switch to transaction mode and begin a transaction
-    /**
+     * @return moodle_transaction
+     * @deprecated Since Moodle 5.0. See MDL-71257.
+     * @todo Final deprecation in Moodle 6.0. See MDL-83171.
+     */
+    #[\core\attribute\deprecated(
+        replacement: 'moodle_read_replica_trait::start_delegated_transaction',
+        since: '5.0',
-     * On DBs that support it, switch to transaction mode and begin a transaction
+        mdl: 'MDL-71257',
+        reason: 'Renamed trait'
-     * @return moodle_transaction
+    )]
-     */
+    public function start_delegated_transaction() {
-    public function start_delegated_transaction() {
+        \core\deprecation::emit_deprecation(__FUNCTION__);
         $this->set_dbhwrite();
      * Indicates delegated transaction finished successfully.
      * Set written times after outermost transaction finished
      * @param moodle_transaction $transaction The transaction to commit
      * @return void
      * @throws dml_transaction_exception Creates and throws transaction related exceptions.
+     * @deprecated Since Moodle 5.0. See MDL-71257.
+     * @todo Final deprecation in Moodle 6.0. See MDL-83171.
      */
+    #[\core\attribute\deprecated(
+        replacement: 'moodle_read_replica_trait::commit_delegated_transaction',
+        since: '5.0',
+        mdl: 'MDL-71257',
+        reason: 'Renamed trait'
+    )]
     public function commit_delegated_transaction(moodle_transaction $transaction) {
+        \core\deprecation::emit_deprecation(__FUNCTION__);
         if ($this->written) {
             // Adjust the written time.
             $now = microtime(true);
             foreach ($this->written as $tablename => $when) {
                 $this->written[$tablename] = $now;

Proyectos de Subversion Moodle

(root)/lib/dml/moodle_read_slave_trait.php – Rev 1 → 1441