Waca\Pages\RequestAction\PageCloseRequest

Complexity

Total Complexity

34

Size/Duplication

Total Lines	226
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	main()	0	3	1
A	confirmEmailAlreadySent()	0	9	2
A	getTemplate()	0	14	4
A	processClose()	0	46	5
A	checkEmailAlreadySent()	0	7	3
A	confirmAccountCreated()	0	9	2
A	sendMail()	0	7	1
A	checkAccountCreated()	0	22	4
A	showConfirmation()	0	14	4
A	processWelcome()	0	18	4
A	checkReserveProtect()	0	13	4

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Pages\RequestAction;

use Exception;
use Waca\DataObjects\EmailTemplate;
use Waca\DataObjects\Request;
use Waca\DataObjects\User;
use Waca\Exceptions\ApplicationLogicException;
use Waca\Helpers\Logger;
use Waca\Helpers\RequestEmailHelper;
use Waca\PdoDatabase;
use Waca\SessionAlert;
use Waca\WebRequest;

class PageCloseRequest extends RequestActionBase
{
    protected function main()
    {
        $this->processClose();
    }

    /**
     * Main function for this page, when no specific actions are called.
     * @throws ApplicationLogicException
     */
    final protected function processClose()
    {
        $this->checkPosted();
        $database = $this->getDatabase();

        $currentUser = User::getCurrent($database);
        $template = $this->getTemplate($database);
        $request = $this->getRequest($database);
        $request->setUpdateVersion(WebRequest::postInt('updateversion'));

        if ($request->getStatus() === 'Closed') {
            throw new ApplicationLogicException('Request is already closed');
        }

        if ($this->confirmEmailAlreadySent($request, $template)) {
            return;
        }

        if ($this->checkReserveProtect($request, $currentUser)) {
            return;
        }

        if ($this->confirmAccountCreated($request, $template)) {
            return;
        }

        // I think we're good here...
        $request->setStatus('Closed');
        $request->setReserved(null);

        Logger::closeRequest($database, $request, $template->getId(), null);

        $request->save();

        $this->processWelcome($template->getDefaultAction());

        // Perform the notifications and stuff *after* we've successfully saved, since the save can throw an OLE and
        // be rolled back.

        $this->getNotificationHelper()->requestClosed($request, $template->getName());
        $sanitisedTemplateName = htmlentities($template->getName(), ENT_COMPAT, 'UTF-8');
        SessionAlert::success("Request {$request->getId()} has been closed as {$sanitisedTemplateName}");

        $this->sendMail($request, $template->getText(), $currentUser, false);

        $this->redirect();
    }

    /**
     * @param PdoDatabase $database
     *
     * @return EmailTemplate
     * @throws ApplicationLogicException
     */
    protected function getTemplate(PdoDatabase $database)
    {
        $templateId = WebRequest::postInt('template');
        if ($templateId === null) {
            throw new ApplicationLogicException('No template specified');
        }

        /** @var EmailTemplate $template */
        $template = EmailTemplate::getById($templateId, $database);
        if ($template === false || !$template->getActive()) {
            throw new ApplicationLogicException('Invalid or inactive template specified');
        }

        return $template;
    }

    /**
     * @param Request       $request
     * @param EmailTemplate $template
     *
     * @return bool
     */
    protected function confirmEmailAlreadySent(Request $request, EmailTemplate $template)
    {
        if ($this->checkEmailAlreadySent($request)) {
            $this->showConfirmation($request, $template, 'close-confirmations/email-sent.tpl');

            return true;
        }

        return false;
    }

    protected function checkEmailAlreadySent(Request $request)
    {
        if ($request->getEmailSent() && !WebRequest::postBoolean('emailSentOverride')) {
            return true;
        }

        return false;
    }

    protected function checkReserveProtect(Request $request, User $currentUser)
    {
        $reservationId = $request->getReserved();

        if ($reservationId !== 0 && $reservationId !== null) {
            if ($currentUser->getId() !== $reservationId) {
                SessionAlert::error("Request is reserved by someone else.");
                $this->redirect('/viewRequest', null, ['id' => $request->getId()] );
                return true;
            }
        }

        return false;
    }

    /**
     * @param Request       $request
     * @param EmailTemplate $template
     *
     * @return bool
     * @throws \Waca\Exceptions\CurlException
     */
    protected function confirmAccountCreated(Request $request, EmailTemplate $template)
    {
        if ($this->checkAccountCreated($request, $template)) {
            $this->showConfirmation($request, $template, 'close-confirmations/account-created.tpl');

            return true;
        }

        return false;
    }

    protected function checkAccountCreated(Request $request, EmailTemplate $template)
    {
        if ($template->getDefaultAction() === EmailTemplate::CREATED && !WebRequest::postBoolean('createOverride')) {
            $parameters = array(
                'action'  => 'query',
                'list'    => 'users',
                'format'  => 'php',
                'ususers' => $request->getName(),
            );

            $content = $this->getHttpHelper()->get($this->getSiteConfiguration()->getMediawikiWebServiceEndpoint(),
                $parameters);

            $apiResult = unserialize($content);
            $exists = !isset($apiResult['query']['users']['0']['missing']);

            if (!$exists) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param Request $request
     * @param string  $mailText
     * @param User    $currentUser
     * @param boolean $ccMailingList
     */
    protected function sendMail(Request $request, $mailText, User $currentUser, $ccMailingList)
    {
        $requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
        $requestEmailHelper->sendMail($request, $mailText, $currentUser, $ccMailingList);

        $request->setEmailSent(true);
        $request->save();
    }

    /**
     * @param Request       $request
     * @param EmailTemplate $template
     * @param string        $templateName
     *
     * @throws Exception
     * @return void
     */
    protected function showConfirmation(Request $request, EmailTemplate $template, $templateName)
    {
        $this->assignCSRFToken();

        $this->assign('request', $request->getId());
        $this->assign('template', $template->getId());

        $this->assign('updateversion', $request->getUpdateVersion());

        $this->assign('emailSentOverride', WebRequest::postBoolean('emailSentOverride') ? 'true' : 'false');
        $this->assign('reserveOverride', WebRequest::postBoolean('reserveOverride') ? 'true' : 'false');
        $this->assign('createOverride', WebRequest::postBoolean('createOverride') ? 'true' : 'false');

        $this->setTemplate($templateName);
    }

    /**
     * @param string $action
     *
     * @throws ApplicationLogicException
     */
    final protected function processWelcome(string $action): void
    {
        $database = $this->getDatabase();
        $currentUser = User::getCurrent($database);

        if ($action !== EmailTemplate::CREATED) {
            return;
        }

        if ($currentUser->getWelcomeTemplate() === null) {

The condition $currentUser->getWelcomeTemplate() === null is always false.

            return;
        }

        if (WebRequest::postBoolean('skipAutoWelcome')) {
            return;
        }

        $this->enqueueWelcomeTask($this->getRequest($database), null, $currentUser, $database);
    }
}