Merge "cleanup callback in usort call"
[lhc/web/wiklou.git] / includes / installer / DatabaseUpdater.php
index b21f694..6483c4e 100644 (file)
@@ -2,6 +2,21 @@
 /**
  * DBMS-specific updater helper.
  *
+ * 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 Deployment
  */
@@ -43,7 +58,8 @@ abstract class DatabaseUpdater {
                'DeleteDefaultMessages',
                'PopulateRevisionLength',
                'PopulateRevisionSha1',
-               'PopulateImageSha1'
+               'PopulateImageSha1',
+               'FixExtLinksProtocolRelative',
        );
 
        /**
@@ -152,6 +168,8 @@ abstract class DatabaseUpdater {
         * Add a new update coming from an extension. This should be called by
         * extensions while executing the LoadExtensionSchemaUpdates hook.
         *
+        * @since 1.17
+        *
         * @param $update Array: the update to run. Format is the following:
         *                first item is the callback function, it also can be a
         *                simple string with the name of a function in this class,
@@ -166,6 +184,9 @@ abstract class DatabaseUpdater {
        /**
         * Convenience wrapper for addExtensionUpdate() when adding a new table (which
         * is the most common usage of updaters in an extension)
+        *
+        * @since 1.18
+        *
         * @param $tableName String Name of table to create
         * @param $sqlPath String Full path to the schema file
         */
@@ -174,6 +195,8 @@ abstract class DatabaseUpdater {
        }
 
        /**
+        * @since 1.19
+        *
         * @param $tableName string
         * @param $indexName string
         * @param $sqlPath string
@@ -183,6 +206,9 @@ abstract class DatabaseUpdater {
        }
 
        /**
+        *
+        * @since 1.19
+        *
         * @param $tableName string
         * @param $columnName string
         * @param $sqlPath string
@@ -191,6 +217,51 @@ abstract class DatabaseUpdater {
                $this->extensionUpdates[] = array( 'addField', $tableName, $columnName, $sqlPath, true );
        }
 
+       /**
+        *
+        * @since 1.20
+        *
+        * @param $tableName string
+        * @param $columnName string
+        * @param $sqlPath string
+        */
+       public function dropExtensionField( $tableName, $columnName, $sqlPath ) {
+               $this->extensionUpdates[] = array( 'dropField', $tableName, $columnName, $sqlPath, true );
+       }
+
+       /**
+        *
+        * @since 1.20
+        *
+        * @param $tableName string
+        * @param $sqlPath string
+        */
+       public function dropExtensionTable( $tableName, $sqlPath ) {
+               $this->extensionUpdates[] = array( 'dropTable', $tableName, $sqlPath, true );
+       }
+
+       /**
+        *
+        * @since 1.20
+        *
+        * @param $tableName string
+        * @return bool
+        */
+       public function tableExists( $tableName ) {
+               return ( $this->db->tableExists( $tableName, __METHOD__ ) );
+       }
+
+       /**
+        * Add a maintenance script to be run after the database updates are complete.
+        * 
+        * @since 1.19
+        * 
+        * @param $class string Name of a Maintenance subclass
+        */
+       public function addPostDatabaseUpdateMaintenance( $class ) {
+               $this->postDatabaseUpdateMaintenance[] = $class;
+       }
+
        /**
         * Get the list of extension-defined updates
         *
@@ -201,6 +272,8 @@ abstract class DatabaseUpdater {
        }
 
        /**
+        * @since 1.17
+        * 
         * @return array
         */
        public function getPostDatabaseUpdateMaintenance() {
@@ -213,8 +286,9 @@ abstract class DatabaseUpdater {
         * @param $what Array: what updates to perform
         */
        public function doUpdates( $what = array( 'core', 'extensions', 'purge', 'stats' ) ) {
-               global $wgVersion;
+               global $wgLocalisationCacheConf, $wgVersion;
 
+               $this->db->begin( __METHOD__ );
                $what = array_flip( $what );
                if ( isset( $what['core'] ) ) {
                        $this->runUpdates( $this->getCoreUpdateList(), false );
@@ -226,12 +300,18 @@ abstract class DatabaseUpdater {
 
                $this->setAppliedUpdates( $wgVersion, $this->updates );
 
-               if( isset( $what['purge'] ) ) {
-                       $this->purgeCache();
-               }
                if ( isset( $what['stats'] ) ) {
                        $this->checkStats();
                }
+
+               if ( isset( $what['purge'] ) ) {
+                       $this->purgeCache();
+
+                       if ( $wgLocalisationCacheConf['manualRecache'] ) {
+                               $this->rebuildLocalisationCache();
+                       }
+               }
+               $this->db->commit( __METHOD__ );
        }
 
        /**
@@ -315,8 +395,8 @@ abstract class DatabaseUpdater {
         * @return boolean
         */
        protected function canUseNewUpdatelog() {
-               return $this->db->tableExists( 'updatelog' ) &&
-                       $this->db->fieldExists( 'updatelog', 'ul_value' );
+               return $this->db->tableExists( 'updatelog', __METHOD__ ) &&
+                       $this->db->fieldExists( 'updatelog', 'ul_value', __METHOD__ );
        }
 
        /**
@@ -399,12 +479,12 @@ abstract class DatabaseUpdater {
         * @param $fullpath Boolean Whether to treat $patch path as a relative or not
         */
        protected function addTable( $name, $patch, $fullpath = false ) {
-               if ( $this->db->tableExists( $name ) ) {
+               if ( $this->db->tableExists( $name, __METHOD__ ) ) {
                        $this->output( "...$name table already exists.\n" );
                } else {
                        $this->output( "Creating $name table..." );
                        $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                }
        }
 
@@ -416,14 +496,14 @@ abstract class DatabaseUpdater {
         * @param $fullpath Boolean Whether to treat $patch path as a relative or not
         */
        protected function addField( $table, $field, $patch, $fullpath = false ) {
-               if ( !$this->db->tableExists( $table ) ) {
-                       $this->output( "...$table table does not exist, skipping new field patch\n" );
-               } elseif ( $this->db->fieldExists( $table, $field ) ) {
+               if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
+                       $this->output( "...$table table does not exist, skipping new field patch.\n" );
+               } elseif ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
                        $this->output( "...have $field field in $table table.\n" );
                } else {
                        $this->output( "Adding $field field to table $table..." );
                        $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                }
        }
 
@@ -435,12 +515,12 @@ abstract class DatabaseUpdater {
         * @param $fullpath Boolean Whether to treat $patch path as a relative or not
         */
        protected function addIndex( $table, $index, $patch, $fullpath = false ) {
-               if ( $this->db->indexExists( $table, $index ) ) {
-                       $this->output( "...$index key already set on $table table.\n" );
+               if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
+                       $this->output( "...index $index already set on $table table.\n" );
                } else {
-                       $this->output( "Adding $index key to table $table... " );
+                       $this->output( "Adding index $index to table $table... " );
                        $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                }
        }
 
@@ -453,10 +533,10 @@ abstract class DatabaseUpdater {
         * @param $fullpath Boolean Whether to treat $patch path as a relative or not
         */
        protected function dropField( $table, $field, $patch, $fullpath = false ) {
-               if ( $this->db->fieldExists( $table, $field ) ) {
+               if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
                        $this->output( "Table $table contains $field field. Dropping... " );
                        $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                } else {
                        $this->output( "...$table table does not contain $field field.\n" );
                }
@@ -471,10 +551,10 @@ abstract class DatabaseUpdater {
         * @param $fullpath Boolean: Whether to treat $patch path as a relative or not
         */
        protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
-               if ( $this->db->indexExists( $table, $index ) ) {
-                       $this->output( "Dropping $index key from table $table... " );
+               if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
+                       $this->output( "Dropping $index index from table $table... " );
                        $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                } else {
                        $this->output( "...$index key doesn't exist.\n" );
                }
@@ -486,10 +566,10 @@ abstract class DatabaseUpdater {
         * @param $fullpath bool
         */
        protected function dropTable( $table, $patch, $fullpath = false ) {
-               if ( $this->db->tableExists( $table ) ) {
+               if ( $this->db->tableExists( $table, __METHOD__ ) ) {
                        $this->output( "Dropping table $table... " );
                        $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                } else {
                        $this->output( "...$table doesn't exist.\n" );
                }
@@ -505,17 +585,17 @@ abstract class DatabaseUpdater {
         */
        public function modifyField( $table, $field, $patch, $fullpath = false ) {
                $updateKey = "$table-$field-$patch";
-               if ( !$this->db->tableExists( $table ) ) {
-                       $this->output( "...$table table does not exist, skipping modify field patch\n" );
-               } elseif ( !$this->db->fieldExists( $table, $field ) ) {
-                       $this->output( "...$field field does not exist in $table table, skipping modify field patch\n" );
+               if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
+                       $this->output( "...$table table does not exist, skipping modify field patch.\n" );
+               } elseif ( !$this->db->fieldExists( $table, $field, __METHOD__ ) ) {
+                       $this->output( "...$field field does not exist in $table table, skipping modify field patch.\n" );
                } elseif( $this->updateRowExists( $updateKey ) ) {
-                       $this->output( "...$field in table $table already modified by patch $patch\n" );
+                       $this->output( "...$field in table $table already modified by patch $patch.\n" );
                } else {
                        $this->output( "Modifying $field field of table $table..." );
                        $this->applyPatch( $patch, $fullpath );
                        $this->insertUpdateRow( $updateKey );
-                       $this->output( "ok\n" );
+                       $this->output( "done.\n" );
                }
        }
 
@@ -534,7 +614,7 @@ abstract class DatabaseUpdater {
         * Check the site_stats table is not properly populated.
         */
        protected function checkStats() {
-               $this->output( "Checking site_stats row..." );
+               $this->output( "...site_stats is populated..." );
                $row = $this->db->selectRow( 'site_stats', '*', array( 'ss_row_id' => 1 ), __METHOD__ );
                if ( $row === false ) {
                        $this->output( "data is missing! rebuilding...\n" );
@@ -549,6 +629,9 @@ abstract class DatabaseUpdater {
 
        # Common updater functions
 
+       /**
+        * Sets the number of active users in the site_stats table
+        */
        protected function doActiveUsersInit() {
                $activeUsers = $this->db->selectField( 'site_stats', 'ss_active_users', false, __METHOD__ );
                if ( $activeUsers == -1 ) {
@@ -564,28 +647,41 @@ abstract class DatabaseUpdater {
                $this->output( "...ss_active_users user count set...\n" );
        }
 
+       /**
+        * Populates the log_user_text field in the logging table
+        */
        protected function doLogUsertextPopulation() {
                if ( !$this->updateRowExists( 'populate log_usertext' ) ) {
                        $this->output(
                        "Populating log_user_text field, printing progress markers. For large\n" .
                        "databases, you may want to hit Ctrl-C and do this manually with\n" .
                        "maintenance/populateLogUsertext.php.\n" );
+
+                       $task = $this->maintenance->runChild( 'PopulateLogUsertext' );
+                       $task->execute();
+                       $this->output( "done.\n" );
                }
-               $task = $this->maintenance->runChild( 'PopulateLogUsertext' );
-               $task->execute();
        }
 
+       /**
+        * Migrate log params to new table and index for searching
+        */
        protected function doLogSearchPopulation() {
                if ( !$this->updateRowExists( 'populate log_search' ) ) {
                        $this->output(
                                "Populating log_search table, printing progress markers. For large\n" .
                                "databases, you may want to hit Ctrl-C and do this manually with\n" .
                                "maintenance/populateLogSearch.php.\n" );
+
+                       $task = $this->maintenance->runChild( 'PopulateLogSearch' );
+                       $task->execute();
+                       $this->output( "done.\n" );
                }
-               $task = $this->maintenance->runChild( 'PopulateLogSearch' );
-               $task->execute();
        }
 
+       /**
+        * Updates the timestamps in the transcache table
+        */
        protected function doUpdateTranscacheField() {
                if ( $this->updateRowExists( 'convert transcache field' ) ) {
                        $this->output( "...transcache tc_time already converted.\n" );
@@ -594,9 +690,12 @@ abstract class DatabaseUpdater {
 
                $this->output( "Converting tc_time from UNIX epoch to MediaWiki timestamp... " );
                $this->applyPatch( 'patch-tc-timestamp.sql' );
-               $this->output( "ok\n" );
+               $this->output( "done.\n" );
        }
 
+       /**
+        * Update CategoryLinks collation
+        */
        protected function doCollationUpdate() {
                global $wgCategoryCollation;
                if ( $this->db->selectField(
@@ -609,13 +708,31 @@ abstract class DatabaseUpdater {
                        return;
                }
 
+               $this->output( "Updating category collations..." );
                $task = $this->maintenance->runChild( 'UpdateCollation' );
                $task->execute();
+               $this->output( "...done.\n" );
        }
 
+       /**
+        * Migrates user options from the user table blob to user_properties
+        */
        protected function doMigrateUserOptions() {
                $cl = $this->maintenance->runChild( 'ConvertUserOptions', 'convertUserOptions.php' );
-               $this->output( "Migrating remaining user_options... " );
+               $cl->execute();
+               $this->output( "done.\n" );
+       }
+
+       /**
+        * Rebuilds the localisation cache
+        */
+       protected function rebuildLocalisationCache() {
+               /**
+                * @var $cl RebuildLocalisationCache
+                */
+               $cl = $this->maintenance->runChild( 'RebuildLocalisationCache', 'rebuildLocalisationCache.php' );
+               $this->output( "Rebuilding localisation cache...\n" );
+               $cl->setForce();
                $cl->execute();
                $this->output( "done.\n" );
        }