Shows the form items posted.
- -| Name | -Value | -
|---|---|
| - | - |
You can see this example with different themes on the www.plupload.com website.
- - - - - \ No newline at end of file diff --git a/sites/all/libraries/plupload/examples/jquery/queue_widget.html b/sites/all/libraries/plupload/examples/jquery/queue_widget.html deleted file mode 100644 index 569564a..0000000 --- a/sites/all/libraries/plupload/examples/jquery/queue_widget.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - -You browser doesn't have Flash, Silverlight, Gears, BrowserPlus or HTML5 support.
-' . 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))) . '
'; + } } - $form = array( - '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'), - ), - ), - '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 { + $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( @@ -62,8 +120,13 @@ class SearchApiAlterBundleFilter extends SearchApiAbstractAlterCallback { } /** - * Helper method for figuring out if the entities with the given entity info - * can be filtered by bundle. + * 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/sites/all/modules/contrib/search/search_api/includes/callback_comment_access.inc b/sites/all/modules/contrib/search/search_api/includes/callback_comment_access.inc new file mode 100644 index 0000000..e627353 --- /dev/null +++ b/sites/all/modules/contrib/search/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/sites/all/modules/contrib/search/search_api/includes/callback_language_control.inc b/sites/all/modules/contrib/search/search_api/includes/callback_language_control.inc index 0ac481f..d406d35 100644 --- a/sites/all/modules/contrib/search/search_api/includes/callback_language_control.inc +++ b/sites/all/modules/contrib/search/search_api/includes/callback_language_control.inc @@ -1,5 +1,10 @@ name); $native = $lang->native; - $languages[$lang->language] = ($name == $native) ? $name : "$name ($native)"; + $languages[$lang->language] = check_plain(($name == $native) ? $name : "$name ($native)"); if (!$lang->enabled) { $languages[$lang->language] .= ' [' . t('disabled') . ']'; } @@ -98,19 +89,7 @@ class SearchApiAlterLanguageControl extends SearchApiAbstractAlterCallback { } /** - * Submit callback for the form returned by configurationForm(). - * - * This method should both return the new options and set them internally. - * - * @param array $form - * The form returned by configurationForm(). - * @param array $values - * The part of the $form_state['values'] array corresponding to this form. - * @param array $form_state - * The complete form state. - * - * @return array - * The new options array for this callback. + * {@inheritdoc} */ public function configurationFormSubmit(array $form, array &$values, array &$form_state) { $values['languages'] = array_filter($values['languages']); @@ -118,15 +97,7 @@ class SearchApiAlterLanguageControl extends SearchApiAbstractAlterCallback { } /** - * Alter items before indexing. - * - * Items which are removed from the array won't be indexed, but will be marked - * as clean for future indexing. This could for instance be used to implement - * some sort of access filter for security purposes (e.g., don't index - * unpublished nodes or comments). - * - * @param array $items - * An array of items to be altered, keyed by item IDs. + * {@inheritdoc} */ public function alterItems(array &$items) { foreach ($items as $i => &$item) { diff --git a/sites/all/modules/contrib/search/search_api/includes/callback_node_access.inc b/sites/all/modules/contrib/search/search_api/includes/callback_node_access.inc index ce671d7..8bfab49 100644 --- a/sites/all/modules/contrib/search/search_api/includes/callback_node_access.inc +++ b/sites/all/modules/contrib/search/search_api/includes/callback_node_access.inc @@ -10,31 +10,19 @@ class SearchApiAlterNodeAccess extends SearchApiAbstractAlterCallback { /** - * Check whether this data-alter callback is applicable for a certain index. + * Overrides SearchApiAbstractAlterCallback::supportsIndex(). * * Returns TRUE only for indexes on nodes. - * - * @param SearchApiIndex $index - * The index to check for. - * - * @return boolean - * TRUE if the callback can run on the given index; FALSE otherwise. */ public function supportsIndex(SearchApiIndex $index) { // Currently only node access is supported. - return $index->item_type === 'node'; + return $index->getEntityType() === 'node'; } /** - * Declare the properties that are (or can be) added to items with this callback. + * Overrides SearchApiAbstractAlterCallback::propertyInfo(). * * Adds the "search_api_access_node" property. - * - * @see hook_entity_property_info() - * - * @return array - * Information about all additional properties, as specified by - * hook_entity_property_info() (only the inner "properties" array). */ public function propertyInfo() { return array( @@ -47,15 +35,7 @@ class SearchApiAlterNodeAccess extends SearchApiAbstractAlterCallback { } /** - * Alter items before indexing. - * - * Items which are removed from the array won't be indexed, but will be marked - * as clean for future indexing. This could for instance be used to implement - * some sort of access filter for security purposes (e.g., don't index - * unpublished nodes or comments). - * - * @param array $items - * An array of items to be altered, keyed by item IDs. + * {@inheritdoc} */ public function alterItems(array &$items) { static $account; @@ -65,30 +45,39 @@ class SearchApiAlterNodeAccess extends SearchApiAbstractAlterCallback { $account = drupal_anonymous_user(); } - foreach ($items as $nid => &$item) { + foreach ($items as $id => $item) { + $node = $this->getNode($item); // Check whether all users have access to the node. - if (!node_access('view', $item, $account)) { + if (!node_access('view', $node, $account)) { // Get node access grants. - $result = db_query('SELECT * FROM {node_access} WHERE (nid = 0 OR nid = :nid) AND grant_view = 1', array(':nid' => $item->nid)); + $result = db_query('SELECT * FROM {node_access} WHERE (nid = 0 OR nid = :nid) AND grant_view = 1', array(':nid' => $node->nid)); - // Store all grants together with it's realms in the item. + // Store all grants together with their realms in the item. foreach ($result as $grant) { - if (!isset($items[$nid]->search_api_access_node)) { - $items[$nid]->search_api_access_node = array(); - } - $items[$nid]->search_api_access_node[] = "node_access_$grant->realm:$grant->gid"; + $items[$id]->search_api_access_node[] = "node_access_{$grant->realm}:{$grant->gid}"; } } else { // Add the generic view grant if we are not using node access or the // node is viewable by anonymous users. - $items[$nid]->search_api_access_node = array('node_access__all'); + $items[$id]->search_api_access_node = array('node_access__all'); } } } /** - * Submit callback for the configuration form. + * Retrieves the node related to a search item. + * + * In the default implementation for nodes, the item is already the node. + * Subclasses may override this to easily provide node access checks for + * items related to nodes. + */ + protected function getNode($item) { + return $item; + } + + /** + * Overrides SearchApiAbstractAlterCallback::configurationFormSubmit(). * * If the data alteration is being enabled, set "Published" and "Author" to * "indexed", because both are needed for the node access filter. diff --git a/sites/all/modules/contrib/search/search_api/includes/callback_node_status.inc b/sites/all/modules/contrib/search/search_api/includes/callback_node_status.inc index bfe35e2..ee57c38 100644 --- a/sites/all/modules/contrib/search/search_api/includes/callback_node_status.inc +++ b/sites/all/modules/contrib/search/search_api/includes/callback_node_status.inc @@ -22,7 +22,7 @@ class SearchApiAlterNodeStatus extends SearchApiAbstractAlterCallback { * TRUE if the callback can run on the given index; FALSE otherwise. */ public function supportsIndex(SearchApiIndex $index) { - return $index->item_type === 'node'; + return $index->getEntityType() === 'node'; } /** diff --git a/sites/all/modules/contrib/search/search_api/includes/callback_role_filter.inc b/sites/all/modules/contrib/search/search_api/includes/callback_role_filter.inc new file mode 100644 index 0000000..68b8d72 --- /dev/null +++ b/sites/all/modules/contrib/search/search_api/includes/callback_role_filter.inc @@ -0,0 +1,78 @@ +isMultiEntityIndex($index)) { + return in_array('user', $index->options['datasource']['types']); + } + return $index->getEntityType() == 'user'; + } + + /** + * Implements SearchApiAlterCallbackInterface::alterItems(). + */ + public function alterItems(array &$items) { + $selected_roles = $this->options['roles']; + $default = (bool) $this->options['default']; + $multi_types = $this->isMultiEntityIndex($this->index); + foreach ($items as $id => $item) { + if ($multi_types) { + if ($item->item_type !== 'user') { + continue; + } + $item_roles = $item->user->roles; + } + else { + $item_roles = $item->roles; + } + $role_match = (count(array_diff_key($item_roles, $selected_roles)) !== count($item_roles)); + if ($role_match === $default) { + unset($items[$id]); + } + } + } + + /** + * Overrides SearchApiAbstractAlterCallback::configurationForm(). + * + * Add option for the roles to include/exclude. + */ + public function configurationForm() { + $options = array_map('check_plain', user_roles()); + $form = array( + 'default' => array( + '#type' => 'radios', + '#title' => t('Which users 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 roles'), + 0 => t('Only those from the selected roles'), + ), + ), + 'roles' => array( + '#type' => 'select', + '#title' => t('Roles'), + '#default_value' => isset($this->options['roles']) ? $this->options['roles'] : array(), + '#options' => $options, + '#size' => min(4, count($options)), + '#multiple' => TRUE, + ), + ); + return $form; + } + +} diff --git a/sites/all/modules/contrib/search/search_api/includes/callback_user_content.inc b/sites/all/modules/contrib/search/search_api/includes/callback_user_content.inc new file mode 100644 index 0000000..168f3ae --- /dev/null +++ b/sites/all/modules/contrib/search/search_api/includes/callback_user_content.inc @@ -0,0 +1,57 @@ +getEntityType() === 'user'; + } + + /** + * {@inheritdoc} + */ + public function propertyInfo() { + return array( + 'search_api_user_content' => array( + 'label' => t('User content'), + 'description' => t('The nodes created by this user'), + 'type' => 'list' . 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) { + // 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/sites/all/modules/contrib/search/search_api/includes/processor_stopwords.inc b/sites/all/modules/contrib/search/search_api/includes/processor_stopwords.inc index d8559ca..0091871 100644 --- a/sites/all/modules/contrib/search/search_api/includes/processor_stopwords.inc +++ b/sites/all/modules/contrib/search/search_api/includes/processor_stopwords.inc @@ -1,10 +1,22 @@ array( '#type' => 'textfield', - '#title' => t('Stopwords file URI'), - '#title' => t('Enter the URI of your stopwords.txt file'), + '#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(
@@ -36,13 +47,8 @@ class SearchApiStopWords extends SearchApiAbstractProcessor {
public function configurationFormValidate(array $form, array &$values, array &$form_state) {
parent::configurationFormValidate($form, $values, $form_state);
- $stopwords = trim($values['stopwords']);
$uri = $values['file'];
- if (empty($stopwords) && empty($uri)) {
- $el = $form['file'];
- form_error($el, $el['#title'] . ': ' . t('At stopwords file or words are required.'));
- }
- if (!empty($uri) && !file_get_contents($uri)) {
+ 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)));
}
@@ -50,7 +56,7 @@ class SearchApiStopWords extends SearchApiAbstractProcessor {
public function process(&$value) {
$stopwords = $this->getStopWords();
- if (empty($stopwords)) {
+ if (empty($stopwords) || !is_string($value)) {
return;
}
$words = preg_split('/\s+/', $value);
@@ -63,17 +69,26 @@ class SearchApiStopWords extends SearchApiAbstractProcessor {
$value = implode(' ', $words);
}
+ public function preprocessSearchQuery(SearchApiQuery $query) {
+ $this->ignored = array();
+ parent::preprocessSearchQuery($query);
+ }
+
public function postprocessSearchResults(array &$response, SearchApiQuery $query) {
- if (isset($this->ignored)) {
+ if ($this->ignored) {
if (isset($response['ignored'])) {
$response['ignored'] = array_merge($response['ignored'], $this->ignored);
}
- else $response['ignored'] = $this->ignored;
+ else {
+ $response['ignored'] = $this->ignored;
+ }
}
}
/**
- * @return
+ * Retrieves the processor's configured stopwords.
+ *
+ * @return array
* An array whose keys are the stopwords set in either the file or the text
* field.
*/
@@ -91,4 +106,4 @@ class SearchApiStopWords extends SearchApiAbstractProcessor {
$this->stopwords = array_flip(array_merge($file_words, $form_words));
return $this->stopwords;
}
-}
\ No newline at end of file
+}
diff --git a/sites/all/modules/contrib/search/search_api/includes/processor_tokenizer.inc b/sites/all/modules/contrib/search/search_api/includes/processor_tokenizer.inc
index ba04d1d..14834df 100644
--- a/sites/all/modules/contrib/search/search_api/includes/processor_tokenizer.inc
+++ b/sites/all/modules/contrib/search/search_api/includes/processor_tokenizer.inc
@@ -1,5 +1,10 @@
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',
@@ -37,7 +53,7 @@ class SearchApiTokenizer extends SearchApiAbstractProcessor {
);
if (!empty($this->options)) {
- $form['spaces']['#default_value'] = $this->options['spaces'];
+ $form['spaces']['#default_value'] = $this->options['spaces'];
$form['ignorable']['#default_value'] = $this->options['ignorable'];
}
@@ -76,12 +92,15 @@ class SearchApiTokenizer extends SearchApiAbstractProcessor {
}
protected function process(&$value) {
- $this->prepare();
- if ($this->ignorable) {
- $value = preg_replace('/' . $this->ignorable . '+/u', '', $value);
- }
- if ($this->spaces) {
- $value = preg_replace('/' . $this->spaces . '+/u', ' ', $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);
+ }
}
}
diff --git a/sites/all/modules/contrib/search/search_api/includes/processor_transliteration.inc b/sites/all/modules/contrib/search/search_api/includes/processor_transliteration.inc
new file mode 100644
index 0000000..e344886
--- /dev/null
+++ b/sites/all/modules/contrib/search/search_api/includes/processor_transliteration.inc
@@ -0,0 +1,20 @@
+", "<", "<=", ">=", ">". They
* have the same semantics as the corresponding SQL operators.
@@ -127,31 +146,36 @@ interface SearchApiQueryInterface {
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.
+ * Adds a sort directive to this search query.
*
- * @param $field
+ * 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.
- * @param $order
+ * 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'.
*
- * @throws SearchApiException
- * If the field is multi-valued or of a fulltext type.
- *
* @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.
+ * Adds a range of results to return.
*
- * @param $offset
+ * 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 $limit
+ * @param int|null $limit
* The number of results to return.
*
* @return SearchApiQueryInterface
@@ -166,7 +190,9 @@ interface SearchApiQueryInterface {
* 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.
+ * 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.
@@ -175,7 +201,16 @@ interface SearchApiQueryInterface {
* 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.
+ * 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.
@@ -193,7 +228,10 @@ interface SearchApiQueryInterface {
* - 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.
+ * 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();
@@ -202,28 +240,36 @@ interface SearchApiQueryInterface {
*
* 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();
/**
- * Postprocess the search results before they are returned.
+ * 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 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();
/**
- * @return
+ * 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
@@ -236,41 +282,59 @@ interface SearchApiQueryInterface {
* 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();
/**
- * @return
+ * 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 getKeys().
+ * 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();
/**
- * @param $name string
+ * Retrieves an option set on this search query.
+ *
+ * @param string $name
* The name of an option.
- * @param $default mixed
+ * @param mixed $default
* The value to return if the specified option is not set.
*
* @return mixed
@@ -279,16 +343,24 @@ interface SearchApiQueryInterface {
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 The option's previous value.
+ * @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.
*/
@@ -297,17 +369,26 @@ interface SearchApiQueryInterface {
}
/**
- * Standard implementation of SearchApiQueryInterface.
+ * Provides a standard implementation of the SearchApiQueryInterface.
*/
class SearchApiQuery implements SearchApiQueryInterface {
/**
- * The index.
+ * 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.
*
@@ -351,44 +432,14 @@ class SearchApiQuery implements SearchApiQueryInterface {
protected $options;
/**
- * Count for providing a unique ID.
+ * Flag for whether preExecute() was already called for this query.
+ *
+ * @var bool
*/
- protected static $count = 0;
+ protected $pre_execute = FALSE;
/**
- * Constructor for SearchApiQuery objects.
- *
- * @param SearchApiIndex $index
- * The index the query should be executed on.
- * @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 SearchApiQuery::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 in the index.
- * - 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 Search API's static cache.
- * - search_api_access_account: The account which will be used for entity
- * access checks, if available and enabled for the index.
- * - search_api_bypass_access: If set to TRUE, entity access checks will be
- * skipped, even if enabled for the index.
- * All options are optional. Third-party modules might define and use other
- * options not listed here.
- *
- * @throws SearchApiException
- * If a search on that index (or with those options) won't be possible.
+ * {@inheritdoc}
*/
public function __construct(SearchApiIndex $index, array $options = array()) {
if (empty($index->options['fields'])) {
@@ -415,12 +466,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * @return array
- * An associative array of parse modes recognized by objects of this class.
- * The keys are the parse modes' ids, values are associative arrays
- * containing the following entries:
- * - name: The translated name of the parse mode.
- * - description: (optional) A translated text describing the parse mode.
+ * {@inheritdoc}
*/
public function parseModes() {
$modes['direct'] = array(
@@ -434,18 +480,15 @@ class SearchApiQuery implements SearchApiQueryInterface {
);
$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.'),
+ '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;
}
/**
- * Parses the keys string according to the $mode parameter.
- *
- * @return
- * The parsed keys. Either a string or an array.
+ * {@inheritdoc}
*/
protected function parseKeys($keys, $mode) {
if ($keys === NULL || is_array($keys)) {
@@ -460,7 +503,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
return array('#conjunction' => $this->options['conjunction'], $keys);
case 'terms':
- $ret = explode(' ', $keys);
+ $ret = preg_split('/\s+/u', $keys);
$quoted = FALSE;
$str = '';
foreach ($ret as $k => $v) {
@@ -500,28 +543,15 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * Method for creating a filter to use with this query object.
- *
- * @param $conjunction
- * The conjunction to use for the filter - either 'AND' or 'OR'.
- *
- * @return SearchApiQueryFilterInterface
- * A filter object that is set to use the specified conjunction.
+ * {@inheritdoc}
*/
- public function createFilter($conjunction = 'AND') {
+ public function createFilter($conjunction = 'AND', $tags = array()) {
$filter_class = $this->options['filter class'];
- return new $filter_class($conjunction);
+ return new $filter_class($conjunction, $tags);
}
/**
- * Sets the keys to search for. If this method is not called on the query
- * before execution, this will be a filter-only query.
- *
- * @param $keys
- * A string with the unparsed search keys, or NULL to use no search keys.
- *
- * @return SearchApiQuery
- * The called object.
+ * {@inheritdoc}
*/
public function keys($keys = NULL) {
$this->orig_keys = $keys;
@@ -534,17 +564,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
return $this;
}
/**
- * Sets the fields that will be searched for the search keys. If this is not
- * called, all fulltext fields should be searched.
- *
- * @param array $fields
- * An array containing fulltext fields that should be searched.
- *
- * @throws SearchApiException
- * If one of the fields isn't of type "text".
- *
- * @return SearchApiQueryInterface
- * The called object.
+ * {@inheritdoc}
*/
public function fields(array $fields) {
$fulltext_fields = $this->index->getFulltextFields();
@@ -556,13 +576,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * Adds a subfilter to this query's filter.
- *
- * @param SearchApiQueryFilterInterface $filter
- * A SearchApiQueryFilter object that should be added as a subfilter.
- *
- * @return SearchApiQuery
- * The called object.
+ * {@inheritdoc}
*/
public function filter(SearchApiQueryFilterInterface $filter) {
$this->filter->filter($filter);
@@ -570,24 +584,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * Add a new ($field $operator $value) condition filter.
- *
- * @param $field
- * The field to filter on, e.g. 'title'.
- * @param $value
- * The value the field should have (or be related to by the operator).
- * @param $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 SearchApiQuery
- * The called object.
+ * {@inheritdoc}
*/
public function condition($field, $value, $operator = '=') {
$this->filter->condition($field, $value, $operator);
@@ -595,20 +592,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * Add a sort directive to this search query. If no sort is manually set, the
- * results will be sorted descending by relevance.
- *
- * @param $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 $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 SearchApiQuery
- * The called object.
+ * {@inheritdoc}
*/
public function sort($field, $order = 'ASC') {
$fields = $this->index->options['fields'];
@@ -616,6 +600,10 @@ class SearchApiQuery implements SearchApiQueryInterface {
'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)));
}
@@ -629,17 +617,7 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * 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 $offset
- * The zero-based offset of the first result returned.
- * @param $limit
- * The number of results to return.
- *
- * @return SearchApiQueryInterface
- * The called object.
+ * {@inheritdoc}
*/
public function range($offset = NULL, $limit = NULL) {
$this->options['offset'] = $offset;
@@ -649,42 +627,9 @@ class SearchApiQuery implements SearchApiQueryInterface {
/**
- * 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
- * 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.
- * - 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.
+ * {@inheritdoc}
*/
- public final function execute() {
+ public function execute() {
$start = microtime(TRUE);
// Prepare the query for execution by the server.
@@ -711,7 +656,15 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * Helper method for adding a language filter.
+ * 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) {
@@ -755,124 +708,92 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * 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.
+ * {@inheritdoc}
*/
public function preExecute() {
- // Add filter for languages.
- if (isset($this->options['languages'])) {
- $this->addLanguages($this->options['languages']);
+ // 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.
+ drupal_alter('search_api_query', $this);
}
-
- // 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.
- drupal_alter('search_api_query', $this);
}
/**
- * Postprocess 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.
+ * {@inheritdoc}
*/
public function postExecute(array &$results) {
// Postprocess results.
$this->index->postprocessSearchResults($results, $this);
+
+ // Let modules alter the results.
+ drupal_alter('search_api_results', $results, $this);
}
/**
- * @return SearchApiIndex
- * The search index this query will be executed on.
+ * {@inheritdoc}
*/
public function getIndex() {
return $this->index;
}
/**
- * @return
- * 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.
+ * {@inheritdoc}
*/
public function &getKeys() {
return $this->keys;
}
/**
- * @return
- * The unprocessed search keys, exactly as passed to this object. Has the
- * same format as getKeys().
+ * {@inheritdoc}
*/
public function getOriginalKeys() {
return $this->orig_keys;
}
/**
- * @return array
- * An array containing the fields that should be searched for the search
- * keys.
+ * {@inheritdoc}
*/
public function &getFields() {
return $this->fields;
}
/**
- * @return SearchApiQueryFilterInterface
- * This object's associated filter object.
+ * {@inheritdoc}
*/
public function getFilter() {
return $this->filter;
}
/**
- * @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.
+ * {@inheritdoc}
*/
public function &getSort() {
return $this->sort;
}
/**
- * @param $name string
- * The name of an option.
- *
- * @return mixed
- * The option with the specified name, if set, or NULL otherwise.
+ * {@inheritdoc}
*/
public function getOption($name, $default = NULL) {
return array_key_exists($name, $this->options) ? $this->options[$name] : $default;
}
/**
- * @param string $name
- * The name of an option.
- * @param mixed $value
- * The new value of the option.
- *
- * @return The option's previous value.
+ * {@inheritdoc}
*/
public function setOption($name, $value) {
$old = $this->getOption($name);
@@ -881,36 +802,113 @@ class SearchApiQuery implements SearchApiQueryInterface {
}
/**
- * @return array
- * An associative array of query options.
+ * {@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;
+ }
+
}
/**
- * Interface representing a search query filter, that filters on one or more
- * fields with a specific conjunction (AND or OR).
+ * Represents a filter on a search query.
*
- * Methods not noting otherwise will return the object itself, so calls can be
- * chained.
+ * 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 $conjunction
- * The conjunction to use for this filter - either 'AND' or 'OR'.
+ * @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');
+ public function __construct($conjunction = 'AND', array $tags = array());
/**
* Sets this filter's conjunction.
*
- * @param $conjunction
+ * @param string $conjunction
* The conjunction to use for this filter - either 'AND' or 'OR'.
*
* @return SearchApiQueryFilterInterface
@@ -921,7 +919,7 @@ interface SearchApiQueryFilterInterface {
/**
* Adds a subfilter.
*
- * @param $filter
+ * @param SearchApiQueryFilterInterface $filter
* A SearchApiQueryFilterInterface object that should be added as a
* subfilter.
*
@@ -931,13 +929,13 @@ interface SearchApiQueryFilterInterface {
public function filter(SearchApiQueryFilterInterface $filter);
/**
- * Add a new ($field $operator $value) condition.
+ * Adds a new ($field $operator $value) condition.
*
- * @param $field
+ * @param string $field
* The field to filter on, e.g. 'title'.
- * @param $value
+ * @param mixed $value
* The value the field should have (or be related to by the operator).
- * @param $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.
@@ -953,53 +951,79 @@ interface SearchApiQueryFilterInterface {
public function condition($field, $value, $operator = '=');
/**
- * @return
+ * 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 an
- * array (field, value, operator), or another SearchApiFilter object.
+ * 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();
+
}
/**
- * Standard implementation of SearchApiQueryFilterInterface.
+ * 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.
+ * 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'). */
+ /**
+ * String specifying this filter's conjunction ('AND' or 'OR').
+ *
+ * @var string
+ */
protected $conjunction;
/**
- * Constructs a new filter that uses the specified conjunction.
- *
- * @param $conjunction
- * The conjunction to use for this filter - either 'AND' or 'OR'.
+ * {@inheritdoc}
*/
- public function __construct($conjunction = 'AND') {
+ public function __construct($conjunction = 'AND', array $tags = array()) {
$this->setConjunction($conjunction);
$this->filters = array();
+ $this->tags = drupal_map_assoc($tags);
}
/**
- * Sets this filter's conjunction.
- *
- * @param $conjunction
- * The conjunction to use for this filter - either 'AND' or 'OR'.
- *
- * @return SearchApiQueryFilter
- * The called object.
+ * {@inheritdoc}
*/
public function setConjunction($conjunction) {
$this->conjunction = strtoupper(trim($conjunction)) == 'OR' ? 'OR' : 'AND';
@@ -1007,14 +1031,7 @@ class SearchApiQueryFilter implements SearchApiQueryFilterInterface {
}
/**
- * Adds a subfilter.
- *
- * @param $filter
- * A SearchApiQueryFilterInterface object that should be added as a
- * subfilter.
- *
- * @return SearchApiQueryFilter
- * The called object.
+ * {@inheritdoc}
*/
public function filter(SearchApiQueryFilterInterface $filter) {
$this->filters[] = $filter;
@@ -1022,24 +1039,7 @@ class SearchApiQueryFilter implements SearchApiQueryFilterInterface {
}
/**
- * Add a new ($field $operator $value) condition.
- *
- * @param $field
- * The field to filter on, e.g. 'title'.
- * @param $value
- * The value the field should have (or be related to by the operator).
- * @param $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 SearchApiQueryFilter
- * The called object.
+ * {@inheritdoc}
*/
public function condition($field, $value, $operator = '=') {
$this->filters[] = array($field, $value, $operator);
@@ -1047,20 +1047,66 @@ class SearchApiQueryFilter implements SearchApiQueryFilterInterface {
}
/**
- * @return
- * The conjunction used by this filter - either 'AND' or 'OR'.
+ * {@inheritdoc}
*/
public function getConjunction() {
return $this->conjunction;
}
/**
- * @return array
- * An array containing this filter's subfilters. Each of these is either an
- * array (field, value, operator), or another SearchApiFilter object.
+ * {@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/sites/all/modules/contrib/search/search_api/includes/server_entity.inc b/sites/all/modules/contrib/search/search_api/includes/server_entity.inc
index 0436171..6ab8bd7 100644
--- a/sites/all/modules/contrib/search/search_api/includes/server_entity.inc
+++ b/sites/all/modules/contrib/search/search_api/includes/server_entity.inc
@@ -1,5 +1,10 @@
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();
- return $this->proxy->addIndex($index);
+ 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();
- return $this->proxy->fieldsUpdated($index);
+ 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();
- return $this->proxy->removeIndex($index);
+ 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();
- return $this->proxy->deleteItems($ids, $index);
+ 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();
+ }
+
}
diff --git a/sites/all/modules/contrib/search/search_api/includes/service.inc b/sites/all/modules/contrib/search/search_api/includes/service.inc
index 29fc637..046e5d3 100644
--- a/sites/all/modules/contrib/search/search_api/includes/service.inc
+++ b/sites/all/modules/contrib/search/search_api/includes/service.inc
@@ -1,16 +1,27 @@
- * listing all relevant settings is preferred.
+ * Displays this server's settings.
+ *
+ * Output can be HTML or a render array, a ' . nl2br(check_plain($description)) . '
'; + } - $output .= '' . $class_description . '
'; + if ($options) { + $label = t('Service options'); + $info = render($options); + $rows[] = _search_api_deep_copy($row); + } + + if ($status != ENTITY_CUSTOM) { + $label = t('Configuration status'); + $info = theme('entity_status', array('status' => $status)); + $class = ($status == ENTITY_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); } - $output .= '' . nl2br(check_plain($description)) . '
'; } - elseif ($server && $server->enabled) { - $output .= t('disabled (!enable_link)', array('!enable_link' => l(t('enable'), 'admin/config/search/search_api/index/' . $machine_name . '/enable', array('query' => array('token' => drupal_get_token($machine_name)))))); + + // 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' => drupal_get_token($machine_name)))))); } else { - $output .= t('disabled'); + $info = t('disabled'); } - $output .= '' . nl2br(check_plain($server->description)) . '
'; - } - $output .= '' . 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( @@ -1342,7 +1695,9 @@ function theme_search_api_admin_item_order(array $variables) { } /** - * Validation callback for search_api_admin_index_workflow. + * 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. @@ -1359,16 +1714,18 @@ function search_api_admin_index_workflow_validate(array $form, array &$form_stat } /** - * Submit callback for search_api_admin_index_workflow. + * 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; - $fields_set = !empty($options['fields']); // Store callback and processor settings. foreach ($form_state['callbacks'] as $name => $callback) { @@ -1386,6 +1743,7 @@ function search_api_admin_index_workflow_submit(array $form, array &$form_state) 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(); @@ -1394,7 +1752,8 @@ function search_api_admin_index_workflow_submit(array $form, array &$form_state) $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-alter callback. + // 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']))) { @@ -1411,16 +1770,6 @@ function search_api_admin_index_workflow_submit(array $form, array &$form_state) } } } - else { - // Callback was just disabled, remove its fields. - $properties = $callback->propertyInfo(); - if ($properties) { - foreach ($properties as $key => $field) { - unset($index->options['fields'][$key]); - } - } - - } } } @@ -1434,26 +1783,26 @@ function search_api_admin_index_workflow_submit(array $form, array &$form_state) uasort($index->options['data_alter_callbacks'], 'search_api_admin_element_compare'); uasort($index->options['processors'], 'search_api_admin_element_compare'); - // Reset the index's internal property cache to correctly incorporate the - // new data alterations. - $index->resetCaches(); + // 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(); - drupal_set_message(t("The search index' workflow was successfully edited. " . - 'All content was scheduled for re-indexing so the new settings can take effect.')); + $vars = array('@url' => url($index_path)); + drupal_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 { drupal_set_message(t('No values were changed.')); } - $form_state['redirect'] = 'admin/config/search/search_api/index/' . $index->machine_name . '/workflow'; + $form_state['redirect'] = $index_path . '/workflow'; } /** * Sort callback sorting array elements by their "weight" key, if present. * - * @see element_sort + * @see element_sort() */ function search_api_admin_element_compare($a, $b) { $a_weight = (is_array($a) && isset($a['weight'])) ? $a['weight'] : 0; @@ -1465,10 +1814,11 @@ function search_api_admin_element_compare($a, $b) { } /** - * Select the indexed fields. + * Form constructor for setting the indexed fields. * - * @param SearchApiIndex $index - * The index to edit. + * @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); @@ -1477,10 +1827,17 @@ function search_api_admin_index_fields(array $form, array &$form_state, SearchAp // An array of option arrays for types, keyed by nesting level. $types = array(0 => search_api_field_types()); - $fulltext_type = array(0 => 'text'); $entity_types = entity_get_info(); - $default_types = search_api_default_field_types(); - $boosts = drupal_map_assoc(array('0.1', '0.2', '0.3', '0.5', '0.8', '1.0', '2.0', '3.0', '5.0', '8.0', '13.0', '21.0')); + $boosts = drupal_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'; @@ -1488,17 +1845,22 @@ function search_api_admin_index_fields(array $form, array &$form_state, SearchAp $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. ' . + '#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))) . '
'; + $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', @@ -1510,17 +1872,20 @@ function search_api_admin_index_fields(array $form, array &$form_state, SearchAp '#default_value' => $info['indexed'], ); if (empty($info['entity_type'])) { - // Determine the correct type options (i.e., with the correct nesting level). + // 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. + // 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; } - $fulltext_type[$level] = $type_prefix . 'text' . $type_suffix; + foreach ($fulltext_types[0] as $type) { + $fulltext_types[$level][] = $type_prefix . $type . $type_suffix; + } } $css_key = '#edit-fields-' . drupal_clean_css_identifier($key); $form['fields'][$key]['type'] = array( @@ -1540,10 +1905,19 @@ function search_api_admin_index_fields(array $form, array &$form_state, SearchAp '#states' => array( 'visible' => array( $css_key . '-indexed' => array('checked' => TRUE), - $css_key . '-type' => array('value' => $fulltext_type[$level]), ), ), ); + // Only add the multiple visible states if the VERSION string is >= 7.14. + // See https://drupal.org/node/1464758. + if (version_compare(VERSION, '7.14', '>=')) { + 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. @@ -1587,12 +1961,17 @@ function search_api_admin_index_fields(array $form, array &$form_state, SearchAp } } + if (!empty($multi_valued_field_present)) { + $form['note']['#markup'] = '' . t('The following service classes are available for creating a search server.') . "
\n"; + $output .= implode("\n\n", $classes); + } + return $output; + case 'admin/config/search/search_api': + return '' . 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.') . '