YAZ: backend.h Source File

00001 /* This file is part of the YAZ toolkit.
00002  * Copyright (C) 1995-2008 Index Data.
00003  * All rights reserved.
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions are met:
00006  *
00007  *     * Redistributions of source code must retain the above copyright
00008  *       notice, this list of conditions and the following disclaimer.
00009  *     * Redistributions in binary form must reproduce the above copyright
00010  *       notice, this list of conditions and the following disclaimer in the
00011  *       documentation and/or other materials provided with the distribution.
00012  *     * Neither the name of Index Data nor the names of its contributors
00013  *       may be used to endorse or promote products derived from this
00014  *       software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
00017  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00018  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
00020  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00021  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00022  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00023  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00025  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00036 #ifndef BACKEND_H
00037 #define BACKEND_H
00038 
00039 #include <yaz/yconfig.h>
00040 #include <yaz/proto.h>
00041 #include <yaz/srw.h>
00042 #include <yaz/oid_db.h>
00043 
00044 YAZ_BEGIN_CDECL
00045     
00046 typedef struct request *bend_request;
00047 typedef struct association *bend_association;
00048 
00050 typedef struct {
00051     char *setname;             /* name to give to this set */
00052     int replace_set;           /* replace set, if it already exists */
00053     int num_bases;             /* number of databases in list */
00054     char **basenames;          /* databases to search */
00055     Z_ReferenceId *referenceId;/* reference ID */
00056     Z_Query *query;            /* query structure */
00057     ODR stream;                /* encode stream */
00058     ODR decode;                /* decode stream */
00059     ODR print;                 /* print stream */
00060 
00061     bend_request request;
00062     bend_association association;
00063     int *fd;
00064     int hits;                  /* number of hits */
00065     int errcode;               /* 0==OK */
00066     char *errstring;           /* system error string or NULL */
00067     Z_OtherInformation *search_info; /* additional search info */
00068     char *srw_sortKeys;        /* holds SRU/SRW sortKeys info */
00069     char *srw_setname;         /* holds SRU/SRW generated resultsetID */
00070     int *srw_setnameIdleTime;  /* holds SRU/SRW life-time */
00071     int estimated_hit_count;   /* if hit count is estimated */
00072     int partial_resultset;     /* if result set is partial */
00073 } bend_search_rr;
00074 
00076 typedef struct {
00077     char *setname;             /* set name */
00078     int start;
00079     int number;                /* record number */
00080     Odr_oid *format;           /* format, transfer syntax (OID) */
00081     Z_ReferenceId *referenceId;/* reference ID */
00082     Z_RecordComposition *comp; /* Formatting instructions */
00083     ODR stream;                /* encoding stream - memory source if required */
00084     ODR print;                 /* printing stream */
00085     bend_request request;
00086     bend_association association;
00087 
00088     int hits;                  /* number of hits */
00089     int errcode;               /* 0==OK */
00090     char *errstring;           /* system error string or NULL */
00091 } bend_present_rr;
00092 
00094 typedef struct bend_fetch_rr {
00095     char *setname;             /* set name */
00096     int number;                /* record number */
00097     Z_ReferenceId *referenceId;/* reference ID */
00098     Odr_oid *request_format;        /* format, transfer syntax (OID) */
00099     Z_RecordComposition *comp; /* Formatting instructions */
00100     ODR stream;                /* encoding stream - memory source if req */
00101     ODR print;                 /* printing stream */
00102 
00103     char *basename;            /* name of database that provided record */
00104     int len;                   /* length of record or -1 if structured */
00105     char *record;              /* record */
00106     int last_in_set;           /* is it?  */
00107     Odr_oid *output_format;        /* response format/syntax (OID) */
00108     int errcode;               /* 0==success */
00109     char *errstring;           /* system error string or NULL */
00110     int surrogate_flag;        /* surrogate diagnostic */
00111     char *schema;              /* string record schema input/output */
00112 } bend_fetch_rr;
00113 
00115 struct scan_entry {
00116     char *term;         /* the returned scan term */
00117     int occurrences;    /* no of occurrences or -1 if error (see below) */
00118     int errcode;        /* Bib-1 diagnostic code; only used when occur.= -1 */
00119     char *errstring;    /* Additional string */
00120     char *display_term;
00121 };
00122 
00123 typedef enum {
00124     BEND_SCAN_SUCCESS,  /* ok */
00125     BEND_SCAN_PARTIAL   /* not all entries could be found */
00126 } bend_scan_status;
00127 
00129 typedef struct bend_scan_rr {
00130     int num_bases;      /* number of elements in databaselist */
00131     char **basenames;   /* databases to search */
00132     Odr_oid *attributeset;
00133     Z_ReferenceId *referenceId; /* reference ID */
00134     Z_AttributesPlusTerm *term;
00135     ODR stream;         /* encoding stream - memory source if required */
00136     ODR print;          /* printing stream */
00137 
00138     int *step_size;     /* step size */
00139     int term_position;  /* desired index of term in result list/returned */
00140     int num_entries;    /* number of entries requested/returned */
00141 
00142     /* scan term entries. The called handler does not have
00143        to allocate this. Size of entries is num_entries (see above) */
00144     struct scan_entry *entries;
00145     bend_scan_status status;
00146     int errcode;
00147     char *errstring;
00148     char *scanClause;   /* CQL scan clause */
00149     char *setname;      /* Scan in result set (NULL if omitted) */
00150 } bend_scan_rr;
00151 
00153 typedef struct bend_update_rr {
00154     int num_bases;      /* number of elements in databaselist */
00155     char **basenames;   /* databases to search */
00156     Z_ReferenceId *referenceId; /* reference ID */
00157     ODR stream;         /* encoding stream - memory source if required */
00158     ODR print;          /* printing stream */
00159     char *operation;
00160     char *operation_status;
00161     char *record_id;
00162     Z_SRW_recordVersion *record_versions;
00163     int num_versions;
00164     char *record_packing;
00165     char *record_schema;
00166     char *record_data;
00167     char *extra_record_data;
00168     char *extra_request_data;
00169     char *extra_response_data;
00170     char *uri;
00171     char *message;
00172     char *details;
00173 } bend_update_rr;
00174 
00176 typedef struct bend_delete_rr {
00177     int function;
00178     int num_setnames;
00179     char **setnames;
00180     Z_ReferenceId *referenceId;
00181     int delete_status;      /* status for the whole operation */
00182     int *statuses;          /* status each set - indexed as setnames */
00183     ODR stream;
00184     ODR print; 
00185 } bend_delete_rr;
00186 
00188 typedef struct bend_sort_rr
00189 {
00190     int num_input_setnames;
00191     char **input_setnames;
00192     char *output_setname;
00193     Z_SortKeySpecList *sort_sequence;
00194     ODR stream;
00195     ODR print;
00196     Z_ReferenceId *referenceId;/* reference ID */
00197 
00198     int sort_status;
00199     int errcode;
00200     char *errstring;
00201 } bend_sort_rr;
00202 
00204 typedef struct bend_esrequest_rr
00205 {
00206     int ItemNo;
00207     Z_ExtendedServicesRequest *esr;
00208     
00209     ODR stream;                /* encoding stream */
00210     ODR decode;                /* decoding stream */
00211     ODR print;                 /* printing stream */
00212     Z_ReferenceId *referenceId;/* reference ID */
00213     bend_request request;
00214     bend_association association;
00215     int errcode;               /* 0==success, -1==accepted, >0 = failure */
00216     char *errstring;           /* system error string or NULL */
00217     Z_TaskPackage *taskPackage;
00218 } bend_esrequest_rr;
00219 
00221 typedef struct bend_segment_rr {
00222     Z_Segment *segment;
00223     ODR stream;
00224     ODR decode;
00225     ODR print;
00226     bend_request request;
00227     bend_association association;
00228 } bend_segment_rr;
00229 
00231 typedef struct {
00232     ODR stream;
00233     ODR decode;
00234     ODR print;
00235     char *explain_buf;
00236     char *database;
00237     char *schema;
00238     void *server_node_ptr;
00239 } bend_explain_rr;
00240 
00247 typedef struct bend_initrequest
00248 {
00250     Z_IdAuthentication *auth; 
00252     ODR stream;
00254     ODR print;
00256     ODR decode; 
00258     Z_ReferenceId *referenceId;
00260     char *peer_name;           
00261     
00266     Z_CharSetandLanguageNegotiation *charneg_request;
00267 
00269     Z_External *charneg_response;
00270 
00275     char *query_charset;      
00276 
00282     int records_in_same_charset;
00283 
00284     char *implementation_id;
00285     char *implementation_name;
00286     char *implementation_version;
00287 
00289     int (*bend_sort)(void *handle, bend_sort_rr *rr);
00291     int (*bend_search)(void *handle, bend_search_rr *rr);
00293     int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
00295     int (*bend_present)(void *handle, bend_present_rr *rr);
00297     int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
00299     int (*bend_delete)(void *handle, bend_delete_rr *rr);
00301     int (*bend_scan)(void *handle, bend_scan_rr *rr);
00303     int (*bend_segment)(void *handle, bend_segment_rr *rr);
00305     int (*bend_explain)(void *handle, bend_explain_rr *rr);
00307     int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
00309     int (*bend_srw_update)(void *handle, bend_update_rr *rr);
00310 
00311 } bend_initrequest;
00312 
00314 typedef struct bend_initresult
00315 {
00316     int errcode;               /* 0==OK */
00317     char *errstring;           /* system error string or NULL */
00318     void *handle;              /* private handle to the backend module */
00319 } bend_initresult;
00320 
00321 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
00322                                    Z_APDU *res);
00323 
00324 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
00325 
00326 YAZ_EXPORT void bend_request_destroy (bend_request *req);
00327 
00328 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
00329 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
00330 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
00331 YAZ_EXPORT void *bend_request_getdata(bend_request r);
00332 
00334 typedef struct statserv_options_block
00335 {
00336     int dynamic;                  /* fork on incoming requests */
00337     int threads;                  /* use threads */
00338     int one_shot;                 /* one session then exit(1) */
00339     char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
00340     char logfile[ODR_MAXNAME+1];  /* file for diagnostic output */
00341     char default_listen[1024];    /* 0 == no default listen */
00342     enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */ 
00343     int idle_timeout;             /* how many minutes to wait before closing */
00344     int maxrecordsize;            /* maximum value for negotiation */
00345     char configname[ODR_MAXNAME+1];  /* given to the backend in bend_init */
00346     char setuid[ODR_MAXNAME+1];     /* setuid to this user after binding */
00347     void (*bend_start)(struct statserv_options_block *p);
00348     void (*bend_stop)(struct statserv_options_block *p);
00349     int (*options_func)(int argc, char **argv);
00350     int (*check_ip)(void *cd, const char *addr, int len, int type);
00351     char daemon_name[128];
00352     int inetd;                    /* Do we use the inet deamon or not */
00353 
00354     void *handle;                 /* Handle */
00355     bend_initresult *(*bend_init)(bend_initrequest *r);
00356     void (*bend_close)(void *handle);
00357 #ifdef WIN32
00358     /* We only have these members for the windows version */
00359     /* They seemed a bit large to have them there in general */
00360     char service_name[128];         /* NT Service Name */
00361     char app_name[128];             /* Application Name */
00362     char service_dependencies[128]; /* The services we are dependent on */
00363     char service_display_name[128]; /* The service display name */
00364 #endif /* WIN32 */
00365     struct bend_soap_handler *soap_handlers;
00366     char pid_fname[128];            /* pid fname */
00367     int background;                 /* auto daemon */
00368     char cert_fname[128];           /* SSL certificate fname */
00369     char xml_config[128];           /* XML config filename */
00370 } statserv_options_block;
00371 
00372 YAZ_EXPORT int statserv_main(
00373     int argc, char **argv,
00374     bend_initresult *(*bend_init)(bend_initrequest *r),
00375     void (*bend_close)(void *handle));
00376 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
00377 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
00378 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
00379 
00380 YAZ_EXPORT int bend_assoc_is_alive(bend_association assoc);
00381 
00382 YAZ_END_CDECL
00383 
00384 #endif
00385 /*
00386  * Local variables:
00387  * c-basic-offset: 4
00388  * indent-tabs-mode: nil
00389  * End:
00390  * vim: shiftwidth=4 tabstop=8 expandtab
00391  */
00392