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