silverstripe-fulltextsearch/code/search/variants/SearchVariantSubsites.php

152 lines
5.5 KiB
PHP
Raw Normal View History

<?php
2017-04-22 11:24:33 +02:00
namespace SilverStripe\FullTextSearch\Search\Variants;
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;
use SilverStripe\FullTextSearch\Search\SearchIntrospection;
use SilverStripe\FullTextSearch\Search\Queries\SearchQuery;
if (!class_exists('Subsite')) {
return;
}
2017-04-22 11:24:33 +02:00
2015-11-21 07:19:20 +01:00
class SearchVariantSubsites extends SearchVariant
{
public function appliesToEnvironment()
{
return class_exists('Subsite');
}
public function appliesTo($class, $includeSubclasses)
{
// Include all DataExtensions that contain a SubsiteID.
// TODO: refactor subsites to inherit a common interface, so we can run introspection once only.
return SearchIntrospection::has_extension($class, 'SiteTreeSubsites', $includeSubclasses) ||
SearchIntrospection::has_extension($class, 'GroupSubsites', $includeSubclasses) ||
SearchIntrospection::has_extension($class, 'FileSubsites', $includeSubclasses) ||
SearchIntrospection::has_extension($class, 'SiteConfigSubsites', $includeSubclasses);
}
public function currentState()
{
return (string)Subsite::currentSubsiteID();
}
public function reindexStates()
{
static $ids = null;
if ($ids === null) {
$ids = array('0');
foreach (DataObject::get('Subsite') as $subsite) {
$ids[] = (string)$subsite->ID;
}
}
return $ids;
}
public function activateState($state)
{
// We always just set the $_GET variable rather than store in Session - this always works, has highest priority
// in Subsite::currentSubsiteID() and doesn't persist unlike Subsite::changeSubsite
$_GET['SubsiteID'] = $state;
Permission::flush_permission_cache();
}
public function alterDefinition($class, $index)
2015-11-21 07:19:20 +01:00
{
$self = get_class($this);
// Add field to root
$this->addFilterField($index, '_subsite', array(
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),
'origin' => $class,
2015-11-21 07:19:20 +01:00
'type' => 'Int',
'lookup_chain' => array(array('call' => 'variant', 'variant' => $self, 'method' => 'currentState'))
));
2015-11-21 07:19:20 +01: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.
*/
2015-11-21 07:19:20 +01:00
public function alterQuery($query, $index)
{
if ($this->isFieldFiltered('_subsite', $query)) {
return;
}
2015-11-21 07:19:20 +01:00
$subsite = Subsite::currentSubsiteID();
$query->filter('_subsite', array($subsite, SearchQuery::$missing));
}
/**
* 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-04-22 11:24:33 +02:00
$query = new SQLSelect('"ID"', '"Subsite"');
$subsites = array_merge(array('0'), $query->execute()->column());
2015-11-21 07:19:20 +01:00
foreach ($writes as $key => $write) {
$applies = $this->appliesTo($write['class'], true);
if (!$applies) {
2015-11-21 07:19:20 +01:00
continue;
}
if (isset($write['fields']['SiteTree:SubsiteID'])) {
$subsitesForWrite = array($write['fields']['SiteTree:SubsiteID']);
}
// files in subsite 0 should be in all subsites as they are global
elseif (isset($write['fields']['File:SubsiteID']) && intval($write['fields']['File:SubsiteID']) !== 0) {
$subsitesForWrite = array($write['fields']['File:SubsiteID']);
}
else {
$subsitesForWrite = $subsites;
}
2015-11-21 07:19:20 +01:00
$next = array();
foreach ($write['statefulids'] as $i => $statefulid) {
foreach ($subsitesForWrite as $subsiteID) {
$next[] = array(
'id' => $statefulid['id'],
'state' => array_merge(
$statefulid['state'],
array($self => (string)$subsiteID)
)
);
2015-11-21 07:19:20 +01:00
}
}
$writes[$key]['statefulids'] = $next;
}
}
/**
* 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;
}
}