2 * Copyright (c) 1995-2007, Index Data
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 /* $Id: backend.h,v 1.47 2007-05-08 08:22:35 adam Exp $ */
31 * \brief Header for GFS
33 * This header includes all public definitions for the
34 * Generic Frontend Server (GFS).
40 #include <yaz/yconfig.h>
41 #include <yaz/proto.h>
43 #include <yaz/oid_db.h>
47 typedef struct request *bend_request;
48 typedef struct association *bend_association;
50 /** \brief Information for Z39.50/SRU search handler */
52 char *setname; /* name to give to this set */
53 int replace_set; /* replace set, if it already exists */
54 int num_bases; /* number of databases in list */
55 char **basenames; /* databases to search */
56 Z_ReferenceId *referenceId;/* reference ID */
57 Z_Query *query; /* query structure */
58 ODR stream; /* encode stream */
59 ODR decode; /* decode stream */
60 ODR print; /* print stream */
63 bend_association association;
65 int hits; /* number of hits */
66 int errcode; /* 0==OK */
67 char *errstring; /* system error string or NULL */
68 Z_OtherInformation *search_info; /* additional search info */
69 char *srw_sortKeys; /* holds SRU/SRW sortKeys info */
70 char *srw_setname; /* holds SRU/SRW generated resultsetID */
71 int *srw_setnameIdleTime; /* holds SRU/SRW life-time */
72 int estimated_hit_count; /* if hit count is estimated */
73 int partial_resultset; /* if result set is partial */
76 /** \brief Information for present handler. Does not replace bend_fetch. */
78 char *setname; /* set name */
80 int number; /* record number */
81 Odr_oid *format; /* format, transfer syntax (OID) */
82 Z_ReferenceId *referenceId;/* reference ID */
83 Z_RecordComposition *comp; /* Formatting instructions */
84 ODR stream; /* encoding stream - memory source if required */
85 ODR print; /* printing stream */
87 bend_association association;
89 int hits; /* number of hits */
90 int errcode; /* 0==OK */
91 char *errstring; /* system error string or NULL */
94 /** \brief Information for fetch record handler */
95 typedef struct bend_fetch_rr {
96 char *setname; /* set name */
97 int number; /* record number */
98 Z_ReferenceId *referenceId;/* reference ID */
99 Odr_oid *request_format; /* format, transfer syntax (OID) */
100 Z_RecordComposition *comp; /* Formatting instructions */
101 ODR stream; /* encoding stream - memory source if req */
102 ODR print; /* printing stream */
104 char *basename; /* name of database that provided record */
105 int len; /* length of record or -1 if structured */
106 char *record; /* record */
107 int last_in_set; /* is it? */
108 Odr_oid *output_format; /* response format/syntax (OID) */
109 int errcode; /* 0==success */
110 char *errstring; /* system error string or NULL */
111 int surrogate_flag; /* surrogate diagnostic */
112 char *schema; /* string record schema input/output */
115 /** \brief Information for scan entry */
117 char *term; /* the returned scan term */
118 int occurrences; /* no of occurrences or -1 if error (see below) */
119 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
120 char *errstring; /* Additional string */
125 BEND_SCAN_SUCCESS, /* ok */
126 BEND_SCAN_PARTIAL /* not all entries could be found */
129 /** \brief Information for SRU / Z39.50 scan handler */
130 typedef struct bend_scan_rr {
131 int num_bases; /* number of elements in databaselist */
132 char **basenames; /* databases to search */
133 Odr_oid *attributeset;
134 Z_ReferenceId *referenceId; /* reference ID */
135 Z_AttributesPlusTerm *term;
136 ODR stream; /* encoding stream - memory source if required */
137 ODR print; /* printing stream */
139 int *step_size; /* step size */
140 int term_position; /* desired index of term in result list/returned */
141 int num_entries; /* number of entries requested/returned */
143 /* scan term entries. The called handler does not have
144 to allocate this. Size of entries is num_entries (see above) */
145 struct scan_entry *entries;
146 bend_scan_status status;
149 char *scanClause; /* CQL scan clause */
152 /** \brief Information for SRU record update handler */
153 typedef struct bend_update_rr {
154 int num_bases; /* number of elements in databaselist */
155 char **basenames; /* databases to search */
156 Z_ReferenceId *referenceId; /* reference ID */
157 ODR stream; /* encoding stream - memory source if required */
158 ODR print; /* printing stream */
160 char *operation_status;
162 Z_SRW_recordVersion *record_versions;
164 char *record_packing;
167 char *extra_record_data;
168 char *extra_request_data;
169 char *extra_response_data;
175 /** \brief Information for Z39.50 delete result set handler */
176 typedef struct bend_delete_rr {
180 Z_ReferenceId *referenceId;
181 int delete_status; /* status for the whole operation */
182 int *statuses; /* status each set - indexed as setnames */
187 /** \brief Information for Z39.50 sort handler */
188 typedef struct bend_sort_rr
190 int num_input_setnames;
191 char **input_setnames;
192 char *output_setname;
193 Z_SortKeySpecList *sort_sequence;
196 Z_ReferenceId *referenceId;/* reference ID */
203 /** \brief Information for Z39.50 extended services handler */
204 typedef struct bend_esrequest_rr
207 Z_ExtendedServicesRequest *esr;
209 ODR stream; /* encoding stream */
210 ODR decode; /* decoding stream */
211 ODR print; /* printing stream */
212 Z_ReferenceId *referenceId;/* reference ID */
213 bend_request request;
214 bend_association association;
215 int errcode; /* 0==success, -1==accepted, >0 = failure */
216 char *errstring; /* system error string or NULL */
217 Z_TaskPackage *taskPackage;
220 /** \brief Information for Z39.50 segment handler */
221 typedef struct bend_segment_rr {
226 bend_request request;
227 bend_association association;
230 /** \brief Information for SRU Explain handler */
238 void *server_node_ptr;
241 /** \brief Information for the Init handler
243 This includes both request
244 information (to be read) and response information which should be
245 set by the bend_init handler
247 typedef struct bend_initrequest
249 /** \brief user/name/password to be read */
250 Z_IdAuthentication *auth;
251 /** \brief encoding stream (for results) */
253 /** \brief printing stream */
255 /** \brief decoding stream (use stream for results) */
257 /** \brief reference ID */
258 Z_ReferenceId *referenceId;
259 /** \brief peer address of client */
262 /** \brief character set and language negotiation
264 see include/yaz/z-charneg.h
266 Z_CharSetandLanguageNegotiation *charneg_request;
268 /** \brief character negotiation response */
269 Z_External *charneg_response;
271 /** \brief character set (encoding) for query terms
273 This is NULL by default. It should be set to the native character
274 set that the backend assumes for query terms */
277 /** \brief whehter query_charset also applies to recors
279 Is 0 (No) by default. Set to 1 (yes) if records is in the same
280 character set as queries. If in doubt, use 0 (No).
282 int records_in_same_charset;
284 char *implementation_id;
285 char *implementation_name;
286 char *implementation_version;
288 /** \brief Z39.50 sort handler */
289 int (*bend_sort)(void *handle, bend_sort_rr *rr);
290 /** \brief SRU/Z39.50 search handler */
291 int (*bend_search)(void *handle, bend_search_rr *rr);
292 /** \brief SRU/Z39.50 fetch handler */
293 int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
294 /** \brief SRU/Z39.50 present handler */
295 int (*bend_present)(void *handle, bend_present_rr *rr);
296 /** \brief Z39.50 extended services handler */
297 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
298 /** \brief Z39.50 delete result set handler */
299 int (*bend_delete)(void *handle, bend_delete_rr *rr);
300 /** \brief Z39.50 scan handler */
301 int (*bend_scan)(void *handle, bend_scan_rr *rr);
302 /** \brief Z39.50 segment facility handler */
303 int (*bend_segment)(void *handle, bend_segment_rr *rr);
304 /** \brief SRU explain handler */
305 int (*bend_explain)(void *handle, bend_explain_rr *rr);
306 /** \brief SRU scan handler */
307 int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
308 /** \brief SRU record update handler */
309 int (*bend_srw_update)(void *handle, bend_update_rr *rr);
313 /** \brief result for init handler (must be filled by handler) */
314 typedef struct bend_initresult
316 int errcode; /* 0==OK */
317 char *errstring; /* system error string or NULL */
318 void *handle; /* private handle to the backend module */
321 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
324 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
326 YAZ_EXPORT void bend_request_destroy (bend_request *req);
328 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
329 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
330 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
331 YAZ_EXPORT void *bend_request_getdata(bend_request r);
333 /** \brief control block for server */
334 typedef struct statserv_options_block
336 int dynamic; /* fork on incoming requests */
337 int threads; /* use threads */
338 int one_shot; /* one session then exit(1) */
339 char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
340 char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */
341 char default_listen[1024]; /* 0 == no default listen */
342 enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
343 int idle_timeout; /* how many minutes to wait before closing */
344 int maxrecordsize; /* maximum value for negotiation */
345 char configname[ODR_MAXNAME+1]; /* given to the backend in bend_init */
346 char setuid[ODR_MAXNAME+1]; /* setuid to this user after binding */
347 void (*bend_start)(struct statserv_options_block *p);
348 void (*bend_stop)(struct statserv_options_block *p);
349 int (*options_func)(int argc, char **argv);
350 int (*check_ip)(void *cd, const char *addr, int len, int type);
351 char daemon_name[128];
352 int inetd; /* Do we use the inet deamon or not */
354 void *handle; /* Handle */
355 bend_initresult *(*bend_init)(bend_initrequest *r);
356 void (*bend_close)(void *handle);
358 /* We only have these members for the windows version */
359 /* They seemed a bit large to have them there in general */
360 char service_name[128]; /* NT Service Name */
361 char app_name[128]; /* Application Name */
362 char service_dependencies[128]; /* The services we are dependent on */
363 char service_display_name[128]; /* The service display name */
365 struct bend_soap_handler *soap_handlers;
366 char pid_fname[128]; /* pid fname */
367 int background; /* auto daemon */
368 char cert_fname[128]; /* SSL certificate fname */
369 char xml_config[128]; /* XML config filename */
370 } statserv_options_block;
372 YAZ_EXPORT int statserv_main(
373 int argc, char **argv,
374 bend_initresult *(*bend_init)(bend_initrequest *r),
375 void (*bend_close)(void *handle));
376 YAZ_EXPORT int statserv_start(int argc, char **argv);
377 YAZ_EXPORT void statserv_closedown(void);
378 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
379 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
380 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
382 YAZ_EXPORT int bend_assoc_is_alive(bend_association assoc);
390 * indent-tabs-mode: nil
392 * vim: shiftwidth=4 tabstop=8 expandtab