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