index/zserver.c

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