Initial commit
[moodle.git] / search / Zend / Search / Lucene / Search / QueryParser.php
1 <?php
2 /**
3  * Zend Framework
4  *
5  * LICENSE
6  *
7  * This source file is subject to the new BSD license that is bundled
8  * with this package in the file LICENSE.txt.
9  * It is also available through the world-wide-web at this URL:
10  * http://framework.zend.com/license/new-bsd
11  * If you did not receive a copy of the license and are unable to
12  * obtain it through the world-wide-web, please send an email
13  * to license@zend.com so we can send you a copy immediately.
14  *
15  * @category   Zend
16  * @package    Zend_Search_Lucene
17  * @subpackage Search
18  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  */
23 /** Zend_Search_Lucene_Search_QueryTokenizer */
24 require_once 'Zend/Search/Lucene/Search/QueryTokenizer.php';
26 /** Zend_Search_Lucene_Index_Term */
27 require_once 'Zend/Search/Lucene/Index/Term.php';
29 /** Zend_Search_Lucene_Search_Query_Term */
30 require_once 'Zend/Search/Lucene/Search/Query/Term.php';
32 /** Zend_Search_Lucene_Search_Query_MultiTerm */
33 require_once 'Zend/Search/Lucene/Search/Query/MultiTerm.php';
35 /** Zend_Search_Lucene_Search_Query_Phrase */
36 require_once 'Zend/Search/Lucene/Search/Query/Phrase.php';
39 /** Zend_Search_Lucene_Exception */
40 require_once 'Zend/Search/Lucene/Exception.php';
43 /**
44  * @category   Zend
45  * @package    Zend_Search_Lucene
46  * @subpackage Search
47  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
48  * @license    http://framework.zend.com/license/new-bsd     New BSD License
49  */
50 class Zend_Search_Lucene_Search_QueryParser
51 {
53     /**
54      * Parses a query string, returning a Zend_Search_Lucene_Search_Query
55      *
56      * @param string $strQuery
57      * @return Zend_Search_Lucene_Search_Query
58      */
59     static public function parse($strQuery)
60     {
61         $tokens = new Zend_Search_Lucene_Search_QueryTokenizer($strQuery);
63         // Empty query
64         if (!$tokens->count()) {
65             throw new Zend_Search_Lucene_Exception('Syntax error: query string cannot be empty.');
66         }
68         // Term query
69         if ($tokens->count() == 1) {
70             if ($tokens->current()->type == Zend_Search_Lucene_Search_QueryToken::TOKTYPE_WORD) {
71                 return new Zend_Search_Lucene_Search_Query_Term(new Zend_Search_Lucene_Index_Term($tokens->current()->text, 'contents'));
72             } else {
73                 throw new Zend_Search_Lucene_Exception('Syntax error: query string must contain at least one word.');
74             }
75         }
78         /**
79          * MultiTerm Query
80          *
81          * Process each token that was returned by the tokenizer.
82          */
83         $terms = array();
84         $signs = array();
85         $prevToken = null;
86         $openBrackets = 0;
87         $field = 'contents';
88         foreach ($tokens as $token) {
89             switch ($token->type) {
90                 case Zend_Search_Lucene_Search_QueryToken::TOKTYPE_WORD:
91                     $terms[] = new Zend_Search_Lucene_Index_Term($token->text, $field);
92                     $field = 'contents';
93                     if ($prevToken !== null &&
94                         $prevToken->type == Zend_Search_Lucene_Search_QueryToken::TOKTYPE_SIGN) {
95                             if ($prevToken->text == "+") {
96                                 $signs[] = true;
97                             } else {
98                                 $signs[] = false;
99                             }
100                     } else {
101                         $signs[] = null;
102                     }
103                     break;
104                 case Zend_Search_Lucene_Search_QueryToken::TOKTYPE_SIGN:
105                     if ($prevToken !== null &&
106                         $prevToken->type == Zend_Search_Lucene_Search_QueryToken::TOKTYPE_SIGN) {
107                             throw new Zend_Search_Lucene_Exception('Syntax error: sign operator must be followed by a word.');
108                     }
109                     break;
110                 case Zend_Search_Lucene_Search_QueryToken::TOKTYPE_FIELD:
111                     $field = $token->text;
112                     // let previous token to be signed as next $prevToken
113                     $token = $prevToken;
114                     break;
115                 case Zend_Search_Lucene_Search_QueryToken::TOKTYPE_BRACKET:
116                     $token->text=='(' ? $openBrackets++ : $openBrackets--;
117             }
118             $prevToken = $token;
119         }
121         // Finish up parsing: check the last token in the query for an opening sign or parenthesis.
122         if ($prevToken->type == Zend_Search_Lucene_Search_QueryToken::TOKTYPE_SIGN) {
123             throw new Zend_Search_Lucene_Exception('Syntax Error: sign operator must be followed by a word.');
124         }
126         // Finish up parsing: check that every opening bracket has a matching closing bracket.
127         if ($openBrackets != 0) {
128             throw new Zend_Search_Lucene_Exception('Syntax Error: mismatched parentheses, every opening must have closing.');
129         }
131         switch (count($terms)) {
132             case 0:
133                 throw new Zend_Search_Lucene_Exception('Syntax error: bad term count.');
134             case 1:
135                 return new Zend_Search_Lucene_Search_Query_Term($terms[0],$signs[0] !== false);
136             default:
137                 return new Zend_Search_Lucene_Search_Query_MultiTerm($terms,$signs);
138         }
139     }