mdaniels5757 / waca

includes/Pages/Request/PageRequestSubmitted.php

Indentation +12 added lines, -12 removed lines

@@ -12,17 +12,17 @@
 
 class PageRequestSubmitted extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        // clear any requests for client hints. Should have been done already prior to
-        // email confirmation, but this catches the case where email confirmation is
-        // disabled.
-        $this->headerQueue[] = "Accept-CH:";
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		// clear any requests for client hints. Should have been done already prior to
+		// email confirmation, but this catches the case where email confirmation is
+		// disabled.
+		$this->headerQueue[] = "Accept-CH:";
 
-        $this->setTemplate('request/email-confirmed.tpl');
-    }
+		$this->setTemplate('request/email-confirmed.tpl');
+	}
 }
\ No newline at end of file

includes/Pages/Request/PageRequestAccount.php

Indentation +310 added lines, -310 removed lines

@@ -27,316 +27,316 @@
 
 class PageRequestAccount extends PublicInterfacePageBase
 {
-    /** @var RequestValidationHelper do not use directly. */
-    private $validationHelper;
-
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     * @throws OptimisticLockFailedException
-     * @throws Exception
-     */
-    protected function main()
-    {
-        // dual mode page
-        if (WebRequest::wasPosted()) {
-            $request = $this->createNewRequest(null);
-            $this->handleFormPost($request);
-        }
-        else {
-            $this->requestClientHints();
-            $this->handleFormRefilling();
-
-            $this->setTemplate('request/request-form.tpl');
-        }
-    }
-
-    /**
-     * Handles dynamic request forms.
-     * @return void
-     * @throws OptimisticLockFailedException
-     * @throws Exception
-     */
-    protected function dynamic()
-    {
-        $database = $this->getDatabase();
-
-        $pathInfo = WebRequest::pathInfo();
-        $domain = Domain::getByShortName($pathInfo[1], $database);
-        if ($domain === false || !$domain->isEnabled()) {
-            throw new ApplicationLogicException("This form is not available at this time.");
-        }
-
-        $form = RequestForm::getByPublicEndpoint($database, $pathInfo[2], $domain->getId());
-
-        if ($form === false || !$form->isEnabled()) {
-            throw new ApplicationLogicException("This form is not available at this time.");
-        }
-
-        // dual mode page
-        if (WebRequest::wasPosted()) {
-            $request = $this->createNewRequest($form);
-            $this->handleFormPost($request);
-        }
-        else {
-            $this->requestClientHints();
-            $this->handleFormRefilling();
-
-            $renderer = new MarkdownRenderingHelper();
-            $this->assign('formPreamble', $renderer->doRender($form->getFormContent()));
-            $this->assign('formUsernameHelp', $renderer->doRenderInline($form->getUsernameHelp()));
-            $this->assign('formEmailHelp', $renderer->doRenderInline($form->getEmailHelp()));
-            $this->assign('formCommentsHelp', $renderer->doRenderInline($form->getCommentHelp()));
-
-            $this->setTemplate('request/request-form-dynamic.tpl');
-        }
-    }
-
-    /**
-     * @param RequestForm|null $form
-     *
-     * @return Request
-     * @throws ApplicationLogicException
-     */
-    protected function createNewRequest(?RequestForm $form): Request
-    {
-        $database = $this->getDatabase();
-
-        $request = new Request();
-
-        if ($form === null) {
-            $domain = 1;
-        }
-        else {
-            $domain = $form->getDomain();
-            $request->setOriginForm($form->getId());
-        }
-
-        $request->setQueue(RequestQueue::getDefaultQueue($database, $domain)->getId());
-        $request->setDatabase($database);
-        $request->setDomain($domain);
-
-        $request->setName(trim(WebRequest::postString('name')));
-        $request->setEmail(WebRequest::postEmail('email'));
-
-        $request->setIp(WebRequest::remoteAddress());
-        $request->setForwardedIp(WebRequest::forwardedAddress());
-
-        $request->setUserAgent(WebRequest::userAgent());
-
-        return $request;
-    }
-
-    /**
-     * @return Comment|null
-     */
-    private function createComment()
-    {
-        $commentText = WebRequest::postString('comments');
-        if ($commentText === null || trim($commentText) === '') {
-            return null;
-        }
-
-        $comment = new Comment();
-        $comment->setDatabase($this->getDatabase());
-
-        $comment->setVisibility('requester');
-        $comment->setUser(null);
-        $comment->setComment($commentText);
-
-        return $comment;
-    }
-
-    /**
-     * @param Request $request
-     *
-     * @return ValidationError[]
-     */
-    protected function validateRequest($request)
-    {
-        $validationHelper = $this->getRequestValidationHelper();
-
-        // These are arrays of ValidationError.
-        $nameValidation = $validationHelper->validateName($request);
-        $emailValidation = $validationHelper->validateEmail($request, WebRequest::postEmail('emailconfirm'));
-        $otherValidation = $validationHelper->validateOther($request);
-
-        $validationErrors = array_merge($nameValidation, $emailValidation, $otherValidation);
-
-        return $validationErrors;
-    }
-
-    /**
-     * @param Request      $request
-     *
-     * @param Comment|null $comment
-     *
-     * @throws OptimisticLockFailedException
-     * @throws Exception
-     */
-    protected function saveAsEmailConfirmation(Request $request, $comment)
-    {
-        $request->generateEmailConfirmationHash();
-        $request->save();
-
-        if ($comment !== null) {
-            $comment->setRequest($request->getId());
-            $comment->save();
-        }
-
-        $trustedIp = $this->getXffTrustProvider()->getTrustedClientIp(
-            $request->getIp(),
-            $request->getForwardedIp());
-
-        $this->assign("ip", $trustedIp);
-        $this->assign("id", $request->getId());
-        $this->assign("hash", $request->getEmailConfirm());
-
-        // Sends the confirmation email to the user.
-        // FIXME: domains
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->getDatabase());
-        $this->getEmailHelper()->sendMail(
-            $domain->getEmailReplyAddress(),
-            $request->getEmail(),
-            "[ACC #{$request->getId()}] English Wikipedia Account Request",
-            $this->fetchTemplate('request/confirmation-mail.tpl'));
-
-        $this->redirect('emailConfirmationRequired');
-    }
-
-    /**
-     * @param Request      $request
-     *
-     * @param Comment|null $comment
-     *
-     * @throws OptimisticLockFailedException
-     * @throws Exception
-     */
-    protected function saveWithoutEmailConfirmation(Request $request, $comment)
-    {
-        $request->setEmailConfirm(0); // fixme Since it can't be null
-        $request->save();
-
-        if ($comment !== null) {
-            $comment->setRequest($request->getId());
-            $comment->save();
-        }
-
-        $this->getNotificationHelper()->requestReceived($request);
-
-        $this->redirect('requestSubmitted');
-    }
-
-    /**
-     * @return RequestValidationHelper
-     */
-    protected function getRequestValidationHelper(): RequestValidationHelper
-    {
-        $banHelper = new BanHelper($this->getDatabase(), $this->getXffTrustProvider(), null);
-
-        if ($this->validationHelper === null) {
-            $this->validationHelper = new RequestValidationHelper(
-                $banHelper,
-                $this->getDatabase(),
-                $this->getAntiSpoofProvider(),
-                $this->getXffTrustProvider(),
-                $this->getHttpHelper(),
-                $this->getTorExitProvider(),
-                $this->getSiteConfiguration());
-        }
-
-        return $this->validationHelper;
+	/** @var RequestValidationHelper do not use directly. */
+	private $validationHelper;
+
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 * @throws OptimisticLockFailedException
+	 * @throws Exception
+	 */
+	protected function main()
+	{
+		// dual mode page
+		if (WebRequest::wasPosted()) {
+			$request = $this->createNewRequest(null);
+			$this->handleFormPost($request);
+		}
+		else {
+			$this->requestClientHints();
+			$this->handleFormRefilling();
+
+			$this->setTemplate('request/request-form.tpl');
+		}
+	}
+
+	/**
+	 * Handles dynamic request forms.
+	 * @return void
+	 * @throws OptimisticLockFailedException
+	 * @throws Exception
+	 */
+	protected function dynamic()
+	{
+		$database = $this->getDatabase();
+
+		$pathInfo = WebRequest::pathInfo();
+		$domain = Domain::getByShortName($pathInfo[1], $database);
+		if ($domain === false || !$domain->isEnabled()) {
+			throw new ApplicationLogicException("This form is not available at this time.");
+		}
+
+		$form = RequestForm::getByPublicEndpoint($database, $pathInfo[2], $domain->getId());
+
+		if ($form === false || !$form->isEnabled()) {
+			throw new ApplicationLogicException("This form is not available at this time.");
+		}
+
+		// dual mode page
+		if (WebRequest::wasPosted()) {
+			$request = $this->createNewRequest($form);
+			$this->handleFormPost($request);
+		}
+		else {
+			$this->requestClientHints();
+			$this->handleFormRefilling();
+
+			$renderer = new MarkdownRenderingHelper();
+			$this->assign('formPreamble', $renderer->doRender($form->getFormContent()));
+			$this->assign('formUsernameHelp', $renderer->doRenderInline($form->getUsernameHelp()));
+			$this->assign('formEmailHelp', $renderer->doRenderInline($form->getEmailHelp()));
+			$this->assign('formCommentsHelp', $renderer->doRenderInline($form->getCommentHelp()));
+
+			$this->setTemplate('request/request-form-dynamic.tpl');
+		}
+	}
+
+	/**
+	 * @param RequestForm|null $form
+	 *
+	 * @return Request
+	 * @throws ApplicationLogicException
+	 */
+	protected function createNewRequest(?RequestForm $form): Request
+	{
+		$database = $this->getDatabase();
+
+		$request = new Request();
+
+		if ($form === null) {
+			$domain = 1;
+		}
+		else {
+			$domain = $form->getDomain();
+			$request->setOriginForm($form->getId());
+		}
+
+		$request->setQueue(RequestQueue::getDefaultQueue($database, $domain)->getId());
+		$request->setDatabase($database);
+		$request->setDomain($domain);
+
+		$request->setName(trim(WebRequest::postString('name')));
+		$request->setEmail(WebRequest::postEmail('email'));
+
+		$request->setIp(WebRequest::remoteAddress());
+		$request->setForwardedIp(WebRequest::forwardedAddress());
+
+		$request->setUserAgent(WebRequest::userAgent());
+
+		return $request;
+	}
+
+	/**
+	 * @return Comment|null
+	 */
+	private function createComment()
+	{
+		$commentText = WebRequest::postString('comments');
+		if ($commentText === null || trim($commentText) === '') {
+			return null;
+		}
+
+		$comment = new Comment();
+		$comment->setDatabase($this->getDatabase());
+
+		$comment->setVisibility('requester');
+		$comment->setUser(null);
+		$comment->setComment($commentText);
+
+		return $comment;
+	}
+
+	/**
+	 * @param Request $request
+	 *
+	 * @return ValidationError[]
+	 */
+	protected function validateRequest($request)
+	{
+		$validationHelper = $this->getRequestValidationHelper();
+
+		// These are arrays of ValidationError.
+		$nameValidation = $validationHelper->validateName($request);
+		$emailValidation = $validationHelper->validateEmail($request, WebRequest::postEmail('emailconfirm'));
+		$otherValidation = $validationHelper->validateOther($request);
+
+		$validationErrors = array_merge($nameValidation, $emailValidation, $otherValidation);
+
+		return $validationErrors;
+	}
+
+	/**
+	 * @param Request      $request
+	 *
+	 * @param Comment|null $comment
+	 *
+	 * @throws OptimisticLockFailedException
+	 * @throws Exception
+	 */
+	protected function saveAsEmailConfirmation(Request $request, $comment)
+	{
+		$request->generateEmailConfirmationHash();
+		$request->save();
+
+		if ($comment !== null) {
+			$comment->setRequest($request->getId());
+			$comment->save();
+		}
+
+		$trustedIp = $this->getXffTrustProvider()->getTrustedClientIp(
+			$request->getIp(),
+			$request->getForwardedIp());
+
+		$this->assign("ip", $trustedIp);
+		$this->assign("id", $request->getId());
+		$this->assign("hash", $request->getEmailConfirm());
+
+		// Sends the confirmation email to the user.
+		// FIXME: domains
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->getDatabase());
+		$this->getEmailHelper()->sendMail(
+			$domain->getEmailReplyAddress(),
+			$request->getEmail(),
+			"[ACC #{$request->getId()}] English Wikipedia Account Request",
+			$this->fetchTemplate('request/confirmation-mail.tpl'));
+
+		$this->redirect('emailConfirmationRequired');
+	}
+
+	/**
+	 * @param Request      $request
+	 *
+	 * @param Comment|null $comment
+	 *
+	 * @throws OptimisticLockFailedException
+	 * @throws Exception
+	 */
+	protected function saveWithoutEmailConfirmation(Request $request, $comment)
+	{
+		$request->setEmailConfirm(0); // fixme Since it can't be null
+		$request->save();
+
+		if ($comment !== null) {
+			$comment->setRequest($request->getId());
+			$comment->save();
+		}
+
+		$this->getNotificationHelper()->requestReceived($request);
+
+		$this->redirect('requestSubmitted');
+	}
+
+	/**
+	 * @return RequestValidationHelper
+	 */
+	protected function getRequestValidationHelper(): RequestValidationHelper
+	{
+		$banHelper = new BanHelper($this->getDatabase(), $this->getXffTrustProvider(), null);
+
+		if ($this->validationHelper === null) {
+			$this->validationHelper = new RequestValidationHelper(
+				$banHelper,
+				$this->getDatabase(),
+				$this->getAntiSpoofProvider(),
+				$this->getXffTrustProvider(),
+				$this->getHttpHelper(),
+				$this->getTorExitProvider(),
+				$this->getSiteConfiguration());
+		}
+
+		return $this->validationHelper;
 }
 
-    /**
-     * @param Request $request
-     *
-     * @return void
-     * @throws OptimisticLockFailedException
-     */
-    protected function handleFormPost(Request $request): void
-    {
-        $comment = $this->createComment();
-
-        $validationErrors = $this->validateRequest($request);
-
-        if (count($validationErrors) > 0) {
-            foreach ($validationErrors as $validationError) {
-                SessionAlert::error($validationError->getErrorMessage());
-            }
-
-            // Preserve the data after an error
-            WebRequest::setSessionContext('accountReq',
-                array(
-                    'username' => WebRequest::postString('name'),
-                    'email'    => WebRequest::postEmail('email'),
-                    'comments' => WebRequest::postString('comments'),
-                )
-            );
-
-            // Validation error, bomb out early.
-            $this->redirect();
-
-            return;
-        }
-
-        // actually save the request to the database
-        if ($this->getSiteConfiguration()->getEmailConfirmationEnabled()) {
-            $this->saveAsEmailConfirmation($request, $comment);
-            $this->savePrivateData($request);
-        }
-        else {
-            $this->saveWithoutEmailConfirmation($request, $comment);
-            $this->savePrivateData($request);
-        }
-
-        $this->getRequestValidationHelper()->postSaveValidations($request);
-    }
-
-    /**
-     * @return void
-     */
-    protected function handleFormRefilling(): void
-    {
-        // set the form values from the session context
-        $context = WebRequest::getSessionContext('accountReq');
-        if ($context !== null && is_array($context)) {
-            $this->assign('username', $context['username']);
-            $this->assign('email', $context['email']);
-            $this->assign('comments', $context['comments']);
-        }
-
-        // Clear it for a refresh
-        WebRequest::setSessionContext('accountReq', null);
-    }
-
-    private function requestClientHints()
-    {
-        $hints = $this->getSiteConfiguration()->getAcceptClientHints();
-
-        $this->headerQueue[] = "Accept-CH: " . implode(', ', $hints);
-    }
-
-    private function savePrivateData(Request $request)
-    {
-        foreach ($this->getSiteConfiguration()->getAcceptClientHints() as $header)
-        {
-            $value = WebRequest::httpHeader($header);
-
-            if($value === null){
-                continue;
-            }
-
-            $d = new RequestData();
-            $d->setDatabase($request->getDatabase());
-            $d->setRequest($request->getId());
-
-            $d->setType(RequestData::TYPE_CLIENTHINT);
-            $d->setName($header);
-            $d->setValue(WebRequest::httpHeader($header));
-
-            $d->save();
-        }
-    }
+	/**
+	 * @param Request $request
+	 *
+	 * @return void
+	 * @throws OptimisticLockFailedException
+	 */
+	protected function handleFormPost(Request $request): void
+	{
+		$comment = $this->createComment();
+
+		$validationErrors = $this->validateRequest($request);
+
+		if (count($validationErrors) > 0) {
+			foreach ($validationErrors as $validationError) {
+				SessionAlert::error($validationError->getErrorMessage());
+			}
+
+			// Preserve the data after an error
+			WebRequest::setSessionContext('accountReq',
+				array(
+					'username' => WebRequest::postString('name'),
+					'email'    => WebRequest::postEmail('email'),
+					'comments' => WebRequest::postString('comments'),
+				)
+			);
+
+			// Validation error, bomb out early.
+			$this->redirect();
+
+			return;
+		}
+
+		// actually save the request to the database
+		if ($this->getSiteConfiguration()->getEmailConfirmationEnabled()) {
+			$this->saveAsEmailConfirmation($request, $comment);
+			$this->savePrivateData($request);
+		}
+		else {
+			$this->saveWithoutEmailConfirmation($request, $comment);
+			$this->savePrivateData($request);
+		}
+
+		$this->getRequestValidationHelper()->postSaveValidations($request);
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function handleFormRefilling(): void
+	{
+		// set the form values from the session context
+		$context = WebRequest::getSessionContext('accountReq');
+		if ($context !== null && is_array($context)) {
+			$this->assign('username', $context['username']);
+			$this->assign('email', $context['email']);
+			$this->assign('comments', $context['comments']);
+		}
+
+		// Clear it for a refresh
+		WebRequest::setSessionContext('accountReq', null);
+	}
+
+	private function requestClientHints()
+	{
+		$hints = $this->getSiteConfiguration()->getAcceptClientHints();
+
+		$this->headerQueue[] = "Accept-CH: " . implode(', ', $hints);
+	}
+
+	private function savePrivateData(Request $request)
+	{
+		foreach ($this->getSiteConfiguration()->getAcceptClientHints() as $header)
+		{
+			$value = WebRequest::httpHeader($header);
+
+			if($value === null){
+				continue;
+			}
+
+			$d = new RequestData();
+			$d->setDatabase($request->getDatabase());
+			$d->setRequest($request->getId());
+
+			$d->setType(RequestData::TYPE_CLIENTHINT);
+			$d->setName($header);
+			$d->setValue(WebRequest::httpHeader($header));
+
+			$d->save();
+		}
+	}
 }
\ No newline at end of file

includes/Pages/Request/PageConfirmEmail.php

Indentation +66 added lines, -66 removed lines

@@ -19,70 +19,70 @@
 
 class PageConfirmEmail extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @throws ApplicationLogicException
-     * @throws Exception
-     */
-    protected function main()
-    {
-        $id = WebRequest::getInt('id');
-        $si = WebRequest::getString('si');
-
-        if ($id === null || $si === null) {
-            throw new ApplicationLogicException('Link incomplete - please double check the link you received.');
-        }
-
-        /** @var Request|false $request */
-        $request = Request::getById($id, $this->getDatabase());
-
-        if ($request === false) {
-            throw new ApplicationLogicException('Request not found');
-        }
-
-        if ($request->getEmailConfirm() === 'Confirmed') {
-            // request has already been confirmed. Bomb out silently.
-            $this->redirect('requestSubmitted');
-
-            return;
-        }
-
-        if ($request->getEmailConfirm() === $si) {
-            $request->setEmailConfirm('Confirmed');
-        }
-        else {
-            throw new ApplicationLogicException('The confirmation value does not appear to match the expected value');
-        }
-
-        try {
-            $request->save();
-        }
-        catch (OptimisticLockFailedException $ex) {
-            // Okay. Someone's edited this in the time between us loading this page and doing the checks, and us getting
-            // to saving the page. We *do not* want to show an optimistic lock failure, the most likely problem is they
-            // double-loaded this page (see #255). Let's confirm this, and bomb out with a success message if it's the
-            // case.
-
-            $request = Request::getById($id, $this->getDatabase());
-            if ($request->getEmailConfirm() === 'Confirmed') {
-                // we've already done the sanity checks above
-
-                $this->redirect('requestSubmitted');
-
-                // skip the log and notification
-                return;
-            }
-
-            // something really weird happened. Another race condition?
-            throw $ex;
-        }
-
-        Logger::emailConfirmed($this->getDatabase(), $request);
-
-        if ($request->getStatus() != RequestStatus::CLOSED) {
-            $this->getNotificationHelper()->requestReceived($request);
-        }
-
-        $this->redirect('requestSubmitted');
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @throws ApplicationLogicException
+	 * @throws Exception
+	 */
+	protected function main()
+	{
+		$id = WebRequest::getInt('id');
+		$si = WebRequest::getString('si');
+
+		if ($id === null || $si === null) {
+			throw new ApplicationLogicException('Link incomplete - please double check the link you received.');
+		}
+
+		/** @var Request|false $request */
+		$request = Request::getById($id, $this->getDatabase());
+
+		if ($request === false) {
+			throw new ApplicationLogicException('Request not found');
+		}
+
+		if ($request->getEmailConfirm() === 'Confirmed') {
+			// request has already been confirmed. Bomb out silently.
+			$this->redirect('requestSubmitted');
+
+			return;
+		}
+
+		if ($request->getEmailConfirm() === $si) {
+			$request->setEmailConfirm('Confirmed');
+		}
+		else {
+			throw new ApplicationLogicException('The confirmation value does not appear to match the expected value');
+		}
+
+		try {
+			$request->save();
+		}
+		catch (OptimisticLockFailedException $ex) {
+			// Okay. Someone's edited this in the time between us loading this page and doing the checks, and us getting
+			// to saving the page. We *do not* want to show an optimistic lock failure, the most likely problem is they
+			// double-loaded this page (see #255). Let's confirm this, and bomb out with a success message if it's the
+			// case.
+
+			$request = Request::getById($id, $this->getDatabase());
+			if ($request->getEmailConfirm() === 'Confirmed') {
+				// we've already done the sanity checks above
+
+				$this->redirect('requestSubmitted');
+
+				// skip the log and notification
+				return;
+			}
+
+			// something really weird happened. Another race condition?
+			throw $ex;
+		}
+
+		Logger::emailConfirmed($this->getDatabase(), $request);
+
+		if ($request->getStatus() != RequestStatus::CLOSED) {
+			$this->getNotificationHelper()->requestReceived($request);
+		}
+
+		$this->redirect('requestSubmitted');
+	}
 }
\ No newline at end of file

includes/Pages/Request/PageEmailConfirmationRequired.php

Indentation +10 added lines, -10 removed lines

@@ -12,15 +12,15 @@
 
 class PageEmailConfirmationRequired extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        // clear any requests for client hints
-        $this->headerQueue[] = "Accept-CH:";
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		// clear any requests for client hints
+		$this->headerQueue[] = "Accept-CH:";
 
-        $this->setTemplate('request/email-confirmation.tpl');
-    }
+		$this->setTemplate('request/email-confirmation.tpl');
+	}
 }
\ No newline at end of file

includes/Pages/PageEditComment.php

Indentation +155 added lines, -155 removed lines

@@ -21,159 +21,159 @@
 
 class PageEditComment extends InternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @throws ApplicationLogicException
-     * @throws Exception
-     */
-    protected function main()
-    {
-        $commentId = WebRequest::getInt('id');
-        if ($commentId === null) {
-            throw new ApplicationLogicException('Comment ID not specified');
-        }
-
-        $database = $this->getDatabase();
-
-        /** @var Comment|false $comment */
-        $comment = Comment::getById($commentId, $database);
-        if ($comment === false) {
-            throw new ApplicationLogicException('Comment not found');
-        }
-
-        $currentUser = User::getCurrent($database);
-
-        $this->checkCommentAccess($comment, $currentUser);
-
-        /** @var Request|false $request */
-        $request = Request::getById($comment->getRequest(), $database);
-
-        if ($request === false) {
-            throw new ApplicationLogicException('Request was not found.');
-        }
-
-        $canUnflag = $this->barrierTest('unflag', $currentUser, PageFlagComment::class);
-
-        if (WebRequest::wasPosted()) {
-            $this->validateCSRFToken();
-            $newComment = WebRequest::postString('newcomment');
-            $visibility = WebRequest::postString('visibility');
-            $doUnflag = WebRequest::postBoolean('unflag');
-
-            if ($newComment === null || $newComment === '') {
-                throw new ApplicationLogicException('Comment cannot be empty!');
-            }
-
-            $commentDataUnchanged = $newComment === $comment->getComment()
-                && ($comment->getVisibility() === 'requester' || $comment->getVisibility() === $visibility);
-            $flagStatusUnchanged = (!$canUnflag || $comment->getFlagged() && !$doUnflag);
-
-            if ($commentDataUnchanged && $flagStatusUnchanged) {
-                // No change was made; redirect back.
-                $this->redirectBack($comment->getRequest());
-
-                return;
-            }
-
-            // optimistically lock from the load of the edit comment form
-            $updateVersion = WebRequest::postInt('updateversion');
-
-            // comment data has changed, update the object
-            if (!$commentDataUnchanged) {
-                $this->updateCommentData($comment, $visibility, $newComment);
-            }
-
-            if ($doUnflag && $canUnflag) {
-                $comment->setFlagged(false);
-            }
-
-            $comment->setUpdateVersion($updateVersion);
-            $comment->save();
-
-            if (!$commentDataUnchanged) {
-                Logger::editComment($database, $comment, $request);
-                $this->getNotificationHelper()->commentEdited($comment, $request);
-            }
-
-            if ($doUnflag && $canUnflag) {
-                Logger::unflaggedComment($database, $comment, $request->getDomain());
-            }
-
-            SessionAlert::success('Comment has been saved successfully');
-            $this->redirectBack($comment->getRequest());
-        }
-        else {
-            $this->assignCSRFToken();
-            $this->assign('comment', $comment);
-            $this->assign('request', $request);
-            $this->assign('user', User::getById($comment->getUser(), $database));
-            $this->assign('canUnflag', $canUnflag);
-            $this->setTemplate('edit-comment.tpl');
-        }
-    }
-
-    /**
-     * @throws AccessDeniedException
-     */
-    private function checkCommentAccess(Comment $comment, User $currentUser): void
-    {
-        if ($comment->getUser() !== $currentUser->getId() && !$this->barrierTest('editOthers', $currentUser)) {
-            throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
-        }
-
-        $restrictedVisibility = $comment->getFlagged()
-            || $comment->getVisibility() === 'admin'
-            || $comment->getVisibility() === 'checkuser';
-
-        if ($restrictedVisibility && !$this->barrierTest('alwaysSeePrivateData', $currentUser, 'RequestData')) {
-            // Restricted visibility comments can only be seen if the user has a request reserved.
-            /** @var Request $request */
-            $request = Request::getById($comment->getRequest(), $comment->getDatabase());
-
-            if ($request->getReserved() !== $currentUser->getId()) {
-                throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
-            }
-        }
-
-        if ($comment->getVisibility() === 'admin'
-            && !$this->barrierTest('seeRestrictedComments', $currentUser, 'RequestData')
-            && $comment->getUser() !== $currentUser->getId()) {
-            throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
-        }
-
-        if ($comment->getVisibility() === 'checkuser'
-            && !$this->barrierTest('seeCheckuserComments', $currentUser, 'RequestData')
-            && $comment->getUser() !== $currentUser->getId()) {
-            throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
-        }
-    }
-
-    /**
-     * @throws ApplicationLogicException
-     */
-    private function updateCommentData(Comment $comment, ?string $visibility, string $newComment): void
-    {
-        if ($comment->getVisibility() !== 'requester') {
-            if ($visibility !== 'user' && $visibility !== 'admin' && $visibility !== 'checkuser') {
-                throw new ApplicationLogicException('Comment visibility is not valid');
-            }
-
-            $comment->setVisibility($visibility);
-        }
-
-        $comment->setComment($newComment);
-        $comment->touchEdited();
-    }
-
-    private function redirectBack(int $requestId): void
-    {
-        $source = WebRequest::getString('from');
-
-        if ($source == 'flagged') {
-            $this->redirect('flaggedComments');
-        }
-        else {
-            $this->redirect('viewRequest', null, array('id' => $requestId));
-        }
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @throws ApplicationLogicException
+	 * @throws Exception
+	 */
+	protected function main()
+	{
+		$commentId = WebRequest::getInt('id');
+		if ($commentId === null) {
+			throw new ApplicationLogicException('Comment ID not specified');
+		}
+
+		$database = $this->getDatabase();
+
+		/** @var Comment|false $comment */
+		$comment = Comment::getById($commentId, $database);
+		if ($comment === false) {
+			throw new ApplicationLogicException('Comment not found');
+		}
+
+		$currentUser = User::getCurrent($database);
+
+		$this->checkCommentAccess($comment, $currentUser);
+
+		/** @var Request|false $request */
+		$request = Request::getById($comment->getRequest(), $database);
+
+		if ($request === false) {
+			throw new ApplicationLogicException('Request was not found.');
+		}
+
+		$canUnflag = $this->barrierTest('unflag', $currentUser, PageFlagComment::class);
+
+		if (WebRequest::wasPosted()) {
+			$this->validateCSRFToken();
+			$newComment = WebRequest::postString('newcomment');
+			$visibility = WebRequest::postString('visibility');
+			$doUnflag = WebRequest::postBoolean('unflag');
+
+			if ($newComment === null || $newComment === '') {
+				throw new ApplicationLogicException('Comment cannot be empty!');
+			}
+
+			$commentDataUnchanged = $newComment === $comment->getComment()
+				&& ($comment->getVisibility() === 'requester' || $comment->getVisibility() === $visibility);
+			$flagStatusUnchanged = (!$canUnflag || $comment->getFlagged() && !$doUnflag);
+
+			if ($commentDataUnchanged && $flagStatusUnchanged) {
+				// No change was made; redirect back.
+				$this->redirectBack($comment->getRequest());
+
+				return;
+			}
+
+			// optimistically lock from the load of the edit comment form
+			$updateVersion = WebRequest::postInt('updateversion');
+
+			// comment data has changed, update the object
+			if (!$commentDataUnchanged) {
+				$this->updateCommentData($comment, $visibility, $newComment);
+			}
+
+			if ($doUnflag && $canUnflag) {
+				$comment->setFlagged(false);
+			}
+
+			$comment->setUpdateVersion($updateVersion);
+			$comment->save();
+
+			if (!$commentDataUnchanged) {
+				Logger::editComment($database, $comment, $request);
+				$this->getNotificationHelper()->commentEdited($comment, $request);
+			}
+
+			if ($doUnflag && $canUnflag) {
+				Logger::unflaggedComment($database, $comment, $request->getDomain());
+			}
+
+			SessionAlert::success('Comment has been saved successfully');
+			$this->redirectBack($comment->getRequest());
+		}
+		else {
+			$this->assignCSRFToken();
+			$this->assign('comment', $comment);
+			$this->assign('request', $request);
+			$this->assign('user', User::getById($comment->getUser(), $database));
+			$this->assign('canUnflag', $canUnflag);
+			$this->setTemplate('edit-comment.tpl');
+		}
+	}
+
+	/**
+	 * @throws AccessDeniedException
+	 */
+	private function checkCommentAccess(Comment $comment, User $currentUser): void
+	{
+		if ($comment->getUser() !== $currentUser->getId() && !$this->barrierTest('editOthers', $currentUser)) {
+			throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
+		}
+
+		$restrictedVisibility = $comment->getFlagged()
+			|| $comment->getVisibility() === 'admin'
+			|| $comment->getVisibility() === 'checkuser';
+
+		if ($restrictedVisibility && !$this->barrierTest('alwaysSeePrivateData', $currentUser, 'RequestData')) {
+			// Restricted visibility comments can only be seen if the user has a request reserved.
+			/** @var Request $request */
+			$request = Request::getById($comment->getRequest(), $comment->getDatabase());
+
+			if ($request->getReserved() !== $currentUser->getId()) {
+				throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
+			}
+		}
+
+		if ($comment->getVisibility() === 'admin'
+			&& !$this->barrierTest('seeRestrictedComments', $currentUser, 'RequestData')
+			&& $comment->getUser() !== $currentUser->getId()) {
+			throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
+		}
+
+		if ($comment->getVisibility() === 'checkuser'
+			&& !$this->barrierTest('seeCheckuserComments', $currentUser, 'RequestData')
+			&& $comment->getUser() !== $currentUser->getId()) {
+			throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
+		}
+	}
+
+	/**
+	 * @throws ApplicationLogicException
+	 */
+	private function updateCommentData(Comment $comment, ?string $visibility, string $newComment): void
+	{
+		if ($comment->getVisibility() !== 'requester') {
+			if ($visibility !== 'user' && $visibility !== 'admin' && $visibility !== 'checkuser') {
+				throw new ApplicationLogicException('Comment visibility is not valid');
+			}
+
+			$comment->setVisibility($visibility);
+		}
+
+		$comment->setComment($newComment);
+		$comment->touchEdited();
+	}
+
+	private function redirectBack(int $requestId): void
+	{
+		$source = WebRequest::getString('from');
+
+		if ($source == 'flagged') {
+			$this->redirect('flaggedComments');
+		}
+		else {
+			$this->redirect('viewRequest', null, array('id' => $requestId));
+		}
+	}
 }

includes/Pages/Statistics/StatsFastCloses.php

Indentation +11 added lines, -11 removed lines

@@ -13,11 +13,11 @@ 
 
 class StatsFastCloses extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Fast Closes :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Fast Closes :: Statistics');
 
-        $query = <<<SQL
+		$query = <<<SQL
 WITH closedescs AS (
     SELECT closes, mail_desc FROM closes
     UNION ALL
@@ -47,11 +47,11 @@ 
 ORDER BY TIMEDIFF(log_closed.timestamp, log_reserved.timestamp) ASC
 ;
 SQL;
-        $database = $this->getDatabase();
-        $statement = $database->query($query);
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $this->assign('dataTable', $data);
-        $this->assign('statsPageTitle', 'Requests closed less than 30 seconds after reservation in the past 3 months');
-        $this->setTemplate('statistics/fast-closes.tpl');
-    }
+		$database = $this->getDatabase();
+		$statement = $database->query($query);
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$this->assign('dataTable', $data);
+		$this->assign('statsPageTitle', 'Requests closed less than 30 seconds after reservation in the past 3 months');
+		$this->setTemplate('statistics/fast-closes.tpl');
+	}
 }

includes/Pages/Statistics/StatsTemplateStats.php

Indentation +17 added lines, -17 removed lines

@@ -15,11 +15,11 @@ 
 
 class StatsTemplateStats extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Template Stats :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Template Stats :: Statistics');
 
-        $query = <<<SQL
+		$query = <<<SQL
 SELECT
     t.id AS templateid,
     t.usercode AS usercode,
@@ -49,17 +49,17 @@ 
      ) allUsers ON allUsers.welcome_template = t.id
 ORDER BY t.id
 SQL;
-        $database = $this->getDatabase();
-        $statement = $database->prepare($query);
-        $statement->execute([
-            ':domain1' => WebRequest::getSessionDomain(),
-            ':domain2' => WebRequest::getSessionDomain(),
-            ':preference1' => PreferenceManager::PREF_WELCOMETEMPLATE,
-            ':preference2' => PreferenceManager::PREF_WELCOMETEMPLATE,
-        ]);
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $this->assign('dataTable', $data);
-        $this->assign('statsPageTitle', 'Template Stats');
-        $this->setTemplate('statistics/welcome-template-usage.tpl');
-    }
+		$database = $this->getDatabase();
+		$statement = $database->prepare($query);
+		$statement->execute([
+			':domain1' => WebRequest::getSessionDomain(),
+			':domain2' => WebRequest::getSessionDomain(),
+			':preference1' => PreferenceManager::PREF_WELCOMETEMPLATE,
+			':preference2' => PreferenceManager::PREF_WELCOMETEMPLATE,
+		]);
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$this->assign('dataTable', $data);
+		$this->assign('statsPageTitle', 'Template Stats');
+		$this->setTemplate('statistics/welcome-template-usage.tpl');
+	}
 }

includes/Pages/Statistics/StatsTopCreators.php

Indentation +34 added lines, -34 removed lines

@@ -14,12 +14,12 @@ 
 
 class StatsTopCreators extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Top Creators :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Top Creators :: Statistics');
 
-        // Retrieve all-time stats
-        $queryAllTime = <<<SQL
+		// Retrieve all-time stats
+		$queryAllTime = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/queryAllTime */
     COUNT(*) count,
@@ -36,8 +36,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve all-time stats for active users only
-        $queryAllTimeActive = <<<SQL
+		// Retrieve all-time stats for active users only
+		$queryAllTimeActive = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/queryAllTimeActive */
     COUNT(*) count,
@@ -54,8 +54,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve today's stats (so far)
-        $queryToday = <<<SQL
+		// Retrieve today's stats (so far)
+		$queryToday = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5out */
     COUNT(*) count,
@@ -71,8 +71,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve Yesterday's stats
-        $queryYesterday = <<<SQL
+		// Retrieve Yesterday's stats
+		$queryYesterday = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5yout */
     COUNT(*) count,
@@ -88,8 +88,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve last 7 days
-        $queryLast7Days = <<<SQL
+		// Retrieve last 7 days
+		$queryLast7Days = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5wout */
     COUNT(*) count,
@@ -105,8 +105,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve last month's stats
-        $queryLast28Days = <<<SQL
+		// Retrieve last month's stats
+		$queryLast28Days = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5mout */
     COUNT(*) count,
@@ -122,25 +122,25 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Put it all together
-        $queries = array(
-            'queryAllTime'       => $queryAllTime,
-            'queryAllTimeActive' => $queryAllTimeActive,
-            'queryToday'         => $queryToday,
-            'queryYesterday'     => $queryYesterday,
-            'queryLast7Days'     => $queryLast7Days,
-            'queryLast28Days'    => $queryLast28Days,
-        );
+		// Put it all together
+		$queries = array(
+			'queryAllTime'       => $queryAllTime,
+			'queryAllTimeActive' => $queryAllTimeActive,
+			'queryToday'         => $queryToday,
+			'queryYesterday'     => $queryYesterday,
+			'queryLast7Days'     => $queryLast7Days,
+			'queryLast28Days'    => $queryLast28Days,
+		);
 
-        $database = $this->getDatabase();
-        foreach ($queries as $name => $sql) {
-            $statement = $database->prepare($sql);
-            $statement->execute([":created" => EmailTemplate::ACTION_CREATED]);
-            $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-            $this->assign($name, $data);
-        }
+		$database = $this->getDatabase();
+		foreach ($queries as $name => $sql) {
+			$statement = $database->prepare($sql);
+			$statement->execute([":created" => EmailTemplate::ACTION_CREATED]);
+			$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+			$this->assign($name, $data);
+		}
 
-        $this->assign('statsPageTitle', 'Top Account Creators');
-        $this->setTemplate('statistics/top-creators.tpl');
-    }
+		$this->assign('statsPageTitle', 'Top Account Creators');
+		$this->setTemplate('statistics/top-creators.tpl');
+	}
 }

includes/Pages/Statistics/StatsMonthlyStats.php

Indentation +11 added lines, -11 removed lines

@@ -13,11 +13,11 @@ 
 
 class StatsMonthlyStats extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Monthly Stats :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Monthly Stats :: Statistics');
 
-        $query = <<<SQL
+		$query = <<<SQL
 WITH activemonths AS (
     -- Pull all values from two generated sequences (values 2008 to 2050, and values 1 to 12) to generate dates.
     -- Filter the resulting set down to months between the earliest and latest log entries.
@@ -155,12 +155,12 @@ 
 ORDER BY sortkey ASC;
 SQL;
 
-        $database = $this->getDatabase();
-        $statement = $database->query($query);
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$database = $this->getDatabase();
+		$statement = $database->query($query);
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
 
-        $this->assign('dataTable', $data);
-        $this->assign('statsPageTitle', 'Monthly Statistics');
-        $this->setTemplate('statistics/monthly-stats.tpl');
-    }
+		$this->assign('dataTable', $data);
+		$this->assign('statsPageTitle', 'Monthly Statistics');
+		$this->setTemplate('statistics/monthly-stats.tpl');
+	}
 }