1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2009 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.
30 * \brief Header for GFS
32 * This header includes all public definitions for the
33 * Generic Frontend Server (GFS).
39 #include <yaz/yconfig.h>
40 #include <yaz/proto.h>
42 #include <yaz/oid_db.h>
46 typedef struct request *bend_request;
47 typedef struct association *bend_association;
49 /** \brief Information for Z39.50/SRU search handler
51 This structure is passed to the search handler. Some members
52 are read-only (input), some are read-write (input and ouput),
53 and others are write-only.
56 char *setname; /**< result set ID (input) */
57 int replace_set; /**< replace set indicator (input) */
58 int num_bases; /**< number of databases (input) */
59 char **basenames; /**< databases to search (input) */
60 Z_ReferenceId *referenceId;/**< reference ID (input) */
61 Z_Query *query; /**< query structure (input) */
62 ODR stream; /**< encode stream (input) */
63 ODR decode; /**< decode stream (input) */
64 ODR print; /**< print stream (input) */
66 bend_request request; /**< GFS request handle (input) */
67 bend_association association; /**< GFS association / sesssion (input) */
68 int *fd; /**< select fd - not working (output) */
69 Odr_int hits; /**< hits (output) */
70 int errcode; /**< Diagnostic code / 0 for no error (output) */
71 char *errstring; /**< Additional info (output) */
72 Z_OtherInformation *search_info; /**< extra search info result (output) */
73 char *srw_sortKeys; /**< SRU sortKeys info (input) */
74 char *srw_setname; /**< SRU generated resultsetID (output) */
75 int *srw_setnameIdleTime; /**< SRU result set idle time (output) */
76 int estimated_hit_count; /**< 1=estimated hits; 0=exact (output) */
77 int partial_resultset; /**< 1=partial results; 0=full (output)*/
78 Z_SRW_extra_arg *extra_args; /**< SRU extra request parameters (input) */
79 char *extra_response_data; /**< SRW extra XML response (output) */
82 /** \brief Information for present handler. Does not replace bend_fetch. */
84 char *setname; /**< result set ID (input) */
85 int start; /**< range start, starting from 1 (input) */
86 int number; /**< number of records to fetch (input) */
87 Odr_oid *format; /**< record syntax OID (input) */
88 Z_ReferenceId *referenceId;/**< reference ID (input) */
89 Z_RecordComposition *comp; /**< Formatting instructions (input) */
90 ODR stream; /**< encoding stream (input) */
91 ODR print; /**< printing stream (input) */
92 bend_request request; /**< GFS request handle (input) */
93 bend_association association; /**< GFS association / sesssion (input) */
95 int errcode; /**< Diagnostic code / 0 for no error (output) */
96 char *errstring; /**< Additional info (output) */
99 /** \brief Information for fetch record handler */
100 typedef struct bend_fetch_rr {
101 char *setname; /**< result set ID (input) */
102 int number; /**< record position (1,2,etc) (input) */
103 Z_ReferenceId *referenceId;/**< reference ID (input) */
104 Odr_oid *request_format; /**< record syntax OID (input) */
105 Z_RecordComposition *comp; /**< Formatting instructions (input) */
106 ODR stream; /**< encoding stream (input) */
107 ODR print; /**< printing stream (input) */
109 char *basename; /**< name of database for record (output) */
110 int len; /**< record length or -1 if structured (output)*/
111 char *record; /**< record buffer (output) */
112 int last_in_set; /**< 1=last in set; 0=not last (output) */
113 Odr_oid *output_format; /**< record syntax OIT (output) */
114 int errcode; /**< Diagnostic code / 0 for no error (output) */
115 char *errstring; /**< Additional info (output) */
116 int surrogate_flag; /**< 1=surrogate diagnostic(SD); 0=NSD (output)*/
117 char *schema; /**< string record schema (input/output) */
120 /** \brief Information for scan entry */
122 char *term; /**< the returned scan term (output) */
123 Odr_int occurrences;/**< >=hits or -1 if error (output) */
124 int errcode; /**< Bib-1 diagnostic; only when occur = -1 (output) */
125 char *errstring; /**< Additional string (output) */
130 BEND_SCAN_SUCCESS, /**< ok */
131 BEND_SCAN_PARTIAL /**< not all entries could be found */
134 /** \brief Information for SRU / Z39.50 scan handler */
135 typedef struct bend_scan_rr {
136 int num_bases; /**< number of databases (input) */
137 char **basenames; /**< databases to scan (input) */
138 Odr_oid *attributeset; /**< attribute-set for term (input) */
139 Z_ReferenceId *referenceId; /**< reference ID (input) */
140 Z_AttributesPlusTerm *term; /**< start term (input) */
141 ODR stream; /**< encoding stream (input) */
142 ODR print; /**< printing stream (input) */
144 Odr_int *step_size; /**< step size */
145 Odr_int term_position; /**< desired index of term in result list/returned */
146 int num_entries; /**< number of entries requested/returned */
148 /* scan term entries. The called handler does not have
149 to allocate this. Size of entries is num_entries (see above) */
150 struct scan_entry *entries;
151 bend_scan_status status;
154 char *scanClause; /**< CQL scan clause */
155 char *setname; /**< Scan in result set (NULL if omitted) */
158 /** \brief Information for SRU record update handler */
159 typedef struct bend_update_rr {
160 int num_bases; /**< number of databases (input) */
161 char **basenames; /**< databases to update (input) */
162 Z_ReferenceId *referenceId; /**< reference ID (input) */
163 ODR stream; /**< encoding stream (input) */
164 ODR print; /**< printing stream (input) */
166 char *operation_status;
168 Z_SRW_recordVersion *record_versions;
170 char *record_packing;
173 char *extra_record_data;
174 char *extra_request_data;
175 char *extra_response_data;
181 /** \brief Information for Z39.50 delete result set handler */
182 typedef struct bend_delete_rr {
186 Z_ReferenceId *referenceId;
187 int delete_status; /**< status for the whole operation */
188 Odr_int *statuses; /**< status each set - indexed as setnames */
193 /** \brief Information for Z39.50 sort handler */
194 typedef struct bend_sort_rr
196 int num_input_setnames;
197 char **input_setnames;
198 char *output_setname;
199 Z_SortKeySpecList *sort_sequence;
202 Z_ReferenceId *referenceId;
209 /** \brief Information for Z39.50 extended services handler */
210 typedef struct bend_esrequest_rr
213 Z_ExtendedServicesRequest *esr;
215 ODR stream; /* encoding stream */
216 ODR decode; /* decoding stream */
217 ODR print; /* printing stream */
218 Z_ReferenceId *referenceId;/* reference ID */
219 bend_request request;
220 bend_association association;
221 int errcode; /* 0==success, -1==accepted, >0 = failure */
222 char *errstring; /* system error string or NULL */
223 Z_TaskPackage *taskPackage;
226 /** \brief Information for Z39.50 segment handler */
227 typedef struct bend_segment_rr {
232 bend_request request;
233 bend_association association;
236 /** \brief Information for SRU Explain handler */
244 void *server_node_ptr;
247 /** \brief Information for the Init handler
249 This includes both request
250 information (to be read) and response information which should be
251 set by the bend_init handler
253 typedef struct bend_initrequest
255 /** \brief user/name/password to be read */
256 Z_IdAuthentication *auth;
257 /** \brief encoding stream (for results) */
259 /** \brief printing stream */
261 /** \brief decoding stream (use stream for results) */
263 /** \brief reference ID */
264 Z_ReferenceId *referenceId;
265 /** \brief peer address of client */
268 /** \brief character set and language negotiation
270 see include/yaz/z-charneg.h
272 Z_CharSetandLanguageNegotiation *charneg_request;
274 /** \brief character negotiation response */
275 Z_External *charneg_response;
277 /** \brief character set (encoding) for query terms
279 This is NULL by default. It should be set to the native character
280 set that the backend assumes for query terms */
283 /** \brief whehter query_charset also applies to recors
285 Is 0 (No) by default. Set to 1 (yes) if records is in the same
286 character set as queries. If in doubt, use 0 (No).
288 int records_in_same_charset;
290 char *implementation_id;
291 char *implementation_name;
292 char *implementation_version;
294 /** \brief Z39.50 sort handler */
295 int (*bend_sort)(void *handle, bend_sort_rr *rr);
296 /** \brief SRU/Z39.50 search handler */
297 int (*bend_search)(void *handle, bend_search_rr *rr);
298 /** \brief SRU/Z39.50 fetch handler */
299 int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
300 /** \brief SRU/Z39.50 present handler */
301 int (*bend_present)(void *handle, bend_present_rr *rr);
302 /** \brief Z39.50 extended services handler */
303 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
304 /** \brief Z39.50 delete result set handler */
305 int (*bend_delete)(void *handle, bend_delete_rr *rr);
306 /** \brief Z39.50 scan handler */
307 int (*bend_scan)(void *handle, bend_scan_rr *rr);
308 /** \brief Z39.50 segment facility handler */
309 int (*bend_segment)(void *handle, bend_segment_rr *rr);
310 /** \brief SRU explain handler */
311 int (*bend_explain)(void *handle, bend_explain_rr *rr);
312 /** \brief SRU scan handler */
313 int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
314 /** \brief SRU record update handler */
315 int (*bend_srw_update)(void *handle, bend_update_rr *rr);
317 /** \brief whether named result sets are supported (0=disable, 1=enable) */
318 int named_result_sets;
321 /** \brief result for init handler (must be filled by handler) */
322 typedef struct bend_initresult
324 int errcode; /* 0==OK */
325 char *errstring; /* system error string or NULL */
326 void *handle; /* private handle to the backend module */
329 /** \brief control block for server */
330 typedef struct statserv_options_block
332 int dynamic; /**< fork on incoming requests */
333 int threads; /**< use threads */
334 int one_shot; /**< one session then exit(1) */
335 char apdufile[ODR_MAXNAME+1]; /**< file for pretty-printed PDUs */
336 char logfile[ODR_MAXNAME+1]; /**< file for diagnostic output */
337 char default_listen[1024]; /**< 0 == no default listen */
338 enum oid_proto default_proto; /**< PROTO_SR or PROTO_Z3950 */
339 int idle_timeout; /**< how many minutes to wait before closing */
340 int maxrecordsize; /**< maximum value for negotiation */
341 char configname[ODR_MAXNAME+1]; /**< given to the backend in bend_init */
342 char setuid[ODR_MAXNAME+1]; /**< setuid to this user after binding */
343 void (*bend_start)(struct statserv_options_block *p);
344 void (*bend_stop)(struct statserv_options_block *p);
345 int (*options_func)(int argc, char **argv);
346 int (*check_ip)(void *cd, const char *addr, int len, int type);
347 char daemon_name[128];
348 int inetd; /**< Do we use the inet deamon or not */
350 void *handle; /**< Handle */
351 bend_initresult *(*bend_init)(bend_initrequest *r);
352 void (*bend_close)(void *handle);
354 /* We only have these members for the windows version */
355 /* They seemed a bit large to have them there in general */
356 char service_name[128]; /**< NT Service Name */
357 char app_name[128]; /**< Application Name */
358 char service_dependencies[128]; /**< The services we are dependent on */
359 char service_display_name[128]; /**< The service display name */
361 struct bend_soap_handler *soap_handlers;
362 char pid_fname[128]; /**< pid fname */
363 int background; /**< auto daemon */
364 char cert_fname[128]; /**< SSL certificate fname */
365 char xml_config[128]; /**< XML config filename */
366 } statserv_options_block;
368 YAZ_EXPORT int statserv_main(
369 int argc, char **argv,
370 bend_initresult *(*bend_init)(bend_initrequest *r),
371 void (*bend_close)(void *handle));
372 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
373 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
374 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
376 YAZ_EXPORT int bend_assoc_is_alive(bend_association assoc);
384 * c-file-style: "Stroustrup"
385 * indent-tabs-mode: nil
387 * vim: shiftwidth=4 tabstop=8 expandtab