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