PageBan::validateEmailBanTarget() - Code Metrics - Inspection of "fix" - mdaniels5757/waca - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — rbac ( be68b4...52c28b )

by Michael

created 2020-04-26 02:29 UTC

PageBan::validateEmailBanTarget() A

↳ Parent: PageBan

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
eloc	2
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
cc	2
nc	2
nop	1
crap	6

<?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;

use Exception;
use Waca\DataObjects\Ban;
use Waca\DataObjects\Request;
use Waca\DataObjects\User;
use Waca\Exceptions\ApplicationLogicException;
use Waca\Helpers\Logger;
use Waca\Helpers\SearchHelpers\UserSearchHelper;
use Waca\SessionAlert;
use Waca\Tasks\InternalPageBase;
use Waca\WebRequest;

class PageBan extends InternalPageBase
{
    /**
     * Main function for this page, when no specific actions are called.
     */
    protected function main()
    {
        $this->assignCSRFToken();

        $this->setHtmlTitle('Bans');

        $bans = Ban::getActiveBans(null, $this->getDatabase());

        $userIds = array_map(
            function(Ban $entry) {

                return $entry->getUser();
            },
            $bans);
        $userList = UserSearchHelper::get($this->getDatabase())->inIds($userIds)->fetchMap('username');

        $user = User::getCurrent($this->getDatabase());
        $this->assign('canSet', $this->barrierTest('set', $user));
        $this->assign('canRemove', $this->barrierTest('remove', $user));

        $this->assign('usernames', $userList);
        $this->assign('activebans', $bans);
        $this->setTemplate('bans/banlist.tpl');
    }


    /**
     * Entry point for the ban set action
     */
    protected function set()
    {
        $this->setHtmlTitle('Bans');

        // dual-mode action
        if (WebRequest::wasPosted()) {
            try {
                $this->handlePostMethodForSetBan();
            }
            catch (ApplicationLogicException $ex) {
                SessionAlert::error($ex->getMessage());
                $this->redirect("bans", "set");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }
        }
        else {
            $this->handleGetMethodForSetBan();
        }
    }


    /**
     * Entry point for the ban remove action
     */
    protected function remove()
    {
        $this->setHtmlTitle('Bans');

        $ban = $this->getBanForUnban();

        // dual mode
        if (WebRequest::wasPosted()) {
            $this->validateCSRFToken();
            $unbanReason = WebRequest::postString('unbanreason');

            if ($unbanReason === null || trim($unbanReason) === "") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                SessionAlert::error('No unban reason specified');
                $this->redirect("bans", "remove", array('id' => $ban->getId()));
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }

            // set optimistic locking from delete form page load
            $updateVersion = WebRequest::postInt('updateversion');
            $ban->setUpdateVersion($updateVersion);

            $database = $this->getDatabase();
            $ban->setActive(false);
            $ban->save();

            Logger::unbanned($database, $ban, $unbanReason);

            SessionAlert::quick('Disabled ban.');
            $this->getNotificationHelper()->unbanned($ban, $unbanReason);

            $this->redirect('bans');
        }
        else {
            $this->assignCSRFToken();
            $this->assign('ban', $ban);
            $this->setTemplate('bans/unban.tpl');
        }
    }


    /**
     * @throws ApplicationLogicException
     */
    private function getBanDuration()
    {
        $duration = WebRequest::postString('duration');
        if ($duration === "other") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            $duration = strtotime(WebRequest::postString('otherduration'));

            if (!$duration) {
                throw new ApplicationLogicException('Invalid ban time');
            }
            elseif (time() > $duration) {
                throw new ApplicationLogicException('Ban time has already expired!');
            }

            return $duration;
        }
        elseif ($duration === "-1") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            $duration = -1;

            return $duration;
        }
        else {
            $duration = WebRequest::postInt('duration') + time();

            return $duration;
        }
    }


    /**
     * @param string $type
     * @param string $target
     *
     * @throws ApplicationLogicException
     */
    private function validateBanType($type, $target)
    {
        switch ($type) {
            case 'IP':
                $this->validateIpBan($target);

                return;
            case 'Name':
                // No validation needed here.
                return;
            case 'EMail':
                $this->validateEmailBanTarget($target);

                return;
            default:
                throw new ApplicationLogicException("Unknown ban type");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
    }


    /**
     * Handles the POST method on the set action
     *
     * @throws ApplicationLogicException
     * @throws Exception
     */

    private function handlePostMethodForSetBan()
    {
        $this->validateCSRFToken();
        $reason = WebRequest::postString('banreason');
        $target = WebRequest::postString('target');

        // Checks whether there is a reason entered for ban.
        if ($reason === null || trim($reason) === "") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            throw new ApplicationLogicException('You must specify a ban reason');
        }

        // Checks whether there is a target entered to ban.
        if ($target === null || trim($target) === "") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            throw new ApplicationLogicException('You must specify a target to be banned');
        }

        // Validate ban duration
        $duration = $this->getBanDuration();

        // Validate ban type & target for that type
        $type = WebRequest::postString('type');
        $this->validateBanType($type, $target);

        $database = $this->getDatabase();

        if (count(Ban::getActiveBans($target, $database)) > 0) {
            throw new ApplicationLogicException('This target is already banned!');
        }

        $ban = new Ban();
        $ban->setDatabase($database);
        $ban->setActive(true);
        $ban->setType($type);
        $ban->setTarget($target);
        $ban->setUser(User::getCurrent($database)->getId());
        $ban->setReason($reason);
        $ban->setDuration($duration);

        $ban->save();

        Logger::banned($database, $ban, $reason);

        $this->getNotificationHelper()->banned($ban);
        SessionAlert::quick('Ban has been set.');

        $this->redirect('bans');
    }


    /**
     * Handles the GET method on the set action
     */
    protected function handleGetMethodForSetBan()
    {
        $this->setTemplate('bans/banform.tpl');
        $this->assignCSRFToken();

        $banType = WebRequest::getString('type');
        $banTarget = WebRequest::getInt('request');

        $database = $this->getDatabase();

        // if the parameters are null, skip loading a request.
        if ($banType === null
            || !in_array($banType, array('IP', 'Name', 'EMail'))
            || $banTarget === null
            || $banTarget === 0
        ) {
            $this->assign('bantarget', '');
            $this->assign('bantype', '');

            return;
        }

        // Set the ban type, which the user has indicated.
        $this->assign('bantype', $banType);

        // Attempt to resolve the correct target
        /** @var Request $request */
        $request = Request::getById($banTarget, $database);
        if ($request === false) {

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

            return;
        }

        $realTarget = '';
        switch ($banType) {
            case 'EMail':
                $realTarget = $request->getEmail();
                break;
            case 'IP':
                $xffProvider = $this->getXffTrustProvider();
                $realTarget = $xffProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
                break;
            case 'Name':
                $realTarget = $request->getName();
                break;
        }

        $this->assign('bantarget', $realTarget);
    }


    /**
     * Validates an IP ban target
     *
     * @param string $target
     *
     * @throws ApplicationLogicException
     */
    private function validateIpBan($target)
    {
        $squidIpList = $this->getSiteConfiguration()->getSquidList();

        if (filter_var($target, FILTER_VALIDATE_IP) === false) {
            throw new ApplicationLogicException('Invalid target - IP address expected.');
        }

        if (in_array($target, $squidIpList)) {
            throw new ApplicationLogicException("This IP address is on the protected list of proxies, and cannot be banned.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
    }


    /**
     * Validates an email address as a ban target
     *
     * @param string $target
     *
     * @throws ApplicationLogicException
     */
    private function validateEmailBanTarget($target)
    {
        if (filter_var($target, FILTER_VALIDATE_EMAIL) !== $target) {
            throw new ApplicationLogicException('Invalid target - email address expected.');
        }
    }


    /**
     * @return Ban
     * @throws ApplicationLogicException
     */
    private function getBanForUnban()
    {
        $banId = WebRequest::getInt('id');
        if ($banId === null || $banId === 0) {
            throw new ApplicationLogicException("The ban ID appears to be missing. This is probably a bug.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }

        $ban = Ban::getActiveId($banId, $this->getDatabase());

        if ($ban === false) {

            throw new ApplicationLogicException("The specified ban is not currently active, or doesn't exist.");
        }

        return $ban;
    }

}



1			<?php
2			/******************************************************************************
3			* Wikipedia Account Creation Assistance tool *
4			* *
5			* All code in this file is released into the public domain by the ACC *
6			* Development Team. Please see team.json for a list of contributors. *
7			******************************************************************************/
8
9			namespace Waca\Pages;
10
11			use Exception;
12			use Waca\DataObjects\Ban;
13			use Waca\DataObjects\Request;
14			use Waca\DataObjects\User;
15			use Waca\Exceptions\ApplicationLogicException;
16			use Waca\Helpers\Logger;
17			use Waca\Helpers\SearchHelpers\UserSearchHelper;
18			use Waca\SessionAlert;
19			use Waca\Tasks\InternalPageBase;
20			use Waca\WebRequest;
21
22			class PageBan extends InternalPageBase
23			{
24			/**
25			* Main function for this page, when no specific actions are called.
26			*/
27			protected function main()
28			{
29			$this->assignCSRFToken();
30
31			$this->setHtmlTitle('Bans');
32
33			$bans = Ban::getActiveBans(null, $this->getDatabase());
34
35			$userIds = array_map(
36			function(Ban $entry) {
			0 ignored issues – show Coding Style introduced 2020-04-26 01:41 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
37			return $entry->getUser();
38			},
39			$bans);

mdaniels5757 / waca

Push — rbac ( be68b4...52c28b )

PageBan::validateEmailBanTarget() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like