Unify the terms 'Staff' and 'Team'

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / moderation / queue / AbstractModerationQueueHandler.class.php

<?php

namespace wcf\system\moderation\queue;

use wcf\data\DatabaseObject;
use wcf\data\moderation\queue\ModerationQueue;
use wcf\data\moderation\queue\ModerationQueueAction;
use wcf\system\cache\runtime\UserProfileRuntimeCache;
use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\exception\InvalidObjectTypeException;
use wcf\system\exception\SystemException;
use wcf\system\moderation\queue\activation\IModerationQueueActivationHandler;
use wcf\system\moderation\queue\report\IModerationQueueReportHandler;
use wcf\system\WCF;

/**
 * Default implementation for moderation queue handlers.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
abstract class AbstractModerationQueueHandler implements IModerationQueueHandler
{
    /**
     * database object class name
     * @var string
     */
    protected $className = '';

    /**
     * definition name
     * @var string
     */
    protected $definitionName = '';

    /**
     * object type
     * @var string
     */
    protected $objectType = '';

    /**
     * required permission for assigned users
     * @var string
     */
    protected $requiredPermission = 'mod.general.canUseModeration';

    /**
     * @inheritDoc
     */
    public function identifyOrphans(array $queues)
    {
        if (
            empty($this->className)
            || !\class_exists($this->className)
            || !\is_subclass_of($this->className, DatabaseObject::class)
        ) {
            throw new SystemException("DatabaseObject class name '" . $this->className . "' is missing or invalid");
        }

        $indexName = \call_user_func([$this->className, 'getDatabaseTableIndexName']);
        $tableName = \call_user_func([$this->className, 'getDatabaseTableName']);

        $conditions = new PreparedStatementConditionBuilder();
        $conditions->add($indexName . " IN (?)", [\array_keys($queues)]);

        $sql = "SELECT  " . $indexName . "
                FROM    " . $tableName . "
                " . $conditions;
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($conditions->getParameters());
        while ($row = $statement->fetchArray()) {
            unset($queues[$row[$indexName]]);
        }

        return \array_values($queues);
    }

    /**
     * @inheritDoc
     */
    public function removeQueues(array $objectIDs)
    {
        $objectTypeID = ModerationQueueManager::getInstance()
            ->getObjectTypeID($this->definitionName, $this->objectType);
        if ($objectTypeID === null) {
            throw new InvalidObjectTypeException($this->objectType, $this->definitionName);
        }

        $conditions = new PreparedStatementConditionBuilder();
        $conditions->add("objectTypeID = ?", [$objectTypeID]);
        $conditions->add("objectID IN (?)", [$objectIDs]);

        $sql = "SELECT  queueID
                FROM    wcf" . WCF_N . "_moderation_queue
                " . $conditions;
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($conditions->getParameters());
        $queueIDs = $statement->fetchAll(\PDO::FETCH_COLUMN);

        if (!empty($queueIDs)) {
            $queueAction = new ModerationQueueAction($queueIDs, 'delete');
            $queueAction->executeAction();
        }
    }

    /**
     * @inheritDoc
     */
    public function canRemoveContent(ModerationQueue $queue)
    {
        return true;
    }

    /**
     * @inheritDoc
     */
    public function isAffectedUser(ModerationQueue $queue, $userID)
    {
        $userProfile = UserProfileRuntimeCache::getInstance()->getObject($userID);

        return $userProfile->getPermission($this->requiredPermission);
    }

    /**
     * @inheritDoc
     * @since   3.0
     */
    public function getCommentNotificationLanguageItemPrefix()
    {
        // this implementation exists to provide backwards compatibility;
        // as there are no abstract implementations of the two interfaces,
        // this is the best approach
        if ($this instanceof IModerationQueueActivationHandler) {
            return 'wcf.moderation.activation.notification';
        } elseif ($this instanceof IModerationQueueReportHandler) {
            return 'wcf.moderation.report.notification';
        }

        return 'wcf.moderation.notification';
    }

    /**
     * @inheritDoc
     */
    public function getCommentNotificationTypeNameLanguageItem(): string
    {
        if ($this instanceof IModerationQueueActivationHandler) {
            return 'wcf.moderation.activation';
        } elseif ($this instanceof IModerationQueueReportHandler) {
            return 'wcf.moderation.report';
        }

        return 'wcf.moderation.moderation';
    }
}