|
<?php
|
|
namespace TYPO3\CMS\IndexedSearch\Hook;
|
|
|
|
/***************************************************************
|
|
* Copyright notice
|
|
*
|
|
* (c) 2011 Michael Stucki (michael@typo3.org)
|
|
* All rights reserved
|
|
*
|
|
* This script is part of the TYPO3 project. The TYPO3 project is
|
|
* free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* The GNU General Public License can be found at
|
|
* http://www.gnu.org/copyleft/gpl.html.
|
|
* A copy is found in the textfile GPL.txt and important notices to the license
|
|
* from the author is found in LICENSE.txt distributed with these scripts.
|
|
*
|
|
*
|
|
* This script is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* This copyright notice MUST APPEAR in all copies of the script!
|
|
***************************************************************/
|
|
/**
|
|
* Class that hooks into Indexed Search and replaces standard SQL queries with MySQL fulltext index queries.
|
|
*
|
|
* @author Michael Stucki <michael@typo3.org>
|
|
*/
|
|
class MysqlFulltextIndexHook {
|
|
|
|
/**
|
|
* @var \TYPO3\CMS\IndexedSearch\Controller\SearchFormController
|
|
*/
|
|
public $pObj;
|
|
|
|
const ANY_PART_OF_THE_WORD = '1';
|
|
const LAST_PART_OF_THE_WORD = '2';
|
|
const FIRST_PART_OF_THE_WORD = '3';
|
|
const SOUNDS_LIKE = '10';
|
|
const SENTENCE = '20';
|
|
/**
|
|
* Gets a SQL result pointer to traverse for the search records.
|
|
*
|
|
* @param array $searchWordsArray Search words
|
|
* @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
|
|
* @return resource|false
|
|
*/
|
|
public function getResultRows_SQLpointer($searchWordsArray, $freeIndexUid = -1) {
|
|
// Build the search string, detect which fulltext index to use, and decide whether boolean search is needed or not
|
|
$searchData = $this->getSearchString($searchWordsArray);
|
|
// Perform SQL Search / collection of result rows array:
|
|
$resource = FALSE;
|
|
if ($searchData) {
|
|
// Do the search:
|
|
$GLOBALS['TT']->push('execFinalQuery');
|
|
$resource = $this->execFinalQuery_fulltext($searchData, $freeIndexUid);
|
|
$GLOBALS['TT']->pull();
|
|
}
|
|
return $resource;
|
|
}
|
|
|
|
/**
|
|
* Returns a search string for use with MySQL FULLTEXT query
|
|
*
|
|
* @param array $searchWordArray Search word array
|
|
* @return string Search string
|
|
*/
|
|
public function getSearchString($searchWordArray) {
|
|
// Initialize variables:
|
|
$count = 0;
|
|
$searchBoolean = FALSE;
|
|
// Change this to TRUE to force BOOLEAN SEARCH MODE (useful if fulltext index is still empty)
|
|
$fulltextIndex = 'index_fulltext.fulltextdata';
|
|
$naturalSearchString = '';
|
|
// This holds the result if the search is natural (doesn't contain any boolean operators)
|
|
$booleanSearchString = '';
|
|
// This holds the result if the search is boolen (contains +/-/| operators)
|
|
$searchType = (string) $this->pObj->piVars['type'];
|
|
// Traverse searchwords and prefix them with corresponding operator
|
|
foreach ($searchWordArray as $searchWordData) {
|
|
// Making the query for a single search word based on the search-type
|
|
$searchWord = $searchWordData['sword'];
|
|
$wildcard = '';
|
|
if (strstr($searchWord, ' ')) {
|
|
$searchType = self::SENTENCE;
|
|
}
|
|
switch ($searchType) {
|
|
case self::ANY_PART_OF_THE_WORD:
|
|
|
|
case self::LAST_PART_OF_THE_WORD:
|
|
|
|
case self::FIRST_PART_OF_THE_WORD:
|
|
// First part of word
|
|
$wildcard = '*';
|
|
// Part-of-word search requires boolean mode!
|
|
$searchBoolean = TRUE;
|
|
break;
|
|
case self::SOUNDS_LIKE:
|
|
$indexerObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\IndexedSearch\\Indexer');
|
|
// Initialize the indexer-class
|
|
/** @var \TYPO3\CMS\IndexedSearch\Indexer $indexerObj */
|
|
$searchWord = $indexerObj->metaphone($searchWord, $indexerObj->storeMetaphoneInfoAsWords);
|
|
unset($indexerObj);
|
|
$fulltextIndex = 'index_fulltext.metaphonedata';
|
|
break;
|
|
case self::SENTENCE:
|
|
$searchBoolean = TRUE;
|
|
// Remove existing quotes and fix misplaced quotes.
|
|
$searchWord = trim(str_replace('"', ' ', $searchWord));
|
|
break;
|
|
}
|
|
// Perform search for word:
|
|
switch ($searchWordData['oper']) {
|
|
case 'AND NOT':
|
|
$booleanSearchString .= ' -' . $searchWord . $wildcard;
|
|
$searchBoolean = TRUE;
|
|
break;
|
|
case 'OR':
|
|
$booleanSearchString .= ' ' . $searchWord . $wildcard;
|
|
$searchBoolean = TRUE;
|
|
break;
|
|
default:
|
|
$booleanSearchString .= ' +' . $searchWord . $wildcard;
|
|
$naturalSearchString .= ' ' . $searchWord;
|
|
}
|
|
$count++;
|
|
}
|
|
if ($searchType == self::SENTENCE) {
|
|
$searchString = '"' . trim($naturalSearchString) . '"';
|
|
} elseif ($searchBoolean) {
|
|
$searchString = trim($booleanSearchString);
|
|
} else {
|
|
$searchString = trim($naturalSearchString);
|
|
}
|
|
return array(
|
|
'searchBoolean' => $searchBoolean,
|
|
'searchString' => $searchString,
|
|
'fulltextIndex' => $fulltextIndex
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Execute final query, based on phash integer list. The main point is sorting the result in the right order.
|
|
*
|
|
* @param array $searchData Array with search string, boolean indicator, and fulltext index reference
|
|
* @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
|
|
* @return resource Query result
|
|
*/
|
|
protected function execFinalQuery_fulltext($searchData, $freeIndexUid = -1) {
|
|
// Setting up methods of filtering results based on page types, access, etc.
|
|
$pageJoin = '';
|
|
// Indexing configuration clause:
|
|
$freeIndexUidClause = $this->pObj->freeIndexUidWhere($freeIndexUid);
|
|
// Calling hook for alternative creation of page ID list
|
|
if ($hookObj = &$this->pObj->hookRequest('execFinalQuery_idList')) {
|
|
$pageWhere = $hookObj->execFinalQuery_idList('');
|
|
} elseif ($this->pObj->join_pages) {
|
|
// Alternative to getting all page ids by ->getTreeList() where "excludeSubpages" is NOT respected.
|
|
$pageJoin = ',
|
|
pages';
|
|
$pageWhere = 'pages.uid = ISEC.page_id
|
|
' . $this->pObj->cObj->enableFields('pages') . '
|
|
AND pages.no_search=0
|
|
AND pages.doktype<200
|
|
';
|
|
} elseif ($this->pObj->wholeSiteIdList >= 0) {
|
|
// 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!
|
|
$siteIdNumbers = \TYPO3\CMS\Core\Utility\GeneralUtility::intExplode(',', $this->pObj->wholeSiteIdList);
|
|
$idList = array();
|
|
foreach ($siteIdNumbers as $rootId) {
|
|
$cObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
|
|
/** @var \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $cObj */
|
|
$idList[] = $cObj->getTreeList($rootId, 9999, 0, 0, '', '') . $rootId;
|
|
}
|
|
$pageWhere = ' ISEC.page_id IN (' . implode(',', $idList) . ')';
|
|
} else {
|
|
// Disable everything... (select all)
|
|
$pageWhere = ' 1=1';
|
|
}
|
|
$searchBoolean = '';
|
|
if ($searchData['searchBoolean']) {
|
|
$searchBoolean = ' IN BOOLEAN MODE';
|
|
}
|
|
$resource = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
|
|
'index_fulltext.*, ISEC.*, IP.*',
|
|
'index_fulltext, index_section ISEC, index_phash IP' . $pageJoin,
|
|
'MATCH (' . $searchData['fulltextIndex'] . ') AGAINST (' . $GLOBALS['TYPO3_DB']->fullQuoteStr($searchData['searchString'], 'index_fulltext') . $searchBoolean . ') ' .
|
|
$this->pObj->mediaTypeWhere() . ' ' .
|
|
$this->pObj->languageWhere() .
|
|
$freeIndexUidClause . '
|
|
AND index_fulltext.phash = IP.phash
|
|
AND ISEC.phash = IP.phash
|
|
AND ' . $pageWhere . $this->pObj->sectionTableWhere(),
|
|
'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'
|
|
);
|
|
return $resource;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
?>
|