2013-02-12 22:16:39 +01:00
|
|
|
<?php
|
2017-04-22 11:24:33 +02:00
|
|
|
|
2017-04-21 03:26:24 +02:00
|
|
|
namespace SilverStripe\FullTextSearch\Search\Variants;
|
2017-04-22 11:24:33 +02:00
|
|
|
|
2017-12-04 21:11:51 +01:00
|
|
|
use SilverStripe\Assets\File;
|
|
|
|
use SilverStripe\CMS\Model\SiteTree;
|
2018-05-14 18:04:40 +02:00
|
|
|
use SilverStripe\FullTextSearch\Search\Indexes\SearchIndex;
|
2017-12-04 21:11:51 +01:00
|
|
|
use SilverStripe\FullTextSearch\Search\SearchIntrospection;
|
|
|
|
use SilverStripe\FullTextSearch\Search\Queries\SearchQuery;
|
2017-04-22 11:24:33 +02:00
|
|
|
use SilverStripe\ORM\Queries\SQLSelect;
|
2017-04-26 13:16:32 +02:00
|
|
|
use SilverStripe\ORM\DataObject;
|
|
|
|
use SilverStripe\Security\Permission;
|
2017-12-04 21:11:51 +01:00
|
|
|
use SilverStripe\Subsites\Model\Subsite;
|
|
|
|
use SilverStripe\Subsites\Extensions\SiteTreeSubsites;
|
|
|
|
use SilverStripe\Subsites\Extensions\GroupSubsites;
|
|
|
|
use SilverStripe\Subsites\Extensions\FileSubsites;
|
|
|
|
use SilverStripe\Subsites\Extensions\SiteConfigSubsites;
|
|
|
|
use SilverStripe\Subsites\State\SubsiteState;
|
|
|
|
|
|
|
|
if (!class_exists(Subsite::class)) {
|
2017-04-26 13:16:32 +02:00
|
|
|
return;
|
|
|
|
}
|
2017-04-22 11:24:33 +02:00
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
class SearchVariantSubsites extends SearchVariant
|
|
|
|
{
|
|
|
|
public function appliesToEnvironment()
|
|
|
|
{
|
2017-12-04 21:11:51 +01:00
|
|
|
return class_exists(Subsite::class) && parent::appliesToEnvironment();
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function appliesTo($class, $includeSubclasses)
|
|
|
|
{
|
2017-12-04 21:11:51 +01:00
|
|
|
if (!$this->appliesToEnvironment()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-11-21 07:19:20 +01:00
|
|
|
// Include all DataExtensions that contain a SubsiteID.
|
|
|
|
// TODO: refactor subsites to inherit a common interface, so we can run introspection once only.
|
2017-12-04 21:11:51 +01:00
|
|
|
return SearchIntrospection::has_extension($class, SiteTreeSubsites::class, $includeSubclasses)
|
|
|
|
|| SearchIntrospection::has_extension($class, GroupSubsites::class, $includeSubclasses)
|
|
|
|
|| SearchIntrospection::has_extension($class, FileSubsites::class, $includeSubclasses)
|
|
|
|
|| SearchIntrospection::has_extension($class, SiteConfigSubsites::class, $includeSubclasses);
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function currentState()
|
|
|
|
{
|
2017-12-04 21:11:51 +01:00
|
|
|
return (string) SubsiteState::singleton()->getSubsiteId();
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function reindexStates()
|
|
|
|
{
|
|
|
|
static $ids = null;
|
|
|
|
|
|
|
|
if ($ids === null) {
|
2017-12-04 21:11:51 +01:00
|
|
|
$ids = ['0'];
|
|
|
|
foreach (Subsite::get() as $subsite) {
|
|
|
|
$ids[] = (string) $subsite->ID;
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $ids;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function activateState($state)
|
|
|
|
{
|
2017-12-04 21:11:51 +01:00
|
|
|
if (!$this->appliesToEnvironment()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Note: Setting directly to the SubsiteState because we don't want the subsite ID to be persisted
|
|
|
|
// like Subsite::changeSubsite would do.
|
|
|
|
SubsiteState::singleton()->setSubsiteId($state);
|
|
|
|
Permission::reset();
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
|
2016-04-15 07:59:10 +02:00
|
|
|
public function alterDefinition($class, $index)
|
2015-11-21 07:19:20 +01:00
|
|
|
{
|
|
|
|
$self = get_class($this);
|
2016-04-15 07:59:10 +02:00
|
|
|
|
2017-12-04 21:11:51 +01:00
|
|
|
if (!$this->appliesTo($class, true)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2016-04-15 07:59:10 +02:00
|
|
|
// Add field to root
|
2017-12-04 21:11:51 +01:00
|
|
|
$this->addFilterField($index, '_subsite', [
|
2015-11-21 07:19:20 +01:00
|
|
|
'name' => '_subsite',
|
|
|
|
'field' => '_subsite',
|
|
|
|
'fullfield' => '_subsite',
|
2017-04-26 13:16:32 +02:00
|
|
|
'base' => DataObject::getSchema()->baseDataClass($class),
|
2016-04-15 07:59:10 +02:00
|
|
|
'origin' => $class,
|
2015-11-21 07:19:20 +01:00
|
|
|
'type' => 'Int',
|
2017-12-04 21:11:51 +01:00
|
|
|
'lookup_chain' => [['call' => 'variant', 'variant' => $self, 'method' => 'currentState']],
|
|
|
|
]);
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
|
2017-03-30 12:17:46 +02:00
|
|
|
/**
|
|
|
|
* This field has been altered to allow a user to obtain search results for a particular subsite
|
|
|
|
* When attempting to do this in project code, SearchVariantSubsites kicks and overwrites any filter you've applied
|
|
|
|
* This fix prevents the module from doing this if a filter is applied on the index or the query, or if a field is
|
|
|
|
* being excluded specifically before being executed.
|
|
|
|
*
|
|
|
|
* A pull request has been raised for this issue. Once accepted this forked module can be deleted and the parent
|
|
|
|
* project should be used instead.
|
2018-05-14 18:04:40 +02:00
|
|
|
*
|
|
|
|
* @param SearchQuery $query
|
|
|
|
* @param SearchIndex $index
|
2017-03-30 12:17:46 +02:00
|
|
|
*/
|
2015-11-21 07:19:20 +01:00
|
|
|
public function alterQuery($query, $index)
|
|
|
|
{
|
2017-12-04 21:11:51 +01:00
|
|
|
if ($this->isFieldFiltered('_subsite', $query) || !$this->appliesToEnvironment()) {
|
2017-03-30 12:17:46 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2017-12-04 21:11:51 +01:00
|
|
|
$subsite = $this->currentState();
|
2018-05-14 18:04:40 +02:00
|
|
|
$query->addFilter('_subsite', [$subsite, SearchQuery::$missing]);
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* We need _really_ complicated logic to find just the changed subsites (because we use versions there's no explicit
|
|
|
|
* deletes, just new versions with different members) so just always use all of them
|
|
|
|
*/
|
|
|
|
public function extractManipulationWriteState(&$writes)
|
|
|
|
{
|
|
|
|
$self = get_class($this);
|
2017-12-04 21:11:51 +01:00
|
|
|
$tableName = DataObject::getSchema()->tableName(Subsite::class);
|
|
|
|
$query = SQLSelect::create('"ID"', '"' . $tableName . '"');
|
|
|
|
$subsites = array_merge(['0'], $query->execute()->column());
|
2015-11-21 07:19:20 +01:00
|
|
|
|
|
|
|
foreach ($writes as $key => $write) {
|
2016-04-15 07:59:10 +02:00
|
|
|
$applies = $this->appliesTo($write['class'], true);
|
|
|
|
if (!$applies) {
|
2015-11-21 07:19:20 +01:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2017-12-04 21:11:51 +01:00
|
|
|
if (isset($write['fields'][SiteTree::class . ':SubsiteID'])) {
|
|
|
|
$subsitesForWrite = [$write['fields'][SiteTree::class . ':SubsiteID']];
|
|
|
|
} elseif (isset($write['fields'][File::class . ':SubsiteID'])
|
|
|
|
&& (int) $write['fields'][File::class . ':SubsiteID'] !== 0
|
|
|
|
) {
|
|
|
|
// files in subsite 0 should be in all subsites as they are global
|
|
|
|
$subsitesForWrite = [$write['fields'][File::class . ':SubsiteID']];
|
2017-11-14 21:48:52 +01:00
|
|
|
} else {
|
2016-12-02 15:08:38 +01:00
|
|
|
$subsitesForWrite = $subsites;
|
|
|
|
}
|
|
|
|
|
2017-12-04 21:11:51 +01:00
|
|
|
$next = [];
|
2015-11-21 07:19:20 +01:00
|
|
|
foreach ($write['statefulids'] as $i => $statefulid) {
|
2016-12-02 15:08:38 +01:00
|
|
|
foreach ($subsitesForWrite as $subsiteID) {
|
2017-12-04 21:11:51 +01:00
|
|
|
$next[] = [
|
2016-04-15 07:59:10 +02:00
|
|
|
'id' => $statefulid['id'],
|
|
|
|
'state' => array_merge(
|
|
|
|
$statefulid['state'],
|
2017-12-04 21:11:51 +01:00
|
|
|
[$self => (string) $subsiteID]
|
|
|
|
),
|
|
|
|
];
|
2015-11-21 07:19:20 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
$writes[$key]['statefulids'] = $next;
|
|
|
|
}
|
|
|
|
}
|
2017-03-30 12:17:46 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Determine if a field with a certain name is filtered by the search query or on the index
|
|
|
|
* This is the equivalent of saying "show me the results that do ONLY contain this value"
|
|
|
|
* @param $field string name of the field being filtered
|
|
|
|
* @param $query SearchQuery currently being executed
|
|
|
|
* @param $index SearchIndex which specifies a filter field
|
|
|
|
* @return bool true if $field is being filtered, false if it is not being filtered
|
|
|
|
*/
|
|
|
|
protected function isFieldFiltered($field, $query)
|
|
|
|
{
|
|
|
|
$queryHasFilter = !empty($query->require[$field]);
|
|
|
|
|
|
|
|
return $queryHasFilter;
|
|
|
|
}
|
2013-02-12 22:16:39 +01:00
|
|
|
}
|