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