Initial commit
This commit is contained in:
root
335
application/Espo/Core/HookManager.php
Normal file
335
application/Espo/Core/HookManager.php
Normal file
@@ -0,0 +1,335 @@
|
||||
<?php
|
||||
/************************************************************************
|
||||
* This file is part of EspoCRM.
|
||||
*
|
||||
* EspoCRM – Open Source CRM application.
|
||||
* Copyright (C) 2014-2025 EspoCRM, Inc.
|
||||
* Website: https://www.espocrm.com
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program 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 Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://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 Affero General Public License version 3.
|
||||
*
|
||||
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
||||
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
||||
************************************************************************/
|
||||
|
||||
namespace Espo\Core;
|
||||
|
||||
use Espo\Core\Hook\GeneralInvoker;
|
||||
use Espo\Core\Utils\Config\SystemConfig;
|
||||
use Espo\Core\Utils\DataCache;
|
||||
use Espo\Core\Utils\File\Manager as FileManager;
|
||||
use Espo\Core\Utils\Log;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Core\Utils\Module\PathProvider;
|
||||
use Espo\Core\Utils\Util;
|
||||
|
||||
/**
|
||||
* Runs hooks. E.g. beforeSave, afterSave. Hooks can be located in a folder
|
||||
* that matches a certain entity type or in the `Common` folder.
|
||||
* Common hooks are applied to all entity types.
|
||||
*
|
||||
* - `Espo\Hooks\Common\MyHook` – a common hook;
|
||||
* - `Espo\Hooks\{EntityType}\MyHook` – an entity type specific hook;
|
||||
* - `Espo\Modules\{ModuleName}\Hooks\{EntityType}\MyHook` – in a module.
|
||||
*
|
||||
* @link https://docs.espocrm.com/development/hooks/
|
||||
*/
|
||||
class HookManager
|
||||
{
|
||||
private const DEFAULT_ORDER = 9;
|
||||
|
||||
/** @var ?array<string, array<string, mixed>> */
|
||||
private $data = null;
|
||||
private bool $isDisabled = false;
|
||||
/** @var array<string, class-string[]> */
|
||||
private $hookListHash = [];
|
||||
/** @var array<class-string, object> */
|
||||
private $hooks;
|
||||
private string $cacheKey = 'hooks';
|
||||
/** @var string[] */
|
||||
private $ignoredMethodList = [
|
||||
'__construct',
|
||||
'getDependencyList',
|
||||
'inject',
|
||||
];
|
||||
|
||||
public function __construct(
|
||||
private InjectableFactory $injectableFactory,
|
||||
private FileManager $fileManager,
|
||||
private Metadata $metadata,
|
||||
private DataCache $dataCache,
|
||||
private Log $log,
|
||||
private PathProvider $pathProvider,
|
||||
private GeneralInvoker $generalInvoker,
|
||||
private SystemConfig $systemConfig,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @param string $scope A scope (entity type).
|
||||
* @param string $hookName A hook name.
|
||||
* @param mixed $injection A subject (usually an entity).
|
||||
* @param array<string, mixed> $options Options.
|
||||
* @param array<string, mixed> $hookData Additional hook data.
|
||||
*/
|
||||
public function process(
|
||||
string $scope,
|
||||
string $hookName,
|
||||
mixed $injection = null,
|
||||
array $options = [],
|
||||
array $hookData = []
|
||||
): void {
|
||||
|
||||
if ($this->isDisabled) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!isset($this->data)) {
|
||||
$this->loadHooks();
|
||||
}
|
||||
|
||||
$hookList = $this->getHookList($scope, $hookName);
|
||||
|
||||
if (empty($hookList)) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($hookList as $className) {
|
||||
if (empty($this->hooks[$className])) {
|
||||
$this->hooks[$className] = $this->createHookByClassName($className);
|
||||
}
|
||||
|
||||
$hook = $this->hooks[$className];
|
||||
|
||||
$this->generalInvoker->invoke(
|
||||
$hook,
|
||||
$hookName,
|
||||
$injection,
|
||||
$options,
|
||||
$hookData
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable hook processing.
|
||||
*/
|
||||
public function disable(): void
|
||||
{
|
||||
$this->isDisabled = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable hook processing.
|
||||
*/
|
||||
public function enable(): void
|
||||
{
|
||||
$this->isDisabled = false;
|
||||
}
|
||||
|
||||
private function loadHooks(): void
|
||||
{
|
||||
if ($this->systemConfig->useCache() && $this->dataCache->has($this->cacheKey)) {
|
||||
/** @var array<string, array<string, mixed>> $cachedData */
|
||||
$cachedData = $this->dataCache->get($this->cacheKey);
|
||||
|
||||
$this->data = $cachedData;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$metadata = $this->metadata;
|
||||
|
||||
$data = $this->readHookData($this->pathProvider->getCustom() . 'Hooks');
|
||||
|
||||
foreach ($metadata->getModuleList() as $moduleName) {
|
||||
$modulePath = $this->pathProvider->getModule($moduleName) . 'Hooks';
|
||||
|
||||
$data = $this->readHookData($modulePath, $data);
|
||||
}
|
||||
|
||||
$data = $this->readHookData($this->pathProvider->getCore() . 'Hooks', $data);
|
||||
|
||||
$this->data = $this->sortHooks($data);
|
||||
|
||||
if ($this->systemConfig->useCache()) {
|
||||
$this->dataCache->store($this->cacheKey, $this->data);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param class-string $className
|
||||
*/
|
||||
private function createHookByClassName(string $className): object
|
||||
{
|
||||
if (!class_exists($className)) {
|
||||
$this->log->error("Hook class '$className' does not exist.");
|
||||
}
|
||||
|
||||
return $this->injectableFactory->create($className);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $hookDir
|
||||
* @param array<string, array<string, mixed>> $hookData
|
||||
* @return array<string, array<string, mixed>>
|
||||
*/
|
||||
private function readHookData(string $hookDir, array $hookData = []): array
|
||||
{
|
||||
if (!$this->fileManager->exists($hookDir)) {
|
||||
return $hookData;
|
||||
}
|
||||
|
||||
/** @var array<string, string[]> $fileList */
|
||||
$fileList = $this->fileManager->getFileList($hookDir, 1, '\.php$', true);
|
||||
|
||||
foreach ($fileList as $scopeName => $hookFiles) {
|
||||
$hookScopeDirPath = Util::concatPath($hookDir, $scopeName);
|
||||
$normalizedScopeName = Util::normalizeScopeName($scopeName);
|
||||
|
||||
foreach ($hookFiles as $hookFile) {
|
||||
$hookFilePath = Util::concatPath($hookScopeDirPath, $hookFile);
|
||||
$className = Util::getClassName($hookFilePath);
|
||||
|
||||
$classMethods = get_class_methods($className);
|
||||
|
||||
$hookMethods = array_diff($classMethods, $this->ignoredMethodList);
|
||||
|
||||
/** @var string[] $hookMethods */
|
||||
$hookMethods = array_filter($hookMethods, function ($item) {
|
||||
if (str_starts_with($item, 'set')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
});
|
||||
|
||||
foreach ($hookMethods as $hookType) {
|
||||
$entityHookData = $hookData[$normalizedScopeName][$hookType] ?? [];
|
||||
|
||||
if ($this->hookExists($className, $entityHookData)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($this->hookClassIsSuppressed($className)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$hookData[$normalizedScopeName][$hookType][] = [
|
||||
'className' => $className,
|
||||
'order' => $className::$order ?? self::DEFAULT_ORDER,
|
||||
];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $hookData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param class-string $className
|
||||
*/
|
||||
private function hookClassIsSuppressed(string $className): bool
|
||||
{
|
||||
$suppressList = $this->metadata->get(['app', 'hook', 'suppressClassNameList']) ?? [];
|
||||
|
||||
return in_array($className, $suppressList);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sort hooks by the order parameter.
|
||||
*
|
||||
* @param array<string, array<string, mixed>> $hooks
|
||||
* @return array<string, array<string, mixed>>
|
||||
*/
|
||||
private function sortHooks(array $hooks): array
|
||||
{
|
||||
foreach ($hooks as &$scopeHooks) {
|
||||
foreach ($scopeHooks as &$hookList) {
|
||||
usort($hookList, [$this, 'cmpHooks']);
|
||||
}
|
||||
}
|
||||
|
||||
return $hooks;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get sorted hook list.
|
||||
*
|
||||
* @return class-string[]
|
||||
*/
|
||||
private function getHookList(string $scope, string $hookName): array
|
||||
{
|
||||
$key = $scope . '_' . $hookName;
|
||||
|
||||
if (!isset($this->hookListHash[$key])) {
|
||||
$hookList = [];
|
||||
|
||||
if (isset($this->data['Common'][$hookName])) {
|
||||
$hookList = $this->data['Common'][$hookName];
|
||||
}
|
||||
|
||||
if (isset($this->data[$scope][$hookName])) {
|
||||
$hookList = array_merge($hookList, $this->data[$scope][$hookName]);
|
||||
|
||||
usort($hookList, array($this, 'cmpHooks'));
|
||||
}
|
||||
|
||||
$normalizedList = [];
|
||||
|
||||
foreach ($hookList as $hookData) {
|
||||
$normalizedList[] = $hookData['className'];
|
||||
}
|
||||
|
||||
$this->hookListHash[$key] = $normalizedList;
|
||||
}
|
||||
|
||||
return $this->hookListHash[$key];
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if hook exists in the list.
|
||||
*
|
||||
* @param class-string $className
|
||||
* @param array<string, mixed> $hookData
|
||||
*/
|
||||
private function hookExists(string $className, array $hookData): bool
|
||||
{
|
||||
$class = preg_replace('/^.*\\\(.*)$/', '$1', $className);
|
||||
|
||||
foreach ($hookData as $item) {
|
||||
if (preg_match('/\\\\'.$class.'$/', $item['className'])) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $a
|
||||
* @param array<string, mixed> $b
|
||||
*/
|
||||
private function cmpHooks($a, $b): int
|
||||
{
|
||||
if ($a['order'] == $b['order']) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
return ($a['order'] < $b['order']) ? -1 : 1;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user