lib/TextSearchQuery.php

   1 <?php rcs_id('$Id: TextSearchQuery.php,v 1.25 2007-01-03 21:22:34 rurban Exp $');
   2 /**
   3  * A text search query, converting queries to PCRE and SQL matchers.
   4  *
   5  * This represents an enhanced "Google-like" text search query:
   6  * <dl>
   7  * <dt> default: case-insensitive glob-style search with special operators OR AND NOT -
   8  * <dt> wiki -test
   9  *   <dd> Match strings containing the substring 'wiki', and NOT containing the
  10  *        substring 'test'.
  11  * <dt> wiki word or page
  12  *   <dd> Match strings containing the substring 'wiki' AND either the substring
  13  *        'word' OR the substring 'page'.
  14  * <dt> auto-detect regex hints, glob-style or regex-style, and converts them
  15  *      to PCRE and SQL matchers:
  16  *   <dd> "^word$" => EXACT(word)
  17  *   <dd> "^word"  => STARTS_WITH(word)
  18  *   <dd> "word*"  => STARTS_WITH(word)
  19  *   <dd> "*word"  => ENDS_WITH(word)
  20  *   <dd> "/^word.* /" => REGEX(^word.*)
  21  *   <dd> "word*word" => REGEX(word.*word)
  22  * </dl>
  23  *
  24  * The full query syntax, in order of precedence, is roughly:
  25  *
  26  * The unary 'NOT' or '-' operator (they are equivalent) negates the
  27  * following search clause.
  28  *
  29  * Search clauses may be joined with the (left-associative) binary operators
  30  * 'AND' and 'OR'. (case-insensitive)
  31  *
  32  * Two adjoining search clauses are joined with an implicit 'AND'.  This has
  33  * lower precedence than either an explicit 'AND' or 'OR', so "a b OR c"
  34  * parses as "a AND ( b OR c )", while "a AND b OR c" parses as
  35  * "( a AND b ) OR c" (due to the left-associativity of 'AND' and 'OR'.)
  36  *
  37  * Search clauses can be grouped with parentheses.
  38  *
  39  * Phrases (or other things which don't look like words) can be forced to
  40  * be interpreted as words by quoting them, either with single (') or double (")
  41  * quotes.  If you wan't to include the quote character within a quoted string,
  42  * double-up on the quote character: 'I''m hungry' is equivalent to
  43  * "I'm hungry".
  44  *
  45  * Force regex on "re:word" => posix-style, "/word/" => pcre-style
  46  * or use regex='glob' to use file wildcard-like matching. (not yet)
  47  *
  48  * The parsed tree is then converted to the needed PCRE (highlight,
  49  * simple backends) or SQL functions.
  50  *
  51  * @author: Jeff Dairiki
  52  * @author: Reini Urban (case and regex detection, enhanced sql callbacks)
  53  */
  54
  55 // regex-style: 'auto', 'none', 'glob', 'posix', 'pcre', 'sql'
  56 define ('TSQ_REGEX_NONE', 0);
  57 define ('TSQ_REGEX_AUTO', 1);
  58 define ('TSQ_REGEX_POSIX',2);
  59 define ('TSQ_REGEX_GLOB', 4);
  60 define ('TSQ_REGEX_PCRE', 8);
  61 define ('TSQ_REGEX_SQL', 16);
  62
  63 class TextSearchQuery {
  64     /**
  65      * Create a new query.
  66      *
  67      * @param $search_query string The query.  Syntax is as described above.
  68      * Note that an empty $search_query will match anything.
  69      * @param $case_exact boolean
  70      * @param $regex string one of 'auto', 'none', 'glob', 'posix', 'pcre', 'sql'
  71      * @see TextSearchQuery
  72      */
  73     function TextSearchQuery($search_query, $case_exact=false, $regex='auto') {
  74         if ($regex == 'none' or !$regex)
  75             $this->_regex = 0;
  76         elseif (defined("TSQ_REGEX_".strtoupper($regex)))
  77             $this->_regex = constant("TSQ_REGEX_".strtoupper($regex));
  78         else {
  79             trigger_error(fmt("Unsupported argument: %s=%s", 'regex', $regex));
  80             $this->_regex = 0;
  81         }
  82         $this->_case_exact = $case_exact;
  83         if ($regex != 'pcre') {
  84             $parser = new TextSearchQuery_Parser;
  85             $this->_tree = $parser->parse($search_query, $case_exact, $this->_regex);
  86             $this->_optimize(); // broken under certain circumstances: "word -word -word"
  87             if (defined("FULLTEXTSEARCH_STOPLIST"))
  88                 $this->_stoplist = FULLTEXTSEARCH_STOPLIST;
  89             else // default stoplist, localizable.
  90                 $this->_stoplist = _("(A|An|And|But|By|For|From|In|Is|It|Of|On|Or|The|To|With)");
  91         }
  92         else {
  93             $this->_tree = new TextSearchQuery_node_regex_pcre($search_query);
  94             if (preg_match("/^\/(.*)\/(\w*)$/", $search_query, $m)) {
  95                 $this->_tree->word = $m[1];
  96                 $this->_regex_modifier = $m[2]; // overrides case_exact
  97             }
  98         }
  99     }
 100
 101     function getType() { return 'text'; }
 102
 103     function _optimize() {
 104         $this->_tree = $this->_tree->optimize();
 105     }
 106
 107     /**
 108      * Get a PCRE regexp which matches the query.
 109      */
 110     function asRegexp() {
 111         if (!isset($this->_regexp)) {
 112             if (!isset($this->_regex_modifier))
 113                 $this->_regex_modifier = ($this->_case_exact?'':'i').'sS';
 114             if ($this->_regex)
 115                 $this->_regexp =  '/' . $this->_tree->regexp() . '/'.$this->_regex_modifier;
 116             else
 117                 $this->_regexp =  '/^' . $this->_tree->regexp() . '/'.$this->_regex_modifier;
 118         }
 119         return $this->_regexp;
 120     }
 121
 122     /**
 123      * Match query against string.
 124      *
 125      * @param $string string The string to match.
 126      * @return boolean True if the string matches the query.
 127      */
 128     function match($string) {
 129         return preg_match($this->asRegexp(), $string);
 130     }
 131
 132
 133     /**
 134      * Get a regular expression suitable for highlighting matched words.
 135      *
 136      * This returns a PCRE regular expression which matches any non-negated
 137      * word in the query.
 138      *
 139      * @return string The PCRE regexp.
 140      */
 141     function getHighlightRegexp() {
 142         if (!isset($this->_hilight_regexp)) {
 143             $words = array_unique($this->_tree->highlight_words());
 144             if (!$words) {
 145                 $this->_hilight_regexp = false;
 146             } else {
 147                 foreach ($words as $key => $word)
 148                     $words[$key] = preg_quote($word, '/');
 149                 $this->_hilight_regexp = '(?:' . join('|', $words) . ')';
 150             }
 151         }
 152         return $this->_hilight_regexp;
 153     }
 154
 155     /**
 156      * Make an SQL clause which matches the query. (deprecated, use makeSqlClause instead)
 157      *
 158      * @param $make_sql_clause_cb WikiCallback
 159      * A callback which takes a single word as an argument and
 160      * returns an SQL clause which will match exactly those records
 161      * containing the word.  The word passed to the callback will always
 162      * be in all lower case.
 163      *
 164      * TODO: support db-specific extensions, like MATCH AGAINST or REGEX
 165      *       mysql => 4.0.1 can also do Google: MATCH AGAINST IN BOOLEAN MODE
 166      *       How? WikiDB backend method?
 167      *
 168      * Old example usage:
 169      * <pre>
 170      *     function sql_title_match($word) {
 171      *         return sprintf("LOWER(title) like '%s'",
 172      *                        addslashes($word));
 173      *     }
 174      *
 175      *     ...
 176      *
 177      *     $query = new TextSearchQuery("wiki -page");
 178      *     $cb = new WikiFunctionCb('sql_title_match');
 179      *     $sql_clause = $query->makeSqlClause($cb);
 180      * </pre>
 181      * This will result in $sql_clause containing something like
 182      * "(LOWER(title) like 'wiki') AND NOT (LOWER(title) like 'page')".
 183      *
 184      * @return string The SQL clause.
 185      */
 186     function makeSqlClause($sql_clause_cb) {
 187         $this->_sql_clause_cb = $sql_clause_cb;
 188         return $this->_sql_clause($this->_tree);
 189     }
 190     // deprecated: use _sql_clause_obj now.
 191     function _sql_clause($node) {
 192         switch ($node->op) {
 193         case 'WORD':        // word => %word%
 194             return $this->_sql_clause_cb->call($node->word);
 195         case 'NOT':
 196             return "NOT (" . $this->_sql_clause($node->leaves[0]) . ")";
 197         case 'AND':
 198         case 'OR':
 199             $subclauses = array();
 200             foreach ($node->leaves as $leaf)
 201                 $subclauses[] = "(" . $this->_sql_clause($leaf) . ")";
 202             return join(" $node->op ", $subclauses);
 203         default:
 204             assert($node->op == 'VOID');
 205             return '1=1';
 206         }
 207     }
 208
 209     /** Get away with the callback and use a db-specific search class instead.
 210      * @see WikiDB_backend_PearDB_search
 211      */
 212     function makeSqlClauseObj(&$sql_search_cb) {
 213         $this->_sql_clause_cb = $sql_search_cb;
 214         return $this->_sql_clause_obj($this->_tree);
 215     }
 216
 217     function _sql_clause_obj($node) {
 218         switch ($node->op) {
 219         case 'NOT':
 220             return "NOT (" . $this->_sql_clause_cb->call($node->leaves[0]) . ")";
 221         case 'AND':
 222         case 'OR':
 223             $subclauses = array();
 224             foreach ($node->leaves as $leaf)
 225                 $subclauses[] = "(" . $this->_sql_clause_obj($leaf) . ")";
 226             return join(" $node->op ", $subclauses);
 227         case 'VOID':
 228             return '0=1';
 229         case 'ALL':
 230             return '1=1';
 231         default:
 232             return $this->_sql_clause_cb->call($node);
 233         }
 234     }
 235
 236     /*
 237      postgresql tsearch2 uses no WHERE operators, just & | and ! in the searchstring
 238      */
 239     function makeTsearch2SqlClauseObj(&$sql_search_cb) {
 240         $this->_sql_clause_cb = $sql_search_cb;
 241         return $this->_Tsearch2Sql_clause_obj($this->_tree);
 242     }
 243
 244     function _Tsearch2Sql_clause_obj($node) {
 245         // TODO: "such a phrase"
 246         switch ($node->op) {
 247         case 'NOT':
 248             return "!" . $node->leaves[0];
 249         case 'AND':
 250             $subclauses = array();
 251             foreach ($node->leaves as $leaf)
 252                 $subclauses[] = $this->_Tsearch2Sql_clause_obj($leaf);
 253             return join("&", $subclauses);
 254         case 'OR':
 255             $subclauses = array();
 256             foreach ($node->leaves as $leaf)
 257                 $subclauses[] = $this->_Tsearch2Sql_clause_obj($leaf);
 258             return join("|", $subclauses);
 259         case 'VOID':
 260             return '';
 261         case 'ALL':
 262             return '1';
 263         default:
 264             return $this->_sql_clause_cb->call($node);
 265         }
 266     }
 267
 268     function sql() { return '%'.$this->_sql_quote($this->word).'%'; }
 269
 270     /**
 271      * Get printable representation of the parse tree.
 272      *
 273      * This is for debugging only.
 274      * @return string Printable parse tree.
 275      */
 276     function asString() {
 277         return $this->_as_string($this->_tree);
 278     }
 279
 280     function _as_string($node, $indent = '') {
 281         switch ($node->op) {
 282         case 'WORD':
 283             return $indent . "WORD: $node->word";
 284         case 'VOID':
 285             return $indent . "VOID";
 286         case 'ALL':
 287             return $indent . "ALL";
 288         default:
 289             $lines = array($indent . $node->op . ":");
 290             $indent .= "  ";
 291             foreach ($node->leaves as $leaf)
 292                 $lines[] = $this->_as_string($leaf, $indent);
 293             return join("\n", $lines);
 294         }
 295     }
 296 }
 297
 298 /**
 299  * This is a TextSearchQuery which matches nothing.
 300  */
 301 class NullTextSearchQuery extends TextSearchQuery {
 302     /**
 303      * Create a new query.
 304      *
 305      * @see TextSearchQuery
 306      */
 307     function NullTextSearchQuery() {}
 308     function asRegexp()         { return '/^(?!a)a/x'; }
 309     function match($string)     { return false; }
 310     function getHighlightRegexp() { return ""; }
 311     function makeSqlClause($make_sql_clause_cb) { return "(1 = 0)"; }
 312     function asString() { return "NullTextSearchQuery"; }
 313 };
 314
 315 /**
 316  * A simple algebraic matcher for numeric attributes.
 317  *  NumericSearchQuery can do ("population < 20000 and area > 1000000", array("population", "area"))
 318  *  ->match(array('population' => 100000, 'area' => 10000000))
 319  *
 320  * Supports all mathematical PHP comparison operators, plus ':=' for equality.
 321  *   "(x < 2000000 and x >= 10000) or (x >= 100 and x < 2000)"
 322  *   "x := 100000" is the same as "x == 100000"
 323  *
 324  * Since this is basic numerics only, we simply try to get away with
 325  * replacing the variable values at the right positions and do an eval then.
 326  *
 327  * @package NumericSearchQuery
 328  * @author Reini Urban
 329  * @see SemanticAttributeSearchQuery
 330  */
 331 class NumericSearchQuery
 332 {
 333     /**
 334      * Create a new query.
 335      *   NumericSearchQuery("population > 20000 or population < 200", "population")
 336      *   NumericSearchQuery("population < 20000 and area > 1000000", array("population", "area"))
 337      *
 338      * With a single variable it is easy: The valid name must be matched elsewhere, just
 339      * replace the given number in match in the query.
 340      *   ->match(2000)
 341      *
 342      * With matching a struct we need strict names, no * as name is allowed.
 343      * So always when the placeholder is an array, the names of the target struct must match
 344      * and all vars be defined. Use the method can_match($struct) therefore.
 345      *
 346      * @access public
 347      * @param $search_query string   A numerical query with placeholders as variable.
 348      * @param $placeholders array or string  All placeholders in the query must be defined
 349      *  here, and will be replaced by the matcher.
 350      */
 351     function NumericSearchQuery($search_query, $placeholders) {
 352         // added some basic security checks against user input
 353         $this->_query = $search_query;
 354         $this->_placeholders = $placeholders;
 355
 356         // we should also allow the M_ constants
 357         $this->_allowed_functions = explode(':','abs:acos:acosh:asin:asinh:atan2:atan:atanh:base_convert:bindec:ceil:cos:cosh:decbin:dechex:decoct:deg2rad:exp:expm1:floor:fmod:getrandmax:hexdec:hypot:is_finite:is_infinite:is_nan:lcg_value:log10:log1p:log:max:min:mt_getrandmax:mt_rand:mt_srand:octdec:pi:pow:rad2deg:rand:round:sin:sinh:sqrt:srand:tan:tanh');
 358         $this->_allowed_operators = explode(',', '-,<,<=,>,>=,==,!=,*,+,/,(,),%,and,or,xor,<<,>>,===,!==,&,^,|,&&,||');
 359         $this->_parser_check = array();
 360         // check should be fast, so make a hash
 361         foreach ($this->_allowed_functions as $f)
 362             $this->_parser_check[$f] = 1;
 363         foreach ($this->_allowed_operators as $f)
 364             $this->_parser_check[$f] = 1;
 365         if (is_array($placeholders))
 366             foreach ($placeholders as $f)
 367                 $this->_parser_check[$f] = 1;
 368         else $this->_parser_check[$placeholders] = 1;
 369
 370         // This is a speciality: := looks like the attribute definition and is
 371         // therefore a dummy check for this definition.
 372         $this->_query = preg_replace("/\b:=\b/", "==", $this->_query);
 373         $this->_query = $this->check_query($this->_query);
 374     }
 375
 376     function getType() { return 'numeric'; }
 377
 378     /**
 379      * Check the symbolic definition query against unwanted functions and characters.
 380      * "population < 20000 and area > 1000000" vs "area > 1000000 and mail($me,file("/etc/passwd"),...)"
 381      * http://localhost/wikicvs/SemanticSearch?attribute=*&attr_op=<0 and find(1)>&s=-0.01&start_debug=1
 382      */
 383     function check_query ($query) {
 384         // Fixme!
 385         while (preg_match("/\A(\w.+)\s*\(\Z/", $query, $m)) {
 386             if (!in_array($m[1], $this->_allowed_functions)
 387                 and !in_array($m[1], $this->_allowed_operators))
 388             {
 389                 trigger_error("Illegal function in query: ".$m[1], E_USER_WARNING);
 390                 return '';
 391             }
 392         }
 393
 394         // Check for illegal functions and operators, which are no placeholders.
 395         if (function_exists('token_get_all')) {
 396             $parsed = token_get_all("<?$query?>");
 397             foreach ($parsed as $x) { // flat, non-recursive array
 398                 if (is_string($x) and !isset($this->_parser_check[$x])) {
 399                     // single char op or name
 400                     trigger_error("illegal string or operator: \"$x\"". E_USER_WARNING);
 401                     $query = '';
 402                 }
 403                 elseif (is_array($x)) {
 404                     $n = token_name($x[0]);
 405                     if ($n == 'T_OPEN_TAG' or $n == 'T_WHITESPACE'
 406                         or $n == 'T_CLOSE_TAG' or $n == 'T_LNUMBER'
 407                         or $n == 'T_CONST' or $n == 'T_DNUMBER' ) continue;
 408                     if ($n == 'T_VARIABLE') { // but we do allow consts
 409                         trigger_error("illegal variable: \"$x[1]\"", E_USER_WARNING);
 410                         $query = '';
 411                     }
 412                     if (is_string($x[1]) and !isset($this->_parser_check[$x[1]])) {
 413                         // multi-char char op or name
 414                         trigger_error("illegal $n: \"$x[1]\"", E_USER_WARNING);
 415                         $query = '';
 416                     }
 417                 }
 418             }
 419             //echo "$query <br>";
 420             //$this->_parse_token($parsed);
 421             //echo "<br>\n";
 422             //var_dump($parsed);
 423             /*
 424 "_x > 0" =>
 425 { T_OPEN_TAG "<?"} { T_STRING "_x"} { T_WHITESPACE " "} ">" { T_WHITESPACE " "} { T_LNUMBER "0"} { T_CLOSE_TAG "?>"}
 426         Interesting: on-char ops, as ">" are not tokenized.
 427 "_x <= 0"
 428 { T_OPEN_TAG "< ?" } { T_STRING "_x" } { T_WHITESPACE " " } { T_IS_SMALLER_OR_EQUAL "<=" } { T_WHITESPACE " " } { T_LNUMBER "0" } { T_CLOSE_TAG "?>" }
 429              */
 430         } else {
 431             // Detect illegal characters besides nums, words and ops. So attribute names can not be utf-8
 432             $c = "/([^\d\w.,\s".preg_quote(join("",$this->_allowed_operators),"/")."])/";
 433             if (preg_match($c, $query, $m)) {
 434                 trigger_error("Illegal character in query: ".$m[1], E_USER_WARNING);
 435                 return '';
 436             }
 437         }
 438         return $query;
 439     }
 440
 441     /**
 442      * Check the bound, numeric-only query against unwanted functions and sideeffects.
 443      * "4560000 < 20000 and 1456022 > 1000000"
 444      */
 445     function _live_check () {
 446         // TODO: check $this->_workquery again?
 447         return !empty($this->_workquery);
 448     }
 449
 450     /**
 451      * A numeric query can only operate with predefined variables. "x < 0 and y < 1"
 452      *
 453      * @return array The names as array of strings. => ('x', 'y') the placeholders.
 454      */
 455     function getVars() {
 456         if(is_array($this->_placeholders)) return $this->_placeholders;
 457         else return array($this->_placeholders);
 458     }
 459
 460     /**
 461      * Strip non-numeric chars from the variable (as the groupseperator) and replace
 462      * it in the symbolic query for evaluation.
 463      *
 464      * @access private
 465      * @param $value number   A numerical value: integer, float or string.
 466      * @param $x string       The variable name to be replaced in the query.
 467      * @return string
 468      */
 469     function _bind($value, $x) {
 470         // TODO: check is_number, is_float, is_integer and do casting
 471         $this->_bound[] = array('linkname'  => $x,
 472                                 'linkvalue' => $value);
 473         $value = preg_replace("/[^-+0123456789.,]/", "", $value);
 474         //$c = "/\b".preg_quote($x,"/")."\b/";
 475         $this->_workquery = preg_replace("/\b".preg_quote($x,"/")."\b/", $value, $this->_workquery);
 476         // FIXME: do again a final check. now only numbers and some operators are allowed.
 477         return $this->_workquery;
 478     }
 479
 480     /* array of successfully bound vars, and in case of success, the resulting vars
 481      */
 482     function _bound() {
 483         return $this->_bound;
 484     }
 485
 486     /**
 487      * With an array of placeholders we need a hash to check against, if all required names are given.
 488      * Purpose: Be silent about missing vars, just return false.
 489      `*
 490      * @access public
 491      * @param $variable string or hash of name => value  The keys must satisfy all placeholders in the definition.
 492      * We want the full hash and not just the keys because a hash check is faster than the array of keys check.
 493      * @return boolean
 494      */
 495     function can_match(&$variables) {
 496         if (empty($this->_query))
 497             return false;
 498         $p =& $this->_placeholders;
 499         if (!is_array($variables) and !is_array($p))
 500             return $variables == $p; // This was easy.
 501         // Check if all placeholders have definitions. can be overdefined but not underdefined.
 502         if (!is_array($p)) {
 503             if (!isset($variables[$p])) return false;
 504         } else {
 505             foreach ($p as $x) {
 506                 if (!isset($variables[$x])) return false;
 507             }
 508         }
 509         return true;
 510     }
 511
 512     /**
 513      * We can match against a single variable or against a hash of variables.
 514      * With one placeholder we need just a number.
 515      * With an array of placeholders we need a hash.
 516      *
 517      * @access public
 518      * @param $variable number or array of name => value  The keys must satisfy all placeholders in the definition.
 519      * @return boolean
 520      */
 521     function match(&$variable) {
 522         $p =& $this->_placeholders;
 523         $this->_workquery = $this->_query;
 524         if (!is_array($p)) {
 525             if (is_array($variable)) { // which var to match? we cannot decide this here
 526                 if (!isset($variable[$p]))
 527                     trigger_error("Required NumericSearchQuery->match variable $x not defined.", E_USER_ERROR);
 528                 $this->_bind($variable[$p], $p);
 529             } else {
 530                 $this->_bind($variable, $p);
 531             }
 532         } else {
 533             foreach ($p as $x) {
 534                 if (!isset($variable[$x]))
 535                     trigger_error("Required NumericSearchQuery->match variable $x not defined.", E_USER_ERROR);
 536                 $this->_bind($variable[$x], $x);
 537             }
 538         }
 539         if (!$this->_live_check()) // check returned an error
 540             return false;
 541         $search = $this->_workquery;
 542         $result = false;
 543         //if (DEBUG & _DEBUG_VERBOSE)
 544         //    trigger_error("\$result = (boolean)($search);", E_USER_NOTICE);
 545         // we might have a numerical problem:
 546         // php-4.2.2 eval'ed as module: "9.636e+08 > 1000" false;
 547         // php-5.1.2 cgi true, 4.2.2 cgi true
 548         eval("\$result = (boolean)($search);");
 549         if ($result and is_array($p)) {
 550             return $this->_bound();
 551         }
 552         return $result;
 553     }
 554 }
 555
 556
 557 ////////////////////////////////////////////////////////////////
 558 //
 559 // Remaining classes are private.
 560 //
 561 ////////////////////////////////////////////////////////////////
 562 /**
 563  * Virtual base class for nodes in a TextSearchQuery parse tree.
 564  *
 565  * Also serves as a 'VOID' (contentless) node.
 566  */
 567 class TextSearchQuery_node
 568 {
 569     var $op = 'VOID';
 570
 571     /**
 572      * Optimize this node.
 573      * @return object Optimized node.
 574      */
 575     function optimize() {
 576         return $this;
 577     }
 578
 579     /**
 580      * @return regexp matching this node.
 581      */
 582     function regexp() {
 583         return '';
 584     }
 585
 586     /**
 587      * @param bool True if this node has been negated (higher in the parse tree.)
 588      * @return array A list of all non-negated words contained by this node.
 589      */
 590     function highlight_words($negated = false) {
 591         return array();
 592     }
 593
 594     function sql()    { return $this->word; }
 595 }
 596
 597 /**
 598  * A word.
 599  */
 600 class TextSearchQuery_node_word
 601 extends TextSearchQuery_node
 602 {
 603     var $op = "WORD";
 604
 605     function TextSearchQuery_node_word($word) {
 606         $this->word = $word;
 607     }
 608     function regexp() {
 609         return '(?=.*' . preg_quote($this->word, '/') . ')';
 610     }
 611     function highlight_words ($negated = false) {
 612         return $negated ? array() : array($this->word);
 613     }
 614     function _sql_quote() {
 615         $word = preg_replace('/(?=[%_\\\\])/', "\\", $this->word);
 616         return $GLOBALS['request']->_dbi->qstr($word);
 617     }
 618     function sql()    { return '%'.$this->_sql_quote($this->word).'%'; }
 619 }
 620
 621 class TextSearchQuery_node_all
 622 extends TextSearchQuery_node {
 623     var $op = "ALL";
 624     function regexp() { return '(?=.*)'; }
 625     function sql()    { return '%'; }
 626 }
 627 class TextSearchQuery_node_starts_with
 628 extends TextSearchQuery_node_word {
 629     var $op = "STARTS_WITH";
 630     function regexp() { return '(?=.*\b' . preg_quote($this->word, '/') . ')'; }
 631     function sql ()   { return $this->_sql_quote($this->word).'%'; }
 632 }
 633
 634 class TextSearchQuery_node_ends_with
 635 extends TextSearchQuery_node_word {
 636     var $op = "ENDS_WITH";
 637     function regexp() { return '(?=.*' . preg_quote($this->word, '/') . '\b)'; }
 638     function sql ()   { return '%'.$this->_sql_quote($this->word); }
 639 }
 640
 641 class TextSearchQuery_node_exact
 642 extends TextSearchQuery_node_word {
 643     var $op = "EXACT";
 644     function regexp() { return '(?=\b' . preg_quote($this->word, '/') . '\b)'; }
 645     function sql ()   { return $this->_sql_squote($this->word); }
 646 }
 647
 648 class TextSearchQuery_node_regex // posix regex. FIXME!
 649 extends TextSearchQuery_node_word {
 650     var $op = "REGEX"; // using REGEXP or ~ extension
 651     function regexp() { return '(?=.*\b' . $this->word . '\b)'; }
 652     function sql ()   { return $this->_sql_quote($this->word); }
 653 }
 654
 655 class TextSearchQuery_node_regex_glob
 656 extends TextSearchQuery_node_regex {
 657     var $op = "REGEX_GLOB";
 658     function regexp() { return '(?=.*\b' . glob_to_pcre($this->word) . '\b)'; }
 659 }
 660
 661 class TextSearchQuery_node_regex_pcre // how to handle pcre modifiers? /i
 662 extends TextSearchQuery_node_regex {
 663     var $op = "REGEX_PCRE";
 664     function regexp() { return $this->word; }
 665 }
 666
 667 class TextSearchQuery_node_regex_sql
 668 extends TextSearchQuery_node_regex {
 669     var $op = "REGEX_SQL"; // using LIKE
 670     function regexp() { return str_replace(array("/%/","/_/"), array(".*","."), $this->word); }
 671     function sql()    { return $this->word; }
 672 }
 673
 674 /**
 675  * A negated clause.
 676  */
 677 class TextSearchQuery_node_not
 678 extends TextSearchQuery_node
 679 {
 680     var $op = "NOT";
 681
 682     function TextSearchQuery_node_not($leaf) {
 683         $this->leaves = array($leaf);
 684     }
 685
 686     function optimize() {
 687         $leaf = &$this->leaves[0];
 688         $leaf = $leaf->optimize();
 689         if ($leaf->op == 'NOT')
 690             return $leaf->leaves[0]; // ( NOT ( NOT x ) ) -> x
 691         return $this;
 692     }
 693
 694     function regexp() {
 695         $leaf = &$this->leaves[0];
 696         return '(?!' . $leaf->regexp() . ')';
 697     }
 698
 699     function highlight_words ($negated = false) {
 700         return $this->leaves[0]->highlight_words(!$negated);
 701     }
 702 }
 703
 704 /**
 705  * Virtual base class for 'AND' and 'OR conjoins.
 706  */
 707 class TextSearchQuery_node_binop
 708 extends TextSearchQuery_node
 709 {
 710     function TextSearchQuery_node_binop($leaves) {
 711         $this->leaves = $leaves;
 712     }
 713
 714     function _flatten() {
 715         // This flattens e.g. (AND (AND a b) (OR c d) e)
 716         //        to (AND a b e (OR c d))
 717         $flat = array();
 718         foreach ($this->leaves as $leaf) {
 719             $leaf = $leaf->optimize();
 720             if ($this->op == $leaf->op)
 721                 $flat = array_merge($flat, $leaf->leaves);
 722             else
 723                 $flat[] = $leaf;
 724         }
 725         $this->leaves = $flat;
 726     }
 727
 728     function optimize() {
 729         $this->_flatten();
 730         assert(!empty($this->leaves));
 731         if (count($this->leaves) == 1)
 732             return $this->leaves[0]; // (AND x) -> x
 733         return $this;
 734     }
 735
 736     function highlight_words($negated = false) {
 737         $words = array();
 738         foreach ($this->leaves as $leaf)
 739             array_splice($words,0,0,
 740                          $leaf->highlight_words($negated));
 741         return $words;
 742     }
 743 }
 744
 745 /**
 746  * A (possibly multi-argument) 'AND' conjoin.
 747  */
 748 class TextSearchQuery_node_and
 749 extends TextSearchQuery_node_binop
 750 {
 751     var $op = "AND";
 752
 753     function optimize() {
 754         $this->_flatten();
 755
 756         // Convert (AND (NOT a) (NOT b) c d) into (AND (NOT (OR a b)) c d).
 757         // Since OR's are more efficient for regexp matching:
 758         //   (?!.*a)(?!.*b)  vs   (?!.*(?:a|b))
 759
 760         // Suck out the negated leaves.
 761         $nots = array();
 762         foreach ($this->leaves as $key => $leaf) {
 763             if ($leaf->op == 'NOT') {
 764                 $nots[] = $leaf->leaves[0];
 765                 unset($this->leaves[$key]);
 766             }
 767         }
 768
 769         // Combine the negated leaves into a single negated or.
 770         if ($nots) {
 771             $node = ( new TextSearchQuery_node_not
 772                       (new TextSearchQuery_node_or($nots)) );
 773             array_unshift($this->leaves, $node->optimize());
 774         }
 775
 776         assert(!empty($this->leaves));
 777         if (count($this->leaves) == 1)
 778             return $this->leaves[0];  // (AND x) -> x
 779         return $this;
 780     }
 781
 782     /* FIXME!
 783      * Either we need all combinations of all words to be position independent,
 784      * or we have to use multiple match calls for each AND
 785      * (AND x y) => /(?(:x)(:y))|(?(:y)(:x))/
 786      */
 787     function regexp() {
 788         $regexp = '';
 789         foreach ($this->leaves as $leaf)
 790             $regexp .= $leaf->regexp();
 791         return $regexp;
 792     }
 793 }
 794
 795 /**
 796  * A (possibly multi-argument) 'OR' conjoin.
 797  */
 798 class TextSearchQuery_node_or
 799 extends TextSearchQuery_node_binop
 800 {
 801     var $op = "OR";
 802
 803     function regexp() {
 804         // We will combine any of our direct descendents which are WORDs
 805         // into a single (?=.*(?:word1|word2|...)) regexp.
 806
 807         $regexps = array();
 808         $words = array();
 809
 810         foreach ($this->leaves as $leaf) {
 811             if ($leaf->op == 'WORD')
 812                 $words[] = preg_quote($leaf->word, '/');
 813             else
 814                 $regexps[] = $leaf->regexp();
 815         }
 816
 817         if ($words)
 818             array_unshift($regexps,
 819                           '(?=.*' . $this->_join($words) . ')');
 820
 821         return $this->_join($regexps);
 822     }
 823
 824     function _join($regexps) {
 825         assert(count($regexps) > 0);
 826
 827         if (count($regexps) > 1)
 828             return '(?:' . join('|', $regexps) . ')';
 829         else
 830             return $regexps[0];
 831     }
 832 }
 833
 834
 835 ////////////////////////////////////////////////////////////////
 836 //
 837 // Parser:
 838 //   op's (and, or, not) are forced to lowercase in the tokenizer.
 839 //
 840 ////////////////////////////////////////////////////////////////
 841 define ('TSQ_TOK_BINOP',  1);
 842 define ('TSQ_TOK_NOT',    2);
 843 define ('TSQ_TOK_LPAREN', 4);
 844 define ('TSQ_TOK_RPAREN', 8);
 845 define ('TSQ_TOK_WORD',   16);
 846 define ('TSQ_TOK_STARTS_WITH', 32);
 847 define ('TSQ_TOK_ENDS_WITH', 64);
 848 define ('TSQ_TOK_EXACT', 128);
 849 define ('TSQ_TOK_REGEX', 256);
 850 define ('TSQ_TOK_REGEX_GLOB', 512);
 851 define ('TSQ_TOK_REGEX_PCRE', 1024);
 852 define ('TSQ_TOK_REGEX_SQL', 2048);
 853 define ('TSQ_TOK_ALL', 4096);
 854 // all bits from word to the last.
 855 define ('TSQ_ALLWORDS', (4096*2)-1 - (16-1));
 856
 857 class TextSearchQuery_Parser
 858 {
 859     /*
 860      * This is a simple recursive descent parser, based on the following grammar:
 861      *
 862      * toplist  :
 863      *          | toplist expr
 864      *          ;
 865      *
 866      *
 867      * list     : expr
 868      *          | list expr
 869      *          ;
 870      *
 871      * expr     : atom
 872      *          | expr BINOP atom
 873      *          ;
 874      *
 875      * atom     : '(' list ')'
 876      *          | NOT atom
 877      *          | WORD
 878      *          ;
 879      *
 880      * The terminal tokens are:
 881      *
 882      *
 883      * and|or             BINOP
 884      * -|not              NOT
 885      * (                  LPAREN
 886      * )                  RPAREN
 887      * /[^-()\s][^()\s]*  WORD
 888      * /"[^"]*"/          WORD
 889      * /'[^']*'/          WORD
 890      *
 891      * ^WORD              STARTS_WITH
 892      * WORD*              STARTS_WITH
 893      * *WORD              ENDS_WITH
 894      * ^WORD$             EXACT
 895      * *                  ALL
 896      */
 897
 898     function parse ($search_expr, $case_exact=false, $regex=TSQ_REGEX_AUTO) {
 899         $this->lexer = new TextSearchQuery_Lexer($search_expr, $case_exact, $regex);
 900         $this->_regex = $regex;
 901         $tree = $this->get_list('toplevel');
 902         assert($this->lexer->eof());
 903         unset($this->lexer);
 904         return $tree;
 905     }
 906
 907     function get_list ($is_toplevel = false) {
 908         $list = array();
 909
 910         // token types we'll accept as words (and thus expr's) for the
 911         // purpose of error recovery:
 912         $accept_as_words = TSQ_TOK_NOT | TSQ_TOK_BINOP;
 913         if ($is_toplevel)
 914             $accept_as_words |= TSQ_TOK_LPAREN | TSQ_TOK_RPAREN;
 915
 916         while ( ($expr = $this->get_expr())
 917                 || ($expr = $this->get_word($accept_as_words)) ) {
 918             $list[] = $expr;
 919         }
 920
 921         if (!$list) {
 922             if ($is_toplevel)
 923                 return new TextSearchQuery_node;
 924             else
 925                 return false;
 926         }
 927         return new TextSearchQuery_node_and($list);
 928     }
 929
 930     function get_expr () {
 931         if ( !($expr = $this->get_atom()) )
 932             return false;
 933
 934         $savedpos = $this->lexer->tell();
 935         while ( ($op = $this->lexer->get(TSQ_TOK_BINOP)) ) {
 936             if ( ! ($right = $this->get_atom()) ) {
 937                 break;
 938             }
 939
 940             if ($op == 'and')
 941                 $expr = new TextSearchQuery_node_and(array($expr, $right));
 942             else {
 943                 assert($op == 'or');
 944                 $expr = new TextSearchQuery_node_or(array($expr, $right));
 945             }
 946
 947             $savedpos = $this->lexer->tell();
 948         }
 949         $this->lexer->seek($savedpos);
 950
 951         return $expr;
 952     }
 953
 954
 955     function get_atom() {
 956         if ($word = $this->get_word(TSQ_ALLWORDS))
 957             return $word;
 958
 959         $savedpos = $this->lexer->tell();
 960         if ( $this->lexer->get(TSQ_TOK_LPAREN) ) {
 961             if ( ($list = $this->get_list()) && $this->lexer->get(TSQ_TOK_RPAREN) )
 962                 return $list;
 963         }
 964         elseif ( $this->lexer->get(TSQ_TOK_NOT) ) {
 965             if ( ($atom = $this->get_atom()) )
 966                 return new TextSearchQuery_node_not($atom);
 967         }
 968         $this->lexer->seek($savedpos);
 969         return false;
 970     }
 971
 972     function get_word($accept = TSQ_ALLWORDS) {
 973         foreach (array("WORD","STARTS_WITH","ENDS_WITH","EXACT",
 974                        "REGEX","REGEX_GLOB","REGEX_PCRE","ALL") as $tok) {
 975             $const = constant("TSQ_TOK_".$tok);
 976             if ( $accept & $const and ($word = $this->lexer->get($const)) ) {
 977                 $classname = "TextSearchQuery_node_".strtolower($tok);
 978                 return new $classname($word);
 979             }
 980         }
 981         return false;
 982     }
 983 }
 984
 985 class TextSearchQuery_Lexer {
 986     function TextSearchQuery_Lexer ($query_str, $case_exact=false, $regex=TSQ_REGEX_AUTO) {
 987         $this->tokens = $this->tokenize($query_str, $case_exact, $regex);
 988         $this->pos = 0;
 989     }
 990
 991     function tell() {
 992         return $this->pos;
 993     }
 994
 995     function seek($pos) {
 996         $this->pos = $pos;
 997     }
 998
 999     function eof() {
1000         return $this->pos == count($this->tokens);
1001     }
1002
1003     /**
1004      * TODO: support more regex styles, esp. prefer the forced ones over auto
1005      * re: and // stuff
1006      */
1007     function tokenize($string, $case_exact=false, $regex=TSQ_REGEX_AUTO) {
1008         $tokens = array();
1009         $buf = $case_exact ? ltrim($string) : strtolower(ltrim($string));
1010         while (!empty($buf)) {
1011             if (preg_match('/^(and|or)\b\s*/i', $buf, $m)) {
1012                 $val = strtolower($m[1]);
1013                 $type = TSQ_TOK_BINOP;
1014             }
1015             elseif (preg_match('/^(-|not\b)\s*/i', $buf, $m)) {
1016                 $val = strtolower($m[1]);
1017                 $type = TSQ_TOK_NOT;
1018             }
1019             elseif (preg_match('/^([()])\s*/', $buf, $m)) {
1020                 $val = $m[1];
1021                 $type = $m[1] == '(' ? TSQ_TOK_LPAREN : TSQ_TOK_RPAREN;
1022             }
1023
1024             // * => ALL
1025             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_GLOB)
1026                     and preg_match('/^\*\s*/', $buf, $m)) {
1027                 $val = "*";
1028                 $type = TSQ_TOK_ALL;
1029             }
1030             // .* => ALL
1031             elseif ($regex & (TSQ_REGEX_PCRE)
1032                     and preg_match('/^\.\*\s*/', $buf, $m)) {
1033                 $val = ".*";
1034                 $type = TSQ_TOK_ALL;
1035             }
1036             // % => ALL
1037             elseif ($regex & (TSQ_REGEX_SQL)
1038                     and preg_match('/^%\s*/', $buf, $m)) {
1039                 $val = "%";
1040                 $type = TSQ_TOK_ALL;
1041             }
1042
1043             // ^word
1044             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_PCRE)
1045                     and preg_match('/^\^([^-()][^()\s]*)\s*/', $buf, $m)) {
1046                 $val = $m[1];
1047                 $type = TSQ_TOK_STARTS_WITH;
1048             }
1049             // word*
1050             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_GLOB)
1051                     and preg_match('/^([^-()][^()\s]*)\*\s*/', $buf, $m)) {
1052                 $val = $m[1];
1053                 $type = TSQ_TOK_STARTS_WITH;
1054             }
1055             // *word
1056             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_GLOB)
1057                     and preg_match('/^\*([^-()][^()\s]*)\s*/', $buf, $m)) {
1058                 $val = $m[1];
1059                 $type = TSQ_TOK_ENDS_WITH;
1060             }
1061             // word$
1062             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_PCRE)
1063                     and preg_match('/^([^-()][^()\s]*)\$\s*/', $buf, $m)) {
1064                 $val = $m[1];
1065                 $type = TSQ_TOK_ENDS_WITH;
1066             }
1067             // ^word$
1068             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_PCRE)
1069                     and preg_match('/^\^([^-()][^()\s]*)\$\s*/', $buf, $m)) {
1070                 $val = $m[1];
1071                 $type = TSQ_TOK_EXACT;
1072             }
1073
1074             // "words "
1075             elseif (preg_match('/^ " ( (?: [^"]+ | "" )* ) " \s*/x', $buf, $m)) {
1076                 $val = str_replace('""', '"', $m[1]);
1077                 $type = TSQ_TOK_WORD;
1078             }
1079             // 'words '
1080             elseif (preg_match("/^ ' ( (?:[^']+|'')* ) ' \s*/x", $buf, $m)) {
1081                 $val = str_replace("''", "'", $m[1]);
1082                 $type = TSQ_TOK_WORD;
1083             }
1084             // word
1085             elseif (preg_match('/^([^-()][^()\s]*)\s*/', $buf, $m)) {
1086                 $val = $m[1];
1087                 $type = TSQ_TOK_WORD;
1088             }
1089             else {
1090                 assert(empty($buf));
1091                 break;
1092             }
1093             $buf = substr($buf, strlen($m[0]));
1094
1095             /* refine the simple parsing from above: bla*bla, bla?bla, ...
1096             if ($regex and $type == TSQ_TOK_WORD) {
1097                 if (substr($val,0,1) == "^")
1098                     $type = TSQ_TOK_STARTS_WITH;
1099                 elseif (substr($val,0,1) == "*")
1100                     $type = TSQ_TOK_ENDS_WITH;
1101                 elseif (substr($val,-1,1) == "*")
1102                     $type = TSQ_TOK_STARTS_WITH;
1103             }
1104             */
1105             $tokens[] = array($type, $val);
1106         }
1107         return $tokens;
1108     }
1109
1110     function get($accept) {
1111         if ($this->pos >= count($this->tokens))
1112             return false;
1113
1114         list ($type, $val) = $this->tokens[$this->pos];
1115         if (($type & $accept) == 0)
1116             return false;
1117
1118         $this->pos++;
1119         return $val;
1120     }
1121 }
1122
1123 // $Log: not supported by cvs2svn $
1124 // Revision 1.24  2007/01/02 13:19:05  rurban
1125 // add NumericSearchQuery. change on pcre: no parsing done, detect modifiers
1126 //
1127 // Revision 1.23  2006/04/13 19:30:44  rurban
1128 // make TextSearchQuery->_stoplist localizable and overridable within config.ini
1129 //
1130
1131 // Local Variables:
1132 // mode: php
1133 // tab-width: 8
1134 // c-basic-offset: 4
1135 // c-hanging-comment-ender-p: nil
1136 // indent-tabs-mode: nil
1137 // End:
1138 ?>