index/zserver.c

   1 /*
   2  * Copyright (C) 1995-1998, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: zserver.c,v $
   7  * Revision 1.59  1998-06-12 12:22:13  adam
   8  * Work on Zebra API.
   9  *
  10  * Revision 1.58  1998/05/27 16:57:46  adam
  11  * Zebra returns surrogate diagnostic for single records when
  12  * appropriate.
  13  *
  14  * Revision 1.57  1998/04/03 14:45:18  adam
  15  * Fixed setting of last_in_set in bend_fetch.
  16  *
  17  * Revision 1.56  1998/03/05 08:45:13  adam
  18  * New result set model and modular ranking system. Moved towards
  19  * descent server API. System information stored as "SGML" records.
  20  *
  21  * Revision 1.55  1998/02/10 12:03:06  adam
  22  * Implemented Sort.
  23  *
  24  * Revision 1.54  1998/01/29 13:39:13  adam
  25  * Compress ISAM is default.
  26  *
  27  * Revision 1.53  1998/01/12 15:04:09  adam
  28  * The test option (-s) only uses read-lock (and not write lock).
  29  *
  30  * Revision 1.52  1997/11/18 10:05:08  adam
  31  * Changed character map facility so that admin can specify character
  32  * mapping files for each register type, w, p, etc.
  33  *
  34  * Revision 1.51  1997/10/27 14:33:06  adam
  35  * Moved towards generic character mapping depending on "structure"
  36  * field in abstract syntax file. Fixed a few memory leaks. Fixed
  37  * bug with negative integers when doing searches with relational
  38  * operators.
  39  *
  40  * Revision 1.50  1997/09/29 09:08:36  adam
  41  * Revised locking system to be thread safe for the server.
  42  *
  43  * Revision 1.49  1997/09/25 14:57:23  adam
  44  * Windows NT port.
  45  *
  46  * Revision 1.48  1997/09/17 12:19:19  adam
  47  * Zebra version corresponds to YAZ version 1.4.
  48  * Changed Zebra server so that it doesn't depend on global common_resource.
  49  *
  50  * Revision 1.47  1997/09/04 13:58:36  adam
  51  * New retrieve/extract method tellf (added).
  52  * Added O_BINARY for open calls.
  53  *
  54  * Revision 1.46  1997/07/28 08:30:47  adam
  55  * Server returns diagnostic 14 when record doesn't exist.
  56  *
  57  * Revision 1.45  1996/12/23 15:30:45  adam
  58  * Work on truncation.
  59  * Bug fix: result sets weren't deleted after server shut down.
  60  *
  61  * Revision 1.44  1996/12/11 12:08:01  adam
  62  * Added better compression.
  63  *
  64  * Revision 1.43  1996/11/15 15:03:58  adam
  65  * Logging of execution speed by using the times(2) call.
  66  *
  67  * Revision 1.42  1996/11/08  11:10:36  adam
  68  * Buffers used during file match got bigger.
  69  * Compressed ISAM support everywhere.
  70  * Bug fixes regarding masking characters in queries.
  71  * Redesigned Regexp-2 queries.
  72  *
  73  * Revision 1.41  1996/10/29 14:09:56  adam
  74  * Use of cisam system - enabled if setting isamc is 1.
  75  *
  76  * Revision 1.40  1996/06/04 10:19:02  adam
  77  * Minor changes - removed include of ctype.h.
  78  *
  79  * Revision 1.39  1996/05/31  09:07:05  quinn
  80  * Work on character-set handling
  81  *
  82  * Revision 1.38  1996/05/14  11:34:01  adam
  83  * Scan support in multiple registers/databases.
  84  *
  85  * Revision 1.37  1996/05/14  06:16:48  adam
  86  * Compact use/set bytes used in search service.
  87  *
  88  * Revision 1.36  1996/05/01 13:46:37  adam
  89  * First work on multiple records in one file.
  90  * New option, -offset, to the "unread" command in the filter module.
  91  *
  92  * Revision 1.35  1996/03/26  16:01:14  adam
  93  * New setting lockPath: directory of various lock files.
  94  *
  95  * Revision 1.34  1996/03/20  09:36:46  adam
  96  * Function dict_lookup_grep got extra parameter, init_pos, which marks
  97  * from which position in pattern approximate pattern matching should occur.
  98  * Approximate pattern matching is used in relevance=re-2.
  99  *
 100  * Revision 1.33  1996/01/17  14:57:56  adam
 101  * Prototype changed for reader functions in extract/retrieve. File
 102  *  is identified by 'void *' instead of 'int.
 103  *
 104  * Revision 1.32  1995/12/11  09:12:58  adam
 105  * The rec_get function returns NULL if record doesn't exist - will
 106  * happen in the server if the result set records have been deleted since
 107  * the creation of the set (i.e. the search).
 108  * The server saves a result temporarily if it is 'volatile', i.e. the
 109  * set is register dependent.
 110  *
 111  * Revision 1.31  1995/12/08  16:22:56  adam
 112  * Work on update while servers are running. Three lock files introduced.
 113  * The servers reload their registers when necessary, but they don't
 114  * reestablish result sets yet.
 115  *
 116  * Revision 1.30  1995/12/07  17:38:48  adam
 117  * Work locking mechanisms for concurrent updates/commit.
 118  *
 119  * Revision 1.29  1995/12/04  14:22:32  adam
 120  * Extra arg to recType_byName.
 121  * Started work on new regular expression parsed input to
 122  * structured records.
 123  *
 124  * Revision 1.28  1995/11/28  09:09:48  adam
 125  * Zebra config renamed.
 126  * Use setting 'recordId' to identify record now.
 127  * Bug fix in recindex.c: rec_release_blocks was invokeded even
 128  * though the blocks were already released.
 129  * File traversal properly deletes records when needed.
 130  *
 131  * Revision 1.27  1995/11/27  13:58:54  adam
 132  * New option -t. storeStore data implemented in server.
 133  *
 134  * Revision 1.26  1995/11/25  10:24:07  adam
 135  * More record fields - they are enumerated now.
 136  * New options: flagStoreData flagStoreKey.
 137  *
 138  * Revision 1.25  1995/11/21  15:29:13  adam
 139  * Config file 'base' read by default by both indexer and server.
 140  *
 141  * Revision 1.24  1995/11/20  16:59:47  adam
 142  * New update method: the 'old' keys are saved for each records.
 143  *
 144  * Revision 1.23  1995/11/16  17:00:56  adam
 145  * Better logging of rpn query.
 146  *
 147  * Revision 1.22  1995/11/16  15:34:55  adam
 148  * Uses new record management system in both indexer and server.
 149  *
 150  * Revision 1.21  1995/11/01  16:25:52  quinn
 151  * *** empty log message ***
 152  *
 153  * Revision 1.20  1995/10/27  14:00:12  adam
 154  * Implemented detection of database availability.
 155  *
 156  * Revision 1.19  1995/10/17  18:02:11  adam
 157  * New feature: databases. Implemented as prefix to words in dictionary.
 158  *
 159  * Revision 1.18  1995/10/16  14:03:09  quinn
 160  * Changes to support element set names and espec1
 161  *
 162  * Revision 1.17  1995/10/16  09:32:40  adam
 163  * More work on relational op.
 164  *
 165  * Revision 1.16  1995/10/13  12:26:44  adam
 166  * Optimization of truncation.
 167  *
 168  * Revision 1.15  1995/10/12  12:40:55  adam
 169  * Bug fixes in rpn_prox.
 170  *
 171  * Revision 1.14  1995/10/09  16:18:37  adam
 172  * Function dict_lookup_grep got extra client data parameter.
 173  *
 174  * Revision 1.13  1995/10/06  14:38:00  adam
 175  * New result set method: r_score.
 176  * Local no (sysno) and score is transferred to retrieveCtrl.
 177  *
 178  * Revision 1.12  1995/10/06  13:52:06  adam
 179  * Bug fixes. Handler may abort further scanning.
 180  *
 181  * Revision 1.11  1995/10/06  10:43:57  adam
 182  * Scan added. 'occurrences' in scan entries not set yet.
 183  *
 184  * Revision 1.10  1995/10/02  16:43:32  quinn
 185  * Set default resulting record type in fetch.
 186  *
 187  * Revision 1.9  1995/10/02  15:18:52  adam
 188  * New member in recRetrieveCtrl: diagnostic.
 189  *
 190  * Revision 1.8  1995/09/28  09:19:47  adam
 191  * xfree/xmalloc used everywhere.
 192  * Extract/retrieve method seems to work for text records.
 193  *
 194  * Revision 1.7  1995/09/27  16:17:32  adam
 195  * More work on retrieve.
 196  *
 197  * Revision 1.6  1995/09/08  08:53:22  adam
 198  * Record buffer maintained in server_info.
 199  *
 200  * Revision 1.5  1995/09/06  16:11:18  adam
 201  * Option: only one word key per file.
 202  *
 203  * Revision 1.4  1995/09/06  10:33:04  adam
 204  * More work on present. Some log messages removed.
 205  *
 206  * Revision 1.3  1995/09/05  15:28:40  adam
 207  * More work on search engine.
 208  *
 209  * Revision 1.2  1995/09/04  12:33:43  adam
 210  * Various cleanup. YAZ util used instead.
 211  *
 212  * Revision 1.1  1995/09/04  09:10:41  adam
 213  * More work on index add/del/update.
 214  * Merge sort implemented.
 215  * Initial work on z39 server.
 216  *
 217  */
 218
 219 #include <stdio.h>
 220 #include <assert.h>
 221 #include <fcntl.h>
 222 #ifdef WINDOWS
 223 #include <io.h>
 224 #include <process.h>
 225 #else
 226 #include <unistd.h>
 227 #endif
 228
 229 #include <data1.h>
 230 #include <dmalloc.h>
 231
 232 #include "zserver.h"
 233
 234 static int bend_sort (void *handle, bend_sort_rr *rr);
 235
 236 bend_initresult *bend_init (bend_initrequest *q)
 237 {
 238     bend_initresult *r = odr_malloc (q->stream, sizeof(*r));
 239     ZebraHandle zh;
 240     struct statserv_options_block *sob;
 241
 242     r->errcode = 0;
 243     r->errstring = 0;
 244     q->bend_sort = bend_sort;
 245
 246     logf (LOG_DEBUG, "bend_init");
 247
 248     sob = statserv_getcontrol ();
 249     if (!(zh = zebra_open (sob->configname)))
 250     {
 251         logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
 252         r->errcode = 1;
 253         return r;
 254     }
 255     r->handle = zh;
 256     return r;
 257 }
 258
 259 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
 260 {
 261     ZebraHandle zh = handle;
 262     bend_searchresult *r = odr_malloc (q->stream, sizeof(*r));
 263
 264     r->hits = 0;
 265     r->errcode = 0;
 266     r->errstring = NULL;
 267
 268     logf (LOG_LOG, "ResultSet '%s'", q->setname);
 269     switch (q->query->which)
 270     {
 271     case Z_Query_type_1: case Z_Query_type_101:
 272         zebra_search_rpn (zh, q->stream, q->query->u.type_1,
 273                           q->num_bases, q->basenames, q->setname);
 274         r->errcode = zh->errCode;
 275         r->errstring = zh->errString;
 276         r->hits = zh->hits;
 277         break;
 278     default:
 279         r->errcode = 107;
 280     }
 281     return r;
 282 }
 283
 284 bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
 285 {
 286     ZebraHandle zh = handle;
 287     bend_fetchresult *r = odr_malloc (q->stream, sizeof(*r));
 288     ZebraRetrievalRecord retrievalRecord;
 289
 290     retrievalRecord.position = q->number;
 291
 292     r->last_in_set = 0;
 293     zebra_records_retrieve (zh, q->stream, q->setname, q->comp,
 294                             q->format, 1, &retrievalRecord);
 295     if (zh->errCode)                  /* non Surrogate Diagnostic */
 296     {
 297         r->errcode = zh->errCode;
 298         r->errstring = zh->errString;
 299     }
 300     else if (retrievalRecord.errCode) /* Surrogate Diagnostic */
 301     {
 302         q->surrogate_flag = 1;
 303         r->errcode = retrievalRecord.errCode;
 304         r->errstring = retrievalRecord.errString;
 305         r->basename = retrievalRecord.base;
 306     }
 307     else                              /* Database Record */
 308     {
 309         r->errcode = 0;
 310         r->basename = retrievalRecord.base;
 311         r->record = retrievalRecord.buf;
 312         r->len = retrievalRecord.len;
 313         r->format = retrievalRecord.format;
 314     }
 315     return r;
 316 }
 317
 318 bend_deleteresult *bend_delete (void *handle, bend_deleterequest *q, int *num)
 319 {
 320     return 0;
 321 }
 322
 323 bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
 324 {
 325     ZebraScanEntry *entries;
 326     ZebraHandle zh = handle;
 327     bend_scanresult *r = odr_malloc (q->stream, sizeof(*r));
 328     int is_partial, i;
 329
 330     r->term_position = q->term_position;
 331     r->num_entries = q->num_entries;
 332
 333     r->entries = odr_malloc (q->stream, sizeof(*r->entries) * q->num_entries);
 334     zebra_scan (zh, q->stream, q->term,
 335                 q->attributeset,
 336                 q->num_bases, q->basenames,
 337                 &r->term_position,
 338                 &r->num_entries, &entries, &is_partial);
 339     if (is_partial)
 340         r->status = BEND_SCAN_PARTIAL;
 341     else
 342         r->status = BEND_SCAN_SUCCESS;
 343     for (i = 0; i < r->num_entries; i++)
 344     {
 345         r->entries[i].term = entries[i].term;
 346         r->entries[i].occurrences = entries[i].occurrences;
 347     }
 348     r->errcode = zh->errCode;
 349     r->errstring = zh->errString;
 350     return r;
 351 }
 352
 353 void bend_close (void *handle)
 354 {
 355     zebra_close ((ZebraHandle) handle);
 356 }
 357
 358 int bend_sort (void *handle, bend_sort_rr *rr)
 359 {
 360     ZebraHandle zh = handle;
 361
 362     zebra_sort (zh, rr->stream, rr->num_input_setnames, rr->input_setnames,
 363                 rr->output_setname, rr->sort_sequence, &rr->sort_status);
 364     rr->errcode = zh->errCode;
 365     rr->errstring = zh->errString;
 366     return 0;
 367 }
 368
 369 #ifndef WINDOWS
 370 static void pre_init (struct statserv_options_block *sob)
 371 {
 372     char *pidfile = "zebrasrv.pid";
 373     int fd = creat (pidfile, 0666);
 374
 375     if (fd == -1)
 376         logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
 377     else
 378     {
 379         char pidstr[30];
 380
 381         sprintf (pidstr, "%ld", (long) getpid ());
 382         write (fd, pidstr, strlen(pidstr));
 383         close (fd);
 384     }
 385 }
 386 #endif
 387
 388 int main (int argc, char **argv)
 389 {
 390     struct statserv_options_block *sob;
 391
 392     sob = statserv_getcontrol ();
 393     strcpy (sob->configname, FNAME_CONFIG);
 394 #ifndef WINDOWS
 395     sob->pre_init = pre_init;
 396 #endif
 397     statserv_setcontrol (sob);
 398
 399     return statserv_main (argc, argv);
 400 }