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