Merge "Follow-up I0b781c11 (2a55449): use User::getAutomaticGroups()."
[lhc/web/wiklou.git] / includes / db / DatabaseMssql.php
index d8452f9..914ab40 100644 (file)
@@ -2,6 +2,21 @@
 /**
  * This is the MS SQL Server Native database abstraction layer.
  *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup Database
  * @author Joel Penner <a-joelpe at microsoft dot com>
@@ -46,6 +61,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * Usually aborts on failure
+        * @return bool|DatabaseBase|null
         */
        function open( $server, $user, $password, $dbName ) {
                # Test for driver support, to avoid suppressed fatal error
@@ -107,17 +123,13 @@ class DatabaseMssql extends DatabaseBase {
        /**
         * Closes a database connection, if it is open
         * Returns success, true if already closed
+        * @return bool
         */
-       function close() {
-               $this->mOpened = false;
-               if ( $this->mConn ) {
-                       return sqlsrv_close( $this->mConn );
-               } else {
-                       return true;
-               }
+       protected function closeConnection() {
+               return sqlsrv_close( $this->mConn );
        }
 
-       function doQuery( $sql ) {
+       protected function doQuery( $sql ) {
                wfDebug( "SQL: [$sql]\n" );
                $this->offset = 0;
 
@@ -226,6 +238,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * This must be called after nextSequenceVal
+        * @return null
         */
        function insertId() {
                return $this->mInsertId;
@@ -310,6 +323,7 @@ class DatabaseMssql extends DatabaseBase {
         * This is not necessarily an accurate estimate, so use sparingly
         * Returns -1 if count cannot be found
         * Takes same arguments as Database::select()
+        * @return int
         */
        function estimateRowCount( $table, $vars = '*', $conds = '', $fname = 'DatabaseMssql::estimateRowCount', $options = array() ) {
                $options['EXPLAIN'] = true;// http://msdn2.microsoft.com/en-us/library/aa259203.aspx
@@ -326,6 +340,7 @@ class DatabaseMssql extends DatabaseBase {
        /**
         * Returns information about an index
         * If errors are explicitly ignored, returns NULL on failure
+        * @return array|bool|null
         */
        function indexInfo( $table, $index, $fname = 'DatabaseMssql::indexExists' ) {
                # This does not return the same info as MYSQL would, but that's OK because MediaWiki never uses the
@@ -345,7 +360,7 @@ class DatabaseMssql extends DatabaseBase {
                                        $row->Column_name = trim( $col );
                                        $result[] = clone $row;
                                }
-                       } else if ( $index == 'PRIMARY' && stristr( $row->index_description, 'PRIMARY' ) ) {
+                       } elseif ( $index == 'PRIMARY' && stristr( $row->index_description, 'PRIMARY' ) ) {
                                $row->Non_unique = 0;
                                $cols = explode( ", ", $row->index_keys );
                                foreach ( $cols as $col ) {
@@ -365,6 +380,7 @@ class DatabaseMssql extends DatabaseBase {
         *
         * Usually aborts on failure
         * If errors are explicitly ignored, returns success
+        * @return bool
         */
        function insert( $table, $arrToInsert, $fname = 'DatabaseMssql::insert', $options = array() ) {
                # No rows to insert, easy just return now
@@ -494,6 +510,7 @@ class DatabaseMssql extends DatabaseBase {
         * Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
         * $conds may be "*" to copy the whole table
         * srcTable may be an array of tables.
+        * @return null|\ResultWrapper
         */
        function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseMssql::insertSelect',
                $insertOptions = array(), $selectOptions = array() ) {
@@ -511,6 +528,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * Return the next in a sequence, save the value for retrieval via insertId()
+        * @return
         */
        function nextSequenceValue( $seqName ) {
                if ( !$this->tableExists( 'sequence_' . $seqName ) ) {
@@ -527,6 +545,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * Return the current value of a sequence. Assumes it has ben nextval'ed in this session.
+        * @return
         */
        function currentSequenceValue( $seqName ) {
                $ret = sqlsrv_query( $this->mConn, "SELECT TOP 1 id FROM [sequence_$seqName] ORDER BY id DESC" );
@@ -539,82 +558,6 @@ class DatabaseMssql extends DatabaseBase {
                }
        }
 
-
-       # REPLACE query wrapper
-       # MSSQL 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 = 'DatabaseMssql::replace' ) {
-               $table = $this->tableName( $table );
-
-               if ( count( $rows ) == 0 ) {
-                       return;
-               }
-
-               # Single row case
-               if ( !is_array( reset( $rows ) ) ) {
-                       $rows = array( $rows );
-               }
-
-               foreach ( $rows as $row ) {
-                       # Delete rows which collide
-                       if ( $uniqueIndexes ) {
-                               $sql = "DELETE FROM $table WHERE ";
-                               $first = true;
-                               foreach ( $uniqueIndexes as $index ) {
-                                       if ( $first ) {
-                                               $first = false;
-                                               $sql .= "(";
-                                       } else {
-                                               $sql .= ') OR (';
-                                       }
-                                       if ( is_array( $index ) ) {
-                                               $first2 = true;
-                                               foreach ( $index as $col ) {
-                                                       if ( $first2 ) {
-                                                               $first2 = false;
-                                                       } else {
-                                                               $sql .= ' AND ';
-                                                       }
-                                                       $sql .= $col . '=' . $this->addQuotes( $row[$col] );
-                                               }
-                                       } else {
-                                               $sql .= $index . '=' . $this->addQuotes( $row[$index] );
-                                       }
-                               }
-                               $sql .= ')';
-                               $this->query( $sql, $fname );
-                       }
-
-                       # Now insert the row
-                       $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES ) . ') VALUES (' .
-                               $this->makeList( $row, LIST_COMMA ) . ')';
-                       $this->query( $sql, $fname );
-               }
-       }
-
-       # DELETE where the condition is a join
-       function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = "DatabaseMssql::deleteJoin" ) {
-               if ( !$conds ) {
-                       throw new DBUnexpectedError( $this, 'DatabaseMssql::deleteJoin() called with empty $conds' );
-               }
-
-               $delTable = $this->tableName( $delTable );
-               $joinTable = $this->tableName( $joinTable );
-               $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
-               if ( $conds != '*' ) {
-                       $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
-               }
-               $sql .= ')';
-
-               $this->query( $sql, $fname );
-       }
-
        # Returns the size of a text field, or -1 for "unlimited"
        function textFieldSize( $table, $field ) {
                $table = $this->tableName( $table );
@@ -635,6 +578,7 @@ class DatabaseMssql extends DatabaseBase {
         * $sql string SQL query we will append the limit too
         * $limit integer the SQL limit
         * $offset integer the SQL offset (default false)
+        * @return mixed|string
         */
        function limitResult( $sql, $limit, $offset = false ) {
                if ( $offset === false || $offset == 0 ) {
@@ -676,14 +620,6 @@ class DatabaseMssql extends DatabaseBase {
                return $sql;
        }
 
-       // MSSQL does support this, but documentation is too thin to make a generalized
-       // function for this. Apparently UPDATE TOP (N) works, but the sort order
-       // may not be what we're expecting so the top n results may be a random selection.
-       // TODO: Implement properly.
-       function limitResultForUpdate( $sql, $num ) {
-               return $sql;
-       }
-
        function timestamp( $ts = 0 ) {
                return wfTimestamp( TS_ISO_8601, $ts );
        }
@@ -707,7 +643,7 @@ class DatabaseMssql extends DatabaseBase {
                return $version;
        }
 
-       function tableExists ( $table, $schema = false ) {
+       function tableExists ( $table, $fname = __METHOD__, $schema = false ) {
                $res = sqlsrv_query( $this->mConn, "SELECT * FROM information_schema.tables
                        WHERE table_type='BASE TABLE' AND table_name = '$table'" );
                if ( $res === false ) {
@@ -723,6 +659,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * Query whether a given column exists in the mediawiki schema
+        * @return bool
         */
        function fieldExists( $table, $field, $fname = 'DatabaseMssql::fieldExists' ) {
                $table = $this->tableName( $table );
@@ -757,7 +694,7 @@ class DatabaseMssql extends DatabaseBase {
        /**
         * Begin a transaction, committing any previously open transaction
         */
-       function begin( $fname = 'DatabaseMssql::begin' ) {
+       protected function doBegin( $fname = 'DatabaseMssql::begin' ) {
                sqlsrv_begin_transaction( $this->mConn );
                $this->mTrxLevel = 1;
        }
@@ -765,7 +702,7 @@ class DatabaseMssql extends DatabaseBase {
        /**
         * End a transaction
         */
-       function commit( $fname = 'DatabaseMssql::commit' ) {
+       protected function doCommit( $fname = 'DatabaseMssql::commit' ) {
                sqlsrv_commit( $this->mConn );
                $this->mTrxLevel = 0;
        }
@@ -774,57 +711,16 @@ class DatabaseMssql extends DatabaseBase {
         * Rollback a transaction.
         * No-op on non-transactional databases.
         */
-       function rollback( $fname = 'DatabaseMssql::rollback' ) {
+       protected function doRollback( $fname = 'DatabaseMssql::rollback' ) {
                sqlsrv_rollback( $this->mConn );
                $this->mTrxLevel = 0;
        }
 
-       function setup_database() {
-               global $wgDBuser;
-
-               // Make sure that we can write to the correct schema
-               $ctest = "mediawiki_test_table";
-               if ( $this->tableExists( $ctest ) ) {
-                       $this->doQuery( "DROP TABLE $ctest" );
-               }
-               $SQL = "CREATE TABLE $ctest (a int)";
-               $res = $this->doQuery( $SQL );
-               if ( !$res ) {
-                       print "<b>FAILED</b>. Make sure that the user " . htmlspecialchars( $wgDBuser ) . " can write to the database</li>\n";
-                       die();
-               }
-               $this->doQuery( "DROP TABLE $ctest" );
-
-               $res = $this->sourceFile( "../maintenance/mssql/tables.sql" );
-               if ( $res !== true ) {
-                       echo " <b>FAILED</b></li>";
-                       die( htmlspecialchars( $res ) );
-               }
-
-               # Avoid the non-standard "REPLACE INTO" syntax
-               $f = fopen( "../maintenance/interwiki.sql", 'r' );
-               if ( $f == false ) {
-                       die( "<li>Could not find the interwiki.sql file" );
-               }
-               # We simply assume it is already empty as we have just created it
-               $SQL = "INSERT INTO interwiki(iw_prefix,iw_url,iw_local) VALUES ";
-               while ( ! feof( $f ) ) {
-                       $line = fgets( $f, 1024 );
-                       $matches = array();
-                       if ( !preg_match( '/^\s*(\(.+?),(\d)\)/', $line, $matches ) ) {
-                               continue;
-                       }
-                       $this->query( "$SQL $matches[1],$matches[2])" );
-               }
-               print " (table interwiki successfully populated)...\n";
-
-               $this->commit();
-       }
-
        /**
         * Escapes a identifier for use inm SQL.
         * Throws an exception if it is invalid.
         * Reference: http://msdn.microsoft.com/en-us/library/aa224033%28v=SQL.80%29.aspx
+        * @return string
         */
        private function escapeIdentifier( $identifier ) {
                if ( strlen( $identifier ) == 0 ) {
@@ -913,6 +809,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * @private
+        * @return string
         */
        function tableNamesWithUseIndexOrJOIN( $tables, $use_index = array(), $join_conds = array() ) {
                $ret = array();
@@ -927,12 +824,12 @@ class DatabaseMssql extends DatabaseBase {
                                $tableClause .= ' ON (' . $this->makeList( (array)$join_conds_safe[$table][1], LIST_AND ) . ')';
                                $retJOIN[] = $tableClause;
                        // Is there an INDEX clause?
-                       } else if ( isset( $use_index_safe[$table] ) ) {
+                       } elseif ( isset( $use_index_safe[$table] ) ) {
                                $tableClause = $this->tableName( $table );
                                $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
                                $ret[] = $tableClause;
                        // Is there a JOIN clause?
-                       } else if ( isset( $join_conds_safe[$table] ) ) {
+                       } elseif ( isset( $join_conds_safe[$table] ) ) {
                                $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
                                $tableClause .= ' ON (' . $this->makeList( (array)$join_conds_safe[$table][1], LIST_AND ) . ')';
                                $retJOIN[] = $tableClause;
@@ -1011,6 +908,7 @@ class DatabaseMssql extends DatabaseBase {
 
        /**
         * Get the type of the DBMS, as it appears in $wgDBtype.
+        * @return string
         */
        function getType(){
                return 'mssql';
@@ -1027,6 +925,7 @@ class DatabaseMssql extends DatabaseBase {
        /**
         * Since MSSQL doesn't recognize the infinity keyword, set date manually.
         * @todo Remove magic date
+        * @return string
         */
        public function getInfinity() {
                return '3000-01-31 00:00:00.000';