index/zserver.c

   1 /*
   2  * Copyright (C) 1995-1998, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: zserver.c,v $
   7  * Revision 1.62  1998-08-06 14:35:28  adam
   8  * Routine bend_deleterequest removed.
   9  *
  10  * Revision 1.61  1998/06/24 12:16:15  adam
  11  * Support for relations on text operands. Open range support in
  12  * DFA module (i.e. [-j], [g-]).
  13  *
  14  * Revision 1.60  1998/06/22 11:36:49  adam
  15  * Added authentication check facility to zebra.
  16  *
  17  * Revision 1.59  1998/06/12 12:22:13  adam
  18  * Work on Zebra API.
  19  *
  20  * Revision 1.58  1998/05/27 16:57:46  adam
  21  * Zebra returns surrogate diagnostic for single records when
  22  * appropriate.
  23  *
  24  * Revision 1.57  1998/04/03 14:45:18  adam
  25  * Fixed setting of last_in_set in bend_fetch.
  26  *
  27  * Revision 1.56  1998/03/05 08:45:13  adam
  28  * New result set model and modular ranking system. Moved towards
  29  * descent server API. System information stored as "SGML" records.
  30  *
  31  * Revision 1.55  1998/02/10 12:03:06  adam
  32  * Implemented Sort.
  33  *
  34  * Revision 1.54  1998/01/29 13:39:13  adam
  35  * Compress ISAM is default.
  36  *
  37  * Revision 1.53  1998/01/12 15:04:09  adam
  38  * The test option (-s) only uses read-lock (and not write lock).
  39  *
  40  * Revision 1.52  1997/11/18 10:05:08  adam
  41  * Changed character map facility so that admin can specify character
  42  * mapping files for each register type, w, p, etc.
  43  *
  44  * Revision 1.51  1997/10/27 14:33:06  adam
  45  * Moved towards generic character mapping depending on "structure"
  46  * field in abstract syntax file. Fixed a few memory leaks. Fixed
  47  * bug with negative integers when doing searches with relational
  48  * operators.
  49  *
  50  * Revision 1.50  1997/09/29 09:08:36  adam
  51  * Revised locking system to be thread safe for the server.
  52  *
  53  * Revision 1.49  1997/09/25 14:57:23  adam
  54  * Windows NT port.
  55  *
  56  * Revision 1.48  1997/09/17 12:19:19  adam
  57  * Zebra version corresponds to YAZ version 1.4.
  58  * Changed Zebra server so that it doesn't depend on global common_resource.
  59  *
  60  * Revision 1.47  1997/09/04 13:58:36  adam
  61  * New retrieve/extract method tellf (added).
  62  * Added O_BINARY for open calls.
  63  *
  64  * Revision 1.46  1997/07/28 08:30:47  adam
  65  * Server returns diagnostic 14 when record doesn't exist.
  66  *
  67  * Revision 1.45  1996/12/23 15:30:45  adam
  68  * Work on truncation.
  69  * Bug fix: result sets weren't deleted after server shut down.
  70  *
  71  * Revision 1.44  1996/12/11 12:08:01  adam
  72  * Added better compression.
  73  *
  74  * Revision 1.43  1996/11/15 15:03:58  adam
  75  * Logging of execution speed by using the times(2) call.
  76  *
  77  * Revision 1.42  1996/11/08  11:10:36  adam
  78  * Buffers used during file match got bigger.
  79  * Compressed ISAM support everywhere.
  80  * Bug fixes regarding masking characters in queries.
  81  * Redesigned Regexp-2 queries.
  82  *
  83  * Revision 1.41  1996/10/29 14:09:56  adam
  84  * Use of cisam system - enabled if setting isamc is 1.
  85  *
  86  * Revision 1.40  1996/06/04 10:19:02  adam
  87  * Minor changes - removed include of ctype.h.
  88  *
  89  * Revision 1.39  1996/05/31  09:07:05  quinn
  90  * Work on character-set handling
  91  *
  92  * Revision 1.38  1996/05/14  11:34:01  adam
  93  * Scan support in multiple registers/databases.
  94  *
  95  * Revision 1.37  1996/05/14  06:16:48  adam
  96  * Compact use/set bytes used in search service.
  97  *
  98  * Revision 1.36  1996/05/01 13:46:37  adam
  99  * First work on multiple records in one file.
 100  * New option, -offset, to the "unread" command in the filter module.
 101  *
 102  * Revision 1.35  1996/03/26  16:01:14  adam
 103  * New setting lockPath: directory of various lock files.
 104  *
 105  * Revision 1.34  1996/03/20  09:36:46  adam
 106  * Function dict_lookup_grep got extra parameter, init_pos, which marks
 107  * from which position in pattern approximate pattern matching should occur.
 108  * Approximate pattern matching is used in relevance=re-2.
 109  *
 110  * Revision 1.33  1996/01/17  14:57:56  adam
 111  * Prototype changed for reader functions in extract/retrieve. File
 112  *  is identified by 'void *' instead of 'int.
 113  *
 114  * Revision 1.32  1995/12/11  09:12:58  adam
 115  * The rec_get function returns NULL if record doesn't exist - will
 116  * happen in the server if the result set records have been deleted since
 117  * the creation of the set (i.e. the search).
 118  * The server saves a result temporarily if it is 'volatile', i.e. the
 119  * set is register dependent.
 120  *
 121  * Revision 1.31  1995/12/08  16:22:56  adam
 122  * Work on update while servers are running. Three lock files introduced.
 123  * The servers reload their registers when necessary, but they don't
 124  * reestablish result sets yet.
 125  *
 126  * Revision 1.30  1995/12/07  17:38:48  adam
 127  * Work locking mechanisms for concurrent updates/commit.
 128  *
 129  * Revision 1.29  1995/12/04  14:22:32  adam
 130  * Extra arg to recType_byName.
 131  * Started work on new regular expression parsed input to
 132  * structured records.
 133  *
 134  * Revision 1.28  1995/11/28  09:09:48  adam
 135  * Zebra config renamed.
 136  * Use setting 'recordId' to identify record now.
 137  * Bug fix in recindex.c: rec_release_blocks was invokeded even
 138  * though the blocks were already released.
 139  * File traversal properly deletes records when needed.
 140  *
 141  * Revision 1.27  1995/11/27  13:58:54  adam
 142  * New option -t. storeStore data implemented in server.
 143  *
 144  * Revision 1.26  1995/11/25  10:24:07  adam
 145  * More record fields - they are enumerated now.
 146  * New options: flagStoreData flagStoreKey.
 147  *
 148  * Revision 1.25  1995/11/21  15:29:13  adam
 149  * Config file 'base' read by default by both indexer and server.
 150  *
 151  * Revision 1.24  1995/11/20  16:59:47  adam
 152  * New update method: the 'old' keys are saved for each records.
 153  *
 154  * Revision 1.23  1995/11/16  17:00:56  adam
 155  * Better logging of rpn query.
 156  *
 157  * Revision 1.22  1995/11/16  15:34:55  adam
 158  * Uses new record management system in both indexer and server.
 159  *
 160  * Revision 1.21  1995/11/01  16:25:52  quinn
 161  * *** empty log message ***
 162  *
 163  * Revision 1.20  1995/10/27  14:00:12  adam
 164  * Implemented detection of database availability.
 165  *
 166  * Revision 1.19  1995/10/17  18:02:11  adam
 167  * New feature: databases. Implemented as prefix to words in dictionary.
 168  *
 169  * Revision 1.18  1995/10/16  14:03:09  quinn
 170  * Changes to support element set names and espec1
 171  *
 172  * Revision 1.17  1995/10/16  09:32:40  adam
 173  * More work on relational op.
 174  *
 175  * Revision 1.16  1995/10/13  12:26:44  adam
 176  * Optimization of truncation.
 177  *
 178  * Revision 1.15  1995/10/12  12:40:55  adam
 179  * Bug fixes in rpn_prox.
 180  *
 181  * Revision 1.14  1995/10/09  16:18:37  adam
 182  * Function dict_lookup_grep got extra client data parameter.
 183  *
 184  * Revision 1.13  1995/10/06  14:38:00  adam
 185  * New result set method: r_score.
 186  * Local no (sysno) and score is transferred to retrieveCtrl.
 187  *
 188  * Revision 1.12  1995/10/06  13:52:06  adam
 189  * Bug fixes. Handler may abort further scanning.
 190  *
 191  * Revision 1.11  1995/10/06  10:43:57  adam
 192  * Scan added. 'occurrences' in scan entries not set yet.
 193  *
 194  * Revision 1.10  1995/10/02  16:43:32  quinn
 195  * Set default resulting record type in fetch.
 196  *
 197  * Revision 1.9  1995/10/02  15:18:52  adam
 198  * New member in recRetrieveCtrl: diagnostic.
 199  *
 200  * Revision 1.8  1995/09/28  09:19:47  adam
 201  * xfree/xmalloc used everywhere.
 202  * Extract/retrieve method seems to work for text records.
 203  *
 204  * Revision 1.7  1995/09/27  16:17:32  adam
 205  * More work on retrieve.
 206  *
 207  * Revision 1.6  1995/09/08  08:53:22  adam
 208  * Record buffer maintained in server_info.
 209  *
 210  * Revision 1.5  1995/09/06  16:11:18  adam
 211  * Option: only one word key per file.
 212  *
 213  * Revision 1.4  1995/09/06  10:33:04  adam
 214  * More work on present. Some log messages removed.
 215  *
 216  * Revision 1.3  1995/09/05  15:28:40  adam
 217  * More work on search engine.
 218  *
 219  * Revision 1.2  1995/09/04  12:33:43  adam
 220  * Various cleanup. YAZ util used instead.
 221  *
 222  * Revision 1.1  1995/09/04  09:10:41  adam
 223  * More work on index add/del/update.
 224  * Merge sort implemented.
 225  * Initial work on z39 server.
 226  *
 227  */
 228
 229 #include <stdio.h>
 230 #include <assert.h>
 231 #include <fcntl.h>
 232 #ifdef WINDOWS
 233 #include <io.h>
 234 #include <process.h>
 235 #else
 236 #include <unistd.h>
 237 #endif
 238
 239 #include <data1.h>
 240 #include <dmalloc.h>
 241
 242 #include "zserver.h"
 243
 244 static int bend_sort (void *handle, bend_sort_rr *rr);
 245
 246 bend_initresult *bend_init (bend_initrequest *q)
 247 {
 248     bend_initresult *r = odr_malloc (q->stream, sizeof(*r));
 249     ZebraHandle zh;
 250     struct statserv_options_block *sob;
 251     char *user = NULL;
 252     char *passwd = NULL;
 253
 254     r->errcode = 0;
 255     r->errstring = 0;
 256     q->bend_sort = bend_sort;
 257
 258     logf (LOG_DEBUG, "bend_init");
 259
 260     sob = statserv_getcontrol ();
 261     if (!(zh = zebra_open (sob->configname)))
 262     {
 263         logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
 264         r->errcode = 1;
 265         return r;
 266     }
 267     if (q->auth)
 268     {
 269         if (q->auth->which == Z_IdAuthentication_open)
 270         {
 271             char *openpass = xstrdup (q->auth->u.open);
 272             char *cp = strchr (openpass, '/');
 273             if (cp)
 274             {
 275                 *cp = '\0';
 276                 user = nmem_strdup (odr_getmem (q->stream), openpass);
 277                 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
 278             }
 279             xfree (openpass);
 280         }
 281     }
 282     if (zebra_auth (zh, user, passwd))
 283     {
 284         r->errcode = 222;
 285         r->errstring = user;
 286         zebra_close (zh);
 287         return r;
 288     }
 289     r->handle = zh;
 290     return r;
 291 }
 292
 293 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
 294 {
 295     ZebraHandle zh = handle;
 296     bend_searchresult *r = odr_malloc (q->stream, sizeof(*r));
 297
 298     r->hits = 0;
 299     r->errcode = 0;
 300     r->errstring = NULL;
 301
 302     logf (LOG_LOG, "ResultSet '%s'", q->setname);
 303     switch (q->query->which)
 304     {
 305     case Z_Query_type_1: case Z_Query_type_101:
 306         zebra_search_rpn (zh, q->stream, q->query->u.type_1,
 307                           q->num_bases, q->basenames, q->setname);
 308         r->errcode = zh->errCode;
 309         r->errstring = zh->errString;
 310         r->hits = zh->hits;
 311         break;
 312     default:
 313         r->errcode = 107;
 314     }
 315     return r;
 316 }
 317
 318 bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
 319 {
 320     ZebraHandle zh = handle;
 321     bend_fetchresult *r = odr_malloc (q->stream, sizeof(*r));
 322     ZebraRetrievalRecord retrievalRecord;
 323
 324     retrievalRecord.position = q->number;
 325
 326     r->last_in_set = 0;
 327     zebra_records_retrieve (zh, q->stream, q->setname, q->comp,
 328                             q->format, 1, &retrievalRecord);
 329     if (zh->errCode)                  /* non Surrogate Diagnostic */
 330     {
 331         r->errcode = zh->errCode;
 332         r->errstring = zh->errString;
 333     }
 334     else if (retrievalRecord.errCode) /* Surrogate Diagnostic */
 335     {
 336         q->surrogate_flag = 1;
 337         r->errcode = retrievalRecord.errCode;
 338         r->errstring = retrievalRecord.errString;
 339         r->basename = retrievalRecord.base;
 340     }
 341     else                              /* Database Record */
 342     {
 343         r->errcode = 0;
 344         r->basename = retrievalRecord.base;
 345         r->record = retrievalRecord.buf;
 346         r->len = retrievalRecord.len;
 347         r->format = retrievalRecord.format;
 348     }
 349     return r;
 350 }
 351
 352 bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
 353 {
 354     ZebraScanEntry *entries;
 355     ZebraHandle zh = handle;
 356     bend_scanresult *r = odr_malloc (q->stream, sizeof(*r));
 357     int is_partial, i;
 358
 359     r->term_position = q->term_position;
 360     r->num_entries = q->num_entries;
 361
 362     r->entries = odr_malloc (q->stream, sizeof(*r->entries) * q->num_entries);
 363     zebra_scan (zh, q->stream, q->term,
 364                 q->attributeset,
 365                 q->num_bases, q->basenames,
 366                 &r->term_position,
 367                 &r->num_entries, &entries, &is_partial);
 368     if (is_partial)
 369         r->status = BEND_SCAN_PARTIAL;
 370     else
 371         r->status = BEND_SCAN_SUCCESS;
 372     for (i = 0; i < r->num_entries; i++)
 373     {
 374         r->entries[i].term = entries[i].term;
 375         r->entries[i].occurrences = entries[i].occurrences;
 376     }
 377     r->errcode = zh->errCode;
 378     r->errstring = zh->errString;
 379     return r;
 380 }
 381
 382 void bend_close (void *handle)
 383 {
 384     zebra_close ((ZebraHandle) handle);
 385 }
 386
 387 int bend_sort (void *handle, bend_sort_rr *rr)
 388 {
 389     ZebraHandle zh = handle;
 390
 391     zebra_sort (zh, rr->stream,
 392                 rr->num_input_setnames, (const char **) rr->input_setnames,
 393                 rr->output_setname, rr->sort_sequence, &rr->sort_status);
 394     rr->errcode = zh->errCode;
 395     rr->errstring = zh->errString;
 396     return 0;
 397 }
 398
 399 #ifndef WINDOWS
 400 static void pre_init (struct statserv_options_block *sob)
 401 {
 402     char *pidfile = "zebrasrv.pid";
 403     int fd = creat (pidfile, 0666);
 404
 405     if (fd == -1)
 406         logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
 407     else
 408     {
 409         char pidstr[30];
 410
 411         sprintf (pidstr, "%ld", (long) getpid ());
 412         write (fd, pidstr, strlen(pidstr));
 413         close (fd);
 414     }
 415 }
 416 #endif
 417
 418 int main (int argc, char **argv)
 419 {
 420     struct statserv_options_block *sob;
 421
 422     sob = statserv_getcontrol ();
 423     strcpy (sob->configname, FNAME_CONFIG);
 424 #ifndef WINDOWS
 425     sob->pre_init = pre_init;
 426 #endif
 427     statserv_setcontrol (sob);
 428
 429     return statserv_main (argc, argv);
 430 }