/**
* This file deals with MySQL interface functions
* and query specifics/optimisations
- * @version # $Id$
* @package MediaWiki
*/
*/
require_once( 'CacheManager.php' );
-/** @todo document */
+/** See Database::makeList() */
define( 'LIST_COMMA', 0 );
-/** @todo document */
define( 'LIST_AND', 1 );
-/** @todo document */
define( 'LIST_SET', 2 );
+define( 'LIST_NAMES', 3);
/** Number of times to re-try an operation in case of deadlock */
define( 'DEADLOCK_TRIES', 4 );
/**
* Database abstraction object
* @package MediaWiki
- * @version # $Id$
*/
class Database {
*/
function open( $server, $user, $password, $dbName ) {
# Test for missing mysql.so
+ # First try to load it
+ if (!@extension_loaded('mysql')) {
+ @dl('mysql.so');
+ }
+
# Otherwise we get a suppressed fatal error, which is very hard to track down
if ( !function_exists( 'mysql_connect' ) ) {
die( "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
}
+ /**
+ * Intended to be compatible with the PEAR::DB wrapper functions.
+ * http://pear.php.net/manual/en/package.database.db.intro-execute.php
+ *
+ * ? = scalar value, quoted as necessary
+ * ! = raw SQL bit (a function for instance)
+ * & = filename; reads the file and inserts as a blob
+ * (we don't use this though...)
+ */
+ function prepare( $sql, $func = 'Database::prepare' ) {
+ /* MySQL doesn't support prepared statements (yet), so just
+ pack up the query for reference. We'll manually replace
+ the bits later. */
+ return array( 'query' => $sql, 'func' => $func );
+ }
+
+ function freePrepared( $prepared ) {
+ /* No-op for MySQL */
+ }
+
+ /**
+ * Execute a prepared query with the various arguments
+ * @param string $prepared the prepared sql
+ * @param mixed $args Either an array here, or put scalars as varargs
+ */
+ function execute( $prepared, $args = null ) {
+ if( !is_array( $args ) ) {
+ # Pull the var args
+ $args = func_get_args();
+ array_shift( $args );
+ }
+ $sql = $this->fillPrepared( $prepared['query'], $args );
+ return $this->query( $sql, $prepared['func'] );
+ }
+
+ /**
+ * Prepare & execute an SQL statement, quoting and inserting arguments
+ * in the appropriate places.
+ * @param string $query
+ * @param string $args (default null)
+ */
+ function safeQuery( $query, $args = null ) {
+ $prepared = $this->prepare( $query, 'Database::safeQuery' );
+ if( !is_array( $args ) ) {
+ # Pull the var args
+ $args = func_get_args();
+ array_shift( $args );
+ }
+ $retval = $this->execute( $prepared, $args );
+ $this->freePrepared( $prepared );
+ return $retval;
+ }
+
+ /**
+ * For faking prepared SQL statements on DBs that don't support
+ * it directly.
+ * @param string $preparedSql - a 'preparable' SQL statement
+ * @param array $args - array of arguments to fill it with
+ * @return string executable SQL
+ */
+ function fillPrepared( $preparedQuery, $args ) {
+ $n = 0;
+ reset( $args );
+ $this->preparedArgs =& $args;
+ return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
+ array( &$this, 'fillPreparedArg' ), $preparedQuery );
+ }
+
+ /**
+ * preg_callback func for fillPrepared()
+ * The arguments should be in $this->preparedArgs and must not be touched
+ * while we're doing this.
+ *
+ * @param array $matches
+ * @return string
+ * @access private
+ */
+ function fillPreparedArg( $matches ) {
+ switch( $matches[1] ) {
+ case '\\?': return '?';
+ case '\\!': return '!';
+ case '\\&': return '&';
+ }
+ list( $n, $arg ) = each( $this->preparedArgs );
+ switch( $matches[1] ) {
+ case '?': return $this->addQuotes( $arg );
+ case '!': return $arg;
+ case '&':
+ # return $this->addQuotes( file_get_contents( $arg ) );
+ wfDebugDieBacktrace( '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
+ default:
+ wfDebugDieBacktrace( 'Received invalid match. This should never happen!' );
+ }
+ }
+
/**#@+
* @param mixed $res A SQL result
*/
/**
- * @todo document
+ * Free a result object
*/
function freeResult( $res ) {
if ( !@/**/mysql_free_result( $res ) ) {
}
/**
- * @todo FIXME: HACK HACK HACK HACK debug
+ * Fetch the next row from the given result object, in object form
*/
function fetchObject( $res ) {
@/**/$row = mysql_fetch_object( $res );
- # FIXME: HACK HACK HACK HACK debug
if( mysql_errno() ) {
wfDebugDieBacktrace( 'Error in fetchObject(): ' . htmlspecialchars( mysql_error() ) );
}
}
/**
- * @todo document
+ * Fetch the next row from the given result object
+ * Returns an array
*/
function fetchRow( $res ) {
@/**/$row = mysql_fetch_array( $res );
}
/**
- * @todo document
+ * Get the number of rows in a result object
*/
function numRows( $res ) {
@/**/$n = mysql_num_rows( $res );
}
/**
- * @todo document
+ * Get the number of fields in a result object
+ * See documentation for mysql_num_fields()
*/
function numFields( $res ) { return mysql_num_fields( $res ); }
/**
- * @todo document
+ * Get a field name in a result object
+ * See documentation for mysql_field_name()
*/
function fieldName( $res, $n ) { return mysql_field_name( $res, $n ); }
+
/**
- * @todo document
+ * Get the inserted value of an auto-increment row
+ *
+ * The value inserted should be fetched from nextSequenceValue()
+ *
+ * Example:
+ * $id = $dbw->nextSequenceValue('page_page_id_seq');
+ * $dbw->insert('page',array('page_id' => $id));
+ * $id = $dbw->insertId();
*/
function insertId() { return mysql_insert_id( $this->mConn ); }
+
/**
- * @todo document
+ * Change the position of the cursor in a result object
+ * See mysql_data_seek()
*/
function dataSeek( $res, $row ) { return mysql_data_seek( $res, $row ); }
+
/**
- * @todo document
+ * Get the last error number
+ * See mysql_errno()
*/
- function lastErrno() { return mysql_errno(); }
+ function lastErrno() {
+ if ( $this->mConn ) {
+ return mysql_errno( $this->mConn );
+ } else {
+ return mysql_errno();
+ }
+ }
+
/**
- * @todo document
+ * Get a description of the last error
+ * See mysql_error() for more details
*/
- function lastError() { return mysql_error(); }
+ function lastError() {
+ if ( $this->mConn ) {
+ $error = mysql_error( $this->mConn );
+ } else {
+ $error = mysql_error();
+ }
+ if( $error ) {
+ $error .= ' (' . $this->mServer . ')';
+ }
+ return $error;
+ }
/**
- * @todo document
+ * Get the number of rows affected by the last write query
+ * See mysql_affected_rows() for more details
*/
function affectedRows() { return mysql_affected_rows( $this->mConn ); }
/**#@-*/ // end of template : @param $result
-
/**
* Simple UPDATE wrapper
* Usually aborts on failure
* If errors are explicitly ignored, returns success
+ *
+ * This function exists for historical reasons, Database::update() has a more standard
+ * calling convention and feature set
*/
function set( $table, $var, $value, $cond, $fname = 'Database::set' )
{
return !!$this->query( $sql, DB_MASTER, $fname );
}
- /**
- * @todo document
- */
- function getField( $table, $var, $cond='', $fname = 'Database::getField', $options = array() ) {
- return $this->selectField( $table, $var, $cond, $fname = 'Database::get', $options = array() );
- }
-
/**
* Simple SELECT wrapper, returns a single field, input must be encoded
* Usually aborts on failure
*/
function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array() )
{
- if ( is_array( $vars ) ) {
+ if( is_array( $vars ) ) {
$vars = implode( ',', $vars );
}
- if ($table!='')
+ if( is_array( $table ) ) {
+ $from = ' FROM ' . implode( ',', array_map( array( &$this, 'tableName' ), $table ) );
+ } elseif ($table!='') {
$from = ' FROM ' .$this->tableName( $table );
- else
+ } else {
$from = '';
+ }
list( $useIndex, $tailOpts ) = $this->makeSelectOptions( $options );
- if ( $conds !== false && $conds != '' ) {
+ if( !empty( $conds ) ) {
if ( is_array( $conds ) ) {
$conds = $this->makeList( $conds, LIST_AND );
}
}
return $this->query( $sql, $fname );
}
-
- /**
- * @todo document
- */
- function getArray( $table, $vars, $conds, $fname = 'Database::getArray', $options = array() ) {
- return $this->selectRow( $table, $vars, $conds, $fname, $options );
- }
-
/**
* Single row SELECT wrapper
* $conds: a condition map, terms are ANDed together.
* Items with numeric keys are taken to be literal conditions
* Takes an array of selected variables, and a condition map, which is ANDed
- * e.g. selectRow( "cur", array( "cur_id" ), array( "cur_namespace" => 0, "cur_title" => "Astronomy" ) )
- * would return an object where $obj->cur_id is the ID of the Astronomy article
+ * e.g: selectRow( "page", array( "page_id" ), array( "page_namespace" =>
+ * NS_MAIN, "page_title" => "Astronomy" ) ) would return an object where
+ * $obj- >page_id is the ID of the Astronomy article
*
* @todo migrate documentation to phpdocumentor format
*/
/**
- * @todo document
+ * Get information about an index into an object
+ * Returns false if the index does not exist
*/
function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
# SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
}
/**
- * @param $table
- * @todo document
+ * Query whether a given table exists
*/
function tableExists( $table ) {
$table = $this->tableName( $table );
}
/**
+ * mysql_fetch_field() wrapper
+ * Returns false if the field doesn't exist
+ *
* @param $table
* @param $field
- * @todo document
*/
function fieldInfo( $table, $field ) {
$table = $this->tableName( $table );
}
/**
- * @todo document
+ * mysql_field_type() wrapper
*/
function fieldType( $res, $index ) {
return mysql_field_type( $res, $index );
}
/**
- * @todo document
+ * Determines if a given index is unique
*/
function indexUnique( $table, $index ) {
$indexInfo = $this->indexInfo( $table, $index );
return !$indexInfo->Non_unique;
}
- /**
- * @todo document
- */
- function insertArray( $table, $a, $fname = 'Database::insertArray', $options = array() ) {
- return $this->insert( $table, $a, $fname = 'Database::insertArray', $options = array() );
- }
-
/**
* INSERT wrapper, inserts an array into a table
*
return !!$this->query( $sql, $fname );
}
- /**
- * @todo document
- */
- function updateArray( $table, $values, $conds, $fname = 'Database::updateArray' ) {
- return $this->update( $table, $values, $conds, $fname );
- }
-
/**
* UPDATE wrapper, takes a condition array and a SET array
*/
* $mode: LIST_COMMA - comma separated, no field names
* LIST_AND - ANDed WHERE clause (without the WHERE)
* LIST_SET - comma separated with field names, like a SET clause
+ * LIST_NAMES - comma separated field names
*/
function makeList( $a, $mode = LIST_COMMA ) {
if ( !is_array( $a ) ) {
}
if ( $mode == LIST_AND && is_numeric( $field ) ) {
$list .= "($value)";
+ } elseif ( $mode == LIST_AND && is_array ($value) ) {
+ $list .= $field." IN (".$this->makeList($value).") ";
} else {
if ( $mode == LIST_AND || $mode == LIST_SET ) {
$list .= $field.'=';
}
- $list .= $this->addQuotes( $value );
+ $list .= ($mode==LIST_NAMES?$value:$this->addQuotes( $value ));
}
}
return $list;
}
/**
- * @todo document
+ * Change the current database
*/
function selectDB( $db ) {
$this->mDBname = $db;
- mysql_select_db( $db, $this->mConn );
+ return mysql_select_db( $db, $this->mConn );
}
/**
- * @todo document
+ * Starts a timer which will kill the DB thread after $timeout seconds
*/
function startTimer( $timeout ) {
global $IP;
if( function_exists( 'mysql_thread_id' ) ) {
# This will kill the query if it's still running after $timeout seconds.
$tid = mysql_thread_id( $this->mConn );
- exec( "php $IP/killthread.php $timeout $tid &>/dev/null &" );
+ exec( "php $IP/includes/killthread.php $timeout $tid &>/dev/null &" );
}
}
/**
- * Does nothing at all
- * @todo document
+ * Stop a timer started by startTimer()
+ * Currently unimplemented.
+ *
*/
function stopTimer() { }
/**
+ * Format a table name ready for use in constructing an SQL query
+ *
+ * This does two important things: it quotes table names which as necessary,
+ * and it adds a table prefix if there is one.
+ *
+ * All functions of this object which require a table name call this function
+ * themselves. Pass the canonical name to such functions. This is only needed
+ * when calling query() directly.
+ *
* @param string $name database table name
- * @todo document
*/
function tableName( $name ) {
global $wgSharedDB;
if ( isset( $wgSharedDB ) && 'user' == $name ) {
$name = $wgSharedDB . '.' . $name;
}
+ if( $name == 'group' ) {
+ $name = '`' . $name . '`';
+ }
return $name;
}
/**
- * @todo document
+ * Fetch a number of table names into an array
+ * This is handy when you need to construct SQL for joins
+ *
+ * Example:
+ * extract($dbr->tableNames('user','watchlist'));
+ * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
+ * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
*/
function tableNames() {
$inArray = func_get_args();
$rows = array( $rows );
}
- $sql = "REPLACE INTO $table (" . implode( ',', array_flip( $rows[0] ) ) .') VALUES ';
+ $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) .') VALUES ';
$first = true;
foreach ( $rows as $row ) {
if ( $first ) {
}
/**
+ * DELETE query wrapper
+ *
* Use $conds == "*" to delete all rows
- * @todo document
*/
function delete( $table, $conds, $fname = 'Database::delete' ) {
if ( !$conds ) {
* $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
* Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
* $conds may be "*" to copy the whole table
+ * srcTable may be an array of tables.
*/
function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'Database::insertSelect' ) {
$destTable = $this->tableName( $destTable );
- $srcTable = $this->tableName( $srcTable );
+ if( is_array( $srcTable ) ) {
+ $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
+ } else {
+ $srcTable = $this->tableName( $srcTable );
+ }
$sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
' SELECT ' . implode( ',', $varMap ) .
" FROM $srcTable";
}
/**
- * @todo document
+ * Construct a LIMIT query with optional offset
+ * This is used for query pages
*/
function limitResult($limit,$offset) {
return ' LIMIT '.(is_numeric($offset)?"{$offset},":"")."{$limit} ";
}
/**
- * @todo document
+ * Returns an SQL expression for a simple conditional.
+ * Uses IF on MySQL.
+ *
+ * @param string $cond SQL expression which will result in a boolean value
+ * @param string $trueVal SQL expression to return if true
+ * @param string $falseVal SQL expression to return if false
+ * @return string SQL fragment
+ */
+ function conditional( $cond, $trueVal, $falseVal ) {
+ return " IF($cond, $trueVal, $falseVal) ";
+ }
+
+ /**
+ * Determines if the last failure was due to a deadlock
*/
function wasDeadlock() {
return $this->lastErrno() == 1213;
}
/**
- * @todo document
+ * Perform a deadlock-prone transaction.
+ *
+ * This function invokes a callback function to perform a set of write
+ * queries. If a deadlock occurs during the processing, the transaction
+ * will be rolled back and the callback function will be called again.
+ *
+ * Usage:
+ * $dbw->deadlockLoop( callback, ... );
+ *
+ * Extra arguments are passed through to the specified callback function.
+ *
+ * Returns whatever the callback function returned on its successful,
+ * iteration, or false on error, for example if the retry limit was
+ * reached.
*/
function deadlockLoop() {
$myFname = 'Database::deadlockLoop';
/**
* Do a SELECT MASTER_POS_WAIT()
- * @todo document
+ *
+ * @param string $file the binlog file
+ * @param string $pos the binlog position
+ * @param integer $timeout the maximum number of seconds to wait for synchronisation
*/
function masterPosWait( $file, $pos, $timeout ) {
+ $fname = 'Database::masterPosWait';
+ wfProfileIn( $fname );
+
+
+ # Commit any open transactions
+ $this->immediateCommit();
+
+ # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
$encFile = $this->strencode( $file );
$sql = "SELECT MASTER_POS_WAIT('$encFile', $pos, $timeout)";
- $res = $this->query( $sql, 'Database::masterPosWait' );
+ $res = $this->doQuery( $sql );
if ( $res && $row = $this->fetchRow( $res ) ) {
$this->freeResult( $res );
return $row[0];
return new ResultWrapper( $this, $result );
}
}
+
+ /**
+ * Return aggregated value alias
+ */
+ function aggregateValue ($valuedata,$valuename='value') {
+ return $valuename;
+ }
+
+ /**
+ * @return string wikitext of a link to the server software's web site
+ */
+ function getSoftwareLink() {
+ return "[http://www.mysql.com/ MySQL]";
+ }
+
+ /**
+ * @return string Version information from the database
+ */
+ function getServerVersion() {
+ return mysql_get_server_info();
+ }
}
/**
*
* @package MediaWiki
* @see Database
- * @version # $Id$
*/
class DatabaseMysql extends Database {
# Inherit all
* Result wrapper for grabbing data queried by someone else
*
* @package MediaWiki
- * @version # $Id$
*/
class ResultWrapper {
var $db, $result;
*/
function wfEmergencyAbort( &$conn, $error ) {
global $wgTitle, $wgUseFileCache, $title, $wgInputEncoding, $wgSiteNotice, $wgOutputEncoding;
+ global $wgSitename, $wgServer;
+ # I give up, Brion is right. Getting the message cache to work when there is no DB is tricky.
+ # Hard coding strings instead.
+
+ $noconnect = 'Sorry! The wiki is experiencing some technical difficulties, and cannot contact the database server. <br />
+$1';
+ $mainpage = 'Main Page';
+ $searchdisabled = <<<EOT
+<p style="margin: 1.5em 2em 1em">$wgSitename search is disabled for performance reasons. You can search via Google in the meantime.
+<span style="font-size: 89%; display: block; margin-left: .2em">Note that their indexes of $wgSitename content may be out of date.</span></p>',
+EOT;
+
+ $googlesearch = "
+<!-- SiteSearch Google -->
+<FORM method=GET action=\"http://www.google.com/search\">
+<TABLE bgcolor=\"#FFFFFF\"><tr><td>
+<A HREF=\"http://www.google.com/\">
+<IMG SRC=\"http://www.google.com/logos/Logo_40wht.gif\"
+border=\"0\" ALT=\"Google\"></A>
+</td>
+<td>
+<INPUT TYPE=text name=q size=31 maxlength=255 value=\"$1\">
+<INPUT type=submit name=btnG VALUE=\"Google Search\">
+<font size=-1>
+<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 />
+<input type='hidden' name='ie' value='$2'>
+<input type='hidden' name='oe' value='$2'>
+</font>
+</td></tr></TABLE>
+</FORM>
+<!-- SiteSearch Google -->";
+ $cachederror = "The following is a cached copy of the requested page, and may not be up to date. ";
+
+
if( !headers_sent() ) {
header( 'HTTP/1.0 500 Internal Server Error' );
header( 'Content-type: text/html; charset='.$wgOutputEncoding );
header( 'Pragma: nocache' );
}
$msg = $wgSiteNotice;
- if($msg == '') $msg = wfMsgNoDB( 'noconnect', $error );
+ if($msg == '') {
+ $msg = str_replace( '$1', $error, $noconnect );
+ }
$text = $msg;
if($wgUseFileCache) {
$t = Title::newFromURL( $title );
} elseif (@/**/$_REQUEST['search']) {
$search = $_REQUEST['search'];
- echo wfMsgNoDB( 'searchdisabled' );
- echo wfMsgNoDB( 'googlesearch', htmlspecialchars( $search ), $wgInputEncoding );
+ echo $searchdisabled;
+ echo str_replace( array( '$1', '$2' ), array( htmlspecialchars( $search ),
+ $wgInputEncoding ), $googlesearch );
wfErrorExit();
} else {
- $t = Title::newFromText( wfMsgNoDB( 'mainpage' ) );
+ $t = Title::newFromText( $mainpage );
}
}
$cache = new CacheManager( $t );
if( $cache->isFileCached() ) {
$msg = '<p style="color: red"><b>'.$msg."<br />\n" .
- wfMsgNoDB( 'cachederror' ) . "</b></p>\n";
+ $cachederror . "</b></p>\n";
$tag = '<div id="article">';
$text = str_replace(
dépôts / lhc / web / wiklou.git / blobdiff