2 * Copyright (c) 1995-2002, 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.15 2002-07-25 12:52:53 adam
28 * Character set negotiation updates
30 * Revision 1.14 2002/03/20 14:36:00 adam
31 * Additional Search Info for GFS
33 * Revision 1.13 2002/03/05 12:45:49 mike
34 * Add trivial support for implementation_id specified by backend.
36 * Revision 1.12 2001/03/25 21:55:12 adam
37 * Added odr_intdup. Ztest server returns TaskPackage for ItemUpdate.
39 * Revision 1.11 2001/01/30 21:34:17 adam
40 * Added step-size for Scan backend interface.
42 * Revision 1.10 2000/10/02 11:07:44 adam
43 * Added peer_name member for bend_init handler. Changed the YAZ
44 * client so that tcp: can be avoided in target spec.
46 * Revision 1.9 2000/08/31 10:20:12 adam
47 * Added member request_format and output_format for backend fetch method.
49 * Revision 1.8 2000/08/31 09:51:25 adam
50 * Added record_syntax member for fetch method (raw OID).
52 * Revision 1.7 2000/04/05 07:39:55 adam
53 * Added shared library support (libtool).
55 * Revision 1.6 2000/03/20 19:06:25 adam
56 * Added Segment request for fronend server. Work on admin for client.
58 * Revision 1.5 2000/03/15 12:59:49 adam
59 * Added handle member to statserv_control.
61 * Revision 1.4 2000/02/28 11:20:06 adam
62 * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
64 * Revision 1.3 2000/01/12 14:36:07 adam
65 * Added printing stream (ODR) for backend functions.
67 * Revision 1.2 1999/12/16 23:36:19 adam
68 * Implemented ILL protocol. Minor updates ASN.1 compiler.
70 * Revision 1.1 1999/11/30 13:47:11 adam
71 * Improved installation. Moved header files to include/yaz.
73 * Revision 1.28 1999/11/04 14:58:44 adam
74 * Added status elements for backend delete result set handler.
75 * Updated delete result result set command for client.
77 * Revision 1.27 1999/10/11 10:01:24 adam
78 * Implemented bend_sort_rr handler for frontend server.
80 * Revision 1.26 1999/06/17 10:54:44 adam
81 * Added facility to specify implementation version - and name
84 * Revision 1.25 1999/06/01 14:29:12 adam
85 * Work on Extended Services.
87 * Revision 1.24 1999/03/31 11:18:24 adam
88 * Implemented odr_strdup. Added Reference ID to backend server API.
90 * Revision 1.23 1998/10/13 16:12:23 adam
91 * Added support for Surrogate Diagnostics for Scan Term entries.
93 * Revision 1.22 1998/09/02 12:41:51 adam
94 * Added decode stream in bend search structures.
96 * Revision 1.21 1998/07/20 12:38:41 adam
97 * Implemented delete result set service to server API.
99 * Revision 1.20 1998/05/27 16:57:06 adam
100 * Support for surrogate diagnostic records added for bend_fetch.
102 * Revision 1.19 1998/03/31 11:07:45 adam
103 * Furhter work on UNIverse resource report.
104 * Added Extended Services handling in frontend server.
106 * Revision 1.18 1998/02/10 11:03:56 adam
107 * Added support for extended handlers in backend server interface.
109 * Revision 1.17 1998/01/29 13:15:35 adam
110 * Implemented sort for the backend interface.
112 * Revision 1.16 1997/09/17 12:10:31 adam
120 #include <yaz/yconfig.h>
121 #include <yaz/proto.h>
125 typedef struct request *bend_request;
126 typedef struct association *bend_association;
128 /* extended search handler (rr = request response) */
130 char *setname; /* name to give to this set */
131 int replace_set; /* replace set, if it already exists */
132 int num_bases; /* number of databases in list */
133 char **basenames; /* databases to search */
134 Z_ReferenceId *referenceId;/* reference ID */
135 Z_Query *query; /* query structure */
136 ODR stream; /* encode stream */
137 ODR decode; /* decode stream */
138 ODR print; /* print stream */
140 bend_request request;
141 bend_association association;
143 int hits; /* number of hits */
144 int errcode; /* 0==OK */
145 char *errstring; /* system error string or NULL */
146 Z_OtherInformation *search_info; /* additional search info */
149 /* extended present handler. Does not replace bend_fetch. */
151 char *setname; /* set name */
153 int number; /* record number */
154 oid_value format; /* One of the CLASS_RECSYN members */
155 Z_ReferenceId *referenceId;/* reference ID */
156 Z_RecordComposition *comp; /* Formatting instructions */
157 ODR stream; /* encoding stream - memory source if required */
158 ODR print; /* printing stream */
159 bend_request request;
160 bend_association association;
162 int hits; /* number of hits */
163 int errcode; /* 0==OK */
164 char *errstring; /* system error string or NULL */
167 typedef struct bend_fetch_rr {
168 char *setname; /* set name */
169 int number; /* record number */
170 Z_ReferenceId *referenceId;/* reference ID */
171 oid_value request_format; /* One of the CLASS_RECSYN members */
172 int *request_format_raw; /* same as above (raw OID) */
173 Z_RecordComposition *comp; /* Formatting instructions */
174 ODR stream; /* encoding stream - memory source if req */
175 ODR print; /* printing stream */
177 char *basename; /* name of database that provided record */
178 int len; /* length of record or -1 if structured */
179 char *record; /* record */
180 int last_in_set; /* is it? */
181 oid_value output_format; /* format */
182 int *output_format_raw; /* used instead of above if not-null */
183 int errcode; /* 0==success */
184 char *errstring; /* system error string or NULL */
185 int surrogate_flag; /* surrogate diagnostic */
189 char *term; /* the returned scan term */
190 int occurrences; /* no of occurrences or -1 if error (see below) */
191 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
192 char *errstring; /* Additional string */
196 BEND_SCAN_SUCCESS, /* ok */
197 BEND_SCAN_PARTIAL /* not all entries could be found */
200 typedef struct bend_scan_rr {
201 int num_bases; /* number of elements in databaselist */
202 char **basenames; /* databases to search */
203 oid_value attributeset;
204 Z_ReferenceId *referenceId; /* reference ID */
205 Z_AttributesPlusTerm *term;
206 ODR stream; /* encoding stream - memory source if required */
207 ODR print; /* printing stream */
209 int *step_size; /* step size */
210 int term_position; /* desired index of term in result list/returned */
211 int num_entries; /* number of entries requested/returned */
213 struct scan_entry *entries;
214 bend_scan_status status;
220 typedef struct bend_delete_rr {
224 Z_ReferenceId *referenceId;
225 int delete_status; /* status for the whole operation */
226 int *statuses; /* status each set - indexed as setnames */
232 typedef struct bend_sort_rr
234 int num_input_setnames;
235 char **input_setnames;
236 char *output_setname;
237 Z_SortKeySpecList *sort_sequence;
240 Z_ReferenceId *referenceId;/* reference ID */
247 typedef struct bend_esrequest_rr
250 Z_ExtendedServicesRequest *esr;
252 ODR stream; /* encoding stream */
253 ODR decode; /* decoding stream */
254 ODR print; /* printing stream */
255 Z_ReferenceId *referenceId;/* reference ID */
256 bend_request request;
257 bend_association association;
258 int errcode; /* 0==success, -1==accepted, >0 = failure */
259 char *errstring; /* system error string or NULL */
260 Z_TaskPackage *taskPackage;
263 typedef struct bend_segment_rr {
268 bend_request request;
269 bend_association association;
272 typedef struct bend_initrequest
274 Z_IdAuthentication *auth;
275 ODR stream; /* encoding stream */
276 ODR print; /* printing stream */
277 Z_ReferenceId *referenceId;/* reference ID */
278 char *peer_name; /* dns host of peer (client) */
280 char *implementation_id;
281 char *implementation_name;
282 char *implementation_version;
283 int (*bend_sort) (void *handle, bend_sort_rr *rr);
284 int (*bend_search) (void *handle, bend_search_rr *rr);
285 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
286 int (*bend_present) (void *handle, bend_present_rr *rr);
287 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
288 int (*bend_delete)(void *handle, bend_delete_rr *rr);
289 int (*bend_scan)(void *handle, bend_scan_rr *rr);
290 int (*bend_segment)(void *handle, bend_segment_rr *rr);
292 ODR decode; /* decoding stream */
293 /* character set and language negotiation - see include/yaz/z-charneg.h */
294 Z_CharSetandLanguageNegotiation *charneg_request;
295 Z_External *charneg_response;
299 typedef struct bend_initresult
301 int errcode; /* 0==OK */
302 char *errstring; /* system error string or NULL */
303 void *handle; /* private handle to the backend module */
306 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
309 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
311 YAZ_EXPORT void bend_request_destroy (bend_request *req);
313 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
314 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
315 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
316 YAZ_EXPORT void *bend_request_getdata(bend_request r);
318 typedef struct statserv_options_block
320 int dynamic; /* fork on incoming requests */
321 int threads; /* use threads */
322 int one_shot; /* one session then exit(1) */
323 int loglevel; /* desired logging-level */
324 char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
325 char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */
326 char default_listen[1024]; /* 0 == no default listen */
327 enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
328 int idle_timeout; /* how many minutes to wait before closing */
329 int maxrecordsize; /* maximum value for negotiation */
330 char configname[ODR_MAXNAME+1]; /* given to the backend in bend_init */
331 char setuid[ODR_MAXNAME+1]; /* setuid to this user after binding */
332 void (*bend_start)(struct statserv_options_block *p);
333 void (*bend_stop)(struct statserv_options_block *p);
334 int (*options_func)(int argc, char **argv);
335 int (*check_ip)(void *cd, const char *addr, int len, int type);
336 char daemon_name[128];
337 int inetd; /* Do we use the inet deamon or not */
339 void *handle; /* Handle */
340 bend_initresult *(*bend_init)(bend_initrequest *r);
341 void (*bend_close)(void *handle);
343 /* We only have these members for the windows version */
344 /* They seemed a bit large to have them there in general */
345 char service_name[128]; /* NT Service Name */
346 char app_name[128]; /* Application Name */
347 char service_dependencies[128]; /* The services we are dependent on */
348 char service_display_name[128]; /* The service display name */
350 } statserv_options_block;
352 YAZ_EXPORT int statserv_main(
353 int argc, char **argv,
354 bend_initresult *(*bend_init)(bend_initrequest *r),
355 void (*bend_close)(void *handle));
356 YAZ_EXPORT int statserv_start(int argc, char **argv);
357 YAZ_EXPORT void statserv_closedown(void);
358 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
359 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
360 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);