index/zserver.h

   1 /*
   2  * Copyright (C) 1994-1999, Index Data
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: zserver.h,v $
   7  * Revision 1.41  1999-05-12 13:08:06  adam
   8  * First version of ISAMS.
   9  *
  10  * Revision 1.40  1998/11/16 16:03:45  adam
  11  * Moved loggin utilities to Yaz. Was implemented in file zlogs.c.
  12  *
  13  * Revision 1.39  1998/10/16 08:14:35  adam
  14  * Updated record control system.
  15  *
  16  * Revision 1.38  1998/09/22 10:03:44  adam
  17  * Changed result sets to be persistent in the sense that they can
  18  * be re-searched if needed.
  19  * Fixed memory leak in rsm_or.
  20  *
  21  * Revision 1.37  1998/09/02 13:53:22  adam
  22  * Extra parameter decode added to search routines to implement
  23  * persistent queries.
  24  *
  25  * Revision 1.36  1998/06/24 12:16:16  adam
  26  * Support for relations on text operands. Open range support in
  27  * DFA module (i.e. [-j], [g-]).
  28  *
  29  * Revision 1.35  1998/06/23 15:33:35  adam
  30  * Added feature to specify sort criteria in query (type 7 specifies
  31  * sort flags).
  32  *
  33  * Revision 1.34  1998/06/22 11:36:50  adam
  34  * Added authentication check facility to zebra.
  35  *
  36  * Revision 1.33  1998/06/12 12:22:14  adam
  37  * Work on Zebra API.
  38  *
  39  * Revision 1.32  1998/05/27 16:57:47  adam
  40  * Zebra returns surrogate diagnostic for single records when
  41  * appropriate.
  42  *
  43  * Revision 1.31  1998/05/20 10:12:23  adam
  44  * Implemented automatic EXPLAIN database maintenance.
  45  * Modified Zebra to work with ASN.1 compiled version of YAZ.
  46  *
  47  * Revision 1.30  1998/03/05 08:45:13  adam
  48  * New result set model and modular ranking system. Moved towards
  49  * descent server API. System information stored as "SGML" records.
  50  *
  51  * Revision 1.29  1998/02/10 12:03:06  adam
  52  * Implemented Sort.
  53  *
  54  * Revision 1.28  1998/01/29 13:40:11  adam
  55  * Better logging for scan service.
  56  *
  57  * Revision 1.27  1997/10/27 14:33:06  adam
  58  * Moved towards generic character mapping depending on "structure"
  59  * field in abstract syntax file. Fixed a few memory leaks. Fixed
  60  * bug with negative integers when doing searches with relational
  61  * operators.
  62  *
  63  * Revision 1.26  1997/09/29 12:41:35  adam
  64  * Fixed bug regarding USE_TIMES var.
  65  *
  66  * Revision 1.25  1997/09/29 09:08:36  adam
  67  * Revised locking system to be thread safe for the server.
  68  *
  69  * Revision 1.24  1997/09/17 12:19:19  adam
  70  * Zebra version corresponds to YAZ version 1.4.
  71  * Changed Zebra server so that it doesn't depend on global common_resource.
  72  *
  73  * Revision 1.23  1996/12/23 15:30:46  adam
  74  * Work on truncation.
  75  * Bug fix: result sets weren't deleted after server shut down.
  76  *
  77  * Revision 1.22  1996/11/04 14:07:49  adam
  78  * Moved truncation code to trunc.c.
  79  *
  80  * Revision 1.21  1996/10/29 14:09:58  adam
  81  * Use of cisam system - enabled if setting isamc is 1.
  82  *
  83  * Revision 1.20  1996/06/04 10:19:02  adam
  84  * Minor changes - removed include of ctype.h.
  85  *
  86  * Revision 1.19  1996/05/14  11:34:01  adam
  87  * Scan support in multiple registers/databases.
  88  *
  89  * Revision 1.18  1996/05/14  06:16:50  adam
  90  * Compact use/set bytes used in search service.
  91  *
  92  * Revision 1.17  1995/12/08 16:22:57  adam
  93  * Work on update while servers are running. Three lock files introduced.
  94  * The servers reload their registers when necessary, but they don't
  95  * reestablish result sets yet.
  96  *
  97  * Revision 1.16  1995/12/07  17:38:48  adam
  98  * Work locking mechanisms for concurrent updates/commit.
  99  *
 100  * Revision 1.15  1995/11/21  15:29:13  adam
 101  * Config file 'base' read by default by both indexer and server.
 102  *
 103  * Revision 1.14  1995/11/16  17:00:57  adam
 104  * Better logging of rpn query.
 105  *
 106  * Revision 1.13  1995/11/16  15:34:56  adam
 107  * Uses new record management system in both indexer and server.
 108  *
 109  * Revision 1.12  1995/10/27  14:00:12  adam
 110  * Implemented detection of database availability.
 111  *
 112  * Revision 1.11  1995/10/17  18:02:12  adam
 113  * New feature: databases. Implemented as prefix to words in dictionary.
 114  *
 115  * Revision 1.10  1995/10/09  16:18:38  adam
 116  * Function dict_lookup_grep got extra client data parameter.
 117  *
 118  * Revision 1.9  1995/10/06  14:38:01  adam
 119  * New result set method: r_score.
 120  * Local no (sysno) and score is transferred to retrieveCtrl.
 121  *
 122  * Revision 1.8  1995/10/06  13:52:06  adam
 123  * Bug fixes. Handler may abort further scanning.
 124  *
 125  * Revision 1.7  1995/10/06  10:43:57  adam
 126  * Scan added. 'occurrences' in scan entries not set yet.
 127  *
 128  * Revision 1.6  1995/09/28  09:19:48  adam
 129  * xfree/xmalloc used everywhere.
 130  * Extract/retrieve method seems to work for text records.
 131  *
 132  * Revision 1.5  1995/09/27  16:17:32  adam
 133  * More work on retrieve.
 134  *
 135  * Revision 1.4  1995/09/14  11:53:28  adam
 136  * First work on regular expressions/truncations.
 137  *
 138  * Revision 1.3  1995/09/08  08:53:23  adam
 139  * Record buffer maintained in server_info.
 140  *
 141  * Revision 1.2  1995/09/06  16:11:19  adam
 142  * Option: only one word key per file.
 143  *
 144  * Revision 1.1  1995/09/05  15:28:40  adam
 145  * More work on search engine.
 146  *
 147  */
 148
 149
 150 #ifndef USE_TIMES
 151 #ifdef __linux__
 152 #define USE_TIMES 1
 153 #else
 154 #define USE_TIMES 0
 155 #endif
 156 #endif
 157
 158 #if USE_TIMES
 159 #include <sys/times.h>
 160 #endif
 161
 162 #include <backend.h>
 163 #include <rset.h>
 164
 165 #include <sortidx.h>
 166 #include <passwddb.h>
 167 #include "index.h"
 168 #include "zebraapi.h"
 169 #include "zinfo.h"
 170
 171 typedef struct {
 172     int sysno;
 173     int score;
 174 } *ZebraPosSet;
 175
 176 typedef struct zebra_set *ZebraSet;
 177
 178 typedef struct zebra_rank_class {
 179     struct rank_control *control;
 180     int init_flag;
 181     void *class_handle;
 182     struct zebra_rank_class *next;
 183 } *ZebraRankClass;
 184
 185 struct zebra_info {
 186     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 187     time_t registerChange;
 188     ZebraSet sets;
 189     Dict dict;
 190     SortIdx sortIdx;
 191     ISAM isam;
 192     ISAMC isamc;
 193     ISAMS isams;
 194     Records records;
 195     int errCode;
 196     int hits;
 197     char *errString;
 198     ZebraExplainInfo zei;
 199     data1_handle dh;
 200     BFiles bfs;
 201     Res res;
 202
 203     ZebraLockHandle server_lock_cmt;
 204     ZebraLockHandle server_lock_org;
 205     char *server_path_prefix;
 206 #if USE_TIMES
 207     struct tms tms1;
 208     struct tms tms2;
 209 #endif
 210     ZebraMaps zebra_maps;
 211     ZebraRankClass rank_classes;
 212     RecTypes recTypes;
 213     Passwd_db passwd_db;
 214 };
 215
 216
 217 struct rank_control {
 218     char *name;
 219     void *(*create)(ZebraHandle zh);
 220     void (*destroy)(ZebraHandle zh, void *class_handle);
 221     void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
 222     void (*end)(ZebraHandle zh, void *set_handle);
 223     int (*calc)(void *set_handle, int sysno);
 224     void (*add)(void *set_handle, int seqno, int term_index);
 225 };
 226
 227 RSET rpn_search (ZebraHandle zh, NMEM mem,
 228                  Z_RPNQuery *rpn, int num_bases, char **basenames,
 229                  const char *setname, ZebraSet sset);
 230
 231
 232 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 233                oid_value attributeset,
 234                int num_bases, char **basenames,
 235                int *position, int *num_entries, ZebraScanEntry **list,
 236                int *is_partial);
 237
 238 RSET rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
 239                  const char *term, int length_term, const char *flags);
 240
 241 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 242 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 243 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode,                                         Z_RPNQuery *rpn, int num_bases, char **basenames,
 244                           const char *setname);
 245 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
 246 void resultSetDestroy (ZebraHandle zh);
 247
 248 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
 249                                int num, int *positions);
 250 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
 251
 252 void resultSetSort (ZebraHandle zh, NMEM nmem,
 253                     int num_input_setnames, const char **input_setnames,
 254                     const char *output_setname,
 255                     Z_SortKeySpecList *sort_sequence, int *sort_status);
 256 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 257                           ZebraSet sset, RSET rset,
 258                           Z_SortKeySpecList *sort_sequence, int *sort_status);
 259 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
 260
 261 void zebra_sort (ZebraHandle zh, ODR stream,
 262                  int num_input_setnames, const char **input_setnames,
 263                  const char *output_setname, Z_SortKeySpecList *sort_sequence,
 264                  int *sort_status);
 265
 266 int zebra_server_lock_init (ZebraHandle zh);
 267 int zebra_server_lock_destroy (ZebraHandle zh);
 268 int zebra_server_lock (ZebraHandle zh, int lockCommit);
 269 void zebra_server_unlock (ZebraHandle zh, int commitPhase);
 270 int zebra_server_lock_get_state (ZebraHandle zh, time_t *timep);
 271
 272 typedef struct attent
 273 {
 274     int attset_ordinal;
 275     data1_local_attribute *local_attributes;
 276 } attent;
 277
 278 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl);
 279 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 280 void zebraRankDestroy (ZebraHandle zh);
 281
 282 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
 283
 284 extern struct rank_control *rank1_class;
 285
 286 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
 287                         oid_value input_format, Z_RecordComposition *comp,
 288                         oid_value *output_format, char **rec_bufp,
 289                         int *rec_lenp, char **basenamep);
 290