chat.php

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

<?php
namespace Bitrix\Im\Model;
 
use Bitrix\Im\Internals\ChatIndex;
use Bitrix\Im\V2\Chat;
use Bitrix\Im\V2\Sync;
use Bitrix\Main\DB\SqlQueryException;
use Bitrix\Main\Entity;
use Bitrix\Main\Loader;
use Bitrix\Main\ORM\Event;
use Bitrix\Main\ORM\Fields\Relations\Reference;
use Bitrix\Main\ORM\Query\Join;
use Bitrix\Main\ORM\Query\Query;
use Bitrix\Main\Search\MapBuilder;
use Bitrix\Im\Text;
 

 
class ChatTable extends Entity\DataManager
{
    public static function getFilePath()
    {
        return __FILE__;
    }
 
    public static function getTableName()
    {
        return 'b_im_chat';
    }
 
    public static function getMap()
    {
        return array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
                //'title' => Loc::getMessage('CHAT_ENTITY_ID_FIELD'),
            ),
            'PARENT_ID' => array(
                'data_type' => 'integer',
                'default_value' => 0,
            ),
            'PARENT_MID' => array(
                'data_type' => 'integer',
                'default_value' => 0,
            ),
            'TITLE' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateTitle'),
                //'title' => Loc::getMessage('CHAT_ENTITY_TITLE_FIELD'),
                'save_data_modification' => array('\Bitrix\Main\Text\Emoji', 'getSaveModificator'),
                'fetch_data_modification' => array('\Bitrix\Main\Text\Emoji', 'getFetchModificator'),
            ),
            'DESCRIPTION' => array(
                'data_type' => 'text',
                //'title' => Loc::getMessage('CHAT_ENTITY_DESCRIPTION_FIELD'),
                'save_data_modification' => array(Text::class, 'getSaveModificator'),
                'fetch_data_modification' => array(Text::class, 'getFetchModificator'),
                'nullable' => true,
            ),
            'COLOR' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateColor'),
                //'title' => Loc::getMessage('CHAT_ENTITY_COLOR_FIELD'),
            ),
            'TYPE' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateType'),
                //'title' => Loc::getMessage('CHAT_ENTITY_TYPE_FIELD'),
                'default_value' => 'C',
            ),
            'EXTRANET' => array(
                'data_type' => 'boolean',
                'values' => array('N', 'Y'),
                //'title' => Loc::getMessage('CHAT_ENTITY_EXTRANET_FIELD'),
                'default_value' => 'N',
            ),
            'AUTHOR_ID' => array(
                'data_type' => 'integer',
                'required' => true,
                //'title' => Loc::getMessage('CHAT_ENTITY_AUTHOR_ID_FIELD'),
            ),
            'AVATAR' => array(
                'data_type' => 'integer'
            ),
            'CALL_TYPE' => array(
                'data_type' => 'integer',
                //'title' => Loc::getMessage('CHAT_ENTITY_CALL_TYPE_FIELD'),
            ),
            'CALL_NUMBER' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateCallNumber'),
                //'title' => Loc::getMessage('CHAT_ENTITY_CALL_NUMBER_FIELD'),
            ),
            'ENTITY_TYPE' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateEntityType'),
                //'title' => Loc::getMessage('CHAT_ENTITY_ENTITY_TYPE_FIELD'),
            ),
            'ENTITY_ID' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateEntityId'),
                //'title' => Loc::getMessage('CHAT_ENTITY_ENTITY_ID_FIELD'),
            ),
            'ENTITY_DATA_1' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateEntityData'),
                //'title' => Loc::getMessage('CHAT_ENTITY_ENTITY_DATA_1_FIELD'),
            ),
            'ENTITY_DATA_2' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateEntityData'),
                //'title' => Loc::getMessage('CHAT_ENTITY_ENTITY_DATA_2_FIELD'),
            ),
            'ENTITY_DATA_3' => array(
                'data_type' => 'string',
                'validation' => array(__CLASS__, 'validateEntityData'),
                //'title' => Loc::getMessage('CHAT_ENTITY_ENTITY_DATA_3_FIELD'),
            ),
            'AUTHOR' => array(
                'data_type' => 'Bitrix\Main\User',
                'reference' => array('=this.AUTHOR_ID' => 'ref.ID'),
            ),
            'DISK_FOLDER_ID' => array(
                'data_type' => 'integer'
            ),
            'PIN_MESSAGE_ID' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'MESSAGE_COUNT' => array(
                'data_type' => 'integer',
                'default_value' => 0,
            ),
            'USER_COUNT' => array(
                'data_type' => 'integer',
                'default_value' => 0,
            ),
            'PREV_MESSAGE_ID' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'LAST_MESSAGE_ID' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'LAST_MESSAGE_STATUS' => array(
                'data_type' => 'string',
                'default_value' => IM_MESSAGE_STATUS_RECEIVED,
                'validation' => array(__CLASS__, 'validateMessageStatus'),
            ),
            'DATE_CREATE' => array(
                'data_type' => 'datetime',
                'required' => false,
                'default_value' => array(__CLASS__, 'getCurrentDate'),
            ),
            'MANAGE_USERS_ADD' => array(
                'data_type' => 'string',
                'default_value' => Chat::MANAGE_RIGHTS_MEMBER,
            ),
            'MANAGE_USERS_DELETE' => array(
                'data_type' => 'string',
                'default_value' => Chat::MANAGE_RIGHTS_MANAGERS,
            ),
            'MANAGE_UI' => array(
                'data_type' => 'string',
                'default_value' => Chat::MANAGE_RIGHTS_MEMBER,
            ),
            'MANAGE_SETTINGS' => array(
                'data_type' => 'string',
                'default_value' => Chat::MANAGE_RIGHTS_OWNER,
            ),
            'CAN_POST' => array(
                'data_type' => 'string',
                'default_value' => Chat::MANAGE_RIGHTS_MEMBER,
            ),
            'INDEX' => array(
                'data_type' => 'Bitrix\Im\Model\ChatIndex',
                'reference' => array('=this.ID' => 'ref.CHAT_ID'),
                'join_type' => 'INNER',
            ),
            'OL_INDEX' => array(
                'data_type' => 'Bitrix\ImOpenLines\Model\ChatIndexTable',
                'reference' => array('=this.ID' => 'ref.CHAT_ID'),
                'join_type' => 'INNER',
            ),
            'ALIAS' => array(
                'data_type' => 'Bitrix\Im\Model\AliasTable',
                'reference' => array(
                    '=this.ID' => 'ref.ENTITY_ID',
                    '=this.ENTITY_TYPE' => 'ref.ENTITY_TYPE'
                ),
                'join_type' => 'LEFT',
            ),
            'DISAPPEARING_TIME' => array(
                'data_type' => 'integer'
            ),
        );
    }
 
    public static function withRelation(Query $query, ?int $userId): void
    {
        $join = Join::on('this.ID', 'ref.CHAT_ID');
        if ($userId !== null)
        {
            $join->where('ref.USER_ID', $userId);
        }
        $query->registerRuntimeField(
            'RELATION',
            new Reference(
                'RELATION',
                RelationTable::class,
                $join,
                ['join_type' => Join::TYPE_LEFT]
            )
        );
    }
 
    public static function onAfterUpdate(\Bitrix\Main\ORM\Event $event)
    {
        $fields = $event->getParameter("fields");
        if (isset($fields['TITLE']))
        {
            $primary = $event->getParameter("id");
 
            $chatIndex =
                ChatIndex::create()
                    ->setChatId((int)$primary["ID"])
            ;
            static::updateIndexRecord($chatIndex);
        }
 
        $chatId = (int)$event->getParameter("id")['ID'];
        if (static::needCacheInvalidate($fields))
        {
            Chat::cleanCache($chatId);
        }
        elseif (static::needCacheUpdate($fields))
        {
            Chat::updateStateAfterOrmEvent($chatId, $fields);
            Chat::cleanCache($chatId, false);
        }
 
        Sync\Logger::getInstance()->add(
            new Sync\Event(Sync\Event::ADD_EVENT, Sync\Event::CHAT_ENTITY, $chatId),
            static fn () => Chat::getInstance($chatId)->getRelations()->getUserIds(),
            Chat::getInstance($chatId)
        );
 
        return new Entity\EventResult();
    }
 
    public static function onAfterDelete(Event $event)
    {
        $id = (int)$event->getParameter('primary')['ID'];
        Chat::cleanCache($id);
 
        return new Entity\EventResult();
    }
 
    public static function indexRecord(ChatIndex $chatIndex)
    {
        if ($chatIndex->getChatId() === 0)
        {
            return;
        }
 
        $record = static::getRecordChatData($chatIndex->getChatId());
        if(!is_array($record))
        {
            return;
        }
 
        $chatIndex->setTitle($record['TITLE']);
 
        ChatIndexTable::merge([
            'CHAT_ID' => $chatIndex->getChatId(),
            'SEARCH_CONTENT' => MapBuilder::create()->addText(self::generateSearchContent($chatIndex))->build(),
            'SEARCH_TITLE' => MapBuilder::create()->addText(self::generateSearchTitle($chatIndex))->build(),
        ]);
    }
 
    public static function addIndexRecord(ChatIndex $index)
    {
        if ($index->getChatId() === 0)
        {
            return;
        }
        $insertData = self::prepareParamsForIndex($index);
 
        try
        {
            ChatIndexTable::add($insertData);
        }
        catch (SqlQueryException)
        {
            self::updateIndexRecord($index);
        }
    }
 
    public static function updateIndexRecord(ChatIndex $index)
    {
        $record = static::getRecordChatData($index->getChatId());
        if(!is_array($record))
        {
            return;
        }
 
        if ($record['TYPE'] === Chat::IM_TYPE_OPEN_LINE)
        {
            if (Loader::includeModule('imopenlines'))
            {
                \Bitrix\ImOpenLines\Model\ChatIndexTable::updateIndex($index->getChatId(), $record['TITLE'] ?? null);
            }
 
            return;
        }
 
        $index->setTitle($record['TITLE']);
        $updateData = self::prepareParamsForIndex($index);
 
        ChatIndexTable::updateIndex(
            $index->getChatId(),
            'CHAT_ID',
            $updateData
        );
    }
 
    protected static function needCacheInvalidate(array $updatedFields): bool
    {
        $cacheInvalidatingFields = [
            'TYPE',
            'ENTITY_TYPE',
        ];
 
        return !empty(array_intersect($cacheInvalidatingFields, array_keys($updatedFields)));
    }
 
    protected static function needCacheUpdate(array $updatedFields): bool
    {
        $cacheUpdatingFields = [
            'TITLE',
            'DESCRIPTION',
            'COLOR',
            'EXTRANET',
            'AUTHOR_ID',
            'AVATAR',
            'ENTITY_ID',
            'ENTITY_DATA_1',
            'ENTITY_DATA_2',
            'ENTITY_DATA_3',
            'DISK_FOLDER_ID',
            'MANAGE_USERS_ADD',
            'MANAGE_USERS_DELETE',
            'MANAGE_UI',
            'MANAGE_SETTINGS',
            'CAN_POST',
        ];
 
        return !empty(array_intersect($cacheUpdatingFields, array_keys($updatedFields)));
    }
 

    public static function generateSearchContent(ChatIndex $chatIndex)
    {
        $indexTitle = $chatIndex->getClearedTitle();
        $userNameList = static::getChatUserNameList($chatIndex);
 
        return $indexTitle . ' ' . implode(' ', $userNameList);
    }
 
    public static function generateSearchTitle(ChatIndex $chatIndex): string
    {
        return $chatIndex->getClearedTitle();
    }
 
    public static function validateTitle()
    {
        return array(
            new Entity\Validator\Length(null, 255),
        );
    }
    public static function validateType()
    {
        return array(
            new Entity\Validator\Length(null, 1),
        );
    }
    public static function validateColor()
    {
        return array(
            new Entity\Validator\Length(null, 255),
        );
    }
    public static function validateEntityType()
    {
        return array(
            new Entity\Validator\Length(null, 50),
        );
    }
    public static function validateEntityId()
    {
        return array(
            new Entity\Validator\Length(null, 255),
        );
    }
    public static function validateCallNumber()
    {
        return array(
            new Entity\Validator\Length(null, 20),
        );
    }
    public static function validateEntityData()
    {
        return array(
            new Entity\Validator\Length(null, 255),
        );
    }
    public static function getCurrentDate()
    {
        return new \Bitrix\Main\Type\DateTime();
    }
    public static function validateMessageStatus()
    {
        return array(
            new Entity\Validator\Length(null, 50),
        );
    }

    private static function getRecordChatData(int $id)
    {
        return
            self::query()
                ->setSelect(['*'])
                ->where('ID', $id)
                ->where(
                    Query::filter()
                        ->logic('or')
                        ->whereNot('ENTITY_TYPE', 'LIVECHAT')
                        ->whereNull('ENTITY_TYPE')
                )
                ->whereNotIn('TYPE', [\Bitrix\Im\Chat::TYPE_SYSTEM, \Bitrix\Im\Chat::TYPE_PRIVATE])
                ->fetch()
            ;
    }
 
    private static function getChatUserNameList(ChatIndex $chatIndex): array
    {
        if (!$chatIndex->isEmptyUsers())
        {
            return $chatIndex->getClearedUserList();
        }
 
        $query =
            \Bitrix\Im\Model\RelationTable::query()
                ->addSelect('USER_ID')
                ->where('CHAT_ID', $chatIndex->getChatId())
                ->setLimit(100)
        ;
 
        $clearedUsers = [];
        foreach ($query->exec() as $relation)
        {
            $rowUserName = \Bitrix\Im\User::getInstance($relation['USER_ID'])->getFullName(false);
            $clearedUsers[] = ChatIndex::clearText($rowUserName);
        }
 
        return $clearedUsers;
    }

    private static function prepareParamsForIndex(ChatIndex $index): array
    {
        return [
            'CHAT_ID' => $index->getChatId(),
            'SEARCH_CONTENT' => MapBuilder::create()->addText(self::generateSearchContent($index))->build(),
            'SEARCH_TITLE' => MapBuilder::create()->addText(self::generateSearchTitle($index))->build(),
        ];
    }
}