Merge "Enable configuration to supply options for Special:Search form"
[lhc/web/wiklou.git] / includes / libs / rdbms / database / Database.php
1 <?php
2 /**
3 * @defgroup Database Database
4 *
5 * This file deals with database interface functions
6 * and query specifics/optimisations.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
22 *
23 * @file
24 * @ingroup Database
25 */
26 namespace Wikimedia\Rdbms;
27
28 use Psr\Log\LoggerAwareInterface;
29 use Psr\Log\LoggerInterface;
30 use Psr\Log\NullLogger;
31 use Wikimedia\ScopedCallback;
32 use Wikimedia\Timestamp\ConvertibleTimestamp;
33 use Wikimedia;
34 use BagOStuff;
35 use HashBagOStuff;
36 use LogicException;
37 use InvalidArgumentException;
38 use UnexpectedValueException;
39 use Exception;
40 use RuntimeException;
41
42 /**
43 * Relational database abstraction object
44 *
45 * @ingroup Database
46 * @since 1.28
47 */
48 abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAwareInterface {
49 /** Number of times to re-try an operation in case of deadlock */
50 const DEADLOCK_TRIES = 4;
51 /** Minimum time to wait before retry, in microseconds */
52 const DEADLOCK_DELAY_MIN = 500000;
53 /** Maximum time to wait before retry */
54 const DEADLOCK_DELAY_MAX = 1500000;
55
56 /** How long before it is worth doing a dummy query to test the connection */
57 const PING_TTL = 1.0;
58 const PING_QUERY = 'SELECT 1 AS ping';
59
60 const TINY_WRITE_SEC = 0.010;
61 const SLOW_WRITE_SEC = 0.500;
62 const SMALL_WRITE_ROWS = 100;
63
64 /** @var string Lock granularity is on the level of the entire database */
65 const ATTR_DB_LEVEL_LOCKING = 'db-level-locking';
66 /** @var string The SCHEMA keyword refers to a grouping of tables in a database */
67 const ATTR_SCHEMAS_AS_TABLE_GROUPS = 'supports-schemas';
68
69 /** @var int New Database instance will not be connected yet when returned */
70 const NEW_UNCONNECTED = 0;
71 /** @var int New Database instance will already be connected when returned */
72 const NEW_CONNECTED = 1;
73
74 /** @var string The last SQL query attempted */
75 private $lastQuery = '';
76 /** @var float|bool UNIX timestamp of last write query */
77 private $lastWriteTime = false;
78 /** @var string|bool */
79 private $lastPhpError = false;
80
81 /** @var string Server that this instance is currently connected to */
82 protected $server;
83 /** @var string User that this instance is currently connected under the name of */
84 protected $user;
85 /** @var string Password used to establish the current connection */
86 protected $password;
87 /** @var array[] Map of (table => (dbname, schema, prefix) map) */
88 protected $tableAliases = [];
89 /** @var string[] Map of (index alias => index) */
90 protected $indexAliases = [];
91 /** @var bool Whether this PHP instance is for a CLI script */
92 protected $cliMode;
93 /** @var string Agent name for query profiling */
94 protected $agent;
95 /** @var array Parameters used by initConnection() to establish a connection */
96 protected $connectionParams = [];
97 /** @var BagOStuff APC cache */
98 protected $srvCache;
99 /** @var LoggerInterface */
100 protected $connLogger;
101 /** @var LoggerInterface */
102 protected $queryLogger;
103 /** @var callable Error logging callback */
104 protected $errorLogger;
105 /** @var callable Deprecation logging callback */
106 protected $deprecationLogger;
107
108 /** @var object|resource|null Database connection */
109 protected $conn = null;
110 /** @var bool */
111 protected $opened = false;
112
113 /** @var array[] List of (callable, method name, atomic section id) */
114 protected $trxIdleCallbacks = [];
115 /** @var array[] List of (callable, method name, atomic section id) */
116 protected $trxPreCommitCallbacks = [];
117 /** @var array[] List of (callable, method name, atomic section id) */
118 protected $trxEndCallbacks = [];
119 /** @var callable[] Map of (name => callable) */
120 protected $trxRecurringCallbacks = [];
121 /** @var bool Whether to suppress triggering of transaction end callbacks */
122 protected $trxEndCallbacksSuppressed = false;
123
124 /** @var int */
125 protected $flags;
126 /** @var array */
127 protected $lbInfo = [];
128 /** @var array|bool */
129 protected $schemaVars = false;
130 /** @var array */
131 protected $sessionVars = [];
132 /** @var array|null */
133 protected $preparedArgs;
134 /** @var string|bool|null Stashed value of html_errors INI setting */
135 protected $htmlErrors;
136 /** @var string */
137 protected $delimiter = ';';
138 /** @var DatabaseDomain */
139 protected $currentDomain;
140 /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
141 protected $affectedRowCount;
142
143 /**
144 * @var int Transaction status
145 */
146 protected $trxStatus = self::STATUS_TRX_NONE;
147 /**
148 * @var Exception|null The last error that caused the status to become STATUS_TRX_ERROR
149 */
150 protected $trxStatusCause;
151 /**
152 * @var array|null If wasKnownStatementRollbackError() prevented trxStatus from being set,
153 * the relevant details are stored here.
154 */
155 protected $trxStatusIgnoredCause;
156 /**
157 * Either 1 if a transaction is active or 0 otherwise.
158 * The other Trx fields may not be meaningfull if this is 0.
159 *
160 * @var int
161 */
162 protected $trxLevel = 0;
163 /**
164 * Either a short hexidecimal string if a transaction is active or ""
165 *
166 * @var string
167 * @see Database::trxLevel
168 */
169 protected $trxShortId = '';
170 /**
171 * The UNIX time that the transaction started. Callers can assume that if
172 * snapshot isolation is used, then the data is *at least* up to date to that
173 * point (possibly more up-to-date since the first SELECT defines the snapshot).
174 *
175 * @var float|null
176 * @see Database::trxLevel
177 */
178 private $trxTimestamp = null;
179 /** @var float Lag estimate at the time of BEGIN */
180 private $trxReplicaLag = null;
181 /**
182 * Remembers the function name given for starting the most recent transaction via begin().
183 * Used to provide additional context for error reporting.
184 *
185 * @var string
186 * @see Database::trxLevel
187 */
188 private $trxFname = null;
189 /**
190 * Record if possible write queries were done in the last transaction started
191 *
192 * @var bool
193 * @see Database::trxLevel
194 */
195 private $trxDoneWrites = false;
196 /**
197 * Record if the current transaction was started implicitly due to DBO_TRX being set.
198 *
199 * @var bool
200 * @see Database::trxLevel
201 */
202 private $trxAutomatic = false;
203 /**
204 * Counter for atomic savepoint identifiers. Reset when a new transaction begins.
205 *
206 * @var int
207 */
208 private $trxAtomicCounter = 0;
209 /**
210 * Array of levels of atomicity within transactions
211 *
212 * @var array List of (name, unique ID, savepoint ID)
213 */
214 private $trxAtomicLevels = [];
215 /**
216 * Record if the current transaction was started implicitly by Database::startAtomic
217 *
218 * @var bool
219 */
220 private $trxAutomaticAtomic = false;
221 /**
222 * Track the write query callers of the current transaction
223 *
224 * @var string[]
225 */
226 private $trxWriteCallers = [];
227 /**
228 * @var float Seconds spent in write queries for the current transaction
229 */
230 private $trxWriteDuration = 0.0;
231 /**
232 * @var int Number of write queries for the current transaction
233 */
234 private $trxWriteQueryCount = 0;
235 /**
236 * @var int Number of rows affected by write queries for the current transaction
237 */
238 private $trxWriteAffectedRows = 0;
239 /**
240 * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
241 */
242 private $trxWriteAdjDuration = 0.0;
243 /**
244 * @var int Number of write queries counted in trxWriteAdjDuration
245 */
246 private $trxWriteAdjQueryCount = 0;
247 /**
248 * @var float RTT time estimate
249 */
250 private $rttEstimate = 0.0;
251
252 /** @var array Map of (name => 1) for locks obtained via lock() */
253 private $namedLocksHeld = [];
254 /** @var array Map of (table name => 1) for TEMPORARY tables */
255 protected $sessionTempTables = [];
256
257 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
258 private $lazyMasterHandle;
259
260 /** @var float UNIX timestamp */
261 protected $lastPing = 0.0;
262
263 /** @var int[] Prior flags member variable values */
264 private $priorFlags = [];
265
266 /** @var callable|null */
267 protected $profiler;
268 /** @var TransactionProfiler */
269 protected $trxProfiler;
270
271 /** @var int */
272 protected $nonNativeInsertSelectBatchSize = 10000;
273
274 /** @var string Idiom used when a cancelable atomic section started the transaction */
275 private static $NOT_APPLICABLE = 'n/a';
276 /** @var string Prefix to the atomic section counter used to make savepoint IDs */
277 private static $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic';
278
279 /** @var int Transaction is in a error state requiring a full or savepoint rollback */
280 const STATUS_TRX_ERROR = 1;
281 /** @var int Transaction is active and in a normal state */
282 const STATUS_TRX_OK = 2;
283 /** @var int No transaction is active */
284 const STATUS_TRX_NONE = 3;
285
286 /** @var int Writes to this temporary table do not affect lastDoneWrites() */
287 const TEMP_NORMAL = 1;
288 /** @var int Writes to this temporary table effect lastDoneWrites() */
289 const TEMP_PSEUDO_PERMANENT = 2;
290
291 /**
292 * @note exceptions for missing libraries/drivers should be thrown in initConnection()
293 * @param array $params Parameters passed from Database::factory()
294 */
295 protected function __construct( array $params ) {
296 foreach ( [ 'host', 'user', 'password', 'dbname', 'schema', 'tablePrefix' ] as $name ) {
297 $this->connectionParams[$name] = $params[$name];
298 }
299
300 $this->cliMode = $params['cliMode'];
301 // Agent name is added to SQL queries in a comment, so make sure it can't break out
302 $this->agent = str_replace( '/', '-', $params['agent'] );
303
304 $this->flags = $params['flags'];
305 if ( $this->flags & self::DBO_DEFAULT ) {
306 if ( $this->cliMode ) {
307 $this->flags &= ~self::DBO_TRX;
308 } else {
309 $this->flags |= self::DBO_TRX;
310 }
311 }
312 // Disregard deprecated DBO_IGNORE flag (T189999)
313 $this->flags &= ~self::DBO_IGNORE;
314
315 $this->sessionVars = $params['variables'];
316
317 $this->srvCache = $params['srvCache'] ?? new HashBagOStuff();
318
319 $this->profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null;
320 $this->trxProfiler = $params['trxProfiler'];
321 $this->connLogger = $params['connLogger'];
322 $this->queryLogger = $params['queryLogger'];
323 $this->errorLogger = $params['errorLogger'];
324 $this->deprecationLogger = $params['deprecationLogger'];
325
326 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
327 $this->nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'];
328 }
329
330 // Set initial dummy domain until open() sets the final DB/prefix
331 $this->currentDomain = new DatabaseDomain(
332 $params['dbname'] != '' ? $params['dbname'] : null,
333 $params['schema'] != '' ? $params['schema'] : null,
334 $params['tablePrefix']
335 );
336 }
337
338 /**
339 * Initialize the connection to the database over the wire (or to local files)
340 *
341 * @throws LogicException
342 * @throws InvalidArgumentException
343 * @throws DBConnectionError
344 * @since 1.31
345 */
346 final public function initConnection() {
347 if ( $this->isOpen() ) {
348 throw new LogicException( __METHOD__ . ': already connected.' );
349 }
350 // Establish the connection
351 $this->doInitConnection();
352 }
353
354 /**
355 * Actually connect to the database over the wire (or to local files)
356 *
357 * @throws InvalidArgumentException
358 * @throws DBConnectionError
359 * @since 1.31
360 */
361 protected function doInitConnection() {
362 if ( strlen( $this->connectionParams['user'] ) ) {
363 $this->open(
364 $this->connectionParams['host'],
365 $this->connectionParams['user'],
366 $this->connectionParams['password'],
367 $this->connectionParams['dbname'],
368 $this->connectionParams['schema'],
369 $this->connectionParams['tablePrefix']
370 );
371 } else {
372 throw new InvalidArgumentException( "No database user provided." );
373 }
374 }
375
376 /**
377 * Open a new connection to the database (closing any existing one)
378 *
379 * @param string $server Database server host
380 * @param string $user Database user name
381 * @param string $password Database user password
382 * @param string $dbName Database name
383 * @param string|null $schema Database schema name
384 * @param string $tablePrefix Table prefix
385 * @return bool
386 * @throws DBConnectionError
387 */
388 abstract protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix );
389
390 /**
391 * Construct a Database subclass instance given a database type and parameters
392 *
393 * This also connects to the database immediately upon object construction
394 *
395 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
396 * @param array $p Parameter map with keys:
397 * - host : The hostname of the DB server
398 * - user : The name of the database user the client operates under
399 * - password : The password for the database user
400 * - dbname : The name of the database to use where queries do not specify one.
401 * The database must exist or an error might be thrown. Setting this to the empty string
402 * will avoid any such errors and make the handle have no implicit database scope. This is
403 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
404 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
405 * in which user names and such are defined, e.g. users are database-specific in Postgres.
406 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
407 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
408 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
409 * recognized in queries. This can be used in place of schemas for handle site farms.
410 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
411 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
412 * flag in place UNLESS this this database simply acts as a key/value store.
413 * - driver: Optional name of a specific DB client driver. For MySQL, there is only the
414 * 'mysqli' driver; the old one 'mysql' has been removed.
415 * - variables: Optional map of session variables to set after connecting. This can be
416 * used to adjust lock timeouts or encoding modes and the like.
417 * - connLogger: Optional PSR-3 logger interface instance.
418 * - queryLogger: Optional PSR-3 logger interface instance.
419 * - profiler : Optional callback that takes a section name argument and returns
420 * a ScopedCallback instance that ends the profile section in its destructor.
421 * These will be called in query(), using a simplified version of the SQL that
422 * also includes the agent as a SQL comment.
423 * - trxProfiler: Optional TransactionProfiler instance.
424 * - errorLogger: Optional callback that takes an Exception and logs it.
425 * - deprecationLogger: Optional callback that takes a string and logs it.
426 * - cliMode: Whether to consider the execution context that of a CLI script.
427 * - agent: Optional name used to identify the end-user in query profiling/logging.
428 * - srvCache: Optional BagOStuff instance to an APC-style cache.
429 * - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
430 * @param int $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
431 * @return Database|null If the database driver or extension cannot be found
432 * @throws InvalidArgumentException If the database driver or extension cannot be found
433 * @since 1.18
434 */
435 final public static function factory( $dbType, $p = [], $connect = self::NEW_CONNECTED ) {
436 $class = self::getClass( $dbType, $p['driver'] ?? null );
437
438 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase::class ) ) {
439 // Resolve some defaults for b/c
440 $p['host'] = $p['host'] ?? false;
441 $p['user'] = $p['user'] ?? false;
442 $p['password'] = $p['password'] ?? false;
443 $p['dbname'] = $p['dbname'] ?? false;
444 $p['flags'] = $p['flags'] ?? 0;
445 $p['variables'] = $p['variables'] ?? [];
446 $p['tablePrefix'] = $p['tablePrefix'] ?? '';
447 $p['schema'] = $p['schema'] ?? null;
448 $p['cliMode'] = $p['cliMode'] ?? ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' );
449 $p['agent'] = $p['agent'] ?? '';
450 if ( !isset( $p['connLogger'] ) ) {
451 $p['connLogger'] = new NullLogger();
452 }
453 if ( !isset( $p['queryLogger'] ) ) {
454 $p['queryLogger'] = new NullLogger();
455 }
456 $p['profiler'] = $p['profiler'] ?? null;
457 if ( !isset( $p['trxProfiler'] ) ) {
458 $p['trxProfiler'] = new TransactionProfiler();
459 }
460 if ( !isset( $p['errorLogger'] ) ) {
461 $p['errorLogger'] = function ( Exception $e ) {
462 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING );
463 };
464 }
465 if ( !isset( $p['deprecationLogger'] ) ) {
466 $p['deprecationLogger'] = function ( $msg ) {
467 trigger_error( $msg, E_USER_DEPRECATED );
468 };
469 }
470
471 /** @var Database $conn */
472 $conn = new $class( $p );
473 if ( $connect == self::NEW_CONNECTED ) {
474 $conn->initConnection();
475 }
476 } else {
477 $conn = null;
478 }
479
480 return $conn;
481 }
482
483 /**
484 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
485 * @param string|null $driver Optional name of a specific DB client driver
486 * @return array Map of (Database::ATTR_* constant => value) for all such constants
487 * @throws InvalidArgumentException
488 * @since 1.31
489 */
490 final public static function attributesFromType( $dbType, $driver = null ) {
491 static $defaults = [
492 self::ATTR_DB_LEVEL_LOCKING => false,
493 self::ATTR_SCHEMAS_AS_TABLE_GROUPS => false
494 ];
495
496 $class = self::getClass( $dbType, $driver );
497
498 return call_user_func( [ $class, 'getAttributes' ] ) + $defaults;
499 }
500
501 /**
502 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
503 * @param string|null $driver Optional name of a specific DB client driver
504 * @return string Database subclass name to use
505 * @throws InvalidArgumentException
506 */
507 private static function getClass( $dbType, $driver = null ) {
508 // For database types with built-in support, the below maps type to IDatabase
509 // implementations. For types with multipe driver implementations (PHP extensions),
510 // an array can be used, keyed by extension name. In case of an array, the
511 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
512 // we auto-detect the first available driver. For types without built-in support,
513 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
514 static $builtinTypes = [
515 'mssql' => DatabaseMssql::class,
516 'mysql' => [ 'mysqli' => DatabaseMysqli::class ],
517 'sqlite' => DatabaseSqlite::class,
518 'postgres' => DatabasePostgres::class,
519 ];
520
521 $dbType = strtolower( $dbType );
522 $class = false;
523
524 if ( isset( $builtinTypes[$dbType] ) ) {
525 $possibleDrivers = $builtinTypes[$dbType];
526 if ( is_string( $possibleDrivers ) ) {
527 $class = $possibleDrivers;
528 } elseif ( (string)$driver !== '' ) {
529 if ( !isset( $possibleDrivers[$driver] ) ) {
530 throw new InvalidArgumentException( __METHOD__ .
531 " type '$dbType' does not support driver '{$driver}'" );
532 }
533
534 $class = $possibleDrivers[$driver];
535 } else {
536 foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
537 if ( extension_loaded( $posDriver ) ) {
538 $class = $possibleClass;
539 break;
540 }
541 }
542 }
543 } else {
544 $class = 'Database' . ucfirst( $dbType );
545 }
546
547 if ( $class === false ) {
548 throw new InvalidArgumentException( __METHOD__ .
549 " no viable database extension found for type '$dbType'" );
550 }
551
552 return $class;
553 }
554
555 /**
556 * @return array Map of (Database::ATTR_* constant => value
557 * @since 1.31
558 */
559 protected static function getAttributes() {
560 return [];
561 }
562
563 /**
564 * Set the PSR-3 logger interface to use for query logging. (The logger
565 * interfaces for connection logging and error logging can be set with the
566 * constructor.)
567 *
568 * @param LoggerInterface $logger
569 */
570 public function setLogger( LoggerInterface $logger ) {
571 $this->queryLogger = $logger;
572 }
573
574 public function getServerInfo() {
575 return $this->getServerVersion();
576 }
577
578 public function bufferResults( $buffer = null ) {
579 $res = !$this->getFlag( self::DBO_NOBUFFER );
580 if ( $buffer !== null ) {
581 $buffer
582 ? $this->clearFlag( self::DBO_NOBUFFER )
583 : $this->setFlag( self::DBO_NOBUFFER );
584 }
585
586 return $res;
587 }
588
589 public function trxLevel() {
590 return $this->trxLevel;
591 }
592
593 public function trxTimestamp() {
594 return $this->trxLevel ? $this->trxTimestamp : null;
595 }
596
597 /**
598 * @return int One of the STATUS_TRX_* class constants
599 * @since 1.31
600 */
601 public function trxStatus() {
602 return $this->trxStatus;
603 }
604
605 public function tablePrefix( $prefix = null ) {
606 $old = $this->currentDomain->getTablePrefix();
607 if ( $prefix !== null ) {
608 $this->currentDomain = new DatabaseDomain(
609 $this->currentDomain->getDatabase(),
610 $this->currentDomain->getSchema(),
611 $prefix
612 );
613 }
614
615 return $old;
616 }
617
618 public function dbSchema( $schema = null ) {
619 if ( strlen( $schema ) && $this->getDBname() === null ) {
620 throw new DBUnexpectedError( $this, "Cannot set schema to '$schema'; no database set." );
621 }
622
623 $old = $this->currentDomain->getSchema();
624 if ( $schema !== null ) {
625 $this->currentDomain = new DatabaseDomain(
626 $this->currentDomain->getDatabase(),
627 // DatabaseDomain uses null for unspecified schemas
628 strlen( $schema ) ? $schema : null,
629 $this->currentDomain->getTablePrefix()
630 );
631 }
632
633 return (string)$old;
634 }
635
636 /**
637 * @return string Schema to use to qualify relations in queries
638 */
639 protected function relationSchemaQualifier() {
640 return $this->dbSchema();
641 }
642
643 public function getLBInfo( $name = null ) {
644 if ( is_null( $name ) ) {
645 return $this->lbInfo;
646 }
647
648 if ( array_key_exists( $name, $this->lbInfo ) ) {
649 return $this->lbInfo[$name];
650 }
651
652 return null;
653 }
654
655 public function setLBInfo( $name, $value = null ) {
656 if ( is_null( $value ) ) {
657 $this->lbInfo = $name;
658 } else {
659 $this->lbInfo[$name] = $value;
660 }
661 }
662
663 public function setLazyMasterHandle( IDatabase $conn ) {
664 $this->lazyMasterHandle = $conn;
665 }
666
667 /**
668 * @return IDatabase|null
669 * @see setLazyMasterHandle()
670 * @since 1.27
671 */
672 protected function getLazyMasterHandle() {
673 return $this->lazyMasterHandle;
674 }
675
676 public function implicitGroupby() {
677 return true;
678 }
679
680 public function implicitOrderby() {
681 return true;
682 }
683
684 public function lastQuery() {
685 return $this->lastQuery;
686 }
687
688 public function doneWrites() {
689 return (bool)$this->lastWriteTime;
690 }
691
692 public function lastDoneWrites() {
693 return $this->lastWriteTime ?: false;
694 }
695
696 public function writesPending() {
697 return $this->trxLevel && $this->trxDoneWrites;
698 }
699
700 public function writesOrCallbacksPending() {
701 return $this->trxLevel && (
702 $this->trxDoneWrites ||
703 $this->trxIdleCallbacks ||
704 $this->trxPreCommitCallbacks ||
705 $this->trxEndCallbacks
706 );
707 }
708
709 public function preCommitCallbacksPending() {
710 return $this->trxLevel && $this->trxPreCommitCallbacks;
711 }
712
713 /**
714 * @return string|null
715 */
716 final protected function getTransactionRoundId() {
717 // If transaction round participation is enabled, see if one is active
718 if ( $this->getFlag( self::DBO_TRX ) ) {
719 $id = $this->getLBInfo( 'trxRoundId' );
720
721 return is_string( $id ) ? $id : null;
722 }
723
724 return null;
725 }
726
727 public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
728 if ( !$this->trxLevel ) {
729 return false;
730 } elseif ( !$this->trxDoneWrites ) {
731 return 0.0;
732 }
733
734 switch ( $type ) {
735 case self::ESTIMATE_DB_APPLY:
736 return $this->pingAndCalculateLastTrxApplyTime();
737 default: // everything
738 return $this->trxWriteDuration;
739 }
740 }
741
742 /**
743 * @return float Time to apply writes to replicas based on trxWrite* fields
744 */
745 private function pingAndCalculateLastTrxApplyTime() {
746 $this->ping( $rtt );
747
748 $rttAdjTotal = $this->trxWriteAdjQueryCount * $rtt;
749 $applyTime = max( $this->trxWriteAdjDuration - $rttAdjTotal, 0 );
750 // For omitted queries, make them count as something at least
751 $omitted = $this->trxWriteQueryCount - $this->trxWriteAdjQueryCount;
752 $applyTime += self::TINY_WRITE_SEC * $omitted;
753
754 return $applyTime;
755 }
756
757 public function pendingWriteCallers() {
758 return $this->trxLevel ? $this->trxWriteCallers : [];
759 }
760
761 public function pendingWriteRowsAffected() {
762 return $this->trxWriteAffectedRows;
763 }
764
765 /**
766 * List the methods that have write queries or callbacks for the current transaction
767 *
768 * This method should not be used outside of Database/LoadBalancer
769 *
770 * @return string[]
771 * @since 1.32
772 */
773 public function pendingWriteAndCallbackCallers() {
774 $fnames = $this->pendingWriteCallers();
775 foreach ( [
776 $this->trxIdleCallbacks,
777 $this->trxPreCommitCallbacks,
778 $this->trxEndCallbacks
779 ] as $callbacks ) {
780 foreach ( $callbacks as $callback ) {
781 $fnames[] = $callback[1];
782 }
783 }
784
785 return $fnames;
786 }
787
788 /**
789 * @return string
790 */
791 private function flatAtomicSectionList() {
792 return array_reduce( $this->trxAtomicLevels, function ( $accum, $v ) {
793 return $accum === null ? $v[0] : "$accum, " . $v[0];
794 } );
795 }
796
797 public function isOpen() {
798 return $this->opened;
799 }
800
801 public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
802 if ( ( $flag & self::DBO_IGNORE ) ) {
803 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
804 }
805
806 if ( $remember === self::REMEMBER_PRIOR ) {
807 array_push( $this->priorFlags, $this->flags );
808 }
809 $this->flags |= $flag;
810 }
811
812 public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
813 if ( ( $flag & self::DBO_IGNORE ) ) {
814 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
815 }
816
817 if ( $remember === self::REMEMBER_PRIOR ) {
818 array_push( $this->priorFlags, $this->flags );
819 }
820 $this->flags &= ~$flag;
821 }
822
823 public function restoreFlags( $state = self::RESTORE_PRIOR ) {
824 if ( !$this->priorFlags ) {
825 return;
826 }
827
828 if ( $state === self::RESTORE_INITIAL ) {
829 $this->flags = reset( $this->priorFlags );
830 $this->priorFlags = [];
831 } else {
832 $this->flags = array_pop( $this->priorFlags );
833 }
834 }
835
836 public function getFlag( $flag ) {
837 return (bool)( $this->flags & $flag );
838 }
839
840 /**
841 * @param string $name Class field name
842 * @return mixed
843 * @deprecated Since 1.28
844 */
845 public function getProperty( $name ) {
846 return $this->$name;
847 }
848
849 public function getDomainID() {
850 return $this->currentDomain->getId();
851 }
852
853 final public function getWikiID() {
854 return $this->getDomainID();
855 }
856
857 /**
858 * Get information about an index into an object
859 * @param string $table Table name
860 * @param string $index Index name
861 * @param string $fname Calling function name
862 * @return mixed Database-specific index description class or false if the index does not exist
863 */
864 abstract function indexInfo( $table, $index, $fname = __METHOD__ );
865
866 /**
867 * Wrapper for addslashes()
868 *
869 * @param string $s String to be slashed.
870 * @return string Slashed string.
871 */
872 abstract function strencode( $s );
873
874 /**
875 * Set a custom error handler for logging errors during database connection
876 */
877 protected function installErrorHandler() {
878 $this->lastPhpError = false;
879 $this->htmlErrors = ini_set( 'html_errors', '0' );
880 set_error_handler( [ $this, 'connectionErrorLogger' ] );
881 }
882
883 /**
884 * Restore the previous error handler and return the last PHP error for this DB
885 *
886 * @return bool|string
887 */
888 protected function restoreErrorHandler() {
889 restore_error_handler();
890 if ( $this->htmlErrors !== false ) {
891 ini_set( 'html_errors', $this->htmlErrors );
892 }
893
894 return $this->getLastPHPError();
895 }
896
897 /**
898 * @return string|bool Last PHP error for this DB (typically connection errors)
899 */
900 protected function getLastPHPError() {
901 if ( $this->lastPhpError ) {
902 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->lastPhpError );
903 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
904
905 return $error;
906 }
907
908 return false;
909 }
910
911 /**
912 * Error handler for logging errors during database connection
913 * This method should not be used outside of Database classes
914 *
915 * @param int $errno
916 * @param string $errstr
917 */
918 public function connectionErrorLogger( $errno, $errstr ) {
919 $this->lastPhpError = $errstr;
920 }
921
922 /**
923 * Create a log context to pass to PSR-3 logger functions.
924 *
925 * @param array $extras Additional data to add to context
926 * @return array
927 */
928 protected function getLogContext( array $extras = [] ) {
929 return array_merge(
930 [
931 'db_server' => $this->server,
932 'db_name' => $this->getDBname(),
933 'db_user' => $this->user,
934 ],
935 $extras
936 );
937 }
938
939 final public function close() {
940 $exception = null; // error to throw after disconnecting
941
942 $wasOpen = $this->opened;
943 // This should mostly do nothing if the connection is already closed
944 if ( $this->conn ) {
945 // Roll back any dangling transaction first
946 if ( $this->trxLevel ) {
947 if ( $this->trxAtomicLevels ) {
948 // Cannot let incomplete atomic sections be committed
949 $levels = $this->flatAtomicSectionList();
950 $exception = new DBUnexpectedError(
951 $this,
952 __METHOD__ . ": atomic sections $levels are still open."
953 );
954 } elseif ( $this->trxAutomatic ) {
955 // Only the connection manager can commit non-empty DBO_TRX transactions
956 // (empty ones we can silently roll back)
957 if ( $this->writesOrCallbacksPending() ) {
958 $exception = new DBUnexpectedError(
959 $this,
960 __METHOD__ .
961 ": mass commit/rollback of peer transaction required (DBO_TRX set)."
962 );
963 }
964 } else {
965 // Manual transactions should have been committed or rolled
966 // back, even if empty.
967 $exception = new DBUnexpectedError(
968 $this,
969 __METHOD__ . ": transaction is still open (from {$this->trxFname})."
970 );
971 }
972
973 if ( $this->trxEndCallbacksSuppressed ) {
974 $exception = $exception ?: new DBUnexpectedError(
975 $this,
976 __METHOD__ . ': callbacks are suppressed; cannot properly commit.'
977 );
978 }
979
980 // Rollback the changes and run any callbacks as needed
981 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
982 }
983
984 // Close the actual connection in the binding handle
985 $closed = $this->closeConnection();
986 } else {
987 $closed = true; // already closed; nothing to do
988 }
989
990 $this->conn = false;
991 $this->opened = false;
992
993 // Throw any unexpected errors after having disconnected
994 if ( $exception instanceof Exception ) {
995 throw $exception;
996 }
997
998 // Note that various subclasses call close() at the start of open(), which itself is
999 // called by replaceLostConnection(). In that case, just because onTransactionResolution()
1000 // callbacks are pending does not mean that an exception should be thrown. Rather, they
1001 // will be executed after the reconnection step.
1002 if ( $wasOpen ) {
1003 // Sanity check that no callbacks are dangling
1004 $fnames = $this->pendingWriteAndCallbackCallers();
1005 if ( $fnames ) {
1006 throw new RuntimeException(
1007 "Transaction callbacks are still pending:\n" . implode( ', ', $fnames )
1008 );
1009 }
1010 }
1011
1012 return $closed;
1013 }
1014
1015 /**
1016 * Make sure there is an open connection handle (alive or not) as a sanity check
1017 *
1018 * This guards against fatal errors to the binding handle not being defined
1019 * in cases where open() was never called or close() was already called
1020 *
1021 * @throws DBUnexpectedError
1022 */
1023 protected function assertHasConnectionHandle() {
1024 if ( !$this->isOpen() ) {
1025 throw new DBUnexpectedError( $this, "DB connection was already closed." );
1026 }
1027 }
1028
1029 /**
1030 * Make sure that this server is not marked as a replica nor read-only as a sanity check
1031 *
1032 * @throws DBUnexpectedError
1033 */
1034 protected function assertIsWritableMaster() {
1035 if ( $this->getLBInfo( 'replica' ) === true ) {
1036 throw new DBReadOnlyRoleError(
1037 $this,
1038 'Write operations are not allowed on replica database connections.'
1039 );
1040 }
1041 $reason = $this->getReadOnlyReason();
1042 if ( $reason !== false ) {
1043 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
1044 }
1045 }
1046
1047 /**
1048 * Closes underlying database connection
1049 * @since 1.20
1050 * @return bool Whether connection was closed successfully
1051 */
1052 abstract protected function closeConnection();
1053
1054 /**
1055 * @deprecated since 1.32
1056 * @param string $error Fallback message, if none is given by DB
1057 * @throws DBConnectionError
1058 */
1059 public function reportConnectionError( $error = 'Unknown error' ) {
1060 call_user_func( $this->deprecationLogger, 'Use of ' . __METHOD__ . ' is deprecated.' );
1061 throw new DBConnectionError( $this, $this->lastError() ?: $error );
1062 }
1063
1064 /**
1065 * Run a query and return a DBMS-dependent wrapper or boolean
1066 *
1067 * For SELECT queries, this returns either:
1068 * - a) A driver-specific value/resource, only on success. This can be iterated
1069 * over by calling fetchObject()/fetchRow() until there are no more rows.
1070 * Alternatively, the result can be passed to resultObject() to obtain a
1071 * ResultWrapper instance which can then be iterated over via "foreach".
1072 * - b) False, on any query failure
1073 *
1074 * For non-SELECT queries, this returns either:
1075 * - a) A driver-specific value/resource, only on success
1076 * - b) True, only on success (e.g. no meaningful result other than "OK")
1077 * - c) False, on any query failure
1078 *
1079 * @param string $sql SQL query
1080 * @return mixed|bool An object, resource, or true on success; false on failure
1081 */
1082 abstract protected function doQuery( $sql );
1083
1084 /**
1085 * Determine whether a query writes to the DB. When in doubt, this returns true.
1086 *
1087 * Main use cases:
1088 *
1089 * - Subsequent web requests should not need to wait for replication from
1090 * the master position seen by this web request, unless this request made
1091 * changes to the master. This is handled by ChronologyProtector by checking
1092 * doneWrites() at the end of the request. doneWrites() returns true if any
1093 * query set lastWriteTime; which query() does based on isWriteQuery().
1094 *
1095 * - Reject write queries to replica DBs, in query().
1096 *
1097 * @param string $sql
1098 * @return bool
1099 */
1100 protected function isWriteQuery( $sql ) {
1101 // BEGIN and COMMIT queries are considered read queries here.
1102 // Database backends and drivers (MySQL, MariaDB, php-mysqli) generally
1103 // treat these as write queries, in that their results have "affected rows"
1104 // as meta data as from writes, instead of "num rows" as from reads.
1105 // But, we treat them as read queries because when reading data (from
1106 // either replica or master) we use transactions to enable repeatable-read
1107 // snapshots, which ensures we get consistent results from the same snapshot
1108 // for all queries within a request. Use cases:
1109 // - Treating these as writes would trigger ChronologyProtector (see method doc).
1110 // - We use this method to reject writes to replicas, but we need to allow
1111 // use of transactions on replicas for read snapshots. This fine given
1112 // that transactions by themselves don't make changes, only actual writes
1113 // within the transaction matter, which we still detect.
1114 return !preg_match(
1115 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SAVEPOINT|RELEASE|SET|SHOW|EXPLAIN|\(SELECT)\b/i',
1116 $sql
1117 );
1118 }
1119
1120 /**
1121 * @param string $sql
1122 * @return string|null
1123 */
1124 protected function getQueryVerb( $sql ) {
1125 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ? strtoupper( $m[1] ) : null;
1126 }
1127
1128 /**
1129 * Determine whether a SQL statement is sensitive to isolation level.
1130 *
1131 * A SQL statement is considered transactable if its result could vary
1132 * depending on the transaction isolation level. Operational commands
1133 * such as 'SET' and 'SHOW' are not considered to be transactable.
1134 *
1135 * Main purpose: Used by query() to decide whether to begin a transaction
1136 * before the current query (in DBO_TRX mode, on by default).
1137 *
1138 * @param string $sql
1139 * @return bool
1140 */
1141 protected function isTransactableQuery( $sql ) {
1142 return !in_array(
1143 $this->getQueryVerb( $sql ),
1144 [ 'BEGIN', 'ROLLBACK', 'COMMIT', 'SET', 'SHOW', 'CREATE', 'ALTER' ],
1145 true
1146 );
1147 }
1148
1149 /**
1150 * @param string $sql A SQL query
1151 * @param bool $pseudoPermanent Treat any table from CREATE TEMPORARY as pseudo-permanent
1152 * @return int|null A self::TEMP_* constant for temp table operations or null otherwise
1153 */
1154 protected function registerTempTableWrite( $sql, $pseudoPermanent ) {
1155 static $qt = '[`"\']?(\w+)[`"\']?'; // quoted table
1156
1157 if ( preg_match(
1158 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?' . $qt . '/i',
1159 $sql,
1160 $matches
1161 ) ) {
1162 $type = $pseudoPermanent ? self::TEMP_PSEUDO_PERMANENT : self::TEMP_NORMAL;
1163 $this->sessionTempTables[$matches[1]] = $type;
1164
1165 return $type;
1166 } elseif ( preg_match(
1167 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?' . $qt . '/i',
1168 $sql,
1169 $matches
1170 ) ) {
1171 $type = $this->sessionTempTables[$matches[1]] ?? null;
1172 unset( $this->sessionTempTables[$matches[1]] );
1173
1174 return $type;
1175 } elseif ( preg_match(
1176 '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?' . $qt . '/i',
1177 $sql,
1178 $matches
1179 ) ) {
1180 return $this->sessionTempTables[$matches[1]] ?? null;
1181 } elseif ( preg_match(
1182 '/^(?:(?:INSERT|REPLACE)\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+' . $qt . '/i',
1183 $sql,
1184 $matches
1185 ) ) {
1186 return $this->sessionTempTables[$matches[1]] ?? null;
1187 }
1188
1189 return null;
1190 }
1191
1192 public function query( $sql, $fname = __METHOD__, $flags = 0 ) {
1193 $this->assertTransactionStatus( $sql, $fname );
1194 $this->assertHasConnectionHandle();
1195
1196 $flags = (int)$flags; // b/c; this field used to be a bool
1197 $ignoreErrors = $this->hasFlags( $flags, self::QUERY_SILENCE_ERRORS );
1198
1199 $priorTransaction = $this->trxLevel;
1200 $priorWritesPending = $this->writesOrCallbacksPending();
1201
1202 if ( $this->isWriteQuery( $sql ) ) {
1203 # In theory, non-persistent writes are allowed in read-only mode, but due to things
1204 # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
1205 $this->assertIsWritableMaster();
1206 # Do not treat temporary table writes as "meaningful writes" that need committing.
1207 # Profile them as reads. Integration tests can override this behavior via $flags.
1208 $pseudoPermanent = $this->hasFlags( $flags, self::QUERY_PSEUDO_PERMANENT );
1209 $tableType = $this->registerTempTableWrite( $sql, $pseudoPermanent );
1210 $isEffectiveWrite = ( $tableType !== self::TEMP_NORMAL );
1211 # DBConnRef uses QUERY_REPLICA_ROLE to enforce the replica role for raw SQL queries
1212 if ( $isEffectiveWrite && $this->hasFlags( $flags, self::QUERY_REPLICA_ROLE ) ) {
1213 throw new DBReadOnlyRoleError( $this, "Cannot write; target role is DB_REPLICA" );
1214 }
1215 } else {
1216 $isEffectiveWrite = false;
1217 }
1218
1219 # Add trace comment to the begin of the sql string, right after the operator.
1220 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
1221 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
1222
1223 # Send the query to the server and fetch any corresponding errors
1224 $ret = $this->attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname );
1225 $lastError = $this->lastError();
1226 $lastErrno = $this->lastErrno();
1227
1228 $recoverableSR = false; // recoverable statement rollback?
1229 $recoverableCL = false; // recoverable connection loss?
1230
1231 if ( $ret === false && $this->wasConnectionLoss() ) {
1232 # Check if no meaningful session state was lost
1233 $recoverableCL = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1234 # Update session state tracking and try to restore the connection
1235 $reconnected = $this->replaceLostConnection( __METHOD__ );
1236 # Silently resend the query to the server if it is safe and possible
1237 if ( $recoverableCL && $reconnected ) {
1238 $ret = $this->attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname );
1239 $lastError = $this->lastError();
1240 $lastErrno = $this->lastErrno();
1241
1242 if ( $ret === false && $this->wasConnectionLoss() ) {
1243 # Query probably causes disconnects; reconnect and do not re-run it
1244 $this->replaceLostConnection( __METHOD__ );
1245 } else {
1246 $recoverableCL = false; // connection does not need recovering
1247 $recoverableSR = $this->wasKnownStatementRollbackError();
1248 }
1249 }
1250 } else {
1251 $recoverableSR = $this->wasKnownStatementRollbackError();
1252 }
1253
1254 if ( $ret === false ) {
1255 if ( $priorTransaction ) {
1256 if ( $recoverableSR ) {
1257 # We're ignoring an error that caused just the current query to be aborted.
1258 # But log the cause so we can log a deprecation notice if a caller actually
1259 # does ignore it.
1260 $this->trxStatusIgnoredCause = [ $lastError, $lastErrno, $fname ];
1261 } elseif ( !$recoverableCL ) {
1262 # Either the query was aborted or all queries after BEGIN where aborted.
1263 # In the first case, the only options going forward are (a) ROLLBACK, or
1264 # (b) ROLLBACK TO SAVEPOINT (if one was set). If the later case, the only
1265 # option is ROLLBACK, since the snapshots would have been released.
1266 $this->trxStatus = self::STATUS_TRX_ERROR;
1267 $this->trxStatusCause =
1268 $this->getQueryExceptionAndLog( $lastError, $lastErrno, $sql, $fname );
1269 $ignoreErrors = false; // cannot recover
1270 $this->trxStatusIgnoredCause = null;
1271 }
1272 }
1273
1274 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $ignoreErrors );
1275 }
1276
1277 return $this->resultObject( $ret );
1278 }
1279
1280 /**
1281 * Wrapper for query() that also handles profiling, logging, and affected row count updates
1282 *
1283 * @param string $sql Original SQL query
1284 * @param string $commentedSql SQL query with debugging/trace comment
1285 * @param bool $isEffectiveWrite Whether the query is a (non-temporary table) write
1286 * @param string $fname Name of the calling function
1287 * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1288 * object for a successful read query, or false on failure
1289 */
1290 private function attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname ) {
1291 $this->beginIfImplied( $sql, $fname );
1292
1293 // Keep track of whether the transaction has write queries pending
1294 if ( $isEffectiveWrite ) {
1295 $this->lastWriteTime = microtime( true );
1296 if ( $this->trxLevel && !$this->trxDoneWrites ) {
1297 $this->trxDoneWrites = true;
1298 $this->trxProfiler->transactionWritingIn(
1299 $this->server, $this->getDomainID(), $this->trxShortId );
1300 }
1301 }
1302
1303 $prefix = !is_null( $this->getLBInfo( 'master' ) ) ? 'query-m: ' : 'query: ';
1304 $generalizedSql = new GeneralizedSql( $sql, $this->trxShortId, $prefix );
1305
1306 $startTime = microtime( true );
1307 $ps = $this->profiler
1308 ? ( $this->profiler )( $generalizedSql->stringify() )
1309 : null;
1310 $this->affectedRowCount = null;
1311 $this->lastQuery = $sql;
1312 $ret = $this->doQuery( $commentedSql );
1313 $this->affectedRowCount = $this->affectedRows();
1314 unset( $ps ); // profile out (if set)
1315 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1316
1317 if ( $ret !== false ) {
1318 $this->lastPing = $startTime;
1319 if ( $isEffectiveWrite && $this->trxLevel ) {
1320 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1321 $this->trxWriteCallers[] = $fname;
1322 }
1323 }
1324
1325 if ( $sql === self::PING_QUERY ) {
1326 $this->rttEstimate = $queryRuntime;
1327 }
1328
1329 $this->trxProfiler->recordQueryCompletion(
1330 $generalizedSql,
1331 $startTime,
1332 $isEffectiveWrite,
1333 $isEffectiveWrite ? $this->affectedRows() : $this->numRows( $ret )
1334 );
1335
1336 // Avoid the overhead of logging calls unless debug mode is enabled
1337 if ( $this->getFlag( self::DBO_DEBUG ) ) {
1338 $this->queryLogger->debug(
1339 "{method} [{runtime}s]: $sql",
1340 [
1341 'method' => $fname,
1342 'db_host' => $this->getServer(),
1343 'domain' => $this->getDomainID(),
1344 'runtime' => round( $queryRuntime, 3 )
1345 ]
1346 );
1347 }
1348
1349 return $ret;
1350 }
1351
1352 /**
1353 * Start an implicit transaction if DBO_TRX is enabled and no transaction is active
1354 *
1355 * @param string $sql
1356 * @param string $fname
1357 */
1358 private function beginIfImplied( $sql, $fname ) {
1359 if (
1360 !$this->trxLevel &&
1361 $this->getFlag( self::DBO_TRX ) &&
1362 $this->isTransactableQuery( $sql )
1363 ) {
1364 $this->begin( __METHOD__ . " ($fname)", self::TRANSACTION_INTERNAL );
1365 $this->trxAutomatic = true;
1366 }
1367 }
1368
1369 /**
1370 * Update the estimated run-time of a query, not counting large row lock times
1371 *
1372 * LoadBalancer can be set to rollback transactions that will create huge replication
1373 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1374 * queries, like inserting a row can take a long time due to row locking. This method
1375 * uses some simple heuristics to discount those cases.
1376 *
1377 * @param string $sql A SQL write query
1378 * @param float $runtime Total runtime, including RTT
1379 * @param int $affected Affected row count
1380 */
1381 private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1382 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1383 $indicativeOfReplicaRuntime = true;
1384 if ( $runtime > self::SLOW_WRITE_SEC ) {
1385 $verb = $this->getQueryVerb( $sql );
1386 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1387 if ( $verb === 'INSERT' ) {
1388 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS;
1389 } elseif ( $verb === 'REPLACE' ) {
1390 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS / 2;
1391 }
1392 }
1393
1394 $this->trxWriteDuration += $runtime;
1395 $this->trxWriteQueryCount += 1;
1396 $this->trxWriteAffectedRows += $affected;
1397 if ( $indicativeOfReplicaRuntime ) {
1398 $this->trxWriteAdjDuration += $runtime;
1399 $this->trxWriteAdjQueryCount += 1;
1400 }
1401 }
1402
1403 /**
1404 * Error out if the DB is not in a valid state for a query via query()
1405 *
1406 * @param string $sql
1407 * @param string $fname
1408 * @throws DBTransactionStateError
1409 */
1410 private function assertTransactionStatus( $sql, $fname ) {
1411 $verb = $this->getQueryVerb( $sql );
1412 if ( $verb === 'USE' ) {
1413 throw new DBUnexpectedError( $this, "Got USE query; use selectDomain() instead." );
1414 }
1415
1416 if ( $verb === 'ROLLBACK' ) { // transaction/savepoint
1417 return;
1418 }
1419
1420 if ( $this->trxStatus < self::STATUS_TRX_OK ) {
1421 throw new DBTransactionStateError(
1422 $this,
1423 "Cannot execute query from $fname while transaction status is ERROR.",
1424 [],
1425 $this->trxStatusCause
1426 );
1427 } elseif ( $this->trxStatus === self::STATUS_TRX_OK && $this->trxStatusIgnoredCause ) {
1428 list( $iLastError, $iLastErrno, $iFname ) = $this->trxStatusIgnoredCause;
1429 call_user_func( $this->deprecationLogger,
1430 "Caller from $fname ignored an error originally raised from $iFname: " .
1431 "[$iLastErrno] $iLastError"
1432 );
1433 $this->trxStatusIgnoredCause = null;
1434 }
1435 }
1436
1437 public function assertNoOpenTransactions() {
1438 if ( $this->explicitTrxActive() ) {
1439 throw new DBTransactionError(
1440 $this,
1441 "Explicit transaction still active. A caller may have caught an error. "
1442 . "Open transactions: " . $this->flatAtomicSectionList()
1443 );
1444 }
1445 }
1446
1447 /**
1448 * Determine whether it is safe to retry queries after a database connection is lost
1449 *
1450 * @param string $sql SQL query
1451 * @param bool $priorWritesPending Whether there is a transaction open with
1452 * possible write queries or transaction pre-commit/idle callbacks
1453 * waiting on it to finish.
1454 * @return bool True if it is safe to retry the query, false otherwise
1455 */
1456 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1457 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1458 # Dropped connections also mean that named locks are automatically released.
1459 # Only allow error suppression in autocommit mode or when the lost transaction
1460 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1461 if ( $this->namedLocksHeld ) {
1462 return false; // possible critical section violation
1463 } elseif ( $this->sessionTempTables ) {
1464 return false; // tables might be queried latter
1465 } elseif ( $sql === 'COMMIT' ) {
1466 return !$priorWritesPending; // nothing written anyway? (T127428)
1467 } elseif ( $sql === 'ROLLBACK' ) {
1468 return true; // transaction lost...which is also what was requested :)
1469 } elseif ( $this->explicitTrxActive() ) {
1470 return false; // don't drop atomocity and explicit snapshots
1471 } elseif ( $priorWritesPending ) {
1472 return false; // prior writes lost from implicit transaction
1473 }
1474
1475 return true;
1476 }
1477
1478 /**
1479 * Clean things up after session (and thus transaction) loss before reconnect
1480 */
1481 private function handleSessionLossPreconnect() {
1482 // Clean up tracking of session-level things...
1483 // https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html
1484 // https://www.postgresql.org/docs/9.2/static/sql-createtable.html (ignoring ON COMMIT)
1485 $this->sessionTempTables = [];
1486 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1487 // https://www.postgresql.org/docs/9.4/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1488 $this->namedLocksHeld = [];
1489 // Session loss implies transaction loss
1490 $this->trxLevel = 0;
1491 $this->trxAtomicCounter = 0;
1492 $this->trxIdleCallbacks = []; // T67263; transaction already lost
1493 $this->trxPreCommitCallbacks = []; // T67263; transaction already lost
1494 // @note: leave trxRecurringCallbacks in place
1495 if ( $this->trxDoneWrites ) {
1496 $this->trxProfiler->transactionWritingOut(
1497 $this->server,
1498 $this->getDomainID(),
1499 $this->trxShortId,
1500 $this->pendingWriteQueryDuration( self::ESTIMATE_TOTAL ),
1501 $this->trxWriteAffectedRows
1502 );
1503 }
1504 }
1505
1506 /**
1507 * Clean things up after session (and thus transaction) loss after reconnect
1508 */
1509 private function handleSessionLossPostconnect() {
1510 try {
1511 // Handle callbacks in trxEndCallbacks, e.g. onTransactionResolution().
1512 // If callback suppression is set then the array will remain unhandled.
1513 $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
1514 } catch ( Exception $ex ) {
1515 // Already logged; move on...
1516 }
1517 try {
1518 // Handle callbacks in trxRecurringCallbacks, e.g. setTransactionListener()
1519 $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
1520 } catch ( Exception $ex ) {
1521 // Already logged; move on...
1522 }
1523 }
1524
1525 /**
1526 * Checks whether the cause of the error is detected to be a timeout.
1527 *
1528 * It returns false by default, and not all engines support detecting this yet.
1529 * If this returns false, it will be treated as a generic query error.
1530 *
1531 * @param string $error Error text
1532 * @param int $errno Error number
1533 * @return bool
1534 */
1535 protected function wasQueryTimeout( $error, $errno ) {
1536 return false;
1537 }
1538
1539 /**
1540 * Report a query error. Log the error, and if neither the object ignore
1541 * flag nor the $ignoreErrors flag is set, throw a DBQueryError.
1542 *
1543 * @param string $error
1544 * @param int $errno
1545 * @param string $sql
1546 * @param string $fname
1547 * @param bool $ignore
1548 * @throws DBQueryError
1549 */
1550 public function reportQueryError( $error, $errno, $sql, $fname, $ignore = false ) {
1551 if ( $ignore ) {
1552 $this->queryLogger->debug( "SQL ERROR (ignored): $error\n" );
1553 } else {
1554 $exception = $this->getQueryExceptionAndLog( $error, $errno, $sql, $fname );
1555
1556 throw $exception;
1557 }
1558 }
1559
1560 /**
1561 * @param string $error
1562 * @param string|int $errno
1563 * @param string $sql
1564 * @param string $fname
1565 * @return DBError
1566 */
1567 private function getQueryExceptionAndLog( $error, $errno, $sql, $fname ) {
1568 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1569 $this->queryLogger->error(
1570 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1571 $this->getLogContext( [
1572 'method' => __METHOD__,
1573 'errno' => $errno,
1574 'error' => $error,
1575 'sql1line' => $sql1line,
1576 'fname' => $fname,
1577 'trace' => ( new RuntimeException() )->getTraceAsString()
1578 ] )
1579 );
1580 $this->queryLogger->debug( "SQL ERROR: " . $error . "\n" );
1581 if ( $this->wasQueryTimeout( $error, $errno ) ) {
1582 $e = new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1583 } elseif ( $this->wasConnectionError( $errno ) ) {
1584 $e = new DBQueryDisconnectedError( $this, $error, $errno, $sql, $fname );
1585 } else {
1586 $e = new DBQueryError( $this, $error, $errno, $sql, $fname );
1587 }
1588
1589 return $e;
1590 }
1591
1592 public function freeResult( $res ) {
1593 }
1594
1595 public function selectField(
1596 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1597 ) {
1598 if ( $var === '*' ) { // sanity
1599 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1600 }
1601
1602 if ( !is_array( $options ) ) {
1603 $options = [ $options ];
1604 }
1605
1606 $options['LIMIT'] = 1;
1607
1608 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1609 if ( $res === false ) {
1610 throw new DBUnexpectedError( $this, "Got false from select()" );
1611 }
1612
1613 $row = $this->fetchRow( $res );
1614 if ( $row === false ) {
1615 return false;
1616 }
1617
1618 return reset( $row );
1619 }
1620
1621 public function selectFieldValues(
1622 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1623 ) {
1624 if ( $var === '*' ) { // sanity
1625 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1626 } elseif ( !is_string( $var ) ) { // sanity
1627 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1628 }
1629
1630 if ( !is_array( $options ) ) {
1631 $options = [ $options ];
1632 }
1633
1634 $res = $this->select( $table, [ 'value' => $var ], $cond, $fname, $options, $join_conds );
1635 if ( $res === false ) {
1636 throw new DBUnexpectedError( $this, "Got false from select()" );
1637 }
1638
1639 $values = [];
1640 foreach ( $res as $row ) {
1641 $values[] = $row->value;
1642 }
1643
1644 return $values;
1645 }
1646
1647 /**
1648 * Returns an optional USE INDEX clause to go after the table, and a
1649 * string to go at the end of the query.
1650 *
1651 * @param array $options Associative array of options to be turned into
1652 * an SQL query, valid keys are listed in the function.
1653 * @return array
1654 * @see Database::select()
1655 */
1656 protected function makeSelectOptions( $options ) {
1657 $preLimitTail = $postLimitTail = '';
1658 $startOpts = '';
1659
1660 $noKeyOptions = [];
1661
1662 foreach ( $options as $key => $option ) {
1663 if ( is_numeric( $key ) ) {
1664 $noKeyOptions[$option] = true;
1665 }
1666 }
1667
1668 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1669
1670 $preLimitTail .= $this->makeOrderBy( $options );
1671
1672 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1673 $postLimitTail .= ' FOR UPDATE';
1674 }
1675
1676 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1677 $postLimitTail .= ' LOCK IN SHARE MODE';
1678 }
1679
1680 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1681 $startOpts .= 'DISTINCT';
1682 }
1683
1684 # Various MySQL extensions
1685 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1686 $startOpts .= ' /*! STRAIGHT_JOIN */';
1687 }
1688
1689 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1690 $startOpts .= ' HIGH_PRIORITY';
1691 }
1692
1693 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1694 $startOpts .= ' SQL_BIG_RESULT';
1695 }
1696
1697 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1698 $startOpts .= ' SQL_BUFFER_RESULT';
1699 }
1700
1701 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1702 $startOpts .= ' SQL_SMALL_RESULT';
1703 }
1704
1705 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1706 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1707 }
1708
1709 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1710 $startOpts .= ' SQL_CACHE';
1711 }
1712
1713 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1714 $startOpts .= ' SQL_NO_CACHE';
1715 }
1716
1717 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1718 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1719 } else {
1720 $useIndex = '';
1721 }
1722 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1723 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1724 } else {
1725 $ignoreIndex = '';
1726 }
1727
1728 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1729 }
1730
1731 /**
1732 * Returns an optional GROUP BY with an optional HAVING
1733 *
1734 * @param array $options Associative array of options
1735 * @return string
1736 * @see Database::select()
1737 * @since 1.21
1738 */
1739 protected function makeGroupByWithHaving( $options ) {
1740 $sql = '';
1741 if ( isset( $options['GROUP BY'] ) ) {
1742 $gb = is_array( $options['GROUP BY'] )
1743 ? implode( ',', $options['GROUP BY'] )
1744 : $options['GROUP BY'];
1745 $sql .= ' GROUP BY ' . $gb;
1746 }
1747 if ( isset( $options['HAVING'] ) ) {
1748 $having = is_array( $options['HAVING'] )
1749 ? $this->makeList( $options['HAVING'], self::LIST_AND )
1750 : $options['HAVING'];
1751 $sql .= ' HAVING ' . $having;
1752 }
1753
1754 return $sql;
1755 }
1756
1757 /**
1758 * Returns an optional ORDER BY
1759 *
1760 * @param array $options Associative array of options
1761 * @return string
1762 * @see Database::select()
1763 * @since 1.21
1764 */
1765 protected function makeOrderBy( $options ) {
1766 if ( isset( $options['ORDER BY'] ) ) {
1767 $ob = is_array( $options['ORDER BY'] )
1768 ? implode( ',', $options['ORDER BY'] )
1769 : $options['ORDER BY'];
1770
1771 return ' ORDER BY ' . $ob;
1772 }
1773
1774 return '';
1775 }
1776
1777 public function select(
1778 $table, $vars, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1779 ) {
1780 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1781
1782 return $this->query( $sql, $fname );
1783 }
1784
1785 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__,
1786 $options = [], $join_conds = []
1787 ) {
1788 if ( is_array( $vars ) ) {
1789 $fields = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1790 } else {
1791 $fields = $vars;
1792 }
1793
1794 $options = (array)$options;
1795 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1796 ? $options['USE INDEX']
1797 : [];
1798 $ignoreIndexes = (
1799 isset( $options['IGNORE INDEX'] ) &&
1800 is_array( $options['IGNORE INDEX'] )
1801 )
1802 ? $options['IGNORE INDEX']
1803 : [];
1804
1805 if (
1806 $this->selectOptionsIncludeLocking( $options ) &&
1807 $this->selectFieldsOrOptionsAggregate( $vars, $options )
1808 ) {
1809 // Some DB types (postgres/oracle) disallow FOR UPDATE with aggregate
1810 // functions. Discourage use of such queries to encourage compatibility.
1811 call_user_func(
1812 $this->deprecationLogger,
1813 __METHOD__ . ": aggregation used with a locking SELECT ($fname)."
1814 );
1815 }
1816
1817 if ( is_array( $table ) ) {
1818 $from = ' FROM ' .
1819 $this->tableNamesWithIndexClauseOrJOIN(
1820 $table, $useIndexes, $ignoreIndexes, $join_conds );
1821 } elseif ( $table != '' ) {
1822 $from = ' FROM ' .
1823 $this->tableNamesWithIndexClauseOrJOIN(
1824 [ $table ], $useIndexes, $ignoreIndexes, [] );
1825 } else {
1826 $from = '';
1827 }
1828
1829 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1830 $this->makeSelectOptions( $options );
1831
1832 if ( is_array( $conds ) ) {
1833 $conds = $this->makeList( $conds, self::LIST_AND );
1834 }
1835
1836 if ( $conds === null || $conds === false ) {
1837 $this->queryLogger->warning(
1838 __METHOD__
1839 . ' called from '
1840 . $fname
1841 . ' with incorrect parameters: $conds must be a string or an array'
1842 );
1843 $conds = '';
1844 }
1845
1846 if ( $conds === '' || $conds === '*' ) {
1847 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex $preLimitTail";
1848 } elseif ( is_string( $conds ) ) {
1849 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex " .
1850 "WHERE $conds $preLimitTail";
1851 } else {
1852 throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
1853 }
1854
1855 if ( isset( $options['LIMIT'] ) ) {
1856 $sql = $this->limitResult( $sql, $options['LIMIT'],
1857 $options['OFFSET'] ?? false );
1858 }
1859 $sql = "$sql $postLimitTail";
1860
1861 if ( isset( $options['EXPLAIN'] ) ) {
1862 $sql = 'EXPLAIN ' . $sql;
1863 }
1864
1865 return $sql;
1866 }
1867
1868 public function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1869 $options = [], $join_conds = []
1870 ) {
1871 $options = (array)$options;
1872 $options['LIMIT'] = 1;
1873
1874 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1875 if ( $res === false ) {
1876 throw new DBUnexpectedError( $this, "Got false from select()" );
1877 }
1878
1879 if ( !$this->numRows( $res ) ) {
1880 return false;
1881 }
1882
1883 return $this->fetchObject( $res );
1884 }
1885
1886 public function estimateRowCount(
1887 $table, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1888 ) {
1889 $conds = $this->normalizeConditions( $conds, $fname );
1890 $column = $this->extractSingleFieldFromList( $var );
1891 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1892 $conds[] = "$column IS NOT NULL";
1893 }
1894
1895 $res = $this->select(
1896 $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options, $join_conds
1897 );
1898 $row = $res ? $this->fetchRow( $res ) : [];
1899
1900 return isset( $row['rowcount'] ) ? (int)$row['rowcount'] : 0;
1901 }
1902
1903 public function selectRowCount(
1904 $tables, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1905 ) {
1906 $conds = $this->normalizeConditions( $conds, $fname );
1907 $column = $this->extractSingleFieldFromList( $var );
1908 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1909 $conds[] = "$column IS NOT NULL";
1910 }
1911
1912 $res = $this->select(
1913 [
1914 'tmp_count' => $this->buildSelectSubquery(
1915 $tables,
1916 '1',
1917 $conds,
1918 $fname,
1919 $options,
1920 $join_conds
1921 )
1922 ],
1923 [ 'rowcount' => 'COUNT(*)' ],
1924 [],
1925 $fname
1926 );
1927 $row = $res ? $this->fetchRow( $res ) : [];
1928
1929 return isset( $row['rowcount'] ) ? (int)$row['rowcount'] : 0;
1930 }
1931
1932 /**
1933 * @param string|array $options
1934 * @return bool
1935 */
1936 private function selectOptionsIncludeLocking( $options ) {
1937 $options = (array)$options;
1938 foreach ( [ 'FOR UPDATE', 'LOCK IN SHARE MODE' ] as $lock ) {
1939 if ( in_array( $lock, $options, true ) ) {
1940 return true;
1941 }
1942 }
1943
1944 return false;
1945 }
1946
1947 /**
1948 * @param array|string $fields
1949 * @param array|string $options
1950 * @return bool
1951 */
1952 private function selectFieldsOrOptionsAggregate( $fields, $options ) {
1953 foreach ( (array)$options as $key => $value ) {
1954 if ( is_string( $key ) ) {
1955 if ( preg_match( '/^(?:GROUP BY|HAVING)$/i', $key ) ) {
1956 return true;
1957 }
1958 } elseif ( is_string( $value ) ) {
1959 if ( preg_match( '/^(?:DISTINCT|DISTINCTROW)$/i', $value ) ) {
1960 return true;
1961 }
1962 }
1963 }
1964
1965 $regex = '/^(?:COUNT|MIN|MAX|SUM|GROUP_CONCAT|LISTAGG|ARRAY_AGG)\s*\\(/i';
1966 foreach ( (array)$fields as $field ) {
1967 if ( is_string( $field ) && preg_match( $regex, $field ) ) {
1968 return true;
1969 }
1970 }
1971
1972 return false;
1973 }
1974
1975 /**
1976 * @param array|string $conds
1977 * @param string $fname
1978 * @return array
1979 */
1980 final protected function normalizeConditions( $conds, $fname ) {
1981 if ( $conds === null || $conds === false ) {
1982 $this->queryLogger->warning(
1983 __METHOD__
1984 . ' called from '
1985 . $fname
1986 . ' with incorrect parameters: $conds must be a string or an array'
1987 );
1988 $conds = '';
1989 }
1990
1991 if ( !is_array( $conds ) ) {
1992 $conds = ( $conds === '' ) ? [] : [ $conds ];
1993 }
1994
1995 return $conds;
1996 }
1997
1998 /**
1999 * @param array|string $var Field parameter in the style of select()
2000 * @return string|null Column name or null; ignores aliases
2001 * @throws DBUnexpectedError Errors out if multiple columns are given
2002 */
2003 final protected function extractSingleFieldFromList( $var ) {
2004 if ( is_array( $var ) ) {
2005 if ( !$var ) {
2006 $column = null;
2007 } elseif ( count( $var ) == 1 ) {
2008 $column = $var[0] ?? reset( $var );
2009 } else {
2010 throw new DBUnexpectedError( $this, __METHOD__ . ': got multiple columns.' );
2011 }
2012 } else {
2013 $column = $var;
2014 }
2015
2016 return $column;
2017 }
2018
2019 public function lockForUpdate(
2020 $table, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
2021 ) {
2022 if ( !$this->trxLevel && !$this->getFlag( self::DBO_TRX ) ) {
2023 throw new DBUnexpectedError(
2024 $this,
2025 __METHOD__ . ': no transaction is active nor is DBO_TRX set'
2026 );
2027 }
2028
2029 $options = (array)$options;
2030 $options[] = 'FOR UPDATE';
2031
2032 return $this->selectRowCount( $table, '*', $conds, $fname, $options, $join_conds );
2033 }
2034
2035 public function fieldExists( $table, $field, $fname = __METHOD__ ) {
2036 $info = $this->fieldInfo( $table, $field );
2037
2038 return (bool)$info;
2039 }
2040
2041 public function indexExists( $table, $index, $fname = __METHOD__ ) {
2042 if ( !$this->tableExists( $table ) ) {
2043 return null;
2044 }
2045
2046 $info = $this->indexInfo( $table, $index, $fname );
2047 if ( is_null( $info ) ) {
2048 return null;
2049 } else {
2050 return $info !== false;
2051 }
2052 }
2053
2054 abstract public function tableExists( $table, $fname = __METHOD__ );
2055
2056 public function indexUnique( $table, $index ) {
2057 $indexInfo = $this->indexInfo( $table, $index );
2058
2059 if ( !$indexInfo ) {
2060 return null;
2061 }
2062
2063 return !$indexInfo[0]->Non_unique;
2064 }
2065
2066 /**
2067 * Helper for Database::insert().
2068 *
2069 * @param array $options
2070 * @return string
2071 */
2072 protected function makeInsertOptions( $options ) {
2073 return implode( ' ', $options );
2074 }
2075
2076 public function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
2077 # No rows to insert, easy just return now
2078 if ( !count( $a ) ) {
2079 return true;
2080 }
2081
2082 $table = $this->tableName( $table );
2083
2084 if ( !is_array( $options ) ) {
2085 $options = [ $options ];
2086 }
2087
2088 $options = $this->makeInsertOptions( $options );
2089
2090 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
2091 $multi = true;
2092 $keys = array_keys( $a[0] );
2093 } else {
2094 $multi = false;
2095 $keys = array_keys( $a );
2096 }
2097
2098 $sql = 'INSERT ' . $options .
2099 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2100
2101 if ( $multi ) {
2102 $first = true;
2103 foreach ( $a as $row ) {
2104 if ( $first ) {
2105 $first = false;
2106 } else {
2107 $sql .= ',';
2108 }
2109 $sql .= '(' . $this->makeList( $row ) . ')';
2110 }
2111 } else {
2112 $sql .= '(' . $this->makeList( $a ) . ')';
2113 }
2114
2115 $this->query( $sql, $fname );
2116
2117 return true;
2118 }
2119
2120 /**
2121 * Make UPDATE options array for Database::makeUpdateOptions
2122 *
2123 * @param array $options
2124 * @return array
2125 */
2126 protected function makeUpdateOptionsArray( $options ) {
2127 if ( !is_array( $options ) ) {
2128 $options = [ $options ];
2129 }
2130
2131 $opts = [];
2132
2133 if ( in_array( 'IGNORE', $options ) ) {
2134 $opts[] = 'IGNORE';
2135 }
2136
2137 return $opts;
2138 }
2139
2140 /**
2141 * Make UPDATE options for the Database::update function
2142 *
2143 * @param array $options The options passed to Database::update
2144 * @return string
2145 */
2146 protected function makeUpdateOptions( $options ) {
2147 $opts = $this->makeUpdateOptionsArray( $options );
2148
2149 return implode( ' ', $opts );
2150 }
2151
2152 public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
2153 $table = $this->tableName( $table );
2154 $opts = $this->makeUpdateOptions( $options );
2155 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self::LIST_SET );
2156
2157 if ( $conds !== [] && $conds !== '*' ) {
2158 $sql .= " WHERE " . $this->makeList( $conds, self::LIST_AND );
2159 }
2160
2161 $this->query( $sql, $fname );
2162
2163 return true;
2164 }
2165
2166 public function makeList( $a, $mode = self::LIST_COMMA ) {
2167 if ( !is_array( $a ) ) {
2168 throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
2169 }
2170
2171 $first = true;
2172 $list = '';
2173
2174 foreach ( $a as $field => $value ) {
2175 if ( !$first ) {
2176 if ( $mode == self::LIST_AND ) {
2177 $list .= ' AND ';
2178 } elseif ( $mode == self::LIST_OR ) {
2179 $list .= ' OR ';
2180 } else {
2181 $list .= ',';
2182 }
2183 } else {
2184 $first = false;
2185 }
2186
2187 if ( ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_numeric( $field ) ) {
2188 $list .= "($value)";
2189 } elseif ( $mode == self::LIST_SET && is_numeric( $field ) ) {
2190 $list .= "$value";
2191 } elseif (
2192 ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_array( $value )
2193 ) {
2194 // Remove null from array to be handled separately if found
2195 $includeNull = false;
2196 foreach ( array_keys( $value, null, true ) as $nullKey ) {
2197 $includeNull = true;
2198 unset( $value[$nullKey] );
2199 }
2200 if ( count( $value ) == 0 && !$includeNull ) {
2201 throw new InvalidArgumentException(
2202 __METHOD__ . ": empty input for field $field" );
2203 } elseif ( count( $value ) == 0 ) {
2204 // only check if $field is null
2205 $list .= "$field IS NULL";
2206 } else {
2207 // IN clause contains at least one valid element
2208 if ( $includeNull ) {
2209 // Group subconditions to ensure correct precedence
2210 $list .= '(';
2211 }
2212 if ( count( $value ) == 1 ) {
2213 // Special-case single values, as IN isn't terribly efficient
2214 // Don't necessarily assume the single key is 0; we don't
2215 // enforce linear numeric ordering on other arrays here.
2216 $value = array_values( $value )[0];
2217 $list .= $field . " = " . $this->addQuotes( $value );
2218 } else {
2219 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2220 }
2221 // if null present in array, append IS NULL
2222 if ( $includeNull ) {
2223 $list .= " OR $field IS NULL)";
2224 }
2225 }
2226 } elseif ( $value === null ) {
2227 if ( $mode == self::LIST_AND || $mode == self::LIST_OR ) {
2228 $list .= "$field IS ";
2229 } elseif ( $mode == self::LIST_SET ) {
2230 $list .= "$field = ";
2231 }
2232 $list .= 'NULL';
2233 } else {
2234 if (
2235 $mode == self::LIST_AND || $mode == self::LIST_OR || $mode == self::LIST_SET
2236 ) {
2237 $list .= "$field = ";
2238 }
2239 $list .= $mode == self::LIST_NAMES ? $value : $this->addQuotes( $value );
2240 }
2241 }
2242
2243 return $list;
2244 }
2245
2246 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2247 $conds = [];
2248
2249 foreach ( $data as $base => $sub ) {
2250 if ( count( $sub ) ) {
2251 $conds[] = $this->makeList(
2252 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
2253 self::LIST_AND );
2254 }
2255 }
2256
2257 if ( $conds ) {
2258 return $this->makeList( $conds, self::LIST_OR );
2259 } else {
2260 // Nothing to search for...
2261 return false;
2262 }
2263 }
2264
2265 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2266 return $valuename;
2267 }
2268
2269 public function bitNot( $field ) {
2270 return "(~$field)";
2271 }
2272
2273 public function bitAnd( $fieldLeft, $fieldRight ) {
2274 return "($fieldLeft & $fieldRight)";
2275 }
2276
2277 public function bitOr( $fieldLeft, $fieldRight ) {
2278 return "($fieldLeft | $fieldRight)";
2279 }
2280
2281 public function buildConcat( $stringList ) {
2282 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2283 }
2284
2285 public function buildGroupConcatField(
2286 $delim, $table, $field, $conds = '', $join_conds = []
2287 ) {
2288 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2289
2290 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
2291 }
2292
2293 public function buildSubstring( $input, $startPosition, $length = null ) {
2294 $this->assertBuildSubstringParams( $startPosition, $length );
2295 $functionBody = "$input FROM $startPosition";
2296 if ( $length !== null ) {
2297 $functionBody .= " FOR $length";
2298 }
2299 return 'SUBSTRING(' . $functionBody . ')';
2300 }
2301
2302 /**
2303 * Check type and bounds for parameters to self::buildSubstring()
2304 *
2305 * All supported databases have substring functions that behave the same for
2306 * positive $startPosition and non-negative $length, but behaviors differ when
2307 * given 0 or negative $startPosition or negative $length. The simplest
2308 * solution to that is to just forbid those values.
2309 *
2310 * @param int $startPosition
2311 * @param int|null $length
2312 * @since 1.31
2313 */
2314 protected function assertBuildSubstringParams( $startPosition, $length ) {
2315 if ( !is_int( $startPosition ) || $startPosition <= 0 ) {
2316 throw new InvalidArgumentException(
2317 '$startPosition must be a positive integer'
2318 );
2319 }
2320 if ( !( is_int( $length ) && $length >= 0 || $length === null ) ) {
2321 throw new InvalidArgumentException(
2322 '$length must be null or an integer greater than or equal to 0'
2323 );
2324 }
2325 }
2326
2327 public function buildStringCast( $field ) {
2328 // In theory this should work for any standards-compliant
2329 // SQL implementation, although it may not be the best way to do it.
2330 return "CAST( $field AS CHARACTER )";
2331 }
2332
2333 public function buildIntegerCast( $field ) {
2334 return 'CAST( ' . $field . ' AS INTEGER )';
2335 }
2336
2337 public function buildSelectSubquery(
2338 $table, $vars, $conds = '', $fname = __METHOD__,
2339 $options = [], $join_conds = []
2340 ) {
2341 return new Subquery(
2342 $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds )
2343 );
2344 }
2345
2346 public function databasesAreIndependent() {
2347 return false;
2348 }
2349
2350 final public function selectDB( $db ) {
2351 $this->selectDomain( new DatabaseDomain(
2352 $db,
2353 $this->currentDomain->getSchema(),
2354 $this->currentDomain->getTablePrefix()
2355 ) );
2356
2357 return true;
2358 }
2359
2360 final public function selectDomain( $domain ) {
2361 $this->doSelectDomain( DatabaseDomain::newFromId( $domain ) );
2362 }
2363
2364 protected function doSelectDomain( DatabaseDomain $domain ) {
2365 $this->currentDomain = $domain;
2366 }
2367
2368 public function getDBname() {
2369 return $this->currentDomain->getDatabase();
2370 }
2371
2372 public function getServer() {
2373 return $this->server;
2374 }
2375
2376 public function tableName( $name, $format = 'quoted' ) {
2377 if ( $name instanceof Subquery ) {
2378 throw new DBUnexpectedError(
2379 $this,
2380 __METHOD__ . ': got Subquery instance when expecting a string.'
2381 );
2382 }
2383
2384 # Skip the entire process when we have a string quoted on both ends.
2385 # Note that we check the end so that we will still quote any use of
2386 # use of `database`.table. But won't break things if someone wants
2387 # to query a database table with a dot in the name.
2388 if ( $this->isQuotedIdentifier( $name ) ) {
2389 return $name;
2390 }
2391
2392 # Lets test for any bits of text that should never show up in a table
2393 # name. Basically anything like JOIN or ON which are actually part of
2394 # SQL queries, but may end up inside of the table value to combine
2395 # sql. Such as how the API is doing.
2396 # Note that we use a whitespace test rather than a \b test to avoid
2397 # any remote case where a word like on may be inside of a table name
2398 # surrounded by symbols which may be considered word breaks.
2399 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2400 $this->queryLogger->warning(
2401 __METHOD__ . ": use of subqueries is not supported this way.",
2402 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
2403 );
2404
2405 return $name;
2406 }
2407
2408 # Split database and table into proper variables.
2409 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
2410
2411 # Quote $table and apply the prefix if not quoted.
2412 # $tableName might be empty if this is called from Database::replaceVars()
2413 $tableName = "{$prefix}{$table}";
2414 if ( $format === 'quoted'
2415 && !$this->isQuotedIdentifier( $tableName )
2416 && $tableName !== ''
2417 ) {
2418 $tableName = $this->addIdentifierQuotes( $tableName );
2419 }
2420
2421 # Quote $schema and $database and merge them with the table name if needed
2422 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
2423 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
2424
2425 return $tableName;
2426 }
2427
2428 /**
2429 * Get the table components needed for a query given the currently selected database
2430 *
2431 * @param string $name Table name in the form of db.schema.table, db.table, or table
2432 * @return array (DB name or "" for default, schema name, table prefix, table name)
2433 */
2434 protected function qualifiedTableComponents( $name ) {
2435 # We reverse the explode so that database.table and table both output the correct table.
2436 $dbDetails = explode( '.', $name, 3 );
2437 if ( count( $dbDetails ) == 3 ) {
2438 list( $database, $schema, $table ) = $dbDetails;
2439 # We don't want any prefix added in this case
2440 $prefix = '';
2441 } elseif ( count( $dbDetails ) == 2 ) {
2442 list( $database, $table ) = $dbDetails;
2443 # We don't want any prefix added in this case
2444 $prefix = '';
2445 # In dbs that support it, $database may actually be the schema
2446 # but that doesn't affect any of the functionality here
2447 $schema = '';
2448 } else {
2449 list( $table ) = $dbDetails;
2450 if ( isset( $this->tableAliases[$table] ) ) {
2451 $database = $this->tableAliases[$table]['dbname'];
2452 $schema = is_string( $this->tableAliases[$table]['schema'] )
2453 ? $this->tableAliases[$table]['schema']
2454 : $this->relationSchemaQualifier();
2455 $prefix = is_string( $this->tableAliases[$table]['prefix'] )
2456 ? $this->tableAliases[$table]['prefix']
2457 : $this->tablePrefix();
2458 } else {
2459 $database = '';
2460 $schema = $this->relationSchemaQualifier(); # Default schema
2461 $prefix = $this->tablePrefix(); # Default prefix
2462 }
2463 }
2464
2465 return [ $database, $schema, $prefix, $table ];
2466 }
2467
2468 /**
2469 * @param string|null $namespace Database or schema
2470 * @param string $relation Name of table, view, sequence, etc...
2471 * @param string $format One of (raw, quoted)
2472 * @return string Relation name with quoted and merged $namespace as needed
2473 */
2474 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2475 if ( strlen( $namespace ) ) {
2476 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2477 $namespace = $this->addIdentifierQuotes( $namespace );
2478 }
2479 $relation = $namespace . '.' . $relation;
2480 }
2481
2482 return $relation;
2483 }
2484
2485 public function tableNames() {
2486 $inArray = func_get_args();
2487 $retVal = [];
2488
2489 foreach ( $inArray as $name ) {
2490 $retVal[$name] = $this->tableName( $name );
2491 }
2492
2493 return $retVal;
2494 }
2495
2496 public function tableNamesN() {
2497 $inArray = func_get_args();
2498 $retVal = [];
2499
2500 foreach ( $inArray as $name ) {
2501 $retVal[] = $this->tableName( $name );
2502 }
2503
2504 return $retVal;
2505 }
2506
2507 /**
2508 * Get an aliased table name
2509 *
2510 * This returns strings like "tableName AS newTableName" for aliased tables
2511 * and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
2512 *
2513 * @see Database::tableName()
2514 * @param string|Subquery $table Table name or object with a 'sql' field
2515 * @param string|bool $alias Table alias (optional)
2516 * @return string SQL name for aliased table. Will not alias a table to its own name
2517 */
2518 protected function tableNameWithAlias( $table, $alias = false ) {
2519 if ( is_string( $table ) ) {
2520 $quotedTable = $this->tableName( $table );
2521 } elseif ( $table instanceof Subquery ) {
2522 $quotedTable = (string)$table;
2523 } else {
2524 throw new InvalidArgumentException( "Table must be a string or Subquery." );
2525 }
2526
2527 if ( $alias === false || $alias === $table ) {
2528 if ( $table instanceof Subquery ) {
2529 throw new InvalidArgumentException( "Subquery table missing alias." );
2530 }
2531
2532 return $quotedTable;
2533 } else {
2534 return $quotedTable . ' ' . $this->addIdentifierQuotes( $alias );
2535 }
2536 }
2537
2538 /**
2539 * Gets an array of aliased table names
2540 *
2541 * @param array $tables [ [alias] => table ]
2542 * @return string[] See tableNameWithAlias()
2543 */
2544 protected function tableNamesWithAlias( $tables ) {
2545 $retval = [];
2546 foreach ( $tables as $alias => $table ) {
2547 if ( is_numeric( $alias ) ) {
2548 $alias = $table;
2549 }
2550 $retval[] = $this->tableNameWithAlias( $table, $alias );
2551 }
2552
2553 return $retval;
2554 }
2555
2556 /**
2557 * Get an aliased field name
2558 * e.g. fieldName AS newFieldName
2559 *
2560 * @param string $name Field name
2561 * @param string|bool $alias Alias (optional)
2562 * @return string SQL name for aliased field. Will not alias a field to its own name
2563 */
2564 protected function fieldNameWithAlias( $name, $alias = false ) {
2565 if ( !$alias || (string)$alias === (string)$name ) {
2566 return $name;
2567 } else {
2568 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2569 }
2570 }
2571
2572 /**
2573 * Gets an array of aliased field names
2574 *
2575 * @param array $fields [ [alias] => field ]
2576 * @return string[] See fieldNameWithAlias()
2577 */
2578 protected function fieldNamesWithAlias( $fields ) {
2579 $retval = [];
2580 foreach ( $fields as $alias => $field ) {
2581 if ( is_numeric( $alias ) ) {
2582 $alias = $field;
2583 }
2584 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2585 }
2586
2587 return $retval;
2588 }
2589
2590 /**
2591 * Get the aliased table name clause for a FROM clause
2592 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2593 *
2594 * @param array $tables ( [alias] => table )
2595 * @param array $use_index Same as for select()
2596 * @param array $ignore_index Same as for select()
2597 * @param array $join_conds Same as for select()
2598 * @return string
2599 */
2600 protected function tableNamesWithIndexClauseOrJOIN(
2601 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2602 ) {
2603 $ret = [];
2604 $retJOIN = [];
2605 $use_index = (array)$use_index;
2606 $ignore_index = (array)$ignore_index;
2607 $join_conds = (array)$join_conds;
2608
2609 foreach ( $tables as $alias => $table ) {
2610 if ( !is_string( $alias ) ) {
2611 // No alias? Set it equal to the table name
2612 $alias = $table;
2613 }
2614
2615 if ( is_array( $table ) ) {
2616 // A parenthesized group
2617 if ( count( $table ) > 1 ) {
2618 $joinedTable = '(' .
2619 $this->tableNamesWithIndexClauseOrJOIN(
2620 $table, $use_index, $ignore_index, $join_conds ) . ')';
2621 } else {
2622 // Degenerate case
2623 $innerTable = reset( $table );
2624 $innerAlias = key( $table );
2625 $joinedTable = $this->tableNameWithAlias(
2626 $innerTable,
2627 is_string( $innerAlias ) ? $innerAlias : $innerTable
2628 );
2629 }
2630 } else {
2631 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2632 }
2633
2634 // Is there a JOIN clause for this table?
2635 if ( isset( $join_conds[$alias] ) ) {
2636 list( $joinType, $conds ) = $join_conds[$alias];
2637 $tableClause = $joinType;
2638 $tableClause .= ' ' . $joinedTable;
2639 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2640 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2641 if ( $use != '' ) {
2642 $tableClause .= ' ' . $use;
2643 }
2644 }
2645 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2646 $ignore = $this->ignoreIndexClause(
2647 implode( ',', (array)$ignore_index[$alias] ) );
2648 if ( $ignore != '' ) {
2649 $tableClause .= ' ' . $ignore;
2650 }
2651 }
2652 $on = $this->makeList( (array)$conds, self::LIST_AND );
2653 if ( $on != '' ) {
2654 $tableClause .= ' ON (' . $on . ')';
2655 }
2656
2657 $retJOIN[] = $tableClause;
2658 } elseif ( isset( $use_index[$alias] ) ) {
2659 // Is there an INDEX clause for this table?
2660 $tableClause = $joinedTable;
2661 $tableClause .= ' ' . $this->useIndexClause(
2662 implode( ',', (array)$use_index[$alias] )
2663 );
2664
2665 $ret[] = $tableClause;
2666 } elseif ( isset( $ignore_index[$alias] ) ) {
2667 // Is there an INDEX clause for this table?
2668 $tableClause = $joinedTable;
2669 $tableClause .= ' ' . $this->ignoreIndexClause(
2670 implode( ',', (array)$ignore_index[$alias] )
2671 );
2672
2673 $ret[] = $tableClause;
2674 } else {
2675 $tableClause = $joinedTable;
2676
2677 $ret[] = $tableClause;
2678 }
2679 }
2680
2681 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2682 $implicitJoins = implode( ',', $ret );
2683 $explicitJoins = implode( ' ', $retJOIN );
2684
2685 // Compile our final table clause
2686 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2687 }
2688
2689 /**
2690 * Allows for index remapping in queries where this is not consistent across DBMS
2691 *
2692 * @param string $index
2693 * @return string
2694 */
2695 protected function indexName( $index ) {
2696 return $this->indexAliases[$index] ?? $index;
2697 }
2698
2699 public function addQuotes( $s ) {
2700 if ( $s instanceof Blob ) {
2701 $s = $s->fetch();
2702 }
2703 if ( $s === null ) {
2704 return 'NULL';
2705 } elseif ( is_bool( $s ) ) {
2706 return (int)$s;
2707 } else {
2708 # This will also quote numeric values. This should be harmless,
2709 # and protects against weird problems that occur when they really
2710 # _are_ strings such as article titles and string->number->string
2711 # conversion is not 1:1.
2712 return "'" . $this->strencode( $s ) . "'";
2713 }
2714 }
2715
2716 public function addIdentifierQuotes( $s ) {
2717 return '"' . str_replace( '"', '""', $s ) . '"';
2718 }
2719
2720 /**
2721 * Returns if the given identifier looks quoted or not according to
2722 * the database convention for quoting identifiers .
2723 *
2724 * @note Do not use this to determine if untrusted input is safe.
2725 * A malicious user can trick this function.
2726 * @param string $name
2727 * @return bool
2728 */
2729 public function isQuotedIdentifier( $name ) {
2730 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2731 }
2732
2733 /**
2734 * @param string $s
2735 * @param string $escapeChar
2736 * @return string
2737 */
2738 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2739 return str_replace( [ $escapeChar, '%', '_' ],
2740 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2741 $s );
2742 }
2743
2744 public function buildLike() {
2745 $params = func_get_args();
2746
2747 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2748 $params = $params[0];
2749 }
2750
2751 $s = '';
2752
2753 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2754 // may escape backslashes, creating problems of double escaping. The `
2755 // character has good cross-DBMS compatibility, avoiding special operators
2756 // in MS SQL like ^ and %
2757 $escapeChar = '`';
2758
2759 foreach ( $params as $value ) {
2760 if ( $value instanceof LikeMatch ) {
2761 $s .= $value->toString();
2762 } else {
2763 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2764 }
2765 }
2766
2767 return ' LIKE ' .
2768 $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2769 }
2770
2771 public function anyChar() {
2772 return new LikeMatch( '_' );
2773 }
2774
2775 public function anyString() {
2776 return new LikeMatch( '%' );
2777 }
2778
2779 public function nextSequenceValue( $seqName ) {
2780 return null;
2781 }
2782
2783 /**
2784 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2785 * is only needed because a) MySQL must be as efficient as possible due to
2786 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2787 * which index to pick. Anyway, other databases might have different
2788 * indexes on a given table. So don't bother overriding this unless you're
2789 * MySQL.
2790 * @param string $index
2791 * @return string
2792 */
2793 public function useIndexClause( $index ) {
2794 return '';
2795 }
2796
2797 /**
2798 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2799 * is only needed because a) MySQL must be as efficient as possible due to
2800 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2801 * which index to pick. Anyway, other databases might have different
2802 * indexes on a given table. So don't bother overriding this unless you're
2803 * MySQL.
2804 * @param string $index
2805 * @return string
2806 */
2807 public function ignoreIndexClause( $index ) {
2808 return '';
2809 }
2810
2811 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
2812 if ( count( $rows ) == 0 ) {
2813 return;
2814 }
2815
2816 $uniqueIndexes = (array)$uniqueIndexes;
2817 // Single row case
2818 if ( !is_array( reset( $rows ) ) ) {
2819 $rows = [ $rows ];
2820 }
2821
2822 try {
2823 $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
2824 $affectedRowCount = 0;
2825 foreach ( $rows as $row ) {
2826 // Delete rows which collide with this one
2827 $indexWhereClauses = [];
2828 foreach ( $uniqueIndexes as $index ) {
2829 $indexColumns = (array)$index;
2830 $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2831 if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2832 throw new DBUnexpectedError(
2833 $this,
2834 'New record does not provide all values for unique key (' .
2835 implode( ', ', $indexColumns ) . ')'
2836 );
2837 } elseif ( in_array( null, $indexRowValues, true ) ) {
2838 throw new DBUnexpectedError(
2839 $this,
2840 'New record has a null value for unique key (' .
2841 implode( ', ', $indexColumns ) . ')'
2842 );
2843 }
2844 $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND );
2845 }
2846
2847 if ( $indexWhereClauses ) {
2848 $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR ), $fname );
2849 $affectedRowCount += $this->affectedRows();
2850 }
2851
2852 // Now insert the row
2853 $this->insert( $table, $row, $fname );
2854 $affectedRowCount += $this->affectedRows();
2855 }
2856 $this->endAtomic( $fname );
2857 $this->affectedRowCount = $affectedRowCount;
2858 } catch ( Exception $e ) {
2859 $this->cancelAtomic( $fname );
2860 throw $e;
2861 }
2862 }
2863
2864 /**
2865 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2866 * statement.
2867 *
2868 * @param string $table Table name
2869 * @param array|string $rows Row(s) to insert
2870 * @param string $fname Caller function name
2871 */
2872 protected function nativeReplace( $table, $rows, $fname ) {
2873 $table = $this->tableName( $table );
2874
2875 # Single row case
2876 if ( !is_array( reset( $rows ) ) ) {
2877 $rows = [ $rows ];
2878 }
2879
2880 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2881 $first = true;
2882
2883 foreach ( $rows as $row ) {
2884 if ( $first ) {
2885 $first = false;
2886 } else {
2887 $sql .= ',';
2888 }
2889
2890 $sql .= '(' . $this->makeList( $row ) . ')';
2891 }
2892
2893 $this->query( $sql, $fname );
2894 }
2895
2896 public function upsert( $table, array $rows, $uniqueIndexes, array $set,
2897 $fname = __METHOD__
2898 ) {
2899 if ( $rows === [] ) {
2900 return true; // nothing to do
2901 }
2902
2903 $uniqueIndexes = (array)$uniqueIndexes;
2904 if ( !is_array( reset( $rows ) ) ) {
2905 $rows = [ $rows ];
2906 }
2907
2908 if ( count( $uniqueIndexes ) ) {
2909 $clauses = []; // list WHERE clauses that each identify a single row
2910 foreach ( $rows as $row ) {
2911 foreach ( $uniqueIndexes as $index ) {
2912 $index = is_array( $index ) ? $index : [ $index ]; // columns
2913 $rowKey = []; // unique key to this row
2914 foreach ( $index as $column ) {
2915 $rowKey[$column] = $row[$column];
2916 }
2917 $clauses[] = $this->makeList( $rowKey, self::LIST_AND );
2918 }
2919 }
2920 $where = [ $this->makeList( $clauses, self::LIST_OR ) ];
2921 } else {
2922 $where = false;
2923 }
2924
2925 $affectedRowCount = 0;
2926 try {
2927 $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
2928 # Update any existing conflicting row(s)
2929 if ( $where !== false ) {
2930 $this->update( $table, $set, $where, $fname );
2931 $affectedRowCount += $this->affectedRows();
2932 }
2933 # Now insert any non-conflicting row(s)
2934 $this->insert( $table, $rows, $fname, [ 'IGNORE' ] );
2935 $affectedRowCount += $this->affectedRows();
2936 $this->endAtomic( $fname );
2937 $this->affectedRowCount = $affectedRowCount;
2938 } catch ( Exception $e ) {
2939 $this->cancelAtomic( $fname );
2940 throw $e;
2941 }
2942
2943 return true;
2944 }
2945
2946 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2947 $fname = __METHOD__
2948 ) {
2949 if ( !$conds ) {
2950 throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
2951 }
2952
2953 $delTable = $this->tableName( $delTable );
2954 $joinTable = $this->tableName( $joinTable );
2955 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2956 if ( $conds != '*' ) {
2957 $sql .= 'WHERE ' . $this->makeList( $conds, self::LIST_AND );
2958 }
2959 $sql .= ')';
2960
2961 $this->query( $sql, $fname );
2962 }
2963
2964 public function textFieldSize( $table, $field ) {
2965 $table = $this->tableName( $table );
2966 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2967 $res = $this->query( $sql, __METHOD__ );
2968 $row = $this->fetchObject( $res );
2969
2970 $m = [];
2971
2972 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
2973 $size = $m[1];
2974 } else {
2975 $size = -1;
2976 }
2977
2978 return $size;
2979 }
2980
2981 public function delete( $table, $conds, $fname = __METHOD__ ) {
2982 if ( !$conds ) {
2983 throw new DBUnexpectedError( $this, __METHOD__ . ' called with no conditions' );
2984 }
2985
2986 $table = $this->tableName( $table );
2987 $sql = "DELETE FROM $table";
2988
2989 if ( $conds != '*' ) {
2990 if ( is_array( $conds ) ) {
2991 $conds = $this->makeList( $conds, self::LIST_AND );
2992 }
2993 $sql .= ' WHERE ' . $conds;
2994 }
2995
2996 $this->query( $sql, $fname );
2997
2998 return true;
2999 }
3000
3001 final public function insertSelect(
3002 $destTable, $srcTable, $varMap, $conds,
3003 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3004 ) {
3005 static $hints = [ 'NO_AUTO_COLUMNS' ];
3006
3007 $insertOptions = (array)$insertOptions;
3008 $selectOptions = (array)$selectOptions;
3009
3010 if ( $this->cliMode && $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
3011 // For massive migrations with downtime, we don't want to select everything
3012 // into memory and OOM, so do all this native on the server side if possible.
3013 $this->nativeInsertSelect(
3014 $destTable,
3015 $srcTable,
3016 $varMap,
3017 $conds,
3018 $fname,
3019 array_diff( $insertOptions, $hints ),
3020 $selectOptions,
3021 $selectJoinConds
3022 );
3023 } else {
3024 $this->nonNativeInsertSelect(
3025 $destTable,
3026 $srcTable,
3027 $varMap,
3028 $conds,
3029 $fname,
3030 array_diff( $insertOptions, $hints ),
3031 $selectOptions,
3032 $selectJoinConds
3033 );
3034 }
3035
3036 return true;
3037 }
3038
3039 /**
3040 * @param array $insertOptions INSERT options
3041 * @param array $selectOptions SELECT options
3042 * @return bool Whether an INSERT SELECT with these options will be replication safe
3043 * @since 1.31
3044 */
3045 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
3046 return true;
3047 }
3048
3049 /**
3050 * Implementation of insertSelect() based on select() and insert()
3051 *
3052 * @see IDatabase::insertSelect()
3053 * @since 1.30
3054 * @param string $destTable
3055 * @param string|array $srcTable
3056 * @param array $varMap
3057 * @param array $conds
3058 * @param string $fname
3059 * @param array $insertOptions
3060 * @param array $selectOptions
3061 * @param array $selectJoinConds
3062 */
3063 protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3064 $fname = __METHOD__,
3065 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3066 ) {
3067 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
3068 // on only the master (without needing row-based-replication). It also makes it easy to
3069 // know how big the INSERT is going to be.
3070 $fields = [];
3071 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
3072 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
3073 }
3074 $selectOptions[] = 'FOR UPDATE';
3075 $res = $this->select(
3076 $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
3077 );
3078 if ( !$res ) {
3079 return;
3080 }
3081
3082 try {
3083 $affectedRowCount = 0;
3084 $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
3085 $rows = [];
3086 $ok = true;
3087 foreach ( $res as $row ) {
3088 $rows[] = (array)$row;
3089
3090 // Avoid inserts that are too huge
3091 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize ) {
3092 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3093 if ( !$ok ) {
3094 break;
3095 }
3096 $affectedRowCount += $this->affectedRows();
3097 $rows = [];
3098 }
3099 }
3100 if ( $rows && $ok ) {
3101 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3102 if ( $ok ) {
3103 $affectedRowCount += $this->affectedRows();
3104 }
3105 }
3106 if ( $ok ) {
3107 $this->endAtomic( $fname );
3108 $this->affectedRowCount = $affectedRowCount;
3109 } else {
3110 $this->cancelAtomic( $fname );
3111 }
3112 } catch ( Exception $e ) {
3113 $this->cancelAtomic( $fname );
3114 throw $e;
3115 }
3116 }
3117
3118 /**
3119 * Native server-side implementation of insertSelect() for situations where
3120 * we don't want to select everything into memory
3121 *
3122 * @see IDatabase::insertSelect()
3123 * @param string $destTable
3124 * @param string|array $srcTable
3125 * @param array $varMap
3126 * @param array $conds
3127 * @param string $fname
3128 * @param array $insertOptions
3129 * @param array $selectOptions
3130 * @param array $selectJoinConds
3131 */
3132 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3133 $fname = __METHOD__,
3134 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3135 ) {
3136 $destTable = $this->tableName( $destTable );
3137
3138 if ( !is_array( $insertOptions ) ) {
3139 $insertOptions = [ $insertOptions ];
3140 }
3141
3142 $insertOptions = $this->makeInsertOptions( $insertOptions );
3143
3144 $selectSql = $this->selectSQLText(
3145 $srcTable,
3146 array_values( $varMap ),
3147 $conds,
3148 $fname,
3149 $selectOptions,
3150 $selectJoinConds
3151 );
3152
3153 $sql = "INSERT $insertOptions" .
3154 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
3155 $selectSql;
3156
3157 $this->query( $sql, $fname );
3158 }
3159
3160 public function limitResult( $sql, $limit, $offset = false ) {
3161 if ( !is_numeric( $limit ) ) {
3162 throw new DBUnexpectedError( $this,
3163 "Invalid non-numeric limit passed to limitResult()\n" );
3164 }
3165 // This version works in MySQL and SQLite. It will very likely need to be
3166 // overridden for most other RDBMS subclasses.
3167 return "$sql LIMIT "
3168 . ( ( is_numeric( $offset ) && $offset != 0 ) ? "{$offset}," : "" )
3169 . "{$limit} ";
3170 }
3171
3172 public function unionSupportsOrderAndLimit() {
3173 return true; // True for almost every DB supported
3174 }
3175
3176 public function unionQueries( $sqls, $all ) {
3177 $glue = $all ? ') UNION ALL (' : ') UNION (';
3178
3179 return '(' . implode( $glue, $sqls ) . ')';
3180 }
3181
3182 public function unionConditionPermutations(
3183 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
3184 $options = [], $join_conds = []
3185 ) {
3186 // First, build the Cartesian product of $permute_conds
3187 $conds = [ [] ];
3188 foreach ( $permute_conds as $field => $values ) {
3189 if ( !$values ) {
3190 // Skip empty $values
3191 continue;
3192 }
3193 $values = array_unique( $values ); // For sanity
3194 $newConds = [];
3195 foreach ( $conds as $cond ) {
3196 foreach ( $values as $value ) {
3197 $cond[$field] = $value;
3198 $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
3199 }
3200 }
3201 $conds = $newConds;
3202 }
3203
3204 $extra_conds = $extra_conds === '' ? [] : (array)$extra_conds;
3205
3206 // If there's just one condition and no subordering, hand off to
3207 // selectSQLText directly.
3208 if ( count( $conds ) === 1 &&
3209 ( !isset( $options['INNER ORDER BY'] ) || !$this->unionSupportsOrderAndLimit() )
3210 ) {
3211 return $this->selectSQLText(
3212 $table, $vars, $conds[0] + $extra_conds, $fname, $options, $join_conds
3213 );
3214 }
3215
3216 // Otherwise, we need to pull out the order and limit to apply after
3217 // the union. Then build the SQL queries for each set of conditions in
3218 // $conds. Then union them together (using UNION ALL, because the
3219 // product *should* already be distinct).
3220 $orderBy = $this->makeOrderBy( $options );
3221 $limit = $options['LIMIT'] ?? null;
3222 $offset = $options['OFFSET'] ?? false;
3223 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
3224 if ( !$this->unionSupportsOrderAndLimit() ) {
3225 unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
3226 } else {
3227 if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
3228 $options['ORDER BY'] = $options['INNER ORDER BY'];
3229 }
3230 if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
3231 // We need to increase the limit by the offset rather than
3232 // using the offset directly, otherwise it'll skip incorrectly
3233 // in the subqueries.
3234 $options['LIMIT'] = $limit + $offset;
3235 unset( $options['OFFSET'] );
3236 }
3237 }
3238
3239 $sqls = [];
3240 foreach ( $conds as $cond ) {
3241 $sqls[] = $this->selectSQLText(
3242 $table, $vars, $cond + $extra_conds, $fname, $options, $join_conds
3243 );
3244 }
3245 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
3246 if ( $limit !== null ) {
3247 $sql = $this->limitResult( $sql, $limit, $offset );
3248 }
3249
3250 return $sql;
3251 }
3252
3253 public function conditional( $cond, $trueVal, $falseVal ) {
3254 if ( is_array( $cond ) ) {
3255 $cond = $this->makeList( $cond, self::LIST_AND );
3256 }
3257
3258 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3259 }
3260
3261 public function strreplace( $orig, $old, $new ) {
3262 return "REPLACE({$orig}, {$old}, {$new})";
3263 }
3264
3265 public function getServerUptime() {
3266 return 0;
3267 }
3268
3269 public function wasDeadlock() {
3270 return false;
3271 }
3272
3273 public function wasLockTimeout() {
3274 return false;
3275 }
3276
3277 public function wasConnectionLoss() {
3278 return $this->wasConnectionError( $this->lastErrno() );
3279 }
3280
3281 public function wasReadOnlyError() {
3282 return false;
3283 }
3284
3285 public function wasErrorReissuable() {
3286 return (
3287 $this->wasDeadlock() ||
3288 $this->wasLockTimeout() ||
3289 $this->wasConnectionLoss()
3290 );
3291 }
3292
3293 /**
3294 * Do not use this method outside of Database/DBError classes
3295 *
3296 * @param int|string $errno
3297 * @return bool Whether the given query error was a connection drop
3298 */
3299 public function wasConnectionError( $errno ) {
3300 return false;
3301 }
3302
3303 /**
3304 * @return bool Whether it is known that the last query error only caused statement rollback
3305 * @note This is for backwards compatibility for callers catching DBError exceptions in
3306 * order to ignore problems like duplicate key errors or foriegn key violations
3307 * @since 1.31
3308 */
3309 protected function wasKnownStatementRollbackError() {
3310 return false; // don't know; it could have caused a transaction rollback
3311 }
3312
3313 public function deadlockLoop() {
3314 $args = func_get_args();
3315 $function = array_shift( $args );
3316 $tries = self::DEADLOCK_TRIES;
3317
3318 $this->begin( __METHOD__ );
3319
3320 $retVal = null;
3321 /** @var Exception $e */
3322 $e = null;
3323 do {
3324 try {
3325 $retVal = $function( ...$args );
3326 break;
3327 } catch ( DBQueryError $e ) {
3328 if ( $this->wasDeadlock() ) {
3329 // Retry after a randomized delay
3330 usleep( mt_rand( self::DEADLOCK_DELAY_MIN, self::DEADLOCK_DELAY_MAX ) );
3331 } else {
3332 // Throw the error back up
3333 throw $e;
3334 }
3335 }
3336 } while ( --$tries > 0 );
3337
3338 if ( $tries <= 0 ) {
3339 // Too many deadlocks; give up
3340 $this->rollback( __METHOD__ );
3341 throw $e;
3342 } else {
3343 $this->commit( __METHOD__ );
3344
3345 return $retVal;
3346 }
3347 }
3348
3349 public function masterPosWait( DBMasterPos $pos, $timeout ) {
3350 # Real waits are implemented in the subclass.
3351 return 0;
3352 }
3353
3354 public function getReplicaPos() {
3355 # Stub
3356 return false;
3357 }
3358
3359 public function getMasterPos() {
3360 # Stub
3361 return false;
3362 }
3363
3364 public function serverIsReadOnly() {
3365 return false;
3366 }
3367
3368 final public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
3369 if ( !$this->trxLevel ) {
3370 throw new DBUnexpectedError( $this, "No transaction is active." );
3371 }
3372 $this->trxEndCallbacks[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3373 }
3374
3375 final public function onTransactionCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
3376 if ( !$this->trxLevel && $this->getTransactionRoundId() ) {
3377 // Start an implicit transaction similar to how query() does
3378 $this->begin( __METHOD__, self::TRANSACTION_INTERNAL );
3379 $this->trxAutomatic = true;
3380 }
3381
3382 $this->trxIdleCallbacks[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3383 if ( !$this->trxLevel ) {
3384 $this->runOnTransactionIdleCallbacks( self::TRIGGER_IDLE );
3385 }
3386 }
3387
3388 final public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
3389 $this->onTransactionCommitOrIdle( $callback, $fname );
3390 }
3391
3392 final public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
3393 if ( !$this->trxLevel && $this->getTransactionRoundId() ) {
3394 // Start an implicit transaction similar to how query() does
3395 $this->begin( __METHOD__, self::TRANSACTION_INTERNAL );
3396 $this->trxAutomatic = true;
3397 }
3398
3399 if ( $this->trxLevel ) {
3400 $this->trxPreCommitCallbacks[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3401 } else {
3402 // No transaction is active nor will start implicitly, so make one for this callback
3403 $this->startAtomic( __METHOD__, self::ATOMIC_CANCELABLE );
3404 try {
3405 $callback( $this );
3406 $this->endAtomic( __METHOD__ );
3407 } catch ( Exception $e ) {
3408 $this->cancelAtomic( __METHOD__ );
3409 throw $e;
3410 }
3411 }
3412 }
3413
3414 /**
3415 * @return AtomicSectionIdentifier|null ID of the topmost atomic section level
3416 */
3417 private function currentAtomicSectionId() {
3418 if ( $this->trxLevel && $this->trxAtomicLevels ) {
3419 $levelInfo = end( $this->trxAtomicLevels );
3420
3421 return $levelInfo[1];
3422 }
3423
3424 return null;
3425 }
3426
3427 /**
3428 * @param AtomicSectionIdentifier $old
3429 * @param AtomicSectionIdentifier $new
3430 */
3431 private function reassignCallbacksForSection(
3432 AtomicSectionIdentifier $old, AtomicSectionIdentifier $new
3433 ) {
3434 foreach ( $this->trxPreCommitCallbacks as $key => $info ) {
3435 if ( $info[2] === $old ) {
3436 $this->trxPreCommitCallbacks[$key][2] = $new;
3437 }
3438 }
3439 foreach ( $this->trxIdleCallbacks as $key => $info ) {
3440 if ( $info[2] === $old ) {
3441 $this->trxIdleCallbacks[$key][2] = $new;
3442 }
3443 }
3444 foreach ( $this->trxEndCallbacks as $key => $info ) {
3445 if ( $info[2] === $old ) {
3446 $this->trxEndCallbacks[$key][2] = $new;
3447 }
3448 }
3449 }
3450
3451 /**
3452 * @param AtomicSectionIdentifier[] $sectionIds ID of an actual savepoint
3453 * @throws UnexpectedValueException
3454 */
3455 private function modifyCallbacksForCancel( array $sectionIds ) {
3456 // Cancel the "on commit" callbacks owned by this savepoint
3457 $this->trxIdleCallbacks = array_filter(
3458 $this->trxIdleCallbacks,
3459 function ( $entry ) use ( $sectionIds ) {
3460 return !in_array( $entry[2], $sectionIds, true );
3461 }
3462 );
3463 $this->trxPreCommitCallbacks = array_filter(
3464 $this->trxPreCommitCallbacks,
3465 function ( $entry ) use ( $sectionIds ) {
3466 return !in_array( $entry[2], $sectionIds, true );
3467 }
3468 );
3469 // Make "on resolution" callbacks owned by this savepoint to perceive a rollback
3470 foreach ( $this->trxEndCallbacks as $key => $entry ) {
3471 if ( in_array( $entry[2], $sectionIds, true ) ) {
3472 $callback = $entry[0];
3473 $this->trxEndCallbacks[$key][0] = function () use ( $callback ) {
3474 return $callback( self::TRIGGER_ROLLBACK, $this );
3475 };
3476 }
3477 }
3478 }
3479
3480 final public function setTransactionListener( $name, callable $callback = null ) {
3481 if ( $callback ) {
3482 $this->trxRecurringCallbacks[$name] = $callback;
3483 } else {
3484 unset( $this->trxRecurringCallbacks[$name] );
3485 }
3486 }
3487
3488 /**
3489 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
3490 *
3491 * This method should not be used outside of Database/LoadBalancer
3492 *
3493 * @param bool $suppress
3494 * @since 1.28
3495 */
3496 final public function setTrxEndCallbackSuppression( $suppress ) {
3497 $this->trxEndCallbacksSuppressed = $suppress;
3498 }
3499
3500 /**
3501 * Actually consume and run any "on transaction idle/resolution" callbacks.
3502 *
3503 * This method should not be used outside of Database/LoadBalancer
3504 *
3505 * @param int $trigger IDatabase::TRIGGER_* constant
3506 * @return int Number of callbacks attempted
3507 * @since 1.20
3508 * @throws Exception
3509 */
3510 public function runOnTransactionIdleCallbacks( $trigger ) {
3511 if ( $this->trxLevel ) { // sanity
3512 throw new DBUnexpectedError( $this, __METHOD__ . ': a transaction is still open.' );
3513 }
3514
3515 if ( $this->trxEndCallbacksSuppressed ) {
3516 return 0;
3517 }
3518
3519 $count = 0;
3520 $autoTrx = $this->getFlag( self::DBO_TRX ); // automatic begin() enabled?
3521 /** @var Exception $e */
3522 $e = null; // first exception
3523 do { // callbacks may add callbacks :)
3524 $callbacks = array_merge(
3525 $this->trxIdleCallbacks,
3526 $this->trxEndCallbacks // include "transaction resolution" callbacks
3527 );
3528 $this->trxIdleCallbacks = []; // consumed (and recursion guard)
3529 $this->trxEndCallbacks = []; // consumed (recursion guard)
3530 foreach ( $callbacks as $callback ) {
3531 ++$count;
3532 list( $phpCallback ) = $callback;
3533 $this->clearFlag( self::DBO_TRX ); // make each query its own transaction
3534 try {
3535 // @phan-suppress-next-line PhanParamTooManyCallable
3536 call_user_func( $phpCallback, $trigger, $this );
3537 } catch ( Exception $ex ) {
3538 call_user_func( $this->errorLogger, $ex );
3539 $e = $e ?: $ex;
3540 // Some callbacks may use startAtomic/endAtomic, so make sure
3541 // their transactions are ended so other callbacks don't fail
3542 if ( $this->trxLevel() ) {
3543 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
3544 }
3545 } finally {
3546 if ( $autoTrx ) {
3547 $this->setFlag( self::DBO_TRX ); // restore automatic begin()
3548 } else {
3549 $this->clearFlag( self::DBO_TRX ); // restore auto-commit
3550 }
3551 }
3552 }
3553 } while ( count( $this->trxIdleCallbacks ) );
3554
3555 if ( $e instanceof Exception ) {
3556 throw $e; // re-throw any first exception
3557 }
3558
3559 return $count;
3560 }
3561
3562 /**
3563 * Actually consume and run any "on transaction pre-commit" callbacks.
3564 *
3565 * This method should not be used outside of Database/LoadBalancer
3566 *
3567 * @since 1.22
3568 * @return int Number of callbacks attempted
3569 * @throws Exception
3570 */
3571 public function runOnTransactionPreCommitCallbacks() {
3572 $count = 0;
3573
3574 $e = null; // first exception
3575 do { // callbacks may add callbacks :)
3576 $callbacks = $this->trxPreCommitCallbacks;
3577 $this->trxPreCommitCallbacks = []; // consumed (and recursion guard)
3578 foreach ( $callbacks as $callback ) {
3579 try {
3580 ++$count;
3581 list( $phpCallback ) = $callback;
3582 $phpCallback( $this );
3583 } catch ( Exception $ex ) {
3584 ( $this->errorLogger )( $ex );
3585 $e = $e ?: $ex;
3586 }
3587 }
3588 } while ( count( $this->trxPreCommitCallbacks ) );
3589
3590 if ( $e instanceof Exception ) {
3591 throw $e; // re-throw any first exception
3592 }
3593
3594 return $count;
3595 }
3596
3597 /**
3598 * Actually run any "transaction listener" callbacks.
3599 *
3600 * This method should not be used outside of Database/LoadBalancer
3601 *
3602 * @param int $trigger IDatabase::TRIGGER_* constant
3603 * @throws Exception
3604 * @since 1.20
3605 */
3606 public function runTransactionListenerCallbacks( $trigger ) {
3607 if ( $this->trxEndCallbacksSuppressed ) {
3608 return;
3609 }
3610
3611 /** @var Exception $e */
3612 $e = null; // first exception
3613
3614 foreach ( $this->trxRecurringCallbacks as $phpCallback ) {
3615 try {
3616 $phpCallback( $trigger, $this );
3617 } catch ( Exception $ex ) {
3618 ( $this->errorLogger )( $ex );
3619 $e = $e ?: $ex;
3620 }
3621 }
3622
3623 if ( $e instanceof Exception ) {
3624 throw $e; // re-throw any first exception
3625 }
3626 }
3627
3628 /**
3629 * Create a savepoint
3630 *
3631 * This is used internally to implement atomic sections. It should not be
3632 * used otherwise.
3633 *
3634 * @since 1.31
3635 * @param string $identifier Identifier for the savepoint
3636 * @param string $fname Calling function name
3637 */
3638 protected function doSavepoint( $identifier, $fname ) {
3639 $this->query( 'SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3640 }
3641
3642 /**
3643 * Release a savepoint
3644 *
3645 * This is used internally to implement atomic sections. It should not be
3646 * used otherwise.
3647 *
3648 * @since 1.31
3649 * @param string $identifier Identifier for the savepoint
3650 * @param string $fname Calling function name
3651 */
3652 protected function doReleaseSavepoint( $identifier, $fname ) {
3653 $this->query( 'RELEASE SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3654 }
3655
3656 /**
3657 * Rollback to a savepoint
3658 *
3659 * This is used internally to implement atomic sections. It should not be
3660 * used otherwise.
3661 *
3662 * @since 1.31
3663 * @param string $identifier Identifier for the savepoint
3664 * @param string $fname Calling function name
3665 */
3666 protected function doRollbackToSavepoint( $identifier, $fname ) {
3667 $this->query( 'ROLLBACK TO SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3668 }
3669
3670 /**
3671 * @param string $fname
3672 * @return string
3673 */
3674 private function nextSavepointId( $fname ) {
3675 $savepointId = self::$SAVEPOINT_PREFIX . ++$this->trxAtomicCounter;
3676 if ( strlen( $savepointId ) > 30 ) {
3677 // 30 == Oracle's identifier length limit (pre 12c)
3678 // With a 22 character prefix, that puts the highest number at 99999999.
3679 throw new DBUnexpectedError(
3680 $this,
3681 'There have been an excessively large number of atomic sections in a transaction'
3682 . " started by $this->trxFname (at $fname)"
3683 );
3684 }
3685
3686 return $savepointId;
3687 }
3688
3689 final public function startAtomic(
3690 $fname = __METHOD__, $cancelable = self::ATOMIC_NOT_CANCELABLE
3691 ) {
3692 $savepointId = $cancelable === self::ATOMIC_CANCELABLE ? self::$NOT_APPLICABLE : null;
3693
3694 if ( !$this->trxLevel ) {
3695 $this->begin( $fname, self::TRANSACTION_INTERNAL ); // sets trxAutomatic
3696 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3697 // in all changes being in one transaction to keep requests transactional.
3698 if ( $this->getFlag( self::DBO_TRX ) ) {
3699 // Since writes could happen in between the topmost atomic sections as part
3700 // of the transaction, those sections will need savepoints.
3701 $savepointId = $this->nextSavepointId( $fname );
3702 $this->doSavepoint( $savepointId, $fname );
3703 } else {
3704 $this->trxAutomaticAtomic = true;
3705 }
3706 } elseif ( $cancelable === self::ATOMIC_CANCELABLE ) {
3707 $savepointId = $this->nextSavepointId( $fname );
3708 $this->doSavepoint( $savepointId, $fname );
3709 }
3710
3711 $sectionId = new AtomicSectionIdentifier;
3712 $this->trxAtomicLevels[] = [ $fname, $sectionId, $savepointId ];
3713 $this->queryLogger->debug( 'startAtomic: entering level ' .
3714 ( count( $this->trxAtomicLevels ) - 1 ) . " ($fname)" );
3715
3716 return $sectionId;
3717 }
3718
3719 final public function endAtomic( $fname = __METHOD__ ) {
3720 if ( !$this->trxLevel || !$this->trxAtomicLevels ) {
3721 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3722 }
3723
3724 // Check if the current section matches $fname
3725 $pos = count( $this->trxAtomicLevels ) - 1;
3726 list( $savedFname, $sectionId, $savepointId ) = $this->trxAtomicLevels[$pos];
3727 $this->queryLogger->debug( "endAtomic: leaving level $pos ($fname)" );
3728
3729 if ( $savedFname !== $fname ) {
3730 throw new DBUnexpectedError(
3731 $this,
3732 "Invalid atomic section ended (got $fname but expected $savedFname)."
3733 );
3734 }
3735
3736 // Remove the last section (no need to re-index the array)
3737 array_pop( $this->trxAtomicLevels );
3738
3739 if ( !$this->trxAtomicLevels && $this->trxAutomaticAtomic ) {
3740 $this->commit( $fname, self::FLUSHING_INTERNAL );
3741 } elseif ( $savepointId !== null && $savepointId !== self::$NOT_APPLICABLE ) {
3742 $this->doReleaseSavepoint( $savepointId, $fname );
3743 }
3744
3745 // Hoist callback ownership for callbacks in the section that just ended;
3746 // all callbacks should have an owner that is present in trxAtomicLevels.
3747 $currentSectionId = $this->currentAtomicSectionId();
3748 if ( $currentSectionId ) {
3749 $this->reassignCallbacksForSection( $sectionId, $currentSectionId );
3750 }
3751 }
3752
3753 final public function cancelAtomic(
3754 $fname = __METHOD__, AtomicSectionIdentifier $sectionId = null
3755 ) {
3756 if ( !$this->trxLevel || !$this->trxAtomicLevels ) {
3757 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3758 }
3759
3760 $excisedFnames = [];
3761 if ( $sectionId !== null ) {
3762 // Find the (last) section with the given $sectionId
3763 $pos = -1;
3764 foreach ( $this->trxAtomicLevels as $i => list( $asFname, $asId, $spId ) ) {
3765 if ( $asId === $sectionId ) {
3766 $pos = $i;
3767 }
3768 }
3769 if ( $pos < 0 ) {
3770 throw new DBUnexpectedError( $this, "Atomic section not found (for $fname)" );
3771 }
3772 // Remove all descendant sections and re-index the array
3773 $excisedIds = [];
3774 $len = count( $this->trxAtomicLevels );
3775 for ( $i = $pos + 1; $i < $len; ++$i ) {
3776 $excisedFnames[] = $this->trxAtomicLevels[$i][0];
3777 $excisedIds[] = $this->trxAtomicLevels[$i][1];
3778 }
3779 $this->trxAtomicLevels = array_slice( $this->trxAtomicLevels, 0, $pos + 1 );
3780 $this->modifyCallbacksForCancel( $excisedIds );
3781 }
3782
3783 // Check if the current section matches $fname
3784 $pos = count( $this->trxAtomicLevels ) - 1;
3785 list( $savedFname, $savedSectionId, $savepointId ) = $this->trxAtomicLevels[$pos];
3786
3787 if ( $excisedFnames ) {
3788 $this->queryLogger->debug( "cancelAtomic: canceling level $pos ($savedFname) " .
3789 "and descendants " . implode( ', ', $excisedFnames ) );
3790 } else {
3791 $this->queryLogger->debug( "cancelAtomic: canceling level $pos ($savedFname)" );
3792 }
3793
3794 if ( $savedFname !== $fname ) {
3795 throw new DBUnexpectedError(
3796 $this,
3797 "Invalid atomic section ended (got $fname but expected $savedFname)."
3798 );
3799 }
3800
3801 // Remove the last section (no need to re-index the array)
3802 array_pop( $this->trxAtomicLevels );
3803 $this->modifyCallbacksForCancel( [ $savedSectionId ] );
3804
3805 if ( $savepointId !== null ) {
3806 // Rollback the transaction to the state just before this atomic section
3807 if ( $savepointId === self::$NOT_APPLICABLE ) {
3808 $this->rollback( $fname, self::FLUSHING_INTERNAL );
3809 } else {
3810 $this->doRollbackToSavepoint( $savepointId, $fname );
3811 $this->trxStatus = self::STATUS_TRX_OK; // no exception; recovered
3812 $this->trxStatusIgnoredCause = null;
3813 }
3814 } elseif ( $this->trxStatus > self::STATUS_TRX_ERROR ) {
3815 // Put the transaction into an error state if it's not already in one
3816 $this->trxStatus = self::STATUS_TRX_ERROR;
3817 $this->trxStatusCause = new DBUnexpectedError(
3818 $this,
3819 "Uncancelable atomic section canceled (got $fname)."
3820 );
3821 }
3822
3823 $this->affectedRowCount = 0; // for the sake of consistency
3824 }
3825
3826 final public function doAtomicSection(
3827 $fname, callable $callback, $cancelable = self::ATOMIC_NOT_CANCELABLE
3828 ) {
3829 $sectionId = $this->startAtomic( $fname, $cancelable );
3830 try {
3831 $res = $callback( $this, $fname );
3832 } catch ( Exception $e ) {
3833 $this->cancelAtomic( $fname, $sectionId );
3834
3835 throw $e;
3836 }
3837 $this->endAtomic( $fname );
3838
3839 return $res;
3840 }
3841
3842 final public function begin( $fname = __METHOD__, $mode = self::TRANSACTION_EXPLICIT ) {
3843 static $modes = [ self::TRANSACTION_EXPLICIT, self::TRANSACTION_INTERNAL ];
3844 if ( !in_array( $mode, $modes, true ) ) {
3845 throw new DBUnexpectedError( $this, "$fname: invalid mode parameter '$mode'." );
3846 }
3847
3848 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3849 if ( $this->trxLevel ) {
3850 if ( $this->trxAtomicLevels ) {
3851 $levels = $this->flatAtomicSectionList();
3852 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3853 throw new DBUnexpectedError( $this, $msg );
3854 } elseif ( !$this->trxAutomatic ) {
3855 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3856 throw new DBUnexpectedError( $this, $msg );
3857 } else {
3858 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3859 throw new DBUnexpectedError( $this, $msg );
3860 }
3861 } elseif ( $this->getFlag( self::DBO_TRX ) && $mode !== self::TRANSACTION_INTERNAL ) {
3862 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3863 throw new DBUnexpectedError( $this, $msg );
3864 }
3865
3866 $this->assertHasConnectionHandle();
3867
3868 $this->doBegin( $fname );
3869 $this->trxStatus = self::STATUS_TRX_OK;
3870 $this->trxStatusIgnoredCause = null;
3871 $this->trxAtomicCounter = 0;
3872 $this->trxTimestamp = microtime( true );
3873 $this->trxFname = $fname;
3874 $this->trxDoneWrites = false;
3875 $this->trxAutomaticAtomic = false;
3876 $this->trxAtomicLevels = [];
3877 $this->trxShortId = sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3878 $this->trxWriteDuration = 0.0;
3879 $this->trxWriteQueryCount = 0;
3880 $this->trxWriteAffectedRows = 0;
3881 $this->trxWriteAdjDuration = 0.0;
3882 $this->trxWriteAdjQueryCount = 0;
3883 $this->trxWriteCallers = [];
3884 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3885 // Get an estimate of the replication lag before any such queries.
3886 $this->trxReplicaLag = null; // clear cached value first
3887 $this->trxReplicaLag = $this->getApproximateLagStatus()['lag'];
3888 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3889 // caller will think its OK to muck around with the transaction just because startAtomic()
3890 // has not yet completed (e.g. setting trxAtomicLevels).
3891 $this->trxAutomatic = ( $mode === self::TRANSACTION_INTERNAL );
3892 }
3893
3894 /**
3895 * Issues the BEGIN command to the database server.
3896 *
3897 * @see Database::begin()
3898 * @param string $fname
3899 */
3900 protected function doBegin( $fname ) {
3901 $this->query( 'BEGIN', $fname );
3902 $this->trxLevel = 1;
3903 }
3904
3905 final public function commit( $fname = __METHOD__, $flush = self::FLUSHING_ONE ) {
3906 static $modes = [ self::FLUSHING_ONE, self::FLUSHING_ALL_PEERS, self::FLUSHING_INTERNAL ];
3907 if ( !in_array( $flush, $modes, true ) ) {
3908 throw new DBUnexpectedError( $this, "$fname: invalid flush parameter '$flush'." );
3909 }
3910
3911 if ( $this->trxLevel && $this->trxAtomicLevels ) {
3912 // There are still atomic sections open; this cannot be ignored
3913 $levels = $this->flatAtomicSectionList();
3914 throw new DBUnexpectedError(
3915 $this,
3916 "$fname: Got COMMIT while atomic sections $levels are still open."
3917 );
3918 }
3919
3920 if ( $flush === self::FLUSHING_INTERNAL || $flush === self::FLUSHING_ALL_PEERS ) {
3921 if ( !$this->trxLevel ) {
3922 return; // nothing to do
3923 } elseif ( !$this->trxAutomatic ) {
3924 throw new DBUnexpectedError(
3925 $this,
3926 "$fname: Flushing an explicit transaction, getting out of sync."
3927 );
3928 }
3929 } elseif ( !$this->trxLevel ) {
3930 $this->queryLogger->error(
3931 "$fname: No transaction to commit, something got out of sync." );
3932 return; // nothing to do
3933 } elseif ( $this->trxAutomatic ) {
3934 throw new DBUnexpectedError(
3935 $this,
3936 "$fname: Expected mass commit of all peer transactions (DBO_TRX set)."
3937 );
3938 }
3939
3940 $this->assertHasConnectionHandle();
3941
3942 $this->runOnTransactionPreCommitCallbacks();
3943
3944 $writeTime = $this->pendingWriteQueryDuration( self::ESTIMATE_DB_APPLY );
3945 $this->doCommit( $fname );
3946 $this->trxStatus = self::STATUS_TRX_NONE;
3947
3948 if ( $this->trxDoneWrites ) {
3949 $this->lastWriteTime = microtime( true );
3950 $this->trxProfiler->transactionWritingOut(
3951 $this->server,
3952 $this->getDomainID(),
3953 $this->trxShortId,
3954 $writeTime,
3955 $this->trxWriteAffectedRows
3956 );
3957 }
3958
3959 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3960 if ( $flush !== self::FLUSHING_ALL_PEERS ) {
3961 $this->runOnTransactionIdleCallbacks( self::TRIGGER_COMMIT );
3962 $this->runTransactionListenerCallbacks( self::TRIGGER_COMMIT );
3963 }
3964 }
3965
3966 /**
3967 * Issues the COMMIT command to the database server.
3968 *
3969 * @see Database::commit()
3970 * @param string $fname
3971 */
3972 protected function doCommit( $fname ) {
3973 if ( $this->trxLevel ) {
3974 $this->query( 'COMMIT', $fname );
3975 $this->trxLevel = 0;
3976 }
3977 }
3978
3979 final public function rollback( $fname = __METHOD__, $flush = '' ) {
3980 $trxActive = $this->trxLevel;
3981
3982 if ( $flush !== self::FLUSHING_INTERNAL
3983 && $flush !== self::FLUSHING_ALL_PEERS
3984 && $this->getFlag( self::DBO_TRX )
3985 ) {
3986 throw new DBUnexpectedError(
3987 $this,
3988 "$fname: Expected mass rollback of all peer transactions (DBO_TRX set)."
3989 );
3990 }
3991
3992 if ( $trxActive ) {
3993 $this->assertHasConnectionHandle();
3994
3995 $this->doRollback( $fname );
3996 $this->trxStatus = self::STATUS_TRX_NONE;
3997 $this->trxAtomicLevels = [];
3998 // Estimate the RTT via a query now that trxStatus is OK
3999 $writeTime = $this->pingAndCalculateLastTrxApplyTime();
4000
4001 if ( $this->trxDoneWrites ) {
4002 $this->trxProfiler->transactionWritingOut(
4003 $this->server,
4004 $this->getDomainID(),
4005 $this->trxShortId,
4006 $writeTime,
4007 $this->trxWriteAffectedRows
4008 );
4009 }
4010 }
4011
4012 // Clear any commit-dependant callbacks. They might even be present
4013 // only due to transaction rounds, with no SQL transaction being active
4014 $this->trxIdleCallbacks = [];
4015 $this->trxPreCommitCallbacks = [];
4016
4017 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
4018 if ( $trxActive && $flush !== self::FLUSHING_ALL_PEERS ) {
4019 try {
4020 $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
4021 } catch ( Exception $e ) {
4022 // already logged; finish and let LoadBalancer move on during mass-rollback
4023 }
4024 try {
4025 $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
4026 } catch ( Exception $e ) {
4027 // already logged; let LoadBalancer move on during mass-rollback
4028 }
4029
4030 $this->affectedRowCount = 0; // for the sake of consistency
4031 }
4032 }
4033
4034 /**
4035 * Issues the ROLLBACK command to the database server.
4036 *
4037 * @see Database::rollback()
4038 * @param string $fname
4039 */
4040 protected function doRollback( $fname ) {
4041 if ( $this->trxLevel ) {
4042 # Disconnects cause rollback anyway, so ignore those errors
4043 $ignoreErrors = true;
4044 $this->query( 'ROLLBACK', $fname, $ignoreErrors );
4045 $this->trxLevel = 0;
4046 }
4047 }
4048
4049 public function flushSnapshot( $fname = __METHOD__ ) {
4050 if ( $this->writesOrCallbacksPending() || $this->explicitTrxActive() ) {
4051 // This only flushes transactions to clear snapshots, not to write data
4052 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4053 throw new DBUnexpectedError(
4054 $this,
4055 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
4056 );
4057 }
4058
4059 $this->commit( $fname, self::FLUSHING_INTERNAL );
4060 }
4061
4062 public function explicitTrxActive() {
4063 return $this->trxLevel && ( $this->trxAtomicLevels || !$this->trxAutomatic );
4064 }
4065
4066 public function duplicateTableStructure(
4067 $oldName, $newName, $temporary = false, $fname = __METHOD__
4068 ) {
4069 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
4070 }
4071
4072 public function listTables( $prefix = null, $fname = __METHOD__ ) {
4073 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
4074 }
4075
4076 public function listViews( $prefix = null, $fname = __METHOD__ ) {
4077 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
4078 }
4079
4080 public function timestamp( $ts = 0 ) {
4081 $t = new ConvertibleTimestamp( $ts );
4082 // Let errors bubble up to avoid putting garbage in the DB
4083 return $t->getTimestamp( TS_MW );
4084 }
4085
4086 public function timestampOrNull( $ts = null ) {
4087 if ( is_null( $ts ) ) {
4088 return null;
4089 } else {
4090 return $this->timestamp( $ts );
4091 }
4092 }
4093
4094 public function affectedRows() {
4095 return ( $this->affectedRowCount === null )
4096 ? $this->fetchAffectedRowCount() // default to driver value
4097 : $this->affectedRowCount;
4098 }
4099
4100 /**
4101 * @return int Number of retrieved rows according to the driver
4102 */
4103 abstract protected function fetchAffectedRowCount();
4104
4105 /**
4106 * Take the result from a query, and wrap it in a ResultWrapper if
4107 * necessary. Boolean values are passed through as is, to indicate success
4108 * of write queries or failure.
4109 *
4110 * Once upon a time, Database::query() returned a bare MySQL result
4111 * resource, and it was necessary to call this function to convert it to
4112 * a wrapper. Nowadays, raw database objects are never exposed to external
4113 * callers, so this is unnecessary in external code.
4114 *
4115 * @param bool|ResultWrapper|resource $result
4116 * @return bool|ResultWrapper
4117 */
4118 protected function resultObject( $result ) {
4119 if ( !$result ) {
4120 return false;
4121 } elseif ( $result instanceof ResultWrapper ) {
4122 return $result;
4123 } elseif ( $result === true ) {
4124 // Successful write query
4125 return $result;
4126 } else {
4127 return new ResultWrapper( $this, $result );
4128 }
4129 }
4130
4131 public function ping( &$rtt = null ) {
4132 // Avoid hitting the server if it was hit recently
4133 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing ) < self::PING_TTL ) {
4134 if ( !func_num_args() || $this->rttEstimate > 0 ) {
4135 $rtt = $this->rttEstimate;
4136 return true; // don't care about $rtt
4137 }
4138 }
4139
4140 // This will reconnect if possible or return false if not
4141 $this->clearFlag( self::DBO_TRX, self::REMEMBER_PRIOR );
4142 $ok = ( $this->query( self::PING_QUERY, __METHOD__, true ) !== false );
4143 $this->restoreFlags( self::RESTORE_PRIOR );
4144
4145 if ( $ok ) {
4146 $rtt = $this->rttEstimate;
4147 }
4148
4149 return $ok;
4150 }
4151
4152 /**
4153 * Close any existing (dead) database connection and open a new connection
4154 *
4155 * @param string $fname
4156 * @return bool True if new connection is opened successfully, false if error
4157 */
4158 protected function replaceLostConnection( $fname ) {
4159 $this->closeConnection();
4160 $this->opened = false;
4161 $this->conn = false;
4162
4163 $this->handleSessionLossPreconnect();
4164
4165 try {
4166 $this->open(
4167 $this->server,
4168 $this->user,
4169 $this->password,
4170 $this->getDBname(),
4171 $this->dbSchema(),
4172 $this->tablePrefix()
4173 );
4174 $this->lastPing = microtime( true );
4175 $ok = true;
4176
4177 $this->connLogger->warning(
4178 $fname . ': lost connection to {dbserver}; reconnected',
4179 [
4180 'dbserver' => $this->getServer(),
4181 'trace' => ( new RuntimeException() )->getTraceAsString()
4182 ]
4183 );
4184 } catch ( DBConnectionError $e ) {
4185 $ok = false;
4186
4187 $this->connLogger->error(
4188 $fname . ': lost connection to {dbserver} permanently',
4189 [ 'dbserver' => $this->getServer() ]
4190 );
4191 }
4192
4193 $this->handleSessionLossPostconnect();
4194
4195 return $ok;
4196 }
4197
4198 public function getSessionLagStatus() {
4199 return $this->getRecordedTransactionLagStatus() ?: $this->getApproximateLagStatus();
4200 }
4201
4202 /**
4203 * Get the replica DB lag when the current transaction started
4204 *
4205 * This is useful when transactions might use snapshot isolation
4206 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
4207 * is this lag plus transaction duration. If they don't, it is still
4208 * safe to be pessimistic. This returns null if there is no transaction.
4209 *
4210 * This returns null if the lag status for this transaction was not yet recorded.
4211 *
4212 * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
4213 * @since 1.27
4214 */
4215 final protected function getRecordedTransactionLagStatus() {
4216 return ( $this->trxLevel && $this->trxReplicaLag !== null )
4217 ? [ 'lag' => $this->trxReplicaLag, 'since' => $this->trxTimestamp() ]
4218 : null;
4219 }
4220
4221 /**
4222 * Get a replica DB lag estimate for this server
4223 *
4224 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
4225 * @since 1.27
4226 */
4227 protected function getApproximateLagStatus() {
4228 return [
4229 'lag' => $this->getLBInfo( 'replica' ) ? $this->getLag() : 0,
4230 'since' => microtime( true )
4231 ];
4232 }
4233
4234 /**
4235 * Merge the result of getSessionLagStatus() for several DBs
4236 * using the most pessimistic values to estimate the lag of
4237 * any data derived from them in combination
4238 *
4239 * This is information is useful for caching modules
4240 *
4241 * @see WANObjectCache::set()
4242 * @see WANObjectCache::getWithSetCallback()
4243 *
4244 * @param IDatabase $db1
4245 * @param IDatabase|null $db2 [optional]
4246 * @return array Map of values:
4247 * - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
4248 * - since: oldest UNIX timestamp of any of the DB lag estimates
4249 * - pending: whether any of the DBs have uncommitted changes
4250 * @throws DBError
4251 * @since 1.27
4252 */
4253 public static function getCacheSetOptions( IDatabase $db1, IDatabase $db2 = null ) {
4254 $res = [ 'lag' => 0, 'since' => INF, 'pending' => false ];
4255 foreach ( func_get_args() as $db ) {
4256 /** @var IDatabase $db */
4257 $status = $db->getSessionLagStatus();
4258 if ( $status['lag'] === false ) {
4259 $res['lag'] = false;
4260 } elseif ( $res['lag'] !== false ) {
4261 $res['lag'] = max( $res['lag'], $status['lag'] );
4262 }
4263 $res['since'] = min( $res['since'], $status['since'] );
4264 $res['pending'] = $res['pending'] ?: $db->writesPending();
4265 }
4266
4267 return $res;
4268 }
4269
4270 public function getLag() {
4271 return 0;
4272 }
4273
4274 public function maxListLen() {
4275 return 0;
4276 }
4277
4278 public function encodeBlob( $b ) {
4279 return $b;
4280 }
4281
4282 public function decodeBlob( $b ) {
4283 if ( $b instanceof Blob ) {
4284 $b = $b->fetch();
4285 }
4286 return $b;
4287 }
4288
4289 public function setSessionOptions( array $options ) {
4290 }
4291
4292 public function sourceFile(
4293 $filename,
4294 callable $lineCallback = null,
4295 callable $resultCallback = null,
4296 $fname = false,
4297 callable $inputCallback = null
4298 ) {
4299 Wikimedia\suppressWarnings();
4300 $fp = fopen( $filename, 'r' );
4301 Wikimedia\restoreWarnings();
4302
4303 if ( $fp === false ) {
4304 throw new RuntimeException( "Could not open \"{$filename}\".\n" );
4305 }
4306
4307 if ( !$fname ) {
4308 $fname = __METHOD__ . "( $filename )";
4309 }
4310
4311 try {
4312 $error = $this->sourceStream(
4313 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
4314 } catch ( Exception $e ) {
4315 fclose( $fp );
4316 throw $e;
4317 }
4318
4319 fclose( $fp );
4320
4321 return $error;
4322 }
4323
4324 public function setSchemaVars( $vars ) {
4325 $this->schemaVars = $vars;
4326 }
4327
4328 public function sourceStream(
4329 $fp,
4330 callable $lineCallback = null,
4331 callable $resultCallback = null,
4332 $fname = __METHOD__,
4333 callable $inputCallback = null
4334 ) {
4335 $delimiterReset = new ScopedCallback(
4336 function ( $delimiter ) {
4337 $this->delimiter = $delimiter;
4338 },
4339 [ $this->delimiter ]
4340 );
4341 $cmd = '';
4342
4343 while ( !feof( $fp ) ) {
4344 if ( $lineCallback ) {
4345 call_user_func( $lineCallback );
4346 }
4347
4348 $line = trim( fgets( $fp ) );
4349
4350 if ( $line == '' ) {
4351 continue;
4352 }
4353
4354 if ( $line[0] == '-' && $line[1] == '-' ) {
4355 continue;
4356 }
4357
4358 if ( $cmd != '' ) {
4359 $cmd .= ' ';
4360 }
4361
4362 $done = $this->streamStatementEnd( $cmd, $line );
4363
4364 $cmd .= "$line\n";
4365
4366 if ( $done || feof( $fp ) ) {
4367 $cmd = $this->replaceVars( $cmd );
4368
4369 if ( $inputCallback ) {
4370 $callbackResult = $inputCallback( $cmd );
4371
4372 if ( is_string( $callbackResult ) || !$callbackResult ) {
4373 $cmd = $callbackResult;
4374 }
4375 }
4376
4377 if ( $cmd ) {
4378 $res = $this->query( $cmd, $fname );
4379
4380 if ( $resultCallback ) {
4381 $resultCallback( $res, $this );
4382 }
4383
4384 if ( $res === false ) {
4385 $err = $this->lastError();
4386
4387 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4388 }
4389 }
4390 $cmd = '';
4391 }
4392 }
4393
4394 ScopedCallback::consume( $delimiterReset );
4395 return true;
4396 }
4397
4398 /**
4399 * Called by sourceStream() to check if we've reached a statement end
4400 *
4401 * @param string &$sql SQL assembled so far
4402 * @param string &$newLine New line about to be added to $sql
4403 * @return bool Whether $newLine contains end of the statement
4404 */
4405 public function streamStatementEnd( &$sql, &$newLine ) {
4406 if ( $this->delimiter ) {
4407 $prev = $newLine;
4408 $newLine = preg_replace(
4409 '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine );
4410 if ( $newLine != $prev ) {
4411 return true;
4412 }
4413 }
4414
4415 return false;
4416 }
4417
4418 /**
4419 * Database independent variable replacement. Replaces a set of variables
4420 * in an SQL statement with their contents as given by $this->getSchemaVars().
4421 *
4422 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4423 *
4424 * - '{$var}' should be used for text and is passed through the database's
4425 * addQuotes method.
4426 * - `{$var}` should be used for identifiers (e.g. table and database names).
4427 * It is passed through the database's addIdentifierQuotes method which
4428 * can be overridden if the database uses something other than backticks.
4429 * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
4430 * database's tableName method.
4431 * - / *i* / passes the name that follows through the database's indexName method.
4432 * - In all other cases, / *$var* / is left unencoded. Except for table options,
4433 * its use should be avoided. In 1.24 and older, string encoding was applied.
4434 *
4435 * @param string $ins SQL statement to replace variables in
4436 * @return string The new SQL statement with variables replaced
4437 */
4438 protected function replaceVars( $ins ) {
4439 $vars = $this->getSchemaVars();
4440 return preg_replace_callback(
4441 '!
4442 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
4443 \'\{\$ (\w+) }\' | # 3. addQuotes
4444 `\{\$ (\w+) }` | # 4. addIdentifierQuotes
4445 /\*\$ (\w+) \*/ # 5. leave unencoded
4446 !x',
4447 function ( $m ) use ( $vars ) {
4448 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
4449 // check for both nonexistent keys *and* the empty string.
4450 if ( isset( $m[1] ) && $m[1] !== '' ) {
4451 if ( $m[1] === 'i' ) {
4452 return $this->indexName( $m[2] );
4453 } else {
4454 return $this->tableName( $m[2] );
4455 }
4456 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
4457 return $this->addQuotes( $vars[$m[3]] );
4458 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
4459 return $this->addIdentifierQuotes( $vars[$m[4]] );
4460 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
4461 return $vars[$m[5]];
4462 } else {
4463 return $m[0];
4464 }
4465 },
4466 $ins
4467 );
4468 }
4469
4470 /**
4471 * Get schema variables. If none have been set via setSchemaVars(), then
4472 * use some defaults from the current object.
4473 *
4474 * @return array
4475 */
4476 protected function getSchemaVars() {
4477 if ( $this->schemaVars ) {
4478 return $this->schemaVars;
4479 } else {
4480 return $this->getDefaultSchemaVars();
4481 }
4482 }
4483
4484 /**
4485 * Get schema variables to use if none have been set via setSchemaVars().
4486 *
4487 * Override this in derived classes to provide variables for tables.sql
4488 * and SQL patch files.
4489 *
4490 * @return array
4491 */
4492 protected function getDefaultSchemaVars() {
4493 return [];
4494 }
4495
4496 public function lockIsFree( $lockName, $method ) {
4497 // RDBMs methods for checking named locks may or may not count this thread itself.
4498 // In MySQL, IS_FREE_LOCK() returns 0 if the thread already has the lock. This is
4499 // the behavior choosen by the interface for this method.
4500 return !isset( $this->namedLocksHeld[$lockName] );
4501 }
4502
4503 public function lock( $lockName, $method, $timeout = 5 ) {
4504 $this->namedLocksHeld[$lockName] = 1;
4505
4506 return true;
4507 }
4508
4509 public function unlock( $lockName, $method ) {
4510 unset( $this->namedLocksHeld[$lockName] );
4511
4512 return true;
4513 }
4514
4515 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
4516 if ( $this->writesOrCallbacksPending() ) {
4517 // This only flushes transactions to clear snapshots, not to write data
4518 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4519 throw new DBUnexpectedError(
4520 $this,
4521 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
4522 );
4523 }
4524
4525 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
4526 return null;
4527 }
4528
4529 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
4530 if ( $this->trxLevel() ) {
4531 // There is a good chance an exception was thrown, causing any early return
4532 // from the caller. Let any error handler get a chance to issue rollback().
4533 // If there isn't one, let the error bubble up and trigger server-side rollback.
4534 $this->onTransactionResolution(
4535 function () use ( $lockKey, $fname ) {
4536 $this->unlock( $lockKey, $fname );
4537 },
4538 $fname
4539 );
4540 } else {
4541 $this->unlock( $lockKey, $fname );
4542 }
4543 } );
4544
4545 $this->commit( $fname, self::FLUSHING_INTERNAL );
4546
4547 return $unlocker;
4548 }
4549
4550 public function namedLocksEnqueue() {
4551 return false;
4552 }
4553
4554 public function tableLocksHaveTransactionScope() {
4555 return true;
4556 }
4557
4558 final public function lockTables( array $read, array $write, $method ) {
4559 if ( $this->writesOrCallbacksPending() ) {
4560 throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
4561 }
4562
4563 if ( $this->tableLocksHaveTransactionScope() ) {
4564 $this->startAtomic( $method );
4565 }
4566
4567 return $this->doLockTables( $read, $write, $method );
4568 }
4569
4570 /**
4571 * Helper function for lockTables() that handles the actual table locking
4572 *
4573 * @param array $read Array of tables to lock for read access
4574 * @param array $write Array of tables to lock for write access
4575 * @param string $method Name of caller
4576 * @return true
4577 */
4578 protected function doLockTables( array $read, array $write, $method ) {
4579 return true;
4580 }
4581
4582 final public function unlockTables( $method ) {
4583 if ( $this->tableLocksHaveTransactionScope() ) {
4584 $this->endAtomic( $method );
4585
4586 return true; // locks released on COMMIT/ROLLBACK
4587 }
4588
4589 return $this->doUnlockTables( $method );
4590 }
4591
4592 /**
4593 * Helper function for unlockTables() that handles the actual table unlocking
4594 *
4595 * @param string $method Name of caller
4596 * @return true
4597 */
4598 protected function doUnlockTables( $method ) {
4599 return true;
4600 }
4601
4602 /**
4603 * Delete a table
4604 * @param string $tableName
4605 * @param string $fName
4606 * @return bool|ResultWrapper
4607 * @since 1.18
4608 */
4609 public function dropTable( $tableName, $fName = __METHOD__ ) {
4610 if ( !$this->tableExists( $tableName, $fName ) ) {
4611 return false;
4612 }
4613 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
4614
4615 return $this->query( $sql, $fName );
4616 }
4617
4618 public function getInfinity() {
4619 return 'infinity';
4620 }
4621
4622 public function encodeExpiry( $expiry ) {
4623 return ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() )
4624 ? $this->getInfinity()
4625 : $this->timestamp( $expiry );
4626 }
4627
4628 public function decodeExpiry( $expiry, $format = TS_MW ) {
4629 if ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() ) {
4630 return 'infinity';
4631 }
4632
4633 return ConvertibleTimestamp::convert( $format, $expiry );
4634 }
4635
4636 public function setBigSelects( $value = true ) {
4637 // no-op
4638 }
4639
4640 public function isReadOnly() {
4641 return ( $this->getReadOnlyReason() !== false );
4642 }
4643
4644 /**
4645 * @return string|bool Reason this DB is read-only or false if it is not
4646 */
4647 protected function getReadOnlyReason() {
4648 $reason = $this->getLBInfo( 'readOnlyReason' );
4649
4650 return is_string( $reason ) ? $reason : false;
4651 }
4652
4653 public function setTableAliases( array $aliases ) {
4654 $this->tableAliases = $aliases;
4655 }
4656
4657 public function setIndexAliases( array $aliases ) {
4658 $this->indexAliases = $aliases;
4659 }
4660
4661 /**
4662 * @param int $field
4663 * @param int $flags
4664 * @return bool
4665 */
4666 protected function hasFlags( $field, $flags ) {
4667 return ( ( $field & $flags ) === $flags );
4668 }
4669
4670 /**
4671 * Get the underlying binding connection handle
4672 *
4673 * Makes sure the connection resource is set (disconnects and ping() failure can unset it).
4674 * This catches broken callers than catch and ignore disconnection exceptions.
4675 * Unlike checking isOpen(), this is safe to call inside of open().
4676 *
4677 * @return mixed
4678 * @throws DBUnexpectedError
4679 * @since 1.26
4680 */
4681 protected function getBindingHandle() {
4682 if ( !$this->conn ) {
4683 throw new DBUnexpectedError(
4684 $this,
4685 'DB connection was already closed or the connection dropped.'
4686 );
4687 }
4688
4689 return $this->conn;
4690 }
4691
4692 /**
4693 * @since 1.19
4694 * @return string
4695 */
4696 public function __toString() {
4697 return (string)$this->conn;
4698 }
4699
4700 /**
4701 * Make sure that copies do not share the same client binding handle
4702 * @throws DBConnectionError
4703 */
4704 public function __clone() {
4705 $this->connLogger->warning(
4706 "Cloning " . static::class . " is not recommended; forking connection:\n" .
4707 ( new RuntimeException() )->getTraceAsString()
4708 );
4709
4710 if ( $this->isOpen() ) {
4711 // Open a new connection resource without messing with the old one
4712 $this->opened = false;
4713 $this->conn = false;
4714 $this->trxEndCallbacks = []; // don't copy
4715 $this->handleSessionLossPreconnect(); // no trx or locks anymore
4716 $this->open(
4717 $this->server,
4718 $this->user,
4719 $this->password,
4720 $this->getDBname(),
4721 $this->dbSchema(),
4722 $this->tablePrefix()
4723 );
4724 $this->lastPing = microtime( true );
4725 }
4726 }
4727
4728 /**
4729 * Called by serialize. Throw an exception when DB connection is serialized.
4730 * This causes problems on some database engines because the connection is
4731 * not restored on unserialize.
4732 */
4733 public function __sleep() {
4734 throw new RuntimeException( 'Database serialization may cause problems, since ' .
4735 'the connection is not restored on wakeup.' );
4736 }
4737
4738 /**
4739 * Run a few simple sanity checks and close dangling connections
4740 */
4741 public function __destruct() {
4742 if ( $this->trxLevel && $this->trxDoneWrites ) {
4743 trigger_error( "Uncommitted DB writes (transaction from {$this->trxFname})." );
4744 }
4745
4746 $danglingWriters = $this->pendingWriteAndCallbackCallers();
4747 if ( $danglingWriters ) {
4748 $fnames = implode( ', ', $danglingWriters );
4749 trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
4750 }
4751
4752 if ( $this->conn ) {
4753 // Avoid connection leaks for sanity. Normally, resources close at script completion.
4754 // The connection might already be closed in zend/hhvm by now, so suppress warnings.
4755 Wikimedia\suppressWarnings();
4756 $this->closeConnection();
4757 Wikimedia\restoreWarnings();
4758 $this->conn = false;
4759 $this->opened = false;
4760 }
4761 }
4762 }
4763
4764 /**
4765 * @deprecated since 1.28
4766 */
4767 class_alias( Database::class, 'DatabaseBase' );
4768
4769 /**
4770 * @deprecated since 1.29
4771 */
4772 class_alias( Database::class, 'Database' );