kernel/kernel.h

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  11  * Permission to use, copy, modify, distribute, and sell this software and
  12  * its documentation, in whole or in part, for any purpose, is hereby granted,
  13  * provided that:
  14  *
  15  * 1. This copyright and permission notice appear in all copies of the
  16  * software and its documentation. Notices of copyright or attribution
  17  * which appear at the beginning of any file must remain unchanged.
  18  *
  19  * 2. The names of EUROPAGATE or the project partners may not be used to
  20  * endorse or promote products derived from this software without specific
  21  * prior written permission.
  22  *
  23  * 3. Users of this software (implementors and gateway operators) agree to
  24  * inform the EUROPAGATE consortium of their use of the software. This
  25  * information will be used to evaluate the EUROPAGATE project and the
  26  * software, and to plan further developments. The consortium may use
  27  * the information in later publications.
  28  *
  29  * 4. Users of this software agree to make their best efforts, when
  30  * documenting their use of the software, to acknowledge the EUROPAGATE
  31  * consortium, and the role played by the software in their work.
  32  *
  33  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  34  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  35  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  36  * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
  37  * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
  38  * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
  39  * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
  40  * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
  41  * USE OR PERFORMANCE OF THIS SOFTWARE.
  42  *
  43  */
  44 /* Gateway kernel
  45  * Europagate, 1995
  46  *
  47  * $Log: kernel.h,v $
  48  * Revision 1.19  1995/07/11 11:49:12  adam
  49  * LINE_MAX renamed to STR_LINE_MAX.
  50  *
  51  * Revision 1.18  1995/05/16  09:40:42  adam
  52  * LICENSE. Setting of CCL token names (and/or/not/set) in read_kernel_res.
  53  *
  54  * Revision 1.17  1995/05/03  16:34:18  adam
  55  * CCL def command, i.e. user definitions - saved as resource files.
  56  *
  57  * Revision 1.16  1995/05/03  07:37:37  adam
  58  * CCL commands stop/continue implemented. New functions gw_res_{int,bool}
  59  * are used when possible.
  60  *
  61  * Revision 1.15  1995/04/19  13:19:08  adam
  62  * New command: account - for authentication.
  63  *
  64  * Revision 1.14  1995/04/19  10:46:18  adam
  65  * Persistency works much better now. New command: status - history-like
  66  *
  67  * Revision 1.13  1995/04/19  07:31:04  adam
  68  * First work on Z39.50 persistence.
  69  *
  70  * Revision 1.12  1995/04/17  09:34:29  adam
  71  * Timeout (idletime) adjustable. Minor changes in kernel.
  72  *
  73  * Revision 1.11  1995/03/28  11:42:34  adam
  74  * First use of string-queue utility.
  75  *
  76  * Revision 1.10  1995/03/27  08:24:01  adam
  77  * First use of gip interface and gw-db.
  78  * First work on eti program.
  79  *
  80  * Revision 1.9  1995/03/03  17:19:13  adam
  81  * Smarter presentation. Bug fix in email header interpretation.
  82  *
  83  * Revision 1.8  1995/03/01  14:32:24  adam
  84  * Better diagnostics. Default is, that only one database selected when
  85  * several are known.
  86  *
  87  * Revision 1.7  1995/02/23  08:32:16  adam
  88  * Changed header.
  89  *
  90  * Revision 1.5  1995/02/22  15:22:32  adam
  91  * Much more checking of run-time state. Show command never retrieves
  92  * more records than indicated by the previous search request. Help
  93  * command available. The maximum number of records retrieved can be
  94  * controlled now.
  95  *
  96  * Revision 1.4  1995/02/20  21:16:18  adam
  97  * FML support. Bug fixes. Profile for drewdb.
  98  *
  99  * Revision 1.3  1995/02/16  18:35:08  adam
 100  * First use of Zdist library. Search requests are supported.
 101  * Present requests are not supported yet.
 102  *
 103  * Revision 1.2  1995/02/16  13:20:59  adam
 104  * Organization of resource files for targets and conversion
 105  * language implemented.
 106  *
 107  * Revision 1.1  1995/02/15  17:45:29  adam
 108  * First version of email gateway kernel. Email requests are read
 109  * from stdin. The output is transferred to an MTA if 'From' is
 110  * found in the header - or stdout if absent. No Z39.50 client is used.
 111  *
 112  */
 113
 114 #include <gw-res.h>
 115 #include <gw-log.h>
 116 #include <ccl.h>
 117 #include <zaccess.h>
 118
 119 #include <iso2709.h>
 120 #if USE_FML
 121 #include <fmlmarc.h>
 122 #endif
 123 #include <strqueue.h>
 124
 125 #define STR_LINE_MAX 1024
 126
 127 struct gw_user_set {
 128     char   *name;               /* name of result set */
 129     int    hits;                /* -1 on error */
 130     char   *database;           /* database(s) in which we search */
 131     struct ccl_rpn_node *rpn;   /* rpn request */
 132     int    present_flag;        /* present in target (presistency) */
 133     char   *search_str;         /* find request string */
 134     struct gw_user_set *prev;
 135 };
 136
 137 struct gw_kernel_info {
 138     CCL_bibset bibset;
 139     GwRes kernel_res;
 140     const char *default_res;
 141     const char *override_res;
 142     char target[128];
 143     char hostname[128];
 144     char account[128];
 145     int  port;
 146     const char *lang;
 147     const char *override_portno;
 148     const char *override_hostname;
 149     char *databases;
 150     char *database;
 151     ZASS  zass;
 152     int command_no;
 153     char  from_str[STR_LINE_MAX+1];
 154     const char *reply_fname;
 155     int setno;
 156     int next_position;
 157     int userid;
 158 #if USE_FML
 159     Fml   fml;
 160 #endif
 161     struct gw_user_set *sets;
 162 };
 163
 164 extern struct gw_kernel_info info;
 165
 166 extern FILE *reply_fd;
 167
 168 int  urp_start   (int continuation, struct str_queue *queue);
 169 int  urp_command (struct str_queue *queue);
 170 void urp_end     (void);
 171
 172 void read_kernel_res (void);
 173
 174 struct gw_user_set *user_set_add (const char *name, int hits,
 175                                   const char *database,
 176                                   struct ccl_rpn_node *rpn,
 177                                   int present_flag,
 178                                   const char *search_str);
 179 struct gw_user_set *user_set_search (const char *name);
 180 void user_set_init (void);
 181
 182 int lgets (char *buf, int max, int fd);
 183
 184 const struct zass_searchent *zass_p_search (ZASS zass,
 185                                       struct ccl_rpn_node *rpn,
 186                                       const char *result_set,
 187                                       const char *database,
 188                                       struct gw_user_set *sets);
 189 const struct zass_presentent *zass_p_present (ZASS zass,
 190                                       const char *result_set,
 191                                       int offset, int number);
 192
 193 int load_p_state (int userid);
 194 int save_p_state (int userid);
 195 void del_p_state (int userid);
 196 int reopen_target (void);
 197
 198 #define KERNEL_LOG "kernel"