index/zserver.c

   1 /*
   2  * Copyright (C) 1995-1997, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: zserver.c,v $
   7  * Revision 1.50  1997-09-29 09:08:36  adam
   8  * Revised locking system to be thread safe for the server.
   9  *
  10  * Revision 1.49  1997/09/25 14:57:23  adam
  11  * Windows NT port.
  12  *
  13  * Revision 1.48  1997/09/17 12:19:19  adam
  14  * Zebra version corresponds to YAZ version 1.4.
  15  * Changed Zebra server so that it doesn't depend on global common_resource.
  16  *
  17  * Revision 1.47  1997/09/04 13:58:36  adam
  18  * New retrieve/extract method tellf (added).
  19  * Added O_BINARY for open calls.
  20  *
  21  * Revision 1.46  1997/07/28 08:30:47  adam
  22  * Server returns diagnostic 14 when record doesn't exist.
  23  *
  24  * Revision 1.45  1996/12/23 15:30:45  adam
  25  * Work on truncation.
  26  * Bug fix: result sets weren't deleted after server shut down.
  27  *
  28  * Revision 1.44  1996/12/11 12:08:01  adam
  29  * Added better compression.
  30  *
  31  * Revision 1.43  1996/11/15 15:03:58  adam
  32  * Logging of execution speed by using the times(2) call.
  33  *
  34  * Revision 1.42  1996/11/08  11:10:36  adam
  35  * Buffers used during file match got bigger.
  36  * Compressed ISAM support everywhere.
  37  * Bug fixes regarding masking characters in queries.
  38  * Redesigned Regexp-2 queries.
  39  *
  40  * Revision 1.41  1996/10/29 14:09:56  adam
  41  * Use of cisam system - enabled if setting isamc is 1.
  42  *
  43  * Revision 1.40  1996/06/04 10:19:02  adam
  44  * Minor changes - removed include of ctype.h.
  45  *
  46  * Revision 1.39  1996/05/31  09:07:05  quinn
  47  * Work on character-set handling
  48  *
  49  * Revision 1.38  1996/05/14  11:34:01  adam
  50  * Scan support in multiple registers/databases.
  51  *
  52  * Revision 1.37  1996/05/14  06:16:48  adam
  53  * Compact use/set bytes used in search service.
  54  *
  55  * Revision 1.36  1996/05/01 13:46:37  adam
  56  * First work on multiple records in one file.
  57  * New option, -offset, to the "unread" command in the filter module.
  58  *
  59  * Revision 1.35  1996/03/26  16:01:14  adam
  60  * New setting lockPath: directory of various lock files.
  61  *
  62  * Revision 1.34  1996/03/20  09:36:46  adam
  63  * Function dict_lookup_grep got extra parameter, init_pos, which marks
  64  * from which position in pattern approximate pattern matching should occur.
  65  * Approximate pattern matching is used in relevance=re-2.
  66  *
  67  * Revision 1.33  1996/01/17  14:57:56  adam
  68  * Prototype changed for reader functions in extract/retrieve. File
  69  *  is identified by 'void *' instead of 'int.
  70  *
  71  * Revision 1.32  1995/12/11  09:12:58  adam
  72  * The rec_get function returns NULL if record doesn't exist - will
  73  * happen in the server if the result set records have been deleted since
  74  * the creation of the set (i.e. the search).
  75  * The server saves a result temporarily if it is 'volatile', i.e. the
  76  * set is register dependent.
  77  *
  78  * Revision 1.31  1995/12/08  16:22:56  adam
  79  * Work on update while servers are running. Three lock files introduced.
  80  * The servers reload their registers when necessary, but they don't
  81  * reestablish result sets yet.
  82  *
  83  * Revision 1.30  1995/12/07  17:38:48  adam
  84  * Work locking mechanisms for concurrent updates/commit.
  85  *
  86  * Revision 1.29  1995/12/04  14:22:32  adam
  87  * Extra arg to recType_byName.
  88  * Started work on new regular expression parsed input to
  89  * structured records.
  90  *
  91  * Revision 1.28  1995/11/28  09:09:48  adam
  92  * Zebra config renamed.
  93  * Use setting 'recordId' to identify record now.
  94  * Bug fix in recindex.c: rec_release_blocks was invokeded even
  95  * though the blocks were already released.
  96  * File traversal properly deletes records when needed.
  97  *
  98  * Revision 1.27  1995/11/27  13:58:54  adam
  99  * New option -t. storeStore data implemented in server.
 100  *
 101  * Revision 1.26  1995/11/25  10:24:07  adam
 102  * More record fields - they are enumerated now.
 103  * New options: flagStoreData flagStoreKey.
 104  *
 105  * Revision 1.25  1995/11/21  15:29:13  adam
 106  * Config file 'base' read by default by both indexer and server.
 107  *
 108  * Revision 1.24  1995/11/20  16:59:47  adam
 109  * New update method: the 'old' keys are saved for each records.
 110  *
 111  * Revision 1.23  1995/11/16  17:00:56  adam
 112  * Better logging of rpn query.
 113  *
 114  * Revision 1.22  1995/11/16  15:34:55  adam
 115  * Uses new record management system in both indexer and server.
 116  *
 117  * Revision 1.21  1995/11/01  16:25:52  quinn
 118  * *** empty log message ***
 119  *
 120  * Revision 1.20  1995/10/27  14:00:12  adam
 121  * Implemented detection of database availability.
 122  *
 123  * Revision 1.19  1995/10/17  18:02:11  adam
 124  * New feature: databases. Implemented as prefix to words in dictionary.
 125  *
 126  * Revision 1.18  1995/10/16  14:03:09  quinn
 127  * Changes to support element set names and espec1
 128  *
 129  * Revision 1.17  1995/10/16  09:32:40  adam
 130  * More work on relational op.
 131  *
 132  * Revision 1.16  1995/10/13  12:26:44  adam
 133  * Optimization of truncation.
 134  *
 135  * Revision 1.15  1995/10/12  12:40:55  adam
 136  * Bug fixes in rpn_prox.
 137  *
 138  * Revision 1.14  1995/10/09  16:18:37  adam
 139  * Function dict_lookup_grep got extra client data parameter.
 140  *
 141  * Revision 1.13  1995/10/06  14:38:00  adam
 142  * New result set method: r_score.
 143  * Local no (sysno) and score is transferred to retrieveCtrl.
 144  *
 145  * Revision 1.12  1995/10/06  13:52:06  adam
 146  * Bug fixes. Handler may abort further scanning.
 147  *
 148  * Revision 1.11  1995/10/06  10:43:57  adam
 149  * Scan added. 'occurrences' in scan entries not set yet.
 150  *
 151  * Revision 1.10  1995/10/02  16:43:32  quinn
 152  * Set default resulting record type in fetch.
 153  *
 154  * Revision 1.9  1995/10/02  15:18:52  adam
 155  * New member in recRetrieveCtrl: diagnostic.
 156  *
 157  * Revision 1.8  1995/09/28  09:19:47  adam
 158  * xfree/xmalloc used everywhere.
 159  * Extract/retrieve method seems to work for text records.
 160  *
 161  * Revision 1.7  1995/09/27  16:17:32  adam
 162  * More work on retrieve.
 163  *
 164  * Revision 1.6  1995/09/08  08:53:22  adam
 165  * Record buffer maintained in server_info.
 166  *
 167  * Revision 1.5  1995/09/06  16:11:18  adam
 168  * Option: only one word key per file.
 169  *
 170  * Revision 1.4  1995/09/06  10:33:04  adam
 171  * More work on present. Some log messages removed.
 172  *
 173  * Revision 1.3  1995/09/05  15:28:40  adam
 174  * More work on search engine.
 175  *
 176  * Revision 1.2  1995/09/04  12:33:43  adam
 177  * Various cleanup. YAZ util used instead.
 178  *
 179  * Revision 1.1  1995/09/04  09:10:41  adam
 180  * More work on index add/del/update.
 181  * Merge sort implemented.
 182  * Initial work on z39 server.
 183  *
 184  */
 185 #include <stdio.h>
 186 #include <assert.h>
 187 #ifdef WINDOWS
 188 #include <io.h>
 189 #include <process.h>
 190 #else
 191 #include <unistd.h>
 192 #endif
 193 #include <fcntl.h>
 194
 195 #include <data1.h>
 196 #include <recctrl.h>
 197 #include <dmalloc.h>
 198
 199 #include "zserver.h"
 200
 201 static int register_lock (ZServerInfo *zi)
 202 {
 203     time_t lastChange;
 204     int state = zebra_server_lock_get_state(zi, &lastChange);
 205
 206     switch (state)
 207     {
 208     case 'c':
 209         state = 1;
 210         break;
 211     default:
 212         state = 0;
 213     }
 214     zebra_server_lock (zi, state);
 215 #if USE_TIMES
 216     times (&zi->tms1);
 217 #endif
 218     if (zi->registerState == state)
 219     {
 220         if (zi->registerChange >= lastChange)
 221             return 0;
 222         logf (LOG_LOG, "Register completely updated since last access");
 223     }
 224     else if (zi->registerState == -1)
 225         logf (LOG_LOG, "Reading register using state %d pid=%ld", state,
 226               (long) getpid());
 227     else
 228         logf (LOG_LOG, "Register has changed state from %d to %d",
 229               zi->registerState, state);
 230     zi->registerChange = lastChange;
 231     if (zi->records)
 232     {
 233         zebTargetInfo_close (zi->zti, 0);
 234         dict_close (zi->dict);
 235         if (zi->isam)
 236             is_close (zi->isam);
 237         if (zi->isamc)
 238             isc_close (zi->isamc);
 239         rec_close (&zi->records);
 240     }
 241     bf_cache (zi->bfs, state ? res_get (zi->res, "shadow") : NULL);
 242     zi->registerState = state;
 243     zi->records = rec_open (zi->bfs, 0);
 244     if (!(zi->dict = dict_open (zi->bfs, FNAME_DICT, 40, 0)))
 245         return -1;
 246     zi->isam = NULL;
 247     zi->isamc = NULL;
 248     if (res_get_match (zi->res, "isam", "c", NULL))
 249     {
 250         if (!(zi->isamc = isc_open (zi->bfs, FNAME_ISAMC,
 251                                     0, key_isamc_m(zi->res))))
 252             return -1;
 253
 254     }
 255     else
 256     {
 257         if (!(zi->isam = is_open (zi->bfs, FNAME_ISAM, key_compare, 0,
 258                                   sizeof (struct it_key), zi->res)))
 259             return -1;
 260     }
 261     zi->zti = zebTargetInfo_open (zi->records, 0);
 262     init_charmap (zi->res);
 263     return 0;
 264 }
 265
 266 static void register_unlock (ZServerInfo *zi)
 267 {
 268     static int waitSec = -1;
 269
 270 #if USE_TIMES
 271     times (&zi->tms2);
 272     logf (LOG_LOG, "user/system: %ld/%ld",
 273                         (long) (zi->tms2.tms_utime - zi->tms1.tms_utime),
 274                         (long) (zi->tms2.tms_stime - zi->tms1.tms_stime));
 275 #endif
 276     if (waitSec == -1)
 277     {
 278         char *s = res_get (zi->res, "debugRequestWait");
 279         if (s)
 280             waitSec = atoi (s);
 281         else
 282             waitSec = 0;
 283     }
 284 #ifdef WINDOWS
 285 #else
 286     if (waitSec > 0)
 287         sleep (waitSec);
 288 #endif
 289     if (zi->registerState != -1)
 290         zebra_server_unlock (zi, zi->registerState);
 291 }
 292
 293 bend_initresult *bend_init (bend_initrequest *q)
 294 {
 295     bend_initresult *r = odr_malloc (q->stream, sizeof(*r));
 296     ZServerInfo *zi = xmalloc (sizeof(*zi));
 297     struct statserv_options_block *sob;
 298
 299     r->errcode = 0;
 300     r->errstring = 0;
 301     r->handle = zi;
 302
 303     logf (LOG_DEBUG, "bend_init");
 304
 305     sob = statserv_getcontrol ();
 306     logf (LOG_LOG, "Reading resources from %s", sob->configname);
 307     if (!(zi->res = res_open (sob->configname)))
 308     {
 309         logf (LOG_FATAL, "Cannot open resource `%s'", sob->configname);
 310         exit (1);
 311     }
 312     zebra_server_lock_init (zi);
 313     zi->dh = data1_create ();
 314     zi->bfs = bfs_create (res_get (zi->res, "register"));
 315     bf_lockDir (zi->bfs, res_get (zi->res, "lockDir"));
 316     data1_set_tabpath (zi->dh, res_get(zi->res, "profilePath"));
 317     zi->sets = NULL;
 318     zi->registerState = -1;  /* trigger open of registers! */
 319     zi->registerChange = 0;
 320
 321     zi->records = NULL;
 322     zi->odr = odr_createmem (ODR_ENCODE);
 323     zi->registered_sets = NULL;
 324     return r;
 325 }
 326
 327 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
 328 {
 329     ZServerInfo *zi = handle;
 330     bend_searchresult *r = odr_malloc (q->stream, sizeof(*r));
 331
 332     r->errcode = 0;
 333     r->errstring = 0;
 334     r->hits = 0;
 335
 336     register_lock (zi);
 337     odr_reset (zi->odr);
 338     zi->errCode = 0;
 339     zi->errString = NULL;
 340
 341     logf (LOG_LOG, "ResultSet '%s'", q->setname);
 342     switch (q->query->which)
 343     {
 344     case Z_Query_type_1: case Z_Query_type_101:
 345         r->errcode = rpn_search (zi, q->query->u.type_1,
 346                                 q->num_bases, q->basenames, q->setname,
 347                                 &r->hits);
 348         r->errstring = zi->errString;
 349         break;
 350     default:
 351         r->errcode = 107;
 352     }
 353     register_unlock (zi);
 354     return r;
 355 }
 356
 357 struct fetch_control {
 358     int record_offset;
 359     int record_int_pos;
 360     char *record_int_buf;
 361     int record_int_len;
 362     int fd;
 363 };
 364
 365 static int record_ext_read (void *fh, char *buf, size_t count)
 366 {
 367     struct fetch_control *fc = fh;
 368     return read (fc->fd, buf, count);
 369 }
 370
 371 static off_t record_ext_seek (void *fh, off_t offset)
 372 {
 373     struct fetch_control *fc = fh;
 374     return lseek (fc->fd, offset + fc->record_offset, SEEK_SET);
 375 }
 376
 377 static off_t record_ext_tell (void *fh)
 378 {
 379     struct fetch_control *fc = fh;
 380     return lseek (fc->fd, 0, SEEK_CUR) - fc->record_offset;
 381 }
 382
 383 static off_t record_int_seek (void *fh, off_t offset)
 384 {
 385     struct fetch_control *fc = fh;
 386     return (off_t) (fc->record_int_pos = offset);
 387 }
 388
 389 static off_t record_int_tell (void *fh)
 390 {
 391     struct fetch_control *fc = fh;
 392     return (off_t) fc->record_int_pos;
 393 }
 394
 395 static int record_int_read (void *fh, char *buf, size_t count)
 396 {
 397     struct fetch_control *fc = fh;
 398     int l = fc->record_int_len - fc->record_int_pos;
 399     if (l <= 0)
 400         return 0;
 401     l = (l < count) ? l : count;
 402     memcpy (buf, fc->record_int_buf + fc->record_int_pos, l);
 403     fc->record_int_pos += l;
 404     return l;
 405 }
 406
 407 static int record_fetch (ZServerInfo *zi, int sysno, int score, ODR stream,
 408                           oid_value input_format, Z_RecordComposition *comp,
 409                           oid_value *output_format, char **rec_bufp,
 410                           int *rec_lenp, char **basenamep)
 411 {
 412     Record rec;
 413     char *fname, *file_type, *basename;
 414     RecType rt;
 415     struct recRetrieveCtrl retrieveCtrl;
 416     char subType[128];
 417     struct fetch_control fc;
 418
 419     rec = rec_get (zi->records, sysno);
 420     if (!rec)
 421     {
 422         logf (LOG_DEBUG, "rec_get fail on sysno=%d", sysno);
 423         return 14;
 424     }
 425     file_type = rec->info[recInfo_fileType];
 426     fname = rec->info[recInfo_filename];
 427     basename = rec->info[recInfo_databaseName];
 428     *basenamep = odr_malloc (stream, strlen(basename)+1);
 429     strcpy (*basenamep, basename);
 430
 431     if (!(rt = recType_byName (file_type, subType)))
 432     {
 433         logf (LOG_FATAL|LOG_ERRNO, "Retrieve: Cannot handle type %s",
 434               file_type);
 435         exit (1);
 436     }
 437     logf (LOG_DEBUG, "retrieve localno=%d score=%d", sysno, score);
 438     retrieveCtrl.fh = &fc;
 439     fc.fd = -1;
 440     if (rec->size[recInfo_storeData] > 0)
 441     {
 442         retrieveCtrl.readf = record_int_read;
 443         retrieveCtrl.seekf = record_int_seek;
 444         retrieveCtrl.tellf = record_int_tell;
 445         fc.record_int_len = rec->size[recInfo_storeData];
 446         fc.record_int_buf = rec->info[recInfo_storeData];
 447         fc.record_int_pos = 0;
 448         logf (LOG_DEBUG, "Internal retrieve. %d bytes", fc.record_int_len);
 449     }
 450     else
 451     {
 452         if ((fc.fd = open (fname, O_BINARY|O_RDONLY)) == -1)
 453         {
 454             logf (LOG_WARN|LOG_ERRNO, "Retrieve fail; missing file: %s",
 455                   fname);
 456             rec_rm (&rec);
 457             return 14;
 458         }
 459         memcpy (&fc.record_offset, rec->info[recInfo_offset],
 460                 sizeof(fc.record_offset));
 461
 462         retrieveCtrl.readf = record_ext_read;
 463         retrieveCtrl.seekf = record_ext_seek;
 464         retrieveCtrl.tellf = record_ext_tell;
 465
 466         record_ext_seek (retrieveCtrl.fh, 0);
 467     }
 468     retrieveCtrl.subType = subType;
 469     retrieveCtrl.localno = sysno;
 470     retrieveCtrl.score = score;
 471     retrieveCtrl.odr = stream;
 472     retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
 473     retrieveCtrl.comp = comp;
 474     retrieveCtrl.diagnostic = 0;
 475     retrieveCtrl.dh = zi->dh;
 476     (*rt->retrieve)(&retrieveCtrl);
 477     *output_format = retrieveCtrl.output_format;
 478     *rec_bufp = retrieveCtrl.rec_buf;
 479     *rec_lenp = retrieveCtrl.rec_len;
 480     if (fc.fd != -1)
 481         close (fc.fd);
 482     rec_rm (&rec);
 483
 484     return retrieveCtrl.diagnostic;
 485 }
 486
 487 bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
 488 {
 489     ZServerInfo *zi = handle;
 490     bend_fetchresult *r = odr_malloc (q->stream, sizeof(*r));
 491     int positions[2];
 492     ZServerSetSysno *records;
 493
 494     register_lock (zi);
 495
 496     r->errstring = 0;
 497     r->last_in_set = 0;
 498     r->basename = "base";
 499
 500     odr_reset (zi->odr);
 501     zi->errCode = 0;
 502
 503     positions[0] = q->number;
 504     records = resultSetSysnoGet (zi, q->setname, 1, positions);
 505     if (!records)
 506     {
 507         logf (LOG_DEBUG, "resultSetRecordGet, error");
 508         r->errcode = 13;
 509         register_unlock (zi);
 510         return r;
 511     }
 512     if (!records[0].sysno)
 513     {
 514         r->errcode = 13;
 515         logf (LOG_DEBUG, "Out of range. pos=%d", q->number);
 516         register_unlock (zi);
 517         return r;
 518     }
 519     r->errcode = record_fetch (zi, records[0].sysno,
 520                               records[0].score, q->stream, q->format,
 521                               q->comp, &r->format, &r->record, &r->len,
 522                               &r->basename);
 523     resultSetSysnoDel (zi, records, 1);
 524     register_unlock (zi);
 525     return r;
 526 }
 527
 528 bend_deleteresult *bend_delete (void *handle, bend_deleterequest *q, int *num)
 529 {
 530     ZServerInfo *zi = handle;
 531     register_lock (zi);
 532     register_unlock (zi);
 533     return 0;
 534 }
 535
 536 bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
 537 {
 538     ZServerInfo *zi = handle;
 539     bend_scanresult *r = odr_malloc (q->stream, sizeof(*r));
 540     int status;
 541
 542     register_lock (zi);
 543     odr_reset (zi->odr);
 544     zi->errCode = 0;
 545     zi->errString = 0;
 546
 547     r->term_position = q->term_position;
 548     r->num_entries = q->num_entries;
 549     r->errcode = rpn_scan (zi, q->term,
 550                           q->attributeset,
 551                           q->num_bases, q->basenames,
 552                           &r->term_position,
 553                           &r->num_entries, &r->entries, &status);
 554     r->errstring = zi->errString;
 555     r->status = status;
 556     register_unlock (zi);
 557     return r;
 558 }
 559
 560 void bend_close (void *handle)
 561 {
 562     ZServerInfo *zi = handle;
 563     if (zi->records)
 564     {
 565         resultSetDestroy (zi);
 566         dict_close (zi->dict);
 567         if (zi->isam)
 568             is_close (zi->isam);
 569         if (zi->isamc)
 570             isc_close (zi->isamc);
 571         rec_close (&zi->records);
 572         register_unlock (zi);
 573     }
 574     bfs_destroy (zi->bfs);
 575     data1_destroy (zi->dh);
 576     zebra_server_lock_destroy (zi);
 577     return;
 578 }
 579
 580 int main (int argc, char **argv)
 581 {
 582     struct statserv_options_block *sob;
 583
 584     sob = statserv_getcontrol ();
 585     strcpy (sob->configname, FNAME_CONFIG);
 586     statserv_setcontrol (sob);
 587
 588     return statserv_main (argc, argv);
 589 }