index/zserver.c

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