2 * Copyright (C) 1994-2000, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.48 2000-04-05 09:49:35 adam
8 * On Unix, zebra/z'mbol uses automake.
10 * Revision 1.47 2000/03/20 19:08:36 adam
11 * Added remote record import using Z39.50 extended services and Segment
14 * Revision 1.46 2000/03/15 15:00:31 adam
15 * First work on threaded version.
17 * Revision 1.45 1999/11/30 13:48:04 adam
18 * Improved installation. Updated for inclusion of YAZ header files.
20 * Revision 1.44 1999/11/04 15:00:45 adam
21 * Implemented delete result set(s).
23 * Revision 1.43 1999/07/14 10:59:27 adam
24 * Changed functions isc_getmethod, isams_getmethod.
25 * Improved fatal error handling (such as missing EXPLAIN schema).
27 * Revision 1.42 1999/05/26 07:49:13 adam
30 * Revision 1.41 1999/05/12 13:08:06 adam
31 * First version of ISAMS.
33 * Revision 1.40 1998/11/16 16:03:45 adam
34 * Moved loggin utilities to Yaz. Was implemented in file zlogs.c.
36 * Revision 1.39 1998/10/16 08:14:35 adam
37 * Updated record control system.
39 * Revision 1.38 1998/09/22 10:03:44 adam
40 * Changed result sets to be persistent in the sense that they can
41 * be re-searched if needed.
42 * Fixed memory leak in rsm_or.
44 * Revision 1.37 1998/09/02 13:53:22 adam
45 * Extra parameter decode added to search routines to implement
48 * Revision 1.36 1998/06/24 12:16:16 adam
49 * Support for relations on text operands. Open range support in
50 * DFA module (i.e. [-j], [g-]).
52 * Revision 1.35 1998/06/23 15:33:35 adam
53 * Added feature to specify sort criteria in query (type 7 specifies
56 * Revision 1.34 1998/06/22 11:36:50 adam
57 * Added authentication check facility to zebra.
59 * Revision 1.33 1998/06/12 12:22:14 adam
62 * Revision 1.32 1998/05/27 16:57:47 adam
63 * Zebra returns surrogate diagnostic for single records when
66 * Revision 1.31 1998/05/20 10:12:23 adam
67 * Implemented automatic EXPLAIN database maintenance.
68 * Modified Zebra to work with ASN.1 compiled version of YAZ.
70 * Revision 1.30 1998/03/05 08:45:13 adam
71 * New result set model and modular ranking system. Moved towards
72 * descent server API. System information stored as "SGML" records.
74 * Revision 1.29 1998/02/10 12:03:06 adam
77 * Revision 1.28 1998/01/29 13:40:11 adam
78 * Better logging for scan service.
80 * Revision 1.27 1997/10/27 14:33:06 adam
81 * Moved towards generic character mapping depending on "structure"
82 * field in abstract syntax file. Fixed a few memory leaks. Fixed
83 * bug with negative integers when doing searches with relational
86 * Revision 1.26 1997/09/29 12:41:35 adam
87 * Fixed bug regarding USE_TIMES var.
89 * Revision 1.25 1997/09/29 09:08:36 adam
90 * Revised locking system to be thread safe for the server.
92 * Revision 1.24 1997/09/17 12:19:19 adam
93 * Zebra version corresponds to YAZ version 1.4.
94 * Changed Zebra server so that it doesn't depend on global common_resource.
96 * Revision 1.23 1996/12/23 15:30:46 adam
98 * Bug fix: result sets weren't deleted after server shut down.
100 * Revision 1.22 1996/11/04 14:07:49 adam
101 * Moved truncation code to trunc.c.
103 * Revision 1.21 1996/10/29 14:09:58 adam
104 * Use of cisam system - enabled if setting isamc is 1.
106 * Revision 1.20 1996/06/04 10:19:02 adam
107 * Minor changes - removed include of ctype.h.
109 * Revision 1.19 1996/05/14 11:34:01 adam
110 * Scan support in multiple registers/databases.
112 * Revision 1.18 1996/05/14 06:16:50 adam
113 * Compact use/set bytes used in search service.
115 * Revision 1.17 1995/12/08 16:22:57 adam
116 * Work on update while servers are running. Three lock files introduced.
117 * The servers reload their registers when necessary, but they don't
118 * reestablish result sets yet.
120 * Revision 1.16 1995/12/07 17:38:48 adam
121 * Work locking mechanisms for concurrent updates/commit.
123 * Revision 1.15 1995/11/21 15:29:13 adam
124 * Config file 'base' read by default by both indexer and server.
126 * Revision 1.14 1995/11/16 17:00:57 adam
127 * Better logging of rpn query.
129 * Revision 1.13 1995/11/16 15:34:56 adam
130 * Uses new record management system in both indexer and server.
132 * Revision 1.12 1995/10/27 14:00:12 adam
133 * Implemented detection of database availability.
135 * Revision 1.11 1995/10/17 18:02:12 adam
136 * New feature: databases. Implemented as prefix to words in dictionary.
138 * Revision 1.10 1995/10/09 16:18:38 adam
139 * Function dict_lookup_grep got extra client data parameter.
141 * Revision 1.9 1995/10/06 14:38:01 adam
142 * New result set method: r_score.
143 * Local no (sysno) and score is transferred to retrieveCtrl.
145 * Revision 1.8 1995/10/06 13:52:06 adam
146 * Bug fixes. Handler may abort further scanning.
148 * Revision 1.7 1995/10/06 10:43:57 adam
149 * Scan added. 'occurrences' in scan entries not set yet.
151 * Revision 1.6 1995/09/28 09:19:48 adam
152 * xfree/xmalloc used everywhere.
153 * Extract/retrieve method seems to work for text records.
155 * Revision 1.5 1995/09/27 16:17:32 adam
156 * More work on retrieve.
158 * Revision 1.4 1995/09/14 11:53:28 adam
159 * First work on regular expressions/truncations.
161 * Revision 1.3 1995/09/08 08:53:23 adam
162 * Record buffer maintained in server_info.
164 * Revision 1.2 1995/09/06 16:11:19 adam
165 * Option: only one word key per file.
167 * Revision 1.1 1995/09/05 15:28:40 adam
168 * More work on search engine.
173 #include <sys/times.h>
177 #include <pthreads.h>
180 #include <yaz/backend.h>
184 #include <passwddb.h>
186 #include "zebraapi.h"
196 typedef struct zebra_set *ZebraSet;
198 typedef struct zebra_rank_class {
199 struct rank_control *control;
202 struct zebra_rank_class *next;
205 struct zebra_service {
207 struct zebra_session *sessions;
216 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
217 time_t registerChange;
220 ZebraExplainInfo zei;
222 ZebraLockHandle server_lock_cmt;
223 ZebraLockHandle server_lock_org;
224 char *server_path_prefix;
230 ZebraMaps zebra_maps;
231 ZebraRankClass rank_classes;
234 Zebra_mutex_cond session_lock;
253 struct sortKey *next;
256 struct zebra_session {
257 struct zebra_session *next;
258 struct zebra_service *service;
261 struct sortKey *sortKeys;
268 char *admin_databaseName;
277 struct rank_control {
279 void *(*create)(ZebraService zh);
280 void (*destroy)(ZebraService zh, void *class_handle);
281 void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
282 void (*end)(ZebraHandle zh, void *set_handle);
283 int (*calc)(void *set_handle, int sysno);
284 void (*add)(void *set_handle, int seqno, int term_index);
287 RSET rpn_search (ZebraHandle zh, NMEM mem,
288 Z_RPNQuery *rpn, int num_bases, char **basenames,
289 const char *setname, ZebraSet sset);
292 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
293 oid_value attributeset,
294 int num_bases, char **basenames,
295 int *position, int *num_entries, ZebraScanEntry **list,
298 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
299 const char *term, int length_term, const char *flags);
301 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
302 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
303 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode, Z_RPNQuery *rpn, int num_bases, char **basenames,
304 const char *setname);
305 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
306 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
309 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
310 int num, int *positions);
311 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
313 void resultSetSort (ZebraHandle zh, NMEM nmem,
314 int num_input_setnames, const char **input_setnames,
315 const char *output_setname,
316 Z_SortKeySpecList *sort_sequence, int *sort_status);
317 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
318 ZebraSet sset, RSET rset,
319 Z_SortKeySpecList *sort_sequence, int *sort_status);
320 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
322 void zebra_sort (ZebraHandle zh, ODR stream,
323 int num_input_setnames, const char **input_setnames,
324 const char *output_setname, Z_SortKeySpecList *sort_sequence,
327 int zebra_server_lock_init (ZebraService zh);
328 int zebra_server_lock_destroy (ZebraService zh);
329 int zebra_server_lock (ZebraService zh, int lockCommit);
330 void zebra_server_unlock (ZebraService zh, int commitPhase);
331 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
333 typedef struct attent
336 data1_local_attribute *local_attributes;
339 void zebraRankInstall (ZebraService zh, struct rank_control *ctrl);
340 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
341 void zebraRankDestroy (ZebraService zh);
343 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
345 extern struct rank_control *rank1_class;
347 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
348 oid_value input_format, Z_RecordComposition *comp,
349 oid_value *output_format, char **rec_bufp,
350 int *rec_lenp, char **basenamep);
352 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
353 void zebra_index_merge (ZebraHandle zh);
356 struct zebra_fetch_control {
360 const char *record_int_buf;
365 int zebra_record_ext_read (void *fh, char *buf, size_t count);
366 off_t zebra_record_ext_seek (void *fh, off_t offset);
367 off_t zebra_record_ext_tell (void *fh);
368 off_t zebra_record_int_seek (void *fh, off_t offset);
369 off_t zebra_record_int_tell (void *fh);
370 int zebra_record_int_read (void *fh, char *buf, size_t count);
371 void zebra_record_int_end (void *fh, off_t offset);