MediaWiki  1.28.0
DatabaseInstaller.php
Go to the documentation of this file.
1 <?php
30 abstract class DatabaseInstaller {
31 
39  public $parent;
40 
46  public $db = null;
47 
53  protected $internalDefaults = [];
54 
60  protected $globalNames = [];
61 
65  abstract public function getName();
66 
70  abstract public function isCompiled();
71 
77  public function checkPrerequisites() {
78  return Status::newGood();
79  }
80 
88  abstract public function getConnectForm();
89 
99  abstract public function submitConnectForm();
100 
108  public function getSettingsForm() {
109  return false;
110  }
111 
118  public function submitSettingsForm() {
119  return Status::newGood();
120  }
121 
130  abstract public function openConnection();
131 
138  abstract public function setupDatabase();
139 
149  public function getConnection() {
150  if ( $this->db ) {
151  return Status::newGood( $this->db );
152  }
153 
154  $status = $this->openConnection();
155  if ( $status->isOK() ) {
156  $this->db = $status->value;
157  // Enable autocommit
158  $this->db->clearFlag( DBO_TRX );
159  $this->db->commit( __METHOD__ );
160  }
161 
162  return $status;
163  }
164 
173  private function stepApplySourceFile(
174  $sourceFileMethod,
175  $stepName,
176  $archiveTableMustNotExist = false
177  ) {
178  $status = $this->getConnection();
179  if ( !$status->isOK() ) {
180  return $status;
181  }
182  $this->db->selectDB( $this->getVar( 'wgDBname' ) );
183 
184  if ( $archiveTableMustNotExist && $this->db->tableExists( 'archive', __METHOD__ ) ) {
185  $status->warning( "config-$stepName-tables-exist" );
186  $this->enableLB();
187 
188  return $status;
189  }
190 
191  $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
192  $this->db->begin( __METHOD__ );
193 
194  $error = $this->db->sourceFile(
195  call_user_func( [ $this, $sourceFileMethod ], $this->db )
196  );
197  if ( $error !== true ) {
198  $this->db->reportQueryError( $error, 0, '', __METHOD__ );
199  $this->db->rollback( __METHOD__ );
200  $status->fatal( "config-$stepName-tables-failed", $error );
201  } else {
202  $this->db->commit( __METHOD__ );
203  }
204  // Resume normal operations
205  if ( $status->isOK() ) {
206  $this->enableLB();
207  }
208 
209  return $status;
210  }
211 
217  public function createTables() {
218  return $this->stepApplySourceFile( 'getSchemaPath', 'install', true );
219  }
220 
226  public function insertUpdateKeys() {
227  return $this->stepApplySourceFile( 'getUpdateKeysPath', 'updates', false );
228  }
229 
238  private function getSqlFilePath( $db, $filename ) {
239  global $IP;
240 
241  $dbmsSpecificFilePath = "$IP/maintenance/" . $db->getType() . "/$filename";
242  if ( file_exists( $dbmsSpecificFilePath ) ) {
243  return $dbmsSpecificFilePath;
244  } else {
245  return "$IP/maintenance/$filename";
246  }
247  }
248 
256  public function getSchemaPath( $db ) {
257  return $this->getSqlFilePath( $db, 'tables.sql' );
258  }
259 
267  public function getUpdateKeysPath( $db ) {
268  return $this->getSqlFilePath( $db, 'update-keys.sql' );
269  }
270 
275  public function createExtensionTables() {
276  $status = $this->getConnection();
277  if ( !$status->isOK() ) {
278  return $status;
279  }
280 
281  // Now run updates to create tables for old extensions
282  DatabaseUpdater::newForDB( $this->db )->doUpdates( [ 'extensions' ] );
283 
284  return $status;
285  }
286 
292  abstract public function getLocalSettings();
293 
299  public function getSchemaVars() {
300  return [];
301  }
302 
309  public function setupSchemaVars() {
310  $status = $this->getConnection();
311  if ( $status->isOK() ) {
312  $status->value->setSchemaVars( $this->getSchemaVars() );
313  } else {
314  $msg = __METHOD__ . ': unexpected error while establishing'
315  . ' a database connection with message: '
316  . $status->getMessage()->plain();
317  throw new MWException( $msg );
318  }
319  }
320 
326  public function enableLB() {
327  $status = $this->getConnection();
328  if ( !$status->isOK() ) {
329  throw new MWException( __METHOD__ . ': unexpected DB connection error' );
330  }
331 
332  \MediaWiki\MediaWikiServices::resetGlobalInstance();
333  $services = \MediaWiki\MediaWikiServices::getInstance();
334 
335  $connection = $status->value;
336  $services->redefineService( 'DBLoadBalancerFactory', function() use ( $connection ) {
337  return LBFactorySingle::newFromConnection( $connection );
338  } );
339 
340  }
341 
347  public function doUpgrade() {
348  $this->setupSchemaVars();
349  $this->enableLB();
350 
351  $ret = true;
352  ob_start( [ $this, 'outputHandler' ] );
353  $up = DatabaseUpdater::newForDB( $this->db );
354  try {
355  $up->doUpdates();
356  } catch ( MWException $e ) {
357  echo "\nAn error occurred:\n";
358  echo $e->getText();
359  $ret = false;
360  } catch ( Exception $e ) {
361  echo "\nAn error occurred:\n";
362  echo $e->getMessage();
363  $ret = false;
364  }
365  $up->purgeCache();
366  ob_end_flush();
367 
368  return $ret;
369  }
370 
376  public function preInstall() {
377  }
378 
382  public function preUpgrade() {
383  }
384 
389  public function getGlobalNames() {
390  return $this->globalNames;
391  }
392 
398  public function __construct( $parent ) {
399  $this->parent = $parent;
400  }
401 
409  protected static function checkExtension( $name ) {
410  return extension_loaded( $name );
411  }
412 
417  public function getReadableName() {
418  // Messages: config-type-mysql, config-type-postgres, config-type-sqlite,
419  // config-type-oracle
420  return wfMessage( 'config-type-' . $this->getName() )->text();
421  }
422 
427  public function getGlobalDefaults() {
428  $defaults = [];
429  foreach ( $this->getGlobalNames() as $var ) {
430  if ( isset( $GLOBALS[$var] ) ) {
431  $defaults[$var] = $GLOBALS[$var];
432  }
433  }
434  return $defaults;
435  }
436 
441  public function getInternalDefaults() {
443  }
444 
451  public function getVar( $var, $default = null ) {
452  $defaults = $this->getGlobalDefaults();
453  $internal = $this->getInternalDefaults();
454  if ( isset( $defaults[$var] ) ) {
455  $default = $defaults[$var];
456  } elseif ( isset( $internal[$var] ) ) {
457  $default = $internal[$var];
458  }
459 
460  return $this->parent->getVar( $var, $default );
461  }
462 
468  public function setVar( $name, $value ) {
469  $this->parent->setVar( $name, $value );
470  }
471 
481  public function getTextBox( $var, $label, $attribs = [], $helpData = "" ) {
482  $name = $this->getName() . '_' . $var;
483  $value = $this->getVar( $var );
484  if ( !isset( $attribs ) ) {
485  $attribs = [];
486  }
487 
488  return $this->parent->getTextBox( [
489  'var' => $var,
490  'label' => $label,
491  'attribs' => $attribs,
492  'controlName' => $name,
493  'value' => $value,
494  'help' => $helpData
495  ] );
496  }
497 
508  public function getPasswordBox( $var, $label, $attribs = [], $helpData = "" ) {
509  $name = $this->getName() . '_' . $var;
510  $value = $this->getVar( $var );
511  if ( !isset( $attribs ) ) {
512  $attribs = [];
513  }
514 
515  return $this->parent->getPasswordBox( [
516  'var' => $var,
517  'label' => $label,
518  'attribs' => $attribs,
519  'controlName' => $name,
520  'value' => $value,
521  'help' => $helpData
522  ] );
523  }
524 
534  public function getCheckBox( $var, $label, $attribs = [], $helpData = "" ) {
535  $name = $this->getName() . '_' . $var;
536  $value = $this->getVar( $var );
537 
538  return $this->parent->getCheckBox( [
539  'var' => $var,
540  'label' => $label,
541  'attribs' => $attribs,
542  'controlName' => $name,
543  'value' => $value,
544  'help' => $helpData
545  ] );
546  }
547 
560  public function getRadioSet( $params ) {
561  $params['controlName'] = $this->getName() . '_' . $params['var'];
562  $params['value'] = $this->getVar( $params['var'] );
563 
564  return $this->parent->getRadioSet( $params );
565  }
566 
574  public function setVarsFromRequest( $varNames ) {
575  return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
576  }
577 
588  public function needsUpgrade() {
589  $status = $this->getConnection();
590  if ( !$status->isOK() ) {
591  return false;
592  }
593 
594  if ( !$this->db->selectDB( $this->getVar( 'wgDBname' ) ) ) {
595  return false;
596  }
597 
598  return $this->db->tableExists( 'cur', __METHOD__ ) ||
599  $this->db->tableExists( 'revision', __METHOD__ );
600  }
601 
607  public function getInstallUserBox() {
608  return Html::openElement( 'fieldset' ) .
609  Html::element( 'legend', [], wfMessage( 'config-db-install-account' )->text() ) .
610  $this->getTextBox(
611  '_InstallUser',
612  'config-db-username',
613  [ 'dir' => 'ltr' ],
614  $this->parent->getHelpBox( 'config-db-install-username' )
615  ) .
616  $this->getPasswordBox(
617  '_InstallPassword',
618  'config-db-password',
619  [ 'dir' => 'ltr' ],
620  $this->parent->getHelpBox( 'config-db-install-password' )
621  ) .
622  Html::closeElement( 'fieldset' );
623  }
624 
629  public function submitInstallUserBox() {
630  $this->setVarsFromRequest( [ '_InstallUser', '_InstallPassword' ] );
631 
632  return Status::newGood();
633  }
634 
642  public function getWebUserBox( $noCreateMsg = false ) {
643  $wrapperStyle = $this->getVar( '_SameAccount' ) ? 'display: none' : '';
644  $s = Html::openElement( 'fieldset' ) .
645  Html::element( 'legend', [], wfMessage( 'config-db-web-account' )->text() ) .
646  $this->getCheckBox(
647  '_SameAccount', 'config-db-web-account-same',
648  [ 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' ]
649  ) .
650  Html::openElement( 'div', [ 'id' => 'dbOtherAccount', 'style' => $wrapperStyle ] ) .
651  $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
652  $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
653  $this->parent->getHelpBox( 'config-db-web-help' );
654  if ( $noCreateMsg ) {
655  $s .= $this->parent->getWarningBox( wfMessage( $noCreateMsg )->plain() );
656  } else {
657  $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
658  }
659  $s .= Html::closeElement( 'div' ) . Html::closeElement( 'fieldset' );
660 
661  return $s;
662  }
663 
669  public function submitWebUserBox() {
670  $this->setVarsFromRequest(
671  [ 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' ]
672  );
673 
674  if ( $this->getVar( '_SameAccount' ) ) {
675  $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
676  $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
677  }
678 
679  if ( $this->getVar( '_CreateDBAccount' ) && strval( $this->getVar( 'wgDBpassword' ) ) == '' ) {
680  return Status::newFatal( 'config-db-password-empty', $this->getVar( 'wgDBuser' ) );
681  }
682 
683  return Status::newGood();
684  }
685 
691  public function populateInterwikiTable() {
692  $status = $this->getConnection();
693  if ( !$status->isOK() ) {
694  return $status;
695  }
696  $this->db->selectDB( $this->getVar( 'wgDBname' ) );
697 
698  if ( $this->db->selectRow( 'interwiki', '*', [], __METHOD__ ) ) {
699  $status->warning( 'config-install-interwiki-exists' );
700 
701  return $status;
702  }
703  global $IP;
704  MediaWiki\suppressWarnings();
705  $rows = file( "$IP/maintenance/interwiki.list",
706  FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
707  MediaWiki\restoreWarnings();
708  $interwikis = [];
709  if ( !$rows ) {
710  return Status::newFatal( 'config-install-interwiki-list' );
711  }
712  foreach ( $rows as $row ) {
713  $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
714  if ( $row == "" ) {
715  continue;
716  }
717  $row .= "|";
718  $interwikis[] = array_combine(
719  [ 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ],
720  explode( '|', $row )
721  );
722  }
723  $this->db->insert( 'interwiki', $interwikis, __METHOD__ );
724 
725  return Status::newGood();
726  }
727 
728  public function outputHandler( $string ) {
729  return htmlspecialchars( $string );
730  }
731 }
static closeElement($element)
Returns "".
Definition: Html.php:305
either a plain
Definition: hooks.txt:1987
$IP
Definition: WebStart.php:58
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:1936
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
preUpgrade()
Allow DB installers a chance to make checks before upgrade.
preInstall()
Allow DB installers a chance to make last-minute changes before installation occurs.
__construct($parent)
Construct and initialise parent.
needsUpgrade()
Determine whether an existing installation of MediaWiki is present in the configured administrative c...
submitSettingsForm()
Set variables based on the request array, assuming it was submitted via the form return by getSetting...
getLocalSettings()
Get the DBMS-specific options for LocalSettings.php generation.
array $globalNames
Array of MW configuration globals this class uses.
static newFromConnection(IDatabase $db, array $params=[])
$value
doUpgrade()
Perform database upgrades.
getVar($var, $default=null)
Get a variable, taking local defaults into account.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
createTables()
Create database tables from scratch.
static newForDB(Database $db, $shared=false, $maintenance=null)
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
const DBO_DDLMODE
Definition: defines.php:13
getConnection()
Connect to the database using the administrative user/password currently defined in the session...
stepApplySourceFile($sourceFileMethod, $stepName, $archiveTableMustNotExist=false)
Apply a SQL source file to the database as part of running an installation step.
getSchemaVars()
Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files.
checkPrerequisites()
Checks for installation prerequisites other than those checked by isCompiled()
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
submitWebUserBox()
Submit the form from getWebUserBox().
getName()
Return the internal name, e.g.
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:93
setupSchemaVars()
Set appropriate schema variables in the current database connection.
$GLOBALS['IP']
getUpdateKeysPath($db)
Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql.
getConnectForm()
Get HTML for a web form that configures this database.
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 unsetoffset-wrap String Wrap the message in html(usually something like"&lt
getReadableName()
Get the internationalised name for this DBMS.
createExtensionTables()
Create the tables for each extension the user enabled.
getInternalDefaults()
Get a name=>value map of internal variables used during installation.
$params
getWebUserBox($noCreateMsg=false)
Get a standard web-user fieldset.
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:1936
getGlobalDefaults()
Get a name=>value map of MW configuration globals for the default values.
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
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:12
submitConnectForm()
Set variables based on the request array, assuming it was submitted via the form returned by getConne...
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:2159
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:9
submitInstallUserBox()
Submit a standard install user fieldset.
getPasswordBox($var, $label, $attribs=[], $helpData="")
Get a labelled password box to configure a local variable.
setVarsFromRequest($varNames)
Convenience function to set variables based on form data.
const DBO_TRX
Definition: defines.php:9
getInstallUserBox()
Get a standard install-user fieldset.
getText()
Get the text to display when reporting the error on the command line.
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:35
Database $db
The database connection.
setupDatabase()
Create the database and return a Status object indicating success or failure.
static checkExtension($name)
Convenience function.
getTextBox($var, $label, $attribs=[], $helpData="")
Get a labelled text box to configure a local variable.
Base class for DBMS-specific installation helper classes.
getCheckBox($var, $label, $attribs=[], $helpData="")
Get a labelled checkbox to configure a local boolean variable.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
openConnection()
Open a connection to the database using the administrative user/password currently defined in the ses...
setVar($name, $value)
Convenience alias for $this->parent->setVar()
getSqlFilePath($db, $filename)
Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file.
insertUpdateKeys()
Insert update keys into table to prevent running unneded updates.
populateInterwikiTable()
Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
getSchemaPath($db)
Return a path to the DBMS-specific schema file, otherwise default to tables.sql.
WebInstaller $parent
The Installer object.
getGlobalNames()
Get an array of MW configuration globals that will be configured by this class.
getRadioSet($params)
Get a set of labelled radio buttons.
getSettingsForm()
Get HTML for a web form that retrieves settings used for installation.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
enableLB()
Set up LBFactory so that wfGetDB() etc.
array $internalDefaults
Internal variables for installation.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300