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