enwikipedia-acc / waca

includes/Pages/PageQueueManagement.php

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 * ACC Development Team. Please see team.json for a list of contributors.     *
 *                                                                            *
 * This is free and unencumbered software released into the public domain.    *
 * Please see LICENSE.md for the full licencing statement.                    *
 ******************************************************************************/

namespace Waca\Pages;

use Waca\DataObjects\RequestQueue;
use Waca\DataObjects\User;
use Waca\Helpers\Logger;
use Waca\Helpers\RequestQueueHelper;
use Waca\SessionAlert;
use Waca\Tasks\InternalPageBase;
use Waca\WebRequest;

class PageQueueManagement extends InternalPageBase
{
    /** @var RequestQueueHelper */
    private $helper;

    public function __construct()
    {
        $this->helper = new RequestQueueHelper();
    }

    protected function main()
    {
        $this->setHtmlTitle('Request Queue Management');

        $database = $this->getDatabase();
        $queues = RequestQueue::getAllQueues($database);

        $this->assign('queues', $queues);

        $user = User::getCurrent($database);
        $this->assign('canCreate', $this->barrierTest('create', $user));
        $this->assign('canEdit', $this->barrierTest('edit', $user));

        $this->setTemplate('queue-management/main.tpl');
    }

    protected function create()
    {
        if (WebRequest::wasPosted()) {
            $this->validateCSRFToken();
            $database = $this->getDatabase();

            $queue = new RequestQueue();

            $queue->setDatabase($database);
            $queue->setDomain(1); // FIXME: domain

            $queue->setHeader(WebRequest::postString('header'));

It seems like Waca\WebRequest::postString('header') can also be of type null; however, parameter $header of Waca\DataObjects\RequestQueue::setHeader() does only seem to accept string, maybe add an additional type check?

            $queue->setDisplayName(WebRequest::postString('displayName'));

It seems like Waca\WebRequest::postString('displayName') can also be of type null; however, parameter $displayName of Waca\DataObjects\RequestQueue::setDisplayName() does only seem to accept string, maybe add an additional type check?

            $queue->setApiName(WebRequest::postString('apiName'));

It seems like Waca\WebRequest::postString('apiName') can also be of type null; however, parameter $apiName of Waca\DataObjects\RequestQueue::setApiName() does only seem to accept string, maybe add an additional type check?

            $queue->setEnabled(WebRequest::postBoolean('enabled'));
            $queue->setDefault(WebRequest::postBoolean('default') && WebRequest::postBoolean('enabled'));
            $queue->setDefaultAntispoof(WebRequest::postBoolean('antispoof') && WebRequest::postBoolean('enabled'));
            $queue->setDefaultTitleBlacklist(WebRequest::postBoolean('titleblacklist') && WebRequest::postBoolean('enabled'));
            $queue->setHelp(WebRequest::postString('help'));
            $queue->setLogName(WebRequest::postString('logName'));

It seems like Waca\WebRequest::postString('logName') can also be of type null; however, parameter $logName of Waca\DataObjects\RequestQueue::setLogName() does only seem to accept string, maybe add an additional type check?

The function Waca\DataObjects\RequestQueue::setLogName() has been deprecated.

            $proceed = true;

            if (RequestQueue::getByApiName($database, $queue->getApiName(), 1) !== false) {
                // FIXME: domain
                SessionAlert::error("The chosen API name is already in use. Please choose another.");
                $proceed = false;
            }

            if (preg_match('/^[A-Za-z][a-zA-Z0-9_-]*$/', $queue->getApiName()) !== 1) {
                SessionAlert::error("The chosen API name contains invalid characters");
                $proceed = false;
            }

            if (RequestQueue::getByDisplayName($database, $queue->getDisplayName(), 1) !== false) {
                // FIXME: domain
                SessionAlert::error("The chosen target display name is already in use. Please choose another.");
                $proceed = false;
            }

            if (RequestQueue::getByHeader($database, $queue->getHeader(), 1) !== false) {
                // FIXME: domain
                SessionAlert::error("The chosen header is already in use. Please choose another.");
                $proceed = false;
            }

            if ($proceed) {
                $queue->save();
                Logger::requestQueueCreated($database, $queue);
                $this->redirect('queueManagement');
            }
            else {
                $this->populateFromObject($queue);

                $this->assign('createMode', true);
                $this->setTemplate('queue-management/edit.tpl');
            }
        }
        else {
            $this->assign('header', null);
            $this->assign('displayName', null);
            $this->assign('apiName', null);
            $this->assign('enabled', false);
            $this->assign('antispoof', false);
            $this->assign('isTarget', false);
            $this->assign('titleblacklist', false);
            $this->assign('default', false);
            $this->assign('help', null);
            $this->assign('logName', null);

            $this->assignCSRFToken();
            $this->assign('createMode', true);
            $this->setTemplate('queue-management/edit.tpl');
        }
    }

    protected function edit()
    {
        $database = $this->getDatabase();

        $id = WebRequest::getInt('queue');
        if ($id === null) {
            $this->redirect('queueManagement');

            return;
        }

        /** @var RequestQueue $queue */
        $queue = RequestQueue::getById($id, $database);

        if (WebRequest::wasPosted()) {
            $this->validateCSRFToken();

            $this->helper->configureDefaults(
                $queue,
                WebRequest::postBoolean('enabled'),
                WebRequest::postBoolean('default'),
                WebRequest::postBoolean('antispoof'),
                WebRequest::postBoolean('titleblacklist'),
                $this->helper->isEmailTemplateTarget($queue, $this->getDatabase()) || $this->helper->isRequestFormTarget($queue, $this->getDatabase()));

            $queue->setHeader(WebRequest::postString('header'));

It seems like Waca\WebRequest::postString('header') can also be of type null; however, parameter $header of Waca\DataObjects\RequestQueue::setHeader() does only seem to accept string, maybe add an additional type check?

            $queue->setDisplayName(WebRequest::postString('displayName'));

It seems like Waca\WebRequest::postString('displayName') can also be of type null; however, parameter $displayName of Waca\DataObjects\RequestQueue::setDisplayName() does only seem to accept string, maybe add an additional type check?

            $queue->setHelp(WebRequest::postString('help'));

            $proceed = true;

            $foundRequestQueue = RequestQueue::getByDisplayName($database, $queue->getDisplayName(), 1);
            if ($foundRequestQueue !== false && $foundRequestQueue->getId() !== $queue->getId()) {
                // FIXME: domain
                SessionAlert::error("The chosen target display name is already in use. Please choose another.");
                $proceed = false;
            }

            $foundRequestQueue = RequestQueue::getByHeader($database, $queue->getHeader(), 1);
            if ($foundRequestQueue !== false && $foundRequestQueue->getId() !== $queue->getId()) {
                // FIXME: domain
                SessionAlert::error("The chosen header is already in use. Please choose another.");
                $proceed = false;
            }

            if ($proceed) {
                Logger::requestQueueEdited($database, $queue);
                $queue->save();
                $this->redirect('queueManagement');
            }
            else {
                $this->populateFromObject($queue);

                $this->assign('createMode', false);
                $this->setTemplate('queue-management/edit.tpl');
            }
        }
        else {
            $this->populateFromObject($queue);

            $this->assign('createMode', false);
            $this->setTemplate('queue-management/edit.tpl');
        }
    }

    /**
     * @param RequestQueue $queue
     */
    protected function populateFromObject(RequestQueue $queue): void
    {
        $this->assignCSRFToken();

        $this->assign('header', $queue->getHeader());
        $this->assign('displayName', $queue->getDisplayName());
        $this->assign('apiName', $queue->getApiName());
        $this->assign('enabled', $queue->isEnabled());
        $this->assign('default', $queue->isDefault());
        $this->assign('antispoof', $queue->isDefaultAntispoof());
        $this->assign('titleblacklist', $queue->isDefaultTitleBlacklist());
        $this->assign('help', $queue->getHelp());
        $this->assign('logName', $queue->getLogName());

The function Waca\DataObjects\RequestQueue::getLogName() has been deprecated.

        $isQueueTarget = $this->helper->isEmailTemplateTarget($queue, $this->getDatabase());
        $isFormTarget = $this->helper->isRequestFormTarget($queue, $this->getDatabase());
        $this->assign('isTarget', $isQueueTarget);
        $this->assign('isFormTarget', $isFormTarget);
    }
}