includes/libs/rdbms/lbfactory/LBFactory.php

   1 <?php
   2 /**
   3  * Generator and manager of database load balancing objects
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Database
  22  */
  23
  24 namespace Wikimedia\Rdbms;
  25
  26 use Psr\Log\LoggerInterface;
  27 use Wikimedia\ScopedCallback;
  28 use BagOStuff;
  29 use EmptyBagOStuff;
  30 use WANObjectCache;
  31 use Exception;
  32 use RuntimeException;
  33 use LogicException;
  34
  35 /**
  36  * An interface for generating database load balancers
  37  * @ingroup Database
  38  */
  39 abstract class LBFactory implements ILBFactory {
  40         /** @var ChronologyProtector */
  41         private $chronProt;
  42         /** @var object|string Class name or object With profileIn/profileOut methods */
  43         private $profiler;
  44         /** @var TransactionProfiler */
  45         private $trxProfiler;
  46         /** @var LoggerInterface */
  47         private $replLogger;
  48         /** @var LoggerInterface */
  49         private $connLogger;
  50         /** @var LoggerInterface */
  51         private $queryLogger;
  52         /** @var LoggerInterface */
  53         private $perfLogger;
  54         /** @var callable Error logger */
  55         private $errorLogger;
  56         /** @var callable Deprecation logger */
  57         private $deprecationLogger;
  58
  59         /** @var BagOStuff */
  60         protected $srvCache;
  61         /** @var BagOStuff */
  62         protected $memStash;
  63         /** @var WANObjectCache */
  64         protected $wanCache;
  65
  66         /** @var DatabaseDomain Local domain */
  67         protected $localDomain;
  68
  69         /** @var string Local hostname of the app server */
  70         private $hostname;
  71         /** @var array Web request information about the client */
  72         private $requestInfo;
  73         /** @var bool Whether this PHP instance is for a CLI script */
  74         private $cliMode;
  75         /** @var string Agent name for query profiling */
  76         private $agent;
  77
  78         /** @var array[] $aliases Map of (table => (dbname, schema, prefix) map) */
  79         private $tableAliases = [];
  80         /** @var string[] Map of (index alias => index) */
  81         private $indexAliases = [];
  82         /** @var callable[] */
  83         private $replicationWaitCallbacks = [];
  84
  85         /** @var mixed */
  86         private $ticket;
  87         /** @var string|bool String if a requested DBO_TRX transaction round is active */
  88         private $trxRoundId = false;
  89         /** @var string One of the ROUND_* class constants */
  90         private $trxRoundStage = self::ROUND_CURSORY;
  91
  92         /** @var string|bool Reason all LBs are read-only or false if not */
  93         protected $readOnlyReason = false;
  94
  95         /** @var string|null */
  96         private $defaultGroup = null;
  97
  98         const ROUND_CURSORY = 'cursory';
  99         const ROUND_BEGINNING = 'within-begin';
 100         const ROUND_COMMITTING = 'within-commit';
 101         const ROUND_ROLLING_BACK = 'within-rollback';
 102         const ROUND_COMMIT_CALLBACKS = 'within-commit-callbacks';
 103         const ROUND_ROLLBACK_CALLBACKS = 'within-rollback-callbacks';
 104
 105         private static $loggerFields =
 106                 [ 'replLogger', 'connLogger', 'queryLogger', 'perfLogger' ];
 107
 108         public function __construct( array $conf ) {
 109                 $this->localDomain = isset( $conf['localDomain'] )
 110                         ? DatabaseDomain::newFromId( $conf['localDomain'] )
 111                         : DatabaseDomain::newUnspecified();
 112
 113                 if ( isset( $conf['readOnlyReason'] ) && is_string( $conf['readOnlyReason'] ) ) {
 114                         $this->readOnlyReason = $conf['readOnlyReason'];
 115                 }
 116
 117                 $this->srvCache = $conf['srvCache'] ?? new EmptyBagOStuff();
 118                 $this->memStash = $conf['memStash'] ?? new EmptyBagOStuff();
 119                 $this->wanCache = $conf['wanCache'] ?? WANObjectCache::newEmpty();
 120
 121                 foreach ( self::$loggerFields as $key ) {
 122                         $this->$key = $conf[$key] ?? new \Psr\Log\NullLogger();
 123                 }
 124                 $this->errorLogger = $conf['errorLogger'] ?? function ( Exception $e ) {
 125                         trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING );
 126                 };
 127                 $this->deprecationLogger = $conf['deprecationLogger'] ?? function ( $msg ) {
 128                         trigger_error( $msg, E_USER_DEPRECATED );
 129                 };
 130
 131                 $this->profiler = $conf['profiler'] ?? null;
 132                 $this->trxProfiler = $conf['trxProfiler'] ?? new TransactionProfiler();
 133
 134                 $this->requestInfo = [
 135                         'IPAddress' => $_SERVER[ 'REMOTE_ADDR' ] ?? '',
 136                         'UserAgent' => $_SERVER['HTTP_USER_AGENT'] ?? '',
 137                         // Headers application can inject via LBFactory::setRequestInfo()
 138                         'ChronologyProtection' => null,
 139                         'ChronologyClientId' => null, // prior $cpClientId value from LBFactory::shutdown()
 140                         'ChronologyPositionIndex' => null // prior $cpIndex value from LBFactory::shutdown()
 141                 ];
 142
 143                 $this->cliMode = $conf['cliMode'] ?? ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' );
 144                 $this->hostname = $conf['hostname'] ?? gethostname();
 145                 $this->agent = $conf['agent'] ?? '';
 146                 $this->defaultGroup = $conf['defaultGroup'] ?? null;
 147
 148                 $this->ticket = mt_rand();
 149         }
 150
 151         public function destroy() {
 152                 $this->shutdown( self::SHUTDOWN_NO_CHRONPROT );
 153                 $this->forEachLBCallMethod( 'disable' );
 154         }
 155
 156         public function getLocalDomainID() {
 157                 return $this->localDomain->getId();
 158         }
 159
 160         public function resolveDomainID( $domain ) {
 161                 return ( $domain !== false ) ? (string)$domain : $this->getLocalDomainID();
 162         }
 163
 164         public function shutdown(
 165                 $mode = self::SHUTDOWN_CHRONPROT_SYNC,
 166                 callable $workCallback = null,
 167                 &$cpIndex = null,
 168                 &$cpClientId = null
 169         ) {
 170                 $chronProt = $this->getChronologyProtector();
 171                 if ( $mode === self::SHUTDOWN_CHRONPROT_SYNC ) {
 172                         $this->shutdownChronologyProtector( $chronProt, $workCallback, 'sync', $cpIndex );
 173                 } elseif ( $mode === self::SHUTDOWN_CHRONPROT_ASYNC ) {
 174                         $this->shutdownChronologyProtector( $chronProt, null, 'async', $cpIndex );
 175                 }
 176
 177                 $cpClientId = $chronProt->getClientId();
 178
 179                 $this->commitMasterChanges( __METHOD__ ); // sanity
 180         }
 181
 182         /**
 183          * @see ILBFactory::newMainLB()
 184          * @param bool $domain
 185          * @return ILoadBalancer
 186          */
 187         abstract public function newMainLB( $domain = false );
 188
 189         /**
 190          * @see ILBFactory::getMainLB()
 191          * @param bool $domain
 192          * @return ILoadBalancer
 193          */
 194         abstract public function getMainLB( $domain = false );
 195
 196         /**
 197          * @see ILBFactory::newExternalLB()
 198          * @param string $cluster
 199          * @return ILoadBalancer
 200          */
 201         abstract public function newExternalLB( $cluster );
 202
 203         /**
 204          * @see ILBFactory::getExternalLB()
 205          * @param string $cluster
 206          * @return ILoadBalancer
 207          */
 208         abstract public function getExternalLB( $cluster );
 209
 210         /**
 211          * Call a method of each tracked load balancer
 212          *
 213          * @param string $methodName
 214          * @param array $args
 215          */
 216         protected function forEachLBCallMethod( $methodName, array $args = [] ) {
 217                 $this->forEachLB(
 218                         function ( ILoadBalancer $loadBalancer, $methodName, array $args ) {
 219                                 $loadBalancer->$methodName( ...$args );
 220                         },
 221                         [ $methodName, $args ]
 222                 );
 223         }
 224
 225         public function flushReplicaSnapshots( $fname = __METHOD__ ) {
 226                 $this->forEachLBCallMethod( 'flushReplicaSnapshots', [ $fname ] );
 227         }
 228
 229         final public function commitAll( $fname = __METHOD__, array $options = [] ) {
 230                 $this->commitMasterChanges( $fname, $options );
 231                 $this->forEachLBCallMethod( 'flushMasterSnapshots', [ $fname ] );
 232                 $this->forEachLBCallMethod( 'flushReplicaSnapshots', [ $fname ] );
 233         }
 234
 235         final public function beginMasterChanges( $fname = __METHOD__ ) {
 236                 $this->assertTransactionRoundStage( self::ROUND_CURSORY );
 237                 $this->trxRoundStage = self::ROUND_BEGINNING;
 238                 if ( $this->trxRoundId !== false ) {
 239                         throw new DBTransactionError(
 240                                 null,
 241                                 "$fname: transaction round '{$this->trxRoundId}' already started."
 242                         );
 243                 }
 244                 $this->trxRoundId = $fname;
 245                 // Set DBO_TRX flags on all appropriate DBs
 246                 $this->forEachLBCallMethod( 'beginMasterChanges', [ $fname ] );
 247                 $this->trxRoundStage = self::ROUND_CURSORY;
 248         }
 249
 250         final public function commitMasterChanges( $fname = __METHOD__, array $options = [] ) {
 251                 $this->assertTransactionRoundStage( self::ROUND_CURSORY );
 252                 $this->trxRoundStage = self::ROUND_COMMITTING;
 253                 if ( $this->trxRoundId !== false && $this->trxRoundId !== $fname ) {
 254                         throw new DBTransactionError(
 255                                 null,
 256                                 "$fname: transaction round '{$this->trxRoundId}' still running."
 257                         );
 258                 }
 259                 /** @noinspection PhpUnusedLocalVariableInspection */
 260                 $scope = $this->getScopedPHPBehaviorForCommit(); // try to ignore client aborts
 261                 // Run pre-commit callbacks and suppress post-commit callbacks, aborting on failure
 262                 do {
 263                         $count = 0; // number of callbacks executed this iteration
 264                         $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$count ) {
 265                                 $count += $lb->finalizeMasterChanges();
 266                         } );
 267                 } while ( $count > 0 );
 268                 $this->trxRoundId = false;
 269                 // Perform pre-commit checks, aborting on failure
 270                 $this->forEachLBCallMethod( 'approveMasterChanges', [ $options ] );
 271                 // Log the DBs and methods involved in multi-DB transactions
 272                 $this->logIfMultiDbTransaction();
 273                 // Actually perform the commit on all master DB connections and revert DBO_TRX
 274                 $this->forEachLBCallMethod( 'commitMasterChanges', [ $fname ] );
 275                 // Run all post-commit callbacks in a separate step
 276                 $this->trxRoundStage = self::ROUND_COMMIT_CALLBACKS;
 277                 $e = $this->executePostTransactionCallbacks();
 278                 $this->trxRoundStage = self::ROUND_CURSORY;
 279                 // Throw any last post-commit callback error
 280                 if ( $e instanceof Exception ) {
 281                         throw $e;
 282                 }
 283         }
 284
 285         final public function rollbackMasterChanges( $fname = __METHOD__ ) {
 286                 $this->trxRoundStage = self::ROUND_ROLLING_BACK;
 287                 $this->trxRoundId = false;
 288                 // Actually perform the rollback on all master DB connections and revert DBO_TRX
 289                 $this->forEachLBCallMethod( 'rollbackMasterChanges', [ $fname ] );
 290                 // Run all post-commit callbacks in a separate step
 291                 $this->trxRoundStage = self::ROUND_ROLLBACK_CALLBACKS;
 292                 $this->executePostTransactionCallbacks();
 293                 $this->trxRoundStage = self::ROUND_CURSORY;
 294         }
 295
 296         /**
 297          * @return Exception|null
 298          */
 299         private function executePostTransactionCallbacks() {
 300                 // Run all post-commit callbacks until new ones stop getting added
 301                 $e = null; // first callback exception
 302                 do {
 303                         $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$e ) {
 304                                 $ex = $lb->runMasterTransactionIdleCallbacks();
 305                                 $e = $e ?: $ex;
 306                         } );
 307                 } while ( $this->hasMasterChanges() );
 308                 // Run all listener callbacks once
 309                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$e ) {
 310                         $ex = $lb->runMasterTransactionListenerCallbacks();
 311                         $e = $e ?: $ex;
 312                 } );
 313
 314                 return $e;
 315         }
 316
 317         public function hasTransactionRound() {
 318                 return ( $this->trxRoundId !== false );
 319         }
 320
 321         public function isReadyForRoundOperations() {
 322                 return ( $this->trxRoundStage === self::ROUND_CURSORY );
 323         }
 324
 325         /**
 326          * Log query info if multi DB transactions are going to be committed now
 327          */
 328         private function logIfMultiDbTransaction() {
 329                 $callersByDB = [];
 330                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$callersByDB ) {
 331                         $masterName = $lb->getServerName( $lb->getWriterIndex() );
 332                         $callers = $lb->pendingMasterChangeCallers();
 333                         if ( $callers ) {
 334                                 $callersByDB[$masterName] = $callers;
 335                         }
 336                 } );
 337
 338                 if ( count( $callersByDB ) >= 2 ) {
 339                         $dbs = implode( ', ', array_keys( $callersByDB ) );
 340                         $msg = "Multi-DB transaction [{$dbs}]:\n";
 341                         foreach ( $callersByDB as $db => $callers ) {
 342                                 $msg .= "$db: " . implode( '; ', $callers ) . "\n";
 343                         }
 344                         $this->queryLogger->info( $msg );
 345                 }
 346         }
 347
 348         public function hasMasterChanges() {
 349                 $ret = false;
 350                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$ret ) {
 351                         $ret = $ret || $lb->hasMasterChanges();
 352                 } );
 353
 354                 return $ret;
 355         }
 356
 357         public function laggedReplicaUsed() {
 358                 $ret = false;
 359                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$ret ) {
 360                         $ret = $ret || $lb->laggedReplicaUsed();
 361                 } );
 362
 363                 return $ret;
 364         }
 365
 366         public function hasOrMadeRecentMasterChanges( $age = null ) {
 367                 $ret = false;
 368                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( $age, &$ret ) {
 369                         $ret = $ret || $lb->hasOrMadeRecentMasterChanges( $age );
 370                 } );
 371                 return $ret;
 372         }
 373
 374         public function waitForReplication( array $opts = [] ) {
 375                 $opts += [
 376                         'domain' => false,
 377                         'cluster' => false,
 378                         'timeout' => $this->cliMode ? 60 : 1,
 379                         'ifWritesSince' => null
 380                 ];
 381
 382                 if ( $opts['domain'] === false && isset( $opts['wiki'] ) ) {
 383                         $opts['domain'] = $opts['wiki']; // b/c
 384                 }
 385
 386                 // Figure out which clusters need to be checked
 387                 /** @var ILoadBalancer[] $lbs */
 388                 $lbs = [];
 389                 if ( $opts['cluster'] !== false ) {
 390                         $lbs[] = $this->getExternalLB( $opts['cluster'] );
 391                 } elseif ( $opts['domain'] !== false ) {
 392                         $lbs[] = $this->getMainLB( $opts['domain'] );
 393                 } else {
 394                         $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$lbs ) {
 395                                 $lbs[] = $lb;
 396                         } );
 397                         if ( !$lbs ) {
 398                                 return; // nothing actually used
 399                         }
 400                 }
 401
 402                 // Get all the master positions of applicable DBs right now.
 403                 // This can be faster since waiting on one cluster reduces the
 404                 // time needed to wait on the next clusters.
 405                 $masterPositions = array_fill( 0, count( $lbs ), false );
 406                 foreach ( $lbs as $i => $lb ) {
 407                         if ( $lb->getServerCount() <= 1 ) {
 408                                 // T29975 - Don't try to wait for replica DBs if there are none
 409                                 // Prevents permission error when getting master position
 410                                 continue;
 411                         } elseif ( $opts['ifWritesSince']
 412                                 && $lb->lastMasterChangeTimestamp() < $opts['ifWritesSince']
 413                         ) {
 414                                 continue; // no writes since the last wait
 415                         }
 416                         $masterPositions[$i] = $lb->getMasterPos();
 417                 }
 418
 419                 // Run any listener callbacks *after* getting the DB positions. The more
 420                 // time spent in the callbacks, the less time is spent in waitForAll().
 421                 foreach ( $this->replicationWaitCallbacks as $callback ) {
 422                         $callback();
 423                 }
 424
 425                 $failed = [];
 426                 foreach ( $lbs as $i => $lb ) {
 427                         if ( $masterPositions[$i] ) {
 428                                 // The RDBMS may not support getMasterPos()
 429                                 if ( !$lb->waitForAll( $masterPositions[$i], $opts['timeout'] ) ) {
 430                                         $failed[] = $lb->getServerName( $lb->getWriterIndex() );
 431                                 }
 432                         }
 433                 }
 434
 435                 return !$failed;
 436         }
 437
 438         public function setWaitForReplicationListener( $name, callable $callback = null ) {
 439                 if ( $callback ) {
 440                         $this->replicationWaitCallbacks[$name] = $callback;
 441                 } else {
 442                         unset( $this->replicationWaitCallbacks[$name] );
 443                 }
 444         }
 445
 446         public function getEmptyTransactionTicket( $fname ) {
 447                 if ( $this->hasMasterChanges() ) {
 448                         $this->queryLogger->error( __METHOD__ . ": $fname does not have outer scope.\n" .
 449                                 ( new RuntimeException() )->getTraceAsString() );
 450
 451                         return null;
 452                 }
 453
 454                 return $this->ticket;
 455         }
 456
 457         final public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] ) {
 458                 if ( $ticket !== $this->ticket ) {
 459                         $this->perfLogger->error( __METHOD__ . ": $fname does not have outer scope.\n" .
 460                                 ( new RuntimeException() )->getTraceAsString() );
 461
 462                         return;
 463                 }
 464
 465                 // The transaction owner and any caller with the empty transaction ticket can commit
 466                 // so that getEmptyTransactionTicket() callers don't risk seeing DBTransactionError.
 467                 if ( $this->trxRoundId !== false && $fname !== $this->trxRoundId ) {
 468                         $this->queryLogger->info( "$fname: committing on behalf of {$this->trxRoundId}." );
 469                         $fnameEffective = $this->trxRoundId;
 470                 } else {
 471                         $fnameEffective = $fname;
 472                 }
 473
 474                 $this->commitMasterChanges( $fnameEffective );
 475                 $waitSucceeded = $this->waitForReplication( $opts );
 476                 // If a nested caller committed on behalf of $fname, start another empty $fname
 477                 // transaction, leaving the caller with the same empty transaction state as before.
 478                 if ( $fnameEffective !== $fname ) {
 479                         $this->beginMasterChanges( $fnameEffective );
 480                 }
 481                 return $waitSucceeded;
 482         }
 483
 484         public function getChronologyProtectorTouched( $dbName ) {
 485                 return $this->getChronologyProtector()->getTouched( $dbName );
 486         }
 487
 488         public function disableChronologyProtection() {
 489                 $this->getChronologyProtector()->setEnabled( false );
 490         }
 491
 492         /**
 493          * @return ChronologyProtector
 494          */
 495         protected function getChronologyProtector() {
 496                 if ( $this->chronProt ) {
 497                         return $this->chronProt;
 498                 }
 499
 500                 $this->chronProt = new ChronologyProtector(
 501                         $this->memStash,
 502                         [
 503                                 'ip' => $this->requestInfo['IPAddress'],
 504                                 'agent' => $this->requestInfo['UserAgent'],
 505                                 'clientId' => $this->requestInfo['ChronologyClientId']
 506                         ],
 507                         $this->requestInfo['ChronologyPositionIndex']
 508                 );
 509                 $this->chronProt->setLogger( $this->replLogger );
 510
 511                 if ( $this->cliMode ) {
 512                         $this->chronProt->setEnabled( false );
 513                 } elseif ( $this->requestInfo['ChronologyProtection'] === 'false' ) {
 514                         // Request opted out of using position wait logic. This is useful for requests
 515                         // done by the job queue or background ETL that do not have a meaningful session.
 516                         $this->chronProt->setWaitEnabled( false );
 517                 } elseif ( $this->memStash instanceof EmptyBagOStuff ) {
 518                         // No where to store any DB positions and wait for them to appear
 519                         $this->chronProt->setEnabled( false );
 520                         $this->replLogger->info( 'Cannot use ChronologyProtector with EmptyBagOStuff.' );
 521                 }
 522
 523                 $this->replLogger->debug( __METHOD__ . ': using request info ' .
 524                         json_encode( $this->requestInfo, JSON_PRETTY_PRINT ) );
 525
 526                 return $this->chronProt;
 527         }
 528
 529         /**
 530          * Get and record all of the staged DB positions into persistent memory storage
 531          *
 532          * @param ChronologyProtector $cp
 533          * @param callable|null $workCallback Work to do instead of waiting on syncing positions
 534          * @param string $mode One of (sync, async); whether to wait on remote datacenters
 535          * @param int|null &$cpIndex DB position key write counter; incremented on update
 536          */
 537         protected function shutdownChronologyProtector(
 538                 ChronologyProtector $cp, $workCallback, $mode, &$cpIndex = null
 539         ) {
 540                 // Record all the master positions needed
 541                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( $cp ) {
 542                         $cp->shutdownLB( $lb );
 543                 } );
 544                 // Write them to the persistent stash. Try to do something useful by running $work
 545                 // while ChronologyProtector waits for the stash write to replicate to all DCs.
 546                 $unsavedPositions = $cp->shutdown( $workCallback, $mode, $cpIndex );
 547                 if ( $unsavedPositions && $workCallback ) {
 548                         // Invoke callback in case it did not cache the result yet
 549                         $workCallback(); // work now to block for less time in waitForAll()
 550                 }
 551                 // If the positions failed to write to the stash, at least wait on local datacenter
 552                 // replica DBs to catch up before responding. Even if there are several DCs, this increases
 553                 // the chance that the user will see their own changes immediately afterwards. As long
 554                 // as the sticky DC cookie applies (same domain), this is not even an issue.
 555                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( $unsavedPositions ) {
 556                         $masterName = $lb->getServerName( $lb->getWriterIndex() );
 557                         if ( isset( $unsavedPositions[$masterName] ) ) {
 558                                 $lb->waitForAll( $unsavedPositions[$masterName] );
 559                         }
 560                 } );
 561         }
 562
 563         /**
 564          * Base parameters to ILoadBalancer::__construct()
 565          * @return array
 566          */
 567         final protected function baseLoadBalancerParams() {
 568                 if ( $this->trxRoundStage === self::ROUND_COMMIT_CALLBACKS ) {
 569                         $initStage = ILoadBalancer::STAGE_POSTCOMMIT_CALLBACKS;
 570                 } elseif ( $this->trxRoundStage === self::ROUND_ROLLBACK_CALLBACKS ) {
 571                         $initStage = ILoadBalancer::STAGE_POSTROLLBACK_CALLBACKS;
 572                 } else {
 573                         $initStage = null;
 574                 }
 575
 576                 return [
 577                         'localDomain' => $this->localDomain,
 578                         'readOnlyReason' => $this->readOnlyReason,
 579                         'srvCache' => $this->srvCache,
 580                         'wanCache' => $this->wanCache,
 581                         'profiler' => $this->profiler,
 582                         'trxProfiler' => $this->trxProfiler,
 583                         'queryLogger' => $this->queryLogger,
 584                         'connLogger' => $this->connLogger,
 585                         'replLogger' => $this->replLogger,
 586                         'errorLogger' => $this->errorLogger,
 587                         'deprecationLogger' => $this->deprecationLogger,
 588                         'hostname' => $this->hostname,
 589                         'cliMode' => $this->cliMode,
 590                         'agent' => $this->agent,
 591                         'defaultGroup' => $this->defaultGroup,
 592                         'chronologyCallback' => function ( ILoadBalancer $lb ) {
 593                                 // Defer ChronologyProtector construction in case setRequestInfo() ends up
 594                                 // being called later (but before the first connection attempt) (T192611)
 595                                 $this->getChronologyProtector()->initLB( $lb );
 596                         },
 597                         'roundStage' => $initStage
 598                 ];
 599         }
 600
 601         /**
 602          * @param ILoadBalancer $lb
 603          */
 604         protected function initLoadBalancer( ILoadBalancer $lb ) {
 605                 if ( $this->trxRoundId !== false ) {
 606                         $lb->beginMasterChanges( $this->trxRoundId ); // set DBO_TRX
 607                 }
 608
 609                 $lb->setTableAliases( $this->tableAliases );
 610                 $lb->setIndexAliases( $this->indexAliases );
 611         }
 612
 613         public function setTableAliases( array $aliases ) {
 614                 $this->tableAliases = $aliases;
 615         }
 616
 617         public function setIndexAliases( array $aliases ) {
 618                 $this->indexAliases = $aliases;
 619         }
 620
 621         public function setDomainPrefix( $prefix ) {
 622                 $this->localDomain = new DatabaseDomain(
 623                         $this->localDomain->getDatabase(),
 624                         null,
 625                         $prefix
 626                 );
 627
 628                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( $prefix ) {
 629                         $lb->setDomainPrefix( $prefix );
 630                 } );
 631         }
 632
 633         public function closeAll() {
 634                 $this->forEachLBCallMethod( 'closeAll', [] );
 635         }
 636
 637         public function setAgentName( $agent ) {
 638                 $this->agent = $agent;
 639         }
 640
 641         public function appendShutdownCPIndexAsQuery( $url, $index ) {
 642                 $usedCluster = 0;
 643                 $this->forEachLB( function ( ILoadBalancer $lb ) use ( &$usedCluster ) {
 644                         $usedCluster |= ( $lb->getServerCount() > 1 );
 645                 } );
 646
 647                 if ( !$usedCluster ) {
 648                         return $url; // no master/replica clusters touched
 649                 }
 650
 651                 return strpos( $url, '?' ) === false ? "$url?cpPosIndex=$index" : "$url&cpPosIndex=$index";
 652         }
 653
 654         /**
 655          * @param int $index Write index
 656          * @param int $time UNIX timestamp; can be used to detect stale cookies (T190082)
 657          * @param string $clientId Agent ID hash from ILBFactory::shutdown()
 658          * @return string Timestamp-qualified write index of the form "<index>@<timestamp>#<hash>"
 659          * @since 1.32
 660          */
 661         public static function makeCookieValueFromCPIndex( $index, $time, $clientId ) {
 662                 return "$index@$time#$clientId";
 663         }
 664
 665         /**
 666          * @param string $value Possible result of LBFactory::makeCookieValueFromCPIndex()
 667          * @param int $minTimestamp Lowest UNIX timestamp that a non-expired value can have
 668          * @return array (index: int or null, clientId: string or null)
 669          * @since 1.32
 670          */
 671         public static function getCPInfoFromCookieValue( $value, $minTimestamp ) {
 672                 static $placeholder = [ 'index' => null, 'clientId' => null ];
 673
 674                 if ( !preg_match( '/^(\d+)@(\d+)#([0-9a-f]{32})$/', $value, $m ) ) {
 675                         return $placeholder; // invalid
 676                 }
 677
 678                 $index = (int)$m[1];
 679                 if ( $index <= 0 ) {
 680                         return $placeholder; // invalid
 681                 } elseif ( isset( $m[2] ) && $m[2] !== '' && (int)$m[2] < $minTimestamp ) {
 682                         return $placeholder; // expired
 683                 }
 684
 685                 $clientId = ( isset( $m[3] ) && $m[3] !== '' ) ? $m[3] : null;
 686
 687                 return [ 'index' => $index, 'clientId' => $clientId ];
 688         }
 689
 690         public function setRequestInfo( array $info ) {
 691                 if ( $this->chronProt ) {
 692                         throw new LogicException( 'ChronologyProtector already initialized.' );
 693                 }
 694
 695                 $this->requestInfo = $info + $this->requestInfo;
 696         }
 697
 698         /**
 699          * @param string $stage
 700          */
 701         private function assertTransactionRoundStage( $stage ) {
 702                 if ( $this->trxRoundStage !== $stage ) {
 703                         throw new DBTransactionError(
 704                                 null,
 705                                 "Transaction round stage must be '$stage' (not '{$this->trxRoundStage}')"
 706                         );
 707                 }
 708         }
 709
 710         /**
 711          * Make PHP ignore user aborts/disconnects until the returned
 712          * value leaves scope. This returns null and does nothing in CLI mode.
 713          *
 714          * @return ScopedCallback|null
 715          */
 716         final protected function getScopedPHPBehaviorForCommit() {
 717                 if ( PHP_SAPI != 'cli' ) { // https://bugs.php.net/bug.php?id=47540
 718                         $old = ignore_user_abort( true ); // avoid half-finished operations
 719                         return new ScopedCallback( function () use ( $old ) {
 720                                 ignore_user_abort( $old );
 721                         } );
 722                 }
 723
 724                 return null;
 725         }
 726
 727         function __destruct() {
 728                 $this->destroy();
 729         }
 730 }