index/zserver.c

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