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