MediaWiki  REL1_31
DatabaseInstaller.php
Go to the documentation of this file.
1 <?php
26 
33 abstract class DatabaseInstaller {
34 
42  public $parent;
43 
47  public static $minimumVersion;
48 
52  protected static $notMiniumumVerisonMessage;
53 
59  public $db = null;
60 
66  protected $internalDefaults = [];
67 
73  protected $globalNames = [];
74 
82  public static function meetsMinimumRequirement( $serverVersion ) {
83  if ( version_compare( $serverVersion, static::$minimumVersion ) < 0 ) {
84  return Status::newFatal(
85  static::$notMiniumumVerisonMessage, static::$minimumVersion, $serverVersion
86  );
87  }
88 
89  return Status::newGood();
90  }
91 
95  abstract public function getName();
96 
100  abstract public function isCompiled();
101 
107  public function checkPrerequisites() {
108  return Status::newGood();
109  }
110 
118  abstract public function getConnectForm();
119 
129  abstract public function submitConnectForm();
130 
138  public function getSettingsForm() {
139  return false;
140  }
141 
148  public function submitSettingsForm() {
149  return Status::newGood();
150  }
151 
160  abstract public function openConnection();
161 
168  abstract public function setupDatabase();
169 
179  public function getConnection() {
180  if ( $this->db ) {
181  return Status::newGood( $this->db );
182  }
183 
184  $status = $this->openConnection();
185  if ( $status->isOK() ) {
186  $this->db = $status->value;
187  // Enable autocommit
188  $this->db->clearFlag( DBO_TRX );
189  $this->db->commit( __METHOD__ );
190  }
191 
192  return $status;
193  }
194 
203  private function stepApplySourceFile(
204  $sourceFileMethod,
205  $stepName,
206  $archiveTableMustNotExist = false
207  ) {
208  $status = $this->getConnection();
209  if ( !$status->isOK() ) {
210  return $status;
211  }
212  $this->db->selectDB( $this->getVar( 'wgDBname' ) );
213 
214  if ( $archiveTableMustNotExist && $this->db->tableExists( 'archive', __METHOD__ ) ) {
215  $status->warning( "config-$stepName-tables-exist" );
216  $this->enableLB();
217 
218  return $status;
219  }
220 
221  $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
222  $this->db->begin( __METHOD__ );
223 
224  $error = $this->db->sourceFile(
225  call_user_func( [ $this, $sourceFileMethod ], $this->db )
226  );
227  if ( $error !== true ) {
228  $this->db->reportQueryError( $error, 0, '', __METHOD__ );
229  $this->db->rollback( __METHOD__ );
230  $status->fatal( "config-$stepName-tables-failed", $error );
231  } else {
232  $this->db->commit( __METHOD__ );
233  }
234  // Resume normal operations
235  if ( $status->isOK() ) {
236  $this->enableLB();
237  }
238 
239  return $status;
240  }
241 
247  public function createTables() {
248  return $this->stepApplySourceFile( 'getSchemaPath', 'install', true );
249  }
250 
256  public function insertUpdateKeys() {
257  return $this->stepApplySourceFile( 'getUpdateKeysPath', 'updates', false );
258  }
259 
268  private function getSqlFilePath( $db, $filename ) {
269  global $IP;
270 
271  $dbmsSpecificFilePath = "$IP/maintenance/" . $db->getType() . "/$filename";
272  if ( file_exists( $dbmsSpecificFilePath ) ) {
273  return $dbmsSpecificFilePath;
274  } else {
275  return "$IP/maintenance/$filename";
276  }
277  }
278 
286  public function getSchemaPath( $db ) {
287  return $this->getSqlFilePath( $db, 'tables.sql' );
288  }
289 
297  public function getUpdateKeysPath( $db ) {
298  return $this->getSqlFilePath( $db, 'update-keys.sql' );
299  }
300 
305  public function createExtensionTables() {
306  $status = $this->getConnection();
307  if ( !$status->isOK() ) {
308  return $status;
309  }
310 
311  // Now run updates to create tables for old extensions
312  DatabaseUpdater::newForDB( $this->db )->doUpdates( [ 'extensions' ] );
313 
314  return $status;
315  }
316 
322  abstract public function getLocalSettings();
323 
329  public function getSchemaVars() {
330  return [];
331  }
332 
339  public function setupSchemaVars() {
340  $status = $this->getConnection();
341  if ( $status->isOK() ) {
342  $status->value->setSchemaVars( $this->getSchemaVars() );
343  } else {
344  $msg = __METHOD__ . ': unexpected error while establishing'
345  . ' a database connection with message: '
346  . $status->getMessage()->plain();
347  throw new MWException( $msg );
348  }
349  }
350 
356  public function enableLB() {
357  $status = $this->getConnection();
358  if ( !$status->isOK() ) {
359  throw new MWException( __METHOD__ . ': unexpected DB connection error' );
360  }
361 
362  \MediaWiki\MediaWikiServices::resetGlobalInstance();
363  $services = \MediaWiki\MediaWikiServices::getInstance();
364 
365  $connection = $status->value;
366  $services->redefineService( 'DBLoadBalancerFactory', function () use ( $connection ) {
367  return LBFactorySingle::newFromConnection( $connection );
368  } );
369  }
370 
376  public function doUpgrade() {
377  $this->setupSchemaVars();
378  $this->enableLB();
379 
380  $ret = true;
381  ob_start( [ $this, 'outputHandler' ] );
382  $up = DatabaseUpdater::newForDB( $this->db );
383  try {
384  $up->doUpdates();
385  } catch ( MWException $e ) {
386  echo "\nAn error occurred:\n";
387  echo $e->getText();
388  $ret = false;
389  } catch ( Exception $e ) {
390  echo "\nAn error occurred:\n";
391  echo $e->getMessage();
392  $ret = false;
393  }
394  $up->purgeCache();
395  ob_end_flush();
396 
397  return $ret;
398  }
399 
405  public function preInstall() {
406  }
407 
411  public function preUpgrade() {
412  }
413 
418  public function getGlobalNames() {
419  return $this->globalNames;
420  }
421 
427  public function __construct( $parent ) {
428  $this->parent = $parent;
429  }
430 
438  protected static function checkExtension( $name ) {
439  return extension_loaded( $name );
440  }
441 
446  public function getReadableName() {
447  // Messages: config-type-mysql, config-type-postgres, config-type-sqlite,
448  // config-type-oracle
449  return wfMessage( 'config-type-' . $this->getName() )->text();
450  }
451 
456  public function getGlobalDefaults() {
457  $defaults = [];
458  foreach ( $this->getGlobalNames() as $var ) {
459  if ( isset( $GLOBALS[$var] ) ) {
460  $defaults[$var] = $GLOBALS[$var];
461  }
462  }
463  return $defaults;
464  }
465 
470  public function getInternalDefaults() {
472  }
473 
480  public function getVar( $var, $default = null ) {
481  $defaults = $this->getGlobalDefaults();
482  $internal = $this->getInternalDefaults();
483  if ( isset( $defaults[$var] ) ) {
484  $default = $defaults[$var];
485  } elseif ( isset( $internal[$var] ) ) {
486  $default = $internal[$var];
487  }
488 
489  return $this->parent->getVar( $var, $default );
490  }
491 
497  public function setVar( $name, $value ) {
498  $this->parent->setVar( $name, $value );
499  }
500 
510  public function getTextBox( $var, $label, $attribs = [], $helpData = "" ) {
511  $name = $this->getName() . '_' . $var;
512  $value = $this->getVar( $var );
513  if ( !isset( $attribs ) ) {
514  $attribs = [];
515  }
516 
517  return $this->parent->getTextBox( [
518  'var' => $var,
519  'label' => $label,
520  'attribs' => $attribs,
521  'controlName' => $name,
522  'value' => $value,
523  'help' => $helpData
524  ] );
525  }
526 
537  public function getPasswordBox( $var, $label, $attribs = [], $helpData = "" ) {
538  $name = $this->getName() . '_' . $var;
539  $value = $this->getVar( $var );
540  if ( !isset( $attribs ) ) {
541  $attribs = [];
542  }
543 
544  return $this->parent->getPasswordBox( [
545  'var' => $var,
546  'label' => $label,
547  'attribs' => $attribs,
548  'controlName' => $name,
549  'value' => $value,
550  'help' => $helpData
551  ] );
552  }
553 
563  public function getCheckBox( $var, $label, $attribs = [], $helpData = "" ) {
564  $name = $this->getName() . '_' . $var;
565  $value = $this->getVar( $var );
566 
567  return $this->parent->getCheckBox( [
568  'var' => $var,
569  'label' => $label,
570  'attribs' => $attribs,
571  'controlName' => $name,
572  'value' => $value,
573  'help' => $helpData
574  ] );
575  }
576 
589  public function getRadioSet( $params ) {
590  $params['controlName'] = $this->getName() . '_' . $params['var'];
591  $params['value'] = $this->getVar( $params['var'] );
592 
593  return $this->parent->getRadioSet( $params );
594  }
595 
603  public function setVarsFromRequest( $varNames ) {
604  return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
605  }
606 
617  public function needsUpgrade() {
618  $status = $this->getConnection();
619  if ( !$status->isOK() ) {
620  return false;
621  }
622 
623  if ( !$this->db->selectDB( $this->getVar( 'wgDBname' ) ) ) {
624  return false;
625  }
626 
627  return $this->db->tableExists( 'cur', __METHOD__ ) ||
628  $this->db->tableExists( 'revision', __METHOD__ );
629  }
630 
636  public function getInstallUserBox() {
637  return Html::openElement( 'fieldset' ) .
638  Html::element( 'legend', [], wfMessage( 'config-db-install-account' )->text() ) .
639  $this->getTextBox(
640  '_InstallUser',
641  'config-db-username',
642  [ 'dir' => 'ltr' ],
643  $this->parent->getHelpBox( 'config-db-install-username' )
644  ) .
645  $this->getPasswordBox(
646  '_InstallPassword',
647  'config-db-password',
648  [ 'dir' => 'ltr' ],
649  $this->parent->getHelpBox( 'config-db-install-password' )
650  ) .
651  Html::closeElement( 'fieldset' );
652  }
653 
658  public function submitInstallUserBox() {
659  $this->setVarsFromRequest( [ '_InstallUser', '_InstallPassword' ] );
660 
661  return Status::newGood();
662  }
663 
671  public function getWebUserBox( $noCreateMsg = false ) {
672  $wrapperStyle = $this->getVar( '_SameAccount' ) ? 'display: none' : '';
673  $s = Html::openElement( 'fieldset' ) .
674  Html::element( 'legend', [], wfMessage( 'config-db-web-account' )->text() ) .
675  $this->getCheckBox(
676  '_SameAccount', 'config-db-web-account-same',
677  [ 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' ]
678  ) .
679  Html::openElement( 'div', [ 'id' => 'dbOtherAccount', 'style' => $wrapperStyle ] ) .
680  $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
681  $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
682  $this->parent->getHelpBox( 'config-db-web-help' );
683  if ( $noCreateMsg ) {
684  $s .= $this->parent->getWarningBox( wfMessage( $noCreateMsg )->plain() );
685  } else {
686  $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
687  }
688  $s .= Html::closeElement( 'div' ) . Html::closeElement( 'fieldset' );
689 
690  return $s;
691  }
692 
698  public function submitWebUserBox() {
699  $this->setVarsFromRequest(
700  [ 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' ]
701  );
702 
703  if ( $this->getVar( '_SameAccount' ) ) {
704  $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
705  $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
706  }
707 
708  if ( $this->getVar( '_CreateDBAccount' ) && strval( $this->getVar( 'wgDBpassword' ) ) == '' ) {
709  return Status::newFatal( 'config-db-password-empty', $this->getVar( 'wgDBuser' ) );
710  }
711 
712  return Status::newGood();
713  }
714 
720  public function populateInterwikiTable() {
721  $status = $this->getConnection();
722  if ( !$status->isOK() ) {
723  return $status;
724  }
725  $this->db->selectDB( $this->getVar( 'wgDBname' ) );
726 
727  if ( $this->db->selectRow( 'interwiki', '1', [], __METHOD__ ) ) {
728  $status->warning( 'config-install-interwiki-exists' );
729 
730  return $status;
731  }
732  global $IP;
733  Wikimedia\suppressWarnings();
734  $rows = file( "$IP/maintenance/interwiki.list",
735  FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
736  Wikimedia\restoreWarnings();
737  $interwikis = [];
738  if ( !$rows ) {
739  return Status::newFatal( 'config-install-interwiki-list' );
740  }
741  foreach ( $rows as $row ) {
742  $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
743  if ( $row == "" ) {
744  continue;
745  }
746  $row .= "|";
747  $interwikis[] = array_combine(
748  [ 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ],
749  explode( '|', $row )
750  );
751  }
752  $this->db->insert( 'interwiki', $interwikis, __METHOD__ );
753 
754  return Status::newGood();
755  }
756 
757  public function outputHandler( $string ) {
758  return htmlspecialchars( $string );
759  }
760 }
DatabaseInstaller\$globalNames
array $globalNames
Array of MW configuration globals this class uses.
Definition: DatabaseInstaller.php:73
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:48
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$rows
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2783
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
DatabaseInstaller\checkExtension
static checkExtension( $name)
Convenience function.
Definition: DatabaseInstaller.php:438
array
the array() calling protocol came about after MediaWiki 1.4rc1.
plain
either a plain
Definition: hooks.txt:2056
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
DatabaseInstaller\doUpgrade
doUpgrade()
Perform database upgrades.
Definition: DatabaseInstaller.php:376
$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
WebInstaller
Class for the core installer web interface.
Definition: WebInstaller.php:30
DatabaseInstaller\getConnection
getConnection()
Connect to the database using the administrative user/password currently defined in the session.
Definition: DatabaseInstaller.php:179
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
DatabaseInstaller\getTextBox
getTextBox( $var, $label, $attribs=[], $helpData="")
Get a labelled text box to configure a local variable.
Definition: DatabaseInstaller.php:510
DatabaseInstaller\checkPrerequisites
checkPrerequisites()
Checks for installation prerequisites other than those checked by isCompiled()
Definition: DatabaseInstaller.php:107
DatabaseInstaller\getSchemaVars
getSchemaVars()
Override this to provide DBMS-specific schema variables, to be substituted into tables....
Definition: DatabaseInstaller.php:329
$s
$s
Definition: mergeMessageFileList.php:187
DatabaseInstaller\preUpgrade
preUpgrade()
Allow DB installers a chance to make checks before upgrade.
Definition: DatabaseInstaller.php:411
DatabaseInstaller\preInstall
preInstall()
Allow DB installers a chance to make last-minute changes before installation occurs.
Definition: DatabaseInstaller.php:405
DatabaseInstaller\submitSettingsForm
submitSettingsForm()
Set variables based on the request array, assuming it was submitted via the form return by getSetting...
Definition: DatabaseInstaller.php:148
DatabaseInstaller\getLocalSettings
getLocalSettings()
Get the DBMS-specific options for LocalSettings.php generation.
DBO_TRX
const DBO_TRX
Definition: defines.php:12
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
DatabaseInstaller\getReadableName
getReadableName()
Get the internationalised name for this DBMS.
Definition: DatabaseInstaller.php:446
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
DatabaseInstaller\createTables
createTables()
Create database tables from scratch.
Definition: DatabaseInstaller.php:247
DatabaseInstaller\getInternalDefaults
getInternalDefaults()
Get a name=>value map of internal variables used during installation.
Definition: DatabaseInstaller.php:470
Html\closeElement
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:309
DatabaseInstaller\getSqlFilePath
getSqlFilePath( $db, $filename)
Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file.
Definition: DatabaseInstaller.php:268
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:106
DatabaseInstaller\getConnectForm
getConnectForm()
Get HTML for a web form that configures this database.
MWException
MediaWiki exception.
Definition: MWException.php:26
DatabaseInstaller\getPasswordBox
getPasswordBox( $var, $label, $attribs=[], $helpData="")
Get a labelled password box to configure a local variable.
Definition: DatabaseInstaller.php:537
Wikimedia\Rdbms\LBFactorySingle
An LBFactory class that always returns a single database object.
Definition: LBFactorySingle.php:32
DatabaseInstaller\submitConnectForm
submitConnectForm()
Set variables based on the request array, assuming it was submitted via the form returned by getConne...
DatabaseInstaller\getUpdateKeysPath
getUpdateKeysPath( $db)
Return a path to the DBMS-specific update key file, otherwise default to update-keys....
Definition: DatabaseInstaller.php:297
DatabaseInstaller\submitWebUserBox
submitWebUserBox()
Submit the form from getWebUserBox().
Definition: DatabaseInstaller.php:698
DatabaseInstaller\$minimumVersion
static string $minimumVersion
Set by subclasses.
Definition: DatabaseInstaller.php:47
DatabaseInstaller\getName
getName()
Return the internal name, e.g.
DatabaseInstaller\outputHandler
outputHandler( $string)
Definition: DatabaseInstaller.php:757
DatabaseInstaller\setupSchemaVars
setupSchemaVars()
Set appropriate schema variables in the current database connection.
Definition: DatabaseInstaller.php:339
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DatabaseInstaller\getSchemaPath
getSchemaPath( $db)
Return a path to the DBMS-specific schema file, otherwise default to tables.sql.
Definition: DatabaseInstaller.php:286
DatabaseInstaller\getWebUserBox
getWebUserBox( $noCreateMsg=false)
Get a standard web-user fieldset.
Definition: DatabaseInstaller.php:671
$services
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2273
DatabaseInstaller\getRadioSet
getRadioSet( $params)
Get a set of labelled radio buttons.
Definition: DatabaseInstaller.php:589
$attribs
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 an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:2014
DatabaseInstaller\stepApplySourceFile
stepApplySourceFile( $sourceFileMethod, $stepName, $archiveTableMustNotExist=false)
Apply a SQL source file to the database as part of running an installation step.
Definition: DatabaseInstaller.php:203
DatabaseInstaller\getGlobalDefaults
getGlobalDefaults()
Get a name=>value map of MW configuration globals for the default values.
Definition: DatabaseInstaller.php:456
$value
$value
Definition: styleTest.css.php:45
DatabaseInstaller\getVar
getVar( $var, $default=null)
Get a variable, taking local defaults into account.
Definition: DatabaseInstaller.php:480
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
DBO_DDLMODE
const DBO_DDLMODE
Definition: defines.php:16
DatabaseInstaller\createExtensionTables
createExtensionTables()
Create the tables for each extension the user enabled.
Definition: DatabaseInstaller.php:305
DatabaseInstaller\submitInstallUserBox
submitInstallUserBox()
Submit a standard install user fieldset.
Definition: DatabaseInstaller.php:658
DatabaseInstaller
Base class for DBMS-specific installation helper classes.
Definition: DatabaseInstaller.php:33
$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
DatabaseInstaller\getGlobalNames
getGlobalNames()
Get an array of MW configuration globals that will be configured by this class.
Definition: DatabaseInstaller.php:418
DatabaseUpdater\newForDB
static newForDB(Database $db, $shared=false, Maintenance $maintenance=null)
Definition: DatabaseUpdater.php:187
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
DatabaseInstaller\getSettingsForm
getSettingsForm()
Get HTML for a web form that retrieves settings used for installation.
Definition: DatabaseInstaller.php:138
DatabaseInstaller\openConnection
openConnection()
Open a connection to the database using the administrative user/password currently defined in the ses...
DatabaseInstaller\enableLB
enableLB()
Set up LBFactory so that wfGetDB() etc.
Definition: DatabaseInstaller.php:356
DatabaseInstaller\populateInterwikiTable
populateInterwikiTable()
Common function for databases that don't understand the MySQLish syntax of interwiki....
Definition: DatabaseInstaller.php:720
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
Html\openElement
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
DatabaseInstaller\setVar
setVar( $name, $value)
Convenience alias for $this->parent->setVar()
Definition: DatabaseInstaller.php:497
DatabaseInstaller\getInstallUserBox
getInstallUserBox()
Get a standard install-user fieldset.
Definition: DatabaseInstaller.php:636
DatabaseInstaller\setVarsFromRequest
setVarsFromRequest( $varNames)
Convenience function to set variables based on form data.
Definition: DatabaseInstaller.php:603
Wikimedia\Rdbms\IDatabase\getType
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
DatabaseInstaller\meetsMinimumRequirement
static meetsMinimumRequirement( $serverVersion)
Whether the provided version meets the necessary requirements for this type.
Definition: DatabaseInstaller.php:82
DatabaseInstaller\$parent
WebInstaller $parent
The Installer object.
Definition: DatabaseInstaller.php:42
DatabaseInstaller\isCompiled
isCompiled()
DatabaseInstaller\$db
Database $db
The database connection.
Definition: DatabaseInstaller.php:59
DatabaseInstaller\setupDatabase
setupDatabase()
Create the database and return a Status object indicating success or failure.
DatabaseInstaller\insertUpdateKeys
insertUpdateKeys()
Insert update keys into table to prevent running unneded updates.
Definition: DatabaseInstaller.php:256
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
$IP
$IP
Definition: WebStart.php:52
DatabaseInstaller\$notMiniumumVerisonMessage
static string $notMiniumumVerisonMessage
Set by subclasses.
Definition: DatabaseInstaller.php:52
DatabaseInstaller\$internalDefaults
array $internalDefaults
Internal variables for installation.
Definition: DatabaseInstaller.php:66
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6
DatabaseInstaller\getCheckBox
getCheckBox( $var, $label, $attribs=[], $helpData="")
Get a labelled checkbox to configure a local boolean variable.
Definition: DatabaseInstaller.php:563
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
DatabaseInstaller\__construct
__construct( $parent)
Construct and initialise parent.
Definition: DatabaseInstaller.php:427
DatabaseInstaller\needsUpgrade
needsUpgrade()
Determine whether an existing installation of MediaWiki is present in the configured administrative c...
Definition: DatabaseInstaller.php:617