class.ilChatroomXMLParser.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilChatroomXMLParser extends ilSaxParser
{
    protected ilObjChatroom $chat;
    protected ilChatroom $room;
    protected string $cdata = '';
    protected bool $in_sub_rooms = false;
    protected bool $in_messages = false;
    protected ?string $import_install_id = null;
    protected ?int $exportRoomId = 0;
    protected ?int $exportSubRoomId = 0;
    protected ?int $owner = 0;
    protected ?int $closed = 0;
    protected ?int $public = 0;
    protected ?int $timestamp = 0;
    protected ?string $message = '';
    protected ?string $title = '';
    protected array $userIds = [];
    protected array $subRoomIdMapping = [];

    public function __construct(ilObjChatroom $chat, string $a_xml_data)
    {
        parent::__construct();

        $this->chat = $chat;

        $room = ilChatroom::byObjectId($this->chat->getId());
        if ($room !== null) {
            $this->room = $room;
        } else {
            $this->room = new ilChatroom();
            $this->room->setSetting('object_id', $this->chat->getId());
            $this->room->save();
        }

        $this->setXMLContent('<?xml version="1.0" encoding="utf-8"?>' . $a_xml_data);
    }

    public function setImportInstallId(?string $id): void
    {
        $this->import_install_id = $id;
    }

    public function getImportInstallId(): ?string
    {
        return $this->import_install_id;
    }

    private function isSameInstallation(): bool
    {
        return defined('IL_INST_ID') && IL_INST_ID > 0 && $this->getImportInstallId() == IL_INST_ID;
    }

    public function setHandlers($a_xml_parser): void
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, [$this, 'handlerBeginTag'], [$this, 'handlerEndTag']);
        xml_set_character_data_handler($a_xml_parser, [$this, 'handlerCharacterData']);
    }

    public function handlerBeginTag($a_xml_parser, string $a_name, array $a_attribs): void
    {
        switch ($a_name) {
            case 'SubRooms':
                $this->in_sub_rooms = true;
                break;

            case 'Messages':
                $this->in_messages = true;
                break;
        }
    }

    public function handlerEndTag($a_xml_parser, string $a_name): void
    {
        $this->cdata = trim($this->cdata);

        switch ($a_name) {
            case 'Title':
                if ($this->in_sub_rooms) {
                    $this->title = ilUtil::stripSlashes($this->cdata);
                } else {
                    $this->chat->setTitle(ilUtil::stripSlashes($this->cdata));
                }
                break;

            case 'Description':
                $this->chat->setDescription(ilUtil::stripSlashes($this->cdata));
                break;

            case 'OnlineStatus':
                $this->room->setSetting('online_status', (int) $this->cdata);
                break;

            case 'AllowAnonymousAccess':
                $this->room->setSetting('allow_anonymous', (int) $this->cdata);
                break;

            case 'AllowCustomUsernames':
                $this->room->setSetting('allow_custom_usernames', (int) $this->cdata);
                break;

            case 'EnableHistory':
                $this->room->setSetting('enable_history', (int) $this->cdata);
                break;

            case 'RestrictHistory':
                $this->room->setSetting('restrict_history', (int) $this->cdata);
                break;

            case 'PrivateRoomsEnabled':
                $this->room->setSetting('private_rooms_enabled', (int) $this->cdata);
                break;

            case 'DisplayPastMessages':
                $this->room->setSetting('display_past_msgs', (int) $this->cdata);
                break;

            case 'AutoGeneratedUsernameSchema':
                $this->room->setSetting('autogen_usernames', ilUtil::stripSlashes($this->cdata));
                break;

            case 'RoomId':
                $this->exportRoomId = (int) $this->cdata;
                break;

            case 'SubRoomId':
                $this->exportSubRoomId = (int) $this->cdata;
                break;

            case 'Owner':
                $this->owner = (int) $this->cdata;
                break;

            case 'Closed':
                $this->closed = (int) $this->cdata;
                break;

            case 'Public':
                $this->public = (int) $this->cdata;
                break;

            case 'CreatedTimestamp':
                $this->timestamp = (int) $this->cdata;
                break;

            case 'PrivilegedUserId':
                $this->userIds[] = (int) $this->cdata;
                break;

            case 'SubRoom':
                if ($this->exportRoomId > 0 && $this->isSameInstallation()) {
                    $user = new ilObjUser();
                    $user->setId((int) $this->owner);

                    $chat_user = new ilChatroomUser($user, $this->room);
                    $subRoomId = $this->room->addPrivateRoom(
                        $this->title,
                        $chat_user,
                        [
                            'public' => (bool) $this->public,
                            'created' => (int) $this->timestamp,
                            'closed' => (bool) $this->closed
                        ]
                    );

                    foreach ($this->userIds as $userId) {
                        $this->room->inviteUserToPrivateRoom($userId, $subRoomId);
                    }

                    $this->subRoomIdMapping[$this->exportSubRoomId] = $subRoomId;
                }

                $this->exportSubRoomId = 0;
                $this->title = '';
                $this->owner = 0;
                $this->closed = 0;
                $this->public = 0;
                $this->timestamp = 0;
                $this->userIds = [];
                break;

            case 'SubRooms':
                $this->in_sub_rooms = false;
                break;

            case 'Body':
                $this->message = $this->cdata;
                break;

            case 'Message':
                if ($this->isSameInstallation()) {
                    $message = json_decode($this->message, true, 512, JSON_THROW_ON_ERROR);
                    if (
                        is_array($message) &&
                        (0 === $this->exportSubRoomId || array_key_exists($this->exportSubRoomId, $this->subRoomIdMapping))
                    ) {
                        $message['roomId'] = $this->room->getRoomId();
                        $message['subRoomId'] = $this->exportSubRoomId ? $this->subRoomIdMapping[$this->exportSubRoomId] : 0;
                        $message['sub'] = $message['subRoomId'];
                        $message['timestamp'] = $this->timestamp;

                        $this->room->addHistoryEntry($message);
                    }
                }

                $this->timestamp = 0;
                $this->exportSubRoomId = 0;
                break;

            case 'Messages':
                $this->in_messages = false;
                break;

            case 'Chatroom':
                $this->chat->update();
                // Set imported chats to offline
                $this->room->setSetting('online_status', 0);
                $this->room->save();
                break;
        }

        $this->cdata = '';
    }

    public function handlerCharacterData($a_xml_parser, string $a_data): void
    {
        if ($a_data !== "\n") {
            $this->cdata .= preg_replace("/\t+/", ' ', $a_data);
        }
    }
}