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

Inheritance diagram for DatabaseInstaller:

[legend]

Collaboration diagram for DatabaseInstaller:

[legend]

Public Member Functions
	__construct ( $parent)
	Construct and initialise parent.

	checkPrerequisites ()
	Checks for installation prerequisites other than those checked by isCompiled() Stable to override.

	createExtensionTables ()
	Create the tables for each extension the user enabled Stable to override.

	createManualTables ()
	Create database tables from scratch.

	createTables ()
	Create database tables from scratch from the automatically generated file Stable to override.

	doUpgrade ()
	Perform database upgrades.

	enableLB ()
	Set up LBFactory so that wfGetDB() etc.

	getCheckBox ( $var, $label, $attribs=[], $helpData="")
	Get a labelled checkbox to configure a local boolean variable.

	getConnectForm ()
	Get HTML for a web form that configures this database.

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

	getGeneratedSchemaPath ( $db)
	Return a path to the DBMS-specific automatically generated schema file.

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

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

	getInstallUserBox ()
	Get a standard install-user fieldset.

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

	getLocalSettings ()
	Get the DBMS-specific options for LocalSettings.php generation.

	getName ()
	Return the internal name, e.g.

	getPasswordBox ( $var, $label, $attribs=[], $helpData="")
	Get a labelled password box to configure a local variable.

	getRadioSet ( $params)
	Get a set of labelled radio buttons.

	getReadableName ()
	Get the internationalised name for this DBMS.

	getSchemaPath ( $db)
	Return a path to the DBMS-specific schema file, otherwise default to tables.sql Stable to override.

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

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

	getTextBox ( $var, $label, $attribs=[], $helpData="")
	Get a labelled text box to configure a local variable.

	getUpdateKeysPath ( $db)
	Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql Stable to override.

	getVar ( $var, $default=null)
	Get a variable, taking local defaults into account.

	getWebUserBox ( $noCreateMsg=false)
	Get a standard web-user fieldset.

	insertUpdateKeys ()
	Insert update keys into table to prevent running unneded updates.

	isCompiled ()

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

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

	outputHandler ( $string)

	populateInterwikiTable ()
	Common function for databases that don't understand the MySQLish syntax of interwiki.sql.

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

	preUpgrade ()
	Allow DB installers a chance to make checks before upgrade.

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

	setupSchemaVars ()
	Set appropriate schema variables in the current database connection.

	setVar ( $name, $value)
	Convenience alias for $this->parent->setVar()

	setVarsFromRequest ( $varNames)
	Convenience function to set variables based on form data.

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

	submitInstallUserBox ()
	Submit a standard install user fieldset.

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

	submitWebUserBox ()
	Submit the form from getWebUserBox().

Static Public Member Functions
static	meetsMinimumRequirement ( $serverVersion)
	Whether the provided version meets the necessary requirements for this type.

Public Attributes
Database	$db = null
	The database connection.

WebInstaller	$parent
	The Installer object.

Static Public Attributes
static string	$minimumVersion
	Set by subclasses.

Static Protected Member Functions
static	checkExtension ( $name)
	Convenience function.

Protected Attributes
array	$globalNames = []
	Array of MW configuration globals this class uses.

array	$internalDefaults = []
	Internal variables for installation.

Static Protected Attributes
static string	$notMinimumVersionMessage
	Set by subclasses.

Private Member Functions
	getSqlFilePath ( $db, $filename)
	Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file.

	stepApplySourceFile ( $sourceFileMethod, $stepName, $archiveTableMustNotExist=false)
	Apply a SQL source file to the database as part of running an installation step.

Detailed Description

Base class for DBMS-specific installation helper classes.

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() 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() Stable to override.

Since: 1.19

Returns: Status

Reimplemented in SqliteInstaller.

Definition at line 110 of file DatabaseInstaller.php.

◆ createExtensionTables()

DatabaseInstaller::createExtensionTables ( )

Create the tables for each extension the user enabled Stable to override.

Returns: Status

Definition at line 339 of file DatabaseInstaller.php.

References getConnection().

◆ createManualTables()

DatabaseInstaller::createManualTables ( )

Create database tables from scratch.

Stable to override

Returns: Status

Definition at line 265 of file DatabaseInstaller.php.

References stepApplySourceFile().

◆ createTables()

DatabaseInstaller::createTables ( )

Create database tables from scratch from the automatically generated file Stable to override.

Returns: Status

Reimplemented in PostgresInstaller, and SqliteInstaller.

Definition at line 255 of file DatabaseInstaller.php.

References stepApplySourceFile().

◆ doUpgrade()

DatabaseInstaller::doUpgrade ( )

Perform database upgrades.

SecurityCheck-XSS Escaping provided by $this->outputHandler

Returns: bool

Definition at line 416 of file DatabaseInstaller.php.

References enableLB(), MWException\getText(), 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	$attribs	Optional.
string	$helpData	Optional.

Returns: string

Definition at line 608 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 MysqlInstaller, PostgresInstaller, and SqliteInstaller.

◆ 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.

Stable to override

Returns: Status PhanUndeclaredMethod

Reimplemented in PostgresInstaller.

Definition at line 186 of file DatabaseInstaller.php.

References DBO_TRX, and openConnection().

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

◆ getGeneratedSchemaPath()

DatabaseInstaller::getGeneratedSchemaPath ( $db )

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

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.

Stable to override

Returns: array

Reimplemented in PostgresInstaller, and SqliteInstaller.

Definition at line 501 of file DatabaseInstaller.php.

References $GLOBALS, and getGlobalNames().

Referenced by getVar().

◆ getGlobalNames()

DatabaseInstaller::getGlobalNames ( )

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

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 687 of file DatabaseInstaller.php.

References getPasswordBox(), getTextBox(), 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 MysqlInstaller, PostgresInstaller, and SqliteInstaller.

◆ getName()

DatabaseInstaller::getName ( )

abstract

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented in MysqlInstaller, PostgresInstaller, and SqliteInstaller.

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	$helpData

Returns: string

Definition at line 582 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 $params Parameters 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 634 of file DatabaseInstaller.php.

References getName(), and getVar().

◆ getReadableName()

DatabaseInstaller::getReadableName ( )

Get the internationalised name for this DBMS.

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 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.

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. Stable to override

Returns: string|bool

Reimplemented in MysqlInstaller, and PostgresInstaller.

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	$helpData

Returns: string

Definition at line 555 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 Stable to override.

Parameters

IDatabase $db

Returns: string

Definition at line 330 of file DatabaseInstaller.php.

References getSqlFilePath().

◆ getVar()

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

Get a variable, taking local defaults into account.

Parameters

string	$var
mixed \| null	$default

Returns: mixed

Definition at line 525 of file DatabaseInstaller.php.

References getGlobalDefaults(), and getInternalDefaults().

◆ getWebUserBox()

DatabaseInstaller::getWebUserBox ( $noCreateMsg = false )

Get a standard web-user fieldset.

Parameters

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

Returns: string

Definition at line 722 of file DatabaseInstaller.php.

References $s, getCheckBox(), getPasswordBox(), getTextBox(), getVar(), and wfMessage().

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

◆ insertUpdateKeys()

DatabaseInstaller::insertUpdateKeys ( )

Insert update keys into table to prevent running unneded updates.

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 MysqlInstaller, PostgresInstaller, and SqliteInstaller.

◆ meetsMinimumRequirement()

static DatabaseInstaller::meetsMinimumRequirement ( $serverVersion )

static

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

Parameters

string $serverVersion Output of Database::getServerVersion()

Returns: Status

Since: 1.30

Definition at line 84 of file DatabaseInstaller.php.

◆ 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.

Stable to override

Returns: bool

Reimplemented in SqliteInstaller.

Definition at line 663 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 MysqlInstaller, PostgresInstaller, and SqliteInstaller.

Referenced by getConnection().

◆ outputHandler()

DatabaseInstaller::outputHandler ( $string )

Definition at line 809 of file DatabaseInstaller.php.

◆ populateInterwikiTable()

DatabaseInstaller::populateInterwikiTable ( )

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

Stable to override

Returns: Status

Definition at line 772 of file DatabaseInstaller.php.

References $IP, getConnection(), and getVar().

◆ 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 :) Stable to override

Reimplemented in MysqlInstaller, and PostgresInstaller.

Definition at line 446 of file DatabaseInstaller.php.

◆ preUpgrade()

DatabaseInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Stable to override

Reimplemented in MysqlInstaller, and PostgresInstaller.

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 MysqlInstaller, PostgresInstaller, and SqliteInstaller.

◆ 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.

Stable to override

Definition at line 378 of file DatabaseInstaller.php.

References getConnection(), and getSchemaVars().

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

◆ setVar()

DatabaseInstaller::setVar	(	$name,
		$value
	)

Convenience alias for $this->parent->setVar()

Parameters

string	$name
mixed	$value

Definition at line 542 of file DatabaseInstaller.php.

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

◆ 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 648 of file DatabaseInstaller.php.

References getName().

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

◆ stepApplySourceFile()

DatabaseInstaller::stepApplySourceFile	(	$sourceFileMethod,
		$stepName,
		$archiveTableMustNotExist = `false`
	)

private

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

Parameters

string	$sourceFileMethod
string	$stepName
bool	$archiveTableMustNotExist

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 MysqlInstaller, PostgresInstaller, and SqliteInstaller.

◆ submitInstallUserBox()

DatabaseInstaller::submitInstallUserBox ( )

Submit a standard install user fieldset.

Returns: Status

Definition at line 709 of file DatabaseInstaller.php.

References 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().

Stable to override

Returns: Status

Reimplemented in MysqlInstaller, and PostgresInstaller.

Definition at line 153 of file DatabaseInstaller.php.

◆ submitWebUserBox()

DatabaseInstaller::submitWebUserBox ( )

Submit the form from getWebUserBox().

Returns: Status

Definition at line 749 of file DatabaseInstaller.php.

References getVar(), setVar(), and setVarsFromRequest().

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

Member Data Documentation

◆ $db

Database DatabaseInstaller::$db = null

The database connection.

Definition at line 61 of file DatabaseInstaller.php.

Referenced by getSqlFilePath(), MysqlInstaller\openConnection(), PostgresInstaller\openConnectionToAnyDB(), and PostgresInstaller\openConnectionWithParams().

◆ $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:

includes/installer/DatabaseInstaller.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkExtension()

◆ checkPrerequisites()

◆ createExtensionTables()

◆ createManualTables()

◆ createTables()

◆ doUpgrade()

◆ enableLB()

◆ getCheckBox()

◆ getConnectForm()

◆ getConnection()

◆ getGeneratedSchemaPath()

◆ getGlobalDefaults()

◆ getGlobalNames()

◆ getInstallUserBox()

◆ getInternalDefaults()

◆ getLocalSettings()

◆ getName()

◆ getPasswordBox()

◆ getRadioSet()

◆ getReadableName()

◆ getSchemaPath()

◆ getSchemaVars()

◆ getSettingsForm()

◆ getSqlFilePath()

◆ getTextBox()

◆ getUpdateKeysPath()

◆ getVar()

◆ getWebUserBox()

◆ insertUpdateKeys()

◆ isCompiled()

◆ meetsMinimumRequirement()

◆ needsUpgrade()

◆ openConnection()

◆ outputHandler()

◆ populateInterwikiTable()

◆ preInstall()

◆ preUpgrade()

◆ setupDatabase()

◆ setupSchemaVars()

◆ setVar()

◆ setVarsFromRequest()

◆ stepApplySourceFile()

◆ submitConnectForm()

◆ submitInstallUserBox()

◆ submitSettingsForm()

◆ submitWebUserBox()

Member Data Documentation

◆ $db

◆ $globalNames

◆ $internalDefaults

◆ $minimumVersion

◆ $notMinimumVersionMessage

◆ $parent