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