MediaWiki  master
DatabaseInstaller Class Reference

Base class for DBMS-specific installation helper classes. More...

Inheritance diagram for DatabaseInstaller:
Collaboration diagram for DatabaseInstaller:

Public Member Functions

 __construct ( $parent)
 Construct and initialise parent. More...
 
 checkPrerequisites ()
 Checks for installation prerequisites other than those checked by isCompiled() More...
 
 createExtensionTables ()
 Create the tables for each extension the user enabled. More...
 
 createManualTables ()
 Create database tables from scratch. More...
 
 createTables ()
 Create database tables from scratch from the automatically generated file. More...
 
 doUpgrade ()
 Perform database upgrades. More...
 
 enableLB ()
 Set up LBFactory so that wfGetDB() etc. More...
 
 getCheckBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled checkbox to configure a local boolean variable. More...
 
 getConnectForm ()
 Get HTML for a web form that configures this database. More...
 
 getConnection ()
 Connect to the database using the administrative user/password currently defined in the session. More...
 
 getGeneratedSchemaPath ( $db)
 Return a path to the DBMS-specific automatically generated schema file. More...
 
 getGlobalDefaults ()
 Get a name=>value map of MW configuration globals for the default values. More...
 
 getGlobalNames ()
 Get an array of MW configuration globals that will be configured by this class. More...
 
 getInstallUserBox ()
 Get a standard install-user fieldset. More...
 
 getInternalDefaults ()
 Get a name=>value map of internal variables used during installation. More...
 
 getLocalSettings ()
 Get the DBMS-specific options for LocalSettings.php generation. More...
 
 getName ()
 Return the internal name, e.g. More...
 
 getPasswordBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled password box to configure a local variable. More...
 
 getRadioSet ( $params)
 Get a set of labelled radio buttons. More...
 
 getReadableName ()
 Get the internationalised name for this DBMS. More...
 
 getSchemaPath ( $db)
 Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More...
 
 getSchemaVars ()
 Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files. More...
 
 getSettingsForm ()
 Get HTML for a web form that retrieves settings used for installation. More...
 
 getTextBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled text box to configure a local variable. More...
 
 getUpdateKeysPath ( $db)
 Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql. More...
 
 getVar ( $var, $default=null)
 Get a variable, taking local defaults into account. More...
 
 getWebUserBox ( $noCreateMsg=false)
 Get a standard web-user fieldset. More...
 
 insertUpdateKeys ()
 Insert update keys into table to prevent running unneeded updates. More...
 
 isCompiled ()
 
 needsUpgrade ()
 Determine whether an existing installation of MediaWiki is present in the configured administrative connection. More...
 
 openConnection ()
 Open a connection to the database using the administrative user/password currently defined in the session, without any caching. More...
 
 outputHandler ( $string)
 
 populateInterwikiTable ()
 Common function for databases that don't understand the MySQLish syntax of interwiki.list. More...
 
 preInstall ()
 Allow DB installers a chance to make last-minute changes before installation occurs. More...
 
 preUpgrade ()
 Allow DB installers a chance to make checks before upgrade. More...
 
 setupDatabase ()
 Create the database and return a Status object indicating success or failure. More...
 
 setupSchemaVars ()
 Set appropriate schema variables in the current database connection. More...
 
 setVar ( $name, $value)
 Convenience alias for $this->parent->setVar() More...
 
 setVarsFromRequest ( $varNames)
 Convenience function to set variables based on form data. More...
 
 submitConnectForm ()
 Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm(). More...
 
 submitInstallUserBox ()
 Submit a standard install user fieldset. More...
 
 submitSettingsForm ()
 Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm(). More...
 
 submitWebUserBox ()
 Submit the form from getWebUserBox(). More...
 

Static Public Member Functions

static meetsMinimumRequirement ( $serverVersion)
 Whether the provided version meets the necessary requirements for this type. More...
 

Public Attributes

Database $db = null
 The database connection. More...
 
WebInstaller $parent
 The Installer object. More...
 

Static Public Attributes

static string $minimumVersion
 Set by subclasses. More...
 

Static Protected Member Functions

static checkExtension ( $name)
 Convenience function. More...
 

Protected Attributes

array $globalNames = []
 Array of MW configuration globals this class uses. More...
 
array $internalDefaults = []
 Internal variables for installation. More...
 

Static Protected Attributes

static string $notMinimumVersionMessage
 Set by subclasses. More...
 

Private Member Functions

 getSqlFilePath ( $db, $filename)
 Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file. More...
 
 stepApplySourceFile ( $sourceFileMethod, $stepName, $tableThatMustNotExist=false)
 Apply a SQL source file to the database as part of running an installation step. More...
 

Detailed Description

Base class for DBMS-specific installation helper classes.

Stability: stable
to extend
Since
1.17

Definition at line 37 of file DatabaseInstaller.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseInstaller::__construct (   $parent)

Construct and initialise parent.

This is typically only called from Installer::getDBInstaller()

Stability: stable
to call
Parameters
WebInstaller$parent

Definition at line 471 of file DatabaseInstaller.php.

References $parent.

Member Function Documentation

◆ checkExtension()

static DatabaseInstaller::checkExtension (   $name)
staticprotected

Convenience function.

Check if a named extension is present.

Parameters
string$name
Returns
bool

Definition at line 482 of file DatabaseInstaller.php.

Referenced by MysqlInstaller\isCompiled(), PostgresInstaller\isCompiled(), and SqliteInstaller\isCompiled().

◆ checkPrerequisites()

DatabaseInstaller::checkPrerequisites ( )

Checks for installation prerequisites other than those checked by isCompiled()

Stability: stable
to override
Since
1.19
Returns
Status

Reimplemented in SqliteInstaller.

Definition at line 110 of file DatabaseInstaller.php.

References StatusValue\newGood().

◆ createExtensionTables()

DatabaseInstaller::createExtensionTables ( )

Create the tables for each extension the user enabled.

Stability: stable
to override
Returns
Status

Definition at line 339 of file DatabaseInstaller.php.

References getConnection(), and DatabaseUpdater\newForDB().

◆ createManualTables()

DatabaseInstaller::createManualTables ( )

Create database tables from scratch.

Stability: stable
to override
Returns
Status

Reimplemented in SqliteInstaller, and PostgresInstaller.

Definition at line 266 of file DatabaseInstaller.php.

References stepApplySourceFile().

◆ createTables()

DatabaseInstaller::createTables ( )

Create database tables from scratch from the automatically generated file.

Stability: stable
to override
Returns
Status

Reimplemented in SqliteInstaller, and PostgresInstaller.

Definition at line 256 of file DatabaseInstaller.php.

References stepApplySourceFile().

◆ doUpgrade()

DatabaseInstaller::doUpgrade ( )

Perform database upgrades.

Returns
bool

Definition at line 416 of file DatabaseInstaller.php.

References enableLB(), MWException\getText(), DatabaseUpdater\newForDB(), and setupSchemaVars().

◆ enableLB()

DatabaseInstaller::enableLB ( )

Set up LBFactory so that wfGetDB() etc.

works. We set up a special LBFactory instance which returns the current installer connection.

Definition at line 396 of file DatabaseInstaller.php.

References getConnection().

Referenced by PostgresInstaller\createTables(), doUpgrade(), and stepApplySourceFile().

◆ getCheckBox()

DatabaseInstaller::getCheckBox (   $var,
  $label,
  $attribs = [],
  $helpData = "" 
)

Get a labelled checkbox to configure a local boolean variable.

Parameters
string$var
string$label
array$attribsOptional.
string$helpDataOptional.
Returns
string

Definition at line 610 of file DatabaseInstaller.php.

References getName(), and getVar().

Referenced by getWebUserBox().

◆ getConnectForm()

DatabaseInstaller::getConnectForm ( )
abstract

Get HTML for a web form that configures this database.

Configuration at this time should be the minimum needed to connect and test whether install or upgrade is required.

If this is called, $this->parent can be assumed to be a WebInstaller.

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

◆ getConnection()

DatabaseInstaller::getConnection ( )

Connect to the database using the administrative user/password currently defined in the session.

Returns a status object. On success, the status object will contain a Database object in its value member.

This will return a cached connection if one is available.

Stability: stable
to override
Returns
Status

Reimplemented in PostgresInstaller.

Definition at line 186 of file DatabaseInstaller.php.

References DBO_TRX, StatusValue\newGood(), and openConnection().

Referenced by MysqlInstaller\canCreateAccounts(), createExtensionTables(), enableLB(), MysqlInstaller\getEngines(), needsUpgrade(), populateInterwikiTable(), Installer\populateSiteStats(), MysqlInstaller\preUpgrade(), MysqlInstaller\setupDatabase(), SqliteInstaller\setupDatabase(), setupSchemaVars(), MysqlInstaller\setupUser(), stepApplySourceFile(), and MysqlInstaller\submitConnectForm().

◆ getGeneratedSchemaPath()

DatabaseInstaller::getGeneratedSchemaPath (   $db)

Return a path to the DBMS-specific automatically generated schema file.

Stability: stable
to override
Parameters
IDatabase$db
Returns
string

Definition at line 318 of file DatabaseInstaller.php.

References getSqlFilePath().

Referenced by PostgresInstaller\createTables().

◆ getGlobalDefaults()

DatabaseInstaller::getGlobalDefaults ( )

Get a name=>value map of MW configuration globals for the default values.

Stability: stable
to override
Returns
array

Reimplemented in SqliteInstaller, and PostgresInstaller.

Definition at line 501 of file DatabaseInstaller.php.

References getGlobalNames().

Referenced by getVar().

◆ getGlobalNames()

DatabaseInstaller::getGlobalNames ( )

Get an array of MW configuration globals that will be configured by this class.

Stability: stable
to override
Returns
array

Definition at line 461 of file DatabaseInstaller.php.

References $globalNames.

Referenced by getGlobalDefaults().

◆ getInstallUserBox()

DatabaseInstaller::getInstallUserBox ( )

Get a standard install-user fieldset.

Returns
string

Definition at line 689 of file DatabaseInstaller.php.

References Html\closeElement(), Html\element(), getPasswordBox(), getTextBox(), Html\openElement(), and wfMessage().

Referenced by MysqlInstaller\getConnectForm(), and PostgresInstaller\getConnectForm().

◆ getInternalDefaults()

DatabaseInstaller::getInternalDefaults ( )

Get a name=>value map of internal variables used during installation.

Returns
array

Definition at line 515 of file DatabaseInstaller.php.

References $internalDefaults.

Referenced by getVar().

◆ getLocalSettings()

DatabaseInstaller::getLocalSettings ( )
abstract

Get the DBMS-specific options for LocalSettings.php generation.

Returns
string

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

◆ getName()

DatabaseInstaller::getName ( )
abstract

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

Referenced by getCheckBox(), getPasswordBox(), getRadioSet(), getReadableName(), getTextBox(), and setVarsFromRequest().

◆ getPasswordBox()

DatabaseInstaller::getPasswordBox (   $var,
  $label,
  $attribs = [],
  $helpData = "" 
)

Get a labelled password box to configure a local variable.

Implements password hiding.

Parameters
string$var
string$label
array$attribs
string$helpDataHTML
Returns
string HTML
-taint escaped

Definition at line 584 of file DatabaseInstaller.php.

References getName(), and getVar().

Referenced by getInstallUserBox(), and getWebUserBox().

◆ getRadioSet()

DatabaseInstaller::getRadioSet (   $params)

Get a set of labelled radio buttons.

Parameters
array$paramsParameters are: var: The variable to be configured (required) label: The message name for the label (required) itemLabelPrefix: The message name prefix for the item labels (required) values: List of allowed values (required) itemAttribs Array of attribute arrays, outer key is the value name (optional)
Returns
string

Definition at line 636 of file DatabaseInstaller.php.

References getName(), and getVar().

◆ getReadableName()

DatabaseInstaller::getReadableName ( )

Get the internationalised name for this DBMS.

Stability: stable
to override
Returns
string

Definition at line 491 of file DatabaseInstaller.php.

References getName(), and wfMessage().

◆ getSchemaPath()

DatabaseInstaller::getSchemaPath (   $db)

Return a path to the DBMS-specific schema file, otherwise default to tables.sql.

Stability: stable
to override
Parameters
IDatabase$db
Returns
string

Definition at line 307 of file DatabaseInstaller.php.

References getSqlFilePath().

Referenced by PostgresInstaller\createTables().

◆ getSchemaVars()

DatabaseInstaller::getSchemaVars ( )

Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files.

Stability: stable
to override
Returns
array

Reimplemented in MysqlInstaller.

Definition at line 366 of file DatabaseInstaller.php.

Referenced by setupSchemaVars().

◆ getSettingsForm()

DatabaseInstaller::getSettingsForm ( )

Get HTML for a web form that retrieves settings used for installation.

$this->parent can be assumed to be a WebInstaller. If the DB type has no settings beyond those already configured with getConnectForm(), this should return false.

Stability: stable
to override
Returns
string|bool

Reimplemented in PostgresInstaller, and MysqlInstaller.

Definition at line 142 of file DatabaseInstaller.php.

◆ getSqlFilePath()

DatabaseInstaller::getSqlFilePath (   $db,
  $filename 
)
private

Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file.

Parameters
IDatabase$db
string$filename
Returns
string

Definition at line 288 of file DatabaseInstaller.php.

References $db, $IP, and Wikimedia\Rdbms\IDatabase\getType().

Referenced by getGeneratedSchemaPath(), getSchemaPath(), and getUpdateKeysPath().

◆ getTextBox()

DatabaseInstaller::getTextBox (   $var,
  $label,
  $attribs = [],
  $helpData = "" 
)

Get a labelled text box to configure a local variable.

Parameters
string$var
string$label
array$attribs
string$helpDataHTML
Returns
string HTML
-taint escaped

Definition at line 556 of file DatabaseInstaller.php.

References getName(), and getVar().

Referenced by MysqlInstaller\getConnectForm(), PostgresInstaller\getConnectForm(), SqliteInstaller\getConnectForm(), getInstallUserBox(), and getWebUserBox().

◆ getUpdateKeysPath()

DatabaseInstaller::getUpdateKeysPath (   $db)

Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql.

Stability: stable
to override
Parameters
IDatabase$db
Returns
string

Definition at line 330 of file DatabaseInstaller.php.

References getSqlFilePath().

◆ getVar()

DatabaseInstaller::getVar (   $var,
  $default = null 
)

◆ getWebUserBox()

DatabaseInstaller::getWebUserBox (   $noCreateMsg = false)

Get a standard web-user fieldset.

Parameters
string | bool$noCreateMsgMessage to display instead of the creation checkbox. Set this to false to show a creation checkbox (default).
Returns
string

Definition at line 726 of file DatabaseInstaller.php.

References $s, Html\closeElement(), Html\element(), getCheckBox(), getPasswordBox(), getTextBox(), getVar(), Html\openElement(), Html\warningBox(), and wfMessage().

Referenced by MysqlInstaller\getSettingsForm(), and PostgresInstaller\getSettingsForm().

◆ insertUpdateKeys()

DatabaseInstaller::insertUpdateKeys ( )

Insert update keys into table to prevent running unneeded updates.

Stability: stable
to override
Returns
Status

Definition at line 276 of file DatabaseInstaller.php.

References stepApplySourceFile().

◆ isCompiled()

DatabaseInstaller::isCompiled ( )
abstract
Returns
bool Returns true if the client library is compiled in.

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

◆ meetsMinimumRequirement()

static DatabaseInstaller::meetsMinimumRequirement (   $serverVersion)
static

Whether the provided version meets the necessary requirements for this type.

Parameters
string$serverVersionOutput of Database::getServerVersion()
Returns
Status
Since
1.30

Definition at line 84 of file DatabaseInstaller.php.

References StatusValue\newFatal(), and StatusValue\newGood().

◆ needsUpgrade()

DatabaseInstaller::needsUpgrade ( )

Determine whether an existing installation of MediaWiki is present in the configured administrative connection.

Returns true if there is such a wiki, false if the database doesn't exist.

Traditionally, this is done by testing for the existence of either the revision table or the cur table.

Stability: stable
to override
Returns
bool

Reimplemented in SqliteInstaller.

Definition at line 665 of file DatabaseInstaller.php.

References getConnection(), and getVar().

◆ openConnection()

DatabaseInstaller::openConnection ( )
abstract

Open a connection to the database using the administrative user/password currently defined in the session, without any caching.

Returns a status object. On success, the status object will contain a Database object in its value member.

Returns
Status

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

Referenced by getConnection().

◆ outputHandler()

DatabaseInstaller::outputHandler (   $string)

Definition at line 813 of file DatabaseInstaller.php.

◆ populateInterwikiTable()

DatabaseInstaller::populateInterwikiTable ( )

Common function for databases that don't understand the MySQLish syntax of interwiki.list.

Stability: stable
to override
Returns
Status

Definition at line 776 of file DatabaseInstaller.php.

References $IP, getConnection(), getVar(), StatusValue\newFatal(), and StatusValue\newGood().

◆ preInstall()

DatabaseInstaller::preInstall ( )

Allow DB installers a chance to make last-minute changes before installation occurs.

This happens before setupDatabase() or createTables() is called, but long after the constructor. Helpful for things like modifying setup steps :)

Stability: stable
to override

Reimplemented in PostgresInstaller, and MysqlInstaller.

Definition at line 446 of file DatabaseInstaller.php.

◆ preUpgrade()

DatabaseInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Stability: stable
to override

Reimplemented in PostgresInstaller, and MysqlInstaller.

Definition at line 453 of file DatabaseInstaller.php.

◆ setupDatabase()

DatabaseInstaller::setupDatabase ( )
abstract

Create the database and return a Status object indicating success or failure.

Returns
Status

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

◆ setupSchemaVars()

DatabaseInstaller::setupSchemaVars ( )

Set appropriate schema variables in the current database connection.

This should be called after any request data has been imported, but before any write operations to the database.

Stability: stable
to override

Definition at line 378 of file DatabaseInstaller.php.

References getConnection(), and getSchemaVars().

Referenced by doUpgrade(), MysqlInstaller\setupDatabase(), SqliteInstaller\setupDatabase(), and MysqlInstaller\setupUser().

◆ setVar()

DatabaseInstaller::setVar (   $name,
  $value 
)

◆ setVarsFromRequest()

DatabaseInstaller::setVarsFromRequest (   $varNames)

Convenience function to set variables based on form data.

Assumes that variables containing "password" in the name are (potentially fake) passwords.

Parameters
array$varNames
Returns
array

Definition at line 650 of file DatabaseInstaller.php.

References getName().

Referenced by MysqlInstaller\submitConnectForm(), PostgresInstaller\submitConnectForm(), SqliteInstaller\submitConnectForm(), submitInstallUserBox(), MysqlInstaller\submitSettingsForm(), and submitWebUserBox().

◆ stepApplySourceFile()

DatabaseInstaller::stepApplySourceFile (   $sourceFileMethod,
  $stepName,
  $tableThatMustNotExist = false 
)
private

Apply a SQL source file to the database as part of running an installation step.

Parameters
string$sourceFileMethod
string$stepName
bool | string$tableThatMustNotExist
Returns
Status

Definition at line 210 of file DatabaseInstaller.php.

References DBO_DDLMODE, enableLB(), getConnection(), and getVar().

Referenced by createManualTables(), createTables(), and insertUpdateKeys().

◆ submitConnectForm()

DatabaseInstaller::submitConnectForm ( )
abstract

Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm().

Validate the connection settings by attempting to connect with them.

If this is called, $this->parent can be assumed to be a WebInstaller.

Returns
Status

Reimplemented in SqliteInstaller, PostgresInstaller, and MysqlInstaller.

◆ submitInstallUserBox()

DatabaseInstaller::submitInstallUserBox ( )

Submit a standard install user fieldset.

Returns
Status

Definition at line 713 of file DatabaseInstaller.php.

References StatusValue\newGood(), and setVarsFromRequest().

Referenced by MysqlInstaller\submitConnectForm(), and PostgresInstaller\submitConnectForm().

◆ submitSettingsForm()

DatabaseInstaller::submitSettingsForm ( )

Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm().

Stability: stable
to override
Returns
Status

Reimplemented in PostgresInstaller, and MysqlInstaller.

Definition at line 153 of file DatabaseInstaller.php.

References StatusValue\newGood().

◆ submitWebUserBox()

DatabaseInstaller::submitWebUserBox ( )

Member Data Documentation

◆ $db

Database DatabaseInstaller::$db = null

◆ $globalNames

array DatabaseInstaller::$globalNames = []
protected

Array of MW configuration globals this class uses.

Definition at line 75 of file DatabaseInstaller.php.

Referenced by getGlobalNames().

◆ $internalDefaults

array DatabaseInstaller::$internalDefaults = []
protected

Internal variables for installation.

Definition at line 68 of file DatabaseInstaller.php.

Referenced by getInternalDefaults().

◆ $minimumVersion

string DatabaseInstaller::$minimumVersion
static

Set by subclasses.

Definition at line 49 of file DatabaseInstaller.php.

◆ $notMinimumVersionMessage

string DatabaseInstaller::$notMinimumVersionMessage
staticprotected

Set by subclasses.

Definition at line 54 of file DatabaseInstaller.php.

◆ $parent

WebInstaller DatabaseInstaller::$parent

The Installer object.

Definition at line 44 of file DatabaseInstaller.php.

Referenced by __construct().


The documentation for this class was generated from the following file: