X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fdb%2FDatabase.php;h=57d98adf3dc7de1f8211ef1429e09dbaf835a1fa;hb=6fb01643438a894c921e6fbcb57091ce20e6fae8;hp=c5ae9468dc43238d5120c14bf53a0e4a540722c1;hpb=f26f0a13aebbc4a0e383ee7becd62014c58ee0a6;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/db/Database.php b/includes/db/Database.php index c5ae9468dc..57d98adf3d 100644 --- a/includes/db/Database.php +++ b/includes/db/Database.php @@ -47,7 +47,7 @@ interface DatabaseType { * Fields can be retrieved with $row->fieldname, with fields acting like * member variables. * - * @param $res SQL result object as returned from DatabaseBase::query(), etc. + * @param $res ResultWrapper|object as returned from DatabaseBase::query(), etc. * @return Row object * @throws DBUnexpectedError Thrown if the database returns an error */ @@ -224,6 +224,12 @@ abstract class DatabaseBase implements DatabaseType { protected $mDefaultBigSelects = null; protected $mSchemaVars = false; + protected $preparedArgs; + + protected $htmlErrors; + + protected $delimiter = ';'; + # ------------------------------------------------------------------------------ # Accessors # ------------------------------------------------------------------------------ @@ -241,8 +247,8 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Boolean, controls output of large amounts of debug information. - * @param $debug: + * Boolean, controls output of large amounts of debug information. + * @param $debug bool|null * - true to enable debugging * - false to disable debugging * - omitted or null to do nothing @@ -254,23 +260,25 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Turns buffering of SQL result sets on (true) or off (false). Default is - * "on". + * Turns buffering of SQL result sets on (true) or off (false). Default is + * "on". * * Unbuffered queries are very troublesome in MySQL: * - * - If another query is executed while the first query is being read + * - If another query is executed while the first query is being read * out, the first query is killed. This means you can't call normal * MediaWiki functions while you are reading an unbuffered query result * from a normal wfGetDB() connection. * - * - Unbuffered queries cause the MySQL server to use large amounts of + * - Unbuffered queries cause the MySQL server to use large amounts of * memory and to hold broad locks which block other queries. * - * If you want to limit client-side memory, it's almost always better to + * If you want to limit client-side memory, it's almost always better to * split up queries into batches using a LIMIT clause than to switch off * buffering. * + * @param $buffer null|bool + * * @return The previous value of the flag */ function bufferResults( $buffer = null ) { @@ -288,7 +296,9 @@ abstract class DatabaseBase implements DatabaseType { * code should use lastErrno() and lastError() to handle the * situation as appropriate. * - * @return The previous value of the flag. + * @param $ignoreErrors bool|null + * + * @return bool The previous value of the flag. */ function ignoreErrors( $ignoreErrors = null ) { return wfSetBit( $this->mFlags, DBO_IGNORE, $ignoreErrors ); @@ -297,7 +307,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Gets or sets the current transaction level. * - * Historically, transactions were allowed to be "nested". This is no + * Historically, transactions were allowed to be "nested". This is no * longer supported, so this function really only returns a boolean. * * @param $level An integer (0 or 1), or omitted to leave it unchanged. @@ -322,15 +332,17 @@ abstract class DatabaseBase implements DatabaseType { * @return The previous table prefix. */ function tablePrefix( $prefix = null ) { - return wfSetVar( $this->mTablePrefix, $prefix, true ); + return wfSetVar( $this->mTablePrefix, $prefix ); } /** - * Get properties passed down from the server info array of the load + * Get properties passed down from the server info array of the load * balancer. * - * @param $name The entry of the info array to get, or null to get the + * @param $name string The entry of the info array to get, or null to get the * whole array + * + * @return LoadBalancer|null */ function getLBInfo( $name = null ) { if ( is_null( $name ) ) { @@ -345,13 +357,12 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Set the LB info array, or a member of it. If called with one parameter, - * the LB info array is set to that parameter. If it is called with two + * Set the LB info array, or a member of it. If called with one parameter, + * the LB info array is set to that parameter. If it is called with two * parameters, the member with the given name is set to the given value. * * @param $name * @param $value - * @return void */ function setLBInfo( $name, $value = null ) { if ( is_null( $value ) ) { @@ -363,6 +374,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Set lag time in seconds for a fake slave + * + * @param $lag int */ function setFakeSlaveLag( $lag ) { $this->mFakeSlaveLag = $lag; @@ -370,6 +383,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Make this connection a fake master + * + * @param $enabled bool */ function setFakeMaster( $enabled = true ) { $this->mFakeMaster = $enabled; @@ -377,6 +392,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database supports (and uses) cascading deletes + * + * @return bool */ function cascadingDeletes() { return false; @@ -384,6 +401,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database supports (and uses) triggers (e.g. on the page table) + * + * @return bool */ function cleanupTriggers() { return false; @@ -392,6 +411,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database is strict about what can be put into an IP field. * Specifically, it uses a NULL value instead of an empty string. + * + * @return bool */ function strictIPs() { return false; @@ -399,6 +420,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database uses timestamps rather than integers + * + * @return bool */ function realTimestamps() { return false; @@ -406,6 +429,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database does an implicit sort when doing GROUP BY + * + * @return bool */ function implicitGroupby() { return true; @@ -414,6 +439,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database does an implicit order by when the column has an index * For example: SELECT page_title FROM page LIMIT 1 + * + * @return bool */ function implicitOrderby() { return true; @@ -422,6 +449,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database requires that SELECT DISTINCT queries require that all ORDER BY expressions occur in the SELECT list per the SQL92 standard + * + * @return bool */ function standardSelectDistinct() { return true; @@ -430,6 +459,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database can do a native search on IP columns * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32'; + * + * @return bool */ function searchableIPs() { return false; @@ -437,6 +468,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns true if this database can use functional indexes + * + * @return bool */ function functionalIndexes() { return false; @@ -450,7 +483,6 @@ abstract class DatabaseBase implements DatabaseType { return $this->mLastQuery; } - /** * Returns true if the connection may have been used for write queries. * Should return true if unsure. @@ -506,6 +538,10 @@ abstract class DatabaseBase implements DatabaseType { /** * General read-only accessor + * + * @param $name string + * + * @return string */ function getProperty( $name ) { return $this->$name; @@ -576,17 +612,44 @@ abstract class DatabaseBase implements DatabaseType { } } + /** + * Called by serialize. Throw an exception when DB connection is serialized. + * This causes problems on some database engines because the connection is + * not restored on unserialize. + */ + public function __sleep() { + throw new MWException( 'Database serialization may cause problems, since the connection is not restored on wakeup.' ); + } + /** * Same as new DatabaseMysql( ... ), kept for backward compatibility * @deprecated since 1.17 * + * @param $server + * @param $user + * @param $password + * @param $dbName + * @param $flags int * @return DatabaseMysql */ static function newFromParams( $server, $user, $password, $dbName, $flags = 0 ) { - wfDeprecated( __METHOD__ ); + wfDeprecated( __METHOD__, '1.17' ); return new DatabaseMysql( $server, $user, $password, $dbName, $flags ); } + /** + * Same as new factory( ... ), kept for backward compatibility + * @deprecated since 1.18 + * @see Database::factory() + */ + public final static function newFromType( $dbType, $p = array() ) { + wfDeprecated( __METHOD__, '1.18' ); + if ( isset( $p['tableprefix'] ) ) { + $p['tablePrefix'] = $p['tableprefix']; + } + return self::factory( $dbType, $p ); + } + /** * Given a DB type, construct the name of the appropriate child class of * DatabaseBase. This is designed to replace all of the manual stuff like: @@ -612,9 +675,9 @@ abstract class DatabaseBase implements DatabaseType { 'mysql', 'postgres', 'sqlite', 'oracle', 'mssql', 'ibm_db2' ); $dbType = strtolower( $dbType ); + $class = 'Database' . ucfirst( $dbType ); if( in_array( $dbType, $canonicalDBTypes ) ) { - $class = 'Database' . ucfirst( $dbType ); return new $class( isset( $p['host'] ) ? $p['host'] : false, isset( $p['user'] ) ? $p['user'] : false, @@ -623,6 +686,8 @@ abstract class DatabaseBase implements DatabaseType { isset( $p['flags'] ) ? $p['flags'] : 0, isset( $p['tablePrefix'] ) ? $p['tablePrefix'] : 'get from global' ); + } elseif (class_exists($class)) { + return new $class($p); } else { return null; } @@ -634,6 +699,9 @@ abstract class DatabaseBase implements DatabaseType { set_error_handler( array( $this, 'connectionErrorHandler' ) ); } + /** + * @return bool|string + */ protected function restoreErrorHandler() { restore_error_handler(); if ( $this->htmlErrors !== false ) { @@ -648,6 +716,10 @@ abstract class DatabaseBase implements DatabaseType { } } + /** + * @param $errno + * @param $errstr + */ protected function connectionErrorHandler( $errno, $errstr ) { $this->mPHPError = $errstr; } @@ -680,7 +752,7 @@ abstract class DatabaseBase implements DatabaseType { * The DBMS-dependent part of query() * * @param $sql String: SQL query. - * @return Result object to feed to fetchObject, fetchRow, ...; or false on failure + * @return ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure */ protected abstract function doQuery( $sql ); @@ -688,6 +760,8 @@ abstract class DatabaseBase implements DatabaseType { * Determine whether a query writes to the DB. * Should return true if unsure. * + * @param $sql string + * * @return bool */ function isWriteQuery( $sql ) { @@ -695,14 +769,14 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Run an SQL query and return the result. Normally throws a DBQueryError + * Run an SQL query and return the result. Normally throws a DBQueryError * on failure. If errors are ignored, returns false instead. * - * In new code, the query wrappers select(), insert(), update(), delete(), - * etc. should be used where possible, since they give much better DBMS + * In new code, the query wrappers select(), insert(), update(), delete(), + * etc. should be used where possible, since they give much better DBMS * independence and automatically quote or validate user input in a variety * of contexts. This function is generally only useful for queries which are - * explicitly DBMS-dependent and are unsupported by the query wrappers, such + * explicitly DBMS-dependent and are unsupported by the query wrappers, such * as CREATE TABLE. * * However, the query wrappers themselves should call this function. @@ -712,7 +786,7 @@ abstract class DatabaseBase implements DatabaseType { * comment (you can use __METHOD__ or add some extra info) * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors... * maybe best to catch the exception instead? - * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object + * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object * for a successful read query, or false on failure if $tempIgnore set * @throws DBQueryError Thrown when the database returns an error of any kind */ @@ -761,7 +835,7 @@ abstract class DatabaseBase implements DatabaseType { # that would delay transaction initializations to once connection # is really used by application $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm) - if ( strpos( $sqlstart, "SHOW " ) !== 0 and strpos( $sqlstart, "SET " ) !== 0 ) + if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) $this->begin(); } @@ -783,9 +857,13 @@ abstract class DatabaseBase implements DatabaseType { throw new MWException( 'Tainted query found' ); } + $queryId = MWDebug::query( $sql, $fname, $isMaster ); + # Do the query and handle errors $ret = $this->doQuery( $commentedSql ); + MWDebug::queryTime( $queryId ); + # Try reconnecting if the connection was lost if ( false === $ret && $this->wasErrorReissuable() ) { # Transaction is gone, like it or not @@ -821,7 +899,7 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Report a query error. Log the error, and if neither the object ignore + * Report a query error. Log the error, and if neither the object ignore * flag nor the $tempIgnore flag is set, throw a DBQueryError. * * @param $error String @@ -855,10 +933,13 @@ abstract class DatabaseBase implements DatabaseType { * & = filename; reads the file and inserts as a blob * (we don't use this though...) * - * This function should not be used directly by new code outside of the + * This function should not be used directly by new code outside of the * database classes. The query wrapper functions (select() etc.) should be * used instead. * + * @param $sql string + * @param $func string + * * @return array */ function prepare( $sql, $func = 'DatabaseBase::prepare' ) { @@ -870,6 +951,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Free a prepared query, generated by prepare(). + * @param $prepared */ function freePrepared( $prepared ) { /* No-op by default */ @@ -898,7 +980,7 @@ abstract class DatabaseBase implements DatabaseType { * Prepare & execute an SQL statement, quoting and inserting arguments * in the appropriate places. * - * This function should not be used directly by new code outside of the + * This function should not be used directly by new code outside of the * database classes. The query wrapper functions (select() etc.) should be * used instead. * @@ -944,7 +1026,6 @@ abstract class DatabaseBase implements DatabaseType { * * @param $matches Array * @return String - * @private */ function fillPreparedArg( $matches ) { switch( $matches[1] ) { @@ -967,8 +1048,8 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Free a result object returned by query() or select(). It's usually not - * necessary to call this, just use unset() or let the variable holding + * Free a result object returned by query() or select(). It's usually not + * necessary to call this, just use unset() or let the variable holding * the result object go out of scope. * * @param $res Mixed: A SQL result @@ -984,6 +1065,12 @@ abstract class DatabaseBase implements DatabaseType { * This function exists for historical reasons, DatabaseBase::update() has a more standard * calling convention and feature set * + * @param $table string + * @param $var + * @param $value + * @param $cond + * @param $fname string + * * @return bool */ function set( $table, $var, $value, $cond, $fname = 'DatabaseBase::set' ) { @@ -997,22 +1084,22 @@ abstract class DatabaseBase implements DatabaseType { /** * A SELECT wrapper which returns a single field from a single result row. * - * Usually throws a DBQueryError on failure. If errors are explicitly + * Usually throws a DBQueryError on failure. If errors are explicitly * ignored, returns false on failure. * * If no result rows are returned from the query, false is returned. * - * @param $table Table name. See DatabaseBase::select() for details. - * @param $var The field name to select. This must be a valid SQL + * @param $table string|array Table name. See DatabaseBase::select() for details. + * @param $var string The field name to select. This must be a valid SQL * fragment: do not use unvalidated user input. - * @param $cond The condition array. See DatabaseBase::select() for details. - * @param $fname The function name of the caller. - * @param $options The query options. See DatabaseBase::select() for details. + * @param $cond string|array The condition array. See DatabaseBase::select() for details. + * @param $fname string The function name of the caller. + * @param $options string|array The query options. See DatabaseBase::select() for details. * - * @return The value from the field, or false on failure. + * @return false|mixed The value from the field, or false on failure. */ - function selectField( $table, $var, $cond = '', $fname = 'DatabaseBase::selectField', - $options = array() ) + function selectField( $table, $var, $cond = '', $fname = 'DatabaseBase::selectField', + $options = array() ) { if ( !is_array( $options ) ) { $options = array( $options ); @@ -1037,7 +1124,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns an optional USE INDEX clause to go after the table, and a - * string to go at the end of the query. + * string to go at the end of the query. * * @param $options Array: associative array of options to be turned into * an SQL query, valid keys are listed in the function. @@ -1145,103 +1232,99 @@ abstract class DatabaseBase implements DatabaseType { * @param $options Array Query options * @param $join_conds Array Join conditions * + * @param $table string|array * - * @b $table - * - * May be either an array of table names, or a single string holding a table - * name. If an array is given, table aliases can be specified, for example: + * May be either an array of table names, or a single string holding a table + * name. If an array is given, table aliases can be specified, for example: * * array( 'a' => 'user' ) * - * This includes the user table in the query, with the alias "a" available + * This includes the user table in the query, with the alias "a" available * for use in field names (e.g. a.user_name). * - * All of the table names given here are automatically run through - * DatabaseBase::tableName(), which causes the table prefix (if any) to be + * All of the table names given here are automatically run through + * DatabaseBase::tableName(), which causes the table prefix (if any) to be * added, and various other table name mappings to be performed. * * - * @b $vars + * @param $vars string|array * - * May be either a field name or an array of field names. The field names - * here are complete fragments of SQL, for direct inclusion into the SELECT + * May be either a field name or an array of field names. The field names + * here are complete fragments of SQL, for direct inclusion into the SELECT * query. Expressions and aliases may be specified as in SQL, for example: * * array( 'MAX(rev_id) AS maxrev' ) - * - * If an expression is given, care must be taken to ensure that it is + * + * If an expression is given, care must be taken to ensure that it is * DBMS-independent. * * - * @b $conds + * @param $conds string|array * - * May be either a string containing a single condition, or an array of - * conditions. If an array is given, the conditions constructed from each - * element are combined with AND. + * May be either a string containing a single condition, or an array of + * conditions. If an array is given, the conditions constructed from each + * element are combined with AND. * * Array elements may take one of two forms: * * - Elements with a numeric key are interpreted as raw SQL fragments. - * - Elements with a string key are interpreted as equality conditions, + * - Elements with a string key are interpreted as equality conditions, * where the key is the field name. - * - If the value of such an array element is a scalar (such as a - * string), it will be treated as data and thus quoted appropriately. + * - If the value of such an array element is a scalar (such as a + * string), it will be treated as data and thus quoted appropriately. * If it is null, an IS NULL clause will be added. - * - If the value is an array, an IN(...) clause will be constructed, - * such that the field name may match any of the elements in the + * - If the value is an array, an IN(...) clause will be constructed, + * such that the field name may match any of the elements in the * array. The elements of the array will be quoted. - * - If the field name ends with "!", this is taken as a flag which - * inverts the comparison, allowing NOT IN clauses to be constructed, - * for example: array( 'user_id!' => array( 1, 2, 3 ) ) * - * Note that expressions are often DBMS-dependent in their syntax. - * DBMS-independent wrappers are provided for constructing several types of + * Note that expressions are often DBMS-dependent in their syntax. + * DBMS-independent wrappers are provided for constructing several types of * expression commonly used in condition queries. See: * - DatabaseBase::buildLike() * - DatabaseBase::conditional() * * - * @b $options + * @param $options string|array * - * Optional: Array of query options. Boolean options are specified by - * including them in the array as a string value with a numeric key, for + * Optional: Array of query options. Boolean options are specified by + * including them in the array as a string value with a numeric key, for * example: * * array( 'FOR UPDATE' ) * * The supported options are: * - * - OFFSET: Skip this many rows at the start of the result set. OFFSET + * - OFFSET: Skip this many rows at the start of the result set. OFFSET * with LIMIT can theoretically be used for paging through a result set, - * but this is discouraged in MediaWiki for performance reasons. + * but this is discouraged in MediaWiki for performance reasons. * - * - LIMIT: Integer: return at most this many rows. The rows are sorted + * - LIMIT: Integer: return at most this many rows. The rows are sorted * and then the first rows are taken until the limit is reached. LIMIT * is applied to a result set after OFFSET. * - * - FOR UPDATE: Boolean: lock the returned rows so that they can't be + * - FOR UPDATE: Boolean: lock the returned rows so that they can't be * changed until the next COMMIT. * * - DISTINCT: Boolean: return only unique result rows. * - * - GROUP BY: May be either an SQL fragment string naming a field or + * - GROUP BY: May be either an SQL fragment string naming a field or * expression to group by, or an array of such SQL fragments. * - * - HAVING: A string containing a HAVING clause. + * - HAVING: A string containing a HAVING clause. * - * - ORDER BY: May be either an SQL fragment giving a field name or + * - ORDER BY: May be either an SQL fragment giving a field name or * expression to order by, or an array of such SQL fragments. * - * - USE INDEX: This may be either a string giving the index name to use - * for the query, or an array. If it is an associative array, each key + * - USE INDEX: This may be either a string giving the index name to use + * for the query, or an array. If it is an associative array, each key * gives the table name (or alias), each value gives the index name to - * use for that table. All strings are SQL fragments and so should be + * use for that table. All strings are SQL fragments and so should be * validated by the caller. * - * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, + * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, * instead of SELECT. * - * And also the following boolean MySQL extensions, see the MySQL manual + * And also the following boolean MySQL extensions, see the MySQL manual * for documentation: * * - LOCK IN SHARE MODE @@ -1255,27 +1338,26 @@ abstract class DatabaseBase implements DatabaseType { * - SQL_NO_CACHE * * - * @b $join_conds + * @param $join_conds string|array * - * Optional associative array of table-specific join conditions. In the - * most common case, this is unnecessary, since the join condition can be + * Optional associative array of table-specific join conditions. In the + * most common case, this is unnecessary, since the join condition can be * in $conds. However, it is useful for doing a LEFT JOIN. * - * The key of the array contains the table name or alias. The value is an - * array with two elements, numbered 0 and 1. The first gives the type of - * join, the second is an SQL fragment giving the join condition for that + * The key of the array contains the table name or alias. The value is an + * array with two elements, numbered 0 and 1. The first gives the type of + * join, the second is an SQL fragment giving the join condition for that * table. For example: * * array( 'page' => array('LEFT JOIN','page_latest=rev_id') ) * * @return ResultWrapper. If the query returned no rows, a ResultWrapper - * with no rows in it will be returned. If there was a query error, a + * with no rows in it will be returned. If there was a query error, a * DBQueryError exception will be thrown, except if the "ignore errors" * option was set, in which case false will be returned. */ - function select( $table, $vars, $conds = '', $fname = 'DatabaseBase::select', - $options = array(), $join_conds = array() ) - { + function select( $table, $vars, $conds = '', $fname = 'DatabaseBase::select', + $options = array(), $join_conds = array() ) { $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds ); return $this->query( $sql, $fname ); @@ -1285,12 +1367,12 @@ abstract class DatabaseBase implements DatabaseType { * The equivalent of DatabaseBase::select() except that the constructed SQL * is returned, instead of being immediately executed. * - * @param $table Table name - * @param $vars Field names - * @param $conds Conditions - * @param $fname Caller function name - * @param $options Query options - * @param $join_conds Join conditions + * @param $table string|array Table name + * @param $vars string|array Field names + * @param $conds string|array Conditions + * @param $fname string Caller function name + * @param $options string|array Query options + * @param $join_conds string|array Join conditions * * @return SQL query string. * @see DatabaseBase::select() @@ -1313,7 +1395,7 @@ abstract class DatabaseBase implements DatabaseType { $from = ' FROM ' . implode( ',', $this->tableNamesWithAlias( $table ) ); } } elseif ( $table != '' ) { - if ( $table { 0 } == ' ' ) { + if ( $table[0] == ' ' ) { $from = ' FROM ' . $table; } else { $from = ' FROM ' . $this->tableName( $table ); @@ -1348,20 +1430,20 @@ abstract class DatabaseBase implements DatabaseType { /** * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except - * that a single row object is returned. If the query returns no rows, + * that a single row object is returned. If the query returns no rows, * false is returned. * - * @param $table Table name - * @param $vars Field names - * @param $conds Conditions - * @param $fname Caller function name - * @param $options Query options - * @param $join_conds Join conditions + * @param $table string|array Table name + * @param $vars string|array Field names + * @param $conds|array Conditions + * @param $fname string Caller function name + * @param $options string|array Query options + * @param $join_conds array|string Join conditions * - * @return ResultWrapper or bool + * @return ResultWrapper|bool */ - function selectRow( $table, $vars, $conds, $fname = 'DatabaseBase::selectRow', - $options = array(), $join_conds = array() ) + function selectRow( $table, $vars, $conds, $fname = 'DatabaseBase::selectRow', + $options = array(), $join_conds = array() ) { $options['LIMIT'] = 1; $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds ); @@ -1382,25 +1464,25 @@ abstract class DatabaseBase implements DatabaseType { /** * Estimate rows in dataset. * - * MySQL allows you to estimate the number of rows that would be returned + * MySQL allows you to estimate the number of rows that would be returned * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using * index cardinality statistics, and is notoriously inaccurate, especially * when large numbers of rows have recently been added or deleted. * * For DBMSs that don't support fast result size estimation, this function - * will actually perform the SELECT COUNT(*). + * will actually perform the SELECT COUNT(*). * * Takes the same arguments as DatabaseBase::select(). * * @param $table String: table name - * @param $vars Array: unused - * @param $conds Array: filters on the table + * @param Array|string $vars : unused + * @param Array|string $conds : filters on the table * @param $fname String: function name for profiling * @param $options Array: options for select * @return Integer: row count */ - public function estimateRowCount( $table, $vars = '*', $conds = '', - $fname = 'DatabaseBase::estimateRowCount', $options = array() ) + public function estimateRowCount( $table, $vars = '*', $conds = '', + $fname = 'DatabaseBase::estimateRowCount', $options = array() ) { $rows = 0; $res = $this->select ( $table, 'COUNT(*) AS rowcount', $conds, $fname, $options ); @@ -1417,7 +1499,9 @@ abstract class DatabaseBase implements DatabaseType { * 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 $sql String: A SQL Query + * @param $sql String A SQL Query + * + * @return string */ static function generalizeSQL( $sql ) { # This does the same as the regexp below would do, but in such a way @@ -1458,6 +1542,10 @@ abstract class DatabaseBase implements DatabaseType { * Usually throws a DBQueryError on failure * If errors are explicitly ignored, returns NULL on failure * + * @param $table + * @param $index + * @param $fname string + * * @return bool|null */ function indexExists( $table, $index, $fname = 'DatabaseBase::indexExists' ) { @@ -1472,14 +1560,15 @@ abstract class DatabaseBase implements DatabaseType { /** * Query whether a given table exists * - * @string table + * @param $table string + * @param $fname string * * @return bool */ - function tableExists( $table ) { + function tableExists( $table, $fname = __METHOD__ ) { $table = $this->tableName( $table ); $old = $this->ignoreErrors( true ); - $res = $this->query( "SELECT 1 FROM $table LIMIT 1", __METHOD__ ); + $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname ); $this->ignoreErrors( $old ); return (bool)$res; @@ -1487,6 +1576,9 @@ abstract class DatabaseBase implements DatabaseType { /** * mysql_field_type() wrapper + * @param $res + * @param $index + * @return string */ function fieldType( $res, $index ) { if ( $res instanceof ResultWrapper ) { @@ -1530,28 +1622,28 @@ abstract class DatabaseBase implements DatabaseType { * $a may be either: * * - A single associative array. The array keys are the field names, and - * the values are the values to insert. The values are treated as data - * and will be quoted appropriately. If NULL is inserted, this will be + * the values are the values to insert. The values are treated as data + * and will be quoted appropriately. If NULL is inserted, this will be * converted to a database NULL. - * - An array with numeric keys, holding a list of associative arrays. + * - An array with numeric keys, holding a list of associative arrays. * This causes a multi-row INSERT on DBMSs that support it. The keys in * each subarray must be identical to each other, and in the same order. * - * Usually throws a DBQueryError on failure. If errors are explicitly ignored, + * Usually throws a DBQueryError on failure. If errors are explicitly ignored, * returns success. * - * $options is an array of options, with boolean options encoded as values - * with numeric keys, in the same style as $options in + * $options is an array of options, with boolean options encoded as values + * with numeric keys, in the same style as $options in * DatabaseBase::select(). Supported options are: * - * - IGNORE: Boolean: if present, duplicate key errors are ignored, and - * any rows which cause duplicate key errors are not inserted. It's - * possible to determine how many rows were successfully inserted using + * - IGNORE: Boolean: if present, duplicate key errors are ignored, and + * any rows which cause duplicate key errors are not inserted. It's + * possible to determine how many rows were successfully inserted using * DatabaseBase::affectedRows(). * * @param $table String Table name. This will be passed through * DatabaseBase::tableName(). - * @param $a Array of rows to insert + * @param $a Array of rows to insert * @param $fname String Calling function name (use __METHOD__) for logs/profiling * @param $options Array of options * @@ -1629,13 +1721,13 @@ abstract class DatabaseBase implements DatabaseType { * @param $table String name of the table to UPDATE. This will be passed through * DatabaseBase::tableName(). * - * @param $values Array: An array of values to SET. For each array element, + * @param $values Array: An array of values to SET. For each array element, * the key gives the field name, and the value gives the data - * to set that field to. The data will be quoted by + * to set that field to. The data will be quoted by * DatabaseBase::addQuotes(). * - * @param $conds Array: An array of conditions (WHERE). See - * DatabaseBase::select() for the details of the format of + * @param $conds Array: An array of conditions (WHERE). See + * DatabaseBase::select() for the details of the format of * condition arrays. Use '*' to update all rows. * * @param $fname String: The function name of the caller (from __METHOD__), @@ -1651,7 +1743,7 @@ abstract class DatabaseBase implements DatabaseType { $opts = $this->makeUpdateOptions( $options ); $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET ); - if ( $conds != '*' ) { + if ( $conds !== array() && $conds !== '*' ) { $sql .= " WHERE " . $this->makeList( $conds, LIST_AND ); } @@ -1661,23 +1753,14 @@ abstract class DatabaseBase implements DatabaseType { /** * Makes an encoded list of strings from an array * @param $a Array containing the data - * @param $mode: + * @param $mode int Constant * - LIST_COMMA: comma separated, no field names - * - LIST_AND: ANDed WHERE clause (without the WHERE). See + * - LIST_AND: ANDed WHERE clause (without the WHERE). See * the documentation for $conds in DatabaseBase::select(). * - LIST_OR: ORed WHERE clause (without the WHERE) * - LIST_SET: comma separated with field names, like a SET clause * - LIST_NAMES: comma separated field names * - * In LIST_AND or LIST_OR modes, you can suffix a field with an exclamation - * mark to generate a 'NOT IN' structure. - * - * Example: - * $db->makeList( array( 'field!' => array( 1,2,3 ) ); - * - * outputs: - * 'field' NOT IN ('1', '2', '3' ); - * @return string */ function makeList( $a, $mode = LIST_COMMA ) { @@ -1701,13 +1784,6 @@ abstract class DatabaseBase implements DatabaseType { $first = false; } - // Support 'NOT IN' by suffixing fieldname with an exclamation mark - $not = false; - if( substr($field,-1) == '!' ) { - $not = true; - $field = substr($field, 0, -1 ); - } - if ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_numeric( $field ) ) { $list .= "($value)"; } elseif ( ( $mode == LIST_SET ) && is_numeric( $field ) ) { @@ -1720,19 +1796,13 @@ abstract class DatabaseBase implements DatabaseType { // Don't necessarily assume the single key is 0; we don't // enforce linear numeric ordering on other arrays here. $value = array_values( $value ); - - $operator = $not ? ' != ' : ' = '; - $list .= $field . $operator . $this->addQuotes( $value[0] ); + $list .= $field . " = " . $this->addQuotes( $value[0] ); } else { - $operator = $not ? ' NOT IN ' : ' IN '; - $list .= $field . $operator . "(" . $this->makeList( $value ) . ")"; + $list .= $field . " IN (" . $this->makeList( $value ) . ") "; } } elseif ( $value === null ) { if ( $mode == LIST_AND || $mode == LIST_OR ) { $list .= "$field IS "; - if ( $not ) { - $list .= "NOT "; - } } elseif ( $mode == LIST_SET ) { $list .= "$field = "; } @@ -1811,6 +1881,9 @@ abstract class DatabaseBase implements DatabaseType { * Change the current database * * @todo Explain what exactly will fail if this is not overridden. + * + * @param $db + * * @return bool Success or failure */ function selectDB( $db ) { @@ -1846,11 +1919,13 @@ abstract class DatabaseBase implements DatabaseType { * when calling query() directly. * * @param $name String: database table name - * @param $quoted Boolean: Automatically pass the table name through - * addIdentifierQuotes() so that it can be used in a query. + * @param $format String One of: + * quoted - Automatically pass the table name through addIdentifierQuotes() + * so that it can be used in a query. + * raw - Do not add identifier quotes to the table name * @return String: full database name */ - function tableName( $name, $quoted = true ) { + function tableName( $name, $format = 'quoted' ) { global $wgSharedDB, $wgSharedPrefix, $wgSharedTables; # Skip the entire process when we have a string quoted on both ends. # Note that we check the end so that we will still quote any use of @@ -1876,12 +1951,18 @@ abstract class DatabaseBase implements DatabaseType { # the correct table. $dbDetails = array_reverse( explode( '.', $name, 2 ) ); if ( isset( $dbDetails[1] ) ) { - @list( $table, $database ) = $dbDetails; + list( $table, $database ) = $dbDetails; } else { - @list( $table ) = $dbDetails; + list( $table ) = $dbDetails; } $prefix = $this->mTablePrefix; # Default prefix + # A database name has been specified in input. We don't want any + # prefixes added. + if ( isset( $database ) ) { + $prefix = ''; + } + # Note that we use the long format because php will complain in in_array if # the input is not an array, and will complain in is_array if it is not set. if ( !isset( $database ) # Don't use shared database if pre selected. @@ -1896,12 +1977,11 @@ abstract class DatabaseBase implements DatabaseType { # Quote the $database and $table and apply the prefix if not quoted. if ( isset( $database ) ) { - $database = ( !$quoted || $this->isQuotedIdentifier( $database ) ? $database : $this->addIdentifierQuotes( $database ) ); - $prefix = ''; + $database = ( $format == 'quoted' || $this->isQuotedIdentifier( $database ) ? $database : $this->addIdentifierQuotes( $database ) ); } $table = "{$prefix}{$table}"; - if ( $quoted && !$this->isQuotedIdentifier( $table ) ) { + if ( $format == 'quoted' && !$this->isQuotedIdentifier( $table ) ) { $table = $this->addIdentifierQuotes( "{$table}" ); } @@ -1919,6 +1999,8 @@ abstract class DatabaseBase implements DatabaseType { * extract($dbr->tableNames('user','watchlist')); * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user * WHERE wl_user=user_id AND wl_user=$nameWithQuotes"; + * + * @return array */ public function tableNames() { $inArray = func_get_args(); @@ -1939,6 +2021,8 @@ abstract class DatabaseBase implements DatabaseType { * list( $user, $watchlist ) = $dbr->tableNamesN('user','watchlist'); * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user * WHERE wl_user=user_id AND wl_user=$nameWithQuotes"; + * + * @return array */ public function tableNamesN() { $inArray = func_get_args(); @@ -1956,7 +2040,7 @@ abstract class DatabaseBase implements DatabaseType { * e.g. tableName AS newTableName * * @param $name string Table name, see tableName() - * @param $alias string Alias (optional) + * @param $alias string|bool Alias (optional) * @return string SQL name for aliased table. Will not alias a table to its own name */ public function tableNameWithAlias( $name, $alias = false ) { @@ -1988,9 +2072,9 @@ abstract class DatabaseBase implements DatabaseType { * Get the aliased table name clause for a FROM clause * which might have a JOIN and/or USE INDEX clause * - * @param $tables array( [alias] => table ) - * @param $use_index array() Same as for select() - * @param $join_conds array() Same as for select() + * @param $tables array ( [alias] => table ) + * @param $use_index array Same as for select() + * @param $join_conds array Same as for select() * @return string */ protected function tableNamesWithUseIndexOrJOIN( @@ -2093,6 +2177,8 @@ abstract class DatabaseBase implements DatabaseType { * Since MySQL is the odd one out here the double quotes are our generic * and we implement backticks in DatabaseMysql. * + * @param $s string + * * @return string */ public function addIdentifierQuotes( $s ) { @@ -2117,10 +2203,12 @@ abstract class DatabaseBase implements DatabaseType { * was renamed to addIdentifierQuotes. * @deprecated since 1.18 use addIdentifierQuotes * + * @param $s string + * * @return string */ function quote_ident( $s ) { - wfDeprecated( __METHOD__ ); + wfDeprecated( __METHOD__, '1.18' ); return $this->addIdentifierQuotes( $s ); } @@ -2129,12 +2217,20 @@ abstract class DatabaseBase implements DatabaseType { * WARNING: you should almost never use this function directly, * instead use buildLike() that escapes everything automatically * @deprecated since 1.17, warnings in 1.17, removed in ??? + * + * @param $s string + * + * @return string */ public function escapeLike( $s ) { - wfDeprecated( __METHOD__ ); + wfDeprecated( __METHOD__, '1.17' ); return $this->escapeLikeInternal( $s ); } + /** + * @param $s string + * @return string + */ protected function escapeLikeInternal( $s ) { $s = str_replace( '\\', '\\\\', $s ); $s = $this->strencode( $s ); @@ -2187,7 +2283,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query * - * @rerturn LikeMatch + * @return LikeMatch */ function anyString() { return new LikeMatch( '%' ); @@ -2197,6 +2293,12 @@ abstract class DatabaseBase implements DatabaseType { * 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() + * + * Any implementation of this function should *not* involve reusing + * sequence numbers created for rolled-back transactions. + * See http://bugs.mysql.com/bug.php?id=30767 for details. + * @param $seqName string + * @return null */ function nextSequenceValue( $seqName ) { return null; @@ -2209,6 +2311,8 @@ abstract class DatabaseBase implements DatabaseType { * which index to pick. Anyway, other databases might have different * indexes on a given table. So don't bother overriding this unless you're * MySQL. + * @param $index + * @return string */ function useIndexClause( $index ) { return ''; @@ -2219,24 +2323,21 @@ abstract class DatabaseBase implements DatabaseType { * * REPLACE is a very handy MySQL extension, which functions like an INSERT * except that when there is a duplicate key error, the old row is deleted - * and the new row is inserted in its place. + * and the new row is inserted in its place. * - * We simulate this with standard SQL with a DELETE followed by INSERT. To - * perform the delete, we need to know what the unique indexes are so that + * We simulate this with standard SQL with a DELETE followed by INSERT. To + * perform the delete, we need to know what the unique indexes are so that * we know how to find the conflicting rows. * - * 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 + * 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. - * - * @param $rows Can be either a single row to insert, or multiple rows, - * in the same format as for DatabaseBase::insert() - * @param $uniqueIndexes is an array of indexes. Each element may be either - * a field name or an array of field names * * @param $table String: The table to replace the row(s) in. - * @param $uniqueIndexes Array: An associative array of indexes - * @param $rows Array: Array of rows to replace + * @param $rows array Can be either a single row to insert, or multiple rows, + * in the same format as for DatabaseBase::insert() + * @param $uniqueIndexes array is an array of indexes. Each element may be either + * a field name or an array of field names * @param $fname String: Calling function name (use __METHOD__) for logs/profiling */ function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseBase::replace' ) { @@ -2290,9 +2391,11 @@ abstract class DatabaseBase implements DatabaseType { * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE * statement. * - * @param $table Table name - * @param $rows Rows to insert - * @param $fname Caller function name + * @param $table string Table name + * @param $rows array Rows to insert + * @param $fname string Caller function name + * + * @return ResultWrapper */ protected function nativeReplace( $table, $rows, $fname ) { $table = $this->tableName( $table ); @@ -2321,10 +2424,10 @@ abstract class DatabaseBase implements DatabaseType { /** * DELETE where the condition is a join. * - * MySQL overrides this to use a multi-table DELETE syntax, in other databases + * MySQL overrides this to use a multi-table DELETE syntax, in other databases * we use sub-selects * - * For safety, an empty $conds will not delete everything. If you want to + * 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. @@ -2333,16 +2436,16 @@ abstract class DatabaseBase implements DatabaseType { * @param $joinTable String: The other table. * @param $delVar String: The variable to join on, in the first table. * @param $joinVar String: The variable to join on, in the second table. - * @param $conds Array: Condition array of field names mapped to variables, + * @param $conds Array: Condition array of field names mapped to variables, * ANDed together in the WHERE clause - * @param $fname String: Calling function name (use __METHOD__) for + * @param $fname String: Calling function name (use __METHOD__) for * logs/profiling */ - function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, - $fname = 'DatabaseBase::deleteJoin' ) + function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, + $fname = 'DatabaseBase::deleteJoin' ) { if ( !$conds ) { - throw new DBUnexpectedError( $this, + throw new DBUnexpectedError( $this, 'DatabaseBase::deleteJoin() called with empty $conds' ); } @@ -2359,6 +2462,11 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns the size of a text field, or -1 for "unlimited" + * + * @param $table string + * @param $field string + * + * @return int */ function textFieldSize( $table, $field ) { $table = $this->tableName( $table ); @@ -2382,7 +2490,7 @@ abstract class DatabaseBase implements DatabaseType { * MySQL's LOW_PRIORITY. If no such feature exists, return an empty * string and nothing bad should happen. * - * @return string Returns the text of the low priority option if it is + * @return string Returns the text of the low priority option if it is * supported, or a blank string otherwise */ function lowPriorityOption() { @@ -2418,29 +2526,29 @@ abstract class DatabaseBase implements DatabaseType { * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it * into another table. * - * @param $destTable The table name to insert into - * @param $srcTable May be either a table name, or an array of table names + * @param $destTable string The table name to insert into + * @param $srcTable string|array May be either a table name, or an array of table names * to include in a join. * - * @param $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 + * @param $varMap array 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 * DatabaseBase::addQuotes() * - * @param $conds Condition array. See $conds in DatabaseBase::select() for - * the details of the format of condition arrays. May be "*" to copy the + * @param $conds array Condition array. See $conds in DatabaseBase::select() for + * the details of the format of condition arrays. May be "*" to copy the * whole table. * - * @param $fname The function name of the caller, from __METHOD__ + * @param $fname string The function name of the caller, from __METHOD__ * - * @param $insertOptions Options for the INSERT part of the query, see + * @param $insertOptions array Options for the INSERT part of the query, see * DatabaseBase::insert() for details. - * @param $selectOptions Options for the SELECT part of the query, see + * @param $selectOptions array Options for the SELECT part of the query, see * DatabaseBase::select() for details. * * @return ResultWrapper */ - function insertSelect( $destTable, $srcTable, $varMap, $conds, + function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseBase::insertSelect', $insertOptions = array(), $selectOptions = array() ) { @@ -2467,7 +2575,10 @@ abstract class DatabaseBase implements DatabaseType { " FROM $srcTable $useIndex "; if ( $conds != '*' ) { - $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND ); + if ( is_array( $conds ) ) { + $conds = $this->makeList( $conds, LIST_AND ); + } + $sql .= " WHERE $conds"; } $sql .= " $tailOpts"; @@ -2489,9 +2600,9 @@ abstract class DatabaseBase implements DatabaseType { * The version provided by default works in MySQL and SQLite. It will very * likely need to be overridden for most other DBMSes. * - * @param $sql String: SQL query we will append the limit too - * @param $limit Integer: the SQL limit - * @param $offset Integer the SQL offset (default false) + * @param $sql String SQL query we will append the limit too + * @param $limit Integer the SQL limit + * @param $offset Integer|false the SQL offset (default false) * * @return string */ @@ -2505,6 +2616,11 @@ abstract class DatabaseBase implements DatabaseType { . "{$limit} "; } + /** + * @param $sql + * @param $num + * @return string + */ function limitResultForUpdate( $sql, $num ) { return $this->limitResult( $sql, $num, 0 ); } @@ -2558,6 +2674,16 @@ abstract class DatabaseBase implements DatabaseType { return "REPLACE({$orig}, {$old}, {$new})"; } + /** + * Determines how long the server has been up + * STUB + * + * @return int + */ + function getServerUptime() { + return 0; + } + /** * Determines if the last failure was due to a deadlock * STUB @@ -2568,6 +2694,16 @@ abstract class DatabaseBase implements DatabaseType { return false; } + /** + * Determines if the last failure was due to a lock timeout + * STUB + * + * @return bool + */ + function wasLockTimeout() { + return false; + } + /** * Determines if the last query error was something that should be dealt * with by pinging the connection and reissuing the query. @@ -2604,6 +2740,8 @@ abstract class DatabaseBase implements DatabaseType { * Returns whatever the callback function returned on its successful, * iteration, or false on error, for example if the retry limit was * reached. + * + * @return bool */ function deadlockLoop() { $myFname = 'DatabaseBase::deadlockLoop'; @@ -2652,11 +2790,11 @@ abstract class DatabaseBase implements DatabaseType { * Wait for the slave to catch up to a given master position. * * @param $pos DBMasterPos object - * @param $timeout Integer: the maximum number of seconds to wait for + * @param $timeout Integer: the maximum number of seconds to wait for * synchronisation * * @return An integer: zero if the slave was past that position already, - * greater than zero if we waited for some period of time, less than + * greater than zero if we waited for some period of time, less than * zero if we timed out. */ function masterPosWait( DBMasterPos $pos, $timeout ) { @@ -2719,6 +2857,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Begin a transaction, committing any previously open transaction + * + * @param $fname string */ function begin( $fname = 'DatabaseBase::begin' ) { $this->query( 'BEGIN', $fname ); @@ -2727,6 +2867,8 @@ abstract class DatabaseBase implements DatabaseType { /** * End a transaction + * + * @param $fname string */ function commit( $fname = 'DatabaseBase::commit' ) { if ( $this->mTrxLevel ) { @@ -2738,6 +2880,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Rollback a transaction. * No-op on non-transactional databases. + * + * @param $fname string */ function rollback( $fname = 'DatabaseBase::rollback' ) { if ( $this->mTrxLevel ) { @@ -2760,10 +2904,10 @@ abstract class DatabaseBase implements DatabaseType { * @param $fname String: calling function name * @return Boolean: true if operation was successful */ - function duplicateTableStructure( $oldName, $newName, $temporary = false, - $fname = 'DatabaseBase::duplicateTableStructure' ) + function duplicateTableStructure( $oldName, $newName, $temporary = false, + $fname = 'DatabaseBase::duplicateTableStructure' ) { - throw new MWException( + throw new MWException( 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' ); } @@ -2778,12 +2922,14 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Convert a timestamp in one of the formats accepted by wfTimestamp() + * Convert a timestamp in one of the formats accepted by wfTimestamp() * to the format used for inserting into timestamp fields in this DBMS. * - * The result is unquoted, and needs to be passed through addQuotes() + * The result is unquoted, and needs to be passed through addQuotes() * before it can be included in raw SQL. * + * @param $ts string|int + * * @return string */ function timestamp( $ts = 0 ) { @@ -2791,14 +2937,16 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Convert a timestamp in one of the formats accepted by wfTimestamp() - * to the format used for inserting into timestamp fields in this DBMS. If - * NULL is input, it is passed through, allowing NULL values to be inserted + * Convert a timestamp in one of the formats accepted by wfTimestamp() + * to the format used for inserting into timestamp fields in this DBMS. If + * NULL is input, it is passed through, allowing NULL values to be inserted * into timestamp fields. * - * The result is unquoted, and needs to be passed through addQuotes() + * The result is unquoted, and needs to be passed through addQuotes() * before it can be included in raw SQL. * + * @param $ts string|int + * * @return string */ function timestampOrNull( $ts = null ) { @@ -2810,15 +2958,19 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Take the result from a query, and wrap it in a ResultWrapper if - * necessary. Boolean values are passed through as is, to indicate success - * of write queries or failure. + * Take the result from a query, and wrap it in a ResultWrapper if + * necessary. Boolean values are passed through as is, to indicate success + * of write queries or failure. * - * Once upon a time, DatabaseBase::query() returned a bare MySQL result + * Once upon a time, DatabaseBase::query() returned a bare MySQL result * resource, and it was necessary to call this function to convert it to * a wrapper. Nowadays, raw database objects are never exposed to external - * callers, so this is unnecessary in external code. For compatibility with + * callers, so this is unnecessary in external code. For compatibility with * old code, ResultWrapper objects are passed through unaltered. + * + * @param $result bool|ResultWrapper + * + * @return bool|ResultWrapper */ function resultObject( $result ) { if ( empty( $result ) ) { @@ -2835,6 +2987,11 @@ abstract class DatabaseBase implements DatabaseType { /** * Return aggregated value alias + * + * @param $valuedata + * @param $valuename string + * + * @return string */ function aggregateValue ( $valuedata, $valuename = 'value' ) { return $valuename; @@ -2851,8 +3008,12 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Get slave lag. - * Currently supported only by MySQL + * Get slave lag. Currently supported only by MySQL. + * + * Note that this function will generate a fatal error on many + * installations. Most callers should use LoadBalancer::safeGetLag() + * instead. + * * @return Database replication lag in seconds */ function getLag() { @@ -2862,17 +3023,19 @@ abstract class DatabaseBase implements DatabaseType { /** * Return the maximum number of items allowed in a list, or 0 for unlimited. * - * return int + * @return int */ function maxListLen() { return 0; } /** - * Some DBMSs have a special format for inserting into blob fields, they - * don't allow simple quoted strings to be inserted. To insert into such - * a field, pass the data through this function before passing it to - * DatabaseBase::insert(). + * Some DBMSs have a special format for inserting into blob fields, they + * don't allow simple quoted strings to be inserted. To insert into such + * a field, pass the data through this function before passing it to + * DatabaseBase::insert(). + * @param $b string + * @return string */ function encodeBlob( $b ) { return $b; @@ -2880,34 +3043,51 @@ abstract class DatabaseBase implements DatabaseType { /** * Some DBMSs return a special placeholder object representing blob fields - * in result objects. Pass the object through this function to return the + * in result objects. Pass the object through this function to return the * original string. + * @param $b string + * @return string */ function decodeBlob( $b ) { return $b; } /** - * Override database's default connection timeout. May be useful for very - * long batch queries such as full-wiki dumps, where a single query reads - * out over hours or days. May or may not be necessary for non-MySQL - * databases. For most purposes, leaving it as a no-op should be fine. + * Override database's default connection timeout * * @param $timeout Integer in seconds + * @return void + * @deprecated since 1.19; use setSessionOptions() + */ + public function setTimeout( $timeout ) { + wfDeprecated( __METHOD__, '1.19' ); + $this->setSessionOptions( array( 'connTimeout' => $timeout ) ); + } + + /** + * Override database's default behavior. $options include: + * 'connTimeout' : Set the connection timeout value in seconds. + * May be useful for very long batch queries such as + * full-wiki dumps, where a single query reads out over + * hours or days. + * + * @param $options Array + * @return void */ - public function setTimeout( $timeout ) {} + public function setSessionOptions( array $options ) {} /** * Read and execute SQL commands from a file. * - * Returns true on success, error string or exception on failure (depending + * Returns true on success, error string or exception on failure (depending * on object's error ignore settings). * * @param $filename String: File name to open * @param $lineCallback Callback: Optional function called before reading each line * @param $resultCallback Callback: Optional function called for each MySQL result - * @param $fname String: Calling function name or false if name should be + * @param $fname String: Calling function name or false if name should be * generated dynamically using $filename + * @return bool|string */ function sourceFile( $filename, $lineCallback = false, $resultCallback = false, $fname = false ) { wfSuppressWarnings(); @@ -2968,62 +3148,45 @@ abstract class DatabaseBase implements DatabaseType { /** * Read and execute commands from an open file handle. * - * Returns true on success, error string or exception on failure (depending + * Returns true on success, error string or exception on failure (depending * on object's error ignore settings). * * @param $fp Resource: File handle * @param $lineCallback Callback: Optional function called before reading each line * @param $resultCallback Callback: Optional function called for each MySQL result * @param $fname String: Calling function name + * @return bool|string */ - function sourceStream( $fp, $lineCallback = false, $resultCallback = false, - $fname = 'DatabaseBase::sourceStream' ) + function sourceStream( $fp, $lineCallback = false, $resultCallback = false, + $fname = 'DatabaseBase::sourceStream' ) { - $cmd = ""; + $cmd = ''; $done = false; - $dollarquote = false; - while ( ! feof( $fp ) ) { + while ( !feof( $fp ) ) { if ( $lineCallback ) { call_user_func( $lineCallback ); } $line = trim( fgets( $fp ) ); - $sl = strlen( $line ) - 1; - if ( $sl < 0 ) { + if ( $line == '' ) { continue; } - if ( '-' == $line { 0 } && '-' == $line { 1 } ) { + if ( '-' == $line[0] && '-' == $line[1] ) { continue; } - # # Allow dollar quoting for function declarations - if ( substr( $line, 0, 4 ) == '$mw$' ) { - if ( $dollarquote ) { - $dollarquote = false; - $done = true; - } - else { - $dollarquote = true; - } - } - elseif ( !$dollarquote ) { - if ( ';' == $line { $sl } && ( $sl < 2 || ';' != $line { $sl - 1 } ) ) { - $done = true; - $line = substr( $line, 0, $sl ); - } - } - if ( $cmd != '' ) { $cmd .= ' '; } + $done = $this->streamStatementEnd( $cmd, $line ); + $cmd .= "$line\n"; - if ( $done ) { - $cmd = str_replace( ';;', ";", $cmd ); + if ( $done || feof( $fp ) ) { $cmd = $this->replaceVars( $cmd ); $res = $this->query( $cmd, $fname ); @@ -3044,18 +3207,36 @@ abstract class DatabaseBase implements DatabaseType { return true; } + /** + * Called by sourceStream() to check if we've reached a statement end + * + * @param $sql String: SQL assembled so far + * @param $newLine String: New line about to be added to $sql + * @returns Bool: Whether $newLine contains end of the statement + */ + protected function streamStatementEnd( &$sql, &$newLine ) { + if ( $this->delimiter ) { + $prev = $newLine; + $newLine = preg_replace( '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine ); + if ( $newLine != $prev ) { + return true; + } + } + return false; + } + /** * Database independent variable replacement. Replaces a set of variables * in an SQL statement with their contents as given by $this->getSchemaVars(). * * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables. * - * - '{$var}' should be used for text and is passed through the database's + * - '{$var}' should be used for text and is passed through the database's * addQuotes method. - * - `{$var}` should be used for identifiers (eg: table and database names), - * it is passed through the database's addIdentifierQuotes method which + * - `{$var}` should be used for identifiers (eg: table and database names), + * it is passed through the database's addIdentifierQuotes method which * can be overridden if the database uses something other than backticks. - * - / *$var* / is just encoded, besides traditional table prefix and + * - / *$var* / is just encoded, besides traditional table prefix and * table options its use should be avoided. * * @param $ins String: SQL statement to replace variables in @@ -3076,6 +3257,10 @@ abstract class DatabaseBase implements DatabaseType { /** * Replace variables in sourced SQL + * + * @param $ins string + * + * @return string */ protected function replaceVars( $ins ) { $ins = $this->replaceSchemaVars( $ins ); @@ -3094,6 +3279,8 @@ abstract class DatabaseBase implements DatabaseType { /** * Get schema variables. If none have been set via setSchemaVars(), then * use some defaults from the current object. + * + * @return array */ protected function getSchemaVars() { if ( $this->mSchemaVars ) { @@ -3108,6 +3295,8 @@ abstract class DatabaseBase implements DatabaseType { * * Override this in derived classes to provide variables for tables.sql * and SQL patch files. + * + * @return array */ protected function getDefaultSchemaVars() { return array(); @@ -3115,7 +3304,10 @@ abstract class DatabaseBase implements DatabaseType { /** * Table name callback - * @private + * + * @param $matches array + * + * @return string */ protected function tableNameCallback( $matches ) { return $this->tableName( $matches[1] ); @@ -3123,6 +3315,10 @@ abstract class DatabaseBase implements DatabaseType { /** * Index name callback + * + * @param $matches array + * + * @return string */ protected function indexNameCallback( $matches ) { return $this->indexName( $matches[1] ); @@ -3173,6 +3369,8 @@ abstract class DatabaseBase implements DatabaseType { * @param $write Array of tables to lock for write access * @param $method String name of caller * @param $lowPriority bool Whether to indicate writes to be LOW PRIORITY + * + * @return bool */ public function lockTables( $read, $write, $method, $lowPriority = true ) { return true; @@ -3182,6 +3380,8 @@ abstract class DatabaseBase implements DatabaseType { * Unlock specific tables * * @param $method String the caller + * + * @return bool */ public function unlockTables( $method ) { return true; @@ -3189,9 +3389,13 @@ abstract class DatabaseBase implements DatabaseType { /** * Delete a table + * @param $tableName string + * @param $fName string + * @return bool|ResultWrapper + * @since 1.18 */ public function dropTable( $tableName, $fName = 'DatabaseBase::dropTable' ) { - if( !$this->tableExists( $tableName ) ) { + if( !$this->tableExists( $tableName, $fName ) ) { return false; } $sql = "DROP TABLE " . $this->tableName( $tableName ); @@ -3242,7 +3446,7 @@ abstract class DatabaseBase implements DatabaseType { * * This is a MySQL-specific feature. * - * @param $value Mixed: true for allow, false for deny, or "default" to + * @param $value Mixed: true for allow, false for deny, or "default" to * restore the initial value */ public function setBigSelects( $value = true ) {