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