From: Aaron Schulz Date: Thu, 22 Sep 2016 21:02:53 +0000 (-0700) Subject: Break long lines and generalize some comments in /rdbms X-Git-Tag: 1.31.0-rc.0~5380^2 X-Git-Url: https://git.cyclocoop.org/%7B%24admin_url%7Dmembres/modifier.php?a=commitdiff_plain;h=80bee99157a344d056f5c02b09ced25b06fa35a0;p=lhc%2Fweb%2Fwiklou.git Break long lines and generalize some comments in /rdbms Change-Id: Ibf80c67b59df748e98d74eeab492b1f33d198024 --- diff --git a/includes/libs/rdbms/database/Database.php b/includes/libs/rdbms/database/Database.php index 0bd1e9e71c..f81c8dcdd2 100644 --- a/includes/libs/rdbms/database/Database.php +++ b/includes/libs/rdbms/database/Database.php @@ -1249,19 +1249,24 @@ abstract class Database implements IDatabase, LoggerAwareInterface { $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) ) ? $options['USE INDEX'] : []; - $ignoreIndexes = ( isset( $options['IGNORE INDEX'] ) && is_array( $options['IGNORE INDEX'] ) ) + $ignoreIndexes = ( + isset( $options['IGNORE INDEX'] ) && + is_array( $options['IGNORE INDEX'] ) + ) ? $options['IGNORE INDEX'] : []; if ( is_array( $table ) ) { $from = ' FROM ' . - $this->tableNamesWithIndexClauseOrJOIN( $table, $useIndexes, $ignoreIndexes, $join_conds ); + $this->tableNamesWithIndexClauseOrJOIN( + $table, $useIndexes, $ignoreIndexes, $join_conds ); } elseif ( $table != '' ) { if ( $table[0] == ' ' ) { $from = ' FROM ' . $table; } else { $from = ' FROM ' . - $this->tableNamesWithIndexClauseOrJOIN( [ $table ], $useIndexes, $ignoreIndexes, [] ); + $this->tableNamesWithIndexClauseOrJOIN( + [ $table ], $useIndexes, $ignoreIndexes, [] ); } } else { $from = ''; @@ -1274,7 +1279,8 @@ abstract class Database implements IDatabase, LoggerAwareInterface { if ( is_array( $conds ) ) { $conds = $this->makeList( $conds, self::LIST_AND ); } - $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex WHERE $conds $preLimitTail"; + $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex " . + "WHERE $conds $preLimitTail"; } else { $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex $preLimitTail"; } @@ -1915,7 +1921,8 @@ abstract class Database implements IDatabase, LoggerAwareInterface { } } if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX? - $ignore = $this->ignoreIndexClause( implode( ',', (array)$ignore_index[$alias] ) ); + $ignore = $this->ignoreIndexClause( + implode( ',', (array)$ignore_index[$alias] ) ); if ( $ignore != '' ) { $tableClause .= ' ' . $ignore; } @@ -2349,7 +2356,8 @@ abstract class Database implements IDatabase, LoggerAwareInterface { $srcTable = $this->tableName( $srcTable ); } - $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' . + $sql = "INSERT $insertOptions" . + " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' . " SELECT $startOpts " . implode( ',', $varMap ) . " FROM $srcTable $useIndex $ignoreIndex "; @@ -2806,7 +2814,8 @@ abstract class Database implements IDatabase, LoggerAwareInterface { } } else { if ( !$this->mTrxLevel ) { - $this->queryLogger->error( "$fname: No transaction to commit, something got out of sync." ); + $this->queryLogger->error( + "$fname: No transaction to commit, something got out of sync." ); return; // nothing to do } elseif ( $this->mTrxAutomatic ) { // @TODO: make this an exception at some point @@ -3159,7 +3168,11 @@ abstract class Database implements IDatabase, LoggerAwareInterface { * @throws Exception */ public function sourceFile( - $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false + $filename, + $lineCallback = false, + $resultCallback = false, + $fname = false, + $inputCallback = false ) { MediaWiki\suppressWarnings(); $fp = fopen( $filename, 'r' ); @@ -3174,7 +3187,8 @@ abstract class Database implements IDatabase, LoggerAwareInterface { } try { - $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback ); + $error = $this->sourceStream( + $fp, $lineCallback, $resultCallback, $fname, $inputCallback ); } catch ( Exception $e ) { fclose( $fp ); throw $e; @@ -3202,8 +3216,12 @@ abstract class Database implements IDatabase, LoggerAwareInterface { * @param bool|callable $inputCallback Optional function called for each complete query sent * @return bool|string */ - public function sourceStream( $fp, $lineCallback = false, $resultCallback = false, - $fname = __METHOD__, $inputCallback = false + public function sourceStream( + $fp, + $lineCallback = false, + $resultCallback = false, + $fname = __METHOD__, + $inputCallback = false ) { $cmd = ''; @@ -3233,7 +3251,7 @@ abstract class Database implements IDatabase, LoggerAwareInterface { if ( $done || feof( $fp ) ) { $cmd = $this->replaceVars( $cmd ); - if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) || !$inputCallback ) { + if ( !$inputCallback || call_user_func( $inputCallback, $cmd ) ) { $res = $this->query( $cmd, $fname ); if ( $resultCallback ) { @@ -3263,7 +3281,8 @@ abstract class Database implements IDatabase, LoggerAwareInterface { public function streamStatementEnd( &$sql, &$newLine ) { if ( $this->delimiter ) { $prev = $newLine; - $newLine = preg_replace( '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine ); + $newLine = preg_replace( + '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine ); if ( $newLine != $prev ) { return true; } diff --git a/includes/libs/rdbms/database/IDatabase.php b/includes/libs/rdbms/database/IDatabase.php index 21ffa8d7f3..56eb002303 100644 --- a/includes/libs/rdbms/database/IDatabase.php +++ b/includes/libs/rdbms/database/IDatabase.php @@ -84,15 +84,14 @@ interface IDatabase { public function getServerInfo(); /** - * 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 * 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. + * Database functions while you are reading an unbuffered query result + * from a normal Database connection. * * - Unbuffered queries cause the MySQL server to use large amounts of * memory and to hold broad locks which block other queries. @@ -657,7 +656,7 @@ interface IDatabase { * * - 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 for performance reasons. * * - 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 @@ -1404,10 +1403,7 @@ interface IDatabase { * The goal of this function is to create an atomic section of SQL queries * without having to start a new transaction if it already exists. * - * Atomic sections are more strict than transactions. With transactions, - * attempting to begin a new transaction when one is already running results - * in MediaWiki issuing a brief warning and doing an implicit commit. All - * atomic levels *must* be explicitly closed using IDatabase::endAtomic(), + * All atomic levels *must* be explicitly closed using IDatabase::endAtomic(), * and any database transactions cannot be began or committed until all atomic * levels are closed. There is no such thing as implicitly opening or closing * an atomic section. diff --git a/includes/libs/rdbms/database/resultwrapper/MssqlResultWrapper.php b/includes/libs/rdbms/database/resultwrapper/MssqlResultWrapper.php index 768511bf5b..b591f4f389 100644 --- a/includes/libs/rdbms/database/resultwrapper/MssqlResultWrapper.php +++ b/includes/libs/rdbms/database/resultwrapper/MssqlResultWrapper.php @@ -17,7 +17,7 @@ class MssqlResultWrapper extends ResultWrapper { $result = sqlsrv_fetch_object( $res ); } - // MediaWiki expects us to return boolean false when there are no more rows instead of null + // Return boolean false when there are no more rows instead of null if ( $result === null ) { return false; } @@ -39,7 +39,7 @@ class MssqlResultWrapper extends ResultWrapper { $result = sqlsrv_fetch_array( $res ); } - // MediaWiki expects us to return boolean false when there are no more rows instead of null + // Return boolean false when there are no more rows instead of null if ( $result === null ) { return false; } diff --git a/includes/libs/rdbms/exception/DBAccessError.php b/includes/libs/rdbms/exception/DBAccessError.php index 7971dbaa93..c00082c530 100644 --- a/includes/libs/rdbms/exception/DBAccessError.php +++ b/includes/libs/rdbms/exception/DBAccessError.php @@ -25,8 +25,6 @@ */ class DBAccessError extends DBUnexpectedError { public function __construct() { - parent::__construct( "Mediawiki tried to access the database via wfGetDB(). " . - "This is not allowed, because database access has been disabled." ); + parent::__construct( "Database access has been disabled." ); } } -