3 * @defgroup Database Database
7 * This file deals with database interface functions
8 * and query specifics/optimisations
11 /** Number of times to re-try an operation in case of deadlock */
12 define( 'DEADLOCK_TRIES', 4 );
13 /** Minimum time to wait before retry, in microseconds */
14 define( 'DEADLOCK_DELAY_MIN', 500000 );
15 /** Maximum time to wait before retry */
16 define( 'DEADLOCK_DELAY_MAX', 1500000 );
19 * Database abstraction object
22 abstract class DatabaseBase
{
24 #------------------------------------------------------------------------------
26 #------------------------------------------------------------------------------
28 protected $mLastQuery = '';
29 protected $mDoneWrites = false;
30 protected $mPHPError = false;
32 protected $mServer, $mUser, $mPassword, $mConn = null, $mDBname;
33 protected $mOpened = false;
35 protected $mFailFunction;
36 protected $mTablePrefix;
38 protected $mTrxLevel = 0;
39 protected $mErrorCount = 0;
40 protected $mLBInfo = array();
41 protected $mFakeSlaveLag = null, $mFakeMaster = false;
42 protected $mDefaultBigSelects = null;
44 #------------------------------------------------------------------------------
46 #------------------------------------------------------------------------------
47 # These optionally set a variable and return the previous state
50 * Fail function, takes a Database as a parameter
51 * Set to false for default, 1 for ignore errors
53 function failFunction( $function = null ) {
54 return wfSetVar( $this->mFailFunction
, $function );
58 * Boolean, controls output of large amounts of debug information
60 function debug( $debug = null ) {
61 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
65 * Turns buffering of SQL result sets on (true) or off (false).
66 * Default is "on" and it should not be changed without good reasons.
68 function bufferResults( $buffer = null ) {
69 if ( is_null( $buffer ) ) {
70 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
72 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
77 * Turns on (false) or off (true) the automatic generation and sending
78 * of a "we're sorry, but there has been a database error" page on
79 * database errors. Default is on (false). When turned off, the
80 * code should use lastErrno() and lastError() to handle the
81 * situation as appropriate.
83 function ignoreErrors( $ignoreErrors = null ) {
84 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
88 * The current depth of nested transactions
89 * @param $level Integer: , default NULL.
91 function trxLevel( $level = null ) {
92 return wfSetVar( $this->mTrxLevel
, $level );
96 * Number of errors logged, only useful when errors are ignored
98 function errorCount( $count = null ) {
99 return wfSetVar( $this->mErrorCount
, $count );
102 function tablePrefix( $prefix = null ) {
103 return wfSetVar( $this->mTablePrefix
, $prefix );
107 * Properties passed down from the server info array of the load balancer
109 function getLBInfo( $name = null ) {
110 if ( is_null( $name ) ) {
111 return $this->mLBInfo
;
113 if ( array_key_exists( $name, $this->mLBInfo
) ) {
114 return $this->mLBInfo
[$name];
121 function setLBInfo( $name, $value = null ) {
122 if ( is_null( $value ) ) {
123 $this->mLBInfo
= $name;
125 $this->mLBInfo
[$name] = $value;
130 * Set lag time in seconds for a fake slave
132 function setFakeSlaveLag( $lag ) {
133 $this->mFakeSlaveLag
= $lag;
137 * Make this connection a fake master
139 function setFakeMaster( $enabled = true ) {
140 $this->mFakeMaster
= $enabled;
144 * Returns true if this database supports (and uses) cascading deletes
146 function cascadingDeletes() {
151 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
153 function cleanupTriggers() {
158 * Returns true if this database is strict about what can be put into an IP field.
159 * Specifically, it uses a NULL value instead of an empty string.
161 function strictIPs() {
166 * Returns true if this database uses timestamps rather than integers
168 function realTimestamps() {
173 * Returns true if this database does an implicit sort when doing GROUP BY
175 function implicitGroupby() {
180 * Returns true if this database does an implicit order by when the column has an index
181 * For example: SELECT page_title FROM page LIMIT 1
183 function implicitOrderby() {
188 * Returns true if this database requires that SELECT DISTINCT queries require that all
189 ORDER BY expressions occur in the SELECT list per the SQL92 standard
191 function standardSelectDistinct() {
196 * Returns true if this database can do a native search on IP columns
197 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
199 function searchableIPs() {
204 * Returns true if this database can use functional indexes
206 function functionalIndexes() {
211 * Return the last query that went through Database::query()
214 function lastQuery() { return $this->mLastQuery
; }
218 * Returns true if the connection may have been used for write queries.
219 * Should return true if unsure.
221 function doneWrites() { return $this->mDoneWrites
; }
224 * Is a connection to the database open?
227 function isOpen() { return $this->mOpened
; }
230 * Set a flag for this connection
232 * @param $flag Integer: DBO_* constants from Defines.php:
233 * - DBO_DEBUG: output some debug info (same as debug())
234 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
235 * - DBO_IGNORE: ignore errors (same as ignoreErrors())
236 * - DBO_TRX: automatically start transactions
237 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
238 * and removes it in command line mode
239 * - DBO_PERSISTENT: use persistant database connection
241 function setFlag( $flag ) {
242 $this->mFlags |
= $flag;
246 * Clear a flag for this connection
248 * @param $flag: same as setFlag()'s $flag param
250 function clearFlag( $flag ) {
251 $this->mFlags
&= ~
$flag;
255 * Returns a boolean whether the flag $flag is set for this connection
257 * @param $flag: same as setFlag()'s $flag param
260 function getFlag( $flag ) {
261 return !!($this->mFlags
& $flag);
265 * General read-only accessor
267 function getProperty( $name ) {
271 function getWikiID() {
272 if( $this->mTablePrefix
) {
273 return "{$this->mDBname}-{$this->mTablePrefix}";
275 return $this->mDBname
;
280 * Get the type of the DBMS, as it appears in $wgDBtype.
282 abstract function getType();
284 #------------------------------------------------------------------------------
286 #------------------------------------------------------------------------------
290 * @param $server String: database server host
291 * @param $user String: database user name
292 * @param $password String: database user password
293 * @param $dbName String: database name
294 * @param $failFunction
296 * @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
298 function __construct( $server = false, $user = false, $password = false, $dbName = false,
299 $failFunction = false, $flags = 0, $tablePrefix = 'get from global' ) {
301 global $wgOut, $wgDBprefix, $wgCommandLineMode;
302 # Can't get a reference if it hasn't been set yet
303 if ( !isset( $wgOut ) ) {
307 $this->mFailFunction
= $failFunction;
308 $this->mFlags
= $flags;
310 if ( $this->mFlags
& DBO_DEFAULT
) {
311 if ( $wgCommandLineMode ) {
312 $this->mFlags
&= ~DBO_TRX
;
314 $this->mFlags |
= DBO_TRX
;
319 // Faster read-only access
320 if ( wfReadOnly() ) {
321 $this->mFlags |= DBO_PERSISTENT;
322 $this->mFlags &= ~DBO_TRX;
325 /** Get the default table prefix*/
326 if ( $tablePrefix == 'get from global' ) {
327 $this->mTablePrefix
= $wgDBprefix;
329 $this->mTablePrefix
= $tablePrefix;
333 $this->open( $server, $user, $password, $dbName );
338 * Same as new DatabaseMysql( ... ), kept for backward compatibility
339 * @param $server String: database server host
340 * @param $user String: database user name
341 * @param $password String: database user password
342 * @param $dbName String: database name
343 * @param failFunction
346 static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0 )
348 wfDeprecated( __METHOD__
);
349 return new DatabaseMysql( $server, $user, $password, $dbName, $failFunction, $flags );
353 * Usually aborts on failure
354 * If the failFunction is set to a non-zero integer, returns success
355 * @param $server String: database server host
356 * @param $user String: database user name
357 * @param $password String: database user password
358 * @param $dbName String: database name
360 abstract function open( $server, $user, $password, $dbName );
362 protected function installErrorHandler() {
363 $this->mPHPError
= false;
364 $this->htmlErrors
= ini_set( 'html_errors', '0' );
365 set_error_handler( array( $this, 'connectionErrorHandler' ) );
368 protected function restoreErrorHandler() {
369 restore_error_handler();
370 if ( $this->htmlErrors
!== false ) {
371 ini_set( 'html_errors', $this->htmlErrors
);
373 if ( $this->mPHPError
) {
374 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError
);
375 $error = preg_replace( '!^.*?:(.*)$!', '$1', $error );
382 protected function connectionErrorHandler( $errno, $errstr ) {
383 $this->mPHPError
= $errstr;
387 * Closes a database connection.
388 * if it is open : commits any open transactions
390 * @return Bool operation success. true if already closed.
393 # Stub, should probably be overridden
398 * @param $error String: fallback error message, used if none is given by DB
400 function reportConnectionError( $error = 'Unknown error' ) {
401 $myError = $this->lastError();
406 if ( $this->mFailFunction
) {
407 # Legacy error handling method
408 if ( !is_int( $this->mFailFunction
) ) {
409 $ff = $this->mFailFunction
;
410 $ff( $this, $error );
414 throw new DBConnectionError( $this, $error );
419 * Determine whether a query writes to the DB.
420 * Should return true if unsure.
422 function isWriteQuery( $sql ) {
423 return !preg_match( '/^(?:SELECT|BEGIN|COMMIT|SET|SHOW|\(SELECT)\b/i', $sql );
427 * Usually aborts on failure. If errors are explicitly ignored, returns success.
429 * @param $sql String: SQL query
430 * @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
431 * comment (you can use __METHOD__ or add some extra info)
432 * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors...
433 * maybe best to catch the exception instead?
434 * @return true for a successful write query, ResultWrapper object for a successful read query,
435 * or false on failure if $tempIgnore set
436 * @throws DBQueryError Thrown when the database returns an error of any kind
438 public function query( $sql, $fname = '', $tempIgnore = false ) {
441 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
442 if ( isset( $wgProfiler ) ) {
443 # generalizeSQL will probably cut down the query to reasonable
444 # logging size most of the time. The substr is really just a sanity check.
446 # Who's been wasting my precious column space? -- TS
447 #$profName = 'query: ' . $fname . ' ' . substr( Database::generalizeSQL( $sql ), 0, 255 );
450 $queryProf = 'query-m: ' . substr( Database
::generalizeSQL( $sql ), 0, 255 );
451 $totalProf = 'Database::query-master';
453 $queryProf = 'query: ' . substr( Database
::generalizeSQL( $sql ), 0, 255 );
454 $totalProf = 'Database::query';
456 wfProfileIn( $totalProf );
457 wfProfileIn( $queryProf );
460 $this->mLastQuery
= $sql;
461 if ( !$this->mDoneWrites
&& $this->isWriteQuery( $sql ) ) {
462 // Set a flag indicating that writes have been done
463 wfDebug( __METHOD__
.": Writes done: $sql\n" );
464 $this->mDoneWrites
= true;
467 # Add a comment for easy SHOW PROCESSLIST interpretation
470 if ( is_object( $wgUser ) && !($wgUser instanceof StubObject
) ) {
471 $userName = $wgUser->getName();
472 if ( mb_strlen( $userName ) > 15 ) {
473 $userName = mb_substr( $userName, 0, 15 ) . '...';
475 $userName = str_replace( '/', '', $userName );
479 $commentedSql = preg_replace('/\s/', " /* $fname $userName */ ", $sql, 1);
481 # $commentedSql = $sql;
484 # If DBO_TRX is set, start a transaction
485 if ( ( $this->mFlags
& DBO_TRX
) && !$this->trxLevel() &&
486 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK') {
487 // avoid establishing transactions for SHOW and SET statements too -
488 // that would delay transaction initializations to once connection
489 // is really used by application
490 $sqlstart = substr($sql,0,10); // very much worth it, benchmark certified(tm)
491 if (strpos($sqlstart,"SHOW ")!==0 and strpos($sqlstart,"SET ")!==0)
495 if ( $this->debug() ) {
496 $sqlx = substr( $commentedSql, 0, 500 );
497 $sqlx = strtr( $sqlx, "\t\n", ' ' );
499 wfDebug( "SQL-master: $sqlx\n" );
501 wfDebug( "SQL: $sqlx\n" );
505 if ( istainted( $sql ) & TC_MYSQL
) {
506 throw new MWException( 'Tainted query found' );
509 # Do the query and handle errors
510 $ret = $this->doQuery( $commentedSql );
512 # Try reconnecting if the connection was lost
513 if ( false === $ret && $this->wasErrorReissuable() ) {
514 # Transaction is gone, like it or not
515 $this->mTrxLevel
= 0;
516 wfDebug( "Connection lost, reconnecting...\n" );
517 if ( $this->ping() ) {
518 wfDebug( "Reconnected\n" );
519 $sqlx = substr( $commentedSql, 0, 500 );
520 $sqlx = strtr( $sqlx, "\t\n", ' ' );
521 global $wgRequestTime;
522 $elapsed = round( microtime(true) - $wgRequestTime, 3 );
523 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
524 $ret = $this->doQuery( $commentedSql );
526 wfDebug( "Failed\n" );
530 if ( false === $ret ) {
531 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
534 if ( isset( $wgProfiler ) ) {
535 wfProfileOut( $queryProf );
536 wfProfileOut( $totalProf );
538 return $this->resultObject( $ret );
542 * The DBMS-dependent part of query()
543 * @param $sql String: SQL query.
544 * @return Result object to feed to fetchObject, fetchRow, ...; or false on failure
547 /*private*/ abstract function doQuery( $sql );
550 * @param $error String
551 * @param $errno Integer
553 * @param $fname String
554 * @param $tempIgnore Boolean
556 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
557 # Ignore errors during error handling to avoid infinite recursion
558 $ignore = $this->ignoreErrors( true );
559 ++
$this->mErrorCount
;
561 if( $ignore ||
$tempIgnore ) {
562 wfDebug("SQL ERROR (ignored): $error\n");
563 $this->ignoreErrors( $ignore );
565 $sql1line = str_replace( "\n", "\\n", $sql );
566 wfLogDBError("$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n");
567 wfDebug("SQL ERROR: " . $error . "\n");
568 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
574 * Intended to be compatible with the PEAR::DB wrapper functions.
575 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
577 * ? = scalar value, quoted as necessary
578 * ! = raw SQL bit (a function for instance)
579 * & = filename; reads the file and inserts as a blob
580 * (we don't use this though...)
582 function prepare( $sql, $func = 'Database::prepare' ) {
583 /* MySQL doesn't support prepared statements (yet), so just
584 pack up the query for reference. We'll manually replace
586 return array( 'query' => $sql, 'func' => $func );
589 function freePrepared( $prepared ) {
590 /* No-op by default */
594 * Execute a prepared query with the various arguments
595 * @param $prepared String: the prepared sql
596 * @param $args Mixed: Either an array here, or put scalars as varargs
598 function execute( $prepared, $args = null ) {
599 if( !is_array( $args ) ) {
601 $args = func_get_args();
602 array_shift( $args );
604 $sql = $this->fillPrepared( $prepared['query'], $args );
605 return $this->query( $sql, $prepared['func'] );
609 * Prepare & execute an SQL statement, quoting and inserting arguments
610 * in the appropriate places.
611 * @param $query String
614 function safeQuery( $query, $args = null ) {
615 $prepared = $this->prepare( $query, 'Database::safeQuery' );
616 if( !is_array( $args ) ) {
618 $args = func_get_args();
619 array_shift( $args );
621 $retval = $this->execute( $prepared, $args );
622 $this->freePrepared( $prepared );
627 * For faking prepared SQL statements on DBs that don't support
629 * @param $preparedQuery String: a 'preparable' SQL statement
630 * @param $args Array of arguments to fill it with
631 * @return string executable SQL
633 function fillPrepared( $preparedQuery, $args ) {
635 $this->preparedArgs
=& $args;
636 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
637 array( &$this, 'fillPreparedArg' ), $preparedQuery );
641 * preg_callback func for fillPrepared()
642 * The arguments should be in $this->preparedArgs and must not be touched
643 * while we're doing this.
645 * @param $matches Array
649 function fillPreparedArg( $matches ) {
650 switch( $matches[1] ) {
651 case '\\?': return '?';
652 case '\\!': return '!';
653 case '\\&': return '&';
655 list( /* $n */ , $arg ) = each( $this->preparedArgs
);
656 switch( $matches[1] ) {
657 case '?': return $this->addQuotes( $arg );
658 case '!': return $arg;
660 # return $this->addQuotes( file_get_contents( $arg ) );
661 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
663 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
668 * Free a result object
669 * @param $res Mixed: A SQL result
671 function freeResult( $res ) {
672 # Stub. Might not really need to be overridden, since results should
673 # be freed by PHP when the variable goes out of scope anyway.
677 * Fetch the next row from the given result object, in object form.
678 * Fields can be retrieved with $row->fieldname, with fields acting like
681 * @param $res SQL result object as returned from Database::query(), etc.
683 * @throws DBUnexpectedError Thrown if the database returns an error
685 abstract function fetchObject( $res );
688 * Fetch the next row from the given result object, in associative array
689 * form. Fields are retrieved with $row['fieldname'].
691 * @param $res SQL result object as returned from Database::query(), etc.
693 * @throws DBUnexpectedError Thrown if the database returns an error
695 abstract function fetchRow( $res );
698 * Get the number of rows in a result object
699 * @param $res Mixed: A SQL result
701 abstract function numRows( $res );
704 * Get the number of fields in a result object
705 * See documentation for mysql_num_fields()
706 * @param $res Mixed: A SQL result
708 abstract function numFields( $res );
711 * Get a field name in a result object
712 * See documentation for mysql_field_name():
713 * http://www.php.net/mysql_field_name
714 * @param $res Mixed: A SQL result
717 abstract function fieldName( $res, $n );
720 * Get the inserted value of an auto-increment row
722 * The value inserted should be fetched from nextSequenceValue()
725 * $id = $dbw->nextSequenceValue('page_page_id_seq');
726 * $dbw->insert('page',array('page_id' => $id));
727 * $id = $dbw->insertId();
729 abstract function insertId();
732 * Change the position of the cursor in a result object
733 * See mysql_data_seek()
734 * @param $res Mixed: A SQL result
735 * @param $row Mixed: Either MySQL row or ResultWrapper
737 abstract function dataSeek( $res, $row );
740 * Get the last error number
743 abstract function lastErrno();
746 * Get a description of the last error
747 * See mysql_error() for more details
749 abstract function lastError();
752 * Get the number of rows affected by the last write query
753 * See mysql_affected_rows() for more details
755 abstract function affectedRows();
758 * Simple UPDATE wrapper
759 * Usually aborts on failure
760 * If errors are explicitly ignored, returns success
762 * This function exists for historical reasons, Database::update() has a more standard
763 * calling convention and feature set
765 function set( $table, $var, $value, $cond, $fname = 'Database::set' ) {
766 $table = $this->tableName( $table );
767 $sql = "UPDATE $table SET $var = '" .
768 $this->strencode( $value ) . "' WHERE ($cond)";
769 return (bool)$this->query( $sql, $fname );
773 * Simple SELECT wrapper, returns a single field, input must be encoded
774 * Usually aborts on failure
775 * If errors are explicitly ignored, returns FALSE on failure
777 function selectField( $table, $var, $cond='', $fname = 'Database::selectField', $options = array() ) {
778 if ( !is_array( $options ) ) {
779 $options = array( $options );
781 $options['LIMIT'] = 1;
783 $res = $this->select( $table, $var, $cond, $fname, $options );
784 if ( $res === false ||
!$this->numRows( $res ) ) {
787 $row = $this->fetchRow( $res );
788 if ( $row !== false ) {
789 $this->freeResult( $res );
790 return reset( $row );
797 * Returns an optional USE INDEX clause to go after the table, and a
798 * string to go at the end of the query
802 * @param $options Array: associative array of options to be turned into
803 * an SQL query, valid keys are listed in the function.
806 function makeSelectOptions( $options ) {
807 $preLimitTail = $postLimitTail = '';
810 $noKeyOptions = array();
811 foreach ( $options as $key => $option ) {
812 if ( is_numeric( $key ) ) {
813 $noKeyOptions[$option] = true;
817 if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
818 if ( isset( $options['HAVING'] ) ) $preLimitTail .= " HAVING {$options['HAVING']}";
819 if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
821 //if (isset($options['LIMIT'])) {
822 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
823 // isset($options['OFFSET']) ? $options['OFFSET']
827 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $postLimitTail .= ' FOR UPDATE';
828 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $postLimitTail .= ' LOCK IN SHARE MODE';
829 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
831 # Various MySQL extensions
832 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) $startOpts .= ' /*! STRAIGHT_JOIN */';
833 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) $startOpts .= ' HIGH_PRIORITY';
834 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) $startOpts .= ' SQL_BIG_RESULT';
835 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) $startOpts .= ' SQL_BUFFER_RESULT';
836 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) $startOpts .= ' SQL_SMALL_RESULT';
837 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) $startOpts .= ' SQL_CALC_FOUND_ROWS';
838 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) $startOpts .= ' SQL_CACHE';
839 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) $startOpts .= ' SQL_NO_CACHE';
841 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
842 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
847 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
853 * @param $table Mixed: Array or string, table name(s) (prefix auto-added)
854 * @param $vars Mixed: Array or string, field name(s) to be retrieved
855 * @param $conds Mixed: Array or string, condition(s) for WHERE
856 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
857 * @param $options Array: Associative array of options (e.g. array('GROUP BY' => 'page_title')),
858 * see Database::makeSelectOptions code for list of supported stuff
859 * @param $join_conds Array: Associative array of table join conditions (optional)
860 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
861 * @return mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure
863 function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array(), $join_conds = array() )
865 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
866 return $this->query( $sql, $fname );
872 * @param $table Mixed: Array or string, table name(s) (prefix auto-added)
873 * @param $vars Mixed: Array or string, field name(s) to be retrieved
874 * @param $conds Mixed: Array or string, condition(s) for WHERE
875 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
876 * @param $options Array: Associative array of options (e.g. array('GROUP BY' => 'page_title')),
877 * see Database::makeSelectOptions code for list of supported stuff
878 * @param $join_conds Array: Associative array of table join conditions (optional)
879 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
880 * @return string, the SQL text
882 function selectSQLText( $table, $vars, $conds='', $fname = 'Database::select', $options = array(), $join_conds = array() ) {
883 if( is_array( $vars ) ) {
884 $vars = implode( ',', $vars );
886 if( !is_array( $options ) ) {
887 $options = array( $options );
889 if( is_array( $table ) ) {
890 if ( !empty($join_conds) ||
( isset( $options['USE INDEX'] ) && is_array( @$options['USE INDEX'] ) ) )
891 $from = ' FROM ' . $this->tableNamesWithUseIndexOrJOIN( $table, @$options['USE INDEX'], $join_conds );
893 $from = ' FROM ' . implode( ',', array_map( array( &$this, 'tableName' ), $table ) );
894 } elseif ($table!='') {
895 if ($table{0}==' ') {
896 $from = ' FROM ' . $table;
898 $from = ' FROM ' . $this->tableName( $table );
904 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) = $this->makeSelectOptions( $options );
906 if( !empty( $conds ) ) {
907 if ( is_array( $conds ) ) {
908 $conds = $this->makeList( $conds, LIST_AND
);
910 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
912 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
915 if (isset($options['LIMIT']))
916 $sql = $this->limitResult($sql, $options['LIMIT'],
917 isset($options['OFFSET']) ?
$options['OFFSET'] : false);
918 $sql = "$sql $postLimitTail";
920 if (isset($options['EXPLAIN'])) {
921 $sql = 'EXPLAIN ' . $sql;
927 * Single row SELECT wrapper
928 * Aborts or returns FALSE on error
930 * @param $table String: table name
931 * @param $vars String: the selected variables
932 * @param $conds Array: a condition map, terms are ANDed together.
933 * Items with numeric keys are taken to be literal conditions
934 * Takes an array of selected variables, and a condition map, which is ANDed
935 * e.g: selectRow( "page", array( "page_id" ), array( "page_namespace" =>
936 * NS_MAIN, "page_title" => "Astronomy" ) ) would return an object where
937 * $obj- >page_id is the ID of the Astronomy article
938 * @param $fname String: Calling function name
939 * @param $options Array
940 * @param $join_conds Array
942 * @todo migrate documentation to phpdocumentor format
944 function selectRow( $table, $vars, $conds, $fname = 'Database::selectRow', $options = array(), $join_conds = array() ) {
945 $options['LIMIT'] = 1;
946 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
947 if ( $res === false )
949 if ( !$this->numRows($res) ) {
950 $this->freeResult($res);
953 $obj = $this->fetchObject( $res );
954 $this->freeResult( $res );
960 * Estimate rows in dataset
961 * Returns estimated count - not necessarily an accurate estimate across different databases,
963 * Takes same arguments as Database::select()
965 * @param $table String: table name
966 * @param $vars Array: unused
967 * @param $conds Array: filters on the table
968 * @param $fname String: function name for profiling
969 * @param $options Array: options for select
970 * @return Integer: row count
972 public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) {
974 $res = $this->select ( $table, 'COUNT(*) AS rowcount', $conds, $fname, $options );
976 $row = $this->fetchRow( $res );
977 $rows = ( isset( $row['rowcount'] ) ) ?
$row['rowcount'] : 0;
979 $this->freeResult( $res );
984 * Removes most variables from an SQL query and replaces them with X or N for numbers.
985 * It's only slightly flawed. Don't use for anything important.
987 * @param $sql String: A SQL Query
989 static function generalizeSQL( $sql ) {
990 # This does the same as the regexp below would do, but in such a way
991 # as to avoid crashing php on some large strings.
992 # $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
994 $sql = str_replace ( "\\\\", '', $sql);
995 $sql = str_replace ( "\\'", '', $sql);
996 $sql = str_replace ( "\\\"", '', $sql);
997 $sql = preg_replace ("/'.*'/s", "'X'", $sql);
998 $sql = preg_replace ('/".*"/s', "'X'", $sql);
1000 # All newlines, tabs, etc replaced by single space
1001 $sql = preg_replace ( '/\s+/', ' ', $sql);
1004 $sql = preg_replace ('/-?[0-9]+/s', 'N', $sql);
1010 * Determines whether a field exists in a table
1012 * @param $table String: table name
1013 * @param $field String: filed to check on that table
1014 * @param $fname String: calling function name (optional)
1015 * @return Boolean: whether $table has filed $field
1017 function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) {
1018 $info = $this->fieldInfo( $table, $field );
1023 * Determines whether an index exists
1024 * Usually aborts on failure
1025 * If errors are explicitly ignored, returns NULL on failure
1027 function indexExists( $table, $index, $fname = 'Database::indexExists' ) {
1028 $info = $this->indexInfo( $table, $index, $fname );
1029 if ( is_null( $info ) ) {
1032 return $info !== false;
1038 * Get information about an index into an object
1039 * Returns false if the index does not exist
1041 function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
1042 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
1043 # SHOW INDEX should work for 3.x and up:
1044 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
1045 $table = $this->tableName( $table );
1046 $index = $this->indexName( $index );
1047 $sql = 'SHOW INDEX FROM '.$table;
1048 $res = $this->query( $sql, $fname );
1054 while ( $row = $this->fetchObject( $res ) ) {
1055 if ( $row->Key_name
== $index ) {
1059 $this->freeResult($res);
1061 return empty($result) ?
false : $result;
1065 * Query whether a given table exists
1067 function tableExists( $table ) {
1068 $table = $this->tableName( $table );
1069 $old = $this->ignoreErrors( true );
1070 $res = $this->query( "SELECT 1 FROM $table LIMIT 1" );
1071 $this->ignoreErrors( $old );
1073 $this->freeResult( $res );
1081 * mysql_fetch_field() wrapper
1082 * Returns false if the field doesn't exist
1087 abstract function fieldInfo( $table, $field );
1090 * mysql_field_type() wrapper
1092 function fieldType( $res, $index ) {
1093 if ( $res instanceof ResultWrapper
) {
1094 $res = $res->result
;
1096 return mysql_field_type( $res, $index );
1100 * Determines if a given index is unique
1102 function indexUnique( $table, $index ) {
1103 $indexInfo = $this->indexInfo( $table, $index );
1104 if ( !$indexInfo ) {
1107 return !$indexInfo[0]->Non_unique
;
1111 * INSERT wrapper, inserts an array into a table
1113 * $a may be a single associative array, or an array of these with numeric keys, for
1116 * Usually aborts on failure
1117 * If errors are explicitly ignored, returns success
1119 function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
1120 # No rows to insert, easy just return now
1121 if ( !count( $a ) ) {
1125 $table = $this->tableName( $table );
1126 if ( !is_array( $options ) ) {
1127 $options = array( $options );
1129 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1131 $keys = array_keys( $a[0] );
1134 $keys = array_keys( $a );
1137 $sql = 'INSERT ' . implode( ' ', $options ) .
1138 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1142 foreach ( $a as $row ) {
1148 $sql .= '(' . $this->makeList( $row ) . ')';
1151 $sql .= '(' . $this->makeList( $a ) . ')';
1153 return (bool)$this->query( $sql, $fname );
1157 * Make UPDATE options for the Database::update function
1160 * @param $options Array: The options passed to Database::update
1163 function makeUpdateOptions( $options ) {
1164 if( !is_array( $options ) ) {
1165 $options = array( $options );
1168 if ( in_array( 'LOW_PRIORITY', $options ) )
1169 $opts[] = $this->lowPriorityOption();
1170 if ( in_array( 'IGNORE', $options ) )
1172 return implode(' ', $opts);
1176 * UPDATE wrapper, takes a condition array and a SET array
1178 * @param $table String: The table to UPDATE
1179 * @param $values Array: An array of values to SET
1180 * @param $conds Array: An array of conditions (WHERE). Use '*' to update all rows.
1181 * @param $fname String: The Class::Function calling this function
1183 * @param $options Array: An array of UPDATE options, can be one or
1184 * more of IGNORE, LOW_PRIORITY
1187 function update( $table, $values, $conds, $fname = 'Database::update', $options = array() ) {
1188 $table = $this->tableName( $table );
1189 $opts = $this->makeUpdateOptions( $options );
1190 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
1191 if ( $conds != '*' ) {
1192 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
1194 return $this->query( $sql, $fname );
1198 * Makes an encoded list of strings from an array
1200 * LIST_COMMA - comma separated, no field names
1201 * LIST_AND - ANDed WHERE clause (without the WHERE)
1202 * LIST_OR - ORed WHERE clause (without the WHERE)
1203 * LIST_SET - comma separated with field names, like a SET clause
1204 * LIST_NAMES - comma separated field names
1206 function makeList( $a, $mode = LIST_COMMA
) {
1207 if ( !is_array( $a ) ) {
1208 throw new DBUnexpectedError( $this, 'Database::makeList called with incorrect parameters' );
1213 foreach ( $a as $field => $value ) {
1215 if ( $mode == LIST_AND
) {
1217 } elseif($mode == LIST_OR
) {
1225 if ( ($mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
1226 $list .= "($value)";
1227 } elseif ( ($mode == LIST_SET
) && is_numeric( $field ) ) {
1229 } elseif ( ($mode == LIST_AND ||
$mode == LIST_OR
) && is_array($value) ) {
1230 if( count( $value ) == 0 ) {
1231 throw new MWException( __METHOD__
.': empty input' );
1232 } elseif( count( $value ) == 1 ) {
1233 // Special-case single values, as IN isn't terribly efficient
1234 // Don't necessarily assume the single key is 0; we don't
1235 // enforce linear numeric ordering on other arrays here.
1236 $value = array_values( $value );
1237 $list .= $field." = ".$this->addQuotes( $value[0] );
1239 $list .= $field." IN (".$this->makeList($value).") ";
1241 } elseif( $value === null ) {
1242 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
1243 $list .= "$field IS ";
1244 } elseif ( $mode == LIST_SET
) {
1245 $list .= "$field = ";
1249 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
1250 $list .= "$field = ";
1252 $list .= $mode == LIST_NAMES ?
$value : $this->addQuotes( $value );
1259 * Build a partial where clause from a 2-d array such as used for LinkBatch.
1260 * The keys on each level may be either integers or strings.
1262 * @param $data Array: organized as 2-d array(baseKeyVal => array(subKeyVal => <ignored>, ...), ...)
1263 * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace')
1264 * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title')
1265 * @return Mixed: string SQL fragment, or false if no items in array.
1267 function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1269 foreach ( $data as $base => $sub ) {
1270 if ( count( $sub ) ) {
1271 $conds[] = $this->makeList(
1272 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
1278 return $this->makeList( $conds, LIST_OR
);
1280 // Nothing to search for...
1286 * Bitwise operations
1289 function bitNot($field) {
1290 return "(~$bitField)";
1293 function bitAnd($fieldLeft, $fieldRight) {
1294 return "($fieldLeft & $fieldRight)";
1297 function bitOr($fieldLeft, $fieldRight) {
1298 return "($fieldLeft | $fieldRight)";
1302 * Change the current database
1304 * @return bool Success or failure
1306 function selectDB( $db ) {
1307 # Stub. Shouldn't cause serious problems if it's not overridden, but
1308 # if your database engine supports a concept similar to MySQL's
1309 # databases you may as well. TODO: explain what exactly will fail if
1310 # this is not overridden.
1315 * Get the current DB name
1317 function getDBname() {
1318 return $this->mDBname
;
1322 * Get the server hostname or IP address
1324 function getServer() {
1325 return $this->mServer
;
1329 * Format a table name ready for use in constructing an SQL query
1331 * This does two important things: it quotes the table names to clean them up,
1332 * and it adds a table prefix if only given a table name with no quotes.
1334 * All functions of this object which require a table name call this function
1335 * themselves. Pass the canonical name to such functions. This is only needed
1336 * when calling query() directly.
1338 * @param $name String: database table name
1339 * @return String: full database name
1341 function tableName( $name ) {
1342 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables;
1343 # Skip the entire process when we have a string quoted on both ends.
1344 # Note that we check the end so that we will still quote any use of
1345 # use of `database`.table. But won't break things if someone wants
1346 # to query a database table with a dot in the name.
1347 if ( $name[0] == '`' && substr( $name, -1, 1 ) == '`' ) return $name;
1349 # Lets test for any bits of text that should never show up in a table
1350 # name. Basically anything like JOIN or ON which are actually part of
1351 # SQL queries, but may end up inside of the table value to combine
1352 # sql. Such as how the API is doing.
1353 # Note that we use a whitespace test rather than a \b test to avoid
1354 # any remote case where a word like on may be inside of a table name
1355 # surrounded by symbols which may be considered word breaks.
1356 if( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) return $name;
1358 # Split database and table into proper variables.
1359 # We reverse the explode so that database.table and table both output
1360 # the correct table.
1361 $dbDetails = array_reverse( explode( '.', $name, 2 ) );
1362 if( isset( $dbDetails[1] ) ) @list
( $table, $database ) = $dbDetails;
1363 else @list
( $table ) = $dbDetails;
1364 $prefix = $this->mTablePrefix
; # Default prefix
1366 # A database name has been specified in input. Quote the table name
1367 # because we don't want any prefixes added.
1368 if( isset($database) ) $table = ( $table[0] == '`' ?
$table : "`{$table}`" );
1370 # Note that we use the long format because php will complain in in_array if
1371 # the input is not an array, and will complain in is_array if it is not set.
1372 if( !isset( $database ) # Don't use shared database if pre selected.
1373 && isset( $wgSharedDB ) # We have a shared database
1374 && $table[0] != '`' # Paranoia check to prevent shared tables listing '`table`'
1375 && isset( $wgSharedTables )
1376 && is_array( $wgSharedTables )
1377 && in_array( $table, $wgSharedTables ) ) { # A shared table is selected
1378 $database = $wgSharedDB;
1379 $prefix = isset( $wgSharedPrefix ) ?
$wgSharedPrefix : $prefix;
1382 # Quote the $database and $table and apply the prefix if not quoted.
1383 if( isset($database) ) $database = ( $database[0] == '`' ?
$database : "`{$database}`" );
1384 $table = ( $table[0] == '`' ?
$table : "`{$prefix}{$table}`" );
1386 # Merge our database and table into our final table name.
1387 $tableName = ( isset($database) ?
"{$database}.{$table}" : "{$table}" );
1389 # We're finished, return.
1394 * Fetch a number of table names into an array
1395 * This is handy when you need to construct SQL for joins
1398 * extract($dbr->tableNames('user','watchlist'));
1399 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
1400 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
1402 public function tableNames() {
1403 $inArray = func_get_args();
1405 foreach ( $inArray as $name ) {
1406 $retVal[$name] = $this->tableName( $name );
1412 * Fetch a number of table names into an zero-indexed numerical array
1413 * This is handy when you need to construct SQL for joins
1416 * list( $user, $watchlist ) = $dbr->tableNamesN('user','watchlist');
1417 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
1418 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
1420 public function tableNamesN() {
1421 $inArray = func_get_args();
1423 foreach ( $inArray as $name ) {
1424 $retVal[] = $this->tableName( $name );
1432 function tableNamesWithUseIndexOrJOIN( $tables, $use_index = array(), $join_conds = array() ) {
1435 $use_index_safe = is_array($use_index) ?
$use_index : array();
1436 $join_conds_safe = is_array($join_conds) ?
$join_conds : array();
1437 foreach ( $tables as $table ) {
1438 // Is there a JOIN and INDEX clause for this table?
1439 if ( isset($join_conds_safe[$table]) && isset($use_index_safe[$table]) ) {
1440 $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
1441 $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
1442 $tableClause .= ' ON (' . $this->makeList((array)$join_conds_safe[$table][1], LIST_AND
) . ')';
1443 $retJOIN[] = $tableClause;
1444 // Is there an INDEX clause?
1445 } else if ( isset($use_index_safe[$table]) ) {
1446 $tableClause = $this->tableName( $table );
1447 $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
1448 $ret[] = $tableClause;
1449 // Is there a JOIN clause?
1450 } else if ( isset($join_conds_safe[$table]) ) {
1451 $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
1452 $tableClause .= ' ON (' . $this->makeList((array)$join_conds_safe[$table][1], LIST_AND
) . ')';
1453 $retJOIN[] = $tableClause;
1455 $tableClause = $this->tableName( $table );
1456 $ret[] = $tableClause;
1459 // We can't separate explicit JOIN clauses with ',', use ' ' for those
1460 $straightJoins = !empty($ret) ?
implode( ',', $ret ) : "";
1461 $otherJoins = !empty($retJOIN) ?
implode( ' ', $retJOIN ) : "";
1462 // Compile our final table clause
1463 return implode(' ',array($straightJoins,$otherJoins) );
1467 * Get the name of an index in a given table
1469 function indexName( $index ) {
1470 // Backwards-compatibility hack
1472 'ar_usertext_timestamp' => 'usertext_timestamp',
1473 'un_user_id' => 'user_id',
1474 'un_user_ip' => 'user_ip',
1476 if( isset( $renamed[$index] ) ) {
1477 return $renamed[$index];
1484 * Wrapper for addslashes()
1485 * @param $s String: to be slashed.
1486 * @return String: slashed string.
1488 abstract function strencode( $s );
1491 * If it's a string, adds quotes and backslashes
1492 * Otherwise returns as-is
1494 function addQuotes( $s ) {
1495 if ( $s === null ) {
1498 # This will also quote numeric values. This should be harmless,
1499 # and protects against weird problems that occur when they really
1500 # _are_ strings such as article titles and string->number->string
1501 # conversion is not 1:1.
1502 return "'" . $this->strencode( $s ) . "'";
1507 * Escape string for safe LIKE usage.
1508 * WARNING: you should almost never use this function directly,
1509 * instead use buildLike() that escapes everything automatically
1510 * Deprecated in 1.17, warnings in 1.17, removed in ???
1512 public function escapeLike( $s ) {
1513 wfDeprecated( __METHOD__
);
1514 return $this->escapeLikeInternal( $s );
1517 protected function escapeLikeInternal( $s ) {
1518 $s = str_replace( '\\', '\\\\', $s );
1519 $s = $this->strencode( $s );
1520 $s = str_replace( array( '%', '_' ), array( '\%', '\_' ), $s );
1525 * LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match
1526 * containing either string literals that will be escaped or tokens returned by anyChar() or anyString().
1527 * Alternatively, the function could be provided with an array of aforementioned parameters.
1529 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches
1530 * for subpages of 'My page title'.
1531 * Alternatively: $pattern = array( 'My_page_title/', $dbr->anyString() ); $query .= $dbr->buildLike( $pattern );
1534 * @return String: fully built LIKE statement
1536 function buildLike() {
1537 $params = func_get_args();
1538 if (count($params) > 0 && is_array($params[0])) {
1539 $params = $params[0];
1543 foreach( $params as $value) {
1544 if( $value instanceof LikeMatch
) {
1545 $s .= $value->toString();
1547 $s .= $this->escapeLikeInternal( $value );
1550 return " LIKE '" . $s . "' ";
1554 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1556 function anyChar() {
1557 return new LikeMatch( '_' );
1561 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1563 function anyString() {
1564 return new LikeMatch( '%' );
1568 * Returns an appropriately quoted sequence value for inserting a new row.
1569 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
1570 * subclass will return an integer, and save the value for insertId()
1572 function nextSequenceValue( $seqName ) {
1577 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
1578 * is only needed because a) MySQL must be as efficient as possible due to
1579 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
1580 * which index to pick. Anyway, other databases might have different
1581 * indexes on a given table. So don't bother overriding this unless you're
1584 function useIndexClause( $index ) {
1589 * REPLACE query wrapper
1590 * PostgreSQL simulates this with a DELETE followed by INSERT
1591 * $row is the row to insert, an associative array
1592 * $uniqueIndexes is an array of indexes. Each element may be either a
1593 * field name or an array of field names
1595 * It may be more efficient to leave off unique indexes which are unlikely to collide.
1596 * However if you do this, you run the risk of encountering errors which wouldn't have
1599 * @todo migrate comment to phodocumentor format
1601 function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
1602 $table = $this->tableName( $table );
1605 if ( !is_array( reset( $rows ) ) ) {
1606 $rows = array( $rows );
1609 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) .') VALUES ';
1611 foreach ( $rows as $row ) {
1617 $sql .= '(' . $this->makeList( $row ) . ')';
1619 return $this->query( $sql, $fname );
1623 * DELETE where the condition is a join
1624 * MySQL does this with a multi-table DELETE syntax, PostgreSQL does it with sub-selects
1626 * For safety, an empty $conds will not delete everything. If you want to delete all rows where the
1627 * join condition matches, set $conds='*'
1629 * DO NOT put the join condition in $conds
1631 * @param $delTable String: The table to delete from.
1632 * @param $joinTable String: The other table.
1633 * @param $delVar String: The variable to join on, in the first table.
1634 * @param $joinVar String: The variable to join on, in the second table.
1635 * @param $conds Array: Condition array of field names mapped to variables, ANDed together in the WHERE clause
1636 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
1638 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'Database::deleteJoin' ) {
1640 throw new DBUnexpectedError( $this, 'Database::deleteJoin() called with empty $conds' );
1643 $delTable = $this->tableName( $delTable );
1644 $joinTable = $this->tableName( $joinTable );
1645 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1646 if ( $conds != '*' ) {
1647 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND
);
1650 return $this->query( $sql, $fname );
1654 * Returns the size of a text field, or -1 for "unlimited"
1656 function textFieldSize( $table, $field ) {
1657 $table = $this->tableName( $table );
1658 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
1659 $res = $this->query( $sql, 'Database::textFieldSize' );
1660 $row = $this->fetchObject( $res );
1661 $this->freeResult( $res );
1664 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
1673 * A string to insert into queries to show that they're low-priority, like
1674 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
1675 * string and nothing bad should happen.
1677 * @return string Returns the text of the low priority option if it is supported, or a blank string otherwise
1679 function lowPriorityOption() {
1684 * DELETE query wrapper
1686 * Use $conds == "*" to delete all rows
1688 function delete( $table, $conds, $fname = 'Database::delete' ) {
1690 throw new DBUnexpectedError( $this, 'Database::delete() called with no conditions' );
1692 $table = $this->tableName( $table );
1693 $sql = "DELETE FROM $table";
1694 if ( $conds != '*' ) {
1695 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
1697 return $this->query( $sql, $fname );
1701 * INSERT SELECT wrapper
1702 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
1703 * Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
1704 * $conds may be "*" to copy the whole table
1705 * srcTable may be an array of tables.
1707 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'Database::insertSelect',
1708 $insertOptions = array(), $selectOptions = array() )
1710 $destTable = $this->tableName( $destTable );
1711 if ( is_array( $insertOptions ) ) {
1712 $insertOptions = implode( ' ', $insertOptions );
1714 if( !is_array( $selectOptions ) ) {
1715 $selectOptions = array( $selectOptions );
1717 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
1718 if( is_array( $srcTable ) ) {
1719 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
1721 $srcTable = $this->tableName( $srcTable );
1723 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
1724 " SELECT $startOpts " . implode( ',', $varMap ) .
1725 " FROM $srcTable $useIndex ";
1726 if ( $conds != '*' ) {
1727 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
1729 $sql .= " $tailOpts";
1730 return $this->query( $sql, $fname );
1734 * Construct a LIMIT query with optional offset. This is used for query
1735 * pages. The SQL should be adjusted so that only the first $limit rows
1736 * are returned. If $offset is provided as well, then the first $offset
1737 * rows should be discarded, and the next $limit rows should be returned.
1738 * If the result of the query is not ordered, then the rows to be returned
1739 * are theoretically arbitrary.
1741 * $sql is expected to be a SELECT, if that makes a difference. For
1742 * UPDATE, limitResultForUpdate should be used.
1744 * The version provided by default works in MySQL and SQLite. It will very
1745 * likely need to be overridden for most other DBMSes.
1747 * @param $sql String: SQL query we will append the limit too
1748 * @param $limit Integer: the SQL limit
1749 * @param $offset Integer the SQL offset (default false)
1751 function limitResult( $sql, $limit, $offset=false ) {
1752 if( !is_numeric( $limit ) ) {
1753 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
1755 return "$sql LIMIT "
1756 . ( (is_numeric($offset) && $offset != 0) ?
"{$offset}," : "" )
1759 function limitResultForUpdate( $sql, $num ) {
1760 return $this->limitResult( $sql, $num, 0 );
1764 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1765 * within the UNION construct.
1768 function unionSupportsOrderAndLimit() {
1769 return true; // True for almost every DB supported
1773 * Construct a UNION query
1774 * This is used for providing overload point for other DB abstractions
1775 * not compatible with the MySQL syntax.
1776 * @param $sqls Array: SQL statements to combine
1777 * @param $all Boolean: use UNION ALL
1778 * @return String: SQL fragment
1780 function unionQueries($sqls, $all) {
1781 $glue = $all ?
') UNION ALL (' : ') UNION (';
1782 return '('.implode( $glue, $sqls ) . ')';
1786 * Returns an SQL expression for a simple conditional. This doesn't need
1787 * to be overridden unless CASE isn't supported in your DBMS.
1789 * @param $cond String: SQL expression which will result in a boolean value
1790 * @param $trueVal String: SQL expression to return if true
1791 * @param $falseVal String: SQL expression to return if false
1792 * @return String: SQL fragment
1794 function conditional( $cond, $trueVal, $falseVal ) {
1795 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
1799 * Returns a comand for str_replace function in SQL query.
1800 * Uses REPLACE() in MySQL
1802 * @param $orig String: column to modify
1803 * @param $old String: column to seek
1804 * @param $new String: column to replace with
1806 function strreplace( $orig, $old, $new ) {
1807 return "REPLACE({$orig}, {$old}, {$new})";
1811 * Determines if the last failure was due to a deadlock
1814 function wasDeadlock() {
1819 * Determines if the last query error was something that should be dealt
1820 * with by pinging the connection and reissuing the query.
1823 function wasErrorReissuable() {
1828 * Determines if the last failure was due to the database being read-only.
1831 function wasReadOnlyError() {
1836 * Perform a deadlock-prone transaction.
1838 * This function invokes a callback function to perform a set of write
1839 * queries. If a deadlock occurs during the processing, the transaction
1840 * will be rolled back and the callback function will be called again.
1843 * $dbw->deadlockLoop( callback, ... );
1845 * Extra arguments are passed through to the specified callback function.
1847 * Returns whatever the callback function returned on its successful,
1848 * iteration, or false on error, for example if the retry limit was
1851 function deadlockLoop() {
1852 $myFname = 'Database::deadlockLoop';
1855 $args = func_get_args();
1856 $function = array_shift( $args );
1857 $oldIgnore = $this->ignoreErrors( true );
1858 $tries = DEADLOCK_TRIES
;
1859 if ( is_array( $function ) ) {
1860 $fname = $function[0];
1865 $retVal = call_user_func_array( $function, $args );
1866 $error = $this->lastError();
1867 $errno = $this->lastErrno();
1868 $sql = $this->lastQuery();
1871 if ( $this->wasDeadlock() ) {
1873 usleep( mt_rand( DEADLOCK_DELAY_MIN
, DEADLOCK_DELAY_MAX
) );
1875 $this->reportQueryError( $error, $errno, $sql, $fname );
1878 } while( $this->wasDeadlock() && --$tries > 0 );
1879 $this->ignoreErrors( $oldIgnore );
1880 if ( $tries <= 0 ) {
1881 $this->query( 'ROLLBACK', $myFname );
1882 $this->reportQueryError( $error, $errno, $sql, $fname );
1885 $this->query( 'COMMIT', $myFname );
1891 * Do a SELECT MASTER_POS_WAIT()
1893 * @param $pos MySQLMasterPos object
1894 * @param $timeout Integer: the maximum number of seconds to wait for synchronisation
1896 function masterPosWait( MySQLMasterPos
$pos, $timeout ) {
1897 $fname = 'Database::masterPosWait';
1898 wfProfileIn( $fname );
1900 # Commit any open transactions
1901 if ( $this->mTrxLevel
) {
1905 if ( !is_null( $this->mFakeSlaveLag
) ) {
1906 $wait = intval( ( $pos->pos
- microtime(true) +
$this->mFakeSlaveLag
) * 1e6
);
1907 if ( $wait > $timeout * 1e6
) {
1908 wfDebug( "Fake slave timed out waiting for $pos ($wait us)\n" );
1909 wfProfileOut( $fname );
1911 } elseif ( $wait > 0 ) {
1912 wfDebug( "Fake slave waiting $wait us\n" );
1914 wfProfileOut( $fname );
1917 wfDebug( "Fake slave up to date ($wait us)\n" );
1918 wfProfileOut( $fname );
1923 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
1924 $encFile = $this->addQuotes( $pos->file
);
1925 $encPos = intval( $pos->pos
);
1926 $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
1927 $res = $this->doQuery( $sql );
1928 if ( $res && $row = $this->fetchRow( $res ) ) {
1929 $this->freeResult( $res );
1930 wfProfileOut( $fname );
1933 wfProfileOut( $fname );
1939 * Get the position of the master from SHOW SLAVE STATUS
1941 function getSlavePos() {
1942 if ( !is_null( $this->mFakeSlaveLag
) ) {
1943 $pos = new MySQLMasterPos( 'fake', microtime(true) - $this->mFakeSlaveLag
);
1944 wfDebug( __METHOD__
.": fake slave pos = $pos\n" );
1947 $res = $this->query( 'SHOW SLAVE STATUS', 'Database::getSlavePos' );
1948 $row = $this->fetchObject( $res );
1950 $pos = isset($row->Exec_master_log_pos
) ?
$row->Exec_master_log_pos
: $row->Exec_Master_Log_Pos
;
1951 return new MySQLMasterPos( $row->Relay_Master_Log_File
, $pos );
1958 * Get the position of the master from SHOW MASTER STATUS
1960 function getMasterPos() {
1961 if ( $this->mFakeMaster
) {
1962 return new MySQLMasterPos( 'fake', microtime( true ) );
1964 $res = $this->query( 'SHOW MASTER STATUS', 'Database::getMasterPos' );
1965 $row = $this->fetchObject( $res );
1967 return new MySQLMasterPos( $row->File
, $row->Position
);
1974 * Begin a transaction, committing any previously open transaction
1976 function begin( $fname = 'Database::begin' ) {
1977 $this->query( 'BEGIN', $fname );
1978 $this->mTrxLevel
= 1;
1984 function commit( $fname = 'Database::commit' ) {
1985 $this->query( 'COMMIT', $fname );
1986 $this->mTrxLevel
= 0;
1990 * Rollback a transaction.
1991 * No-op on non-transactional databases.
1993 function rollback( $fname = 'Database::rollback' ) {
1994 $this->query( 'ROLLBACK', $fname, true );
1995 $this->mTrxLevel
= 0;
1999 * Begin a transaction, committing any previously open transaction
2000 * @deprecated use begin()
2002 function immediateBegin( $fname = 'Database::immediateBegin' ) {
2003 wfDeprecated( __METHOD__
);
2008 * Commit transaction, if one is open
2009 * @deprecated use commit()
2011 function immediateCommit( $fname = 'Database::immediateCommit' ) {
2012 wfDeprecated( __METHOD__
);
2017 * Creates a new table with structure copied from existing table
2018 * Note that unlike most database abstraction functions, this function does not
2019 * automatically append database prefix, because it works at a lower
2020 * abstraction level.
2022 * @param $oldName String: name of table whose structure should be copied
2023 * @param $newName String: name of table to be created
2024 * @param $temporary Boolean: whether the new table should be temporary
2025 * @param $fname String: calling function name
2026 * @return Boolean: true if operation was successful
2028 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'Database::duplicateTableStructure' ) {
2029 throw new MWException( 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
2033 * Return MW-style timestamp used for MySQL schema
2035 function timestamp( $ts=0 ) {
2036 return wfTimestamp(TS_MW
,$ts);
2040 * Local database timestamp format or null
2042 function timestampOrNull( $ts = null ) {
2043 if( is_null( $ts ) ) {
2046 return $this->timestamp( $ts );
2053 function resultObject( $result ) {
2054 if( empty( $result ) ) {
2056 } elseif ( $result instanceof ResultWrapper
) {
2058 } elseif ( $result === true ) {
2059 // Successful write query
2062 return new ResultWrapper( $this, $result );
2067 * Return aggregated value alias
2069 function aggregateValue ($valuedata,$valuename='value') {
2074 * Returns a wikitext link to the DB's website, e.g.,
2075 * return "[http://www.mysql.com/ MySQL]";
2076 * Should at least contain plain text, if for some reason
2077 * your database has no website.
2079 * @return String: wikitext of a link to the server software's web site
2081 abstract function getSoftwareLink();
2084 * A string describing the current software version, like from
2085 * mysql_get_server_info(). Will be listed on Special:Version, etc.
2087 * @return String: Version information from the database
2089 abstract function getServerVersion();
2092 * Ping the server and try to reconnect if it there is no connection
2094 * @return bool Success or failure
2097 # Stub. Not essential to override.
2103 * Currently supported only by MySQL
2104 * @return Database replication lag in seconds
2107 return $this->mFakeSlaveLag
;
2111 * Get status information from SHOW STATUS in an associative array
2113 function getStatus($which="%") {
2114 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
2116 while ( $row = $this->fetchObject( $res ) ) {
2117 $status[$row->Variable_name
] = $row->Value
;
2123 * Return the maximum number of items allowed in a list, or 0 for unlimited.
2125 function maxListLen() {
2129 function encodeBlob($b) {
2133 function decodeBlob($b) {
2138 * Override database's default connection timeout. May be useful for very
2139 * long batch queries such as full-wiki dumps, where a single query reads
2140 * out over hours or days. May or may not be necessary for non-MySQL
2141 * databases. For most purposes, leaving it as a no-op should be fine.
2143 * @param $timeout Integer in seconds
2145 public function setTimeout( $timeout ) {}
2148 * Read and execute SQL commands from a file.
2149 * Returns true on success, error string or exception on failure (depending on object's error ignore settings)
2150 * @param $filename String: File name to open
2151 * @param $lineCallback Callback: Optional function called before reading each line
2152 * @param $resultCallback Callback: Optional function called for each MySQL result
2154 function sourceFile( $filename, $lineCallback = false, $resultCallback = false ) {
2155 $fp = fopen( $filename, 'r' );
2156 if ( false === $fp ) {
2157 if (!defined("MEDIAWIKI_INSTALL"))
2158 throw new MWException( "Could not open \"{$filename}\".\n" );
2160 return "Could not open \"{$filename}\".\n";
2163 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback );
2165 catch( MWException
$e ) {
2166 if ( defined("MEDIAWIKI_INSTALL") ) {
2167 $error = $e->getMessage();
2179 * Get the full path of a patch file. Originally based on archive()
2180 * from updaters.inc. Keep in mind this always returns a patch, as
2181 * it fails back to MySQL if no DB-specific patch can be found
2183 * @param $patch String The name of the patch, like patch-something.sql
2184 * @return String Full path to patch file
2186 public static function patchPath( $patch ) {
2187 global $wgDBtype, $IP;
2188 if ( file_exists( "$IP/maintenance/$wgDBtype/archives/$patch" ) ) {
2189 return "$IP/maintenance/$wgDBtype/archives/$patch";
2191 return "$IP/maintenance/archives/$patch";
2196 * Read and execute commands from an open file handle
2197 * Returns true on success, error string or exception on failure (depending on object's error ignore settings)
2198 * @param $fp String: File handle
2199 * @param $lineCallback Callback: Optional function called before reading each line
2200 * @param $resultCallback Callback: Optional function called for each MySQL result
2202 function sourceStream( $fp, $lineCallback = false, $resultCallback = false ) {
2205 $dollarquote = false;
2207 while ( ! feof( $fp ) ) {
2208 if ( $lineCallback ) {
2209 call_user_func( $lineCallback );
2211 $line = trim( fgets( $fp, 1024 ) );
2212 $sl = strlen( $line ) - 1;
2214 if ( $sl < 0 ) { continue; }
2215 if ( '-' == $line{0} && '-' == $line{1} ) { continue; }
2217 ## Allow dollar quoting for function declarations
2218 if (substr($line,0,4) == '$mw$') {
2220 $dollarquote = false;
2224 $dollarquote = true;
2227 else if (!$dollarquote) {
2228 if ( ';' == $line{$sl} && ($sl < 2 ||
';' != $line{$sl - 1})) {
2230 $line = substr( $line, 0, $sl );
2234 if ( $cmd != '' ) { $cmd .= ' '; }
2238 $cmd = str_replace(';;', ";", $cmd);
2239 $cmd = $this->replaceVars( $cmd );
2240 $res = $this->query( $cmd, __METHOD__
);
2241 if ( $resultCallback ) {
2242 call_user_func( $resultCallback, $res, $this );
2245 if ( false === $res ) {
2246 $err = $this->lastError();
2247 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
2259 * Replace variables in sourced SQL
2261 protected function replaceVars( $ins ) {
2263 'wgDBserver', 'wgDBname', 'wgDBintlname', 'wgDBuser',
2264 'wgDBpassword', 'wgDBsqluser', 'wgDBsqlpassword',
2265 'wgDBadminuser', 'wgDBadminpassword', 'wgDBTableOptions',
2268 // Ordinary variables
2269 foreach ( $varnames as $var ) {
2270 if( isset( $GLOBALS[$var] ) ) {
2271 $val = addslashes( $GLOBALS[$var] ); // FIXME: safety check?
2272 $ins = str_replace( '{$' . $var . '}', $val, $ins );
2273 $ins = str_replace( '/*$' . $var . '*/`', '`' . $val, $ins );
2274 $ins = str_replace( '/*$' . $var . '*/', $val, $ins );
2279 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
2280 array( $this, 'tableNameCallback' ), $ins );
2283 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
2284 array( $this, 'indexNameCallback' ), $ins );
2289 * Table name callback
2292 protected function tableNameCallback( $matches ) {
2293 return $this->tableName( $matches[1] );
2297 * Index name callback
2299 protected function indexNameCallback( $matches ) {
2300 return $this->indexName( $matches[1] );
2304 * Build a concatenation list to feed into a SQL query
2305 * @param $stringList Array: list of raw SQL expressions; caller is responsible for any quoting
2308 function buildConcat( $stringList ) {
2309 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2313 * Acquire a named lock
2315 * Abstracted from Filestore::lock() so child classes can implement for
2318 * @param $lockName String: name of lock to aquire
2319 * @param $method String: name of method calling us
2320 * @param $timeout Integer: timeout
2323 public function lock( $lockName, $method, $timeout = 5 ) {
2330 * @param $lockName String: Name of lock to release
2331 * @param $method String: Name of method calling us
2333 * @return Returns 1 if the lock was released, 0 if the lock was not established
2334 * by this thread (in which case the lock is not released), and NULL if the named
2335 * lock did not exist
2337 public function unlock( $lockName, $method ) {
2342 * Lock specific tables
2344 * @param $read Array of tables to lock for read access
2345 * @param $write Array of tables to lock for write access
2346 * @param $method String name of caller
2347 * @param $lowPriority bool Whether to indicate writes to be LOW PRIORITY
2349 public function lockTables( $read, $write, $method, $lowPriority = true ) {
2354 * Unlock specific tables
2356 * @param $method String the caller
2358 public function unlockTables( $method ) {
2363 * Get search engine class. All subclasses of this need to implement this
2364 * if they wish to use searching.
2368 public function getSearchEngine() {
2369 return 'SearchEngineDummy';
2373 * Allow or deny "big selects" for this session only. This is done by setting
2374 * the sql_big_selects session variable.
2376 * This is a MySQL-specific feature.
2378 * @param $value Mixed: true for allow, false for deny, or "default" to restore the initial value
2380 public function setBigSelects( $value = true ) {
2386 /******************************************************************************
2388 *****************************************************************************/
2397 function DBObject($data) {
2398 $this->mData
= $data;
2406 return $this->mData
;
2414 * This allows us to distinguish a blob from a normal string and an array of strings
2418 function __construct($data) {
2419 $this->mData
= $data;
2422 return $this->mData
;
2431 private $name, $tablename, $default, $max_length, $nullable,
2432 $is_pk, $is_unique, $is_multiple, $is_key, $type;
2433 function __construct ($info) {
2434 $this->name
= $info->name
;
2435 $this->tablename
= $info->table
;
2436 $this->default = $info->def
;
2437 $this->max_length
= $info->max_length
;
2438 $this->nullable
= !$info->not_null
;
2439 $this->is_pk
= $info->primary_key
;
2440 $this->is_unique
= $info->unique_key
;
2441 $this->is_multiple
= $info->multiple_key
;
2442 $this->is_key
= ($this->is_pk ||
$this->is_unique ||
$this->is_multiple
);
2443 $this->type
= $info->type
;
2450 function tableName() {
2451 return $this->tableName
;
2454 function defaultValue() {
2455 return $this->default;
2458 function maxLength() {
2459 return $this->max_length
;
2462 function nullable() {
2463 return $this->nullable
;
2467 return $this->is_key
;
2470 function isMultipleKey() {
2471 return $this->is_multiple
;
2479 /******************************************************************************
2481 *****************************************************************************/
2484 * Database error base class
2487 class DBError
extends MWException
{
2491 * Construct a database error
2492 * @param $db Database object which threw the error
2493 * @param $error A simple error message to be used for debugging
2495 function __construct( DatabaseBase
&$db, $error ) {
2497 parent
::__construct( $error );
2500 function getText() {
2501 global $wgShowDBErrorBacktrace;
2502 $s = $this->getMessage() . "\n";
2503 if ( $wgShowDBErrorBacktrace ) {
2504 $s .= "Backtrace:\n" . $this->getTraceAsString() . "\n";
2513 class DBConnectionError
extends DBError
{
2516 function __construct( DatabaseBase
&$db, $error = 'unknown error' ) {
2517 $msg = 'DB connection error';
2518 if ( trim( $error ) != '' ) {
2521 $this->error
= $error;
2522 parent
::__construct( $db, $msg );
2525 function useOutputPage() {
2526 // Not likely to work
2530 function useMessageCache() {
2531 // Not likely to work
2535 function getLogMessage() {
2536 # Don't send to the exception log
2540 function getPageTitle() {
2541 global $wgSitename, $wgLang;
2542 $header = "$wgSitename has a problem";
2543 if ( $wgLang instanceof Language
) {
2544 $header = htmlspecialchars( $wgLang->getMessage( 'dberr-header' ) );
2550 function getHTML() {
2551 global $wgLang, $wgMessageCache, $wgUseFileCache, $wgShowDBErrorBacktrace;
2553 $sorry = 'Sorry! This site is experiencing technical difficulties.';
2554 $again = 'Try waiting a few minutes and reloading.';
2555 $info = '(Can\'t contact the database server: $1)';
2557 if ( $wgLang instanceof Language
) {
2558 $sorry = htmlspecialchars( $wgLang->getMessage( 'dberr-problems' ) );
2559 $again = htmlspecialchars( $wgLang->getMessage( 'dberr-again' ) );
2560 $info = htmlspecialchars( $wgLang->getMessage( 'dberr-info' ) );
2563 # No database access
2564 if ( is_object( $wgMessageCache ) ) {
2565 $wgMessageCache->disable();
2568 if ( trim( $this->error
) == '' ) {
2569 $this->error
= $this->db
->getProperty('mServer');
2572 $noconnect = "<p><strong>$sorry</strong><br />$again</p><p><small>$info</small></p>";
2573 $text = str_replace( '$1', $this->error
, $noconnect );
2575 if ( $wgShowDBErrorBacktrace ) {
2576 $text .= '<p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) );
2579 $extra = $this->searchForm();
2581 if( $wgUseFileCache ) {
2583 $cache = $this->fileCachedPage();
2584 # Cached version on file system?
2585 if( $cache !== null ) {
2586 # Hack: extend the body for error messages
2587 $cache = str_replace( array('</html>','</body>'), '', $cache );
2588 # Add cache notice...
2589 $cachederror = "This is a cached copy of the requested page, and may not be up to date. ";
2590 # Localize it if possible...
2591 if( $wgLang instanceof Language
) {
2592 $cachederror = htmlspecialchars( $wgLang->getMessage( 'dberr-cachederror' ) );
2594 $warning = "<div style='color:red;font-size:150%;font-weight:bold;'>$cachederror</div>";
2595 # Output cached page with notices on bottom and re-close body
2596 return "{$cache}{$warning}<hr />$text<hr />$extra</body></html>";
2598 } catch( MWException
$e ) {
2599 // Do nothing, just use the default page
2602 # Headers needed here - output is just the error message
2603 return $this->htmlHeader()."$text<hr />$extra".$this->htmlFooter();
2606 function searchForm() {
2607 global $wgSitename, $wgServer, $wgLang, $wgInputEncoding;
2608 $usegoogle = "You can try searching via Google in the meantime.";
2609 $outofdate = "Note that their indexes of our content may be out of date.";
2610 $googlesearch = "Search";
2612 if ( $wgLang instanceof Language
) {
2613 $usegoogle = htmlspecialchars( $wgLang->getMessage( 'dberr-usegoogle' ) );
2614 $outofdate = htmlspecialchars( $wgLang->getMessage( 'dberr-outofdate' ) );
2615 $googlesearch = htmlspecialchars( $wgLang->getMessage( 'searchbutton' ) );
2618 $search = htmlspecialchars(@$_REQUEST['search']);
2621 <div style="margin: 1.5em">$usegoogle<br />
2622 <small>$outofdate</small></div>
2623 <!-- SiteSearch Google -->
2624 <form method="get" action="http://www.google.com/search" id="googlesearch">
2625 <input type="hidden" name="domains" value="$wgServer" />
2626 <input type="hidden" name="num" value="50" />
2627 <input type="hidden" name="ie" value="$wgInputEncoding" />
2628 <input type="hidden" name="oe" value="$wgInputEncoding" />
2630 <input type="text" name="q" size="31" maxlength="255" value="$search" />
2631 <input type="submit" name="btnG" value="$googlesearch" />
2633 <input type="radio" name="sitesearch" id="gwiki" value="$wgServer" checked="checked" /><label for="gwiki">$wgSitename</label>
2634 <input type="radio" name="sitesearch" id="gWWW" value="" /><label for="gWWW">WWW</label>
2637 <!-- SiteSearch Google -->
2642 function fileCachedPage() {
2643 global $wgTitle, $title, $wgLang, $wgOut;
2644 if( $wgOut->isDisabled() ) return; // Done already?
2645 $mainpage = 'Main Page';
2646 if ( $wgLang instanceof Language
) {
2647 $mainpage = htmlspecialchars( $wgLang->getMessage( 'mainpage' ) );
2652 } elseif( $title ) {
2653 $t = Title
::newFromURL( $title );
2655 $t = Title
::newFromText( $mainpage );
2658 $cache = new HTMLFileCache( $t );
2659 if( $cache->isFileCached() ) {
2660 return $cache->fetchPageText();
2666 function htmlBodyOnly() {
2675 class DBQueryError
extends DBError
{
2676 public $error, $errno, $sql, $fname;
2678 function __construct( DatabaseBase
&$db, $error, $errno, $sql, $fname ) {
2679 $message = "A database error has occurred\n" .
2681 "Function: $fname\n" .
2682 "Error: $errno $error\n";
2684 parent
::__construct( $db, $message );
2685 $this->error
= $error;
2686 $this->errno
= $errno;
2688 $this->fname
= $fname;
2691 function getText() {
2692 global $wgShowDBErrorBacktrace;
2693 if ( $this->useMessageCache() ) {
2694 $s = wfMsg( 'dberrortextcl', htmlspecialchars( $this->getSQL() ),
2695 htmlspecialchars( $this->fname
), $this->errno
, htmlspecialchars( $this->error
) ) . "\n";
2696 if ( $wgShowDBErrorBacktrace ) {
2697 $s .= "Backtrace:\n" . $this->getTraceAsString() . "\n";
2701 return parent
::getText();
2706 global $wgShowSQLErrors;
2707 if( !$wgShowSQLErrors ) {
2708 return $this->msg( 'sqlhidden', 'SQL hidden' );
2714 function getLogMessage() {
2715 # Don't send to the exception log
2719 function getPageTitle() {
2720 return $this->msg( 'databaseerror', 'Database error' );
2723 function getHTML() {
2724 global $wgShowDBErrorBacktrace;
2725 if ( $this->useMessageCache() ) {
2726 $s = wfMsgNoDB( 'dberrortext', htmlspecialchars( $this->getSQL() ),
2727 htmlspecialchars( $this->fname
), $this->errno
, htmlspecialchars( $this->error
) );
2729 $s = nl2br( htmlspecialchars( $this->getMessage() ) );
2731 if ( $wgShowDBErrorBacktrace ) {
2732 $s .= '<p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) );
2741 class DBUnexpectedError
extends DBError
{}
2745 * Result wrapper for grabbing data queried by someone else
2748 class ResultWrapper
implements Iterator
{
2749 var $db, $result, $pos = 0, $currentRow = null;
2752 * Create a new result object from a result resource and a Database object
2754 function ResultWrapper( $database, $result ) {
2755 $this->db
= $database;
2756 if ( $result instanceof ResultWrapper
) {
2757 $this->result
= $result->result
;
2759 $this->result
= $result;
2764 * Get the number of rows in a result object
2766 function numRows() {
2767 return $this->db
->numRows( $this );
2771 * Fetch the next row from the given result object, in object form.
2772 * Fields can be retrieved with $row->fieldname, with fields acting like
2775 * @return MySQL row object
2776 * @throws DBUnexpectedError Thrown if the database returns an error
2778 function fetchObject() {
2779 return $this->db
->fetchObject( $this );
2783 * Fetch the next row from the given result object, in associative array
2784 * form. Fields are retrieved with $row['fieldname'].
2786 * @return MySQL row object
2787 * @throws DBUnexpectedError Thrown if the database returns an error
2789 function fetchRow() {
2790 return $this->db
->fetchRow( $this );
2794 * Free a result object
2797 $this->db
->freeResult( $this );
2798 unset( $this->result
);
2803 * Change the position of the cursor in a result object
2804 * See mysql_data_seek()
2806 function seek( $row ) {
2807 $this->db
->dataSeek( $this, $row );
2810 /*********************
2811 * Iterator functions
2812 * Note that using these in combination with the non-iterator functions
2813 * above may cause rows to be skipped or repeated.
2817 if ($this->numRows()) {
2818 $this->db
->dataSeek($this, 0);
2821 $this->currentRow
= null;
2824 function current() {
2825 if ( is_null( $this->currentRow
) ) {
2828 return $this->currentRow
;
2837 $this->currentRow
= $this->fetchObject();
2838 return $this->currentRow
;
2842 return $this->current() !== false;
2846 /* Overloads the relevant methods of the real ResultsWrapper so it
2847 * doesn't go anywhere near an actual database.
2849 class FakeResultWrapper
extends ResultWrapper
{
2851 var $result = array();
2852 var $db = null; // And it's going to stay that way :D
2854 var $currentRow = null;
2856 function __construct( $array ){
2857 $this->result
= $array;
2860 function numRows() {
2861 return count( $this->result
);
2864 function fetchRow() {
2865 $this->currentRow
= $this->result
[$this->pos++
];
2866 return $this->currentRow
;
2869 function seek( $row ) {
2875 // Callers want to be able to access fields with $this->fieldName
2876 function fetchObject(){
2877 $this->currentRow
= $this->result
[$this->pos++
];
2878 return (object)$this->currentRow
;
2883 $this->currentRow
= null;
2888 * Used by DatabaseBase::buildLike() to represent characters that have special meaning in SQL LIKE clauses
2889 * and thus need no escaping. Don't instantiate it manually, use Database::anyChar() and anyString() instead.
2894 public function __construct( $s ) {
2898 public function toString() {