includes/libs/rdbms/database/DBConnRef.php

   1 <?php
   2
   3 namespace Wikimedia\Rdbms;
   4
   5 use InvalidArgumentException;
   6
   7 /**
   8  * Helper class to handle automatically marking connections as reusable (via RAII pattern)
   9  * as well handling deferring the actual network connection until the handle is used
  10  *
  11  * @note: proxy methods are defined explicitly to avoid interface errors
  12  * @ingroup Database
  13  * @since 1.22
  14  */
  15 class DBConnRef implements IDatabase {
  16         /** @var ILoadBalancer */
  17         private $lb;
  18         /** @var Database|null Live connection handle */
  19         private $conn;
  20         /** @var array|null N-tuple of (server index, group, DatabaseDomain|string) */
  21         private $params;
  22
  23         const FLD_INDEX = 0;
  24         const FLD_GROUP = 1;
  25         const FLD_DOMAIN = 2;
  26         const FLD_FLAGS = 3;
  27
  28         /**
  29          * @param ILoadBalancer $lb Connection manager for $conn
  30          * @param Database|array $conn Database handle or (server index, query groups, domain, flags)
  31          */
  32         public function __construct( ILoadBalancer $lb, $conn ) {
  33                 $this->lb = $lb;
  34                 if ( $conn instanceof Database ) {
  35                         $this->conn = $conn; // live handle
  36                 } elseif ( is_array( $conn ) && count( $conn ) >= 4 && $conn[self::FLD_DOMAIN] !== false ) {
  37                         $this->params = $conn;
  38                 } else {
  39                         throw new InvalidArgumentException( "Missing lazy connection arguments." );
  40                 }
  41         }
  42
  43         function __call( $name, array $arguments ) {
  44                 if ( $this->conn === null ) {
  45                         list( $db, $groups, $wiki, $flags ) = $this->params;
  46                         $this->conn = $this->lb->getConnection( $db, $groups, $wiki, $flags );
  47                 }
  48
  49                 return $this->conn->$name( ...$arguments );
  50         }
  51
  52         public function getServerInfo() {
  53                 return $this->__call( __FUNCTION__, func_get_args() );
  54         }
  55
  56         public function bufferResults( $buffer = null ) {
  57                 return $this->__call( __FUNCTION__, func_get_args() );
  58         }
  59
  60         public function trxLevel() {
  61                 return $this->__call( __FUNCTION__, func_get_args() );
  62         }
  63
  64         public function trxTimestamp() {
  65                 return $this->__call( __FUNCTION__, func_get_args() );
  66         }
  67
  68         public function explicitTrxActive() {
  69                 return $this->__call( __FUNCTION__, func_get_args() );
  70         }
  71
  72         public function assertNoOpenTransactions() {
  73                 return $this->__call( __FUNCTION__, func_get_args() );
  74         }
  75
  76         public function tablePrefix( $prefix = null ) {
  77                 return $this->__call( __FUNCTION__, func_get_args() );
  78         }
  79
  80         public function dbSchema( $schema = null ) {
  81                 return $this->__call( __FUNCTION__, func_get_args() );
  82         }
  83
  84         public function getLBInfo( $name = null ) {
  85                 return $this->__call( __FUNCTION__, func_get_args() );
  86         }
  87
  88         public function setLBInfo( $name, $value = null ) {
  89                 return $this->__call( __FUNCTION__, func_get_args() );
  90         }
  91
  92         public function setLazyMasterHandle( IDatabase $conn ) {
  93                 return $this->__call( __FUNCTION__, func_get_args() );
  94         }
  95
  96         public function implicitGroupby() {
  97                 return $this->__call( __FUNCTION__, func_get_args() );
  98         }
  99
 100         public function implicitOrderby() {
 101                 return $this->__call( __FUNCTION__, func_get_args() );
 102         }
 103
 104         public function lastQuery() {
 105                 return $this->__call( __FUNCTION__, func_get_args() );
 106         }
 107
 108         public function doneWrites() {
 109                 return $this->__call( __FUNCTION__, func_get_args() );
 110         }
 111
 112         public function lastDoneWrites() {
 113                 return $this->__call( __FUNCTION__, func_get_args() );
 114         }
 115
 116         public function writesPending() {
 117                 return $this->__call( __FUNCTION__, func_get_args() );
 118         }
 119
 120         public function preCommitCallbacksPending() {
 121                 return $this->__call( __FUNCTION__, func_get_args() );
 122         }
 123
 124         public function writesOrCallbacksPending() {
 125                 return $this->__call( __FUNCTION__, func_get_args() );
 126         }
 127
 128         public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
 129                 return $this->__call( __FUNCTION__, func_get_args() );
 130         }
 131
 132         public function pendingWriteCallers() {
 133                 return $this->__call( __FUNCTION__, func_get_args() );
 134         }
 135
 136         public function pendingWriteRowsAffected() {
 137                 return $this->__call( __FUNCTION__, func_get_args() );
 138         }
 139
 140         public function isOpen() {
 141                 return $this->__call( __FUNCTION__, func_get_args() );
 142         }
 143
 144         public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 145                 return $this->__call( __FUNCTION__, func_get_args() );
 146         }
 147
 148         public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 149                 return $this->__call( __FUNCTION__, func_get_args() );
 150         }
 151
 152         public function restoreFlags( $state = self::RESTORE_PRIOR ) {
 153                 return $this->__call( __FUNCTION__, func_get_args() );
 154         }
 155
 156         public function getFlag( $flag ) {
 157                 return $this->__call( __FUNCTION__, func_get_args() );
 158         }
 159
 160         public function getProperty( $name ) {
 161                 return $this->__call( __FUNCTION__, func_get_args() );
 162         }
 163
 164         public function getDomainID() {
 165                 if ( $this->conn === null ) {
 166                         $domain = $this->params[self::FLD_DOMAIN];
 167                         // Avoid triggering a database connection
 168                         return $domain instanceof DatabaseDomain ? $domain->getId() : $domain;
 169                 }
 170
 171                 return $this->__call( __FUNCTION__, func_get_args() );
 172         }
 173
 174         /**
 175          * @codeCoverageIgnore
 176          */
 177         public function getWikiID() {
 178                 return $this->getDomainID();
 179         }
 180
 181         public function getType() {
 182                 return $this->__call( __FUNCTION__, func_get_args() );
 183         }
 184
 185         public function fetchObject( $res ) {
 186                 return $this->__call( __FUNCTION__, func_get_args() );
 187         }
 188
 189         public function fetchRow( $res ) {
 190                 return $this->__call( __FUNCTION__, func_get_args() );
 191         }
 192
 193         public function numRows( $res ) {
 194                 return $this->__call( __FUNCTION__, func_get_args() );
 195         }
 196
 197         public function numFields( $res ) {
 198                 return $this->__call( __FUNCTION__, func_get_args() );
 199         }
 200
 201         public function fieldName( $res, $n ) {
 202                 return $this->__call( __FUNCTION__, func_get_args() );
 203         }
 204
 205         public function insertId() {
 206                 return $this->__call( __FUNCTION__, func_get_args() );
 207         }
 208
 209         public function dataSeek( $res, $row ) {
 210                 return $this->__call( __FUNCTION__, func_get_args() );
 211         }
 212
 213         public function lastErrno() {
 214                 return $this->__call( __FUNCTION__, func_get_args() );
 215         }
 216
 217         public function lastError() {
 218                 return $this->__call( __FUNCTION__, func_get_args() );
 219         }
 220
 221         public function affectedRows() {
 222                 return $this->__call( __FUNCTION__, func_get_args() );
 223         }
 224
 225         public function getSoftwareLink() {
 226                 return $this->__call( __FUNCTION__, func_get_args() );
 227         }
 228
 229         public function getServerVersion() {
 230                 return $this->__call( __FUNCTION__, func_get_args() );
 231         }
 232
 233         public function close() {
 234                 return $this->__call( __FUNCTION__, func_get_args() );
 235         }
 236
 237         public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) {
 238                 return $this->__call( __FUNCTION__, func_get_args() );
 239         }
 240
 241         public function freeResult( $res ) {
 242                 return $this->__call( __FUNCTION__, func_get_args() );
 243         }
 244
 245         public function selectField(
 246                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
 247         ) {
 248                 return $this->__call( __FUNCTION__, func_get_args() );
 249         }
 250
 251         public function selectFieldValues(
 252                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
 253         ) {
 254                 return $this->__call( __FUNCTION__, func_get_args() );
 255         }
 256
 257         public function select(
 258                 $table, $vars, $conds = '', $fname = __METHOD__,
 259                 $options = [], $join_conds = []
 260         ) {
 261                 return $this->__call( __FUNCTION__, func_get_args() );
 262         }
 263
 264         public function selectSQLText(
 265                 $table, $vars, $conds = '', $fname = __METHOD__,
 266                 $options = [], $join_conds = []
 267         ) {
 268                 return $this->__call( __FUNCTION__, func_get_args() );
 269         }
 270
 271         public function selectRow(
 272                 $table, $vars, $conds, $fname = __METHOD__,
 273                 $options = [], $join_conds = []
 274         ) {
 275                 return $this->__call( __FUNCTION__, func_get_args() );
 276         }
 277
 278         public function estimateRowCount(
 279                 $table, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
 280         ) {
 281                 return $this->__call( __FUNCTION__, func_get_args() );
 282         }
 283
 284         public function selectRowCount(
 285                 $tables, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
 286         ) {
 287                 return $this->__call( __FUNCTION__, func_get_args() );
 288         }
 289
 290         public function lockForUpdate(
 291                 $table, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
 292         ) {
 293                 return $this->__call( __FUNCTION__, func_get_args() );
 294         }
 295
 296         public function fieldExists( $table, $field, $fname = __METHOD__ ) {
 297                 return $this->__call( __FUNCTION__, func_get_args() );
 298         }
 299
 300         public function indexExists( $table, $index, $fname = __METHOD__ ) {
 301                 return $this->__call( __FUNCTION__, func_get_args() );
 302         }
 303
 304         public function tableExists( $table, $fname = __METHOD__ ) {
 305                 return $this->__call( __FUNCTION__, func_get_args() );
 306         }
 307
 308         public function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
 309                 return $this->__call( __FUNCTION__, func_get_args() );
 310         }
 311
 312         public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
 313                 return $this->__call( __FUNCTION__, func_get_args() );
 314         }
 315
 316         public function makeList( $a, $mode = self::LIST_COMMA ) {
 317                 return $this->__call( __FUNCTION__, func_get_args() );
 318         }
 319
 320         public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
 321                 return $this->__call( __FUNCTION__, func_get_args() );
 322         }
 323
 324         public function aggregateValue( $valuedata, $valuename = 'value' ) {
 325                 return $this->__call( __FUNCTION__, func_get_args() );
 326         }
 327
 328         public function bitNot( $field ) {
 329                 return $this->__call( __FUNCTION__, func_get_args() );
 330         }
 331
 332         public function bitAnd( $fieldLeft, $fieldRight ) {
 333                 return $this->__call( __FUNCTION__, func_get_args() );
 334         }
 335
 336         public function bitOr( $fieldLeft, $fieldRight ) {
 337                 return $this->__call( __FUNCTION__, func_get_args() );
 338         }
 339
 340         public function buildConcat( $stringList ) {
 341                 return $this->__call( __FUNCTION__, func_get_args() );
 342         }
 343
 344         public function buildGroupConcatField(
 345                 $delim, $table, $field, $conds = '', $join_conds = []
 346         ) {
 347                 return $this->__call( __FUNCTION__, func_get_args() );
 348         }
 349
 350         public function buildSubstring( $input, $startPosition, $length = null ) {
 351                 return $this->__call( __FUNCTION__, func_get_args() );
 352         }
 353
 354         public function buildStringCast( $field ) {
 355                 return $this->__call( __FUNCTION__, func_get_args() );
 356         }
 357
 358         public function buildIntegerCast( $field ) {
 359                 return $this->__call( __FUNCTION__, func_get_args() );
 360         }
 361
 362         public function buildSelectSubquery(
 363                 $table, $vars, $conds = '', $fname = __METHOD__,
 364                 $options = [], $join_conds = []
 365         ) {
 366                 return $this->__call( __FUNCTION__, func_get_args() );
 367         }
 368
 369         public function databasesAreIndependent() {
 370                 return $this->__call( __FUNCTION__, func_get_args() );
 371         }
 372
 373         public function selectDB( $db ) {
 374                 // Disallow things that might confuse the LoadBalancer tracking
 375                 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
 376         }
 377
 378         public function selectDomain( $domain ) {
 379                 // Disallow things that might confuse the LoadBalancer tracking
 380                 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
 381         }
 382
 383         public function getDBname() {
 384                 return $this->__call( __FUNCTION__, func_get_args() );
 385         }
 386
 387         public function getServer() {
 388                 return $this->__call( __FUNCTION__, func_get_args() );
 389         }
 390
 391         public function addQuotes( $s ) {
 392                 return $this->__call( __FUNCTION__, func_get_args() );
 393         }
 394
 395         public function addIdentifierQuotes( $s ) {
 396                 return $this->__call( __FUNCTION__, func_get_args() );
 397         }
 398
 399         public function buildLike() {
 400                 return $this->__call( __FUNCTION__, func_get_args() );
 401         }
 402
 403         public function anyChar() {
 404                 return $this->__call( __FUNCTION__, func_get_args() );
 405         }
 406
 407         public function anyString() {
 408                 return $this->__call( __FUNCTION__, func_get_args() );
 409         }
 410
 411         public function nextSequenceValue( $seqName ) {
 412                 return $this->__call( __FUNCTION__, func_get_args() );
 413         }
 414
 415         public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
 416                 return $this->__call( __FUNCTION__, func_get_args() );
 417         }
 418
 419         public function upsert(
 420                 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
 421         ) {
 422                 return $this->__call( __FUNCTION__, func_get_args() );
 423         }
 424
 425         public function deleteJoin(
 426                 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
 427         ) {
 428                 return $this->__call( __FUNCTION__, func_get_args() );
 429         }
 430
 431         public function delete( $table, $conds, $fname = __METHOD__ ) {
 432                 return $this->__call( __FUNCTION__, func_get_args() );
 433         }
 434
 435         public function insertSelect(
 436                 $destTable, $srcTable, $varMap, $conds,
 437                 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
 438         ) {
 439                 return $this->__call( __FUNCTION__, func_get_args() );
 440         }
 441
 442         public function unionSupportsOrderAndLimit() {
 443                 return $this->__call( __FUNCTION__, func_get_args() );
 444         }
 445
 446         public function unionQueries( $sqls, $all ) {
 447                 return $this->__call( __FUNCTION__, func_get_args() );
 448         }
 449
 450         public function unionConditionPermutations(
 451                 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
 452                 $options = [], $join_conds = []
 453         ) {
 454                 return $this->__call( __FUNCTION__, func_get_args() );
 455         }
 456
 457         public function conditional( $cond, $trueVal, $falseVal ) {
 458                 return $this->__call( __FUNCTION__, func_get_args() );
 459         }
 460
 461         public function strreplace( $orig, $old, $new ) {
 462                 return $this->__call( __FUNCTION__, func_get_args() );
 463         }
 464
 465         public function getServerUptime() {
 466                 return $this->__call( __FUNCTION__, func_get_args() );
 467         }
 468
 469         public function wasDeadlock() {
 470                 return $this->__call( __FUNCTION__, func_get_args() );
 471         }
 472
 473         public function wasLockTimeout() {
 474                 return $this->__call( __FUNCTION__, func_get_args() );
 475         }
 476
 477         public function wasConnectionLoss() {
 478                 return $this->__call( __FUNCTION__, func_get_args() );
 479         }
 480
 481         public function wasReadOnlyError() {
 482                 return $this->__call( __FUNCTION__, func_get_args() );
 483         }
 484
 485         public function wasErrorReissuable() {
 486                 return $this->__call( __FUNCTION__, func_get_args() );
 487         }
 488
 489         public function masterPosWait( DBMasterPos $pos, $timeout ) {
 490                 return $this->__call( __FUNCTION__, func_get_args() );
 491         }
 492
 493         public function getReplicaPos() {
 494                 return $this->__call( __FUNCTION__, func_get_args() );
 495         }
 496
 497         public function getMasterPos() {
 498                 return $this->__call( __FUNCTION__, func_get_args() );
 499         }
 500
 501         public function serverIsReadOnly() {
 502                 return $this->__call( __FUNCTION__, func_get_args() );
 503         }
 504
 505         public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
 506                 return $this->__call( __FUNCTION__, func_get_args() );
 507         }
 508
 509         public function onTransactionCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
 510                 return $this->__call( __FUNCTION__, func_get_args() );
 511         }
 512
 513         public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
 514                 return $this->__call( __FUNCTION__, func_get_args() );
 515         }
 516
 517         public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
 518                 return $this->__call( __FUNCTION__, func_get_args() );
 519         }
 520
 521         public function setTransactionListener( $name, callable $callback = null ) {
 522                 return $this->__call( __FUNCTION__, func_get_args() );
 523         }
 524
 525         public function startAtomic(
 526                 $fname = __METHOD__, $cancelable = IDatabase::ATOMIC_NOT_CANCELABLE
 527         ) {
 528                 return $this->__call( __FUNCTION__, func_get_args() );
 529         }
 530
 531         public function endAtomic( $fname = __METHOD__ ) {
 532                 return $this->__call( __FUNCTION__, func_get_args() );
 533         }
 534
 535         public function cancelAtomic( $fname = __METHOD__, AtomicSectionIdentifier $sectionId = null ) {
 536                 return $this->__call( __FUNCTION__, func_get_args() );
 537         }
 538
 539         public function doAtomicSection(
 540                 $fname, callable $callback, $cancelable = self::ATOMIC_NOT_CANCELABLE
 541         ) {
 542                 return $this->__call( __FUNCTION__, func_get_args() );
 543         }
 544
 545         public function begin( $fname = __METHOD__, $mode = IDatabase::TRANSACTION_EXPLICIT ) {
 546                 return $this->__call( __FUNCTION__, func_get_args() );
 547         }
 548
 549         public function commit( $fname = __METHOD__, $flush = '' ) {
 550                 return $this->__call( __FUNCTION__, func_get_args() );
 551         }
 552
 553         public function rollback( $fname = __METHOD__, $flush = '' ) {
 554                 return $this->__call( __FUNCTION__, func_get_args() );
 555         }
 556
 557         public function flushSnapshot( $fname = __METHOD__ ) {
 558                 return $this->__call( __FUNCTION__, func_get_args() );
 559         }
 560
 561         public function timestamp( $ts = 0 ) {
 562                 return $this->__call( __FUNCTION__, func_get_args() );
 563         }
 564
 565         public function timestampOrNull( $ts = null ) {
 566                 return $this->__call( __FUNCTION__, func_get_args() );
 567         }
 568
 569         public function ping( &$rtt = null ) {
 570                 return func_num_args()
 571                         ? $this->__call( __FUNCTION__, [ &$rtt ] )
 572                         : $this->__call( __FUNCTION__, [] ); // method cares about null vs missing
 573         }
 574
 575         public function getLag() {
 576                 return $this->__call( __FUNCTION__, func_get_args() );
 577         }
 578
 579         public function getSessionLagStatus() {
 580                 return $this->__call( __FUNCTION__, func_get_args() );
 581         }
 582
 583         public function maxListLen() {
 584                 return $this->__call( __FUNCTION__, func_get_args() );
 585         }
 586
 587         public function encodeBlob( $b ) {
 588                 return $this->__call( __FUNCTION__, func_get_args() );
 589         }
 590
 591         public function decodeBlob( $b ) {
 592                 return $this->__call( __FUNCTION__, func_get_args() );
 593         }
 594
 595         public function setSessionOptions( array $options ) {
 596                 return $this->__call( __FUNCTION__, func_get_args() );
 597         }
 598
 599         public function setSchemaVars( $vars ) {
 600                 return $this->__call( __FUNCTION__, func_get_args() );
 601         }
 602
 603         public function lockIsFree( $lockName, $method ) {
 604                 return $this->__call( __FUNCTION__, func_get_args() );
 605         }
 606
 607         public function lock( $lockName, $method, $timeout = 5 ) {
 608                 return $this->__call( __FUNCTION__, func_get_args() );
 609         }
 610
 611         public function unlock( $lockName, $method ) {
 612                 return $this->__call( __FUNCTION__, func_get_args() );
 613         }
 614
 615         public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
 616                 return $this->__call( __FUNCTION__, func_get_args() );
 617         }
 618
 619         public function namedLocksEnqueue() {
 620                 return $this->__call( __FUNCTION__, func_get_args() );
 621         }
 622
 623         public function getInfinity() {
 624                 return $this->__call( __FUNCTION__, func_get_args() );
 625         }
 626
 627         public function encodeExpiry( $expiry ) {
 628                 return $this->__call( __FUNCTION__, func_get_args() );
 629         }
 630
 631         public function decodeExpiry( $expiry, $format = TS_MW ) {
 632                 return $this->__call( __FUNCTION__, func_get_args() );
 633         }
 634
 635         public function setBigSelects( $value = true ) {
 636                 return $this->__call( __FUNCTION__, func_get_args() );
 637         }
 638
 639         public function isReadOnly() {
 640                 return $this->__call( __FUNCTION__, func_get_args() );
 641         }
 642
 643         public function setTableAliases( array $aliases ) {
 644                 return $this->__call( __FUNCTION__, func_get_args() );
 645         }
 646
 647         public function setIndexAliases( array $aliases ) {
 648                 return $this->__call( __FUNCTION__, func_get_args() );
 649         }
 650
 651         /**
 652          * Clean up the connection when out of scope
 653          */
 654         function __destruct() {
 655                 if ( $this->conn ) {
 656                         $this->lb->reuseConnection( $this->conn );
 657                 }
 658         }
 659 }
 660
 661 /**
 662  * @since 1.22
 663  * @deprecated since 1.29
 664  */
 665 class_alias( DBConnRef::class, 'DBConnRef' );