include/yaz/backend.h

   1 /*
   2  * Copyright (c) 1995-2004, Index Data.
   3  *
   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,
   6  * provided that:
   7  *
   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.
  11  *
  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.
  15  *
  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
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: backend.h,v 1.26 2004-10-15 00:18:59 adam Exp $
  27  */
  28
  29 /**
  30  * \file backend.h
  31  * \brief Header for GFS
  32  *
  33  * This header includes all public definitions for the
  34  * Generic Frontend Server (GFS).
  35  */
  36
  37 #ifndef BACKEND_H
  38 #define BACKEND_H
  39
  40 #include <yaz/yconfig.h>
  41 #include <yaz/proto.h>
  42
  43 YAZ_BEGIN_CDECL
  44
  45 typedef struct request *bend_request;
  46 typedef struct association *bend_association;
  47
  48 /* extended search handler (rr = request response) */
  49 typedef struct {
  50     char *setname;             /* name to give to this set */
  51     int replace_set;           /* replace set, if it already exists */
  52     int num_bases;             /* number of databases in list */
  53     char **basenames;          /* databases to search */
  54     Z_ReferenceId *referenceId;/* reference ID */
  55     Z_Query *query;            /* query structure */
  56     ODR stream;                /* encode stream */
  57     ODR decode;                /* decode stream */
  58     ODR print;                 /* print stream */
  59
  60     bend_request request;
  61     bend_association association;
  62     int *fd;
  63     int hits;                  /* number of hits */
  64     int errcode;               /* 0==OK */
  65     char *errstring;           /* system error string or NULL */
  66     Z_OtherInformation *search_info; /* additional search info */
  67 } bend_search_rr;
  68
  69 /* extended present handler. Does not replace bend_fetch. */
  70 typedef struct {
  71     char *setname;             /* set name */
  72     int start;
  73     int number;                /* record number */
  74     oid_value format;          /* One of the CLASS_RECSYN members */
  75     Z_ReferenceId *referenceId;/* reference ID */
  76     Z_RecordComposition *comp; /* Formatting instructions */
  77     ODR stream;                /* encoding stream - memory source if required */
  78     ODR print;                 /* printing stream */
  79     bend_request request;
  80     bend_association association;
  81
  82     int hits;                  /* number of hits */
  83     int errcode;               /* 0==OK */
  84     char *errstring;           /* system error string or NULL */
  85 } bend_present_rr;
  86
  87 typedef struct bend_fetch_rr {
  88     char *setname;             /* set name */
  89     int number;                /* record number */
  90     Z_ReferenceId *referenceId;/* reference ID */
  91     oid_value request_format;  /* One of the CLASS_RECSYN members */
  92     int *request_format_raw;   /* same as above (raw OID) */
  93     Z_RecordComposition *comp; /* Formatting instructions */
  94     ODR stream;                /* encoding stream - memory source if req */
  95     ODR print;                 /* printing stream */
  96
  97     char *basename;            /* name of database that provided record */
  98     int len;                   /* length of record or -1 if structured */
  99     char *record;              /* record */
 100     int last_in_set;           /* is it?  */
 101     oid_value output_format;   /* format */
 102     int *output_format_raw;    /* used instead of above if not-null */
 103     int errcode;               /* 0==success */
 104     char *errstring;           /* system error string or NULL */
 105     int surrogate_flag;        /* surrogate diagnostic */
 106     char *schema;              /* string record schema input/output */
 107 } bend_fetch_rr;
 108
 109 struct scan_entry {
 110     char *term;         /* the returned scan term */
 111     int occurrences;    /* no of occurrences or -1 if error (see below) */
 112     int errcode;        /* Bib-1 diagnostic code; only used when occur.= -1 */
 113     char *errstring;    /* Additional string */
 114     char *display_term;
 115 };
 116
 117 typedef enum {
 118     BEND_SCAN_SUCCESS,  /* ok */
 119     BEND_SCAN_PARTIAL   /* not all entries could be found */
 120 } bend_scan_status;
 121
 122 typedef struct bend_scan_rr {
 123     int num_bases;      /* number of elements in databaselist */
 124     char **basenames;   /* databases to search */
 125     oid_value attributeset;
 126     Z_ReferenceId *referenceId; /* reference ID */
 127     Z_AttributesPlusTerm *term;
 128     ODR stream;         /* encoding stream - memory source if required */
 129     ODR print;          /* printing stream */
 130
 131     int *step_size;     /* step size */
 132     int term_position;  /* desired index of term in result list/returned */
 133     int num_entries;    /* number of entries requested/returned */
 134
 135     /* scan term entries. The called handler does not have
 136        to allocate this. Size of entries is num_entries (see above) */
 137     struct scan_entry *entries;
 138     bend_scan_status status;
 139     int errcode;
 140     char *errstring;
 141 } bend_scan_rr;
 142
 143 /* delete handler */
 144 typedef struct bend_delete_rr {
 145     int function;
 146     int num_setnames;
 147     char **setnames;
 148     Z_ReferenceId *referenceId;
 149     int delete_status;      /* status for the whole operation */
 150     int *statuses;          /* status each set - indexed as setnames */
 151     ODR stream;
 152     ODR print;
 153 } bend_delete_rr;
 154
 155 /* sort handler */
 156 typedef struct bend_sort_rr
 157 {
 158     int num_input_setnames;
 159     char **input_setnames;
 160     char *output_setname;
 161     Z_SortKeySpecList *sort_sequence;
 162     ODR stream;
 163     ODR print;
 164     Z_ReferenceId *referenceId;/* reference ID */
 165
 166     int sort_status;
 167     int errcode;
 168     char *errstring;
 169 } bend_sort_rr;
 170
 171 typedef struct bend_esrequest_rr
 172 {
 173     int ItemNo;
 174     Z_ExtendedServicesRequest *esr;
 175
 176     ODR stream;                /* encoding stream */
 177     ODR decode;                /* decoding stream */
 178     ODR print;                 /* printing stream */
 179     Z_ReferenceId *referenceId;/* reference ID */
 180     bend_request request;
 181     bend_association association;
 182     int errcode;               /* 0==success, -1==accepted, >0 = failure */
 183     char *errstring;           /* system error string or NULL */
 184     Z_TaskPackage *taskPackage;
 185 } bend_esrequest_rr;
 186
 187 typedef struct bend_segment_rr {
 188     Z_Segment *segment;
 189     ODR stream;
 190     ODR decode;
 191     ODR print;
 192     bend_request request;
 193     bend_association association;
 194 } bend_segment_rr;
 195
 196 typedef struct {
 197     ODR stream;
 198     ODR decode;
 199     ODR print;
 200     char *explain_buf;
 201     char *database;
 202     char *schema;
 203 } bend_explain_rr;
 204
 205 typedef struct bend_initrequest
 206 {
 207     Z_IdAuthentication *auth;
 208     ODR stream;                /* encoding stream */
 209     ODR print;                 /* printing stream */
 210     Z_ReferenceId *referenceId;/* reference ID */
 211     char *peer_name;           /* dns host of peer (client) */
 212
 213     char *implementation_id;
 214     char *implementation_name;
 215     char *implementation_version;
 216     int (*bend_sort) (void *handle, bend_sort_rr *rr);
 217     int (*bend_search) (void *handle, bend_search_rr *rr);
 218     int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
 219     int (*bend_present) (void *handle, bend_present_rr *rr);
 220     int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
 221     int (*bend_delete)(void *handle, bend_delete_rr *rr);
 222     int (*bend_scan)(void *handle, bend_scan_rr *rr);
 223     int (*bend_segment)(void *handle, bend_segment_rr *rr);
 224
 225     ODR decode;                 /* decoding stream */
 226     /* character set and language negotiation - see include/yaz/z-charneg.h */
 227     Z_CharSetandLanguageNegotiation *charneg_request;
 228     Z_External *charneg_response;
 229     int (*bend_explain)(void *handle, bend_explain_rr *rr);
 230 } bend_initrequest;
 231
 232 typedef struct bend_initresult
 233 {
 234     int errcode;               /* 0==OK */
 235     char *errstring;           /* system error string or NULL */
 236     void *handle;              /* private handle to the backend module */
 237 } bend_initresult;
 238
 239 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
 240                                    Z_APDU *res);
 241
 242 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
 243
 244 YAZ_EXPORT void bend_request_destroy (bend_request *req);
 245
 246 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
 247 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
 248 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
 249 YAZ_EXPORT void *bend_request_getdata(bend_request r);
 250
 251 typedef struct statserv_options_block
 252 {
 253     int dynamic;                  /* fork on incoming requests */
 254     int threads;                  /* use threads */
 255     int one_shot;                 /* one session then exit(1) */
 256     int loglevel;                 /* desired logging-level */
 257     char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
 258     char logfile[ODR_MAXNAME+1];  /* file for diagnostic output */
 259     char default_listen[1024];    /* 0 == no default listen */
 260     enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
 261     int idle_timeout;             /* how many minutes to wait before closing */
 262     int maxrecordsize;            /* maximum value for negotiation */
 263     char configname[ODR_MAXNAME+1];  /* given to the backend in bend_init */
 264     char setuid[ODR_MAXNAME+1];     /* setuid to this user after binding */
 265     void (*bend_start)(struct statserv_options_block *p);
 266     void (*bend_stop)(struct statserv_options_block *p);
 267     int (*options_func)(int argc, char **argv);
 268     int (*check_ip)(void *cd, const char *addr, int len, int type);
 269     char daemon_name[128];
 270     int inetd;                    /* Do we use the inet deamon or not */
 271
 272     void *handle;                 /* Handle */
 273     bend_initresult *(*bend_init)(bend_initrequest *r);
 274     void (*bend_close)(void *handle);
 275 #ifdef WIN32
 276     /* We only have these members for the windows version */
 277     /* They seemed a bit large to have them there in general */
 278     char service_name[128];         /* NT Service Name */
 279     char app_name[128];             /* Application Name */
 280     char service_dependencies[128]; /* The services we are dependent on */
 281     char service_display_name[128]; /* The service display name */
 282 #endif /* WIN32 */
 283     struct bend_soap_handler *soap_handlers;
 284     char pid_fname[128];            /* pid fname */
 285     int background;                 /* auto daemon */
 286     char cert_fname[128];           /* SSL certificate fname */
 287 } statserv_options_block;
 288
 289 YAZ_EXPORT int statserv_main(
 290     int argc, char **argv,
 291     bend_initresult *(*bend_init)(bend_initrequest *r),
 292     void (*bend_close)(void *handle));
 293 YAZ_EXPORT int statserv_start(int argc, char **argv);
 294 YAZ_EXPORT void statserv_closedown(void);
 295 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
 296 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
 297 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
 298
 299
 300 YAZ_END_CDECL
 301
 302 #endif