espocrm-extensions/espocrm-base
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

orm pdo provider

Browse Source
This commit is contained in:
Yuri Kuznetsov
2021-07-27 12:41:12 +03:00
parent b44790c15f
commit 18ac071c5d
5 changed files with 225 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files
application/Espo/Core/ORM/EntityManagerFactory.php
+49 -17
View File
@@ -40,6 +40,10 @@ use Espo\ORM\Repository\RepositoryFactory as RepositoryFactoryInterface;
use Espo\ORM\EntityFactory as EntityFactoryInteface;
use Espo\ORM\Value\ValueFactoryFactory as ValueFactoryFactoryInteface;
use Espo\ORM\Value\AttributeExtractorFactory as AttributeExtractorFactoryInteface;
use Espo\ORM\PDO\PDOProvider;
use Espo\ORM\PDO\DefaultPDOProvider;
use RuntimeException;
class EntityManagerFactory
{
@@ -51,6 +55,11 @@ class EntityManagerFactory
private $eventDispatcher;
private $driverPlatformMap = [
'pdo_mysql' => 'Mysql',
'mysqli' => 'Mysql',
];
public function __construct(
Config $config,
InjectableFactory $injectableFactory,
@@ -74,23 +83,7 @@ class EntityManagerFactory
->build()
);
$config = $this->config;
$databaseParams = DatabaseParams::create()
->withHost($config->get('database.host'))
->withPort($config->get('database.port') ? (int) $config->get('database.port') : null)
->withName($config->get('database.dbname'))
->withUsername($config->get('database.user'))
->withPassword($config->get('database.password'))
->withCharset($config->get('database.charset') ?? 'utf8')
->withDriver($config->get('database.driver'))
->withPlatform($config->get('database.platform'))
->withSslCa($config->get('database.sslCA'))
->withSslCert($config->get('database.sslCert'))
->withSslKey($config->get('database.sslKey'))
->withSslCaPath($config->get('database.sslCAPath'))
->withSslCipher($config->get('database.sslCipher'))
->withSslVerifyDisabled($config->get('database.sslVerifyDisabled') ?? false);
$databaseParams = $this->createDatabaseParams();
$metadata = new Metadata($this->metadataDataProvider, $this->eventDispatcher);
@@ -116,8 +109,47 @@ class EntityManagerFactory
->bindInstance(ValueFactoryFactoryInteface::class, $valueFactoryFactory)
->bindInstance(AttributeExtractorFactoryInteface::class, $attributeExtractorFactory)
->bindInstance(EventDispatcher::class, $this->eventDispatcher)
->bindImplementation(PDOProvider::class, DefaultPDOProvider::class)
->build();
return $this->injectableFactory->createWithBinding(EntityManager::class, $binding);
}
private function createDatabaseParams(): DatabaseParams
{
$config = $this->config;
$databaseParams = DatabaseParams::create()
->withHost($config->get('database.host'))
->withPort($config->get('database.port') ? (int) $config->get('database.port') : null)
->withName($config->get('database.dbname'))
->withUsername($config->get('database.user'))
->withPassword($config->get('database.password'))
->withCharset($config->get('database.charset') ?? 'utf8')
->withPlatform($config->get('database.platform'))
->withSslCa($config->get('database.sslCA'))
->withSslCert($config->get('database.sslCert'))
->withSslKey($config->get('database.sslKey'))
->withSslCaPath($config->get('database.sslCAPath'))
->withSslCipher($config->get('database.sslCipher'))
->withSslVerifyDisabled($config->get('database.sslVerifyDisabled') ?? false);
if (!$databaseParams->getPlatform()) {
$driver = $config->get('database.driver');
if (!$driver) {
throw new RuntimeException('No database driver specified.');
}
$platform = $this->driverPlatformMap[$driver] ?? null;
if (!$platform) {
throw new RuntimeException("Database driver '{$driver}' is not supported.");
}
$databaseParams = $databaseParams->withPlatform($platform);
}
return $databaseParams;
}
}
application/Espo/ORM/DatabaseParams.php
-15
View File
@@ -45,8 +45,6 @@ class DatabaseParams
private $charset = null;
private $driver = null;
private $sslCa = null;
private $sslCert = null;
@@ -99,11 +97,6 @@ class DatabaseParams
return $this->charset;
}
public function getDriver(): ?string
{
return $this->driver;
}
public function getSslCa(): ?string
{
return $this->sslCa;
@@ -190,14 +183,6 @@ class DatabaseParams
return $obj;
}
public function withDriver(?string $driver): self
{
$obj = clone $this;
$obj->driver = $driver;
return $obj;
}
public function withSslCa(?string $sslCa): self
{
$obj = clone $this;
application/Espo/ORM/EntityManager.php
+13 -100
View File
@@ -47,6 +47,8 @@ use Espo\ORM\Value\ValueAccessorFactory;
use Espo\ORM\Value\ValueFactoryFactory;
use Espo\ORM\Value\AttributeExtractorFactory;
use Espo\ORM\PDO\PDOProvider;
use PDO;
use RuntimeException;
@@ -55,8 +57,6 @@ use RuntimeException;
*/
class EntityManager
{
private $pdo = null;
private $entityFactory;
private $collectionFactory;
@@ -88,12 +88,9 @@ class EntityManager
private $locker;
private const RDB_MAPPER_NAME = 'RDB';
private $pdoProvider;
protected $driverPlatformMap = [
'pdo_mysql' => 'Mysql',
'mysqli' => 'Mysql',
];
private const RDB_MAPPER_NAME = 'RDB';
public function __construct(
DatabaseParams $databaseParams,
@@ -103,6 +100,7 @@ class EntityManager
ValueFactoryFactory $valueFactoryFactory,
AttributeExtractorFactory $attributeExtractorFactory,
EventDispatcher $eventDispatcher,
PDOProvider $pdoProvider,
?MapperFactory $mapperFactory = null
) {
$this->databaseParams = $databaseParams;
@@ -111,21 +109,10 @@ class EntityManager
$this->entityFactory = $entityFactory;
$this->repositoryFactory = $repositoryFactory;
$this->mapperFactory = $mapperFactory;
$this->pdoProvider = $pdoProvider;
if (!$this->databaseParams->getPlatform()) {
$driver = $this->databaseParams->getDriver();
if (!$driver) {
throw new RuntimeException('No database driver specified.');
}
$platform = $this->driverPlatformMap[$driver] ?? null;
if (!$platform) {
throw new RuntimeException("Database driver '{$driver}' is not supported.");
}
$this->databaseParams = $this->databaseParams->withPlatform($platform);
throw new RuntimeException("No 'platform' parameter.");
}
$valueAccessorFactory = new ValueAccessorFactory(
@@ -139,11 +126,11 @@ class EntityManager
$this->initQueryComposer();
$this->sqlExecutor = new SqlExecutor($this->getPDO());
$this->sqlExecutor = new SqlExecutor($this->pdoProvider->get());
$this->queryExecutor = new QueryExecutor($this->sqlExecutor, $this->queryComposer);
$this->queryBuilder = new QueryBuilder();
$this->collectionFactory = new CollectionFactory($this);
$this->transactionManager = new TransactionManager($this->getPDO(), $this->queryComposer);
$this->transactionManager = new TransactionManager($this->pdoProvider->get(), $this->queryComposer);
$this->initLocker();
}
@@ -158,7 +145,7 @@ class EntityManager
throw new RuntimeException("Query composer for '{$platform}' platform does not exits.");
}
$this->queryComposer = new $className($this->getPDO(), $this->entityFactory, $this->metadata);
$this->queryComposer = new $className($this->pdoProvider->get(), $this->entityFactory, $this->metadata);
}
private function initLocker(): void
@@ -171,7 +158,7 @@ class EntityManager
$className = BaseLocker::class;
}
$this->locker = new $className($this->getPDO(), $this->queryComposer, $this->transactionManager);
$this->locker = new $className($this->pdoProvider->get(), $this->queryComposer, $this->transactionManager);
}
/**
@@ -216,7 +203,7 @@ class EntityManager
$className = $this->getRDBMapperClassName();
$this->mappers[$name] = new $className(
$this->getPDO(),
$this->pdoProvider->get(),
$this->entityFactory,
$this->collectionFactory,
$this->getQueryComposer(),
@@ -247,76 +234,6 @@ class EntityManager
return $className;
}
private function initPDO(): void
{
$platform = strtolower($this->databaseParams->getPlatform() ?? '');
$host = $this->databaseParams->getHost();
$port = $this->databaseParams->getPort();
$dbname = $this->databaseParams->getName();
$charset = $this->databaseParams->getCharset();
$username = $this->databaseParams->getUsername();
$password = $this->databaseParams->getPassword();
if (!$platform) {
throw new RuntimeException("No 'platform' parameter.");
}
if (!$host) {
throw new RuntimeException("No 'host' parameter.");
}
if (!$dbname) {
throw new RuntimeException("No 'dbname' parameter.");
}
$dsn =
$platform . ':' .
'host=' . $host;
if ($port) {
$dsn .= ';' . 'port=' . (string) $port;
}
if ($dbname) {
$dsn .= ';' . 'dbname=' . $dbname;
}
if ($charset) {
$dsn .= ';' . 'charset=' . $charset;
}
$options = [];
if ($this->databaseParams->getSslCa()) {
$options[PDO::MYSQL_ATTR_SSL_CA] = $this->databaseParams->getSslCa();
}
if ($this->databaseParams->getSslCert()) {
$options[PDO::MYSQL_ATTR_SSL_CERT] = $this->databaseParams->getSslCert();
}
if ($this->databaseParams->getSslKey()) {
$options[PDO::MYSQL_ATTR_SSL_KEY] = $this->databaseParams->getSslKey();
}
if ($this->databaseParams->getSslCaPath()) {
$options[PDO::MYSQL_ATTR_SSL_CAPATH] = $this->databaseParams->getSslCaPath();
}
if ($this->databaseParams->getSslCipher()) {
$options[PDO::MYSQL_ATTR_SSL_CIPHER] = $this->databaseParams->getSslCipher();
}
if ($this->databaseParams->isSslVerifyDisabled()) {
$options[PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT] = false;
}
$this->pdo = new PDO($dsn, $username, $password, $options);
$this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
}
/**
* Get an entity. If $id is null, a new entity instance is created.
* If an entity with a specified ID does not exist, then NULL is returned.
@@ -458,11 +375,7 @@ class EntityManager
*/
public function getPDO(): PDO
{
if ($this->pdo === null) {
$this->initPDO();
}
return $this->pdo;
return $this->pdoProvider->get();
}
/**
application/Espo/ORM/PDO/DefaultPDOProvider.php
+126
View File
@@ -0,0 +1,126 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM 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 3 of the License, or
* (at your option) any later version.
*
* EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\ORM\PDO;
use Espo\ORM\DatabaseParams;
use PDO;
use RuntimeException;
class DefaultPDOProvider implements PDOProvider
{
private $databaseParams;
private $pdo = null;
public function __construct(DatabaseParams $databaseParams)
{
$this->databaseParams = $databaseParams;
}
public function get(): PDO
{
if (!$this->pdo) {
$this->intPDO();
}
return $this->pdo;
}
private function intPDO(): void
{
$platform = strtolower($this->databaseParams->getPlatform() ?? '');
$host = $this->databaseParams->getHost();
$port = $this->databaseParams->getPort();
$dbname = $this->databaseParams->getName();
$charset = $this->databaseParams->getCharset();
$username = $this->databaseParams->getUsername();
$password = $this->databaseParams->getPassword();
if (!$platform) {
throw new RuntimeException("No 'platform' parameter.");
}
if (!$host) {
throw new RuntimeException("No 'host' parameter.");
}
if (!$dbname) {
throw new RuntimeException("No 'dbname' parameter.");
}
$dsn =
$platform . ':' .
'host=' . $host;
if ($port) {
$dsn .= ';' . 'port=' . (string) $port;
}
if ($dbname) {
$dsn .= ';' . 'dbname=' . $dbname;
}
if ($charset) {
$dsn .= ';' . 'charset=' . $charset;
}
$options = [];
if ($this->databaseParams->getSslCa()) {
$options[PDO::MYSQL_ATTR_SSL_CA] = $this->databaseParams->getSslCa();
}
if ($this->databaseParams->getSslCert()) {
$options[PDO::MYSQL_ATTR_SSL_CERT] = $this->databaseParams->getSslCert();
}
if ($this->databaseParams->getSslKey()) {
$options[PDO::MYSQL_ATTR_SSL_KEY] = $this->databaseParams->getSslKey();
}
if ($this->databaseParams->getSslCaPath()) {
$options[PDO::MYSQL_ATTR_SSL_CAPATH] = $this->databaseParams->getSslCaPath();
}
if ($this->databaseParams->getSslCipher()) {
$options[PDO::MYSQL_ATTR_SSL_CIPHER] = $this->databaseParams->getSslCipher();
}
if ($this->databaseParams->isSslVerifyDisabled()) {
$options[PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT] = false;
}
$this->pdo = new PDO($dsn, $username, $password, $options);
$this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
}
}
application/Espo/ORM/PDO/PDOProvider.php
+37
View File
@@ -0,0 +1,37 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM 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 3 of the License, or
* (at your option) any later version.
*
* EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\ORM\PDO;
use PDO;
interface PDOProvider
{
public function get(): PDO;
}