nextcloud / server

lib/private/DB/ConnectionFactory.php

Indentation +194 added lines, -194 removed lines

@@ -38,198 +38,198 @@
  * Takes care of creating and configuring Doctrine connections.
  */
 class ConnectionFactory {
-	/**
-	 * @var array
-	 *
-	 * Array mapping DBMS type to default connection parameters passed to
-	 * \Doctrine\DBAL\DriverManager::getConnection().
-	 */
-	protected $defaultConnectionParams = [
-		'mysql' => [
-			'adapter' => '\OC\DB\AdapterMySQL',
-			'charset' => 'UTF8',
-			'driver' => 'pdo_mysql',
-			'wrapperClass' => 'OC\DB\Connection',
-		],
-		'oci' => [
-			'adapter' => '\OC\DB\AdapterOCI8',
-			'charset' => 'AL32UTF8',
-			'driver' => 'oci8',
-			'wrapperClass' => 'OC\DB\OracleConnection',
-		],
-		'pgsql' => [
-			'adapter' => '\OC\DB\AdapterPgSql',
-			'driver' => 'pdo_pgsql',
-			'wrapperClass' => 'OC\DB\Connection',
-		],
-		'sqlite3' => [
-			'adapter' => '\OC\DB\AdapterSqlite',
-			'driver' => 'pdo_sqlite',
-			'wrapperClass' => 'OC\DB\Connection',
-		],
-	];
-
-	/** @var SystemConfig */
-	private $config;
-
-	/**
-	 * ConnectionFactory constructor.
-	 *
-	 * @param SystemConfig $systemConfig
-	 */
-	public function __construct(SystemConfig $systemConfig) {
-		$this->config = $systemConfig;
-		if ($this->config->getValue('mysql.utf8mb4', false)) {
-			$this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
-		}
-	}
-
-	/**
-	 * @brief Get default connection parameters for a given DBMS.
-	 * @param string $type DBMS type
-	 * @throws \InvalidArgumentException If $type is invalid
-	 * @return array Default connection parameters.
-	 */
-	public function getDefaultConnectionParams($type) {
-		$normalizedType = $this->normalizeType($type);
-		if (!isset($this->defaultConnectionParams[$normalizedType])) {
-			throw new \InvalidArgumentException("Unsupported type: $type");
-		}
-		$result = $this->defaultConnectionParams[$normalizedType];
-		// \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
-		// driver is missing. In this case, we won't be able to connect anyway.
-		if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
-			$result['driverOptions'] = array(
-				\PDO::MYSQL_ATTR_FOUND_ROWS => true,
-			);
-		}
-		return $result;
-	}
-
-	/**
-	 * @brief Get default connection parameters for a given DBMS.
-	 * @param string $type DBMS type
-	 * @param array $additionalConnectionParams Additional connection parameters
-	 * @return \OC\DB\Connection
-	 */
-	public function getConnection($type, $additionalConnectionParams) {
-		$normalizedType = $this->normalizeType($type);
-		$eventManager = new EventManager();
-		switch ($normalizedType) {
-			case 'mysql':
-				$eventManager->addEventSubscriber(
-					new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
-				break;
-			case 'oci':
-				$eventManager->addEventSubscriber(new OracleSessionInit);
-				// the driverOptions are unused in dbal and need to be mapped to the parameters
-				if (isset($additionalConnectionParams['driverOptions'])) {
-					$additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
-				}
-				$host = $additionalConnectionParams['host'];
-				$port = isset($additionalConnectionParams['port']) ? $additionalConnectionParams['port'] : null;
-				$dbName = $additionalConnectionParams['dbname'];
-
-				// we set the connect string as dbname and unset the host to coerce doctrine into using it as connect string
-				if ($host === '') {
-					$additionalConnectionParams['dbname'] = $dbName; // use dbname as easy connect name
-				} else {
-					$additionalConnectionParams['dbname'] = '//' . $host . (!empty($port) ? ":{$port}" : "") . '/' . $dbName;
-				}
-				unset($additionalConnectionParams['host']);
-				break;
-
-			case 'sqlite3':
-				$journalMode = $additionalConnectionParams['sqlite.journal_mode'];
-				$additionalConnectionParams['platform'] = new OCSqlitePlatform();
-				$eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
-				break;
-		}
-		/** @var Connection $connection */
-		$connection = DriverManager::getConnection(
-			array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
-			new Configuration(),
-			$eventManager
-		);
-		return $connection;
-	}
-
-	/**
-	 * @brief Normalize DBMS type
-	 * @param string $type DBMS type
-	 * @return string Normalized DBMS type
-	 */
-	public function normalizeType($type) {
-		return $type === 'sqlite' ? 'sqlite3' : $type;
-	}
-
-	/**
-	 * Checks whether the specified DBMS type is valid.
-	 *
-	 * @param string $type
-	 * @return bool
-	 */
-	public function isValidType($type) {
-		$normalizedType = $this->normalizeType($type);
-		return isset($this->defaultConnectionParams[$normalizedType]);
-	}
-
-	/**
-	 * Create the connection parameters for the config
-	 *
-	 * @return array
-	 */
-	public function createConnectionParams() {
-		$type = $this->config->getValue('dbtype', 'sqlite');
-
-		$connectionParams = [
-			'user' => $this->config->getValue('dbuser', ''),
-			'password' => $this->config->getValue('dbpassword', ''),
-		];
-		$name = $this->config->getValue('dbname', 'owncloud');
-
-		if ($this->normalizeType($type) === 'sqlite3') {
-			$dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
-			$connectionParams['path'] = $dataDir . '/' . $name . '.db';
-		} else {
-			$host = $this->config->getValue('dbhost', '');
-			if (strpos($host, ':')) {
-				// Host variable may carry a port or socket.
-				list($host, $portOrSocket) = explode(':', $host, 2);
-				if (ctype_digit($portOrSocket)) {
-					$connectionParams['port'] = $portOrSocket;
-				} else {
-					$connectionParams['unix_socket'] = $portOrSocket;
-				}
-			}
-			$connectionParams['host'] = $host;
-			$connectionParams['dbname'] = $name;
-		}
-
-		$connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', 'oc_');
-		$connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
-
-		//additional driver options, eg. for mysql ssl
-		$driverOptions = $this->config->getValue('dbdriveroptions', null);
-		if ($driverOptions) {
-			$connectionParams['driverOptions'] = $driverOptions;
-		}
-
-		// set default table creation options
-		$connectionParams['defaultTableOptions'] = [
-			'collate' => 'utf8_bin',
-			'tablePrefix' => $connectionParams['tablePrefix']
-		];
-
-		if ($this->config->getValue('mysql.utf8mb4', false)) {
-			$connectionParams['defaultTableOptions'] = [
-				'collate' => 'utf8mb4_bin',
-				'charset' => 'utf8mb4',
-				'row_format' => 'compressed',
-				'tablePrefix' => $connectionParams['tablePrefix']
-			];
-		}
-
-		return $connectionParams;
-	}
+    /**
+     * @var array
+     *
+     * Array mapping DBMS type to default connection parameters passed to
+     * \Doctrine\DBAL\DriverManager::getConnection().
+     */
+    protected $defaultConnectionParams = [
+        'mysql' => [
+            'adapter' => '\OC\DB\AdapterMySQL',
+            'charset' => 'UTF8',
+            'driver' => 'pdo_mysql',
+            'wrapperClass' => 'OC\DB\Connection',
+        ],
+        'oci' => [
+            'adapter' => '\OC\DB\AdapterOCI8',
+            'charset' => 'AL32UTF8',
+            'driver' => 'oci8',
+            'wrapperClass' => 'OC\DB\OracleConnection',
+        ],
+        'pgsql' => [
+            'adapter' => '\OC\DB\AdapterPgSql',
+            'driver' => 'pdo_pgsql',
+            'wrapperClass' => 'OC\DB\Connection',
+        ],
+        'sqlite3' => [
+            'adapter' => '\OC\DB\AdapterSqlite',
+            'driver' => 'pdo_sqlite',
+            'wrapperClass' => 'OC\DB\Connection',
+        ],
+    ];
+
+    /** @var SystemConfig */
+    private $config;
+
+    /**
+     * ConnectionFactory constructor.
+     *
+     * @param SystemConfig $systemConfig
+     */
+    public function __construct(SystemConfig $systemConfig) {
+        $this->config = $systemConfig;
+        if ($this->config->getValue('mysql.utf8mb4', false)) {
+            $this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
+        }
+    }
+
+    /**
+     * @brief Get default connection parameters for a given DBMS.
+     * @param string $type DBMS type
+     * @throws \InvalidArgumentException If $type is invalid
+     * @return array Default connection parameters.
+     */
+    public function getDefaultConnectionParams($type) {
+        $normalizedType = $this->normalizeType($type);
+        if (!isset($this->defaultConnectionParams[$normalizedType])) {
+            throw new \InvalidArgumentException("Unsupported type: $type");
+        }
+        $result = $this->defaultConnectionParams[$normalizedType];
+        // \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
+        // driver is missing. In this case, we won't be able to connect anyway.
+        if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
+            $result['driverOptions'] = array(
+                \PDO::MYSQL_ATTR_FOUND_ROWS => true,
+            );
+        }
+        return $result;
+    }
+
+    /**
+     * @brief Get default connection parameters for a given DBMS.
+     * @param string $type DBMS type
+     * @param array $additionalConnectionParams Additional connection parameters
+     * @return \OC\DB\Connection
+     */
+    public function getConnection($type, $additionalConnectionParams) {
+        $normalizedType = $this->normalizeType($type);
+        $eventManager = new EventManager();
+        switch ($normalizedType) {
+            case 'mysql':
+                $eventManager->addEventSubscriber(
+                    new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
+                break;
+            case 'oci':
+                $eventManager->addEventSubscriber(new OracleSessionInit);
+                // the driverOptions are unused in dbal and need to be mapped to the parameters
+                if (isset($additionalConnectionParams['driverOptions'])) {
+                    $additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
+                }
+                $host = $additionalConnectionParams['host'];
+                $port = isset($additionalConnectionParams['port']) ? $additionalConnectionParams['port'] : null;
+                $dbName = $additionalConnectionParams['dbname'];
+
+                // we set the connect string as dbname and unset the host to coerce doctrine into using it as connect string
+                if ($host === '') {
+                    $additionalConnectionParams['dbname'] = $dbName; // use dbname as easy connect name
+                } else {
+                    $additionalConnectionParams['dbname'] = '//' . $host . (!empty($port) ? ":{$port}" : "") . '/' . $dbName;
+                }
+                unset($additionalConnectionParams['host']);
+                break;
+
+            case 'sqlite3':
+                $journalMode = $additionalConnectionParams['sqlite.journal_mode'];
+                $additionalConnectionParams['platform'] = new OCSqlitePlatform();
+                $eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
+                break;
+        }
+        /** @var Connection $connection */
+        $connection = DriverManager::getConnection(
+            array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
+            new Configuration(),
+            $eventManager
+        );
+        return $connection;
+    }
+
+    /**
+     * @brief Normalize DBMS type
+     * @param string $type DBMS type
+     * @return string Normalized DBMS type
+     */
+    public function normalizeType($type) {
+        return $type === 'sqlite' ? 'sqlite3' : $type;
+    }
+
+    /**
+     * Checks whether the specified DBMS type is valid.
+     *
+     * @param string $type
+     * @return bool
+     */
+    public function isValidType($type) {
+        $normalizedType = $this->normalizeType($type);
+        return isset($this->defaultConnectionParams[$normalizedType]);
+    }
+
+    /**
+     * Create the connection parameters for the config
+     *
+     * @return array
+     */
+    public function createConnectionParams() {
+        $type = $this->config->getValue('dbtype', 'sqlite');
+
+        $connectionParams = [
+            'user' => $this->config->getValue('dbuser', ''),
+            'password' => $this->config->getValue('dbpassword', ''),
+        ];
+        $name = $this->config->getValue('dbname', 'owncloud');
+
+        if ($this->normalizeType($type) === 'sqlite3') {
+            $dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
+            $connectionParams['path'] = $dataDir . '/' . $name . '.db';
+        } else {
+            $host = $this->config->getValue('dbhost', '');
+            if (strpos($host, ':')) {
+                // Host variable may carry a port or socket.
+                list($host, $portOrSocket) = explode(':', $host, 2);
+                if (ctype_digit($portOrSocket)) {
+                    $connectionParams['port'] = $portOrSocket;
+                } else {
+                    $connectionParams['unix_socket'] = $portOrSocket;
+                }
+            }
+            $connectionParams['host'] = $host;
+            $connectionParams['dbname'] = $name;
+        }
+
+        $connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', 'oc_');
+        $connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
+
+        //additional driver options, eg. for mysql ssl
+        $driverOptions = $this->config->getValue('dbdriveroptions', null);
+        if ($driverOptions) {
+            $connectionParams['driverOptions'] = $driverOptions;
+        }
+
+        // set default table creation options
+        $connectionParams['defaultTableOptions'] = [
+            'collate' => 'utf8_bin',
+            'tablePrefix' => $connectionParams['tablePrefix']
+        ];
+
+        if ($this->config->getValue('mysql.utf8mb4', false)) {
+            $connectionParams['defaultTableOptions'] = [
+                'collate' => 'utf8mb4_bin',
+                'charset' => 'utf8mb4',
+                'row_format' => 'compressed',
+                'tablePrefix' => $connectionParams['tablePrefix']
+            ];
+        }
+
+        return $connectionParams;
+    }
 }