Merge pull request #6006 from WoltLab/file-processor-can-adopt

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

<?php

namespace wcf\acp\form;

use wcf\data\category\Category;
use wcf\data\object\type\ObjectType;
use wcf\data\trophy\category\TrophyCategoryCache;
use wcf\data\trophy\Trophy;
use wcf\data\trophy\TrophyAction;
use wcf\data\trophy\TrophyEditor;
use wcf\system\condition\ConditionHandler;
use wcf\system\exception\UserInputException;
use wcf\system\language\I18nValue;
use wcf\system\request\LinkHandler;
use wcf\system\style\FontAwesomeIcon;
use wcf\system\trophy\condition\TrophyConditionHandler;
use wcf\system\WCF;
use wcf\util\StringUtil;

/**
 * Represents the trophy add form.
 *
 * @author  Joshua Ruesweg
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @since   3.1
 */
class TrophyAddForm extends AbstractAcpForm
{
    /**
     * @inheritDoc
     */
    public $activeMenuItem = 'wcf.acp.menu.link.trophy.add';

    /**
     * @inheritDoc
     */
    public $neededPermissions = ['admin.trophy.canManageTrophy'];

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

    /**
     * category id for the trophy.
     * @var int
     */
    public $categoryID = 0;

    /**
     * Category object.
     * @var Category
     */
    public $category;

    /**
     * Trophy description.
     * @var string
     */
    public $description = '';

    /**
     * Trophy title.
     * @var string
     */
    public $title = '';

    /**
     * All available trophy types.
     * @var []
     */
    public $availableTypes = [
        Trophy::TYPE_IMAGE => 'imageUpload',
        Trophy::TYPE_BADGE => 'badge',
    ];

    /**
     * Type of the trophy (whether this is an image or not)
     * @var int
     */
    public $type = Trophy::TYPE_BADGE;

    /**
     * temporary hash for image icon
     * @var string
     */
    public $tmpHash = '';

    /**
     * the url for the uploaded image
     * @var string
     */
    public $uploadedImageURL = '';

    /**
     * the icon name for CSS icons (FA-Icon)
     * @var string
     */
    public $iconName = "trophy;false";

    /**
     * The icon color (rgba format with rgba prefix)
     * @var string
     */
    public $iconColor = 'rgba(255, 255, 255, 1)';

    /**
     * The badge color (rgba format with rgba prefix)
     * @var string
     */
    public $badgeColor = 'rgba(50, 92, 132, 1)';

    /**
     * `1` if the trophy is disabled.
     * @var int
     */
    public $isDisabled = 0;

    /**
     * `1` if the trophy has conditions to reward automatically trophies.
     * @var int
     */
    public $awardAutomatically = 0;

    /**
     * `1` if the trophy should be automatically revoked once the conditions are no longer met.
     * @var int
     */
    public $revokeAutomatically = 0;

    /**
     * `1` if the trophy contains html in the description
     * @var int
     */
    public $trophyUseHtml = 0;

    /**
     * list of grouped user group assignment condition object types
     * @var ObjectType[][]
     */
    public $conditions = [];

    /**
     * the showOrder value of the trophy
     * @var int
     */
    public $showOrder = 0;

    /**
     * @inheritDoc
     */
    public function readData()
    {
        $this->conditions = TrophyConditionHandler::getInstance()->getGroupedObjectTypes();

        parent::readData();
    }

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

        $titleI18n = new I18nValue('title');
        $titleI18n->setLanguageItem('wcf.user.trophy.title', 'wcf.user.trophy', 'com.woltlab.wcf');
        $this->registerI18nValue($titleI18n);

        $descriptionI18n = new I18nValue('description');
        $descriptionI18n->setLanguageItem('wcf.user.trophy.description', 'wcf.user.trophy', 'com.woltlab.wcf');
        $descriptionI18n->setFlags(I18nValue::ALLOW_EMPTY);
        $this->registerI18nValue($descriptionI18n);

        if (isset($_POST['tmpHash'])) {
            $this->tmpHash = StringUtil::trim($_POST['tmpHash']);
        }

        if (empty($this->tmpHash)) {
            $this->tmpHash = StringUtil::getRandomID();
        }
    }

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

        if (isset($_POST['categoryID'])) {
            $this->categoryID = \intval($_POST['categoryID']);
        }
        if (isset($_POST['type'])) {
            $this->type = \intval($_POST['type']);
        }
        if (isset($_POST['isDisabled'])) {
            $this->isDisabled = \intval($_POST['isDisabled']);
        }
        if (isset($_POST['iconName'])) {
            $this->iconName = StringUtil::trim($_POST['iconName']);
        }
        if (isset($_POST['iconColor'])) {
            $this->iconColor = $_POST['iconColor'];
        }
        if (isset($_POST['badgeColor'])) {
            $this->badgeColor = $_POST['badgeColor'];
        }
        if (isset($_POST['awardAutomatically'])) {
            $this->awardAutomatically = 1;
        }
        if (isset($_POST['revokeAutomatically']) && $this->awardAutomatically) {
            $this->revokeAutomatically = 1;
        }
        if (isset($_POST['trophyUseHtml'])) {
            $this->trophyUseHtml = 1;
        }
        if (isset($_POST['showOrder'])) {
            $this->showOrder = \intval($_POST['showOrder']);
        }

        // read file upload
        $fileExtension = WCF::getSession()->getVar('trophyImage-' . $this->tmpHash);

        if ($fileExtension !== null && \file_exists(WCF_DIR . 'images/trophy/tmp_' . $this->tmpHash . '.' . $fileExtension)) {
            $this->uploadedImageURL = WCF::getPath() . 'images/trophy/tmp_' . $this->tmpHash . '.' . $fileExtension;
        }

        $this->category = TrophyCategoryCache::getInstance()->getCategoryByID($this->categoryID);

        foreach ($this->conditions as $conditions) {
            /** @var ObjectType $condition */
            foreach ($conditions as $condition) {
                $condition->getProcessor()->readFormParameters();
            }
        }
    }

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

        if (!\in_array($this->type, \array_keys($this->availableTypes))) {
            throw new UserInputException('type');
        }

        if (!$this->categoryID) {
            throw new UserInputException('categoryID');
        }

        if (!$this->category->getObjectID()) {
            throw new UserInputException('categoryID');
        }

        $this->validateType();

        if ($this->awardAutomatically) {
            $hasData = false;
            foreach ($this->conditions as $conditions) {
                foreach ($conditions as $condition) {
                    $condition->getProcessor()->validate();

                    if (!$hasData && $condition->getProcessor()->getData() !== null) {
                        $hasData = true;
                    }
                }
            }

            if (!$hasData) {
                throw new UserInputException('conditions');
            }
        }
    }

    /**
     * Validates the trophy type.
     */
    protected function validateType()
    {
        switch ($this->type) {
            case Trophy::TYPE_IMAGE:
                $fileExtension = WCF::getSession()->getVar('trophyImage-' . $this->tmpHash);

                if ($fileExtension === null) {
                    throw new UserInputException('imageUpload');
                }

                if (!\file_exists(WCF_DIR . 'images/trophy/tmp_' . $this->tmpHash . '.' . $fileExtension)) {
                    throw new UserInputException('imageUpload');
                }
                break;

            case Trophy::TYPE_BADGE:
                if (empty($this->iconName)) {
                    throw new UserInputException('iconName');
                }

                if (!FontAwesomeIcon::isValidString($this->iconName)) {
                    throw new UserInputException('iconName');
                }

                if (empty($this->iconColor)) {
                    throw new UserInputException('iconColor');
                }

                if (empty($this->badgeColor)) {
                    throw new UserInputException('badgeColor');
                }
                break;
        }
    }

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

        $data = [];
        if ($this->type == Trophy::TYPE_BADGE) {
            $data['iconName'] = $this->iconName;
            $data['iconColor'] = $this->iconColor;
            $data['badgeColor'] = $this->badgeColor;
        }

        $this->objectAction = new TrophyAction([], 'create', [
            'data' => \array_merge($this->additionalFields, $data, [
                'title' => $this->title,
                'description' => $this->description,
                'categoryID' => $this->categoryID,
                'type' => $this->type,
                'isDisabled' => $this->isDisabled,
                'awardAutomatically' => $this->awardAutomatically,
                'revokeAutomatically' => $this->revokeAutomatically,
                'trophyUseHtml' => $this->trophyUseHtml,
                'showOrder' => $this->showOrder,
            ]),
            'tmpHash' => $this->tmpHash,
        ]);
        $returnValues = $this->objectAction->executeAction();

        $this->saveI18n($returnValues['returnValues'], TrophyEditor::class);

        // transform conditions array into one-dimensional array
        $conditions = [];
        foreach ($this->conditions as $groupedObjectTypes) {
            foreach ($groupedObjectTypes as $objectTypes) {
                if (\is_array($objectTypes)) {
                    $conditions = \array_merge($conditions, $objectTypes);
                } else {
                    $conditions[] = $objectTypes;
                }
            }
        }

        ConditionHandler::getInstance()->createConditions($returnValues['returnValues']->trophyID, $conditions);

        $this->reset();

        WCF::getTPL()->assign([
            'objectEditLink' => LinkHandler::getInstance()->getControllerLink(
                TrophyEditForm::class,
                ['id' => $returnValues['returnValues']->trophyID]
            ),
        ]);
    }

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

        $this->isDisabled = $this->awardAutomatically = $this->categoryID = $this->trophyUseHtml = $this->showOrder = $this->revokeAutomatically = 0;
        $this->type = Trophy::TYPE_BADGE;
        $this->iconName = $this->uploadedImageURL = '';
        $this->iconColor = 'rgba(255, 255, 255, 1)';
        $this->badgeColor = 'rgba(50, 92, 132, 1)';
        $this->iconName = 'trophy;false';
        $this->tmpHash = StringUtil::getRandomID();

        foreach ($this->conditions as $conditions) {
            foreach ($conditions as $condition) {
                $condition->getProcessor()->reset();
            }
        }
    }

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

        WCF::getTPL()->assign([
            'categoryID' => $this->categoryID,
            'type' => $this->type,
            'isDisabled' => $this->isDisabled,
            'iconName' => $this->iconName,
            'iconColor' => $this->iconColor,
            'badgeColor' => $this->badgeColor,
            'icon' => FontAwesomeIcon::fromString($this->iconName),
            'trophyCategories' => TrophyCategoryCache::getInstance()->getCategories(),
            'groupedObjectTypes' => $this->conditions,
            'awardAutomatically' => $this->awardAutomatically,
            'revokeAutomatically' => $this->revokeAutomatically,
            'availableTypes' => $this->availableTypes,
            'tmpHash' => $this->tmpHash,
            'uploadedImageURL' => $this->uploadedImageURL,
            'trophyUseHtml' => $this->trophyUseHtml,
            'showOrder' => $this->showOrder,
        ]);
    }
}