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