Tims-Chat/files/lib/data/suspension/Suspension.class.php

<?php

/*
 * Copyright (c) 2010-2024 Tim Düsterhus.
 *
 * Use of this software is governed by the Business Source License
 * included in the LICENSE file.
 *
 * Change Date: 2028-06-15
 *
 * On the date above, in accordance with the Business Source
 * License, use of this software will be governed by version 3
 * or later of the General Public License.
 */

namespace chat\data\suspension;

use chat\data\room\Room;
use chat\data\room\RoomCache;
use wcf\data\DatabaseObject;
use wcf\data\object\type\ObjectType;
use wcf\data\object\type\ObjectTypeCache;
use wcf\data\user\User;
use wcf\system\cache\runtime\UserRuntimeCache;

/**
 * Represents a chat suspension.
 */
class Suspension extends DatabaseObject implements \JsonSerializable
{
    /**
     * Returns the active suspensions for the given (objectTypeID, Room, User)
     * triple.
     *
     * @return \chat\data\suspension\Suspension[]
     */
    public static function getActiveSuspensionsByTriple(int $objectTypeID, User $user, Room $room)
    {
        $suspensionList = new SuspensionList();

        $suspensionList->getConditionBuilder()->add('(expires IS NULL OR expires > ?)', [ TIME_NOW ]);
        $suspensionList->getConditionBuilder()->add('revoked IS NULL');
        $suspensionList->getConditionBuilder()->add('userID = ?', [ $user->userID ]);
        $suspensionList->getConditionBuilder()->add('objectTypeID = ?', [ $objectTypeID ]);
        $suspensionList->getConditionBuilder()->add('(roomID IS NULL OR roomID = ?)', [ $room->roomID ]);

        $suspensionList->readObjects();

        return \array_filter($suspensionList->getObjects(), static function (self $suspension) {
            return $suspension->isActive();
        });
    }

    /**
     * Returns the suspension object type of this message.
     */
    public function getSuspensionType(): ObjectType
    {
        return ObjectTypeCache::getInstance()->getObjectType($this->objectTypeID);
    }

    /**
     * Returns whether this suspension still is in effect.
     */
    public function isActive(): bool
    {
        if ($this->revoked !== null) {
            return false;
        }
        if (!$this->getSuspensionType()->getProcessor()->hasEffect($this)) {
            return false;
        }

        if ($this->expires === null) {
            return true;
        }

        return $this->expires > TIME_NOW;
    }

    /**
     * Returns the chat room this suspension is in effect.
     * Returns null if this is a global suspension.
     */
    public function getRoom(): ?Room
    {
        if ($this->roomID === null) {
            return null;
        }

        return RoomCache::getInstance()->getRoom($this->roomID);
    }

    /**
     * Returns the user that is affected by this suspension.
     */
    public function getUser(): User
    {
        return UserRuntimeCache::getInstance()->getObject($this->userID);
    }

    /**
     * @inheritDoc
     */
    public function jsonSerialize(): array
    {
        return [
            'userID' => $this->userID,
            'username' => $this->getUser()->username,
            'roomID' => $this->roomID,
            'time' => $this->time,
            'expires' => $this->expires,
            'reason' => $this->reason,
            'objectType' => $this->getSuspensionType()->objectType,
            'judgeID' => $this->judgeID,
            'judge' => $this->judge,
        ];
    }
}