2013-07-25 04:27:09 +02:00
|
|
|
<?php
|
2017-04-21 02:27:01 +02:00
|
|
|
namespace SilverStripe\FullTextSearch\Search\Processors;
|
2015-11-21 07:19:20 +01:00
|
|
|
abstract class SearchUpdateProcessor
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* List of dirty records to process in format
|
|
|
|
*
|
|
|
|
* array(
|
|
|
|
* '$BaseClass' => array(
|
|
|
|
* '$State Key' => array(
|
|
|
|
* 'state' => array(
|
|
|
|
* 'key1' => 'value',
|
|
|
|
* 'key2' => 'value'
|
|
|
|
* ),
|
|
|
|
* 'ids' => array(
|
|
|
|
* '*id*' => array(
|
|
|
|
* '*Index Name 1*',
|
|
|
|
* '*Index Name 2*'
|
|
|
|
* )
|
|
|
|
* )
|
|
|
|
* )
|
|
|
|
* )
|
|
|
|
* )
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $dirty;
|
|
|
|
|
|
|
|
public function __construct()
|
|
|
|
{
|
|
|
|
$this->dirty = array();
|
|
|
|
}
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
public function addDirtyIDs($class, $statefulids, $index)
|
|
|
|
{
|
|
|
|
$base = ClassInfo::baseDataClass($class);
|
|
|
|
$forclass = isset($this->dirty[$base]) ? $this->dirty[$base] : array();
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
foreach ($statefulids as $statefulid) {
|
|
|
|
$id = $statefulid['id'];
|
|
|
|
$state = $statefulid['state'];
|
|
|
|
$statekey = serialize($state);
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
if (!isset($forclass[$statekey])) {
|
|
|
|
$forclass[$statekey] = array('state' => $state, 'ids' => array($id => array($index)));
|
|
|
|
} elseif (!isset($forclass[$statekey]['ids'][$id])) {
|
|
|
|
$forclass[$statekey]['ids'][$id] = array($index);
|
|
|
|
} elseif (array_search($index, $forclass[$statekey]['ids'][$id]) === false) {
|
|
|
|
$forclass[$statekey]['ids'][$id][] = $index;
|
|
|
|
// dirty count stays the same
|
|
|
|
}
|
|
|
|
}
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
$this->dirty[$base] = $forclass;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Generates the list of indexes to process for the dirty items
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
protected function prepareIndexes()
|
|
|
|
{
|
|
|
|
$originalState = SearchVariant::current_state();
|
|
|
|
$dirtyIndexes = array();
|
|
|
|
$dirty = $this->getSource();
|
|
|
|
$indexes = FullTextSearch::get_indexes();
|
|
|
|
foreach ($dirty as $base => $statefulids) {
|
|
|
|
if (!$statefulids) {
|
|
|
|
continue;
|
|
|
|
}
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
foreach ($statefulids as $statefulid) {
|
|
|
|
$state = $statefulid['state'];
|
|
|
|
$ids = $statefulid['ids'];
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
SearchVariant::activate_state($state);
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
// Ensure that indexes for all new / updated objects are included
|
|
|
|
$objs = DataObject::get($base)->byIDs(array_keys($ids));
|
|
|
|
foreach ($objs as $obj) {
|
|
|
|
foreach ($ids[$obj->ID] as $index) {
|
|
|
|
if (!$indexes[$index]->variantStateExcluded($state)) {
|
|
|
|
$indexes[$index]->add($obj);
|
|
|
|
$dirtyIndexes[$index] = $indexes[$index];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
unset($ids[$obj->ID]);
|
|
|
|
}
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
// Generate list of records that do not exist and should be removed
|
|
|
|
foreach ($ids as $id => $fromindexes) {
|
|
|
|
foreach ($fromindexes as $index) {
|
|
|
|
if (!$indexes[$index]->variantStateExcluded($state)) {
|
|
|
|
$indexes[$index]->delete($base, $id, $state);
|
|
|
|
$dirtyIndexes[$index] = $indexes[$index];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
SearchVariant::activate_state($originalState);
|
|
|
|
return $dirtyIndexes;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Commits the specified index to the Solr service
|
|
|
|
*
|
|
|
|
* @param SolrIndex $index Index object
|
|
|
|
* @return bool Flag indicating success
|
|
|
|
*/
|
|
|
|
protected function commitIndex($index)
|
|
|
|
{
|
|
|
|
return $index->commit() !== false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the record data source to process
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
protected function getSource()
|
|
|
|
{
|
|
|
|
return $this->dirty;
|
|
|
|
}
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
/**
|
|
|
|
* Process all indexes, returning true if successful
|
|
|
|
*
|
|
|
|
* @return bool Flag indicating success
|
|
|
|
*/
|
|
|
|
public function process()
|
|
|
|
{
|
|
|
|
// Generate and commit all instances
|
|
|
|
$indexes = $this->prepareIndexes();
|
|
|
|
foreach ($indexes as $index) {
|
|
|
|
if (!$this->commitIndex($index)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
2013-07-25 04:27:09 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
abstract public function triggerProcessing();
|
2013-07-25 04:27:09 +02:00
|
|
|
}
|