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