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      */
 407     function check_query($query)
 408     {
 409         $tmp = $query; // check for all function calls, in case the tokenizer is not available.
 410         while (preg_match("/([a-z][a-z0-9]+)\s*\((.*)$/i", $tmp, $m)) {
 411             if (!in_array($m[1], $this->_allowed_functions)
 412                 and !in_array($m[1], $this->_allowed_operators)
 413             ) {
 414                 trigger_error("Illegal function in query: " . $m[1], E_USER_WARNING);
 415                 return '';
 416             }
 417             $tmp = $m[2];
 418         }
 419
 420         // Strictly check for illegal functions and operators, which are no placeholders.
 421         $parsed = token_get_all("<?$query?>");
 422         foreach ($parsed as $x) { // flat, non-recursive array
 423             if (is_string($x) and !isset($this->_parser_check[$x])) {
 424                 // single char op or name
 425                 trigger_error("Illegal string or operator in query: \"$x\"", E_USER_WARNING);
 426                 $query = '';
 427             } elseif (is_array($x)) {
 428                 $n = token_name($x[0]);
 429                 if ($n == 'T_OPEN_TAG' or $n == 'T_WHITESPACE'
 430                     or $n == 'T_CLOSE_TAG' or $n == 'T_LNUMBER'
 431                     or $n == 'T_CONST' or $n == 'T_DNUMBER'
 432                 ) continue;
 433                 if ($n == 'T_VARIABLE') { // but we do allow consts
 434                     trigger_error("Illegal variable in query: \"$x[1]\"", E_USER_WARNING);
 435                     $query = '';
 436                 }
 437                 if (is_string($x[1]) and !isset($this->_parser_check[$x[1]])) {
 438                     // multi-char char op or name
 439                     trigger_error("Illegal $n in query: \"$x[1]\"", E_USER_WARNING);
 440                     $query = '';
 441                 }
 442             }
 443         }
 444         return $query;
 445     }
 446
 447     /**
 448      * Check the bound, numeric-only query against unwanted functions and sideeffects.
 449      * "4560000 < 20000 and 1456022 > 1000000"
 450      */
 451     private function live_check()
 452     {
 453         // TODO: check $this->_workquery again?
 454         return !empty($this->workquery);
 455     }
 456
 457     /**
 458      * A numeric query can only operate with predefined variables. "x < 0 and y < 1"
 459      *
 460      * @return array The names as array of strings. => ('x', 'y') the placeholders.
 461      */
 462     function getVars()
 463     {
 464         if (is_array($this->_placeholders)) return $this->_placeholders;
 465         else return array($this->_placeholders);
 466     }
 467
 468     /**
 469      * Strip non-numeric chars from the variable (as the group separator) and replace
 470      * it in the symbolic query for evaluation.
 471      *
 472      * @param $value number   A numerical value: integer, float or string.
 473      * @param $x string       The variable name to be replaced in the query.
 474      * @return string
 475      */
 476     private function bind($value, $x)
 477     {
 478         // TODO: check is_number, is_float, is_integer and do casting
 479         $this->bound[] = array('linkname' => $x,
 480             'linkvalue' => $value);
 481         $value = preg_replace("/[^-+0123456789.,]/", "", $value);
 482         //$c = "/\b".preg_quote($x,"/")."\b/";
 483         $this->workquery = preg_replace("/\b" . preg_quote($x, "/") . "\b/", $value, $this->workquery);
 484         // FIXME: do again a final check. now only numbers and some operators are allowed.
 485         return $this->workquery;
 486     }
 487
 488     /* array of successfully bound vars, and in case of success, the resulting vars
 489      */
 490     private function bound()
 491     {
 492         return $this->bound;
 493     }
 494
 495     /**
 496      * With an array of placeholders we need a hash to check against, if all required names are given.
 497      * Purpose: Be silent about missing vars, just return false.
 498     `*
 499      * @param string $variables string or hash of name => value  The keys must satisfy all placeholders in the definition.
 500      * We want the full hash and not just the keys because a hash check is faster than the array of keys check.
 501      * @return boolean
 502      */
 503     public function can_match(&$variables)
 504     {
 505         if (empty($this->_query))
 506             return false;
 507         $p =& $this->_placeholders;
 508         if (!is_array($variables) and !is_array($p))
 509             return $variables == $p; // This was easy.
 510         // Check if all placeholders have definitions. can be overdefined but not underdefined.
 511         if (!is_array($p)) {
 512             if (!isset($variables[$p])) return false;
 513         } else {
 514             foreach ($p as $x) {
 515                 if (!isset($variables[$x])) return false;
 516             }
 517         }
 518         return true;
 519     }
 520
 521     /**
 522      * We can match against a single variable or against a hash of variables.
 523      * With one placeholder we need just a number.
 524      * With an array of placeholders we need a hash.
 525      *
 526      * @param $variable number or array of name => value  The keys must satisfy all placeholders in the definition.
 527      * @return boolean
 528      */
 529     public function match(&$variable)
 530     {
 531         $p =& $this->_placeholders;
 532         $this->workquery = $this->_query;
 533         if (!is_array($p)) {
 534             if (is_array($variable)) { // which var to match? we cannot decide this here
 535                 if (!isset($variable[$p]))
 536                     trigger_error("Required NumericSearchQuery->match variable $p not defined.", E_USER_ERROR);
 537                 $this->bind($variable[$p], $p);
 538             } else {
 539                 $this->bind($variable, $p);
 540             }
 541         } else {
 542             foreach ($p as $x) {
 543                 if (!isset($variable[$x]))
 544                     trigger_error("Required NumericSearchQuery->match variable $x not defined.", E_USER_ERROR);
 545                 $this->bind($variable[$x], $x);
 546             }
 547         }
 548         if (!$this->live_check()) // check returned an error
 549             return false;
 550         $search = $this->workquery;
 551         $result = false;
 552         //if (DEBUG & _DEBUG_VERBOSE)
 553         //    trigger_error("\$result = (boolean)($search);", E_USER_NOTICE);
 554         // We might have a numerical problem:
 555         // php-4.2.2 eval'ed as module: "9.636e+08 > 1000" false;
 556         // php-5.1.2 cgi true, 4.2.2 cgi true
 557         eval("\$result = (boolean)($search);");
 558         if ($result and is_array($p)) {
 559             return $this->bound();
 560         }
 561         return $result;
 562     }
 563 }
 564
 565 ////////////////////////////////////////////////////////////////
 566 //
 567 // Remaining classes are private.
 568 //
 569 ////////////////////////////////////////////////////////////////
 570 /**
 571  * Virtual base class for nodes in a TextSearchQuery parse tree.
 572  *
 573  * Also serves as a 'VOID' (contentless) node.
 574  */
 575 class TextSearchQuery_node
 576 {
 577     public $op = 'VOID';
 578     public $_op = 0;
 579     public $word;
 580
 581     /**
 582      * Optimize this node.
 583      * @return object Optimized node.
 584      */
 585     function optimize()
 586     {
 587         return $this;
 588     }
 589
 590     /**
 591      * @return string regexp matching this node.
 592      */
 593     function regexp()
 594     {
 595         return '';
 596     }
 597
 598     /**
 599      * @param bool $negated True if this node has been negated (higher in the parse tree.)
 600      * @return array A list of all non-negated words contained by this node.
 601      */
 602     function highlight_words($negated = false)
 603     {
 604         return array();
 605     }
 606
 607     function sql()
 608     {
 609         return $this->word;
 610     }
 611
 612     function sql_quote()
 613     {
 614         global $request;
 615         $word = preg_replace('/(?=[%_\\\\])/', "\\", $this->word);
 616         return $request->_dbi->_backend->qstr($word);
 617     }
 618 }
 619
 620 /**
 621  * A word. Exact or substring?
 622  */
 623 class TextSearchQuery_node_word
 624     extends TextSearchQuery_node
 625 {
 626     public $op = "WORD";
 627     public $_op = TSQ_TOK_WORD;
 628
 629     function __construct($word)
 630     {
 631         $this->word = $word;
 632     }
 633
 634     function regexp()
 635     {
 636         return '(?=.*\b' . preg_quote($this->word, '/') . '\b)';
 637     }
 638
 639     function highlight_words($negated = false)
 640     {
 641         return $negated ? array() : array($this->word);
 642     }
 643
 644     function sql()
 645     {
 646         return '%' . $this->sql_quote($this->word) . '%';
 647     }
 648 }
 649
 650 class TextSearchQuery_node_all
 651     extends TextSearchQuery_node
 652 {
 653     public $op = "ALL";
 654     public $_op = TSQ_TOK_ALL;
 655
 656     function regexp()
 657     {
 658         return '(?=.*)';
 659     }
 660
 661     function sql()
 662     {
 663         return '%';
 664     }
 665 }
 666
 667 class TextSearchQuery_node_starts_with
 668     extends TextSearchQuery_node_word
 669 {
 670     public $op = "STARTS_WITH";
 671     public $_op = TSQ_TOK_STARTS_WITH;
 672
 673     function regexp()
 674     {
 675         return '(?=.*\b' . preg_quote($this->word, '/') . ')';
 676     }
 677
 678     function sql()
 679     {
 680         return $this->sql_quote($this->word) . '%';
 681     }
 682 }
 683
 684 // ^word: full phrase starts with
 685 class TextSearchQuery_phrase_starts_with
 686     extends TextSearchQuery_node_starts_with
 687 {
 688     function regexp()
 689     {
 690         return '(?=^' . preg_quote($this->word, '/') . ')';
 691     }
 692 }
 693
 694 class TextSearchQuery_node_ends_with
 695     extends TextSearchQuery_node_word
 696 {
 697     public $op = "ENDS_WITH";
 698     public $_op = TSQ_TOK_ENDS_WITH;
 699
 700     function regexp()
 701     {
 702         return '(?=.*' . preg_quote($this->word, '/') . '\b)';
 703     }
 704
 705     function sql()
 706     {
 707         return '%' . $this->sql_quote($this->word);
 708     }
 709 }
 710
 711 // word$: full phrase ends with
 712 class TextSearchQuery_phrase_ends_with
 713     extends TextSearchQuery_node_ends_with
 714 {
 715     function regexp()
 716     {
 717         return '(?=' . preg_quote($this->word, '/') . '$)';
 718     }
 719 }
 720
 721 class TextSearchQuery_node_exact
 722     extends TextSearchQuery_node_word
 723 {
 724     public $op = "EXACT";
 725     public $_op = TSQ_TOK_EXACT;
 726
 727     function regexp()
 728     {
 729         return '(?=\b' . preg_quote($this->word, '/') . '\b)';
 730     }
 731
 732     function sql()
 733     {
 734         return $this->_sql_squote($this->word);
 735     }
 736 }
 737
 738 class TextSearchQuery_node_regex // posix regex. FIXME!
 739     extends TextSearchQuery_node_word
 740 {
 741     public $op = "REGEX"; // using REGEXP or ~ extension
 742     public $_op = TSQ_TOK_REGEX;
 743
 744     function regexp()
 745     {
 746         return '(?=.*\b' . $this->word . '\b)';
 747     }
 748
 749     function sql()
 750     {
 751         return $this->sql_quote($this->word);
 752     }
 753 }
 754
 755 class TextSearchQuery_node_regex_glob
 756     extends TextSearchQuery_node_regex
 757 {
 758     public $op = "REGEX_GLOB";
 759     public $_op = TSQ_TOK_REGEX_GLOB;
 760
 761     function regexp()
 762     {
 763         return '(?=.*\b' . glob_to_pcre($this->word) . '\b)';
 764     }
 765 }
 766
 767 class TextSearchQuery_node_regex_pcre // how to handle pcre modifiers? /i
 768     extends TextSearchQuery_node_regex
 769 {
 770     public $op = "REGEX_PCRE";
 771     public $_op = TSQ_TOK_REGEX_PCRE;
 772
 773     function regexp()
 774     {
 775         return $this->word;
 776     }
 777 }
 778
 779 class TextSearchQuery_node_regex_sql
 780     extends TextSearchQuery_node_regex
 781 {
 782     public $op = "REGEX_SQL"; // using LIKE
 783     public $_op = TSQ_TOK_REGEX_SQL;
 784
 785     function regexp()
 786     {
 787         return str_replace(array("/%/", "/_/"), array(".*", "."), $this->word);
 788     }
 789
 790     function sql()
 791     {
 792         return $this->word;
 793     }
 794 }
 795
 796 /**
 797  * A negated clause.
 798  */
 799 class TextSearchQuery_node_not
 800     extends TextSearchQuery_node
 801 {
 802     public $op = "NOT";
 803     public $_op = TSQ_TOK_NOT;
 804
 805     function TextSearchQuery_node_not($leaf)
 806     {
 807         $this->leaves = array($leaf);
 808     }
 809
 810     function optimize()
 811     {
 812         $leaf = &$this->leaves[0];
 813         $leaf = $leaf->optimize();
 814         if ($leaf->_op == TSQ_TOK_NOT)
 815             return $leaf->leaves[0]; // ( NOT ( NOT x ) ) -> x
 816         return $this;
 817     }
 818
 819     function regexp()
 820     {
 821         $leaf = &$this->leaves[0];
 822         return '(?!' . $leaf->regexp() . ')';
 823     }
 824
 825     function highlight_words($negated = false)
 826     {
 827         return $this->leaves[0]->highlight_words(!$negated);
 828     }
 829 }
 830
 831 /**
 832  * Virtual base class for 'AND' and 'OR conjoins.
 833  */
 834 class TextSearchQuery_node_binop
 835     extends TextSearchQuery_node
 836 {
 837     public $_op = TSQ_TOK_BINOP;
 838
 839     function __construct($leaves)
 840     {
 841         $this->leaves = $leaves;
 842     }
 843
 844     protected function flatten()
 845     {
 846         // This flattens e.g. (AND (AND a b) (OR c d) e)
 847         //        to (AND a b e (OR c d))
 848         $flat = array();
 849         foreach ($this->leaves as $leaf) {
 850             $leaf = $leaf->optimize();
 851             if ($this->op == $leaf->op)
 852                 $flat = array_merge($flat, $leaf->leaves);
 853             else
 854                 $flat[] = $leaf;
 855         }
 856         $this->leaves = $flat;
 857     }
 858
 859     function optimize()
 860     {
 861         $this->flatten();
 862         assert(!empty($this->leaves));
 863         if (count($this->leaves) == 1)
 864             return $this->leaves[0]; // (AND x) -> x
 865         return $this;
 866     }
 867
 868     function highlight_words($negated = false)
 869     {
 870         $words = array();
 871         foreach ($this->leaves as $leaf)
 872             array_splice($words, 0, 0,
 873                 $leaf->highlight_words($negated));
 874         return $words;
 875     }
 876 }
 877
 878 /**
 879  * A (possibly multi-argument) 'AND' conjoin.
 880  */
 881 class TextSearchQuery_node_and
 882     extends TextSearchQuery_node_binop
 883 {
 884     public $op = "AND";
 885
 886     function optimize()
 887     {
 888         $this->flatten();
 889
 890         // Convert (AND (NOT a) (NOT b) c d) into (AND (NOT (OR a b)) c d).
 891         // Since OR's are more efficient for regexp matching:
 892         //   (?!.*a)(?!.*b)  vs   (?!.*(?:a|b))
 893
 894         // Suck out the negated leaves.
 895         $nots = array();
 896         foreach ($this->leaves as $key => $leaf) {
 897             if ($leaf->_op == TSQ_TOK_NOT) {
 898                 $nots[] = $leaf->leaves[0];
 899                 unset($this->leaves[$key]);
 900             }
 901         }
 902
 903         // Combine the negated leaves into a single negated or.
 904         if ($nots) {
 905             $node = (new TextSearchQuery_node_not
 906             (new TextSearchQuery_node_or($nots)));
 907             array_unshift($this->leaves, $node->optimize());
 908         }
 909
 910         assert(!empty($this->leaves));
 911         if (count($this->leaves) == 1)
 912             return $this->leaves[0]; // (AND x) -> x
 913         return $this;
 914     }
 915
 916     /* FIXME!
 917      * Either we need all combinations of all words to be position independent,
 918      * or we have to use multiple match calls for each AND
 919      * (AND x y) => /(?(:x)(:y))|(?(:y)(:x))/
 920      */
 921     function regexp()
 922     {
 923         $regexp = '';
 924         foreach ($this->leaves as $leaf)
 925             $regexp .= $leaf->regexp();
 926         return $regexp;
 927     }
 928 }
 929
 930 /**
 931  * A (possibly multi-argument) 'OR' conjoin.
 932  */
 933 class TextSearchQuery_node_or
 934     extends TextSearchQuery_node_binop
 935 {
 936     public $op = "OR";
 937
 938     function regexp()
 939     {
 940         // We will combine any of our direct descendents which are WORDs
 941         // into a single (?=.*(?:word1|word2|...)) regexp.
 942
 943         $regexps = array();
 944         $words = array();
 945
 946         foreach ($this->leaves as $leaf) {
 947             if ($leaf->op == TSQ_TOK_WORD)
 948                 $words[] = preg_quote($leaf->word, '/');
 949             else
 950                 $regexps[] = $leaf->regexp();
 951         }
 952
 953         if ($words)
 954             array_unshift($regexps,
 955                 '(?=.*' . $this->join($words) . ')');
 956
 957         return $this->join($regexps);
 958     }
 959
 960     private function join($regexps)
 961     {
 962         assert(count($regexps) > 0);
 963
 964         if (count($regexps) > 1)
 965             return '(?:' . join('|', $regexps) . ')';
 966         else
 967             return $regexps[0];
 968     }
 969 }
 970
 971 ////////////////////////////////////////////////////////////////
 972 //
 973 // Parser:
 974 //   op's (and, or, not) are forced to lowercase in the tokenizer.
 975 //
 976 ////////////////////////////////////////////////////////////////
 977 class TextSearchQuery_Parser
 978 {
 979     /*
 980      * This is a simple recursive descent parser, based on the following grammar:
 981      *
 982      * toplist    :
 983      *        | toplist expr
 984      *        ;
 985      *
 986      *
 987      * list    : expr
 988      *        | list expr
 989      *        ;
 990      *
 991      * expr    : atom
 992      *        | expr BINOP atom
 993      *        ;
 994      *
 995      * atom    : '(' list ')'
 996      *        | NOT atom
 997      *        | WORD
 998      *        ;
 999      *
1000      * The terminal tokens are:
1001      *
1002      *
1003      * and|or          BINOP
1004      * -|not          NOT
1005      * (          LPAREN
1006      * )          RPAREN
1007      * /[^-()\s][^()\s]*  WORD
1008      * /"[^"]*"/      WORD
1009      * /'[^']*'/      WORD
1010      *
1011      * ^WORD              TextSearchQuery_phrase_starts_with
1012      * WORD*              STARTS_WITH
1013      * *WORD              ENDS_WITH
1014      * ^WORD$             EXACT
1015      * *                  ALL
1016      */
1017
1018     public $lexer;
1019     private $regex;
1020
1021     function parse($search_expr, $case_exact = false, $regex = TSQ_REGEX_AUTO)
1022     {
1023         $this->lexer = new TextSearchQuery_Lexer($search_expr, $case_exact, $regex);
1024         $this->regex = $regex;
1025         $tree = $this->get_list('toplevel');
1026         // Assert failure when using the following URL in debug mode.
1027         // /TitleSearch?action=FullTextSearch&s=WFXSSProbe'")/>&case_exact=1&regex=sql
1028         //        assert($this->lexer->eof());
1029         unset($this->lexer);
1030         return $tree;
1031     }
1032
1033     function get_list($is_toplevel = false)
1034     {
1035         $list = array();
1036
1037         // token types we'll accept as words (and thus expr's) for the
1038         // purpose of error recovery:
1039         $accept_as_words = TSQ_TOK_NOT | TSQ_TOK_BINOP;
1040         if ($is_toplevel)
1041             $accept_as_words |= TSQ_TOK_LPAREN | TSQ_TOK_RPAREN;
1042
1043         while (($expr = $this->get_expr())
1044             || ($expr = $this->get_word($accept_as_words))) {
1045             $list[] = $expr;
1046         }
1047
1048         if (!$list) {
1049             if ($is_toplevel)
1050                 return new TextSearchQuery_node;
1051             else
1052                 return false;
1053         }
1054         if ($is_toplevel and count($list) == 1) {
1055             if ($this->lexer->query_str[0] == '^')
1056                 return new TextSearchQuery_phrase_starts_with($list[0]->word);
1057             else
1058                 return $list[0];
1059         }
1060         return new TextSearchQuery_node_and($list);
1061     }
1062
1063     function get_expr()
1064     {
1065         if (($expr = $this->get_atom()) === false) // protect against '0'
1066             return false;
1067
1068         $savedpos = $this->lexer->tell();
1069         // Bug#1791564: allow string '0'
1070         while (($op = $this->lexer->get(TSQ_TOK_BINOP)) !== false) {
1071             if (!($right = $this->get_atom())) {
1072                 break;
1073             }
1074
1075             if ($op == 'and')
1076                 $expr = new TextSearchQuery_node_and(array($expr, $right));
1077             else {
1078                 assert($op == 'or');
1079                 $expr = new TextSearchQuery_node_or(array($expr, $right));
1080             }
1081
1082             $savedpos = $this->lexer->tell();
1083         }
1084         $this->lexer->seek($savedpos);
1085
1086         return $expr;
1087     }
1088
1089     function get_atom()
1090     {
1091         if ($atom = $this->get_word(TSQ_ALLWORDS)) // Bug#1791564 not involved: '*'
1092             return $atom;
1093
1094         $savedpos = $this->lexer->tell();
1095         if ($this->lexer->get(TSQ_TOK_LPAREN)) {
1096             if (($list = $this->get_list()) && $this->lexer->get(TSQ_TOK_RPAREN)) {
1097                 return $list;
1098             } else {
1099                 // Fix Bug#1792170
1100                 // Handle " ( " or "(test" without closing ")" as plain word
1101                 $this->lexer->seek($savedpos);
1102                 return new TextSearchQuery_node_word($this->lexer->get(-1));
1103             }
1104         } elseif ($this->lexer->get(TSQ_TOK_NOT)) {
1105             if (($atom = $this->get_atom()))
1106                 return new TextSearchQuery_node_not($atom);
1107         }
1108         $this->lexer->seek($savedpos);
1109         return false;
1110     }
1111
1112     function get_word($accept = TSQ_ALLWORDS)
1113     {
1114         // Performance shortcut for ( and ). This is always false
1115         if (!empty($this->lexer->tokens[$this->lexer->pos])) {
1116             list ($type, $val) = $this->lexer->tokens[$this->lexer->pos];
1117             if ($type == TSQ_TOK_LPAREN or $type == TSQ_TOK_RPAREN)
1118                 return false;
1119         }
1120         foreach (array("WORD", "STARTS_WITH", "ENDS_WITH", "EXACT",
1121                      "REGEX", "REGEX_GLOB", "REGEX_PCRE", "ALL") as $tok) {
1122             $const = constant("TSQ_TOK_" . $tok);
1123             // Bug#1791564: allow word '0'
1124             if ($accept & $const and
1125                 (($word = $this->lexer->get($const)) !== false)
1126             ) {
1127                 // phrase or word level?
1128                 if ($tok == 'STARTS_WITH' and $this->lexer->query_str[0] == '^')
1129                     $classname = "TextSearchQuery_phrase_" . strtolower($tok);
1130                 elseif ($tok == 'ENDS_WITH' and
1131                     string_ends_with($this->lexer->query_str, '$')
1132                 )
1133                     $classname = "TextSearchQuery_phrase_" . strtolower($tok); else
1134                     $classname = "TextSearchQuery_node_" . strtolower($tok);
1135                 return new $classname($word);
1136             }
1137         }
1138         return false;
1139     }
1140 }
1141
1142 class TextSearchQuery_Lexer
1143 {
1144     function TextSearchQuery_Lexer($query_str, $case_exact = false,
1145                                    $regex = TSQ_REGEX_AUTO)
1146     {
1147         $this->tokens = $this->tokenize($query_str, $case_exact, $regex);
1148         $this->query_str = $query_str;
1149         $this->pos = 0;
1150     }
1151
1152     function tell()
1153     {
1154         return $this->pos;
1155     }
1156
1157     function seek($pos)
1158     {
1159         $this->pos = $pos;
1160     }
1161
1162     function eof()
1163     {
1164         return $this->pos == count($this->tokens);
1165     }
1166
1167     /**
1168      * TODO: support more regex styles, esp. prefer the forced ones over auto
1169      * re: and // stuff
1170      */
1171     function tokenize($string, $case_exact = false, $regex = TSQ_REGEX_AUTO)
1172     {
1173         $tokens = array();
1174         $buf = $case_exact ? ltrim($string) : strtolower(ltrim($string));
1175         while (!empty($buf)) {
1176             if (preg_match('/^([()])\s*/', $buf, $m)) {
1177                 $val = $m[1];
1178                 $type = $m[1] == '(' ? TSQ_TOK_LPAREN : TSQ_TOK_RPAREN;
1179             } // * => ALL
1180             elseif ($regex & (TSQ_REGEX_AUTO | TSQ_REGEX_POSIX | TSQ_REGEX_GLOB)
1181                 and preg_match('/^\*\s*/', $buf, $m)
1182             ) {
1183                 $val = "*";
1184                 $type = TSQ_TOK_ALL;
1185             } // .* => ALL
1186             elseif ($regex & (TSQ_REGEX_PCRE)
1187                 and preg_match('/^\.\*\s*/', $buf, $m)
1188             ) {
1189                 $val = ".*";
1190                 $type = TSQ_TOK_ALL;
1191             } // % => ALL
1192             elseif ($regex & (TSQ_REGEX_SQL)
1193                 and preg_match('/^%\s*/', $buf, $m)
1194             ) {
1195                 $val = "%";
1196                 $type = TSQ_TOK_ALL;
1197             } // ^word
1198             elseif ($regex & (TSQ_REGEX_AUTO | TSQ_REGEX_POSIX | TSQ_REGEX_PCRE)
1199                 and preg_match('/^\^([^-()][^()\s]*)\s*/', $buf, $m)
1200             ) {
1201                 $val = $m[1];
1202                 $type = TSQ_TOK_STARTS_WITH;
1203             } // word*
1204             elseif ($regex & (TSQ_REGEX_AUTO | TSQ_REGEX_POSIX | TSQ_REGEX_GLOB)
1205                 and preg_match('/^([^-()][^()\s]*)\*\s*/', $buf, $m)
1206             ) {
1207                 $val = $m[1];
1208                 $type = TSQ_TOK_STARTS_WITH;
1209             } // *word
1210             elseif ($regex & (TSQ_REGEX_AUTO | TSQ_REGEX_POSIX | TSQ_REGEX_GLOB)
1211                 and preg_match('/^\*([^-()][^()\s]*)\s*/', $buf, $m)
1212             ) {
1213                 $val = $m[1];
1214                 $type = TSQ_TOK_ENDS_WITH;
1215             } // word$
1216             elseif ($regex & (TSQ_REGEX_AUTO | TSQ_REGEX_POSIX | TSQ_REGEX_PCRE)
1217                 and preg_match('/^([^-()][^()\s]*)\$\s*/', $buf, $m)
1218             ) {
1219                 $val = $m[1];
1220                 $type = TSQ_TOK_ENDS_WITH;
1221             } // ^word$
1222             elseif ($regex & (TSQ_REGEX_AUTO | TSQ_REGEX_POSIX | TSQ_REGEX_PCRE)
1223                 and preg_match('/^\^([^-()][^()\s]*)\$\s*/', $buf, $m)
1224             ) {
1225                 $val = $m[1];
1226                 $type = TSQ_TOK_EXACT;
1227             } elseif (preg_match('/^(and|or)\b\s*/i', $buf, $m)) {
1228                 $val = strtolower($m[1]);
1229                 $type = TSQ_TOK_BINOP;
1230             } elseif (preg_match('/^(-|not\b)\s*/i', $buf, $m)) {
1231                 $val = strtolower($m[1]);
1232                 $type = TSQ_TOK_NOT;
1233             } // "words "
1234             elseif (preg_match('/^ " ( (?: [^"]+ | "" )* ) " \s*/x', $buf, $m)) {
1235                 $val = str_replace('""', '"', $m[1]);
1236                 $type = TSQ_TOK_WORD;
1237             } // 'words '
1238             elseif (preg_match("/^ ' ( (?:[^']+|'')* ) ' \s*/x", $buf, $m)) {
1239                 $val = str_replace("''", "'", $m[1]);
1240                 $type = TSQ_TOK_WORD;
1241             } // word
1242             elseif (preg_match('/^([^-()][^()\s]*)\s*/', $buf, $m)) {
1243                 $val = $m[1];
1244                 $type = TSQ_TOK_WORD;
1245             } else {
1246                 assert(empty($buf));
1247                 break;
1248             }
1249             $buf = substr($buf, strlen($m[0]));
1250
1251             /* refine the simple parsing from above: bla*bla, bla?bla, ...
1252             if ($regex and $type == TSQ_TOK_WORD) {
1253                 if (substr($val,0,1) == "^")
1254                     $type = TSQ_TOK_STARTS_WITH;
1255                 elseif (substr($val,0,1) == "*")
1256                     $type = TSQ_TOK_ENDS_WITH;
1257                 elseif (substr($val,-1,1) == "*")
1258                     $type = TSQ_TOK_STARTS_WITH;
1259             }
1260             */
1261             $tokens[] = array($type, $val);
1262         }
1263         return $tokens;
1264     }
1265
1266     function get($accept)
1267     {
1268         if ($this->pos >= count($this->tokens))
1269             return false;
1270
1271         list ($type, $val) = $this->tokens[$this->pos];
1272         if (($type & $accept) == 0)
1273             return false;
1274
1275         $this->pos++;
1276         return $val;
1277     }
1278 }
1279
1280 // Local Variables:
1281 // mode: php
1282 // tab-width: 8
1283 // c-basic-offset: 4
1284 // c-hanging-comment-ender-p: nil
1285 // indent-tabs-mode: nil
1286 // End: