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