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