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