mirror of
https://github.com/espocrm/espocrm.git
synced 2026-06-28 06:56:05 +00:00
351 lines
11 KiB
PHP
351 lines
11 KiB
PHP
<?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\Core\ExternalAccount;
|
|
|
|
use Espo\Core\Exceptions\Error;
|
|
|
|
use Espo\Entities\Integration as IntegrationEntity;
|
|
use Espo\Entities\ExternalAccount as ExternalAccountEntity;
|
|
|
|
use Espo\ORM\EntityManager;
|
|
|
|
use Espo\Core\{
|
|
Utils\Metadata,
|
|
Utils\Config,
|
|
InjectableFactory,
|
|
ExternalAccount\OAuth2\Client as OAuth2Client,
|
|
};
|
|
|
|
use Espo\ORM\Entity;
|
|
|
|
class ClientManager
|
|
{
|
|
/**
|
|
* @var EntityManager
|
|
*/
|
|
protected $entityManager;
|
|
|
|
protected $metadata;
|
|
|
|
protected $config;
|
|
|
|
protected $injectableFactory = null;
|
|
|
|
protected $clientMap = [];
|
|
|
|
public function __construct(
|
|
EntityManager $entityManager,
|
|
Metadata $metadata,
|
|
Config $config,
|
|
?InjectableFactory $injectableFactory = null
|
|
) {
|
|
$this->entityManager = $entityManager;
|
|
$this->metadata = $metadata;
|
|
$this->config = $config;
|
|
$this->injectableFactory = $injectableFactory;
|
|
}
|
|
|
|
public function storeAccessToken(string $hash, array $data): void
|
|
{
|
|
if (empty($this->clientMap[$hash]) || empty($this->clientMap[$hash]['externalAccountEntity'])) {
|
|
return;
|
|
}
|
|
|
|
/** @var ExternalAccountEntity $externalAccountEntity */
|
|
$externalAccountEntity = $this->clientMap[$hash]['externalAccountEntity'];
|
|
|
|
$externalAccountEntity->set('accessToken', $data['accessToken']);
|
|
$externalAccountEntity->set('tokenType', $data['tokenType']);
|
|
$externalAccountEntity->set('expiresAt', $data['expiresAt'] ?? null);
|
|
|
|
if ($data['refreshToken'] ?? null) {
|
|
$externalAccountEntity->set('refreshToken', $data['refreshToken']);
|
|
}
|
|
|
|
$copy = $this->entityManager->getEntity('ExternalAccount', $externalAccountEntity->getId());
|
|
|
|
if (!$copy) {
|
|
return;
|
|
}
|
|
|
|
if (!$copy->get('enabled')) {
|
|
throw new Error("External Account Client Manager: Account got disabled.");
|
|
}
|
|
|
|
$copy->set('accessToken', $data['accessToken']);
|
|
$copy->set('tokenType', $data['tokenType']);
|
|
$copy->set('expiresAt', $data['expiresAt'] ?? null);
|
|
|
|
if ($data['refreshToken'] ?? null) {
|
|
$copy->set('refreshToken', $data['refreshToken'] ?? null);
|
|
}
|
|
|
|
$this->entityManager->saveEntity($copy, [
|
|
'isTokenRenewal' => true,
|
|
'skipHooks' => true,
|
|
]);
|
|
}
|
|
|
|
public function create(string $integration, string $userId): ?object
|
|
{
|
|
$authMethod = $this->metadata->get("integrations.{$integration}.authMethod");
|
|
|
|
$methodName = 'create' . ucfirst($authMethod);
|
|
|
|
if (method_exists($this, $methodName)) {
|
|
return $this->$methodName($integration, $userId);
|
|
}
|
|
|
|
if (!$this->injectableFactory) {
|
|
throw new Error();
|
|
}
|
|
|
|
/** @var IntegrationEntity|null $integrationEntity */
|
|
$integrationEntity = $this->entityManager->getEntity('Integration', $integration);
|
|
|
|
/** @var ExternalAccountEntity|null $externalAccountEntity */
|
|
$externalAccountEntity = $this->entityManager->getEntity('ExternalAccount', $integration . '__' . $userId);
|
|
|
|
if (!$externalAccountEntity) {
|
|
throw new Error("External Account {$integration} not found for {$userId}");
|
|
}
|
|
|
|
if (!$integrationEntity->get('enabled')) {
|
|
return null;
|
|
}
|
|
|
|
if (!$externalAccountEntity->get('enabled')) {
|
|
return null;
|
|
}
|
|
|
|
$className = $this->metadata->get("integrations.{$integration}.clientClassName");
|
|
|
|
$client = $this->injectableFactory->create($className);
|
|
|
|
$client->setup(
|
|
$userId,
|
|
$integrationEntity,
|
|
$externalAccountEntity,
|
|
$this
|
|
);
|
|
|
|
$this->addToClientMap($client, $integrationEntity, $externalAccountEntity, $userId);
|
|
|
|
return $client;
|
|
}
|
|
|
|
protected function createOAuth2(string $integration, string $userId): ?object
|
|
{
|
|
/** @var IntegrationEntity|null $integrationEntity */
|
|
$integrationEntity = $this->entityManager->getEntity('Integration', $integration);
|
|
|
|
/** @var ExternalAccountEntity|null $externalAccountEntity */
|
|
$externalAccountEntity = $this->entityManager->getEntity('ExternalAccount', $integration . '__' . $userId);
|
|
|
|
$className = $this->metadata->get("integrations.{$integration}.clientClassName");
|
|
|
|
$redirectUri = $this->config->get('siteUrl') . '?entryPoint=oauthCallback';
|
|
|
|
$redirectUriPath = $this->metadata->get(['integrations', $integration, 'params', 'redirectUriPath']);
|
|
|
|
if ($redirectUriPath) {
|
|
$redirectUri = rtrim($this->config->get('siteUrl'), '/') . '/' . $redirectUriPath;
|
|
}
|
|
|
|
if (!$externalAccountEntity) {
|
|
throw new Error("External Account {$integration} not found for '{$userId}'.");
|
|
}
|
|
|
|
if (!$integrationEntity->get('enabled')) {
|
|
return null;
|
|
}
|
|
|
|
if (!$externalAccountEntity->get('enabled')) {
|
|
return null;
|
|
}
|
|
|
|
$oauth2Client = new OAuth2Client();
|
|
|
|
$params = [
|
|
'endpoint' => $this->metadata->get("integrations.{$integration}.params.endpoint"),
|
|
'tokenEndpoint' => $this->metadata->get("integrations.{$integration}.params.tokenEndpoint"),
|
|
'clientId' => $integrationEntity->get('clientId'),
|
|
'clientSecret' => $integrationEntity->get('clientSecret'),
|
|
'redirectUri' => $redirectUri,
|
|
'accessToken' => $externalAccountEntity->get('accessToken'),
|
|
'refreshToken' => $externalAccountEntity->get('refreshToken'),
|
|
'tokenType' => $externalAccountEntity->get('tokenType'),
|
|
'expiresAt' => $externalAccountEntity->get('expiresAt'),
|
|
];
|
|
|
|
foreach (get_object_vars($integrationEntity->getValueMap()) as $k => $v) {
|
|
if (array_key_exists($k, $params)) {
|
|
continue;
|
|
}
|
|
|
|
if ($integrationEntity->hasAttribute($k)) {
|
|
continue;
|
|
}
|
|
|
|
$params[$k] = $v;
|
|
}
|
|
|
|
$client = new $className($oauth2Client, $params, $this);
|
|
|
|
if ($this->injectableFactory) {
|
|
$this->injectableFactory->createWith($className, [
|
|
'client' => $oauth2Client,
|
|
'params' => $params,
|
|
'manager' => $this,
|
|
]);
|
|
}
|
|
else {
|
|
// For backward compatibility.
|
|
$client = new $className($oauth2Client, $params, $this);
|
|
}
|
|
|
|
$this->addToClientMap($client, $integrationEntity, $externalAccountEntity, $userId);
|
|
|
|
return $client;
|
|
}
|
|
|
|
protected function addToClientMap(
|
|
$client,
|
|
IntegrationEntity $integrationEntity,
|
|
ExternalAccountEntity $externalAccountEntity,
|
|
string $userId
|
|
) {
|
|
$this->clientMap[spl_object_hash($client)] = [
|
|
'client' => $client,
|
|
'userId' => $userId,
|
|
'integration' => $integrationEntity->getId(),
|
|
'integrationEntity' => $integrationEntity,
|
|
'externalAccountEntity' => $externalAccountEntity,
|
|
];
|
|
}
|
|
|
|
protected function getClientRecord($client): Entity
|
|
{
|
|
$data = $this->clientMap[spl_object_hash($client)];
|
|
|
|
if (!$data) {
|
|
throw new Error("External Account Client Manager: Client not found in hash.");
|
|
}
|
|
|
|
return $data['externalAccountEntity'];
|
|
}
|
|
|
|
public function isClientLocked($client): bool
|
|
{
|
|
$externalAccountEntity = $this->getClientRecord($client);
|
|
|
|
$id = $externalAccountEntity->getId();
|
|
|
|
$e = $this->entityManager
|
|
->getRDBRepository('ExternalAccount')
|
|
->select(['id', 'isLocked'])
|
|
->where(['id' => $id])
|
|
->findOne();
|
|
|
|
if (!$e) {
|
|
throw new Error("External Account Client Manager: Client '{$id}' not found in DB.");
|
|
}
|
|
|
|
return $e->get('isLocked');
|
|
}
|
|
|
|
public function lockClient(object $client): void
|
|
{
|
|
$externalAccountEntity = $this->getClientRecord($client);
|
|
|
|
$id = $externalAccountEntity->getId();
|
|
|
|
$e = $this->entityManager
|
|
->getRDBRepository('ExternalAccount')
|
|
->select(['id', 'isLocked'])
|
|
->where(['id' => $id])
|
|
->findOne();
|
|
|
|
if (!$e) {
|
|
throw new Error("External Account Client Manager: Client '{$id}' not found in DB.");
|
|
}
|
|
|
|
$e->set('isLocked', true);
|
|
|
|
$this->entityManager->saveEntity($e, [
|
|
'skipHooks' => true,
|
|
'silent' => true,
|
|
]);
|
|
}
|
|
|
|
public function unlockClient(object $client): void
|
|
{
|
|
$externalAccountEntity = $this->getClientRecord($client);
|
|
|
|
$id = $externalAccountEntity->getId();
|
|
|
|
$e = $this->entityManager
|
|
->getRDBRepository('ExternalAccount')
|
|
->select(['id', 'isLocked'])
|
|
->where(['id' => $id])
|
|
->findOne();
|
|
|
|
if (!$e) {
|
|
throw new Error("External Account Client Manager: Client '{$id}' not found in DB.");
|
|
}
|
|
|
|
$e->set('isLocked', false);
|
|
|
|
$this->entityManager->saveEntity($e, [
|
|
'skipHooks' => true,
|
|
'silent' => true,
|
|
]);
|
|
}
|
|
|
|
public function reFetchClient(object $client): void
|
|
{
|
|
$externalAccountEntity = $this->getClientRecord($client);
|
|
|
|
$id = $externalAccountEntity->getId();
|
|
|
|
$e = $this->entityManager->getEntity('ExternalAccount', $id);
|
|
|
|
if (!$e) {
|
|
throw new Error("External Account Client Manager: Client {$id} not found in DB.");
|
|
}
|
|
|
|
$data = $e->getValueMap();
|
|
|
|
$externalAccountEntity->set($data);
|
|
|
|
$client->setParams(get_object_vars($data));
|
|
}
|
|
}
|