Use __DIR__ instead of dirname( __FILE__ )
[lhc/web/wiklou.git] / includes / installer / DatabaseUpdater.php
index c8f5b50..ff0a99e 100644 (file)
@@ -2,11 +2,26 @@
 /**
  * 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
  */
 
-require_once( dirname(__FILE__) . '/../../maintenance/Maintenance.php' );
+require_once( __DIR__ . '/../../maintenance/Maintenance.php' );
 
 /**
  * Class for handling database updates. Roughly based off of updaters.inc, with
@@ -153,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,
@@ -167,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
         */
@@ -175,6 +195,8 @@ abstract class DatabaseUpdater {
        }
 
        /**
+        * @since 1.19
+        *
         * @param $tableName string
         * @param $indexName string
         * @param $sqlPath string
@@ -184,6 +206,9 @@ abstract class DatabaseUpdater {
        }
 
        /**
+        *
+        * @since 1.19
+        *
         * @param $tableName string
         * @param $columnName string
         * @param $sqlPath string
@@ -193,7 +218,44 @@ abstract class DatabaseUpdater {
        }
 
        /**
-        * Add a maintenance script to be run after the database updates are complete
+        *
+        * @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 ) {
@@ -210,6 +272,8 @@ abstract class DatabaseUpdater {
        }
 
        /**
+        * @since 1.17
+        *
         * @return array
         */
        public function getPostDatabaseUpdateMaintenance() {
@@ -222,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 );
@@ -235,13 +300,18 @@ abstract class DatabaseUpdater {
 
                $this->setAppliedUpdates( $wgVersion, $this->updates );
 
-               if( isset( $what['purge'] ) ) {
-                       $this->purgeCache();
-                       $this->rebuildLocalisationCache();
-               }
                if ( isset( $what['stats'] ) ) {
                        $this->checkStats();
                }
+
+               if ( isset( $what['purge'] ) ) {
+                       $this->purgeCache();
+
+                       if ( $wgLocalisationCacheConf['manualRecache'] ) {
+                               $this->rebuildLocalisationCache();
+                       }
+               }
+               $this->db->commit( __METHOD__ );
        }
 
        /**
@@ -393,13 +463,20 @@ abstract class DatabaseUpdater {
         * Applies a SQL patch
         * @param $path String Path to the patch file
         * @param $isFullPath Boolean Whether to treat $path as a relative or not
+        * @param $msg String Description of the patch
         */
-       protected function applyPatch( $path, $isFullPath = false ) {
-               if ( $isFullPath ) {
-                       $this->db->sourceFile( $path );
-               } else {
-                       $this->db->sourceFile( $this->db->patchPath( $path ) );
+       protected function applyPatch( $path, $isFullPath = false, $msg = null ) {
+               if ( $msg === null ) {
+                       $msg = "Applying $path patch";
+               }
+
+               if ( !$isFullPath ) {
+                       $path = $this->db->patchPath( $path );
                }
+
+               $this->output( "$msg ..." );
+               $this->db->sourceFile( $path );
+               $this->output( "done.\n" );
        }
 
        /**
@@ -412,9 +489,7 @@ abstract class DatabaseUpdater {
                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->applyPatch( $patch, $fullpath, "Creating $name table" );
                }
        }
 
@@ -427,13 +502,11 @@ abstract class DatabaseUpdater {
         */
        protected function addField( $table, $field, $patch, $fullpath = false ) {
                if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
-                       $this->output( "...$table table does not exist, skipping new field patch\n" );
+                       $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->applyPatch( $patch, $fullpath, "Adding $field field to table $table" );
                }
        }
 
@@ -446,11 +519,9 @@ abstract class DatabaseUpdater {
         */
        protected function addIndex( $table, $index, $patch, $fullpath = false ) {
                if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
-                       $this->output( "...$index key already set on $table table.\n" );
+                       $this->output( "...index $index already set on $table table.\n" );
                } else {
-                       $this->output( "Adding $index key to table $table... " );
-                       $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->applyPatch( $patch, $fullpath, "Adding index $index to table $table" );
                }
        }
 
@@ -464,9 +535,7 @@ abstract class DatabaseUpdater {
         */
        protected function dropField( $table, $field, $patch, $fullpath = false ) {
                if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
-                       $this->output( "Table $table contains $field field. Dropping... " );
-                       $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->applyPatch( $patch, $fullpath, "Table $table contains $field field. Dropping" );
                } else {
                        $this->output( "...$table table does not contain $field field.\n" );
                }
@@ -482,24 +551,35 @@ abstract class DatabaseUpdater {
         */
        protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
                if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
-                       $this->output( "Dropping $index key from table $table... " );
-                       $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $this->applyPatch( $patch, $fullpath, "Dropping $index index from table $table" );
                } else {
                        $this->output( "...$index key doesn't exist.\n" );
                }
        }
 
        /**
+        * If the specified table exists, drop it, or execute the
+        * patch if one is provided.
+        *
+        * Public @since 1.20
+        *
         * @param $table string
-        * @param $patch string
+        * @param $patch string|false
         * @param $fullpath bool
         */
-       protected function dropTable( $table, $patch, $fullpath = false ) {
+       public function dropTable( $table, $patch = false, $fullpath = false ) {
                if ( $this->db->tableExists( $table, __METHOD__ ) ) {
-                       $this->output( "Dropping table $table... " );
-                       $this->applyPatch( $patch, $fullpath );
-                       $this->output( "ok\n" );
+                       $msg = "Dropping table $table";
+
+                       if ( $patch === false ) {
+                               $this->output( "$msg ..." );
+                               $this->db->dropTable( $table, __METHOD__ );
+                               $this->output( "done.\n" );
+                       }
+                       else {
+                               $this->applyPatch( $patch, $fullpath, $msg );
+                       }
+
                } else {
                        $this->output( "...$table doesn't exist.\n" );
                }
@@ -516,16 +596,14 @@ abstract class DatabaseUpdater {
        public function modifyField( $table, $field, $patch, $fullpath = false ) {
                $updateKey = "$table-$field-$patch";
                if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
-                       $this->output( "...$table table does not exist, skipping modify field patch\n" );
+                       $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" );
+                       $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->applyPatch( $patch, $fullpath, "Modifying $field field of table $table" );
                        $this->insertUpdateRow( $updateKey );
-                       $this->output( "ok\n" );
                }
        }
 
@@ -544,7 +622,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" );
@@ -589,6 +667,7 @@ abstract class DatabaseUpdater {
 
                        $task = $this->maintenance->runChild( 'PopulateLogUsertext' );
                        $task->execute();
+                       $this->output( "done.\n" );
                }
        }
 
@@ -604,6 +683,7 @@ abstract class DatabaseUpdater {
 
                        $task = $this->maintenance->runChild( 'PopulateLogSearch' );
                        $task->execute();
+                       $this->output( "done.\n" );
                }
        }
 
@@ -616,9 +696,7 @@ abstract class DatabaseUpdater {
                        return;
                }
 
-               $this->output( "Converting tc_time from UNIX epoch to MediaWiki timestamp... " );
-               $this->applyPatch( 'patch-tc-timestamp.sql' );
-               $this->output( "ok\n" );
+               $this->applyPatch( 'patch-tc-timestamp.sql', false, "Converting tc_time from UNIX epoch to MediaWiki timestamp" );
        }
 
        /**
@@ -636,8 +714,10 @@ abstract class DatabaseUpdater {
                        return;
                }
 
+               $this->output( "Updating category collations..." );
                $task = $this->maintenance->runChild( 'UpdateCollation' );
                $task->execute();
+               $this->output( "...done.\n" );
        }
 
        /**
@@ -645,7 +725,6 @@ abstract class DatabaseUpdater {
         */
        protected function doMigrateUserOptions() {
                $cl = $this->maintenance->runChild( 'ConvertUserOptions', 'convertUserOptions.php' );
-               $this->output( "Migrating remaining user_options... " );
                $cl->execute();
                $this->output( "done.\n" );
        }
@@ -661,6 +740,6 @@ abstract class DatabaseUpdater {
                $this->output( "Rebuilding localisation cache...\n" );
                $cl->setForce();
                $cl->execute();
-               $this->output( "Rebuilding localisation cache done.\n" );
+               $this->output( "done.\n" );
        }
 }