<?php
-# $Id$
-# This file deals with MySQL interface functions
-# and query specifics/optimisations
-#
-require_once( "CacheManager.php" );
-
-define( "LIST_COMMA", 0 );
-define( "LIST_AND", 1 );
-define( "LIST_SET", 2 );
-
-# Number of times to re-try an operation in case of deadlock
-define( "DEADLOCK_TRIES", 4 );
-# Minimum time to wait before retry, in microseconds
-define( "DEADLOCK_DELAY_MIN", 500000 );
-# Maximum time to wait before retry
-define( "DEADLOCK_DELAY_MAX", 1500000 );
-
+/**
+ * This file deals with MySQL interface functions
+ * and query specifics/optimisations
+ * @version # $Id$
+ * @package MediaWiki
+ */
+
+/**
+ * Depends on the CacheManager
+ */
+require_once( 'CacheManager.php' );
+
+/** @todo document */
+define( 'LIST_COMMA', 0 );
+/** @todo document */
+define( 'LIST_AND', 1 );
+/** @todo document */
+define( 'LIST_SET', 2 );
+/** @todo document */
+define( 'LIST_NAMES', 3);
+
+/** Number of times to re-try an operation in case of deadlock */
+define( 'DEADLOCK_TRIES', 4 );
+/** Minimum time to wait before retry, in microseconds */
+define( 'DEADLOCK_DELAY_MIN', 500000 );
+/** Maximum time to wait before retry */
+define( 'DEADLOCK_DELAY_MAX', 1500000 );
+
+/**
+ * Database abstraction object
+ * @package MediaWiki
+ * @version # $Id$
+ */
class Database {
#------------------------------------------------------------------------------
# Variables
-#------------------------------------------------------------------------------
- /* private */ var $mLastQuery = "";
+#------------------------------------------------------------------------------
+ /**#@+
+ * @access private
+ */
+ var $mLastQuery = '';
- /* private */ var $mServer, $mUser, $mPassword, $mConn, $mDBname;
- /* private */ var $mOut, $mOpened = false;
+ var $mServer, $mUser, $mPassword, $mConn, $mDBname;
+ var $mOut, $mOpened = false;
- /* private */ var $mFailFunction;
- /* private */ var $mTablePrefix;
- /* private */ var $mFlags;
- /* private */ var $mTrxLevel = 0;
+ var $mFailFunction;
+ var $mTablePrefix;
+ var $mFlags;
+ var $mTrxLevel = 0;
+ /**#@-*/
#------------------------------------------------------------------------------
# Accessors
#------------------------------------------------------------------------------
# These optionally set a variable and return the previous state
- # Fail function, takes a Database as a parameter
- # Set to false for default, 1 for ignore errors
+ /**
+ * Fail function, takes a Database as a parameter
+ * Set to false for default, 1 for ignore errors
+ */
function failFunction( $function = NULL ) {
return wfSetVar( $this->mFailFunction, $function );
}
- # Output page, used for reporting errors
- # FALSE means discard output
+ /**
+ * Output page, used for reporting errors
+ * FALSE means discard output
+ */
function &setOutputPage( &$out ) {
$this->mOut =& $out;
}
- # Boolean, controls output of large amounts of debug information
+ /**
+ * Boolean, controls output of large amounts of debug information
+ */
function debug( $debug = NULL ) {
return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
}
- # Turns buffering of SQL result sets on (true) or off (false). Default is
- # "on" and it should not be changed without good reasons.
+ /**
+ * Turns buffering of SQL result sets on (true) or off (false).
+ * Default is "on" and it should not be changed without good reasons.
+ */
function bufferResults( $buffer = NULL ) {
if ( is_null( $buffer ) ) {
return !(bool)( $this->mFlags & DBO_NOBUFFER );
}
}
- # Turns on (false) or off (true) the automatic generation and sending
- # of a "we're sorry, but there has been a database error" page on
- # database errors. Default is on (false). When turned off, the
- # code should use wfLastErrno() and wfLastError() to handle the
- # situation as appropriate.
+ /**
+ * Turns on (false) or off (true) the automatic generation and sending
+ * of a "we're sorry, but there has been a database error" page on
+ * database errors. Default is on (false). When turned off, the
+ * code should use wfLastErrno() and wfLastError() to handle the
+ * situation as appropriate.
+ */
function ignoreErrors( $ignoreErrors = NULL ) {
return wfSetBit( $this->mFlags, DBO_IGNORE, $ignoreErrors );
}
- # The current depth of nested transactions
+ /**
+ * The current depth of nested transactions
+ * @param integer $level
+ */
function trxLevel( $level = NULL ) {
return wfSetVar( $this->mTrxLevel, $level );
}
- # Get functions
-
+ /**#@+
+ * Get function
+ */
function lastQuery() { return $this->mLastQuery; }
function isOpen() { return $this->mOpened; }
+ /**#@-*/
#------------------------------------------------------------------------------
# Other functions
#------------------------------------------------------------------------------
+ /**#@+
+ * @param string $server database server host
+ * @param string $user database user name
+ * @param string $password database user password
+ * @param string $dbname database name
+ */
+
+ /**
+ * @param failFunction
+ * @param $flags
+ * @param string $tablePrefix Database table prefixes. By default use the prefix gave in LocalSettings.php
+ */
function Database( $server = false, $user = false, $password = false, $dbName = false,
- $failFunction = false, $flags = 0, $tablePrefix = 'get from global' )
- {
+ $failFunction = false, $flags = 0, $tablePrefix = 'get from global' ) {
+
global $wgOut, $wgDBprefix, $wgCommandLineMode;
# Can't get a reference if it hasn't been set yet
if ( !isset( $wgOut ) ) {
$this->mFlags |= DBO_TRX;
}
}
-
+
+ /** Get the default table prefix*/
if ( $tablePrefix == 'get from global' ) {
$this->mTablePrefix = $wgDBprefix;
} else {
}
}
- /* static */ function newFromParams( $server, $user, $password, $dbName,
+ /**
+ * @static
+ * @param failFunction
+ * @param $flags
+ */
+ function newFromParams( $server, $user, $password, $dbName,
$failFunction = false, $flags = 0 )
{
return new Database( $server, $user, $password, $dbName, $failFunction, $flags );
}
- # Usually aborts on failure
- # If the failFunction is set to a non-zero integer, returns success
- function open( $server, $user, $password, $dbName )
- {
+ /**
+ * Usually aborts on failure
+ * If the failFunction is set to a non-zero integer, returns success
+ */
+ function open( $server, $user, $password, $dbName ) {
# Test for missing mysql.so
# Otherwise we get a suppressed fatal error, which is very hard to track down
if ( !function_exists( 'mysql_connect' ) ) {
$success = false;
@/**/$this->mConn = mysql_connect( $server, $user, $password );
- if ( $dbName != "" ) {
+ if ( $dbName != '' ) {
if ( $this->mConn !== false ) {
$success = @/**/mysql_select_db( $dbName, $this->mConn );
if ( !$success ) {
$this->mOpened = $success;
return $success;
}
+ /**#@-*/
- # Closes a database connection, if it is open
- # Commits any open transactions
- # Returns success, true if already closed
+ /**
+ * Closes a database connection.
+ * if it is open : commits any open transactions
+ *
+ * @return bool operation success. true if already closed.
+ */
function close()
{
$this->mOpened = false;
}
}
- /* private */ function reportConnectionError( $msg = "")
- {
+ /**
+ * @access private
+ * @param string $msg error message ?
+ * @todo parameter $msg is not used
+ */
+ function reportConnectionError( $msg = '') {
if ( $this->mFailFunction ) {
if ( !is_int( $this->mFailFunction ) ) {
$ff = $this->mFailFunction;
}
}
- # Usually aborts on failure
- # If errors are explicitly ignored, returns success
- function query( $sql, $fname = "", $tempIgnore = false )
- {
+ /**
+ * Usually aborts on failure
+ * If errors are explicitly ignored, returns success
+ */
+ function query( $sql, $fname = '', $tempIgnore = false ) {
global $wgProfiling, $wgCommandLineMode;
if ( $wgProfiling ) {
# generalizeSQL will probably cut down the query to reasonable
# logging size most of the time. The substr is really just a sanity check.
- $profName = "query: " . substr( Database::generalizeSQL( $sql ), 0, 255 );
+ $profName = 'query: ' . substr( Database::generalizeSQL( $sql ), 0, 255 );
wfProfileIn( $profName );
}
if ( $this->debug() ) {
$sqlx = substr( $sql, 0, 500 );
- $sqlx = wordwrap(strtr($sqlx,"\t\n"," "));
+ $sqlx = wordwrap(strtr($sqlx,"\t\n",' '));
wfDebug( "SQL: $sqlx\n" );
}
# Add a comment for easy SHOW PROCESSLIST interpretation
return $ret;
}
- # The DBMS-dependent part of query()
+ /**
+ * The DBMS-dependent part of query()
+ * @param string $sql SQL query.
+ */
function doQuery( $sql ) {
if( $this->bufferResults() ) {
$ret = mysql_query( $sql, $this->mConn );
return $ret;
}
+ /**
+ * @param $error
+ * @param $errno
+ * @param $sql
+ * @param string $fname
+ * @param bool $tempIgnore
+ */
function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
global $wgCommandLineMode, $wgFullyInitialised;
# Ignore errors during error handling to avoid infinite recursion
$this->ignoreErrors( $ignore );
}
+
+ /**#@+
+ * @param mixed $res A SQL result
+ */
+ /**
+ * @todo document
+ */
function freeResult( $res ) {
if ( !@/**/mysql_free_result( $res ) ) {
wfDebugDieBacktrace( "Unable to free MySQL result\n" );
}
}
+
+ /**
+ * @todo FIXME: HACK HACK HACK HACK debug
+ */
function fetchObject( $res ) {
@/**/$row = mysql_fetch_object( $res );
# FIXME: HACK HACK HACK HACK debug
if( mysql_errno() ) {
- wfDebugDieBacktrace( "Error in fetchObject(): " . htmlspecialchars( mysql_error() ) );
+ wfDebugDieBacktrace( 'Error in fetchObject(): ' . htmlspecialchars( mysql_error() ) );
}
return $row;
}
-
+
+ /**
+ * @todo document
+ */
function fetchRow( $res ) {
@/**/$row = mysql_fetch_array( $res );
if (mysql_errno() ) {
- wfDebugDieBacktrace( "Error in fetchRow(): " . htmlspecialchars( mysql_error() ) );
+ wfDebugDieBacktrace( 'Error in fetchRow(): ' . htmlspecialchars( mysql_error() ) );
}
return $row;
}
+ /**
+ * @todo document
+ */
function numRows( $res ) {
@/**/$n = mysql_num_rows( $res );
if( mysql_errno() ) {
- wfDebugDieBacktrace( "Error in numRows(): " . htmlspecialchars( mysql_error() ) );
+ wfDebugDieBacktrace( 'Error in numRows(): ' . htmlspecialchars( mysql_error() ) );
}
return $n;
}
+
+ /**
+ * @todo document
+ */
function numFields( $res ) { return mysql_num_fields( $res ); }
+
+ /**
+ * @todo document
+ */
function fieldName( $res, $n ) { return mysql_field_name( $res, $n ); }
+ /**
+ * @todo document
+ */
function insertId() { return mysql_insert_id( $this->mConn ); }
+ /**
+ * @todo document
+ */
function dataSeek( $res, $row ) { return mysql_data_seek( $res, $row ); }
+ /**
+ * @todo document
+ */
function lastErrno() { return mysql_errno(); }
+ /**
+ * @todo document
+ */
function lastError() { return mysql_error(); }
+ /**
+ * @todo document
+ */
function affectedRows() { return mysql_affected_rows( $this->mConn ); }
-
- # Simple UPDATE wrapper
- # Usually aborts on failure
- # If errors are explicitly ignored, returns success
- function set( $table, $var, $value, $cond, $fname = "Database::set" )
+ /**#@-*/ // 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' )
{
$table = $this->tableName( $table );
$sql = "UPDATE $table SET $var = '" .
return !!$this->query( $sql, DB_MASTER, $fname );
}
- function getField( $table, $var, $cond="", $fname = "Database::get", $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
- # If errors are explicitly ignored, returns FALSE on failure
- function selectField( $table, $var, $cond="", $fname = "Database::selectField", $options = array() )
- {
+ /**
+ * @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
+ * If errors are explicitly ignored, returns FALSE on failure
+ */
+ function selectField( $table, $var, $cond='', $fname = 'Database::selectField', $options = array() ) {
if ( !is_array( $options ) ) {
$options = array( $options );
}
}
}
- # Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query
+ /**
+ * Returns an optional USE INDEX clause to go after the table, and a
+ * string to go at the end of the query
+ */
function makeSelectOptions( $options ) {
if ( !is_array( $options ) ) {
$options = array( $options );
return array( $useIndex, $tailOpts );
}
- # SELECT wrapper
- function select( $table, $vars, $conds="", $fname = "Database::select", $options = array() )
+ /**
+ * SELECT wrapper
+ */
+ function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array() )
{
if ( is_array( $vars ) ) {
- $vars = implode( ",", $vars );
+ $vars = implode( ',', $vars );
}
- if ($table!="")
- $from = " FROM " .$this->tableName( $table );
+ if ($table!='')
+ $from = ' FROM ' .$this->tableName( $table );
else
- $from = "";
+ $from = '';
list( $useIndex, $tailOpts ) = $this->makeSelectOptions( $options );
- if ( $conds !== false && $conds != "" ) {
+ if ( $conds !== false && $conds != '' ) {
if ( is_array( $conds ) ) {
$conds = $this->makeList( $conds, LIST_AND );
}
return $this->query( $sql, $fname );
}
- function getArray( $table, $vars, $conds, $fname = "Database::getArray", $options = array() ) {
+ /**
+ * @todo document
+ */
+ function getArray( $table, $vars, $conds, $fname = 'Database::getArray', $options = array() ) {
return $this->selectRow( $table, $vars, $conds, $fname, $options );
}
-
- # Single row SELECT wrapper
- # Aborts or returns FALSE on error
- #
- # $vars: the selected variables
- # $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
- function selectRow( $table, $vars, $conds, $fname = "Database::selectRow", $options = array() ) {
+
+
+ /**
+ * Single row SELECT wrapper
+ * Aborts or returns FALSE on error
+ *
+ * $vars: the selected variables
+ * $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
+ *
+ * @todo migrate documentation to phpdocumentor format
+ */
+ function selectRow( $table, $vars, $conds, $fname = 'Database::selectRow', $options = array() ) {
$options['LIMIT'] = 1;
$res = $this->select( $table, $vars, $conds, $fname, $options );
if ( $res === false || !$this->numRows( $res ) ) {
}
- # Removes most variables from an SQL query and replaces them with X or N for numbers.
- # It's only slightly flawed. Don't use for anything important.
- /* static */ function generalizeSQL( $sql )
- {
+ /**
+ * Removes most variables from an SQL query and replaces them with X or N for numbers.
+ * It's only slightly flawed. Don't use for anything important.
+ *
+ * @param string $sql A SQL Query
+ * @static
+ */
+ function generalizeSQL( $sql ) {
# This does the same as the regexp below would do, but in such a way
# as to avoid crashing php on some large strings.
# $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
- $sql = str_replace ( "\\\\", "", $sql);
- $sql = str_replace ( "\\'", "", $sql);
- $sql = str_replace ( "\\\"", "", $sql);
+ $sql = str_replace ( "\\\\", '', $sql);
+ $sql = str_replace ( "\\'", '', $sql);
+ $sql = str_replace ( "\\\"", '', $sql);
$sql = preg_replace ("/'.*'/s", "'X'", $sql);
$sql = preg_replace ('/".*"/s', "'X'", $sql);
# All newlines, tabs, etc replaced by single space
- $sql = preg_replace ( "/\s+/", " ", $sql);
+ $sql = preg_replace ( "/\s+/", ' ', $sql);
# All numbers => N
- $sql = preg_replace ('/-?[0-9]+/s', "N", $sql);
+ $sql = preg_replace ('/-?[0-9]+/s', 'N', $sql);
return $sql;
}
- # Determines whether a field exists in a table
- # Usually aborts on failure
- # If errors are explicitly ignored, returns NULL on failure
- function fieldExists( $table, $field, $fname = "Database::fieldExists" )
- {
+ /**
+ * Determines whether a field exists in a table
+ * Usually aborts on failure
+ * If errors are explicitly ignored, returns NULL on failure
+ */
+ function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) {
$table = $this->tableName( $table );
- $res = $this->query( "DESCRIBE $table", DB_SLAVE, $fname );
+ $res = $this->query( 'DESCRIBE '.$table, DB_SLAVE, $fname );
if ( !$res ) {
return NULL;
}
return $found;
}
- # Determines whether an index exists
- # Usually aborts on failure
- # If errors are explicitly ignored, returns NULL on failure
- function indexExists( $table, $index, $fname = "Database::indexExists" )
- {
+ /**
+ * Determines whether an index exists
+ * Usually aborts on failure
+ * If errors are explicitly ignored, returns NULL on failure
+ */
+ function indexExists( $table, $index, $fname = 'Database::indexExists' ) {
$info = $this->indexInfo( $table, $index, $fname );
if ( is_null( $info ) ) {
return NULL;
}
}
- function indexInfo( $table, $index, $fname = "Database::indexInfo" ) {
+
+ /**
+ * @todo document
+ */
+ function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
# SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
# SHOW INDEX should work for 3.x and up:
# http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
$table = $this->tableName( $table );
- $sql = "SHOW INDEX FROM $table";
+ $sql = 'SHOW INDEX FROM '.$table;
$res = $this->query( $sql, $fname );
if ( !$res ) {
return NULL;
}
return false;
}
- function tableExists( $table )
- {
+
+ /**
+ * @param $table
+ * @todo document
+ */
+ function tableExists( $table ) {
$table = $this->tableName( $table );
$old = $this->ignoreErrors( true );
$res = $this->query( "SELECT 1 FROM $table LIMIT 1" );
}
}
- function fieldInfo( $table, $field )
- {
+ /**
+ * @param $table
+ * @param $field
+ * @todo document
+ */
+ function fieldInfo( $table, $field ) {
$table = $this->tableName( $table );
$res = $this->query( "SELECT * FROM $table LIMIT 1" );
$n = mysql_num_fields( $res );
return false;
}
+ /**
+ * @todo document
+ */
function fieldType( $res, $index ) {
return mysql_field_type( $res, $index );
}
+ /**
+ * @todo document
+ */
function indexUnique( $table, $index ) {
$indexInfo = $this->indexInfo( $table, $index );
if ( !$indexInfo ) {
return !$indexInfo->Non_unique;
}
- function insertArray( $table, $a, $fname = "Database::insertArray", $options = array() ) {
- return $this->insert( $table, $a, $fname = "Database::insertArray", $options = array() );
+ /**
+ * @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
- #
- # $a may be a single associative array, or an array of these with numeric keys, for
- # multi-row insert.
- #
- # Usually aborts on failure
- # If errors are explicitly ignored, returns success
- function insert( $table, $a, $fname = "Database::insert", $options = array() )
- {
+ /**
+ * INSERT wrapper, inserts an array into a table
+ *
+ * $a may be a single associative array, or an array of these with numeric keys, for
+ * multi-row insert.
+ *
+ * Usually aborts on failure
+ * If errors are explicitly ignored, returns success
+ */
+ function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
# No rows to insert, easy just return now
if ( !count( $a ) ) {
return true;
if ( $first ) {
$first = false;
} else {
- $sql .= ",";
+ $sql .= ',';
}
$sql .= '(' . $this->makeList( $row ) . ')';
}
return !!$this->query( $sql, $fname );
}
- function updateArray( $table, $values, $conds, $fname = "Database::updateArray" ) {
+ /**
+ * @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
- function update( $table, $values, $conds, $fname = "Database::update" )
- {
+ /**
+ * UPDATE wrapper, takes a condition array and a SET array
+ */
+ function update( $table, $values, $conds, $fname = 'Database::update' ) {
$table = $this->tableName( $table );
$sql = "UPDATE $table SET " . $this->makeList( $values, LIST_SET );
$sql .= " WHERE " . $this->makeList( $conds, LIST_AND );
$this->query( $sql, $fname );
}
- # Makes a wfStrencoded list from an 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
- function makeList( $a, $mode = LIST_COMMA )
- {
+ /**
+ * Makes a wfStrencoded list from an 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 ) ) {
wfDebugDieBacktrace( 'Database::makeList called with incorrect parameters' );
}
$first = true;
- $list = "";
+ $list = '';
foreach ( $a as $field => $value ) {
if ( !$first ) {
if ( $mode == LIST_AND ) {
- $list .= " AND ";
+ $list .= ' AND ';
} else {
- $list .= ",";
+ $list .= ',';
}
} else {
$first = false;
$list .= "($value)";
} else {
if ( $mode == LIST_AND || $mode == LIST_SET ) {
- $list .= "$field=";
+ $list .= $field.'=';
}
- $list .= $this->addQuotes( $value );
+ $list .= ($mode==LIST_NAMES?$value:$this->addQuotes( $value ));
}
}
return $list;
}
- function selectDB( $db )
- {
+ /**
+ * @todo document
+ */
+ function selectDB( $db ) {
$this->mDBname = $db;
- mysql_select_db( $db, $this->mConn );
+ return mysql_select_db( $db, $this->mConn );
}
- function startTimer( $timeout )
- {
+ /**
+ * @todo document
+ */
+ function startTimer( $timeout ) {
global $IP;
- if( function_exists( "mysql_thread_id" ) ) {
+ 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 &" );
}
}
- function stopTimer()
- {
- }
+ /**
+ * Does nothing at all
+ * @todo document
+ */
+ function stopTimer() { }
+ /**
+ * @param string $name database table name
+ * @todo document
+ */
function tableName( $name ) {
+ global $wgSharedDB;
if ( $this->mTablePrefix !== '' ) {
if ( strpos( '.', $name ) === false ) {
$name = $this->mTablePrefix . $name;
}
}
+ if ( isset( $wgSharedDB ) && 'user' == $name ) {
+ $name = $wgSharedDB . '.' . $name;
+ }
return $name;
}
+ /**
+ * @todo document
+ */
function tableNames() {
$inArray = func_get_args();
$retVal = array();
return $retVal;
}
+ /**
+ * Wrapper for addslashes()
+ * @param string $s String to be slashed.
+ * @return string slashed string.
+ */
function strencode( $s ) {
return addslashes( $s );
}
- # If it's a string, adds quotes and backslashes
- # Otherwise returns as-is
+ /**
+ * If it's a string, adds quotes and backslashes
+ * Otherwise returns as-is
+ */
function addQuotes( $s ) {
if ( is_null( $s ) ) {
$s = 'NULL';
- } else if ( !is_numeric( $s ) ) {
+ } else {
+ # This will also quote numeric values. This should be harmless,
+ # and protects against weird problems that occur when they really
+ # _are_ strings such as article titles and string->number->string
+ # conversion is not 1:1.
$s = "'" . $this->strencode( $s ) . "'";
}
return $s;
}
- # Returns an appropriately quoted sequence value for inserting a new row.
- # MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
- # subclass will return an integer, and save the value for insertId()
+ /**
+ * Returns an appropriately quoted sequence value for inserting a new row.
+ * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
+ * subclass will return an integer, and save the value for insertId()
+ */
function nextSequenceValue( $seqName ) {
return NULL;
}
- # USE INDEX clause
- # PostgreSQL doesn't have them and returns ""
+ /**
+ * USE INDEX clause
+ * PostgreSQL doesn't have them and returns ""
+ */
function useIndexClause( $index ) {
- return "USE INDEX ($index)";
- }
-
- # REPLACE query wrapper
- # PostgreSQL simulates this with a DELETE followed by INSERT
- # $row is the row to insert, an associative array
- # $uniqueIndexes is an array of indexes. Each element may be either a
- # field name or an array of field names
- #
- # It may be more efficient to leave off unique indexes which are unlikely to collide.
- # However if you do this, you run the risk of encountering errors which wouldn't have
- # occurred in MySQL
- function replace( $table, $uniqueIndexes, $rows, $fname = "Database::replace" ) {
+ return 'USE INDEX ('.$index.')';
+ }
+
+ /**
+ * REPLACE query wrapper
+ * PostgreSQL simulates this with a DELETE followed by INSERT
+ * $row is the row to insert, an associative array
+ * $uniqueIndexes is an array of indexes. Each element may be either a
+ * field name or an array of field names
+ *
+ * It may be more efficient to leave off unique indexes which are unlikely to collide.
+ * However if you do this, you run the risk of encountering errors which wouldn't have
+ * occurred in MySQL
+ *
+ * @todo migrate comment to phodocumentor format
+ */
+ function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
$table = $this->tableName( $table );
# Single row case
$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 ) {
$first = false;
} else {
- $sql .= ",";
+ $sql .= ',';
}
- $sql .= "(" . $this->makeList( $row ) . ")";
+ $sql .= '(' . $this->makeList( $row ) . ')';
}
return $this->query( $sql, $fname );
}
- # DELETE where the condition is a join
- # MySQL does this with a multi-table DELETE syntax, PostgreSQL does it with sub-selects
- #
- # $delTable is the table to delete from
- # $joinTable is the other table
- # $delVar is the variable to join on, in the first table
- # $joinVar is the variable to join on, in the second table
- # $conds is a condition array of field names mapped to variables, ANDed together in the WHERE clause
- #
- # For safety, an empty $conds will not delete everything. If you want to delete all rows where the
- # join condition matches, set $conds='*'
- #
- # DO NOT put the join condition in $conds
- function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = "Database::deleteJoin" ) {
+ /**
+ * DELETE where the condition is a join
+ * MySQL does this with a multi-table DELETE syntax, PostgreSQL does it with sub-selects
+ *
+ * For safety, an empty $conds will not delete everything. If you want to delete all rows where the
+ * join condition matches, set $conds='*'
+ *
+ * DO NOT put the join condition in $conds
+ *
+ * @param string $delTable The table to delete from.
+ * @param string $joinTable The other table.
+ * @param string $delVar The variable to join on, in the first table.
+ * @param string $joinVar The variable to join on, in the second table.
+ * @param array $conds Condition array of field names mapped to variables, ANDed together in the WHERE clause
+ */
+ function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'Database::deleteJoin' ) {
if ( !$conds ) {
wfDebugDieBacktrace( 'Database::deleteJoin() called with empty $conds' );
}
$joinTable = $this->tableName( $joinTable );
$sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
if ( $conds != '*' ) {
- $sql .= " AND " . $this->makeList( $conds, LIST_AND );
+ $sql .= ' AND ' . $this->makeList( $conds, LIST_AND );
}
return $this->query( $sql, $fname );
}
- # Returns the size of a text field, or -1 for "unlimited"
+ /**
+ * Returns the size of a text field, or -1 for "unlimited"
+ */
function textFieldSize( $table, $field ) {
$table = $this->tableName( $table );
$sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
- $res = $this->query( $sql, "Database::textFieldSize" );
+ $res = $this->query( $sql, 'Database::textFieldSize' );
$row = $this->fetchObject( $res );
$this->freeResult( $res );
return $size;
}
+ /**
+ * @return string Always return 'LOW_PRIORITY'
+ */
function lowPriorityOption() {
return 'LOW_PRIORITY';
}
- # Use $conds == "*" to delete all rows
- function delete( $table, $conds, $fname = "Database::delete" ) {
+ /**
+ * Use $conds == "*" to delete all rows
+ * @todo document
+ */
+ function delete( $table, $conds, $fname = 'Database::delete' ) {
if ( !$conds ) {
- wfDebugDieBacktrace( "Database::delete() called with no conditions" );
+ wfDebugDieBacktrace( 'Database::delete() called with no conditions' );
}
$table = $this->tableName( $table );
$sql = "DELETE FROM $table ";
if ( $conds != '*' ) {
- $sql .= "WHERE " . $this->makeList( $conds, LIST_AND );
+ $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
}
return $this->query( $sql, $fname );
}
- # INSERT SELECT wrapper
- # $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
+ /**
+ * INSERT SELECT wrapper
+ * $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
+ */
function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'Database::insertSelect' ) {
$destTable = $this->tableName( $destTable );
$srcTable = $this->tableName( $srcTable );
- $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ")" .
- " SELECT " . implode( ',', $varMap ) .
+ $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
+ ' SELECT ' . implode( ',', $varMap ) .
" FROM $srcTable";
if ( $conds != '*' ) {
- $sql .= " WHERE " . $this->makeList( $conds, LIST_AND );
+ $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
}
return $this->query( $sql, $fname );
}
+ /**
+ * @todo document
+ */
function limitResult($limit,$offset) {
- return " LIMIT ".(is_numeric($offset)?"{$offset},":"")."{$limit} ";
+ return ' LIMIT '.(is_numeric($offset)?"{$offset},":"")."{$limit} ";
+ }
+
+ /**
+ * 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) ";
}
+ /**
+ * @todo document
+ */
function wasDeadlock() {
return $this->lastErrno() == 1213;
}
+ /**
+ * @todo document
+ */
function deadlockLoop() {
$myFname = 'Database::deadlockLoop';
- $this->query( "BEGIN", $myFname );
+ $this->query( 'BEGIN', $myFname );
$args = func_get_args();
$function = array_shift( $args );
$oldIgnore = $dbw->ignoreErrors( true );
} while( $dbw->wasDeadlock && --$tries > 0 );
$this->ignoreErrors( $oldIgnore );
if ( $tries <= 0 ) {
- $this->query( "ROLLBACK", $myFname );
+ $this->query( 'ROLLBACK', $myFname );
$this->reportQueryError( $error, $errno, $sql, $fname );
return false;
} else {
- $this->query( "COMMIT", $myFname );
+ $this->query( 'COMMIT', $myFname );
return $retVal;
}
}
- # Do a SELECT MASTER_POS_WAIT()
+ /**
+ * Do a SELECT MASTER_POS_WAIT()
+ * @todo document
+ */
function masterPosWait( $file, $pos, $timeout ) {
$encFile = $this->strencode( $file );
$sql = "SELECT MASTER_POS_WAIT('$encFile', $pos, $timeout)";
- $res = $this->query( $sql, "Database::masterPosWait" );
+ $res = $this->query( $sql, 'Database::masterPosWait' );
if ( $res && $row = $this->fetchRow( $res ) ) {
$this->freeResult( $res );
return $row[0];
}
}
- # Get the position of the master from SHOW SLAVE STATUS
+ /**
+ * Get the position of the master from SHOW SLAVE STATUS
+ */
function getSlavePos() {
$res = $this->query( 'SHOW SLAVE STATUS', 'Database::getSlavePos' );
$row = $this->fetchObject( $res );
}
}
- # Get the position of the master from SHOW MASTER STATUS
+ /**
+ * Get the position of the master from SHOW MASTER STATUS
+ */
function getMasterPos() {
$res = $this->query( 'SHOW MASTER STATUS', 'Database::getMasterPos' );
$row = $this->fetchObject( $res );
}
}
- # Begin a transaction, or if a transaction has already started, continue it
+ /**
+ * Begin a transaction, or if a transaction has already started, continue it
+ */
function begin( $fname = 'Database::begin' ) {
if ( !$this->mTrxLevel ) {
$this->immediateBegin( $fname );
}
}
- # End a transaction, or decrement the nest level if transactions are nested
+ /**
+ * End a transaction, or decrement the nest level if transactions are nested
+ */
function commit( $fname = 'Database::commit' ) {
if ( $this->mTrxLevel ) {
$this->mTrxLevel--;
}
}
- # Rollback a transaction
+ /**
+ * Rollback a transaction
+ */
function rollback( $fname = 'Database::rollback' ) {
$this->query( 'ROLLBACK', $fname );
$this->mTrxLevel = 0;
}
- # Begin a transaction, committing any previously open transaction
+ /**
+ * Begin a transaction, committing any previously open transaction
+ */
function immediateBegin( $fname = 'Database::immediateBegin' ) {
$this->query( 'BEGIN', $fname );
$this->mTrxLevel = 1;
}
- # Commit transaction, if one is open
+ /**
+ * Commit transaction, if one is open
+ */
function immediateCommit( $fname = 'Database::immediateCommit' ) {
$this->query( 'COMMIT', $fname );
$this->mTrxLevel = 0;
}
- # Return MW-style timestamp used for MySQL schema
+ /**
+ * Return MW-style timestamp used for MySQL schema
+ */
function timestamp( $ts=0 ) {
return wfTimestamp(TS_MW,$ts);
}
+
+ /**
+ * @todo document
+ */
+ function &resultObject( &$result ) {
+ if( empty( $result ) ) {
+ return NULL;
+ } else {
+ 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();
+ }
}
+/**
+ * Database abstraction object for mySQL
+ * Inherit all methods and properties of Database::Database()
+ *
+ * @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;
+
+ /**
+ * @todo document
+ */
+ function ResultWrapper( $database, $result ) {
+ $this->db =& $database;
+ $this->result =& $result;
+ }
+
+ /**
+ * @todo document
+ */
+ function numRows() {
+ return $this->db->numRows( $this->result );
+ }
+
+ /**
+ * @todo document
+ */
+ function &fetchObject() {
+ return $this->db->fetchObject( $this->result );
+ }
+
+ /**
+ * @todo document
+ */
+ function &fetchRow() {
+ return $this->db->fetchRow( $this->result );
+ }
+
+ /**
+ * @todo document
+ */
+ function free() {
+ $this->db->freeResult( $this->result );
+ unset( $this->result );
+ unset( $this->db );
+ }
+}
+
#------------------------------------------------------------------------------
# Global functions
#------------------------------------------------------------------------------
-/* Standard fail function, called by default when a connection cannot be established
- Displays the file cache if possible */
+/**
+ * Standard fail function, called by default when a connection cannot be
+ * established.
+ * Displays the file cache if possible
+ */
function wfEmergencyAbort( &$conn, $error ) {
global $wgTitle, $wgUseFileCache, $title, $wgInputEncoding, $wgSiteNotice, $wgOutputEncoding;
if( !headers_sent() ) {
- header( "HTTP/1.0 500 Internal Server Error" );
- header( "Content-type: text/html; charset=$wgOutputEncoding" );
+ header( 'HTTP/1.0 500 Internal Server Error' );
+ header( 'Content-type: text/html; charset='.$wgOutputEncoding );
/* Don't cache error pages! They cause no end of trouble... */
- header( "Cache-control: none" );
- header( "Pragma: nocache" );
+ header( 'Cache-control: none' );
+ header( 'Pragma: nocache' );
}
$msg = $wgSiteNotice;
- if($msg == "") $msg = wfMsgNoDB( "noconnect", $error );
+ if($msg == '') $msg = wfMsgNoDB( 'noconnect', $error );
$text = $msg;
if($wgUseFileCache) {
$t = Title::newFromURL( $title );
} elseif (@/**/$_REQUEST['search']) {
$search = $_REQUEST['search'];
- echo wfMsgNoDB( "searchdisabled" );
- echo wfMsgNoDB( "googlesearch", htmlspecialchars( $search ), $wgInputEncoding );
+ echo wfMsgNoDB( 'searchdisabled' );
+ echo wfMsgNoDB( 'googlesearch', htmlspecialchars( $search ), $wgInputEncoding );
wfErrorExit();
} else {
- $t = Title::newFromText( wfMsgNoDB( "mainpage" ) );
+ $t = Title::newFromText( wfMsgNoDB( 'mainpage' ) );
}
}
$cache = new CacheManager( $t );
if( $cache->isFileCached() ) {
- $msg = "<p style='color: red'><b>$msg<br />\n" .
- wfMsgNoDB( "cachederror" ) . "</b></p>\n";
+ $msg = '<p style="color: red"><b>'.$msg."<br />\n" .
+ wfMsgNoDB( 'cachederror' ) . "</b></p>\n";
- $tag = "<div id='article'>";
+ $tag = '<div id="article">';
$text = str_replace(
$tag,
$tag . $msg,
dépôts / lhc / web / wiklou.git / blobdiff