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 tablePrefix( $prefix = null ) {
  73                 return $this->__call( __FUNCTION__, func_get_args() );
  74         }
  75
  76         public function dbSchema( $schema = null ) {
  77                 return $this->__call( __FUNCTION__, func_get_args() );
  78         }
  79
  80         public function getLBInfo( $name = null ) {
  81                 return $this->__call( __FUNCTION__, func_get_args() );
  82         }
  83
  84         public function setLBInfo( $name, $value = null ) {
  85                 return $this->__call( __FUNCTION__, func_get_args() );
  86         }
  87
  88         public function setLazyMasterHandle( IDatabase $conn ) {
  89                 return $this->__call( __FUNCTION__, func_get_args() );
  90         }
  91
  92         public function implicitGroupby() {
  93                 return $this->__call( __FUNCTION__, func_get_args() );
  94         }
  95
  96         public function implicitOrderby() {
  97                 return $this->__call( __FUNCTION__, func_get_args() );
  98         }
  99
 100         public function lastQuery() {
 101                 return $this->__call( __FUNCTION__, func_get_args() );
 102         }
 103
 104         public function doneWrites() {
 105                 return $this->__call( __FUNCTION__, func_get_args() );
 106         }
 107
 108         public function lastDoneWrites() {
 109                 return $this->__call( __FUNCTION__, func_get_args() );
 110         }
 111
 112         public function writesPending() {
 113                 return $this->__call( __FUNCTION__, func_get_args() );
 114         }
 115
 116         public function preCommitCallbacksPending() {
 117                 return $this->__call( __FUNCTION__, func_get_args() );
 118         }
 119
 120         public function writesOrCallbacksPending() {
 121                 return $this->__call( __FUNCTION__, func_get_args() );
 122         }
 123
 124         public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
 125                 return $this->__call( __FUNCTION__, func_get_args() );
 126         }
 127
 128         public function pendingWriteCallers() {
 129                 return $this->__call( __FUNCTION__, func_get_args() );
 130         }
 131
 132         public function pendingWriteRowsAffected() {
 133                 return $this->__call( __FUNCTION__, func_get_args() );
 134         }
 135
 136         public function isOpen() {
 137                 return $this->__call( __FUNCTION__, func_get_args() );
 138         }
 139
 140         public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 141                 return $this->__call( __FUNCTION__, func_get_args() );
 142         }
 143
 144         public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 145                 return $this->__call( __FUNCTION__, func_get_args() );
 146         }
 147
 148         public function restoreFlags( $state = self::RESTORE_PRIOR ) {
 149                 return $this->__call( __FUNCTION__, func_get_args() );
 150         }
 151
 152         public function getFlag( $flag ) {
 153                 return $this->__call( __FUNCTION__, func_get_args() );
 154         }
 155
 156         public function getProperty( $name ) {
 157                 return $this->__call( __FUNCTION__, func_get_args() );
 158         }
 159
 160         public function getDomainID() {
 161                 if ( $this->conn === null ) {
 162                         $domain = $this->params[self::FLD_DOMAIN];
 163                         // Avoid triggering a database connection
 164                         return $domain instanceof DatabaseDomain ? $domain->getId() : $domain;
 165                 }
 166
 167                 return $this->__call( __FUNCTION__, func_get_args() );
 168         }
 169
 170         /**
 171          * @codeCoverageIgnore
 172          */
 173         public function getWikiID() {
 174                 return $this->getDomainID();
 175         }
 176
 177         public function getType() {
 178                 return $this->__call( __FUNCTION__, func_get_args() );
 179         }
 180
 181         public function open( $server, $user, $password, $dbName ) {
 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                 return $this->__call( __FUNCTION__, func_get_args() );
 375         }
 376
 377         public function getDBname() {
 378                 return $this->__call( __FUNCTION__, func_get_args() );
 379         }
 380
 381         public function getServer() {
 382                 return $this->__call( __FUNCTION__, func_get_args() );
 383         }
 384
 385         public function addQuotes( $s ) {
 386                 return $this->__call( __FUNCTION__, func_get_args() );
 387         }
 388
 389         public function buildLike() {
 390                 return $this->__call( __FUNCTION__, func_get_args() );
 391         }
 392
 393         public function anyChar() {
 394                 return $this->__call( __FUNCTION__, func_get_args() );
 395         }
 396
 397         public function anyString() {
 398                 return $this->__call( __FUNCTION__, func_get_args() );
 399         }
 400
 401         public function nextSequenceValue( $seqName ) {
 402                 return $this->__call( __FUNCTION__, func_get_args() );
 403         }
 404
 405         public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
 406                 return $this->__call( __FUNCTION__, func_get_args() );
 407         }
 408
 409         public function upsert(
 410                 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
 411         ) {
 412                 return $this->__call( __FUNCTION__, func_get_args() );
 413         }
 414
 415         public function deleteJoin(
 416                 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
 417         ) {
 418                 return $this->__call( __FUNCTION__, func_get_args() );
 419         }
 420
 421         public function delete( $table, $conds, $fname = __METHOD__ ) {
 422                 return $this->__call( __FUNCTION__, func_get_args() );
 423         }
 424
 425         public function insertSelect(
 426                 $destTable, $srcTable, $varMap, $conds,
 427                 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
 428         ) {
 429                 return $this->__call( __FUNCTION__, func_get_args() );
 430         }
 431
 432         public function unionSupportsOrderAndLimit() {
 433                 return $this->__call( __FUNCTION__, func_get_args() );
 434         }
 435
 436         public function unionQueries( $sqls, $all ) {
 437                 return $this->__call( __FUNCTION__, func_get_args() );
 438         }
 439
 440         public function unionConditionPermutations(
 441                 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
 442                 $options = [], $join_conds = []
 443         ) {
 444                 return $this->__call( __FUNCTION__, func_get_args() );
 445         }
 446
 447         public function conditional( $cond, $trueVal, $falseVal ) {
 448                 return $this->__call( __FUNCTION__, func_get_args() );
 449         }
 450
 451         public function strreplace( $orig, $old, $new ) {
 452                 return $this->__call( __FUNCTION__, func_get_args() );
 453         }
 454
 455         public function getServerUptime() {
 456                 return $this->__call( __FUNCTION__, func_get_args() );
 457         }
 458
 459         public function wasDeadlock() {
 460                 return $this->__call( __FUNCTION__, func_get_args() );
 461         }
 462
 463         public function wasLockTimeout() {
 464                 return $this->__call( __FUNCTION__, func_get_args() );
 465         }
 466
 467         public function wasConnectionLoss() {
 468                 return $this->__call( __FUNCTION__, func_get_args() );
 469         }
 470
 471         public function wasReadOnlyError() {
 472                 return $this->__call( __FUNCTION__, func_get_args() );
 473         }
 474
 475         public function wasErrorReissuable() {
 476                 return $this->__call( __FUNCTION__, func_get_args() );
 477         }
 478
 479         public function masterPosWait( DBMasterPos $pos, $timeout ) {
 480                 return $this->__call( __FUNCTION__, func_get_args() );
 481         }
 482
 483         public function getReplicaPos() {
 484                 return $this->__call( __FUNCTION__, func_get_args() );
 485         }
 486
 487         public function getMasterPos() {
 488                 return $this->__call( __FUNCTION__, func_get_args() );
 489         }
 490
 491         public function serverIsReadOnly() {
 492                 return $this->__call( __FUNCTION__, func_get_args() );
 493         }
 494
 495         public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
 496                 return $this->__call( __FUNCTION__, func_get_args() );
 497         }
 498
 499         public function onTransactionCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
 500                 return $this->__call( __FUNCTION__, func_get_args() );
 501         }
 502
 503         public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
 504                 return $this->__call( __FUNCTION__, func_get_args() );
 505         }
 506
 507         public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
 508                 return $this->__call( __FUNCTION__, func_get_args() );
 509         }
 510
 511         public function setTransactionListener( $name, callable $callback = null ) {
 512                 return $this->__call( __FUNCTION__, func_get_args() );
 513         }
 514
 515         public function startAtomic(
 516                 $fname = __METHOD__, $cancelable = IDatabase::ATOMIC_NOT_CANCELABLE
 517         ) {
 518                 return $this->__call( __FUNCTION__, func_get_args() );
 519         }
 520
 521         public function endAtomic( $fname = __METHOD__ ) {
 522                 return $this->__call( __FUNCTION__, func_get_args() );
 523         }
 524
 525         public function cancelAtomic( $fname = __METHOD__, AtomicSectionIdentifier $sectionId = null ) {
 526                 return $this->__call( __FUNCTION__, func_get_args() );
 527         }
 528
 529         public function doAtomicSection(
 530                 $fname, callable $callback, $cancelable = self::ATOMIC_NOT_CANCELABLE
 531         ) {
 532                 return $this->__call( __FUNCTION__, func_get_args() );
 533         }
 534
 535         public function begin( $fname = __METHOD__, $mode = IDatabase::TRANSACTION_EXPLICIT ) {
 536                 return $this->__call( __FUNCTION__, func_get_args() );
 537         }
 538
 539         public function commit( $fname = __METHOD__, $flush = '' ) {
 540                 return $this->__call( __FUNCTION__, func_get_args() );
 541         }
 542
 543         public function rollback( $fname = __METHOD__, $flush = '' ) {
 544                 return $this->__call( __FUNCTION__, func_get_args() );
 545         }
 546
 547         public function flushSnapshot( $fname = __METHOD__ ) {
 548                 return $this->__call( __FUNCTION__, func_get_args() );
 549         }
 550
 551         public function timestamp( $ts = 0 ) {
 552                 return $this->__call( __FUNCTION__, func_get_args() );
 553         }
 554
 555         public function timestampOrNull( $ts = null ) {
 556                 return $this->__call( __FUNCTION__, func_get_args() );
 557         }
 558
 559         public function ping( &$rtt = null ) {
 560                 return func_num_args()
 561                         ? $this->__call( __FUNCTION__, [ &$rtt ] )
 562                         : $this->__call( __FUNCTION__, [] ); // method cares about null vs missing
 563         }
 564
 565         public function getLag() {
 566                 return $this->__call( __FUNCTION__, func_get_args() );
 567         }
 568
 569         public function getSessionLagStatus() {
 570                 return $this->__call( __FUNCTION__, func_get_args() );
 571         }
 572
 573         public function maxListLen() {
 574                 return $this->__call( __FUNCTION__, func_get_args() );
 575         }
 576
 577         public function encodeBlob( $b ) {
 578                 return $this->__call( __FUNCTION__, func_get_args() );
 579         }
 580
 581         public function decodeBlob( $b ) {
 582                 return $this->__call( __FUNCTION__, func_get_args() );
 583         }
 584
 585         public function setSessionOptions( array $options ) {
 586                 return $this->__call( __FUNCTION__, func_get_args() );
 587         }
 588
 589         public function setSchemaVars( $vars ) {
 590                 return $this->__call( __FUNCTION__, func_get_args() );
 591         }
 592
 593         public function lockIsFree( $lockName, $method ) {
 594                 return $this->__call( __FUNCTION__, func_get_args() );
 595         }
 596
 597         public function lock( $lockName, $method, $timeout = 5 ) {
 598                 return $this->__call( __FUNCTION__, func_get_args() );
 599         }
 600
 601         public function unlock( $lockName, $method ) {
 602                 return $this->__call( __FUNCTION__, func_get_args() );
 603         }
 604
 605         public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
 606                 return $this->__call( __FUNCTION__, func_get_args() );
 607         }
 608
 609         public function namedLocksEnqueue() {
 610                 return $this->__call( __FUNCTION__, func_get_args() );
 611         }
 612
 613         public function getInfinity() {
 614                 return $this->__call( __FUNCTION__, func_get_args() );
 615         }
 616
 617         public function encodeExpiry( $expiry ) {
 618                 return $this->__call( __FUNCTION__, func_get_args() );
 619         }
 620
 621         public function decodeExpiry( $expiry, $format = TS_MW ) {
 622                 return $this->__call( __FUNCTION__, func_get_args() );
 623         }
 624
 625         public function setBigSelects( $value = true ) {
 626                 return $this->__call( __FUNCTION__, func_get_args() );
 627         }
 628
 629         public function isReadOnly() {
 630                 return $this->__call( __FUNCTION__, func_get_args() );
 631         }
 632
 633         public function setTableAliases( array $aliases ) {
 634                 return $this->__call( __FUNCTION__, func_get_args() );
 635         }
 636
 637         public function setIndexAliases( array $aliases ) {
 638                 return $this->__call( __FUNCTION__, func_get_args() );
 639         }
 640
 641         /**
 642          * Clean up the connection when out of scope
 643          */
 644         function __destruct() {
 645                 if ( $this->conn ) {
 646                         $this->lb->reuseConnection( $this->conn );
 647                 }
 648         }
 649 }
 650
 651 /**
 652  * @since 1.22
 653  * @deprecated since 1.29
 654  */
 655 class_alias( DBConnRef::class, 'DBConnRef' );