MediaWiki  REL1_31
DatabaseUpdater.php
Go to the documentation of this file.
1 <?php
26 
27 require_once __DIR__ . '/../../maintenance/Maintenance.php';
28 
36 abstract class DatabaseUpdater {
42  protected $updates = [];
43 
49  protected $updatesSkipped = [];
50 
55  protected $extensionUpdates = [];
56 
62  protected $db;
63 
67  protected $maintenance;
68 
69  protected $shared = false;
70 
88  ];
89 
95  protected $fileHandle = null;
96 
102  protected $skipSchema = false;
103 
107  protected $holdContentHandlerUseDB = true;
108 
114  protected function __construct( Database &$db, $shared, Maintenance $maintenance = null ) {
115  $this->db = $db;
116  $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
117  $this->shared = $shared;
118  if ( $maintenance ) {
119  $this->maintenance = $maintenance;
120  $this->fileHandle = $maintenance->fileHandle;
121  } else {
122  $this->maintenance = new FakeMaintenance;
123  }
124  $this->maintenance->setDB( $db );
125  $this->initOldGlobals();
126  $this->loadExtensions();
127  Hooks::run( 'LoadExtensionSchemaUpdates', [ $this ] );
128  }
129 
134  private function initOldGlobals() {
135  global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
136  $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
137 
138  # For extensions only, should be populated via hooks
139  # $wgDBtype should be checked to specifiy the proper file
140  $wgExtNewTables = []; // table, dir
141  $wgExtNewFields = []; // table, column, dir
142  $wgExtPGNewFields = []; // table, column, column attributes; for PostgreSQL
143  $wgExtPGAlteredFields = []; // table, column, new type, conversion method; for PostgreSQL
144  $wgExtNewIndexes = []; // table, index, dir
145  $wgExtModifiedFields = []; // table, index, dir
146  }
147 
152  private function loadExtensions() {
153  if ( !defined( 'MEDIAWIKI_INSTALL' ) || defined( 'MW_EXTENSIONS_LOADED' ) ) {
154  return; // already loaded
155  }
157 
158  $registry = ExtensionRegistry::getInstance();
159  $queue = $registry->getQueue();
160  // Don't accidentally load extensions in the future
161  $registry->clearQueue();
162 
163  // This will automatically add "AutoloadClasses" to $wgAutoloadClasses
164  $data = $registry->readFromQueue( $queue );
165  $hooks = [];
166  if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
167  $hooks = $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'];
168  }
169  if ( $vars && isset( $vars['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
170  $hooks = array_merge_recursive( $hooks, $vars['wgHooks']['LoadExtensionSchemaUpdates'] );
171  }
173  $wgHooks['LoadExtensionSchemaUpdates'] = $hooks;
174  if ( $vars && isset( $vars['wgAutoloadClasses'] ) ) {
175  $wgAutoloadClasses += $vars['wgAutoloadClasses'];
176  }
177  }
178 
187  public static function newForDB( Database $db, $shared = false, Maintenance $maintenance = null ) {
188  $type = $db->getType();
189  if ( in_array( $type, Installer::getDBTypes() ) ) {
190  $class = ucfirst( $type ) . 'Updater';
191 
192  return new $class( $db, $shared, $maintenance );
193  } else {
194  throw new MWException( __METHOD__ . ' called for unsupported $wgDBtype' );
195  }
196  }
197 
203  public function getDB() {
204  return $this->db;
205  }
206 
212  public function output( $str ) {
213  if ( $this->maintenance->isQuiet() ) {
214  return;
215  }
217  if ( !$wgCommandLineMode ) {
218  $str = htmlspecialchars( $str );
219  }
220  echo $str;
221  flush();
222  }
223 
236  public function addExtensionUpdate( array $update ) {
237  $this->extensionUpdates[] = $update;
238  }
239 
249  public function addExtensionTable( $tableName, $sqlPath ) {
250  $this->extensionUpdates[] = [ 'addTable', $tableName, $sqlPath, true ];
251  }
252 
260  public function addExtensionIndex( $tableName, $indexName, $sqlPath ) {
261  $this->extensionUpdates[] = [ 'addIndex', $tableName, $indexName, $sqlPath, true ];
262  }
263 
272  public function addExtensionField( $tableName, $columnName, $sqlPath ) {
273  $this->extensionUpdates[] = [ 'addField', $tableName, $columnName, $sqlPath, true ];
274  }
275 
284  public function dropExtensionField( $tableName, $columnName, $sqlPath ) {
285  $this->extensionUpdates[] = [ 'dropField', $tableName, $columnName, $sqlPath, true ];
286  }
287 
297  public function dropExtensionIndex( $tableName, $indexName, $sqlPath ) {
298  $this->extensionUpdates[] = [ 'dropIndex', $tableName, $indexName, $sqlPath, true ];
299  }
300 
308  public function dropExtensionTable( $tableName, $sqlPath ) {
309  $this->extensionUpdates[] = [ 'dropTable', $tableName, $sqlPath, true ];
310  }
311 
324  public function renameExtensionIndex( $tableName, $oldIndexName, $newIndexName,
325  $sqlPath, $skipBothIndexExistWarning = false
326  ) {
327  $this->extensionUpdates[] = [
328  'renameIndex',
329  $tableName,
330  $oldIndexName,
331  $newIndexName,
332  $skipBothIndexExistWarning,
333  $sqlPath,
334  true
335  ];
336  }
337 
345  public function modifyExtensionField( $tableName, $fieldName, $sqlPath ) {
346  $this->extensionUpdates[] = [ 'modifyField', $tableName, $fieldName, $sqlPath, true ];
347  }
348 
355  public function modifyExtensionTable( $tableName, $sqlPath ) {
356  $this->extensionUpdates[] = [ 'modifyTable', $tableName, $sqlPath, true ];
357  }
358 
366  public function tableExists( $tableName ) {
367  return ( $this->db->tableExists( $tableName, __METHOD__ ) );
368  }
369 
379  public function addPostDatabaseUpdateMaintenance( $class ) {
380  $this->postDatabaseUpdateMaintenance[] = $class;
381  }
382 
388  protected function getExtensionUpdates() {
390  }
391 
399  }
400 
407  private function writeSchemaUpdateFile( array $schemaUpdate = [] ) {
409  $this->updatesSkipped = [];
410 
411  foreach ( $updates as $funcList ) {
412  $func = $funcList[0];
413  $arg = $funcList[1];
414  $origParams = $funcList[2];
415  call_user_func_array( $func, $arg );
416  flush();
417  $this->updatesSkipped[] = $origParams;
418  }
419  }
420 
431  public function getSchemaVars() {
432  return []; // DB-type specific
433  }
434 
440  public function doUpdates( array $what = [ 'core', 'extensions', 'stats' ] ) {
441  $this->db->setSchemaVars( $this->getSchemaVars() );
442 
443  $what = array_flip( $what );
444  $this->skipSchema = isset( $what['noschema'] ) || $this->fileHandle !== null;
445  if ( isset( $what['core'] ) ) {
446  $this->runUpdates( $this->getCoreUpdateList(), false );
447  }
448  if ( isset( $what['extensions'] ) ) {
449  $this->runUpdates( $this->getOldGlobalUpdates(), false );
450  $this->runUpdates( $this->getExtensionUpdates(), true );
451  }
452 
453  if ( isset( $what['stats'] ) ) {
454  $this->checkStats();
455  }
456 
457  if ( $this->fileHandle ) {
458  $this->skipSchema = false;
459  $this->writeSchemaUpdateFile();
460  }
461  }
462 
469  private function runUpdates( array $updates, $passSelf ) {
470  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
471 
472  $updatesDone = [];
473  $updatesSkipped = [];
474  foreach ( $updates as $params ) {
475  $origParams = $params;
476  $func = array_shift( $params );
477  if ( !is_array( $func ) && method_exists( $this, $func ) ) {
478  $func = [ $this, $func ];
479  } elseif ( $passSelf ) {
480  array_unshift( $params, $this );
481  }
482  $ret = call_user_func_array( $func, $params );
483  flush();
484  if ( $ret !== false ) {
485  $updatesDone[] = $origParams;
486  $lbFactory->waitForReplication();
487  } else {
488  $updatesSkipped[] = [ $func, $params, $origParams ];
489  }
490  }
491  $this->updatesSkipped = array_merge( $this->updatesSkipped, $updatesSkipped );
492  $this->updates = array_merge( $this->updates, $updatesDone );
493  }
494 
502  public function updateRowExists( $key ) {
503  $row = $this->db->selectRow(
504  'updatelog',
505  # T67813
506  '1 AS X',
507  [ 'ul_key' => $key ],
508  __METHOD__
509  );
510 
511  return (bool)$row;
512  }
513 
521  public function insertUpdateRow( $key, $val = null ) {
522  $this->db->clearFlag( DBO_DDLMODE );
523  $values = [ 'ul_key' => $key ];
524  if ( $val && $this->canUseNewUpdatelog() ) {
525  $values['ul_value'] = $val;
526  }
527  $this->db->insert( 'updatelog', $values, __METHOD__, 'IGNORE' );
528  $this->db->setFlag( DBO_DDLMODE );
529  }
530 
539  protected function canUseNewUpdatelog() {
540  return $this->db->tableExists( 'updatelog', __METHOD__ ) &&
541  $this->db->fieldExists( 'updatelog', 'ul_value', __METHOD__ );
542  }
543 
552  protected function doTable( $name ) {
554 
555  // Don't bother to check $wgSharedTables if there isn't a shared database
556  // or the user actually also wants to do updates on the shared database.
557  if ( $wgSharedDB === null || $this->shared ) {
558  return true;
559  }
560 
561  if ( in_array( $name, $wgSharedTables ) ) {
562  $this->output( "...skipping update to shared table $name.\n" );
563  return false;
564  } else {
565  return true;
566  }
567  }
568 
577  protected function getOldGlobalUpdates() {
578  global $wgExtNewFields, $wgExtNewTables, $wgExtModifiedFields,
579  $wgExtNewIndexes;
580 
581  $updates = [];
582 
583  foreach ( $wgExtNewTables as $tableRecord ) {
584  $updates[] = [
585  'addTable', $tableRecord[0], $tableRecord[1], true
586  ];
587  }
588 
589  foreach ( $wgExtNewFields as $fieldRecord ) {
590  $updates[] = [
591  'addField', $fieldRecord[0], $fieldRecord[1],
592  $fieldRecord[2], true
593  ];
594  }
595 
596  foreach ( $wgExtNewIndexes as $fieldRecord ) {
597  $updates[] = [
598  'addIndex', $fieldRecord[0], $fieldRecord[1],
599  $fieldRecord[2], true
600  ];
601  }
602 
603  foreach ( $wgExtModifiedFields as $fieldRecord ) {
604  $updates[] = [
605  'modifyField', $fieldRecord[0], $fieldRecord[1],
606  $fieldRecord[2], true
607  ];
608  }
609 
610  return $updates;
611  }
612 
621  abstract protected function getCoreUpdateList();
622 
628  public function copyFile( $filename ) {
629  $this->db->sourceFile(
630  $filename,
631  null,
632  null,
633  __METHOD__,
634  [ $this, 'appendLine' ]
635  );
636  }
637 
648  public function appendLine( $line ) {
649  $line = rtrim( $line ) . ";\n";
650  if ( fwrite( $this->fileHandle, $line ) === false ) {
651  throw new MWException( "trouble writing file" );
652  }
653 
654  return false;
655  }
656 
665  protected function applyPatch( $path, $isFullPath = false, $msg = null ) {
666  if ( $msg === null ) {
667  $msg = "Applying $path patch";
668  }
669  if ( $this->skipSchema ) {
670  $this->output( "...skipping schema change ($msg).\n" );
671 
672  return false;
673  }
674 
675  $this->output( "$msg ..." );
676 
677  if ( !$isFullPath ) {
678  $path = $this->patchPath( $this->db, $path );
679  }
680  if ( $this->fileHandle !== null ) {
681  $this->copyFile( $path );
682  } else {
683  $this->db->sourceFile( $path );
684  }
685  $this->output( "done.\n" );
686 
687  return true;
688  }
689 
699  public function patchPath( IDatabase $db, $patch ) {
700  global $IP;
701 
702  $dbType = $db->getType();
703  if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
704  return "$IP/maintenance/$dbType/archives/$patch";
705  } else {
706  return "$IP/maintenance/archives/$patch";
707  }
708  }
709 
718  protected function addTable( $name, $patch, $fullpath = false ) {
719  if ( !$this->doTable( $name ) ) {
720  return true;
721  }
722 
723  if ( $this->db->tableExists( $name, __METHOD__ ) ) {
724  $this->output( "...$name table already exists.\n" );
725  } else {
726  return $this->applyPatch( $patch, $fullpath, "Creating $name table" );
727  }
728 
729  return true;
730  }
731 
741  protected function addField( $table, $field, $patch, $fullpath = false ) {
742  if ( !$this->doTable( $table ) ) {
743  return true;
744  }
745 
746  if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
747  $this->output( "...$table table does not exist, skipping new field patch.\n" );
748  } elseif ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
749  $this->output( "...have $field field in $table table.\n" );
750  } else {
751  return $this->applyPatch( $patch, $fullpath, "Adding $field field to table $table" );
752  }
753 
754  return true;
755  }
756 
766  protected function addIndex( $table, $index, $patch, $fullpath = false ) {
767  if ( !$this->doTable( $table ) ) {
768  return true;
769  }
770 
771  if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
772  $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
773  } elseif ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
774  $this->output( "...index $index already set on $table table.\n" );
775  } else {
776  return $this->applyPatch( $patch, $fullpath, "Adding index $index to table $table" );
777  }
778 
779  return true;
780  }
781 
791  protected function dropField( $table, $field, $patch, $fullpath = false ) {
792  if ( !$this->doTable( $table ) ) {
793  return true;
794  }
795 
796  if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
797  return $this->applyPatch( $patch, $fullpath, "Table $table contains $field field. Dropping" );
798  } else {
799  $this->output( "...$table table does not contain $field field.\n" );
800  }
801 
802  return true;
803  }
804 
814  protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
815  if ( !$this->doTable( $table ) ) {
816  return true;
817  }
818 
819  if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
820  return $this->applyPatch( $patch, $fullpath, "Dropping $index index from table $table" );
821  } else {
822  $this->output( "...$index key doesn't exist.\n" );
823  }
824 
825  return true;
826  }
827 
840  protected function renameIndex( $table, $oldIndex, $newIndex,
841  $skipBothIndexExistWarning, $patch, $fullpath = false
842  ) {
843  if ( !$this->doTable( $table ) ) {
844  return true;
845  }
846 
847  // First requirement: the table must exist
848  if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
849  $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
850 
851  return true;
852  }
853 
854  // Second requirement: the new index must be missing
855  if ( $this->db->indexExists( $table, $newIndex, __METHOD__ ) ) {
856  $this->output( "...index $newIndex already set on $table table.\n" );
857  if ( !$skipBothIndexExistWarning &&
858  $this->db->indexExists( $table, $oldIndex, __METHOD__ )
859  ) {
860  $this->output( "...WARNING: $oldIndex still exists, despite it has " .
861  "been renamed into $newIndex (which also exists).\n" .
862  " $oldIndex should be manually removed if not needed anymore.\n" );
863  }
864 
865  return true;
866  }
867 
868  // Third requirement: the old index must exist
869  if ( !$this->db->indexExists( $table, $oldIndex, __METHOD__ ) ) {
870  $this->output( "...skipping: index $oldIndex doesn't exist.\n" );
871 
872  return true;
873  }
874 
875  // Requirements have been satisfied, patch can be applied
876  return $this->applyPatch(
877  $patch,
878  $fullpath,
879  "Renaming index $oldIndex into $newIndex to table $table"
880  );
881  }
882 
894  public function dropTable( $table, $patch = false, $fullpath = false ) {
895  if ( !$this->doTable( $table ) ) {
896  return true;
897  }
898 
899  if ( $this->db->tableExists( $table, __METHOD__ ) ) {
900  $msg = "Dropping table $table";
901 
902  if ( $patch === false ) {
903  $this->output( "$msg ..." );
904  $this->db->dropTable( $table, __METHOD__ );
905  $this->output( "done.\n" );
906  } else {
907  return $this->applyPatch( $patch, $fullpath, $msg );
908  }
909  } else {
910  $this->output( "...$table doesn't exist.\n" );
911  }
912 
913  return true;
914  }
915 
925  public function modifyField( $table, $field, $patch, $fullpath = false ) {
926  if ( !$this->doTable( $table ) ) {
927  return true;
928  }
929 
930  $updateKey = "$table-$field-$patch";
931  if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
932  $this->output( "...$table table does not exist, skipping modify field patch.\n" );
933  } elseif ( !$this->db->fieldExists( $table, $field, __METHOD__ ) ) {
934  $this->output( "...$field field does not exist in $table table, " .
935  "skipping modify field patch.\n" );
936  } elseif ( $this->updateRowExists( $updateKey ) ) {
937  $this->output( "...$field in table $table already modified by patch $patch.\n" );
938  } else {
939  $apply = $this->applyPatch( $patch, $fullpath, "Modifying $field field of table $table" );
940  if ( $apply ) {
941  $this->insertUpdateRow( $updateKey );
942  }
943  return $apply;
944  }
945  return true;
946  }
947 
957  public function modifyTable( $table, $patch, $fullpath = false ) {
958  if ( !$this->doTable( $table ) ) {
959  return true;
960  }
961 
962  $updateKey = "$table-$patch";
963  if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
964  $this->output( "...$table table does not exist, skipping modify table patch.\n" );
965  } elseif ( $this->updateRowExists( $updateKey ) ) {
966  $this->output( "...table $table already modified by patch $patch.\n" );
967  } else {
968  $apply = $this->applyPatch( $patch, $fullpath, "Modifying table $table" );
969  if ( $apply ) {
970  $this->insertUpdateRow( $updateKey );
971  }
972  return $apply;
973  }
974  return true;
975  }
976 
982  public function setFileAccess() {
983  $repo = RepoGroup::singleton()->getLocalRepo();
984  $zonePath = $repo->getZonePath( 'temp' );
985  if ( $repo->getBackend()->directoryExists( [ 'dir' => $zonePath ] ) ) {
986  // If the directory was never made, then it will have the right ACLs when it is made
987  $status = $repo->getBackend()->secure( [
988  'dir' => $zonePath,
989  'noAccess' => true,
990  'noListing' => true
991  ] );
992  if ( $status->isOK() ) {
993  $this->output( "Set the local repo temp zone container to be private.\n" );
994  } else {
995  $this->output( "Failed to set the local repo temp zone container to be private.\n" );
996  }
997  }
998  }
999 
1003  public function purgeCache() {
1005  // We can't guarantee that the user will be able to use TRUNCATE,
1006  // but we know that DELETE is available to us
1007  $this->output( "Purging caches..." );
1008 
1009  // ObjectCache
1010  $this->db->delete( 'objectcache', '*', __METHOD__ );
1011 
1012  // LocalisationCache
1013  if ( $wgLocalisationCacheConf['manualRecache'] ) {
1014  $this->rebuildLocalisationCache();
1015  }
1016 
1017  // ResourceLoader: Message cache
1018  $blobStore = new MessageBlobStore();
1019  $blobStore->clear();
1020 
1021  // ResourceLoader: File-dependency cache
1022  $this->db->delete( 'module_deps', '*', __METHOD__ );
1023  $this->output( "done.\n" );
1024  }
1025 
1029  protected function checkStats() {
1030  $this->output( "...site_stats is populated..." );
1031  $row = $this->db->selectRow( 'site_stats', '*', [ 'ss_row_id' => 1 ], __METHOD__ );
1032  if ( $row === false ) {
1033  $this->output( "data is missing! rebuilding...\n" );
1034  } elseif ( isset( $row->site_stats ) && $row->ss_total_pages == -1 ) {
1035  $this->output( "missing ss_total_pages, rebuilding...\n" );
1036  } else {
1037  $this->output( "done.\n" );
1038 
1039  return;
1040  }
1041  SiteStatsInit::doAllAndCommit( $this->db );
1042  }
1043 
1044  # Common updater functions
1045 
1049  protected function doActiveUsersInit() {
1050  $activeUsers = $this->db->selectField( 'site_stats', 'ss_active_users', '', __METHOD__ );
1051  if ( $activeUsers == -1 ) {
1052  $activeUsers = $this->db->selectField( 'recentchanges',
1053  'COUNT( DISTINCT rc_user_text )',
1054  [ 'rc_user != 0', 'rc_bot' => 0, "rc_log_type != 'newusers'" ], __METHOD__
1055  );
1056  $this->db->update( 'site_stats',
1057  [ 'ss_active_users' => intval( $activeUsers ) ],
1058  [ 'ss_row_id' => 1 ], __METHOD__, [ 'LIMIT' => 1 ]
1059  );
1060  }
1061  $this->output( "...ss_active_users user count set...\n" );
1062  }
1063 
1067  protected function doLogUsertextPopulation() {
1068  if ( !$this->updateRowExists( 'populate log_usertext' ) ) {
1069  $this->output(
1070  "Populating log_user_text field, printing progress markers. For large\n" .
1071  "databases, you may want to hit Ctrl-C and do this manually with\n" .
1072  "maintenance/populateLogUsertext.php.\n"
1073  );
1074 
1075  $task = $this->maintenance->runChild( PopulateLogUsertext::class );
1076  $task->execute();
1077  $this->output( "done.\n" );
1078  }
1079  }
1080 
1084  protected function doLogSearchPopulation() {
1085  if ( !$this->updateRowExists( 'populate log_search' ) ) {
1086  $this->output(
1087  "Populating log_search table, printing progress markers. For large\n" .
1088  "databases, you may want to hit Ctrl-C and do this manually with\n" .
1089  "maintenance/populateLogSearch.php.\n" );
1090 
1091  $task = $this->maintenance->runChild( PopulateLogSearch::class );
1092  $task->execute();
1093  $this->output( "done.\n" );
1094  }
1095  }
1096 
1101  protected function doUpdateTranscacheField() {
1102  if ( $this->updateRowExists( 'convert transcache field' ) ) {
1103  $this->output( "...transcache tc_time already converted.\n" );
1104 
1105  return true;
1106  }
1107 
1108  return $this->applyPatch( 'patch-tc-timestamp.sql', false,
1109  "Converting tc_time from UNIX epoch to MediaWiki timestamp" );
1110  }
1111 
1115  protected function doCollationUpdate() {
1117  if ( $this->db->fieldExists( 'categorylinks', 'cl_collation', __METHOD__ ) ) {
1118  if ( $this->db->selectField(
1119  'categorylinks',
1120  'COUNT(*)',
1121  'cl_collation != ' . $this->db->addQuotes( $wgCategoryCollation ),
1122  __METHOD__
1123  ) == 0
1124  ) {
1125  $this->output( "...collations up-to-date.\n" );
1126 
1127  return;
1128  }
1129 
1130  $this->output( "Updating category collations..." );
1131  $task = $this->maintenance->runChild( UpdateCollation::class );
1132  $task->execute();
1133  $this->output( "...done.\n" );
1134  }
1135  }
1136 
1140  protected function doMigrateUserOptions() {
1141  if ( $this->db->tableExists( 'user_properties' ) ) {
1142  $cl = $this->maintenance->runChild( ConvertUserOptions::class, 'convertUserOptions.php' );
1143  $cl->execute();
1144  $this->output( "done.\n" );
1145  }
1146  }
1147 
1151  protected function doEnableProfiling() {
1153 
1154  if ( !$this->doTable( 'profiling' ) ) {
1155  return;
1156  }
1157 
1158  $profileToDb = false;
1159  if ( isset( $wgProfiler['output'] ) ) {
1160  $out = $wgProfiler['output'];
1161  if ( $out === 'db' ) {
1162  $profileToDb = true;
1163  } elseif ( is_array( $out ) && in_array( 'db', $out ) ) {
1164  $profileToDb = true;
1165  }
1166  }
1167 
1168  if ( $profileToDb && !$this->db->tableExists( 'profiling', __METHOD__ ) ) {
1169  $this->applyPatch( 'patch-profiling.sql', false, 'Add profiling table' );
1170  }
1171  }
1172 
1176  protected function rebuildLocalisationCache() {
1180  $cl = $this->maintenance->runChild(
1181  RebuildLocalisationCache::class, 'rebuildLocalisationCache.php'
1182  );
1183  $this->output( "Rebuilding localisation cache...\n" );
1184  $cl->setForce();
1185  $cl->execute();
1186  $this->output( "done.\n" );
1187  }
1188 
1193  protected function disableContentHandlerUseDB() {
1195 
1196  if ( $wgContentHandlerUseDB ) {
1197  $this->output( "Turning off Content Handler DB fields for this part of upgrade.\n" );
1198  $this->holdContentHandlerUseDB = $wgContentHandlerUseDB;
1199  $wgContentHandlerUseDB = false;
1200  }
1201  }
1202 
1206  protected function enableContentHandlerUseDB() {
1208 
1209  if ( $this->holdContentHandlerUseDB ) {
1210  $this->output( "Content Handler DB fields should be usable now.\n" );
1211  $wgContentHandlerUseDB = $this->holdContentHandlerUseDB;
1212  }
1213  }
1214 
1219  protected function migrateComments() {
1222  !$this->updateRowExists( 'MigrateComments' )
1223  ) {
1224  $this->output(
1225  "Migrating comments to the 'comments' table, printing progress markers. For large\n" .
1226  "databases, you may want to hit Ctrl-C and do this manually with\n" .
1227  "maintenance/migrateComments.php.\n"
1228  );
1229  $task = $this->maintenance->runChild( MigrateComments::class, 'migrateComments.php' );
1230  $ok = $task->execute();
1231  $this->output( $ok ? "done.\n" : "errors were encountered.\n" );
1232  }
1233  }
1234 
1239  protected function migrateActors() {
1242  !$this->updateRowExists( 'MigrateActors' )
1243  ) {
1244  $this->output(
1245  "Migrating actors to the 'actor' table, printing progress markers. For large\n" .
1246  "databases, you may want to hit Ctrl-C and do this manually with\n" .
1247  "maintenance/migrateActors.php.\n"
1248  );
1249  $task = $this->maintenance->runChild( 'MigrateActors', 'migrateActors.php' );
1250  $ok = $task->execute();
1251  $this->output( $ok ? "done.\n" : "errors were encountered.\n" );
1252  }
1253  }
1254 
1259  protected function migrateArchiveText() {
1260  if ( $this->db->fieldExists( 'archive', 'ar_text', __METHOD__ ) ) {
1261  $this->output( "Migrating archive ar_text to modern storage.\n" );
1262  $task = $this->maintenance->runChild( MigrateArchiveText::class, 'migrateArchiveText.php' );
1263  $task->setForce();
1264  if ( $task->execute() ) {
1265  $this->applyPatch( 'patch-drop-ar_text.sql', false,
1266  'Dropping ar_text and ar_flags columns' );
1267  }
1268  }
1269  }
1270 
1275  protected function populateArchiveRevId() {
1276  $info = $this->db->fieldInfo( 'archive', 'ar_rev_id', __METHOD__ );
1277  if ( !$info ) {
1278  throw new MWException( 'Missing ar_rev_id field of archive table. Should not happen.' );
1279  }
1280  if ( $info->isNullable() ) {
1281  $this->output( "Populating ar_rev_id.\n" );
1282  $task = $this->maintenance->runChild( 'PopulateArchiveRevId', 'populateArchiveRevId.php' );
1283  if ( $task->execute() ) {
1284  $this->applyPatch( 'patch-ar_rev_id-not-null.sql', false,
1285  'Making ar_rev_id not nullable' );
1286  }
1287  }
1288  }
1289 
1290 }
DatabaseUpdater\output
output( $str)
Output some text.
Definition: DatabaseUpdater.php:212
DatabaseUpdater\dropIndex
dropIndex( $table, $index, $patch, $fullpath=false)
Drop an index from an existing table.
Definition: DatabaseUpdater.php:814
DatabaseUpdater\modifyExtensionTable
modifyExtensionTable( $tableName, $sqlPath)
Definition: DatabaseUpdater.php:355
DatabaseUpdater\dropTable
dropTable( $table, $patch=false, $fullpath=false)
If the specified table exists, drop it, or execute the patch if one is provided.
Definition: DatabaseUpdater.php:894
DatabaseUpdater\copyFile
copyFile( $filename)
Append an SQL fragment to the open file handle.
Definition: DatabaseUpdater.php:628
DatabaseUpdater\$updatesSkipped
array $updatesSkipped
Array of updates that were skipped.
Definition: DatabaseUpdater.php:49
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:48
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
DatabaseUpdater\applyPatch
applyPatch( $path, $isFullPath=false, $msg=null)
Applies a SQL patch.
Definition: DatabaseUpdater.php:665
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
DatabaseUpdater\doCollationUpdate
doCollationUpdate()
Update CategoryLinks collation.
Definition: DatabaseUpdater.php:1115
SiteStatsInit\doAllAndCommit
static doAllAndCommit( $database, array $options=[])
Do all updates and commit them.
Definition: SiteStatsInit.php:134
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$wgSharedTables
$wgSharedTables
Definition: DefaultSettings.php:1931
DatabaseUpdater
Class for handling database updates.
Definition: DatabaseUpdater.php:36
DatabaseUpdater\addPostDatabaseUpdateMaintenance
addPostDatabaseUpdateMaintenance( $class)
Add a maintenance script to be run after the database updates are complete.
Definition: DatabaseUpdater.php:379
DatabaseUpdater\checkStats
checkStats()
Check the site_stats table is not properly populated.
Definition: DatabaseUpdater.php:1029
$wgCommentTableSchemaMigrationStage
int $wgCommentTableSchemaMigrationStage
Comment table schema migration stage.
Definition: DefaultSettings.php:8871
$wgSharedDB
$wgSharedDB
Shared database for multiple wikis.
Definition: DefaultSettings.php:1921
DatabaseUpdater\getCoreUpdateList
getCoreUpdateList()
Get an array of updates to perform on the database.
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:2005
DatabaseUpdater\doMigrateUserOptions
doMigrateUserOptions()
Migrates user options from the user table blob to user_properties.
Definition: DatabaseUpdater.php:1140
DatabaseUpdater\dropField
dropField( $table, $field, $patch, $fullpath=false)
Drop a field from an existing table.
Definition: DatabaseUpdater.php:791
DatabaseUpdater\enableContentHandlerUseDB
enableContentHandlerUseDB()
Turns content handler fields back on.
Definition: DatabaseUpdater.php:1206
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
DatabaseUpdater\addField
addField( $table, $field, $patch, $fullpath=false)
Add a new field to an existing table.
Definition: DatabaseUpdater.php:741
DatabaseUpdater\doTable
doTable( $name)
Returns whether updates should be executed on the database table $name.
Definition: DatabaseUpdater.php:552
$params
$params
Definition: styleTest.css.php:40
DatabaseUpdater\getPostDatabaseUpdateMaintenance
getPostDatabaseUpdateMaintenance()
Definition: DatabaseUpdater.php:397
Maintenance\setDB
setDB(IDatabase $db)
Sets database object to be returned by getDB().
Definition: Maintenance.php:1322
DatabaseUpdater\appendLine
appendLine( $line)
Append a line to the open filehandle.
Definition: DatabaseUpdater.php:648
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
DatabaseUpdater\patchPath
patchPath(IDatabase $db, $patch)
Get the full path of a patch file.
Definition: DatabaseUpdater.php:699
DatabaseUpdater\getSchemaVars
getSchemaVars()
Get appropriate schema variables in the current database connection.
Definition: DatabaseUpdater.php:431
DatabaseUpdater\addExtensionIndex
addExtensionIndex( $tableName, $indexName, $sqlPath)
Definition: DatabaseUpdater.php:260
$wgContentHandlerUseDB
$wgContentHandlerUseDB
Set to false to disable use of the database fields introduced by the ContentHandler facility.
Definition: DefaultSettings.php:8581
DatabaseUpdater\$db
Database $db
Handle to the database subclass.
Definition: DatabaseUpdater.php:62
DatabaseUpdater\migrateComments
migrateComments()
Migrate comments to the new 'comment' table.
Definition: DatabaseUpdater.php:1219
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:2006
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
DatabaseUpdater\doActiveUsersInit
doActiveUsersInit()
Sets the number of active users in the site_stats table.
Definition: DatabaseUpdater.php:1049
MIGRATION_WRITE_NEW
const MIGRATION_WRITE_NEW
Definition: Defines.php:304
DatabaseUpdater\dropExtensionIndex
dropExtensionIndex( $tableName, $indexName, $sqlPath)
Drop an index from an extension table.
Definition: DatabaseUpdater.php:297
DatabaseUpdater\$updates
array $updates
Array of updates to perform on the database.
Definition: DatabaseUpdater.php:42
DatabaseUpdater\doEnableProfiling
doEnableProfiling()
Enable profiling table when it's turned on.
Definition: DatabaseUpdater.php:1151
ExtensionRegistry\getInstance
static getInstance()
Definition: ExtensionRegistry.php:88
DatabaseUpdater\addExtensionUpdate
addExtensionUpdate(array $update)
Add a new update coming from an extension.
Definition: DatabaseUpdater.php:236
updates
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these updates(as a Java servelet could)
DatabaseUpdater\setFileAccess
setFileAccess()
Set any .htaccess files or equivilent for storage repos.
Definition: DatabaseUpdater.php:982
MWException
MediaWiki exception.
Definition: MWException.php:26
DatabaseUpdater\renameIndex
renameIndex( $table, $oldIndex, $newIndex, $skipBothIndexExistWarning, $patch, $fullpath=false)
Rename an index from an existing table.
Definition: DatabaseUpdater.php:840
DatabaseUpdater\getExtensionUpdates
getExtensionUpdates()
Get the list of extension-defined updates.
Definition: DatabaseUpdater.php:388
DatabaseUpdater\migrateArchiveText
migrateArchiveText()
Migrate ar_text to modern storage.
Definition: DatabaseUpdater.php:1259
DatabaseUpdater\$maintenance
Maintenance $maintenance
Definition: DatabaseUpdater.php:67
DatabaseUpdater\modifyTable
modifyTable( $table, $patch, $fullpath=false)
Modify an existing table, similar to modifyField.
Definition: DatabaseUpdater.php:957
Wikimedia\Rdbms\Database\setFlag
setFlag( $flag, $remember=self::REMEMBER_NOTHING)
Set a flag for this connection.
Definition: Database.php:762
$wgCommandLineMode
global $wgCommandLineMode
Definition: DevelopmentSettings.php:28
DatabaseUpdater\modifyExtensionField
modifyExtensionField( $tableName, $fieldName, $sqlPath)
Definition: DatabaseUpdater.php:345
DatabaseUpdater\rebuildLocalisationCache
rebuildLocalisationCache()
Rebuilds the localisation cache.
Definition: DatabaseUpdater.php:1176
$queue
$queue
Definition: mergeMessageFileList.php:160
Installer\getExistingLocalSettings
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
Definition: Installer.php:593
DatabaseUpdater\getDB
getDB()
Get a database connection to run updates.
Definition: DatabaseUpdater.php:203
$wgLocalisationCacheConf
$wgLocalisationCacheConf
Localisation cache configuration.
Definition: DefaultSettings.php:2535
DatabaseUpdater\runUpdates
runUpdates(array $updates, $passSelf)
Helper function for doUpdates()
Definition: DatabaseUpdater.php:469
DatabaseUpdater\doUpdates
doUpdates(array $what=[ 'core', 'extensions', 'stats'])
Do all the updates.
Definition: DatabaseUpdater.php:440
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
FakeMaintenance
Fake maintenance wrapper, mostly used for the web installer/updater.
Definition: Maintenance.php:1628
DatabaseUpdater\updateRowExists
updateRowExists( $key)
Helper function: check if the given key is present in the updatelog table.
Definition: DatabaseUpdater.php:502
DatabaseUpdater\disableContentHandlerUseDB
disableContentHandlerUseDB()
Turns off content handler fields during parts of the upgrade where they aren't available.
Definition: DatabaseUpdater.php:1193
DatabaseUpdater\doLogSearchPopulation
doLogSearchPopulation()
Migrate log params to new table and index for searching.
Definition: DatabaseUpdater.php:1084
$wgHooks
$wgHooks['ArticleShow'][]
Definition: hooks.txt:108
$line
$line
Definition: cdb.php:59
DatabaseUpdater\doUpdateTranscacheField
doUpdateTranscacheField()
Updates the timestamps in the transcache table.
Definition: DatabaseUpdater.php:1101
DBO_DDLMODE
const DBO_DDLMODE
Definition: defines.php:16
DatabaseUpdater\__construct
__construct(Database &$db, $shared, Maintenance $maintenance=null)
Definition: DatabaseUpdater.php:114
DatabaseUpdater\populateArchiveRevId
populateArchiveRevId()
Populate ar_rev_id, then make it not nullable.
Definition: DatabaseUpdater.php:1275
DatabaseUpdater\canUseNewUpdatelog
canUseNewUpdatelog()
Updatelog was changed in 1.17 to have a ul_value column so we can record more information about what ...
Definition: DatabaseUpdater.php:539
DatabaseUpdater\$fileHandle
resource $fileHandle
File handle for SQL output.
Definition: DatabaseUpdater.php:95
$wgProfiler
if(!defined( 'MEDIAWIKI')) $wgProfiler
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition: Setup.php:41
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
DatabaseUpdater\getOldGlobalUpdates
getOldGlobalUpdates()
Before 1.17, we used to handle updates via stuff like $wgExtNewTables/Fields/Indexes.
Definition: DatabaseUpdater.php:577
$wgAutoloadClasses
$wgAutoloadClasses
Array mapping class names to filenames, for autoloading.
Definition: DefaultSettings.php:7350
DatabaseUpdater\doLogUsertextPopulation
doLogUsertextPopulation()
Populates the log_user_text field in the logging table.
Definition: DatabaseUpdater.php:1067
DatabaseUpdater\newForDB
static newForDB(Database $db, $shared=false, Maintenance $maintenance=null)
Definition: DatabaseUpdater.php:187
DatabaseUpdater\tableExists
tableExists( $tableName)
Definition: DatabaseUpdater.php:366
DatabaseUpdater\addExtensionField
addExtensionField( $tableName, $columnName, $sqlPath)
Definition: DatabaseUpdater.php:272
DatabaseUpdater\modifyField
modifyField( $table, $field, $patch, $fullpath=false)
Modify an existing field.
Definition: DatabaseUpdater.php:925
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
DatabaseUpdater\writeSchemaUpdateFile
writeSchemaUpdateFile(array $schemaUpdate=[])
Definition: DatabaseUpdater.php:407
DatabaseUpdater\loadExtensions
loadExtensions()
Loads LocalSettings.php, if needed, and initialises everything needed for LoadExtensionSchemaUpdates ...
Definition: DatabaseUpdater.php:152
$path
$path
Definition: NoLocalSettings.php:25
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
DatabaseUpdater\renameExtensionIndex
renameExtensionIndex( $tableName, $oldIndexName, $newIndexName, $sqlPath, $skipBothIndexExistWarning=false)
Rename an index on an extension table.
Definition: DatabaseUpdater.php:324
DatabaseUpdater\addTable
addTable( $name, $patch, $fullpath=false)
Add a new table to the database.
Definition: DatabaseUpdater.php:718
DatabaseUpdater\$shared
$shared
Definition: DatabaseUpdater.php:69
MessageBlobStore
This class generates message blobs for use by ResourceLoader modules.
Definition: MessageBlobStore.php:37
Wikimedia\Rdbms\IDatabase\getType
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
DatabaseUpdater\migrateActors
migrateActors()
Migrate actors to the new 'actor' table.
Definition: DatabaseUpdater.php:1239
DatabaseUpdater\dropExtensionField
dropExtensionField( $tableName, $columnName, $sqlPath)
Definition: DatabaseUpdater.php:284
DatabaseUpdater\purgeCache
purgeCache()
Purge various database caches.
Definition: DatabaseUpdater.php:1003
$wgCategoryCollation
$wgCategoryCollation
Specify how category names should be sorted, when listed on a category page.
Definition: DefaultSettings.php:7637
DatabaseUpdater\$skipSchema
bool $skipSchema
Flag specifying whether or not to skip schema (e.g.
Definition: DatabaseUpdater.php:102
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
DatabaseUpdater\addExtensionTable
addExtensionTable( $tableName, $sqlPath)
Convenience wrapper for addExtensionUpdate() when adding a new table (which is the most common usage ...
Definition: DatabaseUpdater.php:249
Installer\getDBTypes
static getDBTypes()
Get a list of known DB types.
Definition: Installer.php:466
$vars
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2228
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
DatabaseUpdater\initOldGlobals
initOldGlobals()
Initialize all of the old globals.
Definition: DatabaseUpdater.php:134
DatabaseUpdater\addIndex
addIndex( $table, $index, $patch, $fullpath=false)
Add a new index to an existing table.
Definition: DatabaseUpdater.php:766
DatabaseUpdater\$extensionUpdates
array $extensionUpdates
List of extension-provided database updates.
Definition: DatabaseUpdater.php:55
DatabaseUpdater\insertUpdateRow
insertUpdateRow( $key, $val=null)
Helper function: Add a key to the updatelog table Obviously, only use this for updates that occur aft...
Definition: DatabaseUpdater.php:521
$IP
$IP
Definition: WebStart.php:52
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
DatabaseUpdater\$postDatabaseUpdateMaintenance
string[] $postDatabaseUpdateMaintenance
Scripts to run after database update Should be a subclass of LoggedUpdateMaintenance.
Definition: DatabaseUpdater.php:75
DatabaseUpdater\dropExtensionTable
dropExtensionTable( $tableName, $sqlPath)
Definition: DatabaseUpdater.php:308
DatabaseUpdater\$holdContentHandlerUseDB
$holdContentHandlerUseDB
Hold the value of $wgContentHandlerUseDB during the upgrade.
Definition: DatabaseUpdater.php:107
$type
$type
Definition: testCompression.php:48
$wgActorTableSchemaMigrationStage
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Definition: DefaultSettings.php:8878