include/yaz/backend.h

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