BBCodeAddForm.class.php

<?php

namespace wcf\acp\form;

use wcf\data\bbcode\attribute\BBCodeAttributeAction;
use wcf\data\bbcode\BBCode;
use wcf\data\bbcode\BBCodeAction;
use wcf\form\AbstractForm;
use wcf\system\bbcode\command\SaveContent;
use wcf\system\exception\UserInputException;
use wcf\system\language\LanguageFactory;
use wcf\system\Regex;
use wcf\system\request\LinkHandler;
use wcf\system\WCF;
use wcf\util\ArrayUtil;
use wcf\util\StringUtil;

/**
 * Shows the bbcode add form.
 *
 * @author  Tim Duesterhus
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
class BBCodeAddForm extends AbstractForm
{
    /**
     * @inheritDoc
     */
    public $activeMenuItem = 'wcf.acp.menu.link.bbcode.add';

    /**
     * list of attributes
     * @var object[]
     */
    public $attributes = [];

    /**
     * tag name
     * @var string
     */
    public $bbcodeTag = '';

    /**
     * editor button label
     *
     * @var string|string[]
     */
    public $buttonLabel = '';

    /**
     * class name
     * @var string
     */
    public $className = '';

    /**
     * closing html tag
     * @var string
     */
    public $htmlClose = '';

    /**
     * opening html tag
     * @var string
     */
    public $htmlOpen = '';

    /**
     * true if bbcode is a block element
     * @var bool
     */
    public $isBlockElement = false;

    /**
     * true, if bbcode contains source code
     * @var bool
     */
    public $isSourceCode = false;

    /**
     * @inheritDoc
     */
    public $neededPermissions = ['admin.content.bbcode.canManageBBCode'];

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

    /**
     * show editor button
     * @var bool
     */
    public $showButton = false;

    /**
     * wysiwyg editor icon
     * @var string
     */
    public $wysiwygIcon = '';

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

        if (isset($_POST['attributes'])) {
            $this->attributes = $_POST['attributes'];
        }
        if (isset($_POST['bbcodeTag'])) {
            $this->bbcodeTag = \mb_strtolower(StringUtil::trim($_POST['bbcodeTag']));
        }
        if (isset($_POST['className'])) {
            $this->className = StringUtil::trim($_POST['className']);
        }
        if (isset($_POST['htmlClose'])) {
            $this->htmlClose = StringUtil::trim($_POST['htmlClose']);
        }
        if (isset($_POST['htmlOpen'])) {
            $this->htmlOpen = StringUtil::trim($_POST['htmlOpen']);
        }
        if (isset($_POST['isBlockElement'])) {
            $this->isBlockElement = true;
        }
        if (isset($_POST['isSourceCode'])) {
            $this->isSourceCode = true;
        }
        if (isset($_POST['showButton'])) {
            $this->showButton = true;
        }
        if (isset($_POST['wysiwygIcon'])) {
            $this->wysiwygIcon = StringUtil::trim($_POST['wysiwygIcon']);
        }

        $attributeNo = 0;
        foreach ($this->attributes as $key => $val) {
            $val['attributeNo'] = $attributeNo++;
            $val['required'] = (int)isset($val['required']);
            $val['useText'] = (int)isset($val['useText']);
            $this->attributes[$key] = (object)$val;
        }

        $this->readButtonLabelFormParameter();
    }

    /**
     * Reads the form parameter for the button label.
     *
     * @return void
     */
    protected function readButtonLabelFormParameter()
    {
        if (isset($_POST['buttonLabel_i18n']) && \is_array($_POST['buttonLabel_i18n'])) {
            $this->buttonLabel = ArrayUtil::trim($_POST['buttonLabel_i18n']);
        } elseif (isset($_POST['buttonLabel'])) {
            $this->buttonLabel = StringUtil::trim($_POST['buttonLabel']);
        }
    }

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

        // tag name must not be empty
        if (empty($this->bbcodeTag)) {
            throw new UserInputException('bbcodeTag');
        }

        // tag may only contain alphanumeric chars
        if (!Regex::compile('^[a-z0-9]+$', Regex::CASE_INSENSITIVE)->match($this->bbcodeTag)) {
            throw new UserInputException('bbcodeTag', 'invalid');
        }

        // disallow the Pseudo-BBCodes all and none
        if ($this->bbcodeTag == 'all' || $this->bbcodeTag == 'none') {
            throw new UserInputException('bbcodeTag', 'invalid');
        }

        // check whether the tag is in use
        $this->validateBBCodeTagUsage();

        // validate class
        if (!empty($this->className) && !\class_exists($this->className)) {
            throw new UserInputException('className', 'notFound');
        }

        // validate attributes
        foreach ($this->attributes as $attribute) {
            // Check whether the pattern is a valid regex
            if (!Regex::compile($attribute->validationPattern)->isValid()) {
                throw new UserInputException('attributeValidationPattern' . $attribute->attributeNo, 'invalid');
            }
        }

        // button
        if ($this->showButton) {
            // validate label
            if (\is_array($this->buttonLabel)) {
                foreach (LanguageFactory::getInstance()->getLanguages() as $language) {
                    if (empty($this->buttonLabel[$language->languageID])) {
                        throw new UserInputException('buttonLabel', 'multilingual');
                    }
                }
            } elseif ($this->buttonLabel === '') {
                throw new UserInputException('buttonLabel');
            }

            // validate image path
            if (empty($this->wysiwygIcon)) {
                throw new UserInputException('wysiwygIcon');
            }
        } else {
            $this->buttonLabel = '';
        }
    }

    /**
     * Validates the bbcode tag usage.
     *
     * @return void
     * @throws UserInputException
     */
    protected function validateBBCodeTagUsage()
    {
        $bbcode = BBCode::getBBCodeByTag($this->bbcodeTag);
        if ($bbcode->bbcodeID) {
            throw new UserInputException('bbcodeTag', 'inUse');
        }
    }

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

        // save bbcode
        $this->objectAction = new BBCodeAction([], 'create', [
            'data' => \array_merge($this->additionalFields, [
                'bbcodeTag' => $this->bbcodeTag,
                'className' => $this->className,
                'htmlOpen' => $this->htmlOpen,
                'htmlClose' => $this->htmlClose,
                'isBlockElement' => $this->isBlockElement ? 1 : 0,
                'isSourceCode' => $this->isSourceCode ? 1 : 0,
                'packageID' => 1,
                'showButton' => $this->showButton ? 1 : 0,
                'wysiwygIcon' => $this->wysiwygIcon,
            ]),
        ]);
        $returnValues = $this->objectAction->executeAction();
        $bbcodeID = $returnValues['returnValues']->bbcodeID;

        $this->saveButtonLabel($bbcodeID);

        foreach ($this->attributes as $attribute) {
            $attributeAction = new BBCodeAttributeAction([], 'create', [
                'data' => [
                    'bbcodeID' => $bbcodeID,
                    'attributeNo' => $attribute->attributeNo,
                    'attributeHtml' => $attribute->attributeHtml,
                    'validationPattern' => $attribute->validationPattern,
                    'required' => $attribute->required,
                    'useText' => $attribute->useText,
                ],
            ]);
            $attributeAction->executeAction();
        }

        $this->saved();

        // reset values
        $this->bbcodeTag = $this->htmlOpen = $this->htmlClose = $this->className = $this->buttonLabel = $this->wysiwygIcon = '';
        $this->attributes = [];
        $this->isBlockElement = $this->isSourceCode = $this->showButton = false;

        // show success message
        WCF::getTPL()->assign([
            'success' => true,
            'objectEditLink' => LinkHandler::getInstance()->getControllerLink(
                BBCodeEditForm::class,
                ['id' => $returnValues['returnValues']->bbcodeID]
            ),
        ]);
    }

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

        WCF::getTPL()->assign([
            'action' => 'add',
            'attributes' => $this->attributes,
            'bbcodeTag' => $this->bbcodeTag,
            'buttonLabel' => $this->buttonLabel,
            'availableLanguages' => LanguageFactory::getInstance()->getLanguages(),
            'i18nValues' => ['buttonLabel' => \is_array($this->buttonLabel) ? $this->buttonLabel : []],
            'className' => $this->className,
            'htmlOpen' => $this->htmlOpen,
            'htmlClose' => $this->htmlClose,
            'isBlockElement' => $this->isBlockElement,
            'isSourceCode' => $this->isSourceCode,
            'showButton' => $this->showButton,
            'wysiwygIcon' => $this->wysiwygIcon,
        ]);
    }

    protected function saveButtonLabel(int $bbcodeID): void
    {
        if ($this->showButton) {
            if (\is_array($this->buttonLabel)) {
                $buttonLabels = $this->buttonLabel;
            } else {
                $buttonLabels = [0 => $this->buttonLabel];
            }

            (new SaveContent($bbcodeID, $buttonLabels))();
        }
    }
}