Files
espocrm/application/Espo/Tools/Stream/HookProcessor.php
bsiggel 127fa6503b chore: Update copyright year from 2025 to 2026 across core files
- Updated copyright headers in 3,055 core application files
- Changed 'Copyright (C) 2014-2025' to 'Copyright (C) 2014-2026'
- Added 123 new files from EspoCRM core updates
- Removed 4 deprecated files
- Total changes: 61,637 insertions, 54,283 deletions

This is a routine maintenance update for the new year 2026.
2026-02-07 16:05:21 +01:00

715 lines
23 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM Open Source CRM application.
* Copyright (C) 2014-2026 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\Tools\Stream;
use Espo\Core\Acl\AssignmentChecker\Helper;
use Espo\Core\Field\DateTime;
use Espo\Core\Name\Field;
use Espo\Core\ORM\Repository\Option\SaveContext;
use Espo\Core\ORM\Repository\Option\SaveOption;
use Espo\Core\ORM\Entity as CoreEntity;
use Espo\Core\Utils\Metadata;
use Espo\Core\Job\QueueName;
use Espo\Core\Job\JobSchedulerFactory;
use Espo\Entities\Autofollow;
use Espo\Entities\User;
use Espo\Entities\Preferences;
use Espo\ORM\Defs\Params\RelationParam;
use Espo\ORM\EntityManager;
use Espo\ORM\Entity;
use Espo\ORM\Defs\RelationDefs;
use Espo\ORM\Repository\Option\RemoveOptions;
use Espo\ORM\Repository\Option\SaveOptions;
use Espo\Tools\Stream\Service as Service;
use Espo\Tools\Stream\Jobs\AutoFollow as AutoFollowJob;
use Espo\Tools\Stream\Jobs\ControlFollowers as ControlFollowersJob;
use Espo\Tools\User\PreferencesProvider;
/**
* Handles operations with entities.
*/
class HookProcessor
{
/** @var array<string, bool> */
private $hasStreamCache = [];
/** @var array<string, bool> */
private $isLinkObservableInStreamCache = [];
private const FIELD_ASSIGNED_USERS = Field::ASSIGNED_USERS;
public function __construct(
private Metadata $metadata,
private EntityManager $entityManager,
private Service $service,
private User $user,
private Preferences $preferences,
private JobSchedulerFactory $jobSchedulerFactory,
private Helper $helper,
private PreferencesProvider $preferencesProvider,
) {}
public function beforeSave(Entity $entity, SaveOptions $options): void
{
if (
!$this->checkHasStream($entity->getEntityType()) ||
$options->get(SaveOption::NO_STREAM) ||
$options->get(SaveOption::SILENT)
) {
return;
}
$this->processStreamUpdatedAt($entity);
}
/**
* @param array<string, mixed> $options
*/
public function afterSave(Entity $entity, array $options): void
{
$hasStream = $this->checkHasStream($entity->getEntityType());
if ($hasStream) {
$this->afterSaveStream($entity, $options);
}
if (!$hasStream) {
$this->afterSaveNoStream($entity, $options);
}
if (
$entity->isNew() &&
empty($options[SaveOption::NO_STREAM]) &&
empty($options[SaveOption::SILENT]) &&
$this->metadata->get(['scopes', $entity->getEntityType(), 'object'])
) {
$this->handleCreateRelated($entity, $options);
}
}
/** @noinspection PhpUnusedParameterInspection */
public function afterRemove(Entity $entity, RemoveOptions $options): void
{
if ($this->checkHasStream($entity->getEntityType())) {
$this->service->unfollowAllUsersFromEntity($entity);
}
}
private function checkHasStream(string $entityType): bool
{
if (!array_key_exists($entityType, $this->hasStreamCache)) {
$this->hasStreamCache[$entityType] = (bool) $this->metadata->get(['scopes', $entityType, 'stream']);
}
return $this->hasStreamCache[$entityType];
}
private function isLinkObservableInStream(string $entityType, string $link): bool
{
$key = $entityType . '__' . $link;
if (!array_key_exists($key, $this->isLinkObservableInStreamCache)) {
$this->isLinkObservableInStreamCache[$key] =
$this->metadata->get(['scopes', $entityType, 'stream']) &&
$this->metadata->get(['entityDefs', $entityType, 'links', $link, 'audited']);
}
return $this->isLinkObservableInStreamCache[$key];
}
/**
* @param array<string, mixed> $options
*/
private function handleCreateRelated(Entity $entity, array $options = []): void
{
$notifiedEntityTypeList = [];
$relationList = $this->entityManager
->getDefs()
->getEntity($entity->getEntityType())
->getRelationList();
foreach ($relationList as $relation) {
$type = $relation->getType();
if ($type === Entity::BELONGS_TO) {
$this->handleCreateRelatedBelongsTo($entity, $relation, $notifiedEntityTypeList, $options);
continue;
}
if ($type === Entity::BELONGS_TO_PARENT) {
$this->handleCreateRelatedBelongsToParent($entity, $relation, $notifiedEntityTypeList, $options);
continue;
}
if ($type === Entity::HAS_MANY || $type === Entity::MANY_MANY) {
$this->handleCreateRelatedHasMany($entity, $relation, $notifiedEntityTypeList, $options);
/** @noinspection PhpUnnecessaryStopStatementInspection */
continue;
}
}
}
/**
* @param string[] $notifiedEntityTypeList
* @param array<string, mixed> $options
*/
private function handleCreateRelatedBelongsTo(
Entity $entity,
RelationDefs $defs,
array &$notifiedEntityTypeList,
array $options,
): void {
if (
!$defs->hasForeignRelationName() ||
!$defs->hasForeignEntityType()
) {
return;
}
$link = $defs->getName();
$foreign = $defs->getForeignRelationName();
$foreignEntityType = $defs->getForeignEntityType();
if (in_array($foreignEntityType, $notifiedEntityTypeList)) {
return;
}
$id = $entity->get($link . 'Id');
if (!$id) {
return;
}
if (!$this->isLinkObservableInStream($foreignEntityType, $foreign)) {
return;
}
$this->service->noteCreateRelated($entity, $foreignEntityType, $id, $options);
$notifiedEntityTypeList[] = $foreignEntityType;
}
/**
* @param string[] $notifiedEntityTypeList
* @param array<string, mixed> $options
*/
private function handleCreateRelatedBelongsToParent(
Entity $entity,
RelationDefs $defs,
array &$notifiedEntityTypeList,
array $options
): void {
if (!$defs->hasForeignRelationName()) {
return;
}
$link = $defs->getName();
$foreign = $defs->getForeignRelationName();
/** @var ?string $foreignEntityType */
$foreignEntityType = $entity->get($link . 'Type');
$id = $entity->get($link . 'Id');
if (!$foreignEntityType || !$id) {
return;
}
if (in_array($foreignEntityType, $notifiedEntityTypeList)) {
return;
}
if (!$this->isLinkObservableInStream($foreignEntityType, $foreign)) {
return;
}
$this->service->noteCreateRelated($entity, $foreignEntityType, $id, $options);
$notifiedEntityTypeList[] = $foreignEntityType;
}
/**
* @param string[] $notifiedEntityTypeList
* @param array<string, mixed> $options
*/
private function handleCreateRelatedHasMany(
Entity $entity,
RelationDefs $defs,
array &$notifiedEntityTypeList,
array $options
): void {
if (
!$defs->hasForeignRelationName() ||
!$defs->hasForeignEntityType()
) {
return;
}
$link = $defs->getName();
$foreign = $defs->getForeignRelationName();
$foreignEntityType = $defs->getForeignEntityType();
if (in_array($foreignEntityType, $notifiedEntityTypeList)) {
return;
}
if (!$entity->hasAttribute($link . 'Ids')) {
return;
}
$ids = $entity->get($link . 'Ids');
if (!is_array($ids) || !count($ids)) {
return;
}
if (!$this->isLinkObservableInStream($foreignEntityType, $foreign)) {
return;
}
$id = $ids[0];
$this->service->noteCreateRelated($entity, $foreignEntityType, $id, $options);
$notifiedEntityTypeList[] = $foreignEntityType;
}
/**
* @param string[] $ignoreUserIdList
* @return string[]
*/
private function getAutofollowUserIdList(string $entityType, array $ignoreUserIdList = []): array
{
$userIdList = [];
$autofollowList = $this->entityManager
->getRDBRepository(Autofollow::ENTITY_TYPE)
->select(['userId'])
->where([
'entityType' => $entityType,
])
->find();
foreach ($autofollowList as $autofollow) {
$userId = $autofollow->get('userId');
if (in_array($userId, $ignoreUserIdList)) {
continue;
}
$userIdList[] = $userId;
}
return $userIdList;
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveStream(Entity $entity, array $options): void
{
if (!$entity instanceof CoreEntity) {
return;
}
if ($entity->isNew()) {
$this->afterSaveStreamNew($entity, $options);
} else {
$this->afterSaveStreamNotNew($entity, $options);
}
$this->followAddedCollaborators($entity);
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveStreamNew(CoreEntity $entity, array $options): void
{
$entityType = $entity->getEntityType();
$multipleField = $this->metadata->get(['streamDefs', $entityType, 'followingUsersField']) ??
Field::ASSIGNED_USERS;
$hasAssignedUsersField = $entity->hasLinkMultipleField($multipleField);
$userIdList = [];
$assignedUserId = $entity->get('assignedUserId');
$createdById = $entity->get('createdById');
/** @var string[] $assignedUserIdList */
$assignedUserIdList = $hasAssignedUsersField ? $entity->getLinkMultipleIdList($multipleField) : [];
if (
!$this->user->isSystem() &&
!$this->user->isApi() &&
$createdById &&
$createdById === $this->user->getId() &&
(
$this->user->isPortal() ||
$this->preferences->get('followCreatedEntities') ||
in_array($entityType, $this->preferences->get('followCreatedEntityTypeList') ?? [])
)
) {
$userIdList[] = $createdById;
}
if ($hasAssignedUsersField) {
$userIdList = array_unique(
array_merge($userIdList, $assignedUserIdList)
);
}
if ($assignedUserId && !in_array($assignedUserId, $userIdList)) {
$userIdList[] = $assignedUserId;
}
if (count($userIdList)) {
$this->service->followEntityMass($entity, $userIdList);
}
if (empty($options[SaveOption::NO_STREAM]) && empty($options[SaveOption::SILENT])) {
$this->service->noteCreate($entity, $options);
}
if (in_array($this->user->getId(), $userIdList)) {
$entity->set(Field::IS_FOLLOWED, true);
}
$autofollowUserIdList = $this->getAutofollowUserIdList($entity->getEntityType(), $userIdList);
if (count($autofollowUserIdList)) {
$this->jobSchedulerFactory
->create()
->setClassName(AutoFollowJob::class)
->setQueue(QueueName::Q1)
->setData([
'userIdList' => $autofollowUserIdList,
'entityType' => $entity->getEntityType(),
'entityId' => $entity->getId(),
])
->schedule();
}
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveStreamNotNew(CoreEntity $entity, array $options): void
{
$this->afterSaveStreamNotNew1($entity, $options);
$this->afterSaveStreamNotNew2($entity);
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveStreamNotNew1(CoreEntity $entity, array $options): void
{
if (!empty($options[SaveOption::NO_STREAM]) || !empty($options[SaveOption::SILENT])) {
return;
}
if ($entity->isAttributeChanged('assignedUserId')) {
$this->afterSaveStreamNotNewAssignedUserIdChanged($entity, $options);
} else if (
$entity->hasLinkMultipleField(self::FIELD_ASSIGNED_USERS) &&
$entity->isAttributeChanged(self::FIELD_ASSIGNED_USERS . 'Ids')
) {
$this->afterSaveStreamNotNewAssignedUsersIdsChanged($entity, $options);
}
if (empty($options[SaveOption::SKIP_AUDITED])) {
$this->service->handleAudited($entity, $options);
}
$multipleField = $this->metadata->get(['streamDefs', $entity->getEntityType(), 'followingUsersField']) ??
Field::ASSIGNED_USERS;
if (!$entity->hasLinkMultipleField($multipleField)) {
return;
}
$assignedUserIdList = $entity->getLinkMultipleIdList($multipleField);
$fetchedAssignedUserIdList = $entity->getFetched($multipleField . 'Ids') ?? [];
foreach ($assignedUserIdList as $userId) {
if (in_array($userId, $fetchedAssignedUserIdList)) {
continue;
}
$this->service->followEntity($entity, $userId);
if ($this->user->getId() === $userId) {
$entity->set(Field::IS_FOLLOWED, true);
}
}
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveStreamNotNewAssignedUserIdChanged(Entity $entity, array $options): void
{
$assignedUserId = $entity->get('assignedUserId');
if (!$assignedUserId) {
$this->service->noteAssign($entity, $options);
return;
}
$this->service->followEntity($entity, $assignedUserId);
$this->service->noteAssign($entity, $options);
if ($this->user->getId() === $assignedUserId) {
$entity->set(Field::IS_FOLLOWED, true);
}
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveStreamNotNewAssignedUsersIdsChanged(CoreEntity $entity, array $options): void
{
$userIds = $entity->getLinkMultipleIdList(self::FIELD_ASSIGNED_USERS);
/** @var string[] $prevUserIds */
$prevUserIds = $entity->getFetched(self::FIELD_ASSIGNED_USERS . 'Ids') ?? [];
foreach (array_diff($userIds, $prevUserIds) as $userId) {
$this->service->followEntity($entity, $userId);
}
$this->service->noteAssign($entity, $options);
if (in_array($this->user->getId(), $userIds)) {
$entity->set(Field::IS_FOLLOWED, true);
}
}
private function afterSaveStreamNotNew2(CoreEntity $entity): void
{
// Not recommended to use.
$methodName = 'isChangedWithAclAffect';
if (
(method_exists($entity, $methodName) && $entity->$methodName()) ||
(
!method_exists($entity, $methodName) &&
(
// @todo Introduce a metadata parameter.
$entity->isAttributeChanged('assignedUserId') ||
$entity->isAttributeChanged('teamsIds') ||
$entity->isAttributeChanged('assignedUsersIds') ||
$entity->isAttributeChanged('collaboratorsIds')
)
)
) {
$this->jobSchedulerFactory
->create()
->setClassName(ControlFollowersJob::class)
->setQueue(QueueName::Q1)
->setData([
'entityType' => $entity->getEntityType(),
'entityId' => $entity->getId(),
])
->schedule();
}
}
/**
* @param array<string, mixed> $options
*/
public function afterRelate(Entity $entity, Entity $foreignEntity, string $link, array $options): void
{
if (!$entity instanceof CoreEntity) {
return;
}
$entityType = $entity->getEntityType();
$foreignEntityType = $foreignEntity->getEntityType();
$foreignLink = $entity->getRelationParam($link, RelationParam::FOREIGN);
if (
!empty($options[SaveOption::NO_STREAM]) ||
!empty($options[SaveOption::SILENT]) ||
!$this->metadata->get(['scopes', $entityType, 'object'])
) {
return;
}
$audited = $this->metadata->get(['entityDefs', $entityType, 'links', $link, 'audited']);
$auditedForeign = $this->metadata->get(['entityDefs', $foreignEntityType, 'links', $foreignLink, 'audited']);
$saveContext = SaveContext::obtainFromRawOptions($options);
if ($audited) {
if ($saveContext) {
$saveContext->addDeferredAction(
fn () => $this->service->noteRelate($foreignEntity, $entity, $options)
);
} else {
$this->service->noteRelate($foreignEntity, $entity, $options);
}
}
if ($auditedForeign) {
if ($saveContext) {
$saveContext->addDeferredAction(
fn () => $this->service->noteRelate($entity, $foreignEntity, $options)
);
} else {
$this->service->noteRelate($entity, $foreignEntity, $options);
}
}
}
/**
* @param array<string, mixed> $options
*/
public function afterUnrelate(Entity $entity, Entity $foreignEntity, string $link, array $options): void
{
if (!$entity instanceof CoreEntity) {
return;
}
$entityType = $entity->getEntityType();
$foreignEntityType = $foreignEntity->getEntityType();
$foreignLink = $entity->getRelationParam($link, RelationParam::FOREIGN);
if (
!empty($options[SaveOption::NO_STREAM]) ||
!empty($options[SaveOption::SILENT]) ||
!$this->metadata->get(['scopes', $entityType, 'object'])
) {
return;
}
$audited = $this->metadata->get(['entityDefs', $entityType, 'links', $link, 'audited']);
$auditedForeign = $this->metadata->get(['entityDefs', $foreignEntityType, 'links', $foreignLink, 'audited']);
$saveContext = SaveContext::obtainFromRawOptions($options);
if ($audited) {
if ($saveContext) {
$saveContext->addDeferredAction(
fn () => $this->service->noteUnrelate($foreignEntity, $entity, $options)
);
} else {
$this->service->noteUnrelate($foreignEntity, $entity, $options);
}
// @todo
// Add time period (a few minutes). If before, remove RELATE note, don't create 'unrelate' if before.
}
if ($auditedForeign) {
if ($saveContext) {
$saveContext->addDeferredAction(
fn () => $this->service->noteUnrelate($entity, $foreignEntity, $options)
);
} else {
$this->service->noteUnrelate($entity, $foreignEntity, $options);
}
// @todo
// Add time period (a few minutes). If before, remove RELATE note, don't create 'unrelate' if before.
}
}
/**
* @param array<string, mixed> $options
*/
private function afterSaveNoStream(Entity $entity, array $options): void
{
if (!$entity instanceof CoreEntity) {
return;
}
if (!empty($options[SaveOption::NO_STREAM]) || !empty($options[SaveOption::SILENT])) {
return;
}
if (!$entity->isNew()) {
if (empty($options[SaveOption::SKIP_AUDITED])) {
$this->service->handleAudited($entity, $options);
}
}
}
private function processStreamUpdatedAt(Entity $entity): void
{
if (!$this->service->checkEntityNeedsUpdatedAt($entity)) {
return;
}
$entity->set(Field::STREAM_UPDATED_AT, DateTime::createNow()->toString());
}
private function followAddedCollaborators(CoreEntity $entity): void
{
if (
!$this->helper->hasCollaboratorsField($entity->getEntityType()) ||
!$entity->isAttributeChanged(Field::COLLABORATORS . 'Ids')
) {
return;
}
$currentUserIds = $entity->getLinkMultipleIdList(Field::COLLABORATORS);
$previousUserIds = $entity->getFetchedLinkMultipleIdList(Field::COLLABORATORS);
$addedUserIds = array_diff($currentUserIds, $previousUserIds);
$userIds = array_filter($addedUserIds, fn ($userId) => $this->toFollowUserAsCollaborator($userId));
$userIds = array_values($userIds);
$this->service->followEntityMass($entity, $userIds);
}
private function toFollowUserAsCollaborator(string $userId): bool
{
$preferences = $this->preferencesProvider->tryGet($userId);
return $preferences?->get('followAsCollaborator') === true;
}
}