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