1. 8.2.x core/modules/search/search.module
  2. 8.0.x core/modules/search/search.module
  3. 8.1.x core/modules/search/search.module
  4. 8.3.x core/modules/search/search.module
  5. 4.6.x modules/search.module
  6. 4.7.x modules/search.module
  7. 5.x modules/search/search.module
  8. 6.x modules/search/search.module
  9. 7.x modules/search/search.module

Enables site-wide keyword searching.

File

core/modules/search/search.module
View source
  1. <?php
  2. /**
  3. * @file
  4. * Enables site-wide keyword searching.
  5. */
  6. use Drupal\Component\Utility\Html;
  7. use Drupal\Component\Utility\Unicode;
  8. use Drupal\Core\Cache\Cache;
  9. use Drupal\Core\Form\FormStateInterface;
  10. use Drupal\Core\Routing\RouteMatchInterface;
  11. /**
  12. * Matches all 'N' Unicode character classes (numbers)
  13. */
  14. define('PREG_CLASS_NUMBERS',
  15. '\x{30}-\x{39}\x{b2}\x{b3}\x{b9}\x{bc}-\x{be}\x{660}-\x{669}\x{6f0}-\x{6f9}' .
  16. '\x{966}-\x{96f}\x{9e6}-\x{9ef}\x{9f4}-\x{9f9}\x{a66}-\x{a6f}\x{ae6}-\x{aef}' .
  17. '\x{b66}-\x{b6f}\x{be7}-\x{bf2}\x{c66}-\x{c6f}\x{ce6}-\x{cef}\x{d66}-\x{d6f}' .
  18. '\x{e50}-\x{e59}\x{ed0}-\x{ed9}\x{f20}-\x{f33}\x{1040}-\x{1049}\x{1369}-' .
  19. '\x{137c}\x{16ee}-\x{16f0}\x{17e0}-\x{17e9}\x{17f0}-\x{17f9}\x{1810}-\x{1819}' .
  20. '\x{1946}-\x{194f}\x{2070}\x{2074}-\x{2079}\x{2080}-\x{2089}\x{2153}-\x{2183}' .
  21. '\x{2460}-\x{249b}\x{24ea}-\x{24ff}\x{2776}-\x{2793}\x{3007}\x{3021}-\x{3029}' .
  22. '\x{3038}-\x{303a}\x{3192}-\x{3195}\x{3220}-\x{3229}\x{3251}-\x{325f}\x{3280}-' .
  23. '\x{3289}\x{32b1}-\x{32bf}\x{ff10}-\x{ff19}');
  24. /**
  25. * Matches all 'P' Unicode character classes (punctuation)
  26. */
  27. define('PREG_CLASS_PUNCTUATION',
  28. '\x{21}-\x{23}\x{25}-\x{2a}\x{2c}-\x{2f}\x{3a}\x{3b}\x{3f}\x{40}\x{5b}-\x{5d}' .
  29. '\x{5f}\x{7b}\x{7d}\x{a1}\x{ab}\x{b7}\x{bb}\x{bf}\x{37e}\x{387}\x{55a}-\x{55f}' .
  30. '\x{589}\x{58a}\x{5be}\x{5c0}\x{5c3}\x{5f3}\x{5f4}\x{60c}\x{60d}\x{61b}\x{61f}' .
  31. '\x{66a}-\x{66d}\x{6d4}\x{700}-\x{70d}\x{964}\x{965}\x{970}\x{df4}\x{e4f}' .
  32. '\x{e5a}\x{e5b}\x{f04}-\x{f12}\x{f3a}-\x{f3d}\x{f85}\x{104a}-\x{104f}\x{10fb}' .
  33. '\x{1361}-\x{1368}\x{166d}\x{166e}\x{169b}\x{169c}\x{16eb}-\x{16ed}\x{1735}' .
  34. '\x{1736}\x{17d4}-\x{17d6}\x{17d8}-\x{17da}\x{1800}-\x{180a}\x{1944}\x{1945}' .
  35. '\x{2010}-\x{2027}\x{2030}-\x{2043}\x{2045}-\x{2051}\x{2053}\x{2054}\x{2057}' .
  36. '\x{207d}\x{207e}\x{208d}\x{208e}\x{2329}\x{232a}\x{23b4}-\x{23b6}\x{2768}-' .
  37. '\x{2775}\x{27e6}-\x{27eb}\x{2983}-\x{2998}\x{29d8}-\x{29db}\x{29fc}\x{29fd}' .
  38. '\x{3001}-\x{3003}\x{3008}-\x{3011}\x{3014}-\x{301f}\x{3030}\x{303d}\x{30a0}' .
  39. '\x{30fb}\x{fd3e}\x{fd3f}\x{fe30}-\x{fe52}\x{fe54}-\x{fe61}\x{fe63}\x{fe68}' .
  40. '\x{fe6a}\x{fe6b}\x{ff01}-\x{ff03}\x{ff05}-\x{ff0a}\x{ff0c}-\x{ff0f}\x{ff1a}' .
  41. '\x{ff1b}\x{ff1f}\x{ff20}\x{ff3b}-\x{ff3d}\x{ff3f}\x{ff5b}\x{ff5d}\x{ff5f}-' .
  42. '\x{ff65}');
  43. /**
  44. * Matches CJK (Chinese, Japanese, Korean) letter-like characters.
  45. *
  46. * This list is derived from the "East Asian Scripts" section of
  47. * http://www.unicode.org/charts/index.html, as well as a comment on
  48. * http://unicode.org/reports/tr11/tr11-11.html listing some character
  49. * ranges that are reserved for additional CJK ideographs.
  50. *
  51. * The character ranges do not include numbers, punctuation, or symbols, since
  52. * these are handled separately in search. Note that radicals and strokes are
  53. * considered symbols. (See
  54. * http://www.unicode.org/Public/UNIDATA/extracted/DerivedGeneralCategory.txt)
  55. *
  56. * @see search_expand_cjk()
  57. */
  58. define('PREG_CLASS_CJK', '\x{1100}-\x{11FF}\x{3040}-\x{309F}\x{30A1}-\x{318E}' .
  59. '\x{31A0}-\x{31B7}\x{31F0}-\x{31FF}\x{3400}-\x{4DBF}\x{4E00}-\x{9FCF}' .
  60. '\x{A000}-\x{A48F}\x{A4D0}-\x{A4FD}\x{A960}-\x{A97F}\x{AC00}-\x{D7FF}' .
  61. '\x{F900}-\x{FAFF}\x{FF21}-\x{FF3A}\x{FF41}-\x{FF5A}\x{FF66}-\x{FFDC}' .
  62. '\x{20000}-\x{2FFFD}\x{30000}-\x{3FFFD}');
  63. /**
  64. * Implements hook_help().
  65. */
  66. function search_help($route_name, RouteMatchInterface $route_match) {
  67. switch ($route_name) {
  68. case 'help.page.search':
  69. $output = '';
  70. $output .= '<h3>' . t('About') . '</h3>';
  71. $output .= '<p>' . t('The Search module provides the ability to set up search pages based on plugins provided by other modules. In Drupal core, there are two page-type plugins: the Content page type provides keyword searching for content managed by the Node module, and the Users page type provides keyword searching for registered users. Contributed modules may provide other page-type plugins. For more information, see the <a href=":search-module">online documentation for the Search module</a>.', array(':search-module' => 'https://www.drupal.org/documentation/modules/search')) . '</p>';
  72. $output .= '<h3>' . t('Uses') . '</h3>';
  73. $output .= '<dl>';
  74. $output .= '<dt>' . t('Configuring search pages') . '</dt>';
  75. $output .= '<dd>' . t('To configure search pages, visit the <a href=":search-settings">Search pages page</a>. In the Search pages section, you can add a new search page, edit the configuration of existing search pages, enable and disable search pages, and choose the default search page. Each enabled search page has a URL path starting with <em>search</em>, and each will appear as a tab or local task link on the <a href=":search-url">search page</a>; you can configure the text that is shown in the tab. In addition, some search page plugins have additional settings that you can configure for each search page.', array(':search-settings' => \Drupal::url('entity.search_page.collection'), ':search-url' => \Drupal::url('search.view'))) . '</dd>';
  76. $output .= '<dt>' . t('Managing the search index') . '</dt>';
  77. $output .= '<dd>' . t('Some search page plugins, such as the core Content search page, index searchable text using the Drupal core search index, and will not work unless content is indexed. Indexing is done during <em>cron</em> runs, so it requires a <a href=":cron">cron maintenance task</a> to be set up. There are also several settings affecting indexing that can be configured on the <a href=":search-settings">Search pages page</a>: the number of items to index per cron run, the minimum word length to index, and how to handle Chinese, Japanese, and Korean characters.', array(':cron' => \Drupal::url('system.cron_settings'), ':search-settings' => \Drupal::url('entity.search_page.collection'))) . '</dd>';
  78. $output .= '<dd>' . t('Modules providing search page plugins generally ensure that content-related actions on your site (creating, editing, or deleting content and comments) automatically cause affected content items to be marked for indexing or reindexing at the next cron run. When content is marked for reindexing, the previous content remains in the index until cron runs, at which time it is replaced by the new content. However, there are some actions related to the structure of your site that do not cause affected content to be marked for reindexing. Examples of structure-related actions that affect content include deleting or editing taxonomy terms, enabling or disabling modules that add text to content (such as Taxonomy, Comment, and field-providing modules), and modifying the fields or display parameters of your content types. If you take one of these actions and you want to ensure that the search index is updated to reflect your changed site structure, you can mark all content for reindexing by clicking the "Re-index site" button on the <a href=":search-settings">Search pages page</a>. If you have a lot of content on your site, it may take several cron runs for the content to be reindexed.', array(':search-settings' => \Drupal::url('entity.search_page.collection'))) . '</dd>';
  79. $output .= '<dt>' . t('Displaying the Search block') . '</dt>';
  80. $output .= '<dd>' . t('The Search module includes a block, which can be enabled and configured on the <a href=":blocks">Block layout page</a>, if you have the Block module enabled; the default block title is Search, and it is the Search form block in the Forms category, if you wish to add another instance. The block is available to users with the <a href=":search_permission">Use search</a> permission, and it performs a search using the configured default search page.', array(':blocks' => (\Drupal::moduleHandler()->moduleExists('block')) ? \Drupal::url('block.admin_display') : '#', ':search_permission' => \Drupal::url('user.admin_permissions', array(), array('fragment' => 'module-search')))) . '</dd>';
  81. $output .= '<dt>' . t('Searching your site') . '</dt>';
  82. $output .= '<dd>' . t('Users with <a href=":search_permission">Use search</a> permission can use the Search block and <a href=":search">Search page</a>. Users with the <a href=":node_permission">View published content</a> permission can use configured search pages of type <em>Content</em> to search for content containing exact keywords; in addition, users with <a href=":search_permission">Use advanced search</a> permission can use more complex search filtering. Users with the <a href=":user_permission">View user information</a> permission can use configured search pages of type <em>Users</em> to search for active users containing the keyword anywhere in the username, and users with the <a href=":user_permission">Administer users</a> permission can search for active and blocked users, by email address or username keyword.', array(':search' => \Drupal::url('search.view'), ':search_permission' => \Drupal::url('user.admin_permissions', array(), array('fragment' => 'module-search')), ':node_permission' => \Drupal::url('user.admin_permissions', array(), array('fragment' => 'module-node')), ':user_permission' => \Drupal::url('user.admin_permissions', array(), array('fragment' => 'module-user')))) . '</dd>';
  83. $output .= '<dt>' . t('Extending the Search module') . '</dt>';
  84. $output .= '<dd>' . t('By default, the Search module only supports exact keyword matching in content searches. You can modify this behavior by installing a language-specific stemming module for your language (such as <a href=":porterstemmer_url">Porter Stemmer</a> for American English), which allows words such as walk, walking, and walked to be matched in the Search module. Another approach is to use a third-party search technology with stemming or partial word matching features built in, such as <a href=":solr_url">Apache Solr</a> or <a href=":sphinx_url">Sphinx</a>. There are also contributed modules that provide additional search pages. These and other <a href=":contrib-search">search-related contributed modules</a> can be downloaded by visiting Drupal.org.', array(':contrib-search' => 'https://www.drupal.org/project/project_module?f[2]=im_vid_3%3A105', ':porterstemmer_url' => 'https://www.drupal.org/project/porterstemmer', ':solr_url' => 'https://www.drupal.org/project/apachesolr', ':sphinx_url' => 'https://www.drupal.org/project/sphinx')) . '</dd>';
  85. $output .= '</dl>';
  86. return $output;
  87. }
  88. }
  89. /**
  90. * Implements hook_theme().
  91. */
  92. function search_theme() {
  93. return array(
  94. 'search_result' => array(
  95. 'variables' => array('result' => NULL, 'plugin_id' => NULL),
  96. 'file' => 'search.pages.inc',
  97. ),
  98. );
  99. }
  100. /**
  101. * Implements hook_preprocess_HOOK() for block templates.
  102. */
  103. function search_preprocess_block(&$variables) {
  104. if ($variables['plugin_id'] == 'search_form_block') {
  105. $variables['attributes']['role'] = 'search';
  106. }
  107. }
  108. /**
  109. * Clears either a part of, or the entire search index.
  110. *
  111. * This function is meant for use by search page plugins, or for building a
  112. * user interface that lets users clear all or parts of the search index.
  113. *
  114. * @param string|null $type
  115. * (optional) The plugin ID or other machine-readable type for the items to
  116. * remove from the search index. If omitted, $sid and $langcode are ignored
  117. * and the entire search index is cleared.
  118. * @param string|null $sid
  119. * (optional) The ID of the items to remove from the search index. If
  120. * omitted, all items matching $type are cleared, and $langcode is ignored.
  121. * @param string|null $langcode
  122. * (optional) Language code of the item to remove from the search index. If
  123. * omitted, all items matching $sid and $type are cleared.
  124. */
  125. function search_index_clear($type = NULL, $sid = NULL, $langcode = NULL) {
  126. $query_index = db_delete('search_index');
  127. $query_dataset = db_delete('search_dataset');
  128. if ($type) {
  129. $query_index->condition('type', $type);
  130. $query_dataset->condition('type', $type);
  131. if ($sid) {
  132. $query_index->condition('sid', $sid);
  133. $query_dataset->condition('sid', $sid);
  134. if ($langcode) {
  135. $query_index->condition('langcode', $langcode);
  136. $query_dataset->condition('langcode', $langcode);
  137. }
  138. }
  139. }
  140. $query_index->execute();
  141. $query_dataset->execute();
  142. if ($type) {
  143. // Invalidate all render cache items that contain data from this index.
  144. Cache::invalidateTags(['search_index:' . $type]);
  145. }
  146. else {
  147. // Invalidate all render cache items that contain data from any index.
  148. Cache::invalidateTags(['search_index']);
  149. }
  150. }
  151. /**
  152. * Marks a word as "dirty" (changed), or retrieves the list of dirty words.
  153. *
  154. * This is used during indexing (cron). Words that are dirty have outdated
  155. * total counts in the search_total table, and need to be recounted.
  156. */
  157. function search_dirty($word = NULL) {
  158. $dirty = &drupal_static(__FUNCTION__, array());
  159. if ($word !== NULL) {
  160. $dirty[$word] = TRUE;
  161. }
  162. else {
  163. return $dirty;
  164. }
  165. }
  166. /**
  167. * Implements hook_cron().
  168. *
  169. * Fires updateIndex() in the plugins for all indexable active search pages,
  170. * and cleans up dirty words.
  171. *
  172. * @see search_dirty()
  173. */
  174. function search_cron() {
  175. // We register a shutdown function to ensure that search_total is always up
  176. // to date.
  177. drupal_register_shutdown_function('search_update_totals');
  178. /** @var $search_page_repository \Drupal\search\SearchPageRepositoryInterface */
  179. $search_page_repository = \Drupal::service('search.search_page_repository');
  180. foreach ($search_page_repository->getIndexableSearchPages() as $entity) {
  181. $entity->getPlugin()->updateIndex();
  182. }
  183. }
  184. /**
  185. * Updates the {search_total} database table.
  186. *
  187. * This function is called on shutdown to ensure that {search_total} is always
  188. * up to date (even if cron times out or otherwise fails).
  189. */
  190. function search_update_totals() {
  191. // Update word IDF (Inverse Document Frequency) counts for new/changed words.
  192. foreach (search_dirty() as $word => $dummy) {
  193. // Get total count
  194. $total = db_query("SELECT SUM(score) FROM {search_index} WHERE word = :word", array(':word' => $word), array('target' => 'replica'))->fetchField();
  195. // Apply Zipf's law to equalize the probability distribution.
  196. $total = log10(1 + 1 / (max(1, $total)));
  197. db_merge('search_total')
  198. ->key('word', $word)
  199. ->fields(array('count' => $total))
  200. ->execute();
  201. }
  202. // Find words that were deleted from search_index, but are still in
  203. // search_total. We use a LEFT JOIN between the two tables and keep only the
  204. // rows which fail to join.
  205. $result = db_query("SELECT t.word AS realword, i.word FROM {search_total} t LEFT JOIN {search_index} i ON t.word = i.word WHERE i.word IS NULL", array(), array('target' => 'replica'));
  206. $or = db_or();
  207. foreach ($result as $word) {
  208. $or->condition('word', $word->realword);
  209. }
  210. if (count($or) > 0) {
  211. db_delete('search_total')
  212. ->condition($or)
  213. ->execute();
  214. }
  215. }
  216. /**
  217. * Simplifies and preprocesses text for searching.
  218. *
  219. * Processing steps:
  220. * - Entities are decoded.
  221. * - Text is lower-cased and diacritics (accents) are removed.
  222. * - hook_search_preprocess() is invoked.
  223. * - CJK (Chinese, Japanese, Korean) characters are processed, depending on
  224. * the search settings.
  225. * - Punctuation is processed (removed or replaced with spaces, depending on
  226. * where it is; see code for details).
  227. * - Words are truncated to 50 characters maximum.
  228. *
  229. * @param string $text
  230. * Text to simplify.
  231. * @param string|null $langcode
  232. * Language code for the language of $text, if known.
  233. *
  234. * @return string
  235. * Simplified and processed text.
  236. *
  237. * @see hook_search_preprocess()
  238. */
  239. function search_simplify($text, $langcode = NULL) {
  240. // Decode entities to UTF-8
  241. $text = Html::decodeEntities($text);
  242. // Lowercase
  243. $text = Unicode::strtolower($text);
  244. // Remove diacritics.
  245. $text = \Drupal::service('transliteration')->removeDiacritics($text);
  246. // Call an external processor for word handling.
  247. search_invoke_preprocess($text, $langcode);
  248. // Simple CJK handling
  249. if (\Drupal::config('search.settings')->get('index.overlap_cjk')) {
  250. $text = preg_replace_callback('/[' . PREG_CLASS_CJK . ']+/u', 'search_expand_cjk', $text);
  251. }
  252. // To improve searching for numerical data such as dates, IP addresses
  253. // or version numbers, we consider a group of numerical characters
  254. // separated only by punctuation characters to be one piece.
  255. // This also means that searching for e.g. '20/03/1984' also returns
  256. // results with '20-03-1984' in them.
  257. // Readable regexp: ([number]+)[punctuation]+(?=[number])
  258. $text = preg_replace('/([' . PREG_CLASS_NUMBERS . ']+)[' . PREG_CLASS_PUNCTUATION . ']+(?=[' . PREG_CLASS_NUMBERS . '])/u', '\1', $text);
  259. // Multiple dot and dash groups are word boundaries and replaced with space.
  260. // No need to use the unicode modifier here because 0-127 ASCII characters
  261. // can't match higher UTF-8 characters as the leftmost bit of those are 1.
  262. $text = preg_replace('/[.-]{2,}/', ' ', $text);
  263. // The dot, underscore and dash are simply removed. This allows meaningful
  264. // search behavior with acronyms and URLs. See unicode note directly above.
  265. $text = preg_replace('/[._-]+/', '', $text);
  266. // With the exception of the rules above, we consider all punctuation,
  267. // marks, spacers, etc, to be a word boundary.
  268. $text = preg_replace('/[' . Unicode::PREG_CLASS_WORD_BOUNDARY . ']+/u', ' ', $text);
  269. // Truncate everything to 50 characters.
  270. $words = explode(' ', $text);
  271. array_walk($words, '_search_index_truncate');
  272. $text = implode(' ', $words);
  273. return $text;
  274. }
  275. /**
  276. * Splits CJK (Chinese, Japanese, Korean) text into tokens.
  277. *
  278. * The Search module matches exact words, where a word is defined to be a
  279. * sequence of characters delimited by spaces or punctuation. CJK languages are
  280. * written in long strings of characters, though, not split up into words. So
  281. * in order to allow search matching, we split up CJK text into tokens
  282. * consisting of consecutive, overlapping sequences of characters whose length
  283. * is equal to the 'minimum_word_size' variable. This tokenizing is only done
  284. * if the 'overlap_cjk' variable is TRUE.
  285. *
  286. * @param array $matches
  287. * This function is a callback for preg_replace_callback(), which is called
  288. * from search_simplify(). So, $matches is an array of regular expression
  289. * matches, which means that $matches[0] contains the matched text -- a
  290. * string of CJK characters to tokenize.
  291. *
  292. * @return string
  293. * Tokenized text, starting and ending with a space character.
  294. */
  295. function search_expand_cjk($matches) {
  296. $min = \Drupal::config('search.settings')->get('index.minimum_word_size');
  297. $str = $matches[0];
  298. $length = Unicode::strlen($str);
  299. // If the text is shorter than the minimum word size, don't tokenize it.
  300. if ($length <= $min) {
  301. return ' ' . $str . ' ';
  302. }
  303. $tokens = ' ';
  304. // Build a FIFO queue of characters.
  305. $chars = array();
  306. for ($i = 0; $i < $length; $i++) {
  307. // Add the next character off the beginning of the string to the queue.
  308. $current = Unicode::substr($str, 0, 1);
  309. $str = substr($str, strlen($current));
  310. $chars[] = $current;
  311. if ($i >= $min - 1) {
  312. // Make a token of $min characters, and add it to the token string.
  313. $tokens .= implode('', $chars) . ' ';
  314. // Shift out the first character in the queue.
  315. array_shift($chars);
  316. }
  317. }
  318. return $tokens;
  319. }
  320. /**
  321. * Simplifies and splits a string into words for indexing.
  322. *
  323. * @param string $text
  324. * Text to process.
  325. * @param string|null $langcode
  326. * Language code for the language of $text, if known.
  327. *
  328. * @return array
  329. * Array of words in the simplified, preprocessed text.
  330. *
  331. * @see search_simplify()
  332. */
  333. function search_index_split($text, $langcode = NULL) {
  334. $last = &drupal_static(__FUNCTION__);
  335. $lastsplit = &drupal_static(__FUNCTION__ . ':lastsplit');
  336. if ($last == $text) {
  337. return $lastsplit;
  338. }
  339. // Process words
  340. $text = search_simplify($text, $langcode);
  341. $words = explode(' ', $text);
  342. // Save last keyword result
  343. $last = $text;
  344. $lastsplit = $words;
  345. return $words;
  346. }
  347. /**
  348. * Helper function for array_walk in search_index_split.
  349. */
  350. function _search_index_truncate(&$text) {
  351. // Use a static array to avoid re-truncating text we've done before.
  352. // The same words may often be passed in during excerpt generation.
  353. static $truncated = array();
  354. if (isset($truncated[$text])) {
  355. $text = $truncated[$text];
  356. return;
  357. }
  358. // If we didn't find it in the static array, perform the operation.
  359. $original = $text;
  360. if (is_numeric($text)) {
  361. $text = ltrim($text, '0');
  362. }
  363. $text = Unicode::truncate($text, 50);
  364. // Save it for the next time.
  365. $truncated[$original] = $text;
  366. }
  367. /**
  368. * Invokes hook_search_preprocess() to simplify text.
  369. *
  370. * @param string $text
  371. * Text to preprocess, passed by reference and altered in place.
  372. * @param string|null $langcode
  373. * Language code for the language of $text, if known.
  374. */
  375. function search_invoke_preprocess(&$text, $langcode = NULL) {
  376. foreach (\Drupal::moduleHandler()->getImplementations('search_preprocess') as $module) {
  377. $text = \Drupal::moduleHandler()->invoke($module, 'search_preprocess', array($text, $langcode));
  378. }
  379. }
  380. /**
  381. * Updates the full-text search index for a particular item.
  382. *
  383. * @param string $type
  384. * The plugin ID or other machine-readable type of this item,
  385. * which should be less than 64 bytes.
  386. * @param int $sid
  387. * An ID number identifying this particular item (e.g., node ID).
  388. * @param string $langcode
  389. * Language code for the language of the text being indexed.
  390. * @param string $text
  391. * The content of this item. Must be a piece of HTML or plain text.
  392. *
  393. * @ingroup search
  394. */
  395. function search_index($type, $sid, $langcode, $text) {
  396. $minimum_word_size = \Drupal::config('search.settings')->get('index.minimum_word_size');
  397. // Multipliers for scores of words inside certain HTML tags. The weights are
  398. // stored in config so that modules can overwrite the default weights.
  399. // Note: 'a' must be included for link ranking to work.
  400. $tags = \Drupal::config('search.settings')->get('index.tag_weights');
  401. // Strip off all ignored tags to speed up processing, but insert space before
  402. // and after them to keep word boundaries.
  403. $text = str_replace(array('<', '>'), array(' <', '> '), $text);
  404. $text = strip_tags($text, '<' . implode('><', array_keys($tags)) . '>');
  405. // Split HTML tags from plain text.
  406. $split = preg_split('/\s*<([^>]+?)>\s*/', $text, -1, PREG_SPLIT_DELIM_CAPTURE);
  407. // Note: PHP ensures the array consists of alternating delimiters and literals
  408. // and begins and ends with a literal (inserting $null as required).
  409. $tag = FALSE; // Odd/even counter. Tag or no tag.
  410. $score = 1; // Starting score per word
  411. $accum = ' '; // Accumulator for cleaned up data
  412. $tagstack = array(); // Stack with open tags
  413. $tagwords = 0; // Counter for consecutive words
  414. $focus = 1; // Focus state
  415. $scored_words = array(); // Accumulator for words for index
  416. foreach ($split as $value) {
  417. if ($tag) {
  418. // Increase or decrease score per word based on tag
  419. list($tagname) = explode(' ', $value, 2);
  420. $tagname = Unicode::strtolower($tagname);
  421. // Closing or opening tag?
  422. if ($tagname[0] == '/') {
  423. $tagname = substr($tagname, 1);
  424. // If we encounter unexpected tags, reset score to avoid incorrect boosting.
  425. if (!count($tagstack) || $tagstack[0] != $tagname) {
  426. $tagstack = array();
  427. $score = 1;
  428. }
  429. else {
  430. // Remove from tag stack and decrement score
  431. $score = max(1, $score - $tags[array_shift($tagstack)]);
  432. }
  433. }
  434. else {
  435. if (isset($tagstack[0]) && $tagstack[0] == $tagname) {
  436. // None of the tags we look for make sense when nested identically.
  437. // If they are, it's probably broken HTML.
  438. $tagstack = array();
  439. $score = 1;
  440. }
  441. else {
  442. // Add to open tag stack and increment score
  443. array_unshift($tagstack, $tagname);
  444. $score += $tags[$tagname];
  445. }
  446. }
  447. // A tag change occurred, reset counter.
  448. $tagwords = 0;
  449. }
  450. else {
  451. // Note: use of PREG_SPLIT_DELIM_CAPTURE above will introduce empty values
  452. if ($value != '') {
  453. $words = search_index_split($value, $langcode);
  454. foreach ($words as $word) {
  455. // Add word to accumulator
  456. $accum .= $word . ' ';
  457. // Check wordlength
  458. if (is_numeric($word) || Unicode::strlen($word) >= $minimum_word_size) {
  459. if (!isset($scored_words[$word])) {
  460. $scored_words[$word] = 0;
  461. }
  462. $scored_words[$word] += $score * $focus;
  463. // Focus is a decaying value in terms of the amount of unique words up to this point.
  464. // From 100 words and more, it decays, to e.g. 0.5 at 500 words and 0.3 at 1000 words.
  465. $focus = min(1, .01 + 3.5 / (2 + count($scored_words) * .015));
  466. }
  467. $tagwords++;
  468. // Too many words inside a single tag probably mean a tag was accidentally left open.
  469. if (count($tagstack) && $tagwords >= 15) {
  470. $tagstack = array();
  471. $score = 1;
  472. }
  473. }
  474. }
  475. }
  476. $tag = !$tag;
  477. }
  478. // Remove the item $sid from the search index, and invalidate the relevant
  479. // cache tags.
  480. search_index_clear($type, $sid, $langcode);
  481. // Insert cleaned up data into dataset
  482. db_insert('search_dataset')
  483. ->fields(array(
  484. 'sid' => $sid,
  485. 'langcode' => $langcode,
  486. 'type' => $type,
  487. 'data' => $accum,
  488. 'reindex' => 0,
  489. ))
  490. ->execute();
  491. // Insert results into search index
  492. foreach ($scored_words as $word => $score) {
  493. // If a word already exists in the database, its score gets increased
  494. // appropriately. If not, we create a new record with the appropriate
  495. // starting score.
  496. db_merge('search_index')
  497. ->keys(array(
  498. 'word' => $word,
  499. 'sid' => $sid,
  500. 'langcode' => $langcode,
  501. 'type' => $type,
  502. ))
  503. ->fields(array('score' => $score))
  504. ->expression('score', 'score + :score', array(':score' => $score))
  505. ->execute();
  506. search_dirty($word);
  507. }
  508. }
  509. /**
  510. * Changes the timestamp on indexed items to 'now' to force reindexing.
  511. *
  512. * This function is meant for use by search page plugins, or for building a
  513. * user interface that lets users mark all or parts of the search index for
  514. * reindexing.
  515. *
  516. * @param string $type
  517. * (optional) The plugin ID or other machine-readable type of this item. If
  518. * omitted, the entire search index is marked for reindexing, and $sid and
  519. * $langcode are ignored.
  520. * @param int $sid
  521. * (optional) An ID number identifying this particular item (e.g., node ID).
  522. * If omitted, everything matching $type is marked, and $langcode is ignored.
  523. * @param string $langcode
  524. * (optional) The language code to clear. If omitted, everything matching
  525. * $type and $sid is marked.
  526. */
  527. function search_mark_for_reindex($type = NULL, $sid = NULL, $langcode = NULL) {
  528. $query = db_update('search_dataset')
  529. ->fields(array('reindex' => REQUEST_TIME))
  530. // Only mark items that were not previously marked for reindex, so that
  531. // marked items maintain their priority by request time.
  532. ->condition('reindex', 0);
  533. if ($type) {
  534. $query->condition('type', $type);
  535. if ($sid) {
  536. $query->condition('sid', $sid);
  537. if ($langcode) {
  538. $query->condition('langcode', $langcode);
  539. }
  540. }
  541. }
  542. $query->execute();
  543. }
  544. /**
  545. * @defgroup search Search interface
  546. * @{
  547. * The Drupal search interface manages a global search mechanism.
  548. *
  549. * Modules may plug into this system to provide searches of different types of
  550. * data. Most of the system is handled by the Search module, so this must be
  551. * enabled for all of the search features to work.
  552. *
  553. * There are two ways to interact with the search system:
  554. * - Specifically for searching nodes, you can implement
  555. * hook_node_update_index() and hook_node_search_result(). However, note that
  556. * the search system already indexes all visible output of a node; i.e.,
  557. * everything displayed normally during node viewing. This is
  558. * usually sufficient. You should only use this mechanism if you want
  559. * additional, non-visible data to be indexed.
  560. * - Define a plugin implementing \Drupal\search\Plugin\SearchInterface and
  561. * annotated as \Drupal\search\Annotation\SearchPlugin. This will create a
  562. * search page type that users can use to set up one or more search pages.
  563. * Each of these corresponds to a tab on the /search page, which can be
  564. * used to perform searches. You will also need to implement the execute()
  565. * method from the interface to perform the search. A base class is provided
  566. * in \Drupal\search\Plugin\SearchPluginBase. For more information about
  567. * plugins, see the @link plugin_api Plugin API topic. @endlink
  568. *
  569. * If your module needs to provide a more complicated search form, then you
  570. * need to implement it yourself. In that case, you may wish to define it as a
  571. * local task (tab) under the /search page (e.g. /search/mymodule) so that users
  572. * can easily find it.
  573. *
  574. * @see plugin_api
  575. * @see annotation
  576. */
  577. /**
  578. * Returns snippets from a piece of text, with search keywords highlighted.
  579. *
  580. * Used for formatting search results. All HTML tags will be stripped from
  581. * $text.
  582. *
  583. * @param string $keys
  584. * A string containing a search query.
  585. * @param string $text
  586. * The text to extract fragments from.
  587. * @param string|null $langcode
  588. * Language code for the language of $text, if known.
  589. *
  590. * @return array
  591. * A render array containing HTML for the excerpt.
  592. */
  593. function search_excerpt($keys, $text, $langcode = NULL) {
  594. // We highlight around non-indexable or CJK characters.
  595. $boundary_character = '[' . Unicode::PREG_CLASS_WORD_BOUNDARY . PREG_CLASS_CJK . ']';
  596. $preceded_by_boundary = '(?<=' . $boundary_character . ')';
  597. $followed_by_boundary = '(?=' . $boundary_character . ')';
  598. // Extract positive keywords and phrases.
  599. preg_match_all('/ ("([^"]+)"|(?!OR)([^" ]+))/', ' ' . $keys, $matches);
  600. $keys = array_merge($matches[2], $matches[3]);
  601. // Prepare text by stripping HTML tags and decoding HTML entities.
  602. $text = strip_tags(str_replace(array('<', '>'), array(' <', '> '), $text));
  603. $text = Html::decodeEntities($text);
  604. $text_length = strlen($text);
  605. // Make a list of unique keywords that are actually found in the text,
  606. // which could be items in $keys or replacements that are equivalent through
  607. // search_simplify().
  608. $temp_keys = array();
  609. foreach ($keys as $key) {
  610. $key = _search_find_match_with_simplify($key, $text, $boundary_character, $langcode);
  611. if (isset($key)) {
  612. // Quote slashes so they can be used in regular expressions.
  613. $temp_keys[] = preg_quote($key, '/');
  614. }
  615. }
  616. // Several keywords could have simplified down to the same thing, so pick
  617. // out the unique ones.
  618. $keys = array_unique($temp_keys);
  619. // Extract fragments of about 60 characters around keywords, bounded by word
  620. // boundary characters. Try to reach 256 characters, using second occurrences
  621. // if necessary.
  622. $ranges = array();
  623. $length = 0;
  624. $look_start = array();
  625. $remaining_keys = $keys;
  626. while ($length < 256 && !empty($remaining_keys)) {
  627. $found_keys = array();
  628. foreach ($remaining_keys as $key) {
  629. if ($length >= 256) {
  630. break;
  631. }
  632. // Remember where we last found $key, in case we are coming through a
  633. // second time.
  634. if (!isset($look_start[$key])) {
  635. $look_start[$key] = 0;
  636. }
  637. // See if we can find $key after where we found it the last time. Since
  638. // we are requiring a match on a word boundary, make sure $text starts
  639. // and ends with a space.
  640. $matches = array();
  641. if (preg_match('/' . $preceded_by_boundary . $key . $followed_by_boundary . '/iu', ' ' . $text . ' ', $matches, PREG_OFFSET_CAPTURE, $look_start[$key])) {
  642. $found_position = $matches[0][1];
  643. $look_start[$key] = $found_position + 1;
  644. // Keep track of which keys we found this time, in case we need to
  645. // pass through again to find more text.
  646. $found_keys[] = $key;
  647. // Locate a space before and after this match, leaving about 60
  648. // characters of context on each end.
  649. $before = strpos(' ' . $text, ' ', max(0, $found_position - 61));
  650. if ($before !== FALSE && $before <= $found_position) {
  651. if ($text_length > $found_position + 60) {
  652. $after = strrpos(substr($text, 0, $found_position + 60), ' ', $found_position);
  653. }
  654. else {
  655. $after = $text_length;
  656. }
  657. if ($after !== FALSE && $after > $found_position) {
  658. // Account for the spaces we added.
  659. $before = max($before - 1, 0);
  660. if ($before < $after) {
  661. // Save this range.
  662. $ranges[$before] = $after;
  663. $length += $after - $before;
  664. }
  665. }
  666. }
  667. }
  668. }
  669. // Next time through this loop, only look for keys we found this time,
  670. // if any.
  671. $remaining_keys = $found_keys;
  672. }
  673. if (empty($ranges)) {
  674. // We didn't find any keyword matches, so just return the first part of the
  675. // text. We also need to re-encode any HTML special characters that we
  676. // entity-decoded above.
  677. return [
  678. '#plain_text' => Unicode::truncate($text, 256, TRUE, TRUE),
  679. ];
  680. }
  681. // Sort the text ranges by starting position.
  682. ksort($ranges);
  683. // Collapse overlapping text ranges into one. The sorting makes it O(n).
  684. $new_ranges = array();
  685. $max_end = 0;
  686. foreach ($ranges as $this_from => $this_to) {
  687. $max_end = max($max_end, $this_to);
  688. if (!isset($working_from)) {
  689. // This is the first time through this loop: initialize.
  690. $working_from = $this_from;
  691. $working_to = $this_to;
  692. continue;
  693. }
  694. if ($this_from <= $working_to) {
  695. // The ranges overlap: combine them.
  696. $working_to = max($working_to, $this_to);
  697. }
  698. else {
  699. // The ranges do not overlap: save the working range and start a new one.
  700. $new_ranges[$working_from] = $working_to;
  701. $working_from = $this_from;
  702. $working_to = $this_to;
  703. }
  704. }
  705. // Save the remaining working range.
  706. $new_ranges[$working_from] = $working_to;
  707. // Fetch text within the combined ranges we found.
  708. $out = array();
  709. foreach ($new_ranges as $from => $to) {
  710. $out[] = substr($text, $from, $to - $from);
  711. }
  712. // Combine the text chunks with "…" separators. The "…" needs to be
  713. // translated. Let translators have the … separator text as one chunk.
  714. $ellipses = explode('@excerpt', t('… @excerpt … @excerpt …'));
  715. $text = (isset($new_ranges[0]) ? '' : $ellipses[0]) . implode($ellipses[1], $out) . (($max_end < strlen($text) - 1) ? $ellipses[2] : '');
  716. $text = Html::escape($text);
  717. // Highlight keywords. Must be done at once to prevent conflicts ('strong'
  718. // and '<strong>').
  719. $text = trim(preg_replace('/' . $preceded_by_boundary . '(?:' . implode('|', $keys) . ')' . $followed_by_boundary . '/iu', '<strong>\0</strong>', ' ' . $text . ' '));
  720. return [
  721. '#markup' => $text,
  722. '#allowed_tags' => ['strong']
  723. ];
  724. }
  725. /**
  726. * @} End of "defgroup search".
  727. */
  728. /**
  729. * Finds an appropriate keyword in text.
  730. *
  731. * @param string $key
  732. * The keyword to find.
  733. * @param string $text
  734. * The text to search for the keyword.
  735. * @param string $boundary
  736. * Regular expression for the boundary character class (characters that
  737. * indicate spaces between words).
  738. * @param string|null $langcode
  739. * Language code for the language of $text, if known.
  740. *
  741. * @return string|null
  742. * A segment of $text that is between word boundary characters that either
  743. * matches $key directly, or matches $key when both this text segment and
  744. * $key are processed by search_simplify(). If a matching text segment is
  745. * not located, NULL is returned.
  746. */
  747. function _search_find_match_with_simplify($key, $text, $boundary, $langcode = NULL) {
  748. $preceded_by_boundary = '(?<=' . $boundary . ')';
  749. $followed_by_boundary = '(?=' . $boundary . ')';
  750. // See if $key appears as-is. When testing, make sure $text starts/ends with
  751. // a space, because we require $key to be surrounded by word boundary
  752. // characters.
  753. $temp = trim($key);
  754. if ($temp == '') {
  755. return NULL;
  756. }
  757. if (preg_match('/' . $preceded_by_boundary . preg_quote($temp, '/') . $followed_by_boundary . '/iu', ' ' . $text . ' ')) {
  758. return $temp;
  759. }
  760. // See if there is a match after lower-casing and removing diacritics in
  761. // both, which should preserve the string length.
  762. $new_text = Unicode::strtolower($text);
  763. $new_text = \Drupal::service('transliteration')->removeDiacritics($new_text);
  764. $new_key = Unicode::strtolower($temp);
  765. $new_key = \Drupal::service('transliteration')->removeDiacritics($new_key);
  766. if (preg_match('/' . $preceded_by_boundary . preg_quote($new_key, '/') . $followed_by_boundary . '/u', ' ' . $new_text . ' ')) {
  767. $position = Unicode::strpos($new_text, $new_key);
  768. return Unicode::substr($text, $position, Unicode::strlen($new_key));
  769. }
  770. // Run both text and key through search_simplify.
  771. $simplified_key = trim(search_simplify($key, $langcode));
  772. $simplified_text = trim(search_simplify($text, $langcode));
  773. if ($simplified_key == '' || $simplified_text == '' || strpos($simplified_text, $simplified_key) === FALSE) {
  774. // The simplified keyword and text do not match at all, or are empty.
  775. return NULL;
  776. }
  777. // Split $text into words, keeping track of where the word boundaries are.
  778. $words = preg_split('/' . $boundary . '+/u', $text, NULL, PREG_SPLIT_OFFSET_CAPTURE);
  779. // Add an entry pointing to the end of the string, for the loop below.
  780. $words[] = array('', strlen($text));
  781. // Using a binary search, find the earliest possible ending position in
  782. // $text where it will still match the keyword after applying
  783. // search_simplify().
  784. $start_index = 0;
  785. $start_pos = $words[$start_index][1];
  786. $min_end_index = 1;
  787. $max_end_index = count($words) - 1;
  788. while ($max_end_index > $min_end_index) {
  789. // Check the index half way between min and max. See if we ended there,
  790. // if we would still have a match.
  791. $proposed_end_index = floor(($max_end_index + $min_end_index) / 2);
  792. $proposed_end_pos = $words[$proposed_end_index][1];
  793. // Since the split was done with preg_split(), the positions are byte counts
  794. // not character counts, so use substr() not Unicode::substr() here.
  795. $trial_text = trim(search_simplify(substr($text, $start_pos, $proposed_end_pos - $start_pos), $langcode));
  796. if (strpos($trial_text, $simplified_key) !== FALSE) {
  797. // The proposed endpoint is fine, text still matches.
  798. $max_end_index = $proposed_end_index;
  799. }
  800. else {
  801. // The proposed endpoint index is too early, so the earliest possible
  802. // OK ending point would be the next index.
  803. $min_end_index = $proposed_end_index + 1;
  804. }
  805. }
  806. // Now do the same for the starting position: using a binary search, find the
  807. // latest possible starting position in $text where it will still match the
  808. // keyword after applying search_simplify().
  809. $end_index = $min_end_index;
  810. $end_pos = $words[$end_index][1];
  811. $min_start_index = 0;
  812. $max_start_index = $end_index - 1;
  813. while ($max_start_index > $min_start_index) {
  814. // Check the index half way between min and max. See if we started there,
  815. // if we would still have a match.
  816. $proposed_start_index = ceil(($max_start_index + $min_start_index) / 2);
  817. $proposed_start_pos = $words[$proposed_start_index][1];
  818. // Since the split was done with preg_split(), the positions are byte counts
  819. // not character counts, so use substr() not Unicode::substr() here.
  820. $trial_text = trim(search_simplify(substr($text, $proposed_start_pos, $end_pos - $proposed_start_pos), $langcode));
  821. if (strpos($trial_text, $simplified_key) !== FALSE) {
  822. // The proposed start point is fine, text still matches.
  823. $min_start_index = $proposed_start_index;
  824. }
  825. else {
  826. // The proposed start point index is too late, so the latest possible
  827. // OK starting point would be the previous index.
  828. $max_start_index = $proposed_start_index - 1;
  829. }
  830. }
  831. $start_index = $max_start_index;
  832. // Return the matching text. We need to use substr() here and not the
  833. // Unicode::substr() function, because the indices in $words came from
  834. // preg_split(), so they are Unicode-safe byte positions, not character
  835. // positions.
  836. return trim(substr($text, $words[$start_index][1], $words[$end_index][1] - $words[$start_index][1]));
  837. }
  838. /**
  839. * Implements hook_form_FORM_ID_alter() for the search_block_form form.
  840. *
  841. * Since the exposed form is a GET form, we don't want it to send the form
  842. * tokens. However, you cannot make this happen in the form builder function
  843. * itself, because the tokens are added to the form after the builder function
  844. * is called. So, we have to do it in a form_alter.
  845. *
  846. * @see \Drupal\search\Form\SearchBlockForm
  847. */
  848. function search_form_search_block_form_alter(&$form, FormStateInterface $form_state) {
  849. $form['form_build_id']['#access'] = FALSE;
  850. $form['form_token']['#access'] = FALSE;
  851. $form['form_id']['#access'] = FALSE;
  852. }

Functions

Namesort descending Description
search_cron Implements hook_cron().
search_dirty Marks a word as "dirty" (changed), or retrieves the list of dirty words.
search_excerpt Returns snippets from a piece of text, with search keywords highlighted.
search_expand_cjk Splits CJK (Chinese, Japanese, Korean) text into tokens.
search_form_search_block_form_alter Implements hook_form_FORM_ID_alter() for the search_block_form form.
search_help Implements hook_help().
search_index Updates the full-text search index for a particular item.
search_index_clear Clears either a part of, or the entire search index.
search_index_split Simplifies and splits a string into words for indexing.
search_invoke_preprocess Invokes hook_search_preprocess() to simplify text.
search_mark_for_reindex Changes the timestamp on indexed items to 'now' to force reindexing.
search_preprocess_block Implements hook_preprocess_HOOK() for block templates.
search_simplify Simplifies and preprocesses text for searching.
search_theme Implements hook_theme().
search_update_totals Updates the {search_total} database table.
_search_find_match_with_simplify Finds an appropriate keyword in text.
_search_index_truncate Helper function for array_walk in search_index_split.

Constants

Namesort descending Description
PREG_CLASS_CJK Matches CJK (Chinese, Japanese, Korean) letter-like characters.
PREG_CLASS_NUMBERS Matches all 'N' Unicode character classes (numbers)
PREG_CLASS_PUNCTUATION Matches all 'P' Unicode character classes (punctuation)