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