The body & nothing.
\n", $body_value->value(), "Getting processed value."); + $this->assertEqual("The body & nothing.\n", $body_value->value(array('decode' => TRUE)), "Decoded value."); + $this->assertEqual("The body & nothing.", $body_value->raw(), "Raw body returned."); + + // Test getting the summary. + $this->assertEqual("The body.
\n", $wrapper->body->summary->value(), "Getting body summary."); + + $wrapper->body->set(array('value' => "The second body.")); + $this->assertEqual("The second body.
\n", $wrapper->body->value->value(), "Setting a processed field value and reading it again."); + $this->assertEqual($node->body[LANGUAGE_NONE][0]['value'], "The second body.", 'Update appears in the wrapped entity.'); + $this->assert(isset($node->body[LANGUAGE_NONE][0]['safe_value']), 'Formatted text has been processed.'); + + // Test translating the body on an English node. + // Add a new language and optionally set it as default. + require_once BACKDROP_ROOT . '/core/includes/locale.inc'; + $language = (object) array( + 'langcode' => 'de', + ); + language_save($language); + + $body['en'][0] = array('value' => 'English body.', 'summary' => 'The body.'); + $node = $this->backdropCreateNode(array('body' => $body, 'langcode' => 'en', 'type' => 'page')); + $wrapper = entity_metadata_wrapper('node', $node); + + $wrapper->language('de'); + + $languages = language_list(); + $this->assertEqual($wrapper->getPropertyLanguage(), $languages['de'], 'Wrapper language has been set to German'); + $this->assertEqual($wrapper->body->value->value(), "English body.
\n", 'Language fallback on default language.'); + + // Set a German text using the wrapper. + $wrapper->body->set(array('value' => "Der zweite Text.")); + $this->assertEqual($wrapper->body->value->value(), "Der zweite Text.
\n", 'German body set and retrieved.'); + + $wrapper->language(LANGUAGE_NONE); + $this->assertEqual($wrapper->body->value->value(), "English body.
\n", 'Default language text is still there.'); + + // Test iterator. + $type_info = entity_plus_get_property_info('node'); + $this->assertFalse(array_diff_key($type_info['properties'], iterator_to_array($wrapper->getIterator())), 'Iterator is working.'); + foreach ($wrapper as $property) { + $this->assertTrue($property instanceof EntityMetadataWrapper, 'Iterate over wrapper properties.'); + } + + // Test setting a new node. + $node->title = 'foo'; + $wrapper->set($node); + $this->assertEqual($wrapper->title->value(), 'foo', 'Changed the wrapped node.'); + + // Test getting options lists. + $this->assertEqual($wrapper->type->optionsList(), node_type_get_names(), 'Options list returned.'); + + // Test making use of a generic 'entity' reference property the + // 'entity_plus_test' module provides. The property defaults to the node author. +/* $this->assertEqual($wrapper->reference->uid->value(), $wrapper->author->getIdentifier(), 'Used generic entity reference property.'); + // Test updating a property of the generic entity reference. + $wrapper->reference->name->set('foo'); + $this->assertEqual($wrapper->reference->name->value(), 'foo', 'Updated property of generic entity reference'); + // For testing, just point the reference to the node itself now. + $wrapper->reference->set($wrapper); + $this->assertEqual($wrapper->reference->nid->value(), $wrapper->getIdentifier(), 'Correctly updated the generic entity referenced property.'); + */ + // Test saving and deleting. + $wrapper->save(); + $wrapper->delete(); + $return = node_load($wrapper->getIdentifier()); + $this->assertFalse($return, "Node has been successfully deleted."); + + // Ensure changing the bundle changes available wrapper properties. + $wrapper->type->set('post'); + $this->assertTrue(isset($wrapper->field_tags), 'Changing bundle changes available wrapper properties.'); + + // Test labels. + $user = $this->backdropCreateUser(); + user_save($user, array('roles' => array())); + $wrapper->author = $user->uid; + $this->assertEqual($wrapper->label(), $node->title, 'Entity label returned.'); + $this->assertEqual($wrapper->author->roles[0]->label(), t('Authenticated'), 'Label from options list returned'); + $this->assertEqual($wrapper->author->roles->label(), t('Authenticated'), 'Label for a list from options list returned'); + } + + /** + * Test supporting multi-valued fields. + */ + function testListMetadataWrappers() { + $property = $this->field_name; + $values = array(); + $values[LANGUAGE_NONE][0] = array('value' => '2009-09-05'); + $values[LANGUAGE_NONE][1] = array('value' => '2009-09-05'); + $values[LANGUAGE_NONE][2] = array('value' => '2009-08-05'); + + $node = $this->backdropCreateNode(array('type' => 'page', $property => $values)); + $wrapper = entity_metadata_wrapper('node', $node); + + $this->assertEqual('2009-09-05', $wrapper->{$property}[0]->value(), 'Getting array entry.'); + $this->assertEqual('2009-09-05', $wrapper->{$property}->get(1)->value(), 'Getting array entry.'); + $this->assertEqual(3, count($wrapper->{$property}->value()), 'Getting the whole array.'); + + // Test sanitizing + $this->assertEqual(check_plain('2009-09-05'), $wrapper->{$property}[0]->value(array('sanitize' => TRUE)), 'Getting array entry.'); + + // Test iterator + $this->assertEqual(array_keys(iterator_to_array($wrapper->$property->getIterator())), array_keys($wrapper->$property->value()), 'Iterator is working.'); + foreach ($wrapper->$property as $p) { + $this->assertTrue($p instanceof EntityMetadataWrapper, 'Iterate over list wrapper properties.'); + } + + // Make sure changing the array changes the actual entity property. + $wrapper->{$property}[0] = '2009-10-05'; + unset($wrapper->{$property}[1], $wrapper->{$property}[2]); + $this->assertEqual($wrapper->{$property}->value(), array('2009-10-05'), 'Setting multiple property values.'); + + // Test setting an arbitrary list item. + $list = array(0 => REQUEST_TIME); + $wrapper = entity_metadata_wrapper('list',
+ '#options' => array(
+ TRUE => t('For all except the selected'),
+ FALSE => t('Only for the selected'),
+ ),
+ '#default_value' => isset($options['default_true']) ? $options['default_true'] : TRUE,
+ );
+ $form['global']['facet_search_ids'] = array(
+ '#type' => 'select',
+ '#title' => t('Search IDs'),
+ '#suffix' => '
',
+ '#options' => $search_ids,
+ '#size' => min(4, count($search_ids)),
+ '#multiple' => TRUE,
+ '#default_value' => isset($options['facet_search_ids']) ? $options['facet_search_ids'] : array(),
+ );
+ }
+ else {
+ $form['global']['default_true'] = array(
+ '#type' => 'value',
+ '#value' => TRUE,
+ );
+ $form['global']['facet_search_ids'] = array(
+ '#type' => 'value',
+ '#value' => array(),
+ );
+ }
+
+ // Add a granularity option to date query types.
+ if (isset($facet['query type']) && $facet['query type'] == 'date') {
+ $granularity_options = array(
+ FACETAPI_DATE_YEAR => t('Years'),
+ FACETAPI_DATE_MONTH => t('Months'),
+ FACETAPI_DATE_DAY => t('Days'),
+ FACETAPI_DATE_HOUR => t('Hours'),
+ FACETAPI_DATE_MINUTE => t('Minutes'),
+ FACETAPI_DATE_SECOND => t('Seconds'),
+ );
+
+ $form['global']['date_granularity'] = array(
+ '#type' => 'select',
+ '#title' => t('Granularity'),
+ '#description' => t('Determine the maximum drill-down level'),
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#options' => $granularity_options,
+ '#default_value' => isset($options['date_granularity']) ? $options['date_granularity'] : FACETAPI_DATE_MINUTE,
+ );
+
+ $default_value = FACETAPI_DATE_YEAR;
+ if (isset($options['date_granularity_min'])) {
+ $default_value = $options['date_granularity_min'];
+ }
+ $form['global']['date_granularity_min'] = array(
+ '#type' => 'select',
+ '#title' => t('Minimum granularity'),
+ '#description' => t('Determine the minimum drill-down level to start at'),
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#options' => $granularity_options,
+ '#default_value' => $default_value,
+ );
+ }
+
+ // Add an "Exclude" option for terms.
+ if (!empty($facet['query types']) && in_array('term', $facet['query types'])) {
+ $form['global']['operator']['#weight'] = -2;
+ unset($form['global']['operator']['#suffix']);
+ $form['global']['exclude'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Exclude'),
+ '#description' => t('Make the search exclude selected facets, instead of restricting it to them.'),
+ '#suffix' => '',
+ '#weight' => -1,
+ '#default_value' => !empty($options['exclude']),
+ );
+ }
+ }
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_facetapi/plugins/facetapi/query_type_date.inc b/www/modules/contrib/search_api/contrib/search_api_facetapi/plugins/facetapi/query_type_date.inc
new file mode 100644
index 000000000..e80a3085a
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_facetapi/plugins/facetapi/query_type_date.inc
@@ -0,0 +1,366 @@
+adapter->addFacet($this->facet, $query);
+
+ $settings = $this->adapter->getFacet($this->facet)->getSettings()->settings;
+
+ // First check if the facet is enabled for this search.
+ $default_true = isset($settings['default_true']) ? $settings['default_true'] : TRUE;
+ $facet_search_ids = isset($settings['facet_search_ids']) ? $settings['facet_search_ids'] : array();
+ if ($default_true != empty($facet_search_ids[$query->getOption('search id')])) {
+ // Facet is not enabled for this search ID.
+ return;
+ }
+
+ // Change limit to "unlimited" (-1).
+ $options = &$query->getOptions();
+ if (!empty($options['search_api_facets'][$this->facet['name']])) {
+ $options['search_api_facets'][$this->facet['name']]['limit'] = -1;
+ }
+
+ if ($active_items = $this->adapter->getActiveItems($this->facet)) {
+ $field = $this->facet['field'];
+ $operator = 'OR';
+ if ($settings['operator'] !== FACETAPI_OPERATOR_OR) {
+ $operator = 'AND';
+ // If the operator is AND, we just need to apply the lowest-level
+ // filter(s) to make this work correctly. For single-valued fields, this
+ // will always just be the last value, so just use that to improve
+ // performance for that case.
+ $fields = $query->getIndex()->getFields();
+ if (isset($fields[$field]['type'])
+ && !search_api_is_list_type($fields[$field]['type'])) {
+ $active_items = array(end($active_items));
+ }
+ }
+ $date_query = $query->createFilter($operator, array("facet:$field"));
+ foreach ($active_items as $active_item) {
+ $filter = $this->createRangeFilter($active_item['value']);
+ if ($filter) {
+ $this->addFacetFilter($date_query, $field, $filter, $query);
+ }
+ }
+ $query->filter($date_query);
+ }
+ }
+
+ /**
+ * Rewrites the handler-specific date range syntax to the normal facet syntax.
+ *
+ * @param string $value
+ * The user-facing facet value.
+ *
+ * @return string|null
+ * A facet to add as a filter, in the format used internally in this module.
+ * Or NULL if the raw facet in $value is not valid.
+ */
+ protected function createRangeFilter($value) {
+ // Ignore any filters passed directly from the server (range or missing).
+ if (!$value || $value == '!' || (!ctype_digit($value[0]) && preg_match('/^[\[(][^ ]+ TO [^ ]+[\])]$/', $value))) {
+ return $value ? $value : NULL;
+ }
+
+ // Parse into date parts.
+ $parts = $this->parseRangeFilter($value);
+
+ // Return NULL if the date parts are invalid or none were found.
+ if (empty($parts)) {
+ return NULL;
+ }
+
+ $date = new DateTime();
+ switch (count($parts)) {
+ case 1:
+ $date->setDate($parts[0], 1, 1);
+ $date->setTime(0, 0, 0);
+ $lower = $date->format('U');
+ $date->setDate($parts[0] + 1, 1, 1);
+ $date->setTime(0, 0, -1);
+ $upper = $date->format('U');
+ break;
+
+ case 2:
+ // Luckily, $month = 13 is treated as January of next year. (The same
+ // goes for all other parameters.) We use the inverse trick for the
+ // seconds of the upper bound, since that's inclusive and we want to
+ // stop at a second before the next segment starts.
+ $date->setDate($parts[0], $parts[1], 1);
+ $date->setTime(0, 0, 0);
+ $lower = $date->format('U');
+ $date->setDate($parts[0], $parts[1] + 1, 1);
+ $date->setTime(0, 0, -1);
+ $upper = $date->format('U');
+ break;
+
+ case 3:
+ $date->setDate($parts[0], $parts[1], $parts[2]);
+ $date->setTime(0, 0, 0);
+ $lower = $date->format('U');
+ $date->setDate($parts[0], $parts[1], $parts[2] + 1);
+ $date->setTime(0, 0, -1);
+ $upper = $date->format('U');
+ break;
+
+ case 4:
+ $date->setDate($parts[0], $parts[1], $parts[2]);
+ $date->setTime($parts[3], 0, 0);
+ $lower = $date->format('U');
+ $date->setTime($parts[3] + 1, 0, -1);
+ $upper = $date->format('U');
+ break;
+
+ case 5:
+ $date->setDate($parts[0], $parts[1], $parts[2]);
+ $date->setTime($parts[3], $parts[4], 0);
+ $lower = $date->format('U');
+ $date->setTime($parts[3], $parts[4] + 1, -1);
+ $upper = $date->format('U');
+ break;
+
+ case 6:
+ $date->setDate($parts[0], $parts[1], $parts[2]);
+ $date->setTime($parts[3], $parts[4], $parts[5]);
+ return $date->format('U');
+
+ default:
+ return $value;
+ }
+
+ return "[$lower TO $upper]";
+ }
+
+ /**
+ * Parses the date range filter value into parts.
+ *
+ * @param string $value
+ * The user-facing facet value.
+ *
+ * @return int[]|null
+ * An array of date parts, or NULL if an invalid value was provided.
+ */
+ protected static function parseRangeFilter($value) {
+ $parts = explode('-', $value);
+
+ foreach ($parts as $i => $part) {
+ // Invalidate if part is not an integer.
+ if ($part === '' || !is_numeric($part) || intval($part) != $part) {
+ return NULL;
+ }
+ $parts[$i] = (int) $part;
+ // Depending on the position, negative numbers or 0 are invalid.
+ switch ($i) {
+ case 0:
+ // Years can contain anything – negative values are unlikely, but
+ // technically possible.
+ break;
+ case 1:
+ case 2:
+ // Days and months have to be positive.
+ if ($part <= 0) {
+ return NULL;
+ }
+ break;
+ default:
+ // All others can be 0, but not negative.
+ if ($part < 0) {
+ return NULL;
+ }
+ }
+ }
+
+ return $parts;
+ }
+
+ /**
+ * Replacement callback for replacing ISO dates with timestamps.
+ *
+ * Not used anymore, but kept for backwards compatibility with potential
+ * subclasses.
+ */
+ public function replaceDateString($matches) {
+ return strtotime($matches[0]);
+ }
+
+ /**
+ * Initializes the facet's build array.
+ *
+ * @return array
+ * The initialized render array.
+ */
+ public function build() {
+ $facet = $this->adapter->getFacet($this->facet);
+ $search_ids = backdrop_static('search_api_facetapi_active_facets', array());
+ $facet_key = $facet['name'] . '@' . $this->adapter->getSearcher();
+ if (empty($search_ids[$facet_key]) || !search_api_current_search($search_ids[$facet_key])) {
+ return array();
+ }
+ $search_id = $search_ids[$facet_key];
+ $build = array();
+ $search = search_api_current_search($search_id);
+ $results = $search[1];
+ // Gets total number of documents matched in search.
+ $total = $results['result count'];
+
+ // Executes query, iterates over results.
+ if (isset($results['search_api_facets']) && isset($results['search_api_facets'][$this->facet['name']])) {
+ $values = $results['search_api_facets'][$this->facet['name']];
+ $mincount = $facet->getSettings()->settings['facet_mincount'];
+ foreach ($values as $value) {
+ if ($value['count'] >= $mincount) {
+ $filter = $value['filter'];
+ // We only process single values further. The "missing" filter and
+ // range filters will be passed on unchanged.
+ if ($filter == '!') {
+ $build[$filter]['#count'] = $value['count'];
+ }
+ elseif ($filter[0] == '"') {
+ $filter = substr($value['filter'], 1, -1);
+ if ($filter) {
+ $raw_values[$filter] = $value['count'];
+ }
+ }
+ else {
+ $build[$filter]['#count'] = $value['count'];
+ }
+ }
+ }
+ }
+
+ $settings = $facet->getSettings()->settings;
+
+ // Get the finest level of detail we're allowed to drill down to.
+ $max_granularity = FACETAPI_DATE_MINUTE;
+ if (isset($settings['date_granularity'])) {
+ $max_granularity = $settings['date_granularity'];
+ }
+
+ // Get the coarsest level of detail we're allowed to start at.
+ $min_granularity = FACETAPI_DATE_YEAR;
+ if (isset($settings['date_granularity_min'])) {
+ $min_granularity = $settings['date_granularity_min'];
+ }
+
+ // Gets active facets, starts building hierarchy.
+ $parent = $granularity = NULL;
+ $active_items = $this->adapter->getActiveItems($this->facet);
+ foreach ($active_items as $value => $item) {
+ // If the item is active, the count is the result set count.
+ $build[$value] = array('#count' => $total);
+
+ // Gets next "gap" increment. Ignore any filters passed directly from the
+ // server (range or missing). We always create filters starting with a
+ // year.
+ $value = "$value";
+ if (!$value || !ctype_digit($value[0])) {
+ continue;
+ }
+
+ $granularity = search_api_facetapi_date_get_granularity($value);
+ if (!$granularity) {
+ continue;
+ }
+ $granularity = facetapi_get_next_date_gap($granularity, $max_granularity);
+
+ // If there is a previous item, there is a parent, uses a reference so the
+ // arrays are populated when they are updated.
+ if (NULL !== $parent) {
+ $build[$parent]['#item_children'][$value] = &$build[$value];
+ $build[$value]['#item_parents'][$parent] = $parent;
+ }
+ }
+
+ if (empty($raw_values)) {
+ return $build;
+ }
+ ksort($raw_values);
+
+ // Mind the gap! Calculates gap from min and max timestamps.
+ $timestamps = array_keys($raw_values);
+ if (NULL === $parent) {
+ if (count($raw_values) > 1) {
+ $granularity = facetapi_get_timestamp_gap(min($timestamps), max($timestamps), $max_granularity);
+ // Array of numbers used to determine whether the next gap is smaller than
+ // the minimum gap allowed in the drilldown.
+ $gap_numbers = array(
+ FACETAPI_DATE_YEAR => 6,
+ FACETAPI_DATE_MONTH => 5,
+ FACETAPI_DATE_DAY => 4,
+ FACETAPI_DATE_HOUR => 3,
+ FACETAPI_DATE_MINUTE => 2,
+ FACETAPI_DATE_SECOND => 1,
+ );
+ // Gets gap numbers for both the gap, minimum and maximum gap, checks if
+ // the gap is within the limit set by the $granularity parameters.
+ if ($gap_numbers[$granularity] < $gap_numbers[$max_granularity]) {
+ $granularity = $max_granularity;
+ }
+ if ($gap_numbers[$granularity] > $gap_numbers[$min_granularity]) {
+ $granularity = $min_granularity;
+ }
+ }
+ else {
+ $granularity = $max_granularity;
+ }
+ }
+
+ // Groups dates by the range they belong to, builds the $build array with
+ // the facet counts and formatted range values.
+ $format = search_api_facetapi_date_get_granularity_format($granularity);
+ foreach ($raw_values as $value => $count) {
+ $new_value = date($format, $value);
+ if (!isset($build[$new_value])) {
+ $build[$new_value] = array('#count' => $count);
+ }
+ // Active items already have their value set because it's the current
+ // result count.
+ elseif (!isset($active_items[$new_value])) {
+ $build[$new_value]['#count'] += $count;
+ }
+
+ // Adds parent information if not already set.
+ if (NULL !== $parent && $parent != $new_value) {
+ $build[$parent]['#item_children'][$new_value] = &$build[$new_value];
+ $build[$new_value]['#item_parents'][$parent] = $parent;
+ }
+ }
+
+ return $build;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_facetapi/plugins/facetapi/query_type_term.inc b/www/modules/contrib/search_api/contrib/search_api_facetapi/plugins/facetapi/query_type_term.inc
new file mode 100644
index 000000000..fbcded82b
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_facetapi/plugins/facetapi/query_type_term.inc
@@ -0,0 +1,241 @@
+adapter->addFacet($this->facet, $query);
+
+ $settings = $this->getSettings()->settings;
+
+ // First check if the facet is enabled for this search.
+ $default_true = isset($settings['default_true']) ? $settings['default_true'] : TRUE;
+ $facet_search_ids = isset($settings['facet_search_ids']) ? $settings['facet_search_ids'] : array();
+ if ($default_true != empty($facet_search_ids[$query->getOption('search id')])) {
+ // Facet is not enabled for this search ID.
+ return;
+ }
+
+ // Retrieve the active facet filters.
+ $active = $this->adapter->getActiveItems($this->facet);
+ if (empty($active)) {
+ return;
+ }
+
+ // Create the facet filter, and add a tag to it so that it can be easily
+ // identified down the line by services when they need to exclude facets.
+ $operator = $settings['operator'];
+ if ($operator == FACETAPI_OPERATOR_AND) {
+ $conjunction = 'AND';
+ }
+ elseif ($operator == FACETAPI_OPERATOR_OR) {
+ $conjunction = 'OR';
+ // When the operator is OR, remove parent terms from the active ones if
+ // children are active. If we don't do this, sending a term and its
+ // parent will produce the same results as just sending the parent.
+ if (is_callable($this->facet['hierarchy callback']) && !$settings['flatten']) {
+ // Check the filters in reverse order, to avoid checking parents that
+ // will afterwards be removed anyways.
+ $values = array_keys($active);
+ $parents = call_user_func($this->facet['hierarchy callback'], $values);
+ foreach (array_reverse($values) as $filter) {
+ // Skip this filter if it was already removed, or if it is the
+ // "missing value" filter ("!").
+ if (!isset($active[$filter]) || $filter == '!') {
+ continue;
+ }
+ // Go through the entire hierarchy of the value and remove all its
+ // ancestors.
+ while (!empty($parents[$filter])) {
+ $ancestor = array_shift($parents[$filter]);
+ if (isset($active[$ancestor])) {
+ unset($active[$ancestor]);
+ if (!empty($parents[$ancestor])) {
+ $parents[$filter] = array_merge($parents[$filter], $parents[$ancestor]);
+ }
+ }
+ }
+ }
+ }
+ }
+ else {
+ $vars = array(
+ '%operator' => $operator,
+ '%facet' => !empty($this->facet['label']) ? $this->facet['label'] : $this->facet['name'],
+ );
+ watchdog('search_api_facetapi', 'Unknown facet operator %operator used for facet %facet.', $vars, WATCHDOG_WARNING);
+ return;
+ }
+ $tags = array('facet:' . $this->facet['field']);
+ $facet_filter = $query->createFilter($conjunction, $tags);
+
+ foreach ($active as $filter => $filter_array) {
+ $field = $this->facet['field'];
+ $this->addFacetFilter($facet_filter, $field, $filter, $query);
+ }
+
+ // Now add the filter to the query.
+ $query->filter($facet_filter);
+ }
+
+ /**
+ * Helper method for setting a facet filter on a query or query filter object.
+ *
+ * @param SearchApiQueryInterface|SearchApiQueryFilterInterface $query_filter
+ * The query or filter to which apply the filter.
+ * @param string $field
+ * The field to apply the filter to.
+ * @param string $filter
+ * The filter, in the internal string representation used by this module.
+ * @param SearchApiQuery|null $query
+ * (optional) If available, the search query object should be passed as the
+ * fourth parameter.
+ */
+ protected function addFacetFilter($query_filter, $field, $filter) {
+ // Test if this filter should be negated.
+ $settings = $this->adapter->getFacet($this->facet)->getSettings();
+ $exclude = !empty($settings->settings['exclude']);
+ // Integer (or other non-string) filters might mess up some of the following
+ // comparison expressions.
+ $filter = (string) $filter;
+ if ($filter == '!') {
+ $query_filter->condition($field, NULL, $exclude ? '<>' : '=');
+ }
+ elseif ($filter && $filter[0] == '[' && $filter[strlen($filter) - 1] == ']' && ($pos = strpos($filter, ' TO '))) {
+ $lower = trim(substr($filter, 1, $pos));
+ $upper = trim(substr($filter, $pos + 4, -1));
+ $supports_between = FALSE;
+ if (func_num_args() > 3) {
+ $query = func_get_arg(3);
+ if ($query instanceof SearchApiQuery) {
+ try {
+ $supports_between = $query->getIndex()->server()
+ ->supportsFeature('search_api_between');
+ }
+ catch (SearchApiException $e) {
+ // Ignore, really not that important (and rather unlikely).
+ }
+ }
+ }
+ if ($lower == '*' && $upper == '*') {
+ $query_filter->condition($field, NULL, $exclude ? '=' : '<>');
+ }
+ elseif ($supports_between && $lower != '*' && $upper != '*') {
+ $operator = $exclude ? 'NOT BETWEEN' : 'BETWEEN';
+ $query_filter->condition($field, array($lower, $upper), $operator);
+ }
+ elseif (!$exclude) {
+ if ($lower != '*') {
+ // Iff we have a range with two finite boundaries, we set two
+ // conditions (larger than the lower bound and less than the upper
+ // bound) and therefore have to make sure that we have an AND
+ // conjunction for those.
+ if ($upper != '*' && !($query_filter instanceof SearchApiQueryInterface || $query_filter->getConjunction() === 'AND')) {
+ $original_query_filter = $query_filter;
+ $query_filter = new SearchApiQueryFilter('AND');
+ }
+ $query_filter->condition($field, $lower, '>=');
+ }
+ if ($upper != '*') {
+ $query_filter->condition($field, $upper, '<=');
+ }
+ }
+ else {
+ // Same as above, but with inverted logic.
+ if ($lower != '*') {
+ if ($upper != '*' && ($query_filter instanceof SearchApiQueryInterface || $query_filter->getConjunction() === 'AND')) {
+ $original_query_filter = $query_filter;
+ $query_filter = new SearchApiQueryFilter('OR');
+ }
+ $query_filter->condition($field, $lower, '<');
+ }
+ if ($upper != '*') {
+ $query_filter->condition($field, $upper, '>');
+ }
+ }
+ }
+ else {
+ $query_filter->condition($field, $filter, $exclude ? '<>' : '=');
+ }
+ if (isset($original_query_filter)) {
+ $original_query_filter->filter($query_filter);
+ }
+ }
+
+ /**
+ * Initializes the facet's build array.
+ *
+ * @return array
+ * The initialized render array.
+ */
+ public function build() {
+ $facet = $this->adapter->getFacet($this->facet);
+ // The current search per facet is stored in a static variable (during
+ // initActiveFilters) so that we can retrieve it here and get the correct
+ // current search for this facet.
+ $search_ids = backdrop_static('search_api_facetapi_active_facets', array());
+ $facet_key = $facet['name'] . '@' . $this->adapter->getSearcher();
+ if (empty($search_ids[$facet_key]) || !search_api_current_search($search_ids[$facet_key])) {
+ return array();
+ }
+ $search_id = $search_ids[$facet_key];
+ list(, $results) = search_api_current_search($search_id);
+ $build = array();
+
+ // Always include the active facet items.
+ foreach ($this->adapter->getActiveItems($this->facet) as $filter) {
+ $build[$filter['value']]['#count'] = 0;
+ }
+
+ // Then, add the facets returned by the server.
+ if (isset($results['search_api_facets']) && isset($results['search_api_facets'][$this->facet['name']])) {
+ $values = $results['search_api_facets'][$this->facet['name']];
+ foreach ($values as $value) {
+ $filter = $value['filter'];
+ // As Facet API isn't really suited for our native facet filter
+ // representations, convert the format here. (The missing facet can
+ // stay the same.)
+ if ($filter[0] == '"') {
+ $filter = substr($filter, 1, -1);
+ }
+ elseif ($filter != '!') {
+ // This is a range filter.
+ $filter = substr($filter, 1, -1);
+ $pos = strpos($filter, ' ');
+ if ($pos !== FALSE) {
+ $filter = '[' . substr($filter, 0, $pos) . ' TO ' . substr($filter, $pos + 1) . ']';
+ }
+ }
+ $build[$filter] = array(
+ '#count' => $value['count'],
+ );
+ }
+ }
+ return $build;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.api.php b/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.api.php
new file mode 100644
index 000000000..eb5c890c6
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.api.php
@@ -0,0 +1,31 @@
+delete();
+ _search_api_facetapi_set_date_formats();
+}
+
+/**
+ * Helper to ensure the custom date formats exist.
+ */
+function _search_api_facetapi_set_date_formats($action = 'set') {
+ include_once BACKDROP_ROOT . '/core/includes/update.inc';
+ $save_needed = FALSE;
+ $date_config = config('system.date');
+ $defaults = array(
+ 'module' => 'search_api_facetapi',
+ );
+ $date_config_formats = $date_config->get('formats');
+ $date_formats = array(
+ FACETAPI_DATE_YEAR => array(
+ 'label' => t('Search facets - Years'),
+ 'pattern' => 'Y',
+ ) + $defaults,
+ FACETAPI_DATE_MONTH => array(
+ 'label' => t('Search facets - Months'),
+ 'pattern' => 'F Y',
+ ) + $defaults,
+ FACETAPI_DATE_DAY => array(
+ 'label' => t('Search facets - Days'),
+ 'pattern' => 'F j, Y',
+ ) + $defaults,
+ FACETAPI_DATE_HOUR => array(
+ 'label' => t('Search facets - Hours'),
+ 'pattern' => 'H:__',
+ ) + $defaults,
+ FACETAPI_DATE_MINUTE => array(
+ 'label' => t('Search facets - Minutes'),
+ 'pattern' => 'H:i',
+ ) + $defaults,
+ FACETAPI_DATE_SECOND => array(
+ 'label' => t('Search facets - Seconds'),
+ 'pattern' => 'H:i:s',
+ ) + $defaults,
+ );
+ foreach ($date_formats as $type => $format) {
+ $type = strtolower($type);
+ if ($action == 'set' && empty($date_config_formats['search_api_facetapi_' . $type])) {
+ $format['pattern'] = update_variable_get('search_api_facetapi_' . $type, $format['pattern']);
+ $date_config->set('formats.search_api_facetapi_' . $type, $format);
+ $save_needed = TRUE;
+ }
+ elseif ($action == 'unset') {
+ $date_config->clear('formats.search_api_facetapi_' . $type);
+ $save_needed = TRUE;
+ }
+ }
+ if ($save_needed) {
+ $date_config->save();
+ }
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.module b/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.module
new file mode 100644
index 000000000..894cb8640
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.module
@@ -0,0 +1,677 @@
+ $realm) {
+ if ($first) {
+ $first = FALSE;
+ $items['admin/config/search/search_api/index/%search_api_index/facets'] = array(
+ 'title' => 'Facets',
+ 'page callback' => 'search_api_facetapi_settings',
+ 'page arguments' => array($realm_name, 5),
+ 'weight' => -1,
+ 'access arguments' => array('administer search_api'),
+ 'type' => MENU_LOCAL_TASK,
+ 'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
+ );
+ $items['admin/config/search/search_api/index/%search_api_index/facets/' . $realm_name] = array(
+ 'title' => $realm['label'],
+ 'type' => MENU_DEFAULT_LOCAL_TASK,
+ 'weight' => $realm['weight'],
+ );
+ }
+ else {
+ $items['admin/config/search/search_api/index/%search_api_index/facets/' . $realm_name] = array(
+ 'title' => $realm['label'],
+ 'page callback' => 'search_api_facetapi_settings',
+ 'page arguments' => array($realm_name, 5),
+ 'access arguments' => array('administer search_api'),
+ 'type' => MENU_LOCAL_TASK,
+ 'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
+ 'weight' => $realm['weight'],
+ );
+ }
+ }
+
+ return $items;
+}
+
+/**
+ * Implements hook_facetapi_searcher_info().
+ */
+function search_api_facetapi_facetapi_searcher_info() {
+ $info = array();
+ $indexes = search_api_index_load_multiple(FALSE);
+ foreach ($indexes as $index) {
+ if (_search_api_facetapi_index_support_feature($index)) {
+ $searcher_name = 'search_api@' . $index->machine_name;
+ $info[$searcher_name] = array(
+ 'label' => t('Search service: @name', array('@name' => $index->name)),
+ 'adapter' => 'search_api',
+ 'instance' => $index->machine_name,
+ 'types' => array($index->item_type),
+ 'path' => '',
+ 'supports facet missing' => TRUE,
+ 'supports facet mincount' => TRUE,
+ 'include default facets' => FALSE,
+ );
+ if (($entity_type = $index->getEntityType()) && $entity_type !== $index->item_type) {
+ $info[$searcher_name]['types'][] = $entity_type;
+ }
+ }
+ }
+ return $info;
+}
+
+/**
+ * Implements hook_facetapi_facet_info().
+ */
+function search_api_facetapi_facetapi_facet_info(array $searcher_info) {
+ $facet_info = array();
+ if ('search_api' == $searcher_info['adapter']) {
+ $index = search_api_index_load($searcher_info['instance']);
+ if (!empty($index->options['fields'])) {
+ $wrapper = $index->entityWrapper();
+ $bundle_key = NULL;
+ if ($index->getEntityType() && ($entity_info = entity_get_info($index->getEntityType())) && !empty($entity_info['bundle keys']['bundle'])) {
+ $bundle_key = $entity_info['bundle keys']['bundle'];
+ }
+
+ // Some type-specific settings. Allowing to set some additional callbacks
+ // (and other settings) in the map options allows for easier overriding by
+ // other modules.
+ $type_settings = array(
+ 'taxonomy_term' => array(
+ 'hierarchy callback' => 'search_api_facetapi_get_taxonomy_hierarchy',
+ ),
+ 'date' => array(
+ 'query type' => 'date',
+ 'map options' => array(
+ 'map callback' => 'search_api_facetapi_map_date',
+ ),
+ ),
+ );
+
+ // Iterate through the indexed fields to set the facetapi settings for
+ // each one.
+ foreach ($index->getFields() as $key => $field) {
+ $field['key'] = $key;
+ // Determine which, if any, of the field type-specific options will be
+ // used for this field.
+ if (isset($field['entity_type'])) {
+ $type = $inner_type = $field['entity_type'];
+ }
+ else {
+ $type = $field['type'];
+ $inner_type = search_api_extract_inner_type($type);
+ }
+ $type_settings += array($inner_type => array());
+
+ $facet_info[$key] = $type_settings[$inner_type] + array(
+ 'label' => $field['name'],
+ 'description' => t('Filter by @type.', array('@type' => $field['name'])),
+ 'allowed operators' => array(
+ FACETAPI_OPERATOR_AND => TRUE,
+ FACETAPI_OPERATOR_OR => _search_api_facetapi_index_support_feature($index, 'search_api_facets_operator_or'),
+ ),
+ 'dependency plugins' => array('role'),
+ 'facet missing allowed' => TRUE,
+ 'facet mincount allowed' => TRUE,
+ 'map callback' => 'search_api_facetapi_facet_map_callback',
+ 'map options' => array(),
+ 'field type' => $type,
+ );
+ if ($inner_type === 'date') {
+ $facet_info[$key]['description'] .= ' ' . t('(Caution: This may perform very poorly for large result sets.)');
+ }
+ $facet_info[$key]['map options'] += array(
+ 'field' => $field,
+ 'index id' => $index->machine_name,
+ 'value callback' => '_search_api_facetapi_facet_create_label',
+ );
+ // Find out whether this property is a Field API field.
+ if (strpos($key, ':') === FALSE) {
+ if (isset($wrapper->$key)) {
+ $property_info = $wrapper->$key->info();
+ if (!empty($property_info['field'])) {
+ $facet_info[$key]['field api name'] = $key;
+ }
+ }
+ }
+
+ // Add bundle information, if applicable.
+ if ($bundle_key) {
+ if ($key === $bundle_key) {
+ // Set entity type this field contains bundle information for.
+ $facet_info[$key]['field api bundles'][] = $index->getEntityType();
+ }
+ else {
+ // Add "bundle" as possible dependency plugin.
+ $facet_info[$key]['dependency plugins'][] = 'bundle';
+ }
+ }
+ }
+ }
+ }
+ return $facet_info;
+}
+
+/**
+ * Implements hook_facetapi_adapters().
+ */
+function search_api_facetapi_facetapi_adapters() {
+ return array(
+ 'search_api' => array(
+ 'handler' => array(
+ 'class' => 'SearchApiFacetapiAdapter',
+ ),
+ ),
+ );
+}
+
+/**
+ * Implements hook_facetapi_query_types().
+ */
+function search_api_facetapi_facetapi_query_types() {
+ return array(
+ 'search_api_term' => array(
+ 'handler' => array(
+ 'class' => 'SearchApiFacetapiTerm',
+ 'adapter' => 'search_api',
+ ),
+ ),
+ 'search_api_date' => array(
+ 'handler' => array(
+ 'class' => 'SearchApiFacetapiDate',
+ 'adapter' => 'search_api',
+ ),
+ ),
+ );
+}
+
+/**
+ * Implements hook_search_api_query_alter().
+ *
+ * Adds Facet API support to the query.
+ */
+function search_api_facetapi_search_api_query_alter($query) {
+ $index = $query->getIndex();
+ if ($index->server()->supportsFeature('search_api_facets')) {
+ // This is the main point of communication between the facet system and the
+ // search back-end - it makes the query respond to active facets.
+ search_api_facetapi_current_search_path($query);
+ $searcher = 'search_api@' . $index->machine_name;
+ $adapter = facetapi_adapter_load($searcher);
+ if ($adapter) {
+ $adapter->addActiveFilters($query);
+ }
+ }
+}
+
+/**
+ * Helper function that statically stores the Search API's base path. Can
+ * either be used to store or retrieve the base path.
+ *
+ * This static store is used in SearchApiFacetapiAdapter::getSearchPath() in
+ * order to retrieve the current search base path. Just relying on
+ * search_api_current_search() to retrieve the current query is not enough, as
+ * the path might be requested before the query is finally executed and stored.
+ *
+ * @param SearchApiQueryInterface $query
+ * When storing the base base, the query that is executed. Else NULL.
+ *
+ * @return
+ * The Search API's base path.
+ */
+function search_api_facetapi_current_search_path(SearchApiQueryInterface $query = NULL) {
+ $path = &backdrop_static(__FUNCTION__, '');
+ if ($query && $query->getOption('search_api_base_path')) {
+ $path = $query->getOption('search_api_base_path');
+ }
+ // If the path has not been set (yet), return the current path as a fallback.
+ return $path ? $path : current_path();
+}
+
+/**
+ * Menu callback for the facet settings page.
+ */
+function search_api_facetapi_settings($realm_name, SearchApiIndex $index) {
+ if (!$index->enabled) {
+ return array('#markup' => t('Since this index is at the moment disabled, no facets can be activated.'));
+ }
+ if (!_search_api_facetapi_index_support_feature($index)) {
+ return array('#markup' => t('This index uses a server that does not support facet functionality.'));
+ }
+ $searcher_name = 'search_api@' . $index->machine_name;
+ module_load_include('inc', 'facetapi', 'facetapi.admin');
+ return backdrop_get_form('facetapi_realm_settings_form', $searcher_name, $realm_name);
+}
+
+/**
+ * Checks whether a certain feature is supported for an index.
+ *
+ * @param SearchApiIndex $index
+ * The search index which should be checked.
+ * @param string $feature
+ * (optional) The feature to check for. Defaults to "search_api_facets".
+ *
+ * @return bool
+ * TRUE if the feature is supported by the index's server (and the index is
+ * currently enabled), FALSE otherwise.
+ */
+function _search_api_facetapi_index_support_feature(SearchApiIndex $index, $feature = 'search_api_facets') {
+ try {
+ $server = $index->server();
+ return $server && $server->supportsFeature($feature);
+ }
+ catch (SearchApiException $e) {
+ return FALSE;
+ }
+}
+
+/**
+ * Gets hierarchy information for taxonomy terms.
+ *
+ * Used as a hierarchy callback in search_api_facetapi_facetapi_facet_info().
+ *
+ * Internally just uses facetapi_get_taxonomy_hierarchy(), but makes sure that
+ * our special "!" value is not passed.
+ *
+ * @param array $values
+ * An array containing the term IDs.
+ *
+ * @return array
+ * An associative array mapping term IDs to parent IDs (where parents could be
+ * found).
+ */
+function search_api_facetapi_get_taxonomy_hierarchy(array $values) {
+ $values = array_filter($values, 'is_numeric');
+ return $values ? facetapi_get_taxonomy_hierarchy($values) : array();
+}
+
+/**
+ * Map callback for all search_api facet fields.
+ *
+ * @param array $values
+ * The values to map.
+ * @param array $options
+ * An associative array containing:
+ * - field: Field information, as stored in the index, but with an additional
+ * "key" property set to the field's internal name.
+ * - index id: The machine name of the index for this facet.
+ * - map callback: (optional) A callback that will be called at the beginning,
+ * which allows initial mapping of filters. Only values not mapped by that
+ * callback will be processed by this method.
+ * - value callback: A callback used to map single values and the limits of
+ * ranges. The signature is the same as for this function, but all values
+ * will be single values.
+ * - missing label: (optional) The label used for the "missing" facet.
+ *
+ * @return array
+ * An array mapping raw filter values to their labels.
+ */
+function search_api_facetapi_facet_map_callback(array $values, array $options = array()) {
+ $map = array();
+ // See if we have an additional map callback.
+ if (isset($options['map callback']) && is_callable($options['map callback'])) {
+ $map = call_user_func($options['map callback'], $values, $options);
+ }
+
+ // Then look at all unmapped values and save information for them.
+ $mappable_values = array();
+ $ranges = array();
+ foreach ($values as $value) {
+ $value = (string) $value;
+ if (isset($map[$value])) {
+ continue;
+ }
+ if ($value == '!') {
+ // The "missing" filter is usually always the same, but we allow an easy
+ // override via the "missing label" map option.
+ $map['!'] = isset($options['missing label']) ? $options['missing label'] : '(' . t('none') . ')';
+ continue;
+ }
+ $length = strlen($value);
+ if ($length > 5 && $value[0] == '[' && $value[$length - 1] == ']' && ($pos = strpos($value, ' TO '))) {
+ // This is a range filter.
+ $lower = trim(substr($value, 1, $pos));
+ $upper = trim(substr($value, $pos + 4, -1));
+ if ($lower != '*') {
+ $mappable_values[$lower] = TRUE;
+ }
+ if ($upper != '*') {
+ $mappable_values[$upper] = TRUE;
+ }
+ $ranges[$value] = array(
+ 'lower' => $lower,
+ 'upper' => $upper,
+ );
+ }
+ else {
+ // A normal, single-value filter.
+ $mappable_values[$value] = TRUE;
+ }
+ }
+
+ if ($mappable_values) {
+ $map += call_user_func($options['value callback'], array_keys($mappable_values), $options);
+ }
+
+ foreach ($ranges as $value => $range) {
+ $lower = isset($map[$range['lower']]) ? $map[$range['lower']] : $range['lower'];
+ $upper = isset($map[$range['upper']]) ? $map[$range['upper']] : $range['upper'];
+ if ($lower == '*' && $upper == '*') {
+ $map[$value] = t('any');
+ }
+ elseif ($lower == '*') {
+ $map[$value] = "≤ $upper";
+ }
+ elseif ($upper == '*') {
+ $map[$value] = "≥ $lower";
+ }
+ else {
+ $map[$value] = "$lower – $upper";
+ }
+ }
+
+ return $map;
+}
+
+/**
+ * Creates a human-readable label for single facet filter values.
+ *
+ * @param array $values
+ * The values for which labels should be returned.
+ * @param array $options
+ * An associative array containing the following information about the facet:
+ * - field: Field information, as stored in the index, but with an additional
+ * "key" property set to the field's internal name.
+ * - index id: The machine name of the index for this facet.
+ * - map callback: (optional) A callback that will be called at the beginning,
+ * which allows initial mapping of filters. Only values not mapped by that
+ * callback will be processed by this method.
+ * - value callback: A callback used to map single values and the limits of
+ * ranges. The signature is the same as for this function, but all values
+ * will be single values.
+ * - missing label: (optional) The label used for the "missing" facet.
+ *
+ * @return array
+ * An array mapping raw facet values to their labels.
+ */
+function _search_api_facetapi_facet_create_label(array $values, array $options) {
+ $field = $options['field'];
+ $map = array();
+ $n = count($values);
+
+ // For entities, we can simply use the entity labels.
+ if (isset($field['entity_type'])) {
+ $type = $field['entity_type'];
+ $entities = entity_load_multiple($type, $values);
+ foreach ($entities as $id => $entity) {
+ $label = entity_label($type, $entity);
+ if ($label !== FALSE) {
+ $map[$id] = $label;
+ }
+ }
+ if (count($map) == $n) {
+ return $map;
+ }
+ }
+
+ // Then, we check whether there is an options list for the field.
+ $index = search_api_index_load($options['index id']);
+ $wrapper = $index->entityWrapper();
+ $values = backdrop_map_assoc($values);
+ foreach (explode(':', $field['key']) as $part) {
+ if (!isset($wrapper->$part)) {
+ $wrapper = NULL;
+ break;
+ }
+ $wrapper = $wrapper->$part;
+ while (($info = $wrapper->info()) && search_api_is_list_type($info['type'])) {
+ $wrapper = $wrapper[0];
+ }
+ }
+ if ($wrapper && ($options_list = $wrapper->optionsList('view'))) {
+ // We have no use for empty strings, as then the facet links would be
+ // invisible.
+ $map += array_intersect_key(array_filter($options_list, 'strlen'), $values);
+ if (count($map) == $n) {
+ return $map;
+ }
+ }
+
+ // As a "last resort" we try to create a label based on the field type, for
+ // all values that haven't got a mapping yet.
+ foreach (array_diff_key($values, $map) as $value) {
+ switch ($field['type']) {
+ case 'boolean':
+ $map[$value] = $value ? t('true') : t('false');
+ break;
+ case 'date':
+ $v = is_numeric($value) ? $value : strtotime($value);
+ $map[$value] = format_date($v, 'short');
+ break;
+ case 'duration':
+ $map[$value] = format_interval($value);
+ break;
+ }
+ }
+ return $map;
+}
+
+/**
+ * Implements hook_form_FORM_ID_alter().
+ */
+function search_api_facetapi_form_search_api_admin_index_fields_alter(&$form, &$form_state) {
+ $form['#submit'][] = 'search_api_facetapi_search_api_admin_index_fields_submit';
+}
+
+/**
+ * Form submission handler for search_api_admin_index_fields().
+ */
+function search_api_facetapi_search_api_admin_index_fields_submit($form, &$form_state) {
+ // Clears this searcher's cached facet definitions.
+ $cid = 'facetapi:facet_info:search_api@' . $form_state['index']->machine_name . ':';
+ cache_clear_all($cid, 'cache', TRUE);
+}
+
+/**
+ * Implements hook_form_FORM_ID_alter() for views_exposed_form().
+ *
+ * Custom integration for facets. When a Views exposed filter is modified on a
+ * search results page, any facets which have been already selected will be
+ * removed. This (optionally) adds hidden fields for each facet so their values
+ * are retained.
+ */
+function search_api_facetapi_form_views_exposed_form_alter(array &$form, array &$form_state) {
+ if (empty($form_state['view'])) {
+ return;
+ }
+ $view = $form_state['view'];
+
+ // Check if this is a Search API-based view and if the "Preserve facets"
+ // option is enabled. ("search_api_multi" would be the exact base table name,
+ // not just a prefix, but since it's just 16 characters long, we can still use
+ // this check to make the condition less complex.)
+ $base_table_prefix = substr($view->base_table, 0, 17);
+ if (in_array($base_table_prefix, array('search_api_index_', 'search_api_multi'))
+ && _search_api_preserve_views_facets($view)) {
+ // Get query parameters.
+ $query_parameters = backdrop_get_query_parameters();
+
+ // Check if any facet query parameters are provided.
+ if (!empty($query_parameters['f'])) {
+ // Iterate through facet query parameters.
+ foreach ($query_parameters['f'] as $key => $value) {
+ // Add hidden form field for facet parameter.
+ $form['f[' . $key . ']'] = array(
+ '#type' => 'hidden',
+ '#value' => $value,
+ '#weight' => -1,
+ );
+ }
+ }
+ }
+}
+
+/**
+ * Checks whether "Preserve facets" option is enabled on the given view.
+ *
+ * If the view display is overridden, use its configuration. Otherwise, use the
+ * default configuration.
+ *
+ * @param view $view
+ * The search view.
+ *
+* @return bool
+* TRUE if "Preserve facets" is enabled, FALSE otherwise.
+*/
+function _search_api_preserve_views_facets(view $view) {
+ $query_options = $view->display_handler->get_option('query');
+ return !empty($query_options['options']['preserve_facet_query_args']);
+}
+
+/**
+ * Computes the granularity of a date facet filter.
+ *
+ * @param $filter
+ * The filter value to examine.
+ *
+ * @return string|null
+ * Either one of the FACETAPI_DATE_* constants corresponding to the
+ * granularity of the filter, or NULL if it couldn't be computed.
+ */
+function search_api_facetapi_date_get_granularity($filter) {
+ // Granularity corresponds to number of dashes in filter value.
+ $units = array(
+ FACETAPI_DATE_YEAR,
+ FACETAPI_DATE_MONTH,
+ FACETAPI_DATE_DAY,
+ FACETAPI_DATE_HOUR,
+ FACETAPI_DATE_MINUTE,
+ FACETAPI_DATE_SECOND,
+ );
+ $count = substr_count($filter, '-');
+ return isset($units[$count]) ? $units[$count] : NULL;
+}
+
+/**
+ * Returns the date format used for a given granularity.
+ *
+ * @param $granularity
+ * One of the FACETAPI_DATE_* constants.
+ *
+ * @return string
+ * The date format used for the given granularity.
+ */
+function search_api_facetapi_date_get_granularity_format($granularity) {
+ $formats = array(
+ FACETAPI_DATE_YEAR => 'Y',
+ FACETAPI_DATE_MONTH => 'Y-m',
+ FACETAPI_DATE_DAY => 'Y-m-d',
+ FACETAPI_DATE_HOUR => 'Y-m-d-H',
+ FACETAPI_DATE_MINUTE => 'Y-m-d-H-i',
+ FACETAPI_DATE_SECOND => 'Y-m-d-H-i-s',
+ );
+ return $formats[$granularity];
+}
+
+/**
+ * Constructs labels for date facet filter values.
+ *
+ * @param array $values
+ * The date facet filter values, as used in URL parameters.
+ * @param array $options
+ * (optional) Options for creating the mapping. The following options are
+ * recognized:
+ * - format callback: A callback for creating a label for a timestamp. The
+ * function signature is like search_api_facetapi_format_timestamp(),
+ * receiving a timestamp and one of the FACETAPI_DATE_* constants as the
+ * parameters and returning a human-readable label.
+ *
+ * @return array
+ * An array of labels for the given facet filters.
+ */
+function search_api_facetapi_map_date(array $values, array $options = array()) {
+ $map = array();
+ foreach ($values as $value) {
+ // Ignore any filters passed directly from the server (range or missing). We
+ // always create filters starting with a year.
+ $value = "$value";
+ if (!$value || !ctype_digit($value[0])) {
+ continue;
+ }
+
+ // Get the granularity of the filter.
+ $granularity = search_api_facetapi_date_get_granularity($value);
+ if (!$granularity) {
+ continue;
+ }
+
+ // Otherwise, parse the timestamp from the known format and format it as a
+ // label.
+ $format = search_api_facetapi_date_get_granularity_format($granularity);
+ // Use the "!" modifier to make the date parsing independent of the current
+ // date/time. (See #2678856.)
+ $date = DateTime::createFromFormat('!' . $format, $value);
+ if (!$date) {
+ continue;
+ }
+ $format_callback = 'search_api_facetapi_format_timestamp';
+ if (!empty($options['format callback']) && is_callable($options['format callback'])) {
+ $format_callback = $options['format callback'];
+ }
+ $map[$value] = call_user_func($format_callback, $date->format('U'), $granularity);
+ }
+ return $map;
+}
+
+/**
+ * Format a date according to the default timezone and the given precision.
+ *
+ * @param int $timestamp
+ * An integer containing the Unix timestamp being formated.
+ * @param string $precision
+ * A string containing the formatting precision. See the FACETAPI_DATE_*
+ * constants for valid values.
+ *
+ * @return string
+ * A human-readable representation of the timestamp.
+ */
+function search_api_facetapi_format_timestamp($timestamp, $precision = FACETAPI_DATE_YEAR) {
+ $formats = array(
+ FACETAPI_DATE_YEAR,
+ FACETAPI_DATE_MONTH,
+ FACETAPI_DATE_DAY,
+ FACETAPI_DATE_HOUR,
+ FACETAPI_DATE_MINUTE,
+ FACETAPI_DATE_SECOND,
+ );
+
+ if (!in_array($precision, $formats)) {
+ $precision = FACETAPI_DATE_YEAR;
+ }
+ return format_date($timestamp, 'search_api_facetapi_' . strtolower($precision));
+}
+
+/**
+ * Implements hook_autoload_info().
+ */
+function search_api_facetapi_autoload_info() {
+ return array(
+ 'SearchApiFacetapiExampleService' => 'example_service.php',
+ 'SearchApiFacetapiAdapter' => 'plugins/facetapi/adapter.inc',
+ 'SearchApiFacetapiDate' => 'plugins/facetapi/query_type_date.inc',
+ 'SearchApiFacetapiTerm' => 'plugins/facetapi/query_type_term.inc',
+ );
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.tests.info b/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.tests.info
new file mode 100644
index 000000000..34d6985a6
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_facetapi/search_api_facetapi.tests.info
@@ -0,0 +1,5 @@
+
+; Added by Backdrop CMS packaging script on 2026-02-06
+project = search_api
+version = 1.x-1.29.5
+timestamp = 1770395528
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/README.md b/www/modules/contrib/search_api/contrib/search_api_multi/README.md
new file mode 100644
index 000000000..8149206aa
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/README.md
@@ -0,0 +1,30 @@
+# Search API: Multi-index searches
+
+This module allows you to create search queries on multiple indexes that lie on
+the same server. The only thing you'll need is a search service class that
+supports the "search_api_multi" feature. Currently, only the "Solr search"
+supports this.
+
+Information for users
+---------------------
+
+Enable the Search views (search_api_views) module along with this one to make
+instant use of the multi-index searching facilities. You'll get a new base table
+in Views for each server supporting the "search_api_multi" feature.
+You can then add filters, arguments, fields and sorts (although the last one
+might work rather poorly, depending on the sorted field and the implementation)
+from all enabled indexes on this server.
+
+- Issues
+
+If you find any bugs or shortcomings while using this module, please file an
+issue in the project's issue queue
+
+Information for developers
+--------------------------
+
+If you are the developer of a SearchApiServiceInterface implementation and want
+to support searches on multiple indexes with your service class, too, you'll
+have to support the "search_api_multi" feature by implementing the
+SearchApiMultiServiceInterface interface documented in
+search_api_multi.service.inc.
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/includes/search_api_multi.query.inc b/www/modules/contrib/search_api/contrib/search_api_multi/includes/search_api_multi.query.inc
new file mode 100644
index 000000000..2c6befa1f
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/includes/search_api_multi.query.inc
@@ -0,0 +1,1214 @@
+", "<", "<=", ">=", ">". They
+ * have the same semantics as the corresponding SQL operators.
+ * If $field is a fulltext field, $operator can only be "=" or "<>", which
+ * are in this case interpreted as "contains" or "doesn't contain",
+ * respectively.
+ * If $value is NULL, $operator also can only be "=" or "<>", meaning the
+ * field must have no or some value, respectively.
+ *
+ * @return SearchApiMultiQueryInterface
+ * The called object.
+ */
+ public function condition($field, $value, $operator = '=');
+
+ /**
+ * Add a sort directive to this search query.
+ *
+ * If no sort is manually set, the results will be sorted descending by
+ * relevance.
+ *
+ * How sorts on index-specific fields are handled may differ between service
+ * backends.
+ *
+ * @param string $field
+ * The field to sort by. The special fields 'search_api_relevance' (sort by
+ * relevance) and 'search_api_id' (sort by item id) may be used.
+ * @param string $order
+ * The order to sort items in - either 'ASC' or 'DESC'.
+ *
+ * @throws SearchApiException
+ * If the field is multi-valued or of a fulltext type.
+ *
+ * @return SearchApiMultiQueryInterface
+ * The called object.
+ */
+ public function sort($field, $order = 'ASC');
+
+ /**
+ * Adds a range of results to return. This will be saved in the query's
+ * options. If called without parameters, this will remove all range
+ * restrictions previously set.
+ *
+ * @param int|null $offset
+ * The zero-based offset of the first result returned.
+ * @param int|null $limit
+ * The number of results to return.
+ *
+ * @return SearchApiMultiQueryInterface
+ * The called object.
+ */
+ public function range($offset = NULL, $limit = NULL);
+
+ /**
+ * Executes this search query.
+ *
+ * @return array
+ * An associative array containing the search results. The following keys
+ * are standardized:
+ * - 'result count': The overall number of results for this query, without
+ * range restrictions. Might be approximated, for large numbers.
+ * - results: An array of results, ordered as specified. The array keys are
+ * arbitrary unique keys, values are arrays containing the following keys:
+ * - id: The item's ID.
+ * - index_id: The machine name of the index this item was found on.
+ * - score: A float measuring how well the item fits the search.
+ * - fields: (optional) If set, an array containing some field values
+ * already ready-to-use, keyed by their field identifiers (without index
+ * prefix). This allows search engines (or postprocessors) to store
+ * extracted fields so other modules don't have to extract them again.
+ * This fields should always be checked by modules that want to use
+ * field contents of the result items.
+ * - entity (optional): If set, the fully loaded result item. This field
+ * should always be used by modules using search results, to avoid
+ * duplicate item loads.
+ * - excerpt (optional): If set, an HTML text containing highlighted
+ * portions of the fulltext that match the query.
+ * - warnings: A numeric array of translated warning messages that may be
+ * displayed to the user.
+ * - ignored: A numeric array of search keys that were ignored for this
+ * search (e.g., because of being too short or stop words).
+ * - performance: An associative array with the time taken (as floats, in
+ * seconds) for specific parts of the search execution:
+ * - complete: The complete runtime of the query.
+ * - hooks: Hook invocations and other client-side preprocessing.
+ * - preprocessing: Preprocessing of the service class.
+ * - execution: The actual query to the search server, in whatever form.
+ * - postprocessing: Preparing the results for returning.
+ * Additional metadata may be returned in other keys. Only 'result count'
+ * and 'result' always have to be set, all other entries are optional.
+ */
+ public function execute();
+
+ /**
+ * Retrieves the searched indexes.
+ *
+ * @return SearchApiIndex[]
+ * An array of SearchApiIndex objects representing all indexes that will be
+ * used for this search, keyed by machine names.
+ */
+ public function getIndexes();
+
+ /**
+ * Retrieves the search keys.
+ *
+ * @return array|string|null
+ * This object's search keys - either a string or an array specifying a
+ * complex search expression.
+ * An array will contain a '#conjunction' key specifying the conjunction
+ * type, and search strings or nested expression arrays at numeric keys.
+ * Additionally, a '#negation' key might be present, which means – unless it
+ * maps to a FALSE value – that the search keys contained in that array
+ * should be negated, i.e. not be present in returned results.
+ */
+ public function &getKeys();
+
+ /**
+ * Retrieves the original, unprocessed search keys.
+ *
+ * @return array|string|null
+ * The unprocessed search keys, exactly as passed to this object. Has the
+ * same format as getKeys().
+ */
+ public function getOriginalKeys();
+
+ /**
+ * Retrieves the searched fulltext fields.
+ *
+ * @return array|null
+ * An array containing the fields that should be searched for the search
+ * keys.
+ */
+ public function &getFields();
+
+ /**
+ * Retrieves the query's filter object.
+ *
+ * @return SearchApiQueryFilterInterface
+ * This object's associated filter object.
+ */
+ public function getFilter();
+
+ /**
+ * Retrieves the set sorts.
+ *
+ * @return array
+ * An array specifying the sort order for this query. Array keys are the
+ * field names in order of importance, the values are the respective order
+ * in which to sort the results according to the field.
+ */
+ public function &getSort();
+
+ /**
+ * Retrieves a single option.
+ *
+ * @param string $name
+ * The name of an option.
+ * @param mixed $default
+ * The default in case the option isn't set.
+ *
+ * @return mixed
+ * The value of the option with the specified name, if set; $default
+ * otherwise.
+ */
+ public function getOption($name, $default = NULL);
+
+ /**
+ * Sets an option.
+ *
+ * @param string $name
+ * The name of an option.
+ * @param mixed $value
+ * The new value of the option.
+ *
+ * @return mixed
+ * The option's previous value.
+ */
+ public function setOption($name, $value);
+
+ /**
+ * Retrieves all options for this query.
+ *
+ * @return array
+ * An associative array of query options.
+ */
+ public function &getOptions();
+
+}
+
+/**
+ * Standard implementation of SearchApiMultiQueryInterface.
+ *
+ * If the search involves only a single server which supports the
+ * "search_api_multi" feature, the methods for this feature are used. Otherwise,
+ * generic code allows the searching of multiple indexes.
+ */
+class SearchApiMultiQuery implements SearchApiMultiQueryInterface {
+
+ /**
+ * All indexes which are used in this search.
+ *
+ * This is first loaded with all indexes, and only restricted to the used ones
+ * during preExecute().
+ *
+ * @var array
+ */
+ protected $indexes = array();
+
+ /**
+ * The indexes which are currently used in this search.
+ *
+ * This collects the index IDs (in the keys) of indexes as they are used in
+ * the search, so the appropriate ones can be kept in $this->indexes during
+ * preExecute().
+ *
+ * @var array
+ */
+ protected $used_indexes = array();
+
+ /**
+ * All indexes which are used in this search, ordered by their servers.
+ *
+ * The array contains server machine names mapped to an array of all their
+ * searched indexes.
+ *
+ * @var array
+ */
+ protected $servers = array();
+
+ /**
+ * The search keys. If NULL, this will be a filter-only search.
+ *
+ * @var mixed
+ */
+ protected $keys;
+
+ /**
+ * The unprocessed search keys, as passed to the keys() method.
+ *
+ * @var mixed
+ */
+ protected $orig_keys;
+
+ /**
+ * The fields that will be searched for the keys.
+ *
+ * @var array|null
+ */
+ protected $fields;
+
+ /**
+ * The fields that will be searched, grouped by index.
+ *
+ * @var array
+ */
+ protected $index_fields = array();
+
+ /**
+ * The search filter associated with this query.
+ *
+ * @var SearchApiQueryFilterInterface
+ */
+ protected $filter;
+
+ /**
+ * The sort associated with this query.
+ *
+ * @var array
+ */
+ protected $sort = array();
+
+ /**
+ * Search options configuring this query.
+ *
+ * @var array
+ */
+ protected $options;
+
+ /**
+ * Flag for whether preExecute() was already called for this query.
+ *
+ * @var bool
+ */
+ protected $pre_execute = FALSE;
+
+ /**
+ * {@inheritdoc}
+ */
+ public function __construct(array $options = array()) {
+ if (isset($options['parse mode'])) {
+ $modes = $this->parseModes();
+ if (!isset($modes[$options['parse mode']])) {
+ throw new SearchApiException(t('Unknown parse mode: @mode.', array('@mode' => $options['parse mode'])));
+ }
+ }
+ $this->options = $options + array(
+ 'conjunction' => 'AND',
+ 'parse mode' => 'terms',
+ 'filter class' => 'SearchApiQueryFilter',
+ 'search id' => __CLASS__,
+ );
+ $this->filter = $this->createFilter('AND');
+ $this->indexes = search_api_index_load_multiple(FALSE, array('enabled' => TRUE));
+ foreach ($this->indexes as $index_id => $index) {
+ $this->servers[$index->server][$index_id] = $index;
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function parseModes() {
+ $modes['direct'] = array(
+ 'name' => t('Direct query'),
+ 'description' => t("Don't parse the query, just hand it to the search server unaltered. Might fail if the query contains syntax errors in regard to the specific server's query syntax."),
+ );
+ $modes['single'] = array(
+ 'name' => t('Single term'),
+ 'description' => t('The query is interpreted as a single keyword, maybe containing spaces or special characters.'),
+ );
+ $modes['terms'] = array(
+ 'name' => t('Multiple terms'),
+ 'description' => t('The query is interpreted as multiple keywords seperated by spaces. Keywords containing spaces may be "quoted". Quoted keywords must still be seperated by spaces.'),
+ );
+ return $modes;
+ }
+
+ /**
+ * Parses the keys string according to a certain parse mode.
+ *
+ * @param string|array|null $keys
+ * The keys as passed to keys().
+ * @param string $mode
+ * The parse mode to use. Must be one of the keys from parseModes().
+ *
+ * @return string|array|null
+ * The parsed keys.
+ */
+ protected function parseKeys($keys, $mode) {
+ if ($keys == NULL || is_array($keys)) {
+ return $keys;
+ }
+ $keys = '' . $keys;
+ switch ($mode) {
+ case 'direct':
+ return $keys;
+
+ case 'single':
+ return array('#conjunction' => $this->options['conjunction'], $keys);
+
+ case 'terms':
+ $ret = explode(' ', $keys);
+ $ret['#conjunction'] = $this->options['conjunction'];
+ $quoted = FALSE;
+ $str = '';
+ foreach ($ret as $k => $v) {
+ if (!$v) {
+ continue;
+ }
+ if ($quoted) {
+ if ($v[backdrop_strlen($v) - 1] == '"') {
+ $v = substr($v, 0, -1);
+ $str .= ' ' . $v;
+ $ret[$k] = $str;
+ $quoted = FALSE;
+ }
+ else {
+ $str .= ' ' . $v;
+ unset($ret[$k]);
+ }
+ }
+ elseif ($v[0] == '"') {
+ $len = backdrop_strlen($v);
+ if ($len > 1 && $v[$len - 1] == '"') {
+ $ret[$k] = substr($v, 1, -1);
+ }
+ else {
+ $str = substr($v, 1);
+ $quoted = TRUE;
+ unset($ret[$k]);
+ }
+ }
+ }
+ if ($quoted) {
+ $ret[] = $str;
+ }
+ return array_filter($ret);
+
+ default:
+ throw new SearchApiException(t('Unrecognized parse mode %mode.', array('%mode' => $mode)));
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function createFilter($conjunction = 'AND', array $tags = array()) {
+ $filter_class = $this->options['filter class'];
+ return new $filter_class($conjunction, $tags);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function keys($keys = NULL) {
+ $this->orig_keys = $keys;
+ if (isset($keys)) {
+ $this->keys = $this->parseKeys($keys, $this->options['parse mode']);
+ }
+ else {
+ $this->keys = NULL;
+ }
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function fields($fields = NULL) {
+ $this->index_fields = array();
+ if ($fields) {
+ foreach ($fields as $spec) {
+ list($index_id, $field) = explode(':', $spec, 2);
+ $index = $this->indexes[$index_id];
+ if (empty($index->options['fields'][$field]) || !search_api_is_text_type($index->options['fields'][$field]['type'])) {
+ throw new SearchApiException(t('Trying to search on field @field which is no indexed fulltext field.', array('@field' => $field)));
+ }
+ $this->used_indexes[$index_id] = TRUE;
+ $this->index_fields[$index_id][] = $field;
+ }
+ }
+ $this->fields = $fields;
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function filter(SearchApiQueryFilterInterface $filter) {
+ $this->filter->filter($filter);
+ $indexes = $this->checkFilterIndexes($filter);
+ $this->used_indexes += $indexes;
+ // Since the filter is added with AND to the query, the query will be
+ // restricted to the indexes encountered within it.
+ $this->indexes = array_intersect_key($this->indexes, $indexes);
+ return $this;
+ }
+
+ /**
+ * Checks a filter object for filters on the used indexes.
+ *
+ * @param SearchApiQueryFilterInterface $filter
+ * The filter whose indexes should be added.
+ *
+ * @return array
+ * An array mapping the machine names of all indexes used in the filter to
+ * TRUE.
+ */
+ protected function checkFilterIndexes(SearchApiQueryFilterInterface $filter) {
+ $indexes = array();
+ // Remember all the indexes of fields used in any filters, so we can later
+ // restrict the search to only those. Also, restrict the search correctly if
+ // the "search_api_multi_index" field is used.
+ foreach ($filter->getFilters() as $f) {
+ if (is_array($f)) {
+ if ($f[0] == 'search_api_multi_index') {
+ if ($f[2] == '=') {
+ $indexes[$f[1]] = TRUE;
+ }
+ else {
+ foreach ($this->indexes as $id => $index) {
+ if ($id != $f[1]) {
+ $indexes[$id] = TRUE;
+ }
+ }
+ }
+ }
+ elseif ($f[2] != '<>' && strpos($f[0], ':')) {
+ list($index_id) = explode(':', $f[0], 2);
+ $indexes[$index_id] = TRUE;
+ }
+ }
+ else {
+ $indexes += $this->checkFilterIndexes($f);
+ }
+ }
+ return $indexes;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function condition($field, $value, $operator = '=') {
+ if ($field == 'search_api_multi_index') {
+ if ($operator == '=') {
+ if (isset($this->indexes[$value])) {
+ $this->indexes = array($value => $this->indexes[$value]);
+ }
+ else {
+ throw new SearchApiException(t('Trying to filter multi-index query on two indexes simultaneously.'));
+ }
+ }
+ else {
+ unset($this->indexes[$value]);
+ }
+ }
+ else {
+ $this->filter->condition($field, $value, $operator);
+ if ($operator != '<>' && strpos($field, ':')) {
+ list($index_id) = explode(':', $field, 2);
+ $this->used_indexes[$index_id] = TRUE;
+ }
+ }
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function sort($field, $order = 'ASC') {
+ if ($field != 'search_api_relevance' && $field != 'search_api_id') {
+ list($index_id, $f) = explode(':', $field, 2);
+ $index = $this->indexes[$index_id];
+ $fields = $index->options['fields'];
+ if (empty($fields[$f])) {
+ throw new SearchApiException(t('Trying to sort on unknown field @field.', array('@field' => $f)));
+ }
+ $type = $fields[$f]['type'];
+ if (search_api_is_list_type($type) || search_api_is_text_type($type)) {
+ throw new SearchApiException(t('Trying to sort on field @field of illegal type @type.', array(
+ '@field' => $f,
+ '@type' => $type,
+ )));
+ }
+ $this->used_indexes[$index_id] = TRUE;
+ }
+ $order = strtoupper(trim($order)) == 'DESC' ? 'DESC' : 'ASC';
+ $this->sort[$field] = $order;
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function range($offset = NULL, $limit = NULL) {
+ $this->options['offset'] = $offset;
+ $this->options['limit'] = $limit;
+ return $this;
+ }
+
+ /**
+ * Implements SearchApiMultiQueryInterface::execute().
+ *
+ * Uses a server's searchMultiple() method, where possible.
+ */
+ public final function execute() {
+ $start = microtime(TRUE);
+
+ // Call pre-execute hook.
+ $this->preExecute();
+
+ // Let modules alter the query.
+ backdrop_alter('search_api_multi_query', $this);
+
+ $pre_search = microtime(TRUE);
+
+ // Execute query.
+ if (count($this->servers) == 1) {
+ $server = search_api_server_load(key($this->servers));
+ if ($server && $server->supportsFeature('search_api_multi')) {
+ $response = $server->searchMultiple($this);
+ }
+ }
+ if (!isset($response)) {
+ $response = $this->searchMultiple();
+ }
+
+ $post_search = microtime(TRUE);
+
+ // Call post-execute hook.
+ $this->postExecute($response);
+
+ $end = microtime(TRUE);
+ $response['performance']['complete'] = $end - $start;
+ $response['performance']['hooks'] = $response['performance']['complete'] - ($post_search - $pre_search);
+
+ // Store search for later retrieval for facets, etc.
+ search_api_multi_current_search(NULL, $this, $response);
+
+ return $response;
+ }
+
+ /**
+ * Helper method for adding a language filter.
+ *
+ * @param array $languages
+ * The languages which the query should include.
+ */
+ protected function addLanguages(array $languages) {
+ if (array_search(LANGUAGE_NONE, $languages) === FALSE) {
+ $languages[] = LANGUAGE_NONE;
+ }
+
+ $filter = $this->createFilter('OR');
+ foreach ($languages as $lang) {
+ foreach ($this->indexes as $index_id => $index) {
+ $filter->condition("$index_id:search_api_language", $lang);
+ }
+ }
+ $this->filter($filter);
+ }
+
+ /**
+ * Searches multiple indexes with this query.
+ *
+ * Workaround if there is no server's searchMultiple() method available.
+ *
+ * @return array
+ * Search results as specified by SearchApiMultiQueryInterface::execute().
+ */
+ protected function searchMultiple() {
+ // Prepare options/range.
+ $options = $this->options;
+ if (!empty($options['offset']) || isset($options['limit'])) {
+ $options['limit'] = isset($options['limit']) ? $options['offset'] + $options['limit'] : NULL;
+ $options['offset'] = 0;
+ }
+ // Prepare a normal Search API query for all contained indexes.
+ /** @var SearchApiQuery[] $queries */
+ $queries = array();
+ foreach ($this->getIndexes() as $index_id => $index) {
+ try {
+ $queries[$index_id] = search_api_query($index_id, $options);
+ }
+ catch (SearchApiException $e) {
+ watchdog_exception('search_api_multi', $e);
+ }
+ }
+
+ // Set the filters appropriately.
+ $this->addFilters($this->filter->getFilters(), $queries, $queries);
+
+ // Prepare and execute the search on every index available.
+ foreach ($queries as $index_id => $query) {
+ if (isset($this->orig_keys)) {
+ if (empty($this->index_fields[$index_id])) {
+ continue;
+ }
+ $query->keys($this->orig_keys);
+ $query->fields($this->index_fields[$index_id]);
+ }
+ foreach ($this->sort as $field => $order) {
+ if (strpos($field, ':') !== FALSE) {
+ list($field_index_id, $field) = explode(':', $field, 2);
+ if ($field_index_id != $index_id) {
+ continue;
+ }
+ }
+ $query->sort($field, $order);
+ }
+
+ $response = $query->execute();
+
+ if (!empty($response['results'])) {
+ // Adapt the results array to the multi-index format.
+ $results = array();
+ foreach ($response['results'] as $key => $result) {
+ $key = "$index_id:$key";
+ $results[$key] = $result;
+ $results[$key]['index_id'] = $index_id;
+ }
+ $response['results'] = $results;
+ }
+
+ if (!isset($return)) {
+ $return = array(
+ 'result count' => 0,
+ 'results' => array(),
+ 'performance' => array(),
+ );
+ }
+
+ // Add the new result count.
+ $return['result count'] += $response['result count'];
+
+ // Merge results.
+ if (!empty($response['results'])) {
+ $return['results'] = array_merge($return['results'], $response['results']);
+ }
+
+ // Merge performance.
+ if (!empty($response['performance'])) {
+ foreach ($response['performance'] as $measure => $time) {
+ $return['performance'] += array($measure => 0);
+ $return['performance'][$measure] += $time;
+ }
+ }
+
+ // Merge any additional keys. We can only guess what to do here, but we
+ // opt to merge array-valued keys together, and store all other kinds of
+ // data in a new array keyed by index ID.
+ unset($response['result count'], $response['results'], $response['performance']);
+ foreach ($response as $key => $value) {
+ if (is_array($value)) {
+ $return[$key] = isset($return[$key]) ? array_merge($value, $return[$key]) : $value;
+ }
+ else {
+ $return[$key][$index_id] = $value;
+ }
+ }
+ }
+
+ if (isset($return)) {
+ if (!empty($return['results'])) {
+ // Add default sorting by score, if it isn't included already.
+ if ($this->keys && !isset($this->sort['search_api_relevance'])) {
+ $this->sort['search_api_relevance'] = 'DESC';
+ }
+ // Sort the results.
+ if ($this->sort) {
+ $this->ensureSortFields($return['results']);
+ uasort($return['results'], array($this, 'compareResults'));
+ }
+ // Apply range.
+ $offset = $this->getOption('offset', 0);
+ $limit = $this->getOption('limit', NULL);
+ $return['results'] = array_slice($return['results'], $offset, $limit, TRUE);
+ }
+ return $return;
+ }
+
+ return array('result count' => 0);
+ }
+
+ /**
+ * Helper method for adding a filter to index-specific queries.
+ *
+ * @param SearchApiQueryFilterInterface[]|array[] $filters
+ * An array of filters to add, as returned by
+ * SearchApiQueryFilterInterface::getFilters().
+ * @param SearchApiQuery[] $parents
+ * The query or filter objects to which the filters should be applied, keyed
+ * by index ID.
+ * @param SearchApiQuery[] $queries
+ * The queries used, keyed by index ID.
+ */
+ protected function addFilters(array $filters, array $parents, array $queries) {
+ foreach ($filters as $filter) {
+ if (is_array($filter)) {
+ if ($filter[0] == 'search_api_multi_index') {
+ continue;
+ }
+ list($index_id, $field) = explode(':', $filter[0], 2);
+ if (!empty($parents[$index_id])) {
+ $parents[$index_id]->condition($field, $filter[1], $filter[2]);
+ }
+ }
+ else {
+ /** @var SearchApiQueryFilterInterface[] $nested */
+ $nested = array();
+ foreach ($parents as $index_id => $query) {
+ $nested[$index_id] = $queries[$index_id]->createFilter($filter->getConjunction());
+ }
+ $this->addFilters($filter->getFilters(), $nested, $queries);
+ foreach ($nested as $index_id => $nested_filter) {
+ if ($nested_filter->getFilters()) {
+ $parents[$index_id]->filter($nested_filter);
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Ensure that all results have all fields needed for sorting.
+ *
+ * @param array $results
+ * The results array, as in the 'results' key of the return value of
+ * SearchApiMultiQueryInterface::execute().
+ */
+ protected function ensureSortFields(array &$results) {
+ $sort = array_keys($this->sort);
+ // Eliminate special fields which are always included.
+ foreach ($sort as $i => $key) {
+ if ($key == 'search_api_id' || $key == 'search_api_relevance') {
+ unset($sort[$i]);
+ }
+ }
+ if (!$sort) {
+ return;
+ }
+ // Determine what fields we need from items of each index.
+ $fields = array();
+ foreach ($sort as $key) {
+ list($index_id, $field) = explode(':', $key, 2);
+ if (!empty($this->indexes[$index_id])) {
+ $fields[$index_id][$field] = $this->indexes[$index_id]->options['fields'][$field];
+ }
+ }
+ if (!$fields) {
+ return;
+ }
+ // Determine for which items we need the entity.
+ $to_load = array();
+ foreach ($results as $i => $result) {
+ $results[$i] = $result += array('fields' => array(), 'entity' => NULL);
+ if (empty($fields[$result['index_id']]) || $result['entity']) {
+ continue;
+ }
+ foreach ($fields[$result['index_id']] as $field => $info) {
+ if (!array_key_exists($field, $result['fields'])) {
+ $to_load[$this->indexes[$result['index_id']]->item_type][$i] = $result['id'];
+ break;
+ }
+ }
+ }
+ // Load items, as necessary.
+ foreach ($to_load as $type => $ids) {
+ $type_items = search_api_get_datasource_controller($type)->loadItems($ids);
+ foreach ($ids as $i => $id) {
+ if (isset($type_items[$id])) {
+ $results[$i]['entity'] = $type_items[$id];
+ }
+ }
+ }
+ // Now extract the fields for each item.
+ foreach ($results as $i => $result) {
+ if (empty($fields[$result['index_id']])) {
+ continue;
+ }
+ $item_fields = $fields[$result['index_id']];
+ if (empty($result['entity'])) {
+ $results[$i]['fields'] += array_fill_keys(array_keys($item_fields), NULL);
+ continue;
+ }
+ $item_fields = array_diff_key($item_fields, $result['fields']);
+ if ($item_fields) {
+ $wrapper = $this->indexes[$result['index_id']]->entityWrapper($result['entity']);
+ $item_fields = search_api_extract_fields($wrapper, $item_fields);
+ foreach ($item_fields as $field => $info) {
+ $results[$i]['fields'][$field] = $info['value'];
+ }
+ }
+ }
+ }
+
+ /**
+ * Compare two result arrays.
+ *
+ * Callback for uasort() within searchMultiple().
+ *
+ * @param array $a
+ * One result.
+ * @param array $b
+ * The other result.
+ *
+ * @return int
+ * A negative number if $a should come before $b, 0 if both compare equal
+ * and a positive number otherwise.
+ */
+ protected function compareResults(array $a, array $b) {
+ foreach ($this->sort as $key => $order) {
+ // Get the sorting for this specific field.
+ if ($key == 'search_api_relevance') {
+ $comp = $a['score'] - $b['score'];
+ }
+ elseif ($key == 'search_api_id') {
+ if (is_numeric($a['id']) && is_numeric($b['id'])) {
+ $comp = $a['id'] - $b['id'];
+ }
+ else {
+ $comp = strnatcasecmp($a['id'], $b['id']);
+ }
+ }
+ else {
+ list($index_id, $field) = explode(':', $key, 2);
+ $a_applies = ($a['index_id'] == $index_id);
+ $b_applies = ($b['index_id'] == $index_id);
+ if ($a_applies == $b_applies) {
+ if (!$a_applies) {
+ continue;
+ }
+ $value_a = $a['fields'][$field];
+ $value_b = $b['fields'][$field];
+ if (is_numeric($value_a) && is_numeric($value_b)) {
+ $comp = $value_a - $value_b;
+ }
+ else {
+ $comp = strnatcasecmp($value_a, $value_b);
+ }
+ }
+ else {
+ $comp = $a_applies ? -1 : 1;
+ // When the sort only applies to one of the two results, we always
+ // want it in front of the other, regardless of $order.
+ $order = 'ASC';
+ }
+ }
+
+ // Now apply the specified order and either return or continue.
+ if (!$comp) {
+ continue;
+ }
+ return (int) ($order == 'ASC' ? $comp : -$comp);
+ }
+ return 0;
+ }
+
+ /**
+ * Pre-execute hook for modifying search behaviour.
+ */
+ public function preExecute() {
+ // Make sure to only execute this once per query.
+ if (!$this->pre_execute) {
+ $this->pre_execute = TRUE;
+
+ // Add filter for languages.
+ if (isset($this->options['languages'])) {
+ $this->addLanguages($this->options['languages']);
+ }
+
+ // Filter indexes to those used. If no index was explicitly used, include
+ // all of them.
+ if ($this->used_indexes) {
+ $this->indexes = array_intersect_key($this->indexes, $this->used_indexes);
+ }
+
+ // Add fulltext fields, unless set.
+ if ($this->fields === NULL) {
+ $this->fields = $this->index_fields = array();
+ foreach ($this->indexes as $index_id => $index) {
+ foreach ($index->getFulltextFields() as $f) {
+ $this->fields[] = "$index_id:$f";
+ $this->index_fields[$index_id][] = $f;
+ }
+ }
+ }
+ // If both keys and fields are given, indexes with no fields searched
+ // should not be included.
+ elseif ($this->keys) {
+ $this->indexes = array_intersect_key($this->indexes, $this->index_fields);
+ }
+
+ // Filter the $servers property according to the used indexes.
+ foreach ($this->servers as $server_id => $indexes) {
+ foreach ($indexes as $index_id => $index) {
+ if (!isset($this->indexes[$index_id])) {
+ unset($this->servers[$server_id][$index_id]);
+ }
+ }
+ }
+ $this->servers = array_filter($this->servers);
+ }
+ }
+
+ /**
+ * Post-execute hook for modifying search behaviour.
+ *
+ * @param array $results
+ * The results returned by the server, which may be altered.
+ */
+ public function postExecute(array &$results) {}
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getIndexes() {
+ return $this->indexes;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getKeys() {
+ return $this->keys;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getOriginalKeys() {
+ return $this->orig_keys;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getFields() {
+ return $this->fields;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getFilter() {
+ return $this->filter;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getSort() {
+ return $this->sort;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getOption($name, $default = NULL) {
+ return isset($this->options[$name]) ? $this->options[$name] : $default;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setOption($name, $value) {
+ $old = $this->getOption($name);
+ $this->options[$name] = $value;
+ return $old;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getOptions() {
+ return $this->options;
+ }
+
+ /**
+ * Implements the magic __toString() method to simplify debugging.
+ */
+ public function __toString() {
+ $ret = '';
+ if ($this->indexes) {
+ $indexes = array();
+ foreach ($this->indexes as $index) {
+ $indexes[] = $index->machine_name;
+ }
+ $ret .= 'Indexes: ' . implode(', ', $indexes) . "\n";
+ }
+ $ret .= 'Keys: ' . str_replace("\n", "\n ", var_export($this->orig_keys, TRUE)) . "\n";
+ if (isset($this->keys)) {
+ $ret .= 'Parsed keys: ' . str_replace("\n", "\n ", var_export($this->keys, TRUE)) . "\n";
+ $ret .= 'Searched fields: ' . (isset($this->fields) ? implode(', ', $this->fields) : '[ALL]') . "\n";
+ }
+ if ($filter = (string) $this->filter) {
+ $filter = str_replace("\n", "\n ", $filter);
+ $ret .= "Filters:\n $filter\n";
+ }
+ if ($this->sort) {
+ $sort = array();
+ foreach ($this->sort as $field => $order) {
+ $sort[] = "$field $order";
+ }
+ $ret .= 'Sorting: ' . implode(', ', $sort) . "\n";
+ }
+ $options = $this->sanitizeOptions($this->options);
+ $options = str_replace("\n", "\n ", var_export($options, TRUE));
+ $ret .= 'Options: ' . $options . "\n";
+ return $ret;
+ }
+
+ /**
+ * Sanitizes an array of options in a way that plays nice with var_export().
+ *
+ * @param array $options
+ * An array of options.
+ *
+ * @return array
+ * The sanitized options.
+ */
+ protected function sanitizeOptions(array $options) {
+ foreach ($options as $key => $value) {
+ if (is_object($value)) {
+ $options[$key] = 'object (' . get_class($value) . ')';
+ }
+ elseif (is_array($value)) {
+ $options[$key] = $this->sanitizeOptions($value);
+ }
+ }
+ return $options;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/includes/search_api_multi.service.inc b/www/modules/contrib/search_api/contrib/search_api_multi/includes/search_api_multi.service.inc
new file mode 100644
index 000000000..6e1c133e2
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/includes/search_api_multi.service.inc
@@ -0,0 +1,26 @@
+getIndexes();
+ if (isset($indexes['default_node_index'])) {
+ $query->condition('default_node_index:author', 0, '!=');
+ }
+}
+
+/**
+ * @} End of "addtogroup hooks".
+ */
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/search_api_multi.info b/www/modules/contrib/search_api/contrib/search_api_multi/search_api_multi.info
new file mode 100644
index 000000000..6f26c822b
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/search_api_multi.info
@@ -0,0 +1,21 @@
+type = module
+name = Multi-index searches
+description = Small extension for the Search API that allows searches across several indexes on the same server.
+backdrop = 1.x
+package = Search
+
+dependencies[] = entity_plus
+dependencies[] = search_api
+
+files[] = search_api_multi.query.inc
+files[] = search_api_multi.service.inc
+files[] = views/handler_argument_fulltext.inc
+files[] = views/handler_filter_fulltext.inc
+files[] = views/handler_filter_options.inc
+files[] = views/query.inc
+files[] = views/row_entity_view.inc
+
+; Added by Backdrop CMS packaging script on 2026-02-06
+project = search_api
+version = 1.x-1.29.5
+timestamp = 1770395528
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/search_api_multi.install b/www/modules/contrib/search_api/contrib/search_api_multi/search_api_multi.install
new file mode 100644
index 000000000..cd7b448a4
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/search_api_multi.install
@@ -0,0 +1,12 @@
+ '3.0',
+ 'path' => backdrop_get_path('module', 'search_api_multi') . '/views',
+ );
+ }
+}
+
+/**
+ * Implements hook_autoload_info().
+ */
+function search_api_multi_autoload_info() {
+ return array(
+ 'SearchApiMultiQueryInterface' => 'includes/search_api_multi.query.inc',
+ 'SearchApiMultiQuery' => 'includes/search_api_multi.query.inc',
+ 'SearchApiMultiServiceInterface' => 'includes/search_api_multi.service.inc',
+ 'SearchApiMultiHandlerArgumentFulltext' => 'views/handler_argument_fulltext.inc',
+ 'SearchApiMultiHandlerFilterFulltext' => 'views/handler_filter_fulltext.inc',
+ 'SearchApiMultiViewsHandlerFilterOptions' => 'views/handler_filter_options.inc',
+ 'SearchApiMultiViewsQuery' => 'views/query.inc',
+ 'SearchApiMultiRowEntityView' => 'views/row_entity_view.inc',
+ );
+}
+
+/**
+ * Creates a multi-index search query.
+ *
+ * For backwards-compatibility reasons, the options can be passed as either the
+ * first or the second parameter, the other one is ignored.
+ *
+ * @param ?array $options
+ * Associative array of options configuring this query. Recognized options
+ * are:
+ * - conjunction: The type of conjunction to use for this query - either
+ * 'AND' or 'OR'. 'AND' by default. This only influences the search keys,
+ * filters will always use AND by default.
+ * - 'parse mode': The mode with which to parse the $keys variable, if it
+ * is set and not already an array. See SearchApiMultiQuery::parseModes()
+ * for recognized parse modes.
+ * - languages: The languages to search for, as an array of language IDs.
+ * If not specified, all languages will be searched. Language-neutral
+ * content (LANGUAGE_NONE) is always searched.
+ * - offset: The position of the first returned search results relative to
+ * the whole result.
+ * - limit: The maximum number of search results to return. -1 means no
+ * limit.
+ * - 'filter class': Can be used to change the SearchApiQueryFilterInterface
+ * implementation to use.
+ * - 'search id': A string that will be used as the identifier when storing
+ * this search in the static cache.
+ * All options are optional.
+ * @param array $options2
+ * Deprecated. Exactly the same as $options. Will be used if $options is no
+ * array.
+ *
+ * @return SearchApiMultiQueryInterface
+ * A query object for searching multiple indexes.
+ */
+function search_api_multi_query(?array $options = array(), array $options2 = array()) {
+ $options = is_array($options) ? $options : $options2;
+ return new SearchApiMultiQuery($options);
+}
+
+/**
+ * Static store for the multi-index searches executed on the current page.
+ *
+ * Can either be used to store an executed search, or to retrieve a previously
+ * stored search.
+ *
+ * @param ?string $search_id
+ * For pages displaying multiple searches, an optional ID identifying the
+ * search in questions. When storing a search, this is filled automatically,
+ * unless it is manually set.
+ * @param ?SearchApiMultiQuery $query
+ * When storing an executed search, the query that was executed. NULL
+ * otherwise.
+ * @param array $results
+ * When storing an executed search, the returned results as specified by
+ * SearchApiMultiQueryInterface::execute(). An empty array, otherwise.
+ *
+ * @return array
+ * If a search with the specified ID was executed, an array containing
+ * ($query, $results) as used in this function's parameters. If $search_id is
+ * NULL, an array of all executed searches will be returned, keyed by ID.
+ */
+function search_api_multi_current_search(?string $search_id = NULL, ?SearchApiMultiQuery $query = NULL, array $results = array()) {
+ $searches = &backdrop_static(__FUNCTION__, array());
+
+ if (isset($query)) {
+ if (!isset($search_id)) {
+ $search_id = $query->getOption('search id');
+ }
+ $base = $search_id;
+ $i = 0;
+ while (isset($searches[$search_id])) {
+ $search_id = $base . '-' . (++$i);
+ }
+ $searches[$search_id] = array($query, $results);
+ }
+
+ if (isset($searches[$search_id])) {
+ return $searches[$search_id];
+ }
+ return $searches;
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_argument_fulltext.inc b/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_argument_fulltext.inc
new file mode 100644
index 000000000..5ce969532
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_argument_fulltext.inc
@@ -0,0 +1,29 @@
+ TRUE));
+ foreach ($indexes as $index) {
+ if ($index->getFields()) {
+ $prefix = $index->machine_name . ':';
+ $prefix_name = $index->name . ' » ';
+ $f = $index->getFields();
+ foreach ($index->getFulltextFields() as $name) {
+ $fields[$prefix . $name] = $prefix_name . $f[$name]['name'];
+ }
+ }
+ }
+ return $fields;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_filter_fulltext.inc b/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_filter_fulltext.inc
new file mode 100644
index 000000000..c6f4ebe2f
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_filter_fulltext.inc
@@ -0,0 +1,103 @@
+value)) {
+ $this->value = $this->value ? reset($this->value) : '';
+ }
+ // Catch empty strings entered by the user, but not "0".
+ if ($this->value === '') {
+ return;
+ }
+ $fields = $this->options['fields'];
+
+ // If something already specifically set different fields, we silently fall
+ // back to mere filtering.
+ $filter = $this->options['mode'] == 'filter';
+ if (!$filter) {
+ $old = $this->query->getFields();
+ $filter = $old && $fields && (array_diff($old, $fields) || array_diff($fields, $old));
+ }
+
+ if ($filter) {
+ $filter = $this->query->createFilter('OR');
+ foreach ($fields as $field) {
+ $filter->condition($field, $this->value, $this->operator);
+ }
+ $this->query->filter($filter);
+ return;
+ }
+
+ // If the operator was set to OR, set it as the conjunction. (AND is set by
+ // default.)
+ if ($this->operator === 'OR') {
+ $this->query->setOption('conjunction', $this->operator);
+ }
+
+ if ($fields) {
+ $this->query->fields($fields);
+ }
+ $old = $this->query->getOriginalKeys();
+ $this->query->keys($this->value);
+ if ($this->operator == 'NOT') {
+ $keys = &$this->query->getKeys();
+ if (is_array($keys)) {
+ $keys['#negation'] = TRUE;
+ }
+ else {
+ // We can't know how negation is expressed in the server's syntax.
+ }
+ }
+ if ($old) {
+ $keys = &$this->query->getKeys();
+ if (is_array($keys)) {
+ $keys[] = $old;
+ }
+ elseif (is_array($old)) {
+ // We don't support such nonsense.
+ }
+ else {
+ $keys = "($old) ($keys)";
+ }
+ }
+ }
+
+ /**
+ * Helper method to get an option list of all available fulltext fields.
+ */
+ protected function getFulltextFields() {
+ $fields = array();
+ $indexes = search_api_index_load_multiple(FALSE, array('enabled' => TRUE));
+ foreach ($indexes as $index) {
+ if ($index->getFields()) {
+ $prefix = $index->machine_name . ':';
+ $prefix_name = $index->name . ' » ';
+ $f = $index->getFields();
+ foreach ($index->getFulltextFields() as $name) {
+ $fields[$prefix . $name] = $prefix_name . $f[$name]['name'];
+ }
+ }
+ }
+ return $fields;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_filter_options.inc b/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_filter_options.inc
new file mode 100644
index 000000000..f53ea7021
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/views/handler_filter_options.inc
@@ -0,0 +1,56 @@
+real_field, 2);
+ $index = search_api_index_load($index_id);
+ if (!$index) {
+ return NULL;
+ }
+ $wrapper = $index->entityWrapper(NULL, TRUE);
+ $parts = explode(':', $property);
+ foreach ($parts as $i => $part) {
+ if (!isset($wrapper->$part)) {
+ return NULL;
+ }
+ $wrapper = $wrapper->$part;
+ $info = $wrapper->info();
+ if ($i < count($parts) - 1) {
+ // Unwrap lists.
+ $level = search_api_list_nesting_level($info['type']);
+ for ($j = 0; $j < $level; ++$j) {
+ $wrapper = $wrapper[0];
+ }
+ }
+ }
+
+ return $wrapper;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function get_value_options() {
+ if ($this->real_field == 'search_api_multi_index') {
+ $this->value_options = array();
+ foreach (search_api_index_load_multiple(FALSE, array('enabled' => 1)) as $index) {
+ $this->value_options[$index->machine_name] = check_plain($index->name);
+ }
+ }
+ else {
+ parent::get_value_options();
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/views/query.inc b/www/modules/contrib/search_api/contrib/search_api_multi/views/query.inc
new file mode 100644
index 000000000..59916e568
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/views/query.inc
@@ -0,0 +1,219 @@
+query = search_api_multi_query(array('parse mode' => $this->options['parse_mode']));
+ }
+ catch (Exception $e) {
+ $this->errors[] = $e->getMessage();
+ }
+ }
+
+ /**
+ * Adds settings for the UI.
+ *
+ * Adds an option for bypassing access checks.
+ */
+ public function 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'],
+ );
+
+ $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,
+ );
+ }
+ }
+ }
+
+ /**
+ * Helper function for adding results to a view in the format expected by the
+ * view.
+ */
+ protected function addResults(array $results, $view) {
+ $indexes = $this->getIndexes();
+ foreach ($results as $result) {
+ $row = array();
+
+ if (!empty($this->options['entity_access']) && isset($indexes[$result['index_id']]) && $indexes[$result['index_id']]->getEntityType()) {
+ $entity = $indexes[$result['index_id']]->loadItems(array($result['id']));
+ if (!$entity || !entity_access('view', $indexes[$result['index_id']]->item_type, reset($entity))) {
+ continue;
+ }
+ }
+ // 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'] = $result['id'];
+ }
+
+ // Gather any fields from the search results.
+ if (!empty($result['fields'])) {
+ foreach (search_api_get_sanitized_field_values($result['fields']) as $field_id => $value) {
+ $field_id = $result['index_id'] . ':' . $field_id;
+ $row['_entity_properties'][$field_id] = $value;
+ }
+ }
+
+ $row['_entity_properties']['search_api_multi_id'] = $result['id'];
+ $row['_entity_properties']['search_api_multi_index'] = $result['index_id'];
+ $row['_entity_properties']['search_api_relevance'] = $result['score'];
+ $row['_entity_properties']['search_api_excerpt'] = empty($result['excerpt']) ? '' : $result['excerpt'];
+
+ // Add the row to the Views result set.
+ $view->result[] = (object) $row;
+ }
+ }
+
+ /**
+ * 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) {
+ $wrappers = array();
+ $load_items = array();
+ $entity_types = entity_get_info();
+ $indexes = $this->getIndexes();
+
+ // Entity property info for the results.
+ $info = array();
+ foreach ($indexes as $index_id => $index) {
+ $entity_type = $index->getEntityType();
+ $info['property info'][$index_id] = array(
+ 'label' => t('@index results', array('@index' => $index->name)),
+ 'type' => $entity_type ? $entity_type : $index->item_type,
+ 'description' => t('Results from the @index index.', array('@index' => $index->name)),
+ );
+ if (!$entity_type) {
+ $info['property info'][$index_id] += $index->entityWrapper()->info();
+ }
+ }
+
+ // Pick out all results that need to be loaded.
+ foreach ($results as $row_index => $row) {
+ $index_id = $row->_entity_properties['search_api_multi_index'];
+ if (isset($row->entity) && !empty($indexes[$index_id])) {
+ $index = $indexes[$index_id];
+ // If this item isn't loaded, register it for pre-loading.
+ if (is_scalar($row->entity)) {
+ $load_items[$index->item_type][$row->entity] = $row->entity;
+ }
+ }
+ }
+
+ // Load the results in bulk, by item type, and create the wrappers.
+ if (!empty($load_items)) {
+ foreach ($load_items as $type => $ids) {
+ try {
+ $load_items[$type] = search_api_get_datasource_controller($type)->loadItems($ids);
+ }
+ catch (SearchApiException $e) {
+ watchdog_exception('search_api_multi', $e);
+ }
+ }
+ }
+
+ // Create wrappers for all results.
+ foreach ($results as $row_index => $row) {
+ $index_id = $row->_entity_properties['search_api_multi_index'];
+ if ($indexes[$index_id]) {
+ if (is_scalar($row->entity)) {
+ $index = $indexes[$index_id];
+ if (empty($load_items[$index->item_type][$row->entity])) {
+ continue;
+ }
+ $row->entity = $load_items[$index->item_type][$row->entity];
+ }
+ $item = $row->entity;
+ $data = new stdClass();
+ $data->{$index_id} = $item;
+ $wrappers[$row_index] = entity_metadata_wrapper('search_api_multi', $data, $info);
+ }
+ }
+
+ // Apply the relationship, if necessary.
+ $type = 'search_api_multi';
+ $selector_suffix = '';
+ if ($field && ($pos = strrpos($field, ':'))) {
+ $selector_suffix = substr($field, 0, $pos);
+ }
+ if ($selector_suffix || ($relationship && !empty($this->view->relationship[$relationship]))) {
+ // Use EntityPlusFieldHandlerHelper to compute the correct data selector
+ // for the relationship.
+ $handler = (object) array(
+ 'view' => $this->view,
+ 'relationship' => $relationship,
+ 'real_field' => '',
+ );
+ $selector = EntityPlusFieldHandlerHelper::construct_property_selector($handler);
+ $selector .= ($selector ? ':' : '') . $selector_suffix;
+ list($type, $wrappers) = EntityPlusFieldHandlerHelper::extract_property_multiple($wrappers, $selector);
+ }
+
+ return array($type, $wrappers);
+ }
+
+ //
+ // Query interface methods (proxy to $this->query)
+ //
+
+ /**
+ * Retrieves the searched indexes.
+ *
+ * @return SearchApiIndex[]
+ * An array of SearchApiIndex objects representing all indexes that will be
+ * used for this search, keyed by machine names.
+ */
+ public function getIndexes() {
+ if (!$this->errors) {
+ return $this->query->getIndexes();
+ }
+ return array();
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/views/row_entity_view.inc b/www/modules/contrib/search_api/contrib/search_api_multi/views/row_entity_view.inc
new file mode 100644
index 000000000..c0143ca46
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/views/row_entity_view.inc
@@ -0,0 +1,177 @@
+view->query)) {
+ $this->view->init_query();
+ }
+
+ $entity_types = $incompatibles = array();
+ foreach ($this->view->query->getIndexes() as $id => $index) {
+ $type = $index->getEntityType();
+ $label = $index->label();
+
+ if ($type) {
+ $entity_types[$type][] = $label;
+ }
+ else {
+ $incompatibles[$id] = $label;
+ }
+ }
+
+ $this->indexes = array(
+ 'entity_types' => $entity_types,
+ 'incompatibles' => $incompatibles,
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function option_definition() {
+ $options = parent::option_definition();
+ $options['view_mode'] = array('default' => array());
+ return $options;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ $entity_info = entity_get_info();
+
+ $options = array();
+ foreach ($this->indexes['entity_types'] as $type => $indexes) {
+ foreach ($entity_info[$type]['view modes'] as $view_mode => $view_mode_info) {
+ $options[$type][$view_mode] = $view_mode_info['label'];
+ }
+ }
+
+ $form['view_mode'] = array(
+ '#tree' => TRUE,
+ );
+
+ foreach ($options as $entity_type => $modes) {
+ if (count($modes) > 1) {
+ $form['view_mode'][$entity_type] = array(
+ '#type' => 'select',
+ '#options' => $modes,
+ '#title' => t('View mode for @entity_name entities', array(
+ '@entity_name' => $entity_info[$entity_type]['label'],
+ )),
+ '#description' => format_plural(
+ count($this->indexes['entity_types'][$entity_type]),
+ 'This view mode will be used to render entities from the following index: %indexes',
+ 'This view mode will be used to render entities from the following indexes: %indexes',
+ array(
+ '%indexes' => implode(', ', $this->indexes['entity_types'][$entity_type]),
+ )
+ ),
+ );
+ if (!empty($this->options['view_mode'][$entity_type])) {
+ $form['view_mode'][$entity_type]['#default_value'] = $this->options['view_mode'][$entity_type];
+ }
+ }
+ else {
+ // For entity types that only have one view mode, there's no meaningful
+ // choice to make, so just expose it to let the user know about it.
+ $form['view_mode']["{$entity_type}__description"] = array(
+ '#type' => 'item',
+ '#title' => t('View mode for @entity_name entities', array(
+ '@entity_name' => $entity_info[$entity_type]['label'],
+ )),
+ '#description' => reset($modes),
+ );
+ $form['view_mode'][$entity_type] = array(
+ '#type' => 'value',
+ '#value' => key($modes),
+ );
+ }
+ }
+
+ if (count($this->indexes['incompatibles'])) {
+ $form['incompatibles'] = array(
+ '#type' => 'item',
+ '#title' => 'Incompatible indexes',
+ '#description' => t("The following indexes are not based on entities, and can't be used with this row style: %indexes. Items from those indexes will be skipped during rendering.", array(
+ '%indexes' => implode(', ', $this->indexes['incompatibles']),
+ )),
+ );
+ }
+
+ return $form;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function pre_render($values) {
+ if (!empty($values)) {
+ list(, $this->wrappers) = $this->view->query->get_result_wrappers($values);
+ }
+ }
+
+ /**
+ * Returns a metadata wrapper for a returned row.
+ *
+ * @param object $values
+ * The values of the returned row.
+ *
+ * @return EntityMetadataWrapper|null
+ * A wrapper for that row, or NULL if the row doesn't represent an entity.
+ */
+ public function get_wrapper($values) {
+ $index = $values->_entity_properties['search_api_multi_index'];
+ if (isset($this->indexes['incompatibles'][$index])) {
+ return NULL;
+ }
+ if (empty($this->wrappers[$this->view->row_index]->$index)) {
+ return NULL;
+ }
+ return $this->wrappers[$this->view->row_index]->$index;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function render($values) {
+ if ($wrapper = $this->get_wrapper($values)) {
+ $render = $wrapper->view($this->options['view_mode'][$wrapper->type()]);
+ return backdrop_render($render);
+ }
+ }
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_multi/views/search_api_multi.views.inc b/www/modules/contrib/search_api/contrib/search_api_multi/views/search_api_multi.views.inc
new file mode 100644
index 000000000..eddaa0162
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_multi/views/search_api_multi.views.inc
@@ -0,0 +1,171 @@
+ 'search_api_multi_index',
+ 'title' => t('Multi-index search'),
+ 'help' => t('Search several search indexes at once.'),
+ 'query class' => 'search_api_multi_query',
+ );
+ $index_options = array();
+ foreach (search_api_index_load_multiple(FALSE, array('enabled' => TRUE)) as $index_id => $index) {
+ try {
+ $index_options[$index_id] = check_plain($index->name);
+ $wrapper = $index->entityWrapper(NULL, TRUE);
+
+ // Add a relationship to the index's entity type.
+ $info = array(
+ 'label' => t('@index results', array('@index' => $index->name)),
+ 'type' => $index->item_type,
+ 'description' => t('Results from the @index index.', array('@index' => $index->name)),
+ );
+ if (empty($entity_types[$index->item_type])) {
+ $info += $index->entityWrapper()->info();
+ }
+ entity_plus_views_field_definition($index_id, $info, $table);
+
+ // Add handlers for all indexed fields.
+ foreach ($index->getFields() as $key => $field) {
+ $tmp = $wrapper;
+ $group = '';
+ $name = $index->name;
+ $parts = explode(':', $key);
+ foreach ($parts as $i => $part) {
+ if (!isset($tmp->$part)) {
+ continue 2;
+ }
+ $tmp = $tmp->$part;
+ $info = $tmp->info();
+ $group = ($group ? $group . ' » ' . $name : $name);
+ $name = $info['label'];
+ if ($i < count($parts) - 1) {
+ // Unwrap lists.
+ $level = search_api_list_nesting_level($info['type']);
+ for ($j = 0; $j < $level; ++$j) {
+ $tmp = $tmp[0];
+ }
+ }
+ }
+ $key = "$index_id:$key";
+ $id = _entity_plus_views_field_identifier($key, $table);
+ if ($group) {
+ $table[$id]['group'] = $group;
+ $name = t('!field (indexed)', array('!field' => $name));
+ }
+ $table[$id]['title'] = $name;
+ $table[$id]['help'] = empty($info['description']) ? t('(No information available)') : $info['description'];
+ $table[$id]['type'] = $field['type'];
+ $table[$id]['real field'] = $key;
+ _search_api_views_add_handlers($key, $field, $tmp, $table);
+ // The newest (Search API 1.10+) SearchApiViewsHandlerFilterOptions
+ // class is incompatible with multi-index searches. Substitute our own
+ // handler.
+ if (isset($table[$id]['filter']['handler']) && $table[$id]['filter']['handler'] == 'SearchApiViewsHandlerFilterOptions' && method_exists('SearchApiViewsHandlerFilterOptions', 'get_wrapper')) {
+ $table[$id]['filter']['handler'] = 'SearchApiMultiViewsHandlerFilterOptions';
+ }
+ }
+ }
+ catch (Exception $e) {
+ watchdog_exception('search_api_multi', $e);
+ }
+ }
+
+ // Special handlers.
+ $table['search_api_multi_id']['title'] = t('Entity ID');
+ $table['search_api_multi_id']['help'] = t("The entity's ID.");
+ $table['search_api_multi_id']['field']['type'] = 'text';
+ $table['search_api_multi_id']['field']['handler'] = 'entity_plus_views_handler_field_text';
+ $table['search_api_multi_id']['sort']['handler'] = 'SearchApiViewsHandlerSort';
+ $table['search_api_multi_id']['sort']['real field'] = 'search_api_id';
+
+ $table['search_api_multi_index']['title'] = t('Index');
+ $table['search_api_multi_index']['help'] = t('The search indexes that will be searched.');
+ $table['search_api_multi_index']['type'] = 'options';
+ $table['search_api_multi_index']['field']['handler'] = 'entity_views_handler_field_entity';
+ $table['search_api_multi_index']['field']['type'] = 'search_api_index';
+ $table['search_api_multi_index']['relationship']['handler'] = 'entity_views_handler_relationship';
+ $table['search_api_multi_index']['relationship']['base'] = 'entity_search_api_index';
+ $table['search_api_multi_index']['relationship']['base field'] = 'machine_name';
+ $table['search_api_multi_index']['relationship']['relationship field'] = 'search_api_multi_index';
+ $table['search_api_multi_index']['relationship']['label'] = t('Search index');
+ $table['search_api_multi_index']['relationship']['multiple'] = FALSE;
+ $table['search_api_multi_index']['argument']['handler'] = 'SearchApiViewsHandlerArgument';
+ // See above.
+ if (method_exists('SearchApiViewsHandlerFilterOptions', 'get_wrapper')) {
+ $table['search_api_multi_index']['filter']['handler'] = 'SearchApiMultiViewsHandlerFilterOptions';
+ }
+ else {
+ $table['search_api_multi_index']['filter']['handler'] = 'SearchApiViewsHandlerFilterOptions';
+ $table['search_api_multi_index']['filter']['options'] = $index_options;
+ }
+
+ $table['search_api_relevance']['group'] = t('Search');
+ $table['search_api_relevance']['title'] = t('Relevance');
+ $table['search_api_relevance']['help'] = t('The relevance of this search result with respect to the query.');
+ $table['search_api_relevance']['field']['type'] = 'decimal';
+ $table['search_api_relevance']['field']['handler'] = 'entity_views_handler_field_numeric';
+ $table['search_api_relevance']['field']['click sortable'] = TRUE;
+ $table['search_api_relevance']['sort']['handler'] = 'SearchApiViewsHandlerSort';
+
+ $table['search_api_excerpt']['title'] = t('Excerpt');
+ $table['search_api_excerpt']['help'] = t('Excerpts from the search results highlighting occurrences of the keywords.');
+ $table['search_api_excerpt']['field']['type'] = 'text';
+ $table['search_api_excerpt']['field']['handler'] = 'entity_plus_views_handler_field_text';
+
+ $table['search_api_multi_fulltext']['group'] = t('Search');
+ $table['search_api_multi_fulltext']['title'] = t('Fulltext search');
+ $table['search_api_multi_fulltext']['help'] = t('Search several or all fulltext fields at once.');
+ $table['search_api_multi_fulltext']['type'] = 'text';
+ $table['search_api_multi_fulltext']['filter']['handler'] = 'SearchApiMultiHandlerFilterFulltext';
+ $table['search_api_multi_fulltext']['argument']['handler'] = 'SearchApiMultiHandlerArgumentFulltext';
+ }
+ catch (Exception $e) {
+ watchdog_exception('search_api_multi', $e);
+ }
+ return $data;
+}
+
+/**
+ * Implements hook_views_plugins().
+ */
+function search_api_multi_views_plugins() {
+ return array(
+ 'module' => 'search_api_multi',
+ 'query' => array(
+ 'search_api_multi_query' => array(
+ 'title' => t('Search API Query'),
+ 'help' => t('Query will be generated and run using the Search API.'),
+ 'handler' => 'SearchApiMultiViewsQuery',
+ ),
+ ),
+ 'row' => array(
+ 'search_api_multi' => array(
+ 'title' => t('Rendered entity'),
+ 'handler' => 'SearchApiMultiRowEntityView',
+ 'path' => backdrop_get_path('module', 'search_api_multi') . '/views',
+ 'uses options' => TRUE,
+ 'help' => t('Renders a single entity in a specific view mode (e.g. teaser).'),
+ 'base' => array('search_api_multi'),
+ 'uses fields' => FALSE,
+ 'type' => 'normal',
+ ),
+ ),
+ );
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/README.md b/www/modules/contrib/search_api/contrib/search_api_views/README.md
new file mode 100644
index 000000000..61c9cc1ce
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/README.md
@@ -0,0 +1,151 @@
+Search API Views integration
+----------------------------
+
+This module integrates the Search API with the popular Views module [1],
+allowing users to create views with filters, arguments, sorts and fields based
+on any search index.
+
+[1] http://drupal.org/project/views
+
+"More like this" feature
+------------------------
+This module defines the "More like this" feature (feature key: "search_api_mlt")
+that search service classes can implement. With a server supporting this, you
+can use the „More like this“ contextual filter to display a list of items
+related to a given item (usually, nodes similar to the node currently viewed).
+
+For developers:
+A service class that wants to support this feature has to check for a
+"search_api_mlt" option in the search() method. When present, it will be an
+array containing two keys:
+- id: The entity ID of the item to which related items should be searched.
+- fields: An array of indexed fields to use for testing the similarity of items.
+When these are present, the normal keywords should be ignored and the related
+items be returned as results instead. Sorting, filtering and range restriction
+should all work normally.
+
+"Random sort" feature
+---------------------
+This module defines the "Random sort" feature (feature key:
+"search_api_random_sort") that allows to randomly sort the results returned by a
+search. With a server supporting this, you can use the "Global: Random" sort to
+sort the view's results randomly. Every time the query is run a different
+sorting will be provided.
+
+For developers:
+A service class that wants to support this feature has to check for a
+"search_api_random" field in the search query's sorts and insert a random sort
+in that position. If the query is sorted in this way, then the
+"search_api_random_sort" query option can contain additional options for the
+random sort, as an associative array with any of the following keys:
+- seed: A numeric seed value to use for the random sort.
+
+"BETWEEN operator" feature
+--------------------------
+This module defines the "BETWEEN operator" feature (feature key:
+"search_api_between") that adds the "BETWEEN" and "NOT BETWEEN" filter
+operators to search queries. If your search server supports this feature, you
+can use the "Is between" and "Is not between" operators when adding Views
+filters for numeric, string or date types.
+
+For developers:
+A service class that wants to support this feature has to accept "BETWEEN" and
+"NOT BETWEEN" as additional $operator values in query conditions. The value in
+both cases is an array with the keys 0 and 1, with the value under key 0 being
+the lower and the value under key 1 being the upper bound for the range in which
+the field's value should ("BETWEEN") or should not ("NOT BETWEEN") be.
+
+"Facets block" display
+----------------------
+Most features should be clear to users of Views. However, the module also
+provides a new display type, "Facets block", that might need some explanation.
+This display type is only available, if the „Search facets“ module is also
+enabled.
+
+The basic use of the block is to provide a list of links to the most popular
+filter terms (i.e., the ones with the most results) for a certain category. For
+example, you could provide a block listing the most popular authors, or taxonomy
+terms, linking to searches for those, to provide some kind of landing page.
+
+Please note that, due to limitations in Views, this display mode is shown for
+views of all base tables, even though it only works for views based on Search
+API indexes. For views of other base tables, this will just print an error
+message.
+The display will also always ignore the view's "Style" setting, selected fields
+and sorts, etc.
+
+To use the display, specify the base path of the search you want to link to
+(this enables you to also link to searches that aren't based on Views) and the
+facet field to use (any indexed field can be used here, there needn't be a facet
+defined for it). You'll then have the block available in the blocks
+administration and can enable and move it at leisure.
+Note, however, that the facet in question has to be enabled for the search page
+linked to for the filter to have an effect.
+
+Since the block will trigger a search on pages where it is set to appear, you
+can also enable additional „normal“ facet blocks for that search, via the
+„Facets“ tab for the index. They will automatically also point to the same
+search that you specified for the display.
+If you want to use only the normal facets and not display anything at all in
+the Views block, just activate the display's „Hide block“ option.
+
+Note: If you want to display the block not only on a few pages, you should in
+any case take care that it isn't displayed on the search page, since that might
+confuse users.
+
+Access features
+---------------
+Search views created with this module contain two query settings (located in
+the "Advanced" fieldset) which let you control the access checks executed for
+search results displayed in the view.
+
+- Bypass access checks
+This option allows you to deactivate access filters that would otherwise be
+added to the search, if the index supports this. This is, for instance, the case
+for indexes on the "Node" item type, when the "Node access" data alteration is
+activated.
+Use this either to slightly speed up searches where additional checks are
+unnecessary (e.g., because you already filter on "Node: Published") and there is
+no other node access mechanism on your site) or to show certain data that users
+normally wouldn't have access to (e.g., a list of all matching node titles,
+published or not).
+
+- Additional access checks on result entities
+When this option is activated, all result entities will be passed to an
+additional access check, even if search-time access checks are available for
+this index. The advantage is that access rules are guaranteed to be enforced –
+stale data in the index, which might make other access checks incorrect, won't
+influence this access check. You can also use it for item types for which no
+other access mechanisms are available.
+However, note that results filtered out this way will mess up paging, result
+counts and possibly other things too (like facet counts), as the result row is
+only hidden from display after the search has been executed. Where possible,
+you should therefore only use this in combination with appropriate filter
+settings ensuring that only when the index isn't up-to-date items will be
+filtered out this way.
+This option is only available for indexes on entity types.
+
+Other features
+--------------
+- Change parse mode
+You can determine how search keys entered by the user will be parsed by going to
+"Advanced" > "Query settings" within your View's settings. "Direct" can be
+useful, e.g., when you want to give users the full power of Solr. In other
+cases, "Multiple terms" is usually what you want / what users expect.
+Caution: For letting users use fulltext searches, always use the "Search:
+Fulltext search" filter or contextual filter – using a normal filter on a
+fulltext field won't parse the search keys, which means multiple words will only
+be found when they appear as that exact phrase.
+
+- Preserve facets while using filters
+This is another option under "Advanced" > "Query settings", only available when
+the Search Facets module is installed. When enabled, facet filters are persisted
+when submitting an exposed filters form. When disabled (the default), exposed
+filters will override and reset the selected facet filters.
+
+FAQ: Why „*Indexed* Node“?
+--------------------------
+The group name used for the search result itself (in fields, filters, etc.) is
+prefixed with „Indexed“ in order to be distinguishable from fields on referenced
+nodes (or other entities). The data displayed normally still comes from the
+entity, not from the search index.
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/display_facet_block.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/display_facet_block.inc
new file mode 100644
index 000000000..7323d502f
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/display_facet_block.inc
@@ -0,0 +1,334 @@
+ '');
+ $options['facet_field'] = '';
+ $options['hide_block'] = FALSE;
+
+ return $options;
+ }
+
+ /**
+ *
+ */
+ public function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ if (substr($this->view->base_table, 0, 17) != 'search_api_index_') {
+ return;
+ }
+
+ switch ($form_state['section']) {
+ case 'linked_path':
+ $form['#title'] .= t('Search page path');
+ $form['linked_path'] = array(
+ '#type' => 'textfield',
+ '#description' => t('The menu path to which search facets will link. Leave empty to use the current path.'),
+ '#default_value' => $this->get_option('linked_path'),
+ );
+ break;
+ case 'facet_field':
+ $form['facet_field'] = array(
+ '#type' => 'select',
+ '#title' => t('Facet field'),
+ '#options' => $this->getFieldOptions(),
+ '#default_value' => $this->get_option('facet_field'),
+ );
+ break;
+ case 'use_more':
+ $form['use_more']['#description'] = t('This will add a more link to the bottom of this view, which will link to the base path for the facet links.');
+ $form['use_more_always'] = array(
+ '#type' => 'value',
+ '#value' => $this->get_option('use_more_always'),
+ );
+ break;
+ case 'hide_block':
+ $form['hide_block'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Hide block'),
+ '#description' => t('Hide this block, but still execute the search. ' .
+ 'Can be used to show native Facet API facet blocks linking to the search page specified above.'),
+ '#default_value' => $this->get_option('hide_block'),
+ );
+ break;
+ }
+ }
+
+ /**
+ *
+ */
+ public function options_validate(&$form, &$form_state) {
+ if (substr($this->view->base_table, 0, 17) != 'search_api_index_') {
+ form_set_error('', t('The "Facets block" display can only be used with base tables based on Search API indexes.'));
+ }
+ }
+
+ /**
+ *
+ */
+ public function options_submit(&$form, &$form_state) {
+ parent::options_submit($form, $form_state);
+
+ switch ($form_state['section']) {
+ case 'linked_path':
+ $this->set_option('linked_path', $form_state['values']['linked_path']);
+ break;
+ case 'facet_field':
+ $this->set_option('facet_field', $form_state['values']['facet_field']);
+ break;
+ case 'hide_block':
+ $this->set_option('hide_block', $form_state['values']['hide_block']);
+ break;
+ }
+ }
+
+ /**
+ *
+ */
+ public function options_summary(&$categories, &$options) {
+ parent::options_summary($categories, $options);
+
+ $options['linked_path'] = array(
+ 'category' => 'block',
+ 'title' => t('Search page path'),
+ 'value' => $this->get_option('linked_path') ? $this->get_option('linked_path') : t('Use current path'),
+ );
+ $field_options = $this->getFieldOptions();
+ $options['facet_field'] = array(
+ 'category' => 'block',
+ 'title' => t('Facet field'),
+ 'value' => $this->get_option('facet_field') ? $field_options[$this->get_option('facet_field')] : t('None'),
+ );
+ $options['hide_block'] = array(
+ 'category' => 'block',
+ 'title' => t('Hide block'),
+ 'value' => $this->get_option('hide_block') ? t('Yes') : t('No'),
+ );
+ }
+
+ protected $field_options = NULL;
+
+ /**
+ *
+ */
+ protected function getFieldOptions() {
+ if (!isset($this->field_options)) {
+ $index_id = substr($this->view->base_table, 17);
+ if (!($index_id && ($index = search_api_index_load($index_id)))) {
+ $table = views_fetch_data($this->view->base_table);
+ $table = empty($table['table']['base']['title']) ? $this->view->base_table : $table['table']['base']['title'];
+ throw new SearchApiException(t('The "Facets block" display cannot be used with a view for @basetable. ' .
+ 'Please only use this display with base tables representing search indexes.',
+ array('@basetable' => $table)));
+ }
+ $this->field_options = array();
+ if (!empty($index->options['fields'])) {
+ foreach ($index->getFields() as $key => $field) {
+ $this->field_options[$key] = $field['name'];
+ }
+ }
+ }
+ return $this->field_options;
+ }
+
+ /**
+ * Render the 'more' link
+ */
+ public function render_more_link() {
+ if ($this->use_more()) {
+ $path = $this->get_option('linked_path');
+ $theme = views_theme_functions('views_more', $this->view, $this->display);
+ $path = check_url(url($path, array()));
+
+ return array(
+ '#theme' => $theme,
+ '#more_url' => $path,
+ '#link_text' => check_plain($this->use_more_text()),
+ );
+ }
+ }
+
+ /**
+ *
+ */
+ public function query() {
+ parent::query();
+
+ $facet_field = $this->get_option('facet_field');
+ if (!$facet_field) {
+ return NULL;
+ }
+
+ $base_path = $this->get_option('linked_path');
+ if (!$base_path) {
+ $base_path = $_GET['q'];
+ }
+
+ $limit = empty($this->view->query->pager->options['items_per_page']) ? 10 : $this->view->query->pager->options['items_per_page'];
+ $query_options = &$this->view->query->getOptions();
+ if (!$this->get_option('hide_block')) {
+ // If we hide the block, we don't need this extra facet.
+ $query_options['search_api_facets']['search_api_views_facets_block'] = array(
+ 'field' => $facet_field,
+ 'limit' => $limit,
+ 'missing' => FALSE,
+ 'min_count' => 1,
+ );
+ }
+ $query_options['search_api_base_path'] = $base_path;
+ $this->view->query->range(0, 0);
+ }
+
+ /**
+ *
+ */
+ public function render() {
+ if (substr($this->view->base_table, 0, 17) != 'search_api_index_') {
+ form_set_error('', t('The "Facets block" display can only be used with base tables based on Search API indexes.'));
+ return NULL;
+ }
+ $facet_field = $this->get_option('facet_field');
+ if (!$facet_field) {
+ return NULL;
+ }
+
+ $this->view->execute();
+
+ if ($this->get_option('hide_block')) {
+ return NULL;
+ }
+
+ $results = $this->view->query->getSearchApiResults();
+
+ if (empty($results['search_api_facets']['search_api_views_facets_block'])) {
+ return NULL;
+ }
+ $terms = $results['search_api_facets']['search_api_views_facets_block'];
+
+ $filters = array();
+ foreach ($terms as $term) {
+ $filter = $term['filter'];
+ if ($filter[0] == '"') {
+ $filter = substr($filter, 1, -1);
+ }
+ elseif ($filter != '!') {
+ // This is a range filter.
+ $filter = substr($filter, 1, -1);
+ $pos = strpos($filter, ' ');
+ if ($pos !== FALSE) {
+ $filter = '[' . substr($filter, 0, $pos) . ' TO ' . substr($filter, $pos + 1) . ']';
+ }
+ }
+ $filters[$term['filter']] = $filter;
+ }
+
+ $index = $this->view->query->getIndex();
+ $options['field'] = $index->options['fields'][$facet_field];
+ $options['field']['key'] = $facet_field;
+ $options['index id'] = $index->machine_name;
+ $options['value callback'] = '_search_api_facetapi_facet_create_label';
+ $map = search_api_facetapi_facet_map_callback($filters, $options);
+
+ $facets = array();
+ $prefix = rawurlencode($facet_field) . ':';
+ foreach ($terms as $term) {
+ $name = $filter = $filters[$term['filter']];
+ if (isset($map[$filter])) {
+ $name = $map[$filter];
+ }
+ $query['f'][0] = $prefix . $filter;
+
+ // Initializes variables passed to theme hook.
+ $variables = array(
+ 'text' => $name,
+ 'path' => $this->view->query->getOption('search_api_base_path'),
+ 'count' => $term['count'],
+ 'options' => array(
+ 'attributes' => array('class' => 'facetapi-inactive'),
+ 'html' => FALSE,
+ 'query' => $query,
+ ),
+ );
+
+ // Override the $variables['#path'] if facetapi_pretty_paths is enabled.
+ if (module_exists('facetapi_pretty_paths')) {
+ // Get the appropriate facet adapter.
+ $adapter = facetapi_adapter_load('search_api@' . $index->machine_name);
+
+ // Get the URL processor and check if it uses pretty paths.
+ $urlProcessor = $adapter->getUrlProcessor();
+ if ($urlProcessor instanceof FacetapiUrlProcessorPrettyPaths) {
+ // Retrieve the pretty path alias from the URL processor.
+ $facet = facetapi_facet_load($facet_field, 'search_api@' . $index->machine_name);
+ $values = array(trim($term['filter'], '"'));
+
+ // Get the pretty path for the facet and remove the current search's
+ // base path from it.
+ $base_path_current = $urlProcessor->getBasePath();
+ $pretty_path = $urlProcessor->getFacetPath($facet, $values, FALSE);
+ $pretty_path = str_replace($base_path_current, '', $pretty_path);
+
+ // Set the new, pretty path for the facet and remove the "f" query
+ // parameter.
+ $variables['path'] = $variables['path'] . $pretty_path;
+ unset($variables['options']['query']['f']);
+ }
+ }
+
+ // Themes the link, adds row to facets.
+ $facets[] = array(
+ 'class' => array('leaf'),
+ 'data' => theme('facetapi_link_inactive', $variables),
+ );
+ }
+
+ if (!$facets) {
+ return NULL;
+ }
+
+ return array(
+ 'facets' => array(
+ '#theme' => 'item_list',
+ '#items' => $facets,
+ ),
+ );
+ }
+
+ /**
+ *
+ */
+ public function execute() {
+ $info['content'] = $this->render();
+ $info['content']['more'] = $this->render_more_link();
+ $info['subject'] = filter_xss_admin($this->view->get_title());
+ return $info;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument.inc
new file mode 100644
index 000000000..38daaa1d8
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument.inc
@@ -0,0 +1,155 @@
+ array(
+ 'title' => t('Display all values'),
+ 'method' => 'default_ignore',
+ 'breadcrumb' => TRUE, // Generate a breadcrumb to here.
+ ),
+ 'not found' => array(
+ 'title' => t('Hide view / Page not found (404)'),
+ 'method' => 'default_not_found',
+ 'hard fail' => TRUE, // This is a hard fail condition.
+ ),
+ 'empty' => array(
+ 'title' => t('Display empty text'),
+ 'method' => 'default_empty',
+ 'breadcrumb' => TRUE, // Generate a breadcrumb to here.
+ ),
+ 'default' => array(
+ 'title' => t('Provide default argument'),
+ 'method' => 'default_default',
+ 'form method' => 'default_argument_form',
+ 'has default argument' => TRUE,
+ 'default only' => TRUE, // This can only be used for missing argument, not validation failure.
+ ),
+ );
+
+ if ($which) {
+ return isset($defaults[$which]) ? $defaults[$which] : NULL;
+ }
+ return $defaults;
+ }
+
+ /**
+ *
+ */
+ public function option_definition() {
+ $options = parent::option_definition();
+
+ $options['break_phrase'] = array(
+ 'default' => FALSE,
+ 'bool' => TRUE,
+ );
+ $options['not'] = array(
+ 'default' => FALSE,
+ 'bool' => TRUE,
+ );
+
+ return $options;
+ }
+
+ /**
+ *
+ */
+ public function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ // Allow passing multiple values.
+ $form['break_phrase'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Allow multiple values'),
+ '#description' => t('If selected, users can enter multiple values in the form of 1+2+3 (for OR) or 1,2,3 (for AND).'),
+ '#default_value' => $this->options['break_phrase'],
+ '#fieldset' => 'more',
+ );
+
+ $form['not'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Exclude'),
+ '#description' => t('If selected, the numbers entered for the filter will be excluded rather than limiting the view.'),
+ '#default_value' => !empty($this->options['not']),
+ '#fieldset' => 'more',
+ );
+ }
+
+ /**
+ * Set up the query for this argument.
+ *
+ * The argument sent may be found at $this->argument.
+ */
+ public function query($group_by = FALSE) {
+ if (empty($this->value)) {
+ if (!empty($this->options['break_phrase'])) {
+ views_break_phrase($this->argument, $this);
+ }
+ else {
+ $this->value = array($this->argument);
+ }
+ }
+
+ $operator = empty($this->options['not']) ? '=' : '<>';
+
+ if (count($this->value) > 1) {
+ $filter = $this->query->createFilter(backdrop_strtoupper($this->operator));
+ // $filter will be NULL if there were errors in the query.
+ if ($filter) {
+ foreach ($this->value as $value) {
+ $filter->condition($this->real_field, $value, $operator);
+ }
+ $this->query->filter($filter);
+ }
+ }
+ else {
+ $this->query->condition($this->real_field, reset($this->value), $operator);
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_date.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_date.inc
new file mode 100644
index 000000000..a92c896e6
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_date.inc
@@ -0,0 +1,161 @@
+value)) {
+ $this->fillValue();
+ if ($this->value === FALSE) {
+ $this->abort();
+ return;
+ }
+ }
+
+ $outer_conjunction = strtoupper($this->operator);
+
+ if (empty($this->options['not'])) {
+ $operator = '=';
+ $inner_conjunction = 'OR';
+ }
+ else {
+ $operator = '<>';
+ $inner_conjunction = 'AND';
+ }
+
+ if (!empty($this->value)) {
+ if (!empty($this->value)) {
+ $outer_filter = $this->query->createFilter($outer_conjunction);
+ foreach ($this->value as $value) {
+ $value_filter = $this->query->createFilter($inner_conjunction);
+ $values = explode(';', $value);
+ $values = array_map(array($this, 'getTimestamp'), $values);
+ if (in_array(FALSE, $values, TRUE)) {
+ $this->abort();
+ return;
+ }
+ $is_range = (count($values) > 1);
+
+ $inner_filter = ($is_range ? $this->query->createFilter('AND') : $value_filter);
+ $range_op = (empty($this->options['not']) ? '>=' : '<');
+ $inner_filter->condition($this->real_field, $values[0], $is_range ? $range_op : $operator);
+ if ($is_range) {
+ $range_op = (empty($this->options['not']) ? '<=' : '>');
+ $inner_filter->condition($this->real_field, $values[1], $range_op);
+ $value_filter->filter($inner_filter);
+ }
+ $outer_filter->filter($value_filter);
+ }
+
+ $this->query->filter($outer_filter);
+ }
+ }
+ }
+
+ /**
+ * Converts a value to a timestamp, if it isn't one already.
+ *
+ * @param string|int $value
+ * The value to convert. Either a timestamp, or a date/time string as
+ * recognized by strtotime().
+ *
+ * @return int|false
+ * The parsed timestamp, or FALSE if an illegal string was passed.
+ */
+ public function getTimestamp($value) {
+ if (is_numeric($value)) {
+ return $value;
+ }
+
+ return strtotime($value);
+ }
+
+ /**
+ * Fills $this->value with data from the argument.
+ */
+ protected function fillValue() {
+ if (!empty($this->options['break_phrase'])) {
+ // Set up defaults:
+ if (!isset($this->value)) {
+ $this->value = array();
+ }
+
+ if (!isset($this->operator)) {
+ $this->operator = 'OR';
+ }
+
+ if (empty($this->argument)) {
+ return;
+ }
+
+ if (preg_match('/^([-\d;:\s]+\+)*[-\d;:\s]+$/', $this->argument)) {
+ // The '+' character in a query string may be parsed as ' '.
+ $this->value = explode('+', $this->argument);
+ }
+ elseif (preg_match('/^([-\d;:\s]+,)*[-\d;:\s]+$/', $this->argument)) {
+ $this->operator = 'AND';
+ $this->value = explode(',', $this->argument);
+ }
+
+ // Keep an 'error' value if invalid strings were given.
+ if (!empty($this->argument) && (empty($this->value) || !is_array($this->value))) {
+ $this->value = FALSE;
+ }
+ }
+ else {
+ $this->value = array($this->argument);
+ }
+ }
+
+ /**
+ * Aborts the associated query due to an illegal argument.
+ */
+ protected function abort() {
+ $variables['!field'] = $this->definition['group'] . ': ' . $this->definition['title'];
+ $this->query->abort(t('Illegal argument passed to !field contextual filter.', $variables));
+ }
+
+ /**
+ * Computes the title this argument will assign the view, given the argument.
+ *
+ * @return string
+ * A title fitting for the passed argument.
+ */
+ public function title() {
+ if (!empty($this->argument)) {
+ if (empty($this->value)) {
+ $this->fillValue();
+ }
+ $dates = array();
+ foreach ($this->value as $date) {
+ $date_parts = explode(';', $date);
+
+ $ts = $this->getTimestamp($date_parts[0]);
+ $datestr = format_date($ts, 'short');
+ if (count($date_parts) > 1) {
+ $ts = $this->getTimestamp($date_parts[1]);
+ $datestr .= ' - ' . format_date($ts, 'short');
+ }
+
+ if ($datestr) {
+ $dates[] = $datestr;
+ }
+ }
+
+ return $dates ? implode(', ', $dates) : check_plain($this->argument);
+ }
+
+ return check_plain($this->argument);
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_fulltext.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_fulltext.inc
new file mode 100644
index 000000000..a4db8e253
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_fulltext.inc
@@ -0,0 +1,112 @@
+ array());
+ $options['conjunction'] = array('default' => 'AND');
+ return $options;
+ }
+
+ /**
+ * Extend the options form a bit.
+ */
+ public function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ $form['help']['#markup'] = t('Note: You can change how search keys are parsed under "Advanced" > "Query settings".');
+
+ $fields = $this->getFulltextFields();
+ if (!empty($fields)) {
+ $form['fields'] = array(
+ '#type' => 'select',
+ '#title' => t('Searched fields'),
+ '#description' => t('Select the fields that will be searched. If no fields are selected, all available fulltext fields will be searched.'),
+ '#options' => $fields,
+ '#size' => min(4, count($fields)),
+ '#multiple' => TRUE,
+ '#default_value' => $this->options['fields'],
+ );
+ $form['conjunction'] = array(
+ '#title' => t('Operator'),
+ '#description' => t('Determines how multiple keywords entered for the search will be combined.'),
+ '#type' => 'radios',
+ '#options' => array(
+ 'AND' => t('Contains all of these words'),
+ 'OR' => t('Contains any of these words'),
+ ),
+ '#default_value' => $this->options['conjunction'],
+ );
+
+ }
+ else {
+ $form['fields'] = array(
+ '#type' => 'value',
+ '#value' => array(),
+ );
+ }
+ }
+
+ /**
+ * Set up the query for this argument.
+ *
+ * The argument sent may be found at $this->argument.
+ */
+ public function query($group_by = FALSE) {
+ if ($this->options['fields']) {
+ try {
+ $this->query->fields($this->options['fields']);
+ }
+ catch (SearchApiException $e) {
+ $this->query->abort($e->getMessage());
+ return;
+ }
+ }
+ if ($this->options['conjunction'] != 'AND') {
+ $this->query->setOption('conjunction', $this->options['conjunction']);
+ }
+
+ $old = $this->query->getOriginalKeys();
+ $this->query->keys($this->argument);
+ if ($old) {
+ $keys = &$this->query->getKeys();
+ if (is_array($keys)) {
+ $keys[] = $old;
+ }
+ elseif (is_array($old)) {
+ // We don't support such nonsense.
+ }
+ else {
+ $keys = "($old) ($keys)";
+ }
+ }
+ }
+
+ /**
+ * Helper method to get an option list of all available fulltext fields.
+ */
+ protected function getFulltextFields() {
+ $ret = array();
+ $index = search_api_index_load(substr($this->table, 17));
+ if (!empty($index->options['fields'])) {
+ $fields = $index->getFields();
+ foreach ($index->getFulltextFields() as $field) {
+ $ret[$field] = $fields[$field]['name'];
+ }
+ }
+ return $ret;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_more_like_this.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_more_like_this.inc
new file mode 100644
index 000000000..044f86495
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_more_like_this.inc
@@ -0,0 +1,111 @@
+ FALSE);
+ $options['fields'] = array('default' => array());
+ return $options;
+ }
+
+ /**
+ * Extend the options form a bit.
+ */
+ public function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+ unset($form['break_phrase']);
+ unset($form['not']);
+
+ $index = search_api_index_load(substr($this->table, 17));
+
+ if ($index->datasource() instanceof SearchApiCombinedEntityDataSourceController) {
+ $types = array_intersect_key(search_api_entity_type_options_list(), array_flip($index->options['datasource']['types']));
+ $form['entity_type'] = array(
+ '#type' => 'select',
+ '#title' => t('Entity type'),
+ '#description' => t('Select the entity type of the argument.'),
+ '#options' => $types,
+ '#default_value' => $this->options['entity_type'],
+ '#required' => TRUE,
+ );
+ }
+
+ if (!empty($index->options['fields'])) {
+ $fields = array();
+ foreach ($index->getFields() as $key => $field) {
+ $fields[$key] = $field['name'];
+ }
+ }
+ if (!empty($fields)) {
+ $form['fields'] = array(
+ '#type' => 'select',
+ '#title' => t('Fields for Similarity'),
+ '#description' => t('Select the fields that will be used for finding similar content. If no fields are selected, all available fields will be used.'),
+ '#options' => $fields,
+ '#size' => min(8, count($fields)),
+ '#multiple' => TRUE,
+ '#default_value' => $this->options['fields'],
+ );
+ }
+ else {
+ $form['fields'] = array(
+ '#type' => 'value',
+ '#value' => array(),
+ );
+ }
+ }
+
+ /**
+ * Set up the query for this argument.
+ *
+ * The argument sent may be found at $this->argument.
+ */
+ public function query($group_by = FALSE) {
+ try {
+ $server = $this->query->getIndex()->server();
+ if (!$server->supportsFeature('search_api_mlt')) {
+ $class = search_api_get_service_info($server->class);
+ watchdog('search_api_views', 'The search service "@class" does not offer "More like this" functionality.',
+ array('@class' => $class['name']), WATCHDOG_ERROR);
+ $this->query->abort();
+ return;
+ }
+ $index_fields = array_keys($this->query->getIndex()->options['fields']);
+ if (empty($this->options['fields'])) {
+ $fields = $index_fields;
+ }
+ else {
+ $fields = array_intersect($this->options['fields'], $index_fields);
+ }
+ if ($this->query->getIndex()->datasource() instanceof SearchApiCombinedEntityDataSourceController) {
+ $id = $this->options['entity_type'] . '/' . $this->argument;
+ }
+ else {
+ $id = $this->argument;
+ }
+
+ $mlt = array(
+ 'id' => $id,
+ 'fields' => $fields,
+ );
+ $this->query->getSearchApiQuery()->setOption('search_api_mlt', $mlt);
+ }
+ catch (SearchApiException $e) {
+ $this->query->abort($e->getMessage());
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_string.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_string.inc
new file mode 100644
index 000000000..f932ff0e1
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_string.inc
@@ -0,0 +1,31 @@
+argument.
+ */
+ public function query($group_by = FALSE) {
+ if (empty($this->value)) {
+ if (!empty($this->options['break_phrase'])) {
+ views_break_phrase_string($this->argument, $this);
+ }
+ else {
+ $this->value = array($this->argument);
+ }
+ }
+
+ parent::query($group_by);
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_taxonomy_term.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_taxonomy_term.inc
new file mode 100644
index 000000000..5ab97e15e
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_argument_taxonomy_term.inc
@@ -0,0 +1,104 @@
+argument.
+ */
+ public function query($group_by = FALSE) {
+ if (empty($this->value)) {
+ $this->fillValue();
+ }
+
+ $outer_conjunction = strtoupper($this->operator);
+
+ if (empty($this->options['not'])) {
+ $operator = '=';
+ $inner_conjunction = 'OR';
+ }
+ else {
+ $operator = '<>';
+ $inner_conjunction = 'AND';
+ }
+
+ if (!empty($this->value)) {
+ $terms = entity_load_multiple('taxonomy_term', $this->value);
+
+ if (!empty($terms)) {
+ $filter = $this->query->createFilter($outer_conjunction);
+ $vocabulary_fields = $this->definition['vocabulary_fields'];
+ $vocabulary_fields += array('' => array());
+ foreach ($terms as $term) {
+ $inner_filter = $filter;
+ if ($outer_conjunction != $inner_conjunction) {
+ $inner_filter = $this->query->createFilter($inner_conjunction);
+ }
+ // Set filters for all term reference fields which don't specify a
+ // vocabulary, as well as for all fields specifying the term's
+ // vocabulary.
+ if (!empty($this->definition['vocabulary_fields'][$term->vocabulary_machine_name])) {
+ foreach ($this->definition['vocabulary_fields'][$term->vocabulary_machine_name] as $field) {
+ $inner_filter->condition($field, $term->tid, $operator);
+ }
+ }
+ foreach ($vocabulary_fields[''] as $field) {
+ $inner_filter->condition($field, $term->tid, $operator);
+ }
+ if ($outer_conjunction != $inner_conjunction) {
+ $filter->filter($inner_filter);
+ }
+ }
+
+ $this->query->filter($filter);
+ }
+ }
+ }
+
+ /**
+ * Get the title this argument will assign the view, given the argument.
+ */
+ public function title() {
+ if (!empty($this->argument)) {
+ if (empty($this->value)) {
+ $this->fillValue();
+ }
+ $terms = array();
+ foreach ($this->value as $tid) {
+ $taxonomy_term = taxonomy_term_load($tid);
+ if ($taxonomy_term) {
+ $terms[] = check_plain($taxonomy_term->name);
+ }
+ }
+
+ return $terms ? implode(', ', $terms) : check_plain($this->argument);
+ }
+ else {
+ return check_plain($this->argument);
+ }
+ }
+
+ /**
+ * Fill $this->value with data from the argument.
+ *
+ * Uses views_break_phrase(), if appropriate.
+ */
+ protected function fillValue() {
+ if (!empty($this->options['break_phrase'])) {
+ views_break_phrase($this->argument, $this);
+ }
+ else {
+ $this->value = array($this->argument);
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter.inc
new file mode 100644
index 000000000..770526a82
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter.inc
@@ -0,0 +1,119 @@
+ t('Is less than'),
+ '<=' => t('Is less than or equal to'),
+ '=' => t('Is equal to'),
+ '<>' => t('Is not equal to'),
+ '>=' => t('Is greater than or equal to'),
+ '>' => t('Is greater than'),
+ 'empty' => t('Is empty'),
+ 'not empty' => t('Is not empty'),
+ );
+ }
+
+ /**
+ * Provide a form for setting the filter value.
+ */
+ public function value_form(&$form, &$form_state) {
+ while (is_array($this->value) && count($this->value) < 2) {
+ $this->value = $this->value ? reset($this->value) : NULL;
+ }
+ $form['value'] = array(
+ '#type' => 'textfield',
+ '#title' => empty($form_state['exposed']) ? t('Value') : '',
+ '#size' => 30,
+ '#default_value' => isset($this->value) ? $this->value : '',
+ );
+
+ // Hide the value box if the operator is 'empty' or 'not empty'.
+ // Radios share the same selector so we have to add some dummy selector.
+ if (empty($form_state['exposed'])) {
+ $form['value']['#states']['visible'] = array(
+ ':input[name="options[operator]"],dummy-empty' => array('!value' => 'empty'),
+ ':input[name="options[operator]"],dummy-not-empty' => array('!value' => 'not empty'),
+ );
+ }
+ elseif (!empty($this->options['expose']['use_operator'])) {
+ $name = $this->options['expose']['operator_id'];
+ $form['value']['#states']['visible'] = array(
+ ':input[name="' . $name . '"],dummy-empty' => array('!value' => 'empty'),
+ ':input[name="' . $name . '"],dummy-not-empty' => array('!value' => 'not empty'),
+ );
+ }
+ }
+
+ /**
+ * Display the filter on the administrative summary
+ */
+ function admin_summary() {
+ if (!empty($this->options['exposed'])) {
+ return t('exposed');
+ }
+
+ if ($this->operator === 'empty') {
+ return t('is empty');
+ }
+ if ($this->operator === 'not empty') {
+ return t('is not empty');
+ }
+
+ return check_plain((string) $this->operator) . ' ' . check_plain((string) $this->value);
+ }
+
+ /**
+ * Add this filter to the query.
+ */
+ public function query() {
+ if ($this->operator === 'empty') {
+ $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
+ }
+ elseif ($this->operator === 'not empty') {
+ $this->query->condition($this->real_field, NULL, '<>', $this->options['group']);
+ }
+ else {
+ while (is_array($this->value)) {
+ $this->value = $this->value ? reset($this->value) : NULL;
+ }
+ if (strlen($this->value) > 0) {
+ $this->query->condition($this->real_field, $this->value, $this->operator, $this->options['group']);
+ }
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_boolean.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_boolean.inc
new file mode 100644
index 000000000..c39416cf3
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_boolean.inc
@@ -0,0 +1,38 @@
+value)) {
+ $this->value = $this->value ? array_shift($this->value) : NULL;
+ }
+ $form['value'] = array(
+ '#type' => 'select',
+ '#title' => empty($form_state['exposed']) ? t('Value') : '',
+ '#options' => array(
+ 1 => t('True'),
+ 0 => t('False'),
+ ),
+ '#default_value' => isset($this->value) ? $this->value : '',
+ );
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_date.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_date.inc
new file mode 100644
index 000000000..164833c06
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_date.inc
@@ -0,0 +1,167 @@
+ array('default' => 'default'),
+ 'date_popup_format' => array('default' => 'm/d/Y'),
+ 'year_range' => array('default' => '-3:+3'),
+ );
+ }
+
+ /**
+ * If the date popup module is enabled, provide the extra option setting.
+ */
+ public function has_extra_options() {
+ if (module_exists('date_popup')) {
+ return TRUE;
+ }
+ return FALSE;
+ }
+
+ /**
+ * Add extra options if we allow the date popup widget.
+ */
+ public function extra_options_form(&$form, &$form_state) {
+ parent::extra_options_form($form, $form_state);
+
+ if (module_exists('date_popup')) {
+ $widget_options = array(
+ 'default' => 'Default',
+ 'date_popup' => 'Date popup',
+ );
+ $form['widget_type'] = array(
+ '#type' => 'radios',
+ '#title' => t('Date selection form element'),
+ '#default_value' => $this->options['widget_type'],
+ '#options' => $widget_options,
+ );
+ $form['date_popup_format'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Date format'),
+ '#default_value' => $this->options['date_popup_format'],
+ '#description' => t('A date in any format understood by PHP. For example, "Y-m-d" or "m/d/Y".', array(
+ '@doc-link' => 'http://php.net/manual/en/function.date.php',
+ )),
+ '#states' => array(
+ 'visible' => array(
+ ':input[name="options[widget_type]"]' => array('value' => 'date_popup'),
+ ),
+ ),
+ );
+ }
+
+ if (module_exists('date_api')) {
+ $form['year_range'] = array(
+ '#type' => 'date_year_range',
+ '#default_value' => $this->options['year_range'],
+ );
+ }
+ }
+
+ /**
+ * Validate extra options.
+ */
+ public function extra_options_validate($form, &$form_state) {
+ if (isset($form_state['values']['options']['year_range'])) {
+ if (!preg_match('/^(?:\-[0-9]{1,4}|[0-9]{4}):(?:[\+|\-][0-9]{1,4}|[0-9]{4})$/', $form_state['values']['options']['year_range'])) {
+ form_error($form['year_range'], t('Date year range must be in the format -9:+9, 2005:2010, -9:2010, or 2005:+9'));
+ }
+ }
+ }
+
+ /**
+ * Provide a form for setting the filter value.
+ */
+ public function value_form(&$form, &$form_state) {
+ parent::value_form($form, $form_state);
+
+ $is_date_popup = ($this->options['widget_type'] == 'date_popup' && module_exists('date_popup'));
+
+ // If the operator is between.
+ if ($this->operator == 'between') {
+ if ($is_date_popup) {
+ $form['value']['min']['#type'] = 'date_popup';
+ $form['value']['min']['#date_format'] = $this->options['date_popup_format'];
+ $form['value']['min']['#date_year_range'] = $this->options['year_range'];
+ $form['value']['max']['#type'] = 'date_popup';
+ $form['value']['max']['#date_format'] = $this->options['date_popup_format'];
+ $form['value']['max']['#date_year_range'] = $this->options['year_range'];
+ }
+ }
+ // If we are using the date popup widget, overwrite the settings of the form
+ // according to what date_popup expects.
+ elseif ($is_date_popup) {
+ // Add an "id" for the "value" field, since it is expected in
+ // date_views_form_views_exposed_form_alter().
+ // @see date_views_filter_handler_simple::value_form()
+ $form['value']['#id'] = 'date_views_exposed_filter-' . bin2hex(backdrop_random_bytes(16));
+ $form['value']['#type'] = 'date_popup';
+ $form['value']['#date_format'] = $this->options['date_popup_format'];
+ $form['value']['#date_year_range'] = $this->options['year_range'];
+ unset($form['value']['#description']);
+ }
+ elseif (empty($form_state['exposed'])) {
+ $form['value']['#description'] = t('A date in any format understood by PHP. For example, "@date1" or "@date2".', array(
+ '@doc-link' => 'http://php.net/manual/en/function.strtotime.php',
+ '@date1' => format_date(REQUEST_TIME, 'custom', 'Y-m-d H:i:s'),
+ '@date2' => 'now + 1 day',
+ ));
+ }
+ }
+
+ /**
+ * Add this filter to the query.
+ */
+ public function query() {
+ $this->normalizeValue();
+
+ if ($this->operator === 'empty') {
+ $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
+ }
+ elseif ($this->operator === 'not empty') {
+ $this->query->condition($this->real_field, NULL, '<>', $this->options['group']);
+ }
+ elseif (in_array($this->operator, array('between', 'not between'), TRUE)) {
+ $min = $this->value['min'];
+ if ($min !== '') {
+ $min = is_numeric($min) ? $min : strtotime($min, REQUEST_TIME);
+ }
+ $max = $this->value['max'];
+ if ($max !== '') {
+ $max = is_numeric($max) ? $max : strtotime($max, REQUEST_TIME);
+ }
+
+ if (is_numeric($min) && is_numeric($max)) {
+ $this->query->condition($this->real_field, array($min, $max), strtoupper($this->operator), $this->options['group']);
+ }
+ elseif (is_numeric($min)) {
+ $operator = $this->operator === 'between' ? '>=' : '<';
+ $this->query->condition($this->real_field, $min, $operator, $this->options['group']);
+ }
+ elseif (is_numeric($max)) {
+ $operator = $this->operator === 'between' ? '<=' : '>';
+ $this->query->condition($this->real_field, $min, $operator, $this->options['group']);
+ }
+ }
+ else {
+ $v = is_numeric($this->value['value']) ? $this->value['value'] : strtotime($this->value['value'], REQUEST_TIME);
+ if ($v !== FALSE) {
+ $this->query->condition($this->real_field, $v, $this->operator, $this->options['group']);
+ }
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_entity.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_entity.inc
new file mode 100644
index 000000000..82d239e12
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_entity.inc
@@ -0,0 +1,207 @@
+ $this->isMultiValued() ? t('Is one of') : t('Is'),
+ 'all of' => t('Is all of'),
+ '<>' => $this->isMultiValued() ? t('Is not one of') : t('Is not'),
+ 'empty' => t('Is empty'),
+ 'not empty' => t('Is not empty'),
+ );
+ if (!$this->isMultiValued()) {
+ unset($operators['all of']);
+ }
+ return $operators;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function value_form(&$form, &$form_state) {
+ parent::value_form($form, $form_state);
+
+ if (!is_array($this->value)) {
+ $this->value = $this->value ? array($this->value) : array();
+ }
+
+ // Set the correct default value in case the admin-set value is used (and a
+ // value is present). The value is used if the form is either not exposed,
+ // or the exposed form wasn't submitted yet. (There doesn't seem to be an
+ // easier way to check for that.)
+ if ($this->value && (empty($form_state['input']) || !empty($form_state['input']['live_preview']))) {
+ $form['value']['#default_value'] = $this->ids_to_strings($this->value);
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function value_validate($form, &$form_state) {
+ if (!empty($form['value'])) {
+ $value = &$form_state['values']['options']['value'];
+ if (strlen($value)) {
+ $values = $this->isMultiValued($form_state['values']['options']) ? backdrop_explode_tags($value) : array($value);
+ $ids = $this->validate_entity_strings($form['value'], $values);
+
+ if ($ids) {
+ $value = $ids;
+ }
+ }
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function accept_exposed_input($input) {
+ $rc = parent::accept_exposed_input($input);
+
+ if ($rc) {
+ // If we have previously validated input, override.
+ if ($this->validated_exposed_input) {
+ $this->value = $this->validated_exposed_input;
+ }
+ }
+
+ return $rc;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function exposed_validate(&$form, &$form_state) {
+ if (empty($this->options['exposed']) || empty($this->options['expose']['identifier'])) {
+ return;
+ }
+
+ $this->validated_exposed_input = FALSE;
+ $identifier = $this->options['expose']['identifier'];
+ $input = $form_state['values'][$identifier];
+
+ if ($this->options['is_grouped'] && isset($this->options['group_info']['group_items'][$input])) {
+ $this->operator = $this->options['group_info']['group_items'][$input]['operator'];
+ $input = $this->options['group_info']['group_items'][$input]['value'];
+ }
+
+ if (!strlen($input)) {
+ return;
+ }
+ $values = $this->isMultiValued() ? backdrop_explode_tags($input) : array($input);
+
+ if (!$this->options['is_grouped'] || ($this->options['is_grouped'] && ($input != 'All'))) {
+ $this->validated_exposed_input = $this->validate_entity_strings($form[$identifier], $values);
+ }
+ }
+
+ /**
+ * Determines whether multiple user names can be entered into this filter.
+ *
+ * This is either the case if the form isn't exposed, or if the " Allow
+ * multiple selections" option is enabled.
+ *
+ * @param array $options
+ * (optional) The options array to use. If not supplied, the options set on
+ * this filter will be used.
+ *
+ * @return bool
+ * TRUE if multiple values can be entered for this filter, FALSE otherwise.
+ */
+ protected function isMultiValued(array $options = array()) {
+ $options = $options ? $options : $this->options;
+ return empty($options['exposed']) || !empty($options['expose']['multiple']);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function admin_summary() {
+ if (!is_array($this->value)) {
+ $this->value = $this->value ? array($this->value) : array();
+ }
+ $value = $this->value;
+ $this->value = empty($value) ? '' : $this->ids_to_strings($value);
+ $ret = parent::admin_summary();
+ $this->value = $value;
+ return $ret;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function query() {
+ if ($this->operator === 'empty') {
+ $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
+ }
+ elseif ($this->operator === 'not empty') {
+ $this->query->condition($this->real_field, NULL, '<>', $this->options['group']);
+ }
+ elseif (is_array($this->value)) {
+ $all_of = $this->operator === 'all of';
+ $operator = $all_of ? '=' : $this->operator;
+ if (count($this->value) == 1) {
+ $this->query->condition($this->real_field, reset($this->value), $operator, $this->options['group']);
+ }
+ else {
+ $filter = $this->query->createFilter($operator === '<>' || $all_of ? 'AND' : 'OR');
+ foreach ($this->value as $value) {
+ $filter->condition($this->real_field, $value, $operator);
+ }
+ $this->query->filter($filter, $this->options['group']);
+ }
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_fulltext.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_fulltext.inc
new file mode 100644
index 000000000..19987958b
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_fulltext.inc
@@ -0,0 +1,273 @@
+operator_form($form, $form_state);
+ $form['operator']['#description'] = t('This operator is only useful when using \'Search keys\'.');
+ }
+
+ /**
+ * Provide a list of options for the operator form.
+ */
+ public function operator_options() {
+ return array(
+ 'AND' => t('Contains all of these words'),
+ 'OR' => t('Contains any of these words'),
+ 'NOT' => t('Contains none of these words'),
+ );
+ }
+
+ /**
+ * Specify the options this filter uses.
+ */
+ public function option_definition() {
+ $options = parent::option_definition();
+
+ $options['operator']['default'] = 'AND';
+
+ $options['mode'] = array('default' => 'keys');
+ $options['min_length'] = array('default' => '');
+ $options['fields'] = array('default' => array());
+
+ return $options;
+ }
+
+ /**
+ * Extend the options form a bit.
+ */
+ public function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ $form['mode'] = array(
+ '#title' => t('Use as'),
+ '#type' => 'radios',
+ '#options' => array(
+ 'keys' => t('Search keys – multiple words will be split and the filter will influence relevance. You can change how search keys are parsed under "Advanced" > "Query settings".'),
+ 'filter' => t("Search filter – use as a single phrase that restricts the result set but doesn't influence relevance."),
+ ),
+ '#default_value' => $this->options['mode'],
+ );
+
+ $fields = $this->getFulltextFields();
+ if (!empty($fields)) {
+ $form['fields'] = array(
+ '#type' => 'select',
+ '#title' => t('Searched fields'),
+ '#description' => t('Select the fields that will be searched. If no fields are selected, all available fulltext fields will be searched.'),
+ '#options' => $fields,
+ '#size' => min(4, count($fields)),
+ '#multiple' => TRUE,
+ '#default_value' => $this->options['fields'],
+ );
+ }
+ else {
+ $form['fields'] = array(
+ '#type' => 'value',
+ '#value' => array(),
+ );
+ }
+ if (isset($form['expose'])) {
+ $form['expose']['#weight'] = -5;
+ }
+
+ $form['min_length'] = array(
+ '#title' => t('Minimum keyword length'),
+ '#description' => t('Minimum length of each word in the search keys. Leave empty to allow all words.'),
+ '#type' => 'number',
+ '#min' => 1,
+ '#step' => 1,
+ '#size' => 4,
+ '#maxlength' => 4,
+ '#default_value' => $this->options['min_length'],
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function exposed_validate(&$form, &$form_state) {
+ // Only validate exposed input.
+ if (empty($this->options['exposed']) || empty($this->options['expose']['identifier'])) {
+ return;
+ }
+
+ // Don't validate on form reset.
+ if (!empty($form_state['triggering_element']['#value'])
+ && !empty($form['reset']['#value'])
+ && $form_state['triggering_element']['#value'] === $form['reset']['#value']) {
+ return;
+ }
+
+ // We only need to validate if there is a minimum word length set.
+ if ($this->options['min_length'] < 2) {
+ return;
+ }
+
+ $identifier = $this->options['expose']['identifier'];
+ $input = &$form_state['values'][$identifier];
+
+ if ($this->options['is_grouped'] && isset($this->options['group_info']['group_items'][$input])) {
+ $this->operator = $this->options['group_info']['group_items'][$input]['operator'];
+ $input = &$this->options['group_info']['group_items'][$input]['value'];
+ }
+
+ // If there is no input, we're fine.
+ if (!trim($input)) {
+ return;
+ }
+
+ $words = preg_split('/\s+/', $input);
+ $quoted = FALSE;
+ foreach ($words as $i => $word) {
+ $word_length = backdrop_strlen($word);
+ if (!$word_length) {
+ unset($words[$i]);
+ continue;
+ }
+ // Protect quoted strings.
+ if ($quoted && $word[strlen($word) - 1] === '"') {
+ $quoted = FALSE;
+ continue;
+ }
+ if ($quoted || $word[0] === '"') {
+ $quoted = TRUE;
+ continue;
+ }
+ if ($word_length < $this->options['min_length']) {
+ unset($words[$i]);
+ }
+ }
+ if (!$words) {
+ $vars['@count'] = $this->options['min_length'];
+ $msg = t('You must include at least one positive keyword with @count characters or more.', $vars);
+ form_error($form[$identifier], $msg);
+ }
+ $input = implode(' ', $words);
+ }
+
+ /**
+ * Add this filter to the query.
+ */
+ public function query() {
+ while (is_array($this->value)) {
+ $this->value = $this->value ? reset($this->value) : '';
+ }
+ // Catch empty strings entered by the user, but not "0".
+ if ($this->value === '') {
+ return;
+ }
+ $fields = $this->options['fields'];
+ $available_fields = array_keys($this->getFulltextFields());
+ $fields = $fields ? array_intersect($fields, $available_fields) : $available_fields;
+
+ // If something already specifically set different fields, we silently fall
+ // back to mere filtering.
+ $filter = $this->options['mode'] == 'filter';
+ if (!$filter) {
+ $old = $this->query->getFields();
+ $filter = $old && (array_diff($old, $fields) || array_diff($fields, $old));
+ }
+
+ if ($filter) {
+ $filter = $this->query->createFilter('OR');
+ $op = $this->operator === 'NOT' ? '<>' : '=';
+ foreach ($fields as $field) {
+ $filter->condition($field, $this->value, $op);
+ }
+ $this->query->filter($filter);
+ return;
+ }
+
+ // If the operator was set to OR or NOT, set OR as the conjunction. (It is
+ // also set for NOT since otherwise it would be "not all of these words".)
+ if ($this->operator != 'AND') {
+ $this->query->setOption('conjunction', 'OR');
+ }
+
+ try {
+ $this->query->fields($fields);
+ }
+ catch (SearchApiException $e) {
+ $this->query->abort($e->getMessage());
+ return;
+ }
+ $old = $this->query->getKeys();
+ $old_original = $this->query->getOriginalKeys();
+ $this->query->keys($this->value);
+ if ($this->operator == 'NOT') {
+ $keys = &$this->query->getKeys();
+ if (is_array($keys)) {
+ $keys['#negation'] = TRUE;
+ }
+ else {
+ // We can't know how negation is expressed in the server's syntax.
+ }
+ }
+
+ // If there were fulltext keys set, we take care to combine them in a
+ // meaningful way (especially with negated keys).
+ if ($old) {
+ $keys = &$this->query->getKeys();
+ // Array-valued keys are combined.
+ if (is_array($keys)) {
+ // If the old keys weren't parsed into an array, we instead have to
+ // combine the original keys.
+ if (is_scalar($old)) {
+ $keys = "($old) ({$this->value})";
+ }
+ else {
+ // If the conjunction or negation settings aren't the same, we have to
+ // nest both old and new keys array.
+ if (!empty($keys['#negation']) != !empty($old['#negation']) || $keys['#conjunction'] != $old['#conjunction']) {
+ $keys = array(
+ '#conjunction' => 'AND', $old, $keys,
+ );
+ }
+ // Otherwise, just add all individual words from the old keys to the
+ // new ones.
+ else {
+ foreach (element_children($old) as $i) {
+ $keys[] = $old[$i];
+ }
+ }
+ }
+ }
+ // If the parse mode was "direct" for both old and new keys, we
+ // concatenate them and set them both via method and reference (to also
+ // update the originalKeys property.
+ elseif (is_scalar($old_original)) {
+ $combined_keys = "($old_original) ($keys)";
+ $this->query->keys($combined_keys);
+ $keys = $combined_keys;
+ }
+ }
+ }
+
+ /**
+ * Helper method to get an option list of all available fulltext fields.
+ */
+ protected function getFulltextFields() {
+ $fields = array();
+ $index = search_api_index_load(substr($this->table, 17));
+ if (!empty($index->options['fields'])) {
+ $f = $index->getFields();
+ foreach ($index->getFulltextFields() as $name) {
+ $fields[$name] = $f[$name]['name'];
+ }
+ }
+ return $fields;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_language.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_language.inc
new file mode 100644
index 000000000..13433f78f
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_language.inc
@@ -0,0 +1,55 @@
+value_options = $options + $this->value_options;
+ }
+
+ /**
+ * Add this filter to the query.
+ */
+ public function query() {
+ global $language_content;
+
+ if (!is_array($this->value)) {
+ $this->value = $this->value ? array($this->value) : array();
+ }
+ foreach ($this->value as $i => $v) {
+ if ($v == 'current') {
+ $this->value[$i] = $language_content->language;
+ }
+ elseif ($v == 'default') {
+ $this->value[$i] = language_default('language');
+ }
+ elseif ($v == 'fallback' && module_exists('language_hierarchy')) {
+ $fallbacks = array($language_content->language => $language_content->language);
+ $fallbacks += array_keys(language_hierarchy_get_ancestors($language_content->language));
+ $this->value[$i] = backdrop_map_assoc($fallbacks);
+ }
+ }
+ parent::query();
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_numeric.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_numeric.inc
new file mode 100644
index 000000000..c04f2a297
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_numeric.inc
@@ -0,0 +1,248 @@
+normalizeValue();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function option_definition() {
+ $options = parent::option_definition();
+ $options['value'] = array(
+ 'contains' => array(
+ 'value' => array('default' => ''),
+ 'min' => array('default' => ''),
+ 'max' => array('default' => ''),
+ ),
+ );
+
+ return $options;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function operator_options() {
+ $operators = parent::operator_options();
+
+ $index = search_api_index_load(substr($this->table, 17));
+ $server = NULL;
+ try {
+ if ($index) {
+ $server = $index->server();
+ }
+ }
+ catch (SearchApiException $e) {
+ // Ignore.
+ }
+ if ($server && $server->supportsFeature('search_api_between')) {
+ $operators += array(
+ 'between' => t('Is between'),
+ 'not between' => t('Is not between'),
+ );
+ }
+
+ return $operators;
+ }
+
+ /**
+ * Provides a form for setting the filter value.
+ *
+ * Heavily borrowed from views_handler_filter_numeric.
+ *
+ * @see views_handler_filter_numeric::value_form()
+ */
+ public function value_form(&$form, &$form_state) {
+ $form['value']['#tree'] = TRUE;
+
+ $single_field_operators = $this->operator_options();
+ unset(
+ $single_field_operators['empty'],
+ $single_field_operators['not empty'],
+ $single_field_operators['between'],
+ $single_field_operators['not between']
+ );
+ $between_operators = array('between', 'not between');
+
+ // We have to make some choices when creating this as an exposed
+ // filter form. For example, if the operator is locked and thus
+ // not rendered, we can't render dependencies; instead we only
+ // render the form items we need.
+ $which = 'all';
+ $source = NULL;
+ if (!empty($form['operator'])) {
+ $source = ($form['operator']['#type'] == 'radios') ? 'radio:options[operator]' : 'edit-options-operator';
+ }
+
+ $identifier = NULL;
+ if (!empty($form_state['exposed'])) {
+ $identifier = $this->options['expose']['identifier'];
+ if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {
+ // Exposed and locked.
+ $which = in_array($this->operator, $between_operators) ? 'minmax' : 'value';
+ }
+ else {
+ $source = 'edit-' . backdrop_html_id($this->options['expose']['operator_id']);
+ }
+ }
+
+ // Hide the value box if the operator is 'empty' or 'not empty'.
+ // Radios share the same selector so we have to add some dummy selector.
+ if ($which == 'all') {
+ $form['value']['value'] = array(
+ '#type' => 'textfield',
+ '#title' => empty($form_state['exposed']) ? t('Value') : '',
+ '#size' => 30,
+ '#default_value' => $this->value['value'],
+ '#dependency' => array($source => array_keys($single_field_operators)),
+ );
+ if ($identifier && !isset($form_state['input'][$identifier]['value'])) {
+ $form_state['input'][$identifier]['value'] = $this->value['value'];
+ }
+ }
+ elseif ($which == 'value') {
+ // When exposed we drop the value-value and just do value if
+ // the operator is locked.
+ $form['value'] = array(
+ '#type' => 'textfield',
+ '#title' => empty($form_state['exposed']) ? t('Value') : '',
+ '#size' => 30,
+ '#default_value' => isset($this->value['value']) ? $this->value['value'] : '',
+ );
+ if ($identifier && !isset($form_state['input'][$identifier])) {
+ $form_state['input'][$identifier] = isset($this->value['value']) ? $this->value['value'] : '';
+ }
+ }
+
+ if ($which == 'all' || $which == 'minmax') {
+ $form['value']['min'] = array(
+ '#type' => 'textfield',
+ '#title' => empty($form_state['exposed']) ? t('Min') : '',
+ '#size' => 30,
+ '#default_value' => $this->value['min'],
+ );
+ $form['value']['max'] = array(
+ '#type' => 'textfield',
+ '#title' => empty($form_state['exposed']) ? t('And max') : t('And'),
+ '#size' => 30,
+ '#default_value' => $this->value['max'],
+ );
+
+ if ($which == 'all') {
+ $form['value']['min']['#dependency'] = array($source => $between_operators);
+ $form['value']['max']['#dependency'] = array($source => $between_operators);
+ }
+
+ if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['min'])) {
+ $form_state['input'][$identifier]['min'] = $this->value['min'];
+ }
+ if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['max'])) {
+ $form_state['input'][$identifier]['max'] = $this->value['max'];
+ }
+
+ if (!isset($form['value']['value'])) {
+ // Ensure there is something in the 'value'.
+ $form['value']['value'] = array(
+ '#type' => 'value',
+ '#value' => NULL,
+ );
+ }
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function admin_summary() {
+ if (!empty($this->options['exposed'])) {
+ return t('exposed');
+ }
+
+ if ($this->operator === 'empty') {
+ return t('is empty');
+ }
+ if ($this->operator === 'not empty') {
+ return t('is not empty');
+ }
+
+ if (in_array($this->operator, array('between', 'not between'), TRUE)) {
+ // This is of course wrong for translation purposes, but copied from
+ // views_handler_filter_numeric::admin_summary() so probably still better
+ // to re-use this than to do it correctly.
+ $operator = $this->operator === 'between' ? t('between') : t('not between');
+ $vars = array(
+ '@min' => (string) $this->value['min'],
+ '@max' => (string) $this->value['max'],
+ );
+ return $operator . ' ' . t('@min and @max', $vars);
+ }
+
+ return check_plain((string) $this->operator) . ' ' . check_plain((string) $this->value['value']);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function query() {
+ $this->normalizeValue();
+
+ if (in_array($this->operator, array('between', 'not between'), TRUE)) {
+ $min = $this->value['min'];
+ $max = $this->value['max'];
+ if ($min !== '' && $max !== '') {
+ $this->query->condition($this->real_field, array($min, $max), strtoupper($this->operator), $this->options['group']);
+ }
+ elseif ($min !== '') {
+ $operator = $this->operator === 'between' ? '>=' : '<';
+ $this->query->condition($this->real_field, $min, $operator, $this->options['group']);
+ }
+ elseif ($max !== '') {
+ $operator = $this->operator === 'between' ? '<=' : '>';
+ $this->query->condition($this->real_field, $max, $operator, $this->options['group']);
+ }
+ }
+ else {
+ // The parent handler doesn't expect our value structure, just pass the
+ // scalar value instead.
+ $this->value = $this->value['value'];
+ parent::query();
+ }
+ }
+
+ /**
+ * Sets $this->value to an array of options as defined by the filter.
+ *
+ * @see SearchApiViewsHandlerFilterNumeric::option_definition()
+ */
+ protected function normalizeValue() {
+ $value = $this->value;
+ if (is_array($value) && isset($value[0])) {
+ $value = $value[0];
+ }
+ if (!is_array($value)) {
+ $value = array('value' => $value);
+ }
+ $this->value = array(
+ 'value' => isset($value['value']) ? $value['value'] : '',
+ 'min' => isset($value['min']) ? $value['min'] : '',
+ 'max' => isset($value['max']) ? $value['max'] : '',
+ );
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_options.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_options.inc
new file mode 100644
index 000000000..88f61df4b
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_options.inc
@@ -0,0 +1,340 @@
+query) {
+ $index = $this->query->getIndex();
+ }
+ elseif (substr($this->view->base_table, 0, 17) == 'search_api_index_') {
+ $index = search_api_index_load(substr($this->view->base_table, 17));
+ }
+ else {
+ return NULL;
+ }
+ $wrapper = $index->entityWrapper(NULL, TRUE);
+ $parts = explode(':', $this->real_field);
+ foreach ($parts as $i => $part) {
+ if (!isset($wrapper->$part)) {
+ return NULL;
+ }
+ $wrapper = $wrapper->$part;
+ $info = $wrapper->info();
+ if ($i < count($parts) - 1) {
+ // Unwrap lists.
+ $level = search_api_list_nesting_level($info['type']);
+ for ($j = 0; $j < $level; ++$j) {
+ $wrapper = $wrapper[0];
+ }
+ }
+ }
+
+ return $wrapper;
+ }
+
+ /**
+ * Fills the value_options property with all possible options.
+ */
+ protected function get_value_options() {
+ if (isset($this->value_options)) {
+ return;
+ }
+
+ $wrapper = $this->get_wrapper();
+ if ($wrapper) {
+ $this->value_options = $wrapper->optionsList('view');
+ }
+ else {
+ $this->value_options = array();
+ }
+ }
+
+ /**
+ * Provide a list of options for the operator form.
+ */
+ public function operator_options() {
+ $options = array(
+ '=' => t('Is one of'),
+ 'all of' => t('Is all of'),
+ '<>' => t('Is none of'),
+ 'empty' => t('Is empty'),
+ 'not empty' => t('Is not empty'),
+ );
+ // "Is all of" doesn't make sense for single-valued fields.
+ if (empty($this->definition['multi-valued'])) {
+ unset($options['all of']);
+ }
+ return $options;
+ }
+
+ /**
+ * Set "reduce" option to FALSE by default.
+ */
+ public function expose_options() {
+ parent::expose_options();
+ $this->options['expose']['reduce'] = FALSE;
+ }
+
+ /**
+ * Add the "reduce" option to the exposed form.
+ */
+ public function expose_form(&$form, &$form_state) {
+ parent::expose_form($form, $form_state);
+ $form['expose']['reduce'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Limit list to selected items'),
+ '#description' => t('If checked, the only items presented to the user will be the ones selected here.'),
+ '#default_value' => !empty($this->options['expose']['reduce']),
+ );
+ }
+
+ /**
+ * Define "reduce" option.
+ */
+ public function option_definition() {
+ $options = parent::option_definition();
+ $options['value'] = array('default' => '');
+ $options['expose']['contains']['reduce'] = array('default' => FALSE);
+ return $options;
+ }
+
+ /**
+ * Reduce the options according to the selection.
+ */
+ protected function reduce_value_options() {
+ foreach ($this->value_options as $id => $option) {
+ if (!isset($this->options['value'][$id])) {
+ unset($this->value_options[$id]);
+ }
+ }
+ return $this->value_options;
+ }
+
+ /**
+ * Save set checkboxes.
+ */
+ public function value_submit($form, &$form_state) {
+ // Backdrop's FAPI system automatically puts '0' in for any checkbox that
+ // was not set, and the key to the checkbox if it is set.
+ // Unfortunately, this means that if the key to that checkbox is 0,
+ // we are unable to tell if that checkbox was set or not.
+ // Luckily, the '#value' on the checkboxes form actually contains
+ // *only* a list of checkboxes that were set, and we can use that
+ // instead.
+ $form_state['values']['options']['value'] = $form['value']['#value'];
+ }
+
+ /**
+ * Provide a form for setting options.
+ */
+ public function value_form(&$form, &$form_state) {
+ $this->get_value_options();
+ if (!empty($this->options['expose']['reduce']) && !empty($form_state['exposed'])) {
+ $options = $this->reduce_value_options();
+ }
+ else {
+ $options = $this->value_options;
+ }
+
+ $form['value'] = array(
+ '#type' => $this->value_form_type,
+ '#title' => empty($form_state['exposed']) ? t('Value') : '',
+ '#options' => $options,
+ '#multiple' => TRUE,
+ '#size' => min(4, count($options)),
+ '#default_value' => is_array($this->value) ? $this->value : array(),
+ );
+
+ // Hide the value box if the operator is 'empty' or 'not empty'.
+ // Radios share the same selector so we have to add some dummy selector.
+ if (empty($form_state['exposed'])) {
+ $form['value']['#states']['visible'] = array(
+ ':input[name="options[operator]"],dummy-empty' => array('!value' => 'empty'),
+ ':input[name="options[operator]"],dummy-not-empty' => array('!value' => 'not empty'),
+ );
+ }
+ elseif (!empty($this->options['expose']['use_operator'])) {
+ $name = $this->options['expose']['operator_id'];
+ $form['value']['#states']['visible'] = array(
+ ':input[name="' . $name . '"],dummy-empty' => array('!value' => 'empty'),
+ ':input[name="' . $name . '"],dummy-not-empty' => array('!value' => 'not empty'),
+ );
+ }
+ }
+
+ /**
+ * Provides a summary of this filter's value for the admin UI.
+ */
+ public function admin_summary() {
+ if (!empty($this->options['exposed'])) {
+ return t('exposed');
+ }
+
+ if ($this->operator === 'empty') {
+ return t('is empty');
+ }
+ if ($this->operator === 'not empty') {
+ return t('is not empty');
+ }
+
+ if (!is_array($this->value)) {
+ return;
+ }
+
+ $operator_options = $this->operator_options();
+ $operator = $operator_options[$this->operator];
+ $values = '';
+
+ // Remove every element which is not known.
+ $this->get_value_options();
+ foreach ($this->value as $i => $value) {
+ if (!isset($this->value_options[$value])) {
+ unset($this->value[$i]);
+ }
+ }
+ // Choose different kind of ouput for 0, a single and multiple values.
+ if (count($this->value) == 0) {
+ return $this->operator != '<>' ? t('none') : t('any');
+ }
+ elseif (count($this->value) == 1) {
+ switch ($this->operator) {
+ case '=':
+ case 'all of':
+ $operator = '=';
+ break;
+
+ case '<>':
+ $operator = '<>';
+ break;
+ }
+ // If there is only a single value, use just the plain operator, = or <>.
+ $operator = check_plain($operator);
+ $values = check_plain($this->value_options[reset($this->value)]);
+ }
+ else {
+ foreach ($this->value as $value) {
+ if ($values !== '') {
+ $values .= ', ';
+ }
+ if (backdrop_strlen($values) > 20) {
+ $values .= '…';
+ break;
+ }
+ $values .= check_plain($this->value_options[$value]);
+ }
+ }
+
+ return $operator . (($values !== '') ? ' ' . $values : '');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ function accept_exposed_input($input) {
+ $accepted = parent::accept_exposed_input($input);
+
+ // Grouped filters will have the raw form values structure from the
+ // checkboxes as the value here. Convert that into the correct array of
+ // values instead.
+ if ($accepted && is_array($this->value) && $this->is_a_group()) {
+ // For some reason, Views thinks it's a good idea to nest the form values
+ // into a second array in some cases. That one will be numerically indexed
+ // with just a single entry, though, so it should be relatively easy to
+ // spot.
+ if (count($this->value) && isset($this->value[0])) {
+ $this->value = reset($this->value);
+ }
+ $this->value = array_keys(array_filter($this->value));
+ if (!$this->value) {
+ return FALSE;
+ }
+ }
+
+ return $accepted;
+ }
+
+ /**
+ * Add this filter to the query.
+ */
+ public function query() {
+ if ($this->operator === 'empty') {
+ $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
+ return;
+ }
+ if ($this->operator === 'not empty') {
+ $this->query->condition($this->real_field, NULL, '<>', $this->options['group']);
+ return;
+ }
+
+ // Extract the value.
+ while (is_array($this->value) && count($this->value) == 1) {
+ $this->value = reset($this->value);
+ }
+
+ // Determine operator and conjunction. The defaults are already right for
+ // "all of".
+ $operator = '=';
+ $conjunction = 'AND';
+ switch ($this->operator) {
+ case '=':
+ $conjunction = 'OR';
+ break;
+
+ case '<>':
+ $operator = '<>';
+ break;
+ }
+
+ // If the value is an empty array, we either want no filter at all (for
+ // "is none of"), or want to find only items with no value for the field.
+ if ($this->value === array()) {
+ if ($operator != '<>') {
+ $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
+ }
+ return;
+ }
+
+ if (is_scalar($this->value) && $this->value !== '') {
+ $this->query->condition($this->real_field, $this->value, $operator, $this->options['group']);
+ }
+ elseif ($this->value) {
+ $filter = $this->query->createFilter($conjunction);
+ // $filter will be NULL if there were errors in the query.
+ if ($filter) {
+ foreach ($this->value as $v) {
+ $filter->condition($this->real_field, $v, $operator);
+ }
+ $this->query->filter($filter, $this->options['group']);
+ }
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_taxonomy_term.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_taxonomy_term.inc
new file mode 100644
index 000000000..e9a1f1f5d
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_taxonomy_term.inc
@@ -0,0 +1,338 @@
+definition['vocabulary']);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function option_definition() {
+ $options = parent::option_definition();
+
+ $options['type'] = array('default' => !empty($this->definition['vocabulary']) ? 'textfield' : 'select');
+ $options['hierarchy'] = array('default' => 0);
+ $options['expose']['contains']['reduce'] = array('default' => FALSE);
+ $options['error_message'] = array(
+ 'default' => TRUE,
+ 'bool' => TRUE,
+ );
+
+ return $options;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function extra_options_form(&$form, &$form_state) {
+ $form['type'] = array(
+ '#type' => 'radios',
+ '#title' => t('Selection type'),
+ '#options' => array(
+ 'select' => t('Dropdown'),
+ 'textfield' => t('Autocomplete'),
+ ),
+ '#default_value' => $this->options['type'],
+ );
+
+ $form['hierarchy'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Show hierarchy in dropdown'),
+ '#default_value' => !empty($this->options['hierarchy']),
+ );
+ $form['hierarchy']['#states']['visible'][':input[name="options[type]"]']['value'] = 'select';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function value_form(&$form, &$form_state) {
+ parent::value_form($form, $form_state);
+
+ if (!empty($this->definition['vocabulary'])) {
+ $vocabulary = taxonomy_vocabulary_load($this->definition['vocabulary']);
+ $title = t('Select terms from vocabulary @voc', array('@voc' => $vocabulary->name));
+ }
+ else {
+ $vocabulary = FALSE;
+ $title = t('Select terms');
+ }
+ $form['value']['#title'] = $title;
+
+ if ($vocabulary && $this->options['type'] == 'textfield') {
+ $form['value']['#autocomplete_path'] = 'admin/views/ajax/autocomplete/taxonomy/' . $vocabulary->machine_name;
+ }
+ else {
+ if ($vocabulary && !empty($this->options['hierarchy'])) {
+ $tree = taxonomy_get_tree($vocabulary->machine_name, 0, NULL, TRUE);
+ $options = array();
+
+ if ($tree) {
+ foreach ($tree as $term) {
+ $choice = new stdClass();
+ $choice->option = array($term->tid => str_repeat('-', $term->depth) . check_plain(entity_label('taxonomy_term', $term)));
+ $options[] = $choice;
+ }
+ }
+ }
+ else {
+ $options = array();
+ $query = db_select('taxonomy_term_data', 'td');
+ $query->fields('td');
+ $query->orderby('td.vocabulary');
+ $query->orderby('td.weight');
+ $query->orderby('td.name');
+ $query->addTag('taxonomy_term_access');
+ if ($vocabulary) {
+ $query->condition('td.vocabulary', $vocabulary->machine_name);
+ }
+ $result = $query->execute();
+ $tids = array();
+
+ foreach ($result as $term) {
+ $tids[] = $term->tid;
+ }
+ $terms = taxonomy_term_load_multiple($tids);
+
+ foreach ($terms as $term) {
+ $options[$term->tid] = check_plain(entity_label('taxonomy_term', $term));
+ }
+ }
+
+ $default_value = (array) $this->value;
+
+ if (!empty($form_state['exposed'])) {
+ $identifier = $this->options['expose']['identifier'];
+
+ if (!empty($this->options['expose']['reduce'])) {
+ $options = $this->reduce_value_options($options);
+
+ if (!empty($this->options['expose']['multiple']) && empty($this->options['expose']['required'])) {
+ $default_value = array();
+ }
+ }
+
+ if (empty($this->options['expose']['multiple'])) {
+ if (empty($this->options['expose']['required']) && (empty($default_value) || !empty($this->options['expose']['reduce']))) {
+ $default_value = 'All';
+ }
+ elseif (empty($default_value)) {
+ $keys = array_keys($options);
+ $default_value = array_shift($keys);
+ }
+ // Due to #1464174 there is a chance that array('') was saved in the
+ // admin ui. Let's choose a safe default value.
+ elseif ($default_value == array('')) {
+ $default_value = 'All';
+ }
+ else {
+ $copy = $default_value;
+ $default_value = array_shift($copy);
+ }
+ }
+ }
+ $form['value']['#type'] = 'select';
+ $form['value']['#multiple'] = TRUE;
+ $form['value']['#options'] = $options;
+ $form['value']['#size'] = min(9, count($options));
+ $form['value']['#default_value'] = $default_value;
+
+ if (!empty($form_state['exposed']) && isset($identifier) && !isset($form_state['input'][$identifier])) {
+ $form_state['input'][$identifier] = $default_value;
+ }
+ }
+ }
+
+ /**
+ * Reduces the available exposed options according to the selection.
+ */
+ protected function reduce_value_options(array $options) {
+ foreach ($options as $id => $option) {
+ if (empty($this->options['value'][$id])) {
+ unset($options[$id]);
+ }
+ }
+ return $options;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function value_validate($form, &$form_state) {
+ // We only validate if they've chosen the text field style.
+ if ($this->options['type'] != 'textfield') {
+ return;
+ }
+
+ parent::value_validate($form, $form_state);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function accept_exposed_input($input) {
+ if (empty($this->options['exposed'])) {
+ return TRUE;
+ }
+
+ // We need to know the operator, which is normally set in
+ // views_handler_filter::accept_exposed_input(), before we actually call
+ // the parent version of ourselves.
+ if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id']) && isset($input[$this->options['expose']['operator_id']])) {
+ $this->operator = $input[$this->options['expose']['operator_id']];
+ }
+
+ // If view is an attachment and is inheriting exposed filters, then assume
+ // exposed input has already been validated.
+ if (!empty($this->view->is_attachment) && $this->view->display_handler->uses_exposed()) {
+ $this->validated_exposed_input = (array) $this->view->exposed_raw_input[$this->options['expose']['identifier']];
+ }
+
+ // If we're checking for EMPTY or NOT, we don't need any input, and we can
+ // say that our input conditions are met by just having the right operator.
+ if ($this->operator == 'empty' || $this->operator == 'not empty') {
+ return TRUE;
+ }
+
+ // If it's non-required and there's no value don't bother filtering.
+ if (!$this->options['expose']['required'] && empty($this->validated_exposed_input)) {
+ return FALSE;
+ }
+
+ return parent::accept_exposed_input($input);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function exposed_validate(&$form, &$form_state) {
+ if (empty($this->options['exposed']) || empty($this->options['expose']['identifier'])) {
+ return;
+ }
+
+ // We only validate if they've chosen the text field style.
+ if ($this->options['type'] != 'textfield') {
+ $input = $form_state['values'][$this->options['expose']['identifier']];
+ if ($this->options['is_grouped'] && isset($this->options['group_info']['group_items'][$input])) {
+ $input = $this->options['group_info']['group_items'][$input]['value'];
+ }
+
+ if ($input != 'All') {
+ $this->validated_exposed_input = (array) $input;
+ }
+ return;
+ }
+
+ parent::exposed_validate($form, $form_state);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function expose_options() {
+ parent::expose_options();
+ $this->options['expose']['reduce'] = FALSE;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function validate_entity_strings(array &$form, array $values) {
+ if (empty($values)) {
+ return array();
+ }
+
+ $tids = array();
+ $names = array();
+ $missing = array();
+ foreach ($values as $value) {
+ $missing[strtolower($value)] = TRUE;
+ $names[] = $value;
+ }
+
+ if (!$names) {
+ return FALSE;
+ }
+
+ $query = db_select('taxonomy_term_data', 'td');
+ $query->fields('td');
+ $query->condition('td.name', $names);
+ if (!empty($this->definition['vocabulary'])) {
+ $query->condition('td.machine_name', $this->definition['vocabulary']);
+ }
+ $query->addTag('taxonomy_term_access');
+ $result = $query->execute();
+ foreach ($result as $term) {
+ unset($missing[strtolower($term->name)]);
+ $tids[] = $term->tid;
+ }
+
+ if ($missing) {
+ if (!empty($this->options['error_message'])) {
+ form_error($form, format_plural(count($missing), 'Unable to find term: @terms', 'Unable to find terms: @terms', array('@terms' => implode(', ', array_keys($missing)))));
+ }
+ else {
+ // Add a bogus TID which will show an empty result for a positive filter
+ // and be ignored for an excluding one.
+ $tids[] = 0;
+ }
+ }
+
+ return $tids;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function expose_form(&$form, &$form_state) {
+ parent::expose_form($form, $form_state);
+
+ if ($this->options['type'] == 'select') {
+ $form['expose']['reduce'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Limit list to selected items'),
+ '#description' => t('If checked, the only items presented to the user will be the ones selected here.'),
+ '#default_value' => $this->options['expose']['reduce'],
+ );
+ }
+ else {
+ $form['error_message'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Display error message'),
+ '#description' => t('Display an error message if one of the entered terms could not be found.'),
+ '#default_value' => $this->options['error_message'],
+ );
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function ids_to_strings(array $ids) {
+ $ids = array_filter($ids);
+ if (!$ids) {
+ return '';
+ }
+ return implode(', ', db_select('taxonomy_term_data', 'td')
+ ->fields('td', array('name'))
+ ->condition('td.tid', $ids)
+ ->execute()
+ ->fetchCol());
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_text.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_text.inc
new file mode 100644
index 000000000..83152a1d4
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_text.inc
@@ -0,0 +1,68 @@
+ t('contains'), '<>' => t("doesn't contain"));
+ }
+
+ /**
+ * Determines whether input from the exposed filters affects this filter.
+ *
+ * Overridden to not treat "All" differently.
+ *
+ * @param array $input
+ * The user input from the exposed filters.
+ *
+ * @return bool
+ * TRUE if the input should change the behavior of this filter.
+ */
+ public function accept_exposed_input($input) {
+ if (empty($this->options['exposed'])) {
+ return TRUE;
+ }
+
+ if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id']) && isset($input[$this->options['expose']['operator_id']])) {
+ $this->operator = $input[$this->options['expose']['operator_id']];
+ }
+
+ if (!empty($this->options['expose']['identifier'])) {
+ $value = $input[$this->options['expose']['identifier']];
+
+ // Various ways to check for the absence of non-required input.
+ if (empty($this->options['expose']['required'])) {
+ if (($this->operator == 'empty' || $this->operator == 'not empty') && $value === '') {
+ $value = ' ';
+ }
+
+ if (!empty($this->always_multiple) && $value === '') {
+ return FALSE;
+ }
+ }
+
+ if (isset($value)) {
+ $this->value = $value;
+ if (empty($this->always_multiple) && empty($this->options['expose']['multiple'])) {
+ $this->value = array($value);
+ }
+ }
+ else {
+ return FALSE;
+ }
+ }
+
+ return TRUE;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_user.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_user.inc
new file mode 100644
index 000000000..29f42d1e1
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_filter_user.inc
@@ -0,0 +1,79 @@
+isMultiValued() ? 'admin/views/ajax/autocomplete/user' : 'user/autocomplete';
+ $form['value']['#autocomplete_path'] = $path;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function ids_to_strings(array $ids) {
+ $names = array();
+ $args[':uids'] = array_filter($ids);
+ if ($args[':uids']) {
+ $result = db_query('SELECT uid, name FROM {users} u WHERE uid IN (:uids)', $args);
+ $result = $result->fetchAllKeyed();
+ }
+ foreach ($ids as $uid) {
+ if (!$uid) {
+ $names[] = config_get('system.performance', 'anonymous');
+ }
+ elseif (isset($result[$uid])) {
+ $names[] = $result[$uid];
+ }
+ }
+ return implode(', ', $names);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function validate_entity_strings(array &$form, array $values) {
+ $uids = array();
+ $missing = array();
+ foreach ($values as $value) {
+ if (backdrop_strtolower($value) === backdrop_strtolower(config_get('system.performance', 'anonymous'))) {
+ $uids[] = 0;
+ }
+ else {
+ $missing[strtolower($value)] = $value;
+ }
+ }
+
+ if (!$missing) {
+ return $uids;
+ }
+
+ $result = db_query("SELECT * FROM {users} WHERE name IN (:names)", array(':names' => array_values($missing)));
+ foreach ($result as $account) {
+ unset($missing[strtolower($account->name)]);
+ $uids[] = $account->uid;
+ }
+
+ if ($missing) {
+ form_error($form, format_plural(count($missing), 'Unable to find user: @users', 'Unable to find users: @users', array('@users' => implode(', ', $missing))));
+ }
+
+ return $uids;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_sort.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_sort.inc
new file mode 100644
index 000000000..d7ca1e47d
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/handler_sort.inc
@@ -0,0 +1,50 @@
+orderby to an empty array. Therefore, if that property is set,
+ // we here remove all previous sorts.
+ if (isset($this->query->orderby)) {
+ unset($this->query->orderby);
+ $sort = &$this->query->getSort();
+ $sort = array();
+ unset($sort);
+ }
+
+ // If two of the same fields are used for sort, ignore the latter in order
+ // for the prior to take precedence. (Temporary workaround until
+ // https://www.drupal.org/node/2145547 is fixed in Views.)
+ $alreadySorted = $this->query->getSort();
+ if (is_array($alreadySorted) && isset($alreadySorted[$this->real_field])) {
+ return;
+ }
+
+ try {
+ $this->query->sort($this->real_field, $this->options['order']);
+ }
+ catch (SearchApiException $e) {
+ $this->query->abort($e->getMessage());
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/plugin_cache.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/plugin_cache.inc
new file mode 100644
index 000000000..0c5984e36
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/plugin_cache.inc
@@ -0,0 +1,146 @@
+get_results_key();
+ $results = NULL;
+ $query_plugin = $this->view->query;
+ if ($query_plugin instanceof SearchApiViewsQuery) {
+ $results = $query_plugin->getSearchApiResults();
+ }
+ $data = array(
+ 'result' => $this->view->result,
+ 'total_rows' => isset($this->view->total_rows) ? $this->view->total_rows : 0,
+ 'current_page' => $this->view->get_current_page(),
+ 'search_api results' => $results,
+ );
+ cache_set($cid, $data, $this->bin, $this->cache_set_expire($type));
+ }
+
+ /**
+ * Overrides views_plugin_cache::cache_get().
+ *
+ * Additionally stores successfully retrieved results with
+ * search_api_current_search().
+ */
+ public function cache_get($type) {
+ if ($type != 'results') {
+ return parent::cache_get($type);
+ }
+
+ // Values to set: $view->result, $view->total_rows, $view->execute_time,
+ // $view->current_page.
+ if ($cache = cache_get($this->get_results_key(), $this->bin)) {
+ $cutoff = $this->cache_expire($type);
+ if (!$cutoff || $cache->created > $cutoff) {
+ $this->view->result = $cache->data['result'];
+ $this->view->total_rows = $cache->data['total_rows'];
+ $this->view->set_current_page($cache->data['current_page']);
+ $this->view->execute_time = 0;
+
+ // Trick Search API into believing a search happened, to make facetting
+ // et al. work.
+ $query = $this->getSearchApiQuery();
+ search_api_current_search($query->getOption('search id'), $query, $cache->data['search_api results']);
+
+ return TRUE;
+ }
+ }
+ return FALSE;
+ }
+
+ /**
+ * Overrides views_plugin_cache::get_cache_key().
+ *
+ * Use the Search API query as the main source for the key. Note that in
+ * Views < 3.8, this method does not exist.
+ */
+ public function get_cache_key($key_data = array()) {
+ global $user;
+
+ if (!isset($this->_results_key)) {
+ $query = $this->getSearchApiQuery();
+ $query->preExecute();
+ $key_data += array(
+ 'query' => $query,
+ 'roles' => array_keys($user->roles),
+ 'super-user' => $user->uid == 1, // Special caching for super user.
+ 'language' => $GLOBALS['language']->langcode,
+ 'base_url' => $GLOBALS['base_url'],
+ 'offset' => $this->view->get_current_page() . '*' . $this->view->get_items_per_page() . '+' . $this->view->get_offset(),
+ );
+ // Not sure what gets passed in exposed_info, so better include it. All
+ // other parameters used in the parent method are already reflected in the
+ // Search API query object we use.
+ if (isset($_GET['exposed_info'])) {
+ $key_data['exposed_info'] = $_GET['exposed_info'];
+ }
+ }
+ $key = backdrop_hash_base64(serialize($key_data));
+ return $key;
+ }
+
+ /**
+ * Overrides views_plugin_cache::get_results_key().
+ *
+ * This is unnecessary for Views >= 3.8.
+ */
+ public function get_results_key() {
+ if (!isset($this->_results_key)) {
+ $this->_results_key = $this->view->name . ':' . $this->display->id . ':results:' . $this->get_cache_key();
+ }
+
+ return $this->_results_key;
+ }
+
+ /**
+ * Retrieves the Search API query object associated with the current view.
+ *
+ * @return SearchApiQueryInterface|null
+ * The Search API query object associated with the current view; or NULL if
+ * there is none.
+ */
+ protected function getSearchApiQuery() {
+ if (!isset($this->search_api_query)) {
+ $this->search_api_query = FALSE;
+ if (isset($this->view->query) && $this->view->query instanceof SearchApiViewsQuery) {
+ $this->search_api_query = $this->view->query->getSearchApiQuery();
+ }
+ }
+
+ return $this->search_api_query ? $this->search_api_query : NULL;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/plugin_content_cache.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/plugin_content_cache.inc
new file mode 100644
index 000000000..f7da404be
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/plugin_content_cache.inc
@@ -0,0 +1,146 @@
+get_results_key();
+ $results = NULL;
+ $query_plugin = $this->view->query;
+ if ($query_plugin instanceof SearchApiViewsQuery) {
+ $results = $query_plugin->getSearchApiResults();
+ }
+ $data = array(
+ 'result' => $this->view->result,
+ 'total_rows' => isset($this->view->total_rows) ? $this->view->total_rows : 0,
+ 'current_page' => $this->view->get_current_page(),
+ 'search_api results' => $results,
+ );
+ cache_set($cid, $data, $this->table, $this->cache_set_expire($type));
+ }
+
+ /**
+ * Overrides views_plugin_cache::cache_get().
+ *
+ * Additionally stores successfully retrieved results with
+ * search_api_current_search().
+ */
+ public function cache_get($type) {
+ if ($type != 'results') {
+ return parent::cache_get($type);
+ }
+
+ // Values to set: $view->result, $view->total_rows, $view->execute_time,
+ // $view->current_page.
+ if ($cache = cache_get($this->get_results_key(), $this->table)) {
+ $cutoff = $this->cache_expire($type);
+ if (!$cutoff || $cache->created > $cutoff) {
+ $this->view->result = $cache->data['result'];
+ $this->view->total_rows = $cache->data['total_rows'];
+ $this->view->set_current_page($cache->data['current_page']);
+ $this->view->execute_time = 0;
+
+ // Trick Search API into believing a search happened, to make facetting
+ // et al. work.
+ $query = $this->getSearchApiQuery();
+ search_api_current_search($query->getOption('search id'), $query, $cache->data['search_api results']);
+
+ return TRUE;
+ }
+ }
+ return FALSE;
+ }
+
+ /**
+ * Overrides views_plugin_cache::get_cache_key().
+ *
+ * Use the Search API query as the main source for the key. Note that in
+ * Views < 3.8, this method does not exist.
+ */
+ public function get_cache_key($key_data = array()) {
+ global $user;
+
+ if (!isset($this->_results_key)) {
+ $query = $this->getSearchApiQuery();
+ $query->preExecute();
+ $key_data += array(
+ 'query' => $query,
+ 'roles' => array_keys($user->roles),
+ 'super-user' => $user->uid == 1, // Special caching for super user.
+ 'language' => $GLOBALS['language']->language,
+ 'base_url' => $GLOBALS['base_url'],
+ 'offset' => $this->view->get_current_page() . '*' . $this->view->get_items_per_page() . '+' . $this->view->get_offset(),
+ );
+ // Not sure what gets passed in exposed_info, so better include it. All
+ // other parameters used in the parent method are already reflected in the
+ // Search API query object we use.
+ if (isset($_GET['exposed_info'])) {
+ $key_data['exposed_info'] = $_GET['exposed_info'];
+ }
+ }
+ $key = backdrop_hash_base64(serialize($key_data));
+ return $key;
+ }
+
+ /**
+ * Overrides views_plugin_cache::get_results_key().
+ *
+ * This is unnecessary for Views >= 3.8.
+ */
+ public function get_results_key() {
+ if (!isset($this->_results_key)) {
+ $this->_results_key = $this->view->name . ':' . $this->display->id . ':results:' . $this->get_cache_key();
+ }
+
+ return $this->_results_key;
+ }
+
+ /**
+ * Retrieves the Search API query object associated with the current view.
+ *
+ * @return SearchApiQueryInterface|null
+ * The Search API query object associated with the current view; or NULL if
+ * there is none.
+ */
+ protected function getSearchApiQuery() {
+ if (!isset($this->search_api_query)) {
+ $this->search_api_query = FALSE;
+ if (isset($this->view->query) && $this->view->query instanceof SearchApiViewsQuery) {
+ $this->search_api_query = $this->view->query->getSearchApiQuery();
+ }
+ }
+
+ return $this->search_api_query ? $this->search_api_query : NULL;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/includes/query.inc b/www/modules/contrib/search_api/contrib/search_api_views/includes/query.inc
new file mode 100644
index 000000000..b85af71c7
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/includes/query.inc
@@ -0,0 +1,794 @@
+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, if we have one.
+ $path = $this->view->get_url();
+ if ($path) {
+ $this->query->setOption('search_api_base_path', $path);
+ }
+
+ // Save query information for Views UI.
+ $view->build_info['query'] = (string) $this->query;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function alter(&$view) {
+ parent::alter($view);
+ backdrop_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) {
+ backdrop_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 EntityPlusFieldHandlerHelper to compute the correct data selector for
+ // the relationship.
+ $handler = (object) array(
+ 'view' => $this->view,
+ 'relationship' => $relationship,
+ 'real_field' => '',
+ );
+ $selector = EntityPlusFieldHandlerHelper::construct_property_selector($handler);
+ $selector .= ($selector ? ':' : '') . $selector_suffix;
+ list($type, $wrappers) = EntityPlusFieldHandlerHelper::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;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.api.php b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.api.php
new file mode 100644
index 000000000..95a92ca2d
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.api.php
@@ -0,0 +1,34 @@
+name == 'my_view' && is_numeric($view->exposed_raw_input['title']) && $view->exposed_raw_input['title'] > 0) {
+ // Traverse through the 'where' part of the query.
+ foreach ($query->where as &$condition_group) {
+ foreach ($condition_group['conditions'] as &$condition) {
+ // If this is the part of the query filtering on title, chang the
+ // condition to filter on node ID.
+ if (reset($condition) == 'node.title') {
+ $condition = array('node.nid', $view->exposed_raw_input['title'],'=');
+ }
+ }
+ }
+ }
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.info b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.info
new file mode 100644
index 000000000..3b8a6db51
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.info
@@ -0,0 +1,12 @@
+name = Search Views
+description = Integrates the Search API with Views, enabling users to create views with searches as filters or arguments.
+dependencies[] = search_api:search_api
+dependencies[] = entity_plus (>=1.x-1.0.10)
+backdrop = 1.x
+type = module
+package = Search
+
+; Added by Backdrop CMS packaging script on 2026-02-06
+project = search_api
+version = 1.x-1.29.5
+timestamp = 1770395528
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.install b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.install
new file mode 100644
index 000000000..ac0431459
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.install
@@ -0,0 +1,13 @@
+ '3.0',
+ 'path' => backdrop_get_path('module', 'search_api_views') . '/views',
+ );
+}
+
+/**
+ * Implements hook_search_api_index_insert().
+ */
+function search_api_views_search_api_index_insert() {
+ // Make the new index available for views.
+ views_invalidate_cache();
+}
+
+/**
+ * Implements hook_search_api_index_update().
+ */
+function search_api_views_search_api_index_update(SearchApiIndex $index) {
+ // Check whether index was disabled.
+ $is_enabled = $index->enabled;
+ $was_enabled = $index->original->enabled;
+ if (!$is_enabled && $was_enabled) {
+ _search_api_views_index_unavailable($index);
+ return;
+ }
+
+ // Check whether the indexed fields changed.
+ $old_fields = $index->original->options + array('fields' => array());
+ $old_fields = $old_fields['fields'];
+ $new_fields = $index->options + array('fields' => array());
+ $new_fields = $new_fields['fields'];
+
+ // If the index was enabled or its fields changed, invalidate the Views cache.
+ if ($is_enabled != $was_enabled || $old_fields != $new_fields) {
+ views_invalidate_cache();
+ }
+}
+
+/**
+ * Implements hook_search_api_index_delete().
+ */
+function search_api_views_search_api_index_delete(SearchApiIndex $index) {
+ // Only do this if this is a "real" deletion, no revert.
+ if (!$index->hasStatus(ENTITY_PLUS_IN_CODE)) {
+ _search_api_views_index_unavailable($index);
+ }
+}
+
+/**
+ * Function for reacting to a disabled or deleted search index.
+ */
+function _search_api_views_index_unavailable(SearchApiIndex $index) {
+ $names = array();
+ $table = 'search_api_index_' . $index->machine_name;
+ foreach (views_get_all_views() as $name => $view) {
+ if (empty($view->disabled) && $view->base_table == $table) {
+ $names[] = $name;
+ // @todo: if ($index_deleted) $view->delete()?
+ }
+ }
+ if ($names) {
+ views_invalidate_cache();
+ backdrop_set_message(t('The following views were using the index %name: @views. You should disable or delete them.', array('%name' => $index->name, '@views' => implode(', ', $names))), 'warning');
+ }
+}
+
+/**
+ * Implements hook_autoload_info().
+ */
+function search_api_views_autoload_info() {
+ return array(
+ 'SearchApiViewsFacetsBlockDisplay' => 'includes/display_facet_block.inc',
+ 'SearchApiViewsHandlerArgument' => 'includes/handler_argument.inc',
+ 'SearchApiViewsHandlerArgumentDate' => 'includes/handler_argument_date.inc',
+ 'SearchApiViewsHandlerArgumentFulltext' => 'includes/handler_argument_fulltext.inc',
+ 'SearchApiViewsHandlerArgumentMoreLikeThis' => 'includes/handler_argument_more_like_this.inc',
+ 'SearchApiViewsHandlerArgumentString' => 'includes/handler_argument_string.inc',
+ 'SearchApiViewsHandlerArgumentTaxonomyTerm' => 'includes/handler_argument_taxonomy_term.inc',
+ 'SearchApiViewsHandlerFilter' => 'includes/handler_filter.inc',
+ 'SearchApiViewsHandlerFilterBoolean' => 'includes/handler_filter_boolean.inc',
+ 'SearchApiViewsHandlerFilterDate' => 'includes/handler_filter_date.inc',
+ 'SearchApiViewsHandlerFilterEntity' => 'includes/handler_filter_entity.inc',
+ 'SearchApiViewsHandlerFilterFulltext' => 'includes/handler_filter_fulltext.inc',
+ 'SearchApiViewsHandlerFilterLanguage' => 'includes/handler_filter_language.inc',
+ 'SearchApiViewsHandlerFilterNumeric' => 'includes/handler_filter_numeric.inc',
+ 'SearchApiViewsHandlerFilterOptions' => 'includes/handler_filter_options.inc',
+ 'SearchApiViewsHandlerFilterTaxonomyTerm' => 'includes/handler_filter_taxonomy_term.inc',
+ 'SearchApiViewsHandlerFilterText' => 'includes/handler_filter_text.inc',
+ 'SearchApiViewsHandlerFilterUser' => 'includes/handler_filter_user.inc',
+ 'SearchApiViewsHandlerSort' => 'includes/handler_sort.inc',
+ 'SearchApiViewsCache' => 'includes/plugin_cache.inc',
+ 'SearchApiViewsContentCache' => 'includes/plugin_content_cache.inc',
+ 'SearchApiViewsQuery' => 'includes/query.inc',
+ );
+}
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.tests.info b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.tests.info
new file mode 100644
index 000000000..34d6985a6
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/search_api_views.tests.info
@@ -0,0 +1,5 @@
+
+; Added by Backdrop CMS packaging script on 2026-02-06
+project = search_api
+version = 1.x-1.29.5
+timestamp = 1770395528
diff --git a/www/modules/contrib/search_api/contrib/search_api_views/views/search_api_views.views.inc b/www/modules/contrib/search_api/contrib/search_api_views/views/search_api_views.views.inc
new file mode 100644
index 000000000..1da1c0cbc
--- /dev/null
+++ b/www/modules/contrib/search_api/contrib/search_api_views/views/search_api_views.views.inc
@@ -0,0 +1,331 @@
+machine_name;
+ $table = &$data[$key];
+ $type_info = search_api_get_item_type_info($index->item_type);
+ $table['table']['group'] = t('Indexed @entity_type', array('@entity_type' => $type_info['name']));
+ $table['table']['base'] = array(
+ 'field' => 'search_api_id',
+ 'index' => $index->machine_name,
+ 'title' => $index->name,
+ 'help' => t('Use the %name search index for filtering and retrieving data.', array('%name' => $index->name)),
+ 'query class' => 'search_api_views_query',
+ );
+ $table['table']['entity type'] = $index->getEntityType();
+ $table['table']['skip entity load'] = TRUE;
+
+ try {
+ $wrapper = $index->entityWrapper(NULL, FALSE);
+ }
+ catch (EntityMetadataWrapperException $e) {
+ watchdog_exception('search_api_views', $e, "%type while retrieving metadata for index %index: !message in %function (line %line of %file).", array('%index' => $index->name), WATCHDOG_WARNING);
+ continue;
+ }
+
+ // Add field handlers and relationships provided by the Entity API.
+ foreach ($wrapper as $key => $property) {
+ $info = $property->info();
+ if ($info) {
+ entity_plus_views_field_definition($key, $info, $table);
+ }
+ }
+
+ try {
+ $wrapper = $index->entityWrapper(NULL);
+ }
+ catch (EntityMetadataWrapperException $e) {
+ watchdog_exception('search_api_views', $e, "%type while retrieving metadata for index %index: !message in %function (line %line of %file).", array('%index' => $index->name), WATCHDOG_WARNING);
+ continue;
+ }
+
+ // Add handlers for all indexed fields.
+ foreach ($index->getFields() as $key => $field) {
+ $tmp = $wrapper;
+ $group = '';
+ $name = '';
+ $parts = explode(':', $key);
+ foreach ($parts as $i => $part) {
+ if (!isset($tmp->$part)) {
+ continue 2;
+ }
+ $tmp = $tmp->$part;
+ $info = $tmp->info();
+ $group = ($group ? $group . ' » ' . $name : ($name ? $name : ''));
+ $name = $info['label'];
+ if ($i < count($parts) - 1) {
+ // Unwrap lists.
+ $level = search_api_list_nesting_level($info['type']);
+ for ($j = 0; $j < $level; ++$j) {
+ $tmp = $tmp[0];
+ }
+ }
+ }
+ $id = _entity_plus_views_field_identifier($key, $table);
+ if ($group) {
+ // @todo Entity type label instead of $group?
+ $table[$id]['group'] = $group;
+ $name = t('!field (indexed)', array('!field' => $name));
+ }
+ $table[$id]['title'] = $name;
+ $table[$id]['help'] = empty($info['description']) ? t('(No information available)') : $info['description'];
+ $table[$id]['type'] = $field['type'];
+ if ($id != $key) {
+ $table[$id]['real field'] = $key;
+ }
+ _search_api_views_add_handlers($key, $field, $tmp, $table);
+ }
+
+ // Special handlers.
+ $table['search_api_language']['filter']['handler'] = 'SearchApiViewsHandlerFilterLanguage';
+
+ $table['search_api_id']['title'] = t('Entity ID');
+ $table['search_api_id']['help'] = t("The entity's ID.");
+ $table['search_api_id']['sort']['handler'] = 'SearchApiViewsHandlerSort';
+
+ $table['search_api_relevance']['group'] = t('Search');
+ $table['search_api_relevance']['title'] = t('Relevance');
+ $table['search_api_relevance']['help'] = t('The relevance of this search result with respect to the query.');
+ $table['search_api_relevance']['field']['type'] = 'decimal';
+ $table['search_api_relevance']['field']['float'] = TRUE;
+ $table['search_api_relevance']['field']['handler'] = 'entity_plus_views_handler_field_numeric';
+ $table['search_api_relevance']['field']['click sortable'] = TRUE;
+ $table['search_api_relevance']['sort']['handler'] = 'SearchApiViewsHandlerSort';
+
+ $table['search_api_excerpt']['group'] = t('Search');
+ $table['search_api_excerpt']['title'] = t('Excerpt');
+ $table['search_api_excerpt']['help'] = t('The search result excerpted to show found search terms.');
+ $table['search_api_excerpt']['field']['type'] = 'text';
+ $table['search_api_excerpt']['field']['handler'] = 'entity_plus_views_handler_field_text';
+
+ $table['search_api_views_fulltext']['group'] = t('Search');
+ $table['search_api_views_fulltext']['title'] = t('Fulltext search');
+ $table['search_api_views_fulltext']['help'] = t('Search several or all fulltext fields at once.');
+ $table['search_api_views_fulltext']['filter']['handler'] = 'SearchApiViewsHandlerFilterFulltext';
+ $table['search_api_views_fulltext']['argument']['handler'] = 'SearchApiViewsHandlerArgumentFulltext';
+
+ $table['search_api_views_more_like_this']['group'] = t('Search');
+ $table['search_api_views_more_like_this']['title'] = t('More like this');
+ $table['search_api_views_more_like_this']['help'] = t('Find similar content.');
+ $table['search_api_views_more_like_this']['argument']['handler'] = 'SearchApiViewsHandlerArgumentMoreLikeThis';
+
+ // If there are taxonomy term references indexed in the index, include the
+ // "Indexed taxonomy term fields" contextual filter. We also save for all
+ // fields whether they contain only terms of a certain vocabulary, keying
+ // that information by vocabulary for later ease of use.
+ $vocabulary_fields = array();
+ foreach ($index->getFields() as $key => $field) {
+ if (isset($field['entity_type']) && $field['entity_type'] === 'taxonomy_term') {
+ $field_id = ($pos = strrpos($key, ':')) ? substr($key, $pos + 1) : $key;
+ $field_info = field_info_field($field_id);
+ if ($vocabulary = _search_api_views_get_field_vocabulary($field_info)) {
+ $vocabulary_fields[$vocabulary][] = $key;
+ }
+ else {
+ $vocabulary_fields[''][] = $key;
+ }
+ }
+ }
+ if ($vocabulary_fields) {
+ $table['search_api_views_taxonomy_term']['group'] = t('Search');
+ $table['search_api_views_taxonomy_term']['title'] = t('Indexed taxonomy term fields');
+ $table['search_api_views_taxonomy_term']['help'] = t('Search in all indexed taxonomy term fields.');
+ $table['search_api_views_taxonomy_term']['argument']['handler'] = 'SearchApiViewsHandlerArgumentTaxonomyTerm';
+ $table['search_api_views_taxonomy_term']['argument']['vocabulary_fields'] = $vocabulary_fields;
+ }
+ }
+ return $data;
+ }
+ catch (Exception $e) {
+ watchdog_exception('search_api_views', $e);
+ }
+}
+
+/**
+ * Adds handler definitions for a field to a Views data table definition.
+ *
+ * Helper method for search_api_views_views_data().
+ *
+ * @param $id
+ * The internal identifier of the field.
+ * @param array $field
+ * Information about the field.
+ * @param EntityMetadataWrapper $wrapper
+ * A wrapper providing further metadata about the field.
+ * @param array $table
+ * The existing Views data table definition, as a reference.
+ */
+function _search_api_views_add_handlers($id, array $field, EntityMetadataWrapper $wrapper, array &$table) {
+ $type = $field['type'];
+ $inner_type = search_api_extract_inner_type($type);
+
+ if (strpos($id, ':')) {
+ entity_plus_views_field_definition($id, $wrapper->info(), $table);
+ }
+ $id = _entity_plus_views_field_identifier($id, $table);
+ $table += array($id => array());
+
+ if ($inner_type == 'text') {
+ $table[$id] += array(
+ 'argument' => array(
+ 'handler' => 'SearchApiViewsHandlerArgumentString',
+ ),
+ 'filter' => array(
+ 'handler' => 'SearchApiViewsHandlerFilterText',
+ ),
+ );
+ return;
+ }
+
+ $info = $wrapper->info();
+ if (isset($info['options list']) && is_callable($info['options list'])) {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilterOptions';
+ $table[$id]['filter']['multi-valued'] = search_api_is_list_type($type);
+ }
+ elseif ($inner_type == 'boolean') {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilterBoolean';
+ }
+ elseif ($inner_type == 'date') {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilterDate';
+ }
+ elseif (isset($field['entity_type']) && $field['entity_type'] === 'user') {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilterUser';
+ }
+ elseif (isset($field['entity_type']) && $field['entity_type'] === 'taxonomy_term') {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilterTaxonomyTerm';
+ $field_info = field_info_field($info['name']);
+ // For the "Parent terms" and "All parent terms" properties, we can
+ // extrapolate the vocabulary from the parent in the selector. (E.g.,
+ // for "field_tags:parent" we can use the information of "field_tags".)
+ // Otherwise, we can't include any vocabulary information.
+ if (!$field_info && ($info['name'] == 'parent' || $info['name'] == 'parents_all')) {
+ if (!empty($table[$id]['real field'])) {
+ $parts = explode(':', $table[$id]['real field']);
+ $field_info = field_info_field($parts[count($parts) - 2]);
+ }
+ }
+ if ($vocabulary = _search_api_views_get_field_vocabulary($field_info)) {
+ $table[$id]['filter']['vocabulary'] = $vocabulary;
+ }
+ }
+ elseif (in_array($inner_type, array('integer', 'decimal', 'duration', 'string', 'uri'))) {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilterNumeric';
+ }
+ else {
+ $table[$id]['filter']['handler'] = 'SearchApiViewsHandlerFilter';
+ }
+
+ if ($inner_type == 'string' || $inner_type == 'uri') {
+ $table[$id]['argument']['handler'] = 'SearchApiViewsHandlerArgumentString';
+ }
+ elseif ($inner_type == 'date') {
+ $table[$id]['argument']['handler'] = 'SearchApiViewsHandlerArgumentDate';
+ }
+ else {
+ $table[$id]['argument']['handler'] = 'SearchApiViewsHandlerArgument';
+ }
+
+ // We can only sort according to single-valued fields.
+ if ($type == $inner_type) {
+ $table[$id]['sort']['handler'] = 'SearchApiViewsHandlerSort';
+ if (isset($table[$id]['field'])) {
+ $table[$id]['field']['click sortable'] = TRUE;
+ }
+ }
+}
+
+/**
+ * Implements hook_views_plugins().
+ */
+function search_api_views_views_plugins() {
+ // Collect all base tables provided by this module.
+ $bases = array();
+ foreach (search_api_index_load_multiple(FALSE) as $index) {
+ $bases[] = 'search_api_index_' . $index->machine_name;
+ }
+
+ $ret = array(
+ 'query' => array(
+ 'search_api_views_query' => array(
+ 'title' => t('Search API Query'),
+ 'help' => t('Query will be generated and run using the Search API.'),
+ 'handler' => 'SearchApiViewsQuery',
+ ),
+ ),
+ 'cache' => array(
+ 'search_api_views_cache' => array(
+ 'title' => t('Search-specific'),
+ 'help' => t("Cache Search API views. (Other methods probably won't work with search views.)"),
+ 'base' => $bases,
+ 'handler' => 'SearchApiViewsCache',
+ 'uses options' => TRUE,
+ ),
+ ),
+ );
+
+ if (module_exists('search_api_facetapi')) {
+ $ret['display']['search_api_views_facets_block'] = array(
+ 'title' => t('Facets block'),
+ 'help' => t('Display facets for this search as a block anywhere on the site.'),
+ 'handler' => 'SearchApiViewsFacetsBlockDisplay',
+ 'uses hook block' => TRUE,
+ 'use ajax' => FALSE,
+ 'use pager' => FALSE,
+ 'use more' => TRUE,
+ 'accept attachments' => TRUE,
+ 'admin' => t('Facets block'),
+ );
+ }
+
+ if (module_exists('views_content_cache')) {
+ $ret['cache']['search_api_views_content_cache'] = array(
+ 'title' => t('Search-specific content-based'),
+ 'help' => t("Cache Search API views based on content updates. (Requires Views Content Cache)"),
+ 'base' => $bases,
+ 'handler' => 'SearchApiViewsContentCache',
+ 'uses options' => TRUE,
+ );
+ }
+
+ return $ret;
+}
+
+/**
+ * Returns the vocabulary machine name of a term field.
+ *
+ * @param array|null $field_info
+ * The field's field info array, or NULL if the field is not provided by the
+ * Field API. See the return value of field_info_field().
+ *
+ * @return string|null
+ * If the field contains taxonomy terms of a single vocabulary (which could be
+ * determined), that vocabulary's machine name; NULL otherwise.
+ */
+function _search_api_views_get_field_vocabulary($field_info) {
+ // Test for "Term reference" fields.
+ if (isset($field_info['settings']['allowed_values'][0]['vocabulary'])) {
+ return $field_info['settings']['allowed_values'][0]['vocabulary'];
+ }
+ // Test for "Entity reference" fields.
+ elseif (isset($field_info['settings']['handler']) && $field_info['settings']['handler'] === 'base') {
+ if (!empty($field_info['settings']['handler_settings']['target_bundles'])) {
+ $bundles = $field_info['settings']['handler_settings']['target_bundles'];
+ if (count($bundles) == 1) {
+ return key($bundles);
+ }
+ }
+ }
+ return NULL;
+}
diff --git a/www/modules/contrib/search_api/css/search_api.admin.css b/www/modules/contrib/search_api/css/search_api.admin.css
new file mode 100644
index 000000000..1b7aaef04
--- /dev/null
+++ b/www/modules/contrib/search_api/css/search_api.admin.css
@@ -0,0 +1,51 @@
+/**
+ * @file
+ * Styles for Search API admin pages.
+ */
+
+/*
+ * OVERVIEW
+ */
+
+.search-api-overview td.search-api-status {
+ text-align: center;
+}
+
+.search-api-overview td {
+ vertical-align: top;
+}
+
+/*
+ * VIEW SERVER
+ */
+
+.search-api-server-summary ul.inline {
+ margin: 0;
+}
+
+.search-api-server-summary ul.inline li {
+ padding-left: 0;
+}
+
+/*
+ * VIEW INDEX
+ */
+.search-api-limit,
+.search-api-batch-size {
+ text-align: center;
+}
+
+.search-api-index-status .progress .bar .filled::after {
+ background: #0074BD none;
+
+}
+
+/*
+ * MISC
+ */
+
+.search-api-alter-add-aggregation-fields,
+.search-api-checkboxes-list {
+ max-height: 12em;
+ overflow: auto;
+}
diff --git a/www/modules/contrib/search_api/disabled.png b/www/modules/contrib/search_api/disabled.png
new file mode 100644
index 000000000..224776502
Binary files /dev/null and b/www/modules/contrib/search_api/disabled.png differ
diff --git a/www/modules/contrib/search_api/enabled.png b/www/modules/contrib/search_api/enabled.png
new file mode 100644
index 000000000..95f8730e6
Binary files /dev/null and b/www/modules/contrib/search_api/enabled.png differ
diff --git a/www/modules/contrib/search_api/includes/callback.inc b/www/modules/contrib/search_api/includes/callback.inc
new file mode 100644
index 000000000..c41d2c447
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/callback.inc
@@ -0,0 +1,200 @@
+index = $index;
+ $this->options = $options;
+ }
+
+ /**
+ * Implements SearchApiAlterCallbackInterface::supportsIndex().
+ *
+ * The default implementation always returns TRUE.
+ */
+ public function supportsIndex(SearchApiIndex $index) {
+ return TRUE;
+ }
+
+ /**
+ * Implements SearchApiAlterCallbackInterface::configurationForm().
+ */
+ public function configurationForm() {
+ return array();
+ }
+
+ /**
+ * Implements SearchApiAlterCallbackInterface::configurationFormValidate().
+ */
+ public function configurationFormValidate(array $form, array &$values, array &$form_state) { }
+
+ /**
+ * Implements SearchApiAlterCallbackInterface::configurationFormSubmit().
+ */
+ public function configurationFormSubmit(array $form, array &$values, array &$form_state) {
+ $this->options = $values;
+ return $values;
+ }
+
+ /**
+ * Implements SearchApiAlterCallbackInterface::propertyInfo().
+ */
+ public function propertyInfo() {
+ return array();
+ }
+
+ /**
+ * Determines whether the given index contains multiple types of entities.
+ *
+ * @param SearchApiIndex|null $index
+ * (optional) The index to examine. Defaults to the index set for this
+ * plugin.
+ *
+ * @return bool
+ * TRUE if the index is a multi-entity index, FALSE otherwise.
+ */
+ protected function isMultiEntityIndex(?SearchApiIndex $index = NULL) {
+ $index = $index ? $index : $this->index;
+ return $index->datasource() instanceof SearchApiCombinedEntityDataSourceController;
+ }
+
+}
diff --git a/www/modules/contrib/search_api/includes/callback_add_aggregation.inc b/www/modules/contrib/search_api/includes/callback_add_aggregation.inc
new file mode 100644
index 000000000..643e23b1b
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/callback_add_aggregation.inc
@@ -0,0 +1,405 @@
+index->getFields(FALSE);
+ $field_options = array();
+ $field_properties = array();
+ foreach ($fields as $name => $field) {
+ $field_options[$name] = check_plain($field['name']);
+ $field_properties[$name] = array(
+ '#attributes' => array('title' => $name),
+ '#description' => check_plain($field['description']),
+ );
+ }
+ $additional = empty($this->options['fields']) ? array() : $this->options['fields'];
+
+ $types = $this->getTypes();
+ $type_descriptions = $this->getTypes('description');
+ $tmp = array();
+ foreach ($types as $type => $name) {
+ $tmp[$type] = array(
+ '#type' => 'item',
+ '#description' => $type_descriptions[$type],
+ );
+ }
+ $type_descriptions = $tmp;
+
+ $form['#id'] = 'edit-callbacks-search-api-alter-add-aggregation-settings';
+ $form['description'] = array(
+ '#markup' => t('This data alteration lets you define additional fields that will be added to this index. ' . + 'Each of these new fields will be an aggregation of one or more existing fields.
' . + 'To add a new aggregated field, click the "Add new field" button and then fill out the form.
' . + 'To remove a previously defined field, click the "Remove field" button.
' . + 'You can also change the names or contained fields of existing aggregated fields.
'), + ); + $form['fields']['#prefix'] = '';
+ $form['fields']['#suffix'] = '
';
+ if (isset($this->changes)) {
+ $form['fields']['#prefix'] .= '';
+ }
+ foreach ($additional as $name => $field) {
+ $form['fields'][$name] = array(
+ '#type' => 'fieldset',
+ '#title' => $field['name'] ? $field['name'] : t('New field'),
+ '#collapsible' => TRUE,
+ '#collapsed' => (boolean) $field['name'],
+ );
+ $form['fields'][$name]['name'] = array(
+ '#type' => 'textfield',
+ '#title' => t('New field name'),
+ '#default_value' => $field['name'],
+ '#required' => TRUE,
+ );
+ $form['fields'][$name]['type'] = array(
+ '#type' => 'select',
+ '#title' => t('Aggregation type'),
+ '#options' => $types,
+ '#default_value' => $field['type'],
+ '#required' => TRUE,
+ );
+ $form['fields'][$name]['type_descriptions'] = $type_descriptions;
+ $type_selector = ':input[name="callbacks[search_api_alter_add_aggregation][settings][fields][' . $name . '][type]"]';
+ foreach (array_keys($types) as $type) {
+ $form['fields'][$name]['type_descriptions'][$type]['#states']['visible'][$type_selector]['value'] = $type;
+ }
+ $form['fields'][$name]['separator'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Fulltext separator'),
+ '#description' => t('For aggregation type "Fulltext", set the text that should be used to separate the aggregated field values. Use "\t" for tabs and "\n" for newline characters.'),
+ '#default_value' => addcslashes(isset($field['separator']) ? $field['separator'] : "\n\n", "\0..\37\\"),
+ '#states' => array(
+ 'visible' => array(
+ $type_selector => array(
+ 'value' => 'fulltext',
+ ),
+ ),
+ ),
+ );
+ $form['fields'][$name]['fields'] = array_merge($field_properties, array(
+ '#type' => 'checkboxes',
+ '#title' => t('Contained fields'),
+ '#options' => $field_options,
+ '#default_value' => backdrop_map_assoc($field['fields']),
+ '#attributes' => array('class' => array('search-api-alter-add-aggregation-fields')),
+ '#required' => TRUE,
+ ));
+ $form['fields'][$name]['actions'] = array(
+ '#type' => 'actions',
+ 'remove' => array(
+ '#type' => 'submit',
+ '#value' => t('Remove field'),
+ '#submit' => array('_search_api_add_aggregation_field_submit'),
+ '#limit_validation_errors' => array(),
+ '#name' => 'search_api_add_aggregation_remove_' . $name,
+ '#ajax' => array(
+ 'callback' => '_search_api_add_aggregation_field_ajax',
+ 'wrapper' => 'search-api-alter-add-aggregation-field-settings',
+ ),
+ ),
+ );
+ }
+ $form['actions']['#type'] = 'actions';
+ $form['actions']['add_field'] = array(
+ '#type' => 'submit',
+ '#value' => t('Add new field'),
+ '#submit' => array('_search_api_add_aggregation_field_submit'),
+ '#limit_validation_errors' => array(),
+ '#ajax' => array(
+ 'callback' => '_search_api_add_aggregation_field_ajax',
+ 'wrapper' => 'search-api-alter-add-aggregation-field-settings',
+ ),
+ );
+ return $form;
+ }
+
+ /**
+ *
+ */
+ public function configurationFormValidate(array $form, array &$values, array &$form_state) {
+ unset($values['actions']);
+ if (empty($values['fields'])) {
+ return;
+ }
+ foreach ($values['fields'] as $name => $field) {
+ unset($values['fields'][$name]['actions']);
+ $fields = $values['fields'][$name]['fields'] = array_values(array_filter($field['fields']));
+ if ($field['name'] && !$fields) {
+ form_error($form['fields'][$name]['fields'], t('You have to select at least one field to aggregate. If you want to remove an aggregated field, please delete its name.'));
+ }
+ $values['fields'][$name]['separator'] = stripcslashes($field['separator']);
+ }
+ }
+
+ /**
+ *
+ */
+ public function configurationFormSubmit(array $form, array &$values, array &$form_state) {
+ if (empty($values['fields'])) {
+ return array();
+ }
+ $index_fields = $this->index->getFields(FALSE);
+ foreach ($values['fields'] as $name => $field) {
+ if (!$field['name']) {
+ unset($values['fields'][$name]);
+ }
+ else {
+ $values['fields'][$name]['description'] = $this->fieldDescription($field, $index_fields);
+ }
+ }
+ $this->options = $values;
+ return $values;
+ }
+
+ /**
+ *
+ */
+ public function alterItems(array &$items) {
+ if (!$items) {
+ return;
+ }
+ if (isset($this->options['fields'])) {
+ $types = $this->getTypes('type');
+ foreach ($items as $item) {
+ $wrapper = $this->index->entityWrapper($item);
+ foreach ($this->options['fields'] as $name => $field) {
+ if ($field['name']) {
+ $required_fields = array();
+ foreach ($field['fields'] as $f) {
+ if (!isset($required_fields[$f])) {
+ $required_fields[$f]['type'] = $types[$field['type']];
+ }
+ }
+ $fields = search_api_extract_fields($wrapper, $required_fields);
+ $values = array();
+ foreach ($fields as $f) {
+ if (isset($f['value'])) {
+ $values[] = $f['value'];
+ }
+ }
+ $values = $this->flattenArray($values);
+
+ $this->reductionType = $field['type'];
+ $this->fulltextReductionSeparator = isset($field['separator']) ? $field['separator'] : "\n\n";
+ $item->$name = array_reduce($values, array($this, 'reduce'), NULL);
+ if ($field['type'] == 'count' && !$item->$name) {
+ $item->$name = 0;
+ }
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Helper method for reducing an array to a single value.
+ */
+ public function reduce($a, $b) {
+ switch ($this->reductionType) {
+ case 'fulltext':
+ return isset($a) ? $a . $this->fulltextReductionSeparator . $b : $b;
+ case 'sum':
+ return $a + $b;
+ case 'count':
+ return $a + 1;
+ case 'max':
+ return isset($a) ? max($a, $b) : $b;
+ case 'min':
+ return isset($a) ? min($a, $b) : $b;
+ case 'first':
+ return isset($a) ? $a : $b;
+ case 'first_char':
+ $b = "$b";
+ if (isset($a) || $b === '') {
+ return $a;
+ }
+ return backdrop_substr($b, 0, 1);
+ case 'last':
+ return isset($b) ? $b : $a;
+ case 'list':
+ if (!isset($a)) {
+ $a = array();
+ }
+ $a[] = $b;
+ return $a;
+ }
+ return NULL;
+ }
+
+ /**
+ * Helper method for flattening a multi-dimensional array.
+ */
+ protected function flattenArray(array $data) {
+ $ret = array();
+ foreach ($data as $item) {
+ if (!isset($item)) {
+ continue;
+ }
+ if (is_scalar($item)) {
+ $ret[] = $item;
+ }
+ else {
+ $ret = array_merge($ret, $this->flattenArray($item));
+ }
+ }
+ return $ret;
+ }
+
+ /**
+ *
+ */
+ public function propertyInfo() {
+ $types = $this->getTypes('type');
+ $ret = array();
+ if (isset($this->options['fields'])) {
+ foreach ($this->options['fields'] as $name => $field) {
+ $ret[$name] = array(
+ 'label' => $field['name'],
+ 'description' => empty($field['description']) ? '' : $field['description'],
+ 'type' => $types[$field['type']],
+ );
+ }
+ }
+ return $ret;
+ }
+
+ /**
+ * Helper method for creating a field description.
+ */
+ protected function fieldDescription(array $field, array $index_fields) {
+ $fields = array();
+ foreach ($field['fields'] as $f) {
+ $fields[] = isset($index_fields[$f]) ? $index_fields[$f]['name'] : $f;
+ }
+ $type = $this->getTypes();
+ $type = $type[$field['type']];
+ return t('A @type aggregation of the following fields: @fields.', array('@type' => $type, '@fields' => implode(', ', $fields)));
+ }
+
+ /**
+ * Helper method for getting all available aggregation types.
+ *
+ * @param string $info
+ * (optional) One of "name", "type" or "description", to indicate what
+ * information should be returned for the types.
+ *
+ * @return string[]
+ * An associative array of aggregation type identifiers mapped to their
+ * names, data types or descriptions, as requested.
+ */
+ protected function getTypes($info = 'name') {
+ switch ($info) {
+ case 'name':
+ return array(
+ 'fulltext' => t('Fulltext'),
+ 'sum' => t('Sum'),
+ 'count' => t('Count'),
+ 'max' => t('Maximum'),
+ 'min' => t('Minimum'),
+ 'first' => t('First'),
+ 'first_char' => t('First letter'),
+ 'last' => t('Last'),
+ 'list' => t('List'),
+ );
+ case 'type':
+ return array(
+ 'fulltext' => 'text',
+ 'sum' => 'integer',
+ 'count' => 'integer',
+ 'max' => 'integer',
+ 'min' => 'integer',
+ 'first' => 'token',
+ 'first_char' => 'token',
+ 'last' => 'token',
+ 'list' => 'list' . t('Entities of type %type have only a single view mode. ' . + 'Therefore, no selection needs to be made.', array('%type' => $info['label'])) . '
', + ); + } + else { + $form['note'] = array( + '#markup' => '' . t('Entities of type %type have no defined view modes. ' . + 'This might either mean that they are always displayed the same way, or that they cannot be processed by this alteration at all. ' . + 'Please consider this when using this alteration.', array('%type' => $info['label'])) . '
', + ); + } + } + $form['global_language_switch'] = array( + '#type' => 'checkbox', + '#title' => t('Adjust environment language when indexing'), + '#description' => t('If enabled, the indexing process will not just set the language for the entity view but also the global environment. This can prevent wrong translations leaking into the indexed data on multi-lingual sites, but causes problems in rare cases. Unless you notice any problems in connection with this, the recommended setting is enabled.'), + '#default_value' => !empty($this->options['global_language_switch']), + ); + return $form; + } + + /** + * + */ + public function alterItems(array &$items) { + // Prevent session information from being saved while indexing. + backdrop_save_session(FALSE); + + // Language handling. + $languages = language_list(); + $global_language = array( + 'language' => $GLOBALS['language'], + 'language_url' => $GLOBALS['language_url'], + 'language_content' => $GLOBALS['language_content'], + ); + + // Force the current user to anonymous to prevent access bypass in search + // indexes. + $original_user = $GLOBALS['user']; + $GLOBALS['user'] = backdrop_anonymous_user(); + + // Switch to the default theme for rendering if it's not the current one. + $old_theme = _search_api_swap_theme(config_get('system.core', 'theme_default')); + + $type = $this->index->getEntityType(); + $mode = empty($this->options['mode']) ? 'full' : $this->options['mode']; + foreach ($items as &$item) { + // Since we can't really know what happens in entity_view() and render(), + // we use try/catch. This will at least prevent some errors, even though + // it's no protection against fatal errors and the like. + try { + // Check if the global language switch is enabled. + if (!empty($this->options['global_language_switch'])) { + // Language handling. We need to overwrite the global language + // configuration because parts of entity rendering won't rely on the + // passed in language (for instance, URL aliases). + if (isset($languages[$item->search_api_language])) { + $GLOBALS['language'] = $languages[$item->search_api_language]; + $GLOBALS['language_url'] = $languages[$item->search_api_language]; + $GLOBALS['language_content'] = $languages[$item->search_api_language]; + } + else { + $GLOBALS['language'] = $global_language['language']; + $GLOBALS['language_url'] = $global_language['language_url']; + $GLOBALS['language_content'] = $global_language['language_content']; + } + } + + $render = entity_plus_view($type, array($item->id() => $item), $mode, $item->search_api_language); + $text = render($render); + if (!$text) { + $item->search_api_viewed = NULL; + continue; + } + $item->search_api_viewed = $text; + } + catch (Exception $e) { + $item->search_api_viewed = NULL; + } + } + + // Restore global language settings. + if (!empty($this->options['global_language_switch'])) { + $GLOBALS['language'] = $global_language['language']; + $GLOBALS['language_url'] = $global_language['language_url']; + $GLOBALS['language_content'] = $global_language['language_content']; + } + + // Switch back to the previous theme, if necessary. + if ($old_theme) { + _search_api_swap_theme($old_theme); + } + + // Restore the user. + $GLOBALS['user'] = $original_user; + backdrop_save_session(TRUE); + } + + /** + * + */ + public function propertyInfo() { + return array( + 'search_api_viewed' => array( + 'label' => t('Entity HTML output'), + 'description' => t('The whole HTML content of the entity when viewed.'), + 'type' => 'text', + ), + ); + } + +} diff --git a/www/modules/contrib/search_api/includes/callback_bundle_filter.inc b/www/modules/contrib/search_api/includes/callback_bundle_filter.inc new file mode 100644 index 000000000..cde8fe27d --- /dev/null +++ b/www/modules/contrib/search_api/includes/callback_bundle_filter.inc @@ -0,0 +1,135 @@ +isMultiEntityIndex($index)) { + $info = entity_get_info(); + foreach ($index->options['datasource']['types'] as $type) { + if (isset($info[$type]) && self::hasBundles($info[$type])) { + return TRUE; + } + } + return FALSE; + } + return $index->getEntityType() && ($info = entity_get_info($index->getEntityType())) && self::hasBundles($info); + } + + /** + * {@inheritdoc} + */ + public function alterItems(array &$items) { + if (!$this->supportsIndex($this->index) || !isset($this->options['bundles'])) { + return; + } + + $multi_entity = $this->isMultiEntityIndex(); + if ($multi_entity) { + $bundle_prop = 'item_bundle'; + } + else { + $info = entity_get_info($this->index->getEntityType()); + $bundle_prop = $info['entity keys']['bundle']; + } + + $bundles = array_flip($this->options['bundles']); + $default = (bool) $this->options['default']; + + foreach ($items as $id => $item) { + // Ignore types that have no bundles. + if ($multi_entity && !self::hasBundles(entity_get_info($item->item_type))) { + continue; + } + if (isset($bundles[$item->$bundle_prop]) == $default) { + unset($items[$id]); + } + } + } + + /** + * {@inheritdoc} + */ + public function configurationForm() { + if ($this->supportsIndex($this->index)) { + $options = array(); + if ($this->isMultiEntityIndex()) { + $info = entity_get_info(); + $unsupported_types = array(); + foreach ($this->index->options['datasource']['types'] as $type) { + if (isset($info[$type]) && self::hasBundles($info[$type])) { + foreach ($info[$type]['bundles'] as $bundle => $bundle_info) { + $options["$type:$bundle"] = $info[$type]['label'] . ' » ' . $bundle_info['label']; + } + } + else { + $unsupported_types[] = isset($info[$type]['label']) ? $info[$type]['label'] : $type; + } + } + if ($unsupported_types) { + $form['unsupported_types']['#markup'] = '' . t('The following entity types do not contain any bundles: @types. All items of those types will therefore be included in the index.', array('@types' => implode(', ', $unsupported_types))) . '
'; + } + } + else { + $info = entity_get_info($this->index->getEntityType()); + foreach ($info['bundles'] as $bundle => $bundle_info) { + $options[$bundle] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle; + } + } + if (!empty($this->index->options['datasource']['bundles'])) { + $form['message']['#markup'] = '' . t("Note: This index is already restricted to certain bundles. If you use this data alteration, those will be reduced further. However, the index setting is better supported in the user interface and should therefore be prefered. For example, using this data alteration will not reduce the displayed total number of items to index (even though some of them will not be indexed). Consider creating a new index with appropriate bundle settings instead.") . '
'; + $included_bundles = array_flip($this->index->options['datasource']['bundles']); + $options = array_intersect_key($options, $included_bundles); + } + $form['default'] = array( + '#type' => 'radios', + '#title' => t('Which items should be indexed?'), + '#default_value' => isset($this->options['default']) ? $this->options['default'] : 1, + '#options' => array( + 1 => t('All but those from one of the selected bundles'), + 0 => t('Only those from the selected bundles'), + ), + ); + $form['bundles'] = array( + '#type' => 'select', + '#title' => t('Bundles'), + '#default_value' => isset($this->options['bundles']) ? $this->options['bundles'] : array(), + '#options' => $options, + '#size' => min(4, count($options)), + '#multiple' => TRUE, + ); + } + else { + $form = array( + 'forbidden' => array( + '#markup' => '' . t("Items indexed by this index don't have bundles and therefore cannot be filtered here.") . '
', + ), + ); + } + return $form; + } + + /** + * Determines whether a certain entity type has any bundles. + * + * @param array $entity_info + * The entity type's entity_get_info() array. + * + * @return bool + * TRUE if the entity type has bundles, FALSE otherwise. + */ + protected static function hasBundles(array $entity_info) { + return !empty($entity_info['entity keys']['bundle']) && !empty($entity_info['bundles']); + } + +} diff --git a/www/modules/contrib/search_api/includes/callback_comment_access.inc b/www/modules/contrib/search_api/includes/callback_comment_access.inc new file mode 100644 index 000000000..e6273530e --- /dev/null +++ b/www/modules/contrib/search_api/includes/callback_comment_access.inc @@ -0,0 +1,46 @@ +getEntityType() === 'comment'; + } + + /** + * Overrides SearchApiAlterNodeAccess::getNode(). + * + * Returns the comment's node, instead of the item (i.e., the comment) itself. + */ + protected function getNode($item) { + return node_load($item->nid); + } + + /** + * Overrides SearchApiAlterNodeAccess::configurationFormSubmit(). + * + * Doesn't index the comment's "Author". + */ + public function configurationFormSubmit(array $form, array &$values, array &$form_state) { + $old_status = !empty($form_state['index']->options['data_alter_callbacks']['search_api_alter_comment_access']['status']); + $new_status = !empty($form_state['values']['callbacks']['search_api_alter_comment_access']['status']); + + if (!$old_status && $new_status) { + $form_state['index']->options['fields']['status']['type'] = 'boolean'; + } + + return parent::configurationFormSubmit($form, $values, $form_state); + } + +} diff --git a/www/modules/contrib/search_api/includes/callback_file_entity_public.inc b/www/modules/contrib/search_api/includes/callback_file_entity_public.inc new file mode 100644 index 000000000..91ff546fc --- /dev/null +++ b/www/modules/contrib/search_api/includes/callback_file_entity_public.inc @@ -0,0 +1,42 @@ +isMultiEntityIndex($index)) { + return in_array('file', $index->options['datasource']['types']); + } + return $index->getEntityType() === 'file'; + } + + /** + * {@inheritdoc} + */ + public function alterItems(array &$items) { + $multi_types = $this->isMultiEntityIndex($this->index); + foreach ($items as $id => $item) { + $file = $item; + if ($multi_types) { + if ($item->item_type !== 'file') { + continue; + } + $file = $item->file; + } + if (empty($file->uri) || substr($file->uri, 0, 10) === 'private://') { + unset($items[$id]); + } + } + } + +} diff --git a/www/modules/contrib/search_api/includes/callback_language_control.inc b/www/modules/contrib/search_api/includes/callback_language_control.inc new file mode 100644 index 000000000..6933b8dbe --- /dev/null +++ b/www/modules/contrib/search_api/includes/callback_language_control.inc @@ -0,0 +1,126 @@ + '', + 'languages' => array(), + ); + parent::__construct($index, $options); + } + + /** + * Overrides SearchApiAbstractAlterCallback::supportsIndex(). + * + * Only returns TRUE if the system is multilingual. + * + * @see language_multilingual() + */ + public function supportsIndex(SearchApiIndex $index) { + return language_multilingual(); + } + + /** + * {@inheritdoc} + */ + public function configurationForm() { + $form = array(); + + $wrapper = $this->index->entityWrapper(); + $fields[''] = t('- Use default -'); + foreach ($wrapper as $key => $property) { + if ($key == 'search_api_language') { + continue; + } + $type = $property->type(); + // Only single-valued string properties make sense here. Also, nested + // properties probably don't make sense. + if ($type == 'text' || $type == 'token') { + $info = $property->info(); + $fields[$key] = $info['label']; + } + } + + if (count($fields) > 1) { + $form['lang_field'] = array( + '#type' => 'select', + '#title' => t('Language field'), + '#description' => t("Select the field which should be used to determine an item's language."), + '#options' => $fields, + '#default_value' => $this->options['lang_field'], + ); + } + + $languages[LANGUAGE_NONE] = t('Language neutral'); + $list = language_list('enabled') + array(array(), array()); + foreach (array($list[1], $list[0]) as $list) { + foreach ($list as $lang) { + $name = t($lang->name); + $native = $lang->native; + $languages[$lang->language] = check_plain(($name == $native) ? $name : "$name ($native)"); + if (!$lang->enabled) { + $languages[$lang->language] .= ' [' . t('disabled') . ']'; + } + } + } + $form['languages'] = array( + '#type' => 'checkboxes', + '#title' => t('Indexed languages'), + '#description' => t('Index only items in the selected languages. ' . + 'When no language is selected, there will be no language-related restrictions.'), + '#options' => $languages, + '#default_value' => $this->options['languages'], + ); + + return $form; + } + + /** + * {@inheritdoc} + */ + public function configurationFormSubmit(array $form, array &$values, array &$form_state) { + $values['languages'] = array_filter($values['languages']); + return parent::configurationFormSubmit($form, $values, $form_state); + } + + /** + * {@inheritdoc} + */ + public function alterItems(array &$items) { + foreach ($items as $i => &$item) { + // Set item language, if a custom field was selected. + if ($field = $this->options['lang_field']) { + $wrapper = $this->index->entityWrapper($item); + if (isset($wrapper->$field)) { + try { + $item->search_api_language = $wrapper->$field->value(); + } + catch (EntityMetadataWrapperException $e) { + // Something went wrong while accessing the language field. Probably + // doesn't really matter. + } + } + } + // Filter out items according to language, if any were selected. + if ($languages = $this->options['languages']) { + if (empty($languages[$item->search_api_language])) { + unset($items[$i]); + } + } + } + } + +} diff --git a/www/modules/contrib/search_api/includes/callback_node_access.inc b/www/modules/contrib/search_api/includes/callback_node_access.inc new file mode 100644 index 000000000..2ed3240c8 --- /dev/null +++ b/www/modules/contrib/search_api/includes/callback_node_access.inc @@ -0,0 +1,98 @@ +getEntityType() === 'node'; + } + + /** + * Overrides SearchApiAbstractAlterCallback::propertyInfo(). + * + * Adds the "search_api_access_node" property. + */ + public function propertyInfo() { + return array( + 'search_api_access_node' => array( + 'label' => t('Node access information'), + 'description' => t('Data needed to apply node access.'), + 'type' => 'list\n", $errors)); + } + } + + /** + * + */ + protected function processFieldValue(&$value) { + $text = str_replace(array('<', '>'), array(' <', '> '), $value); // Let removed tags still delimit words. + if ($this->options['title']) { + $text = preg_replace('/(<[-a-z_]+[^>]+)\btitle\s*=\s*("([^"]+)"|\'([^\']+)\')([^>]*>)/i', '$1 $5 $3$4 ', $text); + } + if ($this->options['alt']) { + $text = preg_replace('/
' . t('Optionally, provide an exclusion list to override the stemmer algorithm. (Read about the algorithm.)', $args) . '
', + ), + 'exceptions' => array( + '#type' => 'textarea', + '#title' => t('Exceptions'), + '#description' => t('Enter exceptions in the form of WORD=STEM, where "WORD" is the term entered and "STEM" is the resulting stem. List each exception on a separate line.'), + '#default_value' => "texan=texa", + ), + ); + + if (!empty($this->options['exceptions'])) { + $form['exceptions']['#default_value'] = $this->options['exceptions']; + } + return $form; + } + + /** + * {@inheritdoc} + */ + protected function process(&$value) { + if (!$value) { + return; + } + + // Load custom exceptions. + $exceptions = $this->getExceptions(); + + $words = preg_split('/[^\p{L}\p{N}]+/u', $value, -1, PREG_SPLIT_DELIM_CAPTURE); + $stemmed = array(); + foreach ($words as $i => $word) { + if ($i % 2 == 0 && strlen($word)) { + if (!isset($this->stems[$word])) { + $stem = new SearchApiPorter2($word, $exceptions); + $this->stems[$word] = $stem->stem(); + } + $stemmed[] = $this->stems[$word]; + } + else { + $stemmed[] = $word; + } + } + $value = implode(' ', $stemmed); + } + + /** + * Retrieves the processor's configured exceptions. + * + * @return string[] + * An associative array of exceptions, with words as keys and stems as their + * replacements. + */ + protected function getExceptions() { + if (!empty($this->options['exceptions'])) { + $exceptions = parse_ini_string($this->options['exceptions'], TRUE); + return is_array($exceptions) ? $exceptions : array(); + } + return array(); + } + +} + +/** + * Implements the Porter2 stemming algorithm. + * + * @see https://github.com/markfullmer/porter2 + */ +class SearchApiPorter2 { + + /** + * The word being stemmed. + * + * @var string + */ + protected $word; + + /** + * The R1 of the word. + * + * @var int + * + * @see http://snowball.tartarus.org/texts/r1r2.html. + */ + protected $r1; + + /** + * The R2 of the word. + * + * @var int + * + * @see http://snowball.tartarus.org/texts/r1r2.html. + */ + protected $r2; + + /** + * List of exceptions to be used. + * + * @var string[] + */ + protected $exceptions = array(); + + /** + * Constructs a SearchApiPorter2 object. + * + * @param string $word + * The word to stem. + * @param string[] $custom_exceptions + * (optional) A custom list of exceptions. + */ + public function __construct($word, $custom_exceptions = array()) { + $this->word = $word; + $this->exceptions = $custom_exceptions + array( + 'skis' => 'ski', + 'skies' => 'sky', + 'dying' => 'die', + 'lying' => 'lie', + 'tying' => 'tie', + 'idly' => 'idl', + 'gently' => 'gentl', + 'ugly' => 'ugli', + 'early' => 'earli', + 'only' => 'onli', + 'singly' => 'singl', + 'sky' => 'sky', + 'news' => 'news', + 'howe' => 'howe', + 'atlas' => 'atlas', + 'cosmos' => 'cosmos', + 'bias' => 'bias', + 'andes' => 'andes', + ); + + // Set initial y, or y after a vowel, to Y. + $inc = 0; + while ($inc <= $this->length()) { + if (substr($this->word, $inc, 1) === 'y' && ($inc == 0 || $this->isVowel($inc - 1))) { + $this->word = substr_replace($this->word, 'Y', $inc, 1); + + } + $inc++; + } + // Establish the regions R1 and R2. See function R(). + $this->r1 = $this->R(1); + $this->r2 = $this->R(2); + } + + /** + * Computes the stem of the word. + * + * @return string + * The word's stem. + */ + public function stem() { + // Ignore exceptions & words that are two letters or less. + if ($this->exceptions() || $this->length() <= 2) { + return strtolower($this->word); + } + else { + $this->step0(); + $this->step1a(); + $this->step1b(); + $this->step1c(); + $this->step2(); + $this->step3(); + $this->step4(); + $this->step5(); + } + return strtolower($this->word); + } + + /** + * Determines whether the word is contained in our list of exceptions. + * + * If so, the $word property is changed to the stem listed in the exceptions. + * + * @return bool + * TRUE if the word was an exception, FALSE otherwise. + */ + protected function exceptions() { + if (isset($this->exceptions[$this->word])) { + $this->word = $this->exceptions[$this->word]; + return TRUE; + } + return FALSE; + } + + /** + * Searches for the longest among the "s" suffixes and removes it. + * + * Implements step 0 of the Porter2 algorithm. + */ + protected function step0() { + $found = FALSE; + $checks = array("'s'", "'s", "'"); + foreach ($checks as $check) { + if (!$found && $this->hasEnding($check)) { + $this->removeEnding($check); + $found = TRUE; + } + } + } + + /** + * Handles various suffixes, of which the longest is replaced. + * + * Implements step 1a of the Porter2 algorithm. + */ + protected function step1a() { + $found = FALSE; + if ($this->hasEnding('sses')) { + $this->removeEnding('sses'); + $this->addEnding('ss'); + $found = TRUE; + } + $checks = array('ied', 'ies'); + foreach ($checks as $check) { + if (!$found && $this->hasEnding($check)) { + $length = $this->length(); + $this->removeEnding($check); + if ($length > 4) { + $this->addEnding('i'); + } + else { + $this->addEnding('ie'); + } + $found = TRUE; + } + } + if ($this->hasEnding('us') || $this->hasEnding('ss')) { + $found = TRUE; + } + // Delete if preceding word part has a vowel not immediately before the s. + if (!$found && $this->hasEnding('s') && $this->containsVowel(substr($this->word, 0, -2))) { + $this->removeEnding('s'); + } + } + + /** + * Handles various suffixes, of which the longest is replaced. + * + * Implements step 1b of the Porter2 algorithm. + */ + protected function step1b() { + $exceptions = array( + 'inning', + 'outing', + 'canning', + 'herring', + 'earring', + 'proceed', + 'exceed', + 'succeed', + ); + if (in_array($this->word, $exceptions)) { + return; + } + $checks = array('eedly', 'eed'); + foreach ($checks as $check) { + if ($this->hasEnding($check)) { + if ($this->r1 !== $this->length()) { + $this->removeEnding($check); + $this->addEnding('ee'); + } + return; + } + } + $checks = array('ingly', 'edly', 'ing', 'ed'); + $second_endings = array('at', 'bl', 'iz'); + foreach ($checks as $check) { + // If the ending is present and the previous part contains a vowel. + if ($this->hasEnding($check) && $this->containsVowel(substr($this->word, 0, -strlen($check)))) { + $this->removeEnding($check); + foreach ($second_endings as $ending) { + if ($this->hasEnding($ending)) { + $this->addEnding('e'); + return; + } + } + // If the word ends with a double, remove the last letter. + $found = $this->removeDoubles(); + // If the word is short, add e (so hop -> hope). + if (!$found && ($this->isShort())) { + $this->addEnding('e'); + } + return; + } + } + } + + /** + * Replaces suffix y or Y with i if after non-vowel not @ word begin. + * + * Implements step 1c of the Porter2 algorithm. + */ + protected function step1c() { + if (($this->hasEnding('y') || $this->hasEnding('Y')) && $this->length() > 2 && !($this->isVowel($this->length() - 2))) { + $this->removeEnding('y'); + $this->addEnding('i'); + } + } + + /** + * Implements step 2 of the Porter2 algorithm. + */ + protected function step2() { + $checks = array( + "ization" => "ize", + "iveness" => "ive", + "fulness" => "ful", + "ational" => "ate", + "ousness" => "ous", + "biliti" => "ble", + "tional" => "tion", + "lessli" => "less", + "fulli" => "ful", + "entli" => "ent", + "ation" => "ate", + "aliti" => "al", + "iviti" => "ive", + "ousli" => "ous", + "alism" => "al", + "abli" => "able", + "anci" => "ance", + "alli" => "al", + "izer" => "ize", + "enci" => "ence", + "ator" => "ate", + "bli" => "ble", + "ogi" => "og", + ); + foreach ($checks as $find => $replace) { + if ($this->hasEnding($find)) { + if ($this->inR1($find)) { + $this->removeEnding($find); + $this->addEnding($replace); + } + return; + } + } + if ($this->hasEnding('li')) { + if ($this->length() > 4 && $this->validLi($this->charAt(-3))) { + $this->removeEnding('li'); + } + } + } + + /** + * Implements step 3 of the Porter2 algorithm. + */ + protected function step3() { + $checks = array( + 'ational' => 'ate', + 'tional' => 'tion', + 'alize' => 'al', + 'icate' => 'ic', + 'iciti' => 'ic', + 'ical' => 'ic', + 'ness' => '', + 'ful' => '', + ); + foreach ($checks as $find => $replace) { + if ($this->hasEnding($find)) { + if ($this->inR1($find)) { + $this->removeEnding($find); + $this->addEnding($replace); + } + return; + } + } + if ($this->hasEnding('ative')) { + if ($this->inR2('ative')) { + $this->removeEnding('ative'); + } + } + } + + /** + * Implements step 4 of the Porter2 algorithm. + */ + protected function step4() { + $checks = array( + 'ement', + 'ment', + 'ance', + 'ence', + 'able', + 'ible', + 'ant', + 'ent', + 'ion', + 'ism', + 'ate', + 'iti', + 'ous', + 'ive', + 'ize', + 'al', + 'er', + 'ic', + ); + foreach ($checks as $check) { + // Among the suffixes, if found and in R2, delete. + if ($this->hasEnding($check)) { + if ($this->inR2($check)) { + if ($check !== 'ion' || in_array($this->charAt(-4), array('s', 't'))) { + $this->removeEnding($check); + } + } + return; + } + } + } + + /** + * Implements step 5 of the Porter2 algorithm. + */ + protected function step5() { + if ($this->hasEnding('e')) { + // Delete if in R2, or in R1 and not preceded by a short syllable. + if ($this->inR2('e') || ($this->inR1('e') && !$this->isShortSyllable($this->length() - 3))) { + $this->removeEnding('e'); + } + return; + } + if ($this->hasEnding('l')) { + // Delete if in R2 and preceded by l. + if ($this->inR2('l') && $this->charAt(-2) == 'l') { + $this->removeEnding('l'); + } + } + } + + /** + * Removes certain double consonants from the word's end. + * + * @return bool + * TRUE if a match was found and removed, FALSE otherwise. + */ + protected function removeDoubles() { + $found = FALSE; + $doubles = array('bb', 'dd', 'ff', 'gg', 'mm', 'nn', 'pp', 'rr', 'tt'); + foreach ($doubles as $double) { + if (substr($this->word, -2) == $double) { + $this->word = substr($this->word, 0, -1); + $found = TRUE; + break; + } + } + return $found; + } + + /** + * Checks whether a character is a vowel. + * + * @param int $position + * The character's position. + * @param string|null $word + * (optional) The word in which to check. Defaults to $this->word. + * @param string[] $additional + * (optional) Additional characters that should count as vowels. + * + * @return bool + * TRUE if the character is a vowel, FALSE otherwise. + */ + protected function isVowel($position, $word = NULL, $additional = array()) { + if ($word === NULL) { + $word = $this->word; + } + $vowels = array_merge(array('a', 'e', 'i', 'o', 'u', 'y'), $additional); + return in_array($this->charAt($position, $word), $vowels); + } + + /** + * Retrieves the character at the given position. + * + * @param int $position + * The 0-based index of the character. If a negative number is given, the + * position is counted from the end of the string. + * @param string|null $word + * (optional) The word from which to retrieve the character. Defaults to + * $this->word. + * + * @return string + * The character at the given position, or an empty string if the given + * position was illegal. + */ + protected function charAt($position, $word = NULL) { + if ($word === NULL) { + $word = $this->word; + } + $length = strlen($word); + if (abs($position) >= $length) { + return ''; + } + if ($position < 0) { + $position += $length; + } + return $word[$position]; + } + + /** + * Determines whether the word ends in a "vowel-consonant" suffix. + * + * Unless the word is only two characters long, it also checks that the + * third-last character is neither "w", "x" nor "Y". + * + * @param int|null $position + * (optional) If given, do not check the end of the word, but the character + * at the given position, and the next one. + * + * @return bool + * TRUE if the word has the described suffix, FALSE otherwise. + */ + protected function isShortSyllable($position = NULL) { + if ($position === NULL) { + $position = $this->length() - 2; + } + // A vowel at the beginning of the word followed by a non-vowel. + if ($position === 0) { + return $this->isVowel(0) && !$this->isVowel(1); + } + // Vowel followed by non-vowel other than w, x, Y and preceded by + // non-vowel. + $additional = array('w', 'x', 'Y'); + return !$this->isVowel($position - 1) && $this->isVowel($position) && !$this->isVowel($position + 1, NULL, $additional); + } + + /** + * Determines whether the word is short. + * + * A word is called short if it ends in a short syllable and if R1 is null. + * + * @return bool + * TRUE if the word is short, FALSE otherwise. + */ + protected function isShort() { + return $this->isShortSyllable() && $this->r1 == $this->length(); + } + + /** + * Determines the start of a certain "R" region. + * + * R is a region after the first non-vowel following a vowel, or end of word. + * + * @param int $type + * (optional) 1 or 2. If 2, then calculate the R after the R1. + * + * @return int + * The R position. + */ + protected function R($type = 1) { + $inc = 1; + if ($type === 2) { + $inc = $this->r1; + } + elseif ($this->length() > 5) { + $prefix_5 = substr($this->word, 0, 5); + if ($prefix_5 === 'gener' || $prefix_5 === 'arsen') { + return 5; + } + if ($this->length() > 6 && substr($this->word, 0, 6) === 'commun') { + return 6; + } + } + + while ($inc <= $this->length()) { + if (!$this->isVowel($inc) && $this->isVowel($inc - 1)) { + $position = $inc; + break; + } + $inc++; + } + if (!isset($position)) { + $position = $this->length(); + } + else { + // We add one, as this is the position AFTER the first non-vowel. + $position++; + } + return $position; + } + + /** + * Checks whether the given string is contained in R1. + * + * @param string $string + * The string. + * + * @return bool + * TRUE if the string is in R1, FALSE otherwise. + */ + protected function inR1($string) { + $r1 = substr($this->word, $this->r1); + return strpos($r1, $string) !== FALSE; + } + + /** + * Checks whether the given string is contained in R2. + * + * @param string $string + * The string. + * + * @return bool + * TRUE if the string is in R2, FALSE otherwise. + */ + protected function inR2($string) { + $r2 = substr($this->word, $this->r2); + return strpos($r2, $string) !== FALSE; + } + + /** + * Determines the string length of the current word. + * + * @return int + * The string length of the current word. + */ + protected function length() { + return strlen($this->word); + } + + /** + * Checks whether the word ends with the given string. + * + * @param string $string + * The string. + * + * @return bool + * TRUE if the word ends with the given string, FALSE otherwise. + */ + protected function hasEnding($string) { + $length = strlen($string); + if ($length > $this->length()) { + return FALSE; + } + return (substr_compare($this->word, $string, -1 * $length, $length) === 0); + } + + /** + * Appends a given string to the current word. + * + * @param string $string + * The ending to append. + */ + protected function addEnding($string) { + $this->word = $this->word . $string; + } + + /** + * Removes a given string from the end of the current word. + * + * Does not check whether the ending is actually there. + * + * @param string $string + * The ending to remove. + */ + protected function removeEnding($string) { + $this->word = substr($this->word, 0, -strlen($string)); + } + + /** + * Checks whether the given string contains a vowel. + * + * @param string $string + * The string to check. + * + * @return bool + * TRUE if the string contains a vowel, FALSE otherwise. + */ + protected function containsVowel($string) { + $inc = 0; + $return = FALSE; + while ($inc < strlen($string)) { + if ($this->isVowel($inc, $string)) { + $return = TRUE; + break; + } + $inc++; + } + return $return; + } + + /** + * Checks whether the given string is a valid -li prefix. + * + * @param string $string + * The string to check. + * + * @return bool + * TRUE if the given string is a valid -li prefix, FALSE otherwise. + */ + protected function validLi($string) { + return in_array($string, array( + 'c', + 'd', + 'e', + 'g', + 'h', + 'k', + 'm', + 'n', + 'r', + 't', + )); + } + +} diff --git a/www/modules/contrib/search_api/includes/processor_stopwords.inc b/www/modules/contrib/search_api/includes/processor_stopwords.inc new file mode 100644 index 000000000..d83a697c2 --- /dev/null +++ b/www/modules/contrib/search_api/includes/processor_stopwords.inc @@ -0,0 +1,132 @@ + array( + '#markup' => '' . t('Provide a stopwords file or enter the words in this form. If you do both, both will be used. Read about !stopwords.', array('!stopwords' => l(t('stop words'), "http://en.wikipedia.org/wiki/Stop_words"))) . '
', + ), + 'file' => array( + '#type' => 'textfield', + '#title' => t('Stopwords file'), + '#description' => t('This must be a stream-type description likepublic://stopwords/stopwords.txt or http://example.com/stopwords.txt or private://stopwords.txt.'),
+ ),
+ 'stopwords' => array(
+ '#type' => 'textarea',
+ '#title' => t('Stopwords'),
+ '#description' => t('Enter a space and/or linebreak separated list of stopwords that will be removed from content before it is indexed and from search terms before searching.'),
+ '#default_value' => t("but\ndid\nthe this that those\netc"),
+ ),
+ );
+
+ if (!empty($this->options)) {
+ $form['file']['#default_value'] = $this->options['file'];
+ $form['stopwords']['#default_value'] = $this->options['stopwords'];
+ }
+ return $form;
+ }
+
+ /**
+ *
+ */
+ public function configurationFormValidate(array $form, array &$values, array &$form_state) {
+ parent::configurationFormValidate($form, $values, $form_state);
+
+ $uri = $values['file'];
+ if (!empty($uri) && !@file_get_contents($uri)) {
+ $el = $form['file'];
+ form_error($el, t('Stopwords file') . ': ' . t('The file %uri is not readable or does not exist.', array('%uri' => $uri)));
+ }
+ }
+
+ /**
+ *
+ */
+ public function process(&$value) {
+ $stopwords = $this->getStopWords();
+ if (empty($stopwords) || !is_string($value)) {
+ return;
+ }
+ $words = preg_split('/\s+/', $value);
+ foreach ($words as $sub_key => $sub_value) {
+ if (isset($stopwords[$sub_value])) {
+ unset($words[$sub_key]);
+ $this->ignored[] = $sub_value;
+ }
+ }
+ $value = implode(' ', $words);
+ }
+
+ /**
+ *
+ */
+ public function preprocessSearchQuery(SearchApiQuery $query) {
+ $this->ignored = array();
+ parent::preprocessSearchQuery($query);
+ }
+
+ /**
+ *
+ */
+ public function postprocessSearchResults(array &$response, SearchApiQuery $query) {
+ if ($this->ignored) {
+ if (isset($response['ignored'])) {
+ $response['ignored'] = array_merge($response['ignored'], $this->ignored);
+ }
+ else {
+ $response['ignored'] = $this->ignored;
+ }
+ }
+ }
+
+ /**
+ * Retrieves the processor's configured stopwords.
+ *
+ * @return array
+ * An array whose keys are the stopwords set in either the file or the text
+ * field.
+ */
+ protected function getStopWords() {
+ if (isset($this->stopwords)) {
+ return $this->stopwords;
+ }
+ $file_words = $form_words = array();
+ if (!empty($this->options['file']) && $stopwords_file = file_get_contents($this->options['file'])) {
+ $file_words = preg_split('/\s+/', $stopwords_file);
+ }
+ if (!empty($this->options['stopwords'])) {
+ $form_words = preg_split('/\s+/', $this->options['stopwords']);
+ }
+ $this->stopwords = array_flip(array_merge($file_words, $form_words));
+ return $this->stopwords;
+ }
+}
diff --git a/www/modules/contrib/search_api/includes/processor_tokenizer.inc b/www/modules/contrib/search_api/includes/processor_tokenizer.inc
new file mode 100644
index 000000000..ef38c3b93
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/processor_tokenizer.inc
@@ -0,0 +1,129 @@
+index->getFields();
+ $field_options = array();
+ foreach ($fields as $name => $field) {
+ if (empty($field['real_type']) && search_api_is_text_type($field['type'])) {
+ $field_options[$name] = $field['name'];
+ }
+ }
+ $form['fields']['#options'] = $field_options;
+
+ $form += array(
+ 'spaces' => array(
+ '#type' => 'textfield',
+ '#title' => t('Whitespace characters'),
+ '#description' => t('Specify the characters that should be regarded as whitespace and therefore used as word-delimiters. ' .
+ 'Specify the characters as a PCRE character class. ' .
+ 'Note: For non-English content, the default setting might not be suitable.',
+ array('@link' => url('http://www.php.net/manual/en/regexp.reference.character-classes.php'))),
+ '#default_value' => "[^[:alnum:]]",
+ ),
+ 'ignorable' => array(
+ '#type' => 'textfield',
+ '#title' => t('Ignorable characters'),
+ '#description' => t('Specify characters which should be removed from fulltext fields and search strings (e.g., "-"). The same format as above is used.'),
+ '#default_value' => "[']",
+ ),
+ );
+
+ if (!empty($this->options)) {
+ $form['spaces']['#default_value'] = $this->options['spaces'];
+ $form['ignorable']['#default_value'] = $this->options['ignorable'];
+ }
+
+ return $form;
+ }
+
+ /**
+ *
+ */
+ public function configurationFormValidate(array $form, array &$values, array &$form_state) {
+ parent::configurationFormValidate($form, $values, $form_state);
+
+ $spaces = str_replace('/', '\/', $values['spaces']);
+ $ignorable = str_replace('/', '\/', $values['ignorable']);
+ if (@preg_match('/(' . $spaces . ')+/u', '') === FALSE) {
+ $el = $form['spaces'];
+ form_error($el, $el['#title'] . ': ' . t('The entered text is no valid regular expression.'));
+ }
+ if (@preg_match('/(' . $ignorable . ')+/u', '') === FALSE) {
+ $el = $form['ignorable'];
+ form_error($el, $el['#title'] . ': ' . t('The entered text is no valid regular expression.'));
+ }
+ }
+
+ /**
+ *
+ */
+ protected function processFieldValue(&$value) {
+ $this->prepare();
+ if ($this->ignorable) {
+ $value = preg_replace('/(' . $this->ignorable . ')+/u', '', $value);
+ }
+ if ($this->spaces) {
+ $arr = preg_split('/(' . $this->spaces . ')+/u', $value);
+ if (count($arr) > 1) {
+ $value = array();
+ foreach ($arr as $token) {
+ $value[] = array('value' => $token);
+ }
+ }
+ }
+ }
+
+ /**
+ *
+ */
+ protected function process(&$value) {
+ // We don't touch integers, NULL values or the like.
+ if (is_string($value)) {
+ $this->prepare();
+ if ($this->ignorable) {
+ $value = preg_replace('/' . $this->ignorable . '+/u', '', $value);
+ }
+ if ($this->spaces) {
+ $value = preg_replace('/' . $this->spaces . '+/u', ' ', $value);
+ }
+ }
+ }
+
+ /**
+ *
+ */
+ protected function prepare() {
+ if (!isset($this->spaces)) {
+ $this->spaces = str_replace('/', '\/', $this->options['spaces']);
+ $this->ignorable = str_replace('/', '\/', $this->options['ignorable']);
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/includes/processor_transliteration.inc b/www/modules/contrib/search_api/includes/processor_transliteration.inc
new file mode 100644
index 000000000..9f3984839
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/processor_transliteration.inc
@@ -0,0 +1,23 @@
+langcode);
+ }
+ }
+
+}
diff --git a/www/modules/contrib/search_api/includes/query.inc b/www/modules/contrib/search_api/includes/query.inc
new file mode 100644
index 000000000..7a3f20d03
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/query.inc
@@ -0,0 +1,1122 @@
+", "<", "<=", ">=", ">". They
+ * have the same semantics as the corresponding SQL operators.
+ * If $field is a fulltext field, $operator can only be "=" or "<>", which
+ * are in this case interpreted as "contains" or "doesn't contain",
+ * respectively.
+ * If $value is NULL, $operator also can only be "=" or "<>", meaning the
+ * field must have no or some value, respectively.
+ *
+ * @return SearchApiQueryInterface
+ * The called object.
+ */
+ public function condition($field, $value, $operator = '=');
+
+ /**
+ * Adds a sort directive to this search query.
+ *
+ * If no sort is manually set, the results will be sorted descending by
+ * relevance.
+ *
+ * @param string $field
+ * The field to sort by. The special fields 'search_api_relevance' (sort by
+ * relevance) and 'search_api_id' (sort by item id) may be used. Also, if
+ * the search server supports the "search_api_random_sort" feature, the
+ * "search_api_random" special field can be used to sort randomly.
+ * @param string $order
+ * The order to sort items in - either 'ASC' or 'DESC'.
+ *
+ * @return SearchApiQueryInterface
+ * The called object.
+ *
+ * @throws SearchApiException
+ * If the field is multi-valued or of a fulltext type.
+ */
+ public function sort($field, $order = 'ASC');
+
+ /**
+ * Adds a range of results to return.
+ *
+ * This will be saved in the query's options. If called without parameters,
+ * this will remove all range restrictions previously set.
+ *
+ * @param int|null $offset
+ * The zero-based offset of the first result returned.
+ * @param int|null $limit
+ * The number of results to return.
+ *
+ * @return SearchApiQueryInterface
+ * The called object.
+ */
+ public function range($offset = NULL, $limit = NULL);
+
+ /**
+ * Executes this search query.
+ *
+ * @return array
+ * An associative array containing the search results. The following keys
+ * are standardized:
+ * - 'result count': The overall number of results for this query, without
+ * range restrictions. Might be approximated, for large numbers, or
+ * skipped entirely if the "skip result count" option was set on this
+ * query.
+ * - results: An array of results, ordered as specified. The array keys are
+ * the items' IDs, values are arrays containing the following keys:
+ * - id: The item's ID.
+ * - score: A float measuring how well the item fits the search.
+ * - fields: (optional) If set, an array containing some field values
+ * already ready-to-use. This allows search engines (or postprocessors)
+ * to store extracted fields so other modules don't have to extract them
+ * again. This fields should always be checked by modules that want to
+ * use field contents of the result items. The format of the array is
+ * field IDs (as used by the Search API internally) mapped to either the
+ * raw value of the field (scalar or array value), or an associative
+ * array with the following keys:
+ * - #value: The raw field value.
+ * - #sanitize_callback: The callback to use for sanitizing the field
+ * value for HTML output, or FALSE to state that the field value is
+ * already sanitized.
+ * In the simple form, it's assumed the field value should be sanitized
+ * with check_plain().
+ * - entity: (optional) If set, the fully loaded result item. This field
+ * should always be used by modules using search results, to avoid
+ * duplicate item loads.
+ * - excerpt: (optional) If set, an HTML text containing highlighted
+ * portions of the fulltext that match the query.
+ * - warnings: A numeric array of translated warning messages that may be
+ * displayed to the user.
+ * - ignored: A numeric array of search keys that were ignored for this
+ * search (e.g., because of being too short or stop words).
+ * - performance: An associative array with the time taken (as floats, in
+ * seconds) for specific parts of the search execution:
+ * - complete: The complete runtime of the query.
+ * - hooks: Hook invocations and other client-side preprocessing.
+ * - preprocessing: Preprocessing of the service class.
+ * - execution: The actual query to the search server, in whatever form.
+ * - postprocessing: Preparing the results for returning.
+ * Additional metadata may be returned in other keys. Only 'result count'
+ * and 'results' always have to be set, all other entries are optional.
+ *
+ * @throws SearchApiException
+ * If an error prevented the search from completing.
+ */
+ public function execute();
+
+ /**
+ * Prepares the query object for the search.
+ *
+ * This method should always be called by execute() and contain all necessary
+ * operations before the query is passed to the server's search() method.
+ *
+ * @throws SearchApiException
+ * If any error occurred during the preparation of the query.
+ */
+ public function preExecute();
+
+ /**
+ * Postprocesses the search results before they are returned.
+ *
+ * This method should always be called by execute() and contain all necessary
+ * operations after the results are returned from the server.
+ *
+ * @param array $results
+ * The results returned by the server, which may be altered. The data
+ * structure is the same as returned by execute().
+ */
+ public function postExecute(array &$results);
+
+ /**
+ * Retrieves the index associated with this search.
+ *
+ * @return SearchApiIndex
+ * The search index this query should be executed on.
+ */
+ public function getIndex();
+
+ /**
+ * Retrieves the search keys for this query.
+ *
+ * @return array|string|null
+ * This object's search keys - either a string or an array specifying a
+ * complex search expression.
+ * An array will contain a '#conjunction' key specifying the conjunction
+ * type, and search strings or nested expression arrays at numeric keys.
+ * Additionally, a '#negation' key might be present, which means – unless it
+ * maps to a FALSE value – that the search keys contained in that array
+ * should be negated, i.e. not be present in returned results. The negation
+ * works on the whole array, not on each contained term individually – i.e.,
+ * with the "AND" conjunction and negation, only results that contain all
+ * the terms in the array should be excluded; with the "OR" conjunction and
+ * negation, all results containing one or more of the terms in the array
+ * should be excluded.
+ *
+ * @see keys()
+ */
+ public function &getKeys();
+
+ /**
+ * Retrieves the unparsed search keys for this query as originally entered.
+ *
+ * @return array|string|null
+ * The unprocessed search keys, exactly as passed to this object. Has the
+ * same format as the return value of getKeys().
+ *
+ * @see keys()
+ */
+ public function getOriginalKeys();
+
+ /**
+ * Retrieves the fulltext fields that will be searched for the search keys.
+ *
+ * @return array
+ * An array containing the fields that should be searched for the search
+ * keys.
+ *
+ * @see fields()
+ */
+ public function &getFields();
+
+ /**
+ * Retrieves the filter object associated with this search query.
+ *
+ * @return SearchApiQueryFilterInterface
+ * This object's associated filter object.
+ */
+ public function getFilter();
+
+ /**
+ * Retrieves the sorts set for this query.
+ *
+ * @return array
+ * An array specifying the sort order for this query. Array keys are the
+ * field names in order of importance, the values are the respective order
+ * in which to sort the results according to the field.
+ *
+ * @see sort()
+ */
+ public function &getSort();
+
+ /**
+ * Retrieves an option set on this search query.
+ *
+ * @param string $name
+ * The name of an option.
+ * @param mixed $default
+ * The value to return if the specified option is not set.
+ *
+ * @return mixed
+ * The value of the option with the specified name, if set. NULL otherwise.
+ */
+ public function getOption($name, $default = NULL);
+
+ /**
+ * Sets an option for this search query.
+ *
+ * @param string $name
+ * The name of an option.
+ * @param mixed $value
+ * The new value of the option.
+ *
+ * @return mixed
+ * The option's previous value.
+ */
+ public function setOption($name, $value);
+
+ /**
+ * Retrieves all options set for this search query.
+ *
+ * The return value is a reference to the options so they can also be altered
+ * this way.
+ *
+ * @return array
+ * An associative array of query options.
+ */
+ public function &getOptions();
+
+}
+
+/**
+ * Provides a standard implementation of the SearchApiQueryInterface.
+ */
+class SearchApiQuery implements SearchApiQueryInterface {
+
+ /**
+ * The index this query will use.
+ *
+ * @var SearchApiIndex
+ */
+ protected $index;
+
+ /**
+ * The index's machine name.
+ *
+ * Used during serialization to avoid serializing the whole index object.
+ *
+ * @var string
+ */
+ protected $index_id;
+
+ /**
+ * The search keys. If NULL, this will be a filter-only search.
+ *
+ * @var mixed
+ */
+ protected $keys;
+
+ /**
+ * The unprocessed search keys, as passed to the keys() method.
+ *
+ * @var mixed
+ */
+ protected $orig_keys;
+
+ /**
+ * The fields that will be searched for the keys.
+ *
+ * @var array
+ */
+ protected $fields;
+
+ /**
+ * The search filter associated with this query.
+ *
+ * @var SearchApiQueryFilterInterface
+ */
+ protected $filter;
+
+ /**
+ * The sort associated with this query.
+ *
+ * @var array
+ */
+ protected $sort;
+
+ /**
+ * Search options configuring this query.
+ *
+ * @var array
+ */
+ protected $options;
+
+ /**
+ * Flag for whether preExecute() was already called for this query.
+ *
+ * @var bool
+ */
+ protected $pre_execute = FALSE;
+
+ /**
+ * {@inheritdoc}
+ */
+ public function __construct(SearchApiIndex $index, array $options = array()) {
+ if (empty($index->options['fields'])) {
+ throw new SearchApiException(t("Can't search an index which hasn't got any fields defined."));
+ }
+ if (empty($index->enabled)) {
+ throw new SearchApiException(t("Can't search a disabled index."));
+ }
+ if (isset($options['parse mode'])) {
+ $modes = $this->parseModes();
+ if (!isset($modes[$options['parse mode']])) {
+ throw new SearchApiException(t('Unknown parse mode: @mode.', array('@mode' => $options['parse mode'])));
+ }
+ }
+ $this->index = $index;
+ $this->options = $options + array(
+ 'conjunction' => 'AND',
+ 'parse mode' => 'terms',
+ 'filter class' => 'SearchApiQueryFilter',
+ 'search id' => __CLASS__,
+ );
+ $this->filter = $this->createFilter('AND');
+ $this->sort = array();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function parseModes() {
+ $modes['direct'] = array(
+ 'name' => t('Direct query'),
+ 'description' => t("Don't parse the query, just hand it to the search server unaltered. " .
+ "Might fail if the query contains syntax errors in regard to the specific server's query syntax."),
+ );
+ $modes['single'] = array(
+ 'name' => t('Single term'),
+ 'description' => t('The query is interpreted as a single keyword, maybe containing spaces or special characters.'),
+ );
+ $modes['terms'] = array(
+ 'name' => t('Multiple terms'),
+ 'description' => t('The query is interpreted as multiple keywords separated by spaces. ' .
+ 'Keywords containing spaces may be "quoted". Quoted keywords must still be separated by spaces.'),
+ );
+ // @todo Add fourth mode for complicated expressions, e.g.: »"vanilla ice" OR (love NOT hate)«
+ return $modes;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function parseKeys($keys, $mode) {
+ if ($keys === NULL || is_array($keys)) {
+ return $keys;
+ }
+ $keys = '' . $keys;
+ switch ($mode) {
+ case 'direct':
+ return $keys;
+
+ case 'single':
+ return array('#conjunction' => $this->options['conjunction'], $keys);
+
+ case 'terms':
+ $ret = preg_split('/\s+/u', $keys);
+ $quoted = FALSE;
+ $str = '';
+ foreach ($ret as $k => $v) {
+ if (!$v) {
+ continue;
+ }
+ if ($quoted) {
+ if (substr($v, -1) == '"') {
+ $v = substr($v, 0, -1);
+ $str .= ' ' . $v;
+ $ret[$k] = $str;
+ $quoted = FALSE;
+ }
+ else {
+ $str .= ' ' . $v;
+ unset($ret[$k]);
+ }
+ }
+ elseif ($v[0] == '"') {
+ $len = strlen($v);
+ if ($len > 1 && $v[$len - 1] == '"') {
+ $ret[$k] = substr($v, 1, -1);
+ }
+ else {
+ $str = substr($v, 1);
+ $quoted = TRUE;
+ unset($ret[$k]);
+ }
+ }
+ }
+ if ($quoted) {
+ $ret[] = $str;
+ }
+ $ret['#conjunction'] = $this->options['conjunction'];
+ return array_filter($ret);
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function createFilter($conjunction = 'AND', $tags = array()) {
+ $filter_class = $this->options['filter class'];
+ return new $filter_class($conjunction, $tags);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function keys($keys = NULL) {
+ $this->orig_keys = $keys;
+ if (isset($keys)) {
+ $this->keys = $this->parseKeys($keys, $this->options['parse mode']);
+ }
+ else {
+ $this->keys = NULL;
+ }
+ return $this;
+ }
+ /**
+ * {@inheritdoc}
+ */
+ public function fields(array $fields) {
+ $fulltext_fields = $this->index->getFulltextFields();
+ foreach (array_diff($fields, $fulltext_fields) as $field) {
+ throw new SearchApiException(t('Trying to search on field @field which is no indexed fulltext field.', array('@field' => $field)));
+ }
+ $this->fields = $fields;
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function filter(SearchApiQueryFilterInterface $filter) {
+ $this->filter->filter($filter);
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function condition($field, $value, $operator = '=') {
+ $this->filter->condition($field, $value, $operator);
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function sort($field, $order = 'ASC') {
+ $fields = $this->index->options['fields'];
+ $fields += array(
+ 'search_api_relevance' => array('type' => 'decimal'),
+ 'search_api_id' => array('type' => 'integer'),
+ );
+ if ($this->getIndex()->server()->supportsFeature('search_api_random_sort')) {
+ $fields['search_api_random'] = array('type' => 'integer');
+ }
+
+ if (empty($fields[$field])) {
+ throw new SearchApiException(t('Trying to sort on unknown field @field.', array('@field' => $field)));
+ }
+ $type = $fields[$field]['type'];
+ if (search_api_is_list_type($type) || search_api_is_text_type($type)) {
+ throw new SearchApiException(t('Trying to sort on field @field of illegal type @type.', array('@field' => $field, '@type' => $type)));
+ }
+ $order = strtoupper(trim($order)) == 'DESC' ? 'DESC' : 'ASC';
+ $this->sort[$field] = $order;
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function range($offset = NULL, $limit = NULL) {
+ $this->options['offset'] = $offset;
+ $this->options['limit'] = $limit;
+ return $this;
+ }
+
+
+ /**
+ * {@inheritdoc}
+ */
+ public function execute() {
+ $start = microtime(TRUE);
+
+ // Prepare the query for execution by the server.
+ $this->preExecute();
+
+ $pre_search = microtime(TRUE);
+
+ // Execute query.
+ $response = $this->index->server()->search($this);
+
+ $post_search = microtime(TRUE);
+
+ // Postprocess the search results.
+ $this->postExecute($response);
+
+ $end = microtime(TRUE);
+ $response['performance']['complete'] = $end - $start;
+ $response['performance']['hooks'] = $response['performance']['complete'] - ($post_search - $pre_search);
+
+ // Store search for later retrieval for facets, etc.
+ search_api_current_search(NULL, $this, $response);
+
+ return $response;
+ }
+
+ /**
+ * Adds language filters for the query.
+ *
+ * Internal helper function.
+ *
+ * @param array $languages
+ * The languages for which results should be returned.
+ *
+ * @throws SearchApiException
+ * If there was a logical error in the combination of filters and languages.
+ */
+ protected function addLanguages(array $languages) {
+ if (array_search(LANGUAGE_NONE, $languages) === FALSE) {
+ $languages[] = LANGUAGE_NONE;
+ }
+
+ $languages = backdrop_map_assoc($languages);
+ $langs_to_add = $languages;
+ $filters = $this->filter->getFilters();
+ while ($filters && $langs_to_add) {
+ $filter = array_shift($filters);
+ if (is_array($filter)) {
+ if ($filter[0] == 'search_api_language' && $filter[2] == '=') {
+ $lang = $filter[1];
+ if (isset($languages[$lang])) {
+ unset($langs_to_add[$lang]);
+ }
+ else {
+ throw new SearchApiException(t('Impossible combination of filters and languages. There is a filter for "@language", but allowed languages are: "@languages".', array('@language' => $lang, '@languages' => implode('", "', $languages))));
+ }
+ }
+ }
+ else {
+ if ($filter->getConjunction() == 'AND') {
+ $filters += $filter->getFilters();
+ }
+ }
+ }
+ if ($langs_to_add) {
+ if (count($langs_to_add) == 1) {
+ $this->condition('search_api_language', reset($langs_to_add));
+ }
+ else {
+ $filter = $this->createFilter('OR');
+ foreach ($langs_to_add as $lang) {
+ $filter->condition('search_api_language', $lang);
+ }
+ $this->filter($filter);
+ }
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function preExecute() {
+ // Make sure to only execute this once per query.
+ if (!$this->pre_execute) {
+ $this->pre_execute = TRUE;
+ // Add filter for languages.
+ if (isset($this->options['languages'])) {
+ $this->addLanguages($this->options['languages']);
+ }
+
+ // Add fulltext fields, unless set.
+ if ($this->fields === NULL) {
+ $this->fields = $this->index->getFulltextFields();
+ }
+
+ // Preprocess query.
+ $this->index->preprocessSearchQuery($this);
+
+ // Let modules alter the query.
+ backdrop_alter('search_api_query', $this);
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function postExecute(array &$results) {
+ // Postprocess results.
+ $this->index->postprocessSearchResults($results, $this);
+
+ // Let modules alter the results.
+ backdrop_alter('search_api_results', $results, $this);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getIndex() {
+ return $this->index;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getKeys() {
+ return $this->keys;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getOriginalKeys() {
+ return $this->orig_keys;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getFields() {
+ return $this->fields;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getFilter() {
+ return $this->filter;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getSort() {
+ return $this->sort;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getOption($name, $default = NULL) {
+ return array_key_exists($name, $this->options) ? $this->options[$name] : $default;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setOption($name, $value) {
+ $old = $this->getOption($name);
+ $this->options[$name] = $value;
+ return $old;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getOptions() {
+ return $this->options;
+ }
+
+ /**
+ * Implements the magic __sleep() method to avoid serializing the index.
+ */
+ public function __sleep() {
+ $this->index_id = $this->index->machine_name;
+ $keys = get_object_vars($this);
+ unset($keys['index']);
+ return array_keys($keys);
+ }
+
+ /**
+ * Implements the magic __wakeup() method to reload the query's index.
+ */
+ public function __wakeup() {
+ if (!isset($this->index) && !empty($this->index_id)) {
+ $this->index = search_api_index_load($this->index_id);
+ unset($this->index_id);
+ }
+ }
+
+ /**
+ * Implements the magic __clone() method to clone the filter, too.
+ */
+ public function __clone() {
+ $this->filter = clone $this->filter;
+ }
+
+ /**
+ * Implements the magic __toString() method to simplify debugging.
+ */
+ public function __toString() {
+ $ret = 'Index: ' . $this->index->machine_name . "\n";
+ $ret .= 'Keys: ' . str_replace("\n", "\n ", var_export($this->orig_keys, TRUE)) . "\n";
+ if (isset($this->keys)) {
+ $ret .= 'Parsed keys: ' . str_replace("\n", "\n ", var_export($this->keys, TRUE)) . "\n";
+ $ret .= 'Searched fields: ' . (isset($this->fields) ? implode(', ', $this->fields) : '[ALL]') . "\n";
+ }
+ if ($filter = (string) $this->filter) {
+ $filter = str_replace("\n", "\n ", $filter);
+ $ret .= "Filters:\n $filter\n";
+ }
+ if ($this->sort) {
+ $sort = array();
+ foreach ($this->sort as $field => $order) {
+ $sort[] = "$field $order";
+ }
+ $ret .= 'Sorting: ' . implode(', ', $sort) . "\n";
+ }
+ $options = $this->sanitizeOptions($this->options);
+ $options = str_replace("\n", "\n ", var_export($options, TRUE));
+ $ret .= 'Options: ' . $options . "\n";
+ return $ret;
+ }
+
+ /**
+ * Sanitizes an array of options in a way that plays nice with var_export().
+ *
+ * @param array $options
+ * An array of options.
+ *
+ * @return array
+ * The sanitized options.
+ */
+ protected function sanitizeOptions(array $options) {
+ foreach ($options as $key => $value) {
+ if (is_object($value)) {
+ $options[$key] = 'object (' . get_class($value) . ')';
+ }
+ elseif (is_array($value)) {
+ $options[$key] = $this->sanitizeOptions($value);
+ }
+ }
+ return $options;
+ }
+
+}
+
+/**
+ * Represents a filter on a search query.
+ *
+ * Filters apply conditions on one or more fields with a specific conjunction
+ * (AND or OR) and may contain nested filters.
+ */
+interface SearchApiQueryFilterInterface {
+
+ /**
+ * Constructs a new filter that uses the specified conjunction.
+ *
+ * @param string $conjunction
+ * (optional) The conjunction to use for this filter - either 'AND' or 'OR'.
+ * @param array $tags
+ * (optional) An arbitrary set of tags. Can be used to identify this filter
+ * down the line if necessary. This is primarily used by the facet system
+ * to support OR facet queries.
+ */
+ public function __construct($conjunction = 'AND', array $tags = array());
+
+ /**
+ * Sets this filter's conjunction.
+ *
+ * @param string $conjunction
+ * The conjunction to use for this filter - either 'AND' or 'OR'.
+ *
+ * @return SearchApiQueryFilterInterface
+ * The called object.
+ */
+ public function setConjunction($conjunction);
+
+ /**
+ * Adds a subfilter.
+ *
+ * @param SearchApiQueryFilterInterface $filter
+ * A SearchApiQueryFilterInterface object that should be added as a
+ * subfilter.
+ *
+ * @return SearchApiQueryFilterInterface
+ * The called object.
+ */
+ public function filter(SearchApiQueryFilterInterface $filter);
+
+ /**
+ * Adds a new ($field $operator $value) condition.
+ *
+ * @param string $field
+ * The field to filter on, e.g. 'title'.
+ * @param mixed $value
+ * The value the field should have (or be related to by the operator).
+ * @param string $operator
+ * The operator to use for checking the constraint. The following operators
+ * are supported for primitive types: "=", "<>", "<", "<=", ">=", ">". They
+ * have the same semantics as the corresponding SQL operators.
+ * If $field is a fulltext field, $operator can only be "=" or "<>", which
+ * are in this case interpreted as "contains" or "doesn't contain",
+ * respectively.
+ * If $value is NULL, $operator also can only be "=" or "<>", meaning the
+ * field must have no or some value, respectively.
+ *
+ * @return SearchApiQueryFilterInterface
+ * The called object.
+ */
+ public function condition($field, $value, $operator = '=');
+
+ /**
+ * Retrieves the conjunction used by this filter.
+ *
+ * @return string
+ * The conjunction used by this filter - either 'AND' or 'OR'.
+ */
+ public function getConjunction();
+
+ /**
+ * Return all conditions and nested filters contained in this filter.
+ *
+ * @return array
+ * An array containing this filter's subfilters. Each of these is either a
+ * condition, represented as a numerically indexed array with the arguments
+ * of a previous SearchApiQueryFilterInterface::condition() call (field,
+ * value, operator); or a nested filter, represented by a
+ * SearchApiQueryFilterInterface filter object.
+ */
+ public function &getFilters();
+
+ /**
+ * Checks whether a certain tag was set on this filter.
+ *
+ * @param string $tag
+ * A tag to check for.
+ *
+ * @return bool
+ * TRUE if the tag was set for this filter, FALSE otherwise.
+ */
+ public function hasTag($tag);
+
+ /**
+ * Retrieves the tags set on this filter.
+ *
+ * @return array
+ * The tags associated with this filter, as both the array keys and values.
+ */
+ public function &getTags();
+
+}
+
+/**
+ * Provides a standard implementation of SearchApiQueryFilterInterface.
+ */
+class SearchApiQueryFilter implements SearchApiQueryFilterInterface {
+
+ /**
+ * Array containing subfilters.
+ *
+ * Each of these is either an array (field, value, operator), or another
+ * SearchApiFilter object.
+ *
+ * @var array
+ */
+ protected $filters;
+
+ /**
+ * String specifying this filter's conjunction ('AND' or 'OR').
+ *
+ * @var string
+ */
+ protected $conjunction;
+
+ /**
+ * Array of tags for the filter. Can be used to identify this filter down the
+ * line if necessary. This is primarily used by the facet system to support OR
+ * facet queries.
+ *
+ * @var array
+ */
+ protected $tags;
+
+ /**
+ * {@inheritdoc}
+ */
+ public function __construct($conjunction = 'AND', array $tags = array()) {
+ $this->setConjunction($conjunction);
+ $this->filters = array();
+ $this->tags = backdrop_map_assoc($tags);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setConjunction($conjunction) {
+ $this->conjunction = strtoupper(trim($conjunction)) == 'OR' ? 'OR' : 'AND';
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function filter(SearchApiQueryFilterInterface $filter) {
+ $this->filters[] = $filter;
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function condition($field, $value, $operator = '=') {
+ $this->filters[] = array($field, $value, $operator);
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getConjunction() {
+ return $this->conjunction;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getFilters() {
+ return $this->filters;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function hasTag($tag) {
+ return isset($this->tags[$tag]);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function &getTags() {
+ // Tags can sometimes be NULL for old serialized query filter objects.
+ if (!isset($this->tags)) {
+ $this->tags = array();
+ }
+ return $this->tags;
+ }
+
+ /**
+ * Implements the magic __clone() method to clone nested filters, too.
+ */
+ public function __clone() {
+ foreach ($this->filters as $i => $filter) {
+ if (is_object($filter)) {
+ $this->filters[$i] = clone $filter;
+ }
+ }
+ }
+
+ /**
+ * Implements the magic __toString() method to simplify debugging.
+ */
+ public function __toString() {
+ // Special case for a single, nested filter:
+ if (count($this->filters) == 1 && is_object($this->filters[0])) {
+ return (string) $this->filters[0];
+ }
+ $ret = array();
+ foreach ($this->filters as $filter) {
+ if (is_object($filter)) {
+ $ret[] = "[\n " . str_replace("\n", "\n ", (string) $filter) . "\n ]";
+ }
+ else {
+ $ret[] = "$filter[0] $filter[2] " . str_replace("\n", "\n ", var_export($filter[1], TRUE));
+ }
+ }
+ return $ret ? ' ' . implode("\n{$this->conjunction}\n ", $ret) : '';
+ }
+
+}
diff --git a/www/modules/contrib/search_api/includes/server_entity.inc b/www/modules/contrib/search_api/includes/server_entity.inc
new file mode 100644
index 000000000..7a416a322
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/server_entity.inc
@@ -0,0 +1,441 @@
+entityInfo['exportable'])) {
+ return isset($this->{$this->statusKey}) && ($this->{$this->statusKey} & $status) == $status;
+ }
+ }
+
+ /**
+ * Helper method for updating entity properties.
+ *
+ * NOTE: You shouldn't change any properties of this object before calling
+ * this method, as this might lead to the fields not being saved correctly.
+ *
+ * @param array $fields
+ * The new field values.
+ *
+ * @return int|false
+ * SAVE_UPDATED on success, FALSE on failure, 0 if the fields already had
+ * the specified values.
+ */
+ public function update(array $fields) {
+ $changeable = array(
+ 'name' => 1,
+ 'enabled' => 1,
+ 'description' => 1,
+ 'options' => 1,
+ );
+ $changed = FALSE;
+ foreach ($fields as $field => $value) {
+ if (isset($changeable[$field]) && $value !== $this->$field) {
+ $this->$field = $value;
+ $changed = TRUE;
+ }
+ }
+ // If there are no new values, just return 0.
+ if (!$changed) {
+ return 0;
+ }
+ return $this->save();
+ }
+
+ /**
+ * Magic method for determining which fields should be serialized.
+ *
+ * Serialize all properties except the proxy object.
+ *
+ * @return array
+ * An array of properties to be serialized.
+ */
+ public function __sleep() {
+ $ret = get_object_vars($this);
+ unset($ret['proxy'], $ret['status'], $ret['module'], $ret['is_new']);
+ return array_keys($ret);
+ }
+
+ /**
+ * Helper method for ensuring the proxy object is set up.
+ */
+ protected function ensureProxy() {
+ if (!isset($this->proxy)) {
+ $class = search_api_get_service_info($this->class);
+ if ($class && class_exists($class['class'])) {
+ if (empty($this->options)) {
+ // We always have to provide the options.
+ $this->options = array();
+ }
+ $this->proxy = new $class['class']($this);
+ }
+ if (!($this->proxy instanceof SearchApiServiceInterface)) {
+ throw new SearchApiException(t('Search server with machine name @name specifies illegal service class @class.', array('@name' => $this->machine_name, '@class' => $this->class)));
+ }
+ }
+ }
+
+ /**
+ * Reacts to calls of undefined methods on this object.
+ *
+ * If the service class defines additional methods, not specified in the
+ * SearchApiServiceInterface interface, then they are called via this magic
+ * method.
+ */
+ public function __call($name, $arguments = array()) {
+ $this->ensureProxy();
+ return call_user_func_array(array($this->proxy, $name), $arguments);
+ }
+
+ // Proxy methods.
+ // For increased clarity, and since some parameters are passed by reference,
+ // we don't use the __call() magic method for those. This also gives us the
+ // opportunity to do additional error handling.
+
+ /**
+ * Form constructor for the server configuration form.
+ *
+ * @see SearchApiServiceInterface::configurationForm()
+ */
+ public function configurationForm(array $form, array &$form_state) {
+ $this->ensureProxy();
+ return $this->proxy->configurationForm($form, $form_state);
+ }
+
+ /**
+ * Validation callback for the form returned by configurationForm().
+ *
+ * @see SearchApiServiceInterface::configurationFormValidate()
+ */
+ public function configurationFormValidate(array $form, array &$values, array &$form_state) {
+ $this->ensureProxy();
+ return $this->proxy->configurationFormValidate($form, $values, $form_state);
+ }
+
+ /**
+ * Submit callback for the form returned by configurationForm().
+ *
+ * @see SearchApiServiceInterface::configurationFormSubmit()
+ */
+ public function configurationFormSubmit(array $form, array &$values, array &$form_state) {
+ $this->ensureProxy();
+ return $this->proxy->configurationFormSubmit($form, $values, $form_state);
+ }
+
+ /**
+ * Determines whether this service class supports a given feature.
+ *
+ * @see SearchApiServiceInterface::supportsFeature()
+ */
+ public function supportsFeature($feature) {
+ $this->ensureProxy();
+ return $this->proxy->supportsFeature($feature);
+ }
+
+ /**
+ * Displays this server's settings.
+ *
+ * @see SearchApiServiceInterface::viewSettings()
+ */
+ public function viewSettings() {
+ $this->ensureProxy();
+ return $this->proxy->viewSettings();
+ }
+
+ /**
+ * Reacts to the server's creation.
+ *
+ * @see SearchApiServiceInterface::postCreate()
+ */
+ public function postCreate() {
+ $this->ensureProxy();
+ return $this->proxy->postCreate();
+ }
+
+ /**
+ * Notifies this server that its fields are about to be updated.
+ *
+ * @see SearchApiServiceInterface::postUpdate()
+ */
+ public function postUpdate() {
+ $this->ensureProxy();
+ return $this->proxy->postUpdate();
+ }
+
+ /**
+ * Notifies this server that it is about to be deleted from the database.
+ *
+ * @see SearchApiServiceInterface::preDelete()
+ */
+ public function preDelete() {
+ $this->ensureProxy();
+ return $this->proxy->preDelete();
+ }
+
+ /**
+ * Adds a new index to this server.
+ *
+ * If an exception in the service class implementation of this method occurs,
+ * it will be caught and the operation saved as an pending server task.
+ *
+ * @see SearchApiServiceInterface::addIndex()
+ * @see search_api_server_tasks_add()
+ */
+ public function addIndex(SearchApiIndex $index) {
+ $this->ensureProxy();
+ try {
+ $this->proxy->addIndex($index);
+ }
+ catch (SearchApiException $e) {
+ $vars = array(
+ '%server' => $this->name,
+ '%index' => $index->name,
+ );
+ watchdog_exception('search_api', $e, '%type while adding index %index to server %server: !message in %function (line %line of %file).', $vars);
+ search_api_server_tasks_add($this, __FUNCTION__, $index);
+ }
+ }
+
+ /**
+ * Notifies the server that the field settings for the index have changed.
+ *
+ * If the service class implementation of the method returns TRUE, this will
+ * automatically take care of marking the items on the index for re-indexing.
+ *
+ * If an exception in the service class implementation of this method occurs,
+ * it will be caught and the operation saved as an pending server task.
+ *
+ * @see SearchApiServiceInterface::fieldsUpdated()
+ * @see search_api_server_tasks_add()
+ */
+ public function fieldsUpdated(SearchApiIndex $index) {
+ $this->ensureProxy();
+ try {
+ if ($this->proxy->fieldsUpdated($index)) {
+ _search_api_index_reindex($index);
+ return TRUE;
+ }
+ }
+ catch (SearchApiException $e) {
+ $vars = array(
+ '%server' => $this->name,
+ '%index' => $index->name,
+ );
+ watchdog_exception('search_api', $e, '%type while updating the fields of index %index on server %server: !message in %function (line %line of %file).', $vars);
+ search_api_server_tasks_add($this, __FUNCTION__, $index, isset($index->original) ? $index->original : NULL);
+ }
+ return FALSE;
+ }
+
+ /**
+ * Removes an index from this server.
+ *
+ * If an exception in the service class implementation of this method occurs,
+ * it will be caught and the operation saved as an pending server task.
+ *
+ * @see SearchApiServiceInterface::removeIndex()
+ * @see search_api_server_tasks_add()
+ */
+ public function removeIndex($index) {
+ // When removing an index from a server, it doesn't make any sense anymore to
+ // delete items from it, or react to other changes.
+ search_api_server_tasks_delete(NULL, $this, $index);
+
+ $this->ensureProxy();
+ try {
+ $this->proxy->removeIndex($index);
+ }
+ catch (SearchApiException $e) {
+ $vars = array(
+ '%server' => $this->name,
+ '%index' => is_object($index) ? $index->name : $index,
+ );
+ watchdog_exception('search_api', $e, '%type while removing index %index from server %server: !message in %function (line %line of %file).', $vars);
+ search_api_server_tasks_add($this, __FUNCTION__, $index);
+ }
+ }
+
+ /**
+ * Indexes the specified items.
+ *
+ * @see SearchApiServiceInterface::indexItems()
+ */
+ public function indexItems(SearchApiIndex $index, array $items) {
+ $this->ensureProxy();
+ return $this->proxy->indexItems($index, $items);
+ }
+
+ /**
+ * Deletes indexed items from this server.
+ *
+ * If an exception in the service class implementation of this method occurs,
+ * it will be caught and the operation saved as an pending server task.
+ *
+ * @see SearchApiServiceInterface::deleteItems()
+ * @see search_api_server_tasks_add()
+ */
+ public function deleteItems($ids = 'all', ?SearchApiIndex $index = NULL) {
+ $this->ensureProxy();
+ try {
+ $this->proxy->deleteItems($ids, $index);
+ }
+ catch (SearchApiException $e) {
+ $vars = array(
+ '%server' => $this->name,
+ );
+ watchdog_exception('search_api', $e, '%type while deleting items from server %server: !message in %function (line %line of %file).', $vars);
+ search_api_server_tasks_add($this, __FUNCTION__, $index, $ids);
+ }
+ }
+
+ /**
+ * Creates a query object for searching on an index lying on this server.
+ *
+ * @see SearchApiServiceInterface::query()
+ */
+ public function query(SearchApiIndex $index, $options = array()) {
+ $this->ensureProxy();
+ return $this->proxy->query($index, $options);
+ }
+
+ /**
+ * Executes a search on the server represented by this object.
+ *
+ * @see SearchApiServiceInterface::search()
+ */
+ public function search(SearchApiQueryInterface $query) {
+ $this->ensureProxy();
+ return $this->proxy->search($query);
+ }
+
+ /**
+ * Retrieves additional information for the server, if available.
+ *
+ * Retrieving such information is only supported if the service class supports
+ * the "search_api_service_extra" feature.
+ *
+ * @return array
+ * An array containing additional, service class-specific information about
+ * the server.
+ *
+ * @see SearchApiAbstractService::getExtraInformation()
+ */
+ public function getExtraInformation() {
+ if ($this->proxy->supportsFeature('search_api_service_extra')) {
+ return $this->proxy->getExtraInformation();
+ }
+ return array();
+ }
+
+ /**
+ * Return a label for a signup form.
+ */
+ public function label() {
+ // Return $this->title;.
+ return 'the label';
+ }
+
+ /**
+ * Overrides Entity\Entity::uri().
+ */
+ public function uri() {
+ return array();
+ }
+ /**
+ * Implements EntityInterface::id().
+ */
+ public function id() {
+ return $this->id;
+ }
+
+ /**
+ * Implements EntityInterface::entityType().
+ */
+ public function entityType() {
+ return 'search_api_server';
+ }
+}
diff --git a/www/modules/contrib/search_api/includes/service.inc b/www/modules/contrib/search_api/includes/service.inc
new file mode 100644
index 000000000..6d439a420
--- /dev/null
+++ b/www/modules/contrib/search_api/includes/service.inc
@@ -0,0 +1,473 @@
+ listing all relevant settings
+ * is preferred.
+ */
+ public function viewSettings();
+
+ /**
+ * Reacts to the server's creation.
+ *
+ * Called once, when the server is first created. Allows it to set up its
+ * necessary infrastructure.
+ */
+ public function postCreate();
+
+ /**
+ * Notifies this server that its fields are about to be updated.
+ *
+ * The server's $original property can be used to inspect the old property
+ * values.
+ *
+ * @return bool
+ * TRUE, if the update requires reindexing of all content on the server.
+ */
+ public function postUpdate();
+
+ /**
+ * Notifies this server that it is about to be deleted from the database.
+ *
+ * This should execute any necessary cleanup operations.
+ *
+ * Note that you shouldn't call the server's save() method, or any
+ * methods that might do that, from inside of this method as the server isn't
+ * present in the database anymore at this point.
+ */
+ public function preDelete();
+
+ /**
+ * Adds a new index to this server.
+ *
+ * If the index was already added to the server, the object should treat this
+ * as if removeIndex() and then addIndex() were called.
+ *
+ * @param SearchApiIndex $index
+ * The index to add.
+ *
+ * @throws SearchApiException
+ * If an error occurred while adding the index.
+ */
+ public function addIndex(SearchApiIndex $index);
+
+ /**
+ * Notifies the server that the field settings for the index have changed.
+ *
+ * If any user action is necessary as a result of this, the method should
+ * use backdrop_set_message() to notify the user.
+ *
+ * @param SearchApiIndex $index
+ * The updated index.
+ *
+ * @return bool
+ * TRUE, if this change affected the server in any way that forces it to
+ * re-index the content. FALSE otherwise.
+ *
+ * @throws SearchApiException
+ * If an error occurred while reacting to the change of fields.
+ */
+ public function fieldsUpdated(SearchApiIndex $index);
+
+ /**
+ * Removes an index from this server.
+ *
+ * This might mean that the index has been deleted, or reassigned to a
+ * different server. If you need to distinguish between these cases, inspect
+ * $index->server.
+ *
+ * If the index wasn't added to the server, the method call should be ignored.
+ *
+ * Implementations of this method should also check whether $index->read_only
+ * is set, and don't delete any indexed data if it is.
+ *
+ * @param $index
+ * Either an object representing the index to remove, or its machine name
+ * (if the index was completely deleted).
+ *
+ * @throws SearchApiException
+ * If an error occurred while removing the index.
+ */
+ public function removeIndex($index);
+
+ /**
+ * Indexes the specified items.
+ *
+ * @param SearchApiIndex $index
+ * The search index for which items should be indexed.
+ * @param array $items
+ * An array of items to be indexed, keyed by their id. The values are
+ * associative arrays of the fields to be stored, where each field is an
+ * array with the following keys:
+ * - type: One of the data types recognized by the Search API, or the
+ * special type "tokens" for fulltext fields.
+ * - original_type: The original type of the property, as defined by the
+ * datasource controller for the index's item type.
+ * - value: The value to index.
+ *
+ * The special field "search_api_language" contains the item's language and
+ * should always be indexed.
+ *
+ * The value of fields with the "tokens" type is an array of tokens. Each
+ * token is an array containing the following keys:
+ * - value: The word that the token represents.
+ * - score: A score for the importance of that word.
+ *
+ * @return array
+ * An array of the ids of all items that were successfully indexed.
+ *
+ * @throws SearchApiException
+ * If indexing was prevented by a fundamental configuration error.
+ */
+ public function indexItems(SearchApiIndex $index, array $items);
+
+ /**
+ * Deletes indexed items from this server.
+ *
+ * Might be either used to delete some items (given by their ids) from a
+ * specified index, or all items from that index, or all items from all
+ * indexes on this server.
+ *
+ * @param $ids
+ * Either an array containing the ids of the items that should be deleted,
+ * or 'all' if all items should be deleted. Other formats might be
+ * recognized by implementing classes, but these are not standardized.
+ * @param ?SearchApiIndex $index
+ * The index from which items should be deleted, or NULL if all indexes on
+ * this server should be cleared (then, $ids has to be 'all').
+ *
+ * @throws SearchApiException
+ * If an error occurred while trying to delete the items.
+ */
+ public function deleteItems($ids = 'all', ?SearchApiIndex $index = NULL);
+
+ /**
+ * Creates a query object for searching on an index lying on this server.
+ *
+ * @param SearchApiIndex $index
+ * The index to search on.
+ * @param $options
+ * Associative array of options configuring this query. See
+ * SearchApiQueryInterface::__construct().
+ *
+ * @return SearchApiQueryInterface
+ * An object for searching the given index.
+ *
+ * @throws SearchApiException
+ * If the server is currently disabled.
+ */
+ public function query(SearchApiIndex $index, $options = array());
+
+ /**
+ * Executes a search on the server represented by this object.
+ *
+ * @param $query
+ * The SearchApiQueryInterface object to execute.
+ *
+ * @return array
+ * An associative array containing the search results, as required by
+ * SearchApiQueryInterface::execute().
+ *
+ * @throws SearchApiException
+ * If an error prevented the search from completing.
+ */
+ public function search(SearchApiQueryInterface $query);
+
+}
+
+/**
+ * Abstract class with generic implementation of most service methods.
+ *
+ * For creating your own service class extending this class, you only need to
+ * implement indexItems(), deleteItems() and search() from the
+ * SearchApiServiceInterface interface.
+ */
+abstract class SearchApiAbstractService implements SearchApiServiceInterface {
+
+ /**
+ * @var SearchApiServer
+ */
+ protected $server;
+
+ /**
+ * Direct reference to the server's $options property.
+ *
+ * @var array
+ */
+ protected $options = array();
+
+ /**
+ * Implements SearchApiServiceInterface::__construct().
+ *
+ * The default implementation sets $this->server and $this->options.
+ */
+ public function __construct(SearchApiServer $server) {
+ $this->server = $server;
+ $this->options = &$server->options;
+ }
+
+ /**
+ * Implements SearchApiServiceInterface::__construct().
+ *
+ * Returns an empty form by default.
+ */
+ public function configurationForm(array $form, array &$form_state) {
+ return array();
+ }
+
+ /**
+ * Implements SearchApiServiceInterface::__construct().
+ *
+ * Does nothing by default.
+ */
+ public function configurationFormValidate(array $form, array &$values, array &$form_state) {
+ return;
+ }
+
+ /**
+ * Implements SearchApiServiceInterface::__construct().
+ *
+ * The default implementation just ensures that additional elements in
+ * $options, not present in the form, don't get lost at the update.
+ */
+ public function configurationFormSubmit(array $form, array &$values, array &$form_state) {
+ if (!empty($this->options)) {
+ $values += $this->options;
+ }
+ $this->options = $values;
+ }
+
+ /**
+ * Implements SearchApiServiceInterface::__construct().
+ *
+ * The default implementation always returns FALSE.
+ */
+ public function supportsFeature($feature) {
+ return FALSE;
+ }
+
+ /**
+ * Implements SearchApiServiceInterface::__construct().
+ *
+ * The default implementation does a crude output as a definition list, with
+ * option names taken from the configuration form.
+ */
+ public function viewSettings() {
+ $output = '';
+ $form = $form_state = array();
+ $option_form = $this->configurationForm($form, $form_state);
+ $option_names = array();
+ foreach ($option_form as $key => $element) {
+ if (isset($element['#title']) && isset($this->options[$key])) {
+ $option_names[$key] = $element['#title'];
+ }
+ }
+
+ foreach ($option_names as $key => $name) {
+ $value = $this->options[$key];
+ $output .= '- \n$output
' . t('A search server and search index are used to execute searches. Several indexes can exist per server.
You need at least one server and one index to create searches on your site.') . '
';
+ $form['options']['#suffix'] = '
';
+
+ // If $info is not set, there are no service classes. Display an error message
+ // telling the user how to change that and return an empty form.
+ if (!isset($info)) {
+ backdrop_set_message(t('There are no service classes available for the Search API. Please install a module that provides a service class to proceed.', array('@url' => url('https://github.com/backdrop-contrib/search_api/wiki/Search-API-Documentation#service-class'))), 'error');
+ return array();
+ }
+
+ $form['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Create server'),
+ );
+
+ return $form;
+}
+
+/**
+ * Form AJAX handler for search_api_admin_add_server().
+ *
+ * Just returns the "options" array of the already built form array.
+ */
+function search_api_admin_add_server_ajax_callback(array $form, array &$form_state) {
+ return $form['options'];
+}
+
+/**
+ * Form validation handler for adding a server.
+ *
+ * Validates the machine name and calls the service class' validation handler.
+ */
+function search_api_admin_add_server_validate(array $form, array &$form_state) {
+ if (!empty($form_state['values']['machine_name'])) {
+ $name = $form_state['values']['machine_name'];
+ if (is_numeric($name)) {
+ form_set_error('machine_name', t('The machine name must not be a pure number.'));
+ }
+ }
+
+ if (empty($form_state['values']['options']['class'])) {
+ return;
+ }
+ $class = $form_state['values']['options']['class'];
+ $info = search_api_get_service_info($class);
+ $service = NULL;
+ if (class_exists($info['class'])) {
+ $service = new $info['class']($form_state['server']);
+ }
+ if (!($service instanceof SearchApiServiceInterface)) {
+ form_set_error('class', t('There seems to be something wrong with the selected service class.'));
+ return;
+ }
+ $form_state['values']['options']['service'] = $service;
+ if (!empty($form_state['values']['options']['form'])) {
+ $service->configurationFormValidate($form['options']['form'], $form_state['values']['options']['form'], $form_state);
+ }
+}
+
+/**
+ * Form submission handler for adding a server.
+ */
+function search_api_admin_add_server_submit(array $form, array &$form_state) {
+ form_state_values_clean($form_state);
+ $values = $form_state['values'];
+
+ if (!empty($form_state['storage']['step_one'])) {
+ $values += $form_state['storage']['step_one'];
+ unset($form_state['storage']);
+ }
+
+ if (empty($values['options']) || ($values['class'] != $values['options']['class'])) {
+ unset($values['options']);
+ $form_state['storage']['step_one'] = $values;
+ $form_state['rebuild'] = TRUE;
+ backdrop_set_message(t('Please configure the used service.'));
+ return;
+ }
+
+ $options = isset($values['options']['form']) ? $values['options']['form'] : array();
+ unset($values['options']);
+ $form_state['server'] = $server = entity_create('search_api_server', $values);
+ $server->configurationFormSubmit($form['options']['form'], $options, $form_state);
+ $server->save();
+ $form_state['redirect'] = 'admin/config/search/search_api/server/' . $server->machine_name;
+ backdrop_set_message(t('The server was successfully created.'));
+}
+
+/**
+ * Page callback: Displays information about a server.
+ *
+ * @param SearchApiServer $server
+ * The server to display.
+ * @param string|null $action
+ * (optional) An action to execute for the server. One of 'enable', 'disable'
+ * or 'clear'.
+ *
+ * @see search_api_menu()
+ */
+function search_api_admin_server_view(SearchApiServer $server, $action = NULL) {
+ if (!empty($action)) {
+ if ($action == 'enable') {
+ if (isset($_GET['token']) && backdrop_valid_token($_GET['token'], $server->machine_name)) {
+ if ($server->update(array('enabled' => 1))) {
+ backdrop_set_message(t('The server was successfully enabled.'));
+ }
+ else {
+ backdrop_set_message(t('The server could not be enabled. Check the logs for details.'), 'error');
+ }
+ backdrop_goto('admin/config/search/search_api/server/' . $server->machine_name);
+ }
+ else {
+ return MENU_ACCESS_DENIED;
+ }
+ }
+ else {
+ $ret = backdrop_get_form('search_api_admin_confirm', 'server', $action, $server);
+ if (!empty($ret['actions'])) {
+ return $ret;
+ }
+ }
+ }
+
+ backdrop_set_title(search_api_admin_item_title($server));
+ $class = search_api_get_service_info($server->class);
+ $options = $server->viewSettings();
+ $indexes = array();
+ foreach (search_api_index_load_multiple(FALSE, array('server' => $server->machine_name)) as $index) {
+ if (!$indexes) {
+ $indexes['#theme'] = 'links';
+ $indexes['#attributes']['class'] = array('inline');
+ }
+ $indexes['#links'][] = array(
+ 'title' => $index->name,
+ 'href' => 'admin/config/search/search_api/index/' . $index->machine_name,
+ );
+ }
+ $render['view'] = array(
+ '#theme' => 'search_api_server',
+ '#id' => $server->id,
+ '#name' => $server->name,
+ '#machine_name' => $server->machine_name,
+ '#description' => $server->description,
+ '#enabled' => $server->enabled,
+ '#class_id' => $server->class,
+ '#class_name' => $class['name'],
+ '#class_description' => $class['description'],
+ '#indexes' => $indexes,
+ '#options' => $options,
+ '#status' => $server->status,
+ '#extra' => $server->getExtraInformation(),
+ );
+ $render['#attached']['css'][] = backdrop_get_path('module', 'search_api') . '/css/search_api.admin.css';
+ if ($server->enabled) {
+ $render['form'] = backdrop_get_form('search_api_server_status_form', $server);
+ }
+ return $render;
+}
+
+/**
+ * Returns HTML for displaying a server.
+ *
+ * @param array $variables
+ * An associative array containing:
+ * - id: The server's id.
+ * - name: The server's name.
+ * - machine_name: The server's machine name.
+ * - description: The server's description.
+ * - enabled: Boolean indicating whether the server is enabled.
+ * - class_id: The used service class' ID.
+ * - class_name: The used service class' display name.
+ * - class_description: The used service class' description.
+ * - indexes: A list of indexes associated with this server, either as an HTML
+ * string or a render array.
+ * - options: An HTML string or render array containing information about the
+ * server's service-specific settings.
+ * - status: The entity configuration status (in database, in code, etc.).
+ * - extra: An array of additional server information in the format specified
+ * by SearchApiAbstractService::getExtraInformation().
+ *
+ * @return string
+ * HTML for displaying a server.
+ *
+ * @ingroup themeable
+ */
+function theme_search_api_server(array $variables) {
+ $machine_name = $variables['machine_name'];
+ $description = $variables['description'];
+ $enabled = $variables['enabled'];
+ $class_id = $variables['class_id'];
+ $class_name = $variables['class_name'];
+ $indexes = $variables['indexes'];
+ $options = $variables['options'];
+ $status = $variables['status'];
+ $extra = $variables['extra'];
+
+ // First, output the index description if there is one set.
+ $output = '';
+
+ if ($description) {
+ $output .= '' . nl2br(check_plain($description)) . '
'; + } + + // Then, display a table summarizing the index's status. + $rows = array(); + // Create a row template with references so we don't have to deal with the + // complicated structure for each individual row. + $row = array( + 'data' => array( + array('header' => TRUE), + '', + ), + 'class' => array(''), + ); + $label = & $row['data'][0]['data']; + $info = & $row['data'][1]; + $class = & $row['class'][0]; + + if ($enabled) { + $class = 'ok'; + $info = t('enabled (!disable_link)', array('!disable_link' => l(t('disable'), 'admin/config/search/search_api/server/' . $machine_name . '/disable'))); + } + else { + $class = 'warning'; + $info = t('disabled (!enable_link)', array('!enable_link' => l(t('enable'), 'admin/config/search/search_api/server/' . $machine_name . '/enable', array('query' => array('token' => backdrop_get_token($machine_name)))))); + } + $label = t('Status'); + $rows[] = _search_api_deep_copy($row); + $class = ''; + + $label = t('Service class'); + if (module_exists('help')) { + $url_options['fragment'] = backdrop_clean_css_identifier($class_id); + $info = l($class_name, 'admin/help/search_api', $url_options); + } + else { + $info = check_plain($class_name); + } + $rows[] = _search_api_deep_copy($row); + + if ($indexes) { + $label = t('Search indexes'); + $info = render($indexes); + $rows[] = _search_api_deep_copy($row); + } + + if ($options) { + $label = t('Service options'); + $info = render($options); + $rows[] = _search_api_deep_copy($row); + } + + if ($status != ENTITY_PLUS_CUSTOM) { + $label = t('Configuration status'); + $info = theme('entity_plus_status', array('status' => $status)); + $class = ($status == ENTITY_PLUS_OVERRIDDEN) ? 'warning' : 'ok'; + $rows[] = _search_api_deep_copy($row); + $class = ''; + } + + if ($extra) { + foreach ($extra as $information) { + $label = $information['label']; + $info = $information['info']; + $class = !empty($information['status']) ? $information['status'] : ''; + $rows[] = _search_api_deep_copy($row); + } + } + + $theme['rows'] = $rows; + $theme['attributes']['class'][] = 'search-api-summary'; + $theme['attributes']['class'][] = 'search-api-server-summary'; + $theme['attributes']['class'][] = 'system-status-report'; + $output .= theme('table', $theme); + + return $output; +} + +/** + * Form constructor for server operations. + * + * @param SearchApiServer $server + * The server for which the form is displayed. + * + * @ingroup forms + * + * @see search_api_server_status_form_submit() + */ +function search_api_server_status_form(array $form, array &$form_state, SearchApiServer $server) { + $form_state['server'] = $server; + + $form['clear'] = array( + '#type' => 'submit', + '#value' => t('Delete all indexed data on this server'), + '#submit' => array('search_api_server_status_form_clear_submit'), + ); + + $count = $server->enabled ? search_api_server_tasks_count($server) : 0; + if ($count) { + $message = format_plural($count, '@count pending task must be executed before indexing.', '@count pending tasks must be executed before indexing.'); + backdrop_set_message($message, 'warning', FALSE); + $form['execute_pending_tasks'] = array( + '#type' => 'submit', + '#value' => t('Execute all pending tasks on this server'), + '#submit' => array('search_api_server_status_form_execute_pending_tasks_submit'), + ); + } + + return $form; +} + +/** + * Form submission handler for search_api_server_status_form(). + * + * Used for the "Execute all pending tasks" button. + */ +function search_api_server_status_form_execute_pending_tasks_submit($form, &$form_state) { + $server_id = $form_state['server']->machine_name; + $form_state['redirect'] = "admin/config/search/search_api/server/$server_id/execute-tasks"; +} + +/** + * Form submission handler for search_api_server_status_form(). + * + * Used for the "Delete all indexed data" button. + */ +function search_api_server_status_form_clear_submit(array $form, array &$form_state) { + $server_id = $form_state['server']->machine_name; + $form_state['redirect'] = "admin/config/search/search_api/server/$server_id/clear"; +} + +/** + * Form constructor for editing a server's settings. + * + * @param SearchApiServer $server + * The server to edit. + * + * @ingroup forms + * + * @see search_api_admin_server_edit_validate() + * @see search_api_admin_server_edit_submit() + */ +function search_api_admin_server_edit(array $form, array &$form_state, SearchApiServer $server) { + $form_state['server'] = $server; + + $form['name'] = array( + '#type' => 'textfield', + '#title' => t('Server name'), + '#description' => t('Enter the displayed name for the server.'), + '#maxlength' => 50, + '#default_value' => $server->name, + '#required' => TRUE, + ); + $form['enabled'] = array( + '#type' => 'checkbox', + '#title' => t('Enabled'), + '#default_value' => $server->enabled, + ); + $form['description'] = array( + '#type' => 'textarea', + '#title' => t('Server description'), + '#description' => t('Enter a description for the new server.'), + '#default_value' => $server->description, + ); + + $class = search_api_get_service_info($server->class); + + $service_options = array(); + $service_options = $server->configurationForm($service_options, $form_state); + if ($service_options) { + $form['options']['form'] = $service_options; + } + $form['options']['#type'] = 'fieldset'; + $form['options']['#tree'] = TRUE; + $form['options']['#collapsible'] = TRUE; + $form['options']['#title'] = $class['name']; + $form['options']['#description'] = $class['description']; + + $form['actions']['#type'] = 'actions'; + $form['actions']['submit'] = array( + '#type' => 'submit', + '#value' => t('Save settings'), + ); + $form['actions']['delete'] = array( + '#type' => 'submit', + '#value' => t('Delete'), + '#submit' => array('search_api_admin_form_delete_submit'), + '#limit_validation_errors' => array(), + ); + + return $form; +} + +/** + * Form validation handler for search_api_admin_server_edit(). + * + * @see search_api_admin_server_edit_submit() + */ +function search_api_admin_server_edit_validate(array $form, array &$form_state) { + if (!empty($form['options']['form']) && !empty($form_state['values']['options']['form'])) { + $form_state['server']->configurationFormValidate($form['options']['form'], $form_state['values']['options']['form'], $form_state); + } +} + +/** + * Form submission handler for search_api_admin_server_edit(). + * + * @see search_api_admin_server_edit_validate() + */ +function search_api_admin_server_edit_submit(array $form, array &$form_state) { + form_state_values_clean($form_state); + $values = $form_state['values']; + + $server = $form_state['server']; + if (isset($values['options'])) { + $server->configurationFormSubmit($form['options']['form'], $values['options']['form'], $form_state); + } + unset($values['options']); + + $server->update($values); + $form_state['redirect'] = 'admin/config/search/search_api/server/' . $server->machine_name; + backdrop_set_message(t('The search server was successfully edited.')); +} + +/** + * Form submission handler for search_api_admin_server_edit(). + * + * Handles the 'Delete' button on the server and index edit forms. + * + * @see search_api_admin_server_edit() + * @see search_api_admin_index_edit() + */ +function search_api_admin_form_delete_submit($form, &$form_state) { + $destination = array(); + if (isset($_GET['destination'])) { + $destination = backdrop_get_destination(); + unset($_GET['destination']); + } + if (isset($form_state['server'])) { + $server = $form_state['server']; + $form_state['redirect'] = array('admin/config/search/search_api/server/' . $server->machine_name . '/delete', array('query' => $destination)); + } + elseif (isset($form_state['index'])) { + $index = $form_state['index']; + $form_state['redirect'] = array('admin/config/search/search_api/index/' . $index->machine_name . '/delete', array('query' => $destination)); + } +} + +/** + * Form constructor for adding an index. + * + * @ingroup forms + * + * @see search_api_admin_add_index_ajax_callback() + * @see search_api_admin_add_index_validate() + * @see search_api_admin_add_index_submit() + */ +function search_api_admin_add_index(array $form, array &$form_state) { + backdrop_set_title(t('Add index')); + + $old_type = empty($form_state['values']['item_type']) ? '' : $form_state['values']['item_type']; + + $form['#attached']['css'][] = backdrop_get_path('module', 'search_api') . '/css/search_api.admin.css'; + $form['#tree'] = TRUE; + + if (empty($form_state['step_one'])) { + $form['name'] = array( + '#type' => 'textfield', + '#title' => t('Index name'), + '#maxlength' => 50, + '#required' => TRUE, + ); + + $form['machine_name'] = array( + '#type' => 'machine_name', + '#maxlength' => 50, + '#machine_name' => array( + 'exists' => 'search_api_index_load', + ), + ); + + $form['item_type'] = array( + '#type' => 'select', + '#title' => t('Item type'), + '#description' => t('Select the type of items that will be indexed in this index. ' . + 'This setting cannot be changed afterwards.'), + '#options' => array(), + '#required' => TRUE, + '#ajax' => array( + 'callback' => 'search_api_admin_add_index_ajax_callback', + 'wrapper' => 'search-api-datasource-options', + ), + ); + $form['datasource'] = array(); + foreach (search_api_get_item_type_info() as $type => $info) { + $form['item_type']['#options'][$type] = $info['name']; + } + $form['enabled'] = array( + '#type' => 'checkbox', + '#title' => t('Enabled'), + '#description' => t('This will only take effect if you also select a server for the index.'), + '#default_value' => TRUE, + ); + $form['description'] = array( + '#type' => 'textarea', + '#title' => t('Index description'), + ); + $form['server'] = array( + '#type' => 'select', + '#title' => t('Server'), + '#description' => t('Select the server this index should reside on.'), + '#default_value' => '', + '#options' => array('' => t('< No server >')), + ); + $servers = search_api_server_load_multiple(FALSE, array('enabled' => 1)); + // List enabled servers first. + foreach ($servers as $server) { + if ($server->enabled) { + $form['server']['#options'][$server->machine_name] = $server->name; + } + } + foreach ($servers as $server) { + if (!$server->enabled) { + $form['server']['#options'][$server->machine_name] = t('@server_name (disabled)', array('@server_name' => $server->name)); + } + } + $form['read_only'] = array( + '#type' => 'checkbox', + '#title' => t('Read only'), + '#description' => t('Do not write to this index or track the status of items in this index.'), + '#default_value' => FALSE, + ); + $form['options']['index_directly'] = array( + '#type' => 'checkbox', + '#title' => t('Index items immediately'), + '#description' => t('Immediately index new or updated items instead of waiting for the next cron run. ' . + 'This might have serious performance drawbacks and is generally not advised for larger sites.'), + '#default_value' => FALSE, + ); + $form['options']['cron_limit'] = array( + '#type' => 'number', + '#title' => t('Cron batch size'), + '#description' => t('Set how many items will be indexed at once when indexing items during a cron run. ' . + '"0" means that no items will be indexed by cron for this index, "-1" means that cron should index all items at once.'), + '#default_value' => SEARCH_API_DEFAULT_CRON_LIMIT, + '#size' => 4, + '#attributes' => array('class' => array('search-api-cron-limit')), + '#min' => -1, + ); + } + elseif (!$old_type) { + $old_type = $form_state['step_one']['item_type']; + } + + if ($old_type) { + $datasource = search_api_get_datasource_controller($old_type); + $datasource_form = array(); + $datasource_form = $datasource->configurationForm($datasource_form, $form_state); + if ($datasource_form) { + $form['datasource'] = $datasource_form; + $form['datasource']['#parents'] = array('options', 'datasource'); + } + } + $form['datasource']['#prefix'] = '';
+ $form['datasource']['#suffix'] = '
';
+
+ $form['old_type'] = array(
+ '#type' => 'value',
+ '#value' => $old_type,
+ );
+ $form['datasource_config'] = array(
+ '#type' => 'value',
+ '#value' => !empty($datasource_form),
+ );
+
+ $form['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Create index'),
+ );
+
+ return $form;
+}
+
+/**
+ * AJAX submit callback for search_api_admin_add_index().
+ *
+ * Used for displaying the matching datasource configuration form for the
+ * selected item type.
+ */
+function search_api_admin_add_index_ajax_callback(array $form, array &$form_state) {
+ return $form['datasource'];
+}
+
+/**
+ * Form validation handler for search_api_admin_add_index().
+ *
+ * @see search_api_admin_add_index_submit()
+ */
+function search_api_admin_add_index_validate(array $form, array &$form_state) {
+ $values = $form_state['values'];
+ $name = $values['machine_name'];
+ if (is_numeric($name)) {
+ form_set_error('machine_name', t('The machine name must not be a pure number.'));
+ }
+
+ if (!$values['datasource_config'] || empty($values['item_type']) || $values['item_type'] != $values['old_type']) {
+ return;
+ }
+ $datasource = search_api_get_datasource_controller($values['item_type']);
+ $datasource->configurationFormValidate($form['datasource'], $form_state['values']['options']['datasource'], $form_state);
+}
+
+/**
+ * Form submission handler for search_api_admin_add_index().
+ *
+ * @see search_api_admin_add_index_validate()
+ */
+function search_api_admin_add_index_submit(array $form, array &$form_state) {
+ form_state_values_clean($form_state);
+ $values = $form_state['values'];
+
+ if (!empty($form_state['step_one'])) {
+ $values += $form_state['step_one'];
+ unset($form_state['step_one']);
+ }
+
+ // The type was changed (or the form submitted without JS for the first time).
+ // If the new type has a configuration form, we have to display it now.
+ $datasource = search_api_get_datasource_controller($values['item_type']);
+ if ($values['item_type'] != $values['old_type']) {
+ $datasource_form = array();
+ if ($datasource->configurationForm($datasource_form, $form_state)) {
+ unset($values['options']['datasource']);
+ $form_state['step_one'] = $values;
+ $form_state['rebuild'] = TRUE;
+ backdrop_set_message(t('Please specify further configuration options.'));
+ return;
+ }
+ }
+
+ // If the current type has a configuration form, call the datasource
+ // controller's config submit callback.
+ if ($values['datasource_config']) {
+ $datasource->configurationFormSubmit($form['datasource'], $values['options']['datasource'], $form_state);
+ }
+
+ // Validation of whether a server is set for the index is done in the
+ // SearchApiIndex::save() method.
+ search_api_index_insert($values);
+
+ backdrop_set_message(t('The index was successfully created. Please set up its indexed fields now.'));
+ $form_state['redirect'] = 'admin/config/search/search_api/index/' . $values['machine_name'] . '/fields';
+}
+
+/**
+ * Page callback for displaying an index's status.
+ *
+ * @param SearchApiIndex $index
+ * The index to display.
+ * @param string|null $action
+ * (optional) An action to execute for the index. One of "reindex", "clear",
+ * "enable" or "disable". For "disable", a confirm dialog will be shown.
+ *
+ * @see search_api_menu()
+ */
+function search_api_admin_index_view(SearchApiIndex $index, $action = NULL) {
+ if (!empty($action)) {
+ if ($action == 'enable') {
+ if (isset($_GET['token']) && backdrop_valid_token($_GET['token'], $index->machine_name)) {
+ if ($index->update(array('enabled' => 1))) {
+ backdrop_set_message(t('The index was successfully enabled.'));
+ }
+ else {
+ backdrop_set_message(t('The index could not be enabled. Check the logs for details.'), 'error');
+ }
+ backdrop_goto('admin/config/search/search_api/index/' . $index->machine_name);
+ }
+ else {
+ return MENU_ACCESS_DENIED;
+ }
+ }
+ else {
+ $ret = backdrop_get_form('search_api_admin_confirm', 'index', $action, $index);
+ if (!empty($ret['actions'])) {
+ return $ret;
+ }
+ }
+ }
+
+ $status = search_api_index_status($index);
+ try {
+ $server = $index->server();
+ }
+ catch (SearchApiException $e) {
+ $server = NULL;
+ $vars['%server'] = $index->server;
+ $message = t('The index has an unknown server (ID: %server) set. Please check the index settings.', $vars);
+ backdrop_set_message($message, 'error');
+ }
+ $ret['view'] = array(
+ '#theme' => 'search_api_index',
+ '#id' => $index->id,
+ '#name' => $index->name,
+ '#machine_name' => $index->machine_name,
+ '#description' => $index->description,
+ '#item_type' => $index->item_type,
+ '#datasource_config' => $index->datasource()->getConfigurationSummary($index),
+ '#enabled' => $index->enabled,
+ '#server' => $server,
+ '#options' => $index->options,
+ '#fields' => $index->getFields(),
+ '#indexed_items' => $status['indexed'],
+ '#on_server' => NULL,
+ '#total_items' => $status['total'],
+ '#status' => $index->status,
+ '#read_only' => $index->read_only,
+ );
+ try {
+ $ret['view']['#on_server'] = _search_api_get_items_on_server($index);
+ }
+ catch (SearchApiException $e) {
+ watchdog_exception('search_api', $e);
+ }
+ if ($index->enabled && !$index->read_only) {
+ $ret['form'] = backdrop_get_form('search_api_admin_index_status_form', $index, $status);
+ }
+ return $ret;
+}
+
+/**
+ * Returns HTML for a search index.
+ *
+ * @param array $variables
+ * An associative array containing:
+ * - id: The index's id.
+ * - name: The index' name.
+ * - machine_name: The index' machine name.
+ * - description: The index' description.
+ * - item_type: The type of items stored in this index.
+ * - datasource_config: A summary of the datasource's configuration.
+ * - enabled: Boolean indicating whether the index is enabled.
+ * - server: The server this index currently rests on, if any.
+ * - options: The index' options, like cron limit.
+ * - fields: All indexed fields of the index.
+ * - indexed_items: The number of items already indexed in their latest
+ * version on this index.
+ * - on_server: The number of items actually indexed on the server. NULL if
+ * the search for finding out the item count failed.
+ * - total_items: The total number of items that have to be indexed for this
+ * index.
+ * - status: The entity configuration status (in database, in code, etc.).
+ * - read_only: Boolean indicating whether this index is read only.
+ *
+ * @return string
+ * HTML for a search index.
+ *
+ * @ingroup themeable
+ */
+function theme_search_api_index(array $variables) {
+ $machine_name = $variables['machine_name'];
+ $description = $variables['description'];
+ $enabled = $variables['enabled'];
+ $item_type = $variables['item_type'];
+ $datasource_config = $variables['datasource_config'];
+ $server = $variables['server'];
+ $options = $variables['options'];
+ $status = $variables['status'];
+ $indexed_items = $variables['indexed_items'];
+ $on_server = $variables['on_server'];
+ $total_items = $variables['total_items'];
+
+ // First, output the index description if there is one set.
+ $output = '';
+
+ if ($description) {
+ $output .= '' . nl2br(check_plain($description)) . '
'; + } + + // Then, display a table summarizing the index's status. + $rows = array(); + // Create a row template with references so we don't have to deal with the + // complicated structure for each individual row. + $row = array( + 'data' => array( + array('header' => TRUE), + '', + ), + 'class' => array(''), + ); + $label = &$row['data'][0]['data']; + $info = &$row['data'][1]; + $class = &$row['class'][0]; + + $class = 'warning'; + if ($enabled) { + $info = t('enabled (!disable_link)', array('!disable_link' => l(t('disable'), 'admin/config/search/search_api/index/' . $machine_name . '/disable'))); + $class = 'ok'; + } + elseif ($server) { + $info = t('disabled (!enable_link)', array('!enable_link' => l(t('enable'), 'admin/config/search/search_api/index/' . $machine_name . '/enable', array('query' => array('token' => backdrop_get_token($machine_name)))))); + } + else { + $info = t('disabled'); + } + $label = t('Status'); + $rows[] = _search_api_deep_copy($row); + $class = ''; + + $label = t('Item type'); + $type = search_api_get_item_type_info($item_type); + $item_type = !empty($type['name']) ? $type['name'] : $item_type; + $info = check_plain($item_type); + $rows[] = _search_api_deep_copy($row); + + if ($datasource_config) { + $label = t('Item type configuration'); + $info = check_plain($datasource_config); + $rows[] = _search_api_deep_copy($row); + } + + if ($server) { + $label = t('Server'); + $info = l($server->name, 'admin/config/search/search_api/server/' . $server->machine_name); + $rows[] = _search_api_deep_copy($row); + } + + if ($enabled) { + $options += array('cron_limit' => SEARCH_API_DEFAULT_CRON_LIMIT); + if ($options['cron_limit']) { + $class = 'ok'; + $info = format_plural( + $options['cron_limit'], + 'During cron runs, 1 item will be indexed per batch.', + 'During cron runs, @count items will be indexed per batch.' + ); + } + else { + $class = 'warning'; + $info = t('No items will be indexed during cron runs.'); + } + $label = t('Cron batch size'); + $rows[] = _search_api_deep_copy($row); + + $theme = array( + 'percent' => $total_items ? (int) (100 * $indexed_items / $total_items) : 100, + 'message' => t('@indexed/@total indexed', array('@indexed' => $indexed_items, '@total' => $total_items)), + ); + $output .= '' . t('Index status') . '
'; + $output .= '' . theme('progress_bar', $theme) . '
';
+
+ if (!isset($on_server)) {
+ $info = t('An error occurred while trying to determine the server index status. Please check the logs for details.');
+ $class = 'error';
+ }
+ else {
+ $vars['@url'] = url('https://github.com/backdrop-contrib/search_api/wiki/FAQ#what-is-the-server-index-status-for-a-search-index');
+ $info = format_plural($on_server, 'There is 1 item indexed on the server for this index. (More information)', 'There are @count items indexed on the server for this index. (More information)', $vars);
+ $class = '';
+ }
+ $label = t('Server index status');
+ $rows[] = _search_api_deep_copy($row);
+ }
+
+ if ($status != ENTITY_PLUS_CUSTOM) {
+ $label = t('Configuration status');
+ $info = theme('entity_plus_status', array('status' => $status));
+ $class = ($status == ENTITY_PLUS_OVERRIDDEN) ? 'warning' : 'ok';
+ $rows[] = _search_api_deep_copy($row);
+ }
+
+ $theme['rows'] = $rows;
+ $theme['attributes']['class'][] = 'search-api-summary';
+ $theme['attributes']['class'][] = 'search-api-index-summary';
+ $theme['attributes']['class'][] = 'system-status-report';
+ $output .= theme('table', $theme);
+
+ return $output;
+}
+
+/**
+ * Form constructor for an index status form.
+ *
+ * Should only be used for enabled indexes which aren't read-only.
+ *
+ * @param SearchApiIndex $index
+ * The index whose status should be displayed.
+ * @param array $status
+ * The indexing status of the index, as returned by search_api_index_status().
+ *
+ * @ingroup forms
+ *
+ * @see search_api_admin_index_status_form_validate()
+ * @see search_api_admin_index_status_form_submit()
+ */
+function search_api_admin_index_status_form(array $form, array &$form_state, SearchApiIndex $index, array $status) {
+ $form['#attached']['css'][] = backdrop_get_path('module', 'search_api') . '/css/search_api.admin.css';
+ $form_state['index'] = $index;
+
+ $form['index'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Index now'),
+ );
+ $form['index']['#attributes']['class'][] = 'container-inline';
+
+ $allow_indexing = ($status['indexed'] < $status['total']);
+ $all = t('all', array(), array('context' => 'items to index'));
+ $limit = array(
+ '#type' => 'textfield',
+ '#default_value' => $all,
+ '#size' => 4,
+ '#attributes' => array('class' => array('search-api-limit')),
+ '#disabled' => !$allow_indexing,
+ );
+ $batch_size = empty($index->options['cron_limit']) ? SEARCH_API_DEFAULT_CRON_LIMIT : $index->options['cron_limit'];
+ $batch_size = $batch_size > 0 ? $batch_size : $all;
+ $batch_size = array(
+ '#type' => 'textfield',
+ '#default_value' => $batch_size,
+ '#size' => 4,
+ '#attributes' => array('class' => array('search-api-batch-size')),
+ '#disabled' => !$allow_indexing,
+ );
+
+ // Here it gets complicated. We want to build a sentence from the form input
+ // elements, but to translate that we have to make the two form elements (for
+ // limit and batch size) pseudo-variables in the t() call. Since we can't
+ // pass them directly, we split the translated sentence (which still has the
+ // two tokens), figure out their order and then put the pieces together again
+ // using the form elements' #prefix and #suffix properties.
+ $sentence = t('Index @limit items in batches of @batch_size items');
+ $sentence = preg_split('/@(limit|batch_size)/', $sentence, -1, PREG_SPLIT_DELIM_CAPTURE);
+ if (count($sentence) == 5) {
+ $first = $sentence[1];
+ $form['index'][$first] = $$first;
+ $form['index'][$first]['#prefix'] = $sentence[0];
+ $form['index'][$first]['#suffix'] = $sentence[2];
+ $second = $sentence[3];
+ $form['index'][$second] = $$second;
+ $form['index'][$second]['#suffix'] = $sentence[4] . ' ';
+ }
+ else {
+ // PANIC!
+ $limit['#title'] = t('Number of items to index');
+ $form['index']['limit'] = $limit;
+ $batch_size['#title'] = t('Number of items per batch run');
+ $form['index']['batch_size'] = $batch_size;
+ }
+
+ $form['index']['button'] = array(
+ '#type' => 'submit',
+ '#value' => t('Index now'),
+ '#disabled' => !$allow_indexing,
+ );
+ $form['index']['total'] = array(
+ '#type' => 'value',
+ '#value' => $status['total'],
+ );
+ $form['index']['remaining'] = array(
+ '#type' => 'value',
+ '#value' => $status['total'] - $status['indexed'],
+ );
+ $form['index']['all'] = array(
+ '#type' => 'value',
+ '#value' => $all,
+ );
+
+ $form['reindex'] = array(
+ '#type' => 'submit',
+ '#value' => t('Queue all items for reindexing'),
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+ $form['clear'] = array(
+ '#type' => 'submit',
+ '#value' => t('Clear all indexed data'),
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+
+ return $form;
+}
+
+/**
+ * Form validation handler for search_api_admin_index_status_form().
+ *
+ * @see search_api_admin_index_status_form_submit()
+ */
+function search_api_admin_index_status_form_validate(array $form, array &$form_state) {
+ $values = $form_state['values'];
+ if ($values['op'] == t('Index now')) {
+ $all_lower = backdrop_strtolower($values['all']);
+ foreach (array('limit', 'batch_size') as $field) {
+ $val = trim($values[$field]);
+ if (backdrop_strtolower($val) == $all_lower) {
+ $val = -1;
+ }
+ elseif (!$val || !is_numeric($val) || ((int) $val) != $val) {
+ form_error($form['index'][$field], t('Enter a non-zero integer. Use "-1" or "@all" for "all items".', array('@all' => $values['all'])));
+ }
+ else {
+ $val = (int) $val;
+ }
+ $form_state['values'][$field] = $val;
+ }
+ }
+}
+
+/**
+ * Form submission handler for search_api_admin_index_status_form().
+ *
+ * @see search_api_admin_index_status_form_validate()
+ */
+function search_api_admin_index_status_form_submit(array $form, array &$form_state) {
+ $values = $form_state['values'];
+ $index = $form_state['index'];
+ $form_state['redirect'] = 'admin/config/search/search_api/index/' . $index->machine_name;
+
+ // There is a Form API bug here that will let a user submit the form via the
+ // "Index now" button even if it is disabled, and then just set "op" to the
+ // value of an arbitrary other button. We therefore have to take care to spot
+ // this case ourselves.
+ if ($form_state['input']['op'] == t('Index now') && !empty($form['index']['button']['#disabled'])) {
+ backdrop_set_message(t('All items have already been indexed.'), 'warning');
+ return;
+ }
+
+ switch ($values['op']) {
+ case t('Index now'):
+ if (!_search_api_batch_indexing_create($index, $values['batch_size'], $values['limit'], $values['remaining'])) {
+ backdrop_set_message(t("Couldn't create a batch, please check the batch size and limit."), 'warning');
+ }
+ break;
+
+ case t('Queue all items for reindexing'):
+ $form_state['redirect'] .= '/reindex';
+ break;
+
+ case t('Clear all indexed data'):
+ $form_state['redirect'] .= '/clear';
+ break;
+ }
+}
+
+/**
+ * Form constructor for editing an index's settings.
+ *
+ * @param SearchApiIndex $index
+ * The index to edit.
+ *
+ * @ingroup forms
+ *
+ * @see search_api_admin_index_edit_validate()
+ * @see search_api_admin_index_edit_submit()
+ */
+function search_api_admin_index_edit(array $form, array &$form_state, SearchApiIndex $index) {
+ $form_state['index'] = $index;
+
+ $form['#attached']['css'][] = backdrop_get_path('module', 'search_api') . '/css/search_api.admin.css';
+ $form['#tree'] = TRUE;
+ $form['name'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Index name'),
+ '#maxlength' => 50,
+ '#default_value' => $index->name,
+ '#required' => TRUE,
+ );
+ try {
+ $enabled_fixed = !$index->server();
+ }
+ catch (Exception $e) {
+ watchdog_exception('search_api', $e);
+ // The exception only occurs if the index is disabled, and for an unknown
+ // server we of course want do prevent the index from being enabled.
+ $enabled_fixed = TRUE;
+ }
+ $form['enabled'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Enabled'),
+ '#default_value' => $index->enabled,
+ // Can't enable an index that's not lying on any server.
+ '#disabled' => $enabled_fixed,
+ );
+ $form['description'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Index description'),
+ '#default_value' => $index->description,
+ );
+ $form['server'] = array(
+ '#type' => 'select',
+ '#title' => t('Server'),
+ '#description' => t('Select the server this index should reside on.'),
+ '#default_value' => $index->server,
+ '#options' => array('' => t('< No server >')),
+ );
+ $servers = search_api_server_load_multiple(FALSE, array('enabled' => 1));
+ // List enabled servers first.
+ foreach ($servers as $server) {
+ $form['server']['#options'][$server->machine_name] = $server->name;
+ }
+
+ $datasource_form = !empty($form['options']['datasource']) ? $form['options']['datasource'] : array();
+ $datasource_form = $index->datasource()->configurationForm($datasource_form, $form_state);
+ if ($datasource_form) {
+ $form['options']['datasource'] = $datasource_form;
+ $form['options']['datasource']['#type'] = 'fieldset';
+ $form['options']['datasource']['#title'] = t('Datasource options');
+ }
+
+ $form['read_only'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Read only'),
+ '#description' => t('Do not write to this index or track the status of items in this index.'),
+ '#default_value' => $index->read_only,
+ );
+ $form['options']['index_directly'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Index items immediately'),
+ '#description' => t('Immediately index new or updated items instead of waiting for the next cron run. ' .
+ 'This might have serious performance drawbacks and is generally not advised for larger sites.'),
+ '#default_value' => !empty($index->options['index_directly']),
+ '#states' => array(
+ 'invisible' => array(':input[name="read_only"]' => array('checked' => TRUE)),
+ ),
+ );
+ $form['options']['cron_limit'] = array(
+ '#type' => 'number',
+ '#title' => t('Cron batch size'),
+ '#description' => t('Set how many items will be indexed at once when indexing items during a cron run. ' .
+ '"0" means that no items will be indexed by cron for this index, "-1" means that cron should index all items at once.'),
+ '#default_value' => isset($index->options['cron_limit']) ? $index->options['cron_limit'] : SEARCH_API_DEFAULT_CRON_LIMIT,
+ '#size' => 4,
+ '#attributes' => array('class' => array('search-api-cron-limit')),
+ '#min' => -1,
+ '#states' => array(
+ 'invisible' => array(':input[name="read_only"]' => array('checked' => TRUE)),
+ ),
+ );
+
+ $form['actions']['#type'] = 'actions';
+ $form['actions']['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Save settings'),
+ );
+ $form['actions']['delete'] = array(
+ '#type' => 'submit',
+ '#value' => t('Delete'),
+ '#submit' => array('search_api_admin_form_delete_submit'),
+ '#limit_validation_errors' => array(),
+ );
+
+ return $form;
+}
+
+/**
+ * Form validation handler for search_api_admin_index_edit().
+ *
+ * @see search_api_admin_index_edit_submit()
+ */
+function search_api_admin_index_edit_validate(array $form, array &$form_state) {
+ if (!empty($form['options']['datasource'])) {
+ $form_state['values']['options'] += array('datasource' => array());
+ $form_state['index']->datasource()->configurationFormValidate($form['options']['datasource'], $form_state['values']['options']['datasource'], $form_state);
+ }
+}
+
+/**
+ * Form submission handler for search_api_admin_index_edit().
+ *
+ * @see search_api_admin_index_edit_validate()
+ */
+function search_api_admin_index_edit_submit(array $form, array &$form_state) {
+ form_state_values_clean($form_state);
+ $values = $form_state['values'];
+ /** @var SearchApiIndex $index */
+ $index = $form_state['index'];
+
+ if (!empty($form['options']['datasource'])) {
+ $index->datasource()->configurationFormSubmit($form['options']['datasource'], $values['options']['datasource'], $form_state);
+ }
+
+ $values['options'] += $index->options;
+
+ $ret = $index->update($values);
+ $form_state['redirect'] = 'admin/config/search/search_api/index/' . $index->machine_name;
+ if ($ret) {
+ backdrop_set_message(t('The search index was successfully edited.'));
+ }
+ else {
+ backdrop_set_message(t('No values were changed.'));
+ }
+}
+
+/**
+ * Form constructor for editing an index's data alterations and processors.
+ *
+ * @param SearchApiIndex $index
+ * The index to edit.
+ *
+ * @ingroup forms
+ *
+ * @see search_api_admin_index_workflow_validate()
+ * @see search_api_admin_index_workflow_submit()
+ */
+// Copied from filter_admin_format_form()
+/**
+ * @todo Please document this function.
+ * @see http://drupal.org/node/1354
+ */
+function search_api_admin_index_workflow(array $form, array &$form_state, SearchApiIndex $index) {
+ $callback_info = search_api_get_alter_callbacks();
+ $processor_info = search_api_get_processors();
+ $options = empty($index->options) ? array() : $index->options;
+
+ $form_state['index'] = $index;
+ $form['#tree'] = TRUE;
+ $form['#attached']['js'][] = backdrop_get_path('module', 'search_api') . '/js/search_api.admin.js';
+
+ // Callbacks.
+ $callbacks = empty($options['data_alter_callbacks']) ? array() : $options['data_alter_callbacks'];
+ $callback_objects = isset($form_state['callbacks']) ? $form_state['callbacks'] : array();
+ foreach ($callback_info as $name => $callback) {
+ if (!isset($callbacks[$name])) {
+ $callbacks[$name]['status'] = 0;
+ $callbacks[$name]['weight'] = $callback['weight'];
+ }
+ $settings = empty($callbacks[$name]['settings']) ? array() : $callbacks[$name]['settings'];
+ if (empty($callback_objects[$name]) && class_exists($callback['class'])) {
+ $callback_objects[$name] = new $callback['class']($index, $settings);
+ }
+ if (!(class_exists($callback['class']) && $callback_objects[$name] instanceof SearchApiAlterCallbackInterface)) {
+ watchdog('search_api', t('Data alteration @id specifies illegal callback class @class.', array('@id' => $name, '@class' => $callback['class'])), NULL, WATCHDOG_WARNING);
+ unset($callback_info[$name]);
+ unset($callbacks[$name]);
+ unset($callback_objects[$name]);
+ continue;
+ }
+ if (!$callback_objects[$name]->supportsIndex($index)) {
+ unset($callback_info[$name]);
+ unset($callbacks[$name]);
+ unset($callback_objects[$name]);
+ continue;
+ }
+ }
+ $form_state['callbacks'] = $callback_objects;
+ $form['#callbacks'] = $callbacks;
+ $form['callbacks'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Data alterations'),
+ '#description' => t('Select the alterations that will be executed on indexed items, and their order.'),
+ '#collapsible' => TRUE,
+ );
+
+ // Callback status.
+ $form['callbacks']['status'] = array(
+ '#type' => 'item',
+ '#title' => t('Enabled data alterations'),
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+ foreach ($callback_info as $name => $callback) {
+ $form['callbacks']['status'][$name] = array(
+ '#type' => 'checkbox',
+ '#title' => $callback['name'],
+ '#default_value' => $callbacks[$name]['status'],
+ '#parents' => array('callbacks', $name, 'status'),
+ '#description' => $callback['description'],
+ '#weight' => $callback['weight'],
+ );
+ }
+
+ // Callback order (tabledrag).
+ $form['callbacks']['order'] = array(
+ '#type' => 'item',
+ '#title' => t('Data alteration processing order'),
+ '#theme' => 'search_api_admin_item_order',
+ '#table_id' => 'search-api-callbacks-order-table',
+ );
+ foreach ($callback_info as $name => $callback) {
+ $form['callbacks']['order'][$name]['item'] = array(
+ '#markup' => $callback['name'],
+ );
+ $form['callbacks']['order'][$name]['weight'] = array(
+ '#type' => 'weight',
+ '#delta' => 50,
+ '#default_value' => $callbacks[$name]['weight'],
+ '#parents' => array('callbacks', $name, 'weight'),
+ );
+ $form['callbacks']['order'][$name]['#weight'] = $callbacks[$name]['weight'];
+ }
+
+ // Callback settings.
+ $form['callbacks']['settings_title'] = array(
+ '#type' => 'item',
+ '#title' => t('Callback settings'),
+ );
+ $form['callbacks']['settings'] = array(
+ '#type' => 'vertical_tabs',
+ );
+
+ foreach ($callback_info as $name => $callback) {
+ $settings_form = $callback_objects[$name]->configurationForm();
+ if (!empty($settings_form)) {
+ $form['callbacks']['settings'][$name] = array(
+ '#type' => 'fieldset',
+ '#title' => $callback['name'],
+ '#parents' => array('callbacks', $name, 'settings'),
+ '#weight' => $callback['weight'],
+ );
+ $form['callbacks']['settings'][$name] += $settings_form;
+ }
+ }
+
+ // Processors.
+ $processors = empty($options['processors']) ? array() : $options['processors'];
+ $processor_objects = isset($form_state['processors']) ? $form_state['processors'] : array();
+ foreach ($processor_info as $name => $processor) {
+ if (!isset($processors[$name])) {
+ $processors[$name]['status'] = 0;
+ $processors[$name]['weight'] = $processor['weight'];
+ }
+ $settings = empty($processors[$name]['settings']) ? array() : $processors[$name]['settings'];
+ if (empty($processor_objects[$name]) && class_exists($processor['class'])) {
+ $processor_objects[$name] = new $processor['class']($index, $settings);
+ }
+ if (!(class_exists($processor['class']) && $processor_objects[$name] instanceof SearchApiProcessorInterface)) {
+ watchdog('search_api', t('Processor @id specifies illegal processor class @class.', array('@id' => $name, '@class' => $processor['class'])), NULL, WATCHDOG_WARNING);
+ unset($processor_info[$name]);
+ unset($processors[$name]);
+ unset($processor_objects[$name]);
+ continue;
+ }
+ if (!$processor_objects[$name]->supportsIndex($index)) {
+ unset($processor_info[$name]);
+ unset($processors[$name]);
+ unset($processor_objects[$name]);
+ continue;
+ }
+ }
+ $form_state['processors'] = $processor_objects;
+ $form['#processors'] = $processors;
+ $form['processors'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Processors'),
+ '#description' => '' . t("Select processors which will pre- and post-process data at index and search time, and their order. Most processors will only influence fulltext fields, but refer to their individual descriptions for details regarding their effect.
Also, some processors shouldn't be used with more advanced search engines (like Solr or Elasticsearch), since the search engine already provides this functionality.") . '
' . t("Check the server's service class description for details.", + array('@server-url' => url('admin/config/search/search_api/server/' . $index->server . '/edit'))) . '
'; + } + + // Processor status. + $form['processors']['status'] = array( + '#type' => 'item', + '#title' => t('Enabled processors'), + '#prefix' => '',
+ '#suffix' => '
',
+ );
+ foreach ($processor_info as $name => $processor) {
+ $form['processors']['status'][$name] = array(
+ '#type' => 'checkbox',
+ '#title' => $processor['name'],
+ '#default_value' => $processors[$name]['status'],
+ '#parents' => array('processors', $name, 'status'),
+ '#description' => $processor['description'],
+ '#weight' => $processor['weight'],
+ );
+ }
+
+ // Processor order (tabledrag).
+ $form['processors']['order'] = array(
+ '#type' => 'item',
+ '#title' => t('Processor processing order'),
+ '#description' => t('Set the order in which preprocessing will be done at index and search time. ' .
+ 'Postprocessing of search results will be in the exact opposite direction.'),
+ '#theme' => 'search_api_admin_item_order',
+ '#table_id' => 'search-api-processors-order-table',
+ );
+ foreach ($processor_info as $name => $processor) {
+ $form['processors']['order'][$name]['item'] = array(
+ '#markup' => $processor['name'],
+ );
+ $form['processors']['order'][$name]['weight'] = array(
+ '#type' => 'weight',
+ '#delta' => 50,
+ '#default_value' => $processors[$name]['weight'],
+ '#parents' => array('processors', $name, 'weight'),
+ );
+ $form['processors']['order'][$name]['#weight'] = $processors[$name]['weight'];
+ }
+
+ // Processor settings.
+ $form['processors']['settings_title'] = array(
+ '#type' => 'item',
+ '#title' => t('Processor settings'),
+ );
+ $form['processors']['settings'] = array(
+ '#type' => 'vertical_tabs',
+ );
+
+ foreach ($processor_info as $name => $processor) {
+ $settings_form = $processor_objects[$name]->configurationForm();
+ if (!empty($settings_form)) {
+ $form['processors']['settings'][$name] = array(
+ '#type' => 'fieldset',
+ '#title' => $processor['name'],
+ '#parents' => array('processors', $name, 'settings'),
+ '#weight' => $processor['weight'],
+ );
+ $form['processors']['settings'][$name] += $settings_form;
+ }
+ }
+
+ $form['actions'] = array('#type' => 'actions');
+ $form['actions']['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Save configuration'),
+ );
+
+ return $form;
+}
+
+/**
+ * Returns HTML for a processor/callback order form.
+ *
+ * @param array $variables
+ * An associative array containing:
+ * - element: A render element representing the form.
+ */
+function theme_search_api_admin_item_order(array $variables) {
+ $element = $variables['element'];
+
+ $rows = array();
+ foreach (element_children($element, TRUE) as $name) {
+ $element[$name]['weight']['#attributes']['class'][] = 'search-api-order-weight';
+ $rows[] = array(
+ 'data' => array(
+ backdrop_render($element[$name]['item']),
+ backdrop_render($element[$name]['weight']),
+ ),
+ 'class' => array('draggable'),
+ );
+ }
+ $output = backdrop_render_children($element);
+ $output .= theme('table', array('rows' => $rows, 'attributes' => array('id' => $element['#table_id'])));
+ backdrop_add_tabledrag($element['#table_id'], 'order', 'sibling', 'search-api-order-weight', NULL, NULL, TRUE);
+
+ return $output;
+}
+
+/**
+ * Form validation handler for search_api_admin_index_workflow().
+ *
+ * @see search_api_admin_index_workflow_submit()
+ */
+function search_api_admin_index_workflow_validate(array $form, array &$form_state) {
+ // Call validation functions.
+ foreach ($form_state['callbacks'] as $name => $callback) {
+ if (isset($form['callbacks']['settings'][$name]) && isset($form_state['values']['callbacks'][$name]['settings'])) {
+ $callback->configurationFormValidate($form['callbacks']['settings'][$name], $form_state['values']['callbacks'][$name]['settings'], $form_state);
+ }
+ }
+ foreach ($form_state['processors'] as $name => $processor) {
+ if (isset($form['processors']['settings'][$name]) && isset($form_state['values']['processors'][$name]['settings'])) {
+ $processor->configurationFormValidate($form['processors']['settings'][$name], $form_state['values']['processors'][$name]['settings'], $form_state);
+ }
+ }
+}
+
+/**
+ * Form submission handler for search_api_admin_index_workflow().
+ *
+ * @see search_api_admin_index_workflow_validate()
+ */
+function search_api_admin_index_workflow_submit(array $form, array &$form_state) {
+ $values = $form_state['values'];
+ unset($values['callbacks']['settings']);
+ unset($values['processors']['settings']);
+ $index = $form_state['index'];
+ $index_path = 'admin/config/search/search_api/index/' . $index->machine_name;
+
+ $options = empty($index->options) ? array() : $index->options;
+
+ // Store callback and processor settings.
+ foreach ($form_state['callbacks'] as $name => $callback) {
+ $callback_form = isset($form['callbacks']['settings'][$name]) ? $form['callbacks']['settings'][$name] : array();
+ $values['callbacks'][$name] += array('settings' => array());
+ $values['callbacks'][$name]['settings'] = $callback->configurationFormSubmit($callback_form, $values['callbacks'][$name]['settings'], $form_state);
+ }
+ foreach ($form_state['processors'] as $name => $processor) {
+ $processor_form = isset($form['processors']['settings'][$name]) ? $form['processors']['settings'][$name] : array();
+ $values['processors'][$name] += array('settings' => array());
+ $values['processors'][$name]['settings'] = $processor->configurationFormSubmit($processor_form, $values['processors'][$name]['settings'], $form_state);
+ }
+
+ $types = search_api_field_types();
+ foreach ($form_state['callbacks'] as $name => $callback) {
+ // Check whether callback status has changed.
+ if ($values['callbacks'][$name]['status'] == empty($options['data_alter_callbacks'][$name]['status'])) {
+ $callbacks_changed = TRUE;
+ if ($values['callbacks'][$name]['status']) {
+ // Callback was just enabled, add its fields.
+ $properties = $callback->propertyInfo();
+ if ($properties) {
+ foreach ($properties as $key => $field) {
+ $type = $field['type'];
+ $inner = search_api_extract_inner_type($type);
+ if ($inner != 'token' && empty($types[$inner])) {
+ // Someone apparently added a structure or entity as a property in
+ // a data alteration.
+ continue;
+ }
+ if ($inner == 'token' || (search_api_is_text_type($inner) && !empty($field['options list']))) {
+ $old = $type;
+ $type = 'string';
+ while (search_api_is_list_type($old)) {
+ $old = substr($old, 5, -1);
+ $type = "list<$type>";
+ }
+ }
+ $index->options['fields'][$key] = array(
+ 'type' => $type,
+ );
+ }
+ }
+ }
+ }
+ }
+
+ if (!isset($options['data_alter_callbacks']) || !isset($options['processors'])
+ || $options['data_alter_callbacks'] != $values['callbacks']
+ || $options['processors'] != $values['processors']) {
+ $index->options['data_alter_callbacks'] = $values['callbacks'];
+ $index->options['processors'] = $values['processors'];
+
+ // Save the already sorted arrays to avoid having to sort them at each use.
+ uasort($index->options['data_alter_callbacks'], 'search_api_admin_element_compare');
+ uasort($index->options['processors'], 'search_api_admin_element_compare');
+
+ // Re-calculate the fields, since they might have changed in hard-to-predict
+ // ways.
+ search_api_index_recalculate_fields(array($index));
+
+ $index->save();
+ $index->reindex();
+ $vars = array('@url' => url($index_path));
+ backdrop_set_message(t('The indexing workflow was successfully edited. All content was scheduled for re-indexing so the new settings can take effect.', $vars));
+ }
+ else {
+ backdrop_set_message(t('No values were changed.'));
+ }
+
+ $form_state['redirect'] = $index_path . '/workflow';
+}
+
+/**
+ * Sort callback sorting array elements by their "weight" key, if present.
+ *
+ * @see element_sort()
+ */
+function search_api_admin_element_compare($a, $b) {
+ $a_weight = (is_array($a) && isset($a['weight'])) ? $a['weight'] : 0;
+ $b_weight = (is_array($b) && isset($b['weight'])) ? $b['weight'] : 0;
+ if ($a_weight == $b_weight) {
+ return 0;
+ }
+ return ($a_weight < $b_weight) ? -1 : 1;
+}
+
+/**
+ * Form constructor for setting the indexed fields.
+ *
+ * @ingroup forms
+ *
+ * @see search_api_admin_index_fields_submit()
+ */
+function search_api_admin_index_fields(array $form, array &$form_state, SearchApiIndex $index) {
+ $options = $index->getFields(FALSE, TRUE);
+ $fields = $options['fields'];
+ $additional = $options['additional fields'];
+
+ // An array of option arrays for types, keyed by nesting level.
+ $types = array(0 => search_api_field_types());
+ $entity_types = entity_get_info();
+ $boosts = backdrop_map_assoc(array('0.0', '0.1', '0.2', '0.3', '0.5', '0.8', '1.0', '2.0', '3.0', '5.0', '8.0', '13.0', '21.0'));
+
+ $fulltext_types = array(0 => array('text'));
+ // Add all custom data types with fallback "text" to fulltext types as well.
+ foreach (search_api_get_data_type_info() as $id => $type) {
+ if ($type['fallback'] != 'text') {
+ continue;
+ }
+ $fulltext_types[0][] = $id;
+ }
+
+ $form_state['index'] = $index;
+ $form['#theme'] = 'search_api_admin_fields_table';
+ $form['#tree'] = TRUE;
+ $form['description'] = array(
+ '#type' => 'item',
+ '#title' => t('Select fields to index'),
+ '#description' => t('The datatype of a field determines how it can be used for searching and filtering. Fields indexed with type "Fulltext" and multi-valued fields (marked with 1) cannot be used for sorting. ' . + 'The boost is used to give additional weight to certain fields, e.g. titles or tags. It only takes effect for fulltext fields.
' . + 'Whether detailed field types are supported depends on the type of server this index resides on. ' . + 'In any case, fields of type "Fulltext" will always be fulltext-searchable.
'), + ); + if ($index->server) { + $form['description']['#description'] .= '' . t("Check the server's service class description for details.", + array('@server-url' => url('admin/config/search/search_api/server/' . $index->server . '/edit'))) . '
'; + } + foreach ($fields as $key => $info) { + $form['fields'][$key]['title']['#markup'] = check_plain($info['name']); + if (search_api_is_list_type($info['type'])) { + $form['fields'][$key]['title']['#markup'] .= ' 1'; + $multi_valued_field_present = TRUE; + } + $form['fields'][$key]['machine_name']['#markup'] = check_plain($key); + if (isset($info['description'])) { + $form['fields'][$key]['description'] = array( + '#type' => 'value', + '#value' => $info['description'], + ); + } + $form['fields'][$key]['indexed'] = array( + '#type' => 'checkbox', + '#default_value' => $info['indexed'], + ); + if (empty($info['entity_type'])) { + // Determine the correct type options (with the correct nesting level). + $level = search_api_list_nesting_level($info['type']); + if (empty($types[$level])) { + $type_prefix = str_repeat('list<', $level); + $type_suffix = str_repeat('>', $level); + $types[$level] = array(); + foreach ($types[0] as $type => $name) { + // We use the singular name for list types, since the user usually + // doesn't care about the nesting level. + $types[$level][$type_prefix . $type . $type_suffix] = $name; + } + foreach ($fulltext_types[0] as $type) { + $fulltext_types[$level][] = $type_prefix . $type . $type_suffix; + } + } + $css_key = '#edit-fields-' . backdrop_clean_css_identifier($key); + $form['fields'][$key]['type'] = array( + '#type' => 'select', + '#options' => $types[$level], + '#default_value' => isset($info['real_type']) ? $info['real_type'] : $info['type'], + '#states' => array( + 'visible' => array( + $css_key . '-indexed' => array('checked' => TRUE), + ), + ), + ); + $form['fields'][$key]['boost'] = array( + '#type' => 'select', + '#options' => $boosts, + '#default_value' => $info['boost'], + '#states' => array( + 'visible' => array( + $css_key . '-indexed' => array('checked' => TRUE), + ), + ), + ); + // Only add the multiple visible states if the VERSION string is >= 7.14. + // See https://drupal.org/node/1464758. + if (version_compare(BACKDROP_VERSION, '1.17.0', '>=')) { + foreach ($fulltext_types[$level] as $type) { + $form['fields'][$key]['boost']['#states']['visible'][$css_key . '-type'][] = array('value' => $type); + } + } + else { + $form['fields'][$key]['boost']['#states']['visible'][$css_key . '-type'] = array('value' => reset($fulltext_types[$level])); + } + } + else { + // This is an entity. + $label = $entity_types[$info['entity_type']]['label']; + if (!isset($entity_description_added)) { + $form['description']['#description'] .= '' . + t('Note that indexing an entity-valued field (like %field, which has type %type) directly will only index the entity ID. ' . + 'This will be used for filtering and also sorting (which might not be what you expect). ' . + 'The entity label will usually be used when displaying the field, though. ' . + 'Use the "Add related fields" option at the bottom for indexing other fields of related entities.', + array('%field' => $info['name'], '%type' => $label)) . '
'; + $entity_description_added = TRUE; + } + $form['fields'][$key]['type'] = array( + '#type' => 'value', + '#value' => $info['type'], + ); + $form['fields'][$key]['entity_type'] = array( + '#type' => 'value', + '#value' => $info['entity_type'], + ); + $form['fields'][$key]['type_name'] = array( + '#markup' => check_plain($label), + ); + $form['fields'][$key]['boost'] = array( + '#type' => 'value', + '#value' => $info['boost'], + ); + $form['fields'][$key]['boost_text'] = array( + '#markup' => ' ', + ); + } + if ($key == 'search_api_language') { + // Is treated specially to always index the language. + $form['fields'][$key]['type']['#default_value'] = 'string'; + $form['fields'][$key]['type']['#disabled'] = TRUE; + $form['fields'][$key]['boost']['#default_value'] = '1.0'; + $form['fields'][$key]['boost']['#disabled'] = TRUE; + $form['fields'][$key]['indexed']['#default_value'] = 1; + $form['fields'][$key]['indexed']['#disabled'] = TRUE; + } + } + + if (!empty($multi_valued_field_present)) { + $form['note']['#markup'] = '1 ' . t('Multi-valued field') . '
';
+ }
+
+ $form['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Save changes'),
+ );
+
+ if ($additional) {
+ asort($additional);
+ reset($additional);
+ $form['additional'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Add related fields'),
+ '#description' => t('There are entities related to entities of this type. ' .
+ 'You can add their fields to the list above so they can be indexed too.') . '', + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#attributes' => array('class' => array('container-inline')), + 'field' => array( + '#type' => 'select', + '#options' => $additional, + '#default_value' => key($additional), + ), + 'add' => array( + '#type' => 'submit', + '#value' => t('Add fields'), + ), + ); + } + + return $form; +} + +/** + * Helper function for building the field list for an index. + * + * @deprecated Use SearchApiIndex::getFields() instead. + */ +function _search_api_admin_get_fields(SearchApiIndex $index, EntityMetadataWrapper $wrapper) { + $fields = empty($index->options['fields']) ? array() : $index->options['fields']; + $additional = array(); + $entity_types = entity_get_info(); + + // First we need all already added prefixes. + $added = array(); + foreach (array_keys($fields) as $key) { + $key = substr($key, 0, strrpos($key, ':')); + $added[$key] = TRUE; + } + + // Then we walk through all properties and look if they are already contained + // in one of the arrays. Since this uses an iterative instead of a recursive + // approach, it is a bit complicated, with three arrays tracking the current + // depth. + // A wrapper for a specific field name prefix, e.g. 'user:' mapped to the user + // wrapper. + $wrappers = array('' => $wrapper); + // Display names for the prefixes. + $prefix_names = array('' => ''); + // The list nesting level for entities with a certain prefix. + $nesting_levels = array('' => 0); + + $types = search_api_default_field_types(); + $flat = array(); + while ($wrappers) { + foreach ($wrappers as $prefix => $wrapper) { + $prefix_name = $prefix_names[$prefix]; + // Deal with lists of entities. + $nesting_level = $nesting_levels[$prefix]; + $type_prefix = str_repeat('list<', $nesting_level); + $type_suffix = str_repeat('>', $nesting_level); + if ($nesting_level) { + $info = $wrapper->info(); + // The real nesting level of the wrapper, not the accumulated one. + $level = search_api_list_nesting_level($info['type']); + for ($i = 0; $i < $level; ++$i) { + $wrapper = $wrapper[0]; + } + } + // Now look at all properties. + foreach ($wrapper as $property => $value) { + $info = $value->info(); + // We hide the complexity of multi-valued types from the user here. + $type = search_api_extract_inner_type($info['type']); + // Treat Entity API type "token" as our "string" type. + // Also let text fields with limited options be of type "string" by + // default. + if ($type == 'token' || ($type == 'text' && !empty($info['options list']))) { + // Inner type is changed to "string". + $type = 'string'; + // Set the field type accordingly. + $info['type'] = search_api_nest_type('string', $info['type']); + } + $info['type'] = $type_prefix . $info['type'] . $type_suffix; + $key = $prefix . $property; + if (isset($types[$type]) || isset($entity_types[$type])) { + if (isset($fields[$key])) { + // This field is already known in the index configuration. + $fields[$key]['name'] = $prefix_name . $info['label']; + $fields[$key]['description'] = empty($info['description']) ? NULL : $info['description']; + $flat[$key] = $fields[$key]; + // Update its type. + if (isset($entity_types[$type])) { + // Always enforce the proper entity type. + $flat[$key]['type'] = $info['type']; + } + else { + // Else, only update the nesting level. + $set_type = search_api_extract_inner_type(isset($flat[$key]['real_type']) ? $flat[$key]['real_type'] : $flat[$key]['type']); + $flat[$key]['type'] = $info['type']; + $flat[$key]['real_type'] = search_api_nest_type($set_type, $info['type']); + } + } + else { + $flat[$key] = array( + 'name' => $prefix_name . $info['label'], + 'description' => empty($info['description']) ? NULL : $info['description'], + 'type' => $info['type'], + 'boost' => '1.0', + 'indexed' => FALSE, + ); + } + } + if (empty($types[$type])) { + if (isset($added[$key])) { + // Visit this entity/struct in a later iteration. + $wrappers[$key . ':'] = $value; + $prefix_names[$key . ':'] = $prefix_name . $info['label'] . ' » '; + $nesting_levels[$key . ':'] = search_api_list_nesting_level($info['type']); + } + else { + $name = $prefix_name . $info['label']; + // Add machine names to discern fields with identical labels. + if (isset($used_names[$name])) { + if ($used_names[$name] !== FALSE) { + $additional[$used_names[$name]] .= ' [' . $used_names[$name] . ']'; + $used_names[$name] = FALSE; + } + $name .= ' [' . $key . ']'; + } + $additional[$key] = $name; + $used_names[$name] = $key; + } + } + } + unset($wrappers[$prefix]); + } + } + + $options = array(); + $options['fields'] = $flat; + $options['additional fields'] = $additional; + return $options; +} + +/** + * Returns HTML for a field list form. + * + * @param array $variables + * An associative array containing: + * - element: A render element representing the form. + * + * @return string + * The HTML for a field list form. + */ +function theme_search_api_admin_fields_table($variables) { + $form = $variables['element']; + $header = array(t('Field'), t('Machine name'), t('Indexed'), t('Type'), t('Boost')); + + $rows = array(); + foreach (element_children($form['fields']) as $name) { + $row = array(); + foreach (element_children($form['fields'][$name]) as $field) { + if ($cell = render($form['fields'][$name][$field])) { + $row[] = $cell; + } + } + if (empty($form['fields'][$name]['description']['#value'])) { + $rows[] = _search_api_deep_copy($row); + } + else { + $rows[] = array( + 'data' => $row, + 'title' => strip_tags($form['fields'][$name]['description']['#value']), + ); + } + } + + $note = isset($form['note']) ? $form['note'] : ''; + $submit = $form['submit']; + $additional = isset($form['additional']) ? $form['additional'] : FALSE; + unset($form['note'], $form['submit'], $form['additional']); + $output = backdrop_render_children($form); + $output .= theme('table', array('header' => $header, 'rows' => $rows)); + $output .= render($note); + $output .= render($submit); + if ($additional) { + $output .= render($additional); + } + + return $output; +} + +/** + * Form submission handler for search_api_admin_index_fields(). + */ +function search_api_admin_index_fields_submit(array $form, array &$form_state) { + $index = $form_state['index']; + $options = isset($index->options) ? $index->options : array(); + $index_path = 'admin/config/search/search_api/index/' . $index->machine_name; + if ($form_state['values']['op'] == t('Save changes')) { + $fields = $form_state['values']['fields']; + $default_types = search_api_default_field_types(); + $custom_types = search_api_get_data_type_info(); + foreach ($fields as $name => $field) { + if (empty($field['indexed'])) { + unset($fields[$name]); + } + else { + // Don't store the description. "indexed" is implied. + unset($fields[$name]['description'], $fields[$name]['indexed']); + // For non-default types, set type to the fallback and only real_type to + // the custom type. + $inner_type = search_api_extract_inner_type($field['type']); + if (!isset($default_types[$inner_type])) { + $fields[$name]['real_type'] = $field['type']; + $fields[$name]['type'] = search_api_nest_type($custom_types[$inner_type]['fallback'], $field['type']); + } + // Boost defaults to 1.0. + if ($field['boost'] == '1.0') { + unset($fields[$name]['boost']); + } + } + } + $options['fields'] = $fields; + unset($options['additional fields']); + $ret = $index->update(array('options' => $options)); + + if ($ret) { + $vars = array('@url' => $index_path); + backdrop_set_message(t('The indexed fields were successfully changed. The index was cleared and will have to be re-indexed with the new settings.', $vars)); + } + else { + backdrop_set_message(t('No values were changed.')); + } + if (isset($index->options['data_alter_callbacks']) || isset($index->options['processors'])) { + $form_state['redirect'] = $index_path . '/fields'; + } + else { + backdrop_set_message(t('Please set up the indexing workflow.')); + $form_state['redirect'] = $index_path . '/workflow'; + } + return; + } + // Adding a related entity's fields. + $prefix = $form_state['values']['additional']['field']; + $options['additional fields'][$prefix] = $prefix; + $ret = $index->update(array('options' => $options)); + + if ($ret) { + backdrop_set_message(t('The available fields were successfully changed.')); + } + else { + backdrop_set_message(t('No values were changed.')); + } + $form_state['redirect'] = $index_path . '/fields'; +} + +/** + * Form constructor for a generic confirmation form. + * + * @param $type + * The type of entity (not the real "entity type"). Either "server" or + * "index". + * @param $action + * The action that would be executed for this entity after confirming. One of + * "reindex" ("index" type only), "clear", "disable" or "delete". + * @param Entity $entity + * The entity for which the action would be performed. Must have a "name" + * property. + * + * @return array|false + * Either a form array, or FALSE if this combination of type and action is + * not supported. + */ +function search_api_admin_confirm(array $form, array &$form_state, $type, $action, Entity $entity) { + switch ($type) { + case 'server': + switch ($action) { + case 'clear': + $text = array( + t('Clear server @name', array('@name' => $entity->name)), + t('Do you really want to clear all indexed data from this server?'), + t('This will permanently remove all data currently indexed on this server. Before the data is reindexed, searches on the indexes associated with this server will not return any results. This action cannot be undone. Use with caution!'), + t("The server's indexed data was successfully cleared."), + ); + break; + + case 'disable': + $text = array( + t('Disable server @name', array('@name' => $entity->name)), + t('Do you really want to disable this server?'), + t('This will disconnect all indexes from this server and disable them. Searches on these indexes will not be available until they are added to another server and re-enabled. All indexed data (except for read-only indexes) on this server will be cleared.'), + t('The server and its indexes were successfully disabled.'), + ); + break; + + case 'delete': + if ($entity->hasStatus(ENTITY_PLUS_OVERRIDDEN)) { + $text = array( + t('Revert server @name', array('@name' => $entity->name)), + t('Do you really want to revert this server?'), + t('This will revert all settings for this server back to the defaults. This action cannot be undone.'), + t('The server settings have been successfully reverted.'), + ); + } + else { + $text = array( + t('Delete server @name', array('@name' => $entity->name)), + t('Do you really want to delete this server?'), + t('This will delete the server and disable all associated indexes. ' . + "Searches on these indexes won't be available until they are moved to another server and re-enabled."), + t('The server was successfully deleted.'), + ); + } + break; + + default: + return FALSE; + } + break; + case 'index': + switch ($action) { + case 'reindex': + $text = array( + t('Re-index index @name', array('@name' => $entity->name)), + t('Do you really want to queue all items on this index for re-indexing?'), + t('This will mark all items for this index to be marked as needing to be indexed. Searches on this index will continue to yield results while the items are being re-indexed. This action cannot be undone.'), + t('The index was successfully marked for re-indexing.'), + ); + break; + + case 'clear': + $text = array( + t('Clear index @name', array('@name' => $entity->name)), + t('Do you really want to clear the indexed data of this index?'), + t('This will remove all data currently indexed for this index. Before the data is reindexed, searches on the index will not return any results. This action cannot be undone.'), + t('The index was successfully cleared.'), + ); + break; + + case 'disable': + $text = array( + t('Disable index @name', array('@name' => $entity->name)), + t('Do you really want to disable this index?'), + t("Searches on this index won't be available until it is re-enabled."), + t('The index was successfully disabled.'), + ); + break; + + case 'delete': + if ($entity->hasStatus(ENTITY_PLUS_OVERRIDDEN)) { + $text = array( + t('Revert index @name', array('@name' => $entity->name)), + t('Do you really want to revert this index?'), + t('This will revert all settings on this index back to the defaults. This action cannot be undone.'), + t('The index settings have been successfully reverted.'), + ); + } + else { + $text = array( + t('Delete index @name', array('@name' => $entity->name)), + t('Do you really want to delete this index?'), + t('This will remove the index from the server and delete all settings. ' . + 'All data on this index will be lost.'), + t('The index has been successfully deleted.'), + ); + } + break; + + default: + return FALSE; + } + break; + default: + return FALSE; + } + + $form = array( + 'type' => array( + '#type' => 'value', + '#value' => $type, + ), + 'action' => array( + '#type' => 'value', + '#value' => $action, + ), + 'id' => array( + '#type' => 'value', + '#value' => $entity->machine_name, + ), + 'message' => array( + '#type' => 'value', + '#value' => $text[3], + ), + ); + $desc = "
{$text[1]}
{$text[2]}
"; + return confirm_form($form, $text[0], "admin/config/search/search_api/$type/{$entity->machine_name}", $desc); +} + +/** + * Submit function for search_api_admin_confirm(). + */ +function search_api_admin_confirm_submit(array $form, array &$form_state) { + $values = $form_state['values']; + + $type = $values['type']; + $action = $values['action']; + $id = $values['id']; + + $success = FALSE; + $function = "search_api_{$type}_{$action}"; + try { + // Some actions, like disabling, can actually throw an exception. + $success = $function($id); + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + } + if ($success) { + backdrop_set_message($values['message']); + } + else { + backdrop_set_message(t('An error has occurred while performing the desired action. Check the logs for details.'), 'error'); + } + + $form_state['redirect'] = ($action == 'delete') ? "admin/config/search/search_api" : "admin/config/search/search_api/$type/$id"; +} diff --git a/www/modules/contrib/search_api/search_api.api.php b/www/modules/contrib/search_api/search_api.api.php new file mode 100644 index 000000000..94357b491 --- /dev/null +++ b/www/modules/contrib/search_api/search_api.api.php @@ -0,0 +1,611 @@ + t('Some Service'), + 'description' => t('Service for some search engine.'), + 'class' => 'SomeServiceClass', + // Unknown keys can later be read by the object for additional information. + 'init args' => array('foo' => 'Foo', 'bar' => 42), + ); + $services['example_other'] = array( + 'name' => t('Other Service'), + 'description' => t('Service for another search engine.'), + 'class' => 'OtherServiceClass', + ); + + return $services; +} + +/** + * Alter the Search API service info. + * + * Modules may implement this hook to alter the information that defines Search + * API services. All properties that are available in + * hook_search_api_service_info() can be altered here, with the addition of the + * "module" key specifying the module that originally defined the service class. + * + * @param array $service_info + * The Search API service info array, keyed by service id. + * + * @see hook_search_api_service_info() + */ +function hook_search_api_service_info_alter(array &$service_info) { + foreach ($service_info as $id => $info) { + $service_info[$id]['class'] = 'MyProxyServiceClass'; + $service_info[$id]['example_original_class'] = $info['class']; + } +} + +/** + * Define new types of items that can be searched. + * + * This hook allows modules to define their own item types, for which indexes + * can then be created. (Note that the Search API natively provides support for + * all entity types that specify property information, so they should not be + * added here. You should therefore also not use an existing entity type as the + * identifier of a new item type.) + * + * The main part of defining a new item type is implementing its data source + * controller class, which is responsible for loading items, providing metadata + * and tracking existing items. The module defining a certain item type is also + * responsible for observing creations, updates and deletions of items of that + * type and notifying the Search API of them by calling + * search_api_track_item_insert(), search_api_track_item_change() and + * search_api_track_item_delete(), as appropriate. + * The only other restriction for item types is that they have to have a single + * item ID field, with a scalar value. This is, e.g., used to track indexed + * items. + * + * Note, however, that you can also define item types where some of these + * conditions are not met, as long as you are aware that some functionality of + * the Search API and related modules might then not be available for that type. + * + * @return array + * An associative array keyed by item type identifier, and containing type + * information arrays with at least the following keys: + * - name: A human-readable name for the type. + * - datasource controller: A class implementing the + * SearchApiDataSourceControllerInterface interface which will be used as + * the data source controller for this type. + * - entity_type: (optional) If the type represents entities, the entity type. + * This is used by SearchApiAbstractDataSourceController for determining the + * entity type of items. Other datasource controllers might ignore this. + * Other, datasource-specific settings might also be placed here. These should + * be specified with the data source controller in question. + * + * @see hook_search_api_item_type_info_alter() + */ +function hook_search_api_item_type_info() { + // Copied from search_api_search_api_item_type_info(). + $types = array(); + + foreach (entity_plus_get_property_info() as $type => $property_info) { + if ($info = entity_get_info($type)) { + $types[$type] = array( + 'name' => $info['label'], + 'datasource controller' => 'SearchApiEntityDataSourceController', + 'entity_type' => $type, + ); + } + } + + return $types; +} + +/** + * Alter the item type info. + * + * Modules may implement this hook to alter the information that defines an + * item type. All properties that are available in + * hook_search_api_item_type_info() can be altered here, with the addition of + * the "module" key specifying the module that originally defined the type. + * + * @param array $infos + * The item type info array, keyed by type identifier. + * + * @see hook_search_api_item_type_info() + */ +function hook_search_api_item_type_info_alter(array &$infos) { + // Adds a boolean value is_entity to all type options telling whether the item + // type represents an entity type. + foreach ($infos as $type => $info) { + $info['is_entity'] = (bool) entity_get_info($type); + } +} + +/** + * Define new data types for indexed properties. + * + * New data types will appear as new option for the „Type“ field on indexes' + * „Fields“ tabs. Whether choosing a custom data type will have any effect + * depends on the server on which the data is indexed. + * + * @return array + * An array containing custom data type definitions, keyed by their type + * identifier and containing the following keys: + * - name: The human-readable name of the type. + * - fallback: (optional) One of the default data types (the keys from + * search_api_default_field_types()) which should be used as a fallback if + * the server doesn't support this data type. Defaults to "string". + * - conversion callback: (optional) If specified, a callback function for + * converting raw values to the given type, if possible. For the contract + * of such a callback, see example_data_type_conversion(). + * + * @see hook_search_api_data_type_info_alter() + * @see search_api_get_data_type_info() + * @see example_data_type_conversion() + */ +function hook_search_api_data_type_info() { + return array( + 'example_type' => array( + 'name' => t('Example type'), + // Could be omitted, as "string" is the default. + 'fallback' => 'string', + 'conversion callback' => 'example_data_type_conversion', + ), + ); +} + +/** + * Alter the data type info. + * + * Modules may implement this hook to alter the information that defines a data + * type, or to add/remove some entirely. All properties that are available in + * hook_search_api_data_type_info() can be altered here. + * + * @param array $infos + * The data type info array, keyed by type identifier. + * + * @see hook_search_api_data_type_info() + */ +function hook_search_api_data_type_info_alter(array &$infos) { + $infos['example_type']['name'] .= ' 2'; +} + +/** + * Define available data alterations. + * + * Registers one or more callbacks that can be called at index time to add + * additional data to the indexed items (e.g. comments or attachments to nodes), + * alter the data in other forms or remove items from the array. + * + * Data-alter callbacks (which are called "Data alterations" in the UI) are + * classes implementing the SearchApiAlterCallbackInterface interface. + * + * @see SearchApiAlterCallbackInterface + * + * @return array + * An associative array keyed by the callback IDs and containing arrays with + * the following keys: + * - name: The name to display for this callback. + * - description: A short description of what the callback does. + * - class: The callback class. + * - weight: (optional) Defines the order in which callbacks are displayed + * (and, therefore, invoked) by default. Defaults to 0. + */ +function hook_search_api_alter_callback_info() { + $callbacks['example_random_alter'] = array( + 'name' => t('Random alteration'), + 'description' => t('Alters all passed item data completely randomly.'), + 'class' => 'ExampleRandomAlter', + 'weight' => 100, + ); + $callbacks['example_add_comments'] = array( + 'name' => t('Add comments'), + 'description' => t('For nodes and similar entities, adds comments.'), + 'class' => 'ExampleAddComments', + ); + + return $callbacks; +} + +/** + * Alter the available data alterations. + * + * @param array $callbacks + * The callback information to be altered, keyed by callback IDs. + * + * @see hook_search_api_alter_callback_info() + */ +function hook_search_api_alter_callback_info_alter(array &$callbacks) { + if (!empty($callbacks['example_random_alter'])) { + $callbacks['example_random_alter']['name'] = t('Even more random alteration'); + $callbacks['example_random_alter']['class'] = 'ExampleUltraRandomAlter'; + } +} + +/** + * Registers one or more processors. These are classes implementing the + * SearchApiProcessorInterface interface which can be used at index and search + * time to pre-process item data or the search query, and at search time to + * post-process the returned search results. + * + * @see SearchApiProcessorInterface + * + * @return array + * An associative array keyed by the processor id and containing arrays + * with the following keys: + * - name: The name to display for this processor. + * - description: A short description of what the processor does at each + * phase. + * - class: The processor class, which has to implement the + * SearchApiProcessorInterface interface. + * - weight: (optional) Defines the order in which processors are displayed + * (and, therefore, invoked) by default. Defaults to 0. + */ +function hook_search_api_processor_info() { + $callbacks['example_processor'] = array( + 'name' => t('Example processor'), + 'description' => t('Pre- and post-processes data in really cool ways.'), + 'class' => 'ExampleSearchApiProcessor', + 'weight' => -1, + ); + $callbacks['example_processor_minimal'] = array( + 'name' => t('Example processor 2'), + 'description' => t('Processor with minimal description.'), + 'class' => 'ExampleSearchApiProcessor2', + ); + + return $callbacks; +} + +/** + * Alter the available processors. + * + * @param array $processors + * The processor information to be altered, keyed by processor IDs. + * + * @see hook_search_api_processor_info() + */ +function hook_search_api_processor_info_alter(array &$processors) { + if (!empty($processors['example_processor'])) { + $processors['example_processor']['weight'] = -20; + } +} + +/** + * Allows you to log or alter the items that are indexed. + * + * Please be aware that generally preventing the indexing of certain items is + * deprecated. This is better done with data alterations, which can easily be + * configured and only added to indexes where this behaviour is wanted. + * If your module will use this hook to reject certain items from indexing, + * please document this clearly to avoid confusion. + * + * @param array $items + * The entities that will be indexed (before calling any data alterations). + * @param SearchApiIndex $index + * The search index on which items will be indexed. + */ +function hook_search_api_index_items_alter(array &$items, SearchApiIndex $index) { + foreach ($items as $id => $item) { + if ($id % 5 == 0) { + unset($items[$id]); + } + } + example_store_indexed_entity_ids($index->item_type, array_keys($items)); +} + +/** + * Allows modules to react after items were indexed. + * + * @param SearchApiIndex $index + * The used index. + * @param array $item_ids + * An array containing the indexed items' IDs. + */ +function hook_search_api_items_indexed(SearchApiIndex $index, array $item_ids) { + if ($index->getEntityType() == 'node') { + // Flush page cache of the search page. + cache_clear_all(url('search'), 'cache_page'); + } +} + +/** + * Lets modules alter a search query before executing it. + * + * @param SearchApiQueryInterface $query + * The search query being executed. + */ +function hook_search_api_query_alter(SearchApiQueryInterface $query) { + // Exclude entities with ID 0. (Assume the ID field is always indexed.) + if ($query->getIndex()->getEntityType()) { + $info = entity_get_info($query->getIndex()->getEntityType()); + $query->condition($info['entity keys']['id'], 0, '<>'); + } +} + +/** + * Alter the search results before they are returned. + * + * @param array $results + * The results returned by the server, which may be altered. The data + * structure is the same as returned by SearchApiQueryInterface::execute(). + * @param SearchApiQueryInterface $query + * The search query that was executed. + */ +function hook_search_api_results_alter(array &$results, SearchApiQueryInterface $query) { + if ($query->getOption('search id') == 'search_api_views:my_search_view:page') { + // Log the number of results. + $vars = array( + '@keys' => $query->getOriginalKeys(), + '@num' => $results['result count'], + ); + watchdog('my_module', 'Search view with query "@keys" had @num results.', $vars, WATCHDOG_DEBUG); + } +} + +/** + * Act on search servers when they are loaded. + * + * @param array $servers + * An array of loaded SearchApiServer objects. + */ +function hook_search_api_server_load(array $servers) { + foreach ($servers as $server) { + db_insert('example_search_server_access') + ->fields(array( + 'server' => $server->machine_name, + 'access_time' => REQUEST_TIME, + )) + ->execute(); + } +} + +/** + * A new search server was created. + * + * @param SearchApiServer $server + * The new server. + */ +function hook_search_api_server_insert(SearchApiServer $server) { + db_insert('example_search_server') + ->fields(array( + 'server' => $server->machine_name, + 'insert_time' => REQUEST_TIME, + )) + ->execute(); +} + +/** + * A search server was edited, enabled or disabled. + * + * @param SearchApiServer $server + * The edited server. + */ +function hook_search_api_server_update(SearchApiServer $server) { + if ($server->name != $server->original->name) { + db_insert('example_search_server_name_update') + ->fields(array( + 'server' => $server->machine_name, + 'update_time' => REQUEST_TIME, + )) + ->execute(); + } +} + +/** + * A search server was deleted. + * + * @param SearchApiServer $server + * The deleted server. + */ +function hook_search_api_server_delete(SearchApiServer $server) { + db_insert('example_search_server_update') + ->fields(array( + 'server' => $server->machine_name, + 'update_time' => REQUEST_TIME, + )) + ->execute(); + db_delete('example_search_server') + ->condition('server', $server->machine_name) + ->execute(); +} + +/** +* Define default search servers. +* +* @return array +* An array of default search servers, keyed by machine names. +* +* @see hook_default_search_api_server_alter() +*/ +function hook_default_search_api_server() { + $defaults['main'] = entity_create('search_api_server', array( + 'name' => 'Main server', + 'machine_name' => 'main',// Must be same as the used array key. + // Other properties ... + )); + return $defaults; +} + +/** +* Alter default search servers. +* +* @param array $defaults +* An array of default search servers, keyed by machine names. +* +* @see hook_default_search_api_server() +*/ +function hook_default_search_api_server_alter(array &$defaults) { + $defaults['main']->name = 'Customized main server'; +} + +/** + * Act on search indexes when they are loaded. + * + * @param array $indexes + * An array of loaded SearchApiIndex objects. + */ +function hook_search_api_index_load(array $indexes) { + foreach ($indexes as $index) { + db_insert('example_search_index_access') + ->fields(array( + 'index' => $index->machine_name, + 'access_time' => REQUEST_TIME, + )) + ->execute(); + } +} + +/** + * A new search index was created. + * + * @param SearchApiIndex $index + * The new index. + */ +function hook_search_api_index_insert(SearchApiIndex $index) { + db_insert('example_search_index') + ->fields(array( + 'index' => $index->machine_name, + 'insert_time' => REQUEST_TIME, + )) + ->execute(); +} + +/** + * A search index was edited in any way. + * + * @param SearchApiIndex $index + * The edited index. + */ +function hook_search_api_index_update(SearchApiIndex $index) { + if ($index->name != $index->original->name) { + db_insert('example_search_index_name_update') + ->fields(array( + 'index' => $index->machine_name, + 'update_time' => REQUEST_TIME, + )) + ->execute(); + } +} + +/** + * A search index was scheduled for reindexing + * + * @param SearchApiIndex $index + * The edited index. + * @param $clear + * Boolean indicating whether the index was also cleared. + */ +function hook_search_api_index_reindex(SearchApiIndex $index, $clear = FALSE) { + db_insert('example_search_index_reindexed') + ->fields(array( + 'index' => $index->id, + 'update_time' => REQUEST_TIME, + )) + ->execute(); +} + +/** + * A search index was deleted. + * + * @param SearchApiIndex $index + * The deleted index. + */ +function hook_search_api_index_delete(SearchApiIndex $index) { + db_insert('example_search_index_update') + ->fields(array( + 'index' => $index->machine_name, + 'update_time' => REQUEST_TIME, + )) + ->execute(); + db_delete('example_search_index') + ->condition('index', $index->machine_name) + ->execute(); +} + +/** +* Define default search indexes. +* +* @return array +* An array of default search indexes, keyed by machine names. +* +* @see hook_default_search_api_index_alter() +*/ +function hook_default_search_api_index() { + $defaults['main'] = entity_create('search_api_index', array( + 'name' => 'Main index', + 'machine_name' => 'main',// Must be same as the used array key. + // Other properties ... + )); + return $defaults; +} + +/** +* Alter default search indexes. +* +* @param array $defaults +* An array of default search indexes, keyed by machine names. +* +* @see hook_default_search_api_index() +*/ +function hook_default_search_api_index_alter(array &$defaults) { + $defaults['main']->name = 'Customized main index'; +} + +/** + * @} End of "addtogroup hooks". + */ + +/** + * Convert a raw value from an entity to a custom data type. + * + * This function will be called for fields of the specific data type to convert + * all individual values of the field to the correct format. + * + * @param mixed $value + * The raw, single value, as extracted from an entity wrapper. + * @param string $original_type + * The original Entity API type of the value. + * @param string $type + * The custom data type to which the value should be converted. Can be ignored + * if the callback is only used for a single data type. + * + * @return mixed|null + * The converted value, if a conversion could be executed. NULL otherwise. + * + * @see hook_search_api_data_type_info() + */ +function example_data_type_conversion($value, $original_type, $type) { + if ($type === 'example_type') { + // The example_type type apparently requires a rather complex data format. + return array( + 'value' => $value, + 'original' => $original_type, + ); + } + // Someone used this callback for another, unknown type. Return NULL. + // (Normally, you can just assume that the/a correct type is given.) + return NULL; +} diff --git a/www/modules/contrib/search_api/search_api.drush.inc b/www/modules/contrib/search_api/search_api.drush.inc new file mode 100644 index 000000000..16d447149 --- /dev/null +++ b/www/modules/contrib/search_api/search_api.drush.inc @@ -0,0 +1,727 @@ + 'List all search indexes.', + 'examples' => array( + 'drush searchapi-list' => dt('List all search indexes.'), + 'drush sapi-l' => dt('Alias to list all search indexes.'), + ), + 'aliases' => array('sapi-l'), + ); + + $items['search-api-enable'] = array( + 'description' => 'Enable one or all disabled search_api indexes.', + 'examples' => array( + 'drush searchapi-enable' => dt('Enable all disabled indexes.'), + 'drush sapi-en' => dt('Alias to enable all disabled indexes.'), + 'drush sapi-en 1' => dt('Enable index with the ID !id.', array('!id' => 1)), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index to enable.'), + ), + 'aliases' => array('sapi-en'), + ); + + $items['search-api-disable'] = array( + 'description' => 'Disable one or all enabled search_api indexes.', + 'examples' => array( + 'drush searchapi-disable' => dt('Disable all enabled indexes.'), + 'drush sapi-dis' => dt('Alias to disable all enabled indexes.'), + 'drush sapi-dis 1' => dt('Disable index with the ID !id.', array('!id' => 1)), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index to disable.'), + ), + 'aliases' => array('sapi-dis'), + ); + + $items['search-api-status'] = array( + 'description' => 'Show the status of one or all search indexes.', + 'examples' => array( + 'drush searchapi-status' => dt('Show the status of all search indexes.'), + 'drush sapi-s' => dt('Alias to show the status of all search indexes.'), + 'drush sapi-s 1' => dt('Show the status of the search index with the ID !id.', array('!id' => 1)), + 'drush sapi-s default_node_index' => dt('Show the status of the search index with the machine name !name.', array('!name' => 'default_node_index')), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index.'), + ), + 'aliases' => array('sapi-s'), + ); + + $items['search-api-index'] = array( + 'description' => 'Index items for one or all enabled search_api indexes.', + 'examples' => array( + 'drush searchapi-index' => dt('Index items for all enabled indexes.'), + 'drush sapi-i' => dt('Alias to index items for all enabled indexes.'), + 'drush sapi-i 1' => dt('Index items for the index with the ID !id.', array('!id' => 1)), + 'drush sapi-i default_node_index' => dt('Index items for the index with the machine name !name.', array('!name' => 'default_node_index')), + 'drush sapi-i 1 100' => dt("Index a maximum number of !limit items (index's cron batch size items per batch run) for the index with the ID !id.", array('!limit' => 100, '!id' => 1)), + 'drush sapi-i 1 100 10' => dt("Index a maximum number of !limit items (!batch_size items per batch run) for the index with the ID !id.", array('!limit' => 100, '!batch_size' => 10, '!id' => 1)), + 'drush sapi-i 0 0 100' => dt("Index all items of all indexes with !batch_size items per batch run.", array('!batch_size' => 100)), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index. Set to 0 to index all indexes. Defaults to 0 (index all).'), + 'limit' => dt("The number of items to index (index's cron batch size items per run). Set to 0 to index all items. Defaults to 0 (index all)."), + 'batch_size' => dt("The number of items to index per batch run. Set to 0 to index all items at once. Defaults to the index's cron batch size."), + ), + 'aliases' => array('sapi-i'), + ); + + $items['search-api-reindex'] = array( + 'description' => 'Force reindexing of one or all search indexes, without clearing existing index data.', + 'examples' => array( + 'drush searchapi-reindex' => dt('Schedule all search indexes for reindexing.'), + 'drush sapi-r' => dt('Alias to schedule all search indexes for reindexing .'), + 'drush sapi-r 1' => dt('Schedule the search index with the ID !id for re-indexing.', array('!id' => 1)), + 'drush sapi-r default_node_index' => dt('Schedule the search index with the machine name !name for re-indexing.', array('!name' => 'default_node_index')), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index.'), + ), + 'aliases' => array('sapi-r'), + ); + + $items['search-api-reindex-items'] = array( + 'description' => 'Force re-indexing of one or more specific items.', + 'examples' => array( + 'drush search-api-reindex-items node 12,34,56' => dt('Schedule the nodes with ID 12, 34 and 56 for re-indexing.'), + ), + 'arguments' => array( + 'entity_type' => dt('The entity type whose items should be re-indexed.'), + 'entities' => dt('The entities of the given entity type to be re-indexed.'), + ), + 'aliases' => array('sapi-ri'), + ); + + $items['search-api-clear'] = array( + 'description' => 'Clear one or all search indexes and mark them for re-indexing.', + 'examples' => array( + 'drush searchapi-clear' => dt('Clear all search indexes.'), + 'drush sapi-c' => dt('Alias to clear all search indexes.'), + 'drush sapi-c 1' => dt('Clear the search index with the ID !id.', array('!id' => 1)), + 'drush sapi-c default_node_index' => dt('Clear the search index with the machine name !name.', array('!name' => 'default_node_index')), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index.'), + ), + 'aliases' => array('sapi-c'), + ); + + $items['search-api-execute-tasks'] = array( + 'description' => 'Execute all pending tasks or all for a given server.', + 'examples' => array( + 'drush search-api-execute-tasks my_solr_server' => dt('Execute all pending tasks on !server', array('!server' => 'my_solr_server')), + 'drush sapi-et my_solr_server' => dt('Execute all pending tasks on !server', array('!server' => 'my_solr_server')), + 'drush sapi-et' => dt('Execute all pending tasks on all servers.'), + ), + 'arguments' => array( + 'server_id' => dt('The numeric ID or machine name of a server to execute tasks on.'), + ), + 'aliases' => array('sapi-et'), + ); + + $items['search-api-set-index-server'] = array( + 'description' => 'Set the search server used by a given index.', + 'examples' => array( + 'drush search-api-set-index-server default_node_index my_solr_server' => dt('Set the !index index to use the !server server.', array('!index' => 'default_node_index', '!server' => 'my_solr_server')), + 'drush sapi-sis default_node_index my_solr_server' => dt('Alias to set the !index index to use the !server server.', array('!index' => 'default_node_index', '!server' => 'my_solr_server')), + ), + 'arguments' => array( + 'index_id' => dt('The numeric ID or machine name of an index.'), + 'server_id' => dt('The numeric ID or machine name of a server to set on the index.'), + ), + 'aliases' => array('sapi-sis'), + ); + + $items['search-api-server-list'] = array( + 'description' => 'List all search servers.', + 'examples' => array( + 'drush search-api-server-list' => dt('List all search servers.'), + 'drush sapi-sl' => dt('Alias to list all search servers.'), + ), + 'aliases' => array('sapi-sl'), + ); + + $items['search-api-server-enable'] = array( + 'description' => 'Enable a search server.', + 'examples' => array( + 'drush search-api-server-e my_solr_server' => dt('Enable the !server search server.', array('!server' => 'my_solr_server')), + 'drush sapi-se my_solr_server' => dt('Alias to enable the !server search server.', array('!server' => 'my_solr_server')), + ), + 'arguments' => array( + 'server_id' => dt('The numeric ID or machine name of a search server to enable.'), + ), + 'aliases' => array('sapi-se'), + ); + + $items['search-api-server-disable'] = array( + 'description' => 'Disable a search server.', + 'examples' => array( + 'drush search-api-server-disable' => dt('Disable the !server search server.', array('!server' => 'my_solr_server')), + 'drush sapi-sd' => dt('Alias to disable the !server search server.', array('!server' => 'my_solr_server')), + ), + 'arguments' => array( + 'server_id' => dt('The numeric ID or machine name of a search server to disable.'), + ), + 'aliases' => array('sapi-sd'), + ); + + return $items; +} + + +/** + * List all search indexes. + */ +function drush_search_api_list() { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + // See search_api_list_indexes() + $indexes = search_api_index_load_multiple(FALSE); + if (empty($indexes)) { + drush_print(dt('There are no indexes present.')); + return; + } + $rows[] = array( + dt('Id'), + dt('Name'), + dt('Index'), + dt('Server'), + dt('Type'), + dt('Status'), + dt('Limit'), + ); + foreach ($indexes as $index) { + $type = search_api_get_item_type_info($index->item_type); + $type = isset($type['name']) ? $type['name'] : $index->item_type; + try { + $server = $index->server(); + $server = $server ? $server->name : '(' . dt('none') . ')'; + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + $server = '(' . dt('unknown: !server', array('server' => $index->server)) . ')'; + } + $row = array( + $index->id, + $index->name, + $index->machine_name, + $server, + $type, + $index->enabled ? dt('enabled') : dt('disabled'), + $index->options['cron_limit'], + ); + $rows[] = $row; + } + drush_print_table($rows); +} + +/** + * Enable index(es). + * + * @param string|integer $index_id + * The index name or id which should be enabled. + */ +function drush_search_api_enable($index_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $indexes = search_api_drush_get_index($index_id); + if (empty($indexes)) { + return; + } + foreach ($indexes as $index) { + $vars = array('!index' => $index->name); + if (!$index->enabled) { + drush_log(dt("Enabling index !index and queueing items for indexing.", $vars), 'notice'); + $success = FALSE; + try { + if ($success = search_api_index_enable($index->id)) { + drush_log(dt("The index !index was successfully enabled.", $vars), 'ok'); + } + } + catch (SearchApiException $e) { + drush_log($e->getMessage(), 'error'); + } + if (!$success) { + drush_log(dt("Error enabling index !index.", $vars), 'error'); + } + } + else { + drush_log(dt("The index !index is already enabled.", $vars), 'error'); + } + } +} + +/** + * Disable index(es). + * + * @param string|integer $index_id + * The index name or id which should be disabled. + */ +function drush_search_api_disable($index_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $indexes = search_api_drush_get_index($index_id); + if (empty($indexes)) { + return; + } + foreach ($indexes as $index) { + $vars = array('!index' => $index->name); + if ($index->enabled) { + $success = FALSE; + try { + if ($success = search_api_index_disable($index->id)) { + drush_log(dt("The index !index was successfully disabled.", $vars), 'ok'); + } + } + catch (SearchApiException $e) { + drush_log($e->getMessage(), 'error'); + } + if (!$success) { + drush_log(dt("Error disabling index !index.", $vars), 'error'); + } + } + else { + drush_log(dt("The index !index is already disabled.", $vars), 'error'); + } + } +} + +/** + * Display index status. + */ +function drush_search_api_status($index_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $indexes = search_api_drush_get_index($index_id); + if (empty($indexes)) { + return; + } + // See search_api_index_status() + $rows = array(array( + dt('Id'), + dt('Index'), + dt('% Complete'), + dt('Indexed'), + dt('Total'), + )); + foreach ($indexes as $index) { + $status = search_api_index_status($index); + $complete = ($status['total'] > 0) ? 100 * round($status['indexed'] / $status['total'], 3) . '%' : '-'; + $row = array( + $index->id, + $index->name, + $complete, + $status['indexed'], + $status['total'], + ); + $rows[] = $row; + } + drush_print_table($rows); +} + +/** + * Index items. + * + * @param string|integer $index_id + * The index name or id for which items should be indexed. + * @param integer $limit + * Maximum number of items to index. + * @param integer $batch_size + * Number of items to index per batch. + */ +function drush_search_api_index($index_id = NULL, $limit = NULL, $batch_size = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $index_id = !empty($index_id) ? $index_id : NULL; + $indexes = search_api_drush_get_index($index_id); + if (empty($indexes)) { + return; + } + + $process_batch = FALSE; + foreach ($indexes as $index) { + if (_drush_search_api_batch_indexing_create($index, $limit, $batch_size)) { + $process_batch = TRUE; + } + } + + if ($process_batch) { + drush_backend_batch_process(); + } +} + +/** + * Creates and sets a batch for indexing items for a particular index. + * + * @param SearchApiIndex $index + * The index for which items should be indexed. + * @param int $limit + * (optional) The maximum number of items to index, or NULL to index all + * items. + * @param int $batch_size + * (optional) The number of items to index per batch, or NULL to index all + * items at once. + * + * @return bool + * TRUE if batch was created, FALSE otherwise. + */ +function _drush_search_api_batch_indexing_create(SearchApiIndex $index, $limit = NULL, $batch_size = NULL) { + // Get the number of remaining items to index. + try { + $datasource = $index->datasource(); + } + catch (SearchApiException $e) { + drush_log($e->getMessage(), 'error'); + return FALSE; + } + $index_status = $datasource->getIndexStatus($index); + $remaining = $index_status['total'] - $index_status['indexed']; + if ($remaining <= 0) { + drush_log(dt("The index !index is up to date.", array('!index' => $index->name)), 'ok'); + return FALSE; + } + + // Get the number of items to index per batch run. + if (!isset($batch_size)) { + $batch_size = empty($index->options['cron_limit']) ? SEARCH_API_DEFAULT_CRON_LIMIT : $index->options['cron_limit']; + } + elseif ($batch_size <= 0) { + $batch_size = $remaining; + } + + // Get the total number of items to index. + if (!isset($limit) || !is_int($limit += 0) || $limit <= 0) { + $limit = $remaining; + } + + drush_log(dt("Indexing a maximum number of !limit items (!batch_size items per batch run) for the index !index.", array('!index' => $index->name, '!limit' => $limit, '!batch_size' => $batch_size)), 'ok'); + + // Create the batch. + if (!_search_api_batch_indexing_create($index, $batch_size, $limit, $remaining, TRUE)) { + drush_log(dt("Couldn't create a batch, please check the batch size and limit parameters."), 'error'); + return FALSE; + } + + return TRUE; +} + +/** + * Copy of formal_plural that works with drush as 't' may not be available. + */ +function _search_api_drush_format_plural($count, $singular, $plural, array $args = array(), array $options = array()) { + $args['@count'] = $count; + if ($count == 1) { + return dt($singular, $args, $options); + } + + // Get the plural index through the gettext formula. + $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1; + // If the index cannot be computed, use the plural as a fallback (which + // allows for most flexiblity with the replaceable @count value). + if ($index < 0) { + return dt($plural, $args, $options); + } + else { + switch ($index) { + case "0": + return dt($singular, $args, $options); + case "1": + return dt($plural, $args, $options); + default: + unset($args['@count']); + $args['@count[' . $index . ']'] = $count; + return dt(strtr($plural, array('@count' => '@count[' . $index . ']')), $args, $options); + } + } +} + +/** + * Mark for re-indexing. + */ +function drush_search_api_reindex($index_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $indexes = search_api_drush_get_index($index_id); + if (empty($indexes)) { + return; + } + // See search_api_index_reindex() + foreach ($indexes as $index) { + $index->reindex(); + drush_log(dt('!index was successfully marked for re-indexing.', array('!index' => $index->machine_name)), 'ok'); + } +} + +/** + * Marks the given entities as needing to be re-indexed. + */ +function drush_search_api_reindex_items($entity_type, $entities) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + + // Validate list of entity ids. + if (!empty($entities) && !preg_match('#^[0-9]*(,[0-9]*)*$#', $entities)) { + drush_log(dt('Entities should be a single numeric entity ID or a list with the numeric entity IDs separated by comma.'), 'error'); + return; + } + + $ids = explode(',', $entities); + + if (!empty($ids)) { + search_api_track_item_change($entity_type, $ids); + + $combined_ids = array(); + foreach ($ids as $id) { + $combined_ids[] = $entity_type . '/' . $id; + } + search_api_track_item_change('multiple', $combined_ids); + } +} + +/** + * Clear an index. + */ +function drush_search_api_clear($index_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $indexes = search_api_drush_get_index($index_id); + if (empty($indexes)) { + return; + } + // See search_api_index_reindex() + foreach ($indexes as $index) { + $index->clear(); + drush_log(dt('!index was successfully cleared.', array('!index' => $index->machine_name)), 'ok'); + } +} + +/** + * Execute all pending tasks or all for a given server. + */ +function drush_search_api_execute_tasks($server_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + + // Attempt to load the associated server. + $server = NULL; + if ($server_id) { + $servers = search_api_drush_get_server($server_id); + if (!$servers) { + return; + } + $server = reset($servers); + } + + // Process batch op with drush. + try { + search_api_execute_pending_tasks($server); + if ($server) { + drush_log(dt('!server tasks have been successfully executed.', array('!server' => $server->machine_name ?: 'All')), 'ok'); + } + else { + drush_log(dt('All tasks have been successfully executed.'), 'ok'); + } + } + catch (SearchApiException $e) { + drush_log($e->getMessage(), 'error'); + } +} + +/** + * Set the server for a given index. + */ +function drush_search_api_set_index_server($index_id = NULL, $server_id = NULL) { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + // Make sure we have parameters to work with. + if (empty($index_id) || empty($server_id)) { + drush_log(dt('You must specify both an index and server.'), 'error'); + return; + } + // Fetch current index and server data. + $indexes = search_api_drush_get_index($index_id); + $servers = search_api_drush_get_server($server_id); + if (empty($indexes) || empty($servers)) { + // If the specified index or server can't be found, just return. An + // appropriate error message should have been printed already. + return; + } + // Set the new server on the index. + $success = FALSE; + $index = reset($indexes); + $server = reset($servers); + try { + $success = $index->update(array('server' => $server->machine_name)); + } + catch (SearchApiException $e) { + drush_log($e->getMessage(), 'error'); + } + if ($success === FALSE) { + drush_log(dt('There was an error setting index !index to use server !server.', array('!index' => $index->name, '!server' => $server->name)), 'error'); + } + elseif (!$success) { + drush_log(dt('Index !index was already using server !server.', array('!index' => $index->name, '!server' => $server->name)), 'ok'); + } + else { + drush_log(dt('Index !index has been set to use server !server and items have been queued for indexing.', array('!index' => $index->name, '!server' => $server->name)), 'ok'); + } +} + +/** + * Returns an index or all indexes as an array. + * + * @param string|int|null $index_id + * (optional) The ID or machine name of the index to load. Defaults to + * loading all available indexes. + * + * @return SearchApiIndex[] + * An array of indexes. + */ +function search_api_drush_get_index($index_id = NULL) { + $ids = isset($index_id) ? array($index_id) : FALSE; + $indexes = search_api_index_load_multiple($ids); + if (empty($indexes)) { + drush_set_error(dt('Invalid index_id or no indexes present. Listing all indexes:')); + drush_print(); + drush_search_api_list(); + } + return $indexes; +} + +/** + * Returns a server or all servers as an array. + * + * @param string|int|null $server_id + * (optional) The ID or machine name of the server to load. Defaults to + * loading all available servers. + * + * @return SearchApiServer[] + * An array of servers. + */ +function search_api_drush_get_server($server_id = NULL) { + $ids = isset($server_id) ? array($server_id) : FALSE; + $servers = search_api_server_load_multiple($ids); + if (empty($servers)) { + drush_set_error(dt('Invalid server_id or no servers present.')); + drush_print(); + drush_search_api_server_list(); + } + return $servers; +} + +/** + * Does a static lookup to prevent Drush 4 from running twice. + * + * @param string $function + * The Drush function being called. + * + * @return bool + * TRUE if the function was already called in this Drush execution, FALSE + * otherwise. + * + * @see http://drupal.org/node/704848 + */ +function search_api_drush_static($function) { + static $index = array(); + if (isset($index[$function])) { + return TRUE; + } + $index[$function] = TRUE; + return FALSE; +} + +/** + * Lists all search servers. + */ +function drush_search_api_server_list() { + if (search_api_drush_static(__FUNCTION__)) { + return; + } + $servers = search_api_server_load_multiple(FALSE); + if (empty($servers)) { + drush_print(dt('There are no servers present.')); + return; + } + $rows[] = array( + dt('Machine name'), + dt('Name'), + dt('Status'), + ); + foreach ($servers as $server) { + $row = array( + $server->machine_name, + $server->name, + $server->enabled ? dt('enabled') : dt('disabled'), + ); + $rows[] = $row; + } + drush_print_table($rows); +} + +/** + * Enables a search server. + * + * @param int|string $server_id + * The numeric ID or machine name of the server to enable. + */ +function drush_search_api_server_enable($server_id = NULL) { + if (!isset($server_id)) { + drush_print(dt('Please provide a valid server id.')); + return; + } + $server = search_api_server_load($server_id); + if (empty($server)) { + drush_print(dt('The server was not able to load.')); + return; + } + else { + $server->update(array('enabled' => 1)); + drush_print(dt('The server was enabled successfully.')); + } +} + +/** + * Disables a search server. + * + * @param int|string $server_id + * The numeric ID or machine name of the server to disable. + */ +function drush_search_api_server_disable($server_id = NULL) { + if (!isset($server_id)) { + drush_print(dt('Please provide a valid server id.')); + return; + } + $server = search_api_server_load($server_id); + if (empty($server)) { + drush_print(dt('The server was not able to load.')); + } + else { + $server->update(array('enabled' => 0)); + drush_print(dt('The server was disabled successfully.')); + } +} diff --git a/www/modules/contrib/search_api/search_api.info b/www/modules/contrib/search_api/search_api.info new file mode 100644 index 000000000..c97f66c59 --- /dev/null +++ b/www/modules/contrib/search_api/search_api.info @@ -0,0 +1,15 @@ +name = Search API +description = "Provides a generic API for modules offering search capabilities." +backdrop = 1.x +type = module +package = Search +tags[] = Utility + +dependencies[] = entity_plus (>=1.x-1.0.10) + +configure = admin/config/search/search_api + +; Added by Backdrop CMS packaging script on 2026-02-06 +project = search_api +version = 1.x-1.29.5 +timestamp = 1770395528 diff --git a/www/modules/contrib/search_api/search_api.install b/www/modules/contrib/search_api/search_api.install new file mode 100644 index 000000000..4169510af --- /dev/null +++ b/www/modules/contrib/search_api/search_api.install @@ -0,0 +1,480 @@ + 'Stores all search servers created through the Search API.', + 'fields' => array( + 'id' => array( + 'description' => 'The primary identifier for a server.', + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'name' => array( + 'description' => 'The displayed name for a server.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'machine_name' => array( + 'description' => 'The machine name for a server.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'description' => array( + 'description' => 'The displayed description for a server.', + 'type' => 'text', + 'not null' => FALSE, + ), + 'class' => array( + 'description' => 'The id of the service class to use for this server.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'options' => array( + 'description' => 'The options used to configure the service object.', + 'type' => 'text', + 'size' => 'medium', + 'serialize' => TRUE, + 'not null' => TRUE, + ), + 'enabled' => array( + 'description' => 'A flag indicating whether the server is enabled.', + 'type' => 'int', + 'size' => 'tiny', + 'not null' => TRUE, + 'default' => 1, + ), + 'status' => array( + 'description' => 'The exportable status of the entity.', + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0x01, + 'size' => 'tiny', + ), + 'module' => array( + 'description' => 'The name of the providing module if the entity has been defined in code.', + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + ), + ), + 'indexes' => array( + 'enabled' => array('enabled'), + ), + 'unique keys' => array( + 'machine_name' => array('machine_name'), + ), + 'primary key' => array('id'), + ); + + $schema['search_api_index'] = array( + 'description' => 'Stores all search indexes on a {search_api_server}.', + 'fields' => array( + 'id' => array( + 'description' => 'An integer identifying the index.', + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'name' => array( + 'description' => 'A name to be displayed for the index.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'machine_name' => array( + 'description' => 'The machine name of the index.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'description' => array( + 'description' => "A string describing the index' use to users.", + 'type' => 'text', + 'not null' => FALSE, + ), + 'server' => array( + 'description' => 'The {search_api_server}.machine_name with which data should be indexed.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => FALSE, + ), + 'item_type' => array( + 'description' => 'The type of items stored in this index.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'options' => array( + 'description' => 'An array of additional arguments configuring this index.', + 'type' => 'text', + 'size' => 'medium', + 'serialize' => TRUE, + 'not null' => TRUE, + ), + 'enabled' => array( + 'description' => 'A flag indicating whether this index is enabled.', + 'type' => 'int', + 'size' => 'tiny', + 'not null' => TRUE, + 'default' => 1, + ), + 'read_only' => array( + 'description' => 'A flag indicating whether to write to this index.', + 'type' => 'int', + 'size' => 'tiny', + 'not null' => TRUE, + 'default' => 0, + ), + 'status' => array( + 'description' => 'The exportable status of the entity.', + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0x01, + 'size' => 'tiny', + ), + 'module' => array( + 'description' => 'The name of the providing module if the entity has been defined in code.', + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + ), + ), + 'indexes' => array( + 'item_type' => array('item_type'), + 'server' => array('server'), + 'enabled' => array('enabled'), + ), + 'unique keys' => array( + 'machine_name' => array('machine_name'), + ), + 'primary key' => array('id'), + ); + + $schema['search_api_item'] = array( + 'description' => 'Stores the items which should be indexed for each index, and their status.', + 'fields' => array( + 'item_id' => array( + 'description' => "The item's entity id (e.g. {node}.nid for nodes).", + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'index_id' => array( + 'description' => 'The {search_api_index}.id this item belongs to.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'changed' => array( + 'description' => 'Either a flag or a timestamp to indicate if or when the item was changed since it was last indexed.', + 'type' => 'int', + 'size' => 'big', + 'not null' => TRUE, + 'default' => 1, + ), + ), + 'indexes' => array( + 'indexing' => array('index_id', 'changed'), + ), + 'primary key' => array('item_id', 'index_id'), + ); + + $schema['search_api_item_string_id'] = array( + 'description' => 'Stores the items which should be indexed for each index, and their status. Used only for items with string IDs.', + 'fields' => array( + 'item_id' => array( + 'description' => "The item's ID.", + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + ), + 'index_id' => array( + 'description' => 'The {search_api_index}.id this item belongs to.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'changed' => array( + 'description' => 'Either a flag or a timestamp to indicate if or when the item was changed since it was last indexed.', + 'type' => 'int', + 'size' => 'big', + 'not null' => TRUE, + 'default' => 1, + ), + ), + 'indexes' => array( + 'indexing' => array('index_id', 'changed'), + ), + 'primary key' => array('item_id', 'index_id'), + ); + + $schema['search_api_task'] = array( + 'description' => 'Stores pending tasks for servers.', + 'fields' => array( + 'id' => array( + 'description' => 'An integer identifying this task.', + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'server_id' => array( + 'description' => 'The {search_api_server}.machine_name for which this task should be executed.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'type' => array( + 'description' => 'A keyword identifying the type of task that should be executed.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => TRUE, + ), + 'index_id' => array( + 'description' => 'The {search_api_index}.machine_name to which this task pertains, if applicable for this type.', + 'type' => 'varchar', + 'length' => 50, + 'not null' => FALSE, + ), + 'data' => array( + 'description' => 'Some data needed for the task, might be optional depending on the type.', + 'type' => 'text', + 'size' => 'medium', + 'serialize' => TRUE, + 'not null' => FALSE, + ), + ), + 'indexes' => array( + 'server' => array('server_id'), + ), + 'primary key' => array('id'), + ); + + return $schema; +} + +/** + * Implements hook_requirements(). + */ +function search_api_requirements($phase) { + $requirements = array(); + + if ($phase == 'runtime') { + // Check whether at least one server has pending tasks. + if (search_api_server_tasks_count()) { + $items = array(); + + $conditions = array('enabled' => TRUE); + foreach (search_api_server_load_multiple(FALSE, $conditions) as $server) { + $count = search_api_server_tasks_count($server); + if ($count) { + $args = array( + '@name' => $server->name, + ); + $text = format_plural($count, '@name has @count pending task.', '@name has @count pending tasks.', $args); + $items[] = l($text, "admin/config/search/search_api/server/{$server->machine_name}/execute-tasks"); + } + } + + if ($items) { + $text = t('There are pending tasks for the following servers:'); + $text .= theme('item_list', array( + 'type' => 'ul', + 'items' => $items, + )); + if (count($items) > 1) { + $label = t('Execute pending tasks on all servers'); + $text .= l($label, 'admin/config/search/search_api/execute-tasks'); + } + $requirements['search_api_pending_tasks'] = array( + 'title' => t('Search API'), + 'value' => $text, + 'severity' => REQUIREMENT_WARNING, + ); + } + } + } + + return $requirements; +} + +/** + * Implements hook_install(). + * + * Creates a default node index if the module is installed manually. + */ +function search_api_install() { + // In case the module is installed via an installation profile, a batch is + // active and we skip that. + if (batch_get()) { + return; + } + + $name = t('Default node index'); + $values = array( + 'name' => $name, + 'machine_name' => preg_replace('/[^a-z0-9]+/', '_', backdrop_strtolower($name)), + 'description' => t('An automatically created search index for indexing node data. Might be configured to specific needs.'), + 'server' => NULL, + 'item_type' => 'node', + 'options' => array( + 'index_directly' => 1, + 'cron_limit' => '50', + 'data_alter_callbacks' => array( + 'search_api_alter_node_access' => array( + 'status' => 1, + 'weight' => '0', + 'settings' => array(), + ), + ), + 'processors' => array( + 'search_api_case_ignore' => array( + 'status' => 1, + 'weight' => '0', + 'settings' => array( + 'strings' => 0, + ), + ), + 'search_api_html_filter' => array( + 'status' => 1, + 'weight' => '10', + 'settings' => array( + 'title' => 0, + 'alt' => 1, + 'tags' => "h1 = 5\n" . + "h2 = 3\n" . + "h3 = 2\n" . + "strong = 2\n" . + "b = 2\n" . + "em = 1.5\n" . + "u = 1.5", + ), + ), + 'search_api_tokenizer' => array( + 'status' => 1, + 'weight' => '20', + 'settings' => array( + 'spaces' => '[^\\p{L}\\p{N}]', + 'ignorable' => '[-]', + ), + ), + ), + 'fields' => array( + 'type' => array( + 'type' => 'string', + ), + 'title' => array( + 'type' => 'text', + 'boost' => '5.0', + ), + 'promote' => array( + 'type' => 'boolean', + ), + 'sticky' => array( + 'type' => 'boolean', + ), + 'created' => array( + 'type' => 'date', + ), + 'changed' => array( + 'type' => 'date', + ), + 'author' => array( + 'type' => 'integer', + 'entity_type' => 'user', + ), + 'comment_count' => array( + 'type' => 'integer', + ), + 'search_api_language' => array( + 'type' => 'string', + ), + 'body:value' => array( + 'type' => 'text', + ), + ), + ), + ); + entity_info_cache_clear(); + search_api_index_insert($values); + backdrop_set_message(t('The Search API module was installed. A new default node index was created.')); +} + +/** + * Implements hook_enable(). + * + * Mark all items as "dirty", since we can't know whether they are. + */ +function search_api_enable() { + $types = array(); + foreach (search_api_index_load_multiple(FALSE) as $index) { + if ($index->enabled) { + $types[$index->item_type][] = $index; + } + } + foreach ($types as $type => $indexes) { + try { + $controller = search_api_get_datasource_controller($type); + $controller->startTracking($indexes); + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + } + } +} + +/** + * Implements hook_disable(). + */ +function search_api_disable() { + entity_info_cache_clear(); + $types = array(); + foreach (search_api_index_load_multiple(FALSE) as $index) { + $types[$index->item_type][] = $index; + } + foreach ($types as $type => $indexes) { + try { + $controller = search_api_get_datasource_controller($type); + $controller->stopTracking($indexes); + } + catch (SearchApiException $e) { + // Modules defining entity or item types might have been disabled. Ignore. + } + } +} + +/** + * Implements hook_uninstall(). + */ +function search_api_uninstall() { + config_clear('search_api.settings', 'search_api_index_worker_callback_runtime'); +} + +/** + * Implements hook_update_last_removed(). + */ +function search_api_update_last_removed() { + return 7118; +} + +/** + * Implements hook_update_N(). + */ +function search_api_update_1000() { + $config = config('search_api.settings'); + $config->set('search_api_index_worker_callback_runtime', update_variable_get('search_api_index_worker_callback_runtime', '15')); + $config->save(); + update_variable_del('search_api_tasks'); + update_variable_del('search_api_index_worker_callback_runtime'); +} diff --git a/www/modules/contrib/search_api/search_api.module b/www/modules/contrib/search_api/search_api.module new file mode 100644 index 000000000..1ca678283 --- /dev/null +++ b/www/modules/contrib/search_api/search_api.module @@ -0,0 +1,3597 @@ + 'Search API', + 'description' => 'Create and configure search engines.', + 'page callback' => 'search_api_admin_overview', + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + ); + $items[$pre . '/overview'] = array( + 'title' => 'Overview', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -10, + ); + $items[$pre . '/add_server'] = array( + 'title' => 'Add server', + 'description' => 'Create a new search server.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_add_server'), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + 'weight' => -1, + 'type' => MENU_LOCAL_ACTION, + ); + $items[$pre . '/add_index'] = array( + 'title' => 'Add index', + 'description' => 'Create a new search index.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_add_index'), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_ACTION, + ); + $items[$pre . '/server/%search_api_server'] = array( + 'title' => 'View server', + 'title callback' => 'search_api_admin_item_title', + 'title arguments' => array(5), + 'description' => 'View server details.', + 'page callback' => 'search_api_admin_server_view', + 'page arguments' => array(5), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + ); + $items[$pre . '/server/%search_api_server/view'] = array( + 'title' => 'View', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -10, + ); + $items[$pre . '/server/%search_api_server/edit'] = array( + 'title' => 'Edit', + 'description' => 'Edit server details.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_server_edit', 5), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + 'weight' => -1, + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE | MENU_CONTEXT_PAGE, + ); + $items[$pre . '/server/%search_api_server/execute-tasks'] = array( + 'title' => 'Execute pending tasks', + 'description' => 'Attempt to process pending tasks for a given server.', + 'page callback' => 'search_api_execute_pending_tasks', + 'page arguments' => array(5), + 'access callback' => 'search_api_access_execute_tasks_batch', + 'access arguments' => array(5), + 'type' => MENU_CALLBACK, + ); + $items[$pre . '/server/%search_api_server/disable'] = array( + 'title' => 'Disable', + 'description' => 'Disable index.', + 'page callback' => 'search_api_admin_server_view', + 'page arguments' => array(5, 6), + 'access callback' => 'search_api_access_disable_page', + 'access arguments' => array(5), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE, + 'weight' => 8, + ); + $items[$pre . '/server/%search_api_server/delete'] = array( + 'title' => 'Delete', + 'title callback' => 'search_api_title_delete_page', + 'title arguments' => array(5), + 'description' => 'Delete server.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_confirm', 'server', 'delete', 5), + 'access callback' => 'search_api_access_delete_page', + 'access arguments' => array(5), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE, + 'weight' => 10, + ); + $items[$pre . '/execute-tasks'] = array( + 'title' => 'Execute pending tasks', + 'description' => 'Attempt to process pending server tasks.', + 'page callback' => 'search_api_execute_pending_tasks', + 'access callback' => 'search_api_access_execute_tasks_batch', + 'type' => MENU_LOCAL_ACTION, + ); + $items[$pre . '/index/%search_api_index'] = array( + 'title' => 'View index', + 'title callback' => 'search_api_admin_item_title', + 'title arguments' => array(5), + 'description' => 'View index details.', + 'page callback' => 'search_api_admin_index_view', + 'page arguments' => array(5), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + ); + $items[$pre . '/index/%search_api_index/view'] = array( + 'title' => 'View', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -10, + ); + $items[$pre . '/index/%search_api_index/edit'] = array( + 'title' => 'Edit', + 'description' => 'Edit index settings.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_index_edit', 5), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE | MENU_CONTEXT_PAGE, + 'weight' => -6, + ); + $items[$pre . '/index/%search_api_index/fields'] = array( + 'title' => 'Fields', + 'description' => 'Select indexed fields.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_index_fields', 5), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE | MENU_CONTEXT_PAGE, + 'weight' => -4, + ); + $items[$pre . '/index/%search_api_index/workflow'] = array( + 'title' => 'Filters', + 'description' => 'Edit indexing workflow.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_index_workflow', 5), + 'access arguments' => array('administer search_api'), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE | MENU_CONTEXT_PAGE, + 'weight' => -2, + ); + $items[$pre . '/index/%search_api_index/disable'] = array( + 'title' => 'Disable', + 'description' => 'Disable index.', + 'page callback' => 'search_api_admin_index_view', + 'page arguments' => array(5, 6), + 'access callback' => 'search_api_access_disable_page', + 'access arguments' => array(5), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE, + 'weight' => 8, + ); + $items[$pre . '/index/%search_api_index/delete'] = array( + 'title' => 'Delete', + 'title callback' => 'search_api_title_delete_page', + 'title arguments' => array(5), + 'description' => 'Delete index.', + 'page callback' => 'backdrop_get_form', + 'page arguments' => array('search_api_admin_confirm', 'index', 'delete', 5), + 'access callback' => 'search_api_access_delete_page', + 'access arguments' => array(5), + 'file' => 'search_api.admin.inc', + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE, + 'weight' => 10, + ); + + return $items; +} + +/** + * Implements hook_hook_info(). + */ +function search_api_hook_info() { + // We use the same group for all hooks, so save code lines. + $hook_info = array( + 'group' => 'search_api', + ); + return array( + 'search_api_service_info' => $hook_info, + 'search_api_service_info_alter' => $hook_info, + 'search_api_item_type_info' => $hook_info, + 'search_api_item_type_info_alter' => $hook_info, + 'search_api_data_type_info' => $hook_info, + 'search_api_data_type_info_alter' => $hook_info, + 'search_api_alter_callback_info' => $hook_info, + 'search_api_alter_callback_info_alter' => $hook_info, + 'search_api_processor_info' => $hook_info, + 'search_api_processor_info_alter' => $hook_info, + 'search_api_index_items_alter' => $hook_info, + 'search_api_items_indexed' => $hook_info, + 'search_api_query_alter' => $hook_info, + 'search_api_results_alter' => $hook_info, + 'search_api_server_load' => $hook_info, + 'search_api_server_insert' => $hook_info, + 'search_api_server_update' => $hook_info, + 'search_api_server_delete' => $hook_info, + 'default_search_api_server' => $hook_info, + 'default_search_api_server_alter' => $hook_info, + 'search_api_index_load' => $hook_info, + 'search_api_index_insert' => $hook_info, + 'search_api_index_update' => $hook_info, + 'search_api_index_reindex' => $hook_info, + 'search_api_index_delete' => $hook_info, + 'default_search_api_index' => $hook_info, + 'default_search_api_index_alter' => $hook_info, + ); +} + +/** + * Implements hook_theme(). + */ +function search_api_theme() { + $themes['search_api_server'] = array( + 'variables' => array( + 'id' => NULL, + 'name' => '', + 'machine_name' => '', + 'description' => NULL, + 'enabled' => NULL, + 'class_id' => NULL, + 'class_name' => NULL, + 'class_description' => NULL, + 'indexes' => array(), + 'options' => array(), + 'extra' => array(), + 'status' => NULL, + ), + 'file' => 'search_api.admin.inc', + ); + $themes['search_api_index'] = array( + 'variables' => array( + 'id' => NULL, + 'name' => '', + 'machine_name' => '', + 'description' => NULL, + 'item_type' => NULL, + 'datasource_config' => NULL, + 'enabled' => NULL, + 'server' => NULL, + 'options' => array(), + 'fields' => array(), + 'indexed_items' => 0, + 'on_server' => NULL, + 'total_items' => 0, + 'read_only' => 0, + 'status' => NULL, + ), + 'file' => 'search_api.admin.inc', + ); + $themes['search_api_admin_item_order'] = array( + 'render element' => 'element', + 'file' => 'search_api.admin.inc', + ); + $themes['search_api_admin_fields_table'] = array( + 'render element' => 'element', + 'file' => 'search_api.admin.inc', + ); + + return $themes; +} + +/** + * Implements hook_permission(). + */ +function search_api_permission() { + return array( + 'administer search_api' => array( + 'title' => t('Administer Search API'), + 'description' => t('Create and configure Search API servers and indexes.'), + ), + ); +} + +/** + * Implements hook_config_info(). + */ +function search_api_config_info() { + $prefixes['search_api.settings'] = array( + 'label' => t('Search API settings'), + 'group' => t('Configuration'), + ); + return $prefixes; +} + +/** + * Implements hook_cron(). + * + * This will first execute any pending server tasks. After that, items will + * be indexed on all enabled indexes with a non-zero cron limit. Indexing will + * run for the time set in the search_api_index_worker_callback_runtime variable + * (defaulting to 15 seconds), but will at least index one batch of items on + * each index. + * + * @see search_api_server_tasks_check() + */ +function search_api_cron() { + // Execute pending server tasks. + search_api_server_tasks_check(); + + // Load all enabled, not read-only indexes. + $conditions = array( + 'enabled' => TRUE, + 'read_only' => 0, + ); + $indexes = search_api_index_load_multiple(FALSE, $conditions); + if (!$indexes) { + return; + } + // Remember servers which threw an exception. + $ignored_servers = array(); + // Continue indexing, one batch from each index, until the time is up, but at + // least index one batch per index. + $end = time() + config_get('search_api.settings', 'search_api_index_worker_callback_runtime'); + $first_pass = TRUE; + while (TRUE) { + if (!$indexes) { + break; + } + foreach ($indexes as $id => $index) { + if (!$first_pass && time() >= $end) { + break 2; + } + if (!empty($ignored_servers[$index->server])) { + continue; + } + + $limit = isset($index->options['cron_limit']) ? $index->options['cron_limit'] : SEARCH_API_DEFAULT_CRON_LIMIT; + $num = 0; + if ($limit) { + try { + $num = search_api_index_items($index, $limit); + if ($num) { + $variables = array( + '@num' => $num, + '%name' => $index->name, + ); + watchdog('search_api', 'Indexed @num items for index %name.', $variables, WATCHDOG_INFO); + } + } + catch (SearchApiException $e) { + // Exceptions will probably be caused by the server in most cases. + // Therefore, don't index for any index on this server. + $ignored_servers[$index->server] = TRUE; + $vars['%index'] = $index->name; + watchdog_exception('search_api', $e, '%type while trying to index items on %index: !message in %function (line %line of %file).', $vars); + } + } + if (!$num) { + // Couldn't index any items => stop indexing for this index in this + // cron run. + unset($indexes[$id]); + } + } + $first_pass = FALSE; + } +} + +/** + * Implements hook_entity_info(). + */ +function search_api_entity_info() { + $info['search_api_server'] = array( + 'label' => t('Search server'), + 'controller class' => 'EntityPlusControllerExportable', + 'metadata controller class' => FALSE, + 'entity class' => 'SearchApiServer', + 'base table' => 'search_api_server', + 'uri callback' => 'search_api_server_url', + 'access callback' => 'search_api_entity_access', + 'module' => 'search_api', + 'exportable' => TRUE, + 'entity keys' => array( + 'id' => 'id', + 'label' => 'name', + 'name' => 'machine_name', + ), + ); + $info['search_api_index'] = array( + 'label' => t('Search index'), + 'controller class' => 'EntityPlusControllerExportable', + 'metadata controller class' => FALSE, + 'entity class' => 'SearchApiIndex', + 'base table' => 'search_api_index', + 'uri callback' => 'search_api_index_url', + 'access callback' => 'search_api_entity_access', + 'module' => 'search_api', + 'exportable' => TRUE, + 'entity keys' => array( + 'id' => 'id', + 'label' => 'name', + 'name' => 'machine_name', + ), + ); + + return $info; +} + +/** + * Implements hook_entity_property_info(). + */ +function search_api_entity_property_info() { + $info['search_api_server']['properties'] = array( + 'id' => array( + 'label' => t('ID'), + 'type' => 'integer', + 'description' => t('The primary identifier for a server.'), + 'schema field' => 'id', + 'validation callback' => 'entity_metadata_validate_integer_positive', + ), + 'name' => array( + 'label' => t('Name'), + 'type' => 'text', + 'description' => t('The displayed name for a server.'), + 'schema field' => 'name', + 'required' => TRUE, + ), + 'machine_name' => array( + 'label' => t('Machine name'), + 'type' => 'token', + 'description' => t('The internally used machine name for a server.'), + 'schema field' => 'machine_name', + 'required' => TRUE, + ), + 'description' => array( + 'label' => t('Description'), + 'type' => 'text', + 'description' => t('The displayed description for a server.'), + 'schema field' => 'description', + 'sanitize' => 'filter_xss', + ), + 'class' => array( + 'label' => t('Service class'), + 'type' => 'text', + 'description' => t('The ID of the service class to use for this server.'), + 'schema field' => 'class', + 'required' => TRUE, + ), + 'enabled' => array( + 'label' => t('Enabled'), + 'type' => 'boolean', + 'description' => t('A flag indicating whether the server is enabled.'), + 'schema field' => 'enabled', + ), + 'status' => array( + 'label' => t('Status'), + 'type' => 'integer', + 'description' => t('Search API server status property'), + 'schema field' => 'status', + 'options list' => 'search_api_status_options_list', + ), + 'module' => array( + 'label' => t('Module'), + 'type' => 'text', + 'description' => t('The name of the module from which this server originates.'), + 'schema field' => 'module', + ), + ); + $info['search_api_index']['properties'] = array( + 'id' => array( + 'label' => t('ID'), + 'type' => 'integer', + 'description' => t('An integer identifying the index.'), + 'schema field' => 'id', + 'validation callback' => 'entity_metadata_validate_integer_positive', + ), + 'name' => array( + 'label' => t('Name'), + 'type' => 'text', + 'description' => t('A name to be displayed for the index.'), + 'schema field' => 'name', + 'required' => TRUE, + ), + 'machine_name' => array( + 'label' => t('Machine name'), + 'type' => 'token', + 'description' => t('The internally used machine name for an index.'), + 'schema field' => 'machine_name', + 'required' => TRUE, + ), + 'description' => array( + 'label' => t('Description'), + 'type' => 'text', + 'description' => t("A string describing the index' use to users."), + 'schema field' => 'description', + 'sanitize' => 'filter_xss', + ), + 'server' => array( + 'label' => t('Server ID'), + 'type' => 'token', + 'description' => t('The machine name of the search_api_server with which data should be indexed.'), + 'schema field' => 'server', + ), + 'server_entity' => array( + 'label' => t('Server'), + 'type' => 'search_api_server', + 'description' => t('The search_api_server with which data should be indexed.'), + 'getter callback' => 'search_api_index_get_server', + ), + 'item_type' => array( + 'label' => t('Item type'), + 'type' => 'token', + 'description' => t('The type of items stored in this index.'), + 'schema field' => 'item_type', + 'required' => TRUE, + ), + 'enabled' => array( + 'label' => t('Enabled'), + 'type' => 'boolean', + 'description' => t('A flag indicating whether the index is enabled.'), + 'schema field' => 'enabled', + ), + 'read_only' => array( + 'label' => t('Read only'), + 'type' => 'boolean', + 'description' => t('A flag indicating whether the index is read-only.'), + 'schema field' => 'read_only', + ), + 'status' => array( + 'label' => t('Status'), + 'type' => 'integer', + 'description' => t('Search API index status property'), + 'schema field' => 'status', + 'options list' => 'search_api_status_options_list', + ), + 'module' => array( + 'label' => t('Module'), + 'type' => 'text', + 'description' => t('The name of the module from which this index originates.'), + 'schema field' => 'module', + ), + ); + + return $info; +} + +/** + * Implements hook_search_api_server_insert(). + * + * Calls the postCreate() method for the server. + */ +function search_api_search_api_server_insert(SearchApiServer $server) { + // Check whether this is actually part of a revert. + $reverts = &backdrop_static('search_api_search_api_server_delete', array()); + if (isset($reverts[$server->machine_name])) { + $server->original = $reverts[$server->machine_name]; + unset($reverts[$server->machine_name]); + search_api_search_api_server_update($server); + unset($server->original); + return; + } + $server->postCreate(); +} + +/** + * Implements hook_search_api_server_update(). + * + * Calls the server's postUpdate() method and marks all of this server's indexes + * for reindexing, if necessary. + */ +function search_api_search_api_server_update(SearchApiServer $server) { + if ($server->postUpdate()) { + foreach (search_api_index_load_multiple(FALSE, array('server' => $server->machine_name)) as $index) { + $index->reindex(); + } + } + if (!empty($server->original) && $server->enabled != $server->original->enabled) { + if ($server->enabled) { + search_api_server_tasks_check($server); + } + else { + foreach (search_api_index_load_multiple(FALSE, array('server' => $server->machine_name)) as $index) { + $index->update(array('enabled' => 0, 'server' => NULL)); + } + } + } +} + +/** + * Implements hook_search_api_server_delete(). + * + * Calls the preDelete() method for the server. + */ +function search_api_search_api_server_delete(SearchApiServer $server) { + // Only react on real delete, not revert. + if ($server->hasStatus(ENTITY_PLUS_IN_CODE)) { + $reverts = &backdrop_static(__FUNCTION__, array()); + $reverts[$server->machine_name] = $server; + return; + } + + $server->preDelete(); + foreach (search_api_index_load_multiple(FALSE, array('server' => $server->machine_name)) as $index) { + $index->update(array('server' => NULL, 'enabled' => FALSE)); + } + + search_api_server_tasks_delete(NULL, $server); +} + +/** + * Implements hook_search_api_index_insert(). + * + * Adds the index to its server (if any) and starts tracking indexed items (if + * the index is enabled). + */ +function search_api_search_api_index_insert(SearchApiIndex $index) { + // Check whether this is actually part of a revert. + $reverts = &backdrop_static('search_api_search_api_index_delete', array()); + if (isset($reverts[$index->machine_name])) { + $index->original = $reverts[$index->machine_name]; + unset($reverts[$index->machine_name]); + search_api_search_api_index_update($index); + unset($index->original); + return; + } + + $index->postCreate(); +} + +/** + * Implements hook_search_api_index_update(). + */ +function search_api_search_api_index_update(SearchApiIndex $index) { + // Call the datasource update function with the tables this module provides. + search_api_index_update_datasource($index, 'search_api_item'); + search_api_index_update_datasource($index, 'search_api_item_string_id'); + + // If the server was changed, we have to call the appropriate service class + // hook methods. + if ($index->server != $index->original->server) { + // Server changed - inform old and new ones. + if ($index->original->server) { + $old_server = search_api_server_load($index->original->server); + // The server might have changed because the old one was deleted: + if ($old_server) { + $old_server->removeIndex($index); + } + } + + if ($index->server) { + try { + $new_server = $index->server(TRUE); + // If the server is enabled, we call addIndex(); otherwise, we save the task. + $new_server->addIndex($index); + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + // If the new server doesn't exist, we remove the index from all + // servers. Note that saving an entity in its own update hook is usually + // a recipe for disaster, but since we are only doing this if a server + // is set and remove the server here before saving, it should be safe + // enough. + $index->server = NULL; + $index->save(); + } + } + + // We also have to re-index all content. + _search_api_index_reindex($index); + } + + // If the fields were changed, call the appropriate service class hook method + // and re-index the content, if necessary. + $old_fields = $index->original->options + array('fields' => array()); + $old_fields = $old_fields['fields']; + $new_fields = $index->options + array('fields' => array()); + $new_fields = $new_fields['fields']; + if ($old_fields != $new_fields) { + if ($index->server) { + $index->server()->fieldsUpdated($index); + } + } + + // If the index's enabled or read-only status is being changed, queue or + // dequeue items for indexing. + if (!$index->read_only && $index->enabled != $index->original->enabled) { + if ($index->enabled) { + $index->queueItems(); + } + else { + $index->dequeueItems(); + } + } + elseif ($index->read_only != $index->original->read_only) { + if ($index->read_only) { + $index->dequeueItems(); + } + else { + $index->queueItems(); + } + } +} + +/** + * Implements hook_search_api_index_delete(). + * + * Removes all data for indexes not available any more. + */ +function search_api_search_api_index_delete(SearchApiIndex $index) { + // Only react on real delete, not revert. + if ($index->hasStatus(ENTITY_PLUS_IN_CODE)) { + $reverts = &backdrop_static(__FUNCTION__, array()); + $reverts[$index->machine_name] = $index; + return; + } + cache_clear_all($index->getCacheId(''), 'cache', TRUE); + $index->postDelete(); +} + +/** + * Implements hook_features_export_alter(). + * + * Adds dependency information for exported servers. + */ +function search_api_features_export_alter(&$export) { + if (isset($export['features']['search_api_server'])) { + // Get a list of the modules that provide storage engines. + $hook = 'search_api_service_info'; + $classes = array(); + foreach (module_implements('search_api_service_info') as $module) { + $function = $module . '_' . $hook; + $engines = $function(); + foreach ($engines as $service => $specs) { + $classes[$service] = $module; + } + } + + // Check all of the exported server specifications. + foreach ($export['features']['search_api_server'] as $server_name) { + // Load the server's object. + $server = search_api_server_load($server_name); + $module = $classes[$server->class]; + + // Ensure that the module responsible for the server object is listed as + // a dependency. + if (!isset($export['dependencies'][$module])) { + $export['dependencies'][$module] = $module; + } + } + + // Ensure the dependencies list is still sorted alphabetically. + ksort($export['dependencies']); + } +} + +/** + * Implements hook_system_info_alter(). + * + * Checks if the module provides any search item types or service classes. If it + * does, and there are search indexes using those item types, respectively + * servers using those service classes, the module is set to "required". + * + * Heavily borrowed from field_system_info_alter(). + * + * @see hook_search_api_item_type_info() + */ +function search_api_system_info_alter(&$info, $file, $type) { + if ($type != 'module' || $file->name == 'search_api' || !module_exists($file->name)) { + return; + } + // Check for defined item types. + if (module_hook($file->name, 'search_api_item_type_info')) { + $types = array(); + foreach (search_api_get_item_type_info() as $type => $type_info) { + if ($type_info['module'] == $file->name) { + $types[] = $type; + } + } + if ($types) { + $sql = 'SELECT machine_name, name FROM {search_api_index} WHERE item_type IN (:types)'; + $indexes = db_query($sql, array(':types' => $types))->fetchAllKeyed(); + if ($indexes) { + $info['disabled'] = TRUE; + + $links = array(); + foreach ($indexes as $id => $name) { + $url = url("admin/config/search/search_api/index/$id"); + $links[] = '' . check_plain($name) . ''; + } + + $args = array('!indexes' => implode(', ', $links)); + $info['explanation'] = format_plural(count($indexes), 'Item type in use by the following index: !indexes.', 'Item type(s) in use by the following indexes: !indexes.', $args); + } + } + } + // Check for defined service classes. + if (module_hook($file->name, 'search_api_service_info')) { + $classes = array(); + foreach (search_api_get_service_info() as $class => $class_info) { + if ($class_info['module'] == $file->name) { + $classes[] = $class; + } + } + if ($classes) { + $sql = 'SELECT machine_name, name FROM {search_api_server} WHERE class IN (:classes)'; + $servers = db_query($sql, array(':classes' => $classes))->fetchAllKeyed(); + if ($servers) { + $info['disabled'] = TRUE; + + $links = array(); + foreach ($servers as $id => $name) { + $url = url("admin/config/search/search_api/server/$id"); + $links[] = '' . check_plain($name) . ''; + } + + $args = array('!servers' => implode(', ', $links)); + $explanation = format_plural(count($servers), 'Service class in use by the following server: !servers.', 'Service class(es) in use by the following servers: !servers.', $args); + $info['explanation'] = (!empty($info['explanation']) ? $info['explanation'] . ' ' : '') . $explanation; + } + } + } +} + +/** + * Implements hook_entity_insert(). + * + * This is implemented on behalf of the SearchApiEntityDataSourceController + * datasource controller and calls search_api_track_item_insert() for the + * inserted items. + * + * @see search_api_search_api_item_type_info() + */ +function search_api_entity_insert($entity, $type) { + // When inserting a new search index, the new index was already inserted into + // the tracking table. This would lead to a duplicate-key issue, if we would + // continue. + // We also only react on entity operations for types with property + // information, as we don't provide search integration for the others. + if ($type == 'search_api_index' || !entity_plus_get_property_info($type)) { + return; + } + list($id) = entity_extract_ids($type, $entity); + if (isset($id)) { + search_api_track_item_insert($type, array($id)); + $combined_id = $type . '/' . $id; + search_api_track_item_insert('multiple', array($combined_id)); + } +} + +/** + * Implements hook_entity_update(). + * + * This is implemented on behalf of the SearchApiEntityDataSourceController + * datasource controller and calls search_api_track_item_change() for the + * updated items. + * + * It also checks whether the entity's bundle changed and acts accordingly. + * + * @see search_api_search_api_item_type_info() + */ +function search_api_entity_update($entity, $type) { + // We only react on entity operations for types with property information, as + // we don't provide search integration for the others. + if (!entity_plus_get_property_info($type)) { + return; + } + list($id, , $new_bundle) = entity_extract_ids($type, $entity); + + // Check if the entity's bundle changed. + if (!empty($entity->original)) { + list(, , $old_bundle) = entity_extract_ids($type, $entity->original); + if ($new_bundle != $old_bundle) { + _search_api_entity_datasource_bundle_change($type, $id, $old_bundle, $new_bundle); + } + } + + if (isset($id)) { + search_api_track_item_change($type, array($id)); + $combined_id = $type . '/' . $id; + search_api_track_item_change('multiple', array($combined_id)); + } +} + +/** + * Implements hook_entity_delete(). + * + * This is implemented on behalf of the SearchApiEntityDataSourceController + * datasource controller and calls search_api_track_item_delete() for the + * deleted items. + * + * @see search_api_search_api_item_type_info() + */ +function search_api_entity_delete($entity, $type) { + // We only react on entity operations for types with property information, as + // we don't provide search integration for the others. + if (!entity_plus_get_property_info($type)) { + return; + } + list($id) = entity_extract_ids($type, $entity); + if (isset($id)) { + search_api_track_item_delete($type, array($id)); + $combined_id = $type . '/' . $id; + search_api_track_item_delete('multiple', array($combined_id)); + } +} + +/** + * Implements hook_node_access_records_alter(). + * + * Marks the node as "changed" in indexes that use the "Node access" data + * alteration. Also marks the node's comments as changed in indexes that use the + * "Comment access" data alteration. + */ +function search_api_node_access_records_alter(&$grants, $node) { + $conditions = array( + 'enabled' => 1, + 'read_only' => 0, + ); + $indexes = search_api_index_load_multiple(FALSE, $conditions); + foreach ($indexes as $index) { + $item_ids = array(); + if (!empty($index->options['data_alter_callbacks']['search_api_alter_node_access']['status'])) { + $item_id = $index->datasource()->getItemId($node); + if ($item_id !== NULL) { + $item_ids = array($item_id); + } + } + elseif (!empty($index->options['data_alter_callbacks']['search_api_alter_comment_access']['status'])) { + if (!isset($comments)) { + $comments = comment_load_multiple(FALSE, array('nid' => $node->nid)); + } + foreach ($comments as $comment) { + $item_ids[] = $index->datasource()->getItemId($comment); + } + } + + if ($item_ids) { + search_api_track_item_change_for_indexes( + $index->item_type, + $item_ids, + array($index->machine_name => $index) + ); + } + } +} + +/** + * Implements hook_field_attach_rename_bundle(). + * + * This is implemented on behalf of the SearchApiEntityDataSourceController + * datasource controller, to update any bundle settings that contain the changed + * bundle. + */ +function search_api_field_attach_rename_bundle($entity_type, $bundle_old, $bundle_new) { + foreach (search_api_index_load_multiple(FALSE, array('item_type' => $entity_type)) as $index) { + $bundles = &$index->options['datasource']['bundles']; + if (isset($bundles) && ($pos = array_search($bundle_old, $bundles)) !== FALSE) { + $bundles[$pos] = $bundle_new; + $index->save(); + // Clear all caches that could contain the bundle information. + $index->resetCaches(); + backdrop_static_reset('search_api_get_datasource_controller'); + } + } +} + +/** + * Implements hook_field_update_field(). + * + * Recalculates fields settings if the cardinality of the field has changed from + * or to 1. + */ +function search_api_field_update_field($field, $prior_field) { + $before = $prior_field['cardinality']; + $after = $field['cardinality']; + if ($before != $after && ($before == 1 || $after == 1)) { + // Unfortunately, we cannot call this right away since the field information + // is only stored after the hook is called. + backdrop_register_shutdown_function('search_api_index_recalculate_fields'); + } +} + +/** + * Implements hook_flush_caches(). + * + * Recalculates fields settings in case the schema (in most cases: the + * multiplicity) of a property has changed. + */ +function search_api_flush_caches() { + search_api_index_recalculate_fields(); +} + +/** + * Implements hook_search_api_item_type_info(). + * + * Adds item types for all entity types with property information. + */ +function search_api_search_api_item_type_info() { + $types = array(); + + foreach (search_api_entity_type_options_list() as $type => $label) { + $types[$type] = array( + 'name' => $label, + 'datasource controller' => 'SearchApiEntityDataSourceController', + 'entity_type' => $type, + ); + } + + $types['multiple'] = array( + 'name' => t('Multiple types'), + 'datasource controller' => 'SearchApiCombinedEntityDataSourceController', + ); + + return $types; +} + +/** + * Implements hook_module_implements_alter(). + * + * Ensures the item type and service class static caches are invalidated at the + * right time. + */ +function search_api_module_implements_alter(array &$implementations, $hook) { + switch ($hook) { + case 'modules_enabled': + $group = $implementations['search_api']; + unset($implementations['search_api']); + $implementations = array('search_api' => $group) + $implementations; + break; + + case 'modules_disabled': + $group = $implementations['search_api']; + unset($implementations['search_api']); + $implementations['search_api'] = $group; + break; + } +} + +/** + * Implements hook_modules_enabled(). + */ +function search_api_modules_enabled() { + // New modules might offer additional item types or service classes, + // invalidating the cached information. + backdrop_static_reset('search_api_get_item_type_info'); + backdrop_static_reset('search_api_get_service_info'); +} + +/** + * Implements hook_modules_disabled(). + */ +function search_api_modules_disabled() { + // The disabled modules might have offered item types or service classes, + // invalidating the cached information. + backdrop_static_reset('search_api_get_item_type_info'); + backdrop_static_reset('search_api_get_service_info'); +} + +/** + * Implements hook_search_api_alter_callback_info(). + */ +function search_api_search_api_alter_callback_info() { + $callbacks['search_api_alter_bundle_filter'] = array( + 'name' => t('Bundle filter'), + 'description' => t('Exclude items from indexing based on their bundle (content type, vocabulary, …).'), + 'class' => 'SearchApiAlterBundleFilter', + // Filters should be executed first. + 'weight' => -10, + ); + $callbacks['search_api_alter_role_filter'] = array( + 'name' => t('Role filter'), + 'description' => t('Exclude users from indexing based on their role.'), + 'class' => 'SearchApiAlterRoleFilter', + // Filters should be executed first. + 'weight' => -10, + ); + $callbacks['search_api_alter_add_url'] = array( + 'name' => t('URL field'), + 'description' => t("Adds the item's URL to the indexed data."), + 'class' => 'SearchApiAlterAddUrl', + ); + $callbacks['search_api_alter_add_aggregation'] = array( + 'name' => t('Aggregated fields'), + 'description' => t('Gives you the ability to define additional fields, containing data from one or more other fields.'), + 'class' => 'SearchApiAlterAddAggregation', + ); + $callbacks['search_api_alter_add_viewed_entity'] = array( + 'name' => t('Complete entity view'), + 'description' => t('Adds an additional field containing the whole HTML content of the entity when viewed.'), + 'class' => 'SearchApiAlterAddViewedEntity', + ); + $callbacks['search_api_alter_add_hierarchy'] = array( + 'name' => t('Index hierarchy'), + 'description' => t('Allows to index hierarchical fields along with all their ancestors.'), + 'class' => 'SearchApiAlterAddHierarchy', + ); + $callbacks['search_api_alter_file_entity_public'] = array( + 'name' => t('Exclude private files'), + 'description' => t('Exclude file entities in the private files folder from being indexed. Caution: This only affects the indexed file entities themselves. If an indexed entity has references to file entities in the private folder, those will still be indexed (or displayed) normally.'), + 'class' => 'SearchApiAlterFileEntityPublic', + ); + $callbacks['search_api_alter_language_control'] = array( + 'name' => t('Language control'), + 'description' => t('Lets you determine the language of items in the index.'), + 'class' => 'SearchApiAlterLanguageControl', + ); + $callbacks['search_api_alter_node_access'] = array( + 'name' => t('Node access'), + 'description' => t('Add node access information to the index. Caution: This only affects the indexed nodes themselves, not any node reference fields that are indexed with them, or displayed in search results.'), + 'class' => 'SearchApiAlterNodeAccess', + ); + $callbacks['search_api_alter_comment_access'] = array( + 'name' => t('Access check'), + 'description' => t('Add node access information to the index. Caution: This only affects the indexed nodes themselves, not any node reference fields that are indexed with them, or displayed in search results.'), + 'class' => 'SearchApiAlterCommentAccess', + ); + $callbacks['search_api_alter_node_status'] = array( + 'name' => t('Exclude unpublished nodes'), + 'description' => t('Exclude unpublished nodes from the index. Caution: This only affects the indexed nodes themselves. If an enabled node has references to disabled nodes, those will still be indexed (or displayed) normally.'), + 'class' => 'SearchApiAlterNodeStatus', + ); + $callbacks['search_api_alter_user_content'] = array( + 'name' => t('Add user content'), + 'description' => t('Allows indexing of nodes (and their fields) created by the indexed user. (Caution: This might lead to performance problems, or even errors during indexing, on larger sites.)'), + 'class' => 'SearchApiAlterAddUserContent', + ); + $callbacks['search_api_alter_user_status'] = array( + 'name' => t('Exclude blocked users'), + 'description' => t('Exclude blocked users from the index. Caution: This only affects the indexed users themselves. If an active user account includes a reference to a disabled user, that reference will still be indexed (or displayed) normally.'), + 'class' => 'SearchApiAlterUserStatus', + ); + + return $callbacks; +} + +/** + * Implements hook_search_api_processor_info(). + */ +function search_api_search_api_processor_info() { + $processors['search_api_case_ignore'] = array( + 'name' => t('Ignore case'), + 'description' => t('This processor will make searches case-insensitive for fulltext or string fields.'), + 'class' => 'SearchApiIgnoreCase', + ); + $processors['search_api_html_filter'] = array( + 'name' => t('HTML filter'), + 'description' => t('Strips HTML tags from fulltext fields and decodes HTML entities. ' . + 'Use this processor when indexing HTML data, e.g., node bodies for certain text formats.' . + 'The processor also allows to boost (or ignore) the contents of specific elements.'), + 'class' => 'SearchApiHtmlFilter', + 'weight' => 10, + ); + if (function_exists('transliteration_get')) { + $processors['search_api_transliteration'] = array( + 'name' => t('Transliteration'), + 'description' => t('This processor will make searches insensitive to accents and other non-ASCII characters.'), + 'class' => 'SearchApiTransliteration', + 'weight' => 15, + ); + } + $processors['search_api_tokenizer'] = array( + 'name' => t('Tokenizer'), + 'description' => t('Tokenizes fulltext data by stripping whitespace. ' . + 'This processor allows you to specify which characters make up words and which characters should be ignored, using regular expression syntax. ' . + 'Otherwise it is up to the search server implementation to decide how to split indexed fulltext data.'), + 'class' => 'SearchApiTokenizer', + 'weight' => 20, + ); + $processors['search_api_stopwords'] = array( + 'name' => t('Stopwords'), + 'description' => t('This processor prevents certain words from being indexed and removes them from search terms. ' . + 'For best results, it should only be executed after tokenizing.'), + 'class' => 'SearchApiStopWords', + 'weight' => 30, + ); + $processors['search_api_porter_stemmer'] = array( + 'name' => t('Stem words'), + 'description' => t('This processor reduces words to a stem (e.g., "talking" to "talk"). For best results, it should only be executed after tokenizing.'), + 'class' => 'SearchApiPorterStemmer', + 'weight' => 35, + ); + $processors['search_api_highlighting'] = array( + 'name' => t('Highlighting'), + 'description' => t('Adds highlighting for search results.'), + 'class' => 'SearchApiHighlight', + 'weight' => 40, + ); + + return $processors; +} + +/** + * Inserts new unindexed items for all indexes on the specified type. + * + * @param string $type + * The item type of the new items. + * @param array $item_ids + * The IDs of the new items. + */ +function search_api_track_item_insert($type, array $item_ids) { + $conditions = array( + 'enabled' => 1, + 'item_type' => $type, + 'read_only' => 0, + ); + $indexes = search_api_index_load_multiple(FALSE, $conditions); + if (!$indexes) { + return; + } + + try { + $returned_indexes = search_api_get_datasource_controller($type)->trackItemInsert($item_ids, $indexes); + if (isset($returned_indexes)) { + $indexes = $returned_indexes; + } + } + catch (SearchApiException $e) { + $vars['%item_type'] = $type; + watchdog_exception('search_api', $e, '%type while inserting items of type %item_type: !message in %function (line %line of %file).', $vars); + return; + } + + foreach ($indexes as $index) { + if (!empty($index->options['index_directly'])) { + search_api_index_specific_items_delayed($index, $item_ids); + } + } +} + +/** + * Mark the items with the specified IDs as "dirty", i.e., as needing to be reindexed. + * + * For indexes for which items should be indexed immediately, the items are + * indexed directly, instead. + * + * @param $type + * The type of items, specific to the data source. + * @param array $item_ids + * The IDs of the items to be marked dirty. + */ +function search_api_track_item_change($type, array $item_ids) { + $conditions = array( + 'enabled' => 1, + 'item_type' => $type, + 'read_only' => 0, + ); + $indexes = search_api_index_load_multiple(FALSE, $conditions); + if (!$indexes) { + return; + } + search_api_track_item_change_for_indexes($type, $item_ids, $indexes); +} + +/** + * Marks the items with the specified IDs as "dirty" for the given indexes. + * + * @param string $type + * The item type of the items. + * @param array $item_ids + * The item IDs. + * @param SearchApiIndex[] $indexes + * The indexes for which to mark the items as "dirty". + */ +function search_api_track_item_change_for_indexes($type, array $item_ids, $indexes) { + try { + $returned_indexes = search_api_get_datasource_controller($type)->trackItemChange($item_ids, $indexes); + if (isset($returned_indexes)) { + $indexes = $returned_indexes; + } + foreach ($indexes as $index) { + if (!empty($index->options['index_directly'])) { + // For indexes with the index_directly option set, queue the items to be + // indexed at the end of the request. + try { + search_api_index_specific_items_delayed($index, $item_ids); + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + } + } + } + } + catch (SearchApiException $e) { + $vars['%item_type'] = $type; + watchdog_exception('search_api', $e, '%type while updating items of type %item_type: !message in %function (line %line of %file).', $vars); + } +} + +/** + * Marks items as queued for indexing for the specified index. + * + * @param SearchApiIndex $index + * The index on which items were queued. + * @param array $item_ids + * The ids of the queued items. + * + * @deprecated + * As of Search API 1.10, the cron queue is not used for indexing anymore, + * therefore this function has become useless. It will, along with + * SearchApiDataSourceControllerInterface::trackItemQueued(), be removed in + * the Backdrop 8 version of this module. + */ +function search_api_track_item_queued(SearchApiIndex $index, array $item_ids) { + try { + $index->datasource()->trackItemQueued($item_ids, $index); + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + } +} + +/** + * Marks items as successfully indexed for the specified index. + * + * @param SearchApiIndex $index + * The index on which items were indexed. + * @param array $item_ids + * The ids of the indexed items. + */ +function search_api_track_item_indexed(SearchApiIndex $index, array $item_ids) { + $index->datasource()->trackItemIndexed($item_ids, $index); + module_invoke_all('search_api_items_indexed', $index, $item_ids); +} + +/** + * Removes items from all indexes. + * + * @param $type + * The type of the items. + * @param array $item_ids + * The IDs of the deleted items. + */ +function search_api_track_item_delete($type, array $item_ids) { + // First, delete the item from the tracking table. + $conditions = array( + 'enabled' => 1, + 'item_type' => $type, + 'read_only' => 0, + ); + $indexes = search_api_index_load_multiple(FALSE, $conditions); + if ($indexes) { + try { + $changed_indexes = search_api_get_datasource_controller($type)->trackItemDelete($item_ids, $indexes); + if (isset($changed_indexes)) { + $indexes = $changed_indexes; + } + } + catch (SearchApiException $e) { + $vars['%item_type'] = $type; + watchdog_exception('search_api', $e, '%type while deleting items of type %item_type: !message in %function (line %line of %file).', $vars); + } + } + + // Then, delete it from all servers. Servers of disabled indexes have to be + // considered, too! + $conditions['enabled'] = 0; + $indexes = array_merge($indexes, search_api_index_load_multiple(FALSE, $conditions)); + foreach ($indexes as $index) { + try { + if ($server = $index->server()) { + $server->deleteItems($item_ids, $index); + } + } + catch (Exception $e) { + $vars['%item_type'] = $type; + watchdog_exception('search_api', $e, '%type while deleting items of type %item_type: !message in %function (line %line of %file).', $vars); + } + } +} + +/** + * Checks for pending tasks on one or all enabled search servers. + * + * @param SearchApiServer|null $server + * (optional) The server whose tasks should be checked. If not given, the + * tasks for all enabled servers are checked. + * + * @return bool + * TRUE if all tasks (for the specific server, if $server was given) were + * executed successfully, or if there were no tasks. FALSE if there are still + * pending tasks. + */ +function search_api_server_tasks_check(?SearchApiServer $server = NULL) { + $select = db_select('search_api_task', 't') + ->fields('t') + // Only retrieve tasks we can handle. + ->condition('t.type', array('addIndex', 'fieldsUpdated', 'removeIndex', 'deleteItems')); + if ($server) { + $select->condition('t.server_id', $server->machine_name); + } + else { + $select->innerJoin('search_api_server', 's', 't.server_id = s.machine_name AND s.enabled = 1'); + // By ordering by the server, we can later just load them when we reach them + // while looping through the tasks. It is very unlikely there will be tasks + // for more than one or two servers, so a *_load_multiple() probably + // wouldn't bring any significant advantages, but complicate the code. + $select->orderBy('t.server_id'); + } + // Store a count query for later checking whether all tasks were processed + // successfully. + $count_query = $select->countQuery(); + + // Sometimes the order of tasks might be important, so make sure to order by + // the task ID (which should be in order of insertion). + $select->orderBy('t.id'); + // Only retrieve and execute 100 tasks at once, to avoid running out of memory + // or time. We just can't do anything else until all tasks have been resolved, + // but at least we shouldn't crash sites, or keep piling up tasks, that way. + $select->range(0, 100); + $tasks = $select->execute(); + + $executed_tasks = array(); + foreach ($tasks as $task) { + if (!$server || $server->machine_name != $task->server_id) { + $server = search_api_server_load($task->server_id); + if (!$server) { + continue; + } + } + switch ($task->type) { + case 'addIndex': + $index = search_api_index_load($task->index_id); + if ($index) { + $server->addIndex($index); + } + break; + + case 'fieldsUpdated': + $index = search_api_index_load($task->index_id); + if ($index) { + if ($task->data) { + $index->original = unserialize($task->data); + } + $server->fieldsUpdated($index); + } + break; + + case 'removeIndex': + $index = search_api_index_load($task->index_id); + if ($index) { + $server->removeIndex($index ? $index : $task->index_id); + } + break; + + case 'deleteItems': + $ids = $task->data ? unserialize($task->data) : 'all'; + $index = $task->index_id ? search_api_index_load($task->index_id) : NULL; + // Since a failed load returns (for stupid menu handler reasons) FALSE, + // not NULL, we have to make doubly sure here not to pass an invalid + // value (and cause a fatal error). + $index = $index ? $index : NULL; + $server->deleteItems($ids, $index); + break; + + default: + // This should never happen. + continue 2; + } + $executed_tasks[] = $task->id; + } + + // If there were no tasks (we recognized), return TRUE. + if (!$executed_tasks) { + return TRUE; + } + // Otherwise, delete the executed tasks and check if new tasks were created + // (or if we didn't even fetch all due to the 100 tasks limit). + search_api_server_tasks_delete($executed_tasks); + return $count_query->execute()->fetchField() === 0; +} + +/** + * Provides a batch wrapper for search_api_server_tasks_check(). + * + * @param SearchApiServer|null $server + * (optional) The server whose tasks should be executed, or NULL to execute + * tasks for all servers. + */ +function search_api_execute_pending_tasks(?SearchApiServer $server = NULL) { + batch_set(array( + 'title' => t('Processing pending tasks'), + 'operations' => array( + array( + 'search_api_execute_pending_tasks_batch', + array( + $server, + ), + ), + ), + 'finished' => 'search_api_execute_pending_tasks_finished', + )); + if ($server) { + $path = 'admin/config/search/search_api/server/' . $server->machine_name; + } + else { + $path = 'admin/config/search/search_api'; + } + + if (function_exists('drush_backend_batch_process')) { + drush_backend_batch_process(); + } + else { + batch_process($path); + } +} + +/** + * Executes pending server tasks as part of a batch operation. + */ +function search_api_execute_pending_tasks_batch(?SearchApiServer $server = NULL, &$context = array()) { + if (!isset($context['results']['total'])) { + $context['results']['total'] = search_api_server_tasks_count($server); + } + $total = $context['results']['total']; + + search_api_server_tasks_check($server); + + $remaining = search_api_server_tasks_count($server); + $executed = max($total - $remaining, 0); + + $args['@remaining'] = $remaining; + $context['message'] = format_plural($executed, 'Successfully executed @count task, @remaining remaining.', 'Successfully executed @count tasks, @remaining remaining.', $args); + $context['finished'] = $total > 0 ? $executed / $total : 1.0; +} + +/** + * Batch finish callback for pending server tasks. + */ +function search_api_execute_pending_tasks_finished($success, $results, $operations) { + if ($success) { + // Clear the previous warning. + backdrop_get_messages('warning'); + + // Alert user to the number of tasks executed. + backdrop_set_message(format_plural($results['total'], 'Successfully executed @count task.', 'Successfully executed @count tasks.')); + } +} + +/** + * Return the number of pending tasks. + * + * @param SearchApiServer|null $server + * (optional) The server for which tasks should be counted, or NULL to count + * for all enabled servers. + * + * @return int + * The number of pending tasks for the server, or in total. + */ +function search_api_server_tasks_count(?SearchApiServer $server = NULL) { + $query = db_select('search_api_task', 't') + ->fields('t'); + + if ($server) { + $query->condition('server_id', $server->machine_name); + } + else { + $query->join('search_api_server', 's', 's.machine_name = t.server_id'); + $query->condition('s.enabled', 1); + } + + return $query->countQuery()->execute()->fetchField(); +} + +/** + * Access callback: Checks whether a user can execute pending tasks. + * + * @param SearchApiServer|null $server + * (optional) The server for which tasks would be executed. + */ +function search_api_access_execute_tasks_batch(?SearchApiServer $server = NULL) { + return user_access('administer search_api') + && search_api_server_tasks_count($server) + && (!$server || $server->enabled); +} + +/** + * Adds an entry into a server's list of pending tasks. + * + * @param SearchApiServer $server + * The server for which a task should be remembered. + * @param $type + * The type of task to perform. + * @param SearchApiIndex|string|null $index + * (optional) If applicable, the index to which the task pertains (or its + * machine name). + * @param mixed $data + * (optional) If applicable, some further data necessary for the task. + */ +function search_api_server_tasks_add(SearchApiServer $server, $type, $index = NULL, $data = NULL) { + db_insert('search_api_task') + ->fields(array( + 'server_id' => $server->machine_name, + 'type' => $type, + 'index_id' => $index ? (is_object($index) ? $index->machine_name : $index) : NULL, + 'data' => isset($data) ? serialize($data) : NULL, + )) + ->execute(); +} + +/** + * Removes pending server tasks from the list. + * + * @param array|null $ids + * (optional) The IDs of the pending server tasks to delete. Set to NULL + * to not filter by IDs. + * @param SearchApiServer|null $server + * (optional) A server for which the tasks should be deleted. Set to NULL to + * delete tasks from all servers. + * @param SearchApiIndex|string|null $index + * (optional) An index (or its machine name) for which the tasks should be + * deleted. Set to NULL to delete tasks for all indexes. + */ +function search_api_server_tasks_delete(?array $ids = NULL, ?SearchApiServer $server = NULL, $index = NULL) { + $delete = db_delete('search_api_task'); + if ($ids) { + $delete->condition('id', $ids); + } + if ($server) { + $delete->condition('server_id', $server->machine_name); + } + if ($index) { + $delete->condition('index_id', $index->machine_name); + } + $delete->execute(); +} + +/** + * Recalculates the saved fields of an index. + * + * This is mostly necessary when the multiplicity of the underlying properties + * change. The method will re-examine the data structure of the entities in each + * index and, if a discrepancy is spotted, re-save that index with updated + * fields options (thus, of course, also triggering a re-indexing operation). + * + * @param SearchApiIndex[]|false $indexes + * An array of SearchApiIndex objects on which to perform the operation, or + * FALSE to perform it on all indexes. + */ +function search_api_index_recalculate_fields($indexes = FALSE) { + if (!is_array($indexes)) { + $indexes = search_api_index_load_multiple(FALSE); + } + $stored_keys = backdrop_map_assoc(array('type', 'entity_type', 'real_type', 'boost')); + foreach ($indexes as $index) { + if (empty($index->options['fields'])) { + continue; + } + // We have to clear the cache, both static and stored, before using + // getFields(). Otherwise, we'd just use the stale data which the fields + // options are probably already based on. + cache_clear_all($index->getCacheId() . '-1-0', 'cache'); + $index->resetCaches(); + // getFields() automatically uses the actual data types to correct possible + // stale data. + $fields = $index->getFields(); + foreach ($fields as $key => $field) { + $fields[$key] = array_intersect_key($field, $stored_keys); + if (isset($fields[$key]['boost']) && $fields[$key]['boost'] == '1.0') { + unset($fields[$key]['boost']); + } + } + // Use a more accurate method of determining if the fields settings are + // equal to avoid needlessly re-indexing the whole index. + if ($fields != $index->options['fields']) { + $options = $index->options; + $options['fields'] = $fields; + $index->update(array('options' => $options)); + } + } +} + +/** + * Test two setting arrays (or individual settings) for equality. + * + * @param mixed $setting1 + * The first setting (array). + * @param mixed $setting2 + * The second setting (array). + * + * @return bool + * TRUE if both settings are identical, FALSE otherwise. + * + * @deprecated The simple "==" operator will achieve the same. + */ +function _search_api_settings_equals($setting1, $setting2) { + if (!is_array($setting1) || !is_array($setting2)) { + return $setting1 == $setting2; + } + foreach ($setting1 as $key => $value) { + if (!array_key_exists($key, $setting2)) { + return FALSE; + } + if (!_search_api_settings_equals($value, $setting2[$key])) { + return FALSE; + } + unset($setting2[$key]); + } + // If any keys weren't unset previously, they are not present in $setting1 and + // the two are different. + return !$setting2; +} + +/** + * Indexes items for the specified index. + * + * Only items marked as changed are indexed, in their order of change (if + * known). + * + * @param SearchApiIndex $index + * The index on which items should be indexed. + * @param int $limit + * (optional) The number of items which should be indexed at most. Defaults to + * -1, which means that all changed items should be indexed. + * + * @return int + * Number of successfully indexed items. + * + * @throws SearchApiException + * If any error occurs during indexing. + */ +function search_api_index_items(SearchApiIndex $index, $limit = -1) { + // Don't try to index on read-only indexes. + if ($index->read_only) { + return 0; + } + + $ids = search_api_get_items_to_index($index, $limit); + return $ids ? count(search_api_index_specific_items($index, $ids)) : 0; +} + +/** + * Indexes the specified items on the given index. + * + * Items which were successfully indexed are marked as such afterwards. + * + * @param SearchApiIndex $index + * The index on which items should be indexed. + * @param array $ids + * The IDs of the items which should be indexed. + * + * @return array + * The IDs of all successfully indexed items. + * + * @throws SearchApiException + * If any error occurs during indexing. + */ +function search_api_index_specific_items(SearchApiIndex $index, array $ids) { + // Before doing anything else, check whether there are pending tasks that need + // to be executed on the server. It might be important that they are executed + // before any indexing occurs. + if (!search_api_server_tasks_check($index->server())) { + throw new SearchApiException(t('Could not index items since important pending server tasks could not be performed.')); + } + + $items = $index->loadItems($ids); + // Clone items because data alterations may alter them. + $cloned_items = array(); + foreach ($items as $id => $item) { + if (is_object($item)) { + $cloned_items[$id] = clone $item; + } + else { + // Normally, items that can't be loaded shouldn't be returned by + // entity_load_multiple (and other loadItems() implementations). Therefore, this is + // an extremely rare case, which seems to happen during installation for + // some specific setups. + $type = search_api_get_item_type_info($index->item_type); + $type = $type ? $type['name'] : $index->item_type; + watchdog('search_api', "Error during indexing: invalid item loaded for @type with ID @id.", array('@id' => $id, '@type' => $type), WATCHDOG_WARNING); + } + } + $indexed = $items ? $index->index($cloned_items) : array(); + if ($indexed) { + search_api_track_item_indexed($index, $indexed); + // If some items could not be indexed, we don't want to try re-indexing + // them right away, so we mark them as "freshly" changed. Sadly, there is + // no better way than to mark them as indexed first... + if (count($indexed) < count($ids)) { + // Believe it or not but this is actually quite faster than the equivalent + // $diff = array_diff($ids, $indexed);. + $diff = array_keys(array_diff_key(array_flip($ids), array_flip($indexed))); + $index->datasource()->trackItemIndexed($diff, $index); + $index->datasource()->trackItemChange($diff, array($index)); + } + } + + // When indexing via Drush, multiple iterations of a batch will happen in the + // same PHP process, so the static cache will quickly fill up. To prevent + // this, clear it after each batch of items gets indexed. + if (function_exists('drush_backend_batch_process') && batch_get()) { + foreach (array_keys(entity_get_info()) as $entity_type) { + entity_get_controller($entity_type)->resetCache(); + } + } + + return $indexed; +} + +/** + * Queues items for indexing at the end of the page request. + * + * @param SearchApiIndex $index + * The index on which items should be indexed. + * @param array $ids + * The IDs of the items which should be indexed. + * + * @return array + * The current contents of the queue, as a reference. + * + * @see search_api_index_specific_items() + * @see _search_api_index_queued_items() + */ +function &search_api_index_specific_items_delayed(?SearchApiIndex $index = NULL, array $ids = array()) { + // We cannot use backdrop_static() here because the static cache is reset during + // batch processing, which breaks batch handling. + static $queue = array(); + static $registered = FALSE; + + // Only register the shutdown function once. + if (empty($registered)) { + // Instead of registering the shutdown function directly, do it in a way + // that ensures it will run last. This helps avoid issues with other + // modules' shutdown functions, especially workbench_moderation_store(). + backdrop_register_shutdown_function('backdrop_register_shutdown_function', '_search_api_index_queued_items'); + $registered = TRUE; + } + + // Allow for empty call to just retrieve the queue. + if ($index && $ids) { + $index_id = $index->machine_name; + $queue += array($index_id => array()); + $queue[$index_id] += backdrop_map_assoc($ids); + } + + return $queue; +} + +/** + * Returns a list of items that need to be indexed for the specified index. + * + * @param SearchApiIndex $index + * The index for which items should be retrieved. + * @param $limit + * The maximum number of items to retrieve. -1 means no limit. + * + * @return array + * An array of IDs of items that need to be indexed. + */ +function search_api_get_items_to_index(SearchApiIndex $index, $limit = -1) { + if ($limit == 0) { + return array(); + } + return $index->datasource()->getChangedItems($index, $limit); +} + +/** + * Creates a search query on a specified search index. + * + * @param $id + * The ID or machine name of the index to execute the search on. + * @param $options + * An associative array of options to be passed to + * SearchApiQueryInterface::__construct(). + * + * @return SearchApiQueryInterface + * An object for searching on the specified index. + * + * @throws SearchApiException + * If the index is unknown or disabled, or some other error was encountered. + */ +function search_api_query($id, array $options = array()) { + $index = search_api_index_load($id); + if (!$index) { + throw new SearchApiException(t('Unknown index with ID @id.', array('@id' => $id))); + } + return $index->query($options); +} + +/** + * Stores or retrieves a search executed in this page request. + * + * Static storage for the searches executed during the current page request. Can + * used to store an executed search, or to retrieve a previously stored search. + * + * @param $search_id + * For pages displaying multiple searches, an optional ID identifying the + * search in questions. When storing a search, this is filled automatically, + * unless it is manually set. + * @param SearchApiQuery $query + * When storing an executed search, the query that was executed. NULL + * otherwise. + * @param array $results + * When storing an executed search, the returned results as specified by + * SearchApiQueryInterface::execute(). An empty array, otherwise. + * + * @return array + * If a search with the specified ID was executed, an array containing + * ($query, $results) as used in this function's parameters. If $search_id is + * NULL, an array of all executed searches will be returned, keyed by ID. + */ +function search_api_current_search($search_id = NULL, ?SearchApiQuery $query = NULL, array $results = array()) { + $searches = &backdrop_static(__FUNCTION__, array()); + + if (isset($query)) { + if (!isset($search_id)) { + $search_id = $query->getOption('search id'); + } + $base = $search_id; + $i = 0; + while (isset($searches[$search_id])) { + $search_id = $base . '-' . ++$i; + } + $searches[$search_id] = array($query, $results); + } + + if (isset($search_id)) { + return isset($searches[$search_id]) ? $searches[$search_id] : NULL; + } + return $searches; +} + +/** + * Returns all field types recognized by the Search API framework. + * + * @return array + * An associative array with all recognized types as keys, mapped to their + * translated display names. + * + * @see search_api_default_field_types() + * @see search_api_get_data_type_info() + */ +function search_api_field_types() { + $types = search_api_default_field_types(); + foreach (search_api_get_data_type_info() as $id => $type) { + $types[$id] = $type['name']; + } + return $types; +} + +/** + * Returns the default field types recognized by the Search API framework. + * + * @return array + * An associative array with the default types as keys, mapped to their + * translated display names. + */ +function search_api_default_field_types() { + return array( + 'text' => t('Fulltext'), + 'string' => t('String'), + 'integer' => t('Integer'), + 'decimal' => t('Decimal'), + 'date' => t('Date'), + 'duration' => t('Duration'), + 'boolean' => t('Boolean'), + 'uri' => t('URI'), + ); +} + +/** + * Returns either all custom field type definitions, or a specific one. + * + * @param $type + * If specified, the type whose definition should be returned. + * + * @return array + * If $type was not given, an array containing all custom data types, in the + * format specified by hook_search_api_data_type_info(). + * Otherwise, the definition for the given type, or NULL if it is unknown. + * + * @see hook_search_api_data_type_info() + */ +function search_api_get_data_type_info($type = NULL) { + $types = &backdrop_static(__FUNCTION__); + if (!isset($types)) { + $default_types = search_api_default_field_types(); + $types = module_invoke_all('search_api_data_type_info'); + $types = $types ? $types : array(); + foreach ($types as &$type_info) { + if (!isset($type_info['fallback']) || !isset($default_types[$type_info['fallback']])) { + $type_info['fallback'] = 'string'; + } + } + backdrop_alter('search_api_data_type_info', $types); + } + if (isset($type)) { + return isset($types[$type]) ? $types[$type] : NULL; + } + return $types; +} + +/** + * Returns either a list of all available service infos, or a specific one. + * + * @see hook_search_api_service_info() + * + * @param string|null $id + * The ID of the service info to retrieve. + * + * @return array + * If $id was not specified, an array of all available service classes. + * Otherwise, either the service info with the specified id (if it exists), + * or NULL. Service class information is formatted as specified by + * hook_search_api_service_info(), with the addition of a "module" key + * specifying the module that adds a certain class. + */ +function search_api_get_service_info($id = NULL) { + $services = &backdrop_static(__FUNCTION__); + + if (!isset($services)) { + // Inlined version of module_invoke_all() to add "module" keys. + $services = array(); + foreach (module_implements('search_api_service_info') as $module) { + $function = $module . '_search_api_service_info'; + if (function_exists($function)) { + $new_services = $function(); + if (isset($new_services) && is_array($new_services)) { + foreach ($new_services as $service => $info) { + $new_services[$service] += array('module' => $module); + } + } + $services += $new_services; + } + } + + // Same for backdrop_alter(). + foreach (module_implements('search_api_service_info_alter') as $module) { + $function = $module . '_search_api_service_info_alter'; + if (function_exists($function)) { + $old = $services; + $function($services); + if ($new_services = array_diff_key($services, $old)) { + foreach ($new_services as $service => $info) { + $services[$service] += array('module' => $module); + } + } + } + } + } + + if (isset($id)) { + return isset($services[$id]) ? $services[$id] : NULL; + } + return $services; +} + +/** + * Returns information for either all item types, or a specific one. + * + * @param string|null $type + * If set, the item type whose information should be returned. + * + * @return array|null + * If $type is given, either an array containing the information of that item + * type, or NULL if it is unknown. Otherwise, an array keyed by type IDs + * containing the information for all item types. Item type information is + * formatted as specified by hook_search_api_item_type_info(), with the + * addition of a "module" key specifying the module that adds a certain type. + * + * @see hook_search_api_item_type_info() + */ +function search_api_get_item_type_info($type = NULL) { + $types = &backdrop_static(__FUNCTION__); + + if (!isset($types)) { + // Inlined version of module_invoke_all() to add "module" keys. + $types = array(); + foreach (module_implements('search_api_item_type_info') as $module) { + $function = $module . '_search_api_item_type_info'; + if (function_exists($function)) { + $new_types = $function(); + if (isset($new_types) && is_array($new_types)) { + foreach ($new_types as $id => $info) { + $new_types[$id] += array('module' => $module); + } + } + $types += $new_types; + } + } + + // Same for backdrop_alter(). + foreach (module_implements('search_api_item_type_info_alter') as $module) { + $function = $module . '_search_api_item_type_info_alter'; + if (function_exists($function)) { + $old = $types; + $function($types); + if ($new_types = array_diff_key($types, $old)) { + foreach ($new_types as $id => $info) { + $types[$id] += array('module' => $module); + } + } + } + } + } + + if (isset($type)) { + return isset($types[$type]) ? $types[$type] : NULL; + } + return $types; +} + +/** + * Get a data source controller object for the specified type. + * + * @param $type + * The type whose data source controller should be returned. + * + * @return SearchApiDataSourceControllerInterface + * The type's data source controller. + * + * @throws SearchApiException + * If the type is unknown or specifies an invalid data source controller. + */ +function search_api_get_datasource_controller($type) { + $datasources = &backdrop_static(__FUNCTION__, array()); + if (empty($datasources[$type])) { + $info = search_api_get_item_type_info($type); + if (isset($info['datasource controller']) && class_exists($info['datasource controller'])) { + $datasources[$type] = new $info['datasource controller']($type); + } + if (empty($datasources[$type]) || !($datasources[$type] instanceof SearchApiDataSourceControllerInterface)) { + unset($datasources[$type]); + throw new SearchApiException(t('Unknown or invalid item type @type.', array('@type' => $type))); + } + } + return $datasources[$type]; +} + +/** + * Returns a list of all available data alter callbacks. + * + * @see hook_search_api_alter_callback_info() + * + * @return array + * An array of all available data alter callbacks, keyed by function name. + */ +function search_api_get_alter_callbacks() { + $callbacks = &backdrop_static(__FUNCTION__); + + if (!isset($callbacks)) { + $callbacks = module_invoke_all('search_api_alter_callback_info'); + + // Fill optional settings with default values. + foreach ($callbacks as $id => $callback) { + $callbacks[$id] += array('weight' => 0); + } + + // Invoke alter hook. + backdrop_alter('search_api_alter_callback_info', $callbacks); + } + + return $callbacks; +} + +/** + * Returns a list of all available pre- and post-processors. + * + * @see hook_search_api_processor_info() + * + * @return array + * An array of all available processors, keyed by id. + */ +function search_api_get_processors() { + $processors = &backdrop_static(__FUNCTION__); + + if (!isset($processors)) { + $processors = module_invoke_all('search_api_processor_info'); + + // Fill optional settings with default values. + foreach ($processors as $id => $processor) { + $processors[$id] += array('weight' => 0); + } + + // Invoke alter hook. + backdrop_alter('search_api_processor_info', $processors); + } + + return $processors; +} + +/** + * Implements hook_search_api_query_alter(). + * + * Adds node access to the query, if enabled. + * + * @param SearchApiQueryInterface $query + * The SearchApiQueryInterface object representing the search query. + */ +function search_api_search_api_query_alter(SearchApiQueryInterface $query) { + global $user; + $index = $query->getIndex(); + // Only add node access if the necessary fields are indexed in the index, and + // unless disabled explicitly by the query. + $type = $index->getEntityType(); + if (!empty($index->options['data_alter_callbacks']["search_api_alter_{$type}_access"]['status']) && !$query->getOption('search_api_bypass_access')) { + $account = $query->getOption('search_api_access_account', $user); + if (is_numeric($account)) { + $account = user_load($account); + } + if (is_object($account)) { + try { + _search_api_query_add_node_access($account, $query, $type); + } + catch (SearchApiException $e) { + watchdog_exception('search_api', $e); + } + } + else { + $account = $query->getOption('search_api_access_account', '(' . t('none') . ')'); + if (is_object($account)) { + $account = $account->uid; + } + if (!is_scalar($account)) { + $account = var_export($account, TRUE); + } + watchdog('search_api', 'An illegal user UID was given for node access: @uid.', array('@uid' => $account), WATCHDOG_WARNING); + } + } +} + +/** + * Adds a node access filter to a search query, if applicable. + * + * @param object $account + * The user object, who searches. + * @param SearchApiQueryInterface $query + * The query to which a node access filter should be added, if applicable. + * @param string $type + * (optional) The type of search – either "node" or "comment". Defaults to + * "node". + * + * @throws SearchApiException + * If not all necessary fields are indexed on the index. + */ +function _search_api_query_add_node_access($account, SearchApiQueryInterface $query, $type = 'node') { + // Don't do anything if the user can access all content. + if (user_access('bypass node access', $account)) { + return; + } + + $is_comment = ($type == 'comment'); + + // Check whether the necessary fields are indexed. + $fields = $query->getIndex()->options['fields']; + $required = array('search_api_access_node', 'status'); + if (!$is_comment) { + $required[] = 'author'; + } + foreach ($required as $field) { + if (empty($fields[$field])) { + $vars['@field'] = $field; + $vars['@index'] = $query->getIndex()->name; + throw new SearchApiException(t('Required field @field not indexed on index @index. Could not perform access checks.', $vars)); + } + } + + // If the user cannot access content/comments at all, return no results. + if (!user_access('access content', $account) || ($is_comment && !user_access('access comments', $account))) { + // Simple hack for returning no results. + $query->condition('status', 0); + $query->condition('status', 1); + watchdog('search_api', 'User @name tried to execute a search, but cannot access content.', array('@name' => theme('username', array('account' => $account))), WATCHDOG_NOTICE); + return; + } + + // Filter by the "published" status. + $published = $is_comment ? COMMENT_PUBLISHED : NODE_PUBLISHED; + if (!$is_comment && user_access('view own unpublished content')) { + $filter = $query->createFilter('OR'); + $filter->condition('status', $published); + $filter->condition('author', $account->uid); + $query->filter($filter); + } + else { + $query->condition('status', $published); + } + + // Filter by node access grants. + $filter = $query->createFilter('OR'); + $grants = node_access_grants('view', $account); + foreach ($grants as $realm => $gids) { + foreach ($gids as $gid) { + $filter->condition('search_api_access_node', "node_access_$realm:$gid"); + } + } + $filter->condition('search_api_access_node', 'node_access__all'); + $query->filter($filter); +} + +/** + * Determines whether a field of the given type contains text data. + * + * Can also be used to find other types. + * + * @param string $type + * The type for which to check. + * @param array $allowed + * Optionally, an array of allowed types. + * + * @return bool + * TRUE if $type is either one of the specified types or a list of such + * values. FALSE otherwise. + * + * @see search_api_extract_inner_type() + */ +function search_api_is_text_type($type, array $allowed = array('text')) { + return array_search(search_api_extract_inner_type($type), $allowed) !== FALSE; +} + +/** + * Utility function for determining whether a field of the given type contains + * a list of any kind. + * + * @param $type + * A string containing the type to check. + * + * @return bool + * TRUE iff $type is a list type ("list<*>"). + */ +function search_api_is_list_type($type) { + return substr($type, 0, 5) == 'list<'; +} + +/** + * Utility function for determining the nesting level of a list type. + * + * @param $type + * A string containing the type to check. + * + * @return int + * The nesting level of the type. 0 for singular types, 1 for lists of + * singular types, etc. + */ +function search_api_list_nesting_level($type) { + $level = 0; + while (search_api_is_list_type($type)) { + $type = substr($type, 5, -1); + ++$level; + } + return $level; +} + +/** + * Utility function for nesting a type to the same level as another type. + * I.e., after
$t = search_api_nest_type($type, $nested_type); is
+ * executed, the following statements will always be true:
+ * @code
+ * search_api_list_nesting_level($t) == search_api_list_nesting_level($nested_type);
+ * search_api_extract_inner_type($t) == search_api_extract_inner_type($type);
+ * @endcode
+ *
+ * @param $type
+ * The type to wrap.
+ * @param $nested_type
+ * Another type, determining the nesting level.
+ *
+ * @return string
+ * A list version of $type, as specified above.
+ */
+function search_api_nest_type($type, $nested_type) {
+ while (search_api_is_list_type($nested_type)) {
+ $nested_type = substr($nested_type, 5, -1);
+ $type = "list<$type>";
+ }
+ return $type;
+}
+
+/**
+ * Utility function for extracting the contained primitive type of a list type.
+ *
+ * @param $type
+ * A string containing the list type to process.
+ *
+ * @return string
+ * A string containing the primitive type contained within the list, e.g.
+ * "text" for "listHeader
+How to write links to other sites: <a href="URL" title="MOUSEOVER TEXT">TEXT</a>. +< signs can be escaped with "<". +
+END;
+ $tags = <<Index items using multiple database tables, for simple searches.
' . + '- ' . '
- All field types are supported and indexed in a special way, with URI/String and Integer/Duration being equivalent. ' . + '
- The "direct" parse mode results in the keys being normally split around white-space, only preprocessing might differ. ' . + '
- Currently, phrase queries are not supported. ' . '
' . + 'Database search servers currently cannot index such words correctly – the word was therefore trimmed to the allowed length.', + array('%word' => $word), WATCHDOG_WARNING); + $word = backdrop_substr($word, 0, 50); + } + $tokens[] = array( + 'value' => $word, + 'score' => $score, + ); + } + array_splice($value, $i, 1, $tokens); + continue 2; + } + } + break; + } + return $value; + + case 'string': + case 'uri': + // For non-dates, PHP can handle this well enough. + if ($original_type == 'date') { + return date('c', $value); + } + if (backdrop_strlen($value) > 255) { + $value = backdrop_substr($value, 0, 255); + watchdog('search_api_db', 'An overlong value (more than 255 characters) was encountered while indexing: %value.
' . + 'Database search servers currently cannot index such values correctly – the value was therefore trimmed to the allowed length.', + array('%value' => $value), WATCHDOG_WARNING); + } + return $value; + + case 'integer': + case 'duration': + case 'decimal': + return 0 + $value; + + case 'boolean': + // Numeric strings need to be converted to a numeric type before + // converting to a boolean, as strings like '0.00' evaluate to TRUE. + if (is_string($value) && is_numeric($value)) { + $value = 0 + $value; + } + return $value ? 1 : 0; + + case 'date': + if (is_numeric($value) || !$value) { + return 0 + $value; + } + return strtotime($value); + + default: + throw new SearchApiException(t('Unknown field type @type. Database search module might be out of sync with Search API.', array('@type' => $type))); + } + } + + /** + * {@inheritdoc} + */ + public function deleteItems($ids = 'all', ?SearchApiIndex $index = NULL) { + try { + if (!$index) { + if (empty($this->options['indexes'])) { + return; + } + $truncated = array(); + foreach ($this->options['indexes'] as $fields) { + foreach ($fields as $field) { + if (isset($field['table']) && !isset($truncated[$field['table']])) { + $this->connection->truncate($field['table'])->execute(); + $truncated[$field['table']] = TRUE; + } + } + } + return; + } + + if (empty($this->options['indexes'][$index->machine_name])) { + return; + } + foreach ($this->options['indexes'][$index->machine_name] as $field) { + if (is_array($ids)) { + $this->connection->delete($field['table']) + ->condition('item_id', $ids, 'IN') + ->execute(); + } + else { + $this->connection->truncate($field['table'])->execute(); + } + } + } + // The database operations might throw PDO or other exceptions, so we catch + // them all and re-wrap them appropriately. + catch (Exception $e) { + throw new SearchApiException($e->getMessage()); + } + } + + /** + * {@inheritdoc} + */ + public function search(SearchApiQueryInterface $query) { + $time_method_called = microtime(TRUE); + $this->ignored = $this->warnings = array(); + $this->aliasCounter = 0; + $index = $query->getIndex(); + if (empty($this->options['indexes'][$index->machine_name])) { + throw new SearchApiException(t('Unknown index @id.', array('@id' => $index->machine_name))); + } + $fields = $this->getFieldInfo($index); + + $db_query = $this->createDbQuery($query, $fields); + + $time_processing_done = microtime(TRUE); + $results = array( + 'results' => array(), + ); + + $skip_count = $query->getOption('skip result count'); + if (!$skip_count) { + $count_query = $db_query->countQuery(); + $results['result count'] = $count_query->execute()->fetchField(); + } + + if ($skip_count || $results['result count']) { + if ($query->getOption('search_api_facets')) { + $results['search_api_facets'] = $this->getFacets($query, clone $db_query); + } + + $query_options = $query->getOptions(); + if (isset($query_options['offset']) || isset($query_options['limit'])) { + $offset = isset($query_options['offset']) ? $query_options['offset'] : 0; + $limit = isset($query_options['limit']) ? $query_options['limit'] : 1000000; + $db_query->range($offset, $limit); + } + + $this->setQuerySort($query, $db_query, $fields); + + $result = $db_query->execute(); + + foreach ($result as $row) { + $results['results'][$row->item_id] = array( + 'id' => $row->item_id, + 'score' => $row->score / self::SCORE_MULTIPLIER, + ); + } + if ($skip_count) { + $results['result count'] = !empty($results['results']); + } + } + $time_queries_done = microtime(TRUE); + + $results['warnings'] = array_keys($this->warnings); + $results['ignored'] = array_keys($this->ignored); + + $this->postQuery($results, $query); + + $time_end = microtime(TRUE); + $results['performance'] = array( + 'complete' => $time_end - $time_method_called, + 'preprocessing' => $time_processing_done - $time_method_called, + 'execution' => $time_queries_done - $time_processing_done, + 'postprocessing' => $time_end - $time_queries_done, + ); + + return $results; + } + + /** + * Creates a database query for a search. + * + * Used as a helper method in search() and getAutocompleteSuggestions(). + * + * @param SearchApiQueryInterface $query + * The search query for which to create the database query. + * + * @param array $fields + * The internal field information to use. + * + * @return SelectQuery + * A database query object which will return the appropriate results (except + * for the range setting) for the given search query. + * + * @throws SearchApiException + * If some illegal query setting (unknown field, etc.) was encountered. + */ + protected function createDbQuery(SearchApiQueryInterface $query, array $fields) { + $keys = &$query->getKeys(); + $keys_set = (boolean) $keys; + $tokenizer_active = static::isTokenizerActive($query->getIndex()); + $keys = $this->prepareKeys($keys, $tokenizer_active); + // Special case: if the outermost $keys array has "#negation" set, we can't + // handle it like other negated subkeys. To avoid additional complexity + // later, we just wrap $keys so it becomes a subkey. + if (!empty($keys['#negation'])) { + $keys = array( + '#conjunction' => 'AND', $keys, + ); + } + // Only filter by fulltext keys if there are any real keys present. + if ($keys && (!is_array($keys) || count($keys) > 2 || (!isset($keys['#negation']) && count($keys) > 1))) { + $fulltext_fields = $query->getFields(); + if ($fulltext_fields) { + $_fulltext_fields = $fulltext_fields; + $fulltext_fields = array(); + foreach ($_fulltext_fields as $name) { + if (!isset($fields[$name])) { + throw new SearchApiException(t('Unknown field @field specified as search target.', array('@field' => $name))); + } + if (!search_api_is_text_type($fields[$name]['type'])) { + $types = search_api_field_types(); + $type = $types[$fields[$name]['type']]; + throw new SearchApiException(t('Cannot perform fulltext search on field @field of type @type.', array('@field' => $name, '@type' => $type))); + } + $fulltext_fields[$name] = $fields[$name]; + } + + $db_query = $this->createKeysQuery($keys, $fulltext_fields, $fields); + if (is_array($keys) && !empty($keys['#negation'])) { + $db_query->addExpression(':score', 'score', array(':score' => self::SCORE_MULTIPLIER)); + $db_query->distinct(); + } + } + else { + $msg = t('Search keys are given but no fulltext fields are defined.'); + watchdog('search_api_db', $msg, NULL, WATCHDOG_WARNING); + $this->warnings[$msg] = 1; + } + } + elseif ($keys_set) { + $msg = t('No valid search keys were present in the query.'); + $this->warnings[$msg] = 1; + } + + if (!isset($db_query)) { + $db_query = $this->connection->select($fields['search_api_language']['table'], 't'); + $db_query->addField('t', 'item_id', 'item_id'); + $db_query->addExpression(':score', 'score', array(':score' => self::SCORE_MULTIPLIER)); + $db_query->distinct(); + } + + $filter = $query->getFilter(); + if ($filter->getFilters()) { + $condition = $this->createFilterCondition($filter, $fields, $db_query, $query->getIndex()); + if ($condition) { + $db_query->condition($condition); + } + } + + $db_query->addTag('search_api_db_search'); + $db_query->addMetaData('search_api_query', $query); + $db_query->addMetaData('search_api_db_fields', $fields); + + // Allow subclasses and other modules to alter the query. + backdrop_alter('search_api_db_query', $db_query, $query); + $this->preQuery($db_query, $query); + + return $db_query; + } + + /** + * Removes nested expressions and phrase groupings from the search keys. + * + * Used as a helper method in createDbQuery() and createFilterCondition(). + * + * @param array|string|null $keys + * The keys which should be preprocessed. + * @param bool $tokenizer_active + * (optional) TRUE if we can rely on the "Tokenizer" processor already + * having preprocessed the keywords. + * + * @return array|string|null + * The preprocessed keys. + */ + protected function prepareKeys($keys, $tokenizer_active = FALSE) { + if (is_scalar($keys)) { + $keys = $this->splitKeys($keys, $tokenizer_active); + return is_array($keys) ? $this->eliminateDuplicates($keys) : $keys; + } + elseif (!$keys) { + return NULL; + } + $keys = $this->splitKeys($keys, $tokenizer_active); + $keys = $this->eliminateDuplicates($keys); + $conj = $keys['#conjunction']; + $neg = !empty($keys['#negation']); + foreach ($keys as $i => &$nested) { + if (is_array($nested)) { + $nested = $this->prepareKeys($nested, $tokenizer_active); + if (is_array($nested) && $neg == !empty($nested['#negation'])) { + if ($nested['#conjunction'] == $conj) { + unset($nested['#conjunction'], $nested['#negation']); + foreach ($nested as $renested) { + $keys[] = $renested; + } + unset($keys[$i]); + } + } + } + } + $keys = array_filter($keys); + if (($count = count($keys)) <= 2) { + if ($count < 2 || isset($keys['#negation'])) { + $keys = NULL; + } + else { + unset($keys['#conjunction']); + $keys = reset($keys); + } + } + return $keys; + } + + /** + * Splits a keyword expression into separate words. + * + * Used as a helper method in prepareKeys(). + * + * @param array|string|null $keys + * The keys to split. + * @param bool $tokenizer_active + * (optional) TRUE if we can rely on the "Tokenizer" processor already + * having preprocessed the keywords. + * + * @return array|string|null + * The keys split into separate words. + */ + protected function splitKeys($keys, $tokenizer_active = FALSE) { + if (is_scalar($keys)) { + $proc = backdrop_strtolower(trim($keys)); + if (is_numeric($proc)) { + return ltrim($proc, '-0'); + } + elseif (backdrop_strlen($proc) < $this->options['min_chars']) { + $this->ignored[$keys] = 1; + return NULL; + } + + if ($tokenizer_active) { + $words = array_filter(explode(' ', $proc), 'strlen'); + } + else { + $words = preg_split('/[^\p{L}\p{N}]+/u', $proc, -1, PREG_SPLIT_NO_EMPTY); + } + + if (count($words) > 1) { + $proc = $this->splitKeys($words, $tokenizer_active); + if ($proc) { + $proc['#conjunction'] = 'AND'; + } + else { + $proc = NULL; + } + } + return $proc; + } + foreach ($keys as $i => $key) { + if (element_child($i)) { + $keys[$i] = $this->splitKeys($key, $tokenizer_active); + } + } + return array_filter($keys); + } + + /** + * Eliminates duplicate keys from a keyword array. + * + * Used as a helper method in prepareKeys(). + * + * @param array $keys + * The keywords to parse. + * @param array $words + * (optional) A cache of all encountered words so far, used internally for + * recursive invocations. + * + * @return array + * The processed keywords. + */ + protected function eliminateDuplicates($keys, &$words = array()) { + foreach ($keys as $i => $word) { + if (!element_child($i)) { + continue; + } + if (is_scalar($word)) { + if (isset($words[$word])) { + unset($keys[$i]); + } + else { + $words[$word] = TRUE; + } + } + else { + $keys[$i] = $this->eliminateDuplicates($word, $words); + } + } + return $keys; + } + + /** + * Creates a SELECT query for given search keys. + * + * Used as a helper method in createDbQuery() and createFilterCondition(). + * + * @param $keys + * The search keys, formatted like the return value of + * SearchApiQueryInterface::getKeys(), but preprocessed according to + * internal requirements. + * @param array $fields + * The fulltext fields on which to search, with their names as keys mapped + * to internal information about them. + * @param array $all_fields + * Internal information about all indexed fields on the index. + * + * @return SelectQueryInterface + * A SELECT query returning item_id and score (or only item_id, if + * $keys['#negation'] is set). + */ + protected function createKeysQuery($keys, array $fields, array $all_fields) { + if (!is_array($keys)) { + $keys = array( + '#conjunction' => 'AND', $keys, + ); + } + + $neg = !empty($keys['#negation']); + $conj = $keys['#conjunction']; + $words = array(); + $nested = array(); + $negated = array(); + $db_query = NULL; + $word_hits = array(); + $neg_nested = $neg && $conj == 'AND'; + + foreach ($keys as $i => $key) { + if (!element_child($i)) { + continue; + } + if (is_scalar($key)) { + $words[] = $key; + } + elseif (empty($key['#negation'])) { + if ($neg) { + // If this query is negated, we also only need item_ids from + // subqueries. + $key['#negation'] = TRUE; + } + $nested[] = $key; + } + else { + $negated[] = $key; + } + } + $subs = count($words) + count($nested); + $mul_words = count($words) > 1; + $not_nested = ($subs <= 1 && !$mul_words) || ($neg && $conj == 'OR' && !$negated); + + if ($words) { + // All text fields in the index share a table. Get name from the first. + $field = reset($fields); + $db_query = $this->connection->select($field['table'], 't'); + if ($neg_nested) { + $db_query->fields('t', array('item_id', 'word')); + } + elseif ($neg) { + $db_query->fields('t', array('item_id')); + } + elseif ($not_nested) { + $db_query->fields('t', array('item_id')); + $db_query->addExpression('SUM(score)', 'score'); + $db_query->groupBy('t.item_id'); + } + else { + $db_query->fields('t', array('item_id', 'word')); + $db_query->addExpression('SUM(score)', 'score'); + $db_query->groupBy('t.item_id'); + $db_query->groupBy('t.word'); + } + + if (empty($this->options['partial_matches'])) { + $db_query->condition('word', $words, 'IN'); + } + else { + $db_or = db_or(); + // GROUP BY all existing non-grouped, non-aggregated columns – except + // "word", which we remove since it will be useless to us in this case. + $columns = &$db_query->getFields(); + unset($columns['word']); + foreach ($columns as $column => $info) { + $db_query->groupBy($info['table'] . '.' . $column); + } + + foreach ($words as $word) { + $like = '%' . $this->connection->escapeLike($word) . '%'; + $db_or->condition('t.word', $like, 'LIKE'); + + // Add an expression for each keyword that shows whether the indexed + // word matches that particular keyword. That way we don't return a + // result multiple times if a single indexed word (partially) matches + // multiple keywords. We also remember the column name so we can + // afterwards verify that each word matched at least once. + $alias = 'w' . $this->aliasCounter++; + $alias = $db_query->addExpression("CASE WHEN t.word LIKE :like_$alias THEN 1 ELSE 0 END", $alias, array(":like_$alias" => $like)); + $db_query->groupBy($alias); + $word_hits[] = $alias; + } + $db_query->condition($db_or); + } + $db_query->condition('field_name', array_map(array(__CLASS__, 'getTextFieldName'), array_keys($fields)), 'IN'); + } + + if ($nested) { + $word = ''; + foreach ($nested as $k) { + $query = $this->createKeysQuery($k, $fields, $all_fields); + if (!$neg) { + $word .= ' '; + $var = ':word' . strlen($word); + $query->addExpression($var, 'word', array($var => $word)); + } + if (!isset($db_query)) { + $db_query = $query; + } + elseif ($not_nested) { + $db_query->union($query, 'UNION'); + } + else { + $db_query->union($query, 'UNION ALL'); + } + } + } + + if (isset($db_query) && !$not_nested) { + $db_query = $this->connection->select($db_query, 't'); + $db_query->addField('t', 'item_id', 'item_id'); + if (!$neg) { + $db_query->addExpression('SUM(t.score)', 'score'); + $db_query->groupBy('t.item_id'); + } + if ($conj == 'AND' && $subs > 1) { + $var = ':subs' . ((int) $subs); + if (!$db_query->getGroupBy()) { + $db_query->groupBy('t.item_id'); + } + if ($word_hits) { + // Simply check whether each word matched at least once. + foreach ($word_hits as $column) { + $db_query->having("SUM($column) >= 1"); + } + } + elseif ($mul_words) { + $db_query->having('COUNT(DISTINCT t.word) >= ' . $var, array($var => $subs)); + } + else { + $db_query->having('COUNT(t.word) >= ' . $var, array($var => $subs)); + } + } + } + + if ($negated) { + if (!isset($db_query) || $conj == 'OR') { + if (isset($db_query)) { + // We are in a rather bizarre case where the keys are something like + // "a OR (NOT b)". + $old_query = $db_query; + } + // We use this table because all items should be contained exactly once. + $db_query = $this->connection->select($all_fields['search_api_language']['table'], 't'); + $db_query->addField('t', 'item_id', 'item_id'); + if (!$neg) { + $db_query->addExpression(':score', 'score', array(':score' => self::SCORE_MULTIPLIER)); + $db_query->distinct(); + } + } + + if ($conj == 'AND') { + foreach ($negated as $k) { + $db_query->condition('t.item_id', $this->createKeysQuery($k, $fields, $all_fields), 'NOT IN'); + } + } + else { + $or = db_or(); + foreach ($negated as $k) { + $or->condition('t.item_id', $this->createKeysQuery($k, $fields, $all_fields), 'NOT IN'); + } + if (isset($old_query)) { + $or->condition('t.item_id', $old_query, 'NOT IN'); + } + $db_query->condition($or); + } + } + + if ($neg_nested) { + $db_query = $this->connection->select($db_query, 't')->fields('t', array('item_id')); + } + + return $db_query; + } + + /** + * Creates a database query condition for a given search filter. + * + * Used as a helper method in createDbQuery(). + * + * @param SearchApiQueryFilterInterface $filter + * The filter for which a condition should be created. + * @param array $fields + * Internal information about the index's fields. + * @param SelectQueryInterface $db_query + * The database query to which the condition will be added. + * @param ?SearchApiIndex $index + * (optional) The search index whose settings should be used. + * + * @return DatabaseCondition|null + * The condition to set on the query, or NULL if none is necessary. + * + * @throws SearchApiException + * If an unknown field was used in the filter. + */ + protected function createFilterCondition(SearchApiQueryFilterInterface $filter, array $fields, SelectQueryInterface $db_query, ?SearchApiIndex $index = NULL) { + $cond = db_condition($filter->getConjunction()); + // Store whether a JOIN already occurred for a field, so we don't JOIN + // repeatedly for OR filters. + $first_join = array(); + // Store the table aliases for the fields in this condition group. + $tables = array(); + foreach ($filter->getFilters() as $f) { + if (is_object($f)) { + $c = $this->createFilterCondition($f, $fields, $db_query, $index); + if ($c) { + $cond->condition($c); + } + } + else { + list($field, $value, $operator) = $f; + if (!isset($fields[$field])) { + throw new SearchApiException(t('Unknown field in filter clause: @field.', array('@field' => $field))); + } + $field_info = $fields[$field]; + $not_between = $operator === 'NOT BETWEEN'; + $not_equals = $not_between || $operator === '<>' || $operator === '!='; + $text_type = search_api_is_text_type($field_info['type']); + // If the field is in its own table, we have to check for NULL values in + // a special way (i.e., check for missing entries in that table). + if ($value === NULL && ($field_info['column'] === 'value' || $text_type)) { + $query = $this->connection->select($field_info['table'], 't') + ->fields('t', array('item_id')); + if ($text_type) { + $query->condition('t.field_name', $field); + } + $cond->condition('t.item_id', $query, $not_equals ? 'IN' : 'NOT IN'); + continue; + } + if ($text_type) { + if (!isset($tokenizer_active)) { + $tokenizer_active = $index && static::isTokenizerActive($index); + } + $keys = $this->prepareKeys($value, $tokenizer_active); + if (!isset($keys)) { + continue; + } + $query = $this->createKeysQuery($keys, array($field => $field_info), $fields); + // We only want the item IDs, so we use the keys query as a nested query. + $query = $this->connection->select($query, 't')->fields('t', array('item_id')); + $cond->condition('t.item_id', $query, $not_equals ? 'NOT IN' : 'IN'); + } + else { + $new_join = search_api_is_list_type($field_info['type']) + && ($filter->getConjunction() == 'AND' + || empty($first_join[$field])); + if ($new_join || empty($tables[$field])) { + $tables[$field] = $this->getTableAlias($field_info, $db_query, $new_join); + $first_join[$field] = TRUE; + } + $column = $tables[$field] . '.' . $field_info['column']; + if ($value === NULL) { + $method = ($operator == '=') ? 'isNull' : 'isNotNull'; + $cond->$method($column); + } + elseif ($not_equals && search_api_is_list_type($field_info['type'])) { + // The situation is more complicated for multi-valued fields, since + // we must make sure that results are excluded if ANY of the field's + // values equals the one given in this condition. + $sub_operator = ($not_between) ? 'BETWEEN' : '='; + $query = $this->connection->select($field_info['table'], 't') + ->fields('t', array('item_id')) + ->condition($field_info['column'], $value, $sub_operator); + $cond->condition('t.item_id', $query, 'NOT IN'); + } + elseif ($not_between) { + $cond->where("$column NOT BETWEEN {$value[0]} AND {$value[1]}"); + } + else { + $cond->condition($column, $value, $operator); + } + } + } + } + return count($cond->conditions()) > 1 ? $cond : NULL; + } + + /** + * Joins a field's table into a database select query. + * + * @param array $field + * The field information array. The "table" key should contain the table + * name to which a join should be made. + * @param SelectQueryInterface $db_query + * The database query used. + * @param bool $newjoin + * (optional) If TRUE, a join is done even if the table was already joined + * to in the query. + * @param string $join + * (optional) The join method to use. Must be a method of the $db_query. + * Normally, "join", "innerJoin", "leftJoin" and "rightJoin" are supported. + * + * @return string + * The alias for the field's table. + */ + protected function getTableAlias(array $field, SelectQueryInterface $db_query, $newjoin = FALSE, $join = 'leftJoin') { + if (!$newjoin) { + foreach ($db_query->getTables() as $alias => $info) { + $table = $info['table']; + if (is_scalar($table) && $table == $field['table']) { + return $alias; + } + } + } + return $db_query->$join($field['table'], 't', 't.item_id = %alias.item_id'); + } + + /** + * Preprocesses a search's database query before it is executed. + * + * This allows subclasses to apply custom changes before the query (and the + * count query) is executed. + * + * @param SelectQueryInterface $db_query + * The database query to be executed for the search. Will have "item_id" and + * "score" columns in its result. + * @param SearchApiQueryInterface $query + * The search query that is being executed. + * + * @see hook_search_api_db_query_alter() + */ + protected function preQuery(SelectQueryInterface &$db_query, SearchApiQueryInterface $query) { } + + /** + * Postprocess search results. + * + * This allows subclasses to apply custom changes before the results are + * returned. + * + * @param array $results + * The results array that will be returned for the search, in the format + * defined by SearchApiQueryInterface::execute(). + * @param SearchApiQueryInterface $query + * The executed search query. + */ + protected function postQuery(array &$results, SearchApiQueryInterface $query) { } + + /** + * Adds the query sort to a search database query. + * + * @param SearchApiQueryInterface $query + * The search query whose sorts should be applied. + * @param SelectQueryInterface $db_query + * The database query used for the search. + * @param array $fields + * An array containing information about the internal server storage of the + * indexed fields. + * + * @throws SearchApiException + * If an illegal sort was specified. + */ + protected function setQuerySort(SearchApiQueryInterface $query, SelectQueryInterface $db_query, array $fields) { + $sort = $query->getSort(); + if ($sort) { + foreach ($sort as $field_name => $order) { + if ($order != 'ASC' && $order != 'DESC') { + $msg = t('Unknown sort order @order. Assuming "ASC".', array('@order' => $order)); + $this->warnings[$msg] = $msg; + $order = 'ASC'; + } + if ($field_name == 'search_api_relevance') { + $db_query->orderBy('score', $order); + continue; + } + if ($field_name == 'search_api_id') { + $db_query->orderBy('item_id', $order); + continue; + } + if ($field_name == 'search_api_random') { + $db_query->orderRandom(); + continue; + } + if (!isset($fields[$field_name])) { + throw new SearchApiException(t('Trying to sort on unknown field @field.', array('@field' => $field_name))); + } + $field = $fields[$field_name]; + if (search_api_is_list_type($field['type'])) { + throw new SearchApiException(t('Cannot sort on field @field of a list type.', array('@field' => $field_name))); + } + if (search_api_is_text_type($field['type'])) { + throw new SearchApiException(t('Cannot sort on fulltext field @field.', array('@field' => $field_name))); + } + $alias = $this->getTableAlias($field, $db_query); + $db_query->orderBy($alias . '.' . $fields[$field_name]['column'], $order); + // PostgreSQL automatically adds a field to the SELECT list when sorting + // on it. Therefore, if we have aggregations present we also have to + // add the field to the GROUP BY (since Backdrop won't do it for us). + // However, if no aggregations are present, a GROUP BY would lead to + // another error. Therefore, we only add it if there is already a GROUP + // BY. + if ($db_query->getGroupBy()) { + $db_query->groupBy($alias . '.' . $fields[$field_name]['column']); + } + // For SELECT DISTINCT queries in combination with an ORDER BY clause, + // MySQL 5.7 and higher require that the ORDER BY expressions are part + // of the field list. Ensure that all fields used for sorting are part + // of the select list. + if (empty($db_fields[$fields[$field_name]['column']])) { + $db_query->addField($alias, $fields[$field_name]['column']); + } + } + } + else { + $db_query->orderBy('score', 'DESC'); + } + } + + /** + * Computes facets for a search query. + * + * @param SearchApiQueryInterface $query + * The search query for which facets should be computed. + * @param SelectQueryInterface $db_query + * A database select query which returns all results of that search query. + * + * @return array + * An array of facets, as specified by the search_api_facets feature. + */ + protected function getFacets(SearchApiQueryInterface $query, SelectQueryInterface $db_query) { + try { + // Add a tag to the database query to identify it as a facet base query. + $db_query->addTag('search_api_db_facets_base'); + + // Store the results of the query in a temporary table to run facet + // queries on it afterwards. + $table = $this->getTemporaryResultsTable($db_query); + if (!$table) { + return array(); + } + + $fields = $this->getFieldInfo($query->getIndex()); + $ret = array(); + foreach ($query->getOption('search_api_facets') as $key => $facet) { + if (empty($fields[$facet['field']])) { + $this->warnings[] = t('Unknown facet field @field.', array('@field' => $facet['field'])); + continue; + } + $field = $fields[$facet['field']]; + + if (empty($facet['operator']) || $facet['operator'] != 'or') { + // All the AND facets can use the main query. + $select = $this->connection->select($table, 't'); + } + else { + // For OR facets, we need to build a different base query that + // excludes the facet filters applied to the facet. + $or_query = clone $query; + $filters = &$or_query->getFilter()->getFilters(); + $tag = 'facet:' . $facet['field']; + foreach ($filters as $filter_id => $filter) { + if ($filter instanceof SearchApiQueryFilterInterface && $filter->hasTag($tag)) { + unset($filters[$filter_id]); + } + } + $or_db_query = $this->createDbQuery($or_query, $fields); + $select = $this->connection->select($or_db_query, 't'); + } + + // Add tags and metadata. + $select->addTag('search_api_db_facet'); + $select->addMetaData('search_api_query', $query); + $select->addMetaData('search_api_db_fields', $fields); + $select->addMetaData('search_api_db_facet', $facet); + + // If "Include missing facet" is disabled, we use an INNER JOIN and add + // IS NOT NULL for shared tables. + $is_text_type = search_api_is_text_type($field['type']); + $alias = $this->getTableAlias($field, $select, TRUE, $facet['missing'] ? 'leftJoin' : 'innerJoin'); + $select->addField($alias, $field['column'], 'value'); + if ($is_text_type) { + $select->condition("$alias.field_name", $this->getTextFieldName($facet['field'])); + } + if (!$facet['missing'] && !$is_text_type) { + $select->isNotNull($alias . '.' . $field['column']); + } + $select->addExpression('COUNT(DISTINCT t.item_id)', 'num'); + $select->groupBy('value'); + $select->orderBy('num', 'DESC'); + + $limit = $facet['limit']; + if ((int) $limit > 0) { + $select->range(0, $limit); + } + if ($facet['min_count'] > 1) { + $select->having('COUNT(DISTINCT t.item_id) >= :count', array(':count' => $facet['min_count'])); + } + + $terms = array(); + $values = array(); + $has_missing = FALSE; + foreach ($select->execute() as $row) { + $terms[] = array( + 'count' => $row->num, + 'filter' => isset($row->value) ? '"' . $row->value . '"' : '!', + ); + if (isset($row->value)) { + $values[] = $row->value; + } + else { + $has_missing = TRUE; + } + } + + // If 'Minimum facet count' is set to 0 in the display options for this + // facet, we need to retrieve all facets, even ones that aren't matched + // in our search result set above. Here we SELECT all DISTINCT facets, + // and add in those facets that weren't added above. + if ($facet['min_count'] < 1) { + $select = $this->connection->select($field['table'], 't'); + $select->addField('t', $field['column'], 'value'); + $select->distinct(); + if ($values) { + $select->condition($field['column'], $values, 'NOT IN'); + } + if ($is_text_type) { + $select->condition('t.field_name', $this->getTextFieldName($facet['field'])); + } + else { + $select->isNotNull($field['column']); + } + + // Add tags and metadata. + $select->addTag('search_api_db_facet_all'); + $select->addMetaData('search_api_query', $query); + $select->addMetaData('search_api_db_fields', $fields); + $select->addMetaData('search_api_db_facet', $facet); + + foreach ($select->execute() as $row) { + $terms[] = array( + 'count' => 0, + 'filter' => '"' . $row->value . '"', + ); + } + if ($facet['missing'] && !$has_missing) { + $terms[] = array( + 'count' => 0, + 'filter' => '!', + ); + } + } + + $ret[$key] = $terms; + } + return $ret; + } + catch (PDOException $e) { + watchdog_exception('search_api_db', $e, '%type while trying to calculate facets: !message in %function (line %line of %file).'); + return array(); + } + } + + /** + * Creates a temporary table from a SelectQuery. + * + * Will return the name of a table containing the item IDs of all results, or + * FALSE on failure. + * + * @param SelectQueryInterface $db_query + * The select query whose results should be stored in the temporary table. + * + * @return string|false + * The name of the temporary table, or FALSE on failure. + */ + protected function getTemporaryResultsTable(SelectQueryInterface $db_query) { + // We only need the ID column, not the score. + $fields = &$db_query->getFields(); + unset($fields['score']); + if (count($fields) != 1 || !isset($fields['item_id'])) { + watchdog('search_api_db', 'Error while adding facets: only "item_id" field should be used, used are: @fields.', + array('@fields' => implode(', ', array_keys($fields))), WATCHDOG_WARNING); + return FALSE; + } + $expressions = &$db_query->getExpressions(); + $expressions = array(); + + // If there's a GROUP BY for item_id, we leave that, all others need to be + // discarded. + $group_by = &$db_query->getGroupBy(); + $group_by = array_intersect_key($group_by, array('t.item_id' => TRUE)); + + // The order of results also doesn't matter here. Also, this might lead to + // errors if the ORDER BY clause references any expressions we removed. + $sort = &$db_query->getOrderBy(); + $sort = array(); + + $db_query->distinct(); + if (!$db_query->preExecute()) { + return FALSE; + } + $args = $db_query->getArguments(); + return $this->connection->queryTemporary((string) $db_query, $args); + } + + /** + * Implements SearchApiAutocompleteInterface::getAutocompleteSuggestions(). + */ + public function getAutocompleteSuggestions(SearchApiQueryInterface $query, SearchApiAutocompleteSearch $search, $incomplete_key, $user_input) { + $settings = isset($this->options['autocomplete']) ? $this->options['autocomplete'] : array(); + $settings += array( + 'suggest_suffix' => TRUE, + 'suggest_words' => TRUE, + ); + // If none of these options is checked, the user apparently chose a very + // roundabout way of telling us he doesn't want autocompletion. + if (!array_filter($settings)) { + return array(); + } + + $index = $query->getIndex(); + if (empty($this->options['indexes'][$index->machine_name])) { + throw new SearchApiException(t('Unknown index @id.', array('@id' => $index->machine_name))); + } + $fields = $this->getFieldInfo($index); + + $suggestions = array(); + $passes = array(); + + // Make the input lowercase as the indexed data is also all lowercase. + $user_input = backdrop_strtolower($user_input); + $incomplete_key = backdrop_strtolower($incomplete_key); + + // Decide which methods we want to use. + if ($incomplete_key && $settings['suggest_suffix']) { + $tokenizer_active = static::isTokenizerActive($index); + $processed_key = $this->splitKeys($incomplete_key, $tokenizer_active); + if ($processed_key) { + // In case the $incomplete_key turned out to be more than one word, add + // all but the last one to the user input. + if (is_array($processed_key)) { + unset($processed_key['#conjunction']); + $incomplete_key = array_pop($processed_key); + if ($processed_key) { + $user_input .= ' ' . implode(' ', $processed_key); + } + $processed_key = $incomplete_key; + } + $passes[] = 1; + $incomplete_like = $this->connection->escapeLike($processed_key) . '%'; + } + } + if ($settings['suggest_words'] + && (!$incomplete_key || strlen($incomplete_key) >= $this->options['min_chars'])) { + $passes[] = 2; + } + + if (!$passes) { + return array(); + } + + // We want about half of the suggestions from each enabled method. + $limit = $query->getOption('limit', 10); + $limit /= count($passes); + $limit = ceil($limit); + + // Also collect all keywords already contained in the query so we don't + // suggest them. + $keys = backdrop_map_assoc(preg_split('/[^\p{L}\p{N}]+/u', $user_input, -1, PREG_SPLIT_NO_EMPTY)); + if ($incomplete_key) { + $keys[$incomplete_key] = $incomplete_key; + } + + foreach ($passes as $pass) { + if ($pass == 2 && $incomplete_key) { + $query->keys($user_input); + } + // To avoid suggesting incomplete words, we have to temporarily disable + // the "partial_matches" option. (There should be no way we'll save the + // server during the createDbQuery() call, so this should be safe.) + $options = $this->options; + $this->options['partial_matches'] = FALSE; + $db_query = $this->createDbQuery($query, $fields); + $this->options = $options; + + // Add additional tags and metadata. + $db_query->addTag('search_api_db_autocomplete'); + $db_query->addMetaData('search_api_db_autocomplete', array( + 'search' => $search, + 'incomplete_key' => $incomplete_key, + 'user_input' => $user_input, + 'pass' => $pass, + )); + + $text_fields = array(); + foreach ($query->getFields() as $field) { + if (isset($fields[$field]) && search_api_is_text_type($fields[$field]['type'])) { + $text_fields[] = $field; + } + } + if (empty($text_fields)) { + return array(); + } + + // For each text field that will be searched, store the item IDs in a + // temporary table. This is unfortunately necessary since MySQL doesn't + // allow using a temporary table multiple times in a single query. + $all_results = array(); + $total = NULL; + $first_temp_table = TRUE; + foreach ($text_fields as $field) { + $table = $this->getTemporaryResultsTable($db_query); + if (!$table) { + return array(); + } + if ($first_temp_table) { + // For subsequent temporary tables, just use a plain SELECT over the + // first to fill them, instead of the (potentially very complex) + // search query. + $first_temp_table = FALSE; + $db_query = $this->connection->select($table) + ->fields($table, array('item_id')); + } + $all_results[$field] = $this->connection->select($table, 't') + ->fields('t', array('item_id')); + if ($total === NULL) { + $total = $this->connection->query("SELECT COUNT(item_id) FROM {{$table}}")->fetchField(); + } + } + $max_occurrences = max(1, floor($total * config_get('search_api_db.settings', 'autocomplete_max_occurrences'))); + + if (!$total) { + if ($pass == 1) { + return NULL; + } + continue; + } + + $word_query = NULL; + foreach ($text_fields as $field) { + $field_query = $this->connection->select($fields[$field]['table'], 't') + ->fields('t', array('word', 'item_id')) + ->condition('item_id', $all_results[$field], 'IN') + ->condition('field_name', $this->getTextFieldName($field)); + if ($pass == 1) { + $field_query->condition('word', $incomplete_like, 'LIKE') + ->condition('word', $keys, 'NOT IN'); + } + if (!isset($word_query)) { + $word_query = $field_query; + } + else { + $word_query->union($field_query); + } + } + if (!$word_query) { + return array(); + } + $db_query = $this->connection->select($word_query, 't'); + $db_query->addExpression('COUNT(DISTINCT item_id)', 'results'); + $db_query->fields('t', array('word')) + ->groupBy('word') + ->having('COUNT(DISTINCT item_id) <= :max', array(':max' => $max_occurrences)) + ->orderBy('results', 'DESC') + ->range(0, $limit); + $incomp_len = strlen($incomplete_key); + foreach ($db_query->execute() as $row) { + $suffix = ($pass == 1) ? substr($row->word, $incomp_len) : ' ' . $row->word; + $suggestions[] = array( + 'suggestion_suffix' => $suffix, + 'results' => $row->results, + ); + } + } + + return $suggestions; + } + + /** + * Retrieves the internal field information. + * + * @param SearchApiIndex $index + * The index whose fields should be retrieved. + * + * @return array $fields + * An array of arrays. The outer array is keyed by field name. Each value + * is an associative array with information on the field. + */ + protected function getFieldInfo(SearchApiIndex $index) { + $fields = $this->options['indexes'][$index->machine_name]; + foreach ($fields as $key => $field) { + // Legacy fields do not have column set. + if (!isset($field['column'])) { + $fields[$key]['column'] = search_api_is_text_type($field['type']) ? 'word' : 'value'; + } + } + return $fields; + } + + /** + * Emulates self::mbStrcut() if that is not available. + * + * Though the Mbstring PHP extension is recommended for running Backdrop, it is + * not required. Therefore, we have to wrap calls to its functions. + * + * @param string $str + * The string being cut. + * @param int $start + * Starting position in bytes. + * @param int|null $length + * (optional) Length in bytes. If NULL is passed, extract all bytes to the + * end of the string. + * + * @return string + * The portion of $str specified by the $start and $length parameters. + */ + protected static function mbStrcut($str, $start, $length = NULL) { + global $multibyte; + if ($multibyte == UNICODE_MULTIBYTE) { + return mb_strcut($str, $start, $length); + } + return substr($str, $start, $length); + } + + /** + * Determines whether the "Tokenizer" processor is enabled for an index. + * + * @param SearchApiIndex $index + * The index to check. + * + * @return bool + * TRUE if the built-in "Tokenizer" processor is enabled on the given index, + * FALSE otherwise. + */ + protected static function isTokenizerActive(SearchApiIndex $index) { + return !empty($index->options['processors']['search_api_tokenizer']['status']); + } + +} diff --git a/www/themes/backdropcms/css/components-views.css b/www/themes/backdropcms/css/components-views.css index e1507743e..4b3d45cf1 100644 --- a/www/themes/backdropcms/css/components-views.css +++ b/www/themes/backdropcms/css/components-views.css @@ -35,7 +35,8 @@ /******************************************************************************* * Projects view ******************************************************************************/ -.view-modules ol { +.view-modules ol, +.view-project-listings ol { margin-left: 0 ; list-style-type: none; } diff --git a/www/themes/backdropcms/css/page-project-search.css b/www/themes/backdropcms/css/page-project-search.css index 0364e7bf6..eee0330b7 100644 --- a/www/themes/backdropcms/css/page-project-search.css +++ b/www/themes/backdropcms/css/page-project-search.css @@ -12,14 +12,16 @@ padding: 0; } -.view-modules h2 { +.view-modules h2, +.view-project-listings h2 { margin-top: 0; color: #929597; font-size: 24px; line-height: 32px; } @media (min-width: 30em) { /* 480px */ - .view-modules h2 { + .view-modules h2, + .view-project-listings h2 { font-size: 30px; line-height: 36px; } @@ -68,12 +70,18 @@ .block-views--exp-modules-modules, .block-views--exp-modules-themes, -.block-views--exp-modules-layouts { +.block-views--exp-modules-layouts, +.block-views--exp-project-listings-modules, +.block-views--exp-project-listings-themes, +.block-views--exp-project-listings-layouts { width: 100%; } .block-views--exp-modules-modules .block-content, .block-views--exp-modules-themes .block-content, -.block-views--exp-modules-layouts .block-content { +.block-views--exp-modules-layouts .block-content, +.block-views--exp-project-listings-modules .block-content, +.block-views--exp-project-listings-themes .block-content, +.block-views--exp-project-listings-layouts .block-content { max-width: 750px; } @@ -85,11 +93,15 @@ form.views-exposed-form, #views-exposed-form-modules-modules, #views-exposed-form-modules-themes, -#views-exposed-form-modules-layouts { +#views-exposed-form-modules-layouts, +#views-exposed-form-project-listings-modules, +#views-exposed-form-project-listings-themes, +#views-exposed-form-project-listings-layouts { border: 0; padding: 0; } +.views-exposed-form .views-widget-filter-search_api_views_fulltext, .views-exposed-form .views-widget-filter-combine, .views-exposed-form .views-widget-filter-title, .views-exposed-form .views-widget-filter-keys, @@ -100,6 +112,7 @@ form.views-exposed-form, line-height: 1.5; } +.views-exposed-form .views-widget-filter-search_api_views_fulltext, .views-exposed-form .views-widget-filter-combine, .views-exposed-form .views-widget-filter-title, .views-exposed-form .views-widget-filter-keys { @@ -229,6 +242,11 @@ form.views-exposed-form, padding: 0; } +.result__info li.rendered-entity { + width: 100%; + max-width: 100%; +} + .result__info li { margin: 0 5px 0 0; display: inline-block; @@ -237,10 +255,6 @@ form.views-exposed-form, margin: 0; } -.result__info a { - color: #00a1d3; -} - /* @todo delete me */ .result__info .view-node a { font-size: 16px; diff --git a/www/themes/backdropcms/template.php b/www/themes/backdropcms/template.php index 1dd32dd6b..5b353d16c 100644 --- a/www/themes/backdropcms/template.php +++ b/www/themes/backdropcms/template.php @@ -40,7 +40,7 @@ function backdropcms_preprocess_page(&$variables) { $icons_needed[] = 'arrow-circle-down-fill'; } } - elseif ($arg0 == 'modules' || $arg0 == 'themes' || $arg0 == 'layouts') { + elseif(in_array($arg0, array('modules', 'themes', 'layouts', 'modules2', 'themes2', 'layouts2'))) { $variables['classes'][] = 'project-search'; backdrop_add_css($path . '/css/page-project-search.css'); } @@ -465,4 +465,4 @@ function backdropcms_field__body__docs($variables) { function backdropcms_system_powered_by() { return '' . t('Backdrop CMS and the Backdrop logo are registered trademarks of the Softrware Freedom conservancy.', array('@url' => 'https://backdropcms.org')) . ''; } -*/ \ No newline at end of file +*/