2 * Copyright (C) 1994-1998, Index Data I/S
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.31 1998-05-20 10:12:23 adam
8 * Implemented automatic EXPLAIN database maintenance.
9 * Modified Zebra to work with ASN.1 compiled version of YAZ.
11 * Revision 1.30 1998/03/05 08:45:13 adam
12 * New result set model and modular ranking system. Moved towards
13 * descent server API. System information stored as "SGML" records.
15 * Revision 1.29 1998/02/10 12:03:06 adam
18 * Revision 1.28 1998/01/29 13:40:11 adam
19 * Better logging for scan service.
21 * Revision 1.27 1997/10/27 14:33:06 adam
22 * Moved towards generic character mapping depending on "structure"
23 * field in abstract syntax file. Fixed a few memory leaks. Fixed
24 * bug with negative integers when doing searches with relational
27 * Revision 1.26 1997/09/29 12:41:35 adam
28 * Fixed bug regarding USE_TIMES var.
30 * Revision 1.25 1997/09/29 09:08:36 adam
31 * Revised locking system to be thread safe for the server.
33 * Revision 1.24 1997/09/17 12:19:19 adam
34 * Zebra version corresponds to YAZ version 1.4.
35 * Changed Zebra server so that it doesn't depend on global common_resource.
37 * Revision 1.23 1996/12/23 15:30:46 adam
39 * Bug fix: result sets weren't deleted after server shut down.
41 * Revision 1.22 1996/11/04 14:07:49 adam
42 * Moved truncation code to trunc.c.
44 * Revision 1.21 1996/10/29 14:09:58 adam
45 * Use of cisam system - enabled if setting isamc is 1.
47 * Revision 1.20 1996/06/04 10:19:02 adam
48 * Minor changes - removed include of ctype.h.
50 * Revision 1.19 1996/05/14 11:34:01 adam
51 * Scan support in multiple registers/databases.
53 * Revision 1.18 1996/05/14 06:16:50 adam
54 * Compact use/set bytes used in search service.
56 * Revision 1.17 1995/12/08 16:22:57 adam
57 * Work on update while servers are running. Three lock files introduced.
58 * The servers reload their registers when necessary, but they don't
59 * reestablish result sets yet.
61 * Revision 1.16 1995/12/07 17:38:48 adam
62 * Work locking mechanisms for concurrent updates/commit.
64 * Revision 1.15 1995/11/21 15:29:13 adam
65 * Config file 'base' read by default by both indexer and server.
67 * Revision 1.14 1995/11/16 17:00:57 adam
68 * Better logging of rpn query.
70 * Revision 1.13 1995/11/16 15:34:56 adam
71 * Uses new record management system in both indexer and server.
73 * Revision 1.12 1995/10/27 14:00:12 adam
74 * Implemented detection of database availability.
76 * Revision 1.11 1995/10/17 18:02:12 adam
77 * New feature: databases. Implemented as prefix to words in dictionary.
79 * Revision 1.10 1995/10/09 16:18:38 adam
80 * Function dict_lookup_grep got extra client data parameter.
82 * Revision 1.9 1995/10/06 14:38:01 adam
83 * New result set method: r_score.
84 * Local no (sysno) and score is transferred to retrieveCtrl.
86 * Revision 1.8 1995/10/06 13:52:06 adam
87 * Bug fixes. Handler may abort further scanning.
89 * Revision 1.7 1995/10/06 10:43:57 adam
90 * Scan added. 'occurrences' in scan entries not set yet.
92 * Revision 1.6 1995/09/28 09:19:48 adam
93 * xfree/xmalloc used everywhere.
94 * Extract/retrieve method seems to work for text records.
96 * Revision 1.5 1995/09/27 16:17:32 adam
97 * More work on retrieve.
99 * Revision 1.4 1995/09/14 11:53:28 adam
100 * First work on regular expressions/truncations.
102 * Revision 1.3 1995/09/08 08:53:23 adam
103 * Record buffer maintained in server_info.
105 * Revision 1.2 1995/09/06 16:11:19 adam
106 * Option: only one word key per file.
108 * Revision 1.1 1995/09/05 15:28:40 adam
109 * More work on search engine.
123 #include <sys/times.h>
138 typedef struct zebra_set *ZebraSet;
140 typedef struct zebra_rank_class {
141 struct rank_control *control;
144 struct zebra_rank_class *next;
148 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
149 time_t registerChange;
159 ZebraExplainInfo zei;
164 ZebraLockHandle server_lock_cmt;
165 ZebraLockHandle server_lock_org;
166 char *server_path_prefix;
171 ZebraMaps zebra_maps;
172 ZebraRankClass rank_classes;
175 typedef struct zebra_info *ZebraHandle;
177 struct rank_control {
179 void *(*create)(ZebraHandle zh);
180 void (*destroy)(ZebraHandle zh, void *class_handle);
181 void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
182 void (*end)(ZebraHandle zh, void *set_handle);
183 int (*calc)(void *set_handle, int sysno);
184 void (*add)(void *set_handle, int seqno, int term_index);
187 void rpn_search (ZebraHandle zh, ODR stream,
188 Z_RPNQuery *rpn, int num_bases, char **basenames,
189 const char *setname);
197 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
198 oid_value attributeset,
199 int num_bases, char **basenames,
200 int *position, int *num_entries, ZebraScanEntry **list,
203 RSET rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
204 const char *term, int length_term, const char *flags);
206 ZebraSet resultSetAdd (ZebraHandle zh, const char *name,
207 int ov, RSET rset, int *hits);
208 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
209 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
210 void resultSetDestroy (ZebraHandle zh);
212 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
213 int num, int *positions);
214 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
216 void resultSetSort (ZebraHandle zh, ODR stream,
217 int num_input_setnames, char **input_setnames,
218 char *output_setname, Z_SortKeySpecList *sort_sequence,
221 void zebra_sort (ZebraHandle zh, ODR stream,
222 int num_input_setnames, char **input_setnames,
223 char *output_setname, Z_SortKeySpecList *sort_sequence,
226 void zlog_rpn (Z_RPNQuery *rpn);
227 void zlog_scan (Z_AttributesPlusTerm *zapt, oid_value ast);
229 int zebra_server_lock_init (ZebraHandle zh);
230 int zebra_server_lock_destroy (ZebraHandle zh);
231 int zebra_server_lock (ZebraHandle zh, int lockCommit);
232 void zebra_server_unlock (ZebraHandle zh, int commitPhase);
233 int zebra_server_lock_get_state (ZebraHandle zh, time_t *timep);
235 typedef struct attent
238 data1_local_attribute *local_attributes;
241 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl);
242 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
243 void zebraRankDestroy (ZebraHandle zh);
245 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
247 extern struct rank_control *rank1_class;
249 ZebraHandle zebra_open (const char *host, const char *configName);
250 void zebra_search_rpn (ZebraHandle zh, ODR stream,
251 Z_RPNQuery *query, int num_bases, char **basenames,
252 const char *setname);
260 } ZebraRetrievalRecord;
262 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
263 const char *setname, Z_RecordComposition *comp,
264 oid_value input_format,
265 int num_recs, ZebraRetrievalRecord *recs);
267 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
268 oid_value input_format, Z_RecordComposition *comp,
269 oid_value *output_format, char **rec_bufp,
270 int *rec_lenp, char **basenamep);
272 void zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
273 oid_value attributeset,
274 int num_bases, char **basenames,
275 int *position, int *num_entries, ZebraScanEntry **list,
278 void zebra_close (ZebraHandle zh);