PageSearch::main() - Code Metrics - Inspection of "Add option to exclude non-email confirmed requests..." - mdaniels5757/waca - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — search ( a5d1cc )

by Michael

created 2020-06-03 17:38 UTC

PageSearch::main() B

↳ Parent: PageSearch

Complexity

Conditions	8
Paths	12

Size

Total Lines	67
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
eloc	46
c	4
b	0
f	0
dl	0
loc	67
rs	7.9337
cc	8
nc	12
nop	0

How to fix Long Method

<?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\ApplicationLogicException;
use Waca\Fragments\RequestListData;
use Waca\Helpers\SearchHelpers\RequestSearchHelper;
use Waca\Security\SecurityManager;
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');

        // Dual-mode page
        if (WebRequest::getString('type') !== null) {
            $searchType = WebRequest::getString('type');
            $searchTerm = WebRequest::getString('term');
            $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;
            }

            $requestSearch = RequestSearchHelper::get($this->getDatabase());

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

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

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

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

            $this->setupPageData($count, [
                'term'                => $searchTerm,
                'type'                => $searchType,
                'excludeNonConfirmed' => $excludeNonConfirmed,
            ]);

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

            $this->setTemplate('search/main.tpl');
        }
        else {
            $this->assign('target', 'name');
            $this->assign('hasResultset', false);
            $this->assign('limit', 50);
            $this->assign('excludeNonConfirmed', true);
            $this->setTemplate('search/main.tpl');
        }
    }

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

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

        $securityManager = $this->getSecurityManager();
        $currentUser = User::getCurrent($this->getDatabase());
        $securityResult = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser);

        if ($securityResult !== SecurityManager::ALLOWED) {
            $searchHelper->byCommentSecurity(['requester', 'user']);
        }
    }

    /**
     * Gets search results by email
     *
     * @param        $searchHelper
     * @param string $searchTerm
     *
     * @throws ApplicationLogicException
     */
    private function getEmailSearchResults(RequestSearchHelper $searchHelper, $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, $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;
    }
}


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 Waca\DataObjects\Request;
12			use Waca\DataObjects\User;
13			use Waca\Exceptions\ApplicationLogicException;
14			use Waca\Fragments\RequestListData;
15			use Waca\Helpers\SearchHelpers\RequestSearchHelper;
16			use Waca\Security\SecurityManager;
17			use Waca\SessionAlert;
18			use Waca\Tasks\PagedInternalPageBase;
19			use Waca\WebRequest;
20
21			class PageSearch extends PagedInternalPageBase
22			{
23			use RequestListData;
24
25			/**
26			* Main function for this page, when no specific actions are called.
27			*/
28			protected function main()
29			{
30			$this->setHtmlTitle('Search');
31
32			// Dual-mode page
33			if (WebRequest::getString('type') !== null) {
34			$searchType = WebRequest::getString('type');
35			$searchTerm = WebRequest::getString('term');
36			$excludeNonConfirmed = WebRequest::getBoolean('excludeNonConfirmed');
37
38			$validationError = "";
39			if (!$this->validateSearchParameters($searchType, $searchTerm, $validationError)) {
40			SessionAlert::error($validationError, "Search error");
41
42			$this->assign('term', $searchTerm);
43			$this->assign('target', $searchType);
44			$this->assign('excludeNonConfirmed', $excludeNonConfirmed);
45			$this->assign('hasResultset', false);
46			return;
47			}
48
49			$requestSearch = RequestSearchHelper::get($this->getDatabase());
50
51			$this->setSearchHelper($requestSearch);
52			$this->setupLimits();
53
54			if ($excludeNonConfirmed) {
55			$requestSearch->withConfirmedEmail();
56			}
57
58			switch ($searchType) {
59			case 'name':
60			$this->getNameSearchResults($requestSearch, $searchTerm);
61			break;
62			case 'email':
63			$this->getEmailSearchResults($requestSearch, $searchTerm);
64			break;
65			case 'ip':
66			$this->getIpSearchResults($requestSearch, $searchTerm);
67			break;
68			case 'comment':
69			$this->getCommentSearchResults($requestSearch, $searchTerm);
70			break;
71			}
72
73			/** @var Request[] $results */
74			$results = $requestSearch->getRecordCount($count)->fetch();
75
76			$this->setupPageData($count, [
77			'term' => $searchTerm,
78			'type' => $searchType,
79			'excludeNonConfirmed' => $excludeNonConfirmed,
80			]);
81
82			// deal with results
83			$this->assign('requests', $this->prepareRequestData($results));
84			$this->assign('resultCount', count($results));
85			$this->assign('hasResultset', true);
86
87			$this->setTemplate('search/main.tpl');
88			}
89			else {
90			$this->assign('target', 'name');
91			$this->assign('hasResultset', false);
92			$this->assign('limit', 50);
93			$this->assign('excludeNonConfirmed', true);
94			$this->setTemplate('search/main.tpl');
95			}
96			}
97
98			/**
99			* Gets search results by name
100			*
101			* @param RequestSearchHelper $searchHelper
102			* @param string $searchTerm
103			*/
104			private function getNameSearchResults(RequestSearchHelper $searchHelper, $searchTerm)
105			{
106			$padded = '%' . $searchTerm . '%';
107			$searchHelper->byName($padded);
108			}
109
110			/**
111			* Gets search results by comment
112			*
113			* @param RequestSearchHelper $searchHelper
114			* @param string $searchTerm
115			*/
116			private function getCommentSearchResults(RequestSearchHelper $searchHelper, $searchTerm)
117			{
118			$padded = '%' . $searchTerm . '%';
119			$searchHelper->byComment($padded);
120
121			$securityManager = $this->getSecurityManager();
122			$currentUser = User::getCurrent($this->getDatabase());
123			$securityResult = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser);
124
125			if ($securityResult !== SecurityManager::ALLOWED) {
126			$searchHelper->byCommentSecurity(['requester', 'user']);
127			}
128			}
129
130			/**
131			* Gets search results by email
132			*
133			* @param $searchHelper
134			* @param string $searchTerm
135			*
136			* @throws ApplicationLogicException
137			*/
138			private function getEmailSearchResults(RequestSearchHelper $searchHelper, $searchTerm)
139			{
140			if ($searchTerm === "@") {
141			throw new ApplicationLogicException('The search term "@" is not valid for email address searches!');
142			}
143
144			$padded = '%' . $searchTerm . '%';
145
146			$searchHelper->byEmailAddress($padded)->excludingPurgedData($this->getSiteConfiguration());
147			}
148
149			/**
150			* Gets search results by IP address or XFF IP address
151			*
152			* @param RequestSearchHelper $searchHelper
153			* @param string $searchTerm
154			*/
155			private function getIpSearchResults(RequestSearchHelper $searchHelper, $searchTerm)
156			{
157			$searchHelper
158			->byIp($searchTerm)
159			->excludingPurgedData($this->getSiteConfiguration());
160			}
161
162			/**
163			* @param string $searchType
164			* @param string $searchTerm
165			*
166			* @param string $errorMessage
167			*
168			* @return bool true if parameters are valid
169			*/
170			protected function validateSearchParameters($searchType, $searchTerm, &$errorMessage)
171			{
172			if (!in_array($searchType, array('name', 'email', 'ip', 'comment'))) {
173			$errorMessage = 'Unknown search type';
174
175			return false;
176			}
177
178			if ($searchTerm === '%' \|\| $searchTerm === '' \|\| $searchTerm === null) {
179			$errorMessage = 'No search term specified entered';
180
181			return false;
182			}
183
184			$errorMessage = "";
185
186			return true;
187			}
188			}
189

mdaniels5757 / waca

Push — search ( a5d1cc )

PageSearch::main() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like