include/yaz/backend.h

   1 /*
   2  * Copyright (c) 1995-2000, 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  * $Log: backend.h,v $
  27  * Revision 1.7  2000-04-05 07:39:55  adam
  28  * Added shared library support (libtool).
  29  *
  30  * Revision 1.6  2000/03/20 19:06:25  adam
  31  * Added Segment request for fronend server. Work on admin for client.
  32  *
  33  * Revision 1.5  2000/03/15 12:59:49  adam
  34  * Added handle member to statserv_control.
  35  *
  36  * Revision 1.4  2000/02/28 11:20:06  adam
  37  * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
  38  *
  39  * Revision 1.3  2000/01/12 14:36:07  adam
  40  * Added printing stream (ODR) for backend functions.
  41  *
  42  * Revision 1.2  1999/12/16 23:36:19  adam
  43  * Implemented ILL protocol. Minor updates ASN.1 compiler.
  44  *
  45  * Revision 1.1  1999/11/30 13:47:11  adam
  46  * Improved installation. Moved header files to include/yaz.
  47  *
  48  * Revision 1.28  1999/11/04 14:58:44  adam
  49  * Added status elements for backend delete result set handler.
  50  * Updated delete result result set command for client.
  51  *
  52  * Revision 1.27  1999/10/11 10:01:24  adam
  53  * Implemented bend_sort_rr handler for frontend server.
  54  *
  55  * Revision 1.26  1999/06/17 10:54:44  adam
  56  * Added facility to specify implementation version - and name
  57  * for server.
  58  *
  59  * Revision 1.25  1999/06/01 14:29:12  adam
  60  * Work on Extended Services.
  61  *
  62  * Revision 1.24  1999/03/31 11:18:24  adam
  63  * Implemented odr_strdup. Added Reference ID to backend server API.
  64  *
  65  * Revision 1.23  1998/10/13 16:12:23  adam
  66  * Added support for Surrogate Diagnostics for Scan Term entries.
  67  *
  68  * Revision 1.22  1998/09/02 12:41:51  adam
  69  * Added decode stream in bend search structures.
  70  *
  71  * Revision 1.21  1998/07/20 12:38:41  adam
  72  * Implemented delete result set service to server API.
  73  *
  74  * Revision 1.20  1998/05/27 16:57:06  adam
  75  * Support for surrogate diagnostic records added for bend_fetch.
  76  *
  77  * Revision 1.19  1998/03/31 11:07:45  adam
  78  * Furhter work on UNIverse resource report.
  79  * Added Extended Services handling in frontend server.
  80  *
  81  * Revision 1.18  1998/02/10 11:03:56  adam
  82  * Added support for extended handlers in backend server interface.
  83  *
  84  * Revision 1.17  1998/01/29 13:15:35  adam
  85  * Implemented sort for the backend interface.
  86  *
  87  * Revision 1.16  1997/09/17 12:10:31  adam
  88  * YAZ version 1.4.
  89  *
  90  */
  91
  92 #ifndef BACKEND_H
  93 #define BACKEND_H
  94
  95 #include <yaz/yconfig.h>
  96 #include <yaz/proto.h>
  97
  98 YAZ_BEGIN_CDECL
  99
 100 typedef struct request *bend_request;
 101 typedef struct association *bend_association;
 102
 103 /* extended search handler (rr = request response) */
 104 typedef struct {
 105     char *setname;             /* name to give to this set */
 106     int replace_set;           /* replace set, if it already exists */
 107     int num_bases;             /* number of databases in list */
 108     char **basenames;          /* databases to search */
 109     Z_ReferenceId *referenceId;/* reference ID */
 110     Z_Query *query;            /* query structure */
 111     ODR stream;                /* encode stream */
 112     ODR decode;                /* decode stream */
 113     ODR print;                 /* print stream */
 114
 115     bend_request request;
 116     bend_association association;
 117     int *fd;
 118     int hits;                  /* number of hits */
 119     int errcode;               /* 0==OK */
 120     char *errstring;           /* system error string or NULL */
 121 } bend_search_rr;
 122
 123 /* extended present handler. Does not replace bend_fetch. */
 124 typedef struct {
 125     char *setname;             /* set name */
 126     int start;
 127     int number;                /* record number */
 128     oid_value format;          /* One of the CLASS_RECSYN members */
 129     Z_ReferenceId *referenceId;/* reference ID */
 130     Z_RecordComposition *comp; /* Formatting instructions */
 131     ODR stream;                /* encoding stream - memory source if required */
 132     ODR print;                 /* printing stream */
 133     bend_request request;
 134     bend_association association;
 135
 136     int hits;                  /* number of hits */
 137     int errcode;               /* 0==OK */
 138     char *errstring;           /* system error string or NULL */
 139 } bend_present_rr;
 140
 141 typedef struct bend_fetch_rr {
 142     char *setname;             /* set name */
 143     int number;                /* record number */
 144     Z_ReferenceId *referenceId;/* reference ID */
 145     oid_value request_format;  /* One of the CLASS_RECSYN members */
 146     Z_RecordComposition *comp; /* Formatting instructions */
 147     ODR stream;                /* encoding stream - memory source if req */
 148     ODR print;                 /* printing stream */
 149
 150     char *basename;            /* name of database that provided record */
 151     int len;                   /* length of record or -1 if structured */
 152     char *record;              /* record */
 153     int last_in_set;           /* is it?  */
 154     oid_value output_format;   /* format */
 155     int errcode;               /* 0==success */
 156     char *errstring;           /* system error string or NULL */
 157     int surrogate_flag;        /* surrogate diagnostic */
 158 } bend_fetch_rr;
 159
 160 struct scan_entry {
 161     char *term;         /* the returned scan term */
 162     int occurrences;    /* no of occurrences or -1 if error (see below) */
 163     int errcode;        /* Bib-1 diagnostic code; only used when occur.= -1 */
 164     char *errstring;    /* Additional string */
 165 };
 166
 167 typedef enum {
 168     BEND_SCAN_SUCCESS,  /* ok */
 169     BEND_SCAN_PARTIAL   /* not all entries could be found */
 170 } bend_scan_status;
 171
 172 typedef struct bend_scan_rr {
 173     int num_bases;      /* number of elements in databaselist */
 174     char **basenames;   /* databases to search */
 175     oid_value attributeset;
 176     Z_ReferenceId *referenceId; /* reference ID */
 177     Z_AttributesPlusTerm *term;
 178     ODR stream;         /* encoding stream - memory source if required */
 179     ODR print;          /* printing stream */
 180
 181     int term_position;  /* desired index of term in result list/returned */
 182     int num_entries;    /* number of entries requested/returned */
 183
 184     struct scan_entry *entries;
 185     bend_scan_status status;
 186     int errcode;
 187     char *errstring;
 188 } bend_scan_rr;
 189
 190 /* delete handler */
 191 typedef struct bend_delete_rr {
 192     int function;
 193     int num_setnames;
 194     char **setnames;
 195     Z_ReferenceId *referenceId;
 196     int delete_status;      /* status for the whole operation */
 197     int *statuses;          /* status each set - indexed as setnames */
 198     ODR stream;
 199     ODR print;
 200 } bend_delete_rr;
 201
 202 /* sort handler */
 203 typedef struct bend_sort_rr
 204 {
 205     int num_input_setnames;
 206     char **input_setnames;
 207     char *output_setname;
 208     Z_SortKeySpecList *sort_sequence;
 209     ODR stream;
 210     ODR print;
 211     Z_ReferenceId *referenceId;/* reference ID */
 212
 213     int sort_status;
 214     int errcode;
 215     char *errstring;
 216 } bend_sort_rr;
 217
 218 typedef struct bend_esrequest_rr
 219 {
 220     int ItemNo;
 221     Z_ExtendedServicesRequest *esr;
 222
 223     ODR stream;                /* encoding stream */
 224     ODR decode;                /* decoding stream */
 225     ODR print;                 /* printing stream */
 226     Z_ReferenceId *referenceId;/* reference ID */
 227     bend_request request;
 228     bend_association association;
 229     int errcode;               /* 0==success, -1==accepted, >0 = failure */
 230     char *errstring;           /* system error string or NULL */
 231 } bend_esrequest_rr;
 232
 233 typedef struct bend_segment_rr {
 234     Z_Segment *segment;
 235     ODR stream;
 236     ODR decode;
 237     ODR print;
 238     bend_request request;
 239     bend_association association;
 240 } bend_segment_rr;
 241
 242 typedef struct bend_initrequest
 243 {
 244     Z_IdAuthentication *auth;
 245     ODR stream;                /* encoding stream */
 246     ODR print;                 /* printing stream */
 247     Z_ReferenceId *referenceId;/* reference ID */
 248
 249     char *implementation_name;
 250     char *implementation_version;
 251     int (*bend_sort) (void *handle, bend_sort_rr *rr);
 252     int (*bend_search) (void *handle, bend_search_rr *rr);
 253     int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
 254     int (*bend_present) (void *handle, bend_present_rr *rr);
 255     int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
 256     int (*bend_delete)(void *handle, bend_delete_rr *rr);
 257     int (*bend_scan)(void *handle, bend_scan_rr *rr);
 258     int (*bend_segment)(void *handle, bend_segment_rr *rr);
 259 } bend_initrequest;
 260
 261 typedef struct bend_initresult
 262 {
 263     int errcode;               /* 0==OK */
 264     char *errstring;           /* system error string or NULL */
 265     void *handle;              /* private handle to the backend module */
 266 } bend_initresult;
 267
 268 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
 269                                    Z_APDU *res);
 270
 271 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
 272
 273 YAZ_EXPORT void bend_request_destroy (bend_request *req);
 274
 275 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
 276 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
 277 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
 278 YAZ_EXPORT void *bend_request_getdata(bend_request r);
 279
 280 typedef struct statserv_options_block
 281 {
 282     int dynamic;                  /* fork on incoming requests */
 283     int threads;                  /* use threads */
 284     int one_shot;                 /* one session then exit(1) */
 285     int loglevel;                 /* desired logging-level */
 286     char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
 287     char logfile[ODR_MAXNAME+1];  /* file for diagnostic output */
 288     char default_listen[1024];    /* 0 == no default listen */
 289     enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
 290     int idle_timeout;             /* how many minutes to wait before closing */
 291     int maxrecordsize;            /* maximum value for negotiation */
 292     char configname[ODR_MAXNAME+1];  /* given to the backend in bend_init */
 293     char setuid[ODR_MAXNAME+1];     /* setuid to this user after binding */
 294     void (*bend_start)(struct statserv_options_block *p);
 295     void (*bend_stop)(struct statserv_options_block *p);
 296     int (*options_func)(int argc, char **argv);
 297     int (*check_ip)(void *cd, const char *addr, int len, int type);
 298     char daemon_name[128];
 299     int inetd;                    /* Do we use the inet deamon or not */
 300
 301     void *handle;                 /* Handle */
 302     bend_initresult *(*bend_init)(bend_initrequest *r);
 303     void (*bend_close)(void *handle);
 304 #ifdef WIN32
 305     /* We only have these members for the windows version */
 306     /* They seemed a bit large to have them there in general */
 307     char service_name[128];         /* NT Service Name */
 308     char app_name[128];             /* Application Name */
 309     char service_dependencies[128]; /* The services we are dependent on */
 310     char service_display_name[128]; /* The service display name */
 311 #endif /* WIN32 */
 312 } statserv_options_block;
 313
 314 YAZ_EXPORT int statserv_main(
 315     int argc, char **argv,
 316     bend_initresult *(*bend_init)(bend_initrequest *r),
 317     void (*bend_close)(void *handle));
 318 YAZ_EXPORT int statserv_start(int argc, char **argv);
 319 YAZ_EXPORT void statserv_closedown(void);
 320 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
 321 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
 322 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
 323
 324 YAZ_END_CDECL
 325
 326 #endif