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