typo3/sysext/indexed_search/pi/class.tx_indexedsearch.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2001-2005 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  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!
***************************************************************/
require_once(PATH_tslib.'class.tslib_pibase.php');
require_once(PATH_tslib.'class.tslib_search.php');
require_once(t3lib_extMgm::extPath('indexed_search').'class.indexer.php');


class tx_indexedsearch extends tslib_pibase {
    var $prefixId = 'tx_indexedsearch';        // Same as class name
    var $scriptRelPath = 'pi/class.tx_indexedsearch.php';    // Path to this script relative to the extension dir.
    var $extKey = 'indexed_search';    // The extension key.

        var $join_pages = 0;    // See document for info about this flag...
        var $defaultResultNumber = 20;

        var $operator_translate_table = Array (         // case-sensitive. Defines the words, which will be operators between words
                Array ('+' , 'AND'),
                Array ('|' , 'OR'),
                Array ('-' , 'AND NOT'),
                        // english
#               Array ('AND' , 'AND'),
#               Array ('OR' , 'OR'),
#               Array ('NOT' , 'AND NOT'),
        );

                // Internal variable
        var $wholeSiteIdList = 0;               // Root-page PIDs to search in (rl0 field where clause, see initialize() function)

                // Internals:
        var $sWArr = array();                   // Search Words and operators
        var $optValues = array();               // Selector box values for search configuration form
        var $firstRow = Array();                // Will hold the first row in result - used to calculate relative hit-ratings.

        var $cache_path = array();                      // Caching of page path
        var $cache_rl = array();                        // Caching of root line data
        var $fe_groups_required = array();              // Required fe_groups memberships for display of a result.
        var $domain_records = array();                  // Domain records (?)
        var $wSelClauses = array();                             // Select clauses for individual words
        var $resultSections = array();                  // Page tree sections for search result.
        var $external_parsers = array();                // External parser objects
        var $iconFileNameCache = array();               // Storage of icons....
        var $lexerObj;                                                  // Lexer object


        function main($content, $conf)    {

                        // Initialize:
        $this->conf = $conf;
        $this->pi_loadLL();
                $this->pi_setPiVarDefaults();

                        // Initialize the indexer-class - just to use a few function (for making hashes)
                $this->indexerObj = t3lib_div::makeInstance('tx_indexedsearch_indexer');

                        // Initialize:
                $this->initialize();

                        // Do search:
                        // If there were any search words entered...
                if (is_array($this->sWArr))     {
                        $content = $this->doSearch($this->sWArr);
                }

                        // Finally compile all the content, form, messages and results:
        $content=
                        $this->makeSearchForm($this->optValues).
                        $this->printRules().
            $content;

        return $this->pi_wrapInBaseClass($content);
    }

        function initialize()   {
                global $TYPO3_CONF_VARS;

                        // Initialize external document parsers for icon display and other soft operations
                if (is_array($TYPO3_CONF_VARS['EXTCONF']['indexed_search']['external_parsers']))        {
                        foreach($TYPO3_CONF_VARS['EXTCONF']['indexed_search']['external_parsers'] as $extension => $_objRef)    {
                                $this->external_parsers[$extension] = &t3lib_div::getUserObj($_objRef);

                                        // Init parser and if it returns false, unset its entry again:
                                if (!$this->external_parsers[$extension]->softInit($extension)) {
                                        unset($this->external_parsers[$extension]);
                                }
                        }
                }

                        // Init lexer (used to post-processing of search words)
                $lexerObjRef = $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['lexer'] ?
                                                $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['lexer'] :
                                                'EXT:indexed_search/class.lexer.php:&tx_indexedsearch_lexer';
                $this->lexerObj = &t3lib_div::getUserObj($lexerObjRef);

                        // If "_sections" is set, this value overrides any existing value.
                if ($this->piVars['_sections'])         $this->piVars['sections'] = $this->piVars['_sections'];

                        // Add previous search words to current
                if ($this->piVars['sword_prev_include'] && $this->piVars['sword_prev']) {
                        $this->piVars['sword'] = trim($this->piVars['sword_prev']).' '.$this->piVars['sword'];
                }

                $this->piVars['results'] = t3lib_div::intInRange($this->piVars['results'],1,100000,$this->defaultResultNumber);

                        // Selector-box values defined here:
                $this->optValues = Array(
                        'type' => Array(
                                '0' => $this->pi_getLL('opt_type_0'),
                                '1' => $this->pi_getLL('opt_type_1'),
                                '2' => $this->pi_getLL('opt_type_2'),
                                '3' => $this->pi_getLL('opt_type_3'),
                                '10' => $this->pi_getLL('opt_type_10'),
                                '20' => $this->pi_getLL('opt_type_20'),
                        ),
                        'defOp' => Array(
                                '0' => $this->pi_getLL('opt_defOp_0'),
                                '1' => $this->pi_getLL('opt_defOp_1'),
                        ),
                        'sections' => Array(
                                '0' => $this->pi_getLL('opt_sections_0'),
                                '-1' => $this->pi_getLL('opt_sections_-1'),
                                '-2' => $this->pi_getLL('opt_sections_-2'),
                                '-3' => $this->pi_getLL('opt_sections_-3'),
                                // Here values like "rl1_" and "rl2_" + a rootlevel 1/2 id can be added to perform searches in rootlevel 1+2 specifically. The id-values can even be commaseparated. Eg. "rl1_1,2" would search for stuff inside pages on menu-level 1 which has the uid's 1 and 2.
                        ),
                        'media' => Array(
                                '-1' => $this->pi_getLL('opt_media_-1'),
                                '0' => $this->pi_getLL('opt_media_0'),
                                '-2' => $this->pi_getLL('opt_media_-2'),
                        ),
                        'order' => Array(
                                'rank_flag' => $this->pi_getLL('opt_order_rank_flag'),
                                'rank_freq' => $this->pi_getLL('opt_order_rank_freq'),
                                'rank_first' => $this->pi_getLL('opt_order_rank_first'),
                                'rank_count' => $this->pi_getLL('opt_order_rank_count'),
                                'mtime' => $this->pi_getLL('opt_order_mtime'),
                                'title' => $this->pi_getLL('opt_order_title'),
                                'crdate' => $this->pi_getLL('opt_order_crdate'),
                        ),
                        'group' => Array (
                                'sections' => $this->pi_getLL('opt_group_sections'),
                                'flat' => $this->pi_getLL('opt_group_flat'),
                        ),
                        'lang' => Array (
                                -1 => $this->pi_getLL('opt_lang_-1'),
                                0 => $this->pi_getLL('opt_lang_0'),
                        ),
                        'desc' => Array (
                                '0' => $this->pi_getLL('opt_desc_0'),
                                '1' => $this->pi_getLL('opt_desc_1'),
                        ),
                        'results' => Array (
                                '10' => '10',
                                '20' => '20',
                                '50' => '50',
                                '100' => '100',
                        )
                );

                        // Add media to search in:
                foreach($this->external_parsers as $extension => $obj)  {
                        if ($name = $obj->searchTypeMediaTitle($extension))     {
                                $this->optValues['media'][$extension] = $this->pi_getLL('opt_sections_'.$extension,$name);
                        }
                }

                        // Add operators for various languages
                        // Converts the operators to UTF-8 and lowercase
                $this->operator_translate_table[] = Array($GLOBALS['TSFE']->csConvObj->conv_case('utf-8',$GLOBALS['TSFE']->csConvObj->utf8_encode($this->pi_getLL('local_operator_AND'), $GLOBALS['TSFE']->renderCharset),'toLower') , 'AND');
                $this->operator_translate_table[] = Array($GLOBALS['TSFE']->csConvObj->conv_case('utf-8',$GLOBALS['TSFE']->csConvObj->utf8_encode($this->pi_getLL('local_operator_OR'), $GLOBALS['TSFE']->renderCharset),'toLower') , 'OR');
                $this->operator_translate_table[] = Array($GLOBALS['TSFE']->csConvObj->conv_case('utf-8',$GLOBALS['TSFE']->csConvObj->utf8_encode($this->pi_getLL('local_operator_NOT'), $GLOBALS['TSFE']->renderCharset),'toLower') , 'AND NOT');

                        // This is the id of the site root. This value may be a commalist of integer (prepared for this)
                $this->wholeSiteIdList = intval($GLOBALS['TSFE']->config['rootLine'][0]['uid']);

                        // Creating levels for section menu:
                        // This selects the first and secondary menus for the "sections" selector - so we can search in sections and sub sections.
                if ($this->conf['show.']['L1sections']) {
                        $firstLevelMenu = $this->getMenu($this->wholeSiteIdList);
                        while(list($kk,$mR) = each($firstLevelMenu))    {
                                if ($mR['doktype']!=5)  {
                                        $this->optValues['sections']['rl1_'.$mR['uid']] = trim($this->pi_getLL('opt_RL1').' '.$mR['title']);
                                        if ($this->conf['show.']['L2sections']) {
                                                $secondLevelMenu = $this->getMenu($mR['uid']);
                                                while(list($kk2,$mR2) = each($secondLevelMenu)) {
                                                        if ($mR['doktype']!=5)  {
                                                                $this->optValues['sections']['rl2_'.$mR2['uid']] = trim($this->pi_getLL('opt_RL2').' '.$mR2['title']);
                                                        } else unset($secondLevelMenu[$kk2]);
                                                }
                                                $this->optValues['sections']['rl2_'.implode(',',array_keys($secondLevelMenu))] = $this->pi_getLL('opt_RL2ALL');
                                        }
                                } else unset($firstLevelMenu[$kk]);
                        }
                        $this->optValues['sections']['rl1_'.implode(',',array_keys($firstLevelMenu))] = $this->pi_getLL('opt_RL1ALL');
                }

                        // Setting the list of root PIDs 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.
                        // 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...
                if ($this->conf['search.']['rootPidList'])      {
                        $this->wholeSiteIdList = implode(',',t3lib_div::intExplode(',',$this->conf['search.']['rootPidList']));
                }

                        // Add search languages:
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_language', '1=1'.$this->cObj->enableFields('sys_language'));
                while($lR = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))        {
                        $this->optValues['lang'][$lR['uid']] = $lR['title'];
                }

                        // Calling hook for modification of initialized content
                if ($hookObj = &$this->hookRequest('initialize_postProc'))      {
                        $hookObj->initialize_postProc();
                }

                        // Default values set:
                        // Setting first values in optValues as default values IF there is not corresponding piVar value set already.
                foreach($this->optValues as $kk => $vv) {
                        if (!isset($this->piVars[$kk])) {
                                reset($vv);
                                $this->piVars[$kk] = key($vv);
                        }
                }

                        // Blind selectors:
                if (is_array($this->conf['blind.']))    {
                        foreach($this->conf['blind.'] as $kk => $vv)    {
                                if (is_array($vv))      {
                                        foreach($vv as $kkk => $vvv)    {
                                                if (!is_array($vvv) && $vvv && is_array($this->optValues[substr($kk,0,-1)]))    {
                                                        unset($this->optValues[substr($kk,0,-1)][$kkk]);
                                                }
                                        }
                                } elseif ($vv) {        // If value is not set, unset the option array.
                                        unset($this->optValues[$kk]);
                                }
                        }
                }

                        // This gets the search-words into the $sWArr:
                $this->sWArr = $this->getSearchWords($this->piVars['defOp']);
        }

        function getSearchWords($defOp) {
                        // 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!)
                $inSW = substr($this->piVars['sword'],0,200);

                        // Convert to UTF-8 + conv. entities (was also converted during indexing!)
                $inSW = $GLOBALS['TSFE']->csConvObj->utf8_encode($inSW, $GLOBALS['TSFE']->metaCharset);
                $inSW = $GLOBALS['TSFE']->csConvObj->entities_to_utf8($inSW,TRUE);

                if ($hookObj = &$this->hookRequest('getSearchWords'))   {
                        return $hookObj->getSearchWords_splitSWords($inSW, $defOp);
                } else {

                        if ($this->piVars['type']==20)  {
                                return array(array('sword'=>trim($inSW), 'oper'=>'AND'));
                        } else {
                                $search = t3lib_div::makeInstance('tslib_search');
                                $search->default_operator = $defOp==1 ? 'OR' : 'AND';
                                $search->operator_translate_table = $this->operator_translate_table;
                                $search->register_and_explode_search_string($inSW);

                                if (is_array($search->sword_array))     {
                                        return $this->procSearchWordsByLexer($search->sword_array);
                                }
                        }
                }
        }

        function procSearchWordsByLexer($SWArr) {

                        // Init output variable:
                $newSWArr = array();

                        // Traverse the search word array:
                foreach($SWArr as $wordDef)     {
                        if (!strstr($wordDef['sword'],' '))             {       // No space in word (otherwise it might be a sentense in quotes like "there is").
                                        // SPlit the search word by lexer:
                                $res = $this->lexerObj->split2Words($wordDef['sword']);

                                        // Traverse lexer result and add all words again:
                                foreach($res as $word)  {
                                        $newSWArr[] = array('sword'=>$word, 'oper'=>$wordDef['oper']);
                                }
                        } else {
                                $newSWArr[] = $wordDef;
                        }
                }

                        // Return result:
                return $newSWArr;
        }









        /*****************************
         *
         * Main functions
         *
         *****************************/

        function doSearch($sWArr)       {

                        // Get result rows:
                $pt1 = t3lib_div::milliseconds();
                if ($hookObj = &$this->hookRequest('getResultRows'))    {
                        $resData = $hookObj->getResultRows($sWArr);
                } else {
                        $resData = $this->getResultRows($sWArr);
                }

                        // Display search results:
                $pt2 = t3lib_div::milliseconds();
                if ($hookObj = &$this->hookRequest('getDisplayResults'))        {
                        $content = $hookObj->getDisplayResults($sWArr, $resData);
                } else {
                        $content = $this->getDisplayResults($sWArr, $resData);
                }

                $pt3 = t3lib_div::milliseconds();

                        // Write search statistics
                $this->writeSearchStat($sWArr,$resData['count'],array($pt1,$pt2,$pt3));

                        // Return content:
                return $content;
        }

        function getResultRows($sWArr)  {

                        // Getting SQL result pointer:
                        $GLOBALS['TT']->push('Searching result');
                $res = $this->getResultRows_SQLpointer($sWArr);
                        $GLOBALS['TT']->pull();

                        // Organize and process result:
                if ($res)       {

                                // Get some variables:
                        $count = $GLOBALS['TYPO3_DB']->sql_num_rows($res);
                        $pointer = t3lib_div::intInRange($this->piVars['pointer'],0,floor($count/$this->piVars['results']));

                                // Initialize result accumulation variables:
                        $c = 0;
                        $lines = Array();
                        $grouping_phashes = array();    // Used to filter out duplicates.
                        $grouping_chashes = array();    // Used to filter out duplicates BASED ON cHash.
                        $firstRow = Array();            // Will hold the first row in result - used to calculate relative hit-ratings.
                        $resultRows = Array();  // Will hold the results rows for display.

                                // Now, traverse result and put the rows to be displayed into an array
                                // Each row should be a the fields from 'ISEC.*, IP.*' combined + artificial fields "show_resume" (boolean) and "result_number" (counter)
                        while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))       {

                                        // Set first row:
                                if (!$c)        {
                                        $firstRow = $row;
                                }

                                $row['show_resume'] = $this->checkResume($row); // Tells whether we can link directly to a document or not (depends on possible right problems)
                                $phashGr = !in_array($row['phash_grouping'], $grouping_phashes);
                                $chashGr = !in_array($row['contentHash'].'.'.$row['data_page_id'], $grouping_chashes);
                                if ($phashGr && $chashGr)       {
                                        if ($row['show_resume'])        {       // Only if the resume may be shown are we going to filter out duplicates...
                                                if (!$this->multiplePagesType($row['item_type']))       {       // Only on documents which are not multiple pages documents
                                                        $grouping_phashes[] = $row['phash_grouping'];
                                                }
                                                $grouping_chashes[] = $row['contentHash'].'.'.$row['data_page_id'];
                                        }
                                        $c++;

                                                // All rows for display is put into resultRows[]
                                        if ($c > $pointer * $this->piVars['results'])   {
                                                $row['result_number'] = $c;
                                                $resultRows[] = $row;
                                                if ($c+1 > ($pointer+1)*$this->piVars['results'])       break;
                                        }
                                } else {
                                        $count--;       // For each time a phash_grouping document is found (which is thus not displayed) the search-result count is reduced, so that it matches the number of rows displayed.
                                }
                        }

                        return array(
                                                'resultRows' => $resultRows,
                                                'firstRow' => $firstRow,
                                                'count' => $count
                                        );
                } else {        // No results found:
                        return FALSE;
                }
        }

        function getResultRows_SQLpointer($sWArr)       {
                                // This SEARCHES for the searchwords in $sWArr AND returns a COMPLETE list of phash-integers of the matches.
                $list = $this->getPhashList($sWArr);

                        // Perform SQL Search / collection of result rows array:
                if ($list)      {
                                // Do the search:
                        return $this->execFinalQuery($list);
                } else {
                        return FALSE;
                }
        }

        function getDisplayResults($sWArr, $resData)    {
                        // Perform display of result rows array:
                if ($resData)   {
                        $GLOBALS['TT']->push('Display Final result');

                                // Set first selected row (for calculation of ranking later)
                        $this->firstRow = $resData['firstRow'];

                                // Result display here:
                        $rowcontent = '';
                        $rowcontent.= $this->compileResult($resData['resultRows']);

                                // Browsing box:
                        if ($resData['count'])  {
                                $this->internal['res_count'] = $resData['count'];
                                $this->internal['results_at_a_time'] = $this->piVars['results'];
                                $this->internal['maxPages'] = t3lib_div::intInRange($this->conf['search.']['page_links'],1,100,10);
                                $addString = ($resData['count']&&$this->piVars['group']=='sections' ? ' '.sprintf($this->pi_getLL(count($this->resultSections)>1?'inNsections':'inNsection'),count($this->resultSections)):'');
                                $browseBox1 = $this->pi_list_browseresults(1,$addString,$this->printResultSectionLinks());
                                $browseBox2 = $this->pi_list_browseresults(0);
                        }

                                // Browsing nav, bottom.
                        if ($resData['count'])  {
                                $content = $browseBox1.$rowcontent.$browseBox2;
                        } else {
                                $content = '<p'.$this->pi_classParam('noresults').'>'.$this->pi_getLL('noResults','',1).'</p>';
                        }

                        $GLOBALS['TT']->pull();
                } else {
                        $content.='<p'.$this->pi_classParam('noresults').'>'.$this->pi_getLL('noResults','',1).'</p>';
                }

                        // Print a message telling which words we searched for, and in which sections etc.
                $what = $this->tellUsWhatIsSeachedFor($sWArr).
                                (substr($this->piVars['sections'],0,2)=='rl'?' '.$this->pi_getLL('inSection','',1).' "'.substr($this->getPathFromPageId(substr($this->piVars['sections'],4)),1).'"':'');
                $what = '<div'.$this->pi_classParam('whatis').'><p>'.$what.'</p></div>';
                $content = $what.$content;

                        // Return content:
                return $content;
        }

        function compileResult($resultRows)     {
                $content = '';

                        // Transfer result rows to new variable, performing some mapping of sub-results etc.
                $newResultRows = array();
                foreach($resultRows as $row)    {
                        $id = md5($row['phash_grouping']);
                        if (is_array($newResultRows[$id]))      {
                                if (!$newResultRows[$id]['show_resume'] && $row['show_resume']) {       // swapping:

                                                // Remove old
                                        $subrows = $newResultRows[$id]['_sub'];
                                        unset($newResultRows[$id]['_sub']);
                                        $subrows[] = $newResultRows[$id];

                                                // Insert new:
                                        $newResultRows[$id] = $row;
                                        $newResultRows[$id]['_sub'] = $subrows;
                                } else $newResultRows[$id]['_sub'][] = $row;
                        } else {
                                $newResultRows[$id] = $row;
                        }
                }
                $resultRows = $newResultRows;


                switch($this->piVars['group'])  {
                        case 'sections':

                                $rl2flag = substr($this->piVars['sections'],0,2)=='rl';
                                $sections = array();
                                foreach($resultRows as $row)    {
                                        $id = $row['rl0'].'-'.$row['rl1'].($rl2flag?'-'.$row['rl2']:'');
                                        $sections[$id][] = $row;
                                }

                                $this->resultSections = array();

                                foreach($sections as $id => $resultRows)        {
                                        $rlParts = explode('-',$id);
                                        $theId = $rlParts[2] ? $rlParts[2] : ($rlParts[1]?$rlParts[1]:$rlParts[0]);
                                        $theRLid = $rlParts[2] ? 'rl2_'.$rlParts[2]:($rlParts[1]?'rl1_'.$rlParts[1]:'0');

                                        $sectionName = substr($this->getPathFromPageId($theId),1);
                                        if (!trim($sectionName))        {
                                                $sectionTitleLinked = $this->pi_getLL('unnamedSection','',1).':';
                                        } else {
                                                $onclick = 'document.'.$this->prefixId.'[\''.$this->prefixId.'[_sections]\'].value=\''.$theRLid.'\';document.'.$this->prefixId.'.submit();return false;';
                                                $sectionTitleLinked = '<a href="#" onclick="'.htmlspecialchars($onclick).'">'.htmlspecialchars($sectionName).':</a>';
                                        }
                                        $this->resultSections[$id] = array($sectionName,count($resultRows));

                                                // Add content header:
                                        $content.= $this->makeSectionHeader($id,$sectionTitleLinked,count($resultRows));

                                                // Render result rows:
                                        foreach($resultRows as $row)    {
                                                $content.= $this->printResultRow($row);
                                        }
                                }
                        break;
                        default:        // flat:
                                foreach($resultRows as $row)    {
                                        $content.= $this->printResultRow($row);
                                }
                        break;
                }
                return '<div'.$this->pi_classParam('res').'>'.$content.'</div>';
        }











        /***********************************
         *
         *      Searching functions (SQL)
         *
         ***********************************/

        function getPhashList($sWArr)   {

                        // Initialize variables:
                $c=0;
                $totalHashList = array();       // This array accumulates the phash-values
                $this->wSelClauses = array();

                        // Traverse searchwords; for each, select all phash integers and merge/diff/intersect them with previous word (based on operator)
                foreach($sWArr as $k => $v)     {
                        $GLOBALS['TT']->push('SearchWord '.$sWord);

                                // Making the query for a single search word based on the search-type
                        $sWord = $v['sword'];   // $GLOBALS['TSFE']->csConvObj->conv_case('utf-8',$v['sword'],'toLower');       // lower-case all of them...

                        $theType = (string)$this->piVars['type'];
                        if (strstr($sWord,' ')) $theType = 20;  // If there are spaces in the search-word, make a full text search instead.
                        $res = '';
                        $wSel='';

                                // Perform search for word:
                        switch($theType)        {
                                case '1':
                                        $wSel = "IW.baseword LIKE '%".$GLOBALS['TYPO3_DB']->quoteStr($sWord, 'index_words')."%'";
                                        $res = $this->execPHashListQuery($wSel,' AND is_stopword=0');
                                break;
                                case '2':
                                        $wSel = "IW.baseword LIKE '".$GLOBALS['TYPO3_DB']->quoteStr($sWord, 'index_words')."%'";
                                        $res = $this->execPHashListQuery($wSel,' AND is_stopword=0');
                                break;
                                case '3':
                                        $wSel = "IW.baseword LIKE '%".$GLOBALS['TYPO3_DB']->quoteStr($sWord, 'index_words')."'";
                                        $res = $this->execPHashListQuery($wSel,' AND is_stopword=0');
                                break;
                                case '10':
                                        $wSel = 'IW.metaphone = '.$this->indexerObj->metaphone($sWord);
                                        $res = $this->execPHashListQuery($wSel,' AND is_stopword=0');
                                break;
                                case '20':
                                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                                                'ISEC.phash',
                                                                'index_section ISEC, index_fulltext IFT',
                                                                'IFT.fulltextdata LIKE \'%'.$GLOBALS['TYPO3_DB']->quoteStr($sWord, 'index_fulltext').'%\' AND
                                                                        ISEC.phash = IFT.phash
                                                                        '.$this->sectionTableWhere(),
                                                                'ISEC.phash'
                                                        );
                                        $wSel = '1=1';

                                        if ($this->piVars['type']==20)  $this->piVars['order'] = 'mtime';               // 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 instaed. It is not required, but otherwise some hits may be left out.
                                break;
                                default:
                                        $wSel = 'IW.wid = '.$hash = $this->indexerObj->md5inthash($sWord);
                                        $res = $this->execPHashListQuery($wSel,' AND is_stopword=0');
                                break;
                        }

                                // Accumulate the word-select clauses
                        $this->wSelClauses[] = $wSel;

                                // If there was a query to do, then select all phash-integers which resulted from this.
                        if ($res)       {

                                        // Get phash list by searching for it:
                                $phashList = array();
                                while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))       {
                                        $phashList[] = $row['phash'];
                                }
                                $GLOBALS['TYPO3_DB']->sql_free_result($res);

                                        // Here the phash list are merged with the existing result based on whether we are dealing with OR, NOT or AND operations.
                                if ($c) {
                                        switch($v['oper'])      {
                                                case 'OR':
                                                        $totalHashList = array_unique(array_merge($phashList,$totalHashList));
                                                break;
                                                case 'AND NOT':
                                                        $totalHashList = array_diff($totalHashList,$phashList);
                                                break;
                                                default:        // AND...
                                                        $totalHashList = array_intersect($totalHashList,$phashList);
                                                break;
                                        }
                                } else {
                                        $totalHashList = $phashList;    // First search
                                }
                        }

                        $GLOBALS['TT']->pull();
                        $c++;
                }

                return implode(',',$totalHashList);
        }

        function execPHashListQuery($wordSel,$plusQ='') {
                return $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                        'IR.phash',
                                        'index_words IW,
                                                index_rel IR,
                                                index_section ISEC',
                                        $wordSel.'
                                                AND IW.wid=IR.wid
                                                AND ISEC.phash = IR.phash
                                                '.$this->sectionTableWhere().'
                                                '.$plusQ,
                                        'IR.phash'
                                );
        }

        function sectionTableWhere()    {
                $out = $this->wholeSiteIdList<0 ? '' : 'AND ISEC.rl0 IN ('.$this->wholeSiteIdList.')';

                $match = '';
                if (substr($this->piVars['sections'],0,4)=='rl1_')      {
                        $list = implode(',',t3lib_div::intExplode(',',substr($this->piVars['sections'],4)));
                        $out.= 'AND ISEC.rl1 IN ('.$list.')';
                        $match = TRUE;
                } elseif (substr($this->piVars['sections'],0,4)=='rl2_')        {
                        $list = implode(',',t3lib_div::intExplode(',',substr($this->piVars['sections'],4)));
                        $out.= 'AND ISEC.rl2 IN ('.$list.')';
                        $match = TRUE;
                } elseif (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['addRootLineFields']))      {
                                // Traversing user configured fields to see if any of those are used to limit search to a section:
                        foreach($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['addRootLineFields'] as $fieldName => $rootLineLevel)  {
                                if (substr($this->piVars['sections'],0,strlen($fieldName)+1)==$fieldName.'_')   {
                                        $list = implode(',',t3lib_div::intExplode(',',substr($this->piVars['sections'],strlen($fieldName)+1)));
                                        $out.= 'AND ISEC.'.$fieldName.' IN ('.$list.')';
                                        $match = TRUE;
                                        break;
                                }
                        }
                }

                        // If no match above, test the static types:
                if (!$match)    {
                        switch((string)$this->piVars['sections'])       {
                                case '-1':              // '-1' => 'Only this page',
                                        $out.= ' AND ISEC.page_id='.$GLOBALS['TSFE']->id;
                                break;
                                case '-2':              // '-2' => 'Top + level 1',
                                        $out.= ' AND ISEC.rl2=0';
                                break;
                                case '-3':              // '-3' => 'Level 2 and out',
                                        $out.= ' AND ISEC.rl2>0';
                                break;
                        }
                }

                return $out;
        }

        function mediaTypeWhere()       {

                switch((string)$this->piVars['media'])  {
                        case '0':               // '0' => 'Kun TYPO3 sider',
                                $out = 'AND IP.item_type='.$GLOBALS['TYPO3_DB']->fullQuoteStr('0', 'index_phash');;
                        break;
                        case '-2':              // All external documents
                                $out = 'AND IP.item_type!='.$GLOBALS['TYPO3_DB']->fullQuoteStr('0', 'index_phash');;
                        break;
                        case '-1':      // All content
                                $out='';
                        break;
                        default:
                                $out = 'AND IP.item_type='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->piVars['media'], 'index_phash');
                        break;
                }

                return $out;
        }

        function languageWhere()        {
                if ($this->piVars['lang']>=0)   {       // -1 is the same as ALL language.
                        return 'AND IP.sys_language_uid='.intval($this->piVars['lang']);
                }
        }

        function execFinalQuery($list)  {

                        // Setting up methods of filtering results based on page types, access, etc.
                $page_join = '';
                $page_where = '';

                        // Calling hook for alternative creation of page ID list
                if ($hookObj = &$this->hookRequest('execFinalQuery_idList'))    {
                        $page_where = $hookObj->execFinalQuery_idList($list);
                } elseif ($this->join_pages)    {       // Alternative to getting all page ids by ->getTreeList() where "excludeSubpages" is NOT respected.
                        $page_join = ',
                                pages';
                        $page_where = 'pages.uid = ISEC.page_id
                                '.$this->cObj->enableFields('pages').'
                                AND pages.no_search=0
                                AND pages.doktype<200
                        ';
                } elseif ($this->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 = t3lib_div::intExplode(',',$this->wholeSiteIdList);
                        $id_list=array();
                        while(list(,$rootId)=each($siteIdNumbers))      {
                                $id_list[] = $this->cObj->getTreeList($rootId,9999,0,0,'','').$rootId;
                        }
                        $page_where = 'ISEC.page_id IN ('.implode(',',$id_list).')';
                } else {        // Disable everything... (select all)
                        $page_where = ' 1=1 ';
                }


                        // 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.
                if (substr($this->piVars['order'],0,5)=='rank_')        {
                                /*
                                         OK there were some fancy calculations promoted by Graeme Merrall:

                                        "However, regarding relevance you probably want to look at something like
                                        Salton's formula which is a good easy way to measure relevance.
                                        Oracle Intermedia uses this and it's pretty simple:
                                        Score can be between 0 and 100, but the top-scoring document in the query
                                        will not necessarily have a score of 100 -- scoring is relative, not
                                        absolute. This means that scores are not comparable across indexes, or even
                                        across different queries on the same index. Score for each document is
                                        computed using the standard Salton formula:

                                            3f(1+log(N/n))

                                        Where f is the frequency of the search term in the document, N is the total
                                        number of rows in the table, and n is the number of rows which contain the
                                        search term. This is converted into an integer in the range 0 - 100.

                                        There's a good doc on it at
                                        http://ls6-www.informatik.uni-dortmund.de/bib/fulltext/ir/Pfeifer:97/
                                        although it may be a little complex for what you require so just pick the
                                        relevant parts out.
                                        "

                                        However I chose not to go with this for several reasons.
                                        I do not claim that my ways of calculating importance here is the best.
                                        ANY (better) suggestion for ranking calculation is accepted! (as long as they are shipped with tested code in exchange for this.)
                                */

                        switch($this->piVars['order'])  {
                                case 'rank_flag':       // This gives priority to word-position (max-value) so that words in title, keywords, description counts more than in content.
                                                                        // The ordering is refined with the frequency sum as well.
                                        $grsel = 'MAX(IR.flags) AS order_val1, SUM(IR.freq) AS order_val2';
                                        $orderBy = 'order_val1'.$this->isDescending().',order_val2'.$this->isDescending();
                                break;
                                case 'rank_first':      // Results in average position of search words on page. Must be inversely sorted (low numbers are closer to top)
                                        $grsel = 'AVG(IR.first) AS order_val';
                                        $orderBy = 'order_val'.$this->isDescending(1);
                                break;
                                case 'rank_count':      // Number of words found
                                        $grsel = 'SUM(IR.count) AS order_val';
                                        $orderBy = 'order_val'.$this->isDescending();
                                break;
                                default:        // Frequency sum. I'm not sure if this is the best way to do it (make a sum...). Or should it be the average?
                                        $grsel = 'SUM(IR.freq) AS order_val';
                                        $orderBy = 'order_val'.$this->isDescending();
                                break;
                        }

                                // So, words are imploded into an OR statement (no "sentence search" should be done here - may deselect results)
                        $wordSel='('.implode(' OR ',$this->wSelClauses).') AND ';

                        return $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                                'ISEC.*, IP.*, '
                                                .$grsel,
                                                'index_words IW,
                                                        index_rel IR,
                                                        index_section ISEC,
                                                        index_phash IP'.
                                                        $page_join,
                                                $wordSel.'
                                                        IP.phash IN ('.$list.') '.
                                                        $this->mediaTypeWhere().' '.
                                                        $this->languageWhere().'
                                                        AND IW.wid=IR.wid
                                                        AND ISEC.phash = IR.phash
                                                        AND IP.phash = IR.phash
                                                        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',
                                                $orderBy
                                        );
                } else {        // Otherwise, if sorting are done with the pages table or other fields, there is no need for joining with the rel/word tables:

                        $orderBy = '';
                        switch((string)$this->piVars['order'])  {
                                case 'title':
                                        $orderBy = 'IP.item_title'.$this->isDescending();
                                break;
                                case 'crdate':
                                        $orderBy = 'IP.item_crdate'.$this->isDescending();
                                break;
                                case 'mtime':
                                        $orderBy = 'IP.item_mtime'.$this->isDescending();
                                break;
                        }

                        return $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                                'ISEC.*, IP.*',
                                                'index_phash IP,index_section ISEC'.$page_join,
                                                'IP.phash IN ('.$list.') '.
                                                        $this->mediaTypeWhere().' '.
                                                        $this->languageWhere().'
                                                        AND IP.phash = ISEC.phash
                                                        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',
                                                $orderBy
                                        );
                }
        }

        function checkResume($row)      {

                        // If the record is indexed by an indexing configuration, just show it.
                        // At least this is needed for external URLs and files.
                        // For records we might need to extend this - for instance block display if record is access restricted.
                if ($row['freeIndexUid'])       {
                        return TRUE;
                }

                        // Evaluate regularly indexed pages based on item_type:
                if ($row['item_type'])  {       // External media:
                                // For external media we will check the access of the parent page on which the media was linked from.
                                // "phash_t3" is the phash of the parent TYPO3 page row which initiated the indexing of the documents in this section.
                                // So, selecting for the grlist records belonging to the parent phash-row where the current users gr_list exists will help us to know.
                                // 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.
                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('phash', 'index_grlist', 'phash='.intval($row['phash_t3']).' AND gr_list='.$GLOBALS['TYPO3_DB']->fullQuoteStr($GLOBALS['TSFE']->gr_list, 'index_grlist'));
                        if ($GLOBALS['TYPO3_DB']->sql_num_rows($res))   {
                                #debug("Look up for external media '".$row['data_filename']."': phash:".$row['phash_t3'].' YES - ('.$GLOBALS['TSFE']->gr_list.")!",1);
                                return TRUE;
                        } else {
                                #debug("Look up for external media '".$row['data_filename']."': phash:".$row['phash_t3'].' NO - ('.$GLOBALS['TSFE']->gr_list.")!",1);
                                return FALSE;
                        }
                } else {        // Ordinary TYPO3 pages:
                        if (strcmp($row['gr_list'],$GLOBALS['TSFE']->gr_list))  {
                                        // 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...
                                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('phash', 'index_grlist', 'phash='.intval($row['phash']).' AND gr_list='.$GLOBALS['TYPO3_DB']->fullQuoteStr($GLOBALS['TSFE']->gr_list, 'index_grlist'));
                                if ($GLOBALS['TYPO3_DB']->sql_num_rows($res))   {
                                        #debug('Checking on it ...'.$row['item_title'].'/'.$row['phash'].' - YES ('.$GLOBALS['TSFE']->gr_list.")",1);
                                        return TRUE;
                                } else {
                                        #debug('Checking on it ...'.$row['item_title'].'/'.$row['phash']." - NOPE",1);
                                        return FALSE;
                                }
                        } else {
                                        #debug('Resume can be shown, because the document was in fact indexed by this combination of groups!'.$GLOBALS['TSFE']->gr_list.' - '.$row['item_title'].'/'.$row['phash'],1);
                                return TRUE;
                        }
                }
        }

        function isDescending($inverse=FALSE)   {
                $desc = $this->piVars['desc'];
                if ($inverse)   $desc=!$desc;
                return !$desc ? ' DESC':'';
        }

        function writeSearchStat($sWArr,$count,$pt)     {
                $insertFields = array(
                        'searchstring' => $this->piVars['sword'],
                        'searchoptions' => serialize(array($this->piVars,$sWArr,$pt)),
                        'feuser_id' => intval($this->fe_user->user['uid']),                     // fe_user id, integer
                        'cookie' => $this->fe_user->id,                                         // cookie as set or retrieve. If people has cookies disabled this will vary all the time...
                        'IP' => t3lib_div::getIndpEnv('REMOTE_ADDR'),           // Remote IP address
                        'hits' => intval($count),                                                       // Number of hits on the search.
                        'tstamp' => $GLOBALS['EXEC_TIME']                                       // Time stamp
                );

                $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_stat_search', $insertFields);
                $newId = $GLOBALS['TYPO3_DB']->sql_insert_id();

                if ($newId)     {
                        foreach($sWArr as $val) {
                                $insertFields = array(
                                        'word' => $val['sword'],                // $GLOBALS['TSFE']->csConvObj->conv_case('utf-8', $val['sword'], 'toLower'),
                                        'index_stat_search_id' => $newId,
                                        'tstamp' => $GLOBALS['EXEC_TIME'],              // Time stamp
                                        'pageid' => $GLOBALS['TSFE']->id        //search page id for indexed search stats
                                );

                                $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_stat_word', $insertFields);
                        }
                }
        }













        /***********************************
         *
         * HTML output functions
         *
         ***********************************/

        function makeSearchForm($optValues)     {

                        // Accumulate table rows here:
                $rows = array();

                        // Adding search field and button:
                $rows[]='<tr>
                                <td nowrap="nowrap"><p>'.$this->pi_getLL('form_searchFor','',1).'&nbsp;</p></td>
                                <td><input type="text" name="'.$this->prefixId.'[sword]" value="'.htmlspecialchars($this->conf['show.']['clearSearchBox']?'':$this->piVars['sword']).'"'.$this->pi_classParam('searchbox-sword').' />&nbsp;&nbsp;<input type="submit" name="'.$this->prefixId.'[submit_button]" value="'.$this->pi_getLL('submit_button_label','',1).'"'.$this->pi_classParam('searchbox-button').' /></td>
                        </tr>';

                if ($this->conf['show.']['clearSearchBox'] && $this->conf['show.']['clearSearchBox.']['enableSubSearchCheckBox'])       {
                        $rows[]='<tr>
                                <td></td>
                                <td><input type="hidden" name="'.$this->prefixId.'[sword_prev]" value="'.htmlspecialchars($this->piVars['sword']).'" /><input type="checkbox" name="'.$this->prefixId.'[sword_prev_include]" value="1"'.($this->piVars['sword_prev_include']?' checked="checked"':'').' /> '.$this->pi_getLL('makerating_addToCurrentSearch').'</td>
                        </tr>';
                }

                        // Extended search options:
                if ($this->piVars['ext'])       {
                        if (is_array($optValues['type']) || is_array($optValues['defOp']))      $rows[]='<tr>
                                        <td nowrap="nowrap"><p>'.$this->pi_getLL('form_match','',1).'&nbsp;</p></td>
                                        <td>'.$this->renderSelectBox($this->prefixId.'[type]',$this->piVars['type'],$optValues['type']).
                                        $this->renderSelectBox($this->prefixId.'[defOp]',$this->piVars['defOp'],$optValues['defOp']).'</td>
                                </tr>';
                        if (is_array($optValues['media']) || is_array($optValues['lang']))      $rows[]='<tr>
                                        <td nowrap="nowrap"><p>'.$this->pi_getLL('form_searchIn','',1).'&nbsp;</p></td>
                                        <td>'.$this->renderSelectBox($this->prefixId.'[media]',$this->piVars['media'],$optValues['media']).
                                        $this->renderSelectBox($this->prefixId.'[lang]',$this->piVars['lang'],$optValues['lang']).'</td>
                                </tr>';
                        if (is_array($optValues['sections']))   $rows[]='<tr>
                                        <td nowrap="nowrap"><p>'.$this->pi_getLL('form_fromSection','',1).'&nbsp;</p></td>
                                        <td>'.$this->renderSelectBox($this->prefixId.'[sections]',$this->piVars['sections'],$optValues['sections']).'</td>
                                </tr>';
                        if (is_array($optValues['order']) || is_array($optValues['desc']) || is_array($optValues['results']))   $rows[]='<tr>
                                        <td nowrap="nowrap"><p>'.$this->pi_getLL('form_orderBy','',1).'&nbsp;</p></td>
                                        <td><p>'.$this->renderSelectBox($this->prefixId.'[order]',$this->piVars['order'],$optValues['order']).
                                                $this->renderSelectBox($this->prefixId.'[desc]',$this->piVars['desc'],$optValues['desc']).
                                                $this->renderSelectBox($this->prefixId.'[results]',$this->piVars['results'],$optValues['results']).'&nbsp;'.$this->pi_getLL('form_atATime','',1).'</p></td>
                                </tr>';
                        if (is_array($optValues['group']) || !$this->conf['blind.']['extResume'])       $rows[]='<tr>
                                        <td nowrap="nowrap"><p>'.$this->pi_getLL('form_style','',1).'&nbsp;</p></