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