Merge "Avoid function calls in the loop condition of a for statement"
[lhc/web/wiklou.git] / includes / db / Database.php
1 <?php
2
3 /**
4 * @defgroup Database Database
5 *
6 * This file deals with database interface functions
7 * and query specifics/optimisations.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
23 *
24 * @file
25 * @ingroup Database
26 */
27
28 /**
29 * Base interface for all DBMS-specific code. At a bare minimum, all of the
30 * following must be implemented to support MediaWiki
31 *
32 * @file
33 * @ingroup Database
34 */
35 interface DatabaseType {
36 /**
37 * Get the type of the DBMS, as it appears in $wgDBtype.
38 *
39 * @return string
40 */
41 function getType();
42
43 /**
44 * Open a connection to the database. Usually aborts on failure
45 *
46 * @param string $server Database server host
47 * @param string $user Database user name
48 * @param string $password Database user password
49 * @param string $dbName Database name
50 * @return bool
51 * @throws DBConnectionError
52 */
53 function open( $server, $user, $password, $dbName );
54
55 /**
56 * Fetch the next row from the given result object, in object form.
57 * Fields can be retrieved with $row->fieldname, with fields acting like
58 * member variables.
59 * If no more rows are available, false is returned.
60 *
61 * @param ResultWrapper|stdClass $res Object as returned from DatabaseBase::query(), etc.
62 * @return stdClass|bool
63 * @throws DBUnexpectedError Thrown if the database returns an error
64 */
65 function fetchObject( $res );
66
67 /**
68 * Fetch the next row from the given result object, in associative array
69 * form. Fields are retrieved with $row['fieldname'].
70 * If no more rows are available, false is returned.
71 *
72 * @param ResultWrapper $res Result object as returned from DatabaseBase::query(), etc.
73 * @return array|bool
74 * @throws DBUnexpectedError Thrown if the database returns an error
75 */
76 function fetchRow( $res );
77
78 /**
79 * Get the number of rows in a result object
80 *
81 * @param mixed $res A SQL result
82 * @return int
83 */
84 function numRows( $res );
85
86 /**
87 * Get the number of fields in a result object
88 * @see http://www.php.net/mysql_num_fields
89 *
90 * @param mixed $res A SQL result
91 * @return int
92 */
93 function numFields( $res );
94
95 /**
96 * Get a field name in a result object
97 * @see http://www.php.net/mysql_field_name
98 *
99 * @param mixed $res A SQL result
100 * @param int $n
101 * @return string
102 */
103 function fieldName( $res, $n );
104
105 /**
106 * Get the inserted value of an auto-increment row
107 *
108 * The value inserted should be fetched from nextSequenceValue()
109 *
110 * Example:
111 * $id = $dbw->nextSequenceValue( 'page_page_id_seq' );
112 * $dbw->insert( 'page', array( 'page_id' => $id ) );
113 * $id = $dbw->insertId();
114 *
115 * @return int
116 */
117 function insertId();
118
119 /**
120 * Change the position of the cursor in a result object
121 * @see http://www.php.net/mysql_data_seek
122 *
123 * @param mixed $res A SQL result
124 * @param int $row
125 */
126 function dataSeek( $res, $row );
127
128 /**
129 * Get the last error number
130 * @see http://www.php.net/mysql_errno
131 *
132 * @return int
133 */
134 function lastErrno();
135
136 /**
137 * Get a description of the last error
138 * @see http://www.php.net/mysql_error
139 *
140 * @return string
141 */
142 function lastError();
143
144 /**
145 * mysql_fetch_field() wrapper
146 * Returns false if the field doesn't exist
147 *
148 * @param string $table Table name
149 * @param string $field Field name
150 *
151 * @return Field
152 */
153 function fieldInfo( $table, $field );
154
155 /**
156 * Get information about an index into an object
157 * @param string $table Table name
158 * @param string $index Index name
159 * @param string $fname Calling function name
160 * @return mixed Database-specific index description class or false if the index does not exist
161 */
162 function indexInfo( $table, $index, $fname = __METHOD__ );
163
164 /**
165 * Get the number of rows affected by the last write query
166 * @see http://www.php.net/mysql_affected_rows
167 *
168 * @return int
169 */
170 function affectedRows();
171
172 /**
173 * Wrapper for addslashes()
174 *
175 * @param string $s String to be slashed.
176 * @return string Slashed string.
177 */
178 function strencode( $s );
179
180 /**
181 * Returns a wikitext link to the DB's website, e.g.,
182 * return "[http://www.mysql.com/ MySQL]";
183 * Should at least contain plain text, if for some reason
184 * your database has no website.
185 *
186 * @return string Wikitext of a link to the server software's web site
187 */
188 function getSoftwareLink();
189
190 /**
191 * A string describing the current software version, like from
192 * mysql_get_server_info().
193 *
194 * @return string Version information from the database server.
195 */
196 function getServerVersion();
197
198 /**
199 * A string describing the current software version, and possibly
200 * other details in a user-friendly way. Will be listed on Special:Version, etc.
201 * Use getServerVersion() to get machine-friendly information.
202 *
203 * @return string Version information from the database server
204 */
205 function getServerInfo();
206 }
207
208 /**
209 * Interface for classes that implement or wrap DatabaseBase
210 * @ingroup Database
211 */
212 interface IDatabase {
213 }
214
215 /**
216 * Database abstraction object
217 * @ingroup Database
218 */
219 abstract class DatabaseBase implements IDatabase, DatabaseType {
220 /** Number of times to re-try an operation in case of deadlock */
221 const DEADLOCK_TRIES = 4;
222
223 /** Minimum time to wait before retry, in microseconds */
224 const DEADLOCK_DELAY_MIN = 500000;
225
226 /** Maximum time to wait before retry */
227 const DEADLOCK_DELAY_MAX = 1500000;
228
229 # ------------------------------------------------------------------------------
230 # Variables
231 # ------------------------------------------------------------------------------
232
233 protected $mLastQuery = '';
234 protected $mDoneWrites = false;
235 protected $mPHPError = false;
236
237 protected $mServer, $mUser, $mPassword, $mDBname;
238
239 /** @var resource Database connection */
240 protected $mConn = null;
241 protected $mOpened = false;
242
243 /** @var callable[] */
244 protected $mTrxIdleCallbacks = array();
245 /** @var callable[] */
246 protected $mTrxPreCommitCallbacks = array();
247
248 protected $mTablePrefix;
249 protected $mSchema;
250 protected $mFlags;
251 protected $mForeign;
252 protected $mErrorCount = 0;
253 protected $mLBInfo = array();
254 protected $mDefaultBigSelects = null;
255 protected $mSchemaVars = false;
256
257 protected $preparedArgs;
258
259 protected $htmlErrors;
260
261 protected $delimiter = ';';
262
263 /**
264 * Either 1 if a transaction is active or 0 otherwise.
265 * The other Trx fields may not be meaningfull if this is 0.
266 *
267 * @var int
268 */
269 protected $mTrxLevel = 0;
270
271 /**
272 * Either a short hexidecimal string if a transaction is active or ""
273 *
274 * @var string
275 */
276 protected $mTrxShortId = '';
277
278 /**
279 * Remembers the function name given for starting the most recent transaction via begin().
280 * Used to provide additional context for error reporting.
281 *
282 * @var string
283 * @see DatabaseBase::mTrxLevel
284 */
285 private $mTrxFname = null;
286
287 /**
288 * Record if possible write queries were done in the last transaction started
289 *
290 * @var bool
291 * @see DatabaseBase::mTrxLevel
292 */
293 private $mTrxDoneWrites = false;
294
295 /**
296 * Record if the current transaction was started implicitly due to DBO_TRX being set.
297 *
298 * @var bool
299 * @see DatabaseBase::mTrxLevel
300 */
301 private $mTrxAutomatic = false;
302
303 /**
304 * Array of levels of atomicity within transactions
305 *
306 * @var SplStack
307 */
308 private $mTrxAtomicLevels;
309
310 /**
311 * Record if the current transaction was started implicitly by DatabaseBase::startAtomic
312 *
313 * @var bool
314 */
315 private $mTrxAutomaticAtomic = false;
316
317 /**
318 * @since 1.21
319 * @var resource File handle for upgrade
320 */
321 protected $fileHandle = null;
322
323 /**
324 * @since 1.22
325 * @var string[] Process cache of VIEWs names in the database
326 */
327 protected $allViews = null;
328
329 # ------------------------------------------------------------------------------
330 # Accessors
331 # ------------------------------------------------------------------------------
332 # These optionally set a variable and return the previous state
333
334 /**
335 * A string describing the current software version, and possibly
336 * other details in a user-friendly way. Will be listed on Special:Version, etc.
337 * Use getServerVersion() to get machine-friendly information.
338 *
339 * @return string Version information from the database server
340 */
341 public function getServerInfo() {
342 return $this->getServerVersion();
343 }
344
345 /**
346 * @return string Command delimiter used by this database engine
347 */
348 public function getDelimiter() {
349 return $this->delimiter;
350 }
351
352 /**
353 * Boolean, controls output of large amounts of debug information.
354 * @param bool|null $debug
355 * - true to enable debugging
356 * - false to disable debugging
357 * - omitted or null to do nothing
358 *
359 * @return bool|null Previous value of the flag
360 */
361 public function debug( $debug = null ) {
362 return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
363 }
364
365 /**
366 * Turns buffering of SQL result sets on (true) or off (false). Default is
367 * "on".
368 *
369 * Unbuffered queries are very troublesome in MySQL:
370 *
371 * - If another query is executed while the first query is being read
372 * out, the first query is killed. This means you can't call normal
373 * MediaWiki functions while you are reading an unbuffered query result
374 * from a normal wfGetDB() connection.
375 *
376 * - Unbuffered queries cause the MySQL server to use large amounts of
377 * memory and to hold broad locks which block other queries.
378 *
379 * If you want to limit client-side memory, it's almost always better to
380 * split up queries into batches using a LIMIT clause than to switch off
381 * buffering.
382 *
383 * @param null|bool $buffer
384 * @return null|bool The previous value of the flag
385 */
386 public function bufferResults( $buffer = null ) {
387 if ( is_null( $buffer ) ) {
388 return !(bool)( $this->mFlags & DBO_NOBUFFER );
389 } else {
390 return !wfSetBit( $this->mFlags, DBO_NOBUFFER, !$buffer );
391 }
392 }
393
394 /**
395 * Turns on (false) or off (true) the automatic generation and sending
396 * of a "we're sorry, but there has been a database error" page on
397 * database errors. Default is on (false). When turned off, the
398 * code should use lastErrno() and lastError() to handle the
399 * situation as appropriate.
400 *
401 * Do not use this function outside of the Database classes.
402 *
403 * @param null|bool $ignoreErrors
404 * @return bool The previous value of the flag.
405 */
406 public function ignoreErrors( $ignoreErrors = null ) {
407 return wfSetBit( $this->mFlags, DBO_IGNORE, $ignoreErrors );
408 }
409
410 /**
411 * Gets the current transaction level.
412 *
413 * Historically, transactions were allowed to be "nested". This is no
414 * longer supported, so this function really only returns a boolean.
415 *
416 * @return int The previous value
417 */
418 public function trxLevel() {
419 return $this->mTrxLevel;
420 }
421
422 /**
423 * Get/set the number of errors logged. Only useful when errors are ignored
424 * @param int $count The count to set, or omitted to leave it unchanged.
425 * @return int The error count
426 */
427 public function errorCount( $count = null ) {
428 return wfSetVar( $this->mErrorCount, $count );
429 }
430
431 /**
432 * Get/set the table prefix.
433 * @param string $prefix The table prefix to set, or omitted to leave it unchanged.
434 * @return string The previous table prefix.
435 */
436 public function tablePrefix( $prefix = null ) {
437 return wfSetVar( $this->mTablePrefix, $prefix );
438 }
439
440 /**
441 * Get/set the db schema.
442 * @param string $schema The database schema to set, or omitted to leave it unchanged.
443 * @return string The previous db schema.
444 */
445 public function dbSchema( $schema = null ) {
446 return wfSetVar( $this->mSchema, $schema );
447 }
448
449 /**
450 * Set the filehandle to copy write statements to.
451 *
452 * @param resource $fh File handle
453 */
454 public function setFileHandle( $fh ) {
455 $this->fileHandle = $fh;
456 }
457
458 /**
459 * Get properties passed down from the server info array of the load
460 * balancer.
461 *
462 * @param string $name The entry of the info array to get, or null to get the
463 * whole array
464 *
465 * @return array|mixed|null
466 */
467 public function getLBInfo( $name = null ) {
468 if ( is_null( $name ) ) {
469 return $this->mLBInfo;
470 } else {
471 if ( array_key_exists( $name, $this->mLBInfo ) ) {
472 return $this->mLBInfo[$name];
473 } else {
474 return null;
475 }
476 }
477 }
478
479 /**
480 * Set the LB info array, or a member of it. If called with one parameter,
481 * the LB info array is set to that parameter. If it is called with two
482 * parameters, the member with the given name is set to the given value.
483 *
484 * @param string $name
485 * @param array $value
486 */
487 public function setLBInfo( $name, $value = null ) {
488 if ( is_null( $value ) ) {
489 $this->mLBInfo = $name;
490 } else {
491 $this->mLBInfo[$name] = $value;
492 }
493 }
494
495 /**
496 * Set lag time in seconds for a fake slave
497 *
498 * @param mixed $lag Valid values for this parameter are determined by the
499 * subclass, but should be a PHP scalar or array that would be sensible
500 * as part of $wgLBFactoryConf.
501 */
502 public function setFakeSlaveLag( $lag ) {
503 }
504
505 /**
506 * Make this connection a fake master
507 *
508 * @param bool $enabled
509 */
510 public function setFakeMaster( $enabled = true ) {
511 }
512
513 /**
514 * Returns true if this database supports (and uses) cascading deletes
515 *
516 * @return bool
517 */
518 public function cascadingDeletes() {
519 return false;
520 }
521
522 /**
523 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
524 *
525 * @return bool
526 */
527 public function cleanupTriggers() {
528 return false;
529 }
530
531 /**
532 * Returns true if this database is strict about what can be put into an IP field.
533 * Specifically, it uses a NULL value instead of an empty string.
534 *
535 * @return bool
536 */
537 public function strictIPs() {
538 return false;
539 }
540
541 /**
542 * Returns true if this database uses timestamps rather than integers
543 *
544 * @return bool
545 */
546 public function realTimestamps() {
547 return false;
548 }
549
550 /**
551 * Returns true if this database does an implicit sort when doing GROUP BY
552 *
553 * @return bool
554 */
555 public function implicitGroupby() {
556 return true;
557 }
558
559 /**
560 * Returns true if this database does an implicit order by when the column has an index
561 * For example: SELECT page_title FROM page LIMIT 1
562 *
563 * @return bool
564 */
565 public function implicitOrderby() {
566 return true;
567 }
568
569 /**
570 * Returns true if this database can do a native search on IP columns
571 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
572 *
573 * @return bool
574 */
575 public function searchableIPs() {
576 return false;
577 }
578
579 /**
580 * Returns true if this database can use functional indexes
581 *
582 * @return bool
583 */
584 public function functionalIndexes() {
585 return false;
586 }
587
588 /**
589 * Return the last query that went through DatabaseBase::query()
590 * @return string
591 */
592 public function lastQuery() {
593 return $this->mLastQuery;
594 }
595
596 /**
597 * Returns true if the connection may have been used for write queries.
598 * Should return true if unsure.
599 *
600 * @return bool
601 */
602 public function doneWrites() {
603 return (bool)$this->mDoneWrites;
604 }
605
606 /**
607 * Returns the last time the connection may have been used for write queries.
608 * Should return a timestamp if unsure.
609 *
610 * @return int|float UNIX timestamp or false
611 * @since 1.24
612 */
613 public function lastDoneWrites() {
614 return $this->mDoneWrites ?: false;
615 }
616
617 /**
618 * Returns true if there is a transaction open with possible write
619 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
620 *
621 * @return bool
622 */
623 public function writesOrCallbacksPending() {
624 return $this->mTrxLevel && (
625 $this->mTrxDoneWrites || $this->mTrxIdleCallbacks || $this->mTrxPreCommitCallbacks
626 );
627 }
628
629 /**
630 * Is a connection to the database open?
631 * @return bool
632 */
633 public function isOpen() {
634 return $this->mOpened;
635 }
636
637 /**
638 * Set a flag for this connection
639 *
640 * @param int $flag DBO_* constants from Defines.php:
641 * - DBO_DEBUG: output some debug info (same as debug())
642 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
643 * - DBO_TRX: automatically start transactions
644 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
645 * and removes it in command line mode
646 * - DBO_PERSISTENT: use persistant database connection
647 */
648 public function setFlag( $flag ) {
649 global $wgDebugDBTransactions;
650 $this->mFlags |= $flag;
651 if ( ( $flag & DBO_TRX ) && $wgDebugDBTransactions ) {
652 wfDebug( "Implicit transactions are now enabled.\n" );
653 }
654 }
655
656 /**
657 * Clear a flag for this connection
658 *
659 * @param int $flag DBO_* constants from Defines.php:
660 * - DBO_DEBUG: output some debug info (same as debug())
661 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
662 * - DBO_TRX: automatically start transactions
663 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
664 * and removes it in command line mode
665 * - DBO_PERSISTENT: use persistant database connection
666 */
667 public function clearFlag( $flag ) {
668 global $wgDebugDBTransactions;
669 $this->mFlags &= ~$flag;
670 if ( ( $flag & DBO_TRX ) && $wgDebugDBTransactions ) {
671 wfDebug( "Implicit transactions are now disabled.\n" );
672 }
673 }
674
675 /**
676 * Returns a boolean whether the flag $flag is set for this connection
677 *
678 * @param int $flag DBO_* constants from Defines.php:
679 * - DBO_DEBUG: output some debug info (same as debug())
680 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
681 * - DBO_TRX: automatically start transactions
682 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
683 * and removes it in command line mode
684 * - DBO_PERSISTENT: use persistant database connection
685 * @return bool
686 */
687 public function getFlag( $flag ) {
688 return !!( $this->mFlags & $flag );
689 }
690
691 /**
692 * General read-only accessor
693 *
694 * @param string $name
695 * @return string
696 */
697 public function getProperty( $name ) {
698 return $this->$name;
699 }
700
701 /**
702 * @return string
703 */
704 public function getWikiID() {
705 if ( $this->mTablePrefix ) {
706 return "{$this->mDBname}-{$this->mTablePrefix}";
707 } else {
708 return $this->mDBname;
709 }
710 }
711
712 /**
713 * Return a path to the DBMS-specific schema file, otherwise default to tables.sql
714 *
715 * @return string
716 */
717 public function getSchemaPath() {
718 global $IP;
719 if ( file_exists( "$IP/maintenance/" . $this->getType() . "/tables.sql" ) ) {
720 return "$IP/maintenance/" . $this->getType() . "/tables.sql";
721 } else {
722 return "$IP/maintenance/tables.sql";
723 }
724 }
725
726 # ------------------------------------------------------------------------------
727 # Other functions
728 # ------------------------------------------------------------------------------
729
730 /**
731 * Constructor.
732 *
733 * FIXME: It is possible to construct a Database object with no associated
734 * connection object, by specifying no parameters to __construct(). This
735 * feature is deprecated and should be removed.
736 *
737 * DatabaseBase subclasses should not be constructed directly in external
738 * code. DatabaseBase::factory() should be used instead.
739 *
740 * @param array $params Parameters passed from DatabaseBase::factory()
741 */
742 function __construct( $params = null ) {
743 global $wgDBprefix, $wgDBmwschema, $wgCommandLineMode, $wgDebugDBTransactions;
744
745 $this->mTrxAtomicLevels = new SplStack;
746
747 if ( is_array( $params ) ) { // MW 1.22
748 $server = $params['host'];
749 $user = $params['user'];
750 $password = $params['password'];
751 $dbName = $params['dbname'];
752 $flags = $params['flags'];
753 $tablePrefix = $params['tablePrefix'];
754 $schema = $params['schema'];
755 $foreign = $params['foreign'];
756 } else { // legacy calling pattern
757 wfDeprecated( __METHOD__ . " method called without parameter array.", "1.23" );
758 $args = func_get_args();
759 $server = isset( $args[0] ) ? $args[0] : false;
760 $user = isset( $args[1] ) ? $args[1] : false;
761 $password = isset( $args[2] ) ? $args[2] : false;
762 $dbName = isset( $args[3] ) ? $args[3] : false;
763 $flags = isset( $args[4] ) ? $args[4] : 0;
764 $tablePrefix = isset( $args[5] ) ? $args[5] : 'get from global';
765 $schema = 'get from global';
766 $foreign = isset( $args[6] ) ? $args[6] : false;
767 }
768
769 $this->mFlags = $flags;
770 if ( $this->mFlags & DBO_DEFAULT ) {
771 if ( $wgCommandLineMode ) {
772 $this->mFlags &= ~DBO_TRX;
773 if ( $wgDebugDBTransactions ) {
774 wfDebug( "Implicit transaction open disabled.\n" );
775 }
776 } else {
777 $this->mFlags |= DBO_TRX;
778 if ( $wgDebugDBTransactions ) {
779 wfDebug( "Implicit transaction open enabled.\n" );
780 }
781 }
782 }
783
784 /** Get the default table prefix*/
785 if ( $tablePrefix == 'get from global' ) {
786 $this->mTablePrefix = $wgDBprefix;
787 } else {
788 $this->mTablePrefix = $tablePrefix;
789 }
790
791 /** Get the database schema*/
792 if ( $schema == 'get from global' ) {
793 $this->mSchema = $wgDBmwschema;
794 } else {
795 $this->mSchema = $schema;
796 }
797
798 $this->mForeign = $foreign;
799
800 if ( $user ) {
801 $this->open( $server, $user, $password, $dbName );
802 }
803 }
804
805 /**
806 * Called by serialize. Throw an exception when DB connection is serialized.
807 * This causes problems on some database engines because the connection is
808 * not restored on unserialize.
809 */
810 public function __sleep() {
811 throw new MWException( 'Database serialization may cause problems, since ' .
812 'the connection is not restored on wakeup.' );
813 }
814
815 /**
816 * Given a DB type, construct the name of the appropriate child class of
817 * DatabaseBase. This is designed to replace all of the manual stuff like:
818 * $class = 'Database' . ucfirst( strtolower( $dbType ) );
819 * as well as validate against the canonical list of DB types we have
820 *
821 * This factory function is mostly useful for when you need to connect to a
822 * database other than the MediaWiki default (such as for external auth,
823 * an extension, et cetera). Do not use this to connect to the MediaWiki
824 * database. Example uses in core:
825 * @see LoadBalancer::reallyOpenConnection()
826 * @see ForeignDBRepo::getMasterDB()
827 * @see WebInstallerDBConnect::execute()
828 *
829 * @since 1.18
830 *
831 * @param string $dbType A possible DB type
832 * @param array $p An array of options to pass to the constructor.
833 * Valid options are: host, user, password, dbname, flags, tablePrefix, schema, driver
834 * @throws MWException If the database driver or extension cannot be found
835 * @return DatabaseBase|null DatabaseBase subclass or null
836 */
837 final public static function factory( $dbType, $p = array() ) {
838 $canonicalDBTypes = array(
839 'mysql' => array( 'mysqli', 'mysql' ),
840 'postgres' => array(),
841 'sqlite' => array(),
842 'oracle' => array(),
843 'mssql' => array(),
844 );
845
846 $driver = false;
847 $dbType = strtolower( $dbType );
848 if ( isset( $canonicalDBTypes[$dbType] ) && $canonicalDBTypes[$dbType] ) {
849 $possibleDrivers = $canonicalDBTypes[$dbType];
850 if ( !empty( $p['driver'] ) ) {
851 if ( in_array( $p['driver'], $possibleDrivers ) ) {
852 $driver = $p['driver'];
853 } else {
854 throw new MWException( __METHOD__ .
855 " cannot construct Database with type '$dbType' and driver '{$p['driver']}'" );
856 }
857 } else {
858 foreach ( $possibleDrivers as $posDriver ) {
859 if ( extension_loaded( $posDriver ) ) {
860 $driver = $posDriver;
861 break;
862 }
863 }
864 }
865 } else {
866 $driver = $dbType;
867 }
868 if ( $driver === false ) {
869 throw new MWException( __METHOD__ .
870 " no viable database extension found for type '$dbType'" );
871 }
872
873 // Determine schema defaults. Currently Microsoft SQL Server uses $wgDBmwschema,
874 // and everything else doesn't use a schema (e.g. null)
875 // Although postgres and oracle support schemas, we don't use them (yet)
876 // to maintain backwards compatibility
877 $defaultSchemas = array(
878 'mysql' => null,
879 'postgres' => null,
880 'sqlite' => null,
881 'oracle' => null,
882 'mssql' => 'get from global',
883 );
884
885 $class = 'Database' . ucfirst( $driver );
886 if ( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) {
887 $params = array(
888 'host' => isset( $p['host'] ) ? $p['host'] : false,
889 'user' => isset( $p['user'] ) ? $p['user'] : false,
890 'password' => isset( $p['password'] ) ? $p['password'] : false,
891 'dbname' => isset( $p['dbname'] ) ? $p['dbname'] : false,
892 'flags' => isset( $p['flags'] ) ? $p['flags'] : 0,
893 'tablePrefix' => isset( $p['tablePrefix'] ) ? $p['tablePrefix'] : 'get from global',
894 'schema' => isset( $p['schema'] ) ? $p['schema'] : $defaultSchemas[$dbType],
895 'foreign' => isset( $p['foreign'] ) ? $p['foreign'] : false
896 );
897
898 return new $class( $params );
899 } else {
900 return null;
901 }
902 }
903
904 protected function installErrorHandler() {
905 $this->mPHPError = false;
906 $this->htmlErrors = ini_set( 'html_errors', '0' );
907 set_error_handler( array( $this, 'connectionErrorHandler' ) );
908 }
909
910 /**
911 * @return bool|string
912 */
913 protected function restoreErrorHandler() {
914 restore_error_handler();
915 if ( $this->htmlErrors !== false ) {
916 ini_set( 'html_errors', $this->htmlErrors );
917 }
918 if ( $this->mPHPError ) {
919 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError );
920 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
921
922 return $error;
923 } else {
924 return false;
925 }
926 }
927
928 /**
929 * @param int $errno
930 * @param string $errstr
931 */
932 public function connectionErrorHandler( $errno, $errstr ) {
933 $this->mPHPError = $errstr;
934 }
935
936 /**
937 * Closes a database connection.
938 * if it is open : commits any open transactions
939 *
940 * @throws MWException
941 * @return bool Operation success. true if already closed.
942 */
943 public function close() {
944 if ( count( $this->mTrxIdleCallbacks ) ) { // sanity
945 throw new MWException( "Transaction idle callbacks still pending." );
946 }
947 if ( $this->mConn ) {
948 if ( $this->trxLevel() ) {
949 if ( !$this->mTrxAutomatic ) {
950 wfWarn( "Transaction still in progress (from {$this->mTrxFname}), " .
951 " performing implicit commit before closing connection!" );
952 }
953
954 $this->commit( __METHOD__, 'flush' );
955 }
956
957 $closed = $this->closeConnection();
958 $this->mConn = false;
959 } else {
960 $closed = true;
961 }
962 $this->mOpened = false;
963
964 return $closed;
965 }
966
967 /**
968 * Closes underlying database connection
969 * @since 1.20
970 * @return bool Whether connection was closed successfully
971 */
972 abstract protected function closeConnection();
973
974 /**
975 * @param string $error Fallback error message, used if none is given by DB
976 * @throws DBConnectionError
977 */
978 function reportConnectionError( $error = 'Unknown error' ) {
979 $myError = $this->lastError();
980 if ( $myError ) {
981 $error = $myError;
982 }
983
984 # New method
985 throw new DBConnectionError( $this, $error );
986 }
987
988 /**
989 * The DBMS-dependent part of query()
990 *
991 * @param string $sql SQL query.
992 * @return ResultWrapper|bool Result object to feed to fetchObject,
993 * fetchRow, ...; or false on failure
994 */
995 abstract protected function doQuery( $sql );
996
997 /**
998 * Determine whether a query writes to the DB.
999 * Should return true if unsure.
1000 *
1001 * @param string $sql
1002 * @return bool
1003 */
1004 public function isWriteQuery( $sql ) {
1005 return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
1006 }
1007
1008 /**
1009 * Run an SQL query and return the result. Normally throws a DBQueryError
1010 * on failure. If errors are ignored, returns false instead.
1011 *
1012 * In new code, the query wrappers select(), insert(), update(), delete(),
1013 * etc. should be used where possible, since they give much better DBMS
1014 * independence and automatically quote or validate user input in a variety
1015 * of contexts. This function is generally only useful for queries which are
1016 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
1017 * as CREATE TABLE.
1018 *
1019 * However, the query wrappers themselves should call this function.
1020 *
1021 * @param string $sql SQL query
1022 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
1023 * comment (you can use __METHOD__ or add some extra info)
1024 * @param bool $tempIgnore Whether to avoid throwing an exception on errors...
1025 * maybe best to catch the exception instead?
1026 * @throws MWException
1027 * @return bool|ResultWrapper True for a successful write query, ResultWrapper object
1028 * for a successful read query, or false on failure if $tempIgnore set
1029 */
1030 public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) {
1031 global $wgUser, $wgDebugDBTransactions, $wgDebugDumpSqlLength;
1032
1033 $this->mLastQuery = $sql;
1034 if ( $this->isWriteQuery( $sql ) ) {
1035 # Set a flag indicating that writes have been done
1036 wfDebug( __METHOD__ . ': Writes done: ' . DatabaseBase::generalizeSQL( $sql ) . "\n" );
1037 $this->mDoneWrites = microtime( true );
1038 }
1039
1040 # Add a comment for easy SHOW PROCESSLIST interpretation
1041 if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
1042 $userName = $wgUser->getName();
1043 if ( mb_strlen( $userName ) > 15 ) {
1044 $userName = mb_substr( $userName, 0, 15 ) . '...';
1045 }
1046 $userName = str_replace( '/', '', $userName );
1047 } else {
1048 $userName = '';
1049 }
1050
1051 // Add trace comment to the begin of the sql string, right after the operator.
1052 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (bug 42598)
1053 $commentedSql = preg_replace( '/\s|$/', " /* $fname $userName */ ", $sql, 1 );
1054
1055 # If DBO_TRX is set, start a transaction
1056 if ( ( $this->mFlags & DBO_TRX ) && !$this->mTrxLevel &&
1057 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK'
1058 ) {
1059 # Avoid establishing transactions for SHOW and SET statements too -
1060 # that would delay transaction initializations to once connection
1061 # is really used by application
1062 $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
1063 if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) {
1064 if ( $wgDebugDBTransactions ) {
1065 wfDebug( "Implicit transaction start.\n" );
1066 }
1067 $this->begin( __METHOD__ . " ($fname)" );
1068 $this->mTrxAutomatic = true;
1069 }
1070 }
1071
1072 # Keep track of whether the transaction has write queries pending
1073 if ( $this->mTrxLevel && !$this->mTrxDoneWrites && $this->isWriteQuery( $sql ) ) {
1074 $this->mTrxDoneWrites = true;
1075 Profiler::instance()->transactionWritingIn(
1076 $this->mServer, $this->mDBname, $this->mTrxShortId );
1077 }
1078
1079 $queryProf = '';
1080 $totalProf = '';
1081 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1082
1083 if ( !Profiler::instance()->isStub() ) {
1084 # generalizeSQL will probably cut down the query to reasonable
1085 # logging size most of the time. The substr is really just a sanity check.
1086 if ( $isMaster ) {
1087 $queryProf = 'query-m: ' . substr( DatabaseBase::generalizeSQL( $sql ), 0, 255 );
1088 $totalProf = 'DatabaseBase::query-master';
1089 } else {
1090 $queryProf = 'query: ' . substr( DatabaseBase::generalizeSQL( $sql ), 0, 255 );
1091 $totalProf = 'DatabaseBase::query';
1092 }
1093 # Include query transaction state
1094 $queryProf .= $this->mTrxShortId ? " [TRX#{$this->mTrxShortId}]" : "";
1095
1096 $trx = $this->mTrxLevel ? 'TRX=yes' : 'TRX=no';
1097 wfProfileIn( $totalProf );
1098 wfProfileIn( $queryProf );
1099 }
1100
1101 if ( $this->debug() ) {
1102 static $cnt = 0;
1103
1104 $cnt++;
1105 $sqlx = $wgDebugDumpSqlLength ? substr( $commentedSql, 0, $wgDebugDumpSqlLength )
1106 : $commentedSql;
1107 $sqlx = strtr( $sqlx, "\t\n", ' ' );
1108
1109 $master = $isMaster ? 'master' : 'slave';
1110 wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
1111 }
1112
1113 $queryId = MWDebug::query( $sql, $fname, $isMaster );
1114
1115 # Avoid fatals if close() was called
1116 if ( !$this->isOpen() ) {
1117 throw new DBUnexpectedError( $this, "DB connection was already closed." );
1118 }
1119
1120 # Do the query and handle errors
1121 $ret = $this->doQuery( $commentedSql );
1122
1123 MWDebug::queryTime( $queryId );
1124
1125 # Try reconnecting if the connection was lost
1126 if ( false === $ret && $this->wasErrorReissuable() ) {
1127 # Transaction is gone, like it or not
1128 $hadTrx = $this->mTrxLevel; // possible lost transaction
1129 $this->mTrxLevel = 0;
1130 $this->mTrxIdleCallbacks = array(); // bug 65263
1131 $this->mTrxPreCommitCallbacks = array(); // bug 65263
1132 wfDebug( "Connection lost, reconnecting...\n" );
1133
1134 if ( $this->ping() ) {
1135 global $wgRequestTime;
1136 wfDebug( "Reconnected\n" );
1137 $sqlx = $wgDebugDumpSqlLength ? substr( $commentedSql, 0, $wgDebugDumpSqlLength )
1138 : $commentedSql;
1139 $sqlx = strtr( $sqlx, "\t\n", ' ' );
1140 $elapsed = round( microtime( true ) - $wgRequestTime, 3 );
1141 if ( $elapsed < 300 ) {
1142 # Not a database error to lose a transaction after a minute or two
1143 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx" );
1144 }
1145 if ( $hadTrx ) {
1146 # Leave $ret as false and let an error be reported.
1147 # Callers may catch the exception and continue to use the DB.
1148 } else {
1149 # Should be safe to silently retry (no trx and thus no callbacks)
1150 $ret = $this->doQuery( $commentedSql );
1151 }
1152 } else {
1153 wfDebug( "Failed\n" );
1154 }
1155 }
1156
1157 if ( false === $ret ) {
1158 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
1159 }
1160
1161 if ( !Profiler::instance()->isStub() ) {
1162 wfProfileOut( $queryProf );
1163 wfProfileOut( $totalProf );
1164 }
1165
1166 return $this->resultObject( $ret );
1167 }
1168
1169 /**
1170 * Report a query error. Log the error, and if neither the object ignore
1171 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1172 *
1173 * @param string $error
1174 * @param int $errno
1175 * @param string $sql
1176 * @param string $fname
1177 * @param bool $tempIgnore
1178 * @throws DBQueryError
1179 */
1180 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1181 # Ignore errors during error handling to avoid infinite recursion
1182 $ignore = $this->ignoreErrors( true );
1183 ++$this->mErrorCount;
1184
1185 if ( $ignore || $tempIgnore ) {
1186 wfDebug( "SQL ERROR (ignored): $error\n" );
1187 $this->ignoreErrors( $ignore );
1188 } else {
1189 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1190 wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line" );
1191 wfDebug( "SQL ERROR: " . $error . "\n" );
1192 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1193 }
1194 }
1195
1196 /**
1197 * Intended to be compatible with the PEAR::DB wrapper functions.
1198 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1199 *
1200 * ? = scalar value, quoted as necessary
1201 * ! = raw SQL bit (a function for instance)
1202 * & = filename; reads the file and inserts as a blob
1203 * (we don't use this though...)
1204 *
1205 * @param string $sql
1206 * @param string $func
1207 *
1208 * @return array
1209 */
1210 protected function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
1211 /* MySQL doesn't support prepared statements (yet), so just
1212 * pack up the query for reference. We'll manually replace
1213 * the bits later.
1214 */
1215 return array( 'query' => $sql, 'func' => $func );
1216 }
1217
1218 /**
1219 * Free a prepared query, generated by prepare().
1220 * @param string $prepared
1221 */
1222 protected function freePrepared( $prepared ) {
1223 /* No-op by default */
1224 }
1225
1226 /**
1227 * Execute a prepared query with the various arguments
1228 * @param string $prepared The prepared sql
1229 * @param mixed $args Either an array here, or put scalars as varargs
1230 *
1231 * @return ResultWrapper
1232 */
1233 public function execute( $prepared, $args = null ) {
1234 if ( !is_array( $args ) ) {
1235 # Pull the var args
1236 $args = func_get_args();
1237 array_shift( $args );
1238 }
1239
1240 $sql = $this->fillPrepared( $prepared['query'], $args );
1241
1242 return $this->query( $sql, $prepared['func'] );
1243 }
1244
1245 /**
1246 * For faking prepared SQL statements on DBs that don't support it directly.
1247 *
1248 * @param string $preparedQuery A 'preparable' SQL statement
1249 * @param array $args Array of Arguments to fill it with
1250 * @return string Executable SQL
1251 */
1252 public function fillPrepared( $preparedQuery, $args ) {
1253 reset( $args );
1254 $this->preparedArgs =& $args;
1255
1256 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
1257 array( &$this, 'fillPreparedArg' ), $preparedQuery );
1258 }
1259
1260 /**
1261 * preg_callback func for fillPrepared()
1262 * The arguments should be in $this->preparedArgs and must not be touched
1263 * while we're doing this.
1264 *
1265 * @param array $matches
1266 * @throws DBUnexpectedError
1267 * @return string
1268 */
1269 protected function fillPreparedArg( $matches ) {
1270 switch ( $matches[1] ) {
1271 case '\\?':
1272 return '?';
1273 case '\\!':
1274 return '!';
1275 case '\\&':
1276 return '&';
1277 }
1278
1279 list( /* $n */, $arg ) = each( $this->preparedArgs );
1280
1281 switch ( $matches[1] ) {
1282 case '?':
1283 return $this->addQuotes( $arg );
1284 case '!':
1285 return $arg;
1286 case '&':
1287 # return $this->addQuotes( file_get_contents( $arg ) );
1288 throw new DBUnexpectedError(
1289 $this,
1290 '& mode is not implemented. If it\'s really needed, uncomment the line above.'
1291 );
1292 default:
1293 throw new DBUnexpectedError(
1294 $this,
1295 'Received invalid match. This should never happen!'
1296 );
1297 }
1298 }
1299
1300 /**
1301 * Free a result object returned by query() or select(). It's usually not
1302 * necessary to call this, just use unset() or let the variable holding
1303 * the result object go out of scope.
1304 *
1305 * @param mixed $res A SQL result
1306 */
1307 public function freeResult( $res ) {
1308 }
1309
1310 /**
1311 * A SELECT wrapper which returns a single field from a single result row.
1312 *
1313 * Usually throws a DBQueryError on failure. If errors are explicitly
1314 * ignored, returns false on failure.
1315 *
1316 * If no result rows are returned from the query, false is returned.
1317 *
1318 * @param string|array $table Table name. See DatabaseBase::select() for details.
1319 * @param string $var The field name to select. This must be a valid SQL
1320 * fragment: do not use unvalidated user input.
1321 * @param string|array $cond The condition array. See DatabaseBase::select() for details.
1322 * @param string $fname The function name of the caller.
1323 * @param string|array $options The query options. See DatabaseBase::select() for details.
1324 *
1325 * @return bool|mixed The value from the field, or false on failure.
1326 */
1327 public function selectField( $table, $var, $cond = '', $fname = __METHOD__,
1328 $options = array()
1329 ) {
1330 if ( !is_array( $options ) ) {
1331 $options = array( $options );
1332 }
1333
1334 $options['LIMIT'] = 1;
1335
1336 $res = $this->select( $table, $var, $cond, $fname, $options );
1337
1338 if ( $res === false || !$this->numRows( $res ) ) {
1339 return false;
1340 }
1341
1342 $row = $this->fetchRow( $res );
1343
1344 if ( $row !== false ) {
1345 return reset( $row );
1346 } else {
1347 return false;
1348 }
1349 }
1350
1351 /**
1352 * Returns an optional USE INDEX clause to go after the table, and a
1353 * string to go at the end of the query.
1354 *
1355 * @param array $options Associative array of options to be turned into
1356 * an SQL query, valid keys are listed in the function.
1357 * @return array
1358 * @see DatabaseBase::select()
1359 */
1360 public function makeSelectOptions( $options ) {
1361 $preLimitTail = $postLimitTail = '';
1362 $startOpts = '';
1363
1364 $noKeyOptions = array();
1365
1366 foreach ( $options as $key => $option ) {
1367 if ( is_numeric( $key ) ) {
1368 $noKeyOptions[$option] = true;
1369 }
1370 }
1371
1372 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1373
1374 $preLimitTail .= $this->makeOrderBy( $options );
1375
1376 // if (isset($options['LIMIT'])) {
1377 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1378 // isset($options['OFFSET']) ? $options['OFFSET']
1379 // : false);
1380 // }
1381
1382 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1383 $postLimitTail .= ' FOR UPDATE';
1384 }
1385
1386 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1387 $postLimitTail .= ' LOCK IN SHARE MODE';
1388 }
1389
1390 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1391 $startOpts .= 'DISTINCT';
1392 }
1393
1394 # Various MySQL extensions
1395 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1396 $startOpts .= ' /*! STRAIGHT_JOIN */';
1397 }
1398
1399 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1400 $startOpts .= ' HIGH_PRIORITY';
1401 }
1402
1403 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1404 $startOpts .= ' SQL_BIG_RESULT';
1405 }
1406
1407 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1408 $startOpts .= ' SQL_BUFFER_RESULT';
1409 }
1410
1411 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1412 $startOpts .= ' SQL_SMALL_RESULT';
1413 }
1414
1415 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1416 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1417 }
1418
1419 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1420 $startOpts .= ' SQL_CACHE';
1421 }
1422
1423 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1424 $startOpts .= ' SQL_NO_CACHE';
1425 }
1426
1427 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1428 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1429 } else {
1430 $useIndex = '';
1431 }
1432
1433 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1434 }
1435
1436 /**
1437 * Returns an optional GROUP BY with an optional HAVING
1438 *
1439 * @param array $options Associative array of options
1440 * @return string
1441 * @see DatabaseBase::select()
1442 * @since 1.21
1443 */
1444 public function makeGroupByWithHaving( $options ) {
1445 $sql = '';
1446 if ( isset( $options['GROUP BY'] ) ) {
1447 $gb = is_array( $options['GROUP BY'] )
1448 ? implode( ',', $options['GROUP BY'] )
1449 : $options['GROUP BY'];
1450 $sql .= ' GROUP BY ' . $gb;
1451 }
1452 if ( isset( $options['HAVING'] ) ) {
1453 $having = is_array( $options['HAVING'] )
1454 ? $this->makeList( $options['HAVING'], LIST_AND )
1455 : $options['HAVING'];
1456 $sql .= ' HAVING ' . $having;
1457 }
1458
1459 return $sql;
1460 }
1461
1462 /**
1463 * Returns an optional ORDER BY
1464 *
1465 * @param array $options Associative array of options
1466 * @return string
1467 * @see DatabaseBase::select()
1468 * @since 1.21
1469 */
1470 public function makeOrderBy( $options ) {
1471 if ( isset( $options['ORDER BY'] ) ) {
1472 $ob = is_array( $options['ORDER BY'] )
1473 ? implode( ',', $options['ORDER BY'] )
1474 : $options['ORDER BY'];
1475
1476 return ' ORDER BY ' . $ob;
1477 }
1478
1479 return '';
1480 }
1481
1482 /**
1483 * Execute a SELECT query constructed using the various parameters provided.
1484 * See below for full details of the parameters.
1485 *
1486 * @param string|array $table Table name
1487 * @param string|array $vars Field names
1488 * @param string|array $conds Conditions
1489 * @param string $fname Caller function name
1490 * @param array $options Query options
1491 * @param array $join_conds Join conditions
1492 *
1493 * @param string|array $table
1494 *
1495 * May be either an array of table names, or a single string holding a table
1496 * name. If an array is given, table aliases can be specified, for example:
1497 *
1498 * array( 'a' => 'user' )
1499 *
1500 * This includes the user table in the query, with the alias "a" available
1501 * for use in field names (e.g. a.user_name).
1502 *
1503 * All of the table names given here are automatically run through
1504 * DatabaseBase::tableName(), which causes the table prefix (if any) to be
1505 * added, and various other table name mappings to be performed.
1506 *
1507 *
1508 * @param string|array $vars
1509 *
1510 * May be either a field name or an array of field names. The field names
1511 * can be complete fragments of SQL, for direct inclusion into the SELECT
1512 * query. If an array is given, field aliases can be specified, for example:
1513 *
1514 * array( 'maxrev' => 'MAX(rev_id)' )
1515 *
1516 * This includes an expression with the alias "maxrev" in the query.
1517 *
1518 * If an expression is given, care must be taken to ensure that it is
1519 * DBMS-independent.
1520 *
1521 *
1522 * @param string|array $conds
1523 *
1524 * May be either a string containing a single condition, or an array of
1525 * conditions. If an array is given, the conditions constructed from each
1526 * element are combined with AND.
1527 *
1528 * Array elements may take one of two forms:
1529 *
1530 * - Elements with a numeric key are interpreted as raw SQL fragments.
1531 * - Elements with a string key are interpreted as equality conditions,
1532 * where the key is the field name.
1533 * - If the value of such an array element is a scalar (such as a
1534 * string), it will be treated as data and thus quoted appropriately.
1535 * If it is null, an IS NULL clause will be added.
1536 * - If the value is an array, an IN(...) clause will be constructed,
1537 * such that the field name may match any of the elements in the
1538 * array. The elements of the array will be quoted.
1539 *
1540 * Note that expressions are often DBMS-dependent in their syntax.
1541 * DBMS-independent wrappers are provided for constructing several types of
1542 * expression commonly used in condition queries. See:
1543 * - DatabaseBase::buildLike()
1544 * - DatabaseBase::conditional()
1545 *
1546 *
1547 * @param string|array $options
1548 *
1549 * Optional: Array of query options. Boolean options are specified by
1550 * including them in the array as a string value with a numeric key, for
1551 * example:
1552 *
1553 * array( 'FOR UPDATE' )
1554 *
1555 * The supported options are:
1556 *
1557 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
1558 * with LIMIT can theoretically be used for paging through a result set,
1559 * but this is discouraged in MediaWiki for performance reasons.
1560 *
1561 * - LIMIT: Integer: return at most this many rows. The rows are sorted
1562 * and then the first rows are taken until the limit is reached. LIMIT
1563 * is applied to a result set after OFFSET.
1564 *
1565 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
1566 * changed until the next COMMIT.
1567 *
1568 * - DISTINCT: Boolean: return only unique result rows.
1569 *
1570 * - GROUP BY: May be either an SQL fragment string naming a field or
1571 * expression to group by, or an array of such SQL fragments.
1572 *
1573 * - HAVING: May be either an string containing a HAVING clause or an array of
1574 * conditions building the HAVING clause. If an array is given, the conditions
1575 * constructed from each element are combined with AND.
1576 *
1577 * - ORDER BY: May be either an SQL fragment giving a field name or
1578 * expression to order by, or an array of such SQL fragments.
1579 *
1580 * - USE INDEX: This may be either a string giving the index name to use
1581 * for the query, or an array. If it is an associative array, each key
1582 * gives the table name (or alias), each value gives the index name to
1583 * use for that table. All strings are SQL fragments and so should be
1584 * validated by the caller.
1585 *
1586 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
1587 * instead of SELECT.
1588 *
1589 * And also the following boolean MySQL extensions, see the MySQL manual
1590 * for documentation:
1591 *
1592 * - LOCK IN SHARE MODE
1593 * - STRAIGHT_JOIN
1594 * - HIGH_PRIORITY
1595 * - SQL_BIG_RESULT
1596 * - SQL_BUFFER_RESULT
1597 * - SQL_SMALL_RESULT
1598 * - SQL_CALC_FOUND_ROWS
1599 * - SQL_CACHE
1600 * - SQL_NO_CACHE
1601 *
1602 *
1603 * @param string|array $join_conds
1604 *
1605 * Optional associative array of table-specific join conditions. In the
1606 * most common case, this is unnecessary, since the join condition can be
1607 * in $conds. However, it is useful for doing a LEFT JOIN.
1608 *
1609 * The key of the array contains the table name or alias. The value is an
1610 * array with two elements, numbered 0 and 1. The first gives the type of
1611 * join, the second is an SQL fragment giving the join condition for that
1612 * table. For example:
1613 *
1614 * array( 'page' => array( 'LEFT JOIN', 'page_latest=rev_id' ) )
1615 *
1616 * @return ResultWrapper|bool If the query returned no rows, a ResultWrapper
1617 * with no rows in it will be returned. If there was a query error, a
1618 * DBQueryError exception will be thrown, except if the "ignore errors"
1619 * option was set, in which case false will be returned.
1620 */
1621 public function select( $table, $vars, $conds = '', $fname = __METHOD__,
1622 $options = array(), $join_conds = array() ) {
1623 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1624
1625 return $this->query( $sql, $fname );
1626 }
1627
1628 /**
1629 * The equivalent of DatabaseBase::select() except that the constructed SQL
1630 * is returned, instead of being immediately executed. This can be useful for
1631 * doing UNION queries, where the SQL text of each query is needed. In general,
1632 * however, callers outside of Database classes should just use select().
1633 *
1634 * @param string|array $table Table name
1635 * @param string|array $vars Field names
1636 * @param string|array $conds Conditions
1637 * @param string $fname Caller function name
1638 * @param string|array $options Query options
1639 * @param string|array $join_conds Join conditions
1640 *
1641 * @return string SQL query string.
1642 * @see DatabaseBase::select()
1643 */
1644 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__,
1645 $options = array(), $join_conds = array()
1646 ) {
1647 if ( is_array( $vars ) ) {
1648 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1649 }
1650
1651 $options = (array)$options;
1652 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1653 ? $options['USE INDEX']
1654 : array();
1655
1656 if ( is_array( $table ) ) {
1657 $from = ' FROM ' .
1658 $this->tableNamesWithUseIndexOrJOIN( $table, $useIndexes, $join_conds );
1659 } elseif ( $table != '' ) {
1660 if ( $table[0] == ' ' ) {
1661 $from = ' FROM ' . $table;
1662 } else {
1663 $from = ' FROM ' .
1664 $this->tableNamesWithUseIndexOrJOIN( array( $table ), $useIndexes, array() );
1665 }
1666 } else {
1667 $from = '';
1668 }
1669
1670 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) =
1671 $this->makeSelectOptions( $options );
1672
1673 if ( !empty( $conds ) ) {
1674 if ( is_array( $conds ) ) {
1675 $conds = $this->makeList( $conds, LIST_AND );
1676 }
1677 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1678 } else {
1679 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1680 }
1681
1682 if ( isset( $options['LIMIT'] ) ) {
1683 $sql = $this->limitResult( $sql, $options['LIMIT'],
1684 isset( $options['OFFSET'] ) ? $options['OFFSET'] : false );
1685 }
1686 $sql = "$sql $postLimitTail";
1687
1688 if ( isset( $options['EXPLAIN'] ) ) {
1689 $sql = 'EXPLAIN ' . $sql;
1690 }
1691
1692 return $sql;
1693 }
1694
1695 /**
1696 * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except
1697 * that a single row object is returned. If the query returns no rows,
1698 * false is returned.
1699 *
1700 * @param string|array $table Table name
1701 * @param string|array $vars Field names
1702 * @param array $conds Conditions
1703 * @param string $fname Caller function name
1704 * @param string|array $options Query options
1705 * @param array|string $join_conds Join conditions
1706 *
1707 * @return stdClass|bool
1708 */
1709 public function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1710 $options = array(), $join_conds = array()
1711 ) {
1712 $options = (array)$options;
1713 $options['LIMIT'] = 1;
1714 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1715
1716 if ( $res === false ) {
1717 return false;
1718 }
1719
1720 if ( !$this->numRows( $res ) ) {
1721 return false;
1722 }
1723
1724 $obj = $this->fetchObject( $res );
1725
1726 return $obj;
1727 }
1728
1729 /**
1730 * Estimate rows in dataset.
1731 *
1732 * MySQL allows you to estimate the number of rows that would be returned
1733 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
1734 * index cardinality statistics, and is notoriously inaccurate, especially
1735 * when large numbers of rows have recently been added or deleted.
1736 *
1737 * For DBMSs that don't support fast result size estimation, this function
1738 * will actually perform the SELECT COUNT(*).
1739 *
1740 * Takes the same arguments as DatabaseBase::select().
1741 *
1742 * @param string $table Table name
1743 * @param string $vars Unused
1744 * @param array|string $conds Filters on the table
1745 * @param string $fname Function name for profiling
1746 * @param array $options Options for select
1747 * @return int Row count
1748 */
1749 public function estimateRowCount( $table, $vars = '*', $conds = '',
1750 $fname = __METHOD__, $options = array()
1751 ) {
1752 $rows = 0;
1753 $res = $this->select( $table, array( 'rowcount' => 'COUNT(*)' ), $conds, $fname, $options );
1754
1755 if ( $res ) {
1756 $row = $this->fetchRow( $res );
1757 $rows = ( isset( $row['rowcount'] ) ) ? $row['rowcount'] : 0;
1758 }
1759
1760 return $rows;
1761 }
1762
1763 /**
1764 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1765 * It's only slightly flawed. Don't use for anything important.
1766 *
1767 * @param string $sql A SQL Query
1768 *
1769 * @return string
1770 */
1771 static function generalizeSQL( $sql ) {
1772 # This does the same as the regexp below would do, but in such a way
1773 # as to avoid crashing php on some large strings.
1774 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1775
1776 $sql = str_replace( "\\\\", '', $sql );
1777 $sql = str_replace( "\\'", '', $sql );
1778 $sql = str_replace( "\\\"", '', $sql );
1779 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1780 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1781
1782 # All newlines, tabs, etc replaced by single space
1783 $sql = preg_replace( '/\s+/', ' ', $sql );
1784
1785 # All numbers => N,
1786 # except the ones surrounded by characters, e.g. l10n
1787 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1788 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1789
1790 return $sql;
1791 }
1792
1793 /**
1794 * Determines whether a field exists in a table
1795 *
1796 * @param string $table Table name
1797 * @param string $field Filed to check on that table
1798 * @param string $fname Calling function name (optional)
1799 * @return bool Whether $table has filed $field
1800 */
1801 public function fieldExists( $table, $field, $fname = __METHOD__ ) {
1802 $info = $this->fieldInfo( $table, $field );
1803
1804 return (bool)$info;
1805 }
1806
1807 /**
1808 * Determines whether an index exists
1809 * Usually throws a DBQueryError on failure
1810 * If errors are explicitly ignored, returns NULL on failure
1811 *
1812 * @param string $table
1813 * @param string $index
1814 * @param string $fname
1815 * @return bool|null
1816 */
1817 public function indexExists( $table, $index, $fname = __METHOD__ ) {
1818 if ( !$this->tableExists( $table ) ) {
1819 return null;
1820 }
1821
1822 $info = $this->indexInfo( $table, $index, $fname );
1823 if ( is_null( $info ) ) {
1824 return null;
1825 } else {
1826 return $info !== false;
1827 }
1828 }
1829
1830 /**
1831 * Query whether a given table exists
1832 *
1833 * @param string $table
1834 * @param string $fname
1835 * @return bool
1836 */
1837 public function tableExists( $table, $fname = __METHOD__ ) {
1838 $table = $this->tableName( $table );
1839 $old = $this->ignoreErrors( true );
1840 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname );
1841 $this->ignoreErrors( $old );
1842
1843 return (bool)$res;
1844 }
1845
1846 /**
1847 * Determines if a given index is unique
1848 *
1849 * @param string $table
1850 * @param string $index
1851 *
1852 * @return bool
1853 */
1854 public function indexUnique( $table, $index ) {
1855 $indexInfo = $this->indexInfo( $table, $index );
1856
1857 if ( !$indexInfo ) {
1858 return null;
1859 }
1860
1861 return !$indexInfo[0]->Non_unique;
1862 }
1863
1864 /**
1865 * Helper for DatabaseBase::insert().
1866 *
1867 * @param array $options
1868 * @return string
1869 */
1870 protected function makeInsertOptions( $options ) {
1871 return implode( ' ', $options );
1872 }
1873
1874 /**
1875 * INSERT wrapper, inserts an array into a table.
1876 *
1877 * $a may be either:
1878 *
1879 * - A single associative array. The array keys are the field names, and
1880 * the values are the values to insert. The values are treated as data
1881 * and will be quoted appropriately. If NULL is inserted, this will be
1882 * converted to a database NULL.
1883 * - An array with numeric keys, holding a list of associative arrays.
1884 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1885 * each subarray must be identical to each other, and in the same order.
1886 *
1887 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1888 * returns success.
1889 *
1890 * $options is an array of options, with boolean options encoded as values
1891 * with numeric keys, in the same style as $options in
1892 * DatabaseBase::select(). Supported options are:
1893 *
1894 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
1895 * any rows which cause duplicate key errors are not inserted. It's
1896 * possible to determine how many rows were successfully inserted using
1897 * DatabaseBase::affectedRows().
1898 *
1899 * @param string $table Table name. This will be passed through
1900 * DatabaseBase::tableName().
1901 * @param array $a Array of rows to insert
1902 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1903 * @param array $options Array of options
1904 *
1905 * @return bool
1906 */
1907 public function insert( $table, $a, $fname = __METHOD__, $options = array() ) {
1908 # No rows to insert, easy just return now
1909 if ( !count( $a ) ) {
1910 return true;
1911 }
1912
1913 $table = $this->tableName( $table );
1914
1915 if ( !is_array( $options ) ) {
1916 $options = array( $options );
1917 }
1918
1919 $fh = null;
1920 if ( isset( $options['fileHandle'] ) ) {
1921 $fh = $options['fileHandle'];
1922 }
1923 $options = $this->makeInsertOptions( $options );
1924
1925 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1926 $multi = true;
1927 $keys = array_keys( $a[0] );
1928 } else {
1929 $multi = false;
1930 $keys = array_keys( $a );
1931 }
1932
1933 $sql = 'INSERT ' . $options .
1934 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1935
1936 if ( $multi ) {
1937 $first = true;
1938 foreach ( $a as $row ) {
1939 if ( $first ) {
1940 $first = false;
1941 } else {
1942 $sql .= ',';
1943 }
1944 $sql .= '(' . $this->makeList( $row ) . ')';
1945 }
1946 } else {
1947 $sql .= '(' . $this->makeList( $a ) . ')';
1948 }
1949
1950 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1951 return false;
1952 } elseif ( $fh !== null ) {
1953 return true;
1954 }
1955
1956 return (bool)$this->query( $sql, $fname );
1957 }
1958
1959 /**
1960 * Make UPDATE options array for DatabaseBase::makeUpdateOptions
1961 *
1962 * @param array $options
1963 * @return array
1964 */
1965 protected function makeUpdateOptionsArray( $options ) {
1966 if ( !is_array( $options ) ) {
1967 $options = array( $options );
1968 }
1969
1970 $opts = array();
1971
1972 if ( in_array( 'LOW_PRIORITY', $options ) ) {
1973 $opts[] = $this->lowPriorityOption();
1974 }
1975
1976 if ( in_array( 'IGNORE', $options ) ) {
1977 $opts[] = 'IGNORE';
1978 }
1979
1980 return $opts;
1981 }
1982
1983 /**
1984 * Make UPDATE options for the DatabaseBase::update function
1985 *
1986 * @param array $options The options passed to DatabaseBase::update
1987 * @return string
1988 */
1989 protected function makeUpdateOptions( $options ) {
1990 $opts = $this->makeUpdateOptionsArray( $options );
1991
1992 return implode( ' ', $opts );
1993 }
1994
1995 /**
1996 * UPDATE wrapper. Takes a condition array and a SET array.
1997 *
1998 * @param string $table Name of the table to UPDATE. This will be passed through
1999 * DatabaseBase::tableName().
2000 * @param array $values An array of values to SET. For each array element,
2001 * the key gives the field name, and the value gives the data to set
2002 * that field to. The data will be quoted by DatabaseBase::addQuotes().
2003 * @param array $conds An array of conditions (WHERE). See
2004 * DatabaseBase::select() for the details of the format of condition
2005 * arrays. Use '*' to update all rows.
2006 * @param string $fname The function name of the caller (from __METHOD__),
2007 * for logging and profiling.
2008 * @param array $options An array of UPDATE options, can be:
2009 * - IGNORE: Ignore unique key conflicts
2010 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
2011 * @return bool
2012 */
2013 function update( $table, $values, $conds, $fname = __METHOD__, $options = array() ) {
2014 $table = $this->tableName( $table );
2015 $opts = $this->makeUpdateOptions( $options );
2016 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET );
2017
2018 if ( $conds !== array() && $conds !== '*' ) {
2019 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND );
2020 }
2021
2022 return $this->query( $sql, $fname );
2023 }
2024
2025 /**
2026 * Makes an encoded list of strings from an array
2027 *
2028 * @param array $a Containing the data
2029 * @param int $mode Constant
2030 * - LIST_COMMA: Comma separated, no field names
2031 * - LIST_AND: ANDed WHERE clause (without the WHERE). See the
2032 * documentation for $conds in DatabaseBase::select().
2033 * - LIST_OR: ORed WHERE clause (without the WHERE)
2034 * - LIST_SET: Comma separated with field names, like a SET clause
2035 * - LIST_NAMES: Comma separated field names
2036 * @throws MWException|DBUnexpectedError
2037 * @return string
2038 */
2039 public function makeList( $a, $mode = LIST_COMMA ) {
2040 if ( !is_array( $a ) ) {
2041 throw new DBUnexpectedError( $this, 'DatabaseBase::makeList called with incorrect parameters' );
2042 }
2043
2044 $first = true;
2045 $list = '';
2046
2047 foreach ( $a as $field => $value ) {
2048 if ( !$first ) {
2049 if ( $mode == LIST_AND ) {
2050 $list .= ' AND ';
2051 } elseif ( $mode == LIST_OR ) {
2052 $list .= ' OR ';
2053 } else {
2054 $list .= ',';
2055 }
2056 } else {
2057 $first = false;
2058 }
2059
2060 if ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_numeric( $field ) ) {
2061 $list .= "($value)";
2062 } elseif ( ( $mode == LIST_SET ) && is_numeric( $field ) ) {
2063 $list .= "$value";
2064 } elseif ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_array( $value ) ) {
2065 if ( count( $value ) == 0 ) {
2066 throw new MWException( __METHOD__ . ": empty input for field $field" );
2067 } elseif ( count( $value ) == 1 ) {
2068 // Special-case single values, as IN isn't terribly efficient
2069 // Don't necessarily assume the single key is 0; we don't
2070 // enforce linear numeric ordering on other arrays here.
2071 $value = array_values( $value );
2072 $list .= $field . " = " . $this->addQuotes( $value[0] );
2073 } else {
2074 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2075 }
2076 } elseif ( $value === null ) {
2077 if ( $mode == LIST_AND || $mode == LIST_OR ) {
2078 $list .= "$field IS ";
2079 } elseif ( $mode == LIST_SET ) {
2080 $list .= "$field = ";
2081 }
2082 $list .= 'NULL';
2083 } else {
2084 if ( $mode == LIST_AND || $mode == LIST_OR || $mode == LIST_SET ) {
2085 $list .= "$field = ";
2086 }
2087 $list .= $mode == LIST_NAMES ? $value : $this->addQuotes( $value );
2088 }
2089 }
2090
2091 return $list;
2092 }
2093
2094 /**
2095 * Build a partial where clause from a 2-d array such as used for LinkBatch.
2096 * The keys on each level may be either integers or strings.
2097 *
2098 * @param array $data Organized as 2-d
2099 * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...)
2100 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
2101 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
2102 * @return string|bool SQL fragment, or false if no items in array
2103 */
2104 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2105 $conds = array();
2106
2107 foreach ( $data as $base => $sub ) {
2108 if ( count( $sub ) ) {
2109 $conds[] = $this->makeList(
2110 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
2111 LIST_AND );
2112 }
2113 }
2114
2115 if ( $conds ) {
2116 return $this->makeList( $conds, LIST_OR );
2117 } else {
2118 // Nothing to search for...
2119 return false;
2120 }
2121 }
2122
2123 /**
2124 * Return aggregated value alias
2125 *
2126 * @param array $valuedata
2127 * @param string $valuename
2128 *
2129 * @return string
2130 */
2131 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2132 return $valuename;
2133 }
2134
2135 /**
2136 * @param string $field
2137 * @return string
2138 */
2139 public function bitNot( $field ) {
2140 return "(~$field)";
2141 }
2142
2143 /**
2144 * @param string $fieldLeft
2145 * @param string $fieldRight
2146 * @return string
2147 */
2148 public function bitAnd( $fieldLeft, $fieldRight ) {
2149 return "($fieldLeft & $fieldRight)";
2150 }
2151
2152 /**
2153 * @param string $fieldLeft
2154 * @param string $fieldRight
2155 * @return string
2156 */
2157 public function bitOr( $fieldLeft, $fieldRight ) {
2158 return "($fieldLeft | $fieldRight)";
2159 }
2160
2161 /**
2162 * Build a concatenation list to feed into a SQL query
2163 * @param array $stringList List of raw SQL expressions; caller is
2164 * responsible for any quoting
2165 * @return string
2166 */
2167 public function buildConcat( $stringList ) {
2168 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2169 }
2170
2171 /**
2172 * Build a GROUP_CONCAT or equivalent statement for a query.
2173 *
2174 * This is useful for combining a field for several rows into a single string.
2175 * NULL values will not appear in the output, duplicated values will appear,
2176 * and the resulting delimiter-separated values have no defined sort order.
2177 * Code using the results may need to use the PHP unique() or sort() methods.
2178 *
2179 * @param string $delim Glue to bind the results together
2180 * @param string|array $table Table name
2181 * @param string $field Field name
2182 * @param string|array $conds Conditions
2183 * @param string|array $join_conds Join conditions
2184 * @return string SQL text
2185 * @since 1.23
2186 */
2187 public function buildGroupConcatField(
2188 $delim, $table, $field, $conds = '', $join_conds = array()
2189 ) {
2190 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2191
2192 return '(' . $this->selectSQLText( $table, $fld, $conds, null, array(), $join_conds ) . ')';
2193 }
2194
2195 /**
2196 * Change the current database
2197 *
2198 * @todo Explain what exactly will fail if this is not overridden.
2199 *
2200 * @param string $db
2201 *
2202 * @return bool Success or failure
2203 */
2204 public function selectDB( $db ) {
2205 # Stub. Shouldn't cause serious problems if it's not overridden, but
2206 # if your database engine supports a concept similar to MySQL's
2207 # databases you may as well.
2208 $this->mDBname = $db;
2209
2210 return true;
2211 }
2212
2213 /**
2214 * Get the current DB name
2215 * @return string
2216 */
2217 public function getDBname() {
2218 return $this->mDBname;
2219 }
2220
2221 /**
2222 * Get the server hostname or IP address
2223 * @return string
2224 */
2225 public function getServer() {
2226 return $this->mServer;
2227 }
2228
2229 /**
2230 * Format a table name ready for use in constructing an SQL query
2231 *
2232 * This does two important things: it quotes the table names to clean them up,
2233 * and it adds a table prefix if only given a table name with no quotes.
2234 *
2235 * All functions of this object which require a table name call this function
2236 * themselves. Pass the canonical name to such functions. This is only needed
2237 * when calling query() directly.
2238 *
2239 * @param string $name Database table name
2240 * @param string $format One of:
2241 * quoted - Automatically pass the table name through addIdentifierQuotes()
2242 * so that it can be used in a query.
2243 * raw - Do not add identifier quotes to the table name
2244 * @return string Full database name
2245 */
2246 public function tableName( $name, $format = 'quoted' ) {
2247 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables, $wgSharedSchema;
2248 # Skip the entire process when we have a string quoted on both ends.
2249 # Note that we check the end so that we will still quote any use of
2250 # use of `database`.table. But won't break things if someone wants
2251 # to query a database table with a dot in the name.
2252 if ( $this->isQuotedIdentifier( $name ) ) {
2253 return $name;
2254 }
2255
2256 # Lets test for any bits of text that should never show up in a table
2257 # name. Basically anything like JOIN or ON which are actually part of
2258 # SQL queries, but may end up inside of the table value to combine
2259 # sql. Such as how the API is doing.
2260 # Note that we use a whitespace test rather than a \b test to avoid
2261 # any remote case where a word like on may be inside of a table name
2262 # surrounded by symbols which may be considered word breaks.
2263 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2264 return $name;
2265 }
2266
2267 # Split database and table into proper variables.
2268 # We reverse the explode so that database.table and table both output
2269 # the correct table.
2270 $dbDetails = explode( '.', $name, 2 );
2271 if ( count( $dbDetails ) == 3 ) {
2272 list( $database, $schema, $table ) = $dbDetails;
2273 # We don't want any prefix added in this case
2274 $prefix = '';
2275 } elseif ( count( $dbDetails ) == 2 ) {
2276 list( $database, $table ) = $dbDetails;
2277 # We don't want any prefix added in this case
2278 # In dbs that support it, $database may actually be the schema
2279 # but that doesn't affect any of the functionality here
2280 $prefix = '';
2281 $schema = null;
2282 } else {
2283 list( $table ) = $dbDetails;
2284 if ( $wgSharedDB !== null # We have a shared database
2285 && $this->mForeign == false # We're not working on a foreign database
2286 && !$this->isQuotedIdentifier( $table ) # Prevent shared tables listing '`table`'
2287 && in_array( $table, $wgSharedTables ) # A shared table is selected
2288 ) {
2289 $database = $wgSharedDB;
2290 $schema = $wgSharedSchema === null ? $this->mSchema : $wgSharedSchema;
2291 $prefix = $wgSharedPrefix === null ? $this->mTablePrefix : $wgSharedPrefix;
2292 } else {
2293 $database = null;
2294 $schema = $this->mSchema; # Default schema
2295 $prefix = $this->mTablePrefix; # Default prefix
2296 }
2297 }
2298
2299 # Quote $table and apply the prefix if not quoted.
2300 # $tableName might be empty if this is called from Database::replaceVars()
2301 $tableName = "{$prefix}{$table}";
2302 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $tableName ) && $tableName !== '' ) {
2303 $tableName = $this->addIdentifierQuotes( $tableName );
2304 }
2305
2306 # Quote $schema and merge it with the table name if needed
2307 if ( $schema !== null ) {
2308 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $schema ) ) {
2309 $schema = $this->addIdentifierQuotes( $schema );
2310 }
2311 $tableName = $schema . '.' . $tableName;
2312 }
2313
2314 # Quote $database and merge it with the table name if needed
2315 if ( $database !== null ) {
2316 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $database ) ) {
2317 $database = $this->addIdentifierQuotes( $database );
2318 }
2319 $tableName = $database . '.' . $tableName;
2320 }
2321
2322 return $tableName;
2323 }
2324
2325 /**
2326 * Fetch a number of table names into an array
2327 * This is handy when you need to construct SQL for joins
2328 *
2329 * Example:
2330 * extract( $dbr->tableNames( 'user', 'watchlist' ) );
2331 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2332 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2333 *
2334 * @return array
2335 */
2336 public function tableNames() {
2337 $inArray = func_get_args();
2338 $retVal = array();
2339
2340 foreach ( $inArray as $name ) {
2341 $retVal[$name] = $this->tableName( $name );
2342 }
2343
2344 return $retVal;
2345 }
2346
2347 /**
2348 * Fetch a number of table names into an zero-indexed numerical array
2349 * This is handy when you need to construct SQL for joins
2350 *
2351 * Example:
2352 * list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' );
2353 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2354 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2355 *
2356 * @return array
2357 */
2358 public function tableNamesN() {
2359 $inArray = func_get_args();
2360 $retVal = array();
2361
2362 foreach ( $inArray as $name ) {
2363 $retVal[] = $this->tableName( $name );
2364 }
2365
2366 return $retVal;
2367 }
2368
2369 /**
2370 * Get an aliased table name
2371 * e.g. tableName AS newTableName
2372 *
2373 * @param string $name Table name, see tableName()
2374 * @param string|bool $alias Alias (optional)
2375 * @return string SQL name for aliased table. Will not alias a table to its own name
2376 */
2377 public function tableNameWithAlias( $name, $alias = false ) {
2378 if ( !$alias || $alias == $name ) {
2379 return $this->tableName( $name );
2380 } else {
2381 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2382 }
2383 }
2384
2385 /**
2386 * Gets an array of aliased table names
2387 *
2388 * @param array $tables Array( [alias] => table )
2389 * @return string[] See tableNameWithAlias()
2390 */
2391 public function tableNamesWithAlias( $tables ) {
2392 $retval = array();
2393 foreach ( $tables as $alias => $table ) {
2394 if ( is_numeric( $alias ) ) {
2395 $alias = $table;
2396 }
2397 $retval[] = $this->tableNameWithAlias( $table, $alias );
2398 }
2399
2400 return $retval;
2401 }
2402
2403 /**
2404 * Get an aliased field name
2405 * e.g. fieldName AS newFieldName
2406 *
2407 * @param string $name Field name
2408 * @param string|bool $alias Alias (optional)
2409 * @return string SQL name for aliased field. Will not alias a field to its own name
2410 */
2411 public function fieldNameWithAlias( $name, $alias = false ) {
2412 if ( !$alias || (string)$alias === (string)$name ) {
2413 return $name;
2414 } else {
2415 return $name . ' AS ' . $alias; //PostgreSQL needs AS
2416 }
2417 }
2418
2419 /**
2420 * Gets an array of aliased field names
2421 *
2422 * @param array $fields Array( [alias] => field )
2423 * @return string[] See fieldNameWithAlias()
2424 */
2425 public function fieldNamesWithAlias( $fields ) {
2426 $retval = array();
2427 foreach ( $fields as $alias => $field ) {
2428 if ( is_numeric( $alias ) ) {
2429 $alias = $field;
2430 }
2431 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2432 }
2433
2434 return $retval;
2435 }
2436
2437 /**
2438 * Get the aliased table name clause for a FROM clause
2439 * which might have a JOIN and/or USE INDEX clause
2440 *
2441 * @param array $tables ( [alias] => table )
2442 * @param array $use_index Same as for select()
2443 * @param array $join_conds Same as for select()
2444 * @return string
2445 */
2446 protected function tableNamesWithUseIndexOrJOIN(
2447 $tables, $use_index = array(), $join_conds = array()
2448 ) {
2449 $ret = array();
2450 $retJOIN = array();
2451 $use_index = (array)$use_index;
2452 $join_conds = (array)$join_conds;
2453
2454 foreach ( $tables as $alias => $table ) {
2455 if ( !is_string( $alias ) ) {
2456 // No alias? Set it equal to the table name
2457 $alias = $table;
2458 }
2459 // Is there a JOIN clause for this table?
2460 if ( isset( $join_conds[$alias] ) ) {
2461 list( $joinType, $conds ) = $join_conds[$alias];
2462 $tableClause = $joinType;
2463 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2464 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2465 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2466 if ( $use != '' ) {
2467 $tableClause .= ' ' . $use;
2468 }
2469 }
2470 $on = $this->makeList( (array)$conds, LIST_AND );
2471 if ( $on != '' ) {
2472 $tableClause .= ' ON (' . $on . ')';
2473 }
2474
2475 $retJOIN[] = $tableClause;
2476 } elseif ( isset( $use_index[$alias] ) ) {
2477 // Is there an INDEX clause for this table?
2478 $tableClause = $this->tableNameWithAlias( $table, $alias );
2479 $tableClause .= ' ' . $this->useIndexClause(
2480 implode( ',', (array)$use_index[$alias] )
2481 );
2482
2483 $ret[] = $tableClause;
2484 } else {
2485 $tableClause = $this->tableNameWithAlias( $table, $alias );
2486
2487 $ret[] = $tableClause;
2488 }
2489 }
2490
2491 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2492 $implicitJoins = !empty( $ret ) ? implode( ',', $ret ) : "";
2493 $explicitJoins = !empty( $retJOIN ) ? implode( ' ', $retJOIN ) : "";
2494
2495 // Compile our final table clause
2496 return implode( ' ', array( $implicitJoins, $explicitJoins ) );
2497 }
2498
2499 /**
2500 * Get the name of an index in a given table
2501 *
2502 * @param string $index
2503 * @return string
2504 */
2505 protected function indexName( $index ) {
2506 // Backwards-compatibility hack
2507 $renamed = array(
2508 'ar_usertext_timestamp' => 'usertext_timestamp',
2509 'un_user_id' => 'user_id',
2510 'un_user_ip' => 'user_ip',
2511 );
2512
2513 if ( isset( $renamed[$index] ) ) {
2514 return $renamed[$index];
2515 } else {
2516 return $index;
2517 }
2518 }
2519
2520 /**
2521 * Adds quotes and backslashes.
2522 *
2523 * @param string $s
2524 * @return string
2525 */
2526 public function addQuotes( $s ) {
2527 if ( $s === null ) {
2528 return 'NULL';
2529 } else {
2530 # This will also quote numeric values. This should be harmless,
2531 # and protects against weird problems that occur when they really
2532 # _are_ strings such as article titles and string->number->string
2533 # conversion is not 1:1.
2534 return "'" . $this->strencode( $s ) . "'";
2535 }
2536 }
2537
2538 /**
2539 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2540 * MySQL uses `backticks` while basically everything else uses double quotes.
2541 * Since MySQL is the odd one out here the double quotes are our generic
2542 * and we implement backticks in DatabaseMysql.
2543 *
2544 * @param string $s
2545 * @return string
2546 */
2547 public function addIdentifierQuotes( $s ) {
2548 return '"' . str_replace( '"', '""', $s ) . '"';
2549 }
2550
2551 /**
2552 * Returns if the given identifier looks quoted or not according to
2553 * the database convention for quoting identifiers .
2554 *
2555 * @param string $name
2556 * @return bool
2557 */
2558 public function isQuotedIdentifier( $name ) {
2559 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2560 }
2561
2562 /**
2563 * @param string $s
2564 * @return string
2565 */
2566 protected function escapeLikeInternal( $s ) {
2567 return addcslashes( $s, '\%_' );
2568 }
2569
2570 /**
2571 * LIKE statement wrapper, receives a variable-length argument list with
2572 * parts of pattern to match containing either string literals that will be
2573 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
2574 * the function could be provided with an array of aforementioned
2575 * parameters.
2576 *
2577 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
2578 * a LIKE clause that searches for subpages of 'My page title'.
2579 * Alternatively:
2580 * $pattern = array( 'My_page_title/', $dbr->anyString() );
2581 * $query .= $dbr->buildLike( $pattern );
2582 *
2583 * @since 1.16
2584 * @return string Fully built LIKE statement
2585 */
2586 public function buildLike() {
2587 $params = func_get_args();
2588
2589 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2590 $params = $params[0];
2591 }
2592
2593 $s = '';
2594
2595 foreach ( $params as $value ) {
2596 if ( $value instanceof LikeMatch ) {
2597 $s .= $value->toString();
2598 } else {
2599 $s .= $this->escapeLikeInternal( $value );
2600 }
2601 }
2602
2603 return " LIKE {$this->addQuotes( $s )} ";
2604 }
2605
2606 /**
2607 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
2608 *
2609 * @return LikeMatch
2610 */
2611 public function anyChar() {
2612 return new LikeMatch( '_' );
2613 }
2614
2615 /**
2616 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
2617 *
2618 * @return LikeMatch
2619 */
2620 public function anyString() {
2621 return new LikeMatch( '%' );
2622 }
2623
2624 /**
2625 * Returns an appropriately quoted sequence value for inserting a new row.
2626 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
2627 * subclass will return an integer, and save the value for insertId()
2628 *
2629 * Any implementation of this function should *not* involve reusing
2630 * sequence numbers created for rolled-back transactions.
2631 * See http://bugs.mysql.com/bug.php?id=30767 for details.
2632 * @param string $seqName
2633 * @return null|int
2634 */
2635 public function nextSequenceValue( $seqName ) {
2636 return null;
2637 }
2638
2639 /**
2640 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2641 * is only needed because a) MySQL must be as efficient as possible due to
2642 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2643 * which index to pick. Anyway, other databases might have different
2644 * indexes on a given table. So don't bother overriding this unless you're
2645 * MySQL.
2646 * @param string $index
2647 * @return string
2648 */
2649 public function useIndexClause( $index ) {
2650 return '';
2651 }
2652
2653 /**
2654 * REPLACE query wrapper.
2655 *
2656 * REPLACE is a very handy MySQL extension, which functions like an INSERT
2657 * except that when there is a duplicate key error, the old row is deleted
2658 * and the new row is inserted in its place.
2659 *
2660 * We simulate this with standard SQL with a DELETE followed by INSERT. To
2661 * perform the delete, we need to know what the unique indexes are so that
2662 * we know how to find the conflicting rows.
2663 *
2664 * It may be more efficient to leave off unique indexes which are unlikely
2665 * to collide. However if you do this, you run the risk of encountering
2666 * errors which wouldn't have occurred in MySQL.
2667 *
2668 * @param string $table The table to replace the row(s) in.
2669 * @param array $uniqueIndexes Is an array of indexes. Each element may be either
2670 * a field name or an array of field names
2671 * @param array $rows Can be either a single row to insert, or multiple rows,
2672 * in the same format as for DatabaseBase::insert()
2673 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2674 */
2675 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
2676 $quotedTable = $this->tableName( $table );
2677
2678 if ( count( $rows ) == 0 ) {
2679 return;
2680 }
2681
2682 # Single row case
2683 if ( !is_array( reset( $rows ) ) ) {
2684 $rows = array( $rows );
2685 }
2686
2687 foreach ( $rows as $row ) {
2688 # Delete rows which collide
2689 if ( $uniqueIndexes ) {
2690 $sql = "DELETE FROM $quotedTable WHERE ";
2691 $first = true;
2692 foreach ( $uniqueIndexes as $index ) {
2693 if ( $first ) {
2694 $first = false;
2695 $sql .= '( ';
2696 } else {
2697 $sql .= ' ) OR ( ';
2698 }
2699 if ( is_array( $index ) ) {
2700 $first2 = true;
2701 foreach ( $index as $col ) {
2702 if ( $first2 ) {
2703 $first2 = false;
2704 } else {
2705 $sql .= ' AND ';
2706 }
2707 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2708 }
2709 } else {
2710 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2711 }
2712 }
2713 $sql .= ' )';
2714 $this->query( $sql, $fname );
2715 }
2716
2717 # Now insert the row
2718 $this->insert( $table, $row, $fname );
2719 }
2720 }
2721
2722 /**
2723 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2724 * statement.
2725 *
2726 * @param string $table Table name
2727 * @param array|string $rows Row(s) to insert
2728 * @param string $fname Caller function name
2729 *
2730 * @return ResultWrapper
2731 */
2732 protected function nativeReplace( $table, $rows, $fname ) {
2733 $table = $this->tableName( $table );
2734
2735 # Single row case
2736 if ( !is_array( reset( $rows ) ) ) {
2737 $rows = array( $rows );
2738 }
2739
2740 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2741 $first = true;
2742
2743 foreach ( $rows as $row ) {
2744 if ( $first ) {
2745 $first = false;
2746 } else {
2747 $sql .= ',';
2748 }
2749
2750 $sql .= '(' . $this->makeList( $row ) . ')';
2751 }
2752
2753 return $this->query( $sql, $fname );
2754 }
2755
2756 /**
2757 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
2758 *
2759 * This updates any conflicting rows (according to the unique indexes) using
2760 * the provided SET clause and inserts any remaining (non-conflicted) rows.
2761 *
2762 * $rows may be either:
2763 * - A single associative array. The array keys are the field names, and
2764 * the values are the values to insert. The values are treated as data
2765 * and will be quoted appropriately. If NULL is inserted, this will be
2766 * converted to a database NULL.
2767 * - An array with numeric keys, holding a list of associative arrays.
2768 * This causes a multi-row INSERT on DBMSs that support it. The keys in
2769 * each subarray must be identical to each other, and in the same order.
2770 *
2771 * It may be more efficient to leave off unique indexes which are unlikely
2772 * to collide. However if you do this, you run the risk of encountering
2773 * errors which wouldn't have occurred in MySQL.
2774 *
2775 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
2776 * returns success.
2777 *
2778 * @since 1.22
2779 *
2780 * @param string $table Table name. This will be passed through DatabaseBase::tableName().
2781 * @param array $rows A single row or list of rows to insert
2782 * @param array $uniqueIndexes List of single field names or field name tuples
2783 * @param array $set An array of values to SET. For each array element, the
2784 * key gives the field name, and the value gives the data to set that
2785 * field to. The data will be quoted by DatabaseBase::addQuotes().
2786 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2787 * @throws Exception
2788 * @return bool
2789 */
2790 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2791 $fname = __METHOD__
2792 ) {
2793 if ( !count( $rows ) ) {
2794 return true; // nothing to do
2795 }
2796
2797 if ( !is_array( reset( $rows ) ) ) {
2798 $rows = array( $rows );
2799 }
2800
2801 if ( count( $uniqueIndexes ) ) {
2802 $clauses = array(); // list WHERE clauses that each identify a single row
2803 foreach ( $rows as $row ) {
2804 foreach ( $uniqueIndexes as $index ) {
2805 $index = is_array( $index ) ? $index : array( $index ); // columns
2806 $rowKey = array(); // unique key to this row
2807 foreach ( $index as $column ) {
2808 $rowKey[$column] = $row[$column];
2809 }
2810 $clauses[] = $this->makeList( $rowKey, LIST_AND );
2811 }
2812 }
2813 $where = array( $this->makeList( $clauses, LIST_OR ) );
2814 } else {
2815 $where = false;
2816 }
2817
2818 $useTrx = !$this->mTrxLevel;
2819 if ( $useTrx ) {
2820 $this->begin( $fname );
2821 }
2822 try {
2823 # Update any existing conflicting row(s)
2824 if ( $where !== false ) {
2825 $ok = $this->update( $table, $set, $where, $fname );
2826 } else {
2827 $ok = true;
2828 }
2829 # Now insert any non-conflicting row(s)
2830 $ok = $this->insert( $table, $rows, $fname, array( 'IGNORE' ) ) && $ok;
2831 } catch ( Exception $e ) {
2832 if ( $useTrx ) {
2833 $this->rollback( $fname );
2834 }
2835 throw $e;
2836 }
2837 if ( $useTrx ) {
2838 $this->commit( $fname );
2839 }
2840
2841 return $ok;
2842 }
2843
2844 /**
2845 * DELETE where the condition is a join.
2846 *
2847 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
2848 * we use sub-selects
2849 *
2850 * For safety, an empty $conds will not delete everything. If you want to
2851 * delete all rows where the join condition matches, set $conds='*'.
2852 *
2853 * DO NOT put the join condition in $conds.
2854 *
2855 * @param string $delTable The table to delete from.
2856 * @param string $joinTable The other table.
2857 * @param string $delVar The variable to join on, in the first table.
2858 * @param string $joinVar The variable to join on, in the second table.
2859 * @param array $conds Condition array of field names mapped to variables,
2860 * ANDed together in the WHERE clause
2861 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2862 * @throws DBUnexpectedError
2863 */
2864 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2865 $fname = __METHOD__
2866 ) {
2867 if ( !$conds ) {
2868 throw new DBUnexpectedError( $this,
2869 'DatabaseBase::deleteJoin() called with empty $conds' );
2870 }
2871
2872 $delTable = $this->tableName( $delTable );
2873 $joinTable = $this->tableName( $joinTable );
2874 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2875 if ( $conds != '*' ) {
2876 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
2877 }
2878 $sql .= ')';
2879
2880 $this->query( $sql, $fname );
2881 }
2882
2883 /**
2884 * Returns the size of a text field, or -1 for "unlimited"
2885 *
2886 * @param string $table
2887 * @param string $field
2888 * @return int
2889 */
2890 public function textFieldSize( $table, $field ) {
2891 $table = $this->tableName( $table );
2892 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2893 $res = $this->query( $sql, 'DatabaseBase::textFieldSize' );
2894 $row = $this->fetchObject( $res );
2895
2896 $m = array();
2897
2898 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
2899 $size = $m[1];
2900 } else {
2901 $size = -1;
2902 }
2903
2904 return $size;
2905 }
2906
2907 /**
2908 * A string to insert into queries to show that they're low-priority, like
2909 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
2910 * string and nothing bad should happen.
2911 *
2912 * @return string Returns the text of the low priority option if it is
2913 * supported, or a blank string otherwise
2914 */
2915 public function lowPriorityOption() {
2916 return '';
2917 }
2918
2919 /**
2920 * DELETE query wrapper.
2921 *
2922 * @param array $table Table name
2923 * @param string|array $conds Array of conditions. See $conds in DatabaseBase::select()
2924 * for the format. Use $conds == "*" to delete all rows
2925 * @param string $fname Name of the calling function
2926 * @throws DBUnexpectedError
2927 * @return bool|ResultWrapper
2928 */
2929 public function delete( $table, $conds, $fname = __METHOD__ ) {
2930 if ( !$conds ) {
2931 throw new DBUnexpectedError( $this, 'DatabaseBase::delete() called with no conditions' );
2932 }
2933
2934 $table = $this->tableName( $table );
2935 $sql = "DELETE FROM $table";
2936
2937 if ( $conds != '*' ) {
2938 if ( is_array( $conds ) ) {
2939 $conds = $this->makeList( $conds, LIST_AND );
2940 }
2941 $sql .= ' WHERE ' . $conds;
2942 }
2943
2944 return $this->query( $sql, $fname );
2945 }
2946
2947 /**
2948 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
2949 * into another table.
2950 *
2951 * @param string $destTable The table name to insert into
2952 * @param string|array $srcTable May be either a table name, or an array of table names
2953 * to include in a join.
2954 *
2955 * @param array $varMap Must be an associative array of the form
2956 * array( 'dest1' => 'source1', ...). Source items may be literals
2957 * rather than field names, but strings should be quoted with
2958 * DatabaseBase::addQuotes()
2959 *
2960 * @param array $conds Condition array. See $conds in DatabaseBase::select() for
2961 * the details of the format of condition arrays. May be "*" to copy the
2962 * whole table.
2963 *
2964 * @param string $fname The function name of the caller, from __METHOD__
2965 *
2966 * @param array $insertOptions Options for the INSERT part of the query, see
2967 * DatabaseBase::insert() for details.
2968 * @param array $selectOptions Options for the SELECT part of the query, see
2969 * DatabaseBase::select() for details.
2970 *
2971 * @return ResultWrapper
2972 */
2973 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
2974 $fname = __METHOD__,
2975 $insertOptions = array(), $selectOptions = array()
2976 ) {
2977 $destTable = $this->tableName( $destTable );
2978
2979 if ( !is_array( $insertOptions ) ) {
2980 $insertOptions = array( $insertOptions );
2981 }
2982
2983 $insertOptions = $this->makeInsertOptions( $insertOptions );
2984
2985 if ( !is_array( $selectOptions ) ) {
2986 $selectOptions = array( $selectOptions );
2987 }
2988
2989 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
2990
2991 if ( is_array( $srcTable ) ) {
2992 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
2993 } else {
2994 $srcTable = $this->tableName( $srcTable );
2995 }
2996
2997 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
2998 " SELECT $startOpts " . implode( ',', $varMap ) .
2999 " FROM $srcTable $useIndex ";
3000
3001 if ( $conds != '*' ) {
3002 if ( is_array( $conds ) ) {
3003 $conds = $this->makeList( $conds, LIST_AND );
3004 }
3005 $sql .= " WHERE $conds";
3006 }
3007
3008 $sql .= " $tailOpts";
3009
3010 return $this->query( $sql, $fname );
3011 }
3012
3013 /**
3014 * Construct a LIMIT query with optional offset. This is used for query
3015 * pages. The SQL should be adjusted so that only the first $limit rows
3016 * are returned. If $offset is provided as well, then the first $offset
3017 * rows should be discarded, and the next $limit rows should be returned.
3018 * If the result of the query is not ordered, then the rows to be returned
3019 * are theoretically arbitrary.
3020 *
3021 * $sql is expected to be a SELECT, if that makes a difference.
3022 *
3023 * The version provided by default works in MySQL and SQLite. It will very
3024 * likely need to be overridden for most other DBMSes.
3025 *
3026 * @param string $sql SQL query we will append the limit too
3027 * @param int $limit The SQL limit
3028 * @param int|bool $offset The SQL offset (default false)
3029 * @throws DBUnexpectedError
3030 * @return string
3031 */
3032 public function limitResult( $sql, $limit, $offset = false ) {
3033 if ( !is_numeric( $limit ) ) {
3034 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
3035 }
3036
3037 return "$sql LIMIT "
3038 . ( ( is_numeric( $offset ) && $offset != 0 ) ? "{$offset}," : "" )
3039 . "{$limit} ";
3040 }
3041
3042 /**
3043 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
3044 * within the UNION construct.
3045 * @return bool
3046 */
3047 public function unionSupportsOrderAndLimit() {
3048 return true; // True for almost every DB supported
3049 }
3050
3051 /**
3052 * Construct a UNION query
3053 * This is used for providing overload point for other DB abstractions
3054 * not compatible with the MySQL syntax.
3055 * @param array $sqls SQL statements to combine
3056 * @param bool $all Use UNION ALL
3057 * @return string SQL fragment
3058 */
3059 public function unionQueries( $sqls, $all ) {
3060 $glue = $all ? ') UNION ALL (' : ') UNION (';
3061
3062 return '(' . implode( $glue, $sqls ) . ')';
3063 }
3064
3065 /**
3066 * Returns an SQL expression for a simple conditional. This doesn't need
3067 * to be overridden unless CASE isn't supported in your DBMS.
3068 *
3069 * @param string|array $cond SQL expression which will result in a boolean value
3070 * @param string $trueVal SQL expression to return if true
3071 * @param string $falseVal SQL expression to return if false
3072 * @return string SQL fragment
3073 */
3074 public function conditional( $cond, $trueVal, $falseVal ) {
3075 if ( is_array( $cond ) ) {
3076 $cond = $this->makeList( $cond, LIST_AND );
3077 }
3078
3079 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3080 }
3081
3082 /**
3083 * Returns a comand for str_replace function in SQL query.
3084 * Uses REPLACE() in MySQL
3085 *
3086 * @param string $orig Column to modify
3087 * @param string $old Column to seek
3088 * @param string $new Column to replace with
3089 *
3090 * @return string
3091 */
3092 public function strreplace( $orig, $old, $new ) {
3093 return "REPLACE({$orig}, {$old}, {$new})";
3094 }
3095
3096 /**
3097 * Determines how long the server has been up
3098 * STUB
3099 *
3100 * @return int
3101 */
3102 public function getServerUptime() {
3103 return 0;
3104 }
3105
3106 /**
3107 * Determines if the last failure was due to a deadlock
3108 * STUB
3109 *
3110 * @return bool
3111 */
3112 public function wasDeadlock() {
3113 return false;
3114 }
3115
3116 /**
3117 * Determines if the last failure was due to a lock timeout
3118 * STUB
3119 *
3120 * @return bool
3121 */
3122 public function wasLockTimeout() {
3123 return false;
3124 }
3125
3126 /**
3127 * Determines if the last query error was something that should be dealt
3128 * with by pinging the connection and reissuing the query.
3129 * STUB
3130 *
3131 * @return bool
3132 */
3133 public function wasErrorReissuable() {
3134 return false;
3135 }
3136
3137 /**
3138 * Determines if the last failure was due to the database being read-only.
3139 * STUB
3140 *
3141 * @return bool
3142 */
3143 public function wasReadOnlyError() {
3144 return false;
3145 }
3146
3147 /**
3148 * Perform a deadlock-prone transaction.
3149 *
3150 * This function invokes a callback function to perform a set of write
3151 * queries. If a deadlock occurs during the processing, the transaction
3152 * will be rolled back and the callback function will be called again.
3153 *
3154 * Usage:
3155 * $dbw->deadlockLoop( callback, ... );
3156 *
3157 * Extra arguments are passed through to the specified callback function.
3158 *
3159 * Returns whatever the callback function returned on its successful,
3160 * iteration, or false on error, for example if the retry limit was
3161 * reached.
3162 *
3163 * @return bool
3164 */
3165 public function deadlockLoop() {
3166 $this->begin( __METHOD__ );
3167 $args = func_get_args();
3168 $function = array_shift( $args );
3169 $oldIgnore = $this->ignoreErrors( true );
3170 $tries = self::DEADLOCK_TRIES;
3171
3172 if ( is_array( $function ) ) {
3173 $fname = $function[0];
3174 } else {
3175 $fname = $function;
3176 }
3177
3178 do {
3179 $retVal = call_user_func_array( $function, $args );
3180 $error = $this->lastError();
3181 $errno = $this->lastErrno();
3182 $sql = $this->lastQuery();
3183
3184 if ( $errno ) {
3185 if ( $this->wasDeadlock() ) {
3186 # Retry
3187 usleep( mt_rand( self::DEADLOCK_DELAY_MIN, self::DEADLOCK_DELAY_MAX ) );
3188 } else {
3189 $this->reportQueryError( $error, $errno, $sql, $fname );
3190 }
3191 }
3192 } while ( $this->wasDeadlock() && --$tries > 0 );
3193
3194 $this->ignoreErrors( $oldIgnore );
3195
3196 if ( $tries <= 0 ) {
3197 $this->rollback( __METHOD__ );
3198 $this->reportQueryError( $error, $errno, $sql, $fname );
3199
3200 return false;
3201 } else {
3202 $this->commit( __METHOD__ );
3203
3204 return $retVal;
3205 }
3206 }
3207
3208 /**
3209 * Wait for the slave to catch up to a given master position.
3210 *
3211 * @param DBMasterPos $pos
3212 * @param int $timeout The maximum number of seconds to wait for
3213 * synchronisation
3214 * @return int Zzero if the slave was past that position already,
3215 * greater than zero if we waited for some period of time, less than
3216 * zero if we timed out.
3217 */
3218 public function masterPosWait( DBMasterPos $pos, $timeout ) {
3219 # Real waits are implemented in the subclass.
3220 return 0;
3221 }
3222
3223 /**
3224 * Get the replication position of this slave
3225 *
3226 * @return DBMasterPos|bool False if this is not a slave.
3227 */
3228 public function getSlavePos() {
3229 # Stub
3230 return false;
3231 }
3232
3233 /**
3234 * Get the position of this master
3235 *
3236 * @return DBMasterPos|bool False if this is not a master
3237 */
3238 public function getMasterPos() {
3239 # Stub
3240 return false;
3241 }
3242
3243 /**
3244 * Run an anonymous function as soon as there is no transaction pending.
3245 * If there is a transaction and it is rolled back, then the callback is cancelled.
3246 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
3247 * Callbacks must commit any transactions that they begin.
3248 *
3249 * This is useful for updates to different systems or when separate transactions are needed.
3250 * For example, one might want to enqueue jobs into a system outside the database, but only
3251 * after the database is updated so that the jobs will see the data when they actually run.
3252 * It can also be used for updates that easily cause deadlocks if locks are held too long.
3253 *
3254 * @param callable $callback
3255 * @since 1.20
3256 */
3257 final public function onTransactionIdle( $callback ) {
3258 $this->mTrxIdleCallbacks[] = array( $callback, wfGetCaller() );
3259 if ( !$this->mTrxLevel ) {
3260 $this->runOnTransactionIdleCallbacks();
3261 }
3262 }
3263
3264 /**
3265 * Run an anonymous function before the current transaction commits or now if there is none.
3266 * If there is a transaction and it is rolled back, then the callback is cancelled.
3267 * Callbacks must not start nor commit any transactions.
3268 *
3269 * This is useful for updates that easily cause deadlocks if locks are held too long
3270 * but where atomicity is strongly desired for these updates and some related updates.
3271 *
3272 * @param callable $callback
3273 * @since 1.22
3274 */
3275 final public function onTransactionPreCommitOrIdle( $callback ) {
3276 if ( $this->mTrxLevel ) {
3277 $this->mTrxPreCommitCallbacks[] = array( $callback, wfGetCaller() );
3278 } else {
3279 $this->onTransactionIdle( $callback ); // this will trigger immediately
3280 }
3281 }
3282
3283 /**
3284 * Actually any "on transaction idle" callbacks.
3285 *
3286 * @since 1.20
3287 */
3288 protected function runOnTransactionIdleCallbacks() {
3289 $autoTrx = $this->getFlag( DBO_TRX ); // automatic begin() enabled?
3290
3291 $e = null; // last exception
3292 do { // callbacks may add callbacks :)
3293 $callbacks = $this->mTrxIdleCallbacks;
3294 $this->mTrxIdleCallbacks = array(); // recursion guard
3295 foreach ( $callbacks as $callback ) {
3296 try {
3297 list( $phpCallback ) = $callback;
3298 $this->clearFlag( DBO_TRX ); // make each query its own transaction
3299 call_user_func( $phpCallback );
3300 $this->setFlag( $autoTrx ? DBO_TRX : 0 ); // restore automatic begin()
3301 } catch ( Exception $e ) {
3302 }
3303 }
3304 } while ( count( $this->mTrxIdleCallbacks ) );
3305
3306 if ( $e instanceof Exception ) {
3307 throw $e; // re-throw any last exception
3308 }
3309 }
3310
3311 /**
3312 * Actually any "on transaction pre-commit" callbacks.
3313 *
3314 * @since 1.22
3315 */
3316 protected function runOnTransactionPreCommitCallbacks() {
3317 $e = null; // last exception
3318 do { // callbacks may add callbacks :)
3319 $callbacks = $this->mTrxPreCommitCallbacks;
3320 $this->mTrxPreCommitCallbacks = array(); // recursion guard
3321 foreach ( $callbacks as $callback ) {
3322 try {
3323 list( $phpCallback ) = $callback;
3324 call_user_func( $phpCallback );
3325 } catch ( Exception $e ) {
3326 }
3327 }
3328 } while ( count( $this->mTrxPreCommitCallbacks ) );
3329
3330 if ( $e instanceof Exception ) {
3331 throw $e; // re-throw any last exception
3332 }
3333 }
3334
3335 /**
3336 * Begin an atomic section of statements
3337 *
3338 * If a transaction has been started already, just keep track of the given
3339 * section name to make sure the transaction is not committed pre-maturely.
3340 * This function can be used in layers (with sub-sections), so use a stack
3341 * to keep track of the different atomic sections. If there is no transaction,
3342 * start one implicitly.
3343 *
3344 * The goal of this function is to create an atomic section of SQL queries
3345 * without having to start a new transaction if it already exists.
3346 *
3347 * Atomic sections are more strict than transactions. With transactions,
3348 * attempting to begin a new transaction when one is already running results
3349 * in MediaWiki issuing a brief warning and doing an implicit commit. All
3350 * atomic levels *must* be explicitly closed using DatabaseBase::endAtomic(),
3351 * and any database transactions cannot be began or committed until all atomic
3352 * levels are closed. There is no such thing as implicitly opening or closing
3353 * an atomic section.
3354 *
3355 * @since 1.23
3356 * @param string $fname
3357 * @throws DBError
3358 */
3359 final public function startAtomic( $fname = __METHOD__ ) {
3360 if ( !$this->mTrxLevel ) {
3361 $this->begin( $fname );
3362 $this->mTrxAutomatic = true;
3363 $this->mTrxAutomaticAtomic = true;
3364 }
3365
3366 $this->mTrxAtomicLevels->push( $fname );
3367 }
3368
3369 /**
3370 * Ends an atomic section of SQL statements
3371 *
3372 * Ends the next section of atomic SQL statements and commits the transaction
3373 * if necessary.
3374 *
3375 * @since 1.23
3376 * @see DatabaseBase::startAtomic
3377 * @param string $fname
3378 * @throws DBError
3379 */
3380 final public function endAtomic( $fname = __METHOD__ ) {
3381 if ( !$this->mTrxLevel ) {
3382 throw new DBUnexpectedError( $this, 'No atomic transaction is open.' );
3383 }
3384 if ( $this->mTrxAtomicLevels->isEmpty() ||
3385 $this->mTrxAtomicLevels->pop() !== $fname
3386 ) {
3387 throw new DBUnexpectedError( $this, 'Invalid atomic section ended.' );
3388 }
3389
3390 if ( $this->mTrxAtomicLevels->isEmpty() && $this->mTrxAutomaticAtomic ) {
3391 $this->commit( $fname, 'flush' );
3392 }
3393 }
3394
3395 /**
3396 * Begin a transaction. If a transaction is already in progress,
3397 * that transaction will be committed before the new transaction is started.
3398 *
3399 * Note that when the DBO_TRX flag is set (which is usually the case for web
3400 * requests, but not for maintenance scripts), any previous database query
3401 * will have started a transaction automatically.
3402 *
3403 * Nesting of transactions is not supported. Attempts to nest transactions
3404 * will cause a warning, unless the current transaction was started
3405 * automatically because of the DBO_TRX flag.
3406 *
3407 * @param string $fname
3408 * @throws DBError
3409 */
3410 final public function begin( $fname = __METHOD__ ) {
3411 global $wgDebugDBTransactions;
3412
3413 if ( $this->mTrxLevel ) { // implicit commit
3414 if ( !$this->mTrxAtomicLevels->isEmpty() ) {
3415 // If the current transaction was an automatic atomic one, then we definitely have
3416 // a problem. Same if there is any unclosed atomic level.
3417 throw new DBUnexpectedError( $this,
3418 "Attempted to start explicit transaction when atomic levels are still open."
3419 );
3420 } elseif ( !$this->mTrxAutomatic ) {
3421 // We want to warn about inadvertently nested begin/commit pairs, but not about
3422 // auto-committing implicit transactions that were started by query() via DBO_TRX
3423 $msg = "$fname: Transaction already in progress (from {$this->mTrxFname}), " .
3424 " performing implicit commit!";
3425 wfWarn( $msg );
3426 wfLogDBError( $msg );
3427 } else {
3428 // if the transaction was automatic and has done write operations,
3429 // log it if $wgDebugDBTransactions is enabled.
3430 if ( $this->mTrxDoneWrites && $wgDebugDBTransactions ) {
3431 wfDebug( "$fname: Automatic transaction with writes in progress" .
3432 " (from {$this->mTrxFname}), performing implicit commit!\n"
3433 );
3434 }
3435 }
3436
3437 $this->runOnTransactionPreCommitCallbacks();
3438 $this->doCommit( $fname );
3439 if ( $this->mTrxDoneWrites ) {
3440 Profiler::instance()->transactionWritingOut(
3441 $this->mServer, $this->mDBname, $this->mTrxShortId );
3442 }
3443 $this->runOnTransactionIdleCallbacks();
3444 }
3445
3446 # Avoid fatals if close() was called
3447 if ( !$this->isOpen() ) {
3448 throw new DBUnexpectedError( $this, "DB connection was already closed." );
3449 }
3450
3451 $this->doBegin( $fname );
3452 $this->mTrxFname = $fname;
3453 $this->mTrxDoneWrites = false;
3454 $this->mTrxAutomatic = false;
3455 $this->mTrxAutomaticAtomic = false;
3456 $this->mTrxAtomicLevels = new SplStack;
3457 $this->mTrxIdleCallbacks = array();
3458 $this->mTrxPreCommitCallbacks = array();
3459 $this->mTrxShortId = wfRandomString( 12 );
3460 }
3461
3462 /**
3463 * Issues the BEGIN command to the database server.
3464 *
3465 * @see DatabaseBase::begin()
3466 * @param string $fname
3467 */
3468 protected function doBegin( $fname ) {
3469 $this->query( 'BEGIN', $fname );
3470 $this->mTrxLevel = 1;
3471 }
3472
3473 /**
3474 * Commits a transaction previously started using begin().
3475 * If no transaction is in progress, a warning is issued.
3476 *
3477 * Nesting of transactions is not supported.
3478 *
3479 * @param string $fname
3480 * @param string $flush Flush flag, set to 'flush' to disable warnings about
3481 * explicitly committing implicit transactions, or calling commit when no
3482 * transaction is in progress. This will silently break any ongoing
3483 * explicit transaction. Only set the flush flag if you are sure that it
3484 * is safe to ignore these warnings in your context.
3485 * @throws DBUnexpectedError
3486 */
3487 final public function commit( $fname = __METHOD__, $flush = '' ) {
3488 if ( !$this->mTrxAtomicLevels->isEmpty() ) {
3489 // There are still atomic sections open. This cannot be ignored
3490 throw new DBUnexpectedError(
3491 $this,
3492 "Attempted to commit transaction while atomic sections are still open"
3493 );
3494 }
3495
3496 if ( $flush === 'flush' ) {
3497 if ( !$this->mTrxLevel ) {
3498 return; // nothing to do
3499 } elseif ( !$this->mTrxAutomatic ) {
3500 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3501 }
3502 } else {
3503 if ( !$this->mTrxLevel ) {
3504 wfWarn( "$fname: No transaction to commit, something got out of sync!" );
3505 return; // nothing to do
3506 } elseif ( $this->mTrxAutomatic ) {
3507 wfWarn( "$fname: Explicit commit of implicit transaction. Something may be out of sync!" );
3508 }
3509 }
3510
3511 # Avoid fatals if close() was called
3512 if ( !$this->isOpen() ) {
3513 throw new DBUnexpectedError( $this, "DB connection was already closed." );
3514 }
3515
3516 $this->runOnTransactionPreCommitCallbacks();
3517 $this->doCommit( $fname );
3518 if ( $this->mTrxDoneWrites ) {
3519 Profiler::instance()->transactionWritingOut(
3520 $this->mServer, $this->mDBname, $this->mTrxShortId );
3521 }
3522 $this->runOnTransactionIdleCallbacks();
3523 }
3524
3525 /**
3526 * Issues the COMMIT command to the database server.
3527 *
3528 * @see DatabaseBase::commit()
3529 * @param string $fname
3530 */
3531 protected function doCommit( $fname ) {
3532 if ( $this->mTrxLevel ) {
3533 $this->query( 'COMMIT', $fname );
3534 $this->mTrxLevel = 0;
3535 }
3536 }
3537
3538 /**
3539 * Rollback a transaction previously started using begin().
3540 * If no transaction is in progress, a warning is issued.
3541 *
3542 * No-op on non-transactional databases.
3543 *
3544 * @param string $fname
3545 * @param string $flush Flush flag, set to 'flush' to disable warnings about
3546 * calling rollback when no transaction is in progress. This will silently
3547 * break any ongoing explicit transaction. Only set the flush flag if you
3548 * are sure that it is safe to ignore these warnings in your context.
3549 * @since 1.23 Added $flush parameter
3550 */
3551 final public function rollback( $fname = __METHOD__, $flush = '' ) {
3552 if ( $flush !== 'flush' ) {
3553 if ( !$this->mTrxLevel ) {
3554 wfWarn( "$fname: No transaction to rollback, something got out of sync!" );
3555 return; // nothing to do
3556 } elseif ( $this->mTrxAutomatic ) {
3557 wfWarn( "$fname: Explicit rollback of implicit transaction. Something may be out of sync!" );
3558 }
3559 } else {
3560 if ( !$this->mTrxLevel ) {
3561 return; // nothing to do
3562 } elseif ( !$this->mTrxAutomatic ) {
3563 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3564 }
3565 }
3566
3567 # Avoid fatals if close() was called
3568 if ( !$this->isOpen() ) {
3569 throw new DBUnexpectedError( $this, "DB connection was already closed." );
3570 }
3571
3572 $this->doRollback( $fname );
3573 $this->mTrxIdleCallbacks = array(); // cancel
3574 $this->mTrxPreCommitCallbacks = array(); // cancel
3575 $this->mTrxAtomicLevels = new SplStack;
3576 if ( $this->mTrxDoneWrites ) {
3577 Profiler::instance()->transactionWritingOut(
3578 $this->mServer, $this->mDBname, $this->mTrxShortId );
3579 }
3580 }
3581
3582 /**
3583 * Issues the ROLLBACK command to the database server.
3584 *
3585 * @see DatabaseBase::rollback()
3586 * @param string $fname
3587 */
3588 protected function doRollback( $fname ) {
3589 if ( $this->mTrxLevel ) {
3590 $this->query( 'ROLLBACK', $fname, true );
3591 $this->mTrxLevel = 0;
3592 }
3593 }
3594
3595 /**
3596 * Creates a new table with structure copied from existing table
3597 * Note that unlike most database abstraction functions, this function does not
3598 * automatically append database prefix, because it works at a lower
3599 * abstraction level.
3600 * The table names passed to this function shall not be quoted (this
3601 * function calls addIdentifierQuotes when needed).
3602 *
3603 * @param string $oldName Name of table whose structure should be copied
3604 * @param string $newName Name of table to be created
3605 * @param bool $temporary Whether the new table should be temporary
3606 * @param string $fname Calling function name
3607 * @throws MWException
3608 * @return bool True if operation was successful
3609 */
3610 public function duplicateTableStructure( $oldName, $newName, $temporary = false,
3611 $fname = __METHOD__
3612 ) {
3613 throw new MWException(
3614 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
3615 }
3616
3617 /**
3618 * List all tables on the database
3619 *
3620 * @param string $prefix Only show tables with this prefix, e.g. mw_
3621 * @param string $fname Calling function name
3622 * @throws MWException
3623 */
3624 function listTables( $prefix = null, $fname = __METHOD__ ) {
3625 throw new MWException( 'DatabaseBase::listTables is not implemented in descendant class' );
3626 }
3627
3628 /**
3629 * Reset the views process cache set by listViews()
3630 * @since 1.22
3631 */
3632 final public function clearViewsCache() {
3633 $this->allViews = null;
3634 }
3635
3636 /**
3637 * Lists all the VIEWs in the database
3638 *
3639 * For caching purposes the list of all views should be stored in
3640 * $this->allViews. The process cache can be cleared with clearViewsCache()
3641 *
3642 * @param string $prefix Only show VIEWs with this prefix, eg. unit_test_
3643 * @param string $fname Name of calling function
3644 * @throws MWException
3645 * @since 1.22
3646 */
3647 public function listViews( $prefix = null, $fname = __METHOD__ ) {
3648 throw new MWException( 'DatabaseBase::listViews is not implemented in descendant class' );
3649 }
3650
3651 /**
3652 * Differentiates between a TABLE and a VIEW
3653 *
3654 * @param string $name Name of the database-structure to test.
3655 * @throws MWException
3656 * @since 1.22
3657 */
3658 public function isView( $name ) {
3659 throw new MWException( 'DatabaseBase::isView is not implemented in descendant class' );
3660 }
3661
3662 /**
3663 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3664 * to the format used for inserting into timestamp fields in this DBMS.
3665 *
3666 * The result is unquoted, and needs to be passed through addQuotes()
3667 * before it can be included in raw SQL.
3668 *
3669 * @param string|int $ts
3670 *
3671 * @return string
3672 */
3673 public function timestamp( $ts = 0 ) {
3674 return wfTimestamp( TS_MW, $ts );
3675 }
3676
3677 /**
3678 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3679 * to the format used for inserting into timestamp fields in this DBMS. If
3680 * NULL is input, it is passed through, allowing NULL values to be inserted
3681 * into timestamp fields.
3682 *
3683 * The result is unquoted, and needs to be passed through addQuotes()
3684 * before it can be included in raw SQL.
3685 *
3686 * @param string|int $ts
3687 *
3688 * @return string
3689 */
3690 public function timestampOrNull( $ts = null ) {
3691 if ( is_null( $ts ) ) {
3692 return null;
3693 } else {
3694 return $this->timestamp( $ts );
3695 }
3696 }
3697
3698 /**
3699 * Take the result from a query, and wrap it in a ResultWrapper if
3700 * necessary. Boolean values are passed through as is, to indicate success
3701 * of write queries or failure.
3702 *
3703 * Once upon a time, DatabaseBase::query() returned a bare MySQL result
3704 * resource, and it was necessary to call this function to convert it to
3705 * a wrapper. Nowadays, raw database objects are never exposed to external
3706 * callers, so this is unnecessary in external code. For compatibility with
3707 * old code, ResultWrapper objects are passed through unaltered.
3708 *
3709 * @param bool|ResultWrapper|resource $result
3710 * @return bool|ResultWrapper
3711 */
3712 public function resultObject( $result ) {
3713 if ( empty( $result ) ) {
3714 return false;
3715 } elseif ( $result instanceof ResultWrapper ) {
3716 return $result;
3717 } elseif ( $result === true ) {
3718 // Successful write query
3719 return $result;
3720 } else {
3721 return new ResultWrapper( $this, $result );
3722 }
3723 }
3724
3725 /**
3726 * Ping the server and try to reconnect if it there is no connection
3727 *
3728 * @return bool Success or failure
3729 */
3730 public function ping() {
3731 # Stub. Not essential to override.
3732 return true;
3733 }
3734
3735 /**
3736 * Get slave lag. Currently supported only by MySQL.
3737 *
3738 * Note that this function will generate a fatal error on many
3739 * installations. Most callers should use LoadBalancer::safeGetLag()
3740 * instead.
3741 *
3742 * @return int Database replication lag in seconds
3743 */
3744 public function getLag() {
3745 return 0;
3746 }
3747
3748 /**
3749 * Return the maximum number of items allowed in a list, or 0 for unlimited.
3750 *
3751 * @return int
3752 */
3753 function maxListLen() {
3754 return 0;
3755 }
3756
3757 /**
3758 * Some DBMSs have a special format for inserting into blob fields, they
3759 * don't allow simple quoted strings to be inserted. To insert into such
3760 * a field, pass the data through this function before passing it to
3761 * DatabaseBase::insert().
3762 *
3763 * @param string $b
3764 * @return string
3765 */
3766 public function encodeBlob( $b ) {
3767 return $b;
3768 }
3769
3770 /**
3771 * Some DBMSs return a special placeholder object representing blob fields
3772 * in result objects. Pass the object through this function to return the
3773 * original string.
3774 *
3775 * @param string $b
3776 * @return string
3777 */
3778 public function decodeBlob( $b ) {
3779 return $b;
3780 }
3781
3782 /**
3783 * Override database's default behavior. $options include:
3784 * 'connTimeout' : Set the connection timeout value in seconds.
3785 * May be useful for very long batch queries such as
3786 * full-wiki dumps, where a single query reads out over
3787 * hours or days.
3788 *
3789 * @param array $options
3790 * @return void
3791 */
3792 public function setSessionOptions( array $options ) {
3793 }
3794
3795 /**
3796 * Read and execute SQL commands from a file.
3797 *
3798 * Returns true on success, error string or exception on failure (depending
3799 * on object's error ignore settings).
3800 *
3801 * @param string $filename File name to open
3802 * @param bool|callable $lineCallback Optional function called before reading each line
3803 * @param bool|callable $resultCallback Optional function called for each MySQL result
3804 * @param bool|string $fname Calling function name or false if name should be
3805 * generated dynamically using $filename
3806 * @param bool|callable $inputCallback Optional function called for each
3807 * complete line sent
3808 * @throws Exception|MWException
3809 * @return bool|string
3810 */
3811 public function sourceFile(
3812 $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false
3813 ) {
3814 wfSuppressWarnings();
3815 $fp = fopen( $filename, 'r' );
3816 wfRestoreWarnings();
3817
3818 if ( false === $fp ) {
3819 throw new MWException( "Could not open \"{$filename}\".\n" );
3820 }
3821
3822 if ( !$fname ) {
3823 $fname = __METHOD__ . "( $filename )";
3824 }
3825
3826 try {
3827 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3828 } catch ( MWException $e ) {
3829 fclose( $fp );
3830 throw $e;
3831 }
3832
3833 fclose( $fp );
3834
3835 return $error;
3836 }
3837
3838 /**
3839 * Get the full path of a patch file. Originally based on archive()
3840 * from updaters.inc. Keep in mind this always returns a patch, as
3841 * it fails back to MySQL if no DB-specific patch can be found
3842 *
3843 * @param string $patch The name of the patch, like patch-something.sql
3844 * @return string Full path to patch file
3845 */
3846 public function patchPath( $patch ) {
3847 global $IP;
3848
3849 $dbType = $this->getType();
3850 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
3851 return "$IP/maintenance/$dbType/archives/$patch";
3852 } else {
3853 return "$IP/maintenance/archives/$patch";
3854 }
3855 }
3856
3857 /**
3858 * Set variables to be used in sourceFile/sourceStream, in preference to the
3859 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
3860 * all. If it's set to false, $GLOBALS will be used.
3861 *
3862 * @param bool|array $vars Mapping variable name to value.
3863 */
3864 public function setSchemaVars( $vars ) {
3865 $this->mSchemaVars = $vars;
3866 }
3867
3868 /**
3869 * Read and execute commands from an open file handle.
3870 *
3871 * Returns true on success, error string or exception on failure (depending
3872 * on object's error ignore settings).
3873 *
3874 * @param resource $fp File handle
3875 * @param bool|callable $lineCallback Optional function called before reading each query
3876 * @param bool|callable $resultCallback Optional function called for each MySQL result
3877 * @param string $fname Calling function name
3878 * @param bool|callable $inputCallback Optional function called for each complete query sent
3879 * @return bool|string
3880 */
3881 public function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
3882 $fname = __METHOD__, $inputCallback = false
3883 ) {
3884 $cmd = '';
3885
3886 while ( !feof( $fp ) ) {
3887 if ( $lineCallback ) {
3888 call_user_func( $lineCallback );
3889 }
3890
3891 $line = trim( fgets( $fp ) );
3892
3893 if ( $line == '' ) {
3894 continue;
3895 }
3896
3897 if ( '-' == $line[0] && '-' == $line[1] ) {
3898 continue;
3899 }
3900
3901 if ( $cmd != '' ) {
3902 $cmd .= ' ';
3903 }
3904
3905 $done = $this->streamStatementEnd( $cmd, $line );
3906
3907 $cmd .= "$line\n";
3908
3909 if ( $done || feof( $fp ) ) {
3910 $cmd = $this->replaceVars( $cmd );
3911
3912 if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) || !$inputCallback ) {
3913 $res = $this->query( $cmd, $fname );
3914
3915 if ( $resultCallback ) {
3916 call_user_func( $resultCallback, $res, $this );
3917 }
3918
3919 if ( false === $res ) {
3920 $err = $this->lastError();
3921
3922 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3923 }
3924 }
3925 $cmd = '';
3926 }
3927 }
3928
3929 return true;
3930 }
3931
3932 /**
3933 * Called by sourceStream() to check if we've reached a statement end
3934 *
3935 * @param string $sql SQL assembled so far
3936 * @param string $newLine New line about to be added to $sql
3937 * @return bool Whether $newLine contains end of the statement
3938 */
3939 public function streamStatementEnd( &$sql, &$newLine ) {
3940 if ( $this->delimiter ) {
3941 $prev = $newLine;
3942 $newLine = preg_replace( '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine );
3943 if ( $newLine != $prev ) {
3944 return true;
3945 }
3946 }
3947
3948 return false;
3949 }
3950
3951 /**
3952 * Database independent variable replacement. Replaces a set of variables
3953 * in an SQL statement with their contents as given by $this->getSchemaVars().
3954 *
3955 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3956 *
3957 * - '{$var}' should be used for text and is passed through the database's
3958 * addQuotes method.
3959 * - `{$var}` should be used for identifiers (eg: table and database names),
3960 * it is passed through the database's addIdentifierQuotes method which
3961 * can be overridden if the database uses something other than backticks.
3962 * - / *$var* / is just encoded, besides traditional table prefix and
3963 * table options its use should be avoided.
3964 *
3965 * @param string $ins SQL statement to replace variables in
3966 * @return string The new SQL statement with variables replaced
3967 */
3968 protected function replaceSchemaVars( $ins ) {
3969 $vars = $this->getSchemaVars();
3970 foreach ( $vars as $var => $value ) {
3971 // replace '{$var}'
3972 $ins = str_replace( '\'{$' . $var . '}\'', $this->addQuotes( $value ), $ins );
3973 // replace `{$var}`
3974 $ins = str_replace( '`{$' . $var . '}`', $this->addIdentifierQuotes( $value ), $ins );
3975 // replace /*$var*/
3976 $ins = str_replace( '/*$' . $var . '*/', $this->strencode( $value ), $ins );
3977 }
3978
3979 return $ins;
3980 }
3981
3982 /**
3983 * Replace variables in sourced SQL
3984 *
3985 * @param string $ins
3986 * @return string
3987 */
3988 protected function replaceVars( $ins ) {
3989 $ins = $this->replaceSchemaVars( $ins );
3990
3991 // Table prefixes
3992 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
3993 array( $this, 'tableNameCallback' ), $ins );
3994
3995 // Index names
3996 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
3997 array( $this, 'indexNameCallback' ), $ins );
3998
3999 return $ins;
4000 }
4001
4002 /**
4003 * Get schema variables. If none have been set via setSchemaVars(), then
4004 * use some defaults from the current object.
4005 *
4006 * @return array
4007 */
4008 protected function getSchemaVars() {
4009 if ( $this->mSchemaVars ) {
4010 return $this->mSchemaVars;
4011 } else {
4012 return $this->getDefaultSchemaVars();
4013 }
4014 }
4015
4016 /**
4017 * Get schema variables to use if none have been set via setSchemaVars().
4018 *
4019 * Override this in derived classes to provide variables for tables.sql
4020 * and SQL patch files.
4021 *
4022 * @return array
4023 */
4024 protected function getDefaultSchemaVars() {
4025 return array();
4026 }
4027
4028 /**
4029 * Table name callback
4030 *
4031 * @param array $matches
4032 * @return string
4033 */
4034 protected function tableNameCallback( $matches ) {
4035 return $this->tableName( $matches[1] );
4036 }
4037
4038 /**
4039 * Index name callback
4040 *
4041 * @param array $matches
4042 * @return string
4043 */
4044 protected function indexNameCallback( $matches ) {
4045 return $this->indexName( $matches[1] );
4046 }
4047
4048 /**
4049 * Check to see if a named lock is available. This is non-blocking.
4050 *
4051 * @param string $lockName Name of lock to poll
4052 * @param string $method Name of method calling us
4053 * @return bool
4054 * @since 1.20
4055 */
4056 public function lockIsFree( $lockName, $method ) {
4057 return true;
4058 }
4059
4060 /**
4061 * Acquire a named lock
4062 *
4063 * Abstracted from Filestore::lock() so child classes can implement for
4064 * their own needs.
4065 *
4066 * @param string $lockName Name of lock to aquire
4067 * @param string $method Name of method calling us
4068 * @param int $timeout
4069 * @return bool
4070 */
4071 public function lock( $lockName, $method, $timeout = 5 ) {
4072 return true;
4073 }
4074
4075 /**
4076 * Release a lock.
4077 *
4078 * @param string $lockName Name of lock to release
4079 * @param string $method Name of method calling us
4080 *
4081 * @return int Returns 1 if the lock was released, 0 if the lock was not established
4082 * by this thread (in which case the lock is not released), and NULL if the named
4083 * lock did not exist
4084 */
4085 public function unlock( $lockName, $method ) {
4086 return true;
4087 }
4088
4089 /**
4090 * Lock specific tables
4091 *
4092 * @param array $read Array of tables to lock for read access
4093 * @param array $write Array of tables to lock for write access
4094 * @param string $method Name of caller
4095 * @param bool $lowPriority Whether to indicate writes to be LOW PRIORITY
4096 * @return bool
4097 */
4098 public function lockTables( $read, $write, $method, $lowPriority = true ) {
4099 return true;
4100 }
4101
4102 /**
4103 * Unlock specific tables
4104 *
4105 * @param string $method The caller
4106 * @return bool
4107 */
4108 public function unlockTables( $method ) {
4109 return true;
4110 }
4111
4112 /**
4113 * Delete a table
4114 * @param string $tableName
4115 * @param string $fName
4116 * @return bool|ResultWrapper
4117 * @since 1.18
4118 */
4119 public function dropTable( $tableName, $fName = __METHOD__ ) {
4120 if ( !$this->tableExists( $tableName, $fName ) ) {
4121 return false;
4122 }
4123 $sql = "DROP TABLE " . $this->tableName( $tableName );
4124 if ( $this->cascadingDeletes() ) {
4125 $sql .= " CASCADE";
4126 }
4127
4128 return $this->query( $sql, $fName );
4129 }
4130
4131 /**
4132 * Get search engine class. All subclasses of this need to implement this
4133 * if they wish to use searching.
4134 *
4135 * @return string
4136 */
4137 public function getSearchEngine() {
4138 return 'SearchEngineDummy';
4139 }
4140
4141 /**
4142 * Find out when 'infinity' is. Most DBMSes support this. This is a special
4143 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
4144 * because "i" sorts after all numbers.
4145 *
4146 * @return string
4147 */
4148 public function getInfinity() {
4149 return 'infinity';
4150 }
4151
4152 /**
4153 * Encode an expiry time into the DBMS dependent format
4154 *
4155 * @param string $expiry Timestamp for expiry, or the 'infinity' string
4156 * @return string
4157 */
4158 public function encodeExpiry( $expiry ) {
4159 return ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() )
4160 ? $this->getInfinity()
4161 : $this->timestamp( $expiry );
4162 }
4163
4164 /**
4165 * Decode an expiry time into a DBMS independent format
4166 *
4167 * @param string $expiry DB timestamp field value for expiry
4168 * @param int $format TS_* constant, defaults to TS_MW
4169 * @return string
4170 */
4171 public function decodeExpiry( $expiry, $format = TS_MW ) {
4172 return ( $expiry == '' || $expiry == $this->getInfinity() )
4173 ? 'infinity'
4174 : wfTimestamp( $format, $expiry );
4175 }
4176
4177 /**
4178 * Allow or deny "big selects" for this session only. This is done by setting
4179 * the sql_big_selects session variable.
4180 *
4181 * This is a MySQL-specific feature.
4182 *
4183 * @param bool|string $value True for allow, false for deny, or "default" to
4184 * restore the initial value
4185 */
4186 public function setBigSelects( $value = true ) {
4187 // no-op
4188 }
4189
4190 /**
4191 * @since 1.19
4192 */
4193 public function __toString() {
4194 return (string)$this->mConn;
4195 }
4196
4197 /**
4198 * Run a few simple sanity checks
4199 */
4200 public function __destruct() {
4201 if ( $this->mTrxLevel && $this->mTrxDoneWrites ) {
4202 trigger_error( "Uncommitted DB writes (transaction from {$this->mTrxFname})." );
4203 }
4204 if ( count( $this->mTrxIdleCallbacks ) || count( $this->mTrxPreCommitCallbacks ) ) {
4205 $callers = array();
4206 foreach ( $this->mTrxIdleCallbacks as $callbackInfo ) {
4207 $callers[] = $callbackInfo[1];
4208 }
4209 $callers = implode( ', ', $callers );
4210 trigger_error( "DB transaction callbacks still pending (from $callers)." );
4211 }
4212 }
4213 }