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