AbstractSearchController::resultsFilter() - Code Metrics - Inspection of "Fix noclient" - kitodo/kitodo-publication - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#98)

unknown

created 2018-08-01 16:09 UTC

AbstractSearchController::resultsFilter() C

↳ Parent: AbstractSearchController

Complexity

Conditions	13
Paths	102

Size

Total Lines	76
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	36
nc	102
nop	2
dl	0
loc	76
rs	6.6
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
namespace EWW\Dpf\Controller;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Utility\GeneralUtility;
filter:
    dependency_paths: ["lib/*"]
use EWW\Dpf\Services\ElasticSearch;

abstract class AbstractSearchController extends \EWW\Dpf\Controller\AbstractController
{
    // search terms
    private static $terms   = ['_id', 'OWNER_ID', 'submitter', 'project'];

    // search matches
    private static $matches = ['title', 'abstract', 'author', 'language', 'tag', 'corporation', 'doctype', 'collections'];


    protected function initializeView(\TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view)
filter:
    dependency_paths: ["lib/*"]
    {
        parent::initializeView($view);

        if (TYPO3_MODE === 'BE') {

            $selectedPageId = (int) \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('id');
            if ($selectedPageId) {
                $client = $this->clientRepository->findAll()->current();
            }
            if (!$client) {

                $this->redirect('list','Document');
            }
        }
    }

    /**
     * get results from elastic search
     * @param  array $query elasticsearch search query
     * @return array        results
     */
    public function getResultList($query, $type)
    {

        $elasticSearch = $this->objectManager->get(ElasticSearch::class);
        $results = $elasticSearch->search($query, $type);

        return $results;
    }

    /**
     * prepare fulltext query
     * @param  string $searchString
     * @return array query
     */
    public function searchFulltext($searchString)
    {
        // don't return query if searchString is empty
        if (empty($searchString)) {
            return null;
        }

        $searchString = $this->escapeQuery(trim($searchString));

        $query['body']['query']['bool']['should'][0]['query_string']['query']                       = $searchString;

        $query['body']['query']['bool']['should'][1]['has_child']['query']['query_string']['query'] = $searchString;
        $query['body']['query']['bool']['minimum_should_match'] = "1"; // 1
        $query['body']['query']['bool']['should'][1]['has_child']['child_type'] = "datastream"; // 1

        $query = $this->resultsFilter($query, false);

        return $query;

    }

    /**
     * build array for elasticsearch
     * @return array Elasticsearch query array
     */
    public function extendedSearch($searchArray = array())
    {

        $query  = array();
        $filter = array();
        foreach ($searchArray as $key => $qry) {
            $qry = trim($qry);

            if (!empty($qry) && in_array($key, self::$matches)) {

                $query['body']['query']['bool']['must'][] = array('match' => array($key => $qry));

            } elseif (!empty($qry) && in_array($key, self::$terms)) {

                $query['body']['query']['bool']['must'][] = array('term' => array($key => $qry));

            } elseif (!empty($qry) && $key == 'from') {

                if ($dateTime = $this->convertFormDate($qry, false)) {
                    $filter['gte'] = $dateTime->format('Y-m-d');
                }

            } elseif (!empty($qry) && $key == 'till') {

                if ($dateTime = $this->convertFormDate($qry, true)) {
                    $filter['lte'] = $dateTime->format('Y-m-d');
                }

            }
        }

        if (isset($filter['gte']) || isset($filter['lte'])) {

            $query['body']['query']['bool']['must'][] = array('range' => array('distribution_date' => $filter));

        }

        $showDeleted = ($searchArray['showDeleted'] == 'true') ? true : false;
        $query = $this->resultsFilter($query, $showDeleted);
        return $query;

    }

    /**
     * build array for elasticsearch resultfilter
     * @param array Elasticsearch query array
     * @return array Elasticsearch queryFilter array
     */
    public function resultsFilter($query, $showDeleted = false)
    {

        $queryFilter = array();

        // Frontend only
        $searchResultsFilter = $this->settings['searchResultsFilter'];
        if(!empty($searchResultsFilter)) {

            // add doctypes
            if($searchResultsFilter['doctype']) {

                $uids = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $searchResultsFilter['doctype']);
                $documentTypeRepository = $this->documentTypeRepository;
                $documentTypes = array();
                foreach($uids as $uid) {
                    $documentType = $documentTypeRepository->findByUid($uid);
                    $documentTypes[] = $documentType->getName();
                };
                $searchResultsFilter['doctype'] = implode(',', $documentTypes);
            }

            // add date filter
            $dateFilter = array();
            if ($searchResultsFilter['from']) {

                $from     = date('d.m.Y', $searchResultsFilter['from']);
                $dateTime = $this->convertFormDate($from, false);
                $dateFilter['gte'] = $dateTime->format('Y-m-d');
                unset($searchResultsFilter['from']);

            }

            if ($searchResultsFilter['till']) {

                $till          = date('d.m.Y', $searchResultsFilter['till']);
                $dateTime = $this->convertFormDate($till, true);
                $dateFilter['lte'] = $dateTime->format('Y-m-d');
                unset($searchResultsFilter['till']);

            }

            if (isset($dateFilter['gte']) || isset($dateFilter['lte'])) {

                $queryFilter['body']['query']['bool']['must'][] = array('range' => array('distribution_date' => $dateFilter));

            }

            foreach ($searchResultsFilter as $key => $qry) {

                if(!empty($qry)) {
                    $queryFilter['body']['query']['bool']['must'][] = array('match' => array($key => $qry));
                }

            }

        }

        // document must be active
        if($showDeleted == false) {

            $queryFilter['body']['query']['bool']['must'][]['term']['STATE'] = 'A';

        };

        // add OWNER_ID if present
        $clients = $this->clientRepository->findAll();
        if ($clients) {
            $client = $clients->getFirst();
            if ($client) {
                $queryFilter['body']['query']['bool']['must'][]['term']['OWNER_ID'] = $client->getOwnerId();
            }
        }

        $queryFilter = array_merge_recursive($queryFilter, $query);
        return $queryFilter;
    }

    /**
     * Convert date from form input into DateTime object.
     *
     * A 4 character string is taken for a year and the returning
     * DateTime object is supplemented with either the 01. Jan or 31. Dec
     * depending on the $intervalEnd parameter. This allows querying time
     * intervals like `2000 to 2003`.
     *
     * @param  string    $dateString  Date literal from form
     * @param  bool      $intervalEnd Fills missing values with the maximum possible date if true
     * @return DateTime               Determined date

     */
    public function convertFormDate($dateString, $intervalEnd = false)
    {
        try {
            if (strlen($dateString) == 4) {
                // assuming year
                $year  = $dateString;
                $month = $intervalEnd ? "12" : "01";
                $day   = $intervalEnd ? "31" : "01";
                return new \DateTime("$year-$month-$day");

            } else {
                return new \DateTime($dateString);

            }
        } catch (\Exception $_) {
            return false;

        }
    }

    /**
     * escapes lucene reserved characters from string
     * @param $string
     * @return mixed
     */
    private function escapeQuery($string)
    {
        $luceneReservedCharacters = preg_quote('+-&|!(){}[]^"~?:\\');
        $string                   = preg_replace_callback(
            '/([' . $luceneReservedCharacters . '])/',
            function ($matches) {
                return '\\' . $matches[0];
            },
            $string
        );

        return $string;
    }

    /**
     * converts a date from dd.mm.yy to yyyy-dd-mm
     * @param $date
     * @return string
     */
    public function formatDate($date)
    {
        // convert date from dd.mm.yyy to yyyy-dd-mm
        $date = explode(".", $date);
        return $date[2] . '-' . $date[1] . '-' . $date[0];
    }
}


1			<?php
2			namespace EWW\Dpf\Controller;
3
4			/*
5			* This file is part of the TYPO3 CMS project.
6			*
7			* It is free software; you can redistribute it and/or modify it under
8			* the terms of the GNU General Public License, either version 2
9			* of the License, or any later version.
10			*
11			* For the full copyright and license information, please read the
12			* LICENSE.txt file that was distributed with this source code.
13			*
14			* The TYPO3 project - inspiring people to share!
15			*/
16
17			use TYPO3\CMS\Core\Utility\GeneralUtility;
			0 ignored issues – show Bug introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Core\Utility\GeneralUtility` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18			use EWW\Dpf\Services\ElasticSearch;
19
20			abstract class AbstractSearchController extends \EWW\Dpf\Controller\AbstractController
21			{
22			// search terms
23			private static $terms = ['_id', 'OWNER_ID', 'submitter', 'project'];
24
25			// search matches
26			private static $matches = ['title', 'abstract', 'author', 'language', 'tag', 'corporation', 'doctype', 'collections'];
27
28
29			protected function initializeView(\TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view)
			0 ignored issues – show Bug introduced 2018-07-27 13:46 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Extbase\Mvc\View\ViewInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
30			{
31			parent::initializeView($view);
32
33			if (TYPO3_MODE === 'BE') {
			0 ignored issues – show Bug introduced 2018-07-27 13:46 UTC by Report Bug Copy Issue Report The constant `EWW\Dpf\Controller\TYPO3_MODE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
34			$selectedPageId = (int) \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('id');
35			if ($selectedPageId) {
36			$client = $this->clientRepository->findAll()->current();
37			}
38			if (!$client) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-27 13:46 UTC by Report Bug Copy Issue Report The variable `$client` does not seem to be defined for all execution paths leading up to this point. Loading history...
39			$this->redirect('list','Document');
40			}
41			}
42			}
43
44			/**
45			* get results from elastic search
46			* @param array $query elasticsearch search query
47			* @return array results
48			*/
49			public function getResultList($query, $type)
50			{
51
52			$elasticSearch = $this->objectManager->get(ElasticSearch::class);
53			$results = $elasticSearch->search($query, $type);
54
55			return $results;
56			}
57
58			/**
59			* prepare fulltext query
60			* @param string $searchString
61			* @return array query
62			*/
63			public function searchFulltext($searchString)
64			{
65			// don't return query if searchString is empty
66			if (empty($searchString)) {
67			return null;
68			}
69
70			$searchString = $this->escapeQuery(trim($searchString));
71
72			$query['body']['query']['bool']['should'][0]['query_string']['query'] = $searchString;
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report `$query` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$query = array();` before regardless. Loading history...
73			$query['body']['query']['bool']['should'][1]['has_child']['query']['query_string']['query'] = $searchString;
74			$query['body']['query']['bool']['minimum_should_match'] = "1"; // 1
75			$query['body']['query']['bool']['should'][1]['has_child']['child_type'] = "datastream"; // 1
76
77			$query = $this->resultsFilter($query, false);
78
79			return $query;
80
81			}
82
83			/**
84			* build array for elasticsearch
85			* @return array Elasticsearch query array
86			*/
87			public function extendedSearch($searchArray = array())
88			{
89
90			$query = array();
91			$filter = array();
92			foreach ($searchArray as $key => $qry) {
93			$qry = trim($qry);
94
95			if (!empty($qry) && in_array($key, self::$matches)) {
96
97			$query['body']['query']['bool']['must'][] = array('match' => array($key => $qry));
98
99			} elseif (!empty($qry) && in_array($key, self::$terms)) {
100
101			$query['body']['query']['bool']['must'][] = array('term' => array($key => $qry));
102
103			} elseif (!empty($qry) && $key == 'from') {
104
105			if ($dateTime = $this->convertFormDate($qry, false)) {
106			$filter['gte'] = $dateTime->format('Y-m-d');
107			}
108
109			} elseif (!empty($qry) && $key == 'till') {
110
111			if ($dateTime = $this->convertFormDate($qry, true)) {
112			$filter['lte'] = $dateTime->format('Y-m-d');
113			}
114
115			}
116			}
117
118			if (isset($filter['gte']) \|\| isset($filter['lte'])) {
119
120			$query['body']['query']['bool']['must'][] = array('range' => array('distribution_date' => $filter));
121
122			}
123
124			$showDeleted = ($searchArray['showDeleted'] == 'true') ? true : false;
125			$query = $this->resultsFilter($query, $showDeleted);
126			return $query;
127
128			}
129
130			/**
131			* build array for elasticsearch resultfilter
132			* @param array Elasticsearch query array
133			* @return array Elasticsearch queryFilter array
134			*/
135			public function resultsFilter($query, $showDeleted = false)
136			{
137
138			$queryFilter = array();
139
140			// Frontend only
141			$searchResultsFilter = $this->settings['searchResultsFilter'];
142			if(!empty($searchResultsFilter)) {
143
144			// add doctypes
145			if($searchResultsFilter['doctype']) {
146
147			$uids = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $searchResultsFilter['doctype']);
148			$documentTypeRepository = $this->documentTypeRepository;
149			$documentTypes = array();
150			foreach($uids as $uid) {
151			$documentType = $documentTypeRepository->findByUid($uid);
152			$documentTypes[] = $documentType->getName();
153			};
154			$searchResultsFilter['doctype'] = implode(',', $documentTypes);
155			}
156
157			// add date filter
158			$dateFilter = array();
159			if ($searchResultsFilter['from']) {
160
161			$from = date('d.m.Y', $searchResultsFilter['from']);
162			$dateTime = $this->convertFormDate($from, false);
163			$dateFilter['gte'] = $dateTime->format('Y-m-d');
164			unset($searchResultsFilter['from']);
165
166			}
167
168			if ($searchResultsFilter['till']) {
169
170			$till = date('d.m.Y', $searchResultsFilter['till']);
171			$dateTime = $this->convertFormDate($till, true);
172			$dateFilter['lte'] = $dateTime->format('Y-m-d');
173			unset($searchResultsFilter['till']);
174
175			}
176
177			if (isset($dateFilter['gte']) \|\| isset($dateFilter['lte'])) {
178
179			$queryFilter['body']['query']['bool']['must'][] = array('range' => array('distribution_date' => $dateFilter));
180
181			}
182
183			foreach ($searchResultsFilter as $key => $qry) {
184
185			if(!empty($qry)) {
186			$queryFilter['body']['query']['bool']['must'][] = array('match' => array($key => $qry));
187			}
188
189			}
190
191			}
192
193			// document must be active
194			if($showDeleted == false) {
195
196			$queryFilter['body']['query']['bool']['must'][]['term']['STATE'] = 'A';
197
198			};
199
200			// add OWNER_ID if present
201			$clients = $this->clientRepository->findAll();
202			if ($clients) {
203			$client = $clients->getFirst();
204			if ($client) {
205			$queryFilter['body']['query']['bool']['must'][]['term']['OWNER_ID'] = $client->getOwnerId();
206			}
207			}
208
209			$queryFilter = array_merge_recursive($queryFilter, $query);
210			return $queryFilter;
211			}
212
213			/**
214			* Convert date from form input into DateTime object.
215			*
216			* A 4 character string is taken for a year and the returning
217			* DateTime object is supplemented with either the 01. Jan or 31. Dec
218			* depending on the $intervalEnd parameter. This allows querying time
219			* intervals like `2000 to 2003`.
220			*
221			* @param string $dateString Date literal from form
222			* @param bool $intervalEnd Fills missing values with the maximum possible date if true
223			* @return DateTime Determined date
			0 ignored issues – show Bug introduced 2018-01-12 16:17 UTC by Report Bug Copy Issue Report The type `EWW\Dpf\Controller\DateTime` was not found. Did you mean `DateTime`? If so, make sure to prefix the type with `\`. Loading history...
224			*/
225			public function convertFormDate($dateString, $intervalEnd = false)
226			{
227			try {
228			if (strlen($dateString) == 4) {
229			// assuming year
230			$year = $dateString;
231			$month = $intervalEnd ? "12" : "01";
232			$day = $intervalEnd ? "31" : "01";
233			return new \DateTime("$year-$month-$day");
			0 ignored issues – show Bug Best Practice introduced 2018-03-14 14:40 UTC by Report Bug Copy Issue Report The expression `return new DateTime($year.'-'.$month.'-'.$day)` returns the type `DateTime` which is incompatible with the documented return type `EWW\Dpf\Controller\DateTime`. Loading history...
234			} else {
235			return new \DateTime($dateString);
			0 ignored issues – show Bug Best Practice introduced 2018-01-12 16:17 UTC by Report Bug Copy Issue Report The expression `return new DateTime($dateString)` returns the type `DateTime` which is incompatible with the documented return type `EWW\Dpf\Controller\DateTime`. Loading history...
236			}
237			} catch (\Exception $_) {
238			return false;
			0 ignored issues – show Bug Best Practice introduced 2018-01-12 16:17 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the documented return type `EWW\Dpf\Controller\DateTime`. Loading history...
239			}
240			}
241
242			/**
243			* escapes lucene reserved characters from string
244			* @param $string
245			* @return mixed
246			*/
247			private function escapeQuery($string)
248			{
249			$luceneReservedCharacters = preg_quote('+-&\|!(){}[]^"~?:\\');
250			$string = preg_replace_callback(
251			'/([' . $luceneReservedCharacters . '])/',
252			function ($matches) {
253			return '\\' . $matches[0];
254			},
255			$string
256			);
257
258			return $string;
259			}
260
261			/**
262			* converts a date from dd.mm.yy to yyyy-dd-mm
263			* @param $date
264			* @return string
265			*/
266			public function formatDate($date)
267			{
268			// convert date from dd.mm.yyy to yyyy-dd-mm
269			$date = explode(".", $date);
270			return $date[2] . '-' . $date[1] . '-' . $date[0];
271			}
272			}
273

kitodo / kitodo-publication

Pull Request — master (#98)

AbstractSearchController::resultsFilter() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like