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