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