includes/objectcache/SqlBagOStuff.php

   1 <?php
   2 /**
   3  * Object caching using a SQL database.
   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 Cache
  22  */
  23
  24 use MediaWiki\MediaWikiServices;
  25 use Wikimedia\Rdbms\Database;
  26 use Wikimedia\Rdbms\IDatabase;
  27 use Wikimedia\Rdbms\DBError;
  28 use Wikimedia\Rdbms\DBQueryError;
  29 use Wikimedia\Rdbms\DBConnectionError;
  30 use Wikimedia\Rdbms\LoadBalancer;
  31 use Wikimedia\ScopedCallback;
  32 use Wikimedia\WaitConditionLoop;
  33
  34 /**
  35  * Class to store objects in the database
  36  *
  37  * @ingroup Cache
  38  */
  39 class SqlBagOStuff extends BagOStuff {
  40         /** @var array[] (server index => server config) */
  41         protected $serverInfos;
  42         /** @var string[] (server index => tag/host name) */
  43         protected $serverTags;
  44         /** @var int */
  45         protected $numServers;
  46         /** @var int */
  47         protected $lastExpireAll = 0;
  48         /** @var int */
  49         protected $purgePeriod = 100;
  50         /** @var int */
  51         protected $shards = 1;
  52         /** @var string */
  53         protected $tableName = 'objectcache';
  54         /** @var bool */
  55         protected $replicaOnly = false;
  56         /** @var int */
  57         protected $syncTimeout = 3;
  58
  59         /** @var LoadBalancer|null */
  60         protected $separateMainLB;
  61         /** @var array */
  62         protected $conns;
  63         /** @var array UNIX timestamps */
  64         protected $connFailureTimes = [];
  65         /** @var array Exceptions */
  66         protected $connFailureErrors = [];
  67
  68         /**
  69          * Constructor. Parameters are:
  70          *   - server:      A server info structure in the format required by each
  71          *                  element in $wgDBServers.
  72          *
  73          *   - servers:     An array of server info structures describing a set of database servers
  74          *                  to distribute keys to. If this is specified, the "server" option will be
  75          *                  ignored. If string keys are used, then they will be used for consistent
  76          *                  hashing *instead* of the host name (from the server config). This is useful
  77          *                  when a cluster is replicated to another site (with different host names)
  78          *                  but each server has a corresponding replica in the other cluster.
  79          *
  80          *   - purgePeriod: The average number of object cache requests in between
  81          *                  garbage collection operations, where expired entries
  82          *                  are removed from the database. Or in other words, the
  83          *                  reciprocal of the probability of purging on any given
  84          *                  request. If this is set to zero, purging will never be
  85          *                  done.
  86          *
  87          *   - tableName:   The table name to use, default is "objectcache".
  88          *
  89          *   - shards:      The number of tables to use for data storage on each server.
  90          *                  If this is more than 1, table names will be formed in the style
  91          *                  objectcacheNNN where NNN is the shard index, between 0 and
  92          *                  shards-1. The number of digits will be the minimum number
  93          *                  required to hold the largest shard index. Data will be
  94          *                  distributed across all tables by key hash. This is for
  95          *                  MySQL bugs 61735 <https://bugs.mysql.com/bug.php?id=61735>
  96          *                  and 61736 <https://bugs.mysql.com/bug.php?id=61736>.
  97          *
  98          *   - slaveOnly:   Whether to only use replica DBs and avoid triggering
  99          *                  garbage collection logic of expired items. This only
 100          *                  makes sense if the primary DB is used and only if get()
 101          *                  calls will be used. This is used by ReplicatedBagOStuff.
 102          *   - syncTimeout: Max seconds to wait for replica DBs to catch up for WRITE_SYNC.
 103          *
 104          * @param array $params
 105          */
 106         public function __construct( $params ) {
 107                 parent::__construct( $params );
 108
 109                 $this->attrMap[self::ATTR_EMULATION] = self::QOS_EMULATION_SQL;
 110                 $this->attrMap[self::ATTR_SYNCWRITES] = self::QOS_SYNCWRITES_NONE;
 111
 112                 if ( isset( $params['servers'] ) ) {
 113                         $this->serverInfos = [];
 114                         $this->serverTags = [];
 115                         $this->numServers = count( $params['servers'] );
 116                         $index = 0;
 117                         foreach ( $params['servers'] as $tag => $info ) {
 118                                 $this->serverInfos[$index] = $info;
 119                                 if ( is_string( $tag ) ) {
 120                                         $this->serverTags[$index] = $tag;
 121                                 } else {
 122                                         $this->serverTags[$index] = $info['host'] ?? "#$index";
 123                                 }
 124                                 ++$index;
 125                         }
 126                 } elseif ( isset( $params['server'] ) ) {
 127                         $this->serverInfos = [ $params['server'] ];
 128                         $this->numServers = count( $this->serverInfos );
 129                 } else {
 130                         // Default to using the main wiki's database servers
 131                         $this->serverInfos = false;
 132                         $this->numServers = 1;
 133                         $this->attrMap[self::ATTR_SYNCWRITES] = self::QOS_SYNCWRITES_BE;
 134                 }
 135                 if ( isset( $params['purgePeriod'] ) ) {
 136                         $this->purgePeriod = intval( $params['purgePeriod'] );
 137                 }
 138                 if ( isset( $params['tableName'] ) ) {
 139                         $this->tableName = $params['tableName'];
 140                 }
 141                 if ( isset( $params['shards'] ) ) {
 142                         $this->shards = intval( $params['shards'] );
 143                 }
 144                 if ( isset( $params['syncTimeout'] ) ) {
 145                         $this->syncTimeout = $params['syncTimeout'];
 146                 }
 147                 $this->replicaOnly = !empty( $params['slaveOnly'] );
 148         }
 149
 150         /**
 151          * Get a connection to the specified database
 152          *
 153          * @param int $serverIndex
 154          * @return Database
 155          * @throws MWException
 156          */
 157         protected function getDB( $serverIndex ) {
 158                 if ( !isset( $this->conns[$serverIndex] ) ) {
 159                         if ( $serverIndex >= $this->numServers ) {
 160                                 throw new MWException( __METHOD__ . ": Invalid server index \"$serverIndex\"" );
 161                         }
 162
 163                         # Don't keep timing out trying to connect for each call if the DB is down
 164                         if ( isset( $this->connFailureErrors[$serverIndex] )
 165                                 && ( time() - $this->connFailureTimes[$serverIndex] ) < 60
 166                         ) {
 167                                 throw $this->connFailureErrors[$serverIndex];
 168                         }
 169
 170                         if ( $this->serverInfos ) {
 171                                 // Use custom database defined by server connection info
 172                                 $info = $this->serverInfos[$serverIndex];
 173                                 $type = $info['type'] ?? 'mysql';
 174                                 $host = $info['host'] ?? '[unknown]';
 175                                 $this->logger->debug( __CLASS__ . ": connecting to $host" );
 176                                 $db = Database::factory( $type, $info );
 177                                 $db->clearFlag( DBO_TRX ); // auto-commit mode
 178                         } else {
 179                                 // Use the main LB database
 180                                 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
 181                                 $index = $this->replicaOnly ? DB_REPLICA : DB_MASTER;
 182                                 if ( $lb->getServerType( $lb->getWriterIndex() ) !== 'sqlite' ) {
 183                                         // Keep a separate connection to avoid contention and deadlocks
 184                                         $db = $lb->getConnection( $index, [], false, $lb::CONN_TRX_AUTOCOMMIT );
 185                                 } else {
 186                                         // However, SQLite has the opposite behavior due to DB-level locking.
 187                                         // Stock sqlite MediaWiki installs use a separate sqlite cache DB instead.
 188                                         $db = $lb->getConnection( $index );
 189                                 }
 190                         }
 191
 192                         $this->logger->debug( sprintf( "Connection %s will be used for SqlBagOStuff", $db ) );
 193                         $this->conns[$serverIndex] = $db;
 194                 }
 195
 196                 return $this->conns[$serverIndex];
 197         }
 198
 199         /**
 200          * Get the server index and table name for a given key
 201          * @param string $key
 202          * @return array Server index and table name
 203          */
 204         protected function getTableByKey( $key ) {
 205                 if ( $this->shards > 1 ) {
 206                         $hash = hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
 207                         $tableIndex = $hash % $this->shards;
 208                 } else {
 209                         $tableIndex = 0;
 210                 }
 211                 if ( $this->numServers > 1 ) {
 212                         $sortedServers = $this->serverTags;
 213                         ArrayUtils::consistentHashSort( $sortedServers, $key );
 214                         reset( $sortedServers );
 215                         $serverIndex = key( $sortedServers );
 216                 } else {
 217                         $serverIndex = 0;
 218                 }
 219                 return [ $serverIndex, $this->getTableNameByShard( $tableIndex ) ];
 220         }
 221
 222         /**
 223          * Get the table name for a given shard index
 224          * @param int $index
 225          * @return string
 226          */
 227         protected function getTableNameByShard( $index ) {
 228                 if ( $this->shards > 1 ) {
 229                         $decimals = strlen( $this->shards - 1 );
 230                         return $this->tableName .
 231                                 sprintf( "%0{$decimals}d", $index );
 232                 } else {
 233                         return $this->tableName;
 234                 }
 235         }
 236
 237         protected function doGet( $key, $flags = 0 ) {
 238                 $casToken = null;
 239
 240                 return $this->getWithToken( $key, $casToken, $flags );
 241         }
 242
 243         protected function getWithToken( $key, &$casToken, $flags = 0 ) {
 244                 $values = $this->getMulti( [ $key ] );
 245                 if ( array_key_exists( $key, $values ) ) {
 246                         $casToken = $values[$key];
 247                         return $values[$key];
 248                 }
 249                 return false;
 250         }
 251
 252         public function getMulti( array $keys, $flags = 0 ) {
 253                 $values = []; // array of (key => value)
 254
 255                 $keysByTable = [];
 256                 foreach ( $keys as $key ) {
 257                         list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
 258                         $keysByTable[$serverIndex][$tableName][] = $key;
 259                 }
 260
 261                 $this->garbageCollect(); // expire old entries if any
 262
 263                 $dataRows = [];
 264                 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
 265                         try {
 266                                 $db = $this->getDB( $serverIndex );
 267                                 foreach ( $serverKeys as $tableName => $tableKeys ) {
 268                                         $res = $db->select( $tableName,
 269                                                 [ 'keyname', 'value', 'exptime' ],
 270                                                 [ 'keyname' => $tableKeys ],
 271                                                 __METHOD__,
 272                                                 // Approximate write-on-the-fly BagOStuff API via blocking.
 273                                                 // This approximation fails if a ROLLBACK happens (which is rare).
 274                                                 // We do not want to flush the TRX as that can break callers.
 275                                                 $db->trxLevel() ? [ 'LOCK IN SHARE MODE' ] : []
 276                                         );
 277                                         if ( $res === false ) {
 278                                                 continue;
 279                                         }
 280                                         foreach ( $res as $row ) {
 281                                                 $row->serverIndex = $serverIndex;
 282                                                 $row->tableName = $tableName;
 283                                                 $dataRows[$row->keyname] = $row;
 284                                         }
 285                                 }
 286                         } catch ( DBError $e ) {
 287                                 $this->handleReadError( $e, $serverIndex );
 288                         }
 289                 }
 290
 291                 foreach ( $keys as $key ) {
 292                         if ( isset( $dataRows[$key] ) ) { // HIT?
 293                                 $row = $dataRows[$key];
 294                                 $this->debug( "get: retrieved data; expiry time is " . $row->exptime );
 295                                 $db = null;
 296                                 try {
 297                                         $db = $this->getDB( $row->serverIndex );
 298                                         if ( $this->isExpired( $db, $row->exptime ) ) { // MISS
 299                                                 $this->debug( "get: key has expired" );
 300                                         } else { // HIT
 301                                                 $values[$key] = $this->unserialize( $db->decodeBlob( $row->value ) );
 302                                         }
 303                                 } catch ( DBQueryError $e ) {
 304                                         $this->handleWriteError( $e, $db, $row->serverIndex );
 305                                 }
 306                         } else { // MISS
 307                                 $this->debug( 'get: no matching rows' );
 308                         }
 309                 }
 310
 311                 return $values;
 312         }
 313
 314         public function setMulti( array $data, $expiry = 0, $flags = 0 ) {
 315                 $keysByTable = [];
 316                 foreach ( $data as $key => $value ) {
 317                         list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
 318                         $keysByTable[$serverIndex][$tableName][] = $key;
 319                 }
 320
 321                 $this->garbageCollect(); // expire old entries if any
 322
 323                 $result = true;
 324                 $exptime = (int)$expiry;
 325                 $silenceScope = $this->silenceTransactionProfiler();
 326                 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
 327                         $db = null;
 328                         try {
 329                                 $db = $this->getDB( $serverIndex );
 330                         } catch ( DBError $e ) {
 331                                 $this->handleWriteError( $e, $db, $serverIndex );
 332                                 $result = false;
 333                                 continue;
 334                         }
 335
 336                         if ( $exptime < 0 ) {
 337                                 $exptime = 0;
 338                         }
 339
 340                         if ( $exptime == 0 ) {
 341                                 $encExpiry = $this->getMaxDateTime( $db );
 342                         } else {
 343                                 $exptime = $this->convertExpiry( $exptime );
 344                                 $encExpiry = $db->timestamp( $exptime );
 345                         }
 346                         foreach ( $serverKeys as $tableName => $tableKeys ) {
 347                                 $rows = [];
 348                                 foreach ( $tableKeys as $key ) {
 349                                         $rows[] = [
 350                                                 'keyname' => $key,
 351                                                 'value' => $db->encodeBlob( $this->serialize( $data[$key] ) ),
 352                                                 'exptime' => $encExpiry,
 353                                         ];
 354                                 }
 355
 356                                 try {
 357                                         $db->replace(
 358                                                 $tableName,
 359                                                 [ 'keyname' ],
 360                                                 $rows,
 361                                                 __METHOD__
 362                                         );
 363                                 } catch ( DBError $e ) {
 364                                         $this->handleWriteError( $e, $db, $serverIndex );
 365                                         $result = false;
 366                                 }
 367
 368                         }
 369
 370                 }
 371
 372                 return $result;
 373         }
 374
 375         public function set( $key, $value, $exptime = 0, $flags = 0 ) {
 376                 $ok = $this->setMulti( [ $key => $value ], $exptime );
 377                 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
 378                         $ok = $this->waitForReplication() && $ok;
 379                 }
 380
 381                 return $ok;
 382         }
 383
 384         protected function cas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
 385                 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
 386                 $db = null;
 387                 $silenceScope = $this->silenceTransactionProfiler();
 388                 try {
 389                         $db = $this->getDB( $serverIndex );
 390                         $exptime = intval( $exptime );
 391
 392                         if ( $exptime < 0 ) {
 393                                 $exptime = 0;
 394                         }
 395
 396                         if ( $exptime == 0 ) {
 397                                 $encExpiry = $this->getMaxDateTime( $db );
 398                         } else {
 399                                 $exptime = $this->convertExpiry( $exptime );
 400                                 $encExpiry = $db->timestamp( $exptime );
 401                         }
 402                         // (T26425) use a replace if the db supports it instead of
 403                         // delete/insert to avoid clashes with conflicting keynames
 404                         $db->update(
 405                                 $tableName,
 406                                 [
 407                                         'keyname' => $key,
 408                                         'value' => $db->encodeBlob( $this->serialize( $value ) ),
 409                                         'exptime' => $encExpiry
 410                                 ],
 411                                 [
 412                                         'keyname' => $key,
 413                                         'value' => $db->encodeBlob( $this->serialize( $casToken ) )
 414                                 ],
 415                                 __METHOD__
 416                         );
 417                 } catch ( DBQueryError $e ) {
 418                         $this->handleWriteError( $e, $db, $serverIndex );
 419
 420                         return false;
 421                 }
 422
 423                 return (bool)$db->affectedRows();
 424         }
 425
 426         public function delete( $key, $flags = 0 ) {
 427                 $ok = true;
 428
 429                 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
 430                 $db = null;
 431                 $silenceScope = $this->silenceTransactionProfiler();
 432                 try {
 433                         $db = $this->getDB( $serverIndex );
 434                         $db->delete(
 435                                 $tableName,
 436                                 [ 'keyname' => $key ],
 437                                 __METHOD__ );
 438                 } catch ( DBError $e ) {
 439                         $this->handleWriteError( $e, $db, $serverIndex );
 440                         $ok = false;
 441                 }
 442                 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
 443                         $ok = $this->waitForReplication() && $ok;
 444                 }
 445
 446                 return $ok;
 447         }
 448
 449         public function incr( $key, $step = 1 ) {
 450                 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
 451                 $db = null;
 452                 $silenceScope = $this->silenceTransactionProfiler();
 453                 try {
 454                         $db = $this->getDB( $serverIndex );
 455                         $step = intval( $step );
 456                         $row = $db->selectRow(
 457                                 $tableName,
 458                                 [ 'value', 'exptime' ],
 459                                 [ 'keyname' => $key ],
 460                                 __METHOD__,
 461                                 [ 'FOR UPDATE' ] );
 462                         if ( $row === false ) {
 463                                 // Missing
 464
 465                                 return null;
 466                         }
 467                         $db->delete( $tableName, [ 'keyname' => $key ], __METHOD__ );
 468                         if ( $this->isExpired( $db, $row->exptime ) ) {
 469                                 // Expired, do not reinsert
 470
 471                                 return null;
 472                         }
 473
 474                         $oldValue = intval( $this->unserialize( $db->decodeBlob( $row->value ) ) );
 475                         $newValue = $oldValue + $step;
 476                         $db->insert( $tableName,
 477                                 [
 478                                         'keyname' => $key,
 479                                         'value' => $db->encodeBlob( $this->serialize( $newValue ) ),
 480                                         'exptime' => $row->exptime
 481                                 ], __METHOD__, 'IGNORE' );
 482
 483                         if ( $db->affectedRows() == 0 ) {
 484                                 // Race condition. See T30611
 485                                 $newValue = null;
 486                         }
 487                 } catch ( DBError $e ) {
 488                         $this->handleWriteError( $e, $db, $serverIndex );
 489                         return null;
 490                 }
 491
 492                 return $newValue;
 493         }
 494
 495         public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
 496                 $ok = $this->mergeViaCas( $key, $callback, $exptime, $attempts, $flags );
 497                 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
 498                         $ok = $this->waitForReplication() && $ok;
 499                 }
 500
 501                 return $ok;
 502         }
 503
 504         public function changeTTL( $key, $expiry = 0, $flags = 0 ) {
 505                 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
 506                 $db = null;
 507                 $silenceScope = $this->silenceTransactionProfiler();
 508                 try {
 509                         $db = $this->getDB( $serverIndex );
 510                         $db->update(
 511                                 $tableName,
 512                                 [ 'exptime' => $db->timestamp( $this->convertExpiry( $expiry ) ) ],
 513                                 [ 'keyname' => $key, 'exptime > ' . $db->addQuotes( $db->timestamp( time() ) ) ],
 514                                 __METHOD__
 515                         );
 516                         if ( $db->affectedRows() == 0 ) {
 517                                 return false;
 518                         }
 519                 } catch ( DBError $e ) {
 520                         $this->handleWriteError( $e, $db, $serverIndex );
 521                         return false;
 522                 }
 523
 524                 return true;
 525         }
 526
 527         /**
 528          * @param IDatabase $db
 529          * @param string $exptime
 530          * @return bool
 531          */
 532         protected function isExpired( $db, $exptime ) {
 533                 return $exptime != $this->getMaxDateTime( $db ) && wfTimestamp( TS_UNIX, $exptime ) < time();
 534         }
 535
 536         /**
 537          * @param IDatabase $db
 538          * @return string
 539          */
 540         protected function getMaxDateTime( $db ) {
 541                 if ( time() > 0x7fffffff ) {
 542                         return $db->timestamp( 1 << 62 );
 543                 } else {
 544                         return $db->timestamp( 0x7fffffff );
 545                 }
 546         }
 547
 548         protected function garbageCollect() {
 549                 if ( !$this->purgePeriod || $this->replicaOnly ) {
 550                         // Disabled
 551                         return;
 552                 }
 553                 // Only purge on one in every $this->purgePeriod requests.
 554                 if ( $this->purgePeriod !== 1 && mt_rand( 0, $this->purgePeriod - 1 ) ) {
 555                         return;
 556                 }
 557                 $now = time();
 558                 // Avoid repeating the delete within a few seconds
 559                 if ( $now > ( $this->lastExpireAll + 1 ) ) {
 560                         $this->lastExpireAll = $now;
 561                         $this->expireAll();
 562                 }
 563         }
 564
 565         public function expireAll() {
 566                 $this->deleteObjectsExpiringBefore( wfTimestampNow() );
 567         }
 568
 569         /**
 570          * Delete objects from the database which expire before a certain date.
 571          * @param string $timestamp
 572          * @param bool|callable $progressCallback
 573          * @return bool
 574          */
 575         public function deleteObjectsExpiringBefore( $timestamp, $progressCallback = false ) {
 576                 $silenceScope = $this->silenceTransactionProfiler();
 577                 for ( $serverIndex = 0; $serverIndex < $this->numServers; $serverIndex++ ) {
 578                         $db = null;
 579                         try {
 580                                 $db = $this->getDB( $serverIndex );
 581                                 $dbTimestamp = $db->timestamp( $timestamp );
 582                                 $totalSeconds = false;
 583                                 $baseConds = [ 'exptime < ' . $db->addQuotes( $dbTimestamp ) ];
 584                                 for ( $i = 0; $i < $this->shards; $i++ ) {
 585                                         $maxExpTime = false;
 586                                         while ( true ) {
 587                                                 $conds = $baseConds;
 588                                                 if ( $maxExpTime !== false ) {
 589                                                         $conds[] = 'exptime >= ' . $db->addQuotes( $maxExpTime );
 590                                                 }
 591                                                 $rows = $db->select(
 592                                                         $this->getTableNameByShard( $i ),
 593                                                         [ 'keyname', 'exptime' ],
 594                                                         $conds,
 595                                                         __METHOD__,
 596                                                         [ 'LIMIT' => 100, 'ORDER BY' => 'exptime' ] );
 597                                                 if ( $rows === false || !$rows->numRows() ) {
 598                                                         break;
 599                                                 }
 600                                                 $keys = [];
 601                                                 $row = $rows->current();
 602                                                 $minExpTime = $row->exptime;
 603                                                 if ( $totalSeconds === false ) {
 604                                                         $totalSeconds = wfTimestamp( TS_UNIX, $timestamp )
 605                                                                 - wfTimestamp( TS_UNIX, $minExpTime );
 606                                                 }
 607                                                 foreach ( $rows as $row ) {
 608                                                         $keys[] = $row->keyname;
 609                                                         $maxExpTime = $row->exptime;
 610                                                 }
 611
 612                                                 $db->delete(
 613                                                         $this->getTableNameByShard( $i ),
 614                                                         [
 615                                                                 'exptime >= ' . $db->addQuotes( $minExpTime ),
 616                                                                 'exptime < ' . $db->addQuotes( $dbTimestamp ),
 617                                                                 'keyname' => $keys
 618                                                         ],
 619                                                         __METHOD__ );
 620
 621                                                 if ( $progressCallback ) {
 622                                                         if ( intval( $totalSeconds ) === 0 ) {
 623                                                                 $percent = 0;
 624                                                         } else {
 625                                                                 $remainingSeconds = wfTimestamp( TS_UNIX, $timestamp )
 626                                                                         - wfTimestamp( TS_UNIX, $maxExpTime );
 627                                                                 if ( $remainingSeconds > $totalSeconds ) {
 628                                                                         $totalSeconds = $remainingSeconds;
 629                                                                 }
 630                                                                 $processedSeconds = $totalSeconds - $remainingSeconds;
 631                                                                 $percent = ( $i + $processedSeconds / $totalSeconds )
 632                                                                         / $this->shards * 100;
 633                                                         }
 634                                                         $percent = ( $percent / $this->numServers )
 635                                                                 + ( $serverIndex / $this->numServers * 100 );
 636                                                         call_user_func( $progressCallback, $percent );
 637                                                 }
 638                                         }
 639                                 }
 640                         } catch ( DBError $e ) {
 641                                 $this->handleWriteError( $e, $db, $serverIndex );
 642                                 return false;
 643                         }
 644                 }
 645                 return true;
 646         }
 647
 648         /**
 649          * Delete content of shard tables in every server.
 650          * Return true if the operation is successful, false otherwise.
 651          * @return bool
 652          */
 653         public function deleteAll() {
 654                 $silenceScope = $this->silenceTransactionProfiler();
 655                 for ( $serverIndex = 0; $serverIndex < $this->numServers; $serverIndex++ ) {
 656                         $db = null;
 657                         try {
 658                                 $db = $this->getDB( $serverIndex );
 659                                 for ( $i = 0; $i < $this->shards; $i++ ) {
 660                                         $db->delete( $this->getTableNameByShard( $i ), '*', __METHOD__ );
 661                                 }
 662                         } catch ( DBError $e ) {
 663                                 $this->handleWriteError( $e, $db, $serverIndex );
 664                                 return false;
 665                         }
 666                 }
 667                 return true;
 668         }
 669
 670         /**
 671          * Serialize an object and, if possible, compress the representation.
 672          * On typical message and page data, this can provide a 3X decrease
 673          * in storage requirements.
 674          *
 675          * @param mixed &$data
 676          * @return string
 677          */
 678         protected function serialize( &$data ) {
 679                 $serial = serialize( $data );
 680
 681                 if ( function_exists( 'gzdeflate' ) ) {
 682                         return gzdeflate( $serial );
 683                 } else {
 684                         return $serial;
 685                 }
 686         }
 687
 688         /**
 689          * Unserialize and, if necessary, decompress an object.
 690          * @param string $serial
 691          * @return mixed
 692          */
 693         protected function unserialize( $serial ) {
 694                 if ( function_exists( 'gzinflate' ) ) {
 695                         Wikimedia\suppressWarnings();
 696                         $decomp = gzinflate( $serial );
 697                         Wikimedia\restoreWarnings();
 698
 699                         if ( $decomp !== false ) {
 700                                 $serial = $decomp;
 701                         }
 702                 }
 703
 704                 $ret = unserialize( $serial );
 705
 706                 return $ret;
 707         }
 708
 709         /**
 710          * Handle a DBError which occurred during a read operation.
 711          *
 712          * @param DBError $exception
 713          * @param int $serverIndex
 714          */
 715         protected function handleReadError( DBError $exception, $serverIndex ) {
 716                 if ( $exception instanceof DBConnectionError ) {
 717                         $this->markServerDown( $exception, $serverIndex );
 718                 }
 719
 720                 $this->setAndLogDBError( $exception );
 721         }
 722
 723         /**
 724          * Handle a DBQueryError which occurred during a write operation.
 725          *
 726          * @param DBError $exception
 727          * @param IDatabase|null $db DB handle or null if connection failed
 728          * @param int $serverIndex
 729          * @throws Exception
 730          */
 731         protected function handleWriteError( DBError $exception, IDatabase $db = null, $serverIndex ) {
 732                 if ( !$db ) {
 733                         $this->markServerDown( $exception, $serverIndex );
 734                 }
 735
 736                 $this->setAndLogDBError( $exception );
 737         }
 738
 739         /**
 740          * @param DBError $exception
 741          */
 742         private function setAndLogDBError( DBError $exception ) {
 743                 $this->logger->error( "DBError: {$exception->getMessage()}" );
 744                 if ( $exception instanceof DBConnectionError ) {
 745                         $this->setLastError( BagOStuff::ERR_UNREACHABLE );
 746                         $this->logger->debug( __METHOD__ . ": ignoring connection error" );
 747                 } else {
 748                         $this->setLastError( BagOStuff::ERR_UNEXPECTED );
 749                         $this->logger->debug( __METHOD__ . ": ignoring query error" );
 750                 }
 751         }
 752
 753         /**
 754          * Mark a server down due to a DBConnectionError exception
 755          *
 756          * @param DBError $exception
 757          * @param int $serverIndex
 758          */
 759         protected function markServerDown( DBError $exception, $serverIndex ) {
 760                 unset( $this->conns[$serverIndex] ); // bug T103435
 761
 762                 if ( isset( $this->connFailureTimes[$serverIndex] ) ) {
 763                         if ( time() - $this->connFailureTimes[$serverIndex] >= 60 ) {
 764                                 unset( $this->connFailureTimes[$serverIndex] );
 765                                 unset( $this->connFailureErrors[$serverIndex] );
 766                         } else {
 767                                 $this->logger->debug( __METHOD__ . ": Server #$serverIndex already down" );
 768                                 return;
 769                         }
 770                 }
 771                 $now = time();
 772                 $this->logger->info( __METHOD__ . ": Server #$serverIndex down until " . ( $now + 60 ) );
 773                 $this->connFailureTimes[$serverIndex] = $now;
 774                 $this->connFailureErrors[$serverIndex] = $exception;
 775         }
 776
 777         /**
 778          * Create shard tables. For use from eval.php.
 779          */
 780         public function createTables() {
 781                 for ( $serverIndex = 0; $serverIndex < $this->numServers; $serverIndex++ ) {
 782                         $db = $this->getDB( $serverIndex );
 783                         if ( $db->getType() !== 'mysql' ) {
 784                                 throw new MWException( __METHOD__ . ' is not supported on this DB server' );
 785                         }
 786
 787                         for ( $i = 0; $i < $this->shards; $i++ ) {
 788                                 $db->query(
 789                                         'CREATE TABLE ' . $db->tableName( $this->getTableNameByShard( $i ) ) .
 790                                         ' LIKE ' . $db->tableName( 'objectcache' ),
 791                                         __METHOD__ );
 792                         }
 793                 }
 794         }
 795
 796         /**
 797          * @return bool Whether the main DB is used, e.g. wfGetDB( DB_MASTER )
 798          */
 799         protected function usesMainDB() {
 800                 return !$this->serverInfos;
 801         }
 802
 803         protected function waitForReplication() {
 804                 if ( !$this->usesMainDB() ) {
 805                         // Custom DB server list; probably doesn't use replication
 806                         return true;
 807                 }
 808
 809                 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
 810                 if ( $lb->getServerCount() <= 1 ) {
 811                         return true; // no replica DBs
 812                 }
 813
 814                 // Main LB is used; wait for any replica DBs to catch up
 815                 try {
 816                         $masterPos = $lb->getMasterPos();
 817                         if ( !$masterPos ) {
 818                                 return true; // not applicable
 819                         }
 820
 821                         $loop = new WaitConditionLoop(
 822                                 function () use ( $lb, $masterPos ) {
 823                                         return $lb->waitForAll( $masterPos, 1 );
 824                                 },
 825                                 $this->syncTimeout,
 826                                 $this->busyCallbacks
 827                         );
 828
 829                         return ( $loop->invoke() === $loop::CONDITION_REACHED );
 830                 } catch ( DBError $e ) {
 831                         $this->setAndLogDBError( $e );
 832
 833                         return false;
 834                 }
 835         }
 836
 837         /**
 838          * Returns a ScopedCallback which resets the silence flag in the transaction profiler when it is
 839          * destroyed on the end of a scope, for example on return or throw
 840          * @return ScopedCallback
 841          * @since 1.32
 842          */
 843         protected function silenceTransactionProfiler() {
 844                 $trxProfiler = Profiler::instance()->getTransactionProfiler();
 845                 $oldSilenced = $trxProfiler->setSilenced( true );
 846                 return new ScopedCallback( function () use ( $trxProfiler, $oldSilenced ) {
 847                         $trxProfiler->setSilenced( $oldSilenced );
 848                 } );
 849         }
 850 }