index/zserver.h

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