index/zserver.c

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