Merge branch '5.5'

[GitHub/WoltLab/com.woltlab.wcf.conversation.git] / files / lib / system / clipboard / action / ConversationClipboardAction.class.php

<?php

namespace wcf\system\clipboard\action;

use wcf\data\clipboard\action\ClipboardAction;
use wcf\data\conversation\Conversation;
use wcf\data\conversation\ConversationAction;
use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\WCF;

/**
 * Prepares clipboard editor items for conversations.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
class ConversationClipboardAction extends AbstractClipboardAction
{
    /**
     * @inheritDoc
     */
    protected $actionClassActions = ['close', 'markAsRead', 'open'];

    /**
     * list of conversations
     * @var Conversation[]
     */
    public $conversations;

    /**
     * @inheritDoc
     */
    protected $supportedActions = [
        'assignLabel',
        'close',
        'leave',
        'leavePermanently',
        'markAsRead',
        'open',
        'restore',
    ];

    /**
     * @inheritDoc
     */
    public function execute(array $objects, ClipboardAction $action)
    {
        if ($this->conversations === null) {
            // validate conversations
            $this->validateParticipation($objects);
        }

        // check if no conversation was accessible
        if (empty($this->conversations)) {
            return null;
        }

        $item = parent::execute($objects, $action);

        if ($item === null) {
            return null;
        }

        switch ($action->actionName) {
            case 'assignLabel':
                // check if user has labels
                $sql = "SELECT  COUNT(*) AS count
                        FROM    wcf" . WCF_N . "_conversation_label
                        WHERE   userID = ?";
                $statement = WCF::getDB()->prepareStatement($sql);
                $statement->execute([WCF::getUser()->userID]);
                $row = $statement->fetchArray();
                if ($row['count'] == 0) {
                    return null;
                }

                $item->addParameter('objectIDs', \array_keys($this->conversations));
                break;

            case 'leave':
                $item->addInternalData('parameters', ['hideConversation' => 1]);
                $item->addParameter('actionName', 'hideConversation');
                $item->addParameter('className', $this->getClassName());
                break;

            case 'leavePermanently':
                $item->addParameter('objectIDs', \array_keys($this->conversations));
                $item->addInternalData('parameters', ['hideConversation' => 2]);
                $item->addParameter('actionName', 'hideConversation');
                $item->addParameter('className', $this->getClassName());
                break;

            case 'markAsRead':
                $item->addParameter('objectIDs', \array_keys($this->conversations));
                $item->addParameter('actionName', 'markAsRead');
                $item->addParameter('className', $this->getClassName());
                $item->addInternalData(
                    'confirmMessage',
                    WCF::getLanguage()->getDynamicVariable(
                        'wcf.clipboard.item.com.woltlab.wcf.conversation.conversation.markAsRead.confirmMessage',
                        [
                            'count' => $item->getCount(),
                        ]
                    )
                );
                break;

            case 'restore':
                $item->addInternalData('parameters', ['hideConversation' => 0]);
                $item->addParameter('actionName', 'hideConversation');
                $item->addParameter('className', $this->getClassName());
                break;
        }

        return $item;
    }

    /**
     * @inheritDoc
     */
    public function getClassName()
    {
        return ConversationAction::class;
    }

    /**
     * @inheritDoc
     */
    public function getTypeName()
    {
        return 'com.woltlab.wcf.conversation.conversation';
    }

    /**
     * Returns a list of conversations with user participation.
     *
     * @param Conversation[] $conversations
     */
    protected function validateParticipation(array $conversations)
    {
        $conversationIDs = [];

        // validate ownership
        foreach ($conversations as $conversation) {
            if ($conversation->userID != WCF::getUser()->userID) {
                $conversationIDs[] = $conversation->conversationID;
            }
        }

        // validate participation as non-owner
        if (!empty($conversationIDs)) {
            $conditions = new PreparedStatementConditionBuilder();
            $conditions->add("conversationID IN (?)", [$conversationIDs]);
            $conditions->add("participantID = ?", [WCF::getUser()->userID]);

            $sql = "SELECT  conversationID
                    FROM    wcf" . WCF_N . "_conversation_to_user
                    " . $conditions;
            $statement = WCF::getDB()->prepareStatement($sql);
            $statement->execute($conditions->getParameters());
            while ($row = $statement->fetchArray()) {
                $index = \array_search($row['conversationID'], $conversationIDs);
                unset($conversationIDs[$index]);
            }

            // remove unaccessible conversations
            if (!empty($conversationIDs)) {
                foreach ($conversations as $index => $conversation) {
                    if (\in_array($conversation->conversationID, $conversationIDs)) {
                        unset($conversations[$index]);
                    }
                }
            }
        }

        foreach ($conversations as $conversation) {
            $this->conversations[$conversation->conversationID] = $conversation;
        }
    }

    /**
     * Validates if user may close the given conversations.
     *
     * @return  int[]
     */
    protected function validateClose()
    {
        $conversationIDs = [];

        foreach ($this->conversations as $conversation) {
            if (!$conversation->isClosed && $conversation->userID == WCF::getUser()->userID) {
                $conversationIDs[] = $conversation->conversationID;
            }
        }

        return $conversationIDs;
    }

    /**
     * Validates conversations available for leaving.
     *
     * @return  int[]
     */
    public function validateLeave()
    {
        $tmpIDs = [];
        foreach ($this->conversations as $conversation) {
            $tmpIDs[] = $conversation->conversationID;
        }

        $conditions = new PreparedStatementConditionBuilder();
        $conditions->add("conversationID IN (?)", [$tmpIDs]);
        $conditions->add("participantID = ?", [WCF::getUser()->userID]);
        $conditions->add("hideConversation <> ?", [1]);

        $sql = "SELECT  conversationID
                FROM    wcf" . WCF_N . "_conversation_to_user
                " . $conditions;
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($conditions->getParameters());

        return $statement->fetchAll(\PDO::FETCH_COLUMN);
    }

    /**
     * Validates conversations applicable for mark as read.
     *
     * @return  int[]
     */
    public function validateMarkAsRead()
    {
        $conversationIDs = [];

        $conditions = new PreparedStatementConditionBuilder();
        $conditions->add("conversationID IN (?)", [\array_keys($this->conversations)]);
        $conditions->add("participantID = ?", [WCF::getUser()->userID]);

        $sql = "SELECT  conversationID, lastVisitTime
                FROM    wcf" . WCF_N . "_conversation_to_user
                " . $conditions;
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($conditions->getParameters());
        $lastVisitTime = [];
        while ($row = $statement->fetchArray()) {
            $lastVisitTime[$row['conversationID']] = $row['lastVisitTime'];
        }

        foreach ($this->conversations as $conversation) {
            if (
                isset($lastVisitTime[$conversation->conversationID])
                && $lastVisitTime[$conversation->conversationID] < $conversation->lastPostTime
            ) {
                $conversationIDs[] = $conversation->conversationID;
            }
        }

        return $conversationIDs;
    }

    /**
     * Validates if user may open the given conversations.
     *
     * @return  int[]
     */
    protected function validateOpen()
    {
        $conversationIDs = [];

        foreach ($this->conversations as $conversation) {
            if ($conversation->isClosed && $conversation->userID == WCF::getUser()->userID) {
                $conversationIDs[] = $conversation->conversationID;
            }
        }

        return $conversationIDs;
    }

    /**
     * Validates conversations available for restore.
     *
     * @return  int[]
     */
    public function validateRestore()
    {
        $tmpIDs = [];
        foreach ($this->conversations as $conversation) {
            $tmpIDs[] = $conversation->conversationID;
        }

        $conditions = new PreparedStatementConditionBuilder();
        $conditions->add("conversationID IN (?)", [$tmpIDs]);
        $conditions->add("participantID = ?", [WCF::getUser()->userID]);
        $conditions->add("hideConversation <> ?", [0]);

        $sql = "SELECT  conversationID
                FROM    wcf" . WCF_N . "_conversation_to_user
                " . $conditions;
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($conditions->getParameters());

        return $statement->fetchAll(\PDO::FETCH_COLUMN);
    }
}