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