SilverStripe\Elastica\Searchable

Complexity

Total Complexity

116

Size/Duplication

Total Lines	772
Duplicated Lines	5.18 %

Coupling/Cohesion

Components	1
Dependencies	21

Importance

Changes	15
Bugs	10	Features	0

29 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getElasticaType()	0	3	1
A	getElasticaResult()	0	3	1
A	setElasticaResult()	0	3	1
C	getElasticaFields()	0	75	10
A	assignSpecForHasOne()	19	19	3
A	assignSpecForManyRelationship()	21	21	3
D	assignSpecForStandardFieldType()	0	25	10
B	getElasticaMapping()	0	31	3
C	getElasticaDocument()	0	37	7
C	getFieldValuesAsArray()	0	62	12
A	showRecordInSearch()	0	3	2
B	onBeforeWrite()	0	8	5
A	onBeforePublish()	0	11	4
A	onAfterWrite()	0	3	1
A	onAfterPublish()	0	3	1
A	doIndexDocument()	0	7	3
A	onAfterDelete()	0	3	1
A	onAfterUnpublish()	0	3	1
A	doDeleteDocumentIfInSearch()	0	5	2
A	doDeleteDocument()	0	12	3
C	getAllSearchableFields()	0	54	10
B	fieldsToElasticaConfig()	0	17	6
C	requireDefaultRecords()	0	51	7
A	getListRelationshipMethods()	0	12	2
B	isInSiteTree()	0	14	5
A	RenderResult()	0	5	1
A	getTermVectors()	0	3	1
C	updateCMSFields()	0	65	9

<?php

namespace SilverStripe\Elastica;

use Elastica\Document;
use Elastica\Type\Mapping;
use ShortcodeParser;

/**
 * Adds elastic search integration to a data object.
 */
class Searchable extends \DataExtension {

	/**
	 * Counter used to display progress of indexing
	 * @var integer
	 */
	public static $index_ctr = 0;

	/**
	 * Everytime progressInterval divides $index_ctr exactly display progress
	 * @var integer
	 */
	private static $progressInterval = 0;

	public static $mappings = array(
		'Boolean'     => 'boolean',
		'Decimal'     => 'double',
		'Currency'    => 'double',
		'Double'      => 'double',
		'Enum'        => 'string',
		'Float'       => 'float',
		'HTMLText'    => 'string',
		'HTMLVarchar' => 'string',
		'Int'         => 'integer',
		'Text'        => 'string',
		'VarChar'     => 'string',
		'Varchar'     => 'string',
		'Year'        => 'integer',
		'Percentage'  => 'double',
		'Time'  => 'date',

		// The 2 different date types will be stored with different formats
		'Date'        => 'date',
		'SS_Datetime' => 'date',
		'Datetime' => 'date',
		'DBLocale'    => 'string'
	);


	/**
	 * @var ElasticaService associated elastica search service
	 */
	protected $service;


	/**
	 * Array of fields that need HTML parsed
	 * @var array
	 */
	protected $html_fields = array();

	/**
	 * Store a mapping of relationship name to result type
	 */
	protected $relationship_methods = array();


	/**
	 * If importing a large number of items from a fixtures file, or indeed some other source, then
	 * it is quicker to set a flag of value IndexingOff => false.  This has the effect of ensuring
	 * no indexing happens, a request is normally made per fixture when loading.  One can then run
	 * the reindexing teask to bulk index in one HTTP POST request to Elasticsearch
	 *
	 * @var boolean
	 */
	private static $IndexingOff = false;


	/**
	 * @see getElasticaResult
	 * @var \Elastica\Result
	 */
	protected $elastica_result;

	public function __construct(ElasticaService $service) {
		$this->service = $service;
		parent::__construct();
	}


	/**
	 * Get the elasticsearch type name
	 *
	 * @return string
	 */
	public function getElasticaType() {
		return get_class($this->owner);
	}


	/**
	 * If the owner is part of a search result
	 * the raw Elastica search result is returned
	 * if set via setElasticaResult
	 *
	 * @return \Elastica\Result
	 */
	public function getElasticaResult() {
		return $this->elastica_result;
	}


	/**
	 * Set the raw Elastica search result
	 *
	 * @param \Elastica\Result
	 */
	public function setElasticaResult(\Elastica\Result $result) {
		$this->elastica_result = $result;
	}


	/**
	 * Gets an array of elastic field definitions.
	 *
	 * @return array
	 */
	public function getElasticaFields($storeMethodName = false, $recurse = true) {

The parameter $storeMethodName is not used and could be removed.

The parameter $recurse is not used and could be removed.

		$db = $this->owner->db();
		$fields = $this->getAllSearchableFields();
		$result = array();

		foreach($fields as $name => $params) {
			$spec = array();
			$name = str_replace('()', '', $name);

			if(array_key_exists($name, $db)) {
				$class = $db[$name];
				$this->assignSpecForStandardFieldType($class, $spec);
			} else {
				// field name is not in the db, it could be a method
				$has_lists = $this->getListRelationshipMethods();
				$has_ones = $this->owner->has_one();

				// check has_many and many_many relations
				if(isset($has_lists[$name])) {
					// the classes returned by the list method
					$resultType = $has_lists[$name];
					$this->assignSpecForManyRelationship($resultType, $spec);
				} else if(isset($has_ones[$name])) {
					$resultType = $has_ones[$name];
					$this->assignSpecForHasOne($resultType, $spec);
				}
				// otherwise fall back to string - Enum is one such category
				else {
					$spec["type"] = "string";
				}
			}

			// in the case of a relationship type will not be set
			if(isset($spec['type'])) {
				if($spec['type'] == 'string') {
					$unstemmed = array();
					$unstemmed['type'] = "string";
					$unstemmed['analyzer'] = "unstemmed";
					$unstemmed['term_vector'] = "yes";
					$extraFields = array('standard' => $unstemmed);

					$shingles = array();
					$shingles['type'] = "string";
					$shingles['analyzer'] = "shingles";
					$shingles['term_vector'] = "yes";
					$extraFields['shingles'] = $shingles;

					//Add autocomplete field if so required
					$autocomplete = \Config::inst()->get($this->owner->ClassName, 'searchable_autocomplete');

					if(isset($autocomplete) && in_array($name, $autocomplete)) {
						$autocompleteField = array();
						$autocompleteField['type'] = "string";
						$autocompleteField['index_analyzer'] = "autocomplete_index_analyzer";
						$autocompleteField['search_analyzer'] = "autocomplete_search_analyzer";
						$autocompleteField['term_vector'] = "yes";
						$extraFields['autocomplete'] = $autocompleteField;
					}

					$spec['fields'] = $extraFields;
					// FIXME - make index/locale specific, get from settings
					$spec['analyzer'] = 'stemmed';
					$spec['term_vector'] = "yes";
				}
			}

			$result[$name] = $spec;
		}

		if($this->owner->hasMethod('updateElasticHTMLFields')) {
			$this->html_fields = $this->owner->updateElasticHTMLFields($this->html_fields);
		}

		return $result;
	}


	private function assignSpecForHasOne($resultType, &$spec) {

This method seems to be duplicated in your project.

		$resultTypeInstance = \Injector::inst()->create($resultType);

		$resultTypeMapping = array();

		// get the fields for the result type, but do not recurse
		if($recurse) {

The variable $recurse does not exist. Did you forget to declare it?

			$resultTypeMapping = $resultTypeInstance->getElasticaFields($storeMethodName, false);

The variable $storeMethodName does not exist. Did you forget to declare it?

		}

		$resultTypeMapping['ID'] = array('type' => 'integer');

		if($storeMethodName) {
			$resultTypeMapping['__method'] = $name;

The variable $name seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

		}
		$spec = array('properties' => $resultTypeMapping);
		// we now change the name to the result type, not the method name
		$name = $resultType;

$name is not used, you could remove the assignment.

	}

	private function assignSpecForManyRelationship($resultType, &$spec) {

This method seems to be duplicated in your project.

		$resultTypeInstance = \Injector::inst()->create($resultType);
		$resultTypeMapping = array();

		// get the fields for the result type, but do not recurse
		if($recurse) {

The variable $recurse does not exist. Did you forget to declare it?

			$resultTypeMapping = $resultTypeInstance->getElasticaFields($storeMethodName, false);

The variable $storeMethodName does not exist. Did you forget to declare it?

		}

		$resultTypeMapping['ID'] = array('type' => 'integer');

		if($storeMethodName) {
			$resultTypeMapping['__method'] = $name;

The variable $name seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

		}

		$spec = array('properties' => $resultTypeMapping);


		// we now change the name to the result type, not the method name
		$name = $resultType;

$name is not used, you could remove the assignment.

	}


	private function assignSpecForStandardFieldType($class, &$spec) {
		if(($pos = strpos($class, '('))) {
			// Valid in the case of Varchar(255)
			$class = substr($class, 0, $pos);
		}

		if(array_key_exists($class, self::$mappings)) {
			$spec['type'] = self::$mappings[$class];
			if($spec['type'] === 'date') {
				if($class == 'Date') {
					$spec['format'] = 'y-M-d';
				} elseif($class == 'SS_Datetime') {
					$spec['format'] = 'y-M-d H:m:s';
				} elseif($class == 'Datetime') {
					$spec['format'] = 'y-M-d H:m:s';
				} elseif($class == 'Time') {
					$spec['format'] = 'H:m:s';
				}
			}
			if($class === 'HTMLText' || $class === 'HTMLVarchar') {
				array_push($this->html_fields, $name);

The variable $name does not exist. Did you forget to declare it?

			}
		}
		// no need for an extra case here as all SS types checked in tests
	}


	/**
	 * Get the elasticsearch mapping for the current document/type
	 *
	 * @return \Elastica\Type\Mapping
	 */
	public function getElasticaMapping() {
		$mapping = new Mapping();

		$fields = $this->getElasticaFields(false);

		$localeMapping = array();

		if($this->owner->hasField('Locale')) {
			$localeMapping['type'] = 'string';
			// we wish the locale to be stored as is
			$localeMapping['index'] = 'not_analyzed';
			$fields['Locale'] = $localeMapping;
		}

		// ADD CUSTOM FIELDS HERE THAT ARE INDEXED BY DEFAULT
		// add a mapping to flag whether or not class is in SiteTree
		$fields['IsInSiteTree'] = array('type'=>'boolean');
		$fields['Link'] = array('type' => 'string', 'index' => 'not_analyzed');

		$mapping->setProperties($fields);

		//This concatenates all the fields together into a single field.
		//Initially added for suggestions compatibility, in that searching
		//_all field picks up all possible suggestions
		$mapping->enableAllField();

		if($this->owner->hasMethod('updateElasticsearchMapping')) {
			$mapping = $this->owner->updateElasticsearchMapping($mapping);
		}
		return $mapping;
	}


	/**
	 * Get an elasticsearch document
	 *
	 * @return \Elastica\Document
	 */
	public function getElasticaDocument() {
		self::$index_ctr++;
		$fields = $this->getFieldValuesAsArray();
		$progress = Controller::curr()->getVar('progress');
		if(!empty($progress)) {
			self::$progressInterval = (int)$progress;
		}

		if(self::$progressInterval > 0) {
			if(self::$index_ctr % self::$progressInterval === 0) {
				ElasticaUtil::message("\t" . $this->owner->ClassName . " - Prepared " . self::$index_ctr . " for indexing...");
			}
		}

		// Optionally update the document
		$document = new Document($this->owner->ID, $fields);
		if($this->owner->hasMethod('updateElasticsearchDocument')) {
			$document = $this->owner->updateElasticsearchDocument($document);
		}

		// Check if the current classname is part of the site tree or not
		// Results are cached to save reprocessing the same
		$classname = $this->owner->ClassName;
		$inSiteTree = $this->isInSiteTree($classname);

		$document->set('IsInSiteTree', $inSiteTree);

		if($inSiteTree) {
			$document->set('Link', $this->owner->AbsoluteLink());
		}

		if(isset($this->owner->Locale)) {
			$document->set('Locale', $this->owner->Locale);
		}

		return $document;
	}


	public function getFieldValuesAsArray($recurse = true) {
		$fields = array();
		$has_ones = $this->owner->has_one();

		foreach($this->getElasticaFields($recurse) as $field => $config) {
			if(null === $this->owner->$field && is_callable(get_class($this->owner) . "::" . $field)) {
				// call a method to get a field value
				if(in_array($field, $this->html_fields)) {
					// Parse short codes in HTML, and then convert to text
					$fields[$field] = $this->owner->$field;
					$html = ShortcodeParser::get_active()->parse($this->owner->$field());
					$txt = \Convert::html2raw($html);
					$fields[$field] = $txt;
				} else {
					// Plain text
					$fields[$field] = $this->owner->$field();
				}

			} else {
				if(in_array($field, $this->html_fields)) {
					$fields[$field] = $this->owner->$field;
					if(gettype($this->owner->$field) !== 'NULL') {
						$html = ShortcodeParser::get_active()->parse($this->owner->$field);
						$txt = \Convert::html2raw($html);
						$fields[$field] = $txt;
					}
				} else {
					if(isset($config['properties']['__method'])) {
						$methodName = $config['properties']['__method'];
						$data = $this->owner->$methodName();
						$relArray = array();

						// get the fields of a has_one relational object
						if(isset($has_ones[$methodName])) {
							if($data->ID > 0) {
								$item = $data->getFieldValuesAsArray(false);
								$relArray = $item;
							}

						// get the fields for a has_many or many_many relational list
						} else {
							foreach($data->getIterator() as $item) {
								if($recurse) {
									// populate the subitem but do not recurse any further if more relationships
									$itemDoc = $item->getFieldValuesAsArray(false);
									array_push($relArray, $itemDoc);
								}
							}
						}
						// save the relation as an array (for now)
						$fields[$methodName] = $relArray;
					} else {
						$fields[$field] = $this->owner->$field;
					}

				}

			}
		}

		return $fields;
	}


	/**
	 * Returns whether to include the document into the search index.
	 * All documents are added unless they have a field "ShowInSearch" which is set to false
	 *
	 * @return boolean
	 */
	public function showRecordInSearch() {
		return !($this->owner->hasField('ShowInSearch') && false == $this->owner->ShowInSearch);
	}


	/**
	 * Delete the record from the search index if ShowInSearch is deactivated (non-SiteTree).
	 */
	public function onBeforeWrite() {
		if(($this->owner instanceof \SiteTree)) {
			if($this->owner->hasField('ShowInSearch') &&
				$this->owner->isChanged('ShowInSearch', 2) && false == $this->owner->ShowInSearch) {
				$this->doDeleteDocument();
			}
		}
	}


	/**
	 * Delete the record from the search index if ShowInSearch is deactivated (SiteTree).
	 */
	public function onBeforePublish() {
		if(false == $this->owner->ShowInSearch) {
			if($this->owner->isPublished()) {
				$liveRecord = \Versioned::get_by_stage(get_class($this->owner), 'Live')->
					byID($this->owner->ID);
				if($liveRecord->ShowInSearch != $this->owner->ShowInSearch) {
					$this->doDeleteDocument();
				}
			}
		}
	}


	/**
	 * Updates the record in the search index (non-SiteTree).
	 */
	public function onAfterWrite() {
		$this->doIndexDocument();
	}


	/**
	 * Updates the record in the search index (SiteTree).
	 */
	public function onAfterPublish() {
		$this->doIndexDocument();
	}


	/**
	 * Updates the record in the search index.
	 */
	protected function doIndexDocument() {
		if($this->showRecordInSearch()) {
			if(!$this->owner->IndexingOff) {
				$this->service->index($this->owner);
			}
		}
	}


	/**
	 * Removes the record from the search index (non-SiteTree).
	 */
	public function onAfterDelete() {
		$this->doDeleteDocumentIfInSearch();
	}


	/**
	 * Removes the record from the search index (non-SiteTree).
	 */
	public function onAfterUnpublish() {
		$this->doDeleteDocumentIfInSearch();
	}


	/**
	 * Removes the record from the search index if the "ShowInSearch" attribute is set to true.
	 */
	protected function doDeleteDocumentIfInSearch() {
		if($this->showRecordInSearch()) {
			$this->doDeleteDocument();
		}
	}


	/**
	 * Removes the record from the search index.
	 */
	protected function doDeleteDocument() {
		try {
			if(!$this->owner->IndexingOff) {
				// this goes to elastica service
				$this->service->remove($this->owner);
			}
		} catch (\Elastica\Exception\NotFoundException $e) {
			trigger_error("Deleted document " . $this->owner->ClassName . " (" . $this->owner->ID .
				") not found in search index.", E_USER_NOTICE);
		}

	}


	/**
	 * Return all of the searchable fields defined in $this->owner::$searchable_fields and all the parent classes.
	 *
	 * @param  $recuse Whether or not to traverse relationships. First time round yes, subsequently no
	 * @return array searchable fields
	 */
	public function getAllSearchableFields($recurse = true) {
		$fields = \Config::inst()->get(get_class($this->owner), 'searchable_fields');

		// fallback to default method
		if(!$fields) {
			user_error('The field $searchable_fields must be set for the class ' . $this->owner->ClassName);
		}

		// get the values of these fields
		$elasticaMapping = $this->fieldsToElasticaConfig($fields);

		if($recurse) {
			// now for the associated methods and their results
			$methodDescs = \Config::inst()->get(get_class($this->owner), 'searchable_relationships');
			$has_ones = $this->owner->has_one();
			$has_lists = $this->getListRelationshipMethods();

			if(isset($methodDescs) && is_array($methodDescs)) {
				foreach($methodDescs as $methodDesc) {
					// split before the brackets which can optionally list which fields to index
					$splits = explode('(', $methodDesc);
					$methodName = $splits[0];

					if(isset($has_lists[$methodName])) {

						$relClass = $has_lists[$methodName];
						$fields = \Config::inst()->get($relClass, 'searchable_fields');
						if(!$fields) {
							user_error('The field $searchable_fields must be set for the class ' . $relClass);
						}
						$rewrite = $this->fieldsToElasticaConfig($fields);

						// mark as a method, the resultant fields are correct
						$elasticaMapping[$methodName . '()'] = $rewrite;
					} else if(isset($has_ones[$methodName])) {
						$relClass = $has_ones[$methodName];
						$fields = \Config::inst()->get($relClass, 'searchable_fields');
						if(!$fields) {
							user_error('The field $searchable_fields must be set for the class ' . $relClass);
						}
						$rewrite = $this->fieldsToElasticaConfig($fields);

						// mark as a method, the resultant fields are correct
						$elasticaMapping[$methodName . '()'] = $rewrite;
					} else {
						user_error('The method ' . $methodName . ' not found in class ' . $this->owner->ClassName .
								', please check configuration');
					}
				}
			}
		}

		return $elasticaMapping;
	}


	/*
	Evaluate each field, e.g. 'Title', 'Member.Name'
	 */
	private function fieldsToElasticaConfig($fields) {
		// Copied from DataObject::searchableFields() as there is no separate accessible method
		$rewrite = array();
		foreach($fields as $name => $specOrName) {
			$identifer = (is_int($name)) ? $specOrName : $name;
			$rewrite[$identifer] = array();
			if(!isset($rewrite[$identifer]['title'])) {
				$rewrite[$identifer]['title'] = (isset($labels[$identifer]))
					? $labels[$identifer] : \FormField::name_to_label($identifer);
			}
			if(!isset($rewrite[$identifer]['filter'])) {
				$rewrite[$identifer]['filter'] = 'PartialMatchFilter';
			}
		}

		return $rewrite;
	}


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

		$searchableFields = $this->getElasticaFields(true, true);


		$doSC = \SearchableClass::get()->filter(array('Name' => $this->owner->ClassName))->first();
		if(!$doSC) {
			$doSC = new \SearchableClass();
			$doSC->Name = $this->owner->ClassName;

			$inSiteTree = $this->isInSiteTree($this->owner->ClassName);
			$doSC->InSiteTree = $inSiteTree;

			$doSC->write();
		}

		foreach($searchableFields as $name => $searchableField) {
			// check for existence of methods and if they exist use that as the name
			if(!isset($searchableField['type'])) {
				$name = $searchableField['properties']['__method'];
			}

			$filter = array('ClazzName' => $this->owner->ClassName, 'Name' => $name);
			$doSF = \SearchableField::get()->filter($filter)->first();


			if(!$doSF) {
				$doSF = new \SearchableField();
				$doSF->ClazzName = $this->owner->ClassName;
				$doSF->Name = $name;

				if(isset($searchableField['type'])) {
					$doSF->Type = $searchableField['type'];
				} else {
					$doSF->Name = $searchableField['properties']['__method'];
					$doSF->Type = 'relationship';
				}
				$doSF->SearchableClassID = $doSC->ID;

				if(isset($searchableField['fields']['autocomplete'])) {
					$doSF->Autocomplete = true;
				}

				$doSF->write();
				\DB::alteration_message("Created new searchable editable field " . $name, "changed");
			}

			// FIXME deal with deletions
		}
	}


	private function getListRelationshipMethods() {
		$has_manys = $this->owner->has_many();
		$many_manys = $this->owner->many_many();

		// array of method name to retuned object ClassName for relationships returning lists
		$has_lists = $has_manys;
		foreach(array_keys($many_manys) as $key) {
			$has_lists[$key] = $many_manys[$key];
		}

		return $has_lists;
	}


	private function isInSiteTree($classname) {
		$inSiteTree = ($classname === 'SiteTree' ? true : false);
		if(!$inSiteTree) {
			$class = new \ReflectionClass($this->owner->ClassName);
			while($class = $class->getParentClass()) {
				$parentClass = $class->getName();
				if($parentClass == 'SiteTree') {
					$inSiteTree = true;
					break;
				}
			}
		}
		return $inSiteTree;
	}


	/*
	Allow the option of overriding the default template with one of <ClassName>ElasticSearchResult
	 */
	public function RenderResult($linkToContainer = '') {
		$vars = new \ArrayData(array('SearchResult' => $this->owner, 'ContainerLink' => $linkToContainer));
		$possibleTemplates = array($this->owner->ClassName . 'ElasticSearchResult', 'ElasticSearchResult');
		return $this->owner->customise($vars)->renderWith($possibleTemplates);
	}



	public function getTermVectors() {
		return $this->service->getTermVectors($this->owner);
	}


	public function updateCMSFields(\FieldList $fields) {
		$isIndexed = false;
		// SIteTree object must have a live record, ShowInSearch = true
		if($this->isInSiteTree($this->owner->ClassName)) {
			$liveRecord = \Versioned::get_by_stage(get_class($this->owner), 'Live')->
				byID($this->owner->ID);
			if($liveRecord->ShowInSearch) {
				$isIndexed = true;
			} else {
				$isIndexed = false;
			}
		} else {
			// In the case of a DataObject we use the ShowInSearchFlag
			$isIndexed = true;
		}

		if($isIndexed) {
			$termVectors = $this->getTermVectors();
			$termFields = array_keys($termVectors);
			sort($termFields);

			foreach($termFields as $field) {
				$terms = new \ArrayList();

				foreach(array_keys($termVectors[$field]['terms']) as $term) {
					$do = new \DataObject();
					$do->Term = $term;
					$stats = $termVectors[$field]['terms'][$term];
					if(isset($stats['ttf'])) {
						$do->TTF = $stats['ttf'];
					}

					if(isset($stats['doc_freq'])) {
						$do->DocFreq = $stats['doc_freq'];
					}

					if(isset($stats['term_freq'])) {
						$do->TermFreq = $stats['term_freq'];
					}
					$terms->push($do);
				}

				$config = \GridFieldConfig_RecordViewer::create(100);
				$config->getComponentByType('GridFieldDataColumns')->setDisplayFields(array(
					'Term' => 'Term',
					'TTF' => 'Total term frequency (how often a term occurs in all documents)',
					'DocFreq' => 'n documents with this term',
					'TermFreq'=> 'n times this term appears in this field'
				));

			   $underscored = str_replace('.', '_', $field);

				$gridField = new \GridField(
					'TermsFor' . $underscored, // Field name
					$field . 'TITLE' . $field, // Field title
					$terms,
					$config
				);
			   $fields->addFieldToTab('Root.ElasticaTerms.' . $underscored, $gridField);
			}

		}

		return $fields;
	}


}