Merge "rdbms: expand on LoadBalancer ownership concept"

[lhc/web/wiklou.git] / maintenance / Maintenance.php

diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index b74ac40..6d6dbe5 100644 (file)
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -89,7 +89,11 @@ abstract class Maintenance {
        // Const for getStdin()
        const STDIN_ALL = 'all';
 
-       // Array of desired/allowed params
+       /**
+        * Array of desired/allowed params
+        * @var array[]
+        * @phan-var array<string,array{desc:string,require:bool,withArg:string,shortName:string,multiOccurrence:bool}>
+        */
        protected $mParams = [];
 
        // Array of mapping short parameters to long ones
@@ -128,9 +132,17 @@ abstract class Maintenance {
         */
        protected $mBatchSize = null;
 
-       // Generic options added by addDefaultParams()
+       /**
+        * Generic options added by addDefaultParams()
+        * @var array[]
+        * @phan-var array<string,array{desc:string,require:bool,withArg:string,shortName:string,multiOccurrence:bool}>
+        */
        private $mGenericParameters = [];
-       // Generic options which might or not be supported by the script
+       /**
+        * Generic options which might or not be supported by the script
+        * @var array[]
+        * @phan-var array<string,array{desc:string,require:bool,withArg:string,shortName:string,multiOccurrence:bool}>
+        */
        private $mDependantParameters = [];
 
        /**
@@ -831,7 +843,7 @@ abstract class Maintenance {
                                        + $wgProfiler
                                        + [ 'threshold' => $wgProfileLimit ]
                        );
-                       $profiler->setTemplated( true );
+                       $profiler->setAllowOutput();
                        Profiler::replaceStubInstance( $profiler );
                }
 
@@ -1235,6 +1247,7 @@ abstract class Maintenance {
         */
        protected function afterFinalSetup() {
                if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
+                       // @phan-suppress-next-line PhanUndeclaredConstant
                        call_user_func( MW_CMDLINE_CALLBACK );
                }
        }
@@ -1324,6 +1337,7 @@ abstract class Maintenance {
                        $res = $dbw->select( 'content', 'content_address', [], __METHOD__, [ 'DISTINCT' ] );
                        $blobStore = MediaWikiServices::getInstance()->getBlobStore();
                        foreach ( $res as $row ) {
+                               // @phan-suppress-next-line PhanUndeclaredMethod
                                $textId = $blobStore->getTextIdFromAddress( $row->content_address );
                                if ( $textId ) {
                                        $cur[] = $textId;
@@ -1366,28 +1380,34 @@ abstract class Maintenance {
        }
 
        /**
-        * Returns a database to be used by current maintenance script. It can be set by setDB().
-        * If not set, wfGetDB() will be used.
-        * This function has the same parameters as wfGetDB()
+        * Returns a database to be used by current maintenance script.
+        *
+        * This uses the main LBFactory instance by default unless overriden via setDB().
+        *
+        * This function has the same parameters as LoadBalancer::getConnection().
         *
         * @param int $db DB index (DB_REPLICA/DB_MASTER)
         * @param string|string[] $groups default: empty array
-        * @param string|bool $wiki default: current wiki
+        * @param string|bool $dbDomain default: current wiki
         * @return IMaintainableDatabase
         */
-       protected function getDB( $db, $groups = [], $wiki = false ) {
+       protected function getDB( $db, $groups = [], $dbDomain = false ) {
                if ( $this->mDb === null ) {
-                       return wfGetDB( $db, $groups, $wiki );
+                       return MediaWikiServices::getInstance()
+                               ->getDBLoadBalancerFactory()
+                               ->getMainLB( $dbDomain )
+                               ->getMaintenanceConnectionRef( $db, $groups, $dbDomain );
                }
+
                return $this->mDb;
        }
 
        /**
         * Sets database object to be returned by getDB().
         *
-        * @param IDatabase $db
+        * @param IMaintainableDatabase $db
         */
-       public function setDB( IDatabase $db ) {
+       public function setDB( IMaintainableDatabase $db ) {
                $this->mDb = $db;
        }