ztest/ztest.c

   1 /*
   2  * Copyright (c) 1995-2001, Index Data.
   3  * See the file LICENSE for details.
   4  *
   5  * NT Service interface by
   6  *    Chas Woodfield, Fretwell Downing Datasystems.
   7  *
   8  * $Log: ztest.c,v $
   9  * Revision 1.38  2001-02-21 13:46:54  adam
  10  * C++ fixes.
  11  *
  12  * Revision 1.37  2001/02/20 11:25:32  adam
  13  * Added ill_get_APDU and ill_get_Cancel.
  14  *
  15  * Revision 1.36  2001/01/30 21:34:18  adam
  16  * Added step-size for Scan backend interface.
  17  *
  18  * Revision 1.35  2000/11/23 10:58:33  adam
  19  * SSL comstack support. Separate POSIX thread support library.
  20  *
  21  * Revision 1.34  2000/09/04 08:58:15  adam
  22  * Added prefix yaz_ for most logging utility functions.
  23  *
  24  * Revision 1.33  2000/08/10 08:41:26  adam
  25  * Fixes for ILL.
  26  *
  27  * Revision 1.32  2000/04/05 07:39:55  adam
  28  * Added shared library support (libtool).
  29  *
  30  * Revision 1.31  2000/01/31 13:15:21  adam
  31  * Removed uses of assert(3). Cleanup of ODR. CCL parser update so
  32  * that some characters are not surrounded by spaces in resulting term.
  33  * ILL-code updates.
  34  *
  35  * Revision 1.30  2000/01/13 23:05:50  adam
  36  * Fixed tagging for member requester-CHECKED-IN in ILL ASN.1 spec.
  37  *
  38  * Revision 1.29  2000/01/12 14:36:07  adam
  39  * Added printing stream (ODR) for backend functions.
  40  *
  41  * Revision 1.28  1999/12/16 23:36:19  adam
  42  * Implemented ILL protocol. Minor updates ASN.1 compiler.
  43  *
  44  * Revision 1.27  1999/11/30 13:47:12  adam
  45  * Improved installation. Moved header files to include/yaz.
  46  *
  47  * Revision 1.26  1999/08/27 09:40:32  adam
  48  * Renamed logf function to yaz_log. Removed VC++ project files.
  49  *
  50  * Revision 1.25  1999/06/01 14:29:12  adam
  51  * Work on Extended Services.
  52  *
  53  * Revision 1.24  1999/05/27 13:07:54  adam
  54  * Fix.
  55  *
  56  * Revision 1.23  1999/05/27 13:02:20  adam
  57  * Assigned OID for old DB Update (VAL_DBUPDATE0).
  58  *
  59  * Revision 1.22  1999/05/26 13:49:12  adam
  60  * DB Update implemented in client (very basic).
  61  *
  62  * Revision 1.21  1998/12/15 12:45:42  adam
  63  * Minor change.
  64  *
  65  * Revision 1.20  1998/12/14 14:48:05  adam
  66  * Fixed memory leak - happened when fetching MARC records.
  67  *
  68  * Revision 1.19  1998/10/20 15:16:22  adam
  69  * Minor change to prevent warning.
  70  *
  71  * Revision 1.18  1998/10/20 15:13:45  adam
  72  * Minor fix regarding output for Item Order.
  73  *
  74  * Revision 1.17  1998/10/18 22:33:35  quinn
  75  * Added diagnostic dump of Item Order Eservice.
  76  *
  77  * Revision 1.16  1998/10/15 08:26:23  adam
  78  * Added type cast to make C++ happy.
  79  *
  80  * Revision 1.15  1998/10/13 20:05:57  adam
  81  * Minor change.
  82  *
  83  * Revision 1.14  1998/10/13 16:12:25  adam
  84  * Added support for Surrogate Diagnostics for Scan Term entries.
  85  *
  86  * Revision 1.13  1998/08/19 16:10:09  adam
  87  * Changed som member names of DeleteResultSetRequest/Response.
  88  *
  89  * Revision 1.12  1998/07/20 12:38:44  adam
  90  * Implemented delete result set service to server API.
  91  *
  92  * Revision 1.11  1998/06/09 13:55:08  adam
  93  * Minor changes.
  94  *
  95  * Revision 1.10  1998/05/27 16:55:54  adam
  96  * Minor changes.
  97  *
  98  * Revision 1.9  1998/03/31 11:07:45  adam
  99  * Furhter work on UNIverse resource report.
 100  * Added Extended Services handling in frontend server.
 101  *
 102  * Revision 1.8  1998/02/11 11:53:36  adam
 103  * Changed code so that it compiles as C++.
 104  *
 105  * Revision 1.7  1998/02/10 11:03:57  adam
 106  * Added support for extended handlers in backend server interface.
 107  *
 108  * Revision 1.6  1998/01/29 13:16:02  adam
 109  * Added dummy sort in test server.
 110  *
 111  * Revision 1.5  1997/11/07 13:31:58  adam
 112  * Added NT Service name part of statserv_options_block. Moved NT
 113  * service utility to server library.
 114  *
 115  * Revision 1.4  1997/09/17 12:10:43  adam
 116  * YAZ version 1.4.
 117  *
 118  * Revision 1.3  1997/09/09 10:10:20  adam
 119  * Another MSV5.0 port. Changed projects to include proper
 120  * library/include paths.
 121  * Server starts server in test-mode when no options are given.
 122  *
 123  * Revision 1.2  1997/09/04 13:50:31  adam
 124  * Bug fix in ztest.
 125  *
 126  */
 127
 128 /*
 129  * Demonstration of simple server
 130  */
 131
 132 #include <stdio.h>
 133 #include <stdlib.h>
 134 #include <ctype.h>
 135
 136 #include <yaz/backend.h>
 137 #include <yaz/log.h>
 138
 139 #ifdef ASN_COMPILED
 140 #include <yaz/ill.h>
 141 #endif
 142
 143 Z_GenericRecord *read_grs1(FILE *f, ODR o);
 144
 145 int ztest_search (void *handle, bend_search_rr *rr);
 146 int ztest_sort (void *handle, bend_sort_rr *rr);
 147 int ztest_present (void *handle, bend_present_rr *rr);
 148 int ztest_esrequest (void *handle, bend_esrequest_rr *rr);
 149 int ztest_delete (void *handle, bend_delete_rr *rr);
 150
 151 int ztest_search (void *handle, bend_search_rr *rr)
 152 {
 153     rr->hits = rand() % 22;
 154     return 0;
 155 }
 156
 157 int ztest_present (void *handle, bend_present_rr *rr)
 158 {
 159     return 0;
 160 }
 161
 162 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
 163 {
 164     yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
 165     if (rr->esr->packageName)
 166         yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
 167     yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
 168
 169     if (!rr->esr->taskSpecificParameters)
 170     {
 171         yaz_log (LOG_WARN, "No task specific parameters");
 172     }
 173     else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
 174     {
 175         Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
 176         yaz_log (LOG_LOG, "Received ItemOrder");
 177         switch (it->which)
 178         {
 179 #ifdef ASN_COMPILED
 180         case Z_IOItemOrder_esRequest:
 181 #else
 182         case Z_ItemOrder_esRequest:
 183 #endif
 184         {
 185             Z_IORequest *ir = it->u.esRequest;
 186             Z_IOOriginPartToKeep *k = ir->toKeep;
 187             Z_IOOriginPartNotToKeep *n = ir->notToKeep;
 188
 189             if (k && k->contact)
 190             {
 191                 if (k->contact->name)
 192                     yaz_log(LOG_LOG, "contact name %s", k->contact->name);
 193                 if (k->contact->phone)
 194                     yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
 195                 if (k->contact->email)
 196                     yaz_log(LOG_LOG, "contact email %s", k->contact->email);
 197             }
 198             if (k->addlBilling)
 199             {
 200                 yaz_log(LOG_LOG, "Billing info (not shown)");
 201             }
 202
 203             if (n->resultSetItem)
 204             {
 205                 yaz_log(LOG_LOG, "resultsetItem");
 206                 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
 207                 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
 208             }
 209 #ifdef ASN_COMPILED
 210             if (n->itemRequest)
 211             {
 212                 Z_External *r = (Z_External*) n->itemRequest;
 213                 ILL_ItemRequest *item_req = 0;
 214                 ILL_APDU *ill_apdu = 0;
 215                 if (r->direct_reference)
 216                 {
 217                     oident *ent = oid_getentbyoid(r->direct_reference);
 218                     if (ent)
 219                         yaz_log(LOG_LOG, "OID %s", ent->desc);
 220                     if (ent && ent->value == VAL_ISO_ILL_1)
 221                     {
 222                         yaz_log (LOG_LOG, "Decode ItemRequest begin");
 223                         if (r->which == ODR_EXTERNAL_single)
 224                         {
 225                             odr_setbuf(rr->decode,
 226                                        (char *) r->u.single_ASN1_type->buf,
 227                                        r->u.single_ASN1_type->len, 0);
 228
 229                             if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
 230                             {
 231                                 yaz_log (LOG_LOG,
 232                                     "Couldn't decode ItemRequest %s near %d",
 233                                        odr_errmsg(odr_geterror(rr->decode)),
 234                                        odr_offset(rr->decode));
 235 #if 0
 236                                 yaz_log(LOG_LOG, "PDU dump:");
 237                                 odr_dumpBER(yaz_log_file(),
 238                                      r->u.single_ASN1_type->buf,
 239                                      r->u.single_ASN1_type->len);
 240 #endif
 241                             }
 242                             else
 243                                 yaz_log(LOG_LOG, "Decode ItemRequest OK");
 244                             if (rr->print)
 245                             {
 246                                 ill_ItemRequest (rr->print, &item_req, 0,
 247                                     "ItemRequest");
 248                                 odr_reset (rr->print);
 249                             }
 250                         }
 251                         if (!item_req && r->which == ODR_EXTERNAL_single)
 252                         {
 253                             yaz_log (LOG_LOG, "Decode ILL APDU begin");
 254                             odr_setbuf(rr->decode,
 255                                        (char*) r->u.single_ASN1_type->buf,
 256                                        r->u.single_ASN1_type->len, 0);
 257
 258                             if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
 259                             {
 260                                 yaz_log (LOG_LOG,
 261                                     "Couldn't decode ILL APDU %s near %d",
 262                                        odr_errmsg(odr_geterror(rr->decode)),
 263                                        odr_offset(rr->decode));
 264                                 yaz_log(LOG_LOG, "PDU dump:");
 265                                 odr_dumpBER(yaz_log_file(),
 266                                      (char *) r->u.single_ASN1_type->buf,
 267                                      r->u.single_ASN1_type->len);
 268                             }
 269                             else
 270                                 yaz_log(LOG_LOG, "Decode ILL APDU OK");
 271                             if (rr->print)
 272                             {
 273                                 ill_APDU (rr->print, &ill_apdu, 0,
 274                                     "ILL APDU");
 275                                 odr_reset (rr->print);
 276                             }
 277                         }
 278                     }
 279                 }
 280                 if (item_req)
 281                 {
 282                     yaz_log (LOG_LOG, "ILL protocol version = %d",
 283                              *item_req->protocol_version_num);
 284                 }
 285             }
 286 #endif
 287         }
 288         break;
 289         }
 290     }
 291     else if (rr->esr->taskSpecificParameters->which == Z_External_update)
 292     {
 293         Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
 294         yaz_log (LOG_LOG, "Received DB Update");
 295         if (up->which == Z_IUUpdate_esRequest)
 296         {
 297             Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
 298             Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
 299             Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
 300
 301             yaz_log (LOG_LOG, "action");
 302             if (toKeep->action)
 303             {
 304                 switch (*toKeep->action)
 305                 {
 306                 case Z_IUOriginPartToKeep_recordInsert:
 307                     yaz_log (LOG_LOG, " recordInsert");
 308                     break;
 309                 case Z_IUOriginPartToKeep_recordReplace:
 310                     yaz_log (LOG_LOG, " recordUpdate");
 311                     break;
 312                 case Z_IUOriginPartToKeep_recordDelete:
 313                     yaz_log (LOG_LOG, " recordDelete");
 314                     break;
 315                 case Z_IUOriginPartToKeep_elementUpdate:
 316                     yaz_log (LOG_LOG, " elementUpdate");
 317                     break;
 318                 case Z_IUOriginPartToKeep_specialUpdate:
 319                     yaz_log (LOG_LOG, " specialUpdate");
 320                     break;
 321                 default:
 322                     yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
 323                 }
 324             }
 325             if (toKeep->databaseName)
 326             {
 327                 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
 328                 if (!strcmp(toKeep->databaseName, "fault"))
 329                 {
 330                     rr->errcode = 109;
 331                     rr->errstring = toKeep->databaseName;
 332                 }
 333                 if (!strcmp(toKeep->databaseName, "accept"))
 334                     rr->errcode = -1;
 335             }
 336             if (notToKeep)
 337             {
 338                 int i;
 339                 for (i = 0; i < notToKeep->num; i++)
 340                 {
 341                     Z_External *rec = notToKeep->elements[i]->record;
 342
 343                     if (rec->direct_reference)
 344                     {
 345                         struct oident *oident;
 346                         oident = oid_getentbyoid(rec->direct_reference);
 347                         if (oident)
 348                             yaz_log (LOG_LOG, "record %d type %s", i,
 349                                      oident->desc);
 350                     }
 351                     switch (rec->which)
 352                     {
 353                     case Z_External_sutrs:
 354                         if (rec->u.octet_aligned->len > 170)
 355                             yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
 356                                      rec->u.sutrs->len,
 357                                      rec->u.sutrs->buf);
 358                         else
 359                             yaz_log (LOG_LOG, "%d bytes:\n%s",
 360                                      rec->u.sutrs->len,
 361                                      rec->u.sutrs->buf);
 362                         break;
 363                     case Z_External_octet        :
 364                         if (rec->u.octet_aligned->len > 170)
 365                             yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
 366                                      rec->u.octet_aligned->len,
 367                                      rec->u.octet_aligned->buf);
 368                         else
 369                             yaz_log (LOG_LOG, "%d bytes\n%s",
 370                                      rec->u.octet_aligned->len,
 371                                      rec->u.octet_aligned->buf);
 372                     }
 373                 }
 374             }
 375         }
 376     }
 377     else
 378     {
 379         yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
 380                  rr->esr->taskSpecificParameters->which);
 381
 382     }
 383     return 0;
 384 }
 385
 386 int ztest_delete (void *handle, bend_delete_rr *rr)
 387 {
 388     if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
 389         rr->delete_status = Z_DeleteStatus_success;
 390     else
 391         rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
 392     return 0;
 393 }
 394
 395 /* Our sort handler really doesn't sort... */
 396 int ztest_sort (void *handle, bend_sort_rr *rr)
 397 {
 398     rr->errcode = 0;
 399     rr->sort_status = Z_SortStatus_success;
 400     return 0;
 401 }
 402
 403 static int atoin (const char *buf, int n)
 404 {
 405     int val = 0;
 406     while (--n >= 0)
 407     {
 408         if (isdigit(*buf))
 409             val = val*10 + (*buf - '0');
 410         buf++;
 411     }
 412     return val;
 413 }
 414
 415 char *marc_read(FILE *inf, ODR odr)
 416 {
 417     char length_str[5];
 418     size_t size;
 419     char *buf;
 420
 421     if (fread (length_str, 1, 5, inf) != 5)
 422         return NULL;
 423     size = atoin (length_str, 5);
 424     if (size <= 6)
 425         return NULL;
 426     if (!(buf = (char*) odr_malloc (odr, size+1)))
 427         return NULL;
 428     if (fread (buf+5, 1, size-5, inf) != (size-5))
 429     {
 430         xfree (buf);
 431         return NULL;
 432     }
 433     memcpy (buf, length_str, 5);
 434     buf[size] = '\0';
 435     return buf;
 436 }
 437
 438 static char *dummy_database_record (int num, ODR odr)
 439 {
 440     FILE *inf = fopen ("dummy-records", "r");
 441     char *buf = 0;
 442
 443     if (!inf)
 444         return NULL;
 445     while (--num >= 0)
 446     {
 447         if (num == 98)
 448         {
 449             buf = (char*) odr_malloc(odr, 2101);
 450             memset(buf, 'A', 2100);
 451             buf[2100] = '\0';
 452             break;
 453         }
 454         else
 455             buf = marc_read (inf, odr);
 456         if (!num || !buf)
 457             break;
 458     }
 459     fclose(inf);
 460     if (num < 0)
 461         return 0;
 462     return buf;
 463 }
 464
 465 static Z_GenericRecord *dummy_grs_record (int num, ODR o)
 466 {
 467     FILE *f = fopen("dummy-grs", "r");
 468     char line[512];
 469     Z_GenericRecord *r = 0;
 470     int n;
 471
 472     if (!f)
 473         return 0;
 474     while (fgets(line, 512, f))
 475         if (*line == '#' && sscanf(line, "#%d", &n) == 1 && n == num)
 476         {
 477             r = read_grs1(f, o);
 478             break;
 479         }
 480     fclose(f);
 481     return r;
 482 }
 483
 484 int ztest_fetch(void *handle, bend_fetch_rr *r)
 485 {
 486     char *cp;
 487     r->errstring = 0;
 488     r->last_in_set = 0;
 489     r->basename = "DUMMY";
 490     r->output_format = r->request_format;
 491     if (r->request_format == VAL_SUTRS)
 492     {
 493 #if 0
 494 /* this section returns a huge record (for testing non-blocking write, etc) */
 495         r->len = 980000;
 496         r->record = odr_malloc (r->stream, r->len);
 497         memset (r->record, 'x', r->len);
 498 #else
 499 /* this section returns a small record */
 500         char buf[100];
 501
 502         sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
 503
 504         r->len = strlen(buf);
 505         r->record = (char *) odr_malloc (r->stream, r->len+1);
 506         strcpy(r->record, buf);
 507 #endif
 508     }
 509     else if (r->request_format == VAL_GRS1)
 510     {
 511         r->len = -1;
 512         r->record = (char*) dummy_grs_record(r->number, r->stream);
 513         if (!r->record)
 514         {
 515             r->errcode = 13;
 516             return 0;
 517         }
 518     }
 519     else if ((cp = dummy_database_record(r->number, r->stream)))
 520     {
 521         r->len = strlen(cp);
 522         r->record = cp;
 523         r->output_format = VAL_USMARC;
 524     }
 525     else
 526     {
 527         r->errcode = 13;
 528         return 0;
 529     }
 530     r->errcode = 0;
 531     return 0;
 532 }
 533
 534 /*
 535  * silly dummy-scan what reads words from a file.
 536  */
 537 int ztest_scan(void *handle, bend_scan_rr *q)
 538 {
 539     static FILE *f = 0;
 540     static struct scan_entry list[200];
 541     static char entries[200][80];
 542     int hits[200];
 543     char term[80], *p;
 544     int i, pos;
 545     int term_position_req = q->term_position;
 546     int num_entries_req = q->num_entries;
 547
 548     q->errcode = 0;
 549     q->errstring = 0;
 550     q->entries = list;
 551     q->status = BEND_SCAN_SUCCESS;
 552     if (!f && !(f = fopen("dummy-words", "r")))
 553     {
 554         perror("dummy-words");
 555         exit(1);
 556     }
 557     if (q->term->term->which != Z_Term_general)
 558     {
 559         q->errcode = 229; /* unsupported term type */
 560         return 0;
 561     }
 562     if (*q->step_size != 0)
 563     {
 564         q->errcode = 205; /*Only zero step size supported for Scan */
 565         return 0;
 566     }
 567     if (q->term->term->u.general->len >= 80)
 568     {
 569         q->errcode = 11; /* term too long */
 570         return 0;
 571     }
 572     if (q->num_entries > 200)
 573     {
 574         q->errcode = 31;
 575         return 0;
 576     }
 577     memcpy(term, q->term->term->u.general->buf, q->term->term->u.general->len);
 578     term[q->term->term->u.general->len] = '\0';
 579     for (p = term; *p; p++)
 580         if (islower(*p))
 581             *p = toupper(*p);
 582
 583     fseek(f, 0, SEEK_SET);
 584     q->num_entries = 0;
 585
 586     for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
 587         i++, pos < 199 ? pos++ : (pos = 0))
 588     {
 589         if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
 590         {
 591             if ((q->term_position = term_position_req) > i + 1)
 592             {
 593                 q->term_position = i + 1;
 594                 q->status = BEND_SCAN_PARTIAL;
 595             }
 596             for (; q->num_entries < q->term_position; q->num_entries++)
 597             {
 598                 int po;
 599
 600                 po = pos - q->term_position + q->num_entries+1; /* find pos */
 601                 if (po < 0)
 602                     po += 200;
 603
 604                 if (!strcmp (term, "SD") && q->num_entries == 2)
 605                 {
 606                     list[q->num_entries].term = entries[pos];
 607                     list[q->num_entries].occurrences = -1;
 608                     list[q->num_entries].errcode = 233;
 609                     list[q->num_entries].errstring = "SD for Scan Term";
 610                 }
 611                 else
 612                 {
 613                     list[q->num_entries].term = entries[po];
 614                     list[q->num_entries].occurrences = hits[po];
 615                 }
 616             }
 617         }
 618         else if (q->num_entries)
 619         {
 620             list[q->num_entries].term = entries[pos];
 621             list[q->num_entries].occurrences = hits[pos];
 622             q->num_entries++;
 623         }
 624         if (q->num_entries >= num_entries_req)
 625             break;
 626     }
 627     if (feof(f))
 628         q->status = BEND_SCAN_PARTIAL;
 629     return 0;
 630 }
 631
 632 bend_initresult *bend_init(bend_initrequest *q)
 633 {
 634     bend_initresult *r = (bend_initresult *) odr_malloc (q->stream, sizeof(*r));
 635     static char *dummy = "Hej fister";
 636
 637     r->errcode = 0;
 638     r->errstring = 0;
 639     r->handle = dummy;
 640     q->bend_sort = ztest_sort;              /* register sort handler */
 641     q->bend_search = ztest_search;          /* register search handler */
 642     q->bend_present = ztest_present;        /* register present handle */
 643     q->bend_esrequest = ztest_esrequest;
 644     q->bend_delete = ztest_delete;
 645     q->bend_fetch = ztest_fetch;
 646     q->bend_scan = ztest_scan;
 647     return r;
 648 }
 649
 650 void bend_close(void *handle)
 651 {
 652     return;
 653 }
 654
 655 int main(int argc, char **argv)
 656 {
 657     return statserv_main(argc, argv, bend_init, bend_close);
 658 }