2 * Copyright (C) 1994-1998, Index Data I/S
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.33 1998-06-12 12:22:14 adam
10 * Revision 1.32 1998/05/27 16:57:47 adam
11 * Zebra returns surrogate diagnostic for single records when
14 * Revision 1.31 1998/05/20 10:12:23 adam
15 * Implemented automatic EXPLAIN database maintenance.
16 * Modified Zebra to work with ASN.1 compiled version of YAZ.
18 * Revision 1.30 1998/03/05 08:45:13 adam
19 * New result set model and modular ranking system. Moved towards
20 * descent server API. System information stored as "SGML" records.
22 * Revision 1.29 1998/02/10 12:03:06 adam
25 * Revision 1.28 1998/01/29 13:40:11 adam
26 * Better logging for scan service.
28 * Revision 1.27 1997/10/27 14:33:06 adam
29 * Moved towards generic character mapping depending on "structure"
30 * field in abstract syntax file. Fixed a few memory leaks. Fixed
31 * bug with negative integers when doing searches with relational
34 * Revision 1.26 1997/09/29 12:41:35 adam
35 * Fixed bug regarding USE_TIMES var.
37 * Revision 1.25 1997/09/29 09:08:36 adam
38 * Revised locking system to be thread safe for the server.
40 * Revision 1.24 1997/09/17 12:19:19 adam
41 * Zebra version corresponds to YAZ version 1.4.
42 * Changed Zebra server so that it doesn't depend on global common_resource.
44 * Revision 1.23 1996/12/23 15:30:46 adam
46 * Bug fix: result sets weren't deleted after server shut down.
48 * Revision 1.22 1996/11/04 14:07:49 adam
49 * Moved truncation code to trunc.c.
51 * Revision 1.21 1996/10/29 14:09:58 adam
52 * Use of cisam system - enabled if setting isamc is 1.
54 * Revision 1.20 1996/06/04 10:19:02 adam
55 * Minor changes - removed include of ctype.h.
57 * Revision 1.19 1996/05/14 11:34:01 adam
58 * Scan support in multiple registers/databases.
60 * Revision 1.18 1996/05/14 06:16:50 adam
61 * Compact use/set bytes used in search service.
63 * Revision 1.17 1995/12/08 16:22:57 adam
64 * Work on update while servers are running. Three lock files introduced.
65 * The servers reload their registers when necessary, but they don't
66 * reestablish result sets yet.
68 * Revision 1.16 1995/12/07 17:38:48 adam
69 * Work locking mechanisms for concurrent updates/commit.
71 * Revision 1.15 1995/11/21 15:29:13 adam
72 * Config file 'base' read by default by both indexer and server.
74 * Revision 1.14 1995/11/16 17:00:57 adam
75 * Better logging of rpn query.
77 * Revision 1.13 1995/11/16 15:34:56 adam
78 * Uses new record management system in both indexer and server.
80 * Revision 1.12 1995/10/27 14:00:12 adam
81 * Implemented detection of database availability.
83 * Revision 1.11 1995/10/17 18:02:12 adam
84 * New feature: databases. Implemented as prefix to words in dictionary.
86 * Revision 1.10 1995/10/09 16:18:38 adam
87 * Function dict_lookup_grep got extra client data parameter.
89 * Revision 1.9 1995/10/06 14:38:01 adam
90 * New result set method: r_score.
91 * Local no (sysno) and score is transferred to retrieveCtrl.
93 * Revision 1.8 1995/10/06 13:52:06 adam
94 * Bug fixes. Handler may abort further scanning.
96 * Revision 1.7 1995/10/06 10:43:57 adam
97 * Scan added. 'occurrences' in scan entries not set yet.
99 * Revision 1.6 1995/09/28 09:19:48 adam
100 * xfree/xmalloc used everywhere.
101 * Extract/retrieve method seems to work for text records.
103 * Revision 1.5 1995/09/27 16:17:32 adam
104 * More work on retrieve.
106 * Revision 1.4 1995/09/14 11:53:28 adam
107 * First work on regular expressions/truncations.
109 * Revision 1.3 1995/09/08 08:53:23 adam
110 * Record buffer maintained in server_info.
112 * Revision 1.2 1995/09/06 16:11:19 adam
113 * Option: only one word key per file.
115 * Revision 1.1 1995/09/05 15:28:40 adam
116 * More work on search engine.
130 #include <sys/times.h>
138 #include "zebraapi.h"
146 typedef struct zebra_set *ZebraSet;
148 typedef struct zebra_rank_class {
149 struct rank_control *control;
152 struct zebra_rank_class *next;
156 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
157 time_t registerChange;
167 ZebraExplainInfo zei;
172 ZebraLockHandle server_lock_cmt;
173 ZebraLockHandle server_lock_org;
174 char *server_path_prefix;
179 ZebraMaps zebra_maps;
180 ZebraRankClass rank_classes;
184 struct rank_control {
186 void *(*create)(ZebraHandle zh);
187 void (*destroy)(ZebraHandle zh, void *class_handle);
188 void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
189 void (*end)(ZebraHandle zh, void *set_handle);
190 int (*calc)(void *set_handle, int sysno);
191 void (*add)(void *set_handle, int seqno, int term_index);
194 void rpn_search (ZebraHandle zh, ODR stream,
195 Z_RPNQuery *rpn, int num_bases, char **basenames,
196 const char *setname);
199 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
200 oid_value attributeset,
201 int num_bases, char **basenames,
202 int *position, int *num_entries, ZebraScanEntry **list,
205 RSET rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
206 const char *term, int length_term, const char *flags);
208 ZebraSet resultSetAdd (ZebraHandle zh, const char *name,
209 int ov, RSET rset, int *hits);
210 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
211 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
212 void resultSetDestroy (ZebraHandle zh);
214 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
215 int num, int *positions);
216 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
218 void resultSetSort (ZebraHandle zh, ODR stream,
219 int num_input_setnames, char **input_setnames,
220 char *output_setname, Z_SortKeySpecList *sort_sequence,
223 void zebra_sort (ZebraHandle zh, ODR stream,
224 int num_input_setnames, char **input_setnames,
225 char *output_setname, Z_SortKeySpecList *sort_sequence,
228 void zlog_rpn (Z_RPNQuery *rpn);
229 void zlog_scan (Z_AttributesPlusTerm *zapt, oid_value ast);
231 int zebra_server_lock_init (ZebraHandle zh);
232 int zebra_server_lock_destroy (ZebraHandle zh);
233 int zebra_server_lock (ZebraHandle zh, int lockCommit);
234 void zebra_server_unlock (ZebraHandle zh, int commitPhase);
235 int zebra_server_lock_get_state (ZebraHandle zh, time_t *timep);
237 typedef struct attent
240 data1_local_attribute *local_attributes;
243 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl);
244 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
245 void zebraRankDestroy (ZebraHandle zh);
247 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
249 extern struct rank_control *rank1_class;
251 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
252 oid_value input_format, Z_RecordComposition *comp,
253 oid_value *output_format, char **rec_bufp,
254 int *rec_lenp, char **basenamep);