Chat.php

См. документацию.

<?php
 
namespace Bitrix\Im\V2\Controller;
 
use Bitrix\Im\Dialog;
use Bitrix\Im\Recent;
use Bitrix\Im\V2\Chat\ChannelChat;
use Bitrix\Im\V2\Chat\ChatError;
use Bitrix\Im\V2\Chat\ChatFactory;
use Bitrix\Im\V2\Chat\CollabChat;
use Bitrix\Im\V2\Chat\CommentChat;
use Bitrix\Im\V2\Chat\ExternalChat;
use Bitrix\Im\V2\Chat\GeneralChat;
use Bitrix\Im\V2\Chat\GroupChat;
use Bitrix\Im\V2\Chat\MessagesAutoDelete\MessagesAutoDeleteConfigs;
use Bitrix\Im\V2\Chat\OpenChannelChat;
use Bitrix\Im\V2\Chat\OpenChat;
use Bitrix\Im\V2\Chat\OpenLineChat;
use Bitrix\Im\V2\Chat\Param\Params;
use Bitrix\Im\V2\Chat\ExtendedType;
use Bitrix\Im\V2\Controller\Filter\DiskQuickAccessGrantor;
use Bitrix\Im\V2\Permission;
use Bitrix\Im\V2\Chat\Update\UpdateFields;
use Bitrix\Im\V2\Controller\Chat\Pin;
use Bitrix\Im\V2\Controller\Filter\ChatTypeFilter;
use Bitrix\Im\V2\Controller\Filter\CheckActionAccess;
use Bitrix\Im\V2\Controller\Filter\CheckChatAccess;
use Bitrix\Im\V2\Controller\Filter\CheckFileAccess;
use Bitrix\Im\V2\Controller\Filter\ExtendPullWatchPrefilter;
use Bitrix\Im\V2\Controller\Filter\UpdateStatus;
use Bitrix\Im\V2\Entity\File\ChatAvatar;
use Bitrix\Im\V2\Entity\User\UserPopupItem;
use Bitrix\Im\V2\Message;
use Bitrix\Im\V2\Relation\AddUsersConfig;
use Bitrix\Im\V2\Rest\RestAdapter;
use Bitrix\Im\V2\Chat\Update\UpdateService;
use Bitrix\Im\V2\Result;
use Bitrix\Intranet\ActionFilter\IntranetUser;
use Bitrix\Main\Engine\ActionFilter\Base;
use Bitrix\Main\Engine\AutoWire\ExactParameter;
use Bitrix\Main\Engine\CurrentUser;
use Bitrix\Main\Engine\Response\Converter;
 
class Chat extends BaseController
{
    public function configureActions()
    {
        return [
            'add' => [
                '+prefilters' => [
                    new CheckActionAccess(
                        Permission\GlobalAction::CreateChat,
                        fn (Base $filter) => [
                            'TYPE' => $this->getValidatedType(
                                $filter->getAction()->getArguments()['fields']['type'] ?? ''
                            ),
                            'ENTITY_TYPE' => $this->getValidatedEntityType(
                                $filter->getAction()->getArguments()['fields']['entityType'] ?? null
                            ),
                        ]
                    ),
                    new CheckFileAccess(['fields', 'avatar']),
                ],
            ],
            'update' => [
                '+prefilters' => [
                    new CheckFileAccess(['fields', 'avatar']),
                    new CheckActionAccess(Permission\Action::Update),
                    new ChatTypeFilter([GroupChat::class]),
                ],
            ],
            'delete' => [
                '+prefilters' => [
                    new CheckActionAccess(Permission\Action::Delete),
                ],
            ],
            'updateAvatar' => [
                '+prefilters' => [
                    new CheckFileAccess(['avatar']),
                    new CheckActionAccess(Permission\Action::ChangeAvatar),
                ],
            ],
            'setOwner' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeOwner),
                ]
            ],
            'setTitle' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::Rename),
                ]
            ],
            'setDescription' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeDescription),
                ]
            ],
            'setColor' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeColor),
                ]
            ],
            'setAvatarId' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeAvatar),
                    new CheckFileAccess(['avatarId']),
                ]
            ],
            'setAvatar' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeAvatar),
                ]
            ],
            'addUsers' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::Extend),
                ]
            ],
            'deleteUser' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(
                        Permission\Action::Kick,
                        fn (Base $filter) => (int)($filter->getAction()->getArguments()['userId'] ?? 0)
                    ),
                ]
            ],
            'setManagers' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeManagers),
                ]
            ],
            'addManagers' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeManagers),
                    new ChatTypeFilter([GroupChat::class]),
                ]
            ],
            'deleteManagers' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeManagers),
                    new ChatTypeFilter([GroupChat::class]),
                ]
            ],
            'setManageUsersAdd' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeRight),
                ]
            ],
            'setManageUsersDelete' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeRight),
                ]
            ],
            'setManageUI' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeRight),
                ]
            ],
            'setManageSettings' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeRight),
                ]
            ],
            'setMessagesAutoDeleteDelay' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeMessagesAutoDeleteDelay),
                ]
            ],
            'setManageMessages' => [
                '+prefilters' => [
                    new CheckChatAccess(),
                    new CheckActionAccess(Permission\Action::ChangeRight),
                ]
            ],
            'load' => [
                '+prefilters' => [
                    new ExtendPullWatchPrefilter(),
                    new DiskQuickAccessGrantor(),
                ],
            ],
            'loadInContext' => [
                '+prefilters' => [
                    new ExtendPullWatchPrefilter(),
                ],
            ],
            'join' => [
                '+prefilters' => [
                    new ChatTypeFilter([
                        OpenChat::class,
                        OpenLineChat::class,
                        GeneralChat::class,
                        OpenChannelChat::class,
                        CommentChat::class,
                        ExternalChat::class,
                    ]),
                ],
            ],
            'extendPullWatch' => [
                '+prefilters' => [
                    new ChatTypeFilter([OpenChat::class, OpenLineChat::class, ChannelChat::class]),
                ],
            ],
            'pin' => [
                '+prefilters' => [
                    new CheckActionAccess(Permission\Action::PinChat),
                ],
            ],
            'sortPin' => [
                '+prefilters' => [
                    new CheckActionAccess(Permission\Action::PinChat),
                ],
            ],
        ];
    }
 
    public function getPrimaryAutoWiredParameter()
    {
        return new ExactParameter(
            \Bitrix\Im\V2\Chat::class,
            'chat',
            function ($className, $id) {
                return \Bitrix\Im\V2\Chat::getInstance((int)$id);
            }
        );
    }

    public function shallowLoadAction(\Bitrix\Im\V2\Chat $chat): ?array
    {
        return $this->toRestFormat($chat);
    }

    public function loadAction(
        \Bitrix\Im\V2\Chat $chat,
        int $messageLimit = Chat\Message::DEFAULT_LIMIT,
        int $pinLimit = Pin::DEFAULT_LIMIT,
        string $ignoreMark = 'N'
    ): ?array
    {
        $result = $this->load($chat, $messageLimit, $pinLimit, $this->convertCharToBool($ignoreMark));
 
        if (!empty($this->getErrors()))
        {
            return null;
        }
 
        return $result;
    }

    public function loadInContextAction(
        Message $message,
        int $messageLimit = Chat\Message::DEFAULT_LIMIT,
        int $pinLimit = Pin::DEFAULT_LIMIT
    ): ?array
    {
        $result = $this->load($message->getChat(), $messageLimit, $pinLimit, false, $message);
 
        if (!empty($this->getErrors()))
        {
            return null;
        }
 
        return $result;
    }

    public function getAction(\Bitrix\Im\V2\Chat $chat): ?array
    {
        return (new RestAdapter($chat))->toRestFormat(['POPUP_DATA_EXCLUDE' => [UserPopupItem::class]]);
    }

    public function listSharedAction(array $filter, int $limit = self::DEFAULT_LIMIT, int $offset = 0): ?array
    {
        if (!isset($filter['userId']))
        {
            $this->addError(new ChatError(ChatError::USER_ID_EMPTY_ERROR));
 
            return null;
        }
        $userId = (int)$filter['userId'];
        $chats = \Bitrix\Im\V2\Chat::getSharedChatsWithUser($userId, $this->getLimit($limit), $offset);
        \Bitrix\Im\V2\Chat::fillSelfRelations($chats);
        $result = ['chats' => []];
 
        foreach ($chats as $chat)
        {
            $result['chats'][] = $chat->toRestFormat(['CHAT_SHORT_FORMAT' => true, 'CHAT_WITH_DATE_MESSAGE' => true]);
        }
 
        return $result;
    }

    public function getDialogIdAction(string $externalId): ?array
    {
        $chatId = Dialog::getChatId($externalId);
 
        if ($chatId === false || $chatId === 0)
        {
            $this->addError(new ChatError(ChatError::NOT_FOUND));
 
            return null;
        }
 
        return ['dialogId' => "chat{$chatId}"];
    }

    public function readAction(\Bitrix\Im\V2\Chat $chat, string $onlyRecent = 'N'): ?array
    {
        $result = $chat->read($this->convertCharToBool($onlyRecent));
 
        return $this->convertKeysToCamelCase($result->getResult());
    }

    public function readAllAction(CurrentUser $user): ?array
    {
        \Bitrix\Im\V2\Chat::readAllChats((int)$user->getId());
 
        return [];
    }

    public function unreadAction(\Bitrix\Im\V2\Chat $chat): ?array
    {
        Recent::unread($chat->getDialogId(), true);
 
        return [];
    }

    public function startRecordVoiceAction(\Bitrix\Im\V2\Chat $chat): ?array
    {
        $chat->startRecordVoice();
 
        return ['result' => true];
    }

    public function addAction(array $fields): ?array
    {
        $fields['type'] = $this->getValidatedType($fields['type'] ?? null);
        $fields['entityType'] = $this->getValidatedEntityType($fields['entityType'] ?? null);
 
        if (
            !isset($fields['entityType'])
            || $fields['entityType'] !== 'VIDEOCONF'
            || !isset($fields['conferencePassword'])
        )
        {
            unset($fields['conferencePassword']);
        }
 
        if (isset($fields['copilotMainRole']))
        {
            $fields['chatParams'][] = [
                'paramName' => Params::COPILOT_MAIN_ROLE,
                'paramValue' => $fields['copilotMainRole']
            ];
        }
 
        $data = self::recursiveWhiteList($fields, \Bitrix\Im\V2\Chat::AVAILABLE_PARAMS);
        if (isset($data['OWNER_ID']))
        {
            $data['AUTHOR_ID'] = $data['OWNER_ID'];
        }
 
        $result = ChatFactory::getInstance()->addChat($data);
        if (!$result->isSuccess())
        {
            $this->addErrors($result->getErrors());
            return null;
        }
 
        return $this->convertKeysToCamelCase($result->getResult());
    }
 
    //region Update Chat
    public function updateAction(GroupChat $chat, array $fields)
    {
        $converter = new Converter(Converter::TO_SNAKE | Converter::TO_UPPER | Converter::KEYS);
        $updateService = new UpdateService($chat, UpdateFields::create($converter->process($fields)));
 
        $result = $updateService->updateChat();
        if (!$result->isSuccess())
        {
            $this->addError($result->getErrors()[0]);
 
            return null;
        }
 
        return ['result' => true];
    }
 
    //region Delete Chat

    public function deleteAction(\Bitrix\Im\V2\Chat $chat)
    {
        $result = $chat->deleteChat();
 
        if (!$result->isSuccess())
        {
            $this->addError($result->getErrors()[0]);
 
            return null;
        }
 
        return ['result' => true];
    }
 
    //region Manage Users
    public function addUsersAction(\Bitrix\Im\V2\Chat $chat, array $userIds, ?string $hideHistory = null): ?array
    {
        $hideHistoryBool = $hideHistory === null ? null : $this->convertCharToBool($hideHistory, true);
        $chat->addUsers($userIds, new AddUsersConfig(hideHistory: $hideHistoryBool));
 
        return ['result' => true];
    }

    public function joinAction(\Bitrix\Im\V2\Chat $chat): ?array
    {
        $chat->join();
 
        return ['result' => true];
    }

    public function extendPullWatchAction(\Bitrix\Im\V2\Chat $chat): ?array
    {
        if ($chat instanceof OpenChat || $chat instanceof OpenLineChat || $chat instanceof ChannelChat)
        {
            $chat->extendPullWatch();
        }
 
        return ['result' => true];
    }

    public function deleteUserAction(\Bitrix\Im\V2\Chat $chat, int $userId): ?array
    {
        $result = $chat->deleteUser($userId);
 
        if (!$result->isSuccess())
        {
            $this->addErrors($result->getErrors());
 
            return null;
        }
 
        return ['result' => true];
    }
    //endregion
 
    //region Manage UI
    public function setTitleAction(\Bitrix\Im\V2\Chat $chat, string $title)
    {
        $chat->setTitle($title);
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function setDescriptionAction(\Bitrix\Im\V2\Chat $chat, string $description)
    {
        $chat->setDescription($description);
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function setColorAction(\Bitrix\Im\V2\Chat $chat, string $color)
    {
        $result = $chat->validateColor();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        $chat->setColor($color);
        $result = $chat->save();
 
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function updateAvatarAction(\Bitrix\Im\V2\Chat $chat, string $avatar)
    {
        $result = (new ChatAvatar($chat))->update($avatar);
 
        if (!$result->isSuccess())
        {
            $this->addErrors($result->getErrors());
 
            return null;
        }
 
        return ['result' => true];
    }

    public function setAvatarIdAction(\Bitrix\Im\V2\Chat $chat, int $avatarId)
    {
        $result = (new ChatAvatar($chat))->update($avatarId);
 
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return ['result' => true];
    }

    public function setAvatarAction(\Bitrix\Im\V2\Chat $chat, string $avatarBase64)
    {
        $result = (new ChatAvatar($chat))->update($avatarBase64);
 
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return ['avatarId' => $result->getResult()];
    }
    //endregion
 
    //region Manage Settings
    public function setMessagesAutoDeleteDelayAction(\Bitrix\Im\V2\Chat $chat, int $hours)
    {
        $result = match (true)
        {
            $chat instanceof CollabChat => Message\Delete\DisappearService::disappearCollab($chat, $hours),
            default => Message\Delete\DisappearService::disappearChat($chat, $hours),
        };

        if (!$result->isSuccess())
        {
            $this->addErrors($result->getErrors());
 
            return null;
        }
 
        return [
            'messagesAutoDeleteConfigs' => $result->getResult()?->showDefaultValues()?->toRestFormat() ?? [],
        ];
    }

    public function setOwnerAction(\Bitrix\Im\V2\Chat $chat, int $ownerId)
    {
        $chat->setAuthorId($ownerId);
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function setManagersAction(\Bitrix\Im\V2\Chat $chat, array $userIds)
    {
        $chat->setManagers($userIds);
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function addManagersAction(GroupChat $chat, array $userIds): ?array
    {
        $chat->addManagers($userIds);
 
        return ['result' => true];
    }

    public function deleteManagersAction(GroupChat $chat, array $userIds): ?array
    {
        $chat->deleteManagers($userIds);
 
        return ['result' => true];
    }

    public function setManageUsersAddAction(\Bitrix\Im\V2\Chat $chat, string $rightsLevel)
    {
        $chat->setManageUsersAdd(mb_strtoupper($rightsLevel));
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function setManageUsersDeleteAction(\Bitrix\Im\V2\Chat $chat, string $rightsLevel)
    {
        $chat->setManageUsersDelete(mb_strtoupper($rightsLevel));
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function setManageUIAction(\Bitrix\Im\V2\Chat $chat, string $rightsLevel)
    {
        $chat->setManageUI(mb_strtoupper($rightsLevel));
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function setManageSettingsAction(\Bitrix\Im\V2\Chat $chat, string $rightsLevel)
    {
        $chat->setManageSettings(mb_strtoupper($rightsLevel));
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
 
    }

    public function setManageMessagesAction(\Bitrix\Im\V2\Chat $chat, string $rightsLevel)
    {
        $chat->setManageMessages(mb_strtoupper($rightsLevel));
        $result = $chat->save();
        if (!$result->isSuccess())
        {
            return $this->convertKeysToCamelCase($result->getErrors());
        }
 
        return $result->isSuccess();
    }

    public function pinAction(\Bitrix\Im\V2\Chat $chat, CurrentUser $user): ?array
    {
        Recent::pin($chat->getDialogId(), true, $user->getId());
 
        if (Recent::isLimitError())
        {
            $this->addError(new ChatError(ChatError::MAX_PINNED_CHATS_ERROR));
 
            return null;
        }
 
        return ['result' => true];
    }

    public function unpinAction(\Bitrix\Im\V2\Chat $chat, CurrentUser $user): ?array
    {
        Recent::pin($chat->getDialogId(), false, $user->getId());
 
        return ['result' => true];
    }

    public function sortPinAction(\Bitrix\Im\V2\Chat $chat, int $newPosition, CurrentUser $user): ?array
    {
        if ($newPosition <= 0 || $newPosition > Recent::getPinLimit())
        {
            $this->addError(new ChatError(ChatError::INVALID_PIN_POSITION));
 
            return null;
        }
 
        Recent::sortPin($chat, $newPosition, $user->getId());
 
        return ['result' => true];
    }
 
    private function getValidatedType(?string $type): string
    {
        return match ($type)
        {
            'CHANNEL' => \Bitrix\Im\V2\Chat::IM_TYPE_CHANNEL,
            'COPILOT' => \Bitrix\Im\V2\Chat::IM_TYPE_COPILOT,
            'COLLAB' => \Bitrix\Im\V2\Chat::IM_TYPE_COLLAB,
            'AI_ASSISTANT' => \Bitrix\Im\V2\Chat::IM_TYPE_AI_ASSISTANT,
            default => \Bitrix\Im\V2\Chat::IM_TYPE_CHAT,
        };
    }
 
    private function getValidatedEntityType(?string $entityType): ?string
    {
        $convertedEntityType = (string)(new Converter(Converter::TO_UPPER))->process($entityType);
        $extendedType = ExtendedType::tryFrom($convertedEntityType);
 
        return $extendedType?->isInternal() ? null : $convertedEntityType;
    }
    //endregion
    //endregion
}