3 * DBMS-specific updater helper.
9 require_once( dirname(__FILE__
) . '/../../maintenance/Maintenance.php' );
12 * Class for handling database updates. Roughly based off of updaters.inc, with
13 * a few improvements :)
18 abstract class DatabaseUpdater
{
21 * Array of updates to perform on the database
25 protected $updates = array();
28 * List of extension-provided database updates
31 protected $extensionUpdates = array();
34 * Handle to the database subclass
40 protected $shared = false;
42 protected $postDatabaseUpdateMaintenance = array(
43 'DeleteDefaultMessages',
44 'PopulateRevisionLength',
45 'PopulateRevisionSha1',
47 'FixExtLinksProtocolRelative',
53 * @param $db DatabaseBase object to perform updates on
54 * @param $shared bool Whether to perform updates on shared tables
55 * @param $maintenance Maintenance Maintenance object which created us
57 protected function __construct( DatabaseBase
&$db, $shared, Maintenance
$maintenance = null ) {
59 $this->db
->setFlag( DBO_DDLMODE
); // For Oracle's handling of schema files
60 $this->shared
= $shared;
62 $this->maintenance
= $maintenance;
64 $this->maintenance
= new FakeMaintenance
;
66 $this->maintenance
->setDB( $db );
67 $this->initOldGlobals();
68 $this->loadExtensions();
69 wfRunHooks( 'LoadExtensionSchemaUpdates', array( $this ) );
73 * Initialize all of the old globals. One day this should all become
74 * something much nicer
76 private function initOldGlobals() {
77 global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
78 $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
80 # For extensions only, should be populated via hooks
81 # $wgDBtype should be checked to specifiy the proper file
82 $wgExtNewTables = array(); // table, dir
83 $wgExtNewFields = array(); // table, column, dir
84 $wgExtPGNewFields = array(); // table, column, column attributes; for PostgreSQL
85 $wgExtPGAlteredFields = array(); // table, column, new type, conversion method; for PostgreSQL
86 $wgExtNewIndexes = array(); // table, index, dir
87 $wgExtModifiedFields = array(); // table, index, dir
91 * Loads LocalSettings.php, if needed, and initialises everything needed for LoadExtensionSchemaUpdates hook
93 private function loadExtensions() {
94 if ( !defined( 'MEDIAWIKI_INSTALL' ) ) {
95 return; // already loaded
97 $vars = Installer
::getExistingLocalSettings();
99 return; // no LocalSettings found
101 if ( !isset( $vars['wgHooks'] ) ||
!isset( $vars['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
104 global $wgHooks, $wgAutoloadClasses;
105 $wgHooks['LoadExtensionSchemaUpdates'] = $vars['wgHooks']['LoadExtensionSchemaUpdates'];
106 $wgAutoloadClasses = $wgAutoloadClasses +
$vars['wgAutoloadClasses'];
110 * @throws MWException
111 * @param DatabaseBase $db
112 * @param bool $shared
113 * @param null $maintenance
114 * @return DatabaseUpdater
116 public static function newForDB( &$db, $shared = false, $maintenance = null ) {
117 $type = $db->getType();
118 if( in_array( $type, Installer
::getDBTypes() ) ) {
119 $class = ucfirst( $type ) . 'Updater';
120 return new $class( $db, $shared, $maintenance );
122 throw new MWException( __METHOD__
. ' called for unsupported $wgDBtype' );
127 * Get a database connection to run updates
129 * @return DatabaseBase
131 public function getDB() {
136 * Output some text. If we're running from web, escape the text first.
138 * @param $str String: Text to output
140 public function output( $str ) {
141 if ( $this->maintenance
->isQuiet() ) {
144 global $wgCommandLineMode;
145 if( !$wgCommandLineMode ) {
146 $str = htmlspecialchars( $str );
153 * Add a new update coming from an extension. This should be called by
154 * extensions while executing the LoadExtensionSchemaUpdates hook.
156 * @param $update Array: the update to run. Format is the following:
157 * first item is the callback function, it also can be a
158 * simple string with the name of a function in this class,
159 * following elements are parameters to the function.
160 * Note that callback functions will receive this object as
163 public function addExtensionUpdate( Array $update ) {
164 $this->extensionUpdates
[] = $update;
168 * Convenience wrapper for addExtensionUpdate() when adding a new table (which
169 * is the most common usage of updaters in an extension)
170 * @param $tableName String Name of table to create
171 * @param $sqlPath String Full path to the schema file
173 public function addExtensionTable( $tableName, $sqlPath ) {
174 $this->extensionUpdates
[] = array( 'addTable', $tableName, $sqlPath, true );
178 * @param $tableName string
179 * @param $indexName string
180 * @param $sqlPath string
182 public function addExtensionIndex( $tableName, $indexName, $sqlPath ) {
183 $this->extensionUpdates
[] = array( 'addIndex', $tableName, $indexName, $sqlPath, true );
187 * @param $tableName string
188 * @param $columnName string
189 * @param $sqlPath string
191 public function addExtensionField( $tableName, $columnName, $sqlPath ) {
192 $this->extensionUpdates
[] = array( 'addField', $tableName, $columnName, $sqlPath, true );
196 * Add a maintenance script to be run after the database updates are complete
197 * @param $class string Name of a Maintenance subclass
199 public function addPostDatabaseUpdateMaintenance( $class ) {
200 $this->postDatabaseUpdateMaintenance
[] = $class;
204 * Get the list of extension-defined updates
208 protected function getExtensionUpdates() {
209 return $this->extensionUpdates
;
215 public function getPostDatabaseUpdateMaintenance() {
216 return $this->postDatabaseUpdateMaintenance
;
222 * @param $what Array: what updates to perform
224 public function doUpdates( $what = array( 'core', 'extensions', 'purge', 'stats' ) ) {
225 global $wgLocalisationCacheConf, $wgVersion;
227 $what = array_flip( $what );
228 if ( isset( $what['core'] ) ) {
229 $this->runUpdates( $this->getCoreUpdateList(), false );
231 if ( isset( $what['extensions'] ) ) {
232 $this->runUpdates( $this->getOldGlobalUpdates(), false );
233 $this->runUpdates( $this->getExtensionUpdates(), true );
236 $this->setAppliedUpdates( $wgVersion, $this->updates
);
238 if ( isset( $what['purge'] ) ) {
241 if ( $wgLocalisationCacheConf['manualRecache'] ) {
242 $this->rebuildLocalisationCache();
245 if ( isset( $what['stats'] ) ) {
251 * Helper function for doUpdates()
253 * @param $updates Array of updates to run
254 * @param $passSelf Boolean: whether to pass this object we calling external
257 private function runUpdates( array $updates, $passSelf ) {
258 foreach ( $updates as $params ) {
259 $func = array_shift( $params );
260 if( !is_array( $func ) && method_exists( $this, $func ) ) {
261 $func = array( $this, $func );
262 } elseif ( $passSelf ) {
263 array_unshift( $params, $this );
265 call_user_func_array( $func, $params );
268 $this->updates
= array_merge( $this->updates
, $updates );
273 * @param $updates array
275 protected function setAppliedUpdates( $version, $updates = array() ) {
276 $this->db
->clearFlag( DBO_DDLMODE
);
277 if( !$this->canUseNewUpdatelog() ) {
280 $key = "updatelist-$version-" . time();
281 $this->db
->insert( 'updatelog',
282 array( 'ul_key' => $key, 'ul_value' => serialize( $updates ) ),
284 $this->db
->setFlag( DBO_DDLMODE
);
288 * Helper function: check if the given key is present in the updatelog table.
289 * Obviously, only use this for updates that occur after the updatelog table was
291 * @param $key String Name of the key to check for
295 public function updateRowExists( $key ) {
296 $row = $this->db
->selectRow(
299 array( 'ul_key' => $key ),
306 * Helper function: Add a key to the updatelog table
307 * Obviously, only use this for updates that occur after the updatelog table was
309 * @param $key String Name of key to insert
310 * @param $val String [optional] value to insert along with the key
312 public function insertUpdateRow( $key, $val = null ) {
313 $this->db
->clearFlag( DBO_DDLMODE
);
314 $values = array( 'ul_key' => $key );
315 if( $val && $this->canUseNewUpdatelog() ) {
316 $values['ul_value'] = $val;
318 $this->db
->insert( 'updatelog', $values, __METHOD__
, 'IGNORE' );
319 $this->db
->setFlag( DBO_DDLMODE
);
323 * Updatelog was changed in 1.17 to have a ul_value column so we can record
324 * more information about what kind of updates we've done (that's what this
325 * class does). Pre-1.17 wikis won't have this column, and really old wikis
326 * might not even have updatelog at all
330 protected function canUseNewUpdatelog() {
331 return $this->db
->tableExists( 'updatelog', __METHOD__
) &&
332 $this->db
->fieldExists( 'updatelog', 'ul_value', __METHOD__
);
336 * Before 1.17, we used to handle updates via stuff like
337 * $wgExtNewTables/Fields/Indexes. This is nasty :) We refactored a lot
338 * of this in 1.17 but we want to remain back-compatible for a while. So
339 * load up these old global-based things into our update list.
343 protected function getOldGlobalUpdates() {
344 global $wgExtNewFields, $wgExtNewTables, $wgExtModifiedFields,
345 $wgExtNewIndexes, $wgSharedDB, $wgSharedTables;
347 $doUser = $this->shared ?
348 $wgSharedDB && in_array( 'user', $wgSharedTables ) :
349 !$wgSharedDB ||
!in_array( 'user', $wgSharedTables );
353 foreach ( $wgExtNewTables as $tableRecord ) {
355 'addTable', $tableRecord[0], $tableRecord[1], true
359 foreach ( $wgExtNewFields as $fieldRecord ) {
360 if ( $fieldRecord[0] != 'user' ||
$doUser ) {
362 'addField', $fieldRecord[0], $fieldRecord[1],
363 $fieldRecord[2], true
368 foreach ( $wgExtNewIndexes as $fieldRecord ) {
370 'addIndex', $fieldRecord[0], $fieldRecord[1],
371 $fieldRecord[2], true
375 foreach ( $wgExtModifiedFields as $fieldRecord ) {
377 'modifyField', $fieldRecord[0], $fieldRecord[1],
378 $fieldRecord[2], true
386 * Get an array of updates to perform on the database. Should return a
387 * multi-dimensional array. The main key is the MediaWiki version (1.12,
388 * 1.13...) with the values being arrays of updates, identical to how
389 * updaters.inc did it (for now)
393 protected abstract function getCoreUpdateList();
396 * Applies a SQL patch
397 * @param $path String Path to the patch file
398 * @param $isFullPath Boolean Whether to treat $path as a relative or not
400 protected function applyPatch( $path, $isFullPath = false ) {
402 $this->db
->sourceFile( $path );
404 $this->db
->sourceFile( $this->db
->patchPath( $path ) );
409 * Add a new table to the database
410 * @param $name String Name of the new table
411 * @param $patch String Path to the patch file
412 * @param $fullpath Boolean Whether to treat $patch path as a relative or not
414 protected function addTable( $name, $patch, $fullpath = false ) {
415 $this->output( "Creating $name table... " );
416 if ( $this->db
->tableExists( $name, __METHOD__
) ) {
417 $this->output( "...$name table already exists. Skipping create table $name\n" );
419 $this->applyPatch( $patch, $fullpath );
420 $this->output( "ok\n" );
425 * Add a new field to an existing table
426 * @param $table String Name of the table to modify
427 * @param $field String Name of the new field
428 * @param $patch String Path to the patch file
429 * @param $fullpath Boolean Whether to treat $patch path as a relative or not
431 protected function addField( $table, $field, $patch, $fullpath = false ) {
432 $this->output( "Adding $field field to table $table..." );
433 if ( !$this->db
->tableExists( $table, __METHOD__
) ) {
434 $this->output( "...$table table does not exist, skipping new field patch\n" );
435 } elseif ( $this->db
->fieldExists( $table, $field, __METHOD__
) ) {
436 $this->output( "...already have $field field in $table table, skipping new field patch\n" );
438 $this->applyPatch( $patch, $fullpath );
439 $this->output( "ok\n" );
444 * Add a new index to an existing table
445 * @param $table String Name of the table to modify
446 * @param $index String Name of the new index
447 * @param $patch String Path to the patch file
448 * @param $fullpath Boolean Whether to treat $patch path as a relative or not
450 protected function addIndex( $table, $index, $patch, $fullpath = false ) {
451 $this->output( "Adding $index key to table $table... " );
452 if ( $this->db
->indexExists( $table, $index, __METHOD__
) ) {
453 $this->output( "...$index key already set on $table table, skipping new index patch\n" );
455 $this->applyPatch( $patch, $fullpath );
456 $this->output( "ok\n" );
461 * Drop a field from an existing table
463 * @param $table String Name of the table to modify
464 * @param $field String Name of the old field
465 * @param $patch String Path to the patch file
466 * @param $fullpath Boolean Whether to treat $patch path as a relative or not
468 protected function dropField( $table, $field, $patch, $fullpath = false ) {
469 $this->output( "Dropping field $field from table $table... " );
470 if ( $this->db
->fieldExists( $table, $field, __METHOD__
) ) {
471 $this->applyPatch( $patch, $fullpath );
472 $this->output( "ok\n" );
474 $this->output( "...$table table does not contain $field field, skipping drop field\n" );
479 * Drop an index from an existing table
481 * @param $table String: Name of the table to modify
482 * @param $index String: Name of the old index
483 * @param $patch String: Path to the patch file
484 * @param $fullpath Boolean: Whether to treat $patch path as a relative or not
486 protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
487 $this->output( "Dropping $index key from table $table... " );
488 if ( $this->db
->indexExists( $table, $index, __METHOD__
) ) {
489 $this->applyPatch( $patch, $fullpath );
490 $this->output( "ok\n" );
492 $this->output( "...$index key doesn't exist in table $table, skipping drop key\n" );
497 * @param $table string
498 * @param $patch string
499 * @param $fullpath bool
501 protected function dropTable( $table, $patch, $fullpath = false ) {
502 $this->output( "Dropping table $table... " );
503 if ( $this->db
->tableExists( $table, __METHOD__
) ) {
504 $this->applyPatch( $patch, $fullpath );
505 $this->output( "ok\n" );
507 $this->output( "...$table doesn't exist, skipping drop table.\n" );
512 * Modify an existing field
514 * @param $table String: name of the table to which the field belongs
515 * @param $field String: name of the field to modify
516 * @param $patch String: path to the patch file
517 * @param $fullpath Boolean: whether to treat $patch path as a relative or not
519 public function modifyField( $table, $field, $patch, $fullpath = false ) {
520 $updateKey = "$table-$field-$patch";
521 $this->output( "Modifying $field field of table $table... " );
522 if ( !$this->db
->tableExists( $table, __METHOD__
) ) {
523 $this->output( "...$table table does not exist, skipping modify field patch\n" );
524 } elseif ( !$this->db
->fieldExists( $table, $field, __METHOD__
) ) {
525 $this->output( "...$field field does not exist in $table table, skipping modify field patch\n" );
526 } elseif( $this->updateRowExists( $updateKey ) ) {
527 $this->output( "...$field in table $table already modified by patch $patch\n" );
529 $this->applyPatch( $patch, $fullpath );
530 $this->insertUpdateRow( $updateKey );
531 $this->output( "ok\n" );
536 * Purge the objectcache table
538 protected function purgeCache() {
539 # We can't guarantee that the user will be able to use TRUNCATE,
540 # but we know that DELETE is available to us
541 $this->output( "Purging caches..." );
542 $this->db
->delete( 'objectcache', '*', __METHOD__
);
543 $this->output( "done.\n" );
547 * Check the site_stats table is not properly populated.
549 protected function checkStats() {
550 $this->output( "Checking site_stats row..." );
551 $row = $this->db
->selectRow( 'site_stats', '*', array( 'ss_row_id' => 1 ), __METHOD__
);
552 if ( $row === false ) {
553 $this->output( "data is missing! rebuilding...\n" );
554 } elseif ( isset( $row->site_stats
) && $row->ss_total_pages
== -1 ) {
555 $this->output( "missing ss_total_pages, rebuilding...\n" );
557 $this->output( "done.\n" );
560 SiteStatsInit
::doAllAndCommit( $this->db
);
563 # Common updater functions
566 * Sets the number of active users in the site_stats table
568 protected function doActiveUsersInit() {
569 $activeUsers = $this->db
->selectField( 'site_stats', 'ss_active_users', false, __METHOD__
);
570 if ( $activeUsers == -1 ) {
571 $activeUsers = $this->db
->selectField( 'recentchanges',
572 'COUNT( DISTINCT rc_user_text )',
573 array( 'rc_user != 0', 'rc_bot' => 0, "rc_log_type != 'newusers'" ), __METHOD__
575 $this->db
->update( 'site_stats',
576 array( 'ss_active_users' => intval( $activeUsers ) ),
577 array( 'ss_row_id' => 1 ), __METHOD__
, array( 'LIMIT' => 1 )
580 $this->output( "...ss_active_users user count set...\n" );
584 * Populates the log_user_text field in the logging table
586 protected function doLogUsertextPopulation() {
587 if ( !$this->updateRowExists( 'populate log_usertext' ) ) {
589 "Populating log_user_text field, printing progress markers. For large\n" .
590 "databases, you may want to hit Ctrl-C and do this manually with\n" .
591 "maintenance/populateLogUsertext.php.\n" );
593 $task = $this->maintenance
->runChild( 'PopulateLogUsertext' );
599 * Migrate log params to new table and index for searching
601 protected function doLogSearchPopulation() {
602 if ( !$this->updateRowExists( 'populate log_search' ) ) {
604 "Populating log_search table, printing progress markers. For large\n" .
605 "databases, you may want to hit Ctrl-C and do this manually with\n" .
606 "maintenance/populateLogSearch.php.\n" );
608 $task = $this->maintenance
->runChild( 'PopulateLogSearch' );
614 * Updates the timestamps in the transcache table
616 protected function doUpdateTranscacheField() {
617 if ( $this->updateRowExists( 'convert transcache field' ) ) {
618 $this->output( "...transcache tc_time already converted.\n" );
622 $this->output( "Converting tc_time from UNIX epoch to MediaWiki timestamp... " );
623 $this->applyPatch( 'patch-tc-timestamp.sql' );
624 $this->output( "ok\n" );
628 * Update CategoryLinks collation
630 protected function doCollationUpdate() {
631 global $wgCategoryCollation;
632 if ( $this->db
->selectField(
635 'cl_collation != ' . $this->db
->addQuotes( $wgCategoryCollation ),
638 $this->output( "...collations up-to-date.\n" );
642 $task = $this->maintenance
->runChild( 'UpdateCollation' );
647 * Migrates user options from the user table blob to user_properties
649 protected function doMigrateUserOptions() {
650 $cl = $this->maintenance
->runChild( 'ConvertUserOptions', 'convertUserOptions.php' );
651 $this->output( "Migrating remaining user_options... " );
653 $this->output( "done.\n" );
657 * Rebuilds the localisation cache
659 protected function rebuildLocalisationCache() {
661 * @var $cl RebuildLocalisationCache
663 $cl = $this->maintenance
->runChild( 'RebuildLocalisationCache', 'rebuildLocalisationCache.php' );
664 $this->output( "Rebuilding localisation cache...\n" );
667 $this->output( "Rebuilding localisation cache done.\n" );