3 * This file deals with MySQL interface functions
4 * and query specifics/optimisations
9 * Depends on the CacheManager
11 require_once( 'CacheManager.php' );
13 /** See Database::makeList() */
14 define( 'LIST_COMMA', 0 );
15 define( 'LIST_AND', 1 );
16 define( 'LIST_SET', 2 );
17 define( 'LIST_NAMES', 3);
19 /** Number of times to re-try an operation in case of deadlock */
20 define( 'DEADLOCK_TRIES', 4 );
21 /** Minimum time to wait before retry, in microseconds */
22 define( 'DEADLOCK_DELAY_MIN', 500000 );
23 /** Maximum time to wait before retry */
24 define( 'DEADLOCK_DELAY_MAX', 1500000 );
27 * Database abstraction object
32 #------------------------------------------------------------------------------
34 #------------------------------------------------------------------------------
40 var $mServer, $mUser, $mPassword, $mConn, $mDBname;
41 var $mOut, $mOpened = false;
49 #------------------------------------------------------------------------------
51 #------------------------------------------------------------------------------
52 # These optionally set a variable and return the previous state
55 * Fail function, takes a Database as a parameter
56 * Set to false for default, 1 for ignore errors
58 function failFunction( $function = NULL ) {
59 return wfSetVar( $this->mFailFunction
, $function );
63 * Output page, used for reporting errors
64 * FALSE means discard output
66 function &setOutputPage( &$out ) {
71 * Boolean, controls output of large amounts of debug information
73 function debug( $debug = NULL ) {
74 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
78 * Turns buffering of SQL result sets on (true) or off (false).
79 * Default is "on" and it should not be changed without good reasons.
81 function bufferResults( $buffer = NULL ) {
82 if ( is_null( $buffer ) ) {
83 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
85 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
90 * Turns on (false) or off (true) the automatic generation and sending
91 * of a "we're sorry, but there has been a database error" page on
92 * database errors. Default is on (false). When turned off, the
93 * code should use wfLastErrno() and wfLastError() to handle the
94 * situation as appropriate.
96 function ignoreErrors( $ignoreErrors = NULL ) {
97 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
101 * The current depth of nested transactions
102 * @param integer $level
104 function trxLevel( $level = NULL ) {
105 return wfSetVar( $this->mTrxLevel
, $level );
111 function lastQuery() { return $this->mLastQuery
; }
112 function isOpen() { return $this->mOpened
; }
115 #------------------------------------------------------------------------------
117 #------------------------------------------------------------------------------
120 * @param string $server database server host
121 * @param string $user database user name
122 * @param string $password database user password
123 * @param string $dbname database name
127 * @param failFunction
129 * @param string $tablePrefix Database table prefixes. By default use the prefix gave in LocalSettings.php
131 function Database( $server = false, $user = false, $password = false, $dbName = false,
132 $failFunction = false, $flags = 0, $tablePrefix = 'get from global' ) {
134 global $wgOut, $wgDBprefix, $wgCommandLineMode;
135 # Can't get a reference if it hasn't been set yet
136 if ( !isset( $wgOut ) ) {
139 $this->mOut
=& $wgOut;
141 $this->mFailFunction
= $failFunction;
142 $this->mFlags
= $flags;
144 if ( $this->mFlags
& DBO_DEFAULT
) {
145 if ( $wgCommandLineMode ) {
146 $this->mFlags
&= ~DBO_TRX
;
148 $this->mFlags |
= DBO_TRX
;
152 /** Get the default table prefix*/
153 if ( $tablePrefix == 'get from global' ) {
154 $this->mTablePrefix
= $wgDBprefix;
156 $this->mTablePrefix
= $tablePrefix;
160 $this->open( $server, $user, $password, $dbName );
166 * @param failFunction
169 function newFromParams( $server, $user, $password, $dbName,
170 $failFunction = false, $flags = 0 )
172 return new Database( $server, $user, $password, $dbName, $failFunction, $flags );
176 * Usually aborts on failure
177 * If the failFunction is set to a non-zero integer, returns success
179 function open( $server, $user, $password, $dbName ) {
180 # Test for missing mysql.so
181 # First try to load it
182 if (!@extension_loaded
('mysql')) {
186 # Otherwise we get a suppressed fatal error, which is very hard to track down
187 if ( !function_exists( 'mysql_connect' ) ) {
188 die( "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
192 $this->mServer
= $server;
193 $this->mUser
= $user;
194 $this->mPassword
= $password;
195 $this->mDBname
= $dbName;
199 @/**/$this->mConn
= mysql_connect( $server, $user, $password );
200 if ( $dbName != '' ) {
201 if ( $this->mConn
!== false ) {
202 $success = @/**/mysql_select_db( $dbName, $this->mConn
);
204 wfDebug( "Error selecting database \"$dbName\": " . $this->lastError() . "\n" );
207 wfDebug( "DB connection error\n" );
208 wfDebug( "Server: $server, User: $user, Password: " .
209 substr( $password, 0, 3 ) . "...\n" );
214 $success = !!$this->mConn
;
218 $this->reportConnectionError();
221 $this->mOpened
= $success;
227 * Closes a database connection.
228 * if it is open : commits any open transactions
230 * @return bool operation success. true if already closed.
234 $this->mOpened
= false;
235 if ( $this->mConn
) {
236 if ( $this->trxLevel() ) {
237 $this->immediateCommit();
239 return mysql_close( $this->mConn
);
247 * @param string $msg error message ?
248 * @todo parameter $msg is not used
250 function reportConnectionError( $msg = '') {
251 if ( $this->mFailFunction
) {
252 if ( !is_int( $this->mFailFunction
) ) {
253 $ff = $this->mFailFunction
;
254 $ff( $this, mysql_error() );
257 wfEmergencyAbort( $this, mysql_error() );
262 * Usually aborts on failure
263 * If errors are explicitly ignored, returns success
265 function query( $sql, $fname = '', $tempIgnore = false ) {
266 global $wgProfiling, $wgCommandLineMode;
268 if ( $wgProfiling ) {
269 # generalizeSQL will probably cut down the query to reasonable
270 # logging size most of the time. The substr is really just a sanity check.
271 $profName = 'query: ' . substr( Database
::generalizeSQL( $sql ), 0, 255 );
272 wfProfileIn( $profName );
275 $this->mLastQuery
= $sql;
277 if ( $this->debug() ) {
278 $sqlx = substr( $sql, 0, 500 );
279 $sqlx = wordwrap(strtr($sqlx,"\t\n",' '));
280 wfDebug( "SQL: $sqlx\n" );
282 # Add a comment for easy SHOW PROCESSLIST interpretation
284 $commentedSql = "/* $fname */ $sql";
286 $commentedSql = $sql;
289 # If DBO_TRX is set, start a transaction
290 if ( ( $this->mFlags
& DBO_TRX
) && !$this->trxLevel() && $sql != 'BEGIN' ) {
294 # Do the query and handle errors
295 $ret = $this->doQuery( $commentedSql );
296 if ( false === $ret ) {
297 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
300 if ( $wgProfiling ) {
301 wfProfileOut( $profName );
307 * The DBMS-dependent part of query()
308 * @param string $sql SQL query.
310 function doQuery( $sql ) {
311 if( $this->bufferResults() ) {
312 $ret = mysql_query( $sql, $this->mConn
);
314 $ret = mysql_unbuffered_query( $sql, $this->mConn
);
323 * @param string $fname
324 * @param bool $tempIgnore
326 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
327 global $wgCommandLineMode, $wgFullyInitialised;
328 # Ignore errors during error handling to avoid infinite recursion
329 $ignore = $this->ignoreErrors( true );
331 if( $ignore ||
$tempIgnore ) {
332 wfDebug("SQL ERROR (ignored): " . $error . "\n");
334 $sql1line = str_replace( "\n", "\\n", $sql );
335 wfLogDBError("$fname\t$errno\t$error\t$sql1line\n");
336 wfDebug("SQL ERROR: " . $error . "\n");
337 if ( $wgCommandLineMode ||
!$this->mOut ||
empty( $wgFullyInitialised ) ) {
338 $message = "A database error has occurred\n" .
340 "Function: $fname\n" .
341 "Error: $errno $error\n";
342 if ( !$wgCommandLineMode ) {
343 $message = nl2br( $message );
345 wfDebugDieBacktrace( $message );
347 // this calls wfAbruptExit()
348 $this->mOut
->databaseError( $fname, $sql, $error, $errno );
351 $this->ignoreErrors( $ignore );
356 * Intended to be compatible with the PEAR::DB wrapper functions.
357 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
359 * ? = scalar value, quoted as necessary
360 * ! = raw SQL bit (a function for instance)
361 * & = filename; reads the file and inserts as a blob
362 * (we don't use this though...)
364 function prepare( $sql, $func = 'Database::prepare' ) {
365 /* MySQL doesn't support prepared statements (yet), so just
366 pack up the query for reference. We'll manually replace
368 return array( 'query' => $sql, 'func' => $func );
371 function freePrepared( $prepared ) {
372 /* No-op for MySQL */
376 * Execute a prepared query with the various arguments
377 * @param string $prepared the prepared sql
378 * @param mixed $args Either an array here, or put scalars as varargs
380 function execute( $prepared, $args = null ) {
381 if( !is_array( $args ) ) {
383 $args = func_get_args();
384 array_shift( $args );
386 $sql = $this->fillPrepared( $prepared['query'], $args );
387 return $this->query( $sql, $prepared['func'] );
391 * Prepare & execute an SQL statement, quoting and inserting arguments
392 * in the appropriate places.
393 * @param string $query
394 * @param string $args (default null)
396 function safeQuery( $query, $args = null ) {
397 $prepared = $this->prepare( $query, 'Database::safeQuery' );
398 if( !is_array( $args ) ) {
400 $args = func_get_args();
401 array_shift( $args );
403 $retval = $this->execute( $prepared, $args );
404 $this->freePrepared( $prepared );
409 * For faking prepared SQL statements on DBs that don't support
411 * @param string $preparedSql - a 'preparable' SQL statement
412 * @param array $args - array of arguments to fill it with
413 * @return string executable SQL
415 function fillPrepared( $preparedQuery, $args ) {
418 $this->preparedArgs
=& $args;
419 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
420 array( &$this, 'fillPreparedArg' ), $preparedQuery );
424 * preg_callback func for fillPrepared()
425 * The arguments should be in $this->preparedArgs and must not be touched
426 * while we're doing this.
428 * @param array $matches
432 function fillPreparedArg( $matches ) {
433 switch( $matches[1] ) {
434 case '\\?': return '?';
435 case '\\!': return '!';
436 case '\\&': return '&';
438 list( $n, $arg ) = each( $this->preparedArgs
);
439 switch( $matches[1] ) {
440 case '?': return $this->addQuotes( $arg );
441 case '!': return $arg;
443 # return $this->addQuotes( file_get_contents( $arg ) );
444 wfDebugDieBacktrace( '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
446 wfDebugDieBacktrace( 'Received invalid match. This should never happen!' );
451 * @param mixed $res A SQL result
454 * Free a result object
456 function freeResult( $res ) {
457 if ( !@/**/mysql_free_result( $res ) ) {
458 wfDebugDieBacktrace( "Unable to free MySQL result\n" );
463 * Fetch the next row from the given result object, in object form
465 function fetchObject( $res ) {
466 @/**/$row = mysql_fetch_object( $res );
467 if( mysql_errno() ) {
468 wfDebugDieBacktrace( 'Error in fetchObject(): ' . htmlspecialchars( mysql_error() ) );
474 * Fetch the next row from the given result object
477 function fetchRow( $res ) {
478 @/**/$row = mysql_fetch_array( $res );
479 if (mysql_errno() ) {
480 wfDebugDieBacktrace( 'Error in fetchRow(): ' . htmlspecialchars( mysql_error() ) );
486 * Get the number of rows in a result object
488 function numRows( $res ) {
489 @/**/$n = mysql_num_rows( $res );
490 if( mysql_errno() ) {
491 wfDebugDieBacktrace( 'Error in numRows(): ' . htmlspecialchars( mysql_error() ) );
497 * Get the number of fields in a result object
498 * See documentation for mysql_num_fields()
500 function numFields( $res ) { return mysql_num_fields( $res ); }
503 * Get a field name in a result object
504 * See documentation for mysql_field_name()
506 function fieldName( $res, $n ) { return mysql_field_name( $res, $n ); }
509 * Get the inserted value of an auto-increment row
511 * The value inserted should be fetched from nextSequenceValue()
514 * $id = $dbw->nextSequenceValue('page_page_id_seq');
515 * $dbw->insert('page',array('page_id' => $id));
516 * $id = $dbw->insertId();
518 function insertId() { return mysql_insert_id( $this->mConn
); }
521 * Change the position of the cursor in a result object
522 * See mysql_data_seek()
524 function dataSeek( $res, $row ) { return mysql_data_seek( $res, $row ); }
527 * Get the last error number
530 function lastErrno() {
531 if ( $this->mConn
) {
532 return mysql_errno( $this->mConn
);
534 return mysql_errno();
539 * Get a description of the last error
540 * See mysql_error() for more details
542 function lastError() {
543 if ( $this->mConn
) {
544 $error = mysql_error( $this->mConn
);
546 $error = mysql_error();
549 $error .= ' (' . $this->mServer
. ')';
554 * Get the number of rows affected by the last write query
555 * See mysql_affected_rows() for more details
557 function affectedRows() { return mysql_affected_rows( $this->mConn
); }
558 /**#@-*/ // end of template : @param $result
561 * Simple UPDATE wrapper
562 * Usually aborts on failure
563 * If errors are explicitly ignored, returns success
565 * This function exists for historical reasons, Database::update() has a more standard
566 * calling convention and feature set
568 function set( $table, $var, $value, $cond, $fname = 'Database::set' )
570 $table = $this->tableName( $table );
571 $sql = "UPDATE $table SET $var = '" .
572 $this->strencode( $value ) . "' WHERE ($cond)";
573 return !!$this->query( $sql, DB_MASTER
, $fname );
577 * Simple SELECT wrapper, returns a single field, input must be encoded
578 * Usually aborts on failure
579 * If errors are explicitly ignored, returns FALSE on failure
581 function selectField( $table, $var, $cond='', $fname = 'Database::selectField', $options = array() ) {
582 if ( !is_array( $options ) ) {
583 $options = array( $options );
585 $options['LIMIT'] = 1;
587 $res = $this->select( $table, $var, $cond, $fname, $options );
588 if ( $res === false ||
!$this->numRows( $res ) ) {
591 $row = $this->fetchRow( $res );
592 if ( $row !== false ) {
593 $this->freeResult( $res );
601 * Returns an optional USE INDEX clause to go after the table, and a
602 * string to go at the end of the query
604 function makeSelectOptions( $options ) {
605 if ( !is_array( $options ) ) {
606 $options = array( $options );
611 if ( isset( $options['ORDER BY'] ) ) {
612 $tailOpts .= " ORDER BY {$options['ORDER BY']}";
614 if ( isset( $options['LIMIT'] ) ) {
615 $tailOpts .= " LIMIT {$options['LIMIT']}";
618 if ( is_numeric( array_search( 'FOR UPDATE', $options ) ) ) {
619 $tailOpts .= ' FOR UPDATE';
622 if ( is_numeric( array_search( 'LOCK IN SHARE MODE', $options ) ) ) {
623 $tailOpts .= ' LOCK IN SHARE MODE';
626 if ( isset( $options['USE INDEX'] ) ) {
627 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
631 return array( $useIndex, $tailOpts );
637 function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array() )
639 if( is_array( $vars ) ) {
640 $vars = implode( ',', $vars );
642 if( is_array( $table ) ) {
643 $from = ' FROM ' . implode( ',', array_map( array( &$this, 'tableName' ), $table ) );
644 } elseif ($table!='') {
645 $from = ' FROM ' .$this->tableName( $table );
650 list( $useIndex, $tailOpts ) = $this->makeSelectOptions( $options );
652 if( !empty( $conds ) ) {
653 if ( is_array( $conds ) ) {
654 $conds = $this->makeList( $conds, LIST_AND
);
656 $sql = "SELECT $vars $from $useIndex WHERE $conds $tailOpts";
658 $sql = "SELECT $vars $from $useIndex $tailOpts";
660 return $this->query( $sql, $fname );
664 * Single row SELECT wrapper
665 * Aborts or returns FALSE on error
667 * $vars: the selected variables
668 * $conds: a condition map, terms are ANDed together.
669 * Items with numeric keys are taken to be literal conditions
670 * Takes an array of selected variables, and a condition map, which is ANDed
671 * e.g: selectRow( "page", array( "page_id" ), array( "page_namespace" =>
672 * NS_MAIN, "page_title" => "Astronomy" ) ) would return an object where
673 * $obj- >page_id is the ID of the Astronomy article
675 * @todo migrate documentation to phpdocumentor format
677 function selectRow( $table, $vars, $conds, $fname = 'Database::selectRow', $options = array() ) {
678 $options['LIMIT'] = 1;
679 $res = $this->select( $table, $vars, $conds, $fname, $options );
680 if ( $res === false ||
!$this->numRows( $res ) ) {
683 $obj = $this->fetchObject( $res );
684 $this->freeResult( $res );
690 * Removes most variables from an SQL query and replaces them with X or N for numbers.
691 * It's only slightly flawed. Don't use for anything important.
693 * @param string $sql A SQL Query
696 function generalizeSQL( $sql ) {
697 # This does the same as the regexp below would do, but in such a way
698 # as to avoid crashing php on some large strings.
699 # $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
701 $sql = str_replace ( "\\\\", '', $sql);
702 $sql = str_replace ( "\\'", '', $sql);
703 $sql = str_replace ( "\\\"", '', $sql);
704 $sql = preg_replace ("/'.*'/s", "'X'", $sql);
705 $sql = preg_replace ('/".*"/s', "'X'", $sql);
707 # All newlines, tabs, etc replaced by single space
708 $sql = preg_replace ( "/\s+/", ' ', $sql);
711 $sql = preg_replace ('/-?[0-9]+/s', 'N', $sql);
717 * Determines whether a field exists in a table
718 * Usually aborts on failure
719 * If errors are explicitly ignored, returns NULL on failure
721 function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) {
722 $table = $this->tableName( $table );
723 $res = $this->query( 'DESCRIBE '.$table, DB_SLAVE
, $fname );
730 while ( $row = $this->fetchObject( $res ) ) {
731 if ( $row->Field
== $field ) {
740 * Determines whether an index exists
741 * Usually aborts on failure
742 * If errors are explicitly ignored, returns NULL on failure
744 function indexExists( $table, $index, $fname = 'Database::indexExists' ) {
745 $info = $this->indexInfo( $table, $index, $fname );
746 if ( is_null( $info ) ) {
749 return $info !== false;
755 * Get information about an index into an object
756 * Returns false if the index does not exist
758 function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
759 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
760 # SHOW INDEX should work for 3.x and up:
761 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
762 $table = $this->tableName( $table );
763 $sql = 'SHOW INDEX FROM '.$table;
764 $res = $this->query( $sql, $fname );
769 while ( $row = $this->fetchObject( $res ) ) {
770 if ( $row->Key_name
== $index ) {
778 * Query whether a given table exists
780 function tableExists( $table ) {
781 $table = $this->tableName( $table );
782 $old = $this->ignoreErrors( true );
783 $res = $this->query( "SELECT 1 FROM $table LIMIT 1" );
784 $this->ignoreErrors( $old );
786 $this->freeResult( $res );
794 * mysql_fetch_field() wrapper
795 * Returns false if the field doesn't exist
800 function fieldInfo( $table, $field ) {
801 $table = $this->tableName( $table );
802 $res = $this->query( "SELECT * FROM $table LIMIT 1" );
803 $n = mysql_num_fields( $res );
804 for( $i = 0; $i < $n; $i++
) {
805 $meta = mysql_fetch_field( $res, $i );
806 if( $field == $meta->name
) {
814 * mysql_field_type() wrapper
816 function fieldType( $res, $index ) {
817 return mysql_field_type( $res, $index );
821 * Determines if a given index is unique
823 function indexUnique( $table, $index ) {
824 $indexInfo = $this->indexInfo( $table, $index );
828 return !$indexInfo->Non_unique
;
832 * INSERT wrapper, inserts an array into a table
834 * $a may be a single associative array, or an array of these with numeric keys, for
837 * Usually aborts on failure
838 * If errors are explicitly ignored, returns success
840 function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
841 # No rows to insert, easy just return now
842 if ( !count( $a ) ) {
846 $table = $this->tableName( $table );
847 if ( !is_array( $options ) ) {
848 $options = array( $options );
850 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
852 $keys = array_keys( $a[0] );
855 $keys = array_keys( $a );
858 $sql = 'INSERT ' . implode( ' ', $options ) .
859 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
863 foreach ( $a as $row ) {
869 $sql .= '(' . $this->makeList( $row ) . ')';
872 $sql .= '(' . $this->makeList( $a ) . ')';
874 return !!$this->query( $sql, $fname );
878 * UPDATE wrapper, takes a condition array and a SET array
880 function update( $table, $values, $conds, $fname = 'Database::update' ) {
881 $table = $this->tableName( $table );
882 $sql = "UPDATE $table SET " . $this->makeList( $values, LIST_SET
);
883 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
884 $this->query( $sql, $fname );
888 * Makes a wfStrencoded list from an array
889 * $mode: LIST_COMMA - comma separated, no field names
890 * LIST_AND - ANDed WHERE clause (without the WHERE)
891 * LIST_SET - comma separated with field names, like a SET clause
892 * LIST_NAMES - comma separated field names
894 function makeList( $a, $mode = LIST_COMMA
) {
895 if ( !is_array( $a ) ) {
896 wfDebugDieBacktrace( 'Database::makeList called with incorrect parameters' );
901 foreach ( $a as $field => $value ) {
903 if ( $mode == LIST_AND
) {
911 if ( $mode == LIST_AND
&& is_numeric( $field ) ) {
913 } elseif ( $mode == LIST_AND
&& is_array ($value) ) {
914 $list .= $field." IN (".$this->makeList($value).") ";
916 if ( $mode == LIST_AND ||
$mode == LIST_SET
) {
919 $list .= ($mode==LIST_NAMES?
$value:$this->addQuotes( $value ));
926 * Change the current database
928 function selectDB( $db ) {
929 $this->mDBname
= $db;
930 return mysql_select_db( $db, $this->mConn
);
934 * Starts a timer which will kill the DB thread after $timeout seconds
936 function startTimer( $timeout ) {
938 if( function_exists( 'mysql_thread_id' ) ) {
939 # This will kill the query if it's still running after $timeout seconds.
940 $tid = mysql_thread_id( $this->mConn
);
941 exec( "php $IP/includes/killthread.php $timeout $tid &>/dev/null &" );
946 * Stop a timer started by startTimer()
947 * Currently unimplemented.
950 function stopTimer() { }
953 * Format a table name ready for use in constructing an SQL query
955 * This does two important things: it quotes table names which as necessary,
956 * and it adds a table prefix if there is one.
958 * All functions of this object which require a table name call this function
959 * themselves. Pass the canonical name to such functions. This is only needed
960 * when calling query() directly.
962 * @param string $name database table name
964 function tableName( $name ) {
966 if ( $this->mTablePrefix
!== '' ) {
967 if ( strpos( '.', $name ) === false ) {
968 $name = $this->mTablePrefix
. $name;
971 if ( isset( $wgSharedDB ) && 'user' == $name ) {
972 $name = $wgSharedDB . '.' . $name;
974 if( $name == 'group' ) {
975 $name = '`' . $name . '`';
981 * Fetch a number of table names into an array
982 * This is handy when you need to construct SQL for joins
985 * extract($dbr->tableNames('user','watchlist'));
986 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
987 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
989 function tableNames() {
990 $inArray = func_get_args();
992 foreach ( $inArray as $name ) {
993 $retVal[$name] = $this->tableName( $name );
999 * Wrapper for addslashes()
1000 * @param string $s String to be slashed.
1001 * @return string slashed string.
1003 function strencode( $s ) {
1004 return addslashes( $s );
1008 * If it's a string, adds quotes and backslashes
1009 * Otherwise returns as-is
1011 function addQuotes( $s ) {
1012 if ( is_null( $s ) ) {
1015 # This will also quote numeric values. This should be harmless,
1016 # and protects against weird problems that occur when they really
1017 # _are_ strings such as article titles and string->number->string
1018 # conversion is not 1:1.
1019 $s = "'" . $this->strencode( $s ) . "'";
1025 * Returns an appropriately quoted sequence value for inserting a new row.
1026 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
1027 * subclass will return an integer, and save the value for insertId()
1029 function nextSequenceValue( $seqName ) {
1035 * PostgreSQL doesn't have them and returns ""
1037 function useIndexClause( $index ) {
1038 return 'USE INDEX ('.$index.')';
1042 * REPLACE query wrapper
1043 * PostgreSQL simulates this with a DELETE followed by INSERT
1044 * $row is the row to insert, an associative array
1045 * $uniqueIndexes is an array of indexes. Each element may be either a
1046 * field name or an array of field names
1048 * It may be more efficient to leave off unique indexes which are unlikely to collide.
1049 * However if you do this, you run the risk of encountering errors which wouldn't have
1052 * @todo migrate comment to phodocumentor format
1054 function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
1055 $table = $this->tableName( $table );
1058 if ( !is_array( reset( $rows ) ) ) {
1059 $rows = array( $rows );
1062 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) .') VALUES ';
1064 foreach ( $rows as $row ) {
1070 $sql .= '(' . $this->makeList( $row ) . ')';
1072 return $this->query( $sql, $fname );
1076 * DELETE where the condition is a join
1077 * MySQL does this with a multi-table DELETE syntax, PostgreSQL does it with sub-selects
1079 * For safety, an empty $conds will not delete everything. If you want to delete all rows where the
1080 * join condition matches, set $conds='*'
1082 * DO NOT put the join condition in $conds
1084 * @param string $delTable The table to delete from.
1085 * @param string $joinTable The other table.
1086 * @param string $delVar The variable to join on, in the first table.
1087 * @param string $joinVar The variable to join on, in the second table.
1088 * @param array $conds Condition array of field names mapped to variables, ANDed together in the WHERE clause
1090 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'Database::deleteJoin' ) {
1092 wfDebugDieBacktrace( 'Database::deleteJoin() called with empty $conds' );
1095 $delTable = $this->tableName( $delTable );
1096 $joinTable = $this->tableName( $joinTable );
1097 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1098 if ( $conds != '*' ) {
1099 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND
);
1102 return $this->query( $sql, $fname );
1106 * Returns the size of a text field, or -1 for "unlimited"
1108 function textFieldSize( $table, $field ) {
1109 $table = $this->tableName( $table );
1110 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
1111 $res = $this->query( $sql, 'Database::textFieldSize' );
1112 $row = $this->fetchObject( $res );
1113 $this->freeResult( $res );
1115 if ( preg_match( "/\((.*)\)/", $row->Type
, $m ) ) {
1124 * @return string Always return 'LOW_PRIORITY'
1126 function lowPriorityOption() {
1127 return 'LOW_PRIORITY';
1131 * DELETE query wrapper
1133 * Use $conds == "*" to delete all rows
1135 function delete( $table, $conds, $fname = 'Database::delete' ) {
1137 wfDebugDieBacktrace( 'Database::delete() called with no conditions' );
1139 $table = $this->tableName( $table );
1140 $sql = "DELETE FROM $table ";
1141 if ( $conds != '*' ) {
1142 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
1144 return $this->query( $sql, $fname );
1148 * INSERT SELECT wrapper
1149 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
1150 * Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
1151 * $conds may be "*" to copy the whole table
1152 * srcTable may be an array of tables.
1154 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'Database::insertSelect' ) {
1155 $destTable = $this->tableName( $destTable );
1156 if( is_array( $srcTable ) ) {
1157 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
1159 $srcTable = $this->tableName( $srcTable );
1161 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
1162 ' SELECT ' . implode( ',', $varMap ) .
1164 if ( $conds != '*' ) {
1165 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
1167 return $this->query( $sql, $fname );
1171 * Construct a LIMIT query with optional offset
1172 * This is used for query pages
1174 function limitResult($limit,$offset) {
1175 return ' LIMIT '.(is_numeric($offset)?
"{$offset},":"")."{$limit} ";
1179 * Returns an SQL expression for a simple conditional.
1182 * @param string $cond SQL expression which will result in a boolean value
1183 * @param string $trueVal SQL expression to return if true
1184 * @param string $falseVal SQL expression to return if false
1185 * @return string SQL fragment
1187 function conditional( $cond, $trueVal, $falseVal ) {
1188 return " IF($cond, $trueVal, $falseVal) ";
1192 * Determines if the last failure was due to a deadlock
1194 function wasDeadlock() {
1195 return $this->lastErrno() == 1213;
1199 * Perform a deadlock-prone transaction.
1201 * This function invokes a callback function to perform a set of write
1202 * queries. If a deadlock occurs during the processing, the transaction
1203 * will be rolled back and the callback function will be called again.
1206 * $dbw->deadlockLoop( callback, ... );
1208 * Extra arguments are passed through to the specified callback function.
1210 * Returns whatever the callback function returned on its successful,
1211 * iteration, or false on error, for example if the retry limit was
1214 function deadlockLoop() {
1215 $myFname = 'Database::deadlockLoop';
1217 $this->query( 'BEGIN', $myFname );
1218 $args = func_get_args();
1219 $function = array_shift( $args );
1220 $oldIgnore = $dbw->ignoreErrors( true );
1221 $tries = DEADLOCK_TRIES
;
1222 if ( is_array( $function ) ) {
1223 $fname = $function[0];
1228 $retVal = call_user_func_array( $function, $args );
1229 $error = $this->lastError();
1230 $errno = $this->lastErrno();
1231 $sql = $this->lastQuery();
1234 if ( $dbw->wasDeadlock() ) {
1236 usleep( mt_rand( DEADLOCK_DELAY_MIN
, DEADLOCK_DELAY_MAX
) );
1238 $dbw->reportQueryError( $error, $errno, $sql, $fname );
1241 } while( $dbw->wasDeadlock
&& --$tries > 0 );
1242 $this->ignoreErrors( $oldIgnore );
1243 if ( $tries <= 0 ) {
1244 $this->query( 'ROLLBACK', $myFname );
1245 $this->reportQueryError( $error, $errno, $sql, $fname );
1248 $this->query( 'COMMIT', $myFname );
1254 * Do a SELECT MASTER_POS_WAIT()
1256 * @param string $file the binlog file
1257 * @param string $pos the binlog position
1258 * @param integer $timeout the maximum number of seconds to wait for synchronisation
1260 function masterPosWait( $file, $pos, $timeout ) {
1261 $fname = 'Database::masterPosWait';
1262 wfProfileIn( $fname );
1265 # Commit any open transactions
1266 $this->immediateCommit();
1268 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
1269 $encFile = $this->strencode( $file );
1270 $sql = "SELECT MASTER_POS_WAIT('$encFile', $pos, $timeout)";
1271 $res = $this->doQuery( $sql );
1272 if ( $res && $row = $this->fetchRow( $res ) ) {
1273 $this->freeResult( $res );
1281 * Get the position of the master from SHOW SLAVE STATUS
1283 function getSlavePos() {
1284 $res = $this->query( 'SHOW SLAVE STATUS', 'Database::getSlavePos' );
1285 $row = $this->fetchObject( $res );
1287 return array( $row->Master_Log_File
, $row->Read_Master_Log_Pos
);
1289 return array( false, false );
1294 * Get the position of the master from SHOW MASTER STATUS
1296 function getMasterPos() {
1297 $res = $this->query( 'SHOW MASTER STATUS', 'Database::getMasterPos' );
1298 $row = $this->fetchObject( $res );
1300 return array( $row->File
, $row->Position
);
1302 return array( false, false );
1307 * Begin a transaction, or if a transaction has already started, continue it
1309 function begin( $fname = 'Database::begin' ) {
1310 if ( !$this->mTrxLevel
) {
1311 $this->immediateBegin( $fname );
1318 * End a transaction, or decrement the nest level if transactions are nested
1320 function commit( $fname = 'Database::commit' ) {
1321 if ( $this->mTrxLevel
) {
1324 if ( !$this->mTrxLevel
) {
1325 $this->immediateCommit( $fname );
1330 * Rollback a transaction
1332 function rollback( $fname = 'Database::rollback' ) {
1333 $this->query( 'ROLLBACK', $fname );
1334 $this->mTrxLevel
= 0;
1338 * Begin a transaction, committing any previously open transaction
1340 function immediateBegin( $fname = 'Database::immediateBegin' ) {
1341 $this->query( 'BEGIN', $fname );
1342 $this->mTrxLevel
= 1;
1346 * Commit transaction, if one is open
1348 function immediateCommit( $fname = 'Database::immediateCommit' ) {
1349 $this->query( 'COMMIT', $fname );
1350 $this->mTrxLevel
= 0;
1354 * Return MW-style timestamp used for MySQL schema
1356 function timestamp( $ts=0 ) {
1357 return wfTimestamp(TS_MW
,$ts);
1363 function &resultObject( &$result ) {
1364 if( empty( $result ) ) {
1367 return new ResultWrapper( $this, $result );
1372 * Return aggregated value alias
1374 function aggregateValue ($valuedata,$valuename='value') {
1379 * @return string wikitext of a link to the server software's web site
1381 function getSoftwareLink() {
1382 return "[http://www.mysql.com/ MySQL]";
1386 * @return string Version information from the database
1388 function getServerVersion() {
1389 return mysql_get_server_info();
1394 * Database abstraction object for mySQL
1395 * Inherit all methods and properties of Database::Database()
1397 * @package MediaWiki
1400 class DatabaseMysql
extends Database
{
1406 * Result wrapper for grabbing data queried by someone else
1408 * @package MediaWiki
1410 class ResultWrapper
{
1416 function ResultWrapper( $database, $result ) {
1417 $this->db
=& $database;
1418 $this->result
=& $result;
1424 function numRows() {
1425 return $this->db
->numRows( $this->result
);
1431 function &fetchObject() {
1432 return $this->db
->fetchObject( $this->result
);
1438 function &fetchRow() {
1439 return $this->db
->fetchRow( $this->result
);
1446 $this->db
->freeResult( $this->result
);
1447 unset( $this->result
);
1452 #------------------------------------------------------------------------------
1454 #------------------------------------------------------------------------------
1457 * Standard fail function, called by default when a connection cannot be
1459 * Displays the file cache if possible
1461 function wfEmergencyAbort( &$conn, $error ) {
1462 global $wgTitle, $wgUseFileCache, $title, $wgInputEncoding, $wgSiteNotice, $wgOutputEncoding;
1463 global $wgSitename, $wgServer;
1465 # I give up, Brion is right. Getting the message cache to work when there is no DB is tricky.
1466 # Hard coding strings instead.
1468 $noconnect = 'Sorry! The wiki is experiencing some technical difficulties, and cannot contact the database server. <br />
1470 $mainpage = 'Main Page';
1471 $searchdisabled = <<<EOT
1472 <p style="margin: 1.5em 2em 1em">$wgSitename search is disabled for performance reasons. You can search via Google in the meantime.
1473 <span style="font-size: 89%; display: block; margin-left: .2em">Note that their indexes of $wgSitename content may be out of date.</span></p>',
1477 <!-- SiteSearch Google -->
1478 <FORM method=GET action=\"http://www.google.com/search\">
1479 <TABLE bgcolor=\"#FFFFFF\"><tr><td>
1480 <A HREF=\"http://www.google.com/\">
1481 <IMG SRC=\"http://www.google.com/logos/Logo_40wht.gif\"
1482 border=\"0\" ALT=\"Google\"></A>
1485 <INPUT TYPE=text name=q size=31 maxlength=255 value=\"$1\">
1486 <INPUT type=submit name=btnG VALUE=\"Google Search\">
1488 <input type=hidden name=domains value=\"$wgServer\"><br /><input type=radio name=sitesearch value=\"\"> WWW <input type=radio name=sitesearch value=\"$wgServer\" checked> $wgServer <br />
1489 <input type='hidden' name='ie' value='$2'>
1490 <input type='hidden' name='oe' value='$2'>
1494 <!-- SiteSearch Google -->";
1495 $cachederror = "The following is a cached copy of the requested page, and may not be up to date. ";
1498 if( !headers_sent() ) {
1499 header( 'HTTP/1.0 500 Internal Server Error' );
1500 header( 'Content-type: text/html; charset='.$wgOutputEncoding );
1501 /* Don't cache error pages! They cause no end of trouble... */
1502 header( 'Cache-control: none' );
1503 header( 'Pragma: nocache' );
1505 $msg = $wgSiteNotice;
1507 $msg = str_replace( '$1', $error, $noconnect );
1511 if($wgUseFileCache) {
1516 $t = Title
::newFromURL( $title );
1517 } elseif (@/**/$_REQUEST['search']) {
1518 $search = $_REQUEST['search'];
1519 echo $searchdisabled;
1520 echo str_replace( array( '$1', '$2' ), array( htmlspecialchars( $search ),
1521 $wgInputEncoding ), $googlesearch );
1524 $t = Title
::newFromText( $mainpage );
1528 $cache = new CacheManager( $t );
1529 if( $cache->isFileCached() ) {
1530 $msg = '<p style="color: red"><b>'.$msg."<br />\n" .
1531 $cachederror . "</b></p>\n";
1533 $tag = '<div id="article">';
1534 $text = str_replace(
1537 $cache->fetchPageText() );