PageSearch::getCommentSearchResults() - Code Metrics - Inspection of "Introduce manual confirmation" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#753)

by Matthew
created 2022-08-05 18:46 UTC
PageSearch::getCommentSearchResults() A

↳ Parent: PageSearch
Complexity

Conditions	3
Paths	4
Size

Total Lines	17
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	12
Importance

Changes	2
Bugs	1	Features	0
Metric	Value
eloc	9
c	2
b	1
f	0
dl	0
loc	17
ccs	0
cts	13
cp	0
rs	9.9666
cc	3
nc	4
nop	2
crap	12
<?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 Waca\DataObjects\Request;
use Waca\DataObjects\User;
use Waca\Exceptions\AccessDeniedException;
use Waca\Exceptions\ApplicationLogicException;
use Waca\Fragments\RequestListData;
use Waca\Helpers\SearchHelpers\RequestSearchHelper;
use Waca\SessionAlert;
use Waca\Tasks\PagedInternalPageBase;
use Waca\WebRequest;

class PageSearch extends PagedInternalPageBase
{
    use RequestListData;

    /**
     * Main function for this page, when no specific actions are called.
     */
    protected function main()
    {
        $this->setHtmlTitle('Search');

        $database = $this->getDatabase();
        $currentUser = User::getCurrent($database);

        $this->assign('canSearchByComment', $this->barrierTest('byComment', $currentUser));
        $this->assign('canSearchByEmail', $this->barrierTest('byEmail', $currentUser));
        $this->assign('canSearchByIp', $this->barrierTest('byIp', $currentUser));
        $this->assign('canSearchByName', $this->barrierTest('byName', $currentUser));
        $this->assign('canSeeNonConfirmed', $this->barrierTest('allowNonConfirmed', $currentUser));

        $this->setTemplate('search/main.tpl');

        // Dual-mode page
        if (WebRequest::getString('type') !== null) {
            $searchType = WebRequest::getString('type');
            $searchTerm = WebRequest::getString('term');

            $excludeNonConfirmed = true;
            if ($this->barrierTest('allowNonConfirmed', $currentUser)) {
                $excludeNonConfirmed = WebRequest::getBoolean('excludeNonConfirmed');
            }

            $validationError = "";
            if (!$this->validateSearchParameters($searchType, $searchTerm, $validationError)) {
                SessionAlert::error($validationError, "Search error");

                $this->assign('term', $searchTerm);
                $this->assign('target', $searchType);
                $this->assign('excludeNonConfirmed', $excludeNonConfirmed);
                $this->assign('hasResultset', false);

                return;
            }

            // searchType known to be sane from the validate step above
            if (!$this->barrierTest('by' . ucfirst($searchType), User::getCurrent($this->getDatabase()))) {
            if (!$this->barrierTest('by' . ucfirst(/** @scrutinizer ignore-type */ $searchType), User::getCurrent($this->getDatabase()))) {
                // only accessible by url munging, don't care about the UX
                throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
            }

            $requestSearch = RequestSearchHelper::get($database);

            $this->setSearchHelper($requestSearch);
            $this->setupLimits();

            if ($excludeNonConfirmed) {
                $requestSearch->withConfirmedEmail();
            }

            switch ($searchType) {
                case 'name':
                    $this->getNameSearchResults($requestSearch, $searchTerm);
                    $this->getNameSearchResults($requestSearch, /** @scrutinizer ignore-type */ $searchTerm);
                    break;
                case 'email':
                    $this->getEmailSearchResults($requestSearch, $searchTerm);
                    $this->getEmailSearchResults($requestSearch, /** @scrutinizer ignore-type */ $searchTerm);
                    break;
                case 'ip':
                    $this->getIpSearchResults($requestSearch, $searchTerm);
                    $this->getIpSearchResults($requestSearch, /** @scrutinizer ignore-type */ $searchTerm);
                    break;
                case 'comment':
                    $this->getCommentSearchResults($requestSearch, $searchTerm);
                    $this->getCommentSearchResults($requestSearch, /** @scrutinizer ignore-type */ $searchTerm);
                    break;
            }

            /** @var Request[] $results */
            $results = $requestSearch->getRecordCount($count)->fetch();

            $formParameters = [
                'term' => $searchTerm,
                'type' => $searchType,
            ];

            if ($excludeNonConfirmed) {
                $formParameters['excludeNonConfirmed'] = true;
            }

            $this->setupPageData($count, $formParameters);

            // deal with results
            $this->assign('requests', $this->prepareRequestData($results));
            $this->assign('resultCount', count($results));
            $this->assign('hasResultset', true);

            list($defaultSort, $defaultSortDirection) = WebRequest::requestListDefaultSort();
            $this->assign('defaultSort', $defaultSort);
            $this->assign('defaultSortDirection', $defaultSortDirection);
        }
        else {
            $this->assign('target', 'name');
            $this->assign('hasResultset', false);
            $this->assign('limit', 50);
            $this->assign('excludeNonConfirmed', true);
        }
    }

    /**
     * Gets search results by name
     *
     * @param RequestSearchHelper $searchHelper
     * @param string              $searchTerm
     */
    private function getNameSearchResults(RequestSearchHelper $searchHelper, string $searchTerm)
    {
        $padded = '%' . $searchTerm . '%';
        $searchHelper->byName($padded);
    }

    /**
     * Gets search results by comment
     *
     * @param RequestSearchHelper $searchHelper
     * @param string              $searchTerm
     */
    private function getCommentSearchResults(RequestSearchHelper $searchHelper, string $searchTerm)
    {
        $padded = '%' . $searchTerm . '%';
        $searchHelper->byComment($padded);

        $currentUser = User::getCurrent($this->getDatabase());
        $commentSecurity = ['requester', 'user'];

        if ($this->barrierTest('seeRestrictedComments', $currentUser, 'RequestData')) {
            $commentSecurity[] = 'admin';
        }

        if ($this->barrierTest('seeCheckuserComments', $currentUser, 'RequestData')) {
            $commentSecurity[] = 'checkuser';
        }

        $searchHelper->byCommentSecurity($commentSecurity);
    }

    /**
     * Gets search results by email
     *
     * @param RequestSearchHelper $searchHelper
     * @param string              $searchTerm
     *
     * @throws ApplicationLogicException
     */
    private function getEmailSearchResults(RequestSearchHelper $searchHelper, string $searchTerm)
    {
        if ($searchTerm === "@") {
            throw new ApplicationLogicException('The search term "@" is not valid for email address searches!');
        }

        $padded = '%' . $searchTerm . '%';

        $searchHelper->byEmailAddress($padded)->excludingPurgedData($this->getSiteConfiguration());
    }

    /**
     * Gets search results by IP address or XFF IP address
     *
     * @param RequestSearchHelper $searchHelper
     * @param string              $searchTerm
     */
    private function getIpSearchResults(RequestSearchHelper $searchHelper, string $searchTerm)
    {
        $searchHelper
            ->byIp($searchTerm)
            ->excludingPurgedData($this->getSiteConfiguration());
    }

    /**
     * @param string $searchType
     * @param string $searchTerm
     *
     * @param string $errorMessage
     *
     * @return bool true if parameters are valid
     */
    protected function validateSearchParameters($searchType, $searchTerm, &$errorMessage)
    {
        if (!in_array($searchType, array('name', 'email', 'ip', 'comment'))) {
            $errorMessage = 'Unknown search type';

            return false;
        }

        if ($searchTerm === '%' || $searchTerm === '' || $searchTerm === null) {
            $errorMessage = 'No search term specified entered';

            return false;
        }

        $errorMessage = "";

        return true;
    }
}

enwikipedia-acc / waca

Pull Request — master (#753)

PageSearch::getCommentSearchResults() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
