[TASK] Removes extra empty lines
[Packages/TYPO3.CMS.git] / typo3 / sysext / indexed_search / Classes / Controller / SearchFormController.php
1 <?php
2 namespace TYPO3\CMS\IndexedSearch\Controller;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Html\HtmlParser;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19 use TYPO3\CMS\Core\Utility\MathUtility;
20 use TYPO3\CMS\IndexedSearch\Utility;
21
22 /**
23 * Index search frontend
24 *
25 * Creates a searchform for indexed search. Indexing must be enabled
26 * for this to make sense.
27 */
28 class SearchFormController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin
29 {
30 /**
31 * Used as fieldname prefix
32 *
33 * @var string
34 */
35 public $prefixId = 'tx_indexedsearch';
36
37 /**
38 * Extension key.
39 *
40 * @var string
41 */
42 public $extKey = 'indexed_search';
43
44 /**
45 * See document for info about this flag...
46 *
47 * @var int
48 */
49 public $join_pages = 0;
50
51 public $defaultResultNumber = 10;
52
53 /**
54 * Internal variable
55 *
56 * @var array
57 */
58 public $operator_translate_table = array(array('+', 'AND'), array('|', 'OR'), array('-', 'AND NOT'));
59
60 /**
61 * Root-page ids to search in (rl0 field where clause, see initialize() function)
62 *
63 * @var int|string id or comma separated list of ids
64 */
65 public $wholeSiteIdList = 0;
66
67 /**
68 * Search Words and operators
69 *
70 * @var array
71 */
72 public $sWArr = array();
73
74 /**
75 * Selector box values for search configuration form
76 *
77 * @var array
78 */
79 public $optValues = array();
80
81 /**
82 * Will hold the first row in result - used to calculate relative hit-ratings.
83 *
84 * @var array
85 */
86 public $firstRow = array();
87
88 /**
89 * Caching of page path
90 *
91 * @var array
92 */
93 public $cache_path = array();
94
95 /**
96 * Caching of root line data
97 *
98 * @var array
99 */
100 public $cache_rl = array();
101
102 /**
103 * Required fe_groups memberships for display of a result.
104 *
105 * @var array
106 */
107 public $fe_groups_required = array();
108
109 /**
110 * sys_domain records
111 *
112 * @var array
113 */
114 public $domain_records = array();
115
116 /**
117 * Select clauses for individual words
118 *
119 * @var array
120 */
121 public $wSelClauses = array();
122
123 /**
124 * Page tree sections for search result.
125 *
126 * @var array
127 */
128 public $resultSections = array();
129
130 /**
131 * External parser objects
132 * @var array
133 */
134 public $external_parsers = array();
135
136 /**
137 * Storage of icons....
138 *
139 * @var array
140 */
141 public $iconFileNameCache = array();
142
143 /**
144 * Will hold the content of $conf['templateFile']
145 *
146 * @var string
147 */
148 public $templateCode = '';
149
150 public $hiddenFieldList = 'ext, type, defOp, media, order, group, lang, desc, results';
151
152 /**
153 * Indexer configuration, coming from $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['indexed_search']
154 *
155 * @var array
156 */
157 public $indexerConfig = array();
158
159 /**
160 * @var bool
161 */
162 public $enableMetaphoneSearch = false;
163
164 public $storeMetaphoneInfoAsWords;
165
166 /**
167 * Lexer object
168 *
169 * @var \TYPO3\CMS\IndexedSearch\Lexer
170 */
171 public $lexerObj;
172
173 /**
174 * Main function, called from TypoScript as a USER_INT object.
175 *
176 * @param string $content Content input, ignore (just put blank string)
177 * @param array $conf TypoScript configuration of the plugin!
178 * @return string HTML code for the search form / result display.
179 */
180 public function main($content, $conf)
181 {
182 // Initialize:
183 $this->conf = $conf;
184 $this->pi_loadLL('EXT:indexed_search/Resources/Private/Language/locallang_pi.xlf');
185 $this->pi_setPiVarDefaults();
186 // Initialize:
187 $this->initialize();
188 // Do search:
189 // If there were any search words entered...
190 if (is_array($this->sWArr) && !empty($this->sWArr)) {
191 $content = $this->doSearch($this->sWArr);
192 }
193 // Finally compile all the content, form, messages and results:
194 $content = $this->makeSearchForm($this->optValues) . $this->printRules() . $content;
195 return $this->pi_wrapInBaseClass($content);
196 }
197
198 /**
199 * Initialize internal variables, especially selector box values for the search form and search words
200 *
201 * @return void
202 */
203 public function initialize()
204 {
205 // Indexer configuration from Extension Manager interface:
206 $this->indexerConfig = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['indexed_search']);
207 $this->enableMetaphoneSearch = (bool)$this->indexerConfig['enableMetaphoneSearch'];
208 $this->storeMetaphoneInfoAsWords = !\TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility::isTableUsed('index_words');
209 // Initialize external document parsers for icon display and other soft operations
210 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['external_parsers'])) {
211 foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['external_parsers'] as $extension => $_objRef) {
212 $this->external_parsers[$extension] = GeneralUtility::getUserObj($_objRef);
213 // Init parser and if it returns FALSE, unset its entry again:
214 if (!$this->external_parsers[$extension]->softInit($extension)) {
215 unset($this->external_parsers[$extension]);
216 }
217 }
218 }
219 // Init lexer (used to post-processing of search words)
220 $lexerObjRef = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['lexer'] ?: \TYPO3\CMS\IndexedSearch\Lexer::class;
221 $this->lexerObj = GeneralUtility::getUserObj($lexerObjRef);
222 // If "_sections" is set, this value overrides any existing value.
223 if ($this->piVars['_sections']) {
224 $this->piVars['sections'] = $this->piVars['_sections'];
225 }
226 // If "_sections" is set, this value overrides any existing value.
227 if ($this->piVars['_freeIndexUid'] !== '_') {
228 $this->piVars['freeIndexUid'] = $this->piVars['_freeIndexUid'];
229 }
230 // Add previous search words to current
231 if ($this->piVars['sword_prev_include'] && $this->piVars['sword_prev']) {
232 $this->piVars['sword'] = trim($this->piVars['sword_prev']) . ' ' . $this->piVars['sword'];
233 }
234 $this->piVars['results'] = MathUtility::forceIntegerInRange($this->piVars['results'], 1, 100000, $this->defaultResultNumber);
235 // Make sure that some cropping and markup constants used later are defined
236 $this->loadSettings();
237
238 // Selector-box values defined here:
239 $this->optValues = array(
240 'type' => array(
241 '0' => $this->pi_getLL('opt_type_0'),
242 '1' => $this->pi_getLL('opt_type_1'),
243 '2' => $this->pi_getLL('opt_type_2'),
244 '3' => $this->pi_getLL('opt_type_3'),
245 '10' => $this->pi_getLL('opt_type_10'),
246 '20' => $this->pi_getLL('opt_type_20')
247 ),
248 'defOp' => array(
249 '0' => $this->pi_getLL('opt_defOp_0'),
250 '1' => $this->pi_getLL('opt_defOp_1')
251 ),
252 'sections' => array(
253 '0' => $this->pi_getLL('opt_sections_0'),
254 '-1' => $this->pi_getLL('opt_sections_-1'),
255 '-2' => $this->pi_getLL('opt_sections_-2'),
256 '-3' => $this->pi_getLL('opt_sections_-3')
257 ),
258 'freeIndexUid' => array(
259 '-1' => $this->pi_getLL('opt_freeIndexUid_-1'),
260 '-2' => $this->pi_getLL('opt_freeIndexUid_-2'),
261 '0' => $this->pi_getLL('opt_freeIndexUid_0')
262 ),
263 'media' => array(
264 '-1' => $this->pi_getLL('opt_media_-1'),
265 '0' => $this->pi_getLL('opt_media_0'),
266 '-2' => $this->pi_getLL('opt_media_-2')
267 ),
268 'order' => array(
269 'rank_flag' => $this->pi_getLL('opt_order_rank_flag'),
270 'rank_freq' => $this->pi_getLL('opt_order_rank_freq'),
271 'rank_first' => $this->pi_getLL('opt_order_rank_first'),
272 'rank_count' => $this->pi_getLL('opt_order_rank_count'),
273 'mtime' => $this->pi_getLL('opt_order_mtime'),
274 'title' => $this->pi_getLL('opt_order_title'),
275 'crdate' => $this->pi_getLL('opt_order_crdate')
276 ),
277 'group' => array(
278 'sections' => $this->pi_getLL('opt_group_sections'),
279 'flat' => $this->pi_getLL('opt_group_flat')
280 ),
281 'lang' => array(
282 -1 => $this->pi_getLL('opt_lang_-1'),
283 0 => $this->pi_getLL('opt_lang_0')
284 ),
285 'desc' => array(
286 '0' => $this->pi_getLL('opt_desc_0'),
287 '1' => $this->pi_getLL('opt_desc_1')
288 ),
289 'results' => array(
290 '10' => '10',
291 '20' => '20',
292 '50' => '50',
293 '100' => '100'
294 )
295 );
296 // Remove this option if metaphone search is disabled)
297 if (!$this->enableMetaphoneSearch) {
298 unset($this->optValues['type']['10']);
299 }
300 // Free Index Uid:
301 if ($this->conf['search.']['defaultFreeIndexUidList']) {
302 $uidList = GeneralUtility::intExplode(',', $this->conf['search.']['defaultFreeIndexUidList']);
303 $indexCfgRecords = $this->databaseConnection->exec_SELECTgetRows('uid,title', 'index_config', 'uid IN (' . implode(',', $uidList) . ')' . $this->cObj->enableFields('index_config'), '', '', '', 'uid');
304 foreach ($uidList as $uidValue) {
305 if (is_array($indexCfgRecords[$uidValue])) {
306 $this->optValues['freeIndexUid'][$uidValue] = $indexCfgRecords[$uidValue]['title'];
307 }
308 }
309 }
310 // Should we use join_pages instead of long lists of uids?
311 if ($this->conf['search.']['skipExtendToSubpagesChecking']) {
312 $this->join_pages = 1;
313 }
314 // Add media to search in:
315 if (trim($this->conf['search.']['mediaList']) !== '') {
316 $mediaList = implode(',', GeneralUtility::trimExplode(',', $this->conf['search.']['mediaList'], true));
317 }
318 foreach ($this->external_parsers as $extension => $obj) {
319 // Skip unwanted extensions
320 if ($mediaList && !GeneralUtility::inList($mediaList, $extension)) {
321 continue;
322 }
323 if ($name = $obj->searchTypeMediaTitle($extension)) {
324 $this->optValues['media'][$extension] = $this->pi_getLL('opt_sections_' . $extension, $name);
325 }
326 }
327 // Add operators for various languages
328 // Converts the operators to UTF-8 and lowercase
329 $this->operator_translate_table[] = array($this->frontendController->csConvObj->conv_case('utf-8', $this->frontendController->csConvObj->utf8_encode($this->pi_getLL('local_operator_AND'), $this->frontendController->renderCharset), 'toLower'), 'AND');
330 $this->operator_translate_table[] = array($this->frontendController->csConvObj->conv_case('utf-8', $this->frontendController->csConvObj->utf8_encode($this->pi_getLL('local_operator_OR'), $this->frontendController->renderCharset), 'toLower'), 'OR');
331 $this->operator_translate_table[] = array($this->frontendController->csConvObj->conv_case('utf-8', $this->frontendController->csConvObj->utf8_encode($this->pi_getLL('local_operator_NOT'), $this->frontendController->renderCharset), 'toLower'), 'AND NOT');
332 // This is the id of the site root. This value may be a commalist of integer (prepared for this)
333 $this->wholeSiteIdList = (int)$this->frontendController->config['rootLine'][0]['uid'];
334 // Creating levels for section menu:
335 // This selects the first and secondary menus for the "sections" selector - so we can search in sections and sub sections.
336 if ($this->conf['show.']['L1sections']) {
337 $firstLevelMenu = $this->getMenu($this->wholeSiteIdList);
338 foreach ($firstLevelMenu as $optionName => $mR) {
339 if (!$mR['nav_hide']) {
340 $this->optValues['sections']['rl1_' . $mR['uid']] = trim($this->pi_getLL('opt_RL1') . ' ' . $mR['title']);
341 if ($this->conf['show.']['L2sections']) {
342 $secondLevelMenu = $this->getMenu($mR['uid']);
343 foreach ($secondLevelMenu as $kk2 => $mR2) {
344 if (!$mR2['nav_hide']) {
345 $this->optValues['sections']['rl2_' . $mR2['uid']] = trim($this->pi_getLL('opt_RL2') . ' ' . $mR2['title']);
346 } else {
347 unset($secondLevelMenu[$kk2]);
348 }
349 }
350 $this->optValues['sections']['rl2_' . implode(',', array_keys($secondLevelMenu))] = $this->pi_getLL('opt_RL2ALL');
351 }
352 } else {
353 unset($firstLevelMenu[$optionName]);
354 }
355 }
356 $this->optValues['sections']['rl1_' . implode(',', array_keys($firstLevelMenu))] = $this->pi_getLL('opt_RL1ALL');
357 }
358 // Setting the list of root IDs for the search. Notice, these page IDs MUST have a TypoScript template with root flag on them! Basically this list is used to select on the "rl0" field and page ids are registered as "rl0" only if a TypoScript template record with root flag is there.
359 // This happens AFTER the use of $this->wholeSiteIdList above because the above will then fetch the menu for the CURRENT site - regardless of this kind of searching here. Thus a general search will lookup in the WHOLE database while a specific section search will take the current sections...
360 if ($this->conf['search.']['rootPidList']) {
361 $this->wholeSiteIdList = implode(',', GeneralUtility::intExplode(',', $this->conf['search.']['rootPidList']));
362 }
363 // Load the template
364 $this->templateCode = $this->cObj->fileResource($this->conf['templateFile']);
365 // Add search languages:
366 $res = $this->databaseConnection->exec_SELECTquery('*', 'sys_language', '1=1' . $this->cObj->enableFields('sys_language'));
367 while (false !== ($data = $this->databaseConnection->sql_fetch_assoc($res))) {
368 $this->optValues['lang'][$data['uid']] = $data['title'];
369 }
370 $this->databaseConnection->sql_free_result($res);
371 // Calling hook for modification of initialized content
372 if ($hookObj = $this->hookRequest('initialize_postProc')) {
373 $hookObj->initialize_postProc();
374 }
375 // Default values set:
376 // Setting first values in optValues as default values IF there is not corresponding piVar value set already.
377 foreach ($this->optValues as $optionName => $optionValue) {
378 if (!isset($this->piVars[$optionName])) {
379 reset($optionValue);
380 $this->piVars[$optionName] = key($optionValue);
381 }
382 }
383 // Blind selectors:
384 if (is_array($this->conf['blind.'])) {
385 foreach ($this->conf['blind.'] as $optionName => $optionValue) {
386 if (is_array($optionValue)) {
387 foreach ($optionValue as $optionValueSubKey => $optionValueSubValue) {
388 if (!is_array($optionValueSubValue) && $optionValueSubValue && is_array($this->optValues[substr($optionName, 0, -1)])) {
389 unset($this->optValues[substr($optionName, 0, -1)][$optionValueSubKey]);
390 }
391 }
392 } elseif ($optionValue) {
393 // If value is not set, unset the option array
394 unset($this->optValues[$optionName]);
395 }
396 }
397 }
398 // This gets the search-words into the $sWArr:
399 $this->sWArr = $this->getSearchWords($this->piVars['defOp']);
400 }
401
402 /**
403 * Splits the search word input into an array where each word is represented by an array with key "sword" holding the search word and key "oper" holding the SQL operator (eg. AND, OR)
404 *
405 * Only words with 2 or more characters are accepted
406 * Max 200 chars total
407 * Space is used to split words, "" can be used search for a whole string
408 * AND, OR and NOT are prefix words, overruling the default operator
409 * +/|/- equals AND, OR and NOT as operators.
410 * All search words are converted to lowercase.
411 *
412 * $defOp is the default operator. 1=OR, 0=AND
413 *
414 * @param bool $defOp If TRUE, the default operator will be OR, not AND
415 * @return array Returns array with search words if any found
416 */
417 public function getSearchWords($defOp)
418 {
419 // Shorten search-word string to max 200 bytes (does NOT take multibyte charsets into account - but never mind, shortening the string here is only a run-away feature!)
420 $inSW = substr($this->piVars['sword'], 0, 200);
421 // Convert to UTF-8 + conv. entities (was also converted during indexing!)
422 $inSW = $this->frontendController->csConvObj->utf8_encode($inSW, $this->frontendController->metaCharset);
423 $inSW = $this->frontendController->csConvObj->entities_to_utf8($inSW, true);
424 $sWordArray = false;
425 if ($hookObj = $this->hookRequest('getSearchWords')) {
426 $sWordArray = $hookObj->getSearchWords_splitSWords($inSW, $defOp);
427 } else {
428 if ($this->piVars['type'] == 20) {
429 // type = Sentence
430 $sWordArray = array(array('sword' => trim($inSW), 'oper' => 'AND'));
431 } else {
432 $searchWords = \TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility::getExplodedSearchString($inSW, $defOp == 1 ? 'OR' : 'AND', $this->operator_translate_table);
433 if (is_array($searchWords)) {
434 $sWordArray = $this->procSearchWordsByLexer($searchWords);
435 }
436 }
437 }
438 return $sWordArray;
439 }
440
441 /**
442 * Post-process the search word array so it will match the words that was indexed (including case-folding if any)
443 * If any words are split into multiple words (eg. CJK will be!) the operator of the main word will remain.
444 *
445 * @param array $SWArr Search word array
446 * @return array Search word array, processed through lexer
447 */
448 public function procSearchWordsByLexer($SWArr)
449 {
450 // Init output variable:
451 $newSWArr = array();
452 // Traverse the search word array:
453 foreach ($SWArr as $wordDef) {
454 if (!strstr($wordDef['sword'], ' ')) {
455 // No space in word (otherwise it might be a sentense in quotes like "there is").
456 // Split the search word by lexer:
457 $res = $this->lexerObj->split2Words($wordDef['sword']);
458 // Traverse lexer result and add all words again:
459 foreach ($res as $word) {
460 $newSWArr[] = array('sword' => $word, 'oper' => $wordDef['oper']);
461 }
462 } else {
463 $newSWArr[] = $wordDef;
464 }
465 }
466 // Return result:
467 return $newSWArr;
468 }
469
470 /*****************************
471 *
472 * Main functions
473 *
474 *****************************/
475 /**
476 * Performs the search, the display and writing stats
477 *
478 * @param array $sWArr Search words in array, see ->getSearchWords() for details
479 * @return string HTML for result display.
480 */
481 public function doSearch($sWArr)
482 {
483 // Find free index uid:
484 $freeIndexUid = $this->piVars['freeIndexUid'];
485 if ($freeIndexUid == -2) {
486 $freeIndexUid = $this->conf['search.']['defaultFreeIndexUidList'];
487 }
488 $indexCfgs = GeneralUtility::intExplode(',', $freeIndexUid);
489 $accumulatedContent = '';
490 foreach ($indexCfgs as $freeIndexUid) {
491 // Get result rows:
492 $pt1 = GeneralUtility::milliseconds();
493 if ($hookObj = $this->hookRequest('getResultRows')) {
494 $resData = $hookObj->getResultRows($sWArr, $freeIndexUid);
495 } else {
496 $resData = $this->getResultRows($sWArr, $freeIndexUid);
497 }
498 // Display search results:
499 $pt2 = GeneralUtility::milliseconds();
500 if ($hookObj = $this->hookRequest('getDisplayResults')) {
501 $content = $hookObj->getDisplayResults($sWArr, $resData, $freeIndexUid);
502 } else {
503 $content = $this->getDisplayResults($sWArr, $resData, $freeIndexUid);
504 }
505 $pt3 = GeneralUtility::milliseconds();
506 // Create header if we are searching more than one indexing configuration:
507 if (count($indexCfgs) > 1) {
508 if ($freeIndexUid > 0) {
509 $indexCfgRec = $this->databaseConnection->exec_SELECTgetSingleRow('title', 'index_config', 'uid=' . (int)$freeIndexUid . $this->cObj->enableFields('index_config'));
510 $titleString = $indexCfgRec['title'];
511 } else {
512 $titleString = $this->pi_getLL('opt_freeIndexUid_header_' . $freeIndexUid);
513 }
514 $content = '<h1 class="tx-indexedsearch-category">' . htmlspecialchars($titleString) . '</h1>' . $content;
515 }
516 $accumulatedContent .= $content;
517 }
518 // Write search statistics
519 $this->writeSearchStat($sWArr, $resData['count'], array($pt1, $pt2, $pt3));
520 // Return content:
521 return $accumulatedContent;
522 }
523
524 /**
525 * Get search result rows / data from database. Returned as data in array.
526 *
527 * @param array $searchWordArray Search word array
528 * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
529 * @return array False if no result, otherwise an array with keys for first row, result rows and total number of results found.
530 */
531 public function getResultRows($searchWordArray, $freeIndexUid = -1)
532 {
533 // Getting SQL result pointer. This fetches ALL results (1,000,000 if found)
534 $GLOBALS['TT']->push('Searching result');
535 if ($hookObj = &$this->hookRequest('getResultRows_SQLpointer')) {
536 $res = $hookObj->getResultRows_SQLpointer($searchWordArray, $freeIndexUid);
537 } else {
538 $res = $this->getResultRows_SQLpointer($searchWordArray, $freeIndexUid);
539 }
540 $GLOBALS['TT']->pull();
541 // Organize and process result:
542 $result = false;
543 if ($res) {
544 $totalSearchResultCount = $this->databaseConnection->sql_num_rows($res);
545 // Total search-result count
546 $currentPageNumber = MathUtility::forceIntegerInRange($this->piVars['pointer'], 0, floor($totalSearchResultCount / $this->piVars['results']));
547 // The pointer is set to the result page that is currently being viewed
548 // Initialize result accumulation variables:
549 $positionInSearchResults = 0;
550 $groupingPhashes = array();
551 // Used for filtering out duplicates
552 $groupingChashes = array();
553 // Used for filtering out duplicates BASED ON cHash
554 $firstRow = array();
555 // Will hold the first row in result - used to calculate relative hit-ratings.
556 $resultRows = array();
557 // Will hold the results rows for display.
558 // Should we continue counting and checking of results even if
559 // we are sure they are not displayed in this request?
560 // This will slow down your page rendering, but it allows
561 // precise search result counters.
562 $calculateExactCount = (bool)$this->conf['search.']['exactCount'];
563 $lastResultNumberOnPreviousPage = $currentPageNumber * $this->piVars['results'];
564 $firstResultNumberOnNextPage = ($currentPageNumber + 1) * $this->piVars['results'];
565 $lastResultNumberToAnalyze = ($currentPageNumber + 1) * $this->piVars['results'] + $this->piVars['results'];
566 // Now, traverse result and put the rows to be displayed into an array
567 // Each row should contain the fields from 'ISEC.*, IP.*' combined + artificial fields "show_resume" (bool) and "result_number" (counter)
568 while (false !== ($row = $this->databaseConnection->sql_fetch_assoc($res))) {
569 if (!$this->checkExistence($row)) {
570 // Check if the record is still available or if it has been deleted meanwhile.
571 // Currently this works for files only, since extending it to content elements would cause a lot of overhead...
572 // Otherwise, skip the row.
573 $totalSearchResultCount--;
574 continue;
575 }
576 // Set first row:
577 if ($positionInSearchResults === 0) {
578 $firstRow = $row;
579 }
580 $row['show_resume'] = $this->checkResume($row);
581 // Tells whether we can link directly to a document or not (depends on possible right problems)
582 $phashGr = !in_array($row['phash_grouping'], $groupingPhashes);
583 $chashGr = !in_array(($row['contentHash'] . '.' . $row['data_page_id']), $groupingChashes);
584 if ($phashGr && $chashGr) {
585 if ($row['show_resume'] || $this->conf['show.']['forbiddenRecords']) {
586 // Only if the resume may be shown are we going to filter out duplicates...
587 if (!$this->multiplePagesType($row['item_type'])) {
588 // Only on documents which are not multiple pages documents
589 $groupingPhashes[] = $row['phash_grouping'];
590 }
591 $groupingChashes[] = $row['contentHash'] . '.' . $row['data_page_id'];
592 $positionInSearchResults++;
593 // Check if we are inside result range for current page
594 if ($positionInSearchResults > $lastResultNumberOnPreviousPage && $positionInSearchResults <= $lastResultNumberToAnalyze) {
595 // Collect results to display
596 $row['result_number'] = $positionInSearchResults;
597 $resultRows[] = $row;
598 // This may lead to a problem: If the result
599 // check is not stopped here, the search will
600 // take longer. However the result counter
601 // will not filter out grouped cHashes/pHashes
602 // that were not processed yet. You can change
603 // this behavior using the "search.exactCount"
604 // property (see above).
605 $nextResultPosition = $positionInSearchResults + 1;
606 if (!$calculateExactCount && $nextResultPosition > $firstResultNumberOnNextPage) {
607 break;
608 }
609 }
610 } else {
611 // Skip this row if the user cannot view it (missing permission)
612 $totalSearchResultCount--;
613 }
614 } else {
615 // For each time a phash_grouping document is found
616 // (which is thus not displayed) the search-result count
617 // is reduced, so that it matches the number of rows displayed.
618 $totalSearchResultCount--;
619 }
620 }
621 $this->databaseConnection->sql_free_result($res);
622 $result = array(
623 'resultRows' => $resultRows,
624 'firstRow' => $firstRow,
625 'count' => $totalSearchResultCount
626 );
627 }
628 return $result;
629 }
630
631 /**
632 * Gets a SQL result pointer to traverse for the search records.
633 *
634 * @param array $sWArr Search words
635 * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
636 * @return bool|\mysqli_result Query result pointer
637 */
638 public function getResultRows_SQLpointer($sWArr, $freeIndexUid = -1)
639 {
640 // This SEARCHES for the searchwords in $sWArr AND returns a COMPLETE list of phash-integers of the matches.
641 $list = $this->getPhashList($sWArr);
642 // Perform SQL Search / collection of result rows array:
643 if ($list) {
644 // Do the search:
645 $GLOBALS['TT']->push('execFinalQuery');
646 $res = $this->execFinalQuery($list, $freeIndexUid);
647 $GLOBALS['TT']->pull();
648 return $res;
649 } else {
650 return false;
651 }
652 }
653
654 /**
655 * Compiles the HTML display of the incoming array of result rows.
656 *
657 * @param array $sWArr Search words array (for display of text describing what was searched for)
658 * @param array $resData Array with result rows, count, first row.
659 * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
660 * @return string HTML content to display result.
661 */
662 public function getDisplayResults($sWArr, $resData, $freeIndexUid = -1)
663 {
664 $content = '';
665 // Perform display of result rows array:
666 if ($resData) {
667 $GLOBALS['TT']->push('Display Final result');
668 // Set first selected row (for calculation of ranking later)
669 $this->firstRow = $resData['firstRow'];
670 // Result display here:
671 $rowcontent = '';
672 $rowcontent .= $this->compileResult($resData['resultRows'], $freeIndexUid);
673 // Browsing box:
674 if ($resData['count']) {
675 $this->internal['res_count'] = $resData['count'];
676 $this->internal['results_at_a_time'] = $this->piVars['results'];
677 $this->internal['maxPages'] = MathUtility::forceIntegerInRange($this->conf['search.']['page_links'], 1, 100, 10);
678 $resultSectionsCount = count($this->resultSections);
679 $addString = $resData['count'] && $this->piVars['group'] == 'sections' && $freeIndexUid <= 0 ? ' ' . sprintf($this->pi_getLL(($resultSectionsCount > 1 ? 'inNsections' : 'inNsection')), $resultSectionsCount) : '';
680 $browseBox1 = $this->pi_list_browseresults(1, $addString, $this->printResultSectionLinks(), $freeIndexUid);
681 $browseBox2 = $this->pi_list_browseresults(0, '', '', $freeIndexUid);
682 // Browsing nav, bottom.
683 $content = $browseBox1 . $rowcontent . $browseBox2;
684 } else {
685 $content = '<p' . $this->pi_classParam('noresults') . '>' . $this->pi_getLL('noResults', '', true) . '</p>';
686 }
687 $GLOBALS['TT']->pull();
688 } else {
689 $content .= '<p' . $this->pi_classParam('noresults') . '>' . $this->pi_getLL('noResults', '', true) . '</p>';
690 }
691 // Print a message telling which words we searched for, and in which sections etc.
692 $what = $this->tellUsWhatIsSeachedFor($sWArr) . (substr($this->piVars['sections'], 0, 2) == 'rl' ? ' ' . $this->pi_getLL('inSection', '', true) . ' "' . $this->getPathFromPageId(substr($this->piVars['sections'], 4)) . '"' : '');
693 $what = '<div' . $this->pi_classParam('whatis') . '>' . $this->cObj->stdWrap($what, $this->conf['whatis_stdWrap.']) . '</div>';
694 $content = $what . $content;
695 // Return content:
696 return $content;
697 }
698
699 /**
700 * Takes the array with resultrows as input and returns the result-HTML-code
701 * Takes the "group" var into account: Makes a "section" or "flat" display.
702 *
703 * @param array $resultRows Result rows
704 * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
705 * @return string HTML
706 */
707 public function compileResult($resultRows, $freeIndexUid = -1)
708 {
709 $content = '';
710 // Transfer result rows to new variable, performing some mapping of sub-results etc.
711 $newResultRows = array();
712 foreach ($resultRows as $row) {
713 $id = md5($row['phash_grouping']);
714 if (is_array($newResultRows[$id])) {
715 if (!$newResultRows[$id]['show_resume'] && $row['show_resume']) {
716 // swapping:
717 // Remove old
718 $subrows = $newResultRows[$id]['_sub'];
719 unset($newResultRows[$id]['_sub']);
720 $subrows[] = $newResultRows[$id];
721 // Insert new:
722 $newResultRows[$id] = $row;
723 $newResultRows[$id]['_sub'] = $subrows;
724 } else {
725 $newResultRows[$id]['_sub'][] = $row;
726 }
727 } else {
728 $newResultRows[$id] = $row;
729 }
730 }
731 $resultRows = $newResultRows;
732 $this->resultSections = array();
733 if ($freeIndexUid <= 0) {
734 switch ($this->piVars['group']) {
735 case 'sections':
736 $rl2flag = substr($this->piVars['sections'], 0, 2) == 'rl';
737 $sections = array();
738 foreach ($resultRows as $row) {
739 $id = $row['rl0'] . '-' . $row['rl1'] . ($rl2flag ? '-' . $row['rl2'] : '');
740 $sections[$id][] = $row;
741 }
742 $this->resultSections = array();
743 foreach ($sections as $id => $resultRows) {
744 $rlParts = explode('-', $id);
745 $theId = $rlParts[2] ? $rlParts[2] : ($rlParts[1] ? $rlParts[1] : $rlParts[0]);
746 $theRLid = $rlParts[2] ? 'rl2_' . $rlParts[2] : ($rlParts[1] ? 'rl1_' . $rlParts[1] : '0');
747 $sectionName = $this->getPathFromPageId($theId);
748 if ($sectionName[0] == '/') {
749 $sectionName = substr($sectionName, 1);
750 }
751 if (!trim($sectionName)) {
752 $sectionTitleLinked = $this->pi_getLL('unnamedSection', '', true) . ':';
753 } elseif ($this->conf['linkSectionTitles']) {
754 $quotedPrefix = GeneralUtility::quoteJSvalue($this->prefixId);
755 $onclick = 'document.forms[' . $quotedPrefix . '][' . GeneralUtility::quoteJSvalue($this->prefixId . '[_sections]') . '].value=' . GeneralUtility::quoteJSvalue($theRLid) . ';document.forms[' . $quotedPrefix . '].submit();return false;';
756 $sectionTitleLinked = '<a href="#" onclick="' . htmlspecialchars($onclick) . '">' . $sectionName . ':</a>';
757 } else {
758 $sectionTitleLinked = $sectionName;
759 }
760 $resultRowsCount = count($resultRows);
761 $this->resultSections[$id] = array($sectionName, $resultRowsCount);
762 // Add content header:
763 $content .= $this->makeSectionHeader($id, $sectionTitleLinked, $resultRowsCount);
764 // Render result rows:
765 $resultlist = '';
766 foreach ($resultRows as $row) {
767 $resultlist .= $this->printResultRow($row);
768 }
769 $content .= $this->cObj->stdWrap($resultlist, $this->conf['resultlist_stdWrap.']);
770 }
771 break;
772 default:
773 // flat:
774 $resultlist = '';
775 foreach ($resultRows as $row) {
776 $resultlist .= $this->printResultRow($row);
777 }
778 $content .= $this->cObj->stdWrap($resultlist, $this->conf['resultlist_stdWrap.']);
779 }
780 } else {
781 $resultlist = '';
782 foreach ($resultRows as $row) {
783 $resultlist .= $this->printResultRow($row);
784 }
785 $content .= $this->cObj->stdWrap($resultlist, $this->conf['resultlist_stdWrap.']);
786 }
787 return '<div' . $this->pi_classParam('res') . '>' . $content . '</div>';
788 }
789
790 /***********************************
791 *
792 * Searching functions (SQL)
793 *
794 ***********************************/
795 /**
796 * Returns a COMPLETE list of phash-integers matching the search-result composed of the search-words in the sWArr array.
797 * The list of phash integers are unsorted and should be used for subsequent selection of index_phash records for display of the result.
798 *
799 * @param array $sWArr Search word array
800 * @return string List of integers
801 */
802 public function getPhashList($sWArr)
803 {
804 // Initialize variables:
805 $c = 0;
806 $totalHashList = array();
807 // This array accumulates the phash-values
808 // Traverse searchwords; for each, select all phash integers and merge/diff/intersect them with previous word (based on operator)
809 foreach ($sWArr as $k => $v) {
810 // Making the query for a single search word based on the search-type
811 $sWord = $v['sword'];
812 $theType = (string)$this->piVars['type'];
813 if (strstr($sWord, ' ')) {
814 // If there are spaces in the search-word, make a full text search instead.
815 $theType = 20;
816 }
817 $GLOBALS['TT']->push('SearchWord "' . $sWord . '" - $theType=' . $theType);
818 // Perform search for word:
819 switch ($theType) {
820 case '1':
821 // Part of word
822 $res = $this->searchWord($sWord, Utility\LikeWildcard::BOTH);
823 break;
824 case '2':
825 // First part of word
826 $res = $this->searchWord($sWord, Utility\LikeWildcard::RIGHT);
827 break;
828 case '3':
829 // Last part of word
830 $res = $this->searchWord($sWord, Utility\LikeWildcard::LEFT);
831 break;
832 case '10':
833 // Sounds like
834 /**
835 * Indexer object
836 *
837 * @var \TYPO3\CMS\IndexedSearch\Indexer
838 */
839 // Initialize the indexer-class
840 $indexerObj = GeneralUtility::makeInstance(\TYPO3\CMS\IndexedSearch\Indexer::class);
841 // Perform metaphone search
842 $res = $this->searchMetaphone($indexerObj->metaphone($sWord, $this->storeMetaphoneInfoAsWords));
843 unset($indexerObj);
844 break;
845 case '20':
846 // Sentence
847 $res = $this->searchSentence($sWord);
848 $this->piVars['order'] = 'mtime';
849 // If there is a fulltext search for a sentence there is a likeliness that sorting cannot be done by the rankings from the rel-table (because no relations will exist for the sentence in the word-table). So therefore mtime is used instead. It is not required, but otherwise some hits may be left out.
850 break;
851 default:
852 // Distinct word
853 $res = $this->searchDistinct($sWord);
854 }
855 // If there was a query to do, then select all phash-integers which resulted from this.
856 if ($res) {
857 // Get phash list by searching for it:
858 $phashList = array();
859 while ($row = $this->databaseConnection->sql_fetch_assoc($res)) {
860 $phashList[] = $row['phash'];
861 }
862 $this->databaseConnection->sql_free_result($res);
863 // Here the phash list are merged with the existing result based on whether we are dealing with OR, NOT or AND operations.
864 if ($c) {
865 switch ($v['oper']) {
866 case 'OR':
867 $totalHashList = array_unique(array_merge($phashList, $totalHashList));
868 break;
869 case 'AND NOT':
870 $totalHashList = array_diff($totalHashList, $phashList);
871 break;
872 default:
873 // AND...
874 $totalHashList = array_intersect($totalHashList, $phashList);
875 }
876 } else {
877 $totalHashList = $phashList;
878 }
879 }
880 $GLOBALS['TT']->pull();
881 $c++;
882 }
883 return implode(',', $totalHashList);
884 }
885
886 /**
887 * Returns a query which selects the search-word from the word/rel tables.
888 *
889 * @param string $wordSel WHERE clause selecting the word from phash
890 * @param string $plusQ Additional AND clause in the end of the query.
891 * @return bool|\mysqli_result SQL result pointer
892 */
893 public function execPHashListQuery($wordSel, $plusQ = '')
894 {
895 return $this->databaseConnection->exec_SELECTquery('IR.phash', 'index_words IW,
896 index_rel IR,
897 index_section ISEC', $wordSel . '
898 AND IW.wid=IR.wid
899 AND ISEC.phash = IR.phash
900 ' . $this->sectionTableWhere() . '
901 ' . $plusQ, 'IR.phash');
902 }
903
904 /**
905 * Search for a word
906 *
907 * @param string $sWord Word to search for
908 * @param int $wildcard Bit-field of Utility\LikeWildcard
909 * @return bool|\mysqli_result SQL result pointer
910 */
911 public function searchWord($sWord, $wildcard)
912 {
913 $likeWildcard = Utility\LikeWildcard::cast($wildcard);
914 $wSel = $likeWildcard->getLikeQueryPart(
915 'index_words',
916 'IW.baseword',
917 $sWord
918 );
919
920 $this->wSelClauses[] = $wSel;
921 $res = $this->execPHashListQuery($wSel, ' AND is_stopword=0');
922 return $res;
923 }
924
925 /**
926 * Search for one distinct word
927 *
928 * @param string $sWord Word to search for
929 * @return bool|\mysqli_result SQL result pointer
930 */
931 public function searchDistinct($sWord)
932 {
933 $wSel = 'IW.wid=' . \TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility::md5inthash($sWord);
934 $this->wSelClauses[] = $wSel;
935 $res = $this->execPHashListQuery($wSel, ' AND is_stopword=0');
936 return $res;
937 }
938
939 /**
940 * Search for a sentence
941 *
942 * @param string $sSentence Sentence to search for
943 * @return bool|\mysqli_result SQL result pointer
944 */
945 public function searchSentence($sSentence)
946 {
947 $this->wSelClauses[] = '1=1';
948 $likeWildcard = Utility\LikeWildcard::cast(Utility\LikeWildcard::BOTH);
949 $likePart = $likeWildcard->getLikeQueryPart(
950 'index_fulltext',
951 'IFT.fulltextdata',
952 $sSentence
953 );
954
955 return $this->databaseConnection->exec_SELECTquery('ISEC.phash',
956 'index_section ISEC, index_fulltext IFT',
957 $likePart . ' AND ISEC.phash = IFT.phash' . $this->sectionTableWhere(), 'ISEC.phash'
958 );
959 }
960
961 /**
962 * Search for a metaphone word
963 *
964 * @param string $sWord Word to search for
965 * @return \mysqli_result SQL result pointer
966 */
967 public function searchMetaphone($sWord)
968 {
969 $wSel = 'IW.metaphone=' . $sWord;
970 $this->wSelClauses[] = $wSel;
971 return $this->execPHashListQuery($wSel, ' AND is_stopword=0');
972 }
973
974 /**
975 * Returns AND statement for selection of section in database. (rootlevel 0-2 + page_id)
976 *
977 * @return string AND clause for selection of section in database.
978 */
979 public function sectionTableWhere()
980 {
981 $out = $this->wholeSiteIdList < 0 ? '' : ' AND ISEC.rl0 IN (' . $this->wholeSiteIdList . ')';
982 $match = '';
983 if (substr($this->piVars['sections'], 0, 4) == 'rl1_') {
984 $list = implode(',', GeneralUtility::intExplode(',', substr($this->piVars['sections'], 4)));
985 $out .= ' AND ISEC.rl1 IN (' . $list . ')';
986 $match = true;
987 } elseif (substr($this->piVars['sections'], 0, 4) == 'rl2_') {
988 $list = implode(',', GeneralUtility::intExplode(',', substr($this->piVars['sections'], 4)));
989 $out .= ' AND ISEC.rl2 IN (' . $list . ')';
990 $match = true;
991 } elseif (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['addRootLineFields'])) {
992 // Traversing user configured fields to see if any of those are used to limit search to a section:
993 foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['addRootLineFields'] as $fieldName => $rootLineLevel) {
994 if (substr($this->piVars['sections'], 0, strlen($fieldName) + 1) == $fieldName . '_') {
995 $list = implode(',', GeneralUtility::intExplode(',', substr($this->piVars['sections'], strlen($fieldName) + 1)));
996 $out .= ' AND ISEC.' . $fieldName . ' IN (' . $list . ')';
997 $match = true;
998 break;
999 }
1000 }
1001 }
1002 // If no match above, test the static types:
1003 if (!$match) {
1004 switch ((string)$this->piVars['sections']) {
1005 case '-1':
1006 // '-1' => 'Only this page',
1007 $out .= ' AND ISEC.page_id=' . $this->frontendController->id;
1008 break;
1009 case '-2':
1010 // '-2' => 'Top + level 1',
1011 $out .= ' AND ISEC.rl2=0';
1012 break;
1013 case '-3':
1014 // '-3' => 'Level 2 and out',
1015 $out .= ' AND ISEC.rl2>0';
1016 break;
1017 }
1018 }
1019 return $out;
1020 }
1021
1022 /**
1023 * Returns AND statement for selection of media type
1024 *
1025 * @return string AND statement for selection of media type
1026 */
1027 public function mediaTypeWhere()
1028 {
1029 switch ((string)$this->piVars['media']) {
1030 case '0':
1031 // '0' => 'Kun TYPO3 sider',
1032 $out = ' AND IP.item_type=' . $this->databaseConnection->fullQuoteStr('0', 'index_phash');
1033 break;
1034 case '-2':
1035 // All external documents
1036 $out = ' AND IP.item_type<>' . $this->databaseConnection->fullQuoteStr('0', 'index_phash');
1037 break;
1038 case '-1':
1039 // All content
1040 $out = '';
1041 break;
1042 default:
1043 $out = ' AND IP.item_type=' . $this->databaseConnection->fullQuoteStr($this->piVars['media'], 'index_phash');
1044 }
1045 return $out;
1046 }
1047
1048 /**
1049 * Returns AND statement for selection of language
1050 *
1051 * @return string AND statement for selection of language
1052 */
1053 public function languageWhere()
1054 {
1055 $languageWhere = '';
1056 if ($this->piVars['lang'] >= 0) {
1057 // -1 is the same as ALL language.
1058 $languageWhere = 'AND IP.sys_language_uid=' . (int)$this->piVars['lang'];
1059 }
1060 return $languageWhere;
1061 }
1062
1063 /**
1064 * Where-clause for free index-uid value.
1065 *
1066 * @param int $freeIndexUid Free Index UID value to limit search to.
1067 * @return string WHERE SQL clause part.
1068 */
1069 public function freeIndexUidWhere($freeIndexUid)
1070 {
1071 if ($freeIndexUid < 0) {
1072 return '';
1073 }
1074 // First, look if the freeIndexUid is a meta configuration:
1075 $indexCfgRec = $this->databaseConnection->exec_SELECTgetSingleRow('indexcfgs', 'index_config', 'type=5 AND uid=' . (int)$freeIndexUid . $this->cObj->enableFields('index_config'));
1076 if (is_array($indexCfgRec)) {
1077 $refs = GeneralUtility::trimExplode(',', $indexCfgRec['indexcfgs']);
1078 $list = array(-99);
1079 // Default value to protect against empty array.
1080 foreach ($refs as $ref) {
1081 list($table, $uid) = GeneralUtility::revExplode('_', $ref, 2);
1082 switch ($table) {
1083 case 'index_config':
1084 $idxRec = $this->databaseConnection->exec_SELECTgetSingleRow('uid', 'index_config', 'uid=' . (int)$uid . $this->cObj->enableFields('index_config'));
1085 if ($idxRec) {
1086 $list[] = $uid;
1087 }
1088 break;
1089 case 'pages':
1090 $indexCfgRecordsFromPid = $this->databaseConnection->exec_SELECTgetRows('uid', 'index_config', 'pid=' . (int)$uid . $this->cObj->enableFields('index_config'));
1091 foreach ($indexCfgRecordsFromPid as $idxRec) {
1092 $list[] = $idxRec['uid'];
1093 }
1094 break;
1095 }
1096 }
1097 $list = array_unique($list);
1098 } else {
1099 $list = array((int)$freeIndexUid);
1100 }
1101 return ' AND IP.freeIndexUid IN (' . implode(',', $list) . ')';
1102 }
1103
1104 /**
1105 * Execute final query, based on phash integer list. The main point is sorting the result in the right order.
1106 *
1107 * @param string $list List of phash integers which match the search.
1108 * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
1109 * @return bool|\mysqli_result Query result pointer
1110 */
1111 public function execFinalQuery($list, $freeIndexUid = -1)
1112 {
1113 // Setting up methods of filtering results based on page types, access, etc.
1114 $page_join = '';
1115 $page_where = '';
1116 // Calling hook for alternative creation of page ID list
1117 if ($hookObj = $this->hookRequest('execFinalQuery_idList')) {
1118 $page_where = $hookObj->execFinalQuery_idList($list);
1119 } elseif ($this->join_pages) {
1120 // Alternative to getting all page ids by ->getTreeList() where "excludeSubpages" is NOT respected.
1121 $page_join = ',
1122 pages';
1123 $page_where = 'pages.uid = ISEC.page_id
1124 ' . $this->cObj->enableFields('pages') . '
1125 AND pages.no_search=0
1126 AND pages.doktype<200
1127 ';
1128 } elseif ($this->wholeSiteIdList >= 0) {
1129 // Collecting all pages IDs in which to search; filtering out ALL pages that are not accessible due to enableFields. Does NOT look for "no_search" field!
1130 $siteIdNumbers = GeneralUtility::intExplode(',', $this->wholeSiteIdList);
1131 $id_list = array();
1132 foreach ($siteIdNumbers as $rootId) {
1133 $id_list[] = $this->cObj->getTreeList(-1 * $rootId, 9999);
1134 }
1135 $page_where = 'ISEC.page_id IN (' . implode(',', $id_list) . ')';
1136 } else {
1137 // Disable everything... (select all)
1138 $page_where = '1=1';
1139 }
1140 // Indexing configuration clause:
1141 $freeIndexUidClause = $this->freeIndexUidWhere($freeIndexUid);
1142 // If any of the ranking sortings are selected, we must make a join with the word/rel-table again, because we need to calculate ranking based on all search-words found.
1143 if (substr($this->piVars['order'], 0, 5) == 'rank_') {
1144 switch ($this->piVars['order']) {
1145 case 'rank_flag':
1146 // This gives priority to word-position (max-value) so that words in title, keywords, description counts more than in content.
1147 // The ordering is refined with the frequency sum as well.
1148 $grsel = 'MAX(IR.flags) AS order_val1, SUM(IR.freq) AS order_val2';
1149 $orderBy = 'order_val1' . $this->isDescending() . ',order_val2' . $this->isDescending();
1150 break;
1151 case 'rank_first':
1152 // Results in average position of search words on page. Must be inversely sorted (low numbers are closer to top)
1153 $grsel = 'AVG(IR.first) AS order_val';
1154 $orderBy = 'order_val' . $this->isDescending(1);
1155 break;
1156 case 'rank_count':
1157 // Number of words found
1158 $grsel = 'SUM(IR.count) AS order_val';
1159 $orderBy = 'order_val' . $this->isDescending();
1160 break;
1161 default:
1162 // Frequency sum. I'm not sure if this is the best way to do it (make a sum...). Or should it be the average?
1163 $grsel = 'SUM(IR.freq) AS order_val';
1164 $orderBy = 'order_val' . $this->isDescending();
1165 }
1166
1167 // So, words are imploded into an OR statement (no "sentence search" should be done here - may deselect results)
1168 $wordSel = '(' . implode(' OR ', $this->wSelClauses) . ') AND ';
1169
1170 $res = $this->databaseConnection->exec_SELECTquery(
1171 'ISEC.*, IP.*, ' . $grsel,
1172 'index_words IW,
1173 index_rel IR,
1174 index_section ISEC,
1175 index_phash IP' . $page_join,
1176 $wordSel .
1177 'IP.phash IN (' . $list . ') ' .
1178 $this->mediaTypeWhere() . ' ' . $this->languageWhere() . $freeIndexUidClause . '
1179 AND IW.wid=IR.wid
1180 AND ISEC.phash = IR.phash
1181 AND IP.phash = IR.phash
1182 AND ' . $page_where,
1183 'IP.phash,ISEC.phash,ISEC.phash_t3,ISEC.rl0,ISEC.rl1,ISEC.rl2 ,ISEC.page_id,ISEC.uniqid,IP.phash_grouping,IP.data_filename ,IP.data_page_id ,IP.data_page_reg1,IP.data_page_type,IP.data_page_mp,IP.gr_list,IP.item_type,IP.item_title,IP.item_description,IP.item_mtime,IP.tstamp,IP.item_size,IP.contentHash,IP.crdate,IP.parsetime,IP.sys_language_uid,IP.item_crdate,IP.cHashParams,IP.externalUrl,IP.recordUid,IP.freeIndexUid,IP.freeIndexSetId',
1184 $orderBy
1185 );
1186 } else {
1187 // Otherwise, if sorting are done with the pages table or other fields, there is no need for joining with the rel/word tables:
1188 $orderBy = '';
1189 switch ((string)$this->piVars['order']) {
1190 case 'title':
1191 $orderBy = 'IP.item_title' . $this->isDescending();
1192 break;
1193 case 'crdate':
1194 $orderBy = 'IP.item_crdate' . $this->isDescending();
1195 break;
1196 case 'mtime':
1197 $orderBy = 'IP.item_mtime' . $this->isDescending();
1198 break;
1199 }
1200 $res = $this->databaseConnection->exec_SELECTquery('ISEC.*, IP.*', 'index_phash IP,index_section ISEC' . $page_join, 'IP.phash IN (' . $list . ') ' . $this->mediaTypeWhere() . ' ' . $this->languageWhere() . $freeIndexUidClause . '
1201 AND IP.phash = ISEC.phash
1202 AND ' . $page_where, 'IP.phash,ISEC.phash,ISEC.phash_t3,ISEC.rl0,ISEC.rl1,ISEC.rl2 ,ISEC.page_id,ISEC.uniqid,IP.phash_grouping,IP.data_filename ,IP.data_page_id ,IP.data_page_reg1,IP.data_page_type,IP.data_page_mp,IP.gr_list,IP.item_type,IP.item_title,IP.item_description,IP.item_mtime,IP.tstamp,IP.item_size,IP.contentHash,IP.crdate,IP.parsetime,IP.sys_language_uid,IP.item_crdate,IP.cHashParams,IP.externalUrl,IP.recordUid,IP.freeIndexUid,IP.freeIndexSetId', $orderBy);
1203 }
1204 return $res;
1205 }
1206
1207 /**
1208 * Checking if the resume can be shown for the search result (depending on whether the rights are OK)
1209 * ? Should it also check for gr_list "0,-1"?
1210 *
1211 * @param array $row Result row array.
1212 * @return bool Returns TRUE if resume can safely be shown
1213 */
1214 public function checkResume($row)
1215 {
1216 // If the record is indexed by an indexing configuration, just show it.
1217 // At least this is needed for external URLs and files.
1218 // For records we might need to extend this - for instance block display if record is access restricted.
1219 if ($row['freeIndexUid']) {
1220 return true;
1221 }
1222 // Evaluate regularly indexed pages based on item_type:
1223 if ($row['item_type']) {
1224 // External media:
1225 // For external media we will check the access of the parent page on which the media was linked from.
1226 // "phash_t3" is the phash of the parent TYPO3 page row which initiated the indexing of the documents in this section.
1227 // So, selecting for the grlist records belonging to the parent phash-row where the current users gr_list exists will help us to know.
1228 // If this is NOT found, there is still a theoretical possibility that another user accessible page would display a link, so maybe the resume of such a document here may be unjustified hidden. But better safe than sorry.
1229 if (\TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility::isTableUsed('index_grlist')) {
1230 $res = $this->databaseConnection->exec_SELECTquery('phash', 'index_grlist', 'phash=' . (int)$row['phash_t3'] . ' AND gr_list=' . $this->databaseConnection->fullQuoteStr($this->frontendController->gr_list, 'index_grlist'));
1231 } else {
1232 $res = false;
1233 }
1234 if ($res && $this->databaseConnection->sql_num_rows($res)) {
1235 return true;
1236 } else {
1237 return false;
1238 }
1239 } else {
1240 // Ordinary TYPO3 pages:
1241 if ((string)$row['gr_list'] !== (string)$this->frontendController->gr_list) {
1242 // Selecting for the grlist records belonging to the phash-row where the current users gr_list exists. If it is found it is proof that this user has direct access to the phash-rows content although he did not himself initiate the indexing...
1243 if (\TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility::isTableUsed('index_grlist')) {
1244 $res = $this->databaseConnection->exec_SELECTquery('phash', 'index_grlist', 'phash=' . (int)$row['phash'] . ' AND gr_list=' . $this->databaseConnection->fullQuoteStr($this->frontendController->gr_list, 'index_grlist'));
1245 } else {
1246 $res = false;
1247 }
1248 if ($res && $this->databaseConnection->sql_num_rows($res)) {
1249 return true;
1250 } else {
1251 return false;
1252 }
1253 } else {
1254 return true;
1255 }
1256 }
1257 }
1258
1259 /**
1260 * Check if the record is still available or if it has been deleted meanwhile.
1261 * Currently this works for files only, since extending it to page content would cause a lot of overhead.
1262 *
1263 * @param array $row Result row array
1264 * @return bool Returns TRUE if record is still available
1265 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
1266 */
1267 public function checkExistance($row)
1268 {
1269 GeneralUtility::logDeprecatedFunction();
1270 return $this->checkExistence($row);
1271 }
1272
1273 /**
1274 * Check if the record is still available or if it has been deleted meanwhile.
1275 * Currently this works for files only, since extending it to page content would cause a lot of overhead.
1276 *
1277 * @param array $row Result row array
1278 * @return bool Returns TRUE if record is still available
1279 */
1280 protected function checkExistence($row)
1281 {
1282 $recordExists = true;
1283 // Always expect that page content exists
1284 if ($row['item_type']) {
1285 // External media:
1286 if (!is_file($row['data_filename']) || !file_exists($row['data_filename'])) {
1287 $recordExists = false;
1288 }
1289 }
1290 return $recordExists;
1291 }
1292
1293 /**
1294 * Returns "DESC" or "" depending on the settings of the incoming highest/lowest result order (piVars['desc']
1295 *
1296 * @param bool $inverse If TRUE, inverse the order which is defined by piVars['desc']
1297 * @return string " DESC" or
1298 */
1299 public function isDescending($inverse = false)
1300 {
1301 $desc = $this->piVars['desc'];
1302 if ($inverse) {
1303 $desc = !$desc;
1304 }
1305 return !$desc ? ' DESC' : '';
1306 }
1307
1308 /**
1309 * Write statistics information to database for the search operation
1310 *
1311 * @param array $sWArr Search Word array
1312 * @param int $count Number of hits
1313 * @param int $pt Milliseconds the search took
1314 * @return void
1315 */
1316 public function writeSearchStat($sWArr, $count, $pt)
1317 {
1318 $insertFields = array(
1319 'searchstring' => $this->piVars['sword'],
1320 'searchoptions' => serialize(array($this->piVars, $sWArr, $pt)),
1321 'feuser_id' => (int)$GLOBALS['TSFE']->user['uid'],
1322 // fe_user id, integer
1323 'cookie' => (string)$GLOBALS['TSFE']->id,
1324 // cookie as set or retrieve. If people has cookies disabled this will vary all the time...
1325 'IP' => GeneralUtility::getIndpEnv('REMOTE_ADDR'),
1326 // Remote IP address
1327 'hits' => (int)$count,
1328 // Number of hits on the search.
1329 'tstamp' => $GLOBALS['EXEC_TIME']
1330 );
1331 $this->databaseConnection->exec_INSERTquery('index_stat_search', $insertFields);
1332 $newId = $this->databaseConnection->sql_insert_id();
1333 if ($newId) {
1334 foreach ($sWArr as $val) {
1335 $insertFields = array(
1336 'word' => $val['sword'],
1337 'index_stat_search_id' => $newId,
1338 'tstamp' => $GLOBALS['EXEC_TIME'],
1339 // Time stamp
1340 'pageid' => $this->frontendController->id
1341 );
1342 $this->databaseConnection->exec_INSERTquery('index_stat_word', $insertFields);
1343 }
1344 }
1345 }
1346
1347 /***********************************
1348 *
1349 * HTML output functions
1350 *
1351 ***********************************/
1352 /**
1353 * Make search form HTML
1354 *
1355 * @param array $optValues Value/Labels pairs for search form selector boxes.
1356 * @return string Search form HTML
1357 */
1358 public function makeSearchForm($optValues)
1359 {
1360 $html = $this->cObj->getSubpart($this->templateCode, '###SEARCH_FORM###');
1361 // Multilangual text
1362 $substituteArray = array('legend', 'searchFor', 'extResume', 'atATime', 'orderBy', 'fromSection', 'searchIn', 'match', 'style', 'freeIndexUid');
1363 foreach ($substituteArray as $marker) {
1364 $markerArray['###FORM_' . GeneralUtility::strtoupper($marker) . '###'] = $this->pi_getLL('form_' . $marker, '', true);
1365 }
1366 $markerArray['###FORM_SUBMIT###'] = $this->pi_getLL('submit_button_label', '', true);
1367 // Adding search field value
1368 $markerArray['###SWORD_VALUE###'] = htmlspecialchars($this->piVars['sword']);
1369 // Additonal keyword => "Add to current search words"
1370 if ($this->conf['show.']['clearSearchBox'] && $this->conf['show.']['clearSearchBox.']['enableSubSearchCheckBox']) {
1371 $markerArray['###SWORD_PREV_VALUE###'] = htmlspecialchars($this->conf['show.']['clearSearchBox'] ? '' : $this->piVars['sword']);
1372 $markerArray['###SWORD_PREV_INCLUDE_CHECKED###'] = $this->piVars['sword_prev_include'] ? ' checked="checked"' : '';
1373 $markerArray['###ADD_TO_CURRENT_SEARCH###'] = $this->pi_getLL('makerating_addToCurrentSearch', '', true);
1374 } else {
1375 $html = $this->cObj->substituteSubpart($html, '###ADDITONAL_KEYWORD###', '');
1376 }
1377 $markerArray['###ACTION_URL###'] = htmlspecialchars($this->getSearchFormActionURL());
1378 $hiddenFieldCode = $this->cObj->getSubpart($this->templateCode, '###HIDDEN_FIELDS###');
1379 $hiddenFieldCode = preg_replace('/^\\n\\t(.+)/ms', '$1', $hiddenFieldCode);
1380 // Remove first newline and tab (cosmetical issue)
1381 $hiddenFieldArr = array();
1382 foreach (GeneralUtility::trimExplode(',', $this->hiddenFieldList) as $fieldName) {
1383 $hiddenFieldMarkerArray = array();
1384 $hiddenFieldMarkerArray['###HIDDEN_FIELDNAME###'] = $this->prefixId . '[' . $fieldName . ']';
1385 $hiddenFieldMarkerArray['###HIDDEN_VALUE###'] = htmlspecialchars((string)$this->piVars[$fieldName]);
1386 $hiddenFieldArr[$fieldName] = $this->cObj->substituteMarkerArrayCached($hiddenFieldCode, $hiddenFieldMarkerArray, array(), array());
1387 }
1388 // Extended search
1389 if ($this->piVars['ext']) {
1390 // Search for
1391 if (!is_array($optValues['type']) && !is_array($optValues['defOp']) || $this->conf['blind.']['type'] && $this->conf['blind.']['defOp']) {
1392 $html = $this->cObj->substituteSubpart($html, '###SELECT_SEARCH_FOR###', '');
1393 } else {
1394 if (is_array($optValues['type']) && !$this->conf['blind.']['type']) {
1395 unset($hiddenFieldArr['type']);
1396 $markerArray['###SELECTBOX_TYPE_VALUES###'] = $this->renderSelectBoxValues($this->piVars['type'], $optValues['type']);
1397 } else {
1398 $html = $this->cObj->substituteSubpart($html, '###SELECT_SEARCH_TYPE###', '');
1399 }
1400 if (is_array($optValues['defOp']) || !$this->conf['blind.']['defOp']) {
1401 $markerArray['###SELECTBOX_DEFOP_VALUES###'] = $this->renderSelectBoxValues($this->piVars['defOp'], $optValues['defOp']);
1402 } else {
1403 $html = $this->cObj->substituteSubpart($html, '###SELECT_SEARCH_DEFOP###', '');
1404 }
1405 }
1406 // Search in
1407 if (!is_array($optValues['media']) && !is_array($optValues['lang']) || $this->conf['blind.']['media'] && $this->conf['blind.']['lang']) {
1408 $html = $this->cObj->substituteSubpart($html, '###SELECT_SEARCH_IN###', '');
1409 } else {
1410 if (is_array($optValues['media']) && !$this->conf['blind.']['media']) {
1411 unset($hiddenFieldArr['media']);
1412 $markerArray['###SELECTBOX_MEDIA_VALUES###'] = $this->renderSelectBoxValues($this->piVars['media'], $optValues['media']);
1413 } else {
1414 $html = $this->cObj->substituteSubpart($html, '###SELECT_SEARCH_MEDIA###', '');
1415 }
1416 if (is_array($optValues['lang']) || !$this->conf['blind.']['lang']) {
1417 unset($hiddenFieldArr['lang']);
1418 $markerArray['###SELECTBOX_LANG_VALUES###'] = $this->renderSelectBoxValues($this->piVars['lang'], $optValues['lang']);
1419 } else {
1420 $html = $this->cObj->substituteSubpart($html, '###SELECT_SEARCH_LANG###', '');
1421 }
1422 }
1423 // Sections
1424 if (!is_array($optValues['sections']) || $this->conf['blind.']['sections']) {
1425 $html = $this->cObj->substituteSubpart($html, '###SELECT_SECTION###', '');
1426 } else {
1427 $markerArray['###SELECTBOX_SECTIONS_VALUES###'] = $this->renderSelectBoxValues($this->piVars['sections'], $optValues['sections']);
1428 }
1429 // Free Indexing Configurations:
1430 if (!is_array($optValues['freeIndexUid']) || $this->conf['blind.']['freeIndexUid']) {
1431 $html = $this->cObj->substituteSubpart($html, '###SELECT_FREEINDEXUID###', '');
1432 } else {
1433 $markerArray['###SELECTBOX_FREEINDEXUIDS_VALUES###'] = $this->renderSelectBoxValues($this->piVars['freeIndexUid'], $optValues['freeIndexUid']);
1434 }
1435 // Sorting
1436 if (!is_array($optValues['order']) || !is_array($optValues['desc']) || $this->conf['blind.']['order']) {
1437 $html = $this->cObj->substituteSubpart($html, '###SELECT_ORDER###', '');
1438 } else {
1439 unset($hiddenFieldArr['order']);
1440 unset($hiddenFieldArr['desc']);
1441 unset($hiddenFieldArr['results']);
1442 $markerArray['###SELECTBOX_ORDER_VALUES###'] = $this->renderSelectBoxValues($this->piVars['order'], $optValues['order']);
1443 $markerArray['###SELECTBOX_DESC_VALUES###'] = $this->renderSelectBoxValues($this->piVars['desc'], $optValues['desc']);
1444 $markerArray['###SELECTBOX_RESULTS_VALUES###'] = $this->renderSelectBoxValues($this->piVars['results'], $optValues['results']);
1445 }
1446 // Limits
1447 if (!is_array($optValues['results']) || !is_array($optValues['results']) || $this->conf['blind.']['results']) {
1448 $html = $this->cObj->substituteSubpart($html, '###SELECT_RESULTS###', '');
1449 } else {
1450 $markerArray['###SELECTBOX_RESULTS_VALUES###'] = $this->renderSelectBoxValues($this->piVars['results'], $optValues['results']);
1451 }
1452 // Grouping
1453 if (!is_array($optValues['group']) || $this->conf['blind.']['group']) {
1454 $html = $this->cObj->substituteSubpart($html, '###SELECT_GROUP###', '');
1455 } else {
1456 unset($hiddenFieldArr['group']);
1457 $markerArray['###SELECTBOX_GROUP_VALUES###'] = $this->renderSelectBoxValues($this->piVars['group'], $optValues['group']);
1458 }
1459 if ($this->conf['blind.']['extResume']) {
1460 $html = $this->cObj->substituteSubpart($html, '###SELECT_EXTRESUME###', '');
1461 } else {
1462 $markerArray['###EXT_RESUME_CHECKED###'] = $this->piVars['extResume'] ? ' checked="checked"' : '';
1463 }
1464 } else {
1465 // Extended search
1466 $html = $this->cObj->substituteSubpart($html, '###SEARCH_FORM_EXTENDED###', '');
1467 }
1468 if ($this->conf['show.']['advancedSearchLink']) {
1469 $linkToOtherMode = $this->piVars['ext'] ? $this->pi_getPageLink($this->frontendController->id, $this->frontendController->sPre) : $this->pi_getPageLink($this->frontendController->id, $this->frontendController->sPre, array($this->prefixId . '[ext]' => 1));
1470 $markerArray['###LINKTOOTHERMODE###'] = '<a href="' . htmlspecialchars($linkToOtherMode) . '">' . $this->pi_getLL(($this->piVars['ext'] ? 'link_regularSearch' : 'link_advancedSearch'), '', true) . '</a>';
1471 } else {
1472 $markerArray['###LINKTOOTHERMODE###'] = '';
1473 }
1474 // Write all hidden fields
1475 $html = $this->cObj->substituteSubpart($html, '###HIDDEN_FIELDS###', implode('', $hiddenFieldArr));
1476 $substitutedContent = $this->cObj->substituteMarkerArrayCached($html, $markerArray, array(), array());
1477 return $substitutedContent;
1478 }
1479
1480 /**
1481 * Function, rendering selector box values.
1482 *
1483 * @param string $value Current value
1484 * @param array $optValues Array with the options as key=>value pairs
1485 * @return string <options> imploded.
1486 */
1487 public function renderSelectBoxValues($value, $optValues)
1488 {
1489 if (!is_array($optValues)) {
1490 return '';
1491 }
1492 $opt = array();
1493 $isSelFlag = 0;
1494 foreach ($optValues as $k => $v) {
1495 $sel = (string)$k === (string)$value ? ' selected="selected"' : '';
1496 if ($sel) {
1497 $isSelFlag++;
1498 }
1499 $opt[] = '<option value="' . htmlspecialchars($k) . '"' . $sel . '>' . htmlspecialchars($v) . '</option>';
1500 }
1501 return implode('', $opt);
1502 }
1503
1504 /**
1505 * Print the searching rules
1506 *
1507 * @return string Rules for the search
1508 */
1509 public function printRules()
1510 {
1511 if (!$this->conf['show.']['rules']) {
1512 return '';
1513 }
1514 $html = $this->cObj->getSubpart($this->templateCode, '###RULES###');
1515 $markerArray['###RULES_HEADER###'] = $this->pi_getLL('rules_header', '', true);
1516 $markerArray['###RULES_TEXT###'] = nl2br(trim($this->pi_getLL('rules_text', '', true)));
1517 $substitutedContent = $this->cObj->substituteMarkerArrayCached($html, $markerArray, array(), array());
1518 return $this->cObj->stdWrap($substitutedContent, $this->conf['rules_stdWrap.']);
1519 }
1520
1521 /**
1522 * Returns the anchor-links to the sections inside the displayed result rows.
1523 *
1524 * @return string
1525 */
1526 public function printResultSectionLinks()
1527 {
1528 if (empty($this->resultSections)) {
1529 return '';
1530 }
1531 $links = array();
1532 $html = $this->cObj->getSubpart($this->templateCode, '###RESULT_SECTION_LINKS###');
1533 $item = $this->cObj->getSubpart($this->templateCode, '###RESULT_SECTION_LINKS_LINK###');
1534 $anchorPrefix = $GLOBALS['TSFE']->baseUrl ? substr(GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'), strlen(GeneralUtility::getIndpEnv('TYPO3_SITE_URL'))) : '';
1535 foreach ($this->resultSections as $id => $dat) {
1536 $markerArray = array();
1537 $aBegin = '<a href="' . htmlspecialchars($anchorPrefix . '#anchor_' . md5($id)) . '">';
1538 $aContent = (trim($dat[0]) ? trim($dat[0]) : htmlspecialchars($this->pi_getLL('unnamedSection'))) . ' (' . $dat[1] . ' ' . $this->pi_getLL(($dat[1] > 1 ? 'word_pages' : 'word_page'), '', true) . ')';
1539 $aEnd = '</a>';
1540 $markerArray['###LINK###'] = $aBegin . $aContent . $aEnd;
1541 $links[] = $this->cObj->substituteMarkerArrayCached($item, $markerArray, array(), array());
1542 }
1543 $html = $this->cObj->substituteMarkerArrayCached($html, array('###LINKS###' => implode('', $links)), array(), array());
1544 return '<div' . $this->pi_classParam('sectionlinks') . '>' . $this->cObj->stdWrap($html, $this->conf['sectionlinks_stdWrap.']) . '</div>';
1545 }
1546
1547 /**
1548 * Returns the section header of the search result.
1549 *
1550 * @param string $id ID for the section (used for anchor link)
1551 * @param string $sectionTitleLinked Section title with linked wrapped around
1552 * @param int $countResultRows Number of results in section
1553 * @return string HTML output
1554 */
1555 public function makeSectionHeader($id, $sectionTitleLinked, $countResultRows)
1556 {
1557 $html = $this->cObj->getSubpart($this->templateCode, '###SECTION_HEADER###');
1558 $markerArray['###ANCHOR_URL###'] = 'anchor_' . md5($id);
1559 $markerArray['###SECTION_TITLE###'] = $sectionTitleLinked;
1560 $markerArray['###RESULT_COUNT###'] = $countResultRows;
1561 $markerArray['###RESULT_NAME###'] = $this->pi_getLL('word_page' . ($countResultRows > 1 ? 's' : ''));
1562 $substitutedContent = $this->cObj->substituteMarkerArrayCached($html, $markerArray, array(), array());
1563 return $substitutedContent;
1564 }
1565
1566 /**
1567 * This prints a single result row, including a recursive call for subrows.
1568 *
1569 * @param array $row Search result row
1570 * @param int $headerOnly 1=Display only header (for sub-rows!), 2=nothing at all
1571 * @return string HTML code
1572 */
1573 public function printResultRow($row, $headerOnly = 0)
1574 {
1575 // Get template content:
1576 $tmplContent = $this->prepareResultRowTemplateData($row, $headerOnly);
1577 if ($hookObj = $this->hookRequest('printResultRow')) {
1578 return $hookObj->printResultRow($row, $headerOnly, $tmplContent);
1579 } else {
1580 $html = $this->cObj->getSubpart($this->templateCode, '###RESULT_OUTPUT###');
1581 if (!is_array($row['_sub'])) {
1582 $html = $this->cObj->substituteSubpart($html, '###ROW_SUB###', '');
1583 }
1584 if (!$headerOnly) {
1585 $html = $this->cObj->substituteSubpart($html, '###ROW_SHORT###', '');
1586 } elseif ($headerOnly == 1) {
1587 $html = $this->cObj->substituteSubpart($html, '###ROW_LONG###', '');
1588 } elseif ($headerOnly == 2) {
1589 $html = $this->cObj->substituteSubpart($html, '###ROW_SHORT###', '');
1590 $html = $this->cObj->substituteSubpart($html, '###ROW_LONG###', '');
1591 }
1592 if (is_array($tmplContent)) {
1593 foreach ($tmplContent as $k => $v) {
1594 $markerArray['###' . GeneralUtility::strtoupper($k) . '###'] = $v;
1595 }
1596 }
1597 // Description text
1598 $markerArray['###TEXT_ITEM_SIZE###'] = $this->pi_getLL('res_size', '', true);
1599 $markerArray['###TEXT_ITEM_CRDATE###'] = $this->pi_getLL('res_created', '', true);
1600 $markerArray['###TEXT_ITEM_MTIME###'] = $this->pi_getLL('res_modified', '', true);
1601 $markerArray['###TEXT_ITEM_PATH###'] = $this->pi_getLL('res_path', '', true);
1602 $html = $this->cObj->substituteMarkerArrayCached($html, $markerArray, array(), array());
1603 // If there are subrows (eg. subpages in a PDF-file or if a duplicate page is selected due to user-login (phash_grouping))
1604 if (is_array($row['_sub'])) {
1605 if ($this->multiplePagesType($row['item_type'])) {
1606 $html = str_replace('###TEXT_ROW_SUB###', $this->pi_getLL('res_otherMatching', '', true), $html);
1607 foreach ($row['_sub'] as $subRow) {
1608 $html .= $this->printResultRow($subRow, 1);
1609 }
1610 } else {
1611 $markerArray['###TEXT_ROW_SUB###'] = $this->pi_getLL('res_otherMatching', '', true);
1612 $html = str_replace('###TEXT_ROW_SUB###', $this->pi_getLL('res_otherPageAsWell', '', true), $html);
1613 }
1614 }
1615 return $html;
1616 }
1617 }
1618
1619 /**
1620 * Returns a results browser
1621 *
1622 * @param bool $showResultCount Show result count
1623 * @param string $addString String appended to "displaying results..." notice.
1624 * @param string $addPart String appended after section "displaying results...
1625 * @param string $freeIndexUid List of integers pointing to free indexing configurations to search. -1 represents no filtering, 0 represents TYPO3 pages only, any number above zero is a uid of an indexing configuration!
1626 * @return string HTML output
1627 */
1628 public function pi_list_browseresults($showResultCount = true, $addString = '', $addPart = '', $freeIndexUid = -1)
1629 {
1630 // Initializing variables:
1631 $pointer = (int)$this->piVars['pointer'];
1632 $count = (int)$this->internal['res_count'];
1633 $results_at_a_time = MathUtility::forceIntegerInRange($this->internal['results_at_a_time'], 1, 1000);
1634 $pageCount = (int)ceil($count / $results_at_a_time);
1635
1636 $links = array();
1637 // only show the result browser if more than one page is needed
1638 if ($pageCount > 1) {
1639 $maxPages = MathUtility::forceIntegerInRange($this->internal['maxPages'], 1, $pageCount);
1640
1641 // Make browse-table/links:
1642 if ($pointer > 0) {
1643 // all pages after the 1st one
1644 $links[] = '<li>' . $this->makePointerSelector_link($this->pi_getLL('pi_list_browseresults_prev', '< Previous', true), $pointer - 1, $freeIndexUid) . '</li>';
1645 }
1646 $minPage = $pointer - (int)floor($maxPages / 2);
1647 $maxPage = $minPage + $maxPages - 1;
1648 // Check if the indexes are within the page limits
1649 if ($minPage < 0) {
1650 $maxPage -= $minPage;
1651 $minPage = 0;
1652 } elseif ($maxPage >= $pageCount) {
1653 $minPage -= $maxPage - $pageCount + 1;
1654 $maxPage = $pageCount - 1;
1655 }
1656 $pageLabel = $this->pi_getLL('pi_list_browseresults_page', 'Page', true);
1657 for ($a = $minPage; $a <= $maxPage; $a++) {
1658 $label = trim($pageLabel . ' ' . ($a + 1));
1659 $link = $this->makePointerSelector_link($label, $a, $freeIndexUid);
1660 if ($a === $pointer) {
1661 $links[] = '<li' . $this->pi_classParam('browselist-currentPage') . '><strong>' . $link . '</strong></li>';
1662 } else {
1663 $links[] = '<li>' . $link . '</li>';
1664 }
1665 }
1666 if ($pointer + 1 < $pageCount) {
1667 $links[] = '<li>' . $this->makePointerSelector_link($this->pi_getLL('pi_list_browseresults_next', 'Next >', true), $pointer + 1, $freeIndexUid) . '</li>';
1668 }
1669 }
1670 if (!empty($links)) {
1671 $addPart .= '
1672 <ul class="browsebox">
1673 ' . implode('', $links) . '
1674 </ul>';
1675 }
1676 $label = str_replace(
1677 array('###TAG_BEGIN###', '###TAG_END###'),
1678 array('<strong>', '</strong>'),
1679 $this->pi_getLL('pi_list_browseresults_display', 'Displaying results ###TAG_BEGIN###%1$s to %2$s###TAG_END### out of ###TAG_BEGIN###%3$s###TAG_END###')
1680 );
1681 $resultsFrom = $pointer * $results_at_a_time + 1;
1682 $resultsTo = min($resultsFrom + $results_at_a_time - 1, $count);
1683 $resultCountText = '';
1684 if ($showResultCount) {
1685 $resultCountText = '<p>' . sprintf($label, $resultsFrom, $resultsTo, $count) . $addString . '</p>';
1686 }
1687 $sTables = '<div' . $this->pi_classParam('browsebox') . '>'
1688 . $resultCountText
1689 . $addPart . '</div>';
1690 return $sTables;
1691 }
1692
1693 /***********************************
1694 *
1695 * Support functions for HTML output (with a minimum of fixed markup)
1696 *
1697 ***********************************/
1698 /**
1699 * Preparing template data for the result row output
1700 *
1701 * @param array $row Result row
1702 * @param bool $headerOnly If set, display only header of result (for sub-results)
1703 * @return array Array with data to insert in result row template
1704 */
1705 public function prepareResultRowTemplateData($row, $headerOnly)
1706 {
1707 // Initialize:
1708 $specRowConf = $this->getSpecialConfigForRow($row);
1709 $CSSsuffix = $specRowConf['CSSsuffix'] ? '-' . $specRowConf['CSSsuffix'] : '';
1710 // If external media, link to the media-file instead.
1711 if ($row['item_type']) {
1712 // External media
1713 if ($row['show_resume']) {
1714 // Can link directly.
1715 $targetAttribute = '';
1716 if ($this->frontendController->config['config']['fileTarget']) {
1717 $targetAttribute = ' target="' . htmlspecialchars($this->frontendController->config['config']['fileTarget']) . '"';
1718 }
1719 $title = '<a href="' . htmlspecialchars($row['data_filename']) . '"' . $targetAttribute . '>' . htmlspecialchars($this->makeTitle($row)) . '</a>';
1720 } else {
1721 // Suspicious, so linking to page instead...
1722 $copy_row = $row;
1723 unset($copy_row['cHashParams']);
1724 $title = $this->linkPage($row['page_id'], htmlspecialchars($this->makeTitle($row)), $copy_row);
1725 }
1726 } else {
1727 // Else the page:
1728 // Prepare search words for markup in content:
1729 if ($this->conf['forwardSearchWordsInResultLink']) {
1730 if ($this->conf['forwardSearchWordsInResultLink.']['no_cache']) {
1731 $markUpSwParams = array('no_cache' => 1);
1732 } else {
1733 $markUpSwParams = array();
1734 }
1735 foreach ($this->sWArr as $d) {
1736 $markUpSwParams['sword_list'][] = $d['sword'];
1737 }
1738 } else {
1739 $markUpSwParams = array();
1740 }
1741 $title = $this->linkPage($row['data_page_id'], htmlspecialchars($this->makeTitle($row)), $row, $markUpSwParams);
1742 }
1743 $tmplContent = array();
1744 $tmplContent['title'] = $title;
1745 $tmplContent['result_number'] = $this->conf['show.']['resultNumber'] ? $row['result_number'] . ': ' : '&nbsp;';
1746 $tmplContent['icon'] = $this->makeItemTypeIcon($row['item_type'], '', $specRowConf);
1747 $tmplContent['rating'] = $this->makeRating($row);
1748 $tmplContent['description'] = $this->makeDescription(
1749 $row,
1750 !($this->piVars['extResume'] && !$headerOnly),
1751 $this->conf['results.']['summaryCropAfter']
1752 );
1753 $tmplContent = $this->makeInfo($row, $tmplContent);
1754 $tmplContent['access'] = $this->makeAccessIndication($row['page_id']);
1755 $tmplContent['language'] = $this->makeLanguageIndication($row);
1756 $tmplContent['CSSsuffix'] = $CSSsuffix;
1757 // Post processing with hook.
1758 if ($hookObj = $this->hookRequest('prepareResultRowTemplateData_postProc')) {
1759 $tmplContent = $hookObj->prepareResultRowTemplateData_postProc($tmplContent, $row, $headerOnly);
1760 }
1761 return $tmplContent;
1762 }
1763
1764 /**
1765 * Returns a string that tells which search words are searched for.
1766 *
1767 * @param array Array of search words
1768 * @return string HTML telling what is searched for.
1769 */
1770 public function tellUsWhatIsSeachedFor($sWArr)
1771 {
1772 // Init:
1773 $searchingFor = '';
1774 $c = 0;
1775 // Traverse search words:
1776 foreach ($sWArr as $k => $v) {
1777 if ($c) {
1778 switch ($v['oper']) {
1779 case 'OR':
1780 $searchingFor .= ' ' . $this->pi_getLL('searchFor_or', '', true) . ' ' . $this->wrapSW($this->utf8_to_currentCharset($v['sword']));
1781 break;
1782 case 'AND NOT':
1783 $searchingFor .= ' ' . $this->pi_getLL('searchFor_butNot', '', true) . ' ' . $this->wrapSW($this->utf8_to_currentCharset($v['sword']));
1784 break;
1785 default:
1786 // AND...
1787 $searchingFor .= ' ' . $this->pi_getLL('searchFor_and', '', true) . ' ' . $this->wrapSW($this->utf8_to_currentCharset($v['sword']));
1788 }
1789 } else {
1790 $searchingFor = $this->pi_getLL('searchFor', '', true) . ' ' . $this->wrapSW($this->utf8_to_currentCharset($v['sword']));
1791 }
1792 $c++;
1793 }
1794 return $searchingFor;
1795 }
1796
1797 /**
1798 * Wraps the search words in the search-word list display (from ->tellUsWhatIsSeachedFor())
1799 *
1800 * @param string $str search word to wrap (in local charset!)
1801 * @return string Search word wrapped in <span> tag.
1802 */
1803 public function wrapSW($str)
1804 {
1805 return '"<span' . $this->pi_classParam('sw') . '>' . htmlspecialchars($str) . '</span>"';
1806 }
1807
1808 /**
1809 * Makes a selector box
1810 *
1811 * @param string $name Name of selector box
1812 * @param string $value Current value
1813 * @param array $optValues Array of options in the selector box (value => label pairs)
1814 * @return string HTML of selector box
1815 */
1816 public function renderSelectBox($name, $value, $optValues)
1817 {
1818 if (is_array($optValues)) {
1819 $opt = array();
1820 $isSelFlag = 0;
1821 foreach ($optValues as $k => $v) {
1822 $sel = (string)$k === (string)$value ? ' selected="selected"' : '';
1823 if ($sel) {
1824 $isSelFlag++;
1825 }
1826 $opt[] = '<option value="' . htmlspecialchars($k) . '"' . $sel . '>' . htmlspecialchars($v) . '</option>';
1827 }
1828 return '<select name="' . $name . '">' . implode('', $opt) . '</select>';
1829 }
1830 }
1831
1832 /**
1833 * Used to make the link for the result-browser.
1834 * Notice how the links must resubmit the form after setting the new pointer-value in a hidden formfield.
1835 *
1836 * @param string $str String to wrap in <a> tag
1837 * @param int $p Pointer value
1838 * @param string $freeIndexUid List of integers pointing to free indexing configurations to search. -1 represents no filtering, 0 represents TYPO3 pages only, any number above zero is a uid of an indexing configuration!
1839 * @return string Input string wrapped in <a> tag with onclick event attribute set.
1840 */
1841 public function makePointerSelector_link($str, $p, $freeIndexUid)
1842 {
1843 $onclick = 'document.getElementById(\'' . $this->prefixId . '_pointer\').value=\'' . $p . '\';' . 'document.getElementById(\'' . $this->prefixId . '_freeIndexUid\').value=\'' . rawurlencode($freeIndexUid) . '\';' . 'document.getElementById(\'' . $this->prefixId . '\').submit();return false;';
1844 return '<a href="#" onclick="' . htmlspecialchars($onclick) . '">' . $str . '</a>';
1845 }
1846
1847 /**
1848 * Return icon for file extension
1849 *
1850 * @param string $it File extension / item type
1851 * @param string $alt Title attribute value in icon.
1852 * @param array $specRowConf TypoScript configuration specifically for search result.
1853 * @return string <img> tag for icon
1854 */
1855 public function makeItemTypeIcon($it, $alt = '', $specRowConf)
1856 {
1857 // Build compound key if item type is 0, iconRendering is not used
1858 // and specConfs.[pid].pageIcon was set in TS
1859 if ($it === '0' && $specRowConf['_pid'] && is_array($specRowConf['pageIcon.']) && !is_array($this->conf['iconRendering.'])) {
1860 $it .= ':' . $specRowConf['_pid'];
1861 }
1862 if (!isset($this->iconFileNameCache[$it])) {
1863 $this->iconFileNameCache[$it] = '';
1864 // If TypoScript is used to render the icon:
1865 if (is_array($this->conf['iconRendering.'])) {
1866 $this->cObj->setCurrentVal($it);
1867 $this->iconFileNameCache[$it] = $this->cObj->cObjGetSingle($this->conf['iconRendering'], $this->conf['iconRendering.']);
1868 } else {
1869 // Default creation / finding of icon:
1870 $icon = '';
1871 if ($it === '0' || substr($it, 0, 2) == '0:') {
1872 if (is_array($specRowConf['pageIcon.'])) {
1873 $this->iconFileNameCache[$it] = $this->cObj->cObjGetSingle('IMAGE', $specRowConf['pageIcon.']);
1874 } else {
1875 $icon = 'EXT:indexed_search/Resources/Public/Icons/FileTypes/pages.gif';
1876 }
1877 } elseif ($this->external_parsers[$it]) {
1878 $icon = $this->external_parsers[$it]->getIcon($it);
1879 }
1880 if ($icon) {
1881 $fullPath = GeneralUtility::getFileAbsFileName($icon);
1882 if ($fullPath) {
1883 $info = @getimagesize($fullPath);
1884 $iconPath = \TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix($fullPath);
1885 $this->iconFileNameCache[$it] = is_array($info) ? '<img src="' . $iconPath . '" ' . $info[3] . ' title="' . htmlspecialchars($alt) . '" alt="" />' : '';
1886 }
1887 }
1888 }
1889 }
1890 return $this->iconFileNameCache[$it];
1891 }
1892
1893 /**
1894 * Return the rating-HTML code for the result row. This makes use of the $this->firstRow
1895 *
1896 * @param array $row Result row array
1897 * @return string String showing ranking value
1898 */
1899 public function makeRating($row)
1900 {
1901 switch ((string)$this->piVars['order']) {
1902 case 'rank_count':
1903 // Number of occurencies on page
1904 return $row['order_val'] . ' ' . $this->pi_getLL('maketitle_matches');
1905 break;
1906 case 'rank_first':
1907 // Close to top of page
1908 return ceil(MathUtility::forceIntegerInRange((255 - $row['order_val']), 1, 255) / 255 * 100) . '%';
1909 break;
1910 case 'rank_flag':
1911 // Based on priority assigned to <title> / <meta-keywords> / <meta-description> / <body>
1912 if ($this->firstRow['order_val2']) {
1913 $base = $row['order_val1'] * 256;
1914 // (3 MSB bit, 224 is highest value of order_val1 currently)
1915 $freqNumber = $row['order_val2'] / $this->firstRow['order_val2'] * pow(2, 12);
1916 // 15-3 MSB = 12
1917 $total = MathUtility::forceIntegerInRange($base + $freqNumber, 0, 32767);
1918 return ceil(log($total) / log(32767) * 100) . '%';
1919 }
1920 break;
1921 case 'rank_freq':
1922 // Based on frequency
1923 $max = 10000;
1924 $total = MathUtility::forceIntegerInRange($row['order_val'], 0, $max);
1925 return ceil(log($total) / log($max) * 100) . '%';
1926 break;
1927 case 'crdate':
1928 // Based on creation date
1929 return $this->cObj->calcAge($GLOBALS['EXEC_TIME'] - $row['item_crdate'], 0);
1930 break;
1931 case 'mtime':
1932 // Based on modification time
1933 return $this->cObj->calcAge($GLOBALS['EXEC_TIME'] - $row['item_mtime'], 0);
1934 break;
1935 default:
1936 // fx. title
1937 return '&nbsp;';
1938 }
1939 }
1940
1941 /**
1942 * Returns the resume for the search-result.
1943 *
1944 * @param array $row Search result row
1945 * @param bool $noMarkup If noMarkup is FALSE, then the index_fulltext table is used to select the content of the page, split it with regex to display the search words in the text.
1946 * @param int $lgd String length
1947 * @return string HTML string
1948 */
1949 public function makeDescription($row, $noMarkup = false, $lgd = 180)
1950 {
1951 if ($row['show_resume']) {
1952 $markedSW = '';
1953 $outputStr = '';
1954 if (!$noMarkup) {
1955 if (\TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility::isTableUsed('index_fulltext')) {
1956 $res = $this->databaseConnection->exec_SELECTquery('*', 'index_fulltext', 'phash=' . (int)$row['phash']);
1957 } else {
1958 $res = false;
1959 }
1960 if ($res) {
1961 if ($ftdrow = $this->databaseConnection->sql_fetch_assoc($res)) {
1962 // Cut HTTP references after some length
1963 $content = preg_replace('/(http:\\/\\/[^ ]{' . $this->conf['results.']['hrefInSummaryCropAfter'] . '})([^ ]+)/i', '$1...', $ftdrow['fulltextdata']);
1964 $markedSW = $this->markupSWpartsOfString($content);
1965 }
1966 $this->databaseConnection->sql_free_result($res);
1967 }
1968 }
1969 if (!trim($markedSW)) {
1970 $outputStr = $this->frontendController->csConvObj->crop('utf-8', $row['item_description'], $lgd, $this->conf['results.']['summaryCropSignifier']);
1971 $outputStr = htmlspecialchars($outputStr);
1972 }
1973 $output = $this->utf8_to_currentCharset($outputStr ?: $markedSW);
1974 } else {
1975 $output = '<span class="noResume">' . $this->pi_getLL('res_noResume', '', true) . '</span>';
1976 }
1977 return $output;
1978 }
1979
1980 /**
1981 * Marks up the search words from $this->sWarr in the $str with a color.
1982 *
1983 * @param string $str Text in which to find and mark up search words. This text is assumed to be UTF-8 like the search words internally is.
1984 * @return string Processed content.
1985 */
1986 public function markupSWpartsOfString($str)
1987 {
1988 $htmlParser = GeneralUtility::makeInstance(HtmlParser::class);
1989 // Init:
1990 $str = str_replace('&nbsp;', ' ', $htmlParser->bidir_htmlspecialchars($str, -1));
1991 $str = preg_replace('/\\s\\s+/', ' ', $str);
1992 $swForReg = array();
1993 // Prepare search words for regex:
1994 foreach ($this->sWArr as $d) {
1995 $swForReg[] = preg_quote($d['sword'], '/');
1996 }
1997 $regExString = '(' . implode('|', $swForReg) . ')';
1998 // Split and combine:
1999 $parts = preg_split('/' . $regExString . '/ui', ' ' . $str . ' ', 20000, PREG_SPLIT_DELIM_CAPTURE);
2000 // Constants:
2001 $summaryMax = $this->conf['results.']['markupSW_summaryMax'];
2002 $postPreLgd = $this->conf['results.']['markupSW_postPreLgd'];
2003 $postPreLgd_offset = $this->conf['results.']['markupSW_postPreLgd_offset'];
2004 $divider = $this->conf['results.']['markupSW_divider'];
2005 $occurencies = (count($parts) - 1) / 2;
2006 if ($occurencies) {
2007 $postPreLgd = MathUtility::forceIntegerInRange($summaryMax / $occurencies, $postPreLgd, $summaryMax / 2);
2008 }
2009 // Variable:
2010 $summaryLgd = 0;
2011 $output = array();
2012 // Shorten in-between strings:
2013 foreach ($parts as $k => $strP) {
2014 if ($k % 2 == 0) {
2015 // Find length of the summary part:
2016 $strLen = $this->frontendController->csConvObj->strlen('utf-8', $parts[$k]);
2017 $output[$k] = $parts[$k];
2018 // Possibly shorten string:
2019 if (!$k) {
2020 // First entry at all (only cropped on the frontside)
2021 if ($strLen > $postPreLgd) {
2022 $output[$k] = $divider . preg_replace('/^[^[:space:]]+[[:space:]]/', '', $this->frontendController->csConvObj->crop('utf-8', $parts[$k], -($postPreLgd - $postPreLgd_offset)));
2023 }
2024 } elseif ($summaryLgd > $summaryMax || !isset($parts[$k + 1])) {
2025 // In case summary length is exceed OR if there are no more entries at all:
2026 if ($strLen > $postPreLgd) {
2027 $output[$k] = preg_replace('/[[:space:]][^[:space:]]+$/', '', $this->frontendController->csConvObj->crop('utf-8', $parts[$k], ($postPreLgd - $postPreLgd_offset))) . $divider;
2028 }
2029 } else {
2030 // In-between search words:
2031 if ($strLen > $postPreLgd * 2) {
2032 $output[$k] = preg_replace('/[[:space:]][^[:space:]]+$/', '', $this->frontendController->csConvObj->crop('utf-8', $parts[$k], ($postPreLgd - $postPreLgd_offset))) . $divider . preg_replace('/^[^[:space:]]+[[:space:]]/', '', $this->frontendController->csConvObj->crop('utf-8', $parts[$k], -($postPreLgd - $postPreLgd_offset)));
2033 }
2034 }
2035 $summaryLgd += $this->frontendController->csConvObj->strlen('utf-8', $output[$k]);
2036 // Protect output:
2037 $output[$k] = htmlspecialchars($output[$k]);
2038 // If summary lgd is exceed, break the process:
2039 if ($summaryLgd > $summaryMax) {
2040 break;
2041 }
2042 } else {
2043 $summaryLgd += $this->frontendController->csConvObj->strlen('utf-8', $strP);
2044 $output[$k] = '<strong class="tx-indexedsearch-redMarkup">' . htmlspecialchars($parts[$k]) . '</strong>';
2045 }
2046 }
2047 // Return result:
2048 return implode('', $output);
2049 }
2050
2051 /**
2052 * Returns the title of the search result row
2053 *
2054 * @param array $row Result row
2055 * @return string Title from row
2056 */
2057 public function makeTitle($row)
2058 {
2059 $add = '';
2060 if ($this->multiplePagesType($row['item_type'])) {
2061 $dat = unserialize($row['cHashParams']);
2062 $pp = explode('-', $dat['key']);
2063 if ($pp[0] != $pp[1]) {
2064 $add = ', ' . $this->pi_getLL('word_pages') . ' ' . $dat['key'];
2065 } else {
2066 $add = ', ' . $this->pi_getLL('word_page') . ' ' . $pp[0];
2067 }
2068 }
2069 $outputString = $this->frontendController->csConvObj->crop('utf-8', $row['item_title'], $this->conf['results.']['titleCropAfter'], $this->conf['results.']['titleCropSignifier']);
2070 return $this->utf8_to_currentCharset($outputString) . $add;
2071 }
2072
2073 /**
2074 * Returns the info-string in the bottom of the result-row display (size, dates, path)
2075 *
2076 * @param array $row Result row
2077 * @param array $tmplArray Template array to modify
2078 * @return array Modified template array
2079 */
2080 public function makeInfo($row, $tmplArray)
2081 {
2082 $tmplArray['size'] = GeneralUtility::formatSize($row['item_size']);
2083 $tmplArray['created'] = $this->formatCreatedDate($row['item_crdate']);
2084 $tmplArray['modified'] = $this->formatModifiedDate($row['item_mtime']);
2085 $pathId = $row['data_page_id'] ?: $row['page_id'];
2086 $pathMP = $row['data_page_id'] ? $row['data_page_mp'] : '';
2087 $pI = parse_url($row['data_filename']);
2088 if ($pI['scheme']) {
2089 $targetAttribute = '';
2090 if ($this->frontendController->config['config']['fileTarget']) {
2091 $targetAttribute = ' target="' . htmlspecialchars($this->frontendController->config['config']['fileTarget']) . '"';
2092 }
2093 $tmplArray['path'] = '<a href="' . htmlspecialchars($row['data_filename']) . '"' . $targetAttribute . '>' . htmlspecialchars($row['data_filename']) . '</a>';
2094 } else {
2095 $pathStr = $this->getPathFromPageId($pathId, $pathMP);
2096 $tmplArray['path'] = $this->linkPage($pathId, $pathStr, array(
2097 'cHashParams' => $row['cHashParams'],
2098 'data_page_type' => $row['data_page_type'],
2099 'data_page_mp' => $pathMP,
2100 'sys_language_uid' => $row['sys_language_uid']
2101 ));
2102 }
2103 return $tmplArray;
2104 }
2105
2106 /**
2107 * Returns configuration from TypoScript for result row based on ID / location in page tree!
2108 *
2109 * @param array $row Result row
2110 * @return array Configuration array
2111 */
2112 public function getSpecialConfigForRow($row)
2113 {
2114 $pathId = $row['data_page_id'] ?: $row['page_id'];
2115 $pathMP = $row['data_page_id'] ? $row['data_page_mp'] : '';
2116 $rl = $this->getRootLine($pathId, $pathMP);
2117 $specConf = $this->conf['specConfs.']['0.'];
2118 if (is_array($rl)) {
2119 foreach ($rl as $dat) {
2120 if (is_array($this->conf['specConfs.'][$dat['uid'] . '.'])) {
2121 $specConf = $this->conf['specConfs.'][$dat['uid'] . '.'];
2122 $specConf['_pid'] = $dat['uid'];
2123 break;
2124 }
2125 }
2126 }
2127 return $specConf;
2128 }
2129
2130 /**
2131 * Returns the HTML code for language indication.
2132 *
2133 * @param array $row Result row
2134 * @return string HTML code for result row.
2135 */
2136 public function makeLanguageIndication($row)
2137 {
2138 // If search result is a TYPO3 page:
2139 if ((string)$row['item_type'] === '0') {
2140 // If TypoScript is used to render the flag:
2141 if (is_array($this->conf['flagRendering.'])) {
2142 $this->cObj->setCurrentVal($row['sys_language_uid']);
2143 return $this->cObj->cObjGetSingle($this->conf['flagRendering'], $this->conf['flagRendering.']);
2144 }
2145 }
2146 return '&nbsp;';
2147 }
2148
2149 /**
2150 * Returns the HTML code for the locking symbol.
2151 * NOTICE: Requires a call to ->getPathFromPageId() first in order to work (done in ->makeInfo() by calling that first)
2152 *
2153 * @param int $id Page id for which to find answer
2154 * @return string <img> tag if access is limited.
2155 */
2156 public function makeAccessIndication($id)
2157 {
2158 if (is_array($this->fe_groups_required[$id]) && !empty($this->fe_groups_required[$id])) {
2159 return '<img src="' . \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath('indexed_search') . 'Resources/Public/Icons/FileTypes/locked.gif" width="12" height="15" vspace="5" title="' . sprintf($this->pi_getLL('res_memberGroups', '', true), implode(',', array_unique($this->fe_groups_required[$id]))) . '" alt="" />';
2160 }
2161
2162 return '';
2163 }
2164
2165 /**
2166 * Links the $str to page $id
2167 *
2168 * @param int $id Page id
2169 * @param string $str Title String to link
2170 * @param array $row Result row
2171 * @param array $markUpSwParams Additional parameters for marking up seach words
2172 * @return string <A> tag wrapped title string.
2173 */
2174 public function linkPage($id, $str, $row = array(), $markUpSwParams = array())
2175 {
2176 // Parameters for link:
2177 $urlParameters = (array)unserialize($row['cHashParams']);
2178 // Add &type and &MP variable:
2179 if ($row['data_page_type']) {
2180 $urlParameters['type'] = $row['data_page_type'];
2181 }
2182 if ($row['data_page_mp']) {
2183 $urlParameters['MP'] = $row['data_page_mp'];
2184 }
2185 if ($row['sys_language_uid']) {
2186 $urlParameters['L'] = $row['sys_language_uid'];
2187 }
2188 // markup-GET vars:
2189 $urlParameters = array_merge($urlParameters, $markUpSwParams);
2190 // This will make sure that the path is retrieved if it hasn't been already. Used only for the sake of the domain_record thing...
2191 if (!is_array($this->domain_records[$id])) {
2192 $this->getPathFromPageId($id);
2193 }
2194 // If external domain, then link to that:
2195 if (!empty($this->domain_records[$id])) {
2196 reset($this->domain_records[$id]);
2197 $firstDom = current($this->domain_records[$id]);
2198 $scheme = GeneralUtility::getIndpEnv('TYPO3_SSL') ? 'https://' : 'http://';
2199 $addParams = '';
2200 if (is_array($urlParameters) && !empty($urlParameters)) {
2201 $addParams .= GeneralUtility::implodeArrayForUrl('', $urlParameters);
2202 }
2203 if ($target = $this->conf['search.']['detect_sys_domain_records.']['target']) {
2204 $target = ' target="' . $target . '"';
2205 }
2206 return '<a href="' . htmlspecialchars(($scheme . $firstDom . '/index.php?id=' . $id . $addParams)) . '"' . $target . '>' . htmlspecialchars($str) . '</a>';
2207 } else {
2208 return $this->pi_linkToPage($str, $id, $this->conf['result_link_target'], $urlParameters);
2209 }
2210 }
2211
2212 /**
2213 * Returns the path to the page $id
2214 *
2215 * @param int $id Page ID
2216 * @param string $pathMP MP variable content.
2217 * @return string Root line for result.
2218 */
2219 public function getRootLine($id, $pathMP = '')
2220 {
2221 $identStr = $id . '|' . $pathMP;
2222 if (!isset($this->cache_path[$identStr])) {
2223 $this->cache_rl[$identStr] = $this->frontendController->sys_page->getRootLine($id, $pathMP);
2224 }
2225 return $this->cache_rl[$identStr];
2226 }
2227
2228 /**
2229 * Gets the first sys_domain record for the page, $id
2230 *
2231 * @param int $id Page id
2232 * @return string Domain name
2233 */
2234 public function getFirstSysDomainRecordForPage($id)
2235 {
2236 $res = $this->databaseConnection->exec_SELECTquery('domainName', 'sys_domain', 'pid=' . (int)$id . $this->cObj->enableFields('sys_domain'), '', 'sorting');
2237 $row = $this->databaseConnection->sql_fetch_assoc($res);
2238 return rtrim($row['domainName'], '/');
2239 }
2240
2241 /**
2242 * Returns the path to the page $id
2243 *
2244 * @param int $id Page ID
2245 * @param string $pathMP MP variable content
2246 * @return string Path (HTML-escaped)
2247 */
2248 public function getPathFromPageId($id, $pathMP = '')
2249 {
2250 $identStr = $id . '|' . $pathMP;
2251 if (!isset($this->cache_path[$identStr])) {
2252 $this->fe_groups_required[$id] = array();
2253 $this->domain_records[$id] = array();
2254 $rl = $this->getRootLine($id, $pathMP);
2255 $path = '';
2256 $pageCount = count($rl);
2257 if (is_array($rl) && !empty($rl)) {
2258 $index = 0;
2259 $breadcrumbWrap = isset($this->conf['breadcrumbWrap']) ? $this->conf['breadcrumbWrap'] : '/';
2260 $breadcrumbWraps = $GLOBALS['TSFE']->tmpl->splitConfArray(array('wrap' => $breadcrumbWrap), $pageCount);
2261 foreach ($rl as $k => $v) {
2262 // Check fe_user
2263 if ($v['fe_group'] && ($v['uid'] == $id || $v['extendToSubpages'])) {
2264 $this->fe_groups_required[$id][] = $v['fe_group'];
2265 }
2266 // Check sys_domain.
2267 if ($this->conf['search.']['detect_sys_domain_records']) {
2268 $sysDName = $this->getFirstSysDomainRecordForPage($v['uid']);
2269 if ($sysDName) {
2270 $this->domain_records[$id][] = $sysDName;
2271 // Set path accordingly:
2272 $path = $sysDName . $path;
2273 break;
2274 }
2275 }
2276 // Stop, if we find that the current id is the current root page.
2277 if ($v['uid'] == $this->frontendController->config['rootLine'][0]['uid']) {
2278 array_pop($breadcrumbWraps);
2279 break;
2280 }
2281 $path = $this->cObj->wrap(htmlspecialchars($v['title']), array_pop($breadcrumbWraps)['wrap']) . $path;
2282 }
2283 }
2284 $this->cache_path[$identStr] = $path;
2285 if (is_array($this->conf['path_stdWrap.'])) {
2286 $this->cache_path[$identStr] = $this->cObj->stdWrap($this->cache_path[$identStr], $this->conf['path_stdWrap.']);
2287 }
2288 }
2289 return $this->cache_path[$identStr];
2290 }
2291
2292 /**
2293 * Return the menu of pages used for the selector.
2294 *
2295 * @param int $id Page ID for which to return menu
2296 * @return array Menu items (for making the section selector box)
2297 */
2298 public function getMenu($id)
2299 {
2300 if ($this->conf['show.']['LxALLtypes']) {
2301 $output = array();
2302 $res = $this->databaseConnection->exec_SELECTquery('title,uid', 'pages', 'pid=' . (int)$id . $this->cObj->enableFields('pages'), '', 'sorting');
2303 while ($row = $this->databaseConnection->sql_fetch_assoc($res)) {
2304 $output[$row['uid']] = $this->frontendController->sys_page->getPageOverlay($row);
2305 }
2306 $this->databaseConnection->sql_free_result($res);
2307 return $output;
2308 } else {
2309 return $this->frontendController->sys_page->getMenu($id);
2310 }
2311 }
2312
2313 /**
2314 * Returns if an item type is a multipage item type
2315 *
2316 * @param string $item_type Item type
2317 * @return bool TRUE if multipage capable
2318 */
2319 public function multiplePagesType($item_type)
2320 {
2321 return is_object($this->external_parsers[$item_type]) && $this->external_parsers[$item_type]->isMultiplePageExtension($item_type);
2322 }
2323
2324 /**
2325 * Converts the input string from utf-8 to the backend charset.
2326 *
2327 * @param string String to convert (utf-8)
2328 * @return string Converted string (backend charset if different from utf-8)
2329 */
2330 public function utf8_to_currentCharset($str)
2331 {
2332 return $this->frontendController->csConv($str, 'utf-8');
2333 }
2334
2335 /**
2336 * Returns an object reference to the hook object if any
2337 *
2338 * @param string $functionName Name of the function you want to call / hook key
2339 * @return object|NULL Hook object, if any. Otherwise NULL.
2340 */
2341 public function hookRequest($functionName)
2342 {
2343 // Hook: menuConfig_preProcessModMenu
2344 if ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['pi1_hooks'][$functionName]) {
2345 $hookObj = GeneralUtility::getUserObj($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['pi1_hooks'][$functionName]);
2346 if (method_exists($hookObj, $functionName)) {
2347 $hookObj->pObj = $this;
2348 return $hookObj;
2349 }
2350 }
2351 }
2352
2353 /**
2354 * Obtains the URL of the search target page
2355 *
2356 * @return string
2357 */
2358 protected function getSearchFormActionURL()
2359 {
2360 $targetUrlPid = $this->getSearchFormActionPidFromTS();
2361 if ($targetUrlPid == 0) {
2362 $targetUrlPid = $this->frontendController->id;
2363 }
2364 return $this->pi_getPageLink($targetUrlPid, $this->frontendController->sPre);
2365 }
2366
2367 /**
2368 * Obtains search form target pid from the TypoScript configuration
2369 *
2370 * @return int
2371 */
2372 protected function getSearchFormActionPidFromTS()
2373 {
2374 $result = 0;
2375 if (isset($this->conf['search.']['targetPid']) || isset($this->conf['search.']['targetPid.'])) {
2376 if (is_array($this->conf['search.']['targetPid.'])) {
2377 $result = $this->cObj->stdWrap($this->conf['search.']['targetPid'], $this->conf['search.']['targetPid.']);
2378 } else {
2379 $result = $this->conf['search.']['targetPid'];
2380 }
2381 $result = (int)$result;
2382 }
2383 return $result;
2384 }
2385
2386 /**
2387 * Formats date as 'created' date
2388 *
2389 * @param int $date
2390 * @return string
2391 */
2392 protected function formatCreatedDate($date)
2393 {
2394 $defaultFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'];
2395 return $this->formatDate($date, 'created', $defaultFormat);
2396 }
2397
2398 /**
2399 * Formats date as 'modified' date
2400 *
2401 * @param int $date
2402 * @return string
2403 */
2404 protected function formatModifiedDate($date)
2405 {
2406 $defaultFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] . ' ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'];
2407 return $this->formatDate($date, 'modified', $defaultFormat);
2408 }
2409
2410 /**
2411 * Formats the date using format string from TypoScript or default format
2412 * if TypoScript format is not set
2413 *
2414 * @param int $date
2415 * @param string $tsKey
2416 * @param string $defaultFormat
2417 * @return string
2418 */
2419 protected function formatDate($date, $tsKey, $defaultFormat)
2420 {
2421 $strftimeFormat = $this->conf['dateFormat.'][$tsKey];
2422 if ($strftimeFormat) {
2423 $result = strftime($strftimeFormat, $date);
2424 } else {
2425 $result = date($defaultFormat, $date);
2426 }
2427 return $result;
2428 }
2429
2430 /**
2431 * Search type
2432 * e.g. sentence (20), any part of the word (1)
2433 *
2434 * @return int
2435 */
2436 public function getSearchType()
2437 {
2438 return (int)$this->piVars['type'];
2439 }
2440
2441 /**
2442 * A list of integer which should be root-pages to search from
2443 *
2444 * @return int[]
2445 */
2446 public function getSearchRootPageIdList()
2447 {
2448 return \TYPO3\CMS\Core\Utility\GeneralUtility::intExplode(',', $this->wholeSiteIdList);
2449 }
2450
2451 /**
2452 * Getter for join_pages flag
2453 * enabled through $this->conf['search.']['skipExtendToSubpagesChecking']
2454 *
2455 * @return bool
2456 */
2457 public function getJoinPagesForQuery()
2458 {
2459 return (bool)$this->join_pages;
2460 }
2461
2462 /**
2463 * Load settings and apply stdWrap to them
2464 */
2465 protected function loadSettings()
2466 {
2467 if (!is_array($this->conf['results.'])) {
2468 $this->conf['results.'] = array();
2469 }
2470 $this->conf['results.']['summaryCropAfter'] = MathUtility::forceIntegerInRange(
2471 $this->cObj->stdWrap($this->conf['results.']['summaryCropAfter'], $this->conf['results.']['summaryCropAfter.']),
2472 10, 5000, 180
2473 );
2474 $this->conf['results.']['summaryCropSignifier'] = $this->cObj->stdWrap($this->conf['results.']['summaryCropSignifier'], $this->conf['results.']['summaryCropSignifier.']);
2475 $this->conf['results.']['titleCropAfter'] = MathUtility::forceIntegerInRange(
2476 $this->cObj->stdWrap($this->conf['results.']['titleCropAfter'], $this->conf['results.']['titleCropAfter.']),
2477 10, 500, 50
2478 );
2479 $this->conf['results.']['titleCropSignifier'] = $this->cObj->stdWrap($this->conf['results.']['titleCropSignifier'], $this->conf['results.']['titleCropSignifier.']);
2480 $this->conf['results.']['markupSW_summaryMax'] = MathUtility::forceIntegerInRange(
2481 $this->cObj->stdWrap($this->conf['results.']['markupSW_summaryMax'], $this->conf['results.']['markupSW_summaryMax.']),
2482 10, 5000, 300
2483 );
2484 $this->conf['results.']['markupSW_postPreLgd'] = MathUtility::forceIntegerInRange(
2485 $this->cObj->stdWrap($this->conf['results.']['markupSW_postPreLgd'], $this->conf['results.']['markupSW_postPreLgd.']),
2486 1, 500, 60
2487 );
2488 $this->conf['results.']['markupSW_postPreLgd_offset'] = MathUtility::forceIntegerInRange(
2489 $this->cObj->stdWrap($this->conf['results.']['markupSW_postPreLgd_offset'], $this->conf['results.']['markupSW_postPreLgd_offset.']),
2490 1, 50, 5
2491 );
2492 $this->conf['results.']['markupSW_divider'] = $this->cObj->stdWrap($this->conf['results.']['markupSW_divider'], $this->conf['results.']['markupSW_divider.']);
2493 $this->conf['results.']['hrefInSummaryCropAfter'] = MathUtility::forceIntegerInRange(
2494 $this->cObj->stdWrap($this->conf['results.']['hrefInSummaryCropAfter'], $this->conf['results.']['hrefInSummaryCropAfter.']),
2495 10, 400, 60
2496 );
2497 $this->conf['results.']['hrefInSummaryCropSignifier'] = $this->cObj->stdWrap($this->conf['results.']['hrefInSummaryCropSignifier'], $this->conf['results.']['hrefInSummaryCropSignifier.']);
2498 }
2499 }