include/yaz/backend.h

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