Class for setting up the MediaWiki database using Postgres. More...

Inheritance diagram for PostgresInstaller:

Collaboration diagram for PostgresInstaller:

Public Member Functions
	commitChanges ()
	createTables ()
	Create database tables from scratch.
	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.
	getGlobalDefaults ()
	Get a name=>value map of MW configuration globals that overrides.
	getLocalSettings ()
	Get the DBMS-specific options for LocalSettings.php generation.
	getName ()
	Return the internal name, e.g.
	getSettingsForm ()
	Get HTML for a web form that retrieves settings used for installation.
	isCompiled ()
	openConnection ()
	Open a connection to the database using the administrative user/password currently defined in the session, without any caching.
	openConnectionToAnyDB ($user, $password)
	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.
	setupPLpgSQL ()
	setupSchema ()
	setupUser ()
	submitConnectForm ()
	Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm().
	submitSettingsForm ()
	Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm().
Public Attributes
	$maxRoleSearchDepth = 5
	$minimumVersion = '8.3'
Protected Member Functions
	canCreateAccounts ()
	canCreateObjectsForWebUser ()
	Returns true if the install user is able to create objects owned by the web user, false otherwise.
	getInstallUserPermissions ()
	getPgConnection ($type)
	Get a special type of connection.
	isRoleMember ($conn, $targetMember, $group, $maxDepth)
	Recursive helper for canCreateObjectsForWebUser().
	isSuperUser ()
	openConnectionWithParams ($user, $password, $dbName, $schema)
	Open a PG connection with given parameters.
	openPgConnection ($type)
	Get a connection of a specific PostgreSQL-specific type.
Protected Attributes
	$globalNames
	Array of MW configuration globals this class uses.
	$internalDefaults
	Internal variables for installation.
	$pgConns = array()

Detailed Description

Class for setting up the MediaWiki database using Postgres.

Since:: 1.17

Definition at line 30 of file PostgresInstaller.php.

Member Function Documentation

PostgresInstaller::canCreateAccounts ( ) [protected]

Definition at line 303 of file PostgresInstaller.php.

References getInstallUserPermissions().

Referenced by getSettingsForm(), and submitSettingsForm().

PostgresInstaller::canCreateObjectsForWebUser ( ) [protected]

Returns true if the install user is able to create objects owned by the web user, false otherwise.

Returns:: bool

Definition at line 398 of file PostgresInstaller.php.

References array(), getPgConnection(), DatabaseInstaller\getVar(), isRoleMember(), and isSuperUser().

Referenced by submitSettingsForm().

PostgresInstaller::commitChanges ( )

Definition at line 522 of file PostgresInstaller.php.

References Status\newGood().

PostgresInstaller::createTables ( )

Create database tables from scratch.

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 584 of file PostgresInstaller.php.

References $error, DatabaseInstaller\enableLB(), getConnection(), and DatabaseInstaller\getVar().

PostgresInstaller::getConnectForm ( )

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

Definition at line 58 of file PostgresInstaller.php.

References array(), Html\closeElement(), Html\element(), DatabaseInstaller\getInstallUserBox(), DatabaseInstaller\getTextBox(), Html\openElement(), text, and wfMessage().

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

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 137 of file PostgresInstaller.php.

References getPgConnection().

Referenced by createTables().

PostgresInstaller::getGlobalDefaults ( )

Get a name=>value map of MW configuration globals that overrides.

DefaultSettings.php

Returns:: array

Reimplemented from DatabaseInstaller.

Definition at line 627 of file PostgresInstaller.php.

References array().

PostgresInstaller::getInstallUserPermissions ( ) [protected]

Definition at line 286 of file PostgresInstaller.php.

References array(), getPgConnection(), and DatabaseInstaller\getVar().

Referenced by canCreateAccounts(), and isSuperUser().

PostgresInstaller::getLocalSettings ( )

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

Returns:: string

Reimplemented from DatabaseInstaller.

Definition at line 566 of file PostgresInstaller.php.

References DatabaseInstaller\getVar().

PostgresInstaller::getName ( )

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented from DatabaseInstaller.

Definition at line 50 of file PostgresInstaller.php.

PostgresInstaller::getPgConnection ( $ type ) [protected]

Get a special type of connection.

Parameters:

string $type See openPgConnection() for details.

Returns:: Status

Definition at line 180 of file PostgresInstaller.php.

References $type, Status\newGood(), and openPgConnection().

Referenced by canCreateObjectsForWebUser(), getConnection(), getInstallUserPermissions(), setupDatabase(), setupPLpgSQL(), setupSchema(), setupUser(), submitConnectForm(), and submitSettingsForm().

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

Returns:: bool

Reimplemented from DatabaseInstaller.

Definition at line 321 of file PostgresInstaller.php.

References $s, canCreateAccounts(), and DatabaseInstaller\getWebUserBox().

PostgresInstaller::isCompiled ( )

Returns:: bool Returns true if the client library is compiled in.

Reimplemented from DatabaseInstaller.

Definition at line 54 of file PostgresInstaller.php.

References DatabaseInstaller\checkExtension().

PostgresInstaller::isRoleMember	(	$	conn,
		$	targetMember,
		$	group,
		$	maxDepth
	)		`[protected]`

Recursive helper for canCreateObjectsForWebUser().

Parameters:

DatabaseBase	$conn
int	$targetMember	Role ID of the member to look for
int	$group	Role ID of the group to look for
int	$maxDepth	Maximum recursive search depth

Returns:: bool

Definition at line 424 of file PostgresInstaller.php.

References $res, array(), and as.

Referenced by canCreateObjectsForWebUser().

PostgresInstaller::isSuperUser ( ) [protected]

Definition at line 312 of file PostgresInstaller.php.

References getInstallUserPermissions().

Referenced by canCreateObjectsForWebUser(), and setupUser().

PostgresInstaller::openConnection ( )

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

Definition at line 146 of file PostgresInstaller.php.

References openPgConnection().

PostgresInstaller::openConnectionToAnyDB	(	$	user,
		$	password
	)

Definition at line 253 of file PostgresInstaller.php.

References DatabaseInstaller\$db, $error, $user, array(), as, DatabaseInstaller\getVar(), Status\newGood(), and openConnectionWithParams().

Referenced by openPgConnection(), and submitSettingsForm().

PostgresInstaller::openConnectionWithParams	(	$	user,
		$	password,
		$	dbName,
		$	schema
	)		`[protected]`

Open a PG connection with given parameters.

Parameters:

string	$user	User name
string	$password	Password
string	$dbName	Database name
string	$schema	Database schema

Returns:: Status

Definition at line 158 of file PostgresInstaller.php.

References DatabaseInstaller\$db, $e, $user, array(), DatabaseBase\factory(), DatabaseInstaller\getVar(), and Status\newGood().

Referenced by openConnectionToAnyDB(), and openPgConnection().

PostgresInstaller::openPgConnection ( $ type ) [protected]

Get a connection of a specific PostgreSQL-specific type.

Connections of a given type are cached.

PostgreSQL lacks cross-database operations, so after the new database is created, you need to make a separate connection to connect to that database and add tables to it.

New tables are owned by the user that creates them, and MediaWiki's PostgreSQL support has always assumed that the table owner will be $wgDBuser. So before we create new tables, we either need to either connect as the other user or to execute a SET ROLE command. Using a separate connection for this allows us to avoid accidental cross-module dependencies.

Parameters:

string

$type

The type of connection to get:

create-db: A connection for creating DBs, suitable for pre- installation.
create-schema: A connection to the new DB, for creating schemas and other similar objects in the new DB.
create-tables: A connection with a role suitable for creating tables.

Exceptions:

MWException

Returns:: Status On success, a connection object will be in the value member.

Definition at line 224 of file PostgresInstaller.php.

References $type, DatabaseInstaller\getVar(), openConnectionToAnyDB(), and openConnectionWithParams().

Referenced by getPgConnection(), and openConnection().

PostgresInstaller::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 :)

Reimplemented from DatabaseInstaller.

Definition at line 450 of file PostgresInstaller.php.

References array(), and DatabaseInstaller\getVar().

PostgresInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Reimplemented from DatabaseInstaller.

Definition at line 575 of file PostgresInstaller.php.

References DatabaseInstaller\getVar(), and global.

PostgresInstaller::setupDatabase ( )

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

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 476 of file PostgresInstaller.php.

References array(), getPgConnection(), DatabaseInstaller\getVar(), and Status\newGood().

PostgresInstaller::setupPLpgSQL ( )

Definition at line 635 of file PostgresInstaller.php.

References $e, array(), getPgConnection(), DatabaseInstaller\getVar(), Status\newFatal(), and Status\newGood().

PostgresInstaller::setupSchema ( )

Definition at line 495 of file PostgresInstaller.php.

References $e, getPgConnection(), DatabaseInstaller\getVar(), Status\newFatal(), and Status\newGood().

PostgresInstaller::setupUser ( )

Definition at line 528 of file PostgresInstaller.php.

References $e, getPgConnection(), DatabaseInstaller\getVar(), isSuperUser(), Status\newFatal(), and Status\newGood().

PostgresInstaller::submitConnectForm ( )

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

Definition at line 84 of file PostgresInstaller.php.

References array(), getPgConnection(), DatabaseInstaller\getVar(), Status\newFatal(), Status\newGood(), DatabaseInstaller\setVar(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitInstallUserBox().

PostgresInstaller::submitSettingsForm ( )

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

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 332 of file PostgresInstaller.php.

References canCreateAccounts(), canCreateObjectsForWebUser(), getPgConnection(), DatabaseInstaller\getVar(), Status\newFatal(), Status\newGood(), openConnectionToAnyDB(), DatabaseInstaller\setVar(), and DatabaseInstaller\submitWebUserBox().

Member Data Documentation

PostgresInstaller::$globalNames [protected]

Initial value:

 array(
        'wgDBserver',
        'wgDBport',
        'wgDBname',
        'wgDBuser',
        'wgDBpassword',
        'wgDBmwschema',
    )

Array of MW configuration globals this class uses.

Reimplemented from DatabaseInstaller.

Definition at line 32 of file PostgresInstaller.php.

PostgresInstaller::$internalDefaults [protected]

Initial value:

 array(
        '_InstallUser' => 'postgres',
    )

Internal variables for installation.

Reimplemented from DatabaseInstaller.

Definition at line 41 of file PostgresInstaller.php.

PostgresInstaller::$maxRoleSearchDepth = 5

Definition at line 46 of file PostgresInstaller.php.

PostgresInstaller::$minimumVersion = '8.3'

Definition at line 45 of file PostgresInstaller.php.

PostgresInstaller::$pgConns = array() [protected]

Definition at line 48 of file PostgresInstaller.php.

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

includes/installer/PostgresInstaller.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation