3 * PostgreSQL-specific installer.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use Wikimedia\Rdbms\Database
;
25 use Wikimedia\Rdbms\DBQueryError
;
26 use Wikimedia\Rdbms\DBConnectionError
;
29 * Class for setting up the MediaWiki database using Postgres.
34 class PostgresInstaller
extends DatabaseInstaller
{
36 protected $globalNames = [
45 protected $internalDefaults = [
46 '_InstallUser' => 'postgres',
49 public static $minimumVersion = '9.2';
50 protected static $notMinimumVersionMessage = 'config-postgres-old';
51 public $maxRoleSearchDepth = 5;
53 protected $pgConns = [];
59 public function isCompiled() {
60 return self
::checkExtension( 'pgsql' );
63 function getConnectForm() {
64 return $this->getTextBox(
68 $this->parent
->getHelpBox( 'config-db-host-help' )
70 $this->getTextBox( 'wgDBport', 'config-db-port' ) .
71 Html
::openElement( 'fieldset' ) .
72 Html
::element( 'legend', [], wfMessage( 'config-db-wiki-settings' )->text() ) .
77 $this->parent
->getHelpBox( 'config-db-name-help' )
83 $this->parent
->getHelpBox( 'config-db-schema-help' )
85 Html
::closeElement( 'fieldset' ) .
86 $this->getInstallUserBox();
89 function submitConnectForm() {
90 // Get variables from the request
91 $newValues = $this->setVarsFromRequest( [
99 $status = Status
::newGood();
100 if ( !strlen( $newValues['wgDBname'] ) ) {
101 $status->fatal( 'config-missing-db-name' );
102 } elseif ( !preg_match( '/^[a-zA-Z0-9_]+$/', $newValues['wgDBname'] ) ) {
103 $status->fatal( 'config-invalid-db-name', $newValues['wgDBname'] );
105 if ( !preg_match( '/^[a-zA-Z0-9_]*$/', $newValues['wgDBmwschema'] ) ) {
106 $status->fatal( 'config-invalid-schema', $newValues['wgDBmwschema'] );
110 if ( $status->isOK() ) {
111 $status->merge( $this->submitInstallUserBox() );
113 if ( !$status->isOK() ) {
117 $status = $this->getPgConnection( 'create-db' );
118 if ( !$status->isOK() ) {
122 * @var Database $conn
124 $conn = $status->value
;
127 $version = $conn->getServerVersion();
128 $status = static::meetsMinimumRequirement( $version );
129 if ( !$status->isOK() ) {
133 $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
134 $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
136 return Status
::newGood();
139 public function getConnection() {
140 $status = $this->getPgConnection( 'create-tables' );
141 if ( $status->isOK() ) {
142 $this->db
= $status->value
;
148 public function openConnection() {
149 return $this->openPgConnection( 'create-tables' );
153 * Open a PG connection with given parameters
154 * @param string $user User name
155 * @param string $password
156 * @param string $dbName Database name
157 * @param string $schema Database schema
160 protected function openConnectionWithParams( $user, $password, $dbName, $schema ) {
161 $status = Status
::newGood();
163 $db = Database
::factory( 'postgres', [
164 'host' => $this->getVar( 'wgDBserver' ),
165 'port' => $this->getVar( 'wgDBport' ),
167 'password' => $password,
170 'keywordTableMap' => [ 'user' => 'mwuser', 'text' => 'pagecontent' ],
172 $status->value
= $db;
173 } catch ( DBConnectionError
$e ) {
174 $status->fatal( 'config-connection-error', $e->getMessage() );
181 * Get a special type of connection
182 * @param string $type See openPgConnection() for details.
185 protected function getPgConnection( $type ) {
186 if ( isset( $this->pgConns
[$type] ) ) {
187 return Status
::newGood( $this->pgConns
[$type] );
189 $status = $this->openPgConnection( $type );
191 if ( $status->isOK() ) {
193 * @var Database $conn
195 $conn = $status->value
;
196 $conn->clearFlag( DBO_TRX
);
197 $conn->commit( __METHOD__
);
198 $this->pgConns
[$type] = $conn;
205 * Get a connection of a specific PostgreSQL-specific type. Connections
206 * of a given type are cached.
208 * PostgreSQL lacks cross-database operations, so after the new database is
209 * created, you need to make a separate connection to connect to that
210 * database and add tables to it.
212 * New tables are owned by the user that creates them, and MediaWiki's
213 * PostgreSQL support has always assumed that the table owner will be
214 * $wgDBuser. So before we create new tables, we either need to either
215 * connect as the other user or to execute a SET ROLE command. Using a
216 * separate connection for this allows us to avoid accidental cross-module
219 * @param string $type The type of connection to get:
220 * - create-db: A connection for creating DBs, suitable for pre-
222 * - create-schema: A connection to the new DB, for creating schemas and
223 * other similar objects in the new DB.
224 * - create-tables: A connection with a role suitable for creating tables.
226 * @throws MWException
227 * @return Status On success, a connection object will be in the value member.
229 protected function openPgConnection( $type ) {
232 return $this->openConnectionToAnyDB(
233 $this->getVar( '_InstallUser' ),
234 $this->getVar( '_InstallPassword' ) );
235 case 'create-schema':
236 return $this->openConnectionWithParams(
237 $this->getVar( '_InstallUser' ),
238 $this->getVar( '_InstallPassword' ),
239 $this->getVar( 'wgDBname' ),
240 $this->getVar( 'wgDBmwschema' ) );
241 case 'create-tables':
242 $status = $this->openPgConnection( 'create-schema' );
243 if ( $status->isOK() ) {
245 * @var Database $conn
247 $conn = $status->value
;
248 $safeRole = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
249 $conn->query( "SET ROLE $safeRole" );
254 throw new MWException( "Invalid special connection type: \"$type\"" );
258 public function openConnectionToAnyDB( $user, $password ) {
263 if ( !in_array( $this->getVar( 'wgDBname' ), $dbs ) ) {
264 array_unshift( $dbs, $this->getVar( 'wgDBname' ) );
267 $status = Status
::newGood();
268 foreach ( $dbs as $db ) {
271 'host' => $this->getVar( 'wgDBserver' ),
273 'password' => $password,
276 $conn = Database
::factory( 'postgres', $p );
277 } catch ( DBConnectionError
$error ) {
279 $status->fatal( 'config-pg-test-error', $db,
280 $error->getMessage() );
282 if ( $conn !== false ) {
286 if ( $conn !== false ) {
287 return Status
::newGood( $conn );
293 protected function getInstallUserPermissions() {
294 $status = $this->getPgConnection( 'create-db' );
295 if ( !$status->isOK() ) {
299 * @var Database $conn
301 $conn = $status->value
;
302 $superuser = $this->getVar( '_InstallUser' );
304 $row = $conn->selectRow( '"pg_catalog"."pg_roles"', '*',
305 [ 'rolname' => $superuser ], __METHOD__
);
310 protected function canCreateAccounts() {
311 $perms = $this->getInstallUserPermissions();
316 return $perms->rolsuper
=== 't' ||
$perms->rolcreaterole
=== 't';
319 protected function isSuperUser() {
320 $perms = $this->getInstallUserPermissions();
325 return $perms->rolsuper
=== 't';
328 public function getSettingsForm() {
329 if ( $this->canCreateAccounts() ) {
330 $noCreateMsg = false;
332 $noCreateMsg = 'config-db-web-no-create-privs';
334 $s = $this->getWebUserBox( $noCreateMsg );
339 public function submitSettingsForm() {
340 $status = $this->submitWebUserBox();
341 if ( !$status->isOK() ) {
345 $same = $this->getVar( 'wgDBuser' ) === $this->getVar( '_InstallUser' );
350 // Check if the web user exists
351 // Connect to the database with the install user
352 $status = $this->getPgConnection( 'create-db' );
353 if ( !$status->isOK() ) {
356 // @phan-suppress-next-line PhanUndeclaredMethod
357 $exists = $status->value
->roleExists( $this->getVar( 'wgDBuser' ) );
360 // Validate the create checkbox
361 if ( $this->canCreateAccounts() && !$same && !$exists ) {
362 $create = $this->getVar( '_CreateDBAccount' );
364 $this->setVar( '_CreateDBAccount', false );
368 if ( !$create && !$exists ) {
369 if ( $this->canCreateAccounts() ) {
370 $msg = 'config-install-user-missing-create';
372 $msg = 'config-install-user-missing';
375 return Status
::newFatal( $msg, $this->getVar( 'wgDBuser' ) );
379 // No more checks to do
380 return Status
::newGood();
383 // Existing web account. Test the connection.
384 $status = $this->openConnectionToAnyDB(
385 $this->getVar( 'wgDBuser' ),
386 $this->getVar( 'wgDBpassword' ) );
387 if ( !$status->isOK() ) {
391 // The web user is conventionally the table owner in PostgreSQL
392 // installations. Make sure the install user is able to create
393 // objects on behalf of the web user.
394 if ( $same ||
$this->canCreateObjectsForWebUser() ) {
395 return Status
::newGood();
397 return Status
::newFatal( 'config-pg-not-in-role' );
402 * Returns true if the install user is able to create objects owned
403 * by the web user, false otherwise.
406 protected function canCreateObjectsForWebUser() {
407 if ( $this->isSuperUser() ) {
411 $status = $this->getPgConnection( 'create-db' );
412 if ( !$status->isOK() ) {
415 $conn = $status->value
;
416 $installerId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
417 [ 'rolname' => $this->getVar( '_InstallUser' ) ], __METHOD__
);
418 $webId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
419 [ 'rolname' => $this->getVar( 'wgDBuser' ) ], __METHOD__
);
421 return $this->isRoleMember( $conn, $installerId, $webId, $this->maxRoleSearchDepth
);
425 * Recursive helper for canCreateObjectsForWebUser().
426 * @param Database $conn
427 * @param int $targetMember Role ID of the member to look for
428 * @param int $group Role ID of the group to look for
429 * @param int $maxDepth Maximum recursive search depth
432 protected function isRoleMember( $conn, $targetMember, $group, $maxDepth ) {
433 if ( $targetMember === $group ) {
434 // A role is always a member of itself
437 // Get all members of the given group
438 $res = $conn->select( '"pg_catalog"."pg_auth_members"', [ 'member' ],
439 [ 'roleid' => $group ], __METHOD__
);
440 foreach ( $res as $row ) {
441 if ( $row->member
== $targetMember ) {
442 // Found target member
445 // Recursively search each member of the group to see if the target
446 // is a member of it, up to the given maximum depth.
447 if ( $maxDepth > 0 &&
448 $this->isRoleMember( $conn, $targetMember, $row->member
, $maxDepth - 1 )
450 // Found member of member
458 public function preInstall() {
461 'callback' => [ $this, 'setupUser' ],
464 'name' => 'pg-commit',
465 'callback' => [ $this, 'commitChanges' ],
468 'name' => 'pg-plpgsql',
469 'callback' => [ $this, 'setupPLpgSQL' ],
473 'callback' => [ $this, 'setupSchema' ]
476 if ( $this->getVar( '_CreateDBAccount' ) ) {
477 $this->parent
->addInstallStep( $createDbAccount, 'database' );
479 $this->parent
->addInstallStep( $commitCB, 'interwiki' );
480 $this->parent
->addInstallStep( $plpgCB, 'database' );
481 $this->parent
->addInstallStep( $schemaCB, 'database' );
484 function setupDatabase() {
485 $status = $this->getPgConnection( 'create-db' );
486 if ( !$status->isOK() ) {
489 $conn = $status->value
;
491 $dbName = $this->getVar( 'wgDBname' );
493 $exists = $conn->selectField( '"pg_catalog"."pg_database"', '1',
494 [ 'datname' => $dbName ], __METHOD__
);
496 $safedb = $conn->addIdentifierQuotes( $dbName );
497 $conn->query( "CREATE DATABASE $safedb", __METHOD__
);
500 return Status
::newGood();
503 function setupSchema() {
504 // Get a connection to the target database
505 $status = $this->getPgConnection( 'create-schema' );
506 if ( !$status->isOK() ) {
509 /** @var DatabasePostgres $conn */
510 $conn = $status->value
;
511 '@phan-var DatabasePostgres $conn';
513 // Create the schema if necessary
514 $schema = $this->getVar( 'wgDBmwschema' );
515 $safeschema = $conn->addIdentifierQuotes( $schema );
516 $safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
517 if ( !$conn->schemaExists( $schema ) ) {
519 $conn->query( "CREATE SCHEMA $safeschema AUTHORIZATION $safeuser" );
520 } catch ( DBQueryError
$e ) {
521 return Status
::newFatal( 'config-install-pg-schema-failed',
522 $this->getVar( '_InstallUser' ), $schema );
526 // Select the new schema in the current connection
527 $conn->determineCoreSchema( $schema );
529 return Status
::newGood();
532 function commitChanges() {
533 $this->db
->commit( __METHOD__
);
535 return Status
::newGood();
538 function setupUser() {
539 if ( !$this->getVar( '_CreateDBAccount' ) ) {
540 return Status
::newGood();
543 $status = $this->getPgConnection( 'create-db' );
544 if ( !$status->isOK() ) {
547 /** @var DatabasePostgres $conn */
548 $conn = $status->value
;
549 '@phan-var DatabasePostgres $conn';
551 $safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
552 $safepass = $conn->addQuotes( $this->getVar( 'wgDBpassword' ) );
554 // Check if the user already exists
555 $userExists = $conn->roleExists( $this->getVar( 'wgDBuser' ) );
556 if ( !$userExists ) {
559 $sql = "CREATE ROLE $safeuser NOCREATEDB LOGIN PASSWORD $safepass";
561 // If the install user is not a superuser, we need to make the install
562 // user a member of the new user's group, so that the install user will
563 // be able to create a schema and other objects on behalf of the new user.
564 if ( !$this->isSuperUser() ) {
565 $sql .= ' ROLE' . $conn->addIdentifierQuotes( $this->getVar( '_InstallUser' ) );
568 $conn->query( $sql, __METHOD__
);
569 } catch ( DBQueryError
$e ) {
570 return Status
::newFatal( 'config-install-user-create-failed',
571 $this->getVar( 'wgDBuser' ), $e->getMessage() );
575 return Status
::newGood();
578 function getLocalSettings() {
579 $port = $this->getVar( 'wgDBport' );
580 $schema = $this->getVar( 'wgDBmwschema' );
582 return "# Postgres specific settings
583 \$wgDBport = \"{$port}\";
584 \$wgDBmwschema = \"{$schema}\";";
587 public function preUpgrade() {
588 global $wgDBuser, $wgDBpassword;
590 # Normal user and password are selected after this step, so for now
591 # just copy these two
592 $wgDBuser = $this->getVar( '_InstallUser' );
593 $wgDBpassword = $this->getVar( '_InstallPassword' );
596 public function createTables() {
597 $schema = $this->getVar( 'wgDBmwschema' );
599 $status = $this->getConnection();
600 if ( !$status->isOK() ) {
604 /** @var DatabasePostgres $conn */
605 $conn = $status->value
;
606 '@phan-var DatabasePostgres $conn';
608 if ( $conn->tableExists( 'archive' ) ) {
609 $status->warning( 'config-install-tables-exist' );
615 $conn->begin( __METHOD__
);
617 if ( !$conn->schemaExists( $schema ) ) {
618 $status->fatal( 'config-install-pg-schema-not-exist' );
622 $error = $conn->sourceFile( $this->getSchemaPath( $conn ) );
623 if ( $error !== true ) {
624 $conn->reportQueryError( $error, 0, '', __METHOD__
);
625 $conn->rollback( __METHOD__
);
626 $status->fatal( 'config-install-tables-failed', $error );
628 $conn->commit( __METHOD__
);
630 // Resume normal operations
631 if ( $status->isOK() ) {
638 public function getGlobalDefaults() {
639 // The default $wgDBmwschema is null, which breaks Postgres and other DBMSes that require
640 // the use of a schema, so we need to set it here
641 return array_merge( parent
::getGlobalDefaults(), [
642 'wgDBmwschema' => 'mediawiki',
646 public function setupPLpgSQL() {
647 // Connect as the install user, since it owns the database and so is
648 // the user that needs to run "CREATE LANGUAGE"
649 $status = $this->getPgConnection( 'create-schema' );
650 if ( !$status->isOK() ) {
654 * @var Database $conn
656 $conn = $status->value
;
658 $exists = $conn->selectField( '"pg_catalog"."pg_language"', 1,
659 [ 'lanname' => 'plpgsql' ], __METHOD__
);
661 // Already exists, nothing to do
662 return Status
::newGood();
665 // plpgsql is not installed, but if we have a pg_pltemplate table, we
666 // should be able to create it
667 $exists = $conn->selectField(
668 [ '"pg_catalog"."pg_class"', '"pg_catalog"."pg_namespace"' ],
671 'pg_namespace.oid=relnamespace',
672 'nspname' => 'pg_catalog',
673 'relname' => 'pg_pltemplate',
678 $conn->query( 'CREATE LANGUAGE plpgsql' );
679 } catch ( DBQueryError
$e ) {
680 return Status
::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
683 return Status
::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
686 return Status
::newGood();