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 ( 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 call_user_func_array( [ $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 writesOrCallbacksPending() {
 117                 return $this->__call( __FUNCTION__, func_get_args() );
 118         }
 119
 120         public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
 121                 return $this->__call( __FUNCTION__, func_get_args() );
 122         }
 123
 124         public function pendingWriteCallers() {
 125                 return $this->__call( __FUNCTION__, func_get_args() );
 126         }
 127
 128         public function pendingWriteRowsAffected() {
 129                 return $this->__call( __FUNCTION__, func_get_args() );
 130         }
 131
 132         public function isOpen() {
 133                 return $this->__call( __FUNCTION__, func_get_args() );
 134         }
 135
 136         public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 137                 return $this->__call( __FUNCTION__, func_get_args() );
 138         }
 139
 140         public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 141                 return $this->__call( __FUNCTION__, func_get_args() );
 142         }
 143
 144         public function restoreFlags( $state = self::RESTORE_PRIOR ) {
 145                 return $this->__call( __FUNCTION__, func_get_args() );
 146         }
 147
 148         public function getFlag( $flag ) {
 149                 return $this->__call( __FUNCTION__, func_get_args() );
 150         }
 151
 152         public function getProperty( $name ) {
 153                 return $this->__call( __FUNCTION__, func_get_args() );
 154         }
 155
 156         public function getDomainID() {
 157                 if ( $this->conn === null ) {
 158                         $domain = $this->params[self::FLD_DOMAIN];
 159                         // Avoid triggering a database connection
 160                         return $domain instanceof DatabaseDomain ? $domain->getId() : $domain;
 161                 }
 162
 163                 return $this->__call( __FUNCTION__, func_get_args() );
 164         }
 165
 166         public function getWikiID() {
 167                 return $this->getDomainID();
 168         }
 169
 170         public function getType() {
 171                 return $this->__call( __FUNCTION__, func_get_args() );
 172         }
 173
 174         public function open( $server, $user, $password, $dbName ) {
 175                 return $this->__call( __FUNCTION__, func_get_args() );
 176         }
 177
 178         public function fetchObject( $res ) {
 179                 return $this->__call( __FUNCTION__, func_get_args() );
 180         }
 181
 182         public function fetchRow( $res ) {
 183                 return $this->__call( __FUNCTION__, func_get_args() );
 184         }
 185
 186         public function numRows( $res ) {
 187                 return $this->__call( __FUNCTION__, func_get_args() );
 188         }
 189
 190         public function numFields( $res ) {
 191                 return $this->__call( __FUNCTION__, func_get_args() );
 192         }
 193
 194         public function fieldName( $res, $n ) {
 195                 return $this->__call( __FUNCTION__, func_get_args() );
 196         }
 197
 198         public function insertId() {
 199                 return $this->__call( __FUNCTION__, func_get_args() );
 200         }
 201
 202         public function dataSeek( $res, $row ) {
 203                 return $this->__call( __FUNCTION__, func_get_args() );
 204         }
 205
 206         public function lastErrno() {
 207                 return $this->__call( __FUNCTION__, func_get_args() );
 208         }
 209
 210         public function lastError() {
 211                 return $this->__call( __FUNCTION__, func_get_args() );
 212         }
 213
 214         public function fieldInfo( $table, $field ) {
 215                 return $this->__call( __FUNCTION__, func_get_args() );
 216         }
 217
 218         public function affectedRows() {
 219                 return $this->__call( __FUNCTION__, func_get_args() );
 220         }
 221
 222         public function getSoftwareLink() {
 223                 return $this->__call( __FUNCTION__, func_get_args() );
 224         }
 225
 226         public function getServerVersion() {
 227                 return $this->__call( __FUNCTION__, func_get_args() );
 228         }
 229
 230         public function close() {
 231                 return $this->__call( __FUNCTION__, func_get_args() );
 232         }
 233
 234         public function reportConnectionError( $error = 'Unknown error' ) {
 235                 return $this->__call( __FUNCTION__, func_get_args() );
 236         }
 237
 238         public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) {
 239                 return $this->__call( __FUNCTION__, func_get_args() );
 240         }
 241
 242         public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
 243                 return $this->__call( __FUNCTION__, func_get_args() );
 244         }
 245
 246         public function freeResult( $res ) {
 247                 return $this->__call( __FUNCTION__, func_get_args() );
 248         }
 249
 250         public function selectField(
 251                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
 252         ) {
 253                 return $this->__call( __FUNCTION__, func_get_args() );
 254         }
 255
 256         public function selectFieldValues(
 257                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
 258         ) {
 259                 return $this->__call( __FUNCTION__, func_get_args() );
 260         }
 261
 262         public function select(
 263                 $table, $vars, $conds = '', $fname = __METHOD__,
 264                 $options = [], $join_conds = []
 265         ) {
 266                 return $this->__call( __FUNCTION__, func_get_args() );
 267         }
 268
 269         public function selectSQLText(
 270                 $table, $vars, $conds = '', $fname = __METHOD__,
 271                 $options = [], $join_conds = []
 272         ) {
 273                 return $this->__call( __FUNCTION__, func_get_args() );
 274         }
 275
 276         public function selectRow(
 277                 $table, $vars, $conds, $fname = __METHOD__,
 278                 $options = [], $join_conds = []
 279         ) {
 280                 return $this->__call( __FUNCTION__, func_get_args() );
 281         }
 282
 283         public function estimateRowCount(
 284                 $table, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
 285         ) {
 286                 return $this->__call( __FUNCTION__, func_get_args() );
 287         }
 288
 289         public function selectRowCount(
 290                 $tables, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
 291         ) {
 292                 return $this->__call( __FUNCTION__, func_get_args() );
 293         }
 294
 295         public function fieldExists( $table, $field, $fname = __METHOD__ ) {
 296                 return $this->__call( __FUNCTION__, func_get_args() );
 297         }
 298
 299         public function indexExists( $table, $index, $fname = __METHOD__ ) {
 300                 return $this->__call( __FUNCTION__, func_get_args() );
 301         }
 302
 303         public function tableExists( $table, $fname = __METHOD__ ) {
 304                 return $this->__call( __FUNCTION__, func_get_args() );
 305         }
 306
 307         public function indexUnique( $table, $index ) {
 308                 return $this->__call( __FUNCTION__, func_get_args() );
 309         }
 310
 311         public function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
 312                 return $this->__call( __FUNCTION__, func_get_args() );
 313         }
 314
 315         public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
 316                 return $this->__call( __FUNCTION__, func_get_args() );
 317         }
 318
 319         public function makeList( $a, $mode = self::LIST_COMMA ) {
 320                 return $this->__call( __FUNCTION__, func_get_args() );
 321         }
 322
 323         public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
 324                 return $this->__call( __FUNCTION__, func_get_args() );
 325         }
 326
 327         public function aggregateValue( $valuedata, $valuename = 'value' ) {
 328                 return $this->__call( __FUNCTION__, func_get_args() );
 329         }
 330
 331         public function bitNot( $field ) {
 332                 return $this->__call( __FUNCTION__, func_get_args() );
 333         }
 334
 335         public function bitAnd( $fieldLeft, $fieldRight ) {
 336                 return $this->__call( __FUNCTION__, func_get_args() );
 337         }
 338
 339         public function bitOr( $fieldLeft, $fieldRight ) {
 340                 return $this->__call( __FUNCTION__, func_get_args() );
 341         }
 342
 343         public function buildConcat( $stringList ) {
 344                 return $this->__call( __FUNCTION__, func_get_args() );
 345         }
 346
 347         public function buildGroupConcatField(
 348                 $delim, $table, $field, $conds = '', $join_conds = []
 349         ) {
 350                 return $this->__call( __FUNCTION__, func_get_args() );
 351         }
 352
 353         public function buildSubstring( $input, $startPosition, $length = null ) {
 354                 return $this->__call( __FUNCTION__, func_get_args() );
 355         }
 356
 357         public function buildStringCast( $field ) {
 358                 return $this->__call( __FUNCTION__, func_get_args() );
 359         }
 360
 361         public function buildIntegerCast( $field ) {
 362                 return $this->__call( __FUNCTION__, func_get_args() );
 363         }
 364
 365         public function buildSelectSubquery(
 366                 $table, $vars, $conds = '', $fname = __METHOD__,
 367                 $options = [], $join_conds = []
 368         ) {
 369                 return $this->__call( __FUNCTION__, func_get_args() );
 370         }
 371
 372         public function databasesAreIndependent() {
 373                 return $this->__call( __FUNCTION__, func_get_args() );
 374         }
 375
 376         public function selectDB( $db ) {
 377                 return $this->__call( __FUNCTION__, func_get_args() );
 378         }
 379
 380         public function getDBname() {
 381                 return $this->__call( __FUNCTION__, func_get_args() );
 382         }
 383
 384         public function getServer() {
 385                 return $this->__call( __FUNCTION__, func_get_args() );
 386         }
 387
 388         public function addQuotes( $s ) {
 389                 return $this->__call( __FUNCTION__, func_get_args() );
 390         }
 391
 392         public function buildLike() {
 393                 return $this->__call( __FUNCTION__, func_get_args() );
 394         }
 395
 396         public function anyChar() {
 397                 return $this->__call( __FUNCTION__, func_get_args() );
 398         }
 399
 400         public function anyString() {
 401                 return $this->__call( __FUNCTION__, func_get_args() );
 402         }
 403
 404         public function nextSequenceValue( $seqName ) {
 405                 return $this->__call( __FUNCTION__, func_get_args() );
 406         }
 407
 408         public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
 409                 return $this->__call( __FUNCTION__, func_get_args() );
 410         }
 411
 412         public function upsert(
 413                 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
 414         ) {
 415                 return $this->__call( __FUNCTION__, func_get_args() );
 416         }
 417
 418         public function deleteJoin(
 419                 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
 420         ) {
 421                 return $this->__call( __FUNCTION__, func_get_args() );
 422         }
 423
 424         public function delete( $table, $conds, $fname = __METHOD__ ) {
 425                 return $this->__call( __FUNCTION__, func_get_args() );
 426         }
 427
 428         public function insertSelect(
 429                 $destTable, $srcTable, $varMap, $conds,
 430                 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
 431         ) {
 432                 return $this->__call( __FUNCTION__, func_get_args() );
 433         }
 434
 435         public function unionSupportsOrderAndLimit() {
 436                 return $this->__call( __FUNCTION__, func_get_args() );
 437         }
 438
 439         public function unionQueries( $sqls, $all ) {
 440                 return $this->__call( __FUNCTION__, func_get_args() );
 441         }
 442
 443         public function unionConditionPermutations(
 444                 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
 445                 $options = [], $join_conds = []
 446         ) {
 447                 return $this->__call( __FUNCTION__, func_get_args() );
 448         }
 449
 450         public function conditional( $cond, $trueVal, $falseVal ) {
 451                 return $this->__call( __FUNCTION__, func_get_args() );
 452         }
 453
 454         public function strreplace( $orig, $old, $new ) {
 455                 return $this->__call( __FUNCTION__, func_get_args() );
 456         }
 457
 458         public function getServerUptime() {
 459                 return $this->__call( __FUNCTION__, func_get_args() );
 460         }
 461
 462         public function wasDeadlock() {
 463                 return $this->__call( __FUNCTION__, func_get_args() );
 464         }
 465
 466         public function wasLockTimeout() {
 467                 return $this->__call( __FUNCTION__, func_get_args() );
 468         }
 469
 470         public function wasConnectionLoss() {
 471                 return $this->__call( __FUNCTION__, func_get_args() );
 472         }
 473
 474         public function wasReadOnlyError() {
 475                 return $this->__call( __FUNCTION__, func_get_args() );
 476         }
 477
 478         public function wasErrorReissuable() {
 479                 return $this->__call( __FUNCTION__, func_get_args() );
 480         }
 481
 482         public function masterPosWait( DBMasterPos $pos, $timeout ) {
 483                 return $this->__call( __FUNCTION__, func_get_args() );
 484         }
 485
 486         public function getReplicaPos() {
 487                 return $this->__call( __FUNCTION__, func_get_args() );
 488         }
 489
 490         public function getMasterPos() {
 491                 return $this->__call( __FUNCTION__, func_get_args() );
 492         }
 493
 494         public function serverIsReadOnly() {
 495                 return $this->__call( __FUNCTION__, func_get_args() );
 496         }
 497
 498         public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
 499                 return $this->__call( __FUNCTION__, func_get_args() );
 500         }
 501
 502         public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
 503                 return $this->__call( __FUNCTION__, func_get_args() );
 504         }
 505
 506         public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
 507                 return $this->__call( __FUNCTION__, func_get_args() );
 508         }
 509
 510         public function setTransactionListener( $name, callable $callback = null ) {
 511                 return $this->__call( __FUNCTION__, func_get_args() );
 512         }
 513
 514         public function startAtomic( $fname = __METHOD__ ) {
 515                 return $this->__call( __FUNCTION__, func_get_args() );
 516         }
 517
 518         public function endAtomic( $fname = __METHOD__ ) {
 519                 return $this->__call( __FUNCTION__, func_get_args() );
 520         }
 521
 522         public function doAtomicSection( $fname, callable $callback ) {
 523                 return $this->__call( __FUNCTION__, func_get_args() );
 524         }
 525
 526         public function begin( $fname = __METHOD__, $mode = IDatabase::TRANSACTION_EXPLICIT ) {
 527                 return $this->__call( __FUNCTION__, func_get_args() );
 528         }
 529
 530         public function commit( $fname = __METHOD__, $flush = '' ) {
 531                 return $this->__call( __FUNCTION__, func_get_args() );
 532         }
 533
 534         public function rollback( $fname = __METHOD__, $flush = '' ) {
 535                 return $this->__call( __FUNCTION__, func_get_args() );
 536         }
 537
 538         public function flushSnapshot( $fname = __METHOD__ ) {
 539                 return $this->__call( __FUNCTION__, func_get_args() );
 540         }
 541
 542         public function listTables( $prefix = null, $fname = __METHOD__ ) {
 543                 return $this->__call( __FUNCTION__, func_get_args() );
 544         }
 545
 546         public function timestamp( $ts = 0 ) {
 547                 return $this->__call( __FUNCTION__, func_get_args() );
 548         }
 549
 550         public function timestampOrNull( $ts = null ) {
 551                 return $this->__call( __FUNCTION__, func_get_args() );
 552         }
 553
 554         public function ping( &$rtt = null ) {
 555                 return func_num_args()
 556                         ? $this->__call( __FUNCTION__, [ &$rtt ] )
 557                         : $this->__call( __FUNCTION__, [] ); // method cares about null vs missing
 558         }
 559
 560         public function getLag() {
 561                 return $this->__call( __FUNCTION__, func_get_args() );
 562         }
 563
 564         public function getSessionLagStatus() {
 565                 return $this->__call( __FUNCTION__, func_get_args() );
 566         }
 567
 568         public function maxListLen() {
 569                 return $this->__call( __FUNCTION__, func_get_args() );
 570         }
 571
 572         public function encodeBlob( $b ) {
 573                 return $this->__call( __FUNCTION__, func_get_args() );
 574         }
 575
 576         public function decodeBlob( $b ) {
 577                 return $this->__call( __FUNCTION__, func_get_args() );
 578         }
 579
 580         public function setSessionOptions( array $options ) {
 581                 return $this->__call( __FUNCTION__, func_get_args() );
 582         }
 583
 584         public function setSchemaVars( $vars ) {
 585                 return $this->__call( __FUNCTION__, func_get_args() );
 586         }
 587
 588         public function lockIsFree( $lockName, $method ) {
 589                 return $this->__call( __FUNCTION__, func_get_args() );
 590         }
 591
 592         public function lock( $lockName, $method, $timeout = 5 ) {
 593                 return $this->__call( __FUNCTION__, func_get_args() );
 594         }
 595
 596         public function unlock( $lockName, $method ) {
 597                 return $this->__call( __FUNCTION__, func_get_args() );
 598         }
 599
 600         public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
 601                 return $this->__call( __FUNCTION__, func_get_args() );
 602         }
 603
 604         public function namedLocksEnqueue() {
 605                 return $this->__call( __FUNCTION__, func_get_args() );
 606         }
 607
 608         public function getInfinity() {
 609                 return $this->__call( __FUNCTION__, func_get_args() );
 610         }
 611
 612         public function encodeExpiry( $expiry ) {
 613                 return $this->__call( __FUNCTION__, func_get_args() );
 614         }
 615
 616         public function decodeExpiry( $expiry, $format = TS_MW ) {
 617                 return $this->__call( __FUNCTION__, func_get_args() );
 618         }
 619
 620         public function setBigSelects( $value = true ) {
 621                 return $this->__call( __FUNCTION__, func_get_args() );
 622         }
 623
 624         public function isReadOnly() {
 625                 return $this->__call( __FUNCTION__, func_get_args() );
 626         }
 627
 628         public function setTableAliases( array $aliases ) {
 629                 return $this->__call( __FUNCTION__, func_get_args() );
 630         }
 631
 632         public function setIndexAliases( array $aliases ) {
 633                 return $this->__call( __FUNCTION__, func_get_args() );
 634         }
 635
 636         /**
 637          * Clean up the connection when out of scope
 638          */
 639         function __destruct() {
 640                 if ( $this->conn ) {
 641                         $this->lb->reuseConnection( $this->conn );
 642                 }
 643         }
 644 }
 645
 646 class_alias( DBConnRef::class, 'DBConnRef' );