2c59963c6ded235a7427da8ae60d41d50668a47b
[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 InvalidArgumentException;
37 use Exception;
38 use RuntimeException;
39
40 /**
41 * Relational database abstraction object
42 *
43 * @ingroup Database
44 * @since 1.28
45 */
46 abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAwareInterface {
47 /** Number of times to re-try an operation in case of deadlock */
48 const DEADLOCK_TRIES = 4;
49 /** Minimum time to wait before retry, in microseconds */
50 const DEADLOCK_DELAY_MIN = 500000;
51 /** Maximum time to wait before retry */
52 const DEADLOCK_DELAY_MAX = 1500000;
53
54 /** How long before it is worth doing a dummy query to test the connection */
55 const PING_TTL = 1.0;
56 const PING_QUERY = 'SELECT 1 AS ping';
57
58 const TINY_WRITE_SEC = 0.010;
59 const SLOW_WRITE_SEC = 0.500;
60 const SMALL_WRITE_ROWS = 100;
61
62 /** @var string Whether lock granularity is on the level of the entire database */
63 const ATTR_DB_LEVEL_LOCKING = 'db-level-locking';
64
65 /** @var string SQL query */
66 protected $lastQuery = '';
67 /** @var float|bool UNIX timestamp of last write query */
68 protected $lastWriteTime = false;
69 /** @var string|bool */
70 protected $phpError = false;
71 /** @var string */
72 protected $server;
73 /** @var string */
74 protected $user;
75 /** @var string */
76 protected $password;
77 /** @var string */
78 protected $dbName;
79 /** @var array[] $aliases Map of (table => (dbname, schema, prefix) map) */
80 protected $tableAliases = [];
81 /** @var bool Whether this PHP instance is for a CLI script */
82 protected $cliMode;
83 /** @var string Agent name for query profiling */
84 protected $agent;
85
86 /** @var BagOStuff APC cache */
87 protected $srvCache;
88 /** @var LoggerInterface */
89 protected $connLogger;
90 /** @var LoggerInterface */
91 protected $queryLogger;
92 /** @var callback Error logging callback */
93 protected $errorLogger;
94
95 /** @var resource|null Database connection */
96 protected $conn = null;
97 /** @var bool */
98 protected $opened = false;
99
100 /** @var array[] List of (callable, method name) */
101 protected $trxIdleCallbacks = [];
102 /** @var array[] List of (callable, method name) */
103 protected $trxPreCommitCallbacks = [];
104 /** @var array[] List of (callable, method name) */
105 protected $trxEndCallbacks = [];
106 /** @var callable[] Map of (name => callable) */
107 protected $trxRecurringCallbacks = [];
108 /** @var bool Whether to suppress triggering of transaction end callbacks */
109 protected $trxEndCallbacksSuppressed = false;
110
111 /** @var string */
112 protected $tablePrefix = '';
113 /** @var string */
114 protected $schema = '';
115 /** @var int */
116 protected $flags;
117 /** @var array */
118 protected $lbInfo = [];
119 /** @var array|bool */
120 protected $schemaVars = false;
121 /** @var array */
122 protected $sessionVars = [];
123 /** @var array|null */
124 protected $preparedArgs;
125 /** @var string|bool|null Stashed value of html_errors INI setting */
126 protected $htmlErrors;
127 /** @var string */
128 protected $delimiter = ';';
129 /** @var DatabaseDomain */
130 protected $currentDomain;
131 /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
132 protected $affectedRowCount;
133
134 /**
135 * Either 1 if a transaction is active or 0 otherwise.
136 * The other Trx fields may not be meaningfull if this is 0.
137 *
138 * @var int
139 */
140 protected $trxLevel = 0;
141 /**
142 * Either a short hexidecimal string if a transaction is active or ""
143 *
144 * @var string
145 * @see Database::trxLevel
146 */
147 protected $trxShortId = '';
148 /**
149 * The UNIX time that the transaction started. Callers can assume that if
150 * snapshot isolation is used, then the data is *at least* up to date to that
151 * point (possibly more up-to-date since the first SELECT defines the snapshot).
152 *
153 * @var float|null
154 * @see Database::trxLevel
155 */
156 private $trxTimestamp = null;
157 /** @var float Lag estimate at the time of BEGIN */
158 private $trxReplicaLag = null;
159 /**
160 * Remembers the function name given for starting the most recent transaction via begin().
161 * Used to provide additional context for error reporting.
162 *
163 * @var string
164 * @see Database::trxLevel
165 */
166 private $trxFname = null;
167 /**
168 * Record if possible write queries were done in the last transaction started
169 *
170 * @var bool
171 * @see Database::trxLevel
172 */
173 private $trxDoneWrites = false;
174 /**
175 * Record if the current transaction was started implicitly due to DBO_TRX being set.
176 *
177 * @var bool
178 * @see Database::trxLevel
179 */
180 private $trxAutomatic = false;
181 /**
182 * Array of levels of atomicity within transactions
183 *
184 * @var array
185 */
186 private $trxAtomicLevels = [];
187 /**
188 * Record if the current transaction was started implicitly by Database::startAtomic
189 *
190 * @var bool
191 */
192 private $trxAutomaticAtomic = false;
193 /**
194 * Track the write query callers of the current transaction
195 *
196 * @var string[]
197 */
198 private $trxWriteCallers = [];
199 /**
200 * @var float Seconds spent in write queries for the current transaction
201 */
202 private $trxWriteDuration = 0.0;
203 /**
204 * @var int Number of write queries for the current transaction
205 */
206 private $trxWriteQueryCount = 0;
207 /**
208 * @var int Number of rows affected by write queries for the current transaction
209 */
210 private $trxWriteAffectedRows = 0;
211 /**
212 * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
213 */
214 private $trxWriteAdjDuration = 0.0;
215 /**
216 * @var int Number of write queries counted in trxWriteAdjDuration
217 */
218 private $trxWriteAdjQueryCount = 0;
219 /**
220 * @var float RTT time estimate
221 */
222 private $rttEstimate = 0.0;
223
224 /** @var array Map of (name => 1) for locks obtained via lock() */
225 private $namedLocksHeld = [];
226 /** @var array Map of (table name => 1) for TEMPORARY tables */
227 protected $sessionTempTables = [];
228
229 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
230 private $lazyMasterHandle;
231
232 /** @var float UNIX timestamp */
233 protected $lastPing = 0.0;
234
235 /** @var int[] Prior flags member variable values */
236 private $priorFlags = [];
237
238 /** @var object|string Class name or object With profileIn/profileOut methods */
239 protected $profiler;
240 /** @var TransactionProfiler */
241 protected $trxProfiler;
242
243 /** @var int */
244 protected $nonNativeInsertSelectBatchSize = 10000;
245
246 /**
247 * Constructor and database handle and attempt to connect to the DB server
248 *
249 * IDatabase classes should not be constructed directly in external
250 * code. Database::factory() should be used instead.
251 *
252 * @param array $params Parameters passed from Database::factory()
253 */
254 function __construct( array $params ) {
255 $server = $params['host'];
256 $user = $params['user'];
257 $password = $params['password'];
258 $dbName = $params['dbname'];
259
260 $this->schema = $params['schema'];
261 $this->tablePrefix = $params['tablePrefix'];
262
263 $this->cliMode = $params['cliMode'];
264 // Agent name is added to SQL queries in a comment, so make sure it can't break out
265 $this->agent = str_replace( '/', '-', $params['agent'] );
266
267 $this->flags = $params['flags'];
268 if ( $this->flags & self::DBO_DEFAULT ) {
269 if ( $this->cliMode ) {
270 $this->flags &= ~self::DBO_TRX;
271 } else {
272 $this->flags |= self::DBO_TRX;
273 }
274 }
275
276 $this->sessionVars = $params['variables'];
277
278 $this->srvCache = isset( $params['srvCache'] )
279 ? $params['srvCache']
280 : new HashBagOStuff();
281
282 $this->profiler = $params['profiler'];
283 $this->trxProfiler = $params['trxProfiler'];
284 $this->connLogger = $params['connLogger'];
285 $this->queryLogger = $params['queryLogger'];
286 $this->errorLogger = $params['errorLogger'];
287
288 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
289 $this->nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'];
290 }
291
292 // Set initial dummy domain until open() sets the final DB/prefix
293 $this->currentDomain = DatabaseDomain::newUnspecified();
294
295 if ( $user ) {
296 $this->open( $server, $user, $password, $dbName );
297 } elseif ( $this->requiresDatabaseUser() ) {
298 throw new InvalidArgumentException( "No database user provided." );
299 }
300
301 // Set the domain object after open() sets the relevant fields
302 if ( $this->dbName != '' ) {
303 // Domains with server scope but a table prefix are not used by IDatabase classes
304 $this->currentDomain = new DatabaseDomain( $this->dbName, null, $this->tablePrefix );
305 }
306 }
307
308 /**
309 * Construct a Database subclass instance given a database type and parameters
310 *
311 * This also connects to the database immediately upon object construction
312 *
313 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
314 * @param array $p Parameter map with keys:
315 * - host : The hostname of the DB server
316 * - user : The name of the database user the client operates under
317 * - password : The password for the database user
318 * - dbname : The name of the database to use where queries do not specify one.
319 * The database must exist or an error might be thrown. Setting this to the empty string
320 * will avoid any such errors and make the handle have no implicit database scope. This is
321 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
322 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
323 * in which user names and such are defined, e.g. users are database-specific in Postgres.
324 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
325 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
326 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
327 * recognized in queries. This can be used in place of schemas for handle site farms.
328 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
329 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
330 * flag in place UNLESS this this database simply acts as a key/value store.
331 * - driver: Optional name of a specific DB client driver. For MySQL, there is only the
332 * 'mysqli' driver; the old one 'mysql' has been removed.
333 * - variables: Optional map of session variables to set after connecting. This can be
334 * used to adjust lock timeouts or encoding modes and the like.
335 * - connLogger: Optional PSR-3 logger interface instance.
336 * - queryLogger: Optional PSR-3 logger interface instance.
337 * - profiler: Optional class name or object with profileIn()/profileOut() methods.
338 * These will be called in query(), using a simplified version of the SQL that also
339 * includes the agent as a SQL comment.
340 * - trxProfiler: Optional TransactionProfiler instance.
341 * - errorLogger: Optional callback that takes an Exception and logs it.
342 * - cliMode: Whether to consider the execution context that of a CLI script.
343 * - agent: Optional name used to identify the end-user in query profiling/logging.
344 * - srvCache: Optional BagOStuff instance to an APC-style cache.
345 * - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
346 * @return Database|null If the database driver or extension cannot be found
347 * @throws InvalidArgumentException If the database driver or extension cannot be found
348 * @since 1.18
349 */
350 final public static function factory( $dbType, $p = [] ) {
351 $class = self::getClass( $dbType, isset( $p['driver'] ) ? $p['driver'] : null );
352
353 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase::class ) ) {
354 // Resolve some defaults for b/c
355 $p['host'] = isset( $p['host'] ) ? $p['host'] : false;
356 $p['user'] = isset( $p['user'] ) ? $p['user'] : false;
357 $p['password'] = isset( $p['password'] ) ? $p['password'] : false;
358 $p['dbname'] = isset( $p['dbname'] ) ? $p['dbname'] : false;
359 $p['flags'] = isset( $p['flags'] ) ? $p['flags'] : 0;
360 $p['variables'] = isset( $p['variables'] ) ? $p['variables'] : [];
361 $p['tablePrefix'] = isset( $p['tablePrefix'] ) ? $p['tablePrefix'] : '';
362 $p['schema'] = isset( $p['schema'] ) ? $p['schema'] : '';
363 $p['cliMode'] = isset( $p['cliMode'] )
364 ? $p['cliMode']
365 : ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' );
366 $p['agent'] = isset( $p['agent'] ) ? $p['agent'] : '';
367 if ( !isset( $p['connLogger'] ) ) {
368 $p['connLogger'] = new NullLogger();
369 }
370 if ( !isset( $p['queryLogger'] ) ) {
371 $p['queryLogger'] = new NullLogger();
372 }
373 $p['profiler'] = isset( $p['profiler'] ) ? $p['profiler'] : null;
374 if ( !isset( $p['trxProfiler'] ) ) {
375 $p['trxProfiler'] = new TransactionProfiler();
376 }
377 if ( !isset( $p['errorLogger'] ) ) {
378 $p['errorLogger'] = function ( Exception $e ) {
379 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING );
380 };
381 }
382
383 $conn = new $class( $p );
384 } else {
385 $conn = null;
386 }
387
388 return $conn;
389 }
390
391 /**
392 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
393 * @param string|null $driver Optional name of a specific DB client driver
394 * @return array Map of (Database::ATTRIBUTE_* constant => value) for all such constants
395 * @throws InvalidArgumentException
396 * @since 1.31
397 */
398 final public static function attributesFromType( $dbType, $driver = null ) {
399 static $defaults = [ self::ATTR_DB_LEVEL_LOCKING => false ];
400
401 $class = self::getClass( $dbType, $driver );
402
403 return call_user_func( [ $class, 'getAttributes' ] ) + $defaults;
404 }
405
406 /**
407 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
408 * @param string|null $driver Optional name of a specific DB client driver
409 * @return string Database subclass name to use
410 * @throws InvalidArgumentException
411 */
412 private static function getClass( $dbType, $driver = null ) {
413 // For database types with built-in support, the below maps type to IDatabase
414 // implementations. For types with multipe driver implementations (PHP extensions),
415 // an array can be used, keyed by extension name. In case of an array, the
416 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
417 // we auto-detect the first available driver. For types without built-in support,
418 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
419 static $builtinTypes = [
420 'mssql' => DatabaseMssql::class,
421 'mysql' => [ 'mysqli' => DatabaseMysqli::class ],
422 'sqlite' => DatabaseSqlite::class,
423 'postgres' => DatabasePostgres::class,
424 ];
425
426 $dbType = strtolower( $dbType );
427 $class = false;
428
429 if ( isset( $builtinTypes[$dbType] ) ) {
430 $possibleDrivers = $builtinTypes[$dbType];
431 if ( is_string( $possibleDrivers ) ) {
432 $class = $possibleDrivers;
433 } else {
434 if ( (string)$driver !== '' ) {
435 if ( !isset( $possibleDrivers[$driver] ) ) {
436 throw new InvalidArgumentException( __METHOD__ .
437 " type '$dbType' does not support driver '{$driver}'" );
438 } else {
439 $class = $possibleDrivers[$driver];
440 }
441 } else {
442 foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
443 if ( extension_loaded( $posDriver ) ) {
444 $class = $possibleClass;
445 break;
446 }
447 }
448 }
449 }
450 } else {
451 $class = 'Database' . ucfirst( $dbType );
452 }
453
454 if ( $class === false ) {
455 throw new InvalidArgumentException( __METHOD__ .
456 " no viable database extension found for type '$dbType'" );
457 }
458
459 return $class;
460 }
461
462 /**
463 * @return array Map of (Database::ATTRIBUTE_* constant => value
464 * @since 1.31
465 */
466 protected static function getAttributes() {
467 return [];
468 }
469
470 /**
471 * Set the PSR-3 logger interface to use for query logging. (The logger
472 * interfaces for connection logging and error logging can be set with the
473 * constructor.)
474 *
475 * @param LoggerInterface $logger
476 */
477 public function setLogger( LoggerInterface $logger ) {
478 $this->queryLogger = $logger;
479 }
480
481 public function getServerInfo() {
482 return $this->getServerVersion();
483 }
484
485 public function bufferResults( $buffer = null ) {
486 $res = !$this->getFlag( self::DBO_NOBUFFER );
487 if ( $buffer !== null ) {
488 $buffer
489 ? $this->clearFlag( self::DBO_NOBUFFER )
490 : $this->setFlag( self::DBO_NOBUFFER );
491 }
492
493 return $res;
494 }
495
496 /**
497 * Turns on (false) or off (true) the automatic generation and sending
498 * of a "we're sorry, but there has been a database error" page on
499 * database errors. Default is on (false). When turned off, the
500 * code should use lastErrno() and lastError() to handle the
501 * situation as appropriate.
502 *
503 * Do not use this function outside of the Database classes.
504 *
505 * @param null|bool $ignoreErrors
506 * @return bool The previous value of the flag.
507 */
508 protected function ignoreErrors( $ignoreErrors = null ) {
509 $res = $this->getFlag( self::DBO_IGNORE );
510 if ( $ignoreErrors !== null ) {
511 // setFlag()/clearFlag() do not allow DBO_IGNORE changes for sanity
512 if ( $ignoreErrors ) {
513 $this->flags |= self::DBO_IGNORE;
514 } else {
515 $this->flags &= ~self::DBO_IGNORE;
516 }
517 }
518
519 return $res;
520 }
521
522 public function trxLevel() {
523 return $this->trxLevel;
524 }
525
526 public function trxTimestamp() {
527 return $this->trxLevel ? $this->trxTimestamp : null;
528 }
529
530 public function tablePrefix( $prefix = null ) {
531 $old = $this->tablePrefix;
532 if ( $prefix !== null ) {
533 $this->tablePrefix = $prefix;
534 $this->currentDomain = ( $this->dbName != '' )
535 ? new DatabaseDomain( $this->dbName, null, $this->tablePrefix )
536 : DatabaseDomain::newUnspecified();
537 }
538
539 return $old;
540 }
541
542 public function dbSchema( $schema = null ) {
543 $old = $this->schema;
544 if ( $schema !== null ) {
545 $this->schema = $schema;
546 }
547
548 return $old;
549 }
550
551 public function getLBInfo( $name = null ) {
552 if ( is_null( $name ) ) {
553 return $this->lbInfo;
554 } else {
555 if ( array_key_exists( $name, $this->lbInfo ) ) {
556 return $this->lbInfo[$name];
557 } else {
558 return null;
559 }
560 }
561 }
562
563 public function setLBInfo( $name, $value = null ) {
564 if ( is_null( $value ) ) {
565 $this->lbInfo = $name;
566 } else {
567 $this->lbInfo[$name] = $value;
568 }
569 }
570
571 public function setLazyMasterHandle( IDatabase $conn ) {
572 $this->lazyMasterHandle = $conn;
573 }
574
575 /**
576 * @return IDatabase|null
577 * @see setLazyMasterHandle()
578 * @since 1.27
579 */
580 protected function getLazyMasterHandle() {
581 return $this->lazyMasterHandle;
582 }
583
584 public function implicitGroupby() {
585 return true;
586 }
587
588 public function implicitOrderby() {
589 return true;
590 }
591
592 public function lastQuery() {
593 return $this->lastQuery;
594 }
595
596 public function doneWrites() {
597 return (bool)$this->lastWriteTime;
598 }
599
600 public function lastDoneWrites() {
601 return $this->lastWriteTime ?: false;
602 }
603
604 public function writesPending() {
605 return $this->trxLevel && $this->trxDoneWrites;
606 }
607
608 public function writesOrCallbacksPending() {
609 return $this->trxLevel && (
610 $this->trxDoneWrites || $this->trxIdleCallbacks || $this->trxPreCommitCallbacks
611 );
612 }
613
614 public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
615 if ( !$this->trxLevel ) {
616 return false;
617 } elseif ( !$this->trxDoneWrites ) {
618 return 0.0;
619 }
620
621 switch ( $type ) {
622 case self::ESTIMATE_DB_APPLY:
623 $this->ping( $rtt );
624 $rttAdjTotal = $this->trxWriteAdjQueryCount * $rtt;
625 $applyTime = max( $this->trxWriteAdjDuration - $rttAdjTotal, 0 );
626 // For omitted queries, make them count as something at least
627 $omitted = $this->trxWriteQueryCount - $this->trxWriteAdjQueryCount;
628 $applyTime += self::TINY_WRITE_SEC * $omitted;
629
630 return $applyTime;
631 default: // everything
632 return $this->trxWriteDuration;
633 }
634 }
635
636 public function pendingWriteCallers() {
637 return $this->trxLevel ? $this->trxWriteCallers : [];
638 }
639
640 public function pendingWriteRowsAffected() {
641 return $this->trxWriteAffectedRows;
642 }
643
644 /**
645 * Get the list of method names that have pending write queries or callbacks
646 * for this transaction
647 *
648 * @return array
649 */
650 protected function pendingWriteAndCallbackCallers() {
651 if ( !$this->trxLevel ) {
652 return [];
653 }
654
655 $fnames = $this->trxWriteCallers;
656 foreach ( [
657 $this->trxIdleCallbacks,
658 $this->trxPreCommitCallbacks,
659 $this->trxEndCallbacks
660 ] as $callbacks ) {
661 foreach ( $callbacks as $callback ) {
662 $fnames[] = $callback[1];
663 }
664 }
665
666 return $fnames;
667 }
668
669 public function isOpen() {
670 return $this->opened;
671 }
672
673 public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
674 if ( ( $flag & self::DBO_IGNORE ) ) {
675 throw new \UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
676 }
677
678 if ( $remember === self::REMEMBER_PRIOR ) {
679 array_push( $this->priorFlags, $this->flags );
680 }
681 $this->flags |= $flag;
682 }
683
684 public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
685 if ( ( $flag & self::DBO_IGNORE ) ) {
686 throw new \UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
687 }
688
689 if ( $remember === self::REMEMBER_PRIOR ) {
690 array_push( $this->priorFlags, $this->flags );
691 }
692 $this->flags &= ~$flag;
693 }
694
695 public function restoreFlags( $state = self::RESTORE_PRIOR ) {
696 if ( !$this->priorFlags ) {
697 return;
698 }
699
700 if ( $state === self::RESTORE_INITIAL ) {
701 $this->flags = reset( $this->priorFlags );
702 $this->priorFlags = [];
703 } else {
704 $this->flags = array_pop( $this->priorFlags );
705 }
706 }
707
708 public function getFlag( $flag ) {
709 return !!( $this->flags & $flag );
710 }
711
712 /**
713 * @param string $name Class field name
714 * @return mixed
715 * @deprecated Since 1.28
716 */
717 public function getProperty( $name ) {
718 return $this->$name;
719 }
720
721 public function getDomainID() {
722 return $this->currentDomain->getId();
723 }
724
725 final public function getWikiID() {
726 return $this->getDomainID();
727 }
728
729 /**
730 * Get information about an index into an object
731 * @param string $table Table name
732 * @param string $index Index name
733 * @param string $fname Calling function name
734 * @return mixed Database-specific index description class or false if the index does not exist
735 */
736 abstract function indexInfo( $table, $index, $fname = __METHOD__ );
737
738 /**
739 * Wrapper for addslashes()
740 *
741 * @param string $s String to be slashed.
742 * @return string Slashed string.
743 */
744 abstract function strencode( $s );
745
746 /**
747 * Set a custom error handler for logging errors during database connection
748 */
749 protected function installErrorHandler() {
750 $this->phpError = false;
751 $this->htmlErrors = ini_set( 'html_errors', '0' );
752 set_error_handler( [ $this, 'connectionErrorLogger' ] );
753 }
754
755 /**
756 * Restore the previous error handler and return the last PHP error for this DB
757 *
758 * @return bool|string
759 */
760 protected function restoreErrorHandler() {
761 restore_error_handler();
762 if ( $this->htmlErrors !== false ) {
763 ini_set( 'html_errors', $this->htmlErrors );
764 }
765
766 return $this->getLastPHPError();
767 }
768
769 /**
770 * @return string|bool Last PHP error for this DB (typically connection errors)
771 */
772 protected function getLastPHPError() {
773 if ( $this->phpError ) {
774 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->phpError );
775 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
776
777 return $error;
778 }
779
780 return false;
781 }
782
783 /**
784 * Error handler for logging errors during database connection
785 * This method should not be used outside of Database classes
786 *
787 * @param int $errno
788 * @param string $errstr
789 */
790 public function connectionErrorLogger( $errno, $errstr ) {
791 $this->phpError = $errstr;
792 }
793
794 /**
795 * Create a log context to pass to PSR-3 logger functions.
796 *
797 * @param array $extras Additional data to add to context
798 * @return array
799 */
800 protected function getLogContext( array $extras = [] ) {
801 return array_merge(
802 [
803 'db_server' => $this->server,
804 'db_name' => $this->dbName,
805 'db_user' => $this->user,
806 ],
807 $extras
808 );
809 }
810
811 public function close() {
812 if ( $this->conn ) {
813 if ( $this->trxLevel() ) {
814 $this->commit( __METHOD__, self::FLUSHING_INTERNAL );
815 }
816
817 $closed = $this->closeConnection();
818 $this->conn = false;
819 } elseif (
820 $this->trxIdleCallbacks ||
821 $this->trxPreCommitCallbacks ||
822 $this->trxEndCallbacks
823 ) { // sanity
824 throw new RuntimeException( "Transaction callbacks still pending." );
825 } else {
826 $closed = true;
827 }
828 $this->opened = false;
829
830 return $closed;
831 }
832
833 /**
834 * Make sure isOpen() returns true as a sanity check
835 *
836 * @throws DBUnexpectedError
837 */
838 protected function assertOpen() {
839 if ( !$this->isOpen() ) {
840 throw new DBUnexpectedError( $this, "DB connection was already closed." );
841 }
842 }
843
844 /**
845 * Closes underlying database connection
846 * @since 1.20
847 * @return bool Whether connection was closed successfully
848 */
849 abstract protected function closeConnection();
850
851 public function reportConnectionError( $error = 'Unknown error' ) {
852 $myError = $this->lastError();
853 if ( $myError ) {
854 $error = $myError;
855 }
856
857 # New method
858 throw new DBConnectionError( $this, $error );
859 }
860
861 /**
862 * The DBMS-dependent part of query()
863 *
864 * @param string $sql SQL query.
865 * @return ResultWrapper|bool Result object to feed to fetchObject,
866 * fetchRow, ...; or false on failure
867 */
868 abstract protected function doQuery( $sql );
869
870 /**
871 * Determine whether a query writes to the DB.
872 * Should return true if unsure.
873 *
874 * @param string $sql
875 * @return bool
876 */
877 protected function isWriteQuery( $sql ) {
878 return !preg_match(
879 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
880 }
881
882 /**
883 * @param string $sql
884 * @return string|null
885 */
886 protected function getQueryVerb( $sql ) {
887 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ? strtoupper( $m[1] ) : null;
888 }
889
890 /**
891 * Determine whether a SQL statement is sensitive to isolation level.
892 * A SQL statement is considered transactable if its result could vary
893 * depending on the transaction isolation level. Operational commands
894 * such as 'SET' and 'SHOW' are not considered to be transactable.
895 *
896 * @param string $sql
897 * @return bool
898 */
899 protected function isTransactableQuery( $sql ) {
900 return !in_array(
901 $this->getQueryVerb( $sql ),
902 [ 'BEGIN', 'COMMIT', 'ROLLBACK', 'SHOW', 'SET', 'CREATE', 'ALTER' ],
903 true
904 );
905 }
906
907 /**
908 * @param string $sql A SQL query
909 * @return bool Whether $sql is SQL for TEMPORARY table operation
910 */
911 protected function registerTempTableOperation( $sql ) {
912 if ( preg_match(
913 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
914 $sql,
915 $matches
916 ) ) {
917 $this->sessionTempTables[$matches[1]] = 1;
918
919 return true;
920 } elseif ( preg_match(
921 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
922 $sql,
923 $matches
924 ) ) {
925 $isTemp = isset( $this->sessionTempTables[$matches[1]] );
926 unset( $this->sessionTempTables[$matches[1]] );
927
928 return $isTemp;
929 } elseif ( preg_match(
930 '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
931 $sql,
932 $matches
933 ) ) {
934 return isset( $this->sessionTempTables[$matches[1]] );
935 } elseif ( preg_match(
936 '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
937 $sql,
938 $matches
939 ) ) {
940 return isset( $this->sessionTempTables[$matches[1]] );
941 }
942
943 return false;
944 }
945
946 public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) {
947 $priorWritesPending = $this->writesOrCallbacksPending();
948 $this->lastQuery = $sql;
949
950 $isWrite = $this->isWriteQuery( $sql );
951 if ( $isWrite ) {
952 $isNonTempWrite = !$this->registerTempTableOperation( $sql );
953 } else {
954 $isNonTempWrite = false;
955 }
956
957 if ( $isWrite ) {
958 if ( $this->getLBInfo( 'replica' ) === true ) {
959 throw new DBError(
960 $this,
961 'Write operations are not allowed on replica database connections.'
962 );
963 }
964 # In theory, non-persistent writes are allowed in read-only mode, but due to things
965 # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
966 $reason = $this->getReadOnlyReason();
967 if ( $reason !== false ) {
968 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
969 }
970 # Set a flag indicating that writes have been done
971 $this->lastWriteTime = microtime( true );
972 }
973
974 # Add trace comment to the begin of the sql string, right after the operator.
975 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
976 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
977
978 # Start implicit transactions that wrap the request if DBO_TRX is enabled
979 if ( !$this->trxLevel && $this->getFlag( self::DBO_TRX )
980 && $this->isTransactableQuery( $sql )
981 ) {
982 $this->begin( __METHOD__ . " ($fname)", self::TRANSACTION_INTERNAL );
983 $this->trxAutomatic = true;
984 }
985
986 # Keep track of whether the transaction has write queries pending
987 if ( $this->trxLevel && !$this->trxDoneWrites && $isWrite ) {
988 $this->trxDoneWrites = true;
989 $this->trxProfiler->transactionWritingIn(
990 $this->server, $this->dbName, $this->trxShortId );
991 }
992
993 if ( $this->getFlag( self::DBO_DEBUG ) ) {
994 $this->queryLogger->debug( "{$this->dbName} {$commentedSql}" );
995 }
996
997 # Avoid fatals if close() was called
998 $this->assertOpen();
999
1000 # Send the query to the server
1001 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1002
1003 # Try reconnecting if the connection was lost
1004 if ( false === $ret && $this->wasErrorReissuable() ) {
1005 $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1006 # Stash the last error values before anything might clear them
1007 $lastError = $this->lastError();
1008 $lastErrno = $this->lastErrno();
1009 # Update state tracking to reflect transaction loss due to disconnection
1010 $this->handleSessionLoss();
1011 if ( $this->reconnect() ) {
1012 $msg = __METHOD__ . ': lost connection to {dbserver}; reconnected';
1013 $params = [ 'dbserver' => $this->getServer() ];
1014 $this->connLogger->warning( $msg, $params );
1015 $this->queryLogger->warning( $msg, $params +
1016 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ] );
1017
1018 if ( !$recoverable ) {
1019 # Callers may catch the exception and continue to use the DB
1020 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname );
1021 } else {
1022 # Should be safe to silently retry the query
1023 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1024 }
1025 } else {
1026 $msg = __METHOD__ . ': lost connection to {dbserver} permanently';
1027 $this->connLogger->error( $msg, [ 'dbserver' => $this->getServer() ] );
1028 }
1029 }
1030
1031 if ( false === $ret ) {
1032 # Deadlocks cause the entire transaction to abort, not just the statement.
1033 # https://dev.mysql.com/doc/refman/5.7/en/innodb-error-handling.html
1034 # https://www.postgresql.org/docs/9.1/static/explicit-locking.html
1035 if ( $this->wasDeadlock() ) {
1036 if ( $this->explicitTrxActive() || $priorWritesPending ) {
1037 $tempIgnore = false; // not recoverable
1038 }
1039 # Update state tracking to reflect transaction loss
1040 $this->handleSessionLoss();
1041 }
1042
1043 $this->reportQueryError(
1044 $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
1045 }
1046
1047 $res = $this->resultObject( $ret );
1048
1049 return $res;
1050 }
1051
1052 /**
1053 * Wrapper for query() that also handles profiling, logging, and affected row count updates
1054 *
1055 * @param string $sql Original SQL query
1056 * @param string $commentedSql SQL query with debugging/trace comment
1057 * @param bool $isWrite Whether the query is a (non-temporary) write operation
1058 * @param string $fname Name of the calling function
1059 * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1060 * object for a successful read query, or false on failure
1061 */
1062 private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
1063 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1064 # generalizeSQL() will probably cut down the query to reasonable
1065 # logging size most of the time. The substr is really just a sanity check.
1066 if ( $isMaster ) {
1067 $queryProf = 'query-m: ' . substr( self::generalizeSQL( $sql ), 0, 255 );
1068 } else {
1069 $queryProf = 'query: ' . substr( self::generalizeSQL( $sql ), 0, 255 );
1070 }
1071
1072 # Include query transaction state
1073 $queryProf .= $this->trxShortId ? " [TRX#{$this->trxShortId}]" : "";
1074
1075 $startTime = microtime( true );
1076 if ( $this->profiler ) {
1077 call_user_func( [ $this->profiler, 'profileIn' ], $queryProf );
1078 }
1079 $this->affectedRowCount = null;
1080 $ret = $this->doQuery( $commentedSql );
1081 $this->affectedRowCount = $this->affectedRows();
1082 if ( $this->profiler ) {
1083 call_user_func( [ $this->profiler, 'profileOut' ], $queryProf );
1084 }
1085 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1086
1087 unset( $queryProfSection ); // profile out (if set)
1088
1089 if ( $ret !== false ) {
1090 $this->lastPing = $startTime;
1091 if ( $isWrite && $this->trxLevel ) {
1092 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1093 $this->trxWriteCallers[] = $fname;
1094 }
1095 }
1096
1097 if ( $sql === self::PING_QUERY ) {
1098 $this->rttEstimate = $queryRuntime;
1099 }
1100
1101 $this->trxProfiler->recordQueryCompletion(
1102 $queryProf, $startTime, $isWrite, $this->affectedRows()
1103 );
1104 $this->queryLogger->debug( $sql, [
1105 'method' => $fname,
1106 'master' => $isMaster,
1107 'runtime' => $queryRuntime,
1108 ] );
1109
1110 return $ret;
1111 }
1112
1113 /**
1114 * Update the estimated run-time of a query, not counting large row lock times
1115 *
1116 * LoadBalancer can be set to rollback transactions that will create huge replication
1117 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1118 * queries, like inserting a row can take a long time due to row locking. This method
1119 * uses some simple heuristics to discount those cases.
1120 *
1121 * @param string $sql A SQL write query
1122 * @param float $runtime Total runtime, including RTT
1123 * @param int $affected Affected row count
1124 */
1125 private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1126 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1127 $indicativeOfReplicaRuntime = true;
1128 if ( $runtime > self::SLOW_WRITE_SEC ) {
1129 $verb = $this->getQueryVerb( $sql );
1130 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1131 if ( $verb === 'INSERT' ) {
1132 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS;
1133 } elseif ( $verb === 'REPLACE' ) {
1134 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS / 2;
1135 }
1136 }
1137
1138 $this->trxWriteDuration += $runtime;
1139 $this->trxWriteQueryCount += 1;
1140 $this->trxWriteAffectedRows += $affected;
1141 if ( $indicativeOfReplicaRuntime ) {
1142 $this->trxWriteAdjDuration += $runtime;
1143 $this->trxWriteAdjQueryCount += 1;
1144 }
1145 }
1146
1147 /**
1148 * Determine whether or not it is safe to retry queries after a database
1149 * connection is lost
1150 *
1151 * @param string $sql SQL query
1152 * @param bool $priorWritesPending Whether there is a transaction open with
1153 * possible write queries or transaction pre-commit/idle callbacks
1154 * waiting on it to finish.
1155 * @return bool True if it is safe to retry the query, false otherwise
1156 */
1157 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1158 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1159 # Dropped connections also mean that named locks are automatically released.
1160 # Only allow error suppression in autocommit mode or when the lost transaction
1161 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1162 if ( $this->namedLocksHeld ) {
1163 return false; // possible critical section violation
1164 } elseif ( $sql === 'COMMIT' ) {
1165 return !$priorWritesPending; // nothing written anyway? (T127428)
1166 } elseif ( $sql === 'ROLLBACK' ) {
1167 return true; // transaction lost...which is also what was requested :)
1168 } elseif ( $this->explicitTrxActive() ) {
1169 return false; // don't drop atomocity
1170 } elseif ( $priorWritesPending ) {
1171 return false; // prior writes lost from implicit transaction
1172 }
1173
1174 return true;
1175 }
1176
1177 /**
1178 * Clean things up after transaction loss due to disconnection
1179 *
1180 * @return null|Exception
1181 */
1182 private function handleSessionLoss() {
1183 $this->trxLevel = 0;
1184 $this->trxIdleCallbacks = []; // T67263
1185 $this->trxPreCommitCallbacks = []; // T67263
1186 $this->sessionTempTables = [];
1187 $this->namedLocksHeld = [];
1188 try {
1189 // Handle callbacks in trxEndCallbacks
1190 $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
1191 $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
1192 return null;
1193 } catch ( Exception $e ) {
1194 // Already logged; move on...
1195 return $e;
1196 }
1197 }
1198
1199 /**
1200 * Checks whether the cause of the error is detected to be a timeout.
1201 *
1202 * It returns false by default, and not all engines support detecting this yet.
1203 * If this returns false, it will be treated as a generic query error.
1204 *
1205 * @param string $error Error text
1206 * @param int $errno Error number
1207 * @return bool
1208 */
1209 protected function wasQueryTimeout( $error, $errno ) {
1210 return false;
1211 }
1212
1213 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1214 if ( $this->ignoreErrors() || $tempIgnore ) {
1215 $this->queryLogger->debug( "SQL ERROR (ignored): $error\n" );
1216 } else {
1217 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1218 $this->queryLogger->error(
1219 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1220 $this->getLogContext( [
1221 'method' => __METHOD__,
1222 'errno' => $errno,
1223 'error' => $error,
1224 'sql1line' => $sql1line,
1225 'fname' => $fname,
1226 ] )
1227 );
1228 $this->queryLogger->debug( "SQL ERROR: " . $error . "\n" );
1229 $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1230 if ( $wasQueryTimeout ) {
1231 throw new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1232 } else {
1233 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1234 }
1235 }
1236 }
1237
1238 public function freeResult( $res ) {
1239 }
1240
1241 public function selectField(
1242 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1243 ) {
1244 if ( $var === '*' ) { // sanity
1245 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1246 }
1247
1248 if ( !is_array( $options ) ) {
1249 $options = [ $options ];
1250 }
1251
1252 $options['LIMIT'] = 1;
1253
1254 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1255 if ( $res === false || !$this->numRows( $res ) ) {
1256 return false;
1257 }
1258
1259 $row = $this->fetchRow( $res );
1260
1261 if ( $row !== false ) {
1262 return reset( $row );
1263 } else {
1264 return false;
1265 }
1266 }
1267
1268 public function selectFieldValues(
1269 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1270 ) {
1271 if ( $var === '*' ) { // sanity
1272 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1273 } elseif ( !is_string( $var ) ) { // sanity
1274 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1275 }
1276
1277 if ( !is_array( $options ) ) {
1278 $options = [ $options ];
1279 }
1280
1281 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1282 if ( $res === false ) {
1283 return false;
1284 }
1285
1286 $values = [];
1287 foreach ( $res as $row ) {
1288 $values[] = $row->$var;
1289 }
1290
1291 return $values;
1292 }
1293
1294 /**
1295 * Returns an optional USE INDEX clause to go after the table, and a
1296 * string to go at the end of the query.
1297 *
1298 * @param array $options Associative array of options to be turned into
1299 * an SQL query, valid keys are listed in the function.
1300 * @return array
1301 * @see Database::select()
1302 */
1303 protected function makeSelectOptions( $options ) {
1304 $preLimitTail = $postLimitTail = '';
1305 $startOpts = '';
1306
1307 $noKeyOptions = [];
1308
1309 foreach ( $options as $key => $option ) {
1310 if ( is_numeric( $key ) ) {
1311 $noKeyOptions[$option] = true;
1312 }
1313 }
1314
1315 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1316
1317 $preLimitTail .= $this->makeOrderBy( $options );
1318
1319 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1320 $postLimitTail .= ' FOR UPDATE';
1321 }
1322
1323 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1324 $postLimitTail .= ' LOCK IN SHARE MODE';
1325 }
1326
1327 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1328 $startOpts .= 'DISTINCT';
1329 }
1330
1331 # Various MySQL extensions
1332 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1333 $startOpts .= ' /*! STRAIGHT_JOIN */';
1334 }
1335
1336 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1337 $startOpts .= ' HIGH_PRIORITY';
1338 }
1339
1340 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1341 $startOpts .= ' SQL_BIG_RESULT';
1342 }
1343
1344 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1345 $startOpts .= ' SQL_BUFFER_RESULT';
1346 }
1347
1348 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1349 $startOpts .= ' SQL_SMALL_RESULT';
1350 }
1351
1352 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1353 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1354 }
1355
1356 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1357 $startOpts .= ' SQL_CACHE';
1358 }
1359
1360 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1361 $startOpts .= ' SQL_NO_CACHE';
1362 }
1363
1364 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1365 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1366 } else {
1367 $useIndex = '';
1368 }
1369 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1370 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1371 } else {
1372 $ignoreIndex = '';
1373 }
1374
1375 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1376 }
1377
1378 /**
1379 * Returns an optional GROUP BY with an optional HAVING
1380 *
1381 * @param array $options Associative array of options
1382 * @return string
1383 * @see Database::select()
1384 * @since 1.21
1385 */
1386 protected function makeGroupByWithHaving( $options ) {
1387 $sql = '';
1388 if ( isset( $options['GROUP BY'] ) ) {
1389 $gb = is_array( $options['GROUP BY'] )
1390 ? implode( ',', $options['GROUP BY'] )
1391 : $options['GROUP BY'];
1392 $sql .= ' GROUP BY ' . $gb;
1393 }
1394 if ( isset( $options['HAVING'] ) ) {
1395 $having = is_array( $options['HAVING'] )
1396 ? $this->makeList( $options['HAVING'], self::LIST_AND )
1397 : $options['HAVING'];
1398 $sql .= ' HAVING ' . $having;
1399 }
1400
1401 return $sql;
1402 }
1403
1404 /**
1405 * Returns an optional ORDER BY
1406 *
1407 * @param array $options Associative array of options
1408 * @return string
1409 * @see Database::select()
1410 * @since 1.21
1411 */
1412 protected function makeOrderBy( $options ) {
1413 if ( isset( $options['ORDER BY'] ) ) {
1414 $ob = is_array( $options['ORDER BY'] )
1415 ? implode( ',', $options['ORDER BY'] )
1416 : $options['ORDER BY'];
1417
1418 return ' ORDER BY ' . $ob;
1419 }
1420
1421 return '';
1422 }
1423
1424 public function select( $table, $vars, $conds = '', $fname = __METHOD__,
1425 $options = [], $join_conds = [] ) {
1426 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1427
1428 return $this->query( $sql, $fname );
1429 }
1430
1431 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__,
1432 $options = [], $join_conds = []
1433 ) {
1434 if ( is_array( $vars ) ) {
1435 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1436 }
1437
1438 $options = (array)$options;
1439 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1440 ? $options['USE INDEX']
1441 : [];
1442 $ignoreIndexes = (
1443 isset( $options['IGNORE INDEX'] ) &&
1444 is_array( $options['IGNORE INDEX'] )
1445 )
1446 ? $options['IGNORE INDEX']
1447 : [];
1448
1449 if ( is_array( $table ) ) {
1450 $from = ' FROM ' .
1451 $this->tableNamesWithIndexClauseOrJOIN(
1452 $table, $useIndexes, $ignoreIndexes, $join_conds );
1453 } elseif ( $table != '' ) {
1454 $from = ' FROM ' .
1455 $this->tableNamesWithIndexClauseOrJOIN(
1456 [ $table ], $useIndexes, $ignoreIndexes, [] );
1457 } else {
1458 $from = '';
1459 }
1460
1461 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1462 $this->makeSelectOptions( $options );
1463
1464 if ( is_array( $conds ) ) {
1465 $conds = $this->makeList( $conds, self::LIST_AND );
1466 }
1467
1468 if ( $conds === null || $conds === false ) {
1469 $this->queryLogger->warning(
1470 __METHOD__
1471 . ' called from '
1472 . $fname
1473 . ' with incorrect parameters: $conds must be a string or an array'
1474 );
1475 $conds = '';
1476 }
1477
1478 if ( $conds === '' ) {
1479 $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex $preLimitTail";
1480 } elseif ( is_string( $conds ) ) {
1481 $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex " .
1482 "WHERE $conds $preLimitTail";
1483 } else {
1484 throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
1485 }
1486
1487 if ( isset( $options['LIMIT'] ) ) {
1488 $sql = $this->limitResult( $sql, $options['LIMIT'],
1489 isset( $options['OFFSET'] ) ? $options['OFFSET'] : false );
1490 }
1491 $sql = "$sql $postLimitTail";
1492
1493 if ( isset( $options['EXPLAIN'] ) ) {
1494 $sql = 'EXPLAIN ' . $sql;
1495 }
1496
1497 return $sql;
1498 }
1499
1500 public function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1501 $options = [], $join_conds = []
1502 ) {
1503 $options = (array)$options;
1504 $options['LIMIT'] = 1;
1505 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1506
1507 if ( $res === false ) {
1508 return false;
1509 }
1510
1511 if ( !$this->numRows( $res ) ) {
1512 return false;
1513 }
1514
1515 $obj = $this->fetchObject( $res );
1516
1517 return $obj;
1518 }
1519
1520 public function estimateRowCount(
1521 $table, $vars = '*', $conds = '', $fname = __METHOD__, $options = []
1522 ) {
1523 $rows = 0;
1524 $res = $this->select( $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options );
1525
1526 if ( $res ) {
1527 $row = $this->fetchRow( $res );
1528 $rows = ( isset( $row['rowcount'] ) ) ? (int)$row['rowcount'] : 0;
1529 }
1530
1531 return $rows;
1532 }
1533
1534 public function selectRowCount(
1535 $tables, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1536 ) {
1537 $rows = 0;
1538 $sql = $this->selectSQLText( $tables, '1', $conds, $fname, $options, $join_conds );
1539 // The identifier quotes is primarily for MSSQL.
1540 $rowCountCol = $this->addIdentifierQuotes( "rowcount" );
1541 $tableName = $this->addIdentifierQuotes( "tmp_count" );
1542 $res = $this->query( "SELECT COUNT(*) AS $rowCountCol FROM ($sql) $tableName", $fname );
1543
1544 if ( $res ) {
1545 $row = $this->fetchRow( $res );
1546 $rows = ( isset( $row['rowcount'] ) ) ? (int)$row['rowcount'] : 0;
1547 }
1548
1549 return $rows;
1550 }
1551
1552 /**
1553 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1554 * It's only slightly flawed. Don't use for anything important.
1555 *
1556 * @param string $sql A SQL Query
1557 *
1558 * @return string
1559 */
1560 protected static function generalizeSQL( $sql ) {
1561 # This does the same as the regexp below would do, but in such a way
1562 # as to avoid crashing php on some large strings.
1563 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1564
1565 $sql = str_replace( "\\\\", '', $sql );
1566 $sql = str_replace( "\\'", '', $sql );
1567 $sql = str_replace( "\\\"", '', $sql );
1568 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1569 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1570
1571 # All newlines, tabs, etc replaced by single space
1572 $sql = preg_replace( '/\s+/', ' ', $sql );
1573
1574 # All numbers => N,
1575 # except the ones surrounded by characters, e.g. l10n
1576 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1577 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1578
1579 return $sql;
1580 }
1581
1582 public function fieldExists( $table, $field, $fname = __METHOD__ ) {
1583 $info = $this->fieldInfo( $table, $field );
1584
1585 return (bool)$info;
1586 }
1587
1588 public function indexExists( $table, $index, $fname = __METHOD__ ) {
1589 if ( !$this->tableExists( $table ) ) {
1590 return null;
1591 }
1592
1593 $info = $this->indexInfo( $table, $index, $fname );
1594 if ( is_null( $info ) ) {
1595 return null;
1596 } else {
1597 return $info !== false;
1598 }
1599 }
1600
1601 public function tableExists( $table, $fname = __METHOD__ ) {
1602 $tableRaw = $this->tableName( $table, 'raw' );
1603 if ( isset( $this->sessionTempTables[$tableRaw] ) ) {
1604 return true; // already known to exist
1605 }
1606
1607 $table = $this->tableName( $table );
1608 $ignoreErrors = true;
1609 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname, $ignoreErrors );
1610
1611 return (bool)$res;
1612 }
1613
1614 public function indexUnique( $table, $index ) {
1615 $indexInfo = $this->indexInfo( $table, $index );
1616
1617 if ( !$indexInfo ) {
1618 return null;
1619 }
1620
1621 return !$indexInfo[0]->Non_unique;
1622 }
1623
1624 /**
1625 * Helper for Database::insert().
1626 *
1627 * @param array $options
1628 * @return string
1629 */
1630 protected function makeInsertOptions( $options ) {
1631 return implode( ' ', $options );
1632 }
1633
1634 public function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
1635 # No rows to insert, easy just return now
1636 if ( !count( $a ) ) {
1637 return true;
1638 }
1639
1640 $table = $this->tableName( $table );
1641
1642 if ( !is_array( $options ) ) {
1643 $options = [ $options ];
1644 }
1645
1646 $fh = null;
1647 if ( isset( $options['fileHandle'] ) ) {
1648 $fh = $options['fileHandle'];
1649 }
1650 $options = $this->makeInsertOptions( $options );
1651
1652 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1653 $multi = true;
1654 $keys = array_keys( $a[0] );
1655 } else {
1656 $multi = false;
1657 $keys = array_keys( $a );
1658 }
1659
1660 $sql = 'INSERT ' . $options .
1661 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1662
1663 if ( $multi ) {
1664 $first = true;
1665 foreach ( $a as $row ) {
1666 if ( $first ) {
1667 $first = false;
1668 } else {
1669 $sql .= ',';
1670 }
1671 $sql .= '(' . $this->makeList( $row ) . ')';
1672 }
1673 } else {
1674 $sql .= '(' . $this->makeList( $a ) . ')';
1675 }
1676
1677 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1678 return false;
1679 } elseif ( $fh !== null ) {
1680 return true;
1681 }
1682
1683 return (bool)$this->query( $sql, $fname );
1684 }
1685
1686 /**
1687 * Make UPDATE options array for Database::makeUpdateOptions
1688 *
1689 * @param array $options
1690 * @return array
1691 */
1692 protected function makeUpdateOptionsArray( $options ) {
1693 if ( !is_array( $options ) ) {
1694 $options = [ $options ];
1695 }
1696
1697 $opts = [];
1698
1699 if ( in_array( 'IGNORE', $options ) ) {
1700 $opts[] = 'IGNORE';
1701 }
1702
1703 return $opts;
1704 }
1705
1706 /**
1707 * Make UPDATE options for the Database::update function
1708 *
1709 * @param array $options The options passed to Database::update
1710 * @return string
1711 */
1712 protected function makeUpdateOptions( $options ) {
1713 $opts = $this->makeUpdateOptionsArray( $options );
1714
1715 return implode( ' ', $opts );
1716 }
1717
1718 public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
1719 $table = $this->tableName( $table );
1720 $opts = $this->makeUpdateOptions( $options );
1721 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self::LIST_SET );
1722
1723 if ( $conds !== [] && $conds !== '*' ) {
1724 $sql .= " WHERE " . $this->makeList( $conds, self::LIST_AND );
1725 }
1726
1727 return (bool)$this->query( $sql, $fname );
1728 }
1729
1730 public function makeList( $a, $mode = self::LIST_COMMA ) {
1731 if ( !is_array( $a ) ) {
1732 throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
1733 }
1734
1735 $first = true;
1736 $list = '';
1737
1738 foreach ( $a as $field => $value ) {
1739 if ( !$first ) {
1740 if ( $mode == self::LIST_AND ) {
1741 $list .= ' AND ';
1742 } elseif ( $mode == self::LIST_OR ) {
1743 $list .= ' OR ';
1744 } else {
1745 $list .= ',';
1746 }
1747 } else {
1748 $first = false;
1749 }
1750
1751 if ( ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_numeric( $field ) ) {
1752 $list .= "($value)";
1753 } elseif ( $mode == self::LIST_SET && is_numeric( $field ) ) {
1754 $list .= "$value";
1755 } elseif (
1756 ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_array( $value )
1757 ) {
1758 // Remove null from array to be handled separately if found
1759 $includeNull = false;
1760 foreach ( array_keys( $value, null, true ) as $nullKey ) {
1761 $includeNull = true;
1762 unset( $value[$nullKey] );
1763 }
1764 if ( count( $value ) == 0 && !$includeNull ) {
1765 throw new InvalidArgumentException(
1766 __METHOD__ . ": empty input for field $field" );
1767 } elseif ( count( $value ) == 0 ) {
1768 // only check if $field is null
1769 $list .= "$field IS NULL";
1770 } else {
1771 // IN clause contains at least one valid element
1772 if ( $includeNull ) {
1773 // Group subconditions to ensure correct precedence
1774 $list .= '(';
1775 }
1776 if ( count( $value ) == 1 ) {
1777 // Special-case single values, as IN isn't terribly efficient
1778 // Don't necessarily assume the single key is 0; we don't
1779 // enforce linear numeric ordering on other arrays here.
1780 $value = array_values( $value )[0];
1781 $list .= $field . " = " . $this->addQuotes( $value );
1782 } else {
1783 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1784 }
1785 // if null present in array, append IS NULL
1786 if ( $includeNull ) {
1787 $list .= " OR $field IS NULL)";
1788 }
1789 }
1790 } elseif ( $value === null ) {
1791 if ( $mode == self::LIST_AND || $mode == self::LIST_OR ) {
1792 $list .= "$field IS ";
1793 } elseif ( $mode == self::LIST_SET ) {
1794 $list .= "$field = ";
1795 }
1796 $list .= 'NULL';
1797 } else {
1798 if (
1799 $mode == self::LIST_AND || $mode == self::LIST_OR || $mode == self::LIST_SET
1800 ) {
1801 $list .= "$field = ";
1802 }
1803 $list .= $mode == self::LIST_NAMES ? $value : $this->addQuotes( $value );
1804 }
1805 }
1806
1807 return $list;
1808 }
1809
1810 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1811 $conds = [];
1812
1813 foreach ( $data as $base => $sub ) {
1814 if ( count( $sub ) ) {
1815 $conds[] = $this->makeList(
1816 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
1817 self::LIST_AND );
1818 }
1819 }
1820
1821 if ( $conds ) {
1822 return $this->makeList( $conds, self::LIST_OR );
1823 } else {
1824 // Nothing to search for...
1825 return false;
1826 }
1827 }
1828
1829 public function aggregateValue( $valuedata, $valuename = 'value' ) {
1830 return $valuename;
1831 }
1832
1833 public function bitNot( $field ) {
1834 return "(~$field)";
1835 }
1836
1837 public function bitAnd( $fieldLeft, $fieldRight ) {
1838 return "($fieldLeft & $fieldRight)";
1839 }
1840
1841 public function bitOr( $fieldLeft, $fieldRight ) {
1842 return "($fieldLeft | $fieldRight)";
1843 }
1844
1845 public function buildConcat( $stringList ) {
1846 return 'CONCAT(' . implode( ',', $stringList ) . ')';
1847 }
1848
1849 public function buildGroupConcatField(
1850 $delim, $table, $field, $conds = '', $join_conds = []
1851 ) {
1852 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
1853
1854 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1855 }
1856
1857 public function buildSubstring( $input, $startPosition, $length = null ) {
1858 $this->assertBuildSubstringParams( $startPosition, $length );
1859 $functionBody = "$input FROM $startPosition";
1860 if ( $length !== null ) {
1861 $functionBody .= " FOR $length";
1862 }
1863 return 'SUBSTRING(' . $functionBody . ')';
1864 }
1865
1866 /**
1867 * Check type and bounds for parameters to self::buildSubstring()
1868 *
1869 * All supported databases have substring functions that behave the same for
1870 * positive $startPosition and non-negative $length, but behaviors differ when
1871 * given 0 or negative $startPosition or negative $length. The simplest
1872 * solution to that is to just forbid those values.
1873 *
1874 * @param int $startPosition
1875 * @param int|null $length
1876 * @since 1.31
1877 */
1878 protected function assertBuildSubstringParams( $startPosition, $length ) {
1879 if ( !is_int( $startPosition ) || $startPosition <= 0 ) {
1880 throw new InvalidArgumentException(
1881 '$startPosition must be a positive integer'
1882 );
1883 }
1884 if ( !( is_int( $length ) && $length >= 0 || $length === null ) ) {
1885 throw new InvalidArgumentException(
1886 '$length must be null or an integer greater than or equal to 0'
1887 );
1888 }
1889 }
1890
1891 public function buildStringCast( $field ) {
1892 return $field;
1893 }
1894
1895 public function buildIntegerCast( $field ) {
1896 return 'CAST( ' . $field . ' AS INTEGER )';
1897 }
1898
1899 public function databasesAreIndependent() {
1900 return false;
1901 }
1902
1903 public function selectDB( $db ) {
1904 # Stub. Shouldn't cause serious problems if it's not overridden, but
1905 # if your database engine supports a concept similar to MySQL's
1906 # databases you may as well.
1907 $this->dbName = $db;
1908
1909 return true;
1910 }
1911
1912 public function getDBname() {
1913 return $this->dbName;
1914 }
1915
1916 public function getServer() {
1917 return $this->server;
1918 }
1919
1920 public function tableName( $name, $format = 'quoted' ) {
1921 # Skip the entire process when we have a string quoted on both ends.
1922 # Note that we check the end so that we will still quote any use of
1923 # use of `database`.table. But won't break things if someone wants
1924 # to query a database table with a dot in the name.
1925 if ( $this->isQuotedIdentifier( $name ) ) {
1926 return $name;
1927 }
1928
1929 # Lets test for any bits of text that should never show up in a table
1930 # name. Basically anything like JOIN or ON which are actually part of
1931 # SQL queries, but may end up inside of the table value to combine
1932 # sql. Such as how the API is doing.
1933 # Note that we use a whitespace test rather than a \b test to avoid
1934 # any remote case where a word like on may be inside of a table name
1935 # surrounded by symbols which may be considered word breaks.
1936 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
1937 return $name;
1938 }
1939
1940 # Split database and table into proper variables.
1941 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
1942
1943 # Quote $table and apply the prefix if not quoted.
1944 # $tableName might be empty if this is called from Database::replaceVars()
1945 $tableName = "{$prefix}{$table}";
1946 if ( $format === 'quoted'
1947 && !$this->isQuotedIdentifier( $tableName )
1948 && $tableName !== ''
1949 ) {
1950 $tableName = $this->addIdentifierQuotes( $tableName );
1951 }
1952
1953 # Quote $schema and $database and merge them with the table name if needed
1954 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
1955 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
1956
1957 return $tableName;
1958 }
1959
1960 /**
1961 * Get the table components needed for a query given the currently selected database
1962 *
1963 * @param string $name Table name in the form of db.schema.table, db.table, or table
1964 * @return array (DB name or "" for default, schema name, table prefix, table name)
1965 */
1966 protected function qualifiedTableComponents( $name ) {
1967 # We reverse the explode so that database.table and table both output the correct table.
1968 $dbDetails = explode( '.', $name, 3 );
1969 if ( count( $dbDetails ) == 3 ) {
1970 list( $database, $schema, $table ) = $dbDetails;
1971 # We don't want any prefix added in this case
1972 $prefix = '';
1973 } elseif ( count( $dbDetails ) == 2 ) {
1974 list( $database, $table ) = $dbDetails;
1975 # We don't want any prefix added in this case
1976 $prefix = '';
1977 # In dbs that support it, $database may actually be the schema
1978 # but that doesn't affect any of the functionality here
1979 $schema = '';
1980 } else {
1981 list( $table ) = $dbDetails;
1982 if ( isset( $this->tableAliases[$table] ) ) {
1983 $database = $this->tableAliases[$table]['dbname'];
1984 $schema = is_string( $this->tableAliases[$table]['schema'] )
1985 ? $this->tableAliases[$table]['schema']
1986 : $this->schema;
1987 $prefix = is_string( $this->tableAliases[$table]['prefix'] )
1988 ? $this->tableAliases[$table]['prefix']
1989 : $this->tablePrefix;
1990 } else {
1991 $database = '';
1992 $schema = $this->schema; # Default schema
1993 $prefix = $this->tablePrefix; # Default prefix
1994 }
1995 }
1996
1997 return [ $database, $schema, $prefix, $table ];
1998 }
1999
2000 /**
2001 * @param string|null $namespace Database or schema
2002 * @param string $relation Name of table, view, sequence, etc...
2003 * @param string $format One of (raw, quoted)
2004 * @return string Relation name with quoted and merged $namespace as needed
2005 */
2006 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2007 if ( strlen( $namespace ) ) {
2008 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2009 $namespace = $this->addIdentifierQuotes( $namespace );
2010 }
2011 $relation = $namespace . '.' . $relation;
2012 }
2013
2014 return $relation;
2015 }
2016
2017 public function tableNames() {
2018 $inArray = func_get_args();
2019 $retVal = [];
2020
2021 foreach ( $inArray as $name ) {
2022 $retVal[$name] = $this->tableName( $name );
2023 }
2024
2025 return $retVal;
2026 }
2027
2028 public function tableNamesN() {
2029 $inArray = func_get_args();
2030 $retVal = [];
2031
2032 foreach ( $inArray as $name ) {
2033 $retVal[] = $this->tableName( $name );
2034 }
2035
2036 return $retVal;
2037 }
2038
2039 /**
2040 * Get an aliased table name
2041 * e.g. tableName AS newTableName
2042 *
2043 * @param string $name Table name, see tableName()
2044 * @param string|bool $alias Alias (optional)
2045 * @return string SQL name for aliased table. Will not alias a table to its own name
2046 */
2047 protected function tableNameWithAlias( $name, $alias = false ) {
2048 if ( !$alias || $alias == $name ) {
2049 return $this->tableName( $name );
2050 } else {
2051 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2052 }
2053 }
2054
2055 /**
2056 * Gets an array of aliased table names
2057 *
2058 * @param array $tables [ [alias] => table ]
2059 * @return string[] See tableNameWithAlias()
2060 */
2061 protected function tableNamesWithAlias( $tables ) {
2062 $retval = [];
2063 foreach ( $tables as $alias => $table ) {
2064 if ( is_numeric( $alias ) ) {
2065 $alias = $table;
2066 }
2067 $retval[] = $this->tableNameWithAlias( $table, $alias );
2068 }
2069
2070 return $retval;
2071 }
2072
2073 /**
2074 * Get an aliased field name
2075 * e.g. fieldName AS newFieldName
2076 *
2077 * @param string $name Field name
2078 * @param string|bool $alias Alias (optional)
2079 * @return string SQL name for aliased field. Will not alias a field to its own name
2080 */
2081 protected function fieldNameWithAlias( $name, $alias = false ) {
2082 if ( !$alias || (string)$alias === (string)$name ) {
2083 return $name;
2084 } else {
2085 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2086 }
2087 }
2088
2089 /**
2090 * Gets an array of aliased field names
2091 *
2092 * @param array $fields [ [alias] => field ]
2093 * @return string[] See fieldNameWithAlias()
2094 */
2095 protected function fieldNamesWithAlias( $fields ) {
2096 $retval = [];
2097 foreach ( $fields as $alias => $field ) {
2098 if ( is_numeric( $alias ) ) {
2099 $alias = $field;
2100 }
2101 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2102 }
2103
2104 return $retval;
2105 }
2106
2107 /**
2108 * Get the aliased table name clause for a FROM clause
2109 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2110 *
2111 * @param array $tables ( [alias] => table )
2112 * @param array $use_index Same as for select()
2113 * @param array $ignore_index Same as for select()
2114 * @param array $join_conds Same as for select()
2115 * @return string
2116 */
2117 protected function tableNamesWithIndexClauseOrJOIN(
2118 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2119 ) {
2120 $ret = [];
2121 $retJOIN = [];
2122 $use_index = (array)$use_index;
2123 $ignore_index = (array)$ignore_index;
2124 $join_conds = (array)$join_conds;
2125
2126 foreach ( $tables as $alias => $table ) {
2127 if ( !is_string( $alias ) ) {
2128 // No alias? Set it equal to the table name
2129 $alias = $table;
2130 }
2131
2132 if ( is_array( $table ) ) {
2133 // A parenthesized group
2134 if ( count( $table ) > 1 ) {
2135 $joinedTable = '('
2136 . $this->tableNamesWithIndexClauseOrJOIN( $table, $use_index, $ignore_index, $join_conds )
2137 . ')';
2138 } else {
2139 // Degenerate case
2140 $innerTable = reset( $table );
2141 $innerAlias = key( $table );
2142 $joinedTable = $this->tableNameWithAlias(
2143 $innerTable,
2144 is_string( $innerAlias ) ? $innerAlias : $innerTable
2145 );
2146 }
2147 } else {
2148 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2149 }
2150
2151 // Is there a JOIN clause for this table?
2152 if ( isset( $join_conds[$alias] ) ) {
2153 list( $joinType, $conds ) = $join_conds[$alias];
2154 $tableClause = $joinType;
2155 $tableClause .= ' ' . $joinedTable;
2156 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2157 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2158 if ( $use != '' ) {
2159 $tableClause .= ' ' . $use;
2160 }
2161 }
2162 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2163 $ignore = $this->ignoreIndexClause(
2164 implode( ',', (array)$ignore_index[$alias] ) );
2165 if ( $ignore != '' ) {
2166 $tableClause .= ' ' . $ignore;
2167 }
2168 }
2169 $on = $this->makeList( (array)$conds, self::LIST_AND );
2170 if ( $on != '' ) {
2171 $tableClause .= ' ON (' . $on . ')';
2172 }
2173
2174 $retJOIN[] = $tableClause;
2175 } elseif ( isset( $use_index[$alias] ) ) {
2176 // Is there an INDEX clause for this table?
2177 $tableClause = $joinedTable;
2178 $tableClause .= ' ' . $this->useIndexClause(
2179 implode( ',', (array)$use_index[$alias] )
2180 );
2181
2182 $ret[] = $tableClause;
2183 } elseif ( isset( $ignore_index[$alias] ) ) {
2184 // Is there an INDEX clause for this table?
2185 $tableClause = $joinedTable;
2186 $tableClause .= ' ' . $this->ignoreIndexClause(
2187 implode( ',', (array)$ignore_index[$alias] )
2188 );
2189
2190 $ret[] = $tableClause;
2191 } else {
2192 $tableClause = $joinedTable;
2193
2194 $ret[] = $tableClause;
2195 }
2196 }
2197
2198 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2199 $implicitJoins = $ret ? implode( ',', $ret ) : "";
2200 $explicitJoins = $retJOIN ? implode( ' ', $retJOIN ) : "";
2201
2202 // Compile our final table clause
2203 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2204 }
2205
2206 /**
2207 * Allows for index remapping in queries where this is not consistent across DBMS
2208 *
2209 * @param string $index
2210 * @return string
2211 */
2212 protected function indexName( $index ) {
2213 return $index;
2214 }
2215
2216 public function addQuotes( $s ) {
2217 if ( $s instanceof Blob ) {
2218 $s = $s->fetch();
2219 }
2220 if ( $s === null ) {
2221 return 'NULL';
2222 } elseif ( is_bool( $s ) ) {
2223 return (int)$s;
2224 } else {
2225 # This will also quote numeric values. This should be harmless,
2226 # and protects against weird problems that occur when they really
2227 # _are_ strings such as article titles and string->number->string
2228 # conversion is not 1:1.
2229 return "'" . $this->strencode( $s ) . "'";
2230 }
2231 }
2232
2233 /**
2234 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2235 * MySQL uses `backticks` while basically everything else uses double quotes.
2236 * Since MySQL is the odd one out here the double quotes are our generic
2237 * and we implement backticks in DatabaseMysqlBase.
2238 *
2239 * @param string $s
2240 * @return string
2241 */
2242 public function addIdentifierQuotes( $s ) {
2243 return '"' . str_replace( '"', '""', $s ) . '"';
2244 }
2245
2246 /**
2247 * Returns if the given identifier looks quoted or not according to
2248 * the database convention for quoting identifiers .
2249 *
2250 * @note Do not use this to determine if untrusted input is safe.
2251 * A malicious user can trick this function.
2252 * @param string $name
2253 * @return bool
2254 */
2255 public function isQuotedIdentifier( $name ) {
2256 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2257 }
2258
2259 /**
2260 * @param string $s
2261 * @param string $escapeChar
2262 * @return string
2263 */
2264 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2265 return str_replace( [ $escapeChar, '%', '_' ],
2266 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2267 $s );
2268 }
2269
2270 public function buildLike() {
2271 $params = func_get_args();
2272
2273 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2274 $params = $params[0];
2275 }
2276
2277 $s = '';
2278
2279 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2280 // may escape backslashes, creating problems of double escaping. The `
2281 // character has good cross-DBMS compatibility, avoiding special operators
2282 // in MS SQL like ^ and %
2283 $escapeChar = '`';
2284
2285 foreach ( $params as $value ) {
2286 if ( $value instanceof LikeMatch ) {
2287 $s .= $value->toString();
2288 } else {
2289 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2290 }
2291 }
2292
2293 return ' LIKE ' . $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2294 }
2295
2296 public function anyChar() {
2297 return new LikeMatch( '_' );
2298 }
2299
2300 public function anyString() {
2301 return new LikeMatch( '%' );
2302 }
2303
2304 public function nextSequenceValue( $seqName ) {
2305 return null;
2306 }
2307
2308 /**
2309 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2310 * is only needed because a) MySQL must be as efficient as possible due to
2311 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2312 * which index to pick. Anyway, other databases might have different
2313 * indexes on a given table. So don't bother overriding this unless you're
2314 * MySQL.
2315 * @param string $index
2316 * @return string
2317 */
2318 public function useIndexClause( $index ) {
2319 return '';
2320 }
2321
2322 /**
2323 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2324 * is only needed because a) MySQL must be as efficient as possible due to
2325 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2326 * which index to pick. Anyway, other databases might have different
2327 * indexes on a given table. So don't bother overriding this unless you're
2328 * MySQL.
2329 * @param string $index
2330 * @return string
2331 */
2332 public function ignoreIndexClause( $index ) {
2333 return '';
2334 }
2335
2336 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
2337 if ( count( $rows ) == 0 ) {
2338 return;
2339 }
2340
2341 // Single row case
2342 if ( !is_array( reset( $rows ) ) ) {
2343 $rows = [ $rows ];
2344 }
2345
2346 try {
2347 $this->startAtomic( $fname );
2348 $affectedRowCount = 0;
2349 foreach ( $rows as $row ) {
2350 // Delete rows which collide with this one
2351 $indexWhereClauses = [];
2352 foreach ( $uniqueIndexes as $index ) {
2353 $indexColumns = (array)$index;
2354 $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2355 if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2356 throw new DBUnexpectedError(
2357 $this,
2358 'New record does not provide all values for unique key (' .
2359 implode( ', ', $indexColumns ) . ')'
2360 );
2361 } elseif ( in_array( null, $indexRowValues, true ) ) {
2362 throw new DBUnexpectedError(
2363 $this,
2364 'New record has a null value for unique key (' .
2365 implode( ', ', $indexColumns ) . ')'
2366 );
2367 }
2368 $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND );
2369 }
2370
2371 if ( $indexWhereClauses ) {
2372 $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR ), $fname );
2373 $affectedRowCount += $this->affectedRows();
2374 }
2375
2376 // Now insert the row
2377 $this->insert( $table, $row, $fname );
2378 $affectedRowCount += $this->affectedRows();
2379 }
2380 $this->endAtomic( $fname );
2381 $this->affectedRowCount = $affectedRowCount;
2382 } catch ( Exception $e ) {
2383 $this->rollback( $fname, self::FLUSHING_INTERNAL );
2384 throw $e;
2385 }
2386 }
2387
2388 /**
2389 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2390 * statement.
2391 *
2392 * @param string $table Table name
2393 * @param array|string $rows Row(s) to insert
2394 * @param string $fname Caller function name
2395 *
2396 * @return ResultWrapper
2397 */
2398 protected function nativeReplace( $table, $rows, $fname ) {
2399 $table = $this->tableName( $table );
2400
2401 # Single row case
2402 if ( !is_array( reset( $rows ) ) ) {
2403 $rows = [ $rows ];
2404 }
2405
2406 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2407 $first = true;
2408
2409 foreach ( $rows as $row ) {
2410 if ( $first ) {
2411 $first = false;
2412 } else {
2413 $sql .= ',';
2414 }
2415
2416 $sql .= '(' . $this->makeList( $row ) . ')';
2417 }
2418
2419 return $this->query( $sql, $fname );
2420 }
2421
2422 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2423 $fname = __METHOD__
2424 ) {
2425 if ( !count( $rows ) ) {
2426 return true; // nothing to do
2427 }
2428
2429 if ( !is_array( reset( $rows ) ) ) {
2430 $rows = [ $rows ];
2431 }
2432
2433 if ( count( $uniqueIndexes ) ) {
2434 $clauses = []; // list WHERE clauses that each identify a single row
2435 foreach ( $rows as $row ) {
2436 foreach ( $uniqueIndexes as $index ) {
2437 $index = is_array( $index ) ? $index : [ $index ]; // columns
2438 $rowKey = []; // unique key to this row
2439 foreach ( $index as $column ) {
2440 $rowKey[$column] = $row[$column];
2441 }
2442 $clauses[] = $this->makeList( $rowKey, self::LIST_AND );
2443 }
2444 }
2445 $where = [ $this->makeList( $clauses, self::LIST_OR ) ];
2446 } else {
2447 $where = false;
2448 }
2449
2450 $affectedRowCount = 0;
2451 try {
2452 $this->startAtomic( $fname );
2453 # Update any existing conflicting row(s)
2454 if ( $where !== false ) {
2455 $ok = $this->update( $table, $set, $where, $fname );
2456 $affectedRowCount += $this->affectedRows();
2457 } else {
2458 $ok = true;
2459 }
2460 # Now insert any non-conflicting row(s)
2461 $ok = $this->insert( $table, $rows, $fname, [ 'IGNORE' ] ) && $ok;
2462 $affectedRowCount += $this->affectedRows();
2463 $this->endAtomic( $fname );
2464 $this->affectedRowCount = $affectedRowCount;
2465 } catch ( Exception $e ) {
2466 $this->rollback( $fname, self::FLUSHING_INTERNAL );
2467 throw $e;
2468 }
2469
2470 return $ok;
2471 }
2472
2473 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2474 $fname = __METHOD__
2475 ) {
2476 if ( !$conds ) {
2477 throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
2478 }
2479
2480 $delTable = $this->tableName( $delTable );
2481 $joinTable = $this->tableName( $joinTable );
2482 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2483 if ( $conds != '*' ) {
2484 $sql .= 'WHERE ' . $this->makeList( $conds, self::LIST_AND );
2485 }
2486 $sql .= ')';
2487
2488 $this->query( $sql, $fname );
2489 }
2490
2491 public function textFieldSize( $table, $field ) {
2492 $table = $this->tableName( $table );
2493 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2494 $res = $this->query( $sql, __METHOD__ );
2495 $row = $this->fetchObject( $res );
2496
2497 $m = [];
2498
2499 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
2500 $size = $m[1];
2501 } else {
2502 $size = -1;
2503 }
2504
2505 return $size;
2506 }
2507
2508 public function delete( $table, $conds, $fname = __METHOD__ ) {
2509 if ( !$conds ) {
2510 throw new DBUnexpectedError( $this, __METHOD__ . ' called with no conditions' );
2511 }
2512
2513 $table = $this->tableName( $table );
2514 $sql = "DELETE FROM $table";
2515
2516 if ( $conds != '*' ) {
2517 if ( is_array( $conds ) ) {
2518 $conds = $this->makeList( $conds, self::LIST_AND );
2519 }
2520 $sql .= ' WHERE ' . $conds;
2521 }
2522
2523 return $this->query( $sql, $fname );
2524 }
2525
2526 final public function insertSelect(
2527 $destTable, $srcTable, $varMap, $conds,
2528 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2529 ) {
2530 static $hints = [ 'NO_AUTO_COLUMNS' ];
2531
2532 $insertOptions = (array)$insertOptions;
2533 $selectOptions = (array)$selectOptions;
2534
2535 if ( $this->cliMode && $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
2536 // For massive migrations with downtime, we don't want to select everything
2537 // into memory and OOM, so do all this native on the server side if possible.
2538 return $this->nativeInsertSelect(
2539 $destTable,
2540 $srcTable,
2541 $varMap,
2542 $conds,
2543 $fname,
2544 array_diff( $insertOptions, $hints ),
2545 $selectOptions,
2546 $selectJoinConds
2547 );
2548 }
2549
2550 return $this->nonNativeInsertSelect(
2551 $destTable,
2552 $srcTable,
2553 $varMap,
2554 $conds,
2555 $fname,
2556 array_diff( $insertOptions, $hints ),
2557 $selectOptions,
2558 $selectJoinConds
2559 );
2560 }
2561
2562 /**
2563 * @param array $insertOptions INSERT options
2564 * @param array $selectOptions SELECT options
2565 * @return bool Whether an INSERT SELECT with these options will be replication safe
2566 * @since 1.31
2567 */
2568 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
2569 return true;
2570 }
2571
2572 /**
2573 * Implementation of insertSelect() based on select() and insert()
2574 *
2575 * @see IDatabase::insertSelect()
2576 * @since 1.30
2577 * @param string $destTable
2578 * @param string|array $srcTable
2579 * @param array $varMap
2580 * @param array $conds
2581 * @param string $fname
2582 * @param array $insertOptions
2583 * @param array $selectOptions
2584 * @param array $selectJoinConds
2585 * @return bool
2586 */
2587 protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
2588 $fname = __METHOD__,
2589 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2590 ) {
2591 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
2592 // on only the master (without needing row-based-replication). It also makes it easy to
2593 // know how big the INSERT is going to be.
2594 $fields = [];
2595 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
2596 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
2597 }
2598 $selectOptions[] = 'FOR UPDATE';
2599 $res = $this->select(
2600 $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
2601 );
2602 if ( !$res ) {
2603 return false;
2604 }
2605
2606 try {
2607 $affectedRowCount = 0;
2608 $this->startAtomic( $fname );
2609 $rows = [];
2610 $ok = true;
2611 foreach ( $res as $row ) {
2612 $rows[] = (array)$row;
2613
2614 // Avoid inserts that are too huge
2615 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize ) {
2616 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
2617 if ( !$ok ) {
2618 break;
2619 }
2620 $affectedRowCount += $this->affectedRows();
2621 $rows = [];
2622 }
2623 }
2624 if ( $rows && $ok ) {
2625 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
2626 if ( $ok ) {
2627 $affectedRowCount += $this->affectedRows();
2628 }
2629 }
2630 if ( $ok ) {
2631 $this->endAtomic( $fname );
2632 $this->affectedRowCount = $affectedRowCount;
2633 } else {
2634 $this->rollback( $fname, self::FLUSHING_INTERNAL );
2635 }
2636 return $ok;
2637 } catch ( Exception $e ) {
2638 $this->rollback( $fname, self::FLUSHING_INTERNAL );
2639 throw $e;
2640 }
2641 }
2642
2643 /**
2644 * Native server-side implementation of insertSelect() for situations where
2645 * we don't want to select everything into memory
2646 *
2647 * @see IDatabase::insertSelect()
2648 * @param string $destTable
2649 * @param string|array $srcTable
2650 * @param array $varMap
2651 * @param array $conds
2652 * @param string $fname
2653 * @param array $insertOptions
2654 * @param array $selectOptions
2655 * @param array $selectJoinConds
2656 * @return bool
2657 */
2658 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
2659 $fname = __METHOD__,
2660 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2661 ) {
2662 $destTable = $this->tableName( $destTable );
2663
2664 if ( !is_array( $insertOptions ) ) {
2665 $insertOptions = [ $insertOptions ];
2666 }
2667
2668 $insertOptions = $this->makeInsertOptions( $insertOptions );
2669
2670 $selectSql = $this->selectSQLText(
2671 $srcTable,
2672 array_values( $varMap ),
2673 $conds,
2674 $fname,
2675 $selectOptions,
2676 $selectJoinConds
2677 );
2678
2679 $sql = "INSERT $insertOptions" .
2680 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
2681 $selectSql;
2682
2683 return $this->query( $sql, $fname );
2684 }
2685
2686 /**
2687 * Construct a LIMIT query with optional offset. This is used for query
2688 * pages. The SQL should be adjusted so that only the first $limit rows
2689 * are returned. If $offset is provided as well, then the first $offset
2690 * rows should be discarded, and the next $limit rows should be returned.
2691 * If the result of the query is not ordered, then the rows to be returned
2692 * are theoretically arbitrary.
2693 *
2694 * $sql is expected to be a SELECT, if that makes a difference.
2695 *
2696 * The version provided by default works in MySQL and SQLite. It will very
2697 * likely need to be overridden for most other DBMSes.
2698 *
2699 * @param string $sql SQL query we will append the limit too
2700 * @param int $limit The SQL limit
2701 * @param int|bool $offset The SQL offset (default false)
2702 * @throws DBUnexpectedError
2703 * @return string
2704 */
2705 public function limitResult( $sql, $limit, $offset = false ) {
2706 if ( !is_numeric( $limit ) ) {
2707 throw new DBUnexpectedError( $this,
2708 "Invalid non-numeric limit passed to limitResult()\n" );
2709 }
2710
2711 return "$sql LIMIT "
2712 . ( ( is_numeric( $offset ) && $offset != 0 ) ? "{$offset}," : "" )
2713 . "{$limit} ";
2714 }
2715
2716 public function unionSupportsOrderAndLimit() {
2717 return true; // True for almost every DB supported
2718 }
2719
2720 public function unionQueries( $sqls, $all ) {
2721 $glue = $all ? ') UNION ALL (' : ') UNION (';
2722
2723 return '(' . implode( $glue, $sqls ) . ')';
2724 }
2725
2726 public function unionConditionPermutations(
2727 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
2728 $options = [], $join_conds = []
2729 ) {
2730 // First, build the Cartesian product of $permute_conds
2731 $conds = [ [] ];
2732 foreach ( $permute_conds as $field => $values ) {
2733 if ( !$values ) {
2734 // Skip empty $values
2735 continue;
2736 }
2737 $values = array_unique( $values ); // For sanity
2738 $newConds = [];
2739 foreach ( $conds as $cond ) {
2740 foreach ( $values as $value ) {
2741 $cond[$field] = $value;
2742 $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
2743 }
2744 }
2745 $conds = $newConds;
2746 }
2747
2748 $extra_conds = $extra_conds === '' ? [] : (array)$extra_conds;
2749
2750 // If there's just one condition and no subordering, hand off to
2751 // selectSQLText directly.
2752 if ( count( $conds ) === 1 &&
2753 ( !isset( $options['INNER ORDER BY'] ) || !$this->unionSupportsOrderAndLimit() )
2754 ) {
2755 return $this->selectSQLText(
2756 $table, $vars, $conds[0] + $extra_conds, $fname, $options, $join_conds
2757 );
2758 }
2759
2760 // Otherwise, we need to pull out the order and limit to apply after
2761 // the union. Then build the SQL queries for each set of conditions in
2762 // $conds. Then union them together (using UNION ALL, because the
2763 // product *should* already be distinct).
2764 $orderBy = $this->makeOrderBy( $options );
2765 $limit = isset( $options['LIMIT'] ) ? $options['LIMIT'] : null;
2766 $offset = isset( $options['OFFSET'] ) ? $options['OFFSET'] : false;
2767 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
2768 if ( !$this->unionSupportsOrderAndLimit() ) {
2769 unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
2770 } else {
2771 if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
2772 $options['ORDER BY'] = $options['INNER ORDER BY'];
2773 }
2774 if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
2775 // We need to increase the limit by the offset rather than
2776 // using the offset directly, otherwise it'll skip incorrectly
2777 // in the subqueries.
2778 $options['LIMIT'] = $limit + $offset;
2779 unset( $options['OFFSET'] );
2780 }
2781 }
2782
2783 $sqls = [];
2784 foreach ( $conds as $cond ) {
2785 $sqls[] = $this->selectSQLText(
2786 $table, $vars, $cond + $extra_conds, $fname, $options, $join_conds
2787 );
2788 }
2789 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
2790 if ( $limit !== null ) {
2791 $sql = $this->limitResult( $sql, $limit, $offset );
2792 }
2793
2794 return $sql;
2795 }
2796
2797 public function conditional( $cond, $trueVal, $falseVal ) {
2798 if ( is_array( $cond ) ) {
2799 $cond = $this->makeList( $cond, self::LIST_AND );
2800 }
2801
2802 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2803 }
2804
2805 public function strreplace( $orig, $old, $new ) {
2806 return "REPLACE({$orig}, {$old}, {$new})";
2807 }
2808
2809 public function getServerUptime() {
2810 return 0;
2811 }
2812
2813 public function wasDeadlock() {
2814 return false;
2815 }
2816
2817 public function wasLockTimeout() {
2818 return false;
2819 }
2820
2821 public function wasErrorReissuable() {
2822 return false;
2823 }
2824
2825 public function wasReadOnlyError() {
2826 return false;
2827 }
2828
2829 /**
2830 * Do not use this method outside of Database/DBError classes
2831 *
2832 * @param int|string $errno
2833 * @return bool Whether the given query error was a connection drop
2834 */
2835 public function wasConnectionError( $errno ) {
2836 return false;
2837 }
2838
2839 public function deadlockLoop() {
2840 $args = func_get_args();
2841 $function = array_shift( $args );
2842 $tries = self::DEADLOCK_TRIES;
2843
2844 $this->begin( __METHOD__ );
2845
2846 $retVal = null;
2847 /** @var Exception $e */
2848 $e = null;
2849 do {
2850 try {
2851 $retVal = call_user_func_array( $function, $args );
2852 break;
2853 } catch ( DBQueryError $e ) {
2854 if ( $this->wasDeadlock() ) {
2855 // Retry after a randomized delay
2856 usleep( mt_rand( self::DEADLOCK_DELAY_MIN, self::DEADLOCK_DELAY_MAX ) );
2857 } else {
2858 // Throw the error back up
2859 throw $e;
2860 }
2861 }
2862 } while ( --$tries > 0 );
2863
2864 if ( $tries <= 0 ) {
2865 // Too many deadlocks; give up
2866 $this->rollback( __METHOD__ );
2867 throw $e;
2868 } else {
2869 $this->commit( __METHOD__ );
2870
2871 return $retVal;
2872 }
2873 }
2874
2875 public function masterPosWait( DBMasterPos $pos, $timeout ) {
2876 # Real waits are implemented in the subclass.
2877 return 0;
2878 }
2879
2880 public function getReplicaPos() {
2881 # Stub
2882 return false;
2883 }
2884
2885 public function getMasterPos() {
2886 # Stub
2887 return false;
2888 }
2889
2890 public function serverIsReadOnly() {
2891 return false;
2892 }
2893
2894 final public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
2895 if ( !$this->trxLevel ) {
2896 throw new DBUnexpectedError( $this, "No transaction is active." );
2897 }
2898 $this->trxEndCallbacks[] = [ $callback, $fname ];
2899 }
2900
2901 final public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
2902 $this->trxIdleCallbacks[] = [ $callback, $fname ];
2903 if ( !$this->trxLevel ) {
2904 $this->runOnTransactionIdleCallbacks( self::TRIGGER_IDLE );
2905 }
2906 }
2907
2908 final public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
2909 if ( $this->trxLevel || $this->getFlag( self::DBO_TRX ) ) {
2910 // As long as DBO_TRX is set, writes will accumulate until the load balancer issues
2911 // an implicit commit of all peer databases. This is true even if a transaction has
2912 // not yet been triggered by writes; make sure $callback runs *after* any such writes.
2913 $this->trxPreCommitCallbacks[] = [ $callback, $fname ];
2914 } else {
2915 // No transaction is active nor will start implicitly, so make one for this callback
2916 $this->startAtomic( __METHOD__ );
2917 try {
2918 call_user_func( $callback );
2919 $this->endAtomic( __METHOD__ );
2920 } catch ( Exception $e ) {
2921 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
2922 throw $e;
2923 }
2924 }
2925 }
2926
2927 final public function setTransactionListener( $name, callable $callback = null ) {
2928 if ( $callback ) {
2929 $this->trxRecurringCallbacks[$name] = $callback;
2930 } else {
2931 unset( $this->trxRecurringCallbacks[$name] );
2932 }
2933 }
2934
2935 /**
2936 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
2937 *
2938 * This method should not be used outside of Database/LoadBalancer
2939 *
2940 * @param bool $suppress
2941 * @since 1.28
2942 */
2943 final public function setTrxEndCallbackSuppression( $suppress ) {
2944 $this->trxEndCallbacksSuppressed = $suppress;
2945 }
2946
2947 /**
2948 * Actually run and consume any "on transaction idle/resolution" callbacks.
2949 *
2950 * This method should not be used outside of Database/LoadBalancer
2951 *
2952 * @param int $trigger IDatabase::TRIGGER_* constant
2953 * @since 1.20
2954 * @throws Exception
2955 */
2956 public function runOnTransactionIdleCallbacks( $trigger ) {
2957 if ( $this->trxEndCallbacksSuppressed ) {
2958 return;
2959 }
2960
2961 $autoTrx = $this->getFlag( self::DBO_TRX ); // automatic begin() enabled?
2962 /** @var Exception $e */
2963 $e = null; // first exception
2964 do { // callbacks may add callbacks :)
2965 $callbacks = array_merge(
2966 $this->trxIdleCallbacks,
2967 $this->trxEndCallbacks // include "transaction resolution" callbacks
2968 );
2969 $this->trxIdleCallbacks = []; // consumed (and recursion guard)
2970 $this->trxEndCallbacks = []; // consumed (recursion guard)
2971 foreach ( $callbacks as $callback ) {
2972 try {
2973 list( $phpCallback ) = $callback;
2974 $this->clearFlag( self::DBO_TRX ); // make each query its own transaction
2975 call_user_func_array( $phpCallback, [ $trigger ] );
2976 if ( $autoTrx ) {
2977 $this->setFlag( self::DBO_TRX ); // restore automatic begin()
2978 } else {
2979 $this->clearFlag( self::DBO_TRX ); // restore auto-commit
2980 }
2981 } catch ( Exception $ex ) {
2982 call_user_func( $this->errorLogger, $ex );
2983 $e = $e ?: $ex;
2984 // Some callbacks may use startAtomic/endAtomic, so make sure
2985 // their transactions are ended so other callbacks don't fail
2986 if ( $this->trxLevel() ) {
2987 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
2988 }
2989 }
2990 }
2991 } while ( count( $this->trxIdleCallbacks ) );
2992
2993 if ( $e instanceof Exception ) {
2994 throw $e; // re-throw any first exception
2995 }
2996 }
2997
2998 /**
2999 * Actually run and consume any "on transaction pre-commit" callbacks.
3000 *
3001 * This method should not be used outside of Database/LoadBalancer
3002 *
3003 * @since 1.22
3004 * @throws Exception
3005 */
3006 public function runOnTransactionPreCommitCallbacks() {
3007 $e = null; // first exception
3008 do { // callbacks may add callbacks :)
3009 $callbacks = $this->trxPreCommitCallbacks;
3010 $this->trxPreCommitCallbacks = []; // consumed (and recursion guard)
3011 foreach ( $callbacks as $callback ) {
3012 try {
3013 list( $phpCallback ) = $callback;
3014 call_user_func( $phpCallback );
3015 } catch ( Exception $ex ) {
3016 call_user_func( $this->errorLogger, $ex );
3017 $e = $e ?: $ex;
3018 }
3019 }
3020 } while ( count( $this->trxPreCommitCallbacks ) );
3021
3022 if ( $e instanceof Exception ) {
3023 throw $e; // re-throw any first exception
3024 }
3025 }
3026
3027 /**
3028 * Actually run any "transaction listener" callbacks.
3029 *
3030 * This method should not be used outside of Database/LoadBalancer
3031 *
3032 * @param int $trigger IDatabase::TRIGGER_* constant
3033 * @throws Exception
3034 * @since 1.20
3035 */
3036 public function runTransactionListenerCallbacks( $trigger ) {
3037 if ( $this->trxEndCallbacksSuppressed ) {
3038 return;
3039 }
3040
3041 /** @var Exception $e */
3042 $e = null; // first exception
3043
3044 foreach ( $this->trxRecurringCallbacks as $phpCallback ) {
3045 try {
3046 $phpCallback( $trigger, $this );
3047 } catch ( Exception $ex ) {
3048 call_user_func( $this->errorLogger, $ex );
3049 $e = $e ?: $ex;
3050 }
3051 }
3052
3053 if ( $e instanceof Exception ) {
3054 throw $e; // re-throw any first exception
3055 }
3056 }
3057
3058 final public function startAtomic( $fname = __METHOD__ ) {
3059 if ( !$this->trxLevel ) {
3060 $this->begin( $fname, self::TRANSACTION_INTERNAL );
3061 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3062 // in all changes being in one transaction to keep requests transactional.
3063 if ( !$this->getFlag( self::DBO_TRX ) ) {
3064 $this->trxAutomaticAtomic = true;
3065 }
3066 }
3067
3068 $this->trxAtomicLevels[] = $fname;
3069 }
3070
3071 final public function endAtomic( $fname = __METHOD__ ) {
3072 if ( !$this->trxLevel ) {
3073 throw new DBUnexpectedError( $this, "No atomic transaction is open (got $fname)." );
3074 }
3075 if ( !$this->trxAtomicLevels ||
3076 array_pop( $this->trxAtomicLevels ) !== $fname
3077 ) {
3078 throw new DBUnexpectedError( $this, "Invalid atomic section ended (got $fname)." );
3079 }
3080
3081 if ( !$this->trxAtomicLevels && $this->trxAutomaticAtomic ) {
3082 $this->commit( $fname, self::FLUSHING_INTERNAL );
3083 }
3084 }
3085
3086 final public function doAtomicSection( $fname, callable $callback ) {
3087 $this->startAtomic( $fname );
3088 try {
3089 $res = call_user_func_array( $callback, [ $this, $fname ] );
3090 } catch ( Exception $e ) {
3091 $this->rollback( $fname, self::FLUSHING_INTERNAL );
3092 throw $e;
3093 }
3094 $this->endAtomic( $fname );
3095
3096 return $res;
3097 }
3098
3099 final public function begin( $fname = __METHOD__, $mode = self::TRANSACTION_EXPLICIT ) {
3100 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3101 if ( $this->trxLevel ) {
3102 if ( $this->trxAtomicLevels ) {
3103 $levels = implode( ', ', $this->trxAtomicLevels );
3104 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3105 throw new DBUnexpectedError( $this, $msg );
3106 } elseif ( !$this->trxAutomatic ) {
3107 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3108 throw new DBUnexpectedError( $this, $msg );
3109 } else {
3110 // @TODO: make this an exception at some point
3111 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3112 $this->queryLogger->error( $msg );
3113 return; // join the main transaction set
3114 }
3115 } elseif ( $this->getFlag( self::DBO_TRX ) && $mode !== self::TRANSACTION_INTERNAL ) {
3116 // @TODO: make this an exception at some point
3117 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3118 $this->queryLogger->error( $msg );
3119 return; // let any writes be in the main transaction
3120 }
3121
3122 // Avoid fatals if close() was called
3123 $this->assertOpen();
3124
3125 $this->doBegin( $fname );
3126 $this->trxTimestamp = microtime( true );
3127 $this->trxFname = $fname;
3128 $this->trxDoneWrites = false;
3129 $this->trxAutomaticAtomic = false;
3130 $this->trxAtomicLevels = [];
3131 $this->trxShortId = sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3132 $this->trxWriteDuration = 0.0;
3133 $this->trxWriteQueryCount = 0;
3134 $this->trxWriteAffectedRows = 0;
3135 $this->trxWriteAdjDuration = 0.0;
3136 $this->trxWriteAdjQueryCount = 0;
3137 $this->trxWriteCallers = [];
3138 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3139 // Get an estimate of the replica DB lag before then, treating estimate staleness
3140 // as lag itself just to be safe
3141 $status = $this->getApproximateLagStatus();
3142 $this->trxReplicaLag = $status['lag'] + ( microtime( true ) - $status['since'] );
3143 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3144 // caller will think its OK to muck around with the transaction just because startAtomic()
3145 // has not yet completed (e.g. setting trxAtomicLevels).
3146 $this->trxAutomatic = ( $mode === self::TRANSACTION_INTERNAL );
3147 }
3148
3149 /**
3150 * Issues the BEGIN command to the database server.
3151 *
3152 * @see Database::begin()
3153 * @param string $fname
3154 */
3155 protected function doBegin( $fname ) {
3156 $this->query( 'BEGIN', $fname );
3157 $this->trxLevel = 1;
3158 }
3159
3160 final public function commit( $fname = __METHOD__, $flush = '' ) {
3161 if ( $this->trxLevel && $this->trxAtomicLevels ) {
3162 // There are still atomic sections open. This cannot be ignored
3163 $levels = implode( ', ', $this->trxAtomicLevels );
3164 throw new DBUnexpectedError(
3165 $this,
3166 "$fname: Got COMMIT while atomic sections $levels are still open."
3167 );
3168 }
3169
3170 if ( $flush === self::FLUSHING_INTERNAL || $flush === self::FLUSHING_ALL_PEERS ) {
3171 if ( !$this->trxLevel ) {
3172 return; // nothing to do
3173 } elseif ( !$this->trxAutomatic ) {
3174 throw new DBUnexpectedError(
3175 $this,
3176 "$fname: Flushing an explicit transaction, getting out of sync."
3177 );
3178 }
3179 } else {
3180 if ( !$this->trxLevel ) {
3181 $this->queryLogger->error(
3182 "$fname: No transaction to commit, something got out of sync." );
3183 return; // nothing to do
3184 } elseif ( $this->trxAutomatic ) {
3185 // @TODO: make this an exception at some point
3186 $msg = "$fname: Explicit commit of implicit transaction.";
3187 $this->queryLogger->error( $msg );