Merge pull request #5989 from WoltLab/wsc-rpc-api-const

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / form / SignatureEditForm.class.php

<?php

namespace wcf\form;

use wcf\data\user\User;
use wcf\data\user\UserAction;
use wcf\system\exception\PermissionDeniedException;
use wcf\system\html\input\HtmlInputProcessor;
use wcf\system\menu\user\UserMenu;
use wcf\system\message\embedded\object\MessageEmbeddedObjectManager;
use wcf\system\user\signature\SignatureCache;
use wcf\system\WCF;

/**
 * Shows the signature edit form.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
class SignatureEditForm extends MessageForm
{
    /**
     * @inheritDoc
     */
    public $disallowedBBCodesPermission = 'user.signature.disallowedBBCodes';

    /**
     * @inheritDoc
     */
    public $loginRequired = true;

    /**
     * @inheritDoc
     */
    public $messageObjectType = 'com.woltlab.wcf.user.signature';

    /**
     * @inheritDoc
     */
    public $attachmentObjectType = 'com.woltlab.wcf.user.signature';

    /**
     * @inheritDoc
     */
    public $neededModules = ['MODULE_USER_SIGNATURE'];

    /**
     * @inheritDoc
     */
    public $showSignatureSetting = false;

    /**
     * parsed signature cache
     * @var string
     */
    public $signatureCache;

    /**
     * @inheritDoc
     */
    public $templateName = 'signatureEdit';

    /**
     * @inheritDoc
     */
    public $neededPermissions = ['user.signature.canEditSignature'];

    /**
     * @inheritDoc
     */
    public function readParameters()
    {
        parent::readParameters();

        // get max text length
        $this->maxTextLength = WCF::getSession()->getPermission('user.signature.maxLength');
        $this->attachmentObjectID = WCF::getUser()->userID;
    }

    /**
     * @inheritDoc
     */
    public function validate()
    {
        if (WCF::getUser()->disableSignature) {
            throw new PermissionDeniedException();
        }

        AbstractForm::validate();

        if (!empty($this->text)) {
            $this->validateText();
        } else {
            $this->htmlInputProcessor = new HtmlInputProcessor();
            $this->htmlInputProcessor->process($this->text, $this->messageObjectType, WCF::getUser()->userID);
        }
    }

    /**
     * @inheritDoc
     */
    public function readData()
    {
        parent::readData();

        // default values
        if (empty($_POST)) {
            $this->text = WCF::getUser()->signature;
        }

        $this->signatureCache = SignatureCache::getInstance()->getSignature(WCF::getUser());
    }

    /**
     * @inheritDoc
     */
    public function assignVariables()
    {
        parent::assignVariables();

        WCF::getTPL()->assign([
            'signatureCache' => $this->signatureCache,
        ]);
    }

    /**
     * @inheritDoc
     */
    public function show()
    {
        // set active tab
        UserMenu::getInstance()->setActiveMenuItem('wcf.user.menu.profile.signature');

        parent::show();
    }

    /**
     * @inheritDoc
     */
    public function save()
    {
        parent::save();
        $this->htmlInputProcessor->setObjectID(WCF::getUser()->userID);
        MessageEmbeddedObjectManager::getInstance()->registerObjects($this->htmlInputProcessor);

        $this->objectAction = new UserAction([WCF::getUser()], 'update', [
            'data' => \array_merge($this->additionalFields, [
                'signature' => $this->htmlInputProcessor->getHtml(),
                'signatureEnableHtml' => 1,
            ]),
            'signatureAttachmentHandler' => $this->attachmentHandler,
        ]);
        $this->objectAction->executeAction();
        SignatureCache::getInstance()->getSignature(new User(WCF::getUser()->userID));
        $this->saved();

        // show success message
        WCF::getTPL()->assign('success', true);
    }
}