update to MediaWiki 1.17.0

1 files changed, 601 insertions, 0 deletions

diff --git a/includes/installer/PostgresInstaller.php b/includes/installer/PostgresInstaller.php
new file mode 100644
index 00000000..20575b62
--- /dev/null
+++ b/includes/installer/PostgresInstaller.php
@@ -0,0 +1,601 @@
+<?php
+/**
+ * PostgreSQL-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+
+/**
+ * Class for setting up the MediaWiki database using Postgres.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
+class PostgresInstaller extends DatabaseInstaller {
+
+	protected $globalNames = array(
+		'wgDBserver',
+		'wgDBport',
+		'wgDBname',
+		'wgDBuser',
+		'wgDBpassword',
+		'wgDBmwschema',
+	);
+
+	protected $internalDefaults = array(
+		'_InstallUser' => 'postgres',
+	);
+
+	var $minimumVersion = '8.3';
+	var $maxRoleSearchDepth = 5;
+
+	protected $pgConns = array();
+
+	function getName() {
+		return 'postgres';
+	}
+
+	public function isCompiled() {
+		return self::checkExtension( 'pgsql' );
+	}
+
+	function getConnectForm() {
+		return
+			$this->getTextBox( 'wgDBserver', 'config-db-host', array(), $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::closeElement( 'fieldset' ) .
+			$this->getInstallUserBox();
+	}
+
+	function submitConnectForm() {
+		// Get variables from the request
+		$newValues = $this->setVarsFromRequest( array( 'wgDBserver', 'wgDBport',
+			'wgDBname', 'wgDBmwschema' ) );
+
+		// Validate them
+		$status = Status::newGood();
+		if ( !strlen( $newValues['wgDBname'] ) ) {
+			$status->fatal( 'config-missing-db-name' );
+		} elseif ( !preg_match( '/^[a-zA-Z0-9_]+$/', $newValues['wgDBname'] ) ) {
+			$status->fatal( 'config-invalid-db-name', $newValues['wgDBname'] );
+		}
+		if ( !preg_match( '/^[a-zA-Z0-9_]*$/', $newValues['wgDBmwschema'] ) ) {
+			$status->fatal( 'config-invalid-schema', $newValues['wgDBmwschema'] );
+		}
+
+		// Submit user box
+		if ( $status->isOK() ) {
+			$status->merge( $this->submitInstallUserBox() );
+		}
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+
+		$status = $this->getPgConnection( 'create-db' );
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+		$conn = $status->value;
+
+		// Check version
+		$version = $conn->getServerVersion();
+		if ( version_compare( $version, $this->minimumVersion ) < 0 ) {
+			return Status::newFatal( 'config-postgres-old', $this->minimumVersion, $version );
+		}
+
+		$this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
+		$this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
+		return Status::newGood();
+	}
+
+	public function getConnection() {
+		$status = $this->getPgConnection( 'create-tables' );
+		if ( $status->isOK() ) {
+			$this->db = $status->value;
+		}
+		return $status;
+	}
+
+	public function openConnection() {
+		return $this->openPgConnection( 'create-tables' );
+	}
+
+	/**
+	 * Open a PG connection with given parameters
+	 * @param $user User name
+	 * @param $password Password
+	 * @param $dbName Database name
+	 * @return Status
+	 */
+	protected function openConnectionWithParams( $user, $password, $dbName ) {
+		$status = Status::newGood();
+		try {
+			$GLOBALS['wgDBport'] = $this->getVar( 'wgDBport' );
+			$db = new DatabasePostgres(
+				$this->getVar( 'wgDBserver' ),
+				$user,
+				$password,
+				$dbName);
+			$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.
+	 * @return Status
+	 */
+	protected function getPgConnection( $type ) {
+		if ( isset( $this->pgConns[$type] ) ) {
+			return Status::newGood( $this->pgConns[$type] );
+		}
+		$status = $this->openPgConnection( $type );
+
+		if ( $status->isOK() ) {
+			$conn = $status->value;
+			$conn->clearFlag( DBO_TRX );
+			$conn->commit();
+			$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. 
+	 *
+	 * 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:
+	 *    - 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.
+	 *
+	 * @return A Status object. 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( '_InstallPassword' ) );
+			case 'create-schema':
+				return $this->openConnectionWithParams( 
+					$this->getVar( '_InstallUser' ),
+					$this->getVar( '_InstallPassword' ),
+					$this->getVar( 'wgDBname' ) );
+			case 'create-tables':
+				$status = $this->openPgConnection( 'create-schema' );
+				if ( $status->isOK() ) {
+					$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(
+			'template1',
+			'postgres',
+		);
+		if ( !in_array( $this->getVar( 'wgDBname' ), $dbs ) ) {
+			array_unshift( $dbs, $this->getVar( 'wgDBname' ) );
+		}
+		$status = Status::newGood();
+		foreach ( $dbs as $db ) {
+			try {
+				$GLOBALS['wgDBport'] = $this->getVar( 'wgDBport' );
+				$conn = new DatabasePostgres(
+					$this->getVar( 'wgDBserver' ),
+					$user,
+					$password,
+					$db );
+			} catch ( DBConnectionError $error ) {
+				$conn = false;
+				$status->fatal( 'config-pg-test-error', $db,
+					$error->getMessage() );
+			}
+			if ( $conn !== false ) {
+				break;
+			}
+		}
+		if ( $conn !== false ) {
+			return Status::newGood( $conn );
+		} else {
+			return $status;
+		}
+	}
+
+	protected function getInstallUserPermissions() {
+		$status = $this->getPgConnection( 'create-db' );
+		if ( !$status->isOK() ) {
+			return false;
+		}
+		$conn = $status->value;
+		$superuser = $this->getVar( '_InstallUser' );
+
+		$row = $conn->selectRow( '"pg_catalog"."pg_roles"', '*', 
+			array( 'rolname' => $superuser ), __METHOD__ );
+		return $row;
+	}
+
+	protected function canCreateAccounts() {
+		$perms = $this->getInstallUserPermissions();
+		if ( !$perms ) {
+			return false;
+		}
+		return $perms->rolsuper === 't' || $perms->rolcreaterole === 't';
+	}
+
+	protected function isSuperUser() {
+		$perms = $this->getInstallUserPermissions();
+		if ( !$perms ) {
+			return false;
+		}
+		return $perms->rolsuper === 't';		
+	}
+
+	public function getSettingsForm() {
+		if ( $this->canCreateAccounts() ) {
+			$noCreateMsg = false;
+		} else {
+			$noCreateMsg = 'config-db-web-no-create-privs';
+		}
+		$s = $this->getWebUserBox( $noCreateMsg );
+
+		return $s;
+	}
+
+	public function submitSettingsForm() {
+		$status = $this->submitWebUserBox();
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+
+		$same = $this->getVar( 'wgDBuser' ) === $this->getVar( '_InstallUser' );
+
+		if ( $same ) {
+			$exists = true;
+		} else {
+			// Check if the web user exists
+			// Connect to the database with the install user
+			$status = $this->getPgConnection( 'create-db' );
+			if ( !$status->isOK() ) {
+				return $status;
+			}
+			$exists = $status->value->roleExists( $this->getVar( 'wgDBuser' ) );
+		}
+
+		// Validate the create checkbox
+		if ( $this->canCreateAccounts() && !$same && !$exists ) {
+			$create = $this->getVar( '_CreateDBAccount' );
+		} else {
+			$this->setVar( '_CreateDBAccount', false );
+			$create = false;
+		}
+
+		if ( !$create && !$exists ) {
+			if ( $this->canCreateAccounts() ) {
+				$msg = 'config-install-user-missing-create';
+			} else {
+				$msg = 'config-install-user-missing';
+			}
+			return Status::newFatal( $msg, $this->getVar( 'wgDBuser' ) );
+		}
+
+		if ( !$exists ) {
+			// No more checks to do
+			return Status::newGood();
+		}
+
+		// Existing web account. Test the connection.
+		$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 
+		// objects on behalf of the web user.
+		if ( $same || $this->canCreateObjectsForWebUser() ) {
+			return Status::newGood();
+		} else {
+			return Status::newFatal( 'config-pg-not-in-role' );
+		}
+	}
+
+	/**
+	 * Returns true if the install user is able to create objects owned
+	 * by the web user, false otherwise.
+	 */
+	protected function canCreateObjectsForWebUser() {
+		if ( $this->isSuperUser() ) {
+			return true;
+		}
+
+		$status = $this->getPgConnection( 'create-db' );
+		if ( !$status->isOK() ) {
+			return false;
+		}
+		$conn = $status->value;
+		$installerId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
+			array( 'rolname' => $this->getVar( '_InstallUser' ) ), __METHOD__ );
+		$webId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
+			array( '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
+	 */
+	protected function isRoleMember( $conn, $targetMember, $group, $maxDepth ) {
+		if ( $targetMember === $group ) {
+			// A role is always a member of itself
+			return true;
+		}
+		// Get all members of the given group
+		$res = $conn->select( '"pg_catalog"."pg_auth_members"', array( 'member' ),
+			array( 'roleid' => $group ), __METHOD__ );
+		foreach ( $res as $row ) {
+			if ( $row->member == $targetMember ) {
+				// Found target member
+				return true;
+			}
+			// Recursively search each member of the group to see if the target
+			// is a member of it, up to the given maximum depth.
+			if ( $maxDepth > 0 ) {
+				if ( $this->isRoleMember( $conn, $targetMember, $row->member, $maxDepth - 1 ) ) {
+					// Found member of member
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+	public function preInstall() {
+		$commitCB = array(
+			'name' => 'pg-commit',
+			'callback' => array( $this, 'commitChanges' ),
+		);
+		$plpgCB = array(
+			'name' => 'pg-plpgsql',
+			'callback' => array( $this, 'setupPLpgSQL' ),
+		);
+		$schemaCB = array(
+			'name' => 'schema',
+			'callback' => array( $this, 'setupSchema' )
+		);
+		$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() {
+		$status = $this->getPgConnection( 'create-db' );
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+		$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__ );
+		if ( !$exists ) {
+			$safedb = $conn->addIdentifierQuotes( $dbName );
+			$conn->query( "CREATE DATABASE $safedb", __METHOD__ );
+		}
+		return Status::newGood();
+	}
+
+	function setupSchema() {
+		// Get a connection to the target database
+		$status = $this->getPgConnection( 'create-schema' );
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+		$conn = $status->value;
+
+		// Create the schema if necessary
+		$schema = $this->getVar( 'wgDBmwschema' );
+		$safeschema = $conn->addIdentifierQuotes( $schema );
+		$safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
+		if( !$conn->schemaExists( $schema ) ) {
+			try {
+				$conn->query( "CREATE SCHEMA $safeschema AUTHORIZATION $safeuser" );
+			} catch ( DBQueryError $e ) {
+				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" );
+		return Status::newGood();
+	}
+
+	function commitChanges() {
+		$this->db->query( 'COMMIT' );
+		return Status::newGood();
+	}
+
+	function setupUser() {
+		if ( !$this->getVar( '_CreateDBAccount' ) ) {
+			return Status::newGood();
+		}
+
+		$status = $this->getPgConnection( 'create-db' );
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+		$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' ) );
+		if ( !$userExists ) {
+			// 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 
+				// 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() ) {
+					$sql .= ' ROLE' . $conn->addIdentifierQuotes( $this->getVar( '_InstallUser' ) );
+				}
+
+				$conn->query( $sql, __METHOD__ );
+			} catch ( DBQueryError $e ) {
+				return Status::newFatal( 'config-install-user-create-failed', 
+					$this->getVar( 'wgDBuser' ), $e->getMessage() );
+			}
+		}
+
+		return Status::newGood();
+	}
+
+	function getLocalSettings() {
+		$port = $this->getVar( 'wgDBport' );
+		$schema = $this->getVar( 'wgDBmwschema' );
+		return
+"# Postgres specific settings
+\$wgDBport           = \"{$port}\";
+\$wgDBmwschema       = \"{$schema}\";";
+	}
+
+	public function preUpgrade() {
+		global $wgDBuser, $wgDBpassword;
+
+		# Normal user and password are selected after this step, so for now
+		# just copy these two
+		$wgDBuser = $this->getVar( '_InstallUser' );
+		$wgDBpassword = $this->getVar( '_InstallPassword' );
+	}
+
+	public function createTables() {
+		$schema = $this->getVar( 'wgDBmwschema' );
+
+		$status = $this->getConnection();
+		if ( !$status->isOK() ) {
+			return $status;
+		}
+		$conn = $status->value;
+
+		if( $conn->tableExists( 'user' ) ) {
+			$status->warning( 'config-install-tables-exist' );
+			return $status;
+		}
+
+		$conn->begin( __METHOD__ );
+
+		if( !$conn->schemaExists( $schema ) ) {
+			$status->fatal( 'config-install-pg-schema-not-exist' );
+			return $status;
+		}
+		$error = $conn->sourceFile( $conn->getSchema() );
+		if( $error !== true ) {
+			$conn->reportQueryError( $error, 0, '', __METHOD__ );
+			$conn->rollback( __METHOD__ );
+			$status->fatal( 'config-install-tables-failed', $error );
+		} else {
+			$conn->commit( __METHOD__ );
+		}
+		// Resume normal operations
+		if( $status->isOk() ) {
+			$this->enableLB();
+		}
+		return $status;
+	}
+
+	public function setupPLpgSQL() {
+		// 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;
+		}
+		$conn = $status->value;
+
+		$exists = $conn->selectField( '"pg_catalog"."pg_language"', 1,
+			array( '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 
+		// should be able to create it
+		$exists = $conn->selectField(
+			array( '"pg_catalog"."pg_class"', '"pg_catalog"."pg_namespace"' ),
+			1,
+			array(
+				'pg_namespace.oid=relnamespace',
+				'nspname' => 'pg_catalog',
+				'relname' => 'pg_pltemplate',
+			),
+			__METHOD__ );
+		if ( $exists ) {
+			try {
+				$conn->query( 'CREATE LANGUAGE plpgsql' );
+			} catch ( DBQueryError $e ) {
+				return Status::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
+			}
+		} else {
+			return Status::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
+		}
+		return Status::newGood();
+	}
+}