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