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