index/zserver.c

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