query.inc in Search API 7
Same filename in this branch
Contains SearchApiViewsQuery.
File
contrib/search_api_views/includes/query.incView source
<?php
/**
* @file
* Contains SearchApiViewsQuery.
*/
/**
* Views query class using a Search API index as the data source.
*/
class SearchApiViewsQuery extends views_plugin_query {
/**
* Number of results to display.
*
* @var int
*/
protected $limit;
/**
* Offset of first displayed result.
*
* @var int
*/
protected $offset;
/**
* The index this view accesses.
*
* @var SearchApiIndex
*/
protected $index;
/**
* The query that will be executed.
*
* @var SearchApiQueryInterface
*/
protected $query;
/**
* The results returned by the query, after it was executed.
*
* @var array
*/
protected $search_api_results = array();
/**
* Array of all encountered errors.
*
* Each of these is fatal, meaning that a non-empty $errors property will
* result in an empty result being returned.
*
* @var array
*/
protected $errors;
/**
* Whether to abort the search instead of executing it.
*
* @var bool
*/
protected $abort = FALSE;
/**
* The names of all fields whose value is required by a handler.
*
* The format follows the same as Search API field identifiers (parent:child).
*
* @var array
*/
protected $fields;
/**
* The query's sub-filters representing the different Views filter groups.
*
* @var array
*/
protected $filters = array();
/**
* The conjunction with which multiple filter groups are combined.
*
* @var string
*/
public $group_operator = 'AND';
/**
* Create the basic query object and fill with default values.
*/
public function init($base_table, $base_field, $options) {
try {
$this->errors = array();
parent::init($base_table, $base_field, $options);
$this->fields = array();
if (substr($base_table, 0, 17) == 'search_api_index_') {
$id = substr($base_table, 17);
$this->index = search_api_index_load($id);
$this->query = $this->index
->query(array(
'parse mode' => $this->options['parse_mode'],
));
}
} catch (Exception $e) {
$this->errors[] = $e
->getMessage();
}
}
/**
* Add a field that should be retrieved from the results by this view.
*
* @param $field
* The field's identifier, as used by the Search API. E.g., "title" for a
* node's title, "author:name" for a node's author's name.
*
* @return SearchApiViewsQuery
* The called object.
*/
public function addField($field) {
$this->fields[$field] = TRUE;
return $field;
}
/**
* Adds a sort to the query.
*
* @param string $selector
* The field to sort on. All indexed fields of the index are valid values.
* In addition, these special fields may be used:
* - search_api_relevance: sort by relevance;
* - search_api_id: sort by item id;
* - search_api_random: random sort (available only if the server supports
* the "search_api_random_sort" feature).
* @param string $order
* The order to sort items in - either 'ASC' or 'DESC'. Defaults to 'ASC'.
*/
public function add_selector_orderby($selector, $order = 'ASC') {
if (!$this->errors) {
$this->query
->sort($selector, $order);
}
}
/**
* Provides a sorting method as present in the Views default query plugin.
*
* This is provided so that the "Global: Random" sort included in Views will
* work properly with Search API Views. Random sorting is only supported if
* the active search server supports the "search_api_random_sort" feature,
* though, otherwise the call will be ignored.
*
* This method can only be used to sort randomly, as would be done with the
* default query plugin. All other calls are ignored.
*
* @param string|null $table
* Only "rand" is recognized here, all other calls are ignored.
* @param string|null $field
* Is ignored and only present for compatibility reasons.
* @param string $order
* Either "ASC" or "DESC".
* @param string|null $alias
* Is ignored and only present for compatibility reasons.
* @param array $params
* The following optional parameters are recognized:
* - seed: a predefined seed for the random generator.
*
* @see views_plugin_query_default::add_orderby()
*/
public function add_orderby($table, $field = NULL, $order = 'ASC', $alias = '', $params = array()) {
$server = $this
->getIndex()
->server();
if ($table == 'rand') {
if ($server
->supportsFeature('search_api_random_sort')) {
$this
->add_selector_orderby('search_api_random', $order);
if ($params) {
$this
->setOption('search_api_random_sort', $params);
}
}
else {
$variables['%server'] = $server
->label();
watchdog('search_api_views', 'Tried to sort results randomly on server %server which does not support random sorting.', $variables, WATCHDOG_WARNING);
}
}
}
/**
* Defines the options used by this query plugin.
*
* Adds some access options.
*/
public function option_definition() {
return parent::option_definition() + array(
'search_api_bypass_access' => array(
'default' => FALSE,
),
'entity_access' => array(
'default' => FALSE,
),
'parse_mode' => array(
'default' => 'terms',
),
'preserve_facet_query_args' => array(
'default' => FALSE,
'bool' => TRUE,
),
);
}
/**
* Add settings for the UI.
*
* Adds an option for bypassing access checks.
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['search_api_bypass_access'] = array(
'#type' => 'checkbox',
'#title' => t('Bypass access checks'),
'#description' => t('If the underlying search index has access checks enabled, this option allows to disable them for this view.'),
'#default_value' => $this->options['search_api_bypass_access'],
);
if ($this->index && $this->index
->getEntityType()) {
$form['entity_access'] = array(
'#type' => 'checkbox',
'#title' => t('Additional access checks on result entities'),
'#description' => t("Execute an access check for all result entities. This prevents users from seeing inappropriate content when the index contains stale data, or doesn't provide access checks. However, result counts, paging and other things won't work correctly if results are eliminated in this way, so only use this as a last ressort (and in addition to other checks, if possible)."),
'#default_value' => $this->options['entity_access'],
);
}
$form['parse_mode'] = array(
'#type' => 'select',
'#title' => t('Parse mode'),
'#description' => t('Choose how the search keys will be parsed.'),
'#options' => array(),
'#default_value' => $this->options['parse_mode'],
);
foreach ($this->query
->parseModes() as $key => $mode) {
$form['parse_mode']['#options'][$key] = $mode['name'];
if (!empty($mode['description'])) {
$states['visible'][':input[name="query[options][parse_mode]"]']['value'] = $key;
$form["parse_mode_{$key}_description"] = array(
'#type' => 'item',
'#title' => $mode['name'],
'#description' => $mode['description'],
'#states' => $states,
);
}
}
if (module_exists('facetapi')) {
$form['preserve_facet_query_args'] = array(
'#type' => 'checkbox',
'#title' => t('Preserve facets while using filters'),
'#description' => t('By default, changing an exposed filter would reset all selected facets. This option allows you to prevent this behavior.'),
'#default_value' => $this->options['preserve_facet_query_args'],
);
}
}
/**
* Builds the necessary info to execute the query.
*/
public function build(&$view) {
if (!empty($this->errors)) {
return;
}
$this->view = $view;
// Setup the nested filter structure for this query.
if (!empty($this->where)) {
// If the different groups are combined with the OR operator, we have to
// add a new OR filter to the query to which the filters for the groups
// will be added.
if ($this->group_operator === 'OR') {
$base = $this->query
->createFilter('OR');
$this->query
->filter($base);
}
else {
$base = $this->query;
}
// Add a nested filter for each filter group, with its set conjunction.
foreach ($this->where as $group_id => $group) {
if (!empty($group['conditions']) || !empty($group['filters'])) {
$group += array(
'type' => 'AND',
);
// For filters without a group, we want to always add them directly to
// the query.
$filter = $group_id === '' ? $this->query : $this->query
->createFilter($group['type']);
if (!empty($group['conditions'])) {
foreach ($group['conditions'] as $condition) {
list($field, $value, $operator) = $condition;
$filter
->condition($field, $value, $operator);
}
}
if (!empty($group['filters'])) {
foreach ($group['filters'] as $nested_filter) {
$filter
->filter($nested_filter);
}
}
// If no group was given, the filters were already set on the query.
if ($group_id !== '') {
$base
->filter($filter);
}
}
}
}
// Initialize the pager and let it modify the query to add limits.
$view
->init_pager();
$this->pager
->query();
// Set the search ID, if it was not already set.
if ($this->query
->getOption('search id') == get_class($this->query)) {
$this->query
->setOption('search id', 'search_api_views:' . $view->name . ':' . $view->current_display);
}
// Add the "search_api_bypass_access" option to the query, if desired.
if (!empty($this->options['search_api_bypass_access'])) {
$this->query
->setOption('search_api_bypass_access', TRUE);
}
// Store the Views base path.
$this->query
->setOption('search_api_base_path', $this->view
->get_path());
// Save query information for Views UI.
$view->build_info['query'] = (string) $this->query;
}
/**
* {@inheritdoc}
*/
public function alter(&$view) {
parent::alter($view);
drupal_alter('search_api_views_query', $view, $this);
}
/**
* Executes the query and fills the associated view object with according
* values.
*
* Values to set: $view->result, $view->total_rows, $view->execute_time,
* $view->pager['current_page'].
*/
public function execute(&$view) {
if ($this->errors || $this->abort) {
if (error_displayable()) {
foreach ($this->errors as $msg) {
drupal_set_message(check_plain($msg), 'error');
}
}
$view->result = array();
$view->total_rows = 0;
$view->execute_time = 0;
return;
}
// Calculate the "skip result count" option, if it wasn't already set to
// FALSE.
$skip_result_count = $this->query
->getOption('skip result count', TRUE);
if ($skip_result_count) {
$skip_result_count = !$this->pager || !$this->pager
->use_count_query() && empty($view->get_total_rows);
$this->query
->setOption('skip result count', $skip_result_count);
}
try {
// Trigger pager pre_execute().
if ($this->pager) {
$this->pager
->pre_execute($this->query);
}
// Views passes sometimes NULL and sometimes the integer 0 for "All" in a
// pager. If set to 0 items, a string "0" is passed. Therefore, we unset
// the limit if an empty value OTHER than a string "0" was passed.
if (!$this->limit && $this->limit !== '0') {
$this->limit = NULL;
}
// Set the range. (We always set this, as there might even be an offset if
// all items are shown.)
$this->query
->range($this->offset, $this->limit);
$start = microtime(TRUE);
// Execute the search.
$results = $this->query
->execute();
$this->search_api_results = $results;
// Store the results.
if (!$skip_result_count) {
$this->pager->total_items = $view->total_rows = $results['result count'];
if (!empty($this->pager->options['offset'])) {
$this->pager->total_items -= $this->pager->options['offset'];
}
$this->pager
->update_page_info();
}
$view->result = array();
if (!empty($results['results'])) {
$this
->addResults($results['results'], $view);
}
// We shouldn't use $results['performance']['complete'] here, since
// extracting the results probably takes considerable time as well.
$view->execute_time = microtime(TRUE) - $start;
// Trigger pager post_execute().
if ($this->pager) {
$this->pager
->post_execute($view->result);
}
} catch (Exception $e) {
$this->errors[] = $e
->getMessage();
// Recursion to get the same error behaviour as above.
$this
->execute($view);
}
}
/**
* Aborts this search query.
*
* Used by handlers to flag a fatal error which shouldn't be displayed but
* still lead to the view returning empty and the search not being executed.
*
* @param string|null $msg
* Optionally, a translated, unescaped error message to display.
*/
public function abort($msg = NULL) {
if ($msg) {
$this->errors[] = $msg;
}
$this->abort = TRUE;
}
/**
* Helper function for adding results to a view in the format expected by the
* view.
*/
protected function addResults(array $results, $view) {
$rows = array();
$missing = array();
$items = array();
// First off, we try to gather as much field values as possible without
// loading any items.
foreach ($results as $id => $result) {
if (!empty($this->options['entity_access']) && ($entity_type = $this->index
->getEntityType())) {
$entity = $this->index
->loadItems(array(
$id,
));
if (!$entity || !entity_access('view', $entity_type, reset($entity))) {
continue;
}
}
$row = array();
// Include the loaded item for this result row, if present, or the item
// ID.
if (!empty($result['entity'])) {
$row['entity'] = $result['entity'];
}
else {
$row['entity'] = $id;
}
$row['_entity_properties']['search_api_relevance'] = $result['score'];
$row['_entity_properties']['search_api_excerpt'] = empty($result['excerpt']) ? '' : $result['excerpt'];
// Gather any fields from the search results.
if (!empty($result['fields'])) {
$row['_entity_properties'] += search_api_get_sanitized_field_values($result['fields']);
}
// Check whether we need to extract any properties from the result item.
$missing_fields = array_diff_key($this->fields, $row['_entity_properties']);
if ($missing_fields) {
$missing[$id] = $missing_fields;
if (is_object($row['entity'])) {
$items[$id] = $row['entity'];
}
else {
$ids[] = $id;
}
}
// Save the row values for adding them to the Views result afterwards.
$rows[$id] = (object) $row;
}
// Load items of those rows which haven't got all field values, yet.
if (!empty($ids)) {
$items += $this->index
->loadItems($ids);
}
// $items now includes all loaded items from which fields still need to be
// extracted.
foreach ($items as $id => $item) {
// Extract item properties.
$wrapper = $this->index
->entityWrapper($item, FALSE);
$rows[$id]->_entity_properties += $this
->extractFields($wrapper, $missing[$id]);
$rows[$id]->entity = $item;
}
// Finally, add all rows to the Views result set.
$view->result = array_values($rows);
}
/**
* Helper function for extracting all necessary fields from a result item.
*
* Usually, this method isn't needed anymore as the properties are now
* extracted by the field handlers themselves.
*/
protected function extractFields(EntityMetadataWrapper $wrapper, array $all_fields) {
$fields = array();
foreach ($all_fields as $key => $true) {
$fields[$key]['type'] = 'string';
}
$fields = search_api_extract_fields($wrapper, $fields, array(
'sanitized' => TRUE,
));
$ret = array();
foreach ($all_fields as $key => $true) {
$ret[$key] = isset($fields[$key]['value']) ? $fields[$key]['value'] : '';
}
return $ret;
}
/**
* Returns the according entity objects for the given query results.
*
* This is necessary to support generic entity handlers and plugins with this
* query backend.
*
* If the current query isn't based on an entity type, the method will return
* an empty array.
*/
public function get_result_entities($results, $relationship = NULL, $field = NULL) {
list($type, $wrappers) = $this
->get_result_wrappers($results, $relationship, $field);
$return = array();
foreach ($wrappers as $i => $wrapper) {
try {
// Get the entity ID beforehand for possible watchdog messages.
$id = $wrapper
->value(array(
'identifier' => TRUE,
));
// Only add results that exist.
if ($entity = $wrapper
->value()) {
$return[$i] = $entity;
}
else {
watchdog('search_api_views', 'The search index returned a reference to an entity with ID @id, which does not exist in the database. Your index may be out of sync and should be rebuilt.', array(
'@id' => $id,
), WATCHDOG_ERROR);
}
} catch (EntityMetadataWrapperException $e) {
watchdog_exception('search_api_views', $e, "%type while trying to load search result entity with ID @id: !message in %function (line %line of %file).", array(
'@id' => $id,
), WATCHDOG_ERROR);
}
}
return array(
$type,
$return,
);
}
/**
* Returns the according metadata wrappers for the given query results.
*
* This is necessary to support generic entity handlers and plugins with this
* query backend.
*/
public function get_result_wrappers($results, $relationship = NULL, $field = NULL) {
$type = $this->index
->getEntityType() ? $this->index
->getEntityType() : $this->index->item_type;
$wrappers = array();
$load_items = array();
foreach ($results as $row_index => $row) {
if (isset($row->entity)) {
// If this entity isn't load, register it for pre-loading.
if (!is_object($row->entity)) {
$load_items[$row->entity] = $row_index;
}
else {
$wrappers[$row_index] = $this->index
->entityWrapper($row->entity);
}
}
}
// If the results are entities, we pre-load them to make use of a multiple
// load. (Otherwise, each result would be loaded individually.)
if (!empty($load_items)) {
$items = $this->index
->loadItems(array_keys($load_items));
foreach ($items as $id => $item) {
$wrappers[$load_items[$id]] = $this->index
->entityWrapper($item);
}
}
// Apply the relationship, if necessary.
$selector_suffix = '';
if ($field && ($pos = strrpos($field, ':'))) {
$selector_suffix = substr($field, 0, $pos);
}
if ($selector_suffix || $relationship && !empty($this->view->relationship[$relationship])) {
// Use EntityFieldHandlerHelper to compute the correct data selector for
// the relationship.
$handler = (object) array(
'view' => $this->view,
'relationship' => $relationship,
'real_field' => '',
);
$selector = EntityFieldHandlerHelper::construct_property_selector($handler);
$selector .= ($selector ? ':' : '') . $selector_suffix;
list($type, $wrappers) = EntityFieldHandlerHelper::extract_property_multiple($wrappers, $selector);
}
return array(
$type,
$wrappers,
);
}
/**
* API function for accessing the raw Search API query object.
*
* @return SearchApiQueryInterface
* The search query object used internally by this handler.
*/
public function getSearchApiQuery() {
return $this->query;
}
/**
* API function for accessing the raw Search API results.
*
* @return array
* An associative array containing the search results, as specified by
* SearchApiQueryInterface::execute().
*/
public function getSearchApiResults() {
return $this->search_api_results;
}
//
// Query interface methods (proxy to $this->query)
//
public function createFilter($conjunction = 'AND', $tags = array()) {
if (!$this->errors) {
return $this->query
->createFilter($conjunction, $tags);
}
}
public function keys($keys = NULL) {
if (!$this->errors) {
$this->query
->keys($keys);
}
return $this;
}
public function fields(array $fields) {
if (!$this->errors) {
$this->query
->fields($fields);
}
return $this;
}
/**
* Adds a nested filter to the search query object.
*
* If $group is given, the filter is added to the relevant filter group
* instead.
*/
public function filter(SearchApiQueryFilterInterface $filter, $group = NULL) {
if (!$this->errors) {
$this->where[$group]['filters'][] = $filter;
}
return $this;
}
/**
* Set a condition on the search query object.
*
* If $group is given, the condition is added to the relevant filter group
* instead.
*/
public function condition($field, $value, $operator = '=', $group = NULL) {
if (!$this->errors) {
$this->where[$group]['conditions'][] = array(
$field,
$value,
$operator,
);
}
return $this;
}
public function sort($field, $order = 'ASC') {
if (!$this->errors) {
$this->query
->sort($field, $order);
}
return $this;
}
public function range($offset = NULL, $limit = NULL) {
if (!$this->errors) {
$this->query
->range($offset, $limit);
}
return $this;
}
public function getIndex() {
return $this->index;
}
public function &getKeys() {
if (!$this->errors) {
return $this->query
->getKeys();
}
$ret = NULL;
return $ret;
}
public function getOriginalKeys() {
if (!$this->errors) {
return $this->query
->getOriginalKeys();
}
}
public function &getFields() {
if (!$this->errors) {
return $this->query
->getFields();
}
$ret = NULL;
return $ret;
}
public function getFilter() {
if (!$this->errors) {
return $this->query
->getFilter();
}
}
public function &getSort() {
if (!$this->errors) {
return $this->query
->getSort();
}
$ret = NULL;
return $ret;
}
public function getOption($name, $default = NULL) {
if (!$this->errors) {
return $this->query
->getOption($name, $default);
}
return $default;
}
public function setOption($name, $value) {
if (!$this->errors) {
return $this->query
->setOption($name, $value);
}
return NULL;
}
public function &getOptions() {
if (!$this->errors) {
return $this->query
->getOptions();
}
$ret = NULL;
return $ret;
}
}Classes
Name |
Description |
|---|---|
| SearchApiViewsQuery | Views query class using a Search API index as the data source. |