lib/TextSearchQuery.php

   1 <?php rcs_id('$Id: TextSearchQuery.php,v 1.20 2005-09-11 14:55:05 rurban Exp $');
   2 /**
   3  * A text search query, converting queries to PCRE and SQL matchers.
   4  *
   5  * This represents an enhanced "Google-like" text search query:
   6  * <dl>
   7  * <dt> default: case-insensitive glob-style search with special operators OR AND NOT -
   8  * <dt> wiki -test
   9  *   <dd> Match strings containing the substring 'wiki', and NOT containing the
  10  *        substring 'test'.
  11  * <dt> wiki word or page
  12  *   <dd> Match strings containing the substring 'wiki' AND either the substring
  13  *        'word' OR the substring 'page'.
  14  * <dt> auto-detect regex hints, glob-style or regex-style, and converts them
  15  *      to PCRE and SQL matchers:
  16  *   <dd> "^word$" => EXACT(word)
  17  *   <dd> "^word"  => STARTS_WITH(word)
  18  *   <dd> "word*"  => STARTS_WITH(word)
  19  *   <dd> "*word"  => ENDS_WITH(word)
  20  *   <dd> "/^word.* /" => REGEX(^word.*)
  21  *   <dd> "word*word" => REGEX(word.*word)
  22  * </dl>
  23  *
  24  * The full query syntax, in order of precedence, is roughly:
  25  *
  26  * The unary 'NOT' or '-' operator (they are equivalent) negates the
  27  * following search clause.
  28  *
  29  * Search clauses may be joined with the (left-associative) binary operators
  30  * 'AND' and 'OR'. (case-insensitive)
  31  *
  32  * Two adjoining search clauses are joined with an implicit 'AND'.  This has
  33  * lower precedence than either an explicit 'AND' or 'OR', so "a b OR c"
  34  * parses as "a AND ( b OR c )", while "a AND b OR c" parses as
  35  * "( a AND b ) OR c" (due to the left-associativity of 'AND' and 'OR'.)
  36  *
  37  * Search clauses can be grouped with parentheses.
  38  *
  39  * Phrases (or other things which don't look like words) can be forced to
  40  * be interpreted as words by quoting them, either with single (') or double (")
  41  * quotes.  If you wan't to include the quote character within a quoted string,
  42  * double-up on the quote character: 'I''m hungry' is equivalent to
  43  * "I'm hungry".
  44  *
  45  * Force regex on "re:word" => posix-style, "/word/" => pcre-style
  46  * or use regex='glob' to use file wildcard-like matching. (not yet)
  47  *
  48  * The parsed tree is then converted to the needed PCRE (highlight,
  49  * simple backends) or SQL functions.
  50  *
  51  * @author: Jeff Dairiki
  52  * @author: Reini Urban (case and regex detection, enhanced sql callbacks)
  53  */
  54
  55 // regex-style: 'auto', 'none', 'glob', 'posix', 'pcre', 'sql'
  56 define ('TSQ_REGEX_NONE', 0);
  57 define ('TSQ_REGEX_AUTO', 1);
  58 define ('TSQ_REGEX_POSIX', 2);
  59 define ('TSQ_REGEX_GLOB', 4);
  60 define ('TSQ_REGEX_PCRE', 8);
  61 define ('TSQ_REGEX_SQL', 16);
  62
  63 class TextSearchQuery {
  64     /**
  65      * Create a new query.
  66      *
  67      * @param $search_query string The query.  Syntax is as described above.
  68      * Note that an empty $search_query will match anything.
  69      * @param $case_exact boolean
  70      * @param $regex string one of 'auto', 'none', 'glob', 'posix', 'pcre', 'sql'
  71      * @see TextSearchQuery
  72      */
  73     function TextSearchQuery($search_query, $case_exact=false, $regex='auto') {
  74         if ($regex == 'none' or !$regex)
  75             $this->_regex = 0;
  76         elseif (defined("TSQ_REGEX_".strtoupper($regex)))
  77             $this->_regex = constant("TSQ_REGEX_".strtoupper($regex));
  78         else {
  79             trigger_error(fmt("Unsupported argument: %s=%s", 'regex', $regex));
  80             $this->_regex = 0;
  81         }
  82         $this->_case_exact = $case_exact;
  83         $parser = new TextSearchQuery_Parser;
  84         $this->_tree = $parser->parse($search_query, $case_exact, $this->_regex);
  85         //$this->_optimize(); // broken under certain circumstances: "word -word -word"
  86         $this->_stoplist = '(A|An|And|But|By|For|From|In|Is|It|Of|On|Or|The|To|With)';
  87     }
  88
  89     function _optimize() {
  90         $this->_tree = $this->_tree->optimize();
  91     }
  92
  93     /**
  94      * Get a PCRE regexp which matches the query.
  95      */
  96     function asRegexp() {
  97         if (!isset($this->_regexp)) {
  98             if ($this->_regex)
  99                 $this->_regexp =  '/' . $this->_tree->regexp() . '/'.($this->_case_exact?'':'i').'sS';
 100             else
 101                 $this->_regexp =  '/^' . $this->_tree->regexp() . '/'.($this->_case_exact?'':'i').'sS';
 102         }
 103         return $this->_regexp;
 104     }
 105
 106     /**
 107      * Match query against string.
 108      *
 109      * @param $string string The string to match.
 110      * @return boolean True if the string matches the query.
 111      */
 112     function match($string) {
 113         return preg_match($this->asRegexp(), $string);
 114     }
 115
 116
 117     /**
 118      * Get a regular expression suitable for highlighting matched words.
 119      *
 120      * This returns a PCRE regular expression which matches any non-negated
 121      * word in the query.
 122      *
 123      * @return string The PCRE regexp.
 124      */
 125     function getHighlightRegexp() {
 126         if (!isset($this->_hilight_regexp)) {
 127             $words = array_unique($this->_tree->highlight_words());
 128             if (!$words) {
 129                 $this->_hilight_regexp = false;
 130             } else {
 131                 foreach ($words as $key => $word)
 132                     $words[$key] = preg_quote($word, '/');
 133                 $this->_hilight_regexp = '(?:' . join('|', $words) . ')';
 134             }
 135         }
 136         return $this->_hilight_regexp;
 137     }
 138
 139     /**
 140      * Make an SQL clause which matches the query. (deprecated, use makeSqlClause instead)
 141      *
 142      * @param $make_sql_clause_cb WikiCallback
 143      * A callback which takes a single word as an argument and
 144      * returns an SQL clause which will match exactly those records
 145      * containing the word.  The word passed to the callback will always
 146      * be in all lower case.
 147      *
 148      * TODO: support db-specific extensions, like MATCH AGAINST or REGEX
 149      *       mysql => 4.0.1 can also do Google: MATCH AGAINST IN BOOLEAN MODE
 150      *       How? WikiDB backend method?
 151      *
 152      * Old example usage:
 153      * <pre>
 154      *     function sql_title_match($word) {
 155      *         return sprintf("LOWER(title) like '%s'",
 156      *                        addslashes($word));
 157      *     }
 158      *
 159      *     ...
 160      *
 161      *     $query = new TextSearchQuery("wiki -page");
 162      *     $cb = new WikiFunctionCb('sql_title_match');
 163      *     $sql_clause = $query->makeSqlClause($cb);
 164      * </pre>
 165      * This will result in $sql_clause containing something like
 166      * "(LOWER(title) like 'wiki') AND NOT (LOWER(title) like 'page')".
 167      *
 168      * @return string The SQL clause.
 169      */
 170     function makeSqlClause($sql_clause_cb) {
 171         $this->_sql_clause_cb = $sql_clause_cb;
 172         return $this->_sql_clause($this->_tree);
 173     }
 174     // deprecated: use _sql_clause_obj now.
 175     function _sql_clause($node) {
 176         switch ($node->op) {
 177         case 'WORD':        // word => %word%
 178             return $this->_sql_clause_cb->call($node->word);
 179         case 'NOT':
 180             return "NOT (" . $this->_sql_clause($node->leaves[0]) . ")";
 181         case 'AND':
 182         case 'OR':
 183             $subclauses = array();
 184             foreach ($node->leaves as $leaf)
 185                 $subclauses[] = "(" . $this->_sql_clause($leaf) . ")";
 186             return join(" $node->op ", $subclauses);
 187         default:
 188             assert($node->op == VOID);
 189             return '1=1';
 190         }
 191     }
 192
 193     /** Get away with the callback and use a db-specific search class instead.
 194      * @see WikiDB_backend_PearDB_search
 195      */
 196     function makeSqlClauseObj(&$sql_search_cb) {
 197         $this->_sql_clause_cb = $sql_search_cb;
 198         return $this->_sql_clause_obj($this->_tree);
 199     }
 200
 201     function _sql_clause_obj($node) {
 202         switch ($node->op) {
 203         case 'NOT':
 204             return "NOT (" . $this->_sql_clause_cb->call($node->leaves[0]) . ")";
 205         case 'AND':
 206         case 'OR':
 207             $subclauses = array();
 208             foreach ($node->leaves as $leaf)
 209                 $subclauses[] = "(" . $this->_sql_clause_obj($leaf) . ")";
 210             return join(" $node->op ", $subclauses);
 211         case 'VOID':
 212             return '1=1';
 213         default:
 214             return $this->_sql_clause_cb->call($node);
 215         }
 216     }
 217
 218     function sql() { return '%'.$this->_sql_quote($this->word).'%'; }
 219
 220     /**
 221      * Get printable representation of the parse tree.
 222      *
 223      * This is for debugging only.
 224      * @return string Printable parse tree.
 225      */
 226     function asString() {
 227         return $this->_as_string($this->_tree);
 228     }
 229
 230     function _as_string($node, $indent = '') {
 231         switch ($node->op) {
 232         case 'WORD':
 233             return $indent . "WORD: $node->word";
 234         case 'VOID':
 235             return $indent . "VOID";
 236         default:
 237             $lines = array($indent . $node->op . ":");
 238             $indent .= "  ";
 239             foreach ($node->leaves as $leaf)
 240                 $lines[] = $this->_as_string($leaf, $indent);
 241             return join("\n", $lines);
 242         }
 243     }
 244 }
 245
 246 /**
 247  * This is a TextSearchQuery which matches nothing.
 248  */
 249 class NullTextSearchQuery extends TextSearchQuery {
 250     /**
 251      * Create a new query.
 252      *
 253      * @see TextSearchQuery
 254      */
 255     function NullTextSearchQuery() {}
 256     function asRegexp()         { return '/^(?!a)a/x'; }
 257     function match($string)     { return false; }
 258     function getHighlightRegexp() { return ""; }
 259     function makeSqlClause($make_sql_clause_cb) { return "(1 = 0)"; }
 260     function asString() { return "NullTextSearchQuery"; }
 261 };
 262
 263
 264 ////////////////////////////////////////////////////////////////
 265 //
 266 // Remaining classes are private.
 267 //
 268 ////////////////////////////////////////////////////////////////
 269 /**
 270  * Virtual base class for nodes in a TextSearchQuery parse tree.
 271  *
 272  * Also servers as a 'VOID' (contentless) node.
 273  */
 274 class TextSearchQuery_node
 275 {
 276     var $op = 'VOID';
 277
 278     /**
 279      * Optimize this node.
 280      * @return object Optimized node.
 281      */
 282     function optimize() {
 283         return $this;
 284     }
 285
 286     /**
 287      * @return regexp matching this node.
 288      */
 289     function regexp() {
 290         return '';
 291     }
 292
 293     /**
 294      * @param bool True if this node has been negated (higher in the parse tree.)
 295      * @return array A list of all non-negated words contained by this node.
 296      */
 297     function highlight_words($negated = false) {
 298         return array();
 299     }
 300
 301     function sql()    { return $this->word; }
 302 }
 303
 304 /**
 305  * A word.
 306  */
 307 class TextSearchQuery_node_word
 308 extends TextSearchQuery_node
 309 {
 310     var $op = "WORD";
 311
 312     function TextSearchQuery_node_word($word) {
 313         $this->word = $word;
 314     }
 315     function regexp() {
 316         return '(?=.*' . preg_quote($this->word, '/') . ')';
 317     }
 318     function highlight_words($negated = false) {
 319         return $negated ? array() : array($this->word);
 320     }
 321     function _sql_quote() {
 322         $word = preg_replace('/(?=[%_\\\\])/', "\\", $this->word);
 323         return $GLOBALS['request']->_dbi->qstr($word);
 324     }
 325     function sql()    { return '%'.$this->_sql_quote($this->word).'%'; }
 326 }
 327
 328 class TextSearchQuery_node_starts_with
 329 extends TextSearchQuery_node_word {
 330     var $op = "STARTS_WITH";
 331     function regexp() { return '(?=.*\b' . preg_quote($this->word, '/') . ')'; }
 332     function sql()    { return $this->_sql_quote($this->word).'%'; }
 333 }
 334
 335 class TextSearchQuery_node_ends_with
 336 extends TextSearchQuery_node_word {
 337     var $op = "ENDS_WITH";
 338     function regexp() { return '(?=.*' . preg_quote($this->word, '/') . '\b)'; }
 339     function sql()    { return '%'.$this->_sql_quote($this->word); }
 340 }
 341
 342 class TextSearchQuery_node_exact
 343 extends TextSearchQuery_node_word {
 344     var $op = "EXACT";
 345     function regexp() { return '(?=\b' . preg_quote($this->word, '/') . '\b)'; }
 346     function sql()    { return $this->_sql_squote($this->word); }
 347 }
 348
 349 class TextSearchQuery_node_regex // posix regex. FIXME!
 350 extends TextSearchQuery_node_word {
 351     var $op = "REGEX"; // using REGEXP or ~ extension
 352     function regexp() { return '(?=.*\b' . $this->word . '\b)'; }
 353     function sql()    { return $this->_sql_quote($this->word); }
 354 }
 355
 356 class TextSearchQuery_node_regex_glob
 357 extends TextSearchQuery_node_regex {
 358     var $op = "REGEX_GLOB";
 359     function regexp() { return '(?=.*\b' . glob_to_pcre($this->word) . '\b)'; }
 360 }
 361
 362 class TextSearchQuery_node_regex_pcre // how to handle pcre modifiers? /i
 363 extends TextSearchQuery_node_regex {
 364     var $op = "REGEX_PCRE";
 365     function regexp() { return $this->word; }
 366 }
 367
 368 class TextSearchQuery_node_regex_sql
 369 extends TextSearchQuery_node_regex {
 370     var $op = "REGEX_SQL"; // using LIKE
 371     function regexp() { return str_replace(array("/%/","/_/"), array(".*","."), $this->word); }
 372     function sql()    { return $this->word; }
 373 }
 374
 375 /**
 376  * A negated clause.
 377  */
 378 class TextSearchQuery_node_not
 379 extends TextSearchQuery_node
 380 {
 381     var $op = "NOT";
 382
 383     function TextSearchQuery_node_not($leaf) {
 384         $this->leaves = array($leaf);
 385     }
 386
 387     function optimize() {
 388         $leaf = &$this->leaves[0];
 389         $leaf = $leaf->optimize();
 390         if ($leaf->op == 'NOT')
 391             return $leaf->leaves[0]; // ( NOT ( NOT x ) ) -> x
 392         return $this;
 393     }
 394
 395     function regexp() {
 396         $leaf = &$this->leaves[0];
 397         return '(?!' . $leaf->regexp() . ')';
 398     }
 399
 400     function highlight_words($negated = false) {
 401         return $this->leaves[0]->highlight_words(!$negated);
 402     }
 403 }
 404
 405 /**
 406  * Virtual base class for 'AND' and 'OR conjoins.
 407  */
 408 class TextSearchQuery_node_binop
 409 extends TextSearchQuery_node
 410 {
 411     function TextSearchQuery_node_binop($leaves) {
 412         $this->leaves = $leaves;
 413     }
 414
 415     function _flatten() {
 416         // This flattens e.g. (AND (AND a b) (OR c d) e)
 417         //        to (AND a b e (OR c d))
 418         $flat = array();
 419         foreach ($this->leaves as $leaf) {
 420             $leaf = $leaf->optimize();
 421             if ($this->op == $leaf->op)
 422                 $flat = array_merge($flat, $leaf->leaves);
 423             else
 424                 $flat[] = $leaf;
 425         }
 426         $this->leaves = $flat;
 427     }
 428
 429     function optimize() {
 430         $this->_flatten();
 431         assert(!empty($this->leaves));
 432         if (count($this->leaves) == 1)
 433             return $this->leaves[0]; // (AND x) -> x
 434         return $this;
 435     }
 436
 437     function highlight_words($negated = false) {
 438         $words = array();
 439         foreach ($this->leaves as $leaf)
 440             array_splice($words,0,0,
 441                          $leaf->highlight_words($negated));
 442         return $words;
 443     }
 444 }
 445
 446 /**
 447  * A (possibly multi-argument) 'AND' conjoin.
 448  */
 449 class TextSearchQuery_node_and
 450 extends TextSearchQuery_node_binop
 451 {
 452     var $op = "AND";
 453
 454     function optimize() {
 455         $this->_flatten();
 456
 457         // Convert (AND (NOT a) (NOT b) c d) into (AND (NOT (OR a b)) c d).
 458         // Since OR's are more efficient for regexp matching:
 459         //   (?!.*a)(?!.*b)  vs   (?!.*(?:a|b))
 460
 461         // Suck out the negated leaves.
 462         $nots = array();
 463         foreach ($this->leaves as $key => $leaf) {
 464             if ($leaf->op == 'NOT') {
 465                 $nots[] = $leaf->leaves[0];
 466                 unset($this->leaves[$key]);
 467             }
 468         }
 469
 470         // Combine the negated leaves into a single negated or.
 471         if ($nots) {
 472             $node = ( new TextSearchQuery_node_not
 473                       (new TextSearchQuery_node_or($nots)) );
 474             array_unshift($this->leaves, $node->optimize());
 475         }
 476
 477         assert(!empty($this->leaves));
 478         if (count($this->leaves) == 1)
 479             return $this->leaves[0];  // (AND x) -> x
 480         return $this;
 481     }
 482
 483     /* FIXME!
 484      * Either we need all combinations of all words to be position independent,
 485      * or we have to use multiple match calls for each AND
 486      * (AND x y) => /(?(:x)(:y))|(?(:y)(:x))/
 487      */
 488     function regexp() {
 489         $regexp = '';
 490         foreach ($this->leaves as $leaf)
 491             $regexp .= $leaf->regexp();
 492         return $regexp;
 493     }
 494 }
 495
 496 /**
 497  * A (possibly multi-argument) 'OR' conjoin.
 498  */
 499 class TextSearchQuery_node_or
 500 extends TextSearchQuery_node_binop
 501 {
 502     var $op = "OR";
 503
 504     function regexp() {
 505         // We will combine any of our direct descendents which are WORDs
 506         // into a single (?=.*(?:word1|word2|...)) regexp.
 507
 508         $regexps = array();
 509         $words = array();
 510
 511         foreach ($this->leaves as $leaf) {
 512             if ($leaf->op == 'WORD')
 513                 $words[] = preg_quote($leaf->word, '/');
 514             else
 515                 $regexps[] = $leaf->regexp();
 516         }
 517
 518         if ($words)
 519             array_unshift($regexps,
 520                           '(?=.*' . $this->_join($words) . ')');
 521
 522         return $this->_join($regexps);
 523     }
 524
 525     function _join($regexps) {
 526         assert(count($regexps) > 0);
 527
 528         if (count($regexps) > 1)
 529             return '(?:' . join('|', $regexps) . ')';
 530         else
 531             return $regexps[0];
 532     }
 533 }
 534
 535
 536 ////////////////////////////////////////////////////////////////
 537 //
 538 // Parser:
 539 //   op's (and, or, not) are forced to lowercase in the tokenizer.
 540 //
 541 ////////////////////////////////////////////////////////////////
 542 define ('TSQ_TOK_BINOP',  1);
 543 define ('TSQ_TOK_NOT',    2);
 544 define ('TSQ_TOK_LPAREN', 4);
 545 define ('TSQ_TOK_RPAREN', 8);
 546 define ('TSQ_TOK_WORD',   16);
 547 define ('TSQ_TOK_STARTS_WITH', 32);
 548 define ('TSQ_TOK_ENDS_WITH', 64);
 549 define ('TSQ_TOK_EXACT', 128);
 550 define ('TSQ_TOK_REGEX', 256);
 551 define ('TSQ_TOK_REGEX_GLOB', 512);
 552 define ('TSQ_TOK_REGEX_PCRE', 1024);
 553 define ('TSQ_TOK_REGEX_SQL', 2048);
 554 // all bits from word to the last.
 555 define ('TSQ_ALLWORDS', (2048*2)-1 - (16-1));
 556
 557 class TextSearchQuery_Parser
 558 {
 559     /*
 560      * This is a simple recursive descent parser, based on the following grammar:
 561      *
 562      * toplist  :
 563      *          | toplist expr
 564      *          ;
 565      *
 566      *
 567      * list     : expr
 568      *          | list expr
 569      *          ;
 570      *
 571      * expr     : atom
 572      *          | expr BINOP atom
 573      *          ;
 574      *
 575      * atom     : '(' list ')'
 576      *          | NOT atom
 577      *          | WORD
 578      *          ;
 579      *
 580      * The terminal tokens are:
 581      *
 582      *
 583      * and|or             BINOP
 584      * -|not              NOT
 585      * (                  LPAREN
 586      * )                  RPAREN
 587      * /[^-()\s][^()\s]*  WORD
 588      * /"[^"]*"/          WORD
 589      * /'[^']*'/          WORD
 590      *
 591      * ^WORD              STARTS_WITH
 592      * WORD*              STARTS_WITH
 593      * *WORD              ENDS_WITH
 594      * ^WORD$             EXACT
 595      */
 596
 597     function parse ($search_expr, $case_exact=false, $regex=TSQ_REGEX_AUTO) {
 598         $this->lexer = new TextSearchQuery_Lexer($search_expr, $case_exact, $regex);
 599         $this->_regex = $regex;
 600         $tree = $this->get_list('toplevel');
 601         assert($this->lexer->eof());
 602         unset($this->lexer);
 603         return $tree;
 604     }
 605
 606     function get_list ($is_toplevel = false) {
 607         $list = array();
 608
 609         // token types we'll accept as words (and thus expr's) for the
 610         // purpose of error recovery:
 611         $accept_as_words = TSQ_TOK_NOT | TSQ_TOK_BINOP;
 612         if ($is_toplevel)
 613             $accept_as_words |= TSQ_TOK_LPAREN | TSQ_TOK_RPAREN;
 614
 615         while ( ($expr = $this->get_expr())
 616                 || ($expr = $this->get_word($accept_as_words)) ) {
 617             $list[] = $expr;
 618         }
 619
 620         if (!$list) {
 621             if ($is_toplevel)
 622                 return new TextSearchQuery_node;
 623             else
 624                 return false;
 625         }
 626         return new TextSearchQuery_node_and($list);
 627     }
 628
 629     function get_expr () {
 630         if ( !($expr = $this->get_atom()) )
 631             return false;
 632
 633         $savedpos = $this->lexer->tell();
 634         while ( ($op = $this->lexer->get(TSQ_TOK_BINOP)) ) {
 635             if ( ! ($right = $this->get_atom()) ) {
 636                 break;
 637             }
 638
 639             if ($op == 'and')
 640                 $expr = new TextSearchQuery_node_and(array($expr, $right));
 641             else {
 642                 assert($op == 'or');
 643                 $expr = new TextSearchQuery_node_or(array($expr, $right));
 644             }
 645
 646             $savedpos = $this->lexer->tell();
 647         }
 648         $this->lexer->seek($savedpos);
 649
 650         return $expr;
 651     }
 652
 653
 654     function get_atom() {
 655         if ($word = $this->get_word(TSQ_ALLWORDS))
 656             return $word;
 657
 658         $savedpos = $this->lexer->tell();
 659         if ( $this->lexer->get(TSQ_TOK_LPAREN) ) {
 660             if ( ($list = $this->get_list()) && $this->lexer->get(TSQ_TOK_RPAREN) )
 661                 return $list;
 662         }
 663         elseif ( $this->lexer->get(TSQ_TOK_NOT) ) {
 664             if ( ($atom = $this->get_atom()) )
 665                 return new TextSearchQuery_node_not($atom);
 666         }
 667         $this->lexer->seek($savedpos);
 668         return false;
 669     }
 670
 671     function get_word($accept = TSQ_ALLWORDS) {
 672         foreach (array("WORD","STARTS_WITH","ENDS_WITH","EXACT",
 673                        "REGEX","REGEX_GLOB","REGEX_PCRE") as $tok) {
 674             $const = constant("TSQ_TOK_".$tok);
 675             if ( $accept & $const and ($word = $this->lexer->get($const)) ) {
 676                 $classname = "TextSearchQuery_node_".strtolower($tok);
 677                 return new $classname($word);
 678             }
 679         }
 680         return false;
 681     }
 682 }
 683
 684 class TextSearchQuery_Lexer {
 685     function TextSearchQuery_Lexer ($query_str, $case_exact=false, $regex=TSQ_REGEX_AUTO) {
 686         $this->tokens = $this->tokenize($query_str, $case_exact, $regex);
 687         $this->pos = 0;
 688     }
 689
 690     function tell() {
 691         return $this->pos;
 692     }
 693
 694     function seek($pos) {
 695         $this->pos = $pos;
 696     }
 697
 698     function eof() {
 699         return $this->pos == count($this->tokens);
 700     }
 701
 702     /**
 703      * TODO: support more regex styles, esp. prefer the forced ones over auto
 704      * re: and // stuff
 705      */
 706     function tokenize($string, $case_exact=false, $regex=TSQ_REGEX_AUTO) {
 707         $tokens = array();
 708         $buf = $case_exact ? ltrim($string) : strtolower(ltrim($string));
 709         while (!empty($buf)) {
 710             if (preg_match('/^(and|or)\b\s*/i', $buf, $m)) {
 711                 $val = strtolower($m[1]);
 712                 $type = TSQ_TOK_BINOP;
 713             }
 714             elseif (preg_match('/^(-|not\b)\s*/i', $buf, $m)) {
 715                 $val = strtolower($m[1]);
 716                 $type = TSQ_TOK_NOT;
 717             }
 718             elseif (preg_match('/^([()])\s*/', $buf, $m)) {
 719                 $val = $m[1];
 720                 $type = $m[1] == '(' ? TSQ_TOK_LPAREN : TSQ_TOK_RPAREN;
 721             }
 722             // ^word
 723             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_PCRE)
 724                     and preg_match('/^\^([^-()][^()\s]*)\s*/', $buf, $m)) {
 725                 $val = $m[1];
 726                 $type = TSQ_TOK_STARTS_WITH;
 727             }
 728             // word*
 729             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_GLOB)
 730                     and preg_match('/^([^-()][^()\s]*)\*\s*/', $buf, $m)) {
 731                 $val = $m[1];
 732                 $type = TSQ_TOK_STARTS_WITH;
 733             }
 734             // *word
 735             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_GLOB)
 736                     and preg_match('/^\*([^-()][^()\s]*)\s*/', $buf, $m)) {
 737                 $val = $m[1];
 738                 $type = TSQ_TOK_ENDS_WITH;
 739             }
 740             // word$
 741             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_PCRE)
 742                     and preg_match('/^([^-()][^()\s]*)\$\s*/', $buf, $m)) {
 743                 $val = $m[1];
 744                 $type = TSQ_TOK_ENDS_WITH;
 745             }
 746             // ^word$
 747             elseif ($regex & (TSQ_REGEX_AUTO|TSQ_REGEX_POSIX|TSQ_REGEX_PCRE)
 748                     and preg_match('/^\^([^-()][^()\s]*)\$\s*/', $buf, $m)) {
 749                 $val = $m[1];
 750                 $type = TSQ_TOK_EXACT;
 751             }
 752             // "words "
 753             elseif (preg_match('/^ " ( (?: [^"]+ | "" )* ) " \s*/x', $buf, $m)) {
 754                 $val = str_replace('""', '"', $m[1]);
 755                 $type = TSQ_TOK_WORD;
 756             }
 757             // 'words '
 758             elseif (preg_match("/^ ' ( (?:[^']+|'')* ) ' \s*/x", $buf, $m)) {
 759                 $val = str_replace("''", "'", $m[1]);
 760                 $type = TSQ_TOK_WORD;
 761             }
 762             // word
 763             elseif (preg_match('/^([^-()][^()\s]*)\s*/', $buf, $m)) {
 764                 $val = $m[1];
 765                 $type = TSQ_TOK_WORD;
 766             }
 767             else {
 768                 assert(empty($buf));
 769                 break;
 770             }
 771             $buf = substr($buf, strlen($m[0]));
 772
 773             /* refine the simple parsing from above: bla*bla, bla?bla, ...
 774             if ($regex and $type == TSQ_TOK_WORD) {
 775                 if (substr($val,0,1) == "^")
 776                     $type = TSQ_TOK_STARTS_WITH;
 777                 elseif (substr($val,0,1) == "*")
 778                     $type = TSQ_TOK_ENDS_WITH;
 779                 elseif (substr($val,-1,1) == "*")
 780                     $type = TSQ_TOK_STARTS_WITH;
 781             }
 782             */
 783             $tokens[] = array($type, $val);
 784         }
 785         return $tokens;
 786     }
 787
 788     function get($accept) {
 789         if ($this->pos >= count($this->tokens))
 790             return false;
 791
 792         list ($type, $val) = $this->tokens[$this->pos];
 793         if (($type & $accept) == 0)
 794             return false;
 795
 796         $this->pos++;
 797         return $val;
 798     }
 799 }
 800
 801 // Local Variables:
 802 // mode: php
 803 // tab-width: 8
 804 // c-basic-offset: 4
 805 // c-hanging-comment-ender-p: nil
 806 // indent-tabs-mode: nil
 807 // End:
 808 ?>