Source of file PostgreSQLDatabaseConfigurationHelper.php
Size: 6,384 Bytes - Last Modified: 2021-12-23T10:33:33+00:00
/var/www/docs.ssmods.com/process/src/code/PostgreSQLDatabaseConfigurationHelper.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195 | <?php namespace SilverStripe\PostgreSQL; use SilverStripe\Dev\Install\DatabaseAdapterRegistry; use SilverStripe\Dev\Install\DatabaseConfigurationHelper; use Exception; use PDO; /** * This is a helper class for the SS installer. * * It does all the specific checking for PostgreSQLDatabase * to ensure that the configuration is setup correctly. * * @package postgresql */ class PostgreSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper { /** * Create a connection of the appropriate type * * @skipUpgrade * @param array $databaseConfig * @param string $error Error message passed by value * @return mixed|null Either the connection object, or null if error */ protected function createConnection($databaseConfig, &$error) { $error = null; $username = empty($databaseConfig['username']) ? '' : $databaseConfig['username']; $password = empty($databaseConfig['password']) ? '' : $databaseConfig['password']; $server = $databaseConfig['server']; try { switch ($databaseConfig['type']) { case 'PostgreSQLDatabase': $userPart = $username ? " user=$username" : ''; $passwordPart = $password ? " password=$password" : ''; $connstring = "host=$server port=5432 dbname=postgres{$userPart}{$passwordPart}"; $conn = pg_connect($connstring); break; case 'PostgrePDODatabase': // May throw a PDOException if fails $conn = @new PDO('postgresql:host='.$server.';dbname=postgres;port=5432', $username, $password); break; default: $error = 'Invalid connection type: ' . $databaseConfig['type']; return null; } } catch (Exception $ex) { $error = $ex->getMessage(); return null; } if ($conn) { return $conn; } else { $error = 'PostgreSQL requires a valid username and password to determine if the server exists.'; return null; } } public function requireDatabaseFunctions($databaseConfig) { $data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']); return !empty($data['supported']); } public function requireDatabaseServer($databaseConfig) { $conn = $this->createConnection($databaseConfig, $error); $success = !empty($conn); return array( 'success' => $success, 'error' => $error ); } public function requireDatabaseConnection($databaseConfig) { $conn = $this->createConnection($databaseConfig, $error); $success = !empty($conn); return array( 'success' => $success, 'connection' => $conn, 'error' => $error ); } public function getDatabaseVersion($databaseConfig) { $conn = $this->createConnection($databaseConfig, $error); if (!$conn) { return false; } elseif ($conn instanceof PDO) { return $conn->getAttribute(PDO::ATTR_SERVER_VERSION); } elseif (is_resource($conn)) { $info = pg_version($conn); return $info['server']; } else { return false; } } /** * Ensure that the PostgreSQL version is at least 8.3. * * @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc * @return array Result - e.g. array('success' => true, 'error' => 'details of error') */ public function requireDatabaseVersion($databaseConfig) { $success = false; $error = ''; $version = $this->getDatabaseVersion($databaseConfig); if ($version) { $success = version_compare($version, '8.3', '>='); if (!$success) { $error = "Your PostgreSQL version is $version. It's recommended you use at least 8.3."; } } else { $error = "Your PostgreSQL version could not be determined."; } return array( 'success' => $success, 'error' => $error ); } /** * Helper function to execute a query * * @param mixed $conn Connection object/resource * @param string $sql SQL string to execute * @return array List of first value from each resulting row */ protected function query($conn, $sql) { $items = array(); if ($conn instanceof PDO) { foreach ($conn->query($sql) as $row) { $items[] = $row[0]; } } elseif (is_resource($conn)) { $result = pg_query($conn, $sql); while ($row = pg_fetch_row($result)) { $items[] = $row[0]; } } return $items; } public function requireDatabaseOrCreatePermissions($databaseConfig) { $success = false; $alreadyExists = false; $conn = $this->createConnection($databaseConfig, $error); if ($conn) { // Check if db already exists $existingDatabases = $this->query($conn, "SELECT datname FROM pg_database"); $alreadyExists = in_array($databaseConfig['database'], $existingDatabases); if ($alreadyExists) { $success = true; } else { // Check if this user has create privileges $allowedUsers = $this->query($conn, "select rolname from pg_authid where rolcreatedb = true;"); $success = in_array($databaseConfig['username'], $allowedUsers); } } return array( 'success' => $success, 'alreadyExists' => $alreadyExists ); } public function requireDatabaseAlterPermissions($databaseConfig) { $conn = $this->createConnection($databaseConfig, $error); if ($conn) { // if the account can even log in, it can alter tables return array( 'success' => true, 'applies' => true ); } return array( 'success' => false, 'applies' => true ); } } |