3 * This file deals with MySQL interface functions
4 * and query specifics/optimisations
7 /** Number of times to re-try an operation in case of deadlock */
8 define( 'DEADLOCK_TRIES', 4 );
9 /** Minimum time to wait before retry, in microseconds */
10 define( 'DEADLOCK_DELAY_MIN', 500000 );
11 /** Maximum time to wait before retry */
12 define( 'DEADLOCK_DELAY_MAX', 1500000 );
14 /******************************************************************************
16 *****************************************************************************/
20 * @addtogroup Database
25 function DBObject($data) {
40 * @addtogroup Database
43 private $name, $tablename, $default, $max_length, $nullable,
44 $is_pk, $is_unique, $is_key, $type;
45 function __construct ($info) {
46 $this->name
= $info->name
;
47 $this->tablename
= $info->table
;
48 $this->default = $info->def
;
49 $this->max_length
= $info->max_length
;
50 $this->nullable
= !$info->not_null
;
51 $this->is_pk
= $info->primary_key
;
52 $this->is_unique
= $info->unique_key
;
53 $this->is_multiple
= $info->multiple_key
;
54 $this->is_key
= ($this->is_pk ||
$this->is_unique ||
$this->is_multiple
);
55 $this->type
= $info->type
;
62 function tableName() {
63 return $this->tableName
;
66 function defaultValue() {
67 return $this->default;
70 function maxLength() {
71 return $this->max_length
;
75 return $this->nullable
;
82 function isMultipleKey() {
83 return $this->is_multiple
;
91 /******************************************************************************
93 *****************************************************************************/
96 * Database error base class
97 * @addtogroup Database
99 class DBError
extends MWException
{
103 * Construct a database error
104 * @param Database $db The database object which threw the error
105 * @param string $error A simple error message to be used for debugging
107 function __construct( Database
&$db, $error ) {
109 parent
::__construct( $error );
114 * @addtogroup Database
116 class DBConnectionError
extends DBError
{
119 function __construct( Database
&$db, $error = 'unknown error' ) {
120 $msg = 'DB connection error';
121 if ( trim( $error ) != '' ) {
124 $this->error
= $error;
125 parent
::__construct( $db, $msg );
128 function useOutputPage() {
129 // Not likely to work
133 function useMessageCache() {
134 // Not likely to work
139 return $this->getMessage() . "\n";
142 function getLogMessage() {
143 # Don't send to the exception log
147 function getPageTitle() {
149 return "$wgSitename has a problem";
153 global $wgTitle, $wgUseFileCache, $title, $wgInputEncoding;
154 global $wgSitename, $wgServer, $wgMessageCache;
156 # I give up, Brion is right. Getting the message cache to work when there is no DB is tricky.
157 # Hard coding strings instead.
159 $noconnect = "<p><strong>Sorry! This site is experiencing technical difficulties.</strong></p><p>Try waiting a few minutes and reloading.</p><p><small>(Can't contact the database server: $1)</small></p>";
160 $mainpage = 'Main Page';
161 $searchdisabled = <<<EOT
162 <p style="margin: 1.5em 2em 1em">$wgSitename search is disabled for performance reasons. You can search via Google in the meantime.
163 <span style="font-size: 89%; display: block; margin-left: .2em">Note that their indexes of $wgSitename content may be out of date.</span></p>',
167 <!-- SiteSearch Google -->
168 <FORM method=GET action=\"http://www.google.com/search\">
169 <TABLE bgcolor=\"#FFFFFF\"><tr><td>
170 <A HREF=\"http://www.google.com/\">
171 <IMG SRC=\"http://www.google.com/logos/Logo_40wht.gif\"
172 border=\"0\" ALT=\"Google\"></A>
175 <INPUT TYPE=text name=q size=31 maxlength=255 value=\"$1\">
176 <INPUT type=submit name=btnG VALUE=\"Google Search\">
178 <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 />
179 <input type='hidden' name='ie' value='$2'>
180 <input type='hidden' name='oe' value='$2'>
184 <!-- SiteSearch Google -->";
185 $cachederror = "The following is a cached copy of the requested page, and may not be up to date. ";
188 if ( is_object( $wgMessageCache ) ) {
189 $wgMessageCache->disable();
192 if ( trim( $this->error
) == '' ) {
193 $this->error
= $this->db
->getProperty('mServer');
196 $text = str_replace( '$1', $this->error
, $noconnect );
197 $text .= wfGetSiteNotice();
199 if($wgUseFileCache) {
204 $t = Title
::newFromURL( $title );
205 } elseif (@/**/$_REQUEST['search']) {
206 $search = $_REQUEST['search'];
207 return $searchdisabled .
208 str_replace( array( '$1', '$2' ), array( htmlspecialchars( $search ),
209 $wgInputEncoding ), $googlesearch );
211 $t = Title
::newFromText( $mainpage );
215 $cache = new HTMLFileCache( $t );
216 if( $cache->isFileCached() ) {
217 // @todo, FIXME: $msg is not defined on the next line.
218 $msg = '<p style="color: red"><b>'.$msg."<br />\n" .
219 $cachederror . "</b></p>\n";
221 $tag = '<div id="article">';
225 $cache->fetchPageText() );
234 * @addtogroup Database
236 class DBQueryError
extends DBError
{
237 public $error, $errno, $sql, $fname;
239 function __construct( Database
&$db, $error, $errno, $sql, $fname ) {
240 $message = "A database error has occurred\n" .
242 "Function: $fname\n" .
243 "Error: $errno $error\n";
245 parent
::__construct( $db, $message );
246 $this->error
= $error;
247 $this->errno
= $errno;
249 $this->fname
= $fname;
253 if ( $this->useMessageCache() ) {
254 return wfMsg( 'dberrortextcl', htmlspecialchars( $this->getSQL() ),
255 htmlspecialchars( $this->fname
), $this->errno
, htmlspecialchars( $this->error
) ) . "\n";
257 return $this->getMessage();
262 global $wgShowSQLErrors;
263 if( !$wgShowSQLErrors ) {
264 return $this->msg( 'sqlhidden', 'SQL hidden' );
270 function getLogMessage() {
271 # Don't send to the exception log
275 function getPageTitle() {
276 return $this->msg( 'databaseerror', 'Database error' );
280 if ( $this->useMessageCache() ) {
281 return wfMsgNoDB( 'dberrortext', htmlspecialchars( $this->getSQL() ),
282 htmlspecialchars( $this->fname
), $this->errno
, htmlspecialchars( $this->error
) );
284 return nl2br( htmlspecialchars( $this->getMessage() ) );
290 * @addtogroup Database
292 class DBUnexpectedError
extends DBError
{}
294 /******************************************************************************/
297 * Database abstraction object
298 * @addtogroup Database
302 #------------------------------------------------------------------------------
304 #------------------------------------------------------------------------------
306 protected $mLastQuery = '';
308 protected $mServer, $mUser, $mPassword, $mConn = null, $mDBname;
309 protected $mOut, $mOpened = false;
311 protected $mFailFunction;
312 protected $mTablePrefix;
314 protected $mTrxLevel = 0;
315 protected $mErrorCount = 0;
316 protected $mLBInfo = array();
318 #------------------------------------------------------------------------------
320 #------------------------------------------------------------------------------
321 # These optionally set a variable and return the previous state
324 * Fail function, takes a Database as a parameter
325 * Set to false for default, 1 for ignore errors
327 function failFunction( $function = NULL ) {
328 return wfSetVar( $this->mFailFunction
, $function );
332 * Output page, used for reporting errors
333 * FALSE means discard output
335 function setOutputPage( $out ) {
340 * Boolean, controls output of large amounts of debug information
342 function debug( $debug = NULL ) {
343 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
347 * Turns buffering of SQL result sets on (true) or off (false).
348 * Default is "on" and it should not be changed without good reasons.
350 function bufferResults( $buffer = NULL ) {
351 if ( is_null( $buffer ) ) {
352 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
354 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
359 * Turns on (false) or off (true) the automatic generation and sending
360 * of a "we're sorry, but there has been a database error" page on
361 * database errors. Default is on (false). When turned off, the
362 * code should use lastErrno() and lastError() to handle the
363 * situation as appropriate.
365 function ignoreErrors( $ignoreErrors = NULL ) {
366 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
370 * The current depth of nested transactions
371 * @param $level Integer: , default NULL.
373 function trxLevel( $level = NULL ) {
374 return wfSetVar( $this->mTrxLevel
, $level );
378 * Number of errors logged, only useful when errors are ignored
380 function errorCount( $count = NULL ) {
381 return wfSetVar( $this->mErrorCount
, $count );
385 * Properties passed down from the server info array of the load balancer
387 function getLBInfo( $name = NULL ) {
388 if ( is_null( $name ) ) {
389 return $this->mLBInfo
;
391 if ( array_key_exists( $name, $this->mLBInfo
) ) {
392 return $this->mLBInfo
[$name];
399 function setLBInfo( $name, $value = NULL ) {
400 if ( is_null( $value ) ) {
401 $this->mLBInfo
= $name;
403 $this->mLBInfo
[$name] = $value;
408 * Returns true if this database supports (and uses) cascading deletes
410 function cascadingDeletes() {
415 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
417 function cleanupTriggers() {
422 * Returns true if this database is strict about what can be put into an IP field.
423 * Specifically, it uses a NULL value instead of an empty string.
425 function strictIPs() {
430 * Returns true if this database uses timestamps rather than integers
432 function realTimestamps() {
437 * Returns true if this database does an implicit sort when doing GROUP BY
439 function implicitGroupby() {
444 * Returns true if this database can do a native search on IP columns
445 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
447 function searchableIPs() {
452 * Returns true if this database can use functional indexes
454 function functionalIndexes() {
461 function lastQuery() { return $this->mLastQuery
; }
462 function isOpen() { return $this->mOpened
; }
465 function setFlag( $flag ) {
466 $this->mFlags |
= $flag;
469 function clearFlag( $flag ) {
470 $this->mFlags
&= ~
$flag;
473 function getFlag( $flag ) {
474 return !!($this->mFlags
& $flag);
478 * General read-only accessor
480 function getProperty( $name ) {
484 #------------------------------------------------------------------------------
486 #------------------------------------------------------------------------------
490 * @param string $server database server host
491 * @param string $user database user name
492 * @param string $password database user password
493 * @param string $dbname database name
494 * @param failFunction
496 * @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
498 function __construct( $server = false, $user = false, $password = false, $dbName = false,
499 $failFunction = false, $flags = 0, $tablePrefix = 'get from global' ) {
501 global $wgOut, $wgDBprefix, $wgCommandLineMode;
502 # Can't get a reference if it hasn't been set yet
503 if ( !isset( $wgOut ) ) {
506 $this->mOut
=& $wgOut;
508 $this->mFailFunction
= $failFunction;
509 $this->mFlags
= $flags;
511 if ( $this->mFlags
& DBO_DEFAULT
) {
512 if ( $wgCommandLineMode ) {
513 $this->mFlags
&= ~DBO_TRX
;
515 $this->mFlags |
= DBO_TRX
;
520 // Faster read-only access
521 if ( wfReadOnly() ) {
522 $this->mFlags |= DBO_PERSISTENT;
523 $this->mFlags &= ~DBO_TRX;
526 /** Get the default table prefix*/
527 if ( $tablePrefix == 'get from global' ) {
528 $this->mTablePrefix
= $wgDBprefix;
530 $this->mTablePrefix
= $tablePrefix;
534 $this->open( $server, $user, $password, $dbName );
540 * @param failFunction
543 static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0 )
545 return new Database( $server, $user, $password, $dbName, $failFunction, $flags );
549 * Usually aborts on failure
550 * If the failFunction is set to a non-zero integer, returns success
552 function open( $server, $user, $password, $dbName ) {
554 wfProfileIn( __METHOD__
);
556 # Test for missing mysql.so
557 # First try to load it
558 if (!@extension_loaded
('mysql')) {
563 # Otherwise we get a suppressed fatal error, which is very hard to track down
564 if ( !function_exists( 'mysql_connect' ) ) {
565 throw new DBConnectionError( $this, "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
569 $this->mServer
= $server;
570 $this->mUser
= $user;
571 $this->mPassword
= $password;
572 $this->mDBname
= $dbName;
576 wfProfileIn("dbconnect-$server");
578 # LIVE PATCH by Tim, ask Domas for why: retry loop
579 $this->mConn
= false;
581 for ( $i = 0; $i < $max && !$this->mConn
; $i++
) {
585 if ( $this->mFlags
& DBO_PERSISTENT
) {
586 @/**/$this->mConn
= mysql_pconnect( $server, $user, $password );
588 # Create a new connection...
589 @/**/$this->mConn
= mysql_connect( $server, $user, $password, true );
591 if ($this->mConn
=== false) {
593 #wfLogDBError("Connect loop error $iplus of $max ($server): " . mysql_errno() . " - " . mysql_error()."\n");
597 wfProfileOut("dbconnect-$server");
599 if ( $dbName != '' ) {
600 if ( $this->mConn
!== false ) {
601 $success = @/**/mysql_select_db( $dbName, $this->mConn
);
603 $error = "Error selecting database $dbName on server {$this->mServer} " .
604 "from client host {$wguname['nodename']}\n";
605 wfLogDBError(" Error selecting database $dbName on server {$this->mServer} \n");
609 wfDebug( "DB connection error\n" );
610 wfDebug( "Server: $server, User: $user, Password: " .
611 substr( $password, 0, 3 ) . "..., error: " . mysql_error() . "\n" );
616 $success = (bool)$this->mConn
;
620 $version = $this->getServerVersion();
621 if ( version_compare( $version, '4.1' ) >= 0 ) {
622 // Tell the server we're communicating with it in UTF-8.
623 // This may engage various charset conversions.
626 $this->query( 'SET NAMES utf8', __METHOD__
);
628 // Turn off strict mode
629 $this->query( "SET sql_mode = ''", __METHOD__
);
632 // Turn off strict mode if it is on
634 $this->reportConnectionError();
637 $this->mOpened
= $success;
638 wfProfileOut( __METHOD__
);
644 * Closes a database connection.
645 * if it is open : commits any open transactions
647 * @return bool operation success. true if already closed.
651 $this->mOpened
= false;
652 if ( $this->mConn
) {
653 if ( $this->trxLevel() ) {
654 $this->immediateCommit();
656 return mysql_close( $this->mConn
);
663 * @param string $error fallback error message, used if none is given by MySQL
665 function reportConnectionError( $error = 'Unknown error' ) {
666 $myError = $this->lastError();
671 if ( $this->mFailFunction
) {
672 # Legacy error handling method
673 if ( !is_int( $this->mFailFunction
) ) {
674 $ff = $this->mFailFunction
;
675 $ff( $this, $error );
679 wfLogDBError( "Connection error: $error\n" );
680 throw new DBConnectionError( $this, $error );
685 * Usually aborts on failure. If errors are explicitly ignored, returns success.
687 * @param $sql String: SQL query
688 * @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
689 * comment (you can use __METHOD__ or add some extra info)
690 * @param $tempIgnore Bool: Whether to avoid throwing an exception on errors...
691 * maybe best to catch the exception instead?
692 * @return true for a successful write query, ResultWrapper object for a successful read query,
693 * or false on failure if $tempIgnore set
694 * @throws DBQueryError Thrown when the database returns an error of any kind
696 public function query( $sql, $fname = '', $tempIgnore = false ) {
699 if ( $wgProfiling ) {
700 # generalizeSQL will probably cut down the query to reasonable
701 # logging size most of the time. The substr is really just a sanity check.
703 # Who's been wasting my precious column space? -- TS
704 #$profName = 'query: ' . $fname . ' ' . substr( Database::generalizeSQL( $sql ), 0, 255 );
706 if ( is_null( $this->getLBInfo( 'master' ) ) ) {
707 $queryProf = 'query: ' . substr( Database
::generalizeSQL( $sql ), 0, 255 );
708 $totalProf = 'Database::query';
710 $queryProf = 'query-m: ' . substr( Database
::generalizeSQL( $sql ), 0, 255 );
711 $totalProf = 'Database::query-master';
713 wfProfileIn( $totalProf );
714 wfProfileIn( $queryProf );
717 $this->mLastQuery
= $sql;
719 # Add a comment for easy SHOW PROCESSLIST interpretation
722 if ( is_object( $wgUser ) && !($wgUser instanceof StubObject
) ) {
723 $userName = $wgUser->getName();
724 if ( strlen( $userName ) > 15 ) {
725 $userName = substr( $userName, 0, 15 ) . '...';
727 $userName = str_replace( '/', '', $userName );
731 $commentedSql = preg_replace('/\s/', " /* $fname $userName */ ", $sql, 1);
733 # $commentedSql = $sql;
736 # If DBO_TRX is set, start a transaction
737 if ( ( $this->mFlags
& DBO_TRX
) && !$this->trxLevel() &&
738 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK'
743 if ( $this->debug() ) {
744 $sqlx = substr( $commentedSql, 0, 500 );
745 $sqlx = strtr( $sqlx, "\t\n", ' ' );
746 wfDebug( "SQL: $sqlx\n" );
749 # Do the query and handle errors
750 $ret = $this->doQuery( $commentedSql );
752 # Try reconnecting if the connection was lost
753 if ( false === $ret && ( $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006 ) ) {
754 # Transaction is gone, like it or not
755 $this->mTrxLevel
= 0;
756 wfDebug( "Connection lost, reconnecting...\n" );
757 if ( $this->ping() ) {
758 wfDebug( "Reconnected\n" );
759 $sqlx = substr( $commentedSql, 0, 500 );
760 $sqlx = strtr( $sqlx, "\t\n", ' ' );
761 global $wgRequestTime;
762 $elapsed = round( microtime(true) - $wgRequestTime, 3 );
763 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
764 $ret = $this->doQuery( $commentedSql );
766 wfDebug( "Failed\n" );
770 if ( false === $ret ) {
771 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
774 if ( $wgProfiling ) {
775 wfProfileOut( $queryProf );
776 wfProfileOut( $totalProf );
778 return $this->resultObject( $ret );
782 * The DBMS-dependent part of query()
783 * @param $sql String: SQL query.
784 * @return Result object to feed to fetchObject, fetchRow, ...; or false on failure
787 /*private*/ function doQuery( $sql ) {
788 if( $this->bufferResults() ) {
789 $ret = mysql_query( $sql, $this->mConn
);
791 $ret = mysql_unbuffered_query( $sql, $this->mConn
);
800 * @param string $fname
801 * @param bool $tempIgnore
803 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
804 global $wgCommandLineMode;
805 # Ignore errors during error handling to avoid infinite recursion
806 $ignore = $this->ignoreErrors( true );
807 ++
$this->mErrorCount
;
809 if( $ignore ||
$tempIgnore ) {
810 wfDebug("SQL ERROR (ignored): $error\n");
811 $this->ignoreErrors( $ignore );
813 $sql1line = str_replace( "\n", "\\n", $sql );
814 wfLogDBError("$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n");
815 wfDebug("SQL ERROR: " . $error . "\n");
816 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
822 * Intended to be compatible with the PEAR::DB wrapper functions.
823 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
825 * ? = scalar value, quoted as necessary
826 * ! = raw SQL bit (a function for instance)
827 * & = filename; reads the file and inserts as a blob
828 * (we don't use this though...)
830 function prepare( $sql, $func = 'Database::prepare' ) {
831 /* MySQL doesn't support prepared statements (yet), so just
832 pack up the query for reference. We'll manually replace
834 return array( 'query' => $sql, 'func' => $func );
837 function freePrepared( $prepared ) {
838 /* No-op for MySQL */
842 * Execute a prepared query with the various arguments
843 * @param string $prepared the prepared sql
844 * @param mixed $args Either an array here, or put scalars as varargs
846 function execute( $prepared, $args = null ) {
847 if( !is_array( $args ) ) {
849 $args = func_get_args();
850 array_shift( $args );
852 $sql = $this->fillPrepared( $prepared['query'], $args );
853 return $this->query( $sql, $prepared['func'] );
857 * Prepare & execute an SQL statement, quoting and inserting arguments
858 * in the appropriate places.
859 * @param string $query
860 * @param string $args ...
862 function safeQuery( $query, $args = null ) {
863 $prepared = $this->prepare( $query, 'Database::safeQuery' );
864 if( !is_array( $args ) ) {
866 $args = func_get_args();
867 array_shift( $args );
869 $retval = $this->execute( $prepared, $args );
870 $this->freePrepared( $prepared );
875 * For faking prepared SQL statements on DBs that don't support
877 * @param string $preparedSql - a 'preparable' SQL statement
878 * @param array $args - array of arguments to fill it with
879 * @return string executable SQL
881 function fillPrepared( $preparedQuery, $args ) {
883 $this->preparedArgs
=& $args;
884 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
885 array( &$this, 'fillPreparedArg' ), $preparedQuery );
889 * preg_callback func for fillPrepared()
890 * The arguments should be in $this->preparedArgs and must not be touched
891 * while we're doing this.
893 * @param array $matches
897 function fillPreparedArg( $matches ) {
898 switch( $matches[1] ) {
899 case '\\?': return '?';
900 case '\\!': return '!';
901 case '\\&': return '&';
903 list( /* $n */ , $arg ) = each( $this->preparedArgs
);
904 switch( $matches[1] ) {
905 case '?': return $this->addQuotes( $arg );
906 case '!': return $arg;
908 # return $this->addQuotes( file_get_contents( $arg ) );
909 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
911 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
916 * @param mixed $res A SQL result
919 * Free a result object
921 function freeResult( $res ) {
922 if ( $res instanceof ResultWrapper
) {
925 if ( !@/**/mysql_free_result( $res ) ) {
926 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
931 * Fetch the next row from the given result object, in object form.
932 * Fields can be retrieved with $row->fieldname, with fields acting like
935 * @param $res SQL result object as returned from Database::query(), etc.
936 * @return MySQL row object
937 * @throws DBUnexpectedError Thrown if the database returns an error
939 function fetchObject( $res ) {
940 if ( $res instanceof ResultWrapper
) {
943 @/**/$row = mysql_fetch_object( $res );
944 if( $this->lastErrno() ) {
945 throw new DBUnexpectedError( $this, 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() ) );
951 * Fetch the next row from the given result object, in associative array
952 * form. Fields are retrieved with $row['fieldname'].
954 * @param $res SQL result object as returned from Database::query(), etc.
955 * @return MySQL row object
956 * @throws DBUnexpectedError Thrown if the database returns an error
958 function fetchRow( $res ) {
959 if ( $res instanceof ResultWrapper
) {
962 @/**/$row = mysql_fetch_array( $res );
963 if ( $this->lastErrno() ) {
964 throw new DBUnexpectedError( $this, 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() ) );
970 * Get the number of rows in a result object
972 function numRows( $res ) {
973 if ( $res instanceof ResultWrapper
) {
976 @/**/$n = mysql_num_rows( $res );
977 if( $this->lastErrno() ) {
978 throw new DBUnexpectedError( $this, 'Error in numRows(): ' . htmlspecialchars( $this->lastError() ) );
984 * Get the number of fields in a result object
985 * See documentation for mysql_num_fields()
987 function numFields( $res ) {
988 if ( $res instanceof ResultWrapper
) {
991 return mysql_num_fields( $res );
995 * Get a field name in a result object
996 * See documentation for mysql_field_name():
997 * http://www.php.net/mysql_field_name
999 function fieldName( $res, $n ) {
1000 if ( $res instanceof ResultWrapper
) {
1001 $res = $res->result
;
1003 return mysql_field_name( $res, $n );
1007 * Get the inserted value of an auto-increment row
1009 * The value inserted should be fetched from nextSequenceValue()
1012 * $id = $dbw->nextSequenceValue('page_page_id_seq');
1013 * $dbw->insert('page',array('page_id' => $id));
1014 * $id = $dbw->insertId();
1016 function insertId() { return mysql_insert_id( $this->mConn
); }
1019 * Change the position of the cursor in a result object
1020 * See mysql_data_seek()
1022 function dataSeek( $res, $row ) {
1023 if ( $res instanceof ResultWrapper
) {
1024 $res = $res->result
;
1026 return mysql_data_seek( $res, $row );
1030 * Get the last error number
1033 function lastErrno() {
1034 if ( $this->mConn
) {
1035 return mysql_errno( $this->mConn
);
1037 return mysql_errno();
1042 * Get a description of the last error
1043 * See mysql_error() for more details
1045 function lastError() {
1046 if ( $this->mConn
) {
1047 # Even if it's non-zero, it can still be invalid
1048 wfSuppressWarnings();
1049 $error = mysql_error( $this->mConn
);
1051 $error = mysql_error();
1053 wfRestoreWarnings();
1055 $error = mysql_error();
1058 $error .= ' (' . $this->mServer
. ')';
1063 * Get the number of rows affected by the last write query
1064 * See mysql_affected_rows() for more details
1066 function affectedRows() { return mysql_affected_rows( $this->mConn
); }
1067 /**#@-*/ // end of template : @param $result
1070 * Simple UPDATE wrapper
1071 * Usually aborts on failure
1072 * If errors are explicitly ignored, returns success
1074 * This function exists for historical reasons, Database::update() has a more standard
1075 * calling convention and feature set
1077 function set( $table, $var, $value, $cond, $fname = 'Database::set' )
1079 $table = $this->tableName( $table );
1080 $sql = "UPDATE $table SET $var = '" .
1081 $this->strencode( $value ) . "' WHERE ($cond)";
1082 return (bool)$this->query( $sql, $fname );
1086 * Simple SELECT wrapper, returns a single field, input must be encoded
1087 * Usually aborts on failure
1088 * If errors are explicitly ignored, returns FALSE on failure
1090 function selectField( $table, $var, $cond='', $fname = 'Database::selectField', $options = array() ) {
1091 if ( !is_array( $options ) ) {
1092 $options = array( $options );
1094 $options['LIMIT'] = 1;
1096 $res = $this->select( $table, $var, $cond, $fname, $options );
1097 if ( $res === false ||
!$this->numRows( $res ) ) {
1100 $row = $this->fetchRow( $res );
1101 if ( $row !== false ) {
1102 $this->freeResult( $res );
1110 * Returns an optional USE INDEX clause to go after the table, and a
1111 * string to go at the end of the query
1115 * @param array $options an associative array of options to be turned into
1116 * an SQL query, valid keys are listed in the function.
1119 function makeSelectOptions( $options ) {
1120 $preLimitTail = $postLimitTail = '';
1123 $noKeyOptions = array();
1124 foreach ( $options as $key => $option ) {
1125 if ( is_numeric( $key ) ) {
1126 $noKeyOptions[$option] = true;
1130 if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
1131 if ( isset( $options['HAVING'] ) ) $preLimitTail .= " HAVING {$options['HAVING']}";
1132 if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
1134 //if (isset($options['LIMIT'])) {
1135 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1136 // isset($options['OFFSET']) ? $options['OFFSET']
1140 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $postLimitTail .= ' FOR UPDATE';
1141 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $postLimitTail .= ' LOCK IN SHARE MODE';
1142 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
1144 # Various MySQL extensions
1145 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) $startOpts .= ' /*! STRAIGHT_JOIN */';
1146 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) $startOpts .= ' HIGH_PRIORITY';
1147 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) $startOpts .= ' SQL_BIG_RESULT';
1148 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) $startOpts .= ' SQL_BUFFER_RESULT';
1149 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) $startOpts .= ' SQL_SMALL_RESULT';
1150 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) $startOpts .= ' SQL_CALC_FOUND_ROWS';
1151 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) $startOpts .= ' SQL_CACHE';
1152 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) $startOpts .= ' SQL_NO_CACHE';
1154 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1155 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1160 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1166 * @param mixed $table Array or string, table name(s) (prefix auto-added)
1167 * @param mixed $vars Array or string, field name(s) to be retrieved
1168 * @param mixed $conds Array or string, condition(s) for WHERE
1169 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1170 * @param array $options Associative array of options (e.g. array('GROUP BY' => 'page_title')),
1171 * see Database::makeSelectOptions code for list of supported stuff
1172 * @return mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure
1174 function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array() )
1176 if( is_array( $vars ) ) {
1177 $vars = implode( ',', $vars );
1179 if( !is_array( $options ) ) {
1180 $options = array( $options );
1182 if( is_array( $table ) ) {
1183 if ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1184 $from = ' FROM ' . $this->tableNamesWithUseIndex( $table, $options['USE INDEX'] );
1186 $from = ' FROM ' . implode( ',', array_map( array( &$this, 'tableName' ), $table ) );
1187 } elseif ($table!='') {
1188 if ($table{0}==' ') {
1189 $from = ' FROM ' . $table;
1191 $from = ' FROM ' . $this->tableName( $table );
1197 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) = $this->makeSelectOptions( $options );
1199 if( !empty( $conds ) ) {
1200 if ( is_array( $conds ) ) {
1201 $conds = $this->makeList( $conds, LIST_AND
);
1203 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1205 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1208 if (isset($options['LIMIT']))
1209 $sql = $this->limitResult($sql, $options['LIMIT'],
1210 isset($options['OFFSET']) ?
$options['OFFSET'] : false);
1211 $sql = "$sql $postLimitTail";
1213 if (isset($options['EXPLAIN'])) {
1214 $sql = 'EXPLAIN ' . $sql;
1216 return $this->query( $sql, $fname );
1220 * Single row SELECT wrapper
1221 * Aborts or returns FALSE on error
1223 * $vars: the selected variables
1224 * $conds: a condition map, terms are ANDed together.
1225 * Items with numeric keys are taken to be literal conditions
1226 * Takes an array of selected variables, and a condition map, which is ANDed
1227 * e.g: selectRow( "page", array( "page_id" ), array( "page_namespace" =>
1228 * NS_MAIN, "page_title" => "Astronomy" ) ) would return an object where
1229 * $obj- >page_id is the ID of the Astronomy article
1231 * @todo migrate documentation to phpdocumentor format
1233 function selectRow( $table, $vars, $conds, $fname = 'Database::selectRow', $options = array() ) {
1234 $options['LIMIT'] = 1;
1235 $res = $this->select( $table, $vars, $conds, $fname, $options );
1236 if ( $res === false )
1238 if ( !$this->numRows($res) ) {
1239 $this->freeResult($res);
1242 $obj = $this->fetchObject( $res );
1243 $this->freeResult( $res );
1249 * Estimate rows in dataset
1250 * Returns estimated count, based on EXPLAIN output
1251 * Takes same arguments as Database::select()
1254 function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) {
1255 $options['EXPLAIN']=true;
1256 $res = $this->select ($table, $vars, $conds, $fname, $options );
1257 if ( $res === false )
1259 if (!$this->numRows($res)) {
1260 $this->freeResult($res);
1266 while( $plan = $this->fetchObject( $res ) ) {
1267 $rows *= ($plan->rows
> 0)?
$plan->rows
:1; // avoid resetting to zero
1270 $this->freeResult($res);
1276 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1277 * It's only slightly flawed. Don't use for anything important.
1279 * @param string $sql A SQL Query
1282 static function generalizeSQL( $sql ) {
1283 # This does the same as the regexp below would do, but in such a way
1284 # as to avoid crashing php on some large strings.
1285 # $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
1287 $sql = str_replace ( "\\\\", '', $sql);
1288 $sql = str_replace ( "\\'", '', $sql);
1289 $sql = str_replace ( "\\\"", '', $sql);
1290 $sql = preg_replace ("/'.*'/s", "'X'", $sql);
1291 $sql = preg_replace ('/".*"/s', "'X'", $sql);
1293 # All newlines, tabs, etc replaced by single space
1294 $sql = preg_replace ( '/\s+/', ' ', $sql);
1297 $sql = preg_replace ('/-?[0-9]+/s', 'N', $sql);
1303 * Determines whether a field exists in a table
1304 * Usually aborts on failure
1305 * If errors are explicitly ignored, returns NULL on failure
1307 function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) {
1308 $table = $this->tableName( $table );
1309 $res = $this->query( 'DESCRIBE '.$table, $fname );
1316 while ( $row = $this->fetchObject( $res ) ) {
1317 if ( $row->Field
== $field ) {
1326 * Determines whether an index exists
1327 * Usually aborts on failure
1328 * If errors are explicitly ignored, returns NULL on failure
1330 function indexExists( $table, $index, $fname = 'Database::indexExists' ) {
1331 $info = $this->indexInfo( $table, $index, $fname );
1332 if ( is_null( $info ) ) {
1335 return $info !== false;
1341 * Get information about an index into an object
1342 * Returns false if the index does not exist
1344 function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
1345 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
1346 # SHOW INDEX should work for 3.x and up:
1347 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
1348 $table = $this->tableName( $table );
1349 $sql = 'SHOW INDEX FROM '.$table;
1350 $res = $this->query( $sql, $fname );
1356 while ( $row = $this->fetchObject( $res ) ) {
1357 if ( $row->Key_name
== $index ) {
1361 $this->freeResult($res);
1363 return empty($result) ?
false : $result;
1367 * Query whether a given table exists
1369 function tableExists( $table ) {
1370 $table = $this->tableName( $table );
1371 $old = $this->ignoreErrors( true );
1372 $res = $this->query( "SELECT 1 FROM $table LIMIT 1" );
1373 $this->ignoreErrors( $old );
1375 $this->freeResult( $res );
1383 * mysql_fetch_field() wrapper
1384 * Returns false if the field doesn't exist
1389 function fieldInfo( $table, $field ) {
1390 $table = $this->tableName( $table );
1391 $res = $this->query( "SELECT * FROM $table LIMIT 1" );
1392 $n = mysql_num_fields( $res->result
);
1393 for( $i = 0; $i < $n; $i++
) {
1394 $meta = mysql_fetch_field( $res->result
, $i );
1395 if( $field == $meta->name
) {
1396 return new MySQLField($meta);
1403 * mysql_field_type() wrapper
1405 function fieldType( $res, $index ) {
1406 if ( $res instanceof ResultWrapper
) {
1407 $res = $res->result
;
1409 return mysql_field_type( $res, $index );
1413 * Determines if a given index is unique
1415 function indexUnique( $table, $index ) {
1416 $indexInfo = $this->indexInfo( $table, $index );
1417 if ( !$indexInfo ) {
1420 return !$indexInfo[0]->Non_unique
;
1424 * INSERT wrapper, inserts an array into a table
1426 * $a may be a single associative array, or an array of these with numeric keys, for
1429 * Usually aborts on failure
1430 * If errors are explicitly ignored, returns success
1432 function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
1433 # No rows to insert, easy just return now
1434 if ( !count( $a ) ) {
1438 $table = $this->tableName( $table );
1439 if ( !is_array( $options ) ) {
1440 $options = array( $options );
1442 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1444 $keys = array_keys( $a[0] );
1447 $keys = array_keys( $a );
1450 $sql = 'INSERT ' . implode( ' ', $options ) .
1451 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1455 foreach ( $a as $row ) {
1461 $sql .= '(' . $this->makeList( $row ) . ')';
1464 $sql .= '(' . $this->makeList( $a ) . ')';
1466 return (bool)$this->query( $sql, $fname );
1470 * Make UPDATE options for the Database::update function
1473 * @param array $options The options passed to Database::update
1476 function makeUpdateOptions( $options ) {
1477 if( !is_array( $options ) ) {
1478 $options = array( $options );
1481 if ( in_array( 'LOW_PRIORITY', $options ) )
1482 $opts[] = $this->lowPriorityOption();
1483 if ( in_array( 'IGNORE', $options ) )
1485 return implode(' ', $opts);
1489 * UPDATE wrapper, takes a condition array and a SET array
1491 * @param string $table The table to UPDATE
1492 * @param array $values An array of values to SET
1493 * @param array $conds An array of conditions (WHERE). Use '*' to update all rows.
1494 * @param string $fname The Class::Function calling this function
1496 * @param array $options An array of UPDATE options, can be one or
1497 * more of IGNORE, LOW_PRIORITY
1500 function update( $table, $values, $conds, $fname = 'Database::update', $options = array() ) {
1501 $table = $this->tableName( $table );
1502 $opts = $this->makeUpdateOptions( $options );
1503 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
1504 if ( $conds != '*' ) {
1505 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
1507 return $this->query( $sql, $fname );
1511 * Makes an encoded list of strings from an array
1513 * LIST_COMMA - comma separated, no field names
1514 * LIST_AND - ANDed WHERE clause (without the WHERE)
1515 * LIST_OR - ORed WHERE clause (without the WHERE)
1516 * LIST_SET - comma separated with field names, like a SET clause
1517 * LIST_NAMES - comma separated field names
1519 function makeList( $a, $mode = LIST_COMMA
) {
1520 if ( !is_array( $a ) ) {
1521 throw new DBUnexpectedError( $this, 'Database::makeList called with incorrect parameters' );
1526 foreach ( $a as $field => $value ) {
1528 if ( $mode == LIST_AND
) {
1530 } elseif($mode == LIST_OR
) {
1538 if ( ($mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
1539 $list .= "($value)";
1540 } elseif ( ($mode == LIST_SET
) && is_numeric( $field ) ) {
1542 } elseif ( ($mode == LIST_AND ||
$mode == LIST_OR
) && is_array($value) ) {
1543 $list .= $field." IN (".$this->makeList($value).") ";
1544 } elseif( is_null($value) ) {
1545 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
1546 $list .= "$field IS ";
1547 } elseif ( $mode == LIST_SET
) {
1548 $list .= "$field = ";
1552 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
1553 $list .= "$field = ";
1555 $list .= $mode == LIST_NAMES ?
$value : $this->addQuotes( $value );
1562 * Change the current database
1564 function selectDB( $db ) {
1565 $this->mDBname
= $db;
1566 return mysql_select_db( $db, $this->mConn
);
1570 * Format a table name ready for use in constructing an SQL query
1572 * This does two important things: it quotes table names which as necessary,
1573 * and it adds a table prefix if there is one.
1575 * All functions of this object which require a table name call this function
1576 * themselves. Pass the canonical name to such functions. This is only needed
1577 * when calling query() directly.
1579 * @param string $name database table name
1581 function tableName( $name ) {
1583 # Skip quoted literals
1584 if ( $name{0} != '`' ) {
1585 if ( $this->mTablePrefix
!== '' && strpos( $name, '.' ) === false ) {
1586 $name = "{$this->mTablePrefix}$name";
1588 if ( isset( $wgSharedDB ) && "{$this->mTablePrefix}user" == $name ) {
1589 $name = "`$wgSharedDB`.`$name`";
1599 * Fetch a number of table names into an array
1600 * This is handy when you need to construct SQL for joins
1603 * extract($dbr->tableNames('user','watchlist'));
1604 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
1605 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
1607 public function tableNames() {
1608 $inArray = func_get_args();
1610 foreach ( $inArray as $name ) {
1611 $retVal[$name] = $this->tableName( $name );
1617 * Fetch a number of table names into an zero-indexed numerical array
1618 * This is handy when you need to construct SQL for joins
1621 * list( $user, $watchlist ) = $dbr->tableNamesN('user','watchlist');
1622 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
1623 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
1625 public function tableNamesN() {
1626 $inArray = func_get_args();
1628 foreach ( $inArray as $name ) {
1629 $retVal[] = $this->tableName( $name );
1637 function tableNamesWithUseIndex( $tables, $use_index ) {
1640 foreach ( $tables as $table )
1641 if ( @$use_index[$table] !== null )
1642 $ret[] = $this->tableName( $table ) . ' ' . $this->useIndexClause( implode( ',', (array)$use_index[$table] ) );
1644 $ret[] = $this->tableName( $table );
1646 return implode( ',', $ret );
1650 * Wrapper for addslashes()
1651 * @param string $s String to be slashed.
1652 * @return string slashed string.
1654 function strencode( $s ) {
1655 return mysql_real_escape_string( $s, $this->mConn
);
1659 * If it's a string, adds quotes and backslashes
1660 * Otherwise returns as-is
1662 function addQuotes( $s ) {
1663 if ( is_null( $s ) ) {
1666 # This will also quote numeric values. This should be harmless,
1667 # and protects against weird problems that occur when they really
1668 # _are_ strings such as article titles and string->number->string
1669 # conversion is not 1:1.
1670 return "'" . $this->strencode( $s ) . "'";
1675 * Escape string for safe LIKE usage
1677 function escapeLike( $s ) {
1678 $s=$this->strencode( $s );
1679 $s=str_replace(array('%','_'),array('\%','\_'),$s);
1684 * Returns an appropriately quoted sequence value for inserting a new row.
1685 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
1686 * subclass will return an integer, and save the value for insertId()
1688 function nextSequenceValue( $seqName ) {
1694 * PostgreSQL doesn't have them and returns ""
1696 function useIndexClause( $index ) {
1697 return "FORCE INDEX ($index)";
1701 * REPLACE query wrapper
1702 * PostgreSQL simulates this with a DELETE followed by INSERT
1703 * $row is the row to insert, an associative array
1704 * $uniqueIndexes is an array of indexes. Each element may be either a
1705 * field name or an array of field names
1707 * It may be more efficient to leave off unique indexes which are unlikely to collide.
1708 * However if you do this, you run the risk of encountering errors which wouldn't have
1711 * @todo migrate comment to phodocumentor format
1713 function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
1714 $table = $this->tableName( $table );
1717 if ( !is_array( reset( $rows ) ) ) {
1718 $rows = array( $rows );
1721 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) .') VALUES ';
1723 foreach ( $rows as $row ) {
1729 $sql .= '(' . $this->makeList( $row ) . ')';
1731 return $this->query( $sql, $fname );
1735 * DELETE where the condition is a join
1736 * MySQL does this with a multi-table DELETE syntax, PostgreSQL does it with sub-selects
1738 * For safety, an empty $conds will not delete everything. If you want to delete all rows where the
1739 * join condition matches, set $conds='*'
1741 * DO NOT put the join condition in $conds
1743 * @param string $delTable The table to delete from.
1744 * @param string $joinTable The other table.
1745 * @param string $delVar The variable to join on, in the first table.
1746 * @param string $joinVar The variable to join on, in the second table.
1747 * @param array $conds Condition array of field names mapped to variables, ANDed together in the WHERE clause
1749 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'Database::deleteJoin' ) {
1751 throw new DBUnexpectedError( $this, 'Database::deleteJoin() called with empty $conds' );
1754 $delTable = $this->tableName( $delTable );
1755 $joinTable = $this->tableName( $joinTable );
1756 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1757 if ( $conds != '*' ) {
1758 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND
);
1761 return $this->query( $sql, $fname );
1765 * Returns the size of a text field, or -1 for "unlimited"
1767 function textFieldSize( $table, $field ) {
1768 $table = $this->tableName( $table );
1769 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
1770 $res = $this->query( $sql, 'Database::textFieldSize' );
1771 $row = $this->fetchObject( $res );
1772 $this->freeResult( $res );
1775 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
1784 * @return string Returns the text of the low priority option if it is supported, or a blank string otherwise
1786 function lowPriorityOption() {
1787 return 'LOW_PRIORITY';
1791 * DELETE query wrapper
1793 * Use $conds == "*" to delete all rows
1795 function delete( $table, $conds, $fname = 'Database::delete' ) {
1797 throw new DBUnexpectedError( $this, 'Database::delete() called with no conditions' );
1799 $table = $this->tableName( $table );
1800 $sql = "DELETE FROM $table";
1801 if ( $conds != '*' ) {
1802 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
1804 return $this->query( $sql, $fname );
1808 * INSERT SELECT wrapper
1809 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
1810 * Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
1811 * $conds may be "*" to copy the whole table
1812 * srcTable may be an array of tables.
1814 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'Database::insertSelect',
1815 $insertOptions = array(), $selectOptions = array() )
1817 $destTable = $this->tableName( $destTable );
1818 if ( is_array( $insertOptions ) ) {
1819 $insertOptions = implode( ' ', $insertOptions );
1821 if( !is_array( $selectOptions ) ) {
1822 $selectOptions = array( $selectOptions );
1824 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
1825 if( is_array( $srcTable ) ) {
1826 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
1828 $srcTable = $this->tableName( $srcTable );
1830 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
1831 " SELECT $startOpts " . implode( ',', $varMap ) .
1832 " FROM $srcTable $useIndex ";
1833 if ( $conds != '*' ) {
1834 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
1836 $sql .= " $tailOpts";
1837 return $this->query( $sql, $fname );
1841 * Construct a LIMIT query with optional offset
1842 * This is used for query pages
1843 * $sql string SQL query we will append the limit too
1844 * $limit integer the SQL limit
1845 * $offset integer the SQL offset (default false)
1847 function limitResult($sql, $limit, $offset=false) {
1848 if( !is_numeric($limit) ) {
1849 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
1851 return " $sql LIMIT "
1852 . ( (is_numeric($offset) && $offset != 0) ?
"{$offset}," : "" )
1855 function limitResultForUpdate($sql, $num) {
1856 return $this->limitResult($sql, $num, 0);
1860 * Returns an SQL expression for a simple conditional.
1863 * @param string $cond SQL expression which will result in a boolean value
1864 * @param string $trueVal SQL expression to return if true
1865 * @param string $falseVal SQL expression to return if false
1866 * @return string SQL fragment
1868 function conditional( $cond, $trueVal, $falseVal ) {
1869 return " IF($cond, $trueVal, $falseVal) ";
1873 * Determines if the last failure was due to a deadlock
1875 function wasDeadlock() {
1876 return $this->lastErrno() == 1213;
1880 * Perform a deadlock-prone transaction.
1882 * This function invokes a callback function to perform a set of write
1883 * queries. If a deadlock occurs during the processing, the transaction
1884 * will be rolled back and the callback function will be called again.
1887 * $dbw->deadlockLoop( callback, ... );
1889 * Extra arguments are passed through to the specified callback function.
1891 * Returns whatever the callback function returned on its successful,
1892 * iteration, or false on error, for example if the retry limit was
1895 function deadlockLoop() {
1896 $myFname = 'Database::deadlockLoop';
1899 $args = func_get_args();
1900 $function = array_shift( $args );
1901 $oldIgnore = $this->ignoreErrors( true );
1902 $tries = DEADLOCK_TRIES
;
1903 if ( is_array( $function ) ) {
1904 $fname = $function[0];
1909 $retVal = call_user_func_array( $function, $args );
1910 $error = $this->lastError();
1911 $errno = $this->lastErrno();
1912 $sql = $this->lastQuery();
1915 if ( $this->wasDeadlock() ) {
1917 usleep( mt_rand( DEADLOCK_DELAY_MIN
, DEADLOCK_DELAY_MAX
) );
1919 $this->reportQueryError( $error, $errno, $sql, $fname );
1922 } while( $this->wasDeadlock() && --$tries > 0 );
1923 $this->ignoreErrors( $oldIgnore );
1924 if ( $tries <= 0 ) {
1925 $this->query( 'ROLLBACK', $myFname );
1926 $this->reportQueryError( $error, $errno, $sql, $fname );
1929 $this->query( 'COMMIT', $myFname );
1935 * Do a SELECT MASTER_POS_WAIT()
1937 * @param string $file the binlog file
1938 * @param string $pos the binlog position
1939 * @param integer $timeout the maximum number of seconds to wait for synchronisation
1941 function masterPosWait( $file, $pos, $timeout ) {
1942 $fname = 'Database::masterPosWait';
1943 wfProfileIn( $fname );
1946 # Commit any open transactions
1947 $this->immediateCommit();
1949 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
1950 $encFile = $this->strencode( $file );
1951 $sql = "SELECT MASTER_POS_WAIT('$encFile', $pos, $timeout)";
1952 $res = $this->doQuery( $sql );
1953 if ( $res && $row = $this->fetchRow( $res ) ) {
1954 $this->freeResult( $res );
1955 wfProfileOut( $fname );
1958 wfProfileOut( $fname );
1964 * Get the position of the master from SHOW SLAVE STATUS
1966 function getSlavePos() {
1967 $res = $this->query( 'SHOW SLAVE STATUS', 'Database::getSlavePos' );
1968 $row = $this->fetchObject( $res );
1970 return array( $row->Master_Log_File
, $row->Read_Master_Log_Pos
);
1972 return array( false, false );
1977 * Get the position of the master from SHOW MASTER STATUS
1979 function getMasterPos() {
1980 $res = $this->query( 'SHOW MASTER STATUS', 'Database::getMasterPos' );
1981 $row = $this->fetchObject( $res );
1983 return array( $row->File
, $row->Position
);
1985 return array( false, false );
1990 * Begin a transaction, committing any previously open transaction
1992 function begin( $fname = 'Database::begin' ) {
1993 $this->query( 'BEGIN', $fname );
1994 $this->mTrxLevel
= 1;
2000 function commit( $fname = 'Database::commit' ) {
2001 $this->query( 'COMMIT', $fname );
2002 $this->mTrxLevel
= 0;
2006 * Rollback a transaction
2008 function rollback( $fname = 'Database::rollback' ) {
2009 $this->query( 'ROLLBACK', $fname );
2010 $this->mTrxLevel
= 0;
2014 * Begin a transaction, committing any previously open transaction
2015 * @deprecated use begin()
2017 function immediateBegin( $fname = 'Database::immediateBegin' ) {
2022 * Commit transaction, if one is open
2023 * @deprecated use commit()
2025 function immediateCommit( $fname = 'Database::immediateCommit' ) {
2030 * Return MW-style timestamp used for MySQL schema
2032 function timestamp( $ts=0 ) {
2033 return wfTimestamp(TS_MW
,$ts);
2037 * Local database timestamp format or null
2039 function timestampOrNull( $ts = null ) {
2040 if( is_null( $ts ) ) {
2043 return $this->timestamp( $ts );
2050 function resultObject( $result ) {
2051 if( empty( $result ) ) {
2053 } elseif ( $result instanceof ResultWrapper
) {
2055 } elseif ( $result === true ) {
2056 // Successful write query
2059 return new ResultWrapper( $this, $result );
2064 * Return aggregated value alias
2066 function aggregateValue ($valuedata,$valuename='value') {
2071 * @return string wikitext of a link to the server software's web site
2073 function getSoftwareLink() {
2074 return "[http://www.mysql.com/ MySQL]";
2078 * @return string Version information from the database
2080 function getServerVersion() {
2081 return mysql_get_server_info( $this->mConn
);
2085 * Ping the server and try to reconnect if it there is no connection
2088 if( function_exists( 'mysql_ping' ) ) {
2089 return mysql_ping( $this->mConn
);
2091 wfDebug( "Tried to call mysql_ping but this is ancient PHP version. Faking it!\n" );
2098 * At the moment, this will only work if the DB user has the PROCESS privilege
2101 $res = $this->query( 'SHOW PROCESSLIST' );
2102 # Find slave SQL thread
2103 while ( $row = $this->fetchObject( $res ) ) {
2104 /* This should work for most situations - when default db
2105 * for thread is not specified, it had no events executed,
2106 * and therefore it doesn't know yet how lagged it is.
2108 * Relay log I/O thread does not select databases.
2110 if ( $row->User
== 'system user' &&
2111 $row->State
!= 'Waiting for master to send event' &&
2112 $row->State
!= 'Connecting to master' &&
2113 $row->State
!= 'Queueing master event to the relay log' &&
2114 $row->State
!= 'Waiting for master update' &&
2115 $row->State
!= 'Requesting binlog dump'
2117 # This is it, return the time (except -ve)
2118 if ( $row->Time
> 0x7fffffff ) {
2129 * Get status information from SHOW STATUS in an associative array
2131 function getStatus($which="%") {
2132 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
2134 while ( $row = $this->fetchObject( $res ) ) {
2135 $status[$row->Variable_name
] = $row->Value
;
2141 * Return the maximum number of items allowed in a list, or 0 for unlimited.
2143 function maxListLen() {
2147 function encodeBlob($b) {
2151 function decodeBlob($b) {
2156 * Override database's default connection timeout.
2157 * May be useful for very long batch queries such as
2158 * full-wiki dumps, where a single query reads out
2159 * over hours or days.
2160 * @param int $timeout in seconds
2162 public function setTimeout( $timeout ) {
2163 $this->query( "SET net_read_timeout=$timeout" );
2164 $this->query( "SET net_write_timeout=$timeout" );
2168 * Read and execute SQL commands from a file.
2169 * Returns true on success, error string on failure
2170 * @param string $filename File name to open
2171 * @param callback $lineCallback Optional function called before reading each line
2172 * @param callback $resultCallback Optional function called for each MySQL result
2174 function sourceFile( $filename, $lineCallback = false, $resultCallback = false ) {
2175 $fp = fopen( $filename, 'r' );
2176 if ( false === $fp ) {
2177 return "Could not open \"{$filename}\".\n";
2179 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback );
2185 * Read and execute commands from an open file handle
2186 * Returns true on success, error string on failure
2187 * @param string $fp File handle
2188 * @param callback $lineCallback Optional function called before reading each line
2189 * @param callback $resultCallback Optional function called for each MySQL result
2191 function sourceStream( $fp, $lineCallback = false, $resultCallback = false ) {
2194 $dollarquote = false;
2196 while ( ! feof( $fp ) ) {
2197 if ( $lineCallback ) {
2198 call_user_func( $lineCallback );
2200 $line = trim( fgets( $fp, 1024 ) );
2201 $sl = strlen( $line ) - 1;
2203 if ( $sl < 0 ) { continue; }
2204 if ( '-' == $line{0} && '-' == $line{1} ) { continue; }
2206 ## Allow dollar quoting for function declarations
2207 if (substr($line,0,4) == '$mw$') {
2209 $dollarquote = false;
2213 $dollarquote = true;
2216 else if (!$dollarquote) {
2217 if ( ';' == $line{$sl} && ($sl < 2 ||
';' != $line{$sl - 1})) {
2219 $line = substr( $line, 0, $sl );
2223 if ( '' != $cmd ) { $cmd .= ' '; }
2227 $cmd = str_replace(';;', ";", $cmd);
2228 $cmd = $this->replaceVars( $cmd );
2229 $res = $this->query( $cmd, __METHOD__
, true );
2230 if ( $resultCallback ) {
2231 call_user_func( $resultCallback, $res );
2234 if ( false === $res ) {
2235 $err = $this->lastError();
2236 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
2248 * Replace variables in sourced SQL
2250 protected function replaceVars( $ins ) {
2252 'wgDBserver', 'wgDBname', 'wgDBintlname', 'wgDBuser',
2253 'wgDBpassword', 'wgDBsqluser', 'wgDBsqlpassword',
2254 'wgDBadminuser', 'wgDBadminpassword', 'wgDBTableOptions',
2257 // Ordinary variables
2258 foreach ( $varnames as $var ) {
2259 if( isset( $GLOBALS[$var] ) ) {
2260 $val = addslashes( $GLOBALS[$var] ); // FIXME: safety check?
2261 $ins = str_replace( '{$' . $var . '}', $val, $ins );
2262 $ins = str_replace( '/*$' . $var . '*/`', '`' . $val, $ins );
2263 $ins = str_replace( '/*$' . $var . '*/', $val, $ins );
2268 $ins = preg_replace_callback( '/\/\*(?:\$wgDBprefix|_)\*\/([a-z_]*)/',
2269 array( &$this, 'tableNameCallback' ), $ins );
2274 * Table name callback
2277 protected function tableNameCallback( $matches ) {
2278 return $this->tableName( $matches[1] );
2284 * Database abstraction object for mySQL
2285 * Inherit all methods and properties of Database::Database()
2287 * @addtogroup Database
2290 class DatabaseMysql
extends Database
{
2296 * Result wrapper for grabbing data queried by someone else
2297 * @addtogroup Database
2299 class ResultWrapper
implements Iterator
{
2300 var $db, $result, $pos = 0, $currentRow = null;
2303 * Create a new result object from a result resource and a Database object
2305 function ResultWrapper( $database, $result ) {
2306 $this->db
= $database;
2307 if ( $result instanceof ResultWrapper
) {
2308 $this->result
= $result->result
;
2310 $this->result
= $result;
2315 * Get the number of rows in a result object
2317 function numRows() {
2318 return $this->db
->numRows( $this->result
);
2322 * Fetch the next row from the given result object, in object form.
2323 * Fields can be retrieved with $row->fieldname, with fields acting like
2326 * @param $res SQL result object as returned from Database::query(), etc.
2327 * @return MySQL row object
2328 * @throws DBUnexpectedError Thrown if the database returns an error
2330 function fetchObject() {
2331 return $this->db
->fetchObject( $this->result
);
2335 * Fetch the next row from the given result object, in associative array
2336 * form. Fields are retrieved with $row['fieldname'].
2338 * @param $res SQL result object as returned from Database::query(), etc.
2339 * @return MySQL row object
2340 * @throws DBUnexpectedError Thrown if the database returns an error
2342 function fetchRow() {
2343 return $this->db
->fetchRow( $this->result
);
2347 * Free a result object
2350 $this->db
->freeResult( $this->result
);
2351 unset( $this->result
);
2356 * Change the position of the cursor in a result object
2357 * See mysql_data_seek()
2359 function seek( $row ) {
2360 $this->db
->dataSeek( $this->result
, $row );
2363 /*********************
2364 * Iterator functions
2365 * Note that using these in combination with the non-iterator functions
2366 * above may cause rows to be skipped or repeated.
2370 if ($this->numRows()) {
2371 $this->db
->dataSeek($this->result
, 0);
2374 $this->currentRow
= null;
2377 function current() {
2378 if ( is_null( $this->currentRow
) ) {
2381 return $this->currentRow
;
2390 $this->currentRow
= $this->fetchObject();
2391 return $this->currentRow
;
2395 return $this->current() !== false;