ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilLuceneSearcher.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2006 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
24include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResult.php';
25
36{
37 const TYPE_STANDARD = 1;
38 const TYPE_USER = 2;
39
40 private static $instance = null;
41
42 private $query_parser = null;
43 private $result = null;
44 private $highlighter = null;
45 private $page_number = 1;
47
53 private function __construct($qp)
54 {
55 $this->result = new ilLuceneSearchResult();
56 $this->result->setCallback(array($this,'nextResultPage'));
57 $this->query_parser = $qp;
58 }
59
67 public static function getInstance(ilLuceneQueryParser $qp)
68 {
69 if(self::$instance)
70 {
71 return self::$instance;
72 }
73 return self::$instance = new ilLuceneSearcher($qp);
74 }
75
80 public function setType($a_type)
81 {
82 $this->type = $a_type;
83 }
84
89 public function getType()
90 {
91 return $this->type;
92 }
93
94
99 public function search()
100 {
101 $this->performSearch();
102 }
103
109 public function highlight($a_obj_ids)
110 {
111 global $ilBench,$ilSetting;
112
113 include_once './Services/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php';
114
115 // TODO error handling
116 if(!$this->query_parser->getQuery())
117 {
118 return;
119 }
120
121 // Search in combined index
122 $ilBench->start('Lucene','SearchHighlight');
123 try
124 {
125 include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
126 $res = ilRpcClientFactory::factory('RPCSearchHandler')->highlight(
127 CLIENT_ID.'_'.$ilSetting->get('inst_id',0),
128 $a_obj_ids,
129 $this->query_parser->getQuery()
130 );
131 }
133 {
134 ilLoggerFactory::getLogger('src')->critical('Highlighting failed with message: ' . $e->getMessage());
136 }
137 catch(Exception $e)
138 {
139 ilLoggerFactory::getLogger('src')->error('Highlighting failed with message: ' . $e->getMessage());
141 }
142
143 include_once './Services/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php';
144 $this->highlighter = new ilLuceneHighlighterResultParser();
145 $this->highlighter->setResultString($res);
146 $this->highlighter->parse();
147
148 return $this->highlighter;
149 }
150
156 public function nextResultPage()
157 {
158 $this->page_number++;
159 $this->performSearch();
160 }
161
166 public function getHighlighter()
167 {
168 return $this->highlighter;
169 }
170
176 public function getResult()
177 {
178 if($this->result instanceof ilLuceneSearchResult)
179 {
180 return $this->result;
181 }
182 // TODO Error handling
183 }
184
190 public function getPageNumber()
191 {
192 return $this->page_number;
193 }
194
199 protected function performSearch()
200 {
201 global $ilBench,$ilSetting;
202
203 // TODO error handling
204 if(!$this->query_parser->getQuery())
205 {
206 return;
207 }
208 $ilBench->start('Lucene','SearchCombinedIndex');
209 try
210 {
211 switch($this->getType())
212 {
213
214 case self::TYPE_USER:
215 include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
216 $res = ilRpcClientFactory::factory('RPCSearchHandler')->searchUsers(
217 CLIENT_ID.'_'.$ilSetting->get('inst_id',0),
218 (string) $this->query_parser->getQuery()
219 );
220 break;
221
223 default:
224 include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
225 $res = ilRpcClientFactory::factory('RPCSearchHandler')->search(
226 CLIENT_ID.'_'.$ilSetting->get('inst_id',0),
227 (string) $this->query_parser->getQuery(),
228 $this->getPageNumber()
229 );
230 break;
231
232 }
233 ilLoggerFactory::getLogger('src')->debug('Searching for: ' . $this->query_parser->getQuery());
234 }
236 {
237 ilLoggerFactory::getLogger('src')->critical($e->getMessage());
238 return;
239 }
240 catch(Exception $e)
241 {
242 ilLoggerFactory::getLogger('src')->error('Searching failed with message: ' . $e->getMessage());
243 return;
244 }
245
246 // Parse results
247 include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResultParser.php';
248 $parser = new ilLuceneSearchResultParser($res);
249 $parser->parse($this->result);
250 return;
251 }
252}
253?>
static getLogger($a_component_id)
Get component logger.
Parses result XML from lucene search highlight.
Search result implementing iterator interface.
Reads and parses lucene search results.
performSearch()
search lucene
highlight($a_obj_ids)
Highlight/Detail query.
__construct($qp)
Constructor.
static getInstance(ilLuceneQueryParser $qp)
Get singleton instance.
getPageNumber()
get current page number
nextResultPage()
get next result page
setType($a_type)
Set search type.
getHighlighter()
get highlighter
static factory($a_package)
Create an XML_RPC2 client instance.
global $ilBench
Definition: ilias.php:18
global $ilSetting
Definition: privfeed.php:40