2 * Copyright (C) 1994-1999, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.42 1999-05-26 07:49:13 adam
10 * Revision 1.41 1999/05/12 13:08:06 adam
11 * First version of ISAMS.
13 * Revision 1.40 1998/11/16 16:03:45 adam
14 * Moved loggin utilities to Yaz. Was implemented in file zlogs.c.
16 * Revision 1.39 1998/10/16 08:14:35 adam
17 * Updated record control system.
19 * Revision 1.38 1998/09/22 10:03:44 adam
20 * Changed result sets to be persistent in the sense that they can
21 * be re-searched if needed.
22 * Fixed memory leak in rsm_or.
24 * Revision 1.37 1998/09/02 13:53:22 adam
25 * Extra parameter decode added to search routines to implement
28 * Revision 1.36 1998/06/24 12:16:16 adam
29 * Support for relations on text operands. Open range support in
30 * DFA module (i.e. [-j], [g-]).
32 * Revision 1.35 1998/06/23 15:33:35 adam
33 * Added feature to specify sort criteria in query (type 7 specifies
36 * Revision 1.34 1998/06/22 11:36:50 adam
37 * Added authentication check facility to zebra.
39 * Revision 1.33 1998/06/12 12:22:14 adam
42 * Revision 1.32 1998/05/27 16:57:47 adam
43 * Zebra returns surrogate diagnostic for single records when
46 * Revision 1.31 1998/05/20 10:12:23 adam
47 * Implemented automatic EXPLAIN database maintenance.
48 * Modified Zebra to work with ASN.1 compiled version of YAZ.
50 * Revision 1.30 1998/03/05 08:45:13 adam
51 * New result set model and modular ranking system. Moved towards
52 * descent server API. System information stored as "SGML" records.
54 * Revision 1.29 1998/02/10 12:03:06 adam
57 * Revision 1.28 1998/01/29 13:40:11 adam
58 * Better logging for scan service.
60 * Revision 1.27 1997/10/27 14:33:06 adam
61 * Moved towards generic character mapping depending on "structure"
62 * field in abstract syntax file. Fixed a few memory leaks. Fixed
63 * bug with negative integers when doing searches with relational
66 * Revision 1.26 1997/09/29 12:41:35 adam
67 * Fixed bug regarding USE_TIMES var.
69 * Revision 1.25 1997/09/29 09:08:36 adam
70 * Revised locking system to be thread safe for the server.
72 * Revision 1.24 1997/09/17 12:19:19 adam
73 * Zebra version corresponds to YAZ version 1.4.
74 * Changed Zebra server so that it doesn't depend on global common_resource.
76 * Revision 1.23 1996/12/23 15:30:46 adam
78 * Bug fix: result sets weren't deleted after server shut down.
80 * Revision 1.22 1996/11/04 14:07:49 adam
81 * Moved truncation code to trunc.c.
83 * Revision 1.21 1996/10/29 14:09:58 adam
84 * Use of cisam system - enabled if setting isamc is 1.
86 * Revision 1.20 1996/06/04 10:19:02 adam
87 * Minor changes - removed include of ctype.h.
89 * Revision 1.19 1996/05/14 11:34:01 adam
90 * Scan support in multiple registers/databases.
92 * Revision 1.18 1996/05/14 06:16:50 adam
93 * Compact use/set bytes used in search service.
95 * Revision 1.17 1995/12/08 16:22:57 adam
96 * Work on update while servers are running. Three lock files introduced.
97 * The servers reload their registers when necessary, but they don't
98 * reestablish result sets yet.
100 * Revision 1.16 1995/12/07 17:38:48 adam
101 * Work locking mechanisms for concurrent updates/commit.
103 * Revision 1.15 1995/11/21 15:29:13 adam
104 * Config file 'base' read by default by both indexer and server.
106 * Revision 1.14 1995/11/16 17:00:57 adam
107 * Better logging of rpn query.
109 * Revision 1.13 1995/11/16 15:34:56 adam
110 * Uses new record management system in both indexer and server.
112 * Revision 1.12 1995/10/27 14:00:12 adam
113 * Implemented detection of database availability.
115 * Revision 1.11 1995/10/17 18:02:12 adam
116 * New feature: databases. Implemented as prefix to words in dictionary.
118 * Revision 1.10 1995/10/09 16:18:38 adam
119 * Function dict_lookup_grep got extra client data parameter.
121 * Revision 1.9 1995/10/06 14:38:01 adam
122 * New result set method: r_score.
123 * Local no (sysno) and score is transferred to retrieveCtrl.
125 * Revision 1.8 1995/10/06 13:52:06 adam
126 * Bug fixes. Handler may abort further scanning.
128 * Revision 1.7 1995/10/06 10:43:57 adam
129 * Scan added. 'occurrences' in scan entries not set yet.
131 * Revision 1.6 1995/09/28 09:19:48 adam
132 * xfree/xmalloc used everywhere.
133 * Extract/retrieve method seems to work for text records.
135 * Revision 1.5 1995/09/27 16:17:32 adam
136 * More work on retrieve.
138 * Revision 1.4 1995/09/14 11:53:28 adam
139 * First work on regular expressions/truncations.
141 * Revision 1.3 1995/09/08 08:53:23 adam
142 * Record buffer maintained in server_info.
144 * Revision 1.2 1995/09/06 16:11:19 adam
145 * Option: only one word key per file.
147 * Revision 1.1 1995/09/05 15:28:40 adam
148 * More work on search engine.
162 #include <sys/times.h>
169 #include <passwddb.h>
171 #include "zebraapi.h"
183 typedef struct zebra_set *ZebraSet;
185 typedef struct zebra_rank_class {
186 struct rank_control *control;
189 struct zebra_rank_class *next;
193 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
194 time_t registerChange;
205 ZebraExplainInfo zei;
210 ZebraLockHandle server_lock_cmt;
211 ZebraLockHandle server_lock_org;
212 char *server_path_prefix;
217 ZebraMaps zebra_maps;
218 ZebraRankClass rank_classes;
224 struct rank_control {
226 void *(*create)(ZebraHandle zh);
227 void (*destroy)(ZebraHandle zh, void *class_handle);
228 void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
229 void (*end)(ZebraHandle zh, void *set_handle);
230 int (*calc)(void *set_handle, int sysno);
231 void (*add)(void *set_handle, int seqno, int term_index);
234 RSET rpn_search (ZebraHandle zh, NMEM mem,
235 Z_RPNQuery *rpn, int num_bases, char **basenames,
236 const char *setname, ZebraSet sset);
239 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
240 oid_value attributeset,
241 int num_bases, char **basenames,
242 int *position, int *num_entries, ZebraScanEntry **list,
245 RSET rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
246 const char *term, int length_term, const char *flags);
248 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
249 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
250 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode, Z_RPNQuery *rpn, int num_bases, char **basenames,
251 const char *setname);
252 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
253 void resultSetDestroy (ZebraHandle zh);
255 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
256 int num, int *positions);
257 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
259 void resultSetSort (ZebraHandle zh, NMEM nmem,
260 int num_input_setnames, const char **input_setnames,
261 const char *output_setname,
262 Z_SortKeySpecList *sort_sequence, int *sort_status);
263 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
264 ZebraSet sset, RSET rset,
265 Z_SortKeySpecList *sort_sequence, int *sort_status);
266 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
268 void zebra_sort (ZebraHandle zh, ODR stream,
269 int num_input_setnames, const char **input_setnames,
270 const char *output_setname, Z_SortKeySpecList *sort_sequence,
273 int zebra_server_lock_init (ZebraHandle zh);
274 int zebra_server_lock_destroy (ZebraHandle zh);
275 int zebra_server_lock (ZebraHandle zh, int lockCommit);
276 void zebra_server_unlock (ZebraHandle zh, int commitPhase);
277 int zebra_server_lock_get_state (ZebraHandle zh, time_t *timep);
279 typedef struct attent
282 data1_local_attribute *local_attributes;
285 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl);
286 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
287 void zebraRankDestroy (ZebraHandle zh);
289 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
291 extern struct rank_control *rank1_class;
293 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
294 oid_value input_format, Z_RecordComposition *comp,
295 oid_value *output_format, char **rec_bufp,
296 int *rec_lenp, char **basenamep);