2 * Copyright (c) 1995-2001, 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.12 2001-03-25 21:55:12 adam
28 * Added odr_intdup. Ztest server returns TaskPackage for ItemUpdate.
30 * Revision 1.11 2001/01/30 21:34:17 adam
31 * Added step-size for Scan backend interface.
33 * Revision 1.10 2000/10/02 11:07:44 adam
34 * Added peer_name member for bend_init handler. Changed the YAZ
35 * client so that tcp: can be avoided in target spec.
37 * Revision 1.9 2000/08/31 10:20:12 adam
38 * Added member request_format and output_format for backend fetch method.
40 * Revision 1.8 2000/08/31 09:51:25 adam
41 * Added record_syntax member for fetch method (raw OID).
43 * Revision 1.7 2000/04/05 07:39:55 adam
44 * Added shared library support (libtool).
46 * Revision 1.6 2000/03/20 19:06:25 adam
47 * Added Segment request for fronend server. Work on admin for client.
49 * Revision 1.5 2000/03/15 12:59:49 adam
50 * Added handle member to statserv_control.
52 * Revision 1.4 2000/02/28 11:20:06 adam
53 * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
55 * Revision 1.3 2000/01/12 14:36:07 adam
56 * Added printing stream (ODR) for backend functions.
58 * Revision 1.2 1999/12/16 23:36:19 adam
59 * Implemented ILL protocol. Minor updates ASN.1 compiler.
61 * Revision 1.1 1999/11/30 13:47:11 adam
62 * Improved installation. Moved header files to include/yaz.
64 * Revision 1.28 1999/11/04 14:58:44 adam
65 * Added status elements for backend delete result set handler.
66 * Updated delete result result set command for client.
68 * Revision 1.27 1999/10/11 10:01:24 adam
69 * Implemented bend_sort_rr handler for frontend server.
71 * Revision 1.26 1999/06/17 10:54:44 adam
72 * Added facility to specify implementation version - and name
75 * Revision 1.25 1999/06/01 14:29:12 adam
76 * Work on Extended Services.
78 * Revision 1.24 1999/03/31 11:18:24 adam
79 * Implemented odr_strdup. Added Reference ID to backend server API.
81 * Revision 1.23 1998/10/13 16:12:23 adam
82 * Added support for Surrogate Diagnostics for Scan Term entries.
84 * Revision 1.22 1998/09/02 12:41:51 adam
85 * Added decode stream in bend search structures.
87 * Revision 1.21 1998/07/20 12:38:41 adam
88 * Implemented delete result set service to server API.
90 * Revision 1.20 1998/05/27 16:57:06 adam
91 * Support for surrogate diagnostic records added for bend_fetch.
93 * Revision 1.19 1998/03/31 11:07:45 adam
94 * Furhter work on UNIverse resource report.
95 * Added Extended Services handling in frontend server.
97 * Revision 1.18 1998/02/10 11:03:56 adam
98 * Added support for extended handlers in backend server interface.
100 * Revision 1.17 1998/01/29 13:15:35 adam
101 * Implemented sort for the backend interface.
103 * Revision 1.16 1997/09/17 12:10:31 adam
111 #include <yaz/yconfig.h>
112 #include <yaz/proto.h>
116 typedef struct request *bend_request;
117 typedef struct association *bend_association;
119 /* extended search handler (rr = request response) */
121 char *setname; /* name to give to this set */
122 int replace_set; /* replace set, if it already exists */
123 int num_bases; /* number of databases in list */
124 char **basenames; /* databases to search */
125 Z_ReferenceId *referenceId;/* reference ID */
126 Z_Query *query; /* query structure */
127 ODR stream; /* encode stream */
128 ODR decode; /* decode stream */
129 ODR print; /* print stream */
131 bend_request request;
132 bend_association association;
134 int hits; /* number of hits */
135 int errcode; /* 0==OK */
136 char *errstring; /* system error string or NULL */
139 /* extended present handler. Does not replace bend_fetch. */
141 char *setname; /* set name */
143 int number; /* record number */
144 oid_value format; /* One of the CLASS_RECSYN members */
145 Z_ReferenceId *referenceId;/* reference ID */
146 Z_RecordComposition *comp; /* Formatting instructions */
147 ODR stream; /* encoding stream - memory source if required */
148 ODR print; /* printing stream */
149 bend_request request;
150 bend_association association;
152 int hits; /* number of hits */
153 int errcode; /* 0==OK */
154 char *errstring; /* system error string or NULL */
157 typedef struct bend_fetch_rr {
158 char *setname; /* set name */
159 int number; /* record number */
160 Z_ReferenceId *referenceId;/* reference ID */
161 oid_value request_format; /* One of the CLASS_RECSYN members */
162 int *request_format_raw; /* same as above (raw OID) */
163 Z_RecordComposition *comp; /* Formatting instructions */
164 ODR stream; /* encoding stream - memory source if req */
165 ODR print; /* printing stream */
167 char *basename; /* name of database that provided record */
168 int len; /* length of record or -1 if structured */
169 char *record; /* record */
170 int last_in_set; /* is it? */
171 oid_value output_format; /* format */
172 int *output_format_raw; /* used instead of above if not-null */
173 int errcode; /* 0==success */
174 char *errstring; /* system error string or NULL */
175 int surrogate_flag; /* surrogate diagnostic */
179 char *term; /* the returned scan term */
180 int occurrences; /* no of occurrences or -1 if error (see below) */
181 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
182 char *errstring; /* Additional string */
186 BEND_SCAN_SUCCESS, /* ok */
187 BEND_SCAN_PARTIAL /* not all entries could be found */
190 typedef struct bend_scan_rr {
191 int num_bases; /* number of elements in databaselist */
192 char **basenames; /* databases to search */
193 oid_value attributeset;
194 Z_ReferenceId *referenceId; /* reference ID */
195 Z_AttributesPlusTerm *term;
196 ODR stream; /* encoding stream - memory source if required */
197 ODR print; /* printing stream */
199 int *step_size; /* step size */
200 int term_position; /* desired index of term in result list/returned */
201 int num_entries; /* number of entries requested/returned */
203 struct scan_entry *entries;
204 bend_scan_status status;
210 typedef struct bend_delete_rr {
214 Z_ReferenceId *referenceId;
215 int delete_status; /* status for the whole operation */
216 int *statuses; /* status each set - indexed as setnames */
222 typedef struct bend_sort_rr
224 int num_input_setnames;
225 char **input_setnames;
226 char *output_setname;
227 Z_SortKeySpecList *sort_sequence;
230 Z_ReferenceId *referenceId;/* reference ID */
237 typedef struct bend_esrequest_rr
240 Z_ExtendedServicesRequest *esr;
242 ODR stream; /* encoding stream */
243 ODR decode; /* decoding stream */
244 ODR print; /* printing stream */
245 Z_ReferenceId *referenceId;/* reference ID */
246 bend_request request;
247 bend_association association;
248 int errcode; /* 0==success, -1==accepted, >0 = failure */
249 char *errstring; /* system error string or NULL */
250 Z_TaskPackage *taskPackage;
253 typedef struct bend_segment_rr {
258 bend_request request;
259 bend_association association;
262 typedef struct bend_initrequest
264 Z_IdAuthentication *auth;
265 ODR stream; /* encoding stream */
266 ODR print; /* printing stream */
267 Z_ReferenceId *referenceId;/* reference ID */
268 char *peer_name; /* dns host of peer (client) */
270 char *implementation_name;
271 char *implementation_version;
272 int (*bend_sort) (void *handle, bend_sort_rr *rr);
273 int (*bend_search) (void *handle, bend_search_rr *rr);
274 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
275 int (*bend_present) (void *handle, bend_present_rr *rr);
276 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
277 int (*bend_delete)(void *handle, bend_delete_rr *rr);
278 int (*bend_scan)(void *handle, bend_scan_rr *rr);
279 int (*bend_segment)(void *handle, bend_segment_rr *rr);
282 typedef struct bend_initresult
284 int errcode; /* 0==OK */
285 char *errstring; /* system error string or NULL */
286 void *handle; /* private handle to the backend module */
289 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
292 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
294 YAZ_EXPORT void bend_request_destroy (bend_request *req);
296 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
297 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
298 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
299 YAZ_EXPORT void *bend_request_getdata(bend_request r);
301 typedef struct statserv_options_block
303 int dynamic; /* fork on incoming requests */
304 int threads; /* use threads */
305 int one_shot; /* one session then exit(1) */
306 int loglevel; /* desired logging-level */
307 char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
308 char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */
309 char default_listen[1024]; /* 0 == no default listen */
310 enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
311 int idle_timeout; /* how many minutes to wait before closing */
312 int maxrecordsize; /* maximum value for negotiation */
313 char configname[ODR_MAXNAME+1]; /* given to the backend in bend_init */
314 char setuid[ODR_MAXNAME+1]; /* setuid to this user after binding */
315 void (*bend_start)(struct statserv_options_block *p);
316 void (*bend_stop)(struct statserv_options_block *p);
317 int (*options_func)(int argc, char **argv);
318 int (*check_ip)(void *cd, const char *addr, int len, int type);
319 char daemon_name[128];
320 int inetd; /* Do we use the inet deamon or not */
322 void *handle; /* Handle */
323 bend_initresult *(*bend_init)(bend_initrequest *r);
324 void (*bend_close)(void *handle);
326 /* We only have these members for the windows version */
327 /* They seemed a bit large to have them there in general */
328 char service_name[128]; /* NT Service Name */
329 char app_name[128]; /* Application Name */
330 char service_dependencies[128]; /* The services we are dependent on */
331 char service_display_name[128]; /* The service display name */
333 } statserv_options_block;
335 YAZ_EXPORT int statserv_main(
336 int argc, char **argv,
337 bend_initresult *(*bend_init)(bend_initrequest *r),
338 void (*bend_close)(void *handle));
339 YAZ_EXPORT int statserv_start(int argc, char **argv);
340 YAZ_EXPORT void statserv_closedown(void);
341 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
342 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
343 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);