2 * Copyright (c) 1995-2000, Index Data.
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation, in whole or in part, for any purpose, is hereby granted,
8 * 1. This copyright and permission notice appear in all copies of the
9 * software and its documentation. Notices of copyright or attribution
10 * which appear at the beginning of any file must remain unchanged.
12 * 2. The name of Index Data or the individual authors may not be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
27 * Revision 1.8 2000-08-31 09:51:25 adam
28 * Added record_syntax member for fetch method (raw OID).
30 * Revision 1.7 2000/04/05 07:39:55 adam
31 * Added shared library support (libtool).
33 * Revision 1.6 2000/03/20 19:06:25 adam
34 * Added Segment request for fronend server. Work on admin for client.
36 * Revision 1.5 2000/03/15 12:59:49 adam
37 * Added handle member to statserv_control.
39 * Revision 1.4 2000/02/28 11:20:06 adam
40 * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
42 * Revision 1.3 2000/01/12 14:36:07 adam
43 * Added printing stream (ODR) for backend functions.
45 * Revision 1.2 1999/12/16 23:36:19 adam
46 * Implemented ILL protocol. Minor updates ASN.1 compiler.
48 * Revision 1.1 1999/11/30 13:47:11 adam
49 * Improved installation. Moved header files to include/yaz.
51 * Revision 1.28 1999/11/04 14:58:44 adam
52 * Added status elements for backend delete result set handler.
53 * Updated delete result result set command for client.
55 * Revision 1.27 1999/10/11 10:01:24 adam
56 * Implemented bend_sort_rr handler for frontend server.
58 * Revision 1.26 1999/06/17 10:54:44 adam
59 * Added facility to specify implementation version - and name
62 * Revision 1.25 1999/06/01 14:29:12 adam
63 * Work on Extended Services.
65 * Revision 1.24 1999/03/31 11:18:24 adam
66 * Implemented odr_strdup. Added Reference ID to backend server API.
68 * Revision 1.23 1998/10/13 16:12:23 adam
69 * Added support for Surrogate Diagnostics for Scan Term entries.
71 * Revision 1.22 1998/09/02 12:41:51 adam
72 * Added decode stream in bend search structures.
74 * Revision 1.21 1998/07/20 12:38:41 adam
75 * Implemented delete result set service to server API.
77 * Revision 1.20 1998/05/27 16:57:06 adam
78 * Support for surrogate diagnostic records added for bend_fetch.
80 * Revision 1.19 1998/03/31 11:07:45 adam
81 * Furhter work on UNIverse resource report.
82 * Added Extended Services handling in frontend server.
84 * Revision 1.18 1998/02/10 11:03:56 adam
85 * Added support for extended handlers in backend server interface.
87 * Revision 1.17 1998/01/29 13:15:35 adam
88 * Implemented sort for the backend interface.
90 * Revision 1.16 1997/09/17 12:10:31 adam
98 #include <yaz/yconfig.h>
99 #include <yaz/proto.h>
103 typedef struct request *bend_request;
104 typedef struct association *bend_association;
106 /* extended search handler (rr = request response) */
108 char *setname; /* name to give to this set */
109 int replace_set; /* replace set, if it already exists */
110 int num_bases; /* number of databases in list */
111 char **basenames; /* databases to search */
112 Z_ReferenceId *referenceId;/* reference ID */
113 Z_Query *query; /* query structure */
114 ODR stream; /* encode stream */
115 ODR decode; /* decode stream */
116 ODR print; /* print stream */
118 bend_request request;
119 bend_association association;
121 int hits; /* number of hits */
122 int errcode; /* 0==OK */
123 char *errstring; /* system error string or NULL */
126 /* extended present handler. Does not replace bend_fetch. */
128 char *setname; /* set name */
130 int number; /* record number */
131 oid_value format; /* One of the CLASS_RECSYN members */
132 int *record_syntax; /* same as above (raw OID) */
133 Z_ReferenceId *referenceId;/* reference ID */
134 Z_RecordComposition *comp; /* Formatting instructions */
135 ODR stream; /* encoding stream - memory source if required */
136 ODR print; /* printing stream */
137 bend_request request;
138 bend_association association;
140 int hits; /* number of hits */
141 int errcode; /* 0==OK */
142 char *errstring; /* system error string or NULL */
145 typedef struct bend_fetch_rr {
146 char *setname; /* set name */
147 int number; /* record number */
148 Z_ReferenceId *referenceId;/* reference ID */
149 oid_value request_format; /* One of the CLASS_RECSYN members */
150 int *record_syntax; /* same as above (raw OID) */
151 Z_RecordComposition *comp; /* Formatting instructions */
152 ODR stream; /* encoding stream - memory source if req */
153 ODR print; /* printing stream */
155 char *basename; /* name of database that provided record */
156 int len; /* length of record or -1 if structured */
157 char *record; /* record */
158 int last_in_set; /* is it? */
159 oid_value output_format; /* format */
160 int errcode; /* 0==success */
161 char *errstring; /* system error string or NULL */
162 int surrogate_flag; /* surrogate diagnostic */
166 char *term; /* the returned scan term */
167 int occurrences; /* no of occurrences or -1 if error (see below) */
168 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
169 char *errstring; /* Additional string */
173 BEND_SCAN_SUCCESS, /* ok */
174 BEND_SCAN_PARTIAL /* not all entries could be found */
177 typedef struct bend_scan_rr {
178 int num_bases; /* number of elements in databaselist */
179 char **basenames; /* databases to search */
180 oid_value attributeset;
181 Z_ReferenceId *referenceId; /* reference ID */
182 Z_AttributesPlusTerm *term;
183 ODR stream; /* encoding stream - memory source if required */
184 ODR print; /* printing stream */
186 int term_position; /* desired index of term in result list/returned */
187 int num_entries; /* number of entries requested/returned */
189 struct scan_entry *entries;
190 bend_scan_status status;
196 typedef struct bend_delete_rr {
200 Z_ReferenceId *referenceId;
201 int delete_status; /* status for the whole operation */
202 int *statuses; /* status each set - indexed as setnames */
208 typedef struct bend_sort_rr
210 int num_input_setnames;
211 char **input_setnames;
212 char *output_setname;
213 Z_SortKeySpecList *sort_sequence;
216 Z_ReferenceId *referenceId;/* reference ID */
223 typedef struct bend_esrequest_rr
226 Z_ExtendedServicesRequest *esr;
228 ODR stream; /* encoding stream */
229 ODR decode; /* decoding stream */
230 ODR print; /* printing stream */
231 Z_ReferenceId *referenceId;/* reference ID */
232 bend_request request;
233 bend_association association;
234 int errcode; /* 0==success, -1==accepted, >0 = failure */
235 char *errstring; /* system error string or NULL */
238 typedef struct bend_segment_rr {
243 bend_request request;
244 bend_association association;
247 typedef struct bend_initrequest
249 Z_IdAuthentication *auth;
250 ODR stream; /* encoding stream */
251 ODR print; /* printing stream */
252 Z_ReferenceId *referenceId;/* reference ID */
254 char *implementation_name;
255 char *implementation_version;
256 int (*bend_sort) (void *handle, bend_sort_rr *rr);
257 int (*bend_search) (void *handle, bend_search_rr *rr);
258 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
259 int (*bend_present) (void *handle, bend_present_rr *rr);
260 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
261 int (*bend_delete)(void *handle, bend_delete_rr *rr);
262 int (*bend_scan)(void *handle, bend_scan_rr *rr);
263 int (*bend_segment)(void *handle, bend_segment_rr *rr);
266 typedef struct bend_initresult
268 int errcode; /* 0==OK */
269 char *errstring; /* system error string or NULL */
270 void *handle; /* private handle to the backend module */
273 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
276 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
278 YAZ_EXPORT void bend_request_destroy (bend_request *req);
280 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
281 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
282 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
283 YAZ_EXPORT void *bend_request_getdata(bend_request r);
285 typedef struct statserv_options_block
287 int dynamic; /* fork on incoming requests */
288 int threads; /* use threads */
289 int one_shot; /* one session then exit(1) */
290 int loglevel; /* desired logging-level */
291 char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
292 char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */
293 char default_listen[1024]; /* 0 == no default listen */
294 enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
295 int idle_timeout; /* how many minutes to wait before closing */
296 int maxrecordsize; /* maximum value for negotiation */
297 char configname[ODR_MAXNAME+1]; /* given to the backend in bend_init */
298 char setuid[ODR_MAXNAME+1]; /* setuid to this user after binding */
299 void (*bend_start)(struct statserv_options_block *p);
300 void (*bend_stop)(struct statserv_options_block *p);
301 int (*options_func)(int argc, char **argv);
302 int (*check_ip)(void *cd, const char *addr, int len, int type);
303 char daemon_name[128];
304 int inetd; /* Do we use the inet deamon or not */
306 void *handle; /* Handle */
307 bend_initresult *(*bend_init)(bend_initrequest *r);
308 void (*bend_close)(void *handle);
310 /* We only have these members for the windows version */
311 /* They seemed a bit large to have them there in general */
312 char service_name[128]; /* NT Service Name */
313 char app_name[128]; /* Application Name */
314 char service_dependencies[128]; /* The services we are dependent on */
315 char service_display_name[128]; /* The service display name */
317 } statserv_options_block;
319 YAZ_EXPORT int statserv_main(
320 int argc, char **argv,
321 bend_initresult *(*bend_init)(bend_initrequest *r),
322 void (*bend_close)(void *handle));
323 YAZ_EXPORT int statserv_start(int argc, char **argv);
324 YAZ_EXPORT void statserv_closedown(void);
325 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
326 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
327 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);