/**
* PostgreSQL-specific installer.
*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
* @file
* @ingroup Deployment
*/
+use Wikimedia\Rdbms\Database;
+use Wikimedia\Rdbms\DBQueryError;
+use Wikimedia\Rdbms\DBConnectionError;
+
/**
* Class for setting up the MediaWiki database using Postgres.
*
*/
class PostgresInstaller extends DatabaseInstaller {
- protected $globalNames = array(
+ protected $globalNames = [
'wgDBserver',
'wgDBport',
'wgDBname',
'wgDBuser',
'wgDBpassword',
'wgDBmwschema',
- );
+ ];
- protected $internalDefaults = array(
+ protected $internalDefaults = [
'_InstallUser' => 'postgres',
- );
+ ];
- var $minimumVersion = '8.3';
- var $maxRoleSearchDepth = 5;
+ public static $minimumVersion = '9.1';
+ protected static $notMiniumumVerisonMessage = 'config-postgres-old';
+ public $maxRoleSearchDepth = 5;
- protected $pgConns = array();
+ protected $pgConns = [];
function getName() {
return 'postgres';
}
function getConnectForm() {
- return
- $this->getTextBox( 'wgDBserver', 'config-db-host', array(), $this->parent->getHelpBox( 'config-db-host-help' ) ) .
+ return $this->getTextBox(
+ 'wgDBserver',
+ 'config-db-host',
+ [],
+ $this->parent->getHelpBox( 'config-db-host-help' )
+ ) .
$this->getTextBox( 'wgDBport', 'config-db-port' ) .
Html::openElement( 'fieldset' ) .
- Html::element( 'legend', array(), wfMsg( 'config-db-wiki-settings' ) ) .
- $this->getTextBox( 'wgDBname', 'config-db-name', array(), $this->parent->getHelpBox( 'config-db-name-help' ) ) .
- $this->getTextBox( 'wgDBmwschema', 'config-db-schema', array(), $this->parent->getHelpBox( 'config-db-schema-help' ) ) .
+ Html::element( 'legend', [], wfMessage( 'config-db-wiki-settings' )->text() ) .
+ $this->getTextBox(
+ 'wgDBname',
+ 'config-db-name',
+ [],
+ $this->parent->getHelpBox( 'config-db-name-help' )
+ ) .
+ $this->getTextBox(
+ 'wgDBmwschema',
+ 'config-db-schema',
+ [],
+ $this->parent->getHelpBox( 'config-db-schema-help' )
+ ) .
Html::closeElement( 'fieldset' ) .
$this->getInstallUserBox();
}
function submitConnectForm() {
// Get variables from the request
- $newValues = $this->setVarsFromRequest( array( 'wgDBserver', 'wgDBport',
- 'wgDBname', 'wgDBmwschema' ) );
+ $newValues = $this->setVarsFromRequest( [
+ 'wgDBserver',
+ 'wgDBport',
+ 'wgDBname',
+ 'wgDBmwschema'
+ ] );
// Validate them
$status = Status::newGood();
if ( !$status->isOK() ) {
return $status;
}
+ /**
+ * @var $conn Database
+ */
$conn = $status->value;
// Check version
$version = $conn->getServerVersion();
- if ( version_compare( $version, $this->minimumVersion ) < 0 ) {
- return Status::newFatal( 'config-postgres-old', $this->minimumVersion, $version );
+ $status = static::meetsMinimumRequirement( $conn->getServerVersion() );
+ if ( !$status->isOK() ) {
+ return $status;
}
$this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
$this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
+
return Status::newGood();
}
if ( $status->isOK() ) {
$this->db = $status->value;
}
+
return $status;
}
/**
* Open a PG connection with given parameters
- * @param $user User name
- * @param $password Password
- * @param $dbName Database name
+ * @param string $user User name
+ * @param string $password Password
+ * @param string $dbName Database name
+ * @param string $schema Database schema
* @return Status
*/
- protected function openConnectionWithParams( $user, $password, $dbName ) {
+ protected function openConnectionWithParams( $user, $password, $dbName, $schema ) {
$status = Status::newGood();
try {
- $GLOBALS['wgDBport'] = $this->getVar( 'wgDBport' );
- $db = new DatabasePostgres(
- $this->getVar( 'wgDBserver' ),
- $user,
- $password,
- $dbName);
+ $db = Database::factory( 'postgres', [
+ 'host' => $this->getVar( 'wgDBserver' ),
+ 'port' => $this->getVar( 'wgDBport' ),
+ 'user' => $user,
+ 'password' => $password,
+ 'dbname' => $dbName,
+ 'schema' => $schema,
+ 'keywordTableMap' => [ 'user' => 'mwuser', 'text' => 'pagecontent' ],
+ ] );
$status->value = $db;
} catch ( DBConnectionError $e ) {
$status->fatal( 'config-connection-error', $e->getMessage() );
}
+
return $status;
}
/**
* Get a special type of connection
- * @param $type See openPgConnection() for details.
+ * @param string $type See openPgConnection() for details.
* @return Status
*/
protected function getPgConnection( $type ) {
$status = $this->openPgConnection( $type );
if ( $status->isOK() ) {
+ /**
+ * @var $conn Database
+ */
$conn = $status->value;
$conn->clearFlag( DBO_TRX );
- $conn->commit();
+ $conn->commit( __METHOD__ );
$this->pgConns[$type] = $conn;
}
+
return $status;
}
* 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.
+ * 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
+ * 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.
*
- * @param $type The type of connection to get:
+ * @param 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
+ * - 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.
*
- * @return A Status object. On success, a connection object will be in the
- * value member.
+ * @throws MWException
+ * @return Status On success, a connection object will be in the value member.
*/
protected function openPgConnection( $type ) {
switch ( $type ) {
case 'create-db':
return $this->openConnectionToAnyDB(
- $this->getVar( '_InstallUser' ),
+ $this->getVar( '_InstallUser' ),
$this->getVar( '_InstallPassword' ) );
case 'create-schema':
- return $this->openConnectionWithParams(
+ return $this->openConnectionWithParams(
$this->getVar( '_InstallUser' ),
$this->getVar( '_InstallPassword' ),
- $this->getVar( 'wgDBname' ) );
+ $this->getVar( 'wgDBname' ),
+ $this->getVar( 'wgDBmwschema' ) );
case 'create-tables':
$status = $this->openPgConnection( 'create-schema' );
if ( $status->isOK() ) {
+ /**
+ * @var $conn Database
+ */
$conn = $status->value;
$safeRole = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
$conn->query( "SET ROLE $safeRole" );
}
+
return $status;
default:
throw new MWException( "Invalid special connection type: \"$type\"" );
}
public function openConnectionToAnyDB( $user, $password ) {
- $dbs = array(
+ $dbs = [
'template1',
'postgres',
- );
+ ];
if ( !in_array( $this->getVar( 'wgDBname' ), $dbs ) ) {
array_unshift( $dbs, $this->getVar( 'wgDBname' ) );
}
+ $conn = false;
$status = Status::newGood();
foreach ( $dbs as $db ) {
try {
- $GLOBALS['wgDBport'] = $this->getVar( 'wgDBport' );
- $conn = new DatabasePostgres(
- $this->getVar( 'wgDBserver' ),
- $user,
- $password,
- $db );
+ $p = [
+ 'host' => $this->getVar( 'wgDBserver' ),
+ 'user' => $user,
+ 'password' => $password,
+ 'dbname' => $db
+ ];
+ $conn = Database::factory( 'postgres', $p );
} catch ( DBConnectionError $error ) {
$conn = false;
$status->fatal( 'config-pg-test-error', $db,
if ( !$status->isOK() ) {
return false;
}
+ /**
+ * @var $conn Database
+ */
$conn = $status->value;
$superuser = $this->getVar( '_InstallUser' );
- $row = $conn->selectRow( '"pg_catalog"."pg_roles"', '*',
- array( 'rolname' => $superuser ), __METHOD__ );
+ $row = $conn->selectRow( '"pg_catalog"."pg_roles"', '*',
+ [ 'rolname' => $superuser ], __METHOD__ );
+
return $row;
}
if ( !$perms ) {
return false;
}
+
return $perms->rolsuper === 't' || $perms->rolcreaterole === 't';
}
if ( !$perms ) {
return false;
}
- return $perms->rolsuper === 't';
+
+ return $perms->rolsuper === 't';
}
public function getSettingsForm() {
} else {
$msg = 'config-install-user-missing';
}
+
return Status::newFatal( $msg, $this->getVar( 'wgDBuser' ) );
}
}
// Existing web account. Test the connection.
- $status = $this->openConnectionToAnyDB(
+ $status = $this->openConnectionToAnyDB(
$this->getVar( 'wgDBuser' ),
$this->getVar( 'wgDBpassword' ) );
if ( !$status->isOK() ) {
return $status;
}
- // The web user is conventionally the table owner in PostgreSQL
- // installations. Make sure the install user is able to create
+ // The web user is conventionally the table owner in PostgreSQL
+ // installations. Make sure the install user is able to create
// objects on behalf of the web user.
if ( $same || $this->canCreateObjectsForWebUser() ) {
return Status::newGood();
/**
* Returns true if the install user is able to create objects owned
* by the web user, false otherwise.
+ * @return bool
*/
protected function canCreateObjectsForWebUser() {
if ( $this->isSuperUser() ) {
}
$conn = $status->value;
$installerId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
- array( 'rolname' => $this->getVar( '_InstallUser' ) ), __METHOD__ );
+ [ 'rolname' => $this->getVar( '_InstallUser' ) ], __METHOD__ );
$webId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
- array( 'rolname' => $this->getVar( 'wgDBuser' ) ), __METHOD__ );
+ [ 'rolname' => $this->getVar( 'wgDBuser' ) ], __METHOD__ );
return $this->isRoleMember( $conn, $installerId, $webId, $this->maxRoleSearchDepth );
}
/**
* Recursive helper for canCreateObjectsForWebUser().
- * @param $conn Database object
- * @param $targetMember Role ID of the member to look for
- * @param $group Role ID of the group to look for
- * @param $maxDepth Maximum recursive search depth
+ * @param Database $conn
+ * @param int $targetMember Role ID of the member to look for
+ * @param int $group Role ID of the group to look for
+ * @param int $maxDepth Maximum recursive search depth
+ * @return bool
*/
protected function isRoleMember( $conn, $targetMember, $group, $maxDepth ) {
if ( $targetMember === $group ) {
return true;
}
// Get all members of the given group
- $res = $conn->select( '"pg_catalog"."pg_auth_members"', array( 'member' ),
- array( 'roleid' => $group ), __METHOD__ );
+ $res = $conn->select( '"pg_catalog"."pg_auth_members"', [ 'member' ],
+ [ 'roleid' => $group ], __METHOD__ );
foreach ( $res as $row ) {
if ( $row->member == $targetMember ) {
// Found target member
}
}
}
+
return false;
}
public function preInstall() {
- $commitCB = array(
+ $createDbAccount = [
+ 'name' => 'user',
+ 'callback' => [ $this, 'setupUser' ],
+ ];
+ $commitCB = [
'name' => 'pg-commit',
- 'callback' => array( $this, 'commitChanges' ),
- );
- $plpgCB = array(
+ 'callback' => [ $this, 'commitChanges' ],
+ ];
+ $plpgCB = [
'name' => 'pg-plpgsql',
- 'callback' => array( $this, 'setupPLpgSQL' ),
- );
- $schemaCB = array(
+ 'callback' => [ $this, 'setupPLpgSQL' ],
+ ];
+ $schemaCB = [
'name' => 'schema',
- 'callback' => array( $this, 'setupSchema' )
- );
+ 'callback' => [ $this, 'setupSchema' ]
+ ];
+
+ if ( $this->getVar( '_CreateDBAccount' ) ) {
+ $this->parent->addInstallStep( $createDbAccount, 'database' );
+ }
$this->parent->addInstallStep( $commitCB, 'interwiki' );
$this->parent->addInstallStep( $plpgCB, 'database' );
$this->parent->addInstallStep( $schemaCB, 'database' );
- if( $this->getVar( '_CreateDBAccount' ) ) {
- $this->parent->addInstallStep( array(
- 'name' => 'user',
- 'callback' => array( $this, 'setupUser' ),
- ) );
- }
}
function setupDatabase() {
$conn = $status->value;
$dbName = $this->getVar( 'wgDBname' );
- $schema = $this->getVar( 'wgDBmwschema' );
- $user = $this->getVar( 'wgDBuser' );
- $safeschema = $conn->addIdentifierQuotes( $schema );
- $safeuser = $conn->addIdentifierQuotes( $user );
$exists = $conn->selectField( '"pg_catalog"."pg_database"', '1',
- array( 'datname' => $dbName ), __METHOD__ );
+ [ 'datname' => $dbName ], __METHOD__ );
if ( !$exists ) {
$safedb = $conn->addIdentifierQuotes( $dbName );
$conn->query( "CREATE DATABASE $safedb", __METHOD__ );
}
+
return Status::newGood();
}
$schema = $this->getVar( 'wgDBmwschema' );
$safeschema = $conn->addIdentifierQuotes( $schema );
$safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
- if( !$conn->schemaExists( $schema ) ) {
+ if ( !$conn->schemaExists( $schema ) ) {
try {
$conn->query( "CREATE SCHEMA $safeschema AUTHORIZATION $safeuser" );
} catch ( DBQueryError $e ) {
- return Status::newFatal( 'config-install-pg-schema-failed',
+ return Status::newFatal( 'config-install-pg-schema-failed',
$this->getVar( '_InstallUser' ), $schema );
}
}
- // If we created a user, alter it now to search the new schema by default
- if ( $this->getVar( '_CreateDBAccount' ) ) {
- $conn->query( "ALTER ROLE $safeuser SET search_path = $safeschema, public",
- __METHOD__ );
- }
-
// Select the new schema in the current connection
- $conn->query( "SET search_path = $safeschema" );
+ $conn->determineCoreSchema( $schema );
+
return Status::newGood();
}
function commitChanges() {
- $this->db->query( 'COMMIT' );
+ $this->db->commit( __METHOD__ );
+
return Status::newGood();
}
}
$conn = $status->value;
- $schema = $this->getVar( 'wgDBmwschema' );
$safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
$safepass = $conn->addQuotes( $this->getVar( 'wgDBpassword' ) );
- $safeschema = $conn->addIdentifierQuotes( $schema );
// Check if the user already exists
$userExists = $conn->roleExists( $this->getVar( 'wgDBuser' ) );
// Create the user
try {
$sql = "CREATE ROLE $safeuser NOCREATEDB LOGIN PASSWORD $safepass";
-
- // If the install user is not a superuser, we need to make the install
+
+ // If the install user is not a superuser, we need to make the install
// user a member of the new user's group, so that the install user will
// be able to create a schema and other objects on behalf of the new user.
if ( !$this->isSuperUser() ) {
$conn->query( $sql, __METHOD__ );
} catch ( DBQueryError $e ) {
- return Status::newFatal( 'config-install-user-create-failed',
+ return Status::newFatal( 'config-install-user-create-failed',
$this->getVar( 'wgDBuser' ), $e->getMessage() );
}
}
function getLocalSettings() {
$port = $this->getVar( 'wgDBport' );
$schema = $this->getVar( 'wgDBmwschema' );
- return
-"# Postgres specific settings
-\$wgDBport = \"{$port}\";
-\$wgDBmwschema = \"{$schema}\";";
+
+ return "# Postgres specific settings
+\$wgDBport = \"{$port}\";
+\$wgDBmwschema = \"{$schema}\";";
}
public function preUpgrade() {
if ( !$status->isOK() ) {
return $status;
}
+
+ /** @var DatabasePostgres $conn */
$conn = $status->value;
- if( $conn->tableExists( 'user' ) ) {
+ if ( $conn->tableExists( 'archive' ) ) {
$status->warning( 'config-install-tables-exist' );
+ $this->enableLB();
+
return $status;
}
$conn->begin( __METHOD__ );
- if( !$conn->schemaExists( $schema ) ) {
+ if ( !$conn->schemaExists( $schema ) ) {
$status->fatal( 'config-install-pg-schema-not-exist' );
+
return $status;
}
- $error = $conn->sourceFile( $conn->getSchema() );
- if( $error !== true ) {
+ $error = $conn->sourceFile( $this->getSchemaPath( $conn ) );
+ if ( $error !== true ) {
$conn->reportQueryError( $error, 0, '', __METHOD__ );
$conn->rollback( __METHOD__ );
$status->fatal( 'config-install-tables-failed', $error );
$conn->commit( __METHOD__ );
}
// Resume normal operations
- if( $status->isOk() ) {
+ if ( $status->isOK() ) {
$this->enableLB();
}
+
return $status;
}
+ public function getGlobalDefaults() {
+ // The default $wgDBmwschema is null, which breaks Postgres and other DBMSes that require
+ // the use of a schema, so we need to set it here
+ return array_merge( parent::getGlobalDefaults(), [
+ 'wgDBmwschema' => 'mediawiki',
+ ] );
+ }
+
public function setupPLpgSQL() {
- // Connect as the install user, since it owns the database and so is
+ // Connect as the install user, since it owns the database and so is
// the user that needs to run "CREATE LANGAUGE"
$status = $this->getPgConnection( 'create-schema' );
if ( !$status->isOK() ) {
return $status;
}
+ /**
+ * @var $conn Database
+ */
$conn = $status->value;
$exists = $conn->selectField( '"pg_catalog"."pg_language"', 1,
- array( 'lanname' => 'plpgsql' ), __METHOD__ );
+ [ 'lanname' => 'plpgsql' ], __METHOD__ );
if ( $exists ) {
// Already exists, nothing to do
return Status::newGood();
}
- // plpgsql is not installed, but if we have a pg_pltemplate table, we
+ // plpgsql is not installed, but if we have a pg_pltemplate table, we
// should be able to create it
$exists = $conn->selectField(
- array( '"pg_catalog"."pg_class"', '"pg_catalog"."pg_namespace"' ),
+ [ '"pg_catalog"."pg_class"', '"pg_catalog"."pg_namespace"' ],
1,
- array(
+ [
'pg_namespace.oid=relnamespace',
'nspname' => 'pg_catalog',
'relname' => 'pg_pltemplate',
- ),
+ ],
__METHOD__ );
if ( $exists ) {
try {
} else {
return Status::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
}
+
return Status::newGood();
}
}
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff