index/zserver.c

   1 /*
   2  * Copyright (C) 1995-2000, Index Data
   3  * All rights reserved.
   4  *
   5  * $Id: zserver.c,v 1.85 2002-04-04 14:14:13 adam Exp $
   6  */
   7
   8 #include <stdio.h>
   9 #include <assert.h>
  10 #include <fcntl.h>
  11 #ifdef WIN32
  12 #include <io.h>
  13 #include <process.h>
  14 #else
  15 #include <unistd.h>
  16 #endif
  17
  18 #include <yaz/data1.h>
  19 #ifdef ASN_COMPILED
  20 #include <yaz/ill.h>
  21 #endif
  22
  23 #include "zserver.h"
  24
  25 static int bend_sort (void *handle, bend_sort_rr *rr);
  26 static int bend_delete (void *handle, bend_delete_rr *rr);
  27 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
  28 static int bend_segment (void *handle, bend_segment_rr *rr);
  29 static int bend_search (void *handle, bend_search_rr *r);
  30 static int bend_fetch (void *handle, bend_fetch_rr *r);
  31 static int bend_scan (void *handle, bend_scan_rr *r);
  32
  33 bend_initresult *bend_init (bend_initrequest *q)
  34 {
  35     bend_initresult *r = (bend_initresult *)
  36         odr_malloc (q->stream, sizeof(*r));
  37     ZebraHandle zh;
  38     struct statserv_options_block *sob;
  39     char *user = NULL;
  40     char *passwd = NULL;
  41
  42     r->errcode = 0;
  43     r->errstring = 0;
  44     q->bend_sort = bend_sort;
  45     q->bend_delete = bend_delete;
  46     q->bend_esrequest = bend_esrequest;
  47     q->bend_segment = bend_segment;
  48     q->bend_search = bend_search;
  49     q->bend_fetch = bend_fetch;
  50     q->bend_scan = bend_scan;
  51
  52 #if ZMBOL
  53     q->implementation_name = "Z'mbol Information Server";
  54     q->implementation_version = "Z'mbol " ZEBRAVER;
  55 #else
  56     q->implementation_name = "Zebra Information Server";
  57     q->implementation_version = "Zebra " ZEBRAVER;
  58 #endif
  59
  60     logf (LOG_DEBUG, "bend_init");
  61
  62     sob = statserv_getcontrol ();
  63     if (!(zh = zebra_open (sob->handle)))
  64     {
  65         logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
  66         r->errcode = 1;
  67         return r;
  68     }
  69     if (q->auth)
  70     {
  71         if (q->auth->which == Z_IdAuthentication_open)
  72         {
  73             char *openpass = xstrdup (q->auth->u.open);
  74             char *cp = strchr (openpass, '/');
  75             if (cp)
  76             {
  77                 *cp = '\0';
  78                 user = nmem_strdup (odr_getmem (q->stream), openpass);
  79                 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
  80             }
  81             xfree (openpass);
  82         }
  83     }
  84     if (zebra_auth (zh, user, passwd))
  85     {
  86         r->errcode = 222;
  87         r->errstring = user;
  88         zebra_close (zh);
  89         return r;
  90     }
  91     r->handle = zh;
  92     return r;
  93 }
  94
  95 static void search_terms (ZebraHandle zh, bend_search_rr *r)
  96 {
  97     int count;
  98     int no_terms;
  99     int i;
 100     struct Z_External *ext;
 101     Z_SearchInfoReport *sr;
 102
 103     /* get no of terms for result set */
 104     zebra_resultSetTerms (zh, r->setname, -1, &count, &no_terms);
 105     if (!no_terms)
 106         return;
 107
 108     r->search_info = odr_malloc (r->stream, sizeof(*r->search_info));
 109
 110     r->search_info->num_elements = 1;
 111     r->search_info->list =
 112         odr_malloc (r->stream, sizeof(*r->search_info->list));
 113     r->search_info->list[0] =
 114         odr_malloc (r->stream, sizeof(**r->search_info->list));
 115     r->search_info->list[0]->category = 0;
 116     r->search_info->list[0]->which = Z_OtherInfo_externallyDefinedInfo;
 117     ext = odr_malloc (r->stream, sizeof(*ext));
 118     r->search_info->list[0]->information.externallyDefinedInfo = ext;
 119     ext->direct_reference =
 120         yaz_oidval_to_z3950oid (r->stream, CLASS_USERINFO, VAL_SEARCHRES1);
 121     ext->indirect_reference = 0;
 122     ext->descriptor = 0;
 123     ext->which = Z_External_searchResult1;
 124     sr = odr_malloc (r->stream, sizeof(Z_SearchInfoReport));
 125     ext->u.searchResult1 = sr;
 126     sr->num = no_terms;
 127     sr->elements = odr_malloc (r->stream, sr->num *
 128                                sizeof(*sr->elements));
 129     for (i = 0; i<no_terms; i++)
 130     {
 131         Z_Term *term;
 132         const char *termz = zebra_resultSetTerms (zh, r->setname, i,
 133                                                   &count, &no_terms);
 134
 135         sr->elements[i] = odr_malloc (r->stream, sizeof(**sr->elements));
 136         sr->elements[i]->subqueryId = 0;
 137         sr->elements[i]->fullQuery = odr_malloc (r->stream,
 138                                                  sizeof(bool_t));
 139         *sr->elements[i]->fullQuery = 0;
 140         sr->elements[i]->subqueryExpression =
 141             odr_malloc (r->stream, sizeof(Z_QueryExpression));
 142         sr->elements[i]->subqueryExpression->which =
 143             Z_QueryExpression_term;
 144         sr->elements[i]->subqueryExpression->u.term =
 145             odr_malloc (r->stream, sizeof(Z_QueryExpressionTerm));
 146         term = odr_malloc (r->stream, sizeof(Z_Term));
 147         sr->elements[i]->subqueryExpression->u.term->queryTerm = term;
 148
 149         term->which = Z_Term_general;
 150         term->u.general = odr_malloc (r->stream, sizeof(Odr_oct));
 151         term->u.general->buf = odr_strdup (r->stream, termz);
 152
 153         term->u.general->len = strlen (termz);
 154         term->u.general->size = strlen (termz);
 155
 156         sr->elements[i]->subqueryExpression->u.term->termComment = 0;
 157         sr->elements[i]->subqueryInterpretation = 0;
 158         sr->elements[i]->subqueryRecommendation = 0;
 159         sr->elements[i]->subqueryCount = odr_intdup (r->stream, count);
 160         sr->elements[i]->subqueryWeight = 0;
 161         sr->elements[i]->resultsByDB = 0;
 162     }
 163 }
 164
 165 int bend_search (void *handle, bend_search_rr *r)
 166 {
 167     ZebraHandle zh = (ZebraHandle) handle;
 168
 169     r->hits = 0;
 170     r->errcode = 0;
 171     r->errstring = NULL;
 172
 173     if (zebra_select_databases (zh, r->num_bases,
 174                                 (const char **) r->basenames))
 175     {
 176         zebra_result (zh, &r->errcode, &r->errstring);
 177         return 0;
 178     }
 179     logf (LOG_LOG, "ResultSet '%s'", r->setname);
 180     switch (r->query->which)
 181     {
 182     case Z_Query_type_1: case Z_Query_type_101:
 183         zebra_search_rpn (zh, r->decode, r->stream, r->query->u.type_1,
 184                           r->setname, &r->hits);
 185         zebra_result (zh, &r->errcode, &r->errstring);
 186         if (!r->errcode)
 187             search_terms (zh, r);
 188         break;
 189     case Z_Query_type_2:
 190         r->errcode = 107;
 191         r->errstring = "type-2";
 192         break;
 193     default:
 194         r->errcode = 107;
 195     }
 196     return 0;
 197 }
 198
 199
 200 int bend_fetch (void *handle, bend_fetch_rr *r)
 201 {
 202     ZebraHandle zh = (ZebraHandle) handle;
 203     ZebraRetrievalRecord retrievalRecord;
 204
 205     retrievalRecord.position = r->number;
 206
 207     r->last_in_set = 0;
 208     zebra_records_retrieve (zh, r->stream, r->setname, r->comp,
 209                             r->request_format, 1, &retrievalRecord);
 210     zebra_result (zh, &r->errcode, &r->errstring);
 211     /*  non Surrogate Diagnostic OR Surrogate Diagnostic */
 212     if (r->errcode == 0 && retrievalRecord.errCode)
 213     {
 214         r->surrogate_flag = 1;
 215         r->errcode = retrievalRecord.errCode;
 216         r->errstring = retrievalRecord.errString;
 217         r->basename = retrievalRecord.base;
 218     }
 219     else if (r->errcode == 0)        /* Database Record */
 220     {
 221         r->errcode = 0;
 222         r->basename = retrievalRecord.base;
 223         r->record = retrievalRecord.buf;
 224         r->len = retrievalRecord.len;
 225         r->output_format = retrievalRecord.format;
 226     }
 227     return 0;
 228 }
 229
 230 static int bend_scan (void *handle, bend_scan_rr *r)
 231 {
 232     ZebraScanEntry *entries;
 233     ZebraHandle zh = (ZebraHandle) handle;
 234     int is_partial, i;
 235
 236     zebra_select_databases (zh, r->num_bases, (const char **) r->basenames);
 237
 238     r->entries = (struct scan_entry *)
 239         odr_malloc (r->stream, sizeof(*r->entries) * r->num_entries);
 240     zebra_scan (zh, r->stream, r->term,
 241                 r->attributeset,
 242                 &r->term_position,
 243                 &r->num_entries, &entries, &is_partial);
 244     if (is_partial)
 245         r->status = BEND_SCAN_PARTIAL;
 246     else
 247         r->status = BEND_SCAN_SUCCESS;
 248     for (i = 0; i < r->num_entries; i++)
 249     {
 250         r->entries[i].term = entries[i].term;
 251         r->entries[i].occurrences = entries[i].occurrences;
 252     }
 253     zebra_result (zh, &r->errcode, &r->errstring);
 254     return 0;
 255 }
 256
 257 void bend_close (void *handle)
 258 {
 259     zebra_close ((ZebraHandle) handle);
 260     xmalloc_trav("bend_close");
 261     nmem_print_list();
 262 }
 263
 264 int bend_sort (void *handle, bend_sort_rr *rr)
 265 {
 266     ZebraHandle zh = (ZebraHandle) handle;
 267
 268     zebra_sort (zh, rr->stream,
 269                 rr->num_input_setnames, (const char **) rr->input_setnames,
 270                 rr->output_setname, rr->sort_sequence, &rr->sort_status);
 271     zebra_result (zh, &rr->errcode, &rr->errstring);
 272     return 0;
 273 }
 274
 275 int bend_delete (void *handle, bend_delete_rr *rr)
 276 {
 277     ZebraHandle zh = (ZebraHandle) handle;
 278
 279     rr->delete_status = zebra_deleleResultSet(zh, rr->function,
 280                                               rr->num_setnames, rr->setnames,
 281                                               rr->statuses);
 282     return 0;
 283 }
 284
 285 static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
 286 {
 287     switch (r->toKeep->which)
 288     {
 289     case Z_ESAdminOriginPartToKeep_reIndex:
 290         yaz_log(LOG_LOG, "adm-reindex");
 291         break;
 292     case Z_ESAdminOriginPartToKeep_truncate:
 293         yaz_log(LOG_LOG, "adm-truncate");
 294         break;
 295     case Z_ESAdminOriginPartToKeep_drop:
 296         yaz_log(LOG_LOG, "adm-drop");
 297         break;
 298     case Z_ESAdminOriginPartToKeep_create:
 299         yaz_log(LOG_LOG, "adm-create");
 300         zebra_admin_create (zh, r->toKeep->databaseName);
 301         break;
 302     case Z_ESAdminOriginPartToKeep_import:
 303         yaz_log(LOG_LOG, "adm-import");
 304         zebra_admin_import_begin (zh, r->toKeep->databaseName);
 305         break;
 306     case Z_ESAdminOriginPartToKeep_refresh:
 307         yaz_log(LOG_LOG, "adm-refresh");
 308         break;
 309     case Z_ESAdminOriginPartToKeep_commit:
 310         yaz_log(LOG_LOG, "adm-commit");
 311         break;
 312     case Z_ESAdminOriginPartToKeep_shutdown:
 313         yaz_log(LOG_LOG, "shutdown");
 314         zebra_admin_shutdown(zh);
 315         break;
 316     case Z_ESAdminOriginPartToKeep_start:
 317         yaz_log(LOG_LOG, "start");
 318         zebra_admin_start(zh);
 319         break;
 320     default:
 321         yaz_log(LOG_LOG, "unknown admin");
 322     }
 323     if (r->toKeep->databaseName)
 324     {
 325         yaz_log(LOG_LOG, "database %s", r->toKeep->databaseName);
 326     }
 327     return 0;
 328 }
 329
 330 static int es_admin (ZebraHandle zh, Z_Admin *r)
 331 {
 332     switch (r->which)
 333     {
 334     case Z_Admin_esRequest:
 335         es_admin_request (zh, r->u.esRequest);
 336         break;
 337     case Z_Admin_taskPackage:
 338         yaz_log (LOG_LOG, "adm taskpackage (unhandled)");
 339         break;
 340     default:
 341         break;
 342     }
 343
 344     return 0;
 345 }
 346
 347 int bend_segment (void *handle, bend_segment_rr *rr)
 348 {
 349     ZebraHandle zh = (ZebraHandle) handle;
 350     Z_Segment *segment = rr->segment;
 351
 352     if (segment->num_segmentRecords)
 353         zebra_admin_import_segment (zh, rr->segment);
 354     else
 355         zebra_admin_import_end (zh);
 356     return 0;
 357 }
 358
 359 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
 360 {
 361     ZebraHandle zh = (ZebraHandle) handle;
 362
 363     yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
 364     if (rr->esr->packageName)
 365         yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
 366     yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
 367
 368     if (!rr->esr->taskSpecificParameters)
 369     {
 370         yaz_log (LOG_WARN, "No task specific parameters");
 371     }
 372     else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
 373     {
 374         es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
 375
 376         zebra_result (zh, &rr->errcode, &rr->errstring);
 377     }
 378     else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
 379     {
 380         Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
 381         yaz_log (LOG_LOG, "Received ItemOrder");
 382         switch (it->which)
 383         {
 384 #ifdef ASN_COMPILED
 385         case Z_IOItemOrder_esRequest:
 386 #else
 387         case Z_ItemOrder_esRequest:
 388 #endif
 389         {
 390             Z_IORequest *ir = it->u.esRequest;
 391             Z_IOOriginPartToKeep *k = ir->toKeep;
 392             Z_IOOriginPartNotToKeep *n = ir->notToKeep;
 393
 394             if (k && k->contact)
 395             {
 396                 if (k->contact->name)
 397                     yaz_log(LOG_LOG, "contact name %s", k->contact->name);
 398                 if (k->contact->phone)
 399                     yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
 400                 if (k->contact->email)
 401                     yaz_log(LOG_LOG, "contact email %s", k->contact->email);
 402             }
 403             if (k->addlBilling)
 404             {
 405                 yaz_log(LOG_LOG, "Billing info (not shown)");
 406             }
 407
 408             if (n->resultSetItem)
 409             {
 410                 yaz_log(LOG_LOG, "resultsetItem");
 411                 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
 412                 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
 413             }
 414 #ifdef ASN_COMPILED
 415             if (n->itemRequest)
 416             {
 417                 Z_External *r = (Z_External*) n->itemRequest;
 418                 ILL_ItemRequest *item_req = 0;
 419                 ILL_Request *ill_req = 0;
 420                 if (r->direct_reference)
 421                 {
 422                     oident *ent = oid_getentbyoid(r->direct_reference);
 423                     if (ent)
 424                         yaz_log(LOG_LOG, "OID %s", ent->desc);
 425                     if (ent && ent->value == VAL_ISO_ILL_1)
 426                     {
 427                         yaz_log (LOG_LOG, "ItemRequest");
 428                         if (r->which == ODR_EXTERNAL_single)
 429                         {
 430                             odr_setbuf(rr->decode,
 431                                        r->u.single_ASN1_type->buf,
 432                                        r->u.single_ASN1_type->len, 0);
 433
 434                             if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
 435                             {
 436                                 yaz_log (LOG_LOG,
 437                                     "Couldn't decode ItemRequest %s near %d",
 438                                        odr_errmsg(odr_geterror(rr->decode)),
 439                                        odr_offset(rr->decode));
 440                                 yaz_log(LOG_LOG, "PDU dump:");
 441                                 odr_dumpBER(yaz_log_file(),
 442                                      r->u.single_ASN1_type->buf,
 443                                      r->u.single_ASN1_type->len);
 444                             }
 445                             if (rr->print)
 446                             {
 447                                 ill_ItemRequest (rr->print, &item_req, 0,
 448                                     "ItemRequest");
 449                                 odr_reset (rr->print);
 450                             }
 451                         }
 452                         if (!item_req && r->which == ODR_EXTERNAL_single)
 453                         {
 454                             yaz_log (LOG_LOG, "ILLRequest");
 455                             odr_setbuf(rr->decode,
 456                                        r->u.single_ASN1_type->buf,
 457                                        r->u.single_ASN1_type->len, 0);
 458
 459                             if (!ill_Request (rr->decode, &ill_req, 0, 0))
 460                             {
 461                                 yaz_log (LOG_LOG,
 462                                     "Couldn't decode ILLRequest %s near %d",
 463                                        odr_errmsg(odr_geterror(rr->decode)),
 464                                        odr_offset(rr->decode));
 465                                 yaz_log(LOG_LOG, "PDU dump:");
 466                                 odr_dumpBER(yaz_log_file(),
 467                                      r->u.single_ASN1_type->buf,
 468                                      r->u.single_ASN1_type->len);
 469                             }
 470                             if (rr->print)
 471                             {
 472                                 ill_Request (rr->print, &ill_req, 0,
 473                                     "ILLRequest");
 474                                 odr_reset (rr->print);
 475                             }
 476                         }
 477                     }
 478                 }
 479                 if (item_req)
 480                 {
 481                     yaz_log (LOG_LOG, "ILL protocol version = %d",
 482                              *item_req->protocol_version_num);
 483                 }
 484             }
 485 #endif
 486         }
 487         break;
 488         }
 489     }
 490     else if (rr->esr->taskSpecificParameters->which == Z_External_update)
 491     {
 492         Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
 493         yaz_log (LOG_LOG, "Received DB Update");
 494         if (up->which == Z_IUUpdate_esRequest)
 495         {
 496             Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
 497             Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
 498             Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
 499
 500             yaz_log (LOG_LOG, "action");
 501             if (toKeep->action)
 502             {
 503                 switch (*toKeep->action)
 504                 {
 505                 case Z_IUOriginPartToKeep_recordInsert:
 506                     yaz_log (LOG_LOG, "recordInsert");
 507                     break;
 508                 case Z_IUOriginPartToKeep_recordReplace:
 509                     yaz_log (LOG_LOG, "recordUpdate");
 510                     break;
 511                 case Z_IUOriginPartToKeep_recordDelete:
 512                     yaz_log (LOG_LOG, "recordDelete");
 513                     break;
 514                 case Z_IUOriginPartToKeep_elementUpdate:
 515                     yaz_log (LOG_LOG, "elementUpdate");
 516                     break;
 517                 case Z_IUOriginPartToKeep_specialUpdate:
 518                     yaz_log (LOG_LOG, "specialUpdate");
 519                     break;
 520                 case Z_ESAdminOriginPartToKeep_shutdown:
 521                     yaz_log (LOG_LOG, "shutDown");
 522                     break;
 523                 case Z_ESAdminOriginPartToKeep_start:
 524                     yaz_log (LOG_LOG, "start");
 525                     break;
 526                 default:
 527                     yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
 528                 }
 529             }
 530             if (toKeep->databaseName)
 531             {
 532                 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
 533                 if (!strcmp(toKeep->databaseName, "fault"))
 534                 {
 535                     rr->errcode = 109;
 536                     rr->errstring = toKeep->databaseName;
 537                 }
 538                 if (!strcmp(toKeep->databaseName, "accept"))
 539                     rr->errcode = -1;
 540             }
 541             if (notToKeep)
 542             {
 543                 int i;
 544                 for (i = 0; i < notToKeep->num; i++)
 545                 {
 546                     Z_External *rec = notToKeep->elements[i]->record;
 547
 548                     if (rec->direct_reference)
 549                     {
 550                         struct oident *oident;
 551                         oident = oid_getentbyoid(rec->direct_reference);
 552                         if (oident)
 553                             yaz_log (LOG_LOG, "record %d type %s", i,
 554                                      oident->desc);
 555                     }
 556                     switch (rec->which)
 557                     {
 558                     case Z_External_sutrs:
 559                         if (rec->u.octet_aligned->len > 170)
 560                             yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
 561                                      rec->u.sutrs->len,
 562                                      rec->u.sutrs->buf);
 563                         else
 564                             yaz_log (LOG_LOG, "%d bytes:\n%s",
 565                                      rec->u.sutrs->len,
 566                                      rec->u.sutrs->buf);
 567                         break;
 568                     case Z_External_octet:
 569                         if (rec->u.octet_aligned->len > 170)
 570                             yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
 571                                      rec->u.octet_aligned->len,
 572                                      rec->u.octet_aligned->buf);
 573                         else
 574                             yaz_log (LOG_LOG, "%d bytes\n%s",
 575                                      rec->u.octet_aligned->len,
 576                                      rec->u.octet_aligned->buf);
 577                     }
 578                 }
 579             }
 580         }
 581     }
 582     else
 583     {
 584         yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
 585                  rr->esr->taskSpecificParameters->which);
 586
 587     }
 588     return 0;
 589 }
 590
 591 static void bend_start (struct statserv_options_block *sob)
 592 {
 593 #ifdef WIN32
 594
 595 #else
 596     if (!sob->inetd)
 597     {
 598         char *pidfile = "zebrasrv.pid";
 599         int fd = creat (pidfile, 0666);
 600         if (fd == -1)
 601             logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
 602         else
 603         {
 604             char pidstr[30];
 605
 606             sprintf (pidstr, "%ld", (long) getpid ());
 607             write (fd, pidstr, strlen(pidstr));
 608             close (fd);
 609         }
 610     }
 611 #endif
 612     if (sob->handle)
 613         zebra_stop((ZebraService) sob->handle);
 614     sob->handle = zebra_start(sob->configname);
 615 }
 616
 617 static void bend_stop(struct statserv_options_block *sob)
 618 {
 619     if (sob->handle)
 620     {
 621         ZebraService service = sob->handle;
 622         zebra_stop(service);
 623     }
 624 }
 625
 626 int main (int argc, char **argv)
 627 {
 628     struct statserv_options_block *sob;
 629
 630     sob = statserv_getcontrol ();
 631     strcpy (sob->configname, "zebra.cfg");
 632     sob->bend_start = bend_start;
 633     sob->bend_stop = bend_stop;
 634
 635     statserv_setcontrol (sob);
 636
 637     return statserv_main (argc, argv, bend_init, bend_close);
 638 }