class.tslib_search.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 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!
***************************************************************/
class tslib_search {
   var $tables = Array ();

   var $group_by = 'PRIMARY_KEY';                     // Alternatively 'PRIMARY_KEY'; sorting by primary key
   var $default_operator = 'AND';                     // Standard SQL-operator between words
   var $operator_translate_table_caseinsensitive = '1';
   var $operator_translate_table = Array (               // case-sensitiv. Defineres the words, which will be operators between words
      Array ('+' , 'AND'),
      Array ('-' , 'AND NOT'),
         // english
      Array ('AND' , 'AND'),
      Array ('OR' , 'OR'),
      Array ('NOT' , 'AND NOT'),
         // danish
      Array ('OG' , 'AND'),
      Array ('ELLER' , 'OR'),
      Array ('UDEN' , 'AND NOT')
   );

   // Internal
   var $sword_array;    // Contains the search-words and operators
   var $queryParts;     // Contains the query parts after processing.

   var $other_where_clauses;  // Addition to the whereclause. This could be used to limit search to a certain page or alike in the system.
   var $fTable;      // This is set with the foreign table that 'pages' are connected to.

   var $res_offset = 0; // How many rows to offset from the beginning
   var $res_shows = 20; // How many results to show (0 = no limit)
   var $res_count;         // Intern: How many results, there was last time (with the exact same searchstring.

   var $pageIdList='';     // List of pageIds.

   var $listOfSearchFields ='';

   function register_tables_and_columns($requestedCols,$allowedCols) {
      $rCols=$this->explodeCols($requestedCols);
      $aCols=$this->explodeCols($allowedCols);

      foreach ($rCols as $k => $v)  {
         $rCols[$k]=trim($v);
         if (in_array($rCols[$k], $aCols))   {
            $parts = explode('.',$rCols[$k]);
            $this->tables[$parts[0]]['searchfields'][] = $parts[1];
         }
      }
      $this->tables['pages']['primary_key'] = 'uid';
      $this->tables['pages']['resultfields'][] = 'uid';
      unset($this->tables['pages']['fkey']);

      foreach ($aCols as $k => $v)  {
         $aCols[$k]=trim($v);
         $parts = explode('.',$aCols[$k]);
         $this->tables[$parts[0]]['resultfields'][] = $parts[1].' AS '.str_replace('.','_',$aCols[$k]);
         $this->tables[$parts[0]]['fkey']='pid';
      }

      $this->fTable='';
      foreach ($this->tables as $t => $v) {
         if ($t!='pages')  {
            if (!$this->fTable)  {
               $this->fTable = $t;
            } else {
               unset($this->tables[$t]);
            }
         }
      }
   }

   function explodeCols($in)  {
      $theArray = explode(':',$in);
      $out = Array();
      while(list(,$val)=each($theArray))  {
         $val=trim($val);
         $parts = explode('.',$val);
         if ($parts[0] && $parts[1])   {
            $subparts = explode('-',$parts[1]);
            while(list(,$piece)=each($subparts))   {
               $piece=trim($piece);
               if ($piece)    $out[]=$parts[0].'.'.$piece;
            }
         }
      }
      return $out;
   }

   function register_and_explode_search_string($sword)   {
      $sword = trim($sword);
      if ($sword) {
         $components = $this->split($sword);
         $s_sword = '';  // the searchword is stored here during the loop
         if (is_array($components)) {
            $i=0;
            $lastoper = '';
            reset($components);
            while (list($key,$val) = each ($components)) {
               $operator=$this->get_operator($val);
               if ($operator) {
                  $lastoper = $operator;
               } elseif (strlen($val)>1) {      // A searchword MUST be at least two characters long!
                  $this->sword_array[$i]['sword'] = $val;
                  $this->sword_array[$i]['oper'] = ($lastoper) ? $lastoper : $this->default_operator;
                  $lastoper = '';
                  $i++;
               }
            }
         }
      }
   }

   function split($origSword, $specchars='+-', $delchars='+.,-')  {
      $sword = $origSword;
      $specs = '['.$this->quotemeta($specchars).']';
      $delchars = '['.$this->quotemeta($delchars).']';

         // As long as $sword is true (that means $sword MUST be reduced little by little until its empty inside the loop!)
      while ($sword) {
         if (ereg('^"',$sword))  {     // There was a double-quote and we will then look for the ending quote.
            $sword = ereg_replace('^"','',$sword);    // Removes first double-quote
            ereg('^[^"]*',$sword,$reg);  // Removes everything till next double-quote
            $value[] = $reg[0];  // reg[0] is the value, should not be trimmed
            $sword = ereg_replace('^'.$this->quotemeta($reg[0]),'',$sword);
            $sword = trim(ereg_replace('^"','',$sword));    // Removes last double-quote
         } elseif (ereg('^'.$specs,$sword,$reg)) {
            $value[] = $reg[0];
            $sword = trim(ereg_replace('^'.$specs,'',$sword));    // Removes = sign
         } elseif (ereg('[\+\-]',$sword)) {  // Check if $sword contains + or -
               // + and - shall only be interpreted as $specchars when there's whitespace before it
               // otherwise it's included in the searchword (e.g. "know-how")
            $a_sword = explode(' ',$sword);  // explode $sword to single words
            $word = array_shift($a_sword);   // get first word
            $word = ereg_replace($delchars.'$','',$word);      // Delete $delchars at end of string
            $value[] = $word; // add searchword to values
            $sword = implode(' ',$a_sword);  // re-build $sword
         } else {
               // There are no double-quotes around the value. Looking for next (space) or special char.
            ereg('^[^ '.$this->quotemeta($specchars).']*',$sword,$reg);
            $word = ereg_replace($delchars.'$','',trim($reg[0]));    // Delete $delchars at end of string
            $value[] = $word;
            $sword = trim(ereg_replace('^'.$this->quotemeta($reg[0]),'',$sword));
         }
      }

      return $value;
   }

   function quotemeta($str)   {
      $str = str_replace('|','\|',quotemeta($str));
      #$str = str_replace('-','\-',$str);    // Breaks "-" which should NOT have a slash before it inside of [ ] in a regex.
      return $str;
   }

   function build_search_query($endClause) {

      if (is_array($this->tables))  {
         $tables = $this->tables;
         $primary_table = '';

            // Primary key table is found.
         foreach($tables as $key => $val) {
            if ($tables[$key]['primary_key'])   {$primary_table = $key;}
         }

         if ($primary_table) {

               // Initialize query parts:
            $this->queryParts = array(
               'SELECT' => '',
               'FROM' => '',
               'WHERE' => '',
               'GROUPBY' => '',
               'ORDERBY' => '',
               'LIMIT' => '',
            );

               // Find tables / field names to select:
            $fieldArray = array();
            $tableArray = array();
            foreach($tables as $key => $val) {
               $tableArray[] = $key;
               $resultfields = $tables[$key]['resultfields'];
               if (is_array($resultfields))  {
                  foreach($resultfields as $key2 => $val2)  {
                     $fieldArray[] = $key.'.'.$val2;
                  }
               }
            }
            $this->queryParts['SELECT'] = implode(',',$fieldArray);
            $this->queryParts['FROM'] = implode(',',$tableArray);

               // Set join WHERE parts:
            $whereArray = array();

            $primary_table_and_key = $primary_table.'.'.$tables[$primary_table]['primary_key'];
            $primKeys = Array();
            foreach($tables as $key => $val) {
               $fkey = $tables[$key]['fkey'];
               if ($fkey)  {
                   $primKeys[] = $key.'.'.$fkey.'='.$primary_table_and_key;
               }
            }
            if (count($primKeys))   {
               $whereArray[] = '('.implode(' OR ',$primKeys).')';
            }

               // Additional where clause:
            if (trim($endClause))   {
               $whereArray[] = trim($endClause);
            }

               // Add search word where clause:
            $query_part = $this->build_search_query_for_searchwords();
            if (!$query_part) {
               $query_part = '(0!=0)';
            }
            $whereArray[] = '('.$query_part.')';

               // Implode where clauses:
            $this->queryParts['WHERE'] = implode(' AND ',$whereArray);

               // Group by settings:
            if ($this->group_by) {
               if ($this->group_by == 'PRIMARY_KEY')  {
                  $this->queryParts['GROUPBY'] = $primary_table_and_key;
               } else {
                  $this->queryParts['GROUPBY'] = $this->group_by;
               }
            }
         }
      }
   }

   function build_search_query_for_searchwords()   {

      if (is_array($this->sword_array))   {
         $main_query_part = array();

         foreach($this->sword_array as $key => $val)  {
            $s_sword = $this->sword_array[$key]['sword'];

               // Get subQueryPart
            $sub_query_part = array();

            $this->listOfSearchFields='';
            foreach($this->tables as $key3 => $val3)  {
               $searchfields = $this->tables[$key3]['searchfields'];
               if (is_array($searchfields))  {
                  foreach($searchfields as $key2 => $val2)  {
                     $this->listOfSearchFields.= $key3.'.'.$val2.',';
                     $sub_query_part[] = $key3.'.'.$val2.' LIKE "%'.$GLOBALS['TYPO3_DB']->quoteStr($s_sword, $key3).'%"';
                  }
               }
            }

            if (count($sub_query_part))   {
               $main_query_part[] = $this->sword_array[$key]['oper'];
               $main_query_part[] = '('.implode(' OR ',$sub_query_part).')';
            }
         }

         if (count($main_query_part))  {
            unset($main_query_part[0]);   // Remove first part anyways.
            return implode(' ',$main_query_part);
         }
      }
   }

   function get_operator($operator) {
      $operator = trim($operator);
      $op_array = $this->operator_translate_table;
      reset ($op_array);
      if ($this->operator_translate_table_caseinsensitive)  {
         $operator = strtoupper($operator);
      }
      while (list($key,$val) = each($op_array)) {
         $item = $op_array[$key][0];
         if ($this->operator_translate_table_caseinsensitive)  {
            $item = strtoupper($item);
         }
         if ($operator==$item)   {
            return $op_array[$key][1];
         }
      }
   }

   function count_query() {
      if (is_array($this->queryParts)) {
         $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($this->queryParts['SELECT'], $this->queryParts['FROM'], $this->queryParts['WHERE'], $this->queryParts['GROUPBY']);
          $this->res_count = $GLOBALS['TYPO3_DB']->sql_num_rows($res);
         return TRUE;
      }
   }

   function execute_query() {
      if (is_array($this->queryParts)) {
           $this->result = $GLOBALS['TYPO3_DB']->exec_SELECT_queryArray($this->queryParts);
         return TRUE;
      }
   }

   function get_searchwords() {
      $SWORD_PARAMS='';
      if (is_array($this->sword_array))   {
         foreach($this->sword_array as $key => $val)  {
            $SWORD_PARAMS.='&sword_list[]='.rawurlencode($val['sword']);
         }
      }
      return $SWORD_PARAMS;
   }

   function get_searchwordsArray()  {
      if (is_array($this->sword_array))   {
         foreach($this->sword_array as $key => $val)  {
            $swords[]=$val['sword'];
         }
      }
      return $swords;
   }
}




if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['tslib/class.tslib_search.php'])  {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['tslib/class.tslib_search.php']);
}

?>

---