ElasticSearchPage_Controller::index() - Code Metrics - Inspection of "FIX: Refactored suggested query into a separate me..." - gordonbanderson/silverstripe-elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev2 ( a77d0b...0f20ec )

by Gordon

created 2015-12-03 07:21 UTC

ElasticSearchPage_Controller::index() B

↳ Parent: ElasticSearchPage_Controller

Complexity

Conditions	2
Paths	7

Size

Total Lines	24
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	24
rs	8.9714
cc	2
eloc	17
nc	7
nop	0

<?php

use Elastica\Document;
use Elastica\Query;
use \SilverStripe\Elastica\ResultList;
use Elastica\Query\QueryString;
use Elastica\Aggregation\Filter;
use Elastica\Filter\Term;
use Elastica\Filter\BoolAnd;
use Elastica\Aggregation\Terms;
use Elastica\Query\Filtered;
use Elastica\Query\Range;
use \SilverStripe\Elastica\ElasticSearcher;
use \SilverStripe\Elastica\Searchable;
use \SilverStripe\Elastica\QueryGenerator;
use \SilverStripe\Elastica\ElasticaUtil;

class ElasticSearchPage_Controller extends Page_Controller {

	private static $allowed_actions = array('SearchForm', 'submit', 'index', 'similar');

	public function init() {
		parent::init();

		Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
		Requirements::javascript("elastica/javascript/jquery.autocomplete.js");
		Requirements::javascript("elastica/javascript/elastica.js");
		Requirements::css("elastica/css/elastica.css");

		$this->SearchPage = Controller::curr()->dataRecord;
	}



	/*
	Find DataObjects in Elasticsearch similar to the one selected.  Note that aggregations are not
	taken into account, merely the text of the selected document.
	 */
	public function similar() {
		//FIXME double check security, ie if escaping needed
		$class = $this->request->param('ID');
		$instanceID = $this->request->param('OtherID');

		$es = $this->primeElasticSearcherFromRequest();
		$data = $this->initialiseDataArray();
		$this->setMoreLikeThisParamsFromRequest($es);
		$this->addSiteTreeFilterIfRequired($es);
		$this->getSelectedSearchFields();

		try {
			$this->checkForSimulatedServerDown();
			if(class_exists($class)) {
				$instance = \DataObject::get_by_id($class, $instanceID);

				$paginated = $es->moreLikeThis($instance, $this->FieldsToSearch);

				$this->Aggregations = $es->getAggregations();
				$this->successfulSearch($data, $paginated);
				$data['SimilarTo'] = $instance;


				$moreLikeThisTerms = $paginated->getList()->MoreLikeThisTerms;
				$fieldToTerms = new ArrayList();
				foreach(array_keys($moreLikeThisTerms) as $fieldName) {
					$readableFieldName = str_replace('.standard', '', $fieldName);
					$fieldTerms = new ArrayList();
					foreach($moreLikeThisTerms[$fieldName] as $value) {
						$do = new DataObject();
						$do->Term = $value;
						$fieldTerms->push($do);
					}

					$do = new DataObject();
					$do->FieldName = $readableFieldName;
					$do->Terms = $fieldTerms;
					$fieldToTerms->push($do);
				}

				$data['SimilarSearchTerms'] = $fieldToTerms;
			} else {
				// class does not exist
				$data['ErrorMessage'] = "Class $class is either not found or not searchable\n";
			}
		} catch (\InvalidArgumentException $e) {
			$data['ErrorMessage'] = "Class $class is either not found or not searchable\n";
		} catch (Elastica\Exception\Connection\HttpException $e) {
			$data['ErrorMessage'] = 'Unable to connect to search server';
		}

		$data['ElapsedTime'] = $this->calculateTime();
		return $this->renderResults($data);
	}



	/*
	Display the search form. If the query parameter exists, search against Elastica
	and render results accordingly.
	 */
	public function index() {
		$es = $this->primeElasticSearcherFromRequest();
		$data = $this->initialiseDataArray();
		$this->dealWithAggregation($es);
		$this->addSiteTreeFilterIfRequired($es);
		$this->getSelectedSearchFields();

		$paginated = null;
		try {
			$this->checkForSimulatedServerDown();

			// now actually perform the search using the original query
			$paginated = $es->search($this->QueryText, $this->FieldsToSearch,$this->TestMode);
			$this->dealWithSuggestedQuery($es, $data, $paginated);

			$data['ElapsedTime'] = $this->calculateTime();
			$this->Aggregations = $es->getAggregations();
			$this->successfulSearch($data, $paginated);
		} catch (Elastica\Exception\Connection\HttpException $e) {
			$data['ErrorMessage'] = 'Unable to connect to search server';
		}

		return $this->renderResults($data);
	}


	private function dealWithSuggestedQuery(&$es, &$data, &$paginated) {
		// This is the case of the original query having a better one suggested.  Do a
		// second search for the suggested query, throwing away the original
		if($es->hasSuggestedQuery() && !$this->IgnoreSuggestions) {
			$data['SuggestedQuery'] = $es->getSuggestedQuery();
			$data['SuggestedQueryHighlighted'] = $es->getSuggestedQueryHighlighted();
			//Link for if the user really wants to try their original query
			$sifLink = rtrim($this->Link(), '/') . '?q=' . $this->QueryText . '&is=1';
			$data['SearchInsteadForLink'] = $sifLink;
			$paginated = $es->search($es->getSuggestedQuery(), $this->FieldsToSearch);
		}
	}


	private function successfulSearch(&$data, $paginated) {
		$data['SearchResults'] = $paginated;
		$data['SearchPerformed'] = true;
		$data['NumberOfResults'] = $paginated->getTotalItems();
		$data['SearchPageLink'] = $this->SearchPage->Link();
	}


	/*
	Return true if the query is not empty
	 */
	public function QueryIsEmpty() {
		return empty($this->request->getVar('q'));
	}


	/**
	 * Process submission of the search form, redirecting to a URL that will render search results
	 * @param  array $data form data
	 * @param  Form $form form
	 */
	public function submit($data, $form) {
		$queryText = $data['q'];
		$url = $this->Link();
		$url = rtrim($url, '/');
		$link = rtrim($url, '/') . '?q=' . $queryText . '&sfid=' . $data['identifier'];
		$this->redirect($link);
	}


	/*
	Obtain an instance of the form
	*/
	public function SearchForm() {
		$form = new ElasticSearchForm($this, 'SearchForm');
		$fields = $form->Fields();
		$elasticaSearchPage = Controller::curr()->dataRecord;
		$identifierField = new HiddenField('identifier');
		$identifierField->setValue($elasticaSearchPage->Identifier);

		$fields->push($identifierField);
		$queryField = $fields->fieldByName('q');

		 if($this->isParamSet('q') && $this->isParamSet('sfid')) {
		 	$sfid = $this->request->getVar('sfid');
			if($sfid == $elasticaSearchPage->Identifier) {

				$queryText = $this->request->getVar('q');
				$queryField->setValue($queryText);
			}

		}

		if($this->action == 'similar') {
			$queryField->setDisabled(true);
			$actions = $form->Actions();
			if(!empty($actions)) {
				foreach($actions as $field) {
					$field->setDisabled(true);
				}
			}

		}

		if($this->AutoCompleteFieldID > 0) {
			ElasticaUtil::addAutocompleteToQueryField(
				$queryField,
				$this->ClassesToSearch,
				$this->SiteTreeOnly,
				$this->Link(),
				$this->AutocompleteFunction()->Slug
			);
		}
		return $form;
	}


	/**
	 * @param string $paramName
	 */
	private function isParamSet($paramName) {
		return !empty($this->request->getVar($paramName));
	}


	/**
	 * Set the start page from the request and results per page for a given searcher object
	 */
	private function primeElasticSearcherFromRequest() {
		$elasticSearcher = new ElasticSearcher();
		// start, and page length, i.e. pagination
		$startParam = $this->request->getVar('start');
		$start = isset($startParam) ? $startParam : 0;
		$elasticSearcher->setStart($start);
		$this->StartTime = microtime(true);
		$elasticSearcher->setPageLength($this->SearchPage->ResultsPerPage);

		// Do not show suggestions if this flag is set
		$this->IgnoreSuggestions = null !== $this->request->getVar('is');

		// query string
		$queryTextParam = $this->request->getVar('q');
		$queryText = !empty($queryTextParam) ? $queryTextParam : '';
		$this->QueryText = $queryText;

		$this->TestMode = !empty($this->request->getVar('TestMode'));
		return $elasticSearcher;
	}


	/**
	 * Set the admin configured similarity parameters
	 * @param \SilverStripe\Elastica\ElasticSearcher &$elasticSearcher ElasticaSearcher object
	 */
	private function setMoreLikeThisParamsFromRequest(&$elasticSearcher) {
		$elasticSearcher->setMinTermFreq($this->MinTermFreq);
		$elasticSearcher->setMaxTermFreq($this->MaxTermFreq);
		$elasticSearcher->setMinDocFreq($this->MinDocFreq);
		$elasticSearcher->setMaxDocFreq($this->MaxDocFreq);
		$elasticSearcher->setMinWordLength($this->MinWordLength);
		$elasticSearcher->setMaxWordLength($this->MaxWordLength);
		$elasticSearcher->setMinShouldMatch($this->MinShouldMatch);
		$elasticSearcher->setSimilarityStopWords($this->SimilarityStopWords);
	}


	private function dealWithAggregation(&$es) {
		$ignore = \Config::inst()->get('Elastica', 'BlackList');
		foreach($this->request->getVars() as $key => $value) {
			if(!in_array($key, $ignore)) {
				$es->addFilter($key, $value);
			}
		}

		// set the optional aggregation manipulator
		// In the event of a manipulator being present, show all the results for search
		// Otherwise aggregations are all zero
		if($this->SearchHelper) {
			$es->setQueryResultManipulator($this->SearchHelper);
			$es->showResultsForEmptySearch();
		} else {
			$es->hideResultsForEmptySearch();
		}
	}


	private function addSiteTreeFilterIfRequired(&$es) {
		// filter by class or site tree
		if($this->SearchPage->SiteTreeOnly) {
			$es->addFilter('IsInSiteTree', true);
		} else {
			$es->setClasses($this->SearchPage->ClassesToSearch);
		}
	}


	private function getSelectedSearchFields() {
		// get the edited fields to search from the database for this search page
		// Convert this into a name => weighting array
		$fieldsToSearch = array();
		$editedSearchFields = $this->ElasticaSearchableFields()->filter(array(
			'Active' => true,
			'Searchable' => true
		));

		foreach($editedSearchFields->getIterator() as $searchField) {
			$fieldsToSearch[$searchField->Name] = $searchField->Weight;
		}

		// For a 'more like this' search, use the original unstemmed words
		// This means using the .standard named field of text
		if ($this->action == 'similar') {
			// Use the standard field for more like this, ie not stemmed
			foreach($fieldsToSearch as $field => $value) {
				$fieldsToSearch[$field . '.standard'] = $value;
				unset($fieldsToSearch[$field]);
			}
		}
		$this->FieldsToSearch = $fieldsToSearch;
	}


	private function initialiseDataArray() {
		return array(
			'Content' => $this->Content,
			'Title' => $this->Title,
			'SearchPerformed' => false,
			'OriginalQuery' => $this->QueryText,
			'IgnoreSuggestions' => $this->IgnoreSuggestions
		);
	}


	private function renderResults($data) {
		// allow the optional use of overriding the search result page, e.g. for photos, maps or facets
		if($this->hasExtension('PageControllerTemplateOverrideExtension')) {
			return $this->useTemplateOverride($data);
		} else {
			return $data;
		}
	}


	private function calculateTime() {
		$endTime = microtime(true);
		$elapsed = round(100 * ($endTime - $this->StartTime)) / 100;
		return $elapsed;
	}


	private function checkForSimulatedServerDown() {
		// Simulate server being down for testing purposes
		if(!empty($this->request->getVar('ServerDown'))) {
			throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
		}
	}
}


1			<?php
2
3			use Elastica\Document;
4			use Elastica\Query;
5			use \SilverStripe\Elastica\ResultList;
6			use Elastica\Query\QueryString;
7			use Elastica\Aggregation\Filter;
8			use Elastica\Filter\Term;
9			use Elastica\Filter\BoolAnd;
10			use Elastica\Aggregation\Terms;
11			use Elastica\Query\Filtered;
12			use Elastica\Query\Range;
13			use \SilverStripe\Elastica\ElasticSearcher;
14			use \SilverStripe\Elastica\Searchable;
15			use \SilverStripe\Elastica\QueryGenerator;
16			use \SilverStripe\Elastica\ElasticaUtil;
17
18			class ElasticSearchPage_Controller extends Page_Controller {
19
20			private static $allowed_actions = array('SearchForm', 'submit', 'index', 'similar');
21
22			public function init() {
23			parent::init();
24
25			Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
26			Requirements::javascript("elastica/javascript/jquery.autocomplete.js");
27			Requirements::javascript("elastica/javascript/elastica.js");
28			Requirements::css("elastica/css/elastica.css");
29
30			$this->SearchPage = Controller::curr()->dataRecord;
31			}
32
33
34
35			/*
36			Find DataObjects in Elasticsearch similar to the one selected. Note that aggregations are not
37			taken into account, merely the text of the selected document.
38			*/
39			public function similar() {
40			//FIXME double check security, ie if escaping needed
41			$class = $this->request->param('ID');
42			$instanceID = $this->request->param('OtherID');
43
44			$es = $this->primeElasticSearcherFromRequest();
45			$data = $this->initialiseDataArray();
46			$this->setMoreLikeThisParamsFromRequest($es);
47			$this->addSiteTreeFilterIfRequired($es);
48			$this->getSelectedSearchFields();
49
50			try {
51			$this->checkForSimulatedServerDown();
52			if(class_exists($class)) {
53			$instance = \DataObject::get_by_id($class, $instanceID);
54
55			$paginated = $es->moreLikeThis($instance, $this->FieldsToSearch);
56
57			$this->Aggregations = $es->getAggregations();
58			$this->successfulSearch($data, $paginated);
59			$data['SimilarTo'] = $instance;
60
61
62			$moreLikeThisTerms = $paginated->getList()->MoreLikeThisTerms;
63			$fieldToTerms = new ArrayList();
64			foreach(array_keys($moreLikeThisTerms) as $fieldName) {
65			$readableFieldName = str_replace('.standard', '', $fieldName);
66			$fieldTerms = new ArrayList();
67			foreach($moreLikeThisTerms[$fieldName] as $value) {
68			$do = new DataObject();
69			$do->Term = $value;
70			$fieldTerms->push($do);
71			}
72
73			$do = new DataObject();
74			$do->FieldName = $readableFieldName;
75			$do->Terms = $fieldTerms;
76			$fieldToTerms->push($do);
77			}
78
79			$data['SimilarSearchTerms'] = $fieldToTerms;
80			} else {
81			// class does not exist
82			$data['ErrorMessage'] = "Class $class is either not found or not searchable\n";
83			}
84			} catch (\InvalidArgumentException $e) {
85			$data['ErrorMessage'] = "Class $class is either not found or not searchable\n";
86			} catch (Elastica\Exception\Connection\HttpException $e) {
87			$data['ErrorMessage'] = 'Unable to connect to search server';
88			}
89
90			$data['ElapsedTime'] = $this->calculateTime();
91			return $this->renderResults($data);
92			}
93
94
95
96			/*
97			Display the search form. If the query parameter exists, search against Elastica
98			and render results accordingly.
99			*/
100			public function index() {
101			$es = $this->primeElasticSearcherFromRequest();
102			$data = $this->initialiseDataArray();
103			$this->dealWithAggregation($es);
104			$this->addSiteTreeFilterIfRequired($es);
105			$this->getSelectedSearchFields();
106
107			$paginated = null;
108			try {
109			$this->checkForSimulatedServerDown();
110
111			// now actually perform the search using the original query
112			$paginated = $es->search($this->QueryText, $this->FieldsToSearch,$this->TestMode);
113			$this->dealWithSuggestedQuery($es, $data, $paginated);
114
115			$data['ElapsedTime'] = $this->calculateTime();
116			$this->Aggregations = $es->getAggregations();
117			$this->successfulSearch($data, $paginated);
118			} catch (Elastica\Exception\Connection\HttpException $e) {
119			$data['ErrorMessage'] = 'Unable to connect to search server';
120			}
121
122			return $this->renderResults($data);
123			}
124
125
126			private function dealWithSuggestedQuery(&$es, &$data, &$paginated) {
127			// This is the case of the original query having a better one suggested. Do a
128			// second search for the suggested query, throwing away the original
129			if($es->hasSuggestedQuery() && !$this->IgnoreSuggestions) {
130			$data['SuggestedQuery'] = $es->getSuggestedQuery();
131			$data['SuggestedQueryHighlighted'] = $es->getSuggestedQueryHighlighted();
132			//Link for if the user really wants to try their original query
133			$sifLink = rtrim($this->Link(), '/') . '?q=' . $this->QueryText . '&is=1';
134			$data['SearchInsteadForLink'] = $sifLink;
135			$paginated = $es->search($es->getSuggestedQuery(), $this->FieldsToSearch);
136			}
137			}
138
139
140			private function successfulSearch(&$data, $paginated) {
141			$data['SearchResults'] = $paginated;
142			$data['SearchPerformed'] = true;
143			$data['NumberOfResults'] = $paginated->getTotalItems();
144			$data['SearchPageLink'] = $this->SearchPage->Link();
145			}
146
147
148			/*
149			Return true if the query is not empty
150			*/
151			public function QueryIsEmpty() {
152			return empty($this->request->getVar('q'));
153			}
154
155
156			/**
157			* Process submission of the search form, redirecting to a URL that will render search results
158			* @param array $data form data
159			* @param Form $form form
160			*/
161			public function submit($data, $form) {
162			$queryText = $data['q'];
163			$url = $this->Link();
164			$url = rtrim($url, '/');
165			$link = rtrim($url, '/') . '?q=' . $queryText . '&sfid=' . $data['identifier'];
166			$this->redirect($link);
167			}
168
169
170			/*
171			Obtain an instance of the form
172			*/
173			public function SearchForm() {
174			$form = new ElasticSearchForm($this, 'SearchForm');
175			$fields = $form->Fields();
176			$elasticaSearchPage = Controller::curr()->dataRecord;
177			$identifierField = new HiddenField('identifier');
178			$identifierField->setValue($elasticaSearchPage->Identifier);
179
180			$fields->push($identifierField);
181			$queryField = $fields->fieldByName('q');
182
183			if($this->isParamSet('q') && $this->isParamSet('sfid')) {
184			$sfid = $this->request->getVar('sfid');
185			if($sfid == $elasticaSearchPage->Identifier) {
186
187			$queryText = $this->request->getVar('q');
188			$queryField->setValue($queryText);
189			}
190
191			}
192
193			if($this->action == 'similar') {
194			$queryField->setDisabled(true);
195			$actions = $form->Actions();
196			if(!empty($actions)) {
197			foreach($actions as $field) {
198			$field->setDisabled(true);
199			}
200			}
201
202			}
203
204			if($this->AutoCompleteFieldID > 0) {
205			ElasticaUtil::addAutocompleteToQueryField(
206			$queryField,
207			$this->ClassesToSearch,
208			$this->SiteTreeOnly,
209			$this->Link(),
210			$this->AutocompleteFunction()->Slug
211			);
212			}
213			return $form;
214			}
215
216
217			/**
218			* @param string $paramName
219			*/
220			private function isParamSet($paramName) {
221			return !empty($this->request->getVar($paramName));
222			}
223
224
225			/**
226			* Set the start page from the request and results per page for a given searcher object
227			*/
228			private function primeElasticSearcherFromRequest() {
229			$elasticSearcher = new ElasticSearcher();
230			// start, and page length, i.e. pagination
231			$startParam = $this->request->getVar('start');
232			$start = isset($startParam) ? $startParam : 0;
233			$elasticSearcher->setStart($start);
234			$this->StartTime = microtime(true);
235			$elasticSearcher->setPageLength($this->SearchPage->ResultsPerPage);
236
237			// Do not show suggestions if this flag is set
238			$this->IgnoreSuggestions = null !== $this->request->getVar('is');
239
240			// query string
241			$queryTextParam = $this->request->getVar('q');
242			$queryText = !empty($queryTextParam) ? $queryTextParam : '';
243			$this->QueryText = $queryText;
244
245			$this->TestMode = !empty($this->request->getVar('TestMode'));
246			return $elasticSearcher;
247			}
248
249
250			/**
251			* Set the admin configured similarity parameters
252			* @param \SilverStripe\Elastica\ElasticSearcher &$elasticSearcher ElasticaSearcher object
253			*/
254			private function setMoreLikeThisParamsFromRequest(&$elasticSearcher) {
255			$elasticSearcher->setMinTermFreq($this->MinTermFreq);
256			$elasticSearcher->setMaxTermFreq($this->MaxTermFreq);
257			$elasticSearcher->setMinDocFreq($this->MinDocFreq);
258			$elasticSearcher->setMaxDocFreq($this->MaxDocFreq);
259			$elasticSearcher->setMinWordLength($this->MinWordLength);
260			$elasticSearcher->setMaxWordLength($this->MaxWordLength);
261			$elasticSearcher->setMinShouldMatch($this->MinShouldMatch);
262			$elasticSearcher->setSimilarityStopWords($this->SimilarityStopWords);
263			}
264
265
266			private function dealWithAggregation(&$es) {
267			$ignore = \Config::inst()->get('Elastica', 'BlackList');
268			foreach($this->request->getVars() as $key => $value) {
269			if(!in_array($key, $ignore)) {
270			$es->addFilter($key, $value);
271			}
272			}
273
274			// set the optional aggregation manipulator
275			// In the event of a manipulator being present, show all the results for search
276			// Otherwise aggregations are all zero
277			if($this->SearchHelper) {
278			$es->setQueryResultManipulator($this->SearchHelper);
279			$es->showResultsForEmptySearch();
280			} else {
281			$es->hideResultsForEmptySearch();
282			}
283			}
284
285
286			private function addSiteTreeFilterIfRequired(&$es) {
287			// filter by class or site tree
288			if($this->SearchPage->SiteTreeOnly) {
289			$es->addFilter('IsInSiteTree', true);
290			} else {
291			$es->setClasses($this->SearchPage->ClassesToSearch);
292			}
293			}
294
295
296			private function getSelectedSearchFields() {
297			// get the edited fields to search from the database for this search page
298			// Convert this into a name => weighting array
299			$fieldsToSearch = array();
300			$editedSearchFields = $this->ElasticaSearchableFields()->filter(array(
301			'Active' => true,
302			'Searchable' => true
303			));
304
305			foreach($editedSearchFields->getIterator() as $searchField) {
306			$fieldsToSearch[$searchField->Name] = $searchField->Weight;
307			}
308
309			// For a 'more like this' search, use the original unstemmed words
310			// This means using the .standard named field of text
311			if ($this->action == 'similar') {
312			// Use the standard field for more like this, ie not stemmed
313			foreach($fieldsToSearch as $field => $value) {
314			$fieldsToSearch[$field . '.standard'] = $value;
315			unset($fieldsToSearch[$field]);
316			}
317			}
318			$this->FieldsToSearch = $fieldsToSearch;
319			}
320
321
322			private function initialiseDataArray() {
323			return array(
324			'Content' => $this->Content,
325			'Title' => $this->Title,
326			'SearchPerformed' => false,
327			'OriginalQuery' => $this->QueryText,
328			'IgnoreSuggestions' => $this->IgnoreSuggestions
329			);
330			}
331
332
333			private function renderResults($data) {
334			// allow the optional use of overriding the search result page, e.g. for photos, maps or facets
335			if($this->hasExtension('PageControllerTemplateOverrideExtension')) {
336			return $this->useTemplateOverride($data);
337			} else {
338			return $data;
339			}
340			}
341
342
343			private function calculateTime() {
344			$endTime = microtime(true);
345			$elapsed = round(100 * ($endTime - $this->StartTime)) / 100;
346			return $elapsed;
347			}
348
349
350			private function checkForSimulatedServerDown() {
351			// Simulate server being down for testing purposes
352			if(!empty($this->request->getVar('ServerDown'))) {
353			throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
354			}
355			}
356			}
357

gordonbanderson / silverstripe-elastica

Push — dev2 ( a77d0b...0f20ec )

ElasticSearchPage_Controller::index() B

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like