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