index/zserver.h

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