lib/TextSearchQuery.php

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