ztest/ztest.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 Index Data
   3  * See the file LICENSE for details.
   4  */
   5
   6 /** \file
   7  * \brief yaz-ztest Generic Frontend Server
   8  */
   9
  10 #include <stdio.h>
  11 #include <math.h>
  12 #include <stdlib.h>
  13 #include <ctype.h>
  14
  15 #if HAVE_SYS_TIME_H
  16 #include <sys/time.h>
  17 #endif
  18 #if HAVE_UNISTD_H
  19 #include <unistd.h>
  20 #endif
  21 #if HAVE_SYS_SELECT_H
  22 #include <sys/select.h>
  23 #endif
  24 #ifdef WIN32
  25 #include <windows.h>
  26 #endif
  27
  28 #include <yaz/log.h>
  29 #include <yaz/backend.h>
  30 #include <yaz/ill.h>
  31 #include <yaz/diagbib1.h>
  32 #include <yaz/otherinfo.h>
  33 #include <yaz/facet.h>
  34
  35 #include "ztest.h"
  36
  37 static int log_level=0;
  38 static int log_level_set=0;
  39
  40 struct delay {
  41     double d1;
  42     double d2;
  43 };
  44
  45 struct result_set {
  46     char *name;
  47     char *db;
  48     Odr_int hits;
  49     struct delay search_delay;
  50     struct delay present_delay;
  51     struct delay fetch_delay;
  52     struct result_set *next;
  53 };
  54
  55 struct session_handle {
  56     struct result_set *result_sets;
  57 };
  58
  59 int ztest_search(void *handle, bend_search_rr *rr);
  60 int ztest_sort(void *handle, bend_sort_rr *rr);
  61 int ztest_present(void *handle, bend_present_rr *rr);
  62 int ztest_esrequest(void *handle, bend_esrequest_rr *rr);
  63 int ztest_delete(void *handle, bend_delete_rr *rr);
  64
  65 static struct result_set *get_set(struct session_handle *sh, const char *name)
  66 {
  67     struct result_set *set = sh->result_sets;
  68     for (; set; set = set->next)
  69         if (!strcmp(name, set->name))
  70             return set;
  71     return 0;
  72 }
  73
  74 static void remove_sets(struct session_handle *sh)
  75 {
  76     struct result_set *set = sh->result_sets;
  77     while (set)
  78     {
  79         struct result_set *set_next = set->next;
  80         xfree(set->name);
  81         xfree(set->db);
  82         xfree(set);
  83         set = set_next;
  84     }
  85     sh->result_sets = 0;
  86 }
  87
  88 /** \brief use term value as hit count
  89     \param s RPN structure
  90     \return >= 0: search term number or -1: not found
  91
  92     Traverse RPN tree 'in order' and use term value as hit count.
  93     Only terms  that looks a numeric is used.. Returns -1 if
  94     no sub tree has a hit count term
  95 */
  96 static Odr_int get_term_hit(Z_RPNStructure *s)
  97 {
  98     Odr_int h = -1;
  99     switch(s->which)
 100     {
 101     case Z_RPNStructure_simple:
 102         if (s->u.simple->which == Z_Operand_APT)
 103         {
 104             Z_AttributesPlusTerm *apt = s->u.simple->u.attributesPlusTerm;
 105             if (apt->term->which == Z_Term_general)
 106             {
 107                 Odr_oct *oct = apt->term->u.general;
 108                 if (oct->len > 0 && oct->buf[0] >= '0' && oct->buf[0] <= '9')
 109                 {
 110                     WRBUF hits_str = wrbuf_alloc();
 111                     wrbuf_write(hits_str, (const char *) oct->buf, oct->len);
 112                     h = odr_atoi(wrbuf_cstr(hits_str));
 113                     wrbuf_destroy(hits_str);
 114                 }
 115             }
 116         }
 117         break;
 118     case Z_RPNStructure_complex:
 119         h = get_term_hit(s->u.complex->s1);
 120         if (h == -1)
 121             h = get_term_hit(s->u.complex->s2);
 122         break;
 123     }
 124     return h;
 125 }
 126
 127 /** \brief gets hit count for numeric terms in RPN queries
 128     \param q RPN Query
 129     \return number of hits (random or number for term)
 130
 131     This is just for testing.. A real database of course uses
 132     the content of a database to establish a value.. In our case, we
 133     have a way to trigger a certain hit count. Good for testing of
 134     client applications etc
 135 */
 136 static Odr_int get_hit_count(Z_Query *q)
 137 {
 138     if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
 139     {
 140         Odr_int h = -1;
 141         h = get_term_hit(q->u.type_1->RPNStructure);
 142         if (h == -1)
 143             h = rand() % 24;
 144         return h;
 145     }
 146     else
 147         return 24;
 148 }
 149
 150 /** \brief checks if it's a dummy Slow database
 151     \param basename database name to check
 152     \param association backend association (or NULL if not available)
 153     \retval 1 is slow database
 154     \retval 0 is not a slow database
 155
 156     The Slow database is for testing.. It allows us to simulate
 157     a slow server...
 158 */
 159 static int check_slow(const char *basename, bend_association association)
 160 {
 161     if (strncmp(basename, "Slow", 4) == 0)
 162     {
 163 #if HAVE_UNISTD_H
 164         int i, w = 3;
 165         if (basename[4])
 166             sscanf(basename+4, "%d", &w);
 167         /* wait up to 3 seconds and check if connection is still alive */
 168         for (i = 0; i < w; i++)
 169         {
 170             if (association && !bend_assoc_is_alive(association))
 171             {
 172                 yaz_log(YLOG_LOG, "search aborted");
 173                 break;
 174             }
 175             sleep(1);
 176         }
 177 #endif
 178         return 1;
 179     }
 180     return 0;
 181 }
 182
 183 static int strcmp_prefix(const char *s, const char *p)
 184 {
 185     size_t l = strlen(p);
 186     if (strlen(s) >= l && !memcmp(s, p, l))
 187         return 1;
 188     return 0;
 189 }
 190
 191 static void init_delay(struct delay *delayp)
 192 {
 193     delayp->d1 = delayp->d2 = 0.0;
 194 }
 195
 196 static int parse_delay(struct delay *delayp, const char *value)
 197 {
 198     if (sscanf(value, "%lf:%lf", &delayp->d1, &delayp->d2) == 2)
 199         ;
 200     else if (sscanf(value, "%lf", &delayp->d1) == 1)
 201         delayp->d2 = 0.0;
 202     else
 203         return -1;
 204     return 0;
 205 }
 206
 207 static void ztest_sleep(double d)
 208 {
 209 #ifdef WIN32
 210     Sleep( (DWORD) (d * 1000));
 211 #else
 212     struct timeval tv;
 213     tv.tv_sec = floor(d);
 214     tv.tv_usec = (d - floor(d)) * 1000000;
 215     select(0, 0, 0, 0, &tv);
 216 #endif
 217 }
 218
 219 static void do_delay(const struct delay *delayp)
 220 {
 221     double d = delayp->d1;
 222
 223     if (d > 0.0)
 224     {
 225         if (delayp->d2 > d)
 226             d += (rand()) * (delayp->d2 - d) / RAND_MAX;
 227         ztest_sleep(d);
 228     }
 229 }
 230
 231 static void addterms(ODR odr, Z_FacetField *facet_field, const char *facet_name) {
 232     int index;
 233     int freq = 100;
 234     int length = strlen(facet_name) + 10;
 235     char key[length];
 236     key[0] = '\0';
 237     for (index = 0; index < facet_field->num_terms; index++) {
 238         Z_Term *term;
 239         Z_FacetTerm *facet_term;
 240         sprintf(key, "%s%d", facet_name, index);
 241         yaz_log(YLOG_DEBUG, "facet add term %s %d %s", facet_name, index, key);
 242         term = term_create(odr, key);
 243         facet_term = facet_term_create(odr, term, freq);
 244         freq = freq - 10 ;
 245         facet_field_term_set(odr, facet_field, facet_term, index);
 246     }
 247 }
 248
 249 Z_OtherInformation *build_facet_response(ODR odr, Z_FacetList *facet_list) {
 250     int index, new_index = 0;
 251     Z_FacetList *new_list = facet_list_create(odr, facet_list->num);
 252
 253     for (index = 0; index < facet_list->num; index++) {
 254         struct yaz_facet_attr attrvalues;
 255         facet_struct_init(&attrvalues);
 256         attrvalues.limit = 10;
 257         facetattrs(facet_list->elements[index]->attributes, &attrvalues);
 258         yaz_log(YLOG_LOG, "Attributes: %s %d ", attrvalues.useattr, attrvalues.limit);
 259         if (attrvalues.errstring)
 260             yaz_log(YLOG_LOG, "Error parsing attributes: %s", attrvalues.errstring);
 261         if (attrvalues.limit > 0 && attrvalues.useattr) {
 262             new_list->elements[new_index] = facet_field_create(odr, facet_list->elements[index]->attributes, attrvalues.limit);
 263             addterms(odr, new_list->elements[new_index], attrvalues.useattr);
 264             new_index++;
 265         }
 266         else {
 267             yaz_log(YLOG_DEBUG, "Facet: skipping %s due to 0 limit.", attrvalues.useattr);
 268         }
 269
 270     }
 271     new_list->num = new_index;
 272     if (new_index > 0) {
 273         Z_OtherInformation *oi = odr_malloc(odr, sizeof(*oi));
 274         Z_OtherInformationUnit *oiu = odr_malloc(odr, sizeof(*oiu));
 275         oi->num_elements = 1;
 276         oi->list = odr_malloc(odr, oi->num_elements * sizeof(*oi->list));
 277         oiu->category = 0;
 278         oiu->which = Z_OtherInfo_externallyDefinedInfo;
 279         oiu->information.externallyDefinedInfo = odr_malloc(odr, sizeof(*oiu->information.externallyDefinedInfo));
 280         oiu->information.externallyDefinedInfo->direct_reference = odr_oiddup(odr, yaz_oid_userinfo_facet_1);
 281         oiu->information.externallyDefinedInfo->descriptor = 0;
 282         oiu->information.externallyDefinedInfo->indirect_reference = 0;
 283         oiu->information.externallyDefinedInfo->which = Z_External_userFacets;
 284         oiu->information.externallyDefinedInfo->u.facetList = new_list;
 285         oi->list[0] = oiu;
 286         return oi;
 287     }
 288     return 0;
 289 }
 290
 291 int ztest_search(void *handle, bend_search_rr *rr)
 292 {
 293     struct session_handle *sh = (struct session_handle*) handle;
 294     struct result_set *new_set;
 295     const char *db, *db_sep;
 296
 297     if (rr->num_bases != 1)
 298     {
 299         rr->errcode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
 300         return 0;
 301     }
 302
 303     db = rr->basenames[0];
 304
 305     /* Allow Default, db.* and Slow */
 306     if (strcmp_prefix(db, "Default"))
 307         ;  /* Default is OK in our test */
 308     else if (strcmp_prefix(db, "db"))
 309         ;  /* db.* is OK in our test */
 310     else if (check_slow(rr->basenames[0], rr->association))
 311     {
 312         rr->estimated_hit_count = 1;
 313     }
 314     else
 315     {
 316         rr->errcode = YAZ_BIB1_DATABASE_UNAVAILABLE;
 317         rr->errstring = rr->basenames[0];
 318         return 0;
 319     }
 320
 321     new_set = get_set(sh, rr->setname);
 322     if (new_set)
 323     {
 324         if (!rr->replace_set)
 325         {
 326             rr->errcode = YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF;
 327             return 0;
 328         }
 329         xfree(new_set->db);
 330     }
 331     else
 332     {
 333         new_set = xmalloc(sizeof(*new_set));
 334         new_set->next = sh->result_sets;
 335         sh->result_sets = new_set;
 336         new_set->name = xstrdup(rr->setname);
 337     }
 338     new_set->hits = 0;
 339     new_set->db = xstrdup(db);
 340     init_delay(&new_set->search_delay);
 341     init_delay(&new_set->present_delay);
 342     init_delay(&new_set->fetch_delay);
 343
 344     db_sep = strchr(db, '?');
 345     if (db_sep)
 346     {
 347         char **names;
 348         char **values;
 349         int no_parms = yaz_uri_to_array(db_sep+1, rr->stream, &names, &values);
 350         int i;
 351         for (i = 0; i < no_parms; i++)
 352         {
 353             const char *name = names[i];
 354             const char *value = values[i];
 355             if (!strcmp(name, "seed"))
 356                 srand(atoi(value));
 357             else if (!strcmp(name, "search-delay"))
 358                 parse_delay(&new_set->search_delay, value);
 359             else if (!strcmp(name, "present-delay"))
 360                 parse_delay(&new_set->present_delay, value);
 361             else if (!strcmp(name, "fetch-delay"))
 362                 parse_delay(&new_set->fetch_delay, value);
 363             else
 364             {
 365                 rr->errcode = YAZ_BIB1_SERVICE_UNSUPP_FOR_THIS_DATABASE;
 366                 rr->errstring = odr_strdup(rr->stream, name);
 367             }
 368         }
 369     }
 370
 371     if (rr->extra_args)
 372     {
 373         Z_SRW_extra_arg *a;
 374         WRBUF response_xml = wrbuf_alloc();
 375         wrbuf_puts(response_xml, "<extra>");
 376         for (a = rr->extra_args; a; a = a->next)
 377         {
 378             wrbuf_puts(response_xml, "<extra name=\"");
 379             wrbuf_xmlputs(response_xml, a->name);
 380             wrbuf_puts(response_xml, "\"");
 381             if (a->value)
 382             {
 383                 wrbuf_puts(response_xml, " value=\"");
 384                 wrbuf_xmlputs(response_xml, a->value);
 385                 wrbuf_puts(response_xml, "\"");
 386             }
 387             wrbuf_puts(response_xml, "/>");
 388         }
 389         wrbuf_puts(response_xml, "</extra>");
 390         rr->extra_response_data =
 391             odr_strdup(rr->stream, wrbuf_cstr(response_xml));
 392         wrbuf_destroy(response_xml);
 393     }
 394     rr->hits = get_hit_count(rr->query);
 395
 396     if (1)
 397     {
 398         /* TODO Not general. Only handles one (Facet) OtherInformation. Overwrite  */
 399         Z_FacetList *facet_list = extract_facet_request(rr->stream, rr->search_input);
 400
 401         if (facet_list) {
 402             yaz_log(YLOG_LOG, "%d Facets in search request.", facet_list->num);
 403             rr->search_info = build_facet_response(rr->stream, facet_list);
 404         }
 405         else
 406             yaz_log(YLOG_DEBUG, "No facets parsed search request.");
 407
 408     }
 409     do_delay(&new_set->search_delay);
 410     new_set->hits = rr->hits;
 411
 412     return 0;
 413 }
 414
 415
 416 /* this huge function handles extended services */
 417 int ztest_esrequest(void *handle, bend_esrequest_rr *rr)
 418 {
 419     /* user-defined handle - created in bend_init */
 420     int *counter = (int*) handle;
 421
 422     yaz_log(log_level, "ESRequest no %d", *counter);
 423
 424     (*counter)++;
 425
 426     if (rr->esr->packageName)
 427         yaz_log(log_level, "packagename: %s", rr->esr->packageName);
 428     yaz_log(log_level, "Waitaction: " ODR_INT_PRINTF, *rr->esr->waitAction);
 429
 430
 431     yaz_log(log_level, "function: " ODR_INT_PRINTF, *rr->esr->function);
 432
 433     if (!rr->esr->taskSpecificParameters)
 434     {
 435         yaz_log(log_level, "No task specific parameters");
 436     }
 437     else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
 438     {
 439         Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
 440         yaz_log(log_level, "Received ItemOrder");
 441         if (it->which == Z_IOItemOrder_esRequest)
 442         {
 443             Z_IORequest *ir = it->u.esRequest;
 444             Z_IOOriginPartToKeep *k = ir->toKeep;
 445             Z_IOOriginPartNotToKeep *n = ir->notToKeep;
 446             const char *xml_in_response = 0;
 447
 448             if (k && k->contact)
 449             {
 450                 if (k->contact->name)
 451                     yaz_log(log_level, "contact name %s", k->contact->name);
 452                 if (k->contact->phone)
 453                     yaz_log(log_level, "contact phone %s", k->contact->phone);
 454                 if (k->contact->email)
 455                     yaz_log(log_level, "contact email %s", k->contact->email);
 456             }
 457             if (k->addlBilling)
 458             {
 459                 yaz_log(log_level, "Billing info (not shown)");
 460             }
 461
 462             if (n->resultSetItem)
 463             {
 464                 yaz_log(log_level, "resultsetItem");
 465                 yaz_log(log_level, "setId: %s", n->resultSetItem->resultSetId);
 466                 yaz_log(log_level, "item: " ODR_INT_PRINTF, *n->resultSetItem->item);
 467             }
 468             if (n->itemRequest)
 469             {
 470                 Z_External *r = (Z_External*) n->itemRequest;
 471                 ILL_ItemRequest *item_req = 0;
 472                 ILL_APDU *ill_apdu = 0;
 473                 if (r->direct_reference)
 474                 {
 475                     char oid_name_str[OID_STR_MAX];
 476                     oid_class oclass;
 477                     const char *oid_name =
 478                         yaz_oid_to_string_buf(r->direct_reference,
 479                                               &oclass, oid_name_str);
 480                     if (oid_name)
 481                         yaz_log(log_level, "OID %s", oid_name);
 482                     if (!oid_oidcmp(r->direct_reference, yaz_oid_recsyn_xml))
 483                     {
 484                         yaz_log(log_level, "ILL XML request");
 485                         if (r->which == Z_External_octet)
 486                             yaz_log(log_level, "%.*s",
 487                                     r->u.octet_aligned->len,
 488                                     r->u.octet_aligned->buf);
 489                         xml_in_response = "<dummy>x</dummy>";
 490                     }
 491                     if (!oid_oidcmp(r->direct_reference,
 492                                     yaz_oid_general_isoill_1))
 493                     {
 494                         yaz_log(log_level, "Decode ItemRequest begin");
 495                         if (r->which == ODR_EXTERNAL_single)
 496                         {
 497                             odr_setbuf(rr->decode,
 498                                        (char *) r->u.single_ASN1_type->buf,
 499                                        r->u.single_ASN1_type->len, 0);
 500
 501                             if (!ill_ItemRequest(rr->decode, &item_req, 0, 0))
 502                             {
 503                                 yaz_log(log_level,
 504                                         "Couldn't decode ItemRequest %s near %ld",
 505                                         odr_errmsg(odr_geterror(rr->decode)),
 506                                         (long) odr_offset(rr->decode));
 507                             }
 508                             else
 509                                 yaz_log(log_level, "Decode ItemRequest OK");
 510                             if (rr->print)
 511                             {
 512                                 ill_ItemRequest(rr->print, &item_req, 0,
 513                                                 "ItemRequest");
 514                                 odr_reset(rr->print);
 515                             }
 516                         }
 517                         if (!item_req && r->which == ODR_EXTERNAL_single)
 518                         {
 519                             yaz_log(log_level, "Decode ILL APDU begin");
 520                             odr_setbuf(rr->decode,
 521                                        (char*) r->u.single_ASN1_type->buf,
 522                                        r->u.single_ASN1_type->len, 0);
 523
 524                             if (!ill_APDU(rr->decode, &ill_apdu, 0, 0))
 525                             {
 526                                 yaz_log(log_level,
 527                                         "Couldn't decode ILL APDU %s near %ld",
 528                                         odr_errmsg(odr_geterror(rr->decode)),
 529                                         (long) odr_offset(rr->decode));
 530                                 yaz_log(log_level, "PDU dump:");
 531                                 odr_dumpBER(yaz_log_file(),
 532                                             (char *) r->u.single_ASN1_type->buf,
 533                                             r->u.single_ASN1_type->len);
 534                             }
 535                             else
 536                                 yaz_log(log_level, "Decode ILL APDU OK");
 537                             if (rr->print)
 538                             {
 539                                 ill_APDU(rr->print, &ill_apdu, 0,
 540                                          "ILL APDU");
 541                                 odr_reset(rr->print);
 542                             }
 543                         }
 544                     }
 545                 }
 546                 if (item_req)
 547                 {
 548                     yaz_log(log_level, "ILL protocol version = "
 549                             ODR_INT_PRINTF,
 550                             *item_req->protocol_version_num);
 551                 }
 552             }
 553             if (k)
 554             {
 555
 556                 Z_External *ext = (Z_External *)
 557                     odr_malloc(rr->stream, sizeof(*ext));
 558                 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
 559                     odr_malloc(rr->stream, sizeof(*keep));
 560                 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
 561                     odr_malloc(rr->stream, sizeof(*targetPart));
 562
 563                 rr->taskPackage = (Z_TaskPackage *)
 564                     odr_malloc(rr->stream, sizeof(*rr->taskPackage));
 565                 rr->taskPackage->packageType =
 566                     odr_oiddup(rr->stream, rr->esr->packageType);
 567                 rr->taskPackage->packageName = 0;
 568                 rr->taskPackage->userId = 0;
 569                 rr->taskPackage->retentionTime = 0;
 570                 rr->taskPackage->permissions = 0;
 571                 rr->taskPackage->description = 0;
 572                 rr->taskPackage->targetReference = (Odr_oct *)
 573                     odr_malloc(rr->stream, sizeof(Odr_oct));
 574                 rr->taskPackage->targetReference->buf =
 575                     (unsigned char *) odr_strdup(rr->stream, "911");
 576                 rr->taskPackage->targetReference->len =
 577                     rr->taskPackage->targetReference->size =
 578                     strlen((char *) (rr->taskPackage->targetReference->buf));
 579                 rr->taskPackage->creationDateTime = 0;
 580                 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
 581                 rr->taskPackage->packageDiagnostics = 0;
 582                 rr->taskPackage->taskSpecificParameters = ext;
 583
 584                 ext->direct_reference =
 585                     odr_oiddup(rr->stream, rr->esr->packageType);
 586                 ext->indirect_reference = 0;
 587                 ext->descriptor = 0;
 588                 ext->which = Z_External_itemOrder;
 589                 ext->u.itemOrder = (Z_ItemOrder *)
 590                     odr_malloc(rr->stream, sizeof(*ext->u.update));
 591                 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
 592                 ext->u.itemOrder->u.taskPackage =  (Z_IOTaskPackage *)
 593                     odr_malloc(rr->stream, sizeof(Z_IOTaskPackage));
 594                 ext->u.itemOrder->u.taskPackage->originPart = k;
 595                 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
 596
 597                 if (xml_in_response)
 598                     targetPart->itemRequest =
 599                         z_ext_record_xml(rr->stream, xml_in_response,
 600                                          strlen(xml_in_response));
 601                 else
 602                     targetPart->itemRequest = 0;
 603
 604                 targetPart->statusOrErrorReport = 0;
 605                 targetPart->auxiliaryStatus = 0;
 606             }
 607         }
 608     }
 609     else if (rr->esr->taskSpecificParameters->which == Z_External_update)
 610     {
 611         Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
 612         yaz_log(log_level, "Received DB Update");
 613         if (up->which == Z_IUUpdate_esRequest)
 614         {
 615             Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
 616             Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
 617             Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
 618
 619             yaz_log(log_level, "action");
 620             if (toKeep->action)
 621             {
 622                 switch (*toKeep->action)
 623                 {
 624                 case Z_IUOriginPartToKeep_recordInsert:
 625                     yaz_log(log_level, " recordInsert");
 626                     break;
 627                 case Z_IUOriginPartToKeep_recordReplace:
 628                     yaz_log(log_level, " recordReplace");
 629                     break;
 630                 case Z_IUOriginPartToKeep_recordDelete:
 631                     yaz_log(log_level, " recordDelete");
 632                     break;
 633                 case Z_IUOriginPartToKeep_elementUpdate:
 634                     yaz_log(log_level, " elementUpdate");
 635                     break;
 636                 case Z_IUOriginPartToKeep_specialUpdate:
 637                     yaz_log(log_level, " specialUpdate");
 638                     break;
 639                 default:
 640                     yaz_log(log_level, " unknown (" ODR_INT_PRINTF ")",
 641                             *toKeep->action);
 642                 }
 643             }
 644             if (toKeep->databaseName)
 645             {
 646                 yaz_log(log_level, "database: %s", toKeep->databaseName);
 647                 if (!strcmp(toKeep->databaseName, "fault"))
 648                 {
 649                     rr->errcode = YAZ_BIB1_DATABASE_UNAVAILABLE;
 650                     rr->errstring = toKeep->databaseName;
 651                 }
 652                 if (!strcmp(toKeep->databaseName, "accept"))
 653                     rr->errcode = -1;
 654             }
 655             if (toKeep)
 656             {
 657                 Z_External *ext = (Z_External *)
 658                     odr_malloc(rr->stream, sizeof(*ext));
 659                 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
 660                     odr_malloc(rr->stream, sizeof(*keep));
 661                 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
 662                     odr_malloc(rr->stream, sizeof(*targetPart));
 663
 664                 rr->taskPackage = (Z_TaskPackage *)
 665                     odr_malloc(rr->stream, sizeof(*rr->taskPackage));
 666                 rr->taskPackage->packageType =
 667                     odr_oiddup(rr->stream, rr->esr->packageType);
 668                 rr->taskPackage->packageName = 0;
 669                 rr->taskPackage->userId = 0;
 670                 rr->taskPackage->retentionTime = 0;
 671                 rr->taskPackage->permissions = 0;
 672                 rr->taskPackage->description = 0;
 673                 rr->taskPackage->targetReference = (Odr_oct *)
 674                     odr_malloc(rr->stream, sizeof(Odr_oct));
 675                 rr->taskPackage->targetReference->buf =
 676                     (unsigned char *) odr_strdup(rr->stream, "123");
 677                 rr->taskPackage->targetReference->len =
 678                     rr->taskPackage->targetReference->size =
 679                     strlen((char *) (rr->taskPackage->targetReference->buf));
 680                 rr->taskPackage->creationDateTime = 0;
 681                 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
 682                 rr->taskPackage->packageDiagnostics = 0;
 683                 rr->taskPackage->taskSpecificParameters = ext;
 684
 685                 ext->direct_reference =
 686                     odr_oiddup(rr->stream, rr->esr->packageType);
 687                 ext->indirect_reference = 0;
 688                 ext->descriptor = 0;
 689                 ext->which = Z_External_update;
 690                 ext->u.update = (Z_IUUpdate *)
 691                     odr_malloc(rr->stream, sizeof(*ext->u.update));
 692                 ext->u.update->which = Z_IUUpdate_taskPackage;
 693                 ext->u.update->u.taskPackage =  (Z_IUUpdateTaskPackage *)
 694                     odr_malloc(rr->stream, sizeof(Z_IUUpdateTaskPackage));
 695                 ext->u.update->u.taskPackage->originPart = keep;
 696                 ext->u.update->u.taskPackage->targetPart = targetPart;
 697
 698                 keep->action = odr_intdup(rr->stream, *toKeep->action);
 699                 keep->databaseName =
 700                     odr_strdup(rr->stream, toKeep->databaseName);
 701                 keep->schema = 0;
 702                 keep->elementSetName = 0;
 703                 keep->actionQualifier = 0;
 704
 705                 targetPart->updateStatus = odr_intdup(rr->stream, 1);
 706                 targetPart->num_globalDiagnostics = 0;
 707                 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
 708                 targetPart->num_taskPackageRecords = 1;
 709                 targetPart->taskPackageRecords =
 710                     (Z_IUTaskPackageRecordStructure **)
 711                     odr_malloc(rr->stream,
 712                                sizeof(Z_IUTaskPackageRecordStructure *));
 713                 targetPart->taskPackageRecords[0] =
 714                     (Z_IUTaskPackageRecordStructure *)
 715                     odr_malloc(rr->stream,
 716                                sizeof(Z_IUTaskPackageRecordStructure));
 717
 718                 targetPart->taskPackageRecords[0]->which =
 719                     Z_IUTaskPackageRecordStructure_record;
 720                 targetPart->taskPackageRecords[0]->u.record =
 721                     z_ext_record_sutrs(rr->stream, "test", 4);
 722                 targetPart->taskPackageRecords[0]->correlationInfo = 0;
 723                 targetPart->taskPackageRecords[0]->recordStatus =
 724                     odr_intdup(rr->stream,
 725                                Z_IUTaskPackageRecordStructure_success);
 726                 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
 727                     = 0;
 728
 729                 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
 730             }
 731             if (notToKeep)
 732             {
 733                 int i;
 734                 for (i = 0; i < notToKeep->num; i++)
 735                 {
 736                     Z_External *rec = notToKeep->elements[i]->record;
 737
 738                     if (rec->direct_reference)
 739                     {
 740                         char oid_name_str[OID_STR_MAX];
 741                         const char *oid_name
 742                             = oid_name = yaz_oid_to_string_buf(
 743                                 rec->direct_reference, 0,
 744                                 oid_name_str);
 745                         if (oid_name)
 746                             yaz_log(log_level, "record %d type %s", i,
 747                                     oid_name);
 748                     }
 749                     switch (rec->which)
 750                     {
 751                     case Z_External_sutrs:
 752                         if (rec->u.octet_aligned->len > 170)
 753                             yaz_log(log_level, "%d bytes:\n%.168s ...",
 754                                     rec->u.sutrs->len,
 755                                     rec->u.sutrs->buf);
 756                         else
 757                             yaz_log(log_level, "%d bytes:\n%s",
 758                                     rec->u.sutrs->len,
 759                                     rec->u.sutrs->buf);
 760                         break;
 761                     case Z_External_octet        :
 762                         if (rec->u.octet_aligned->len > 170)
 763                             yaz_log(log_level, "%d bytes:\n%.168s ...",
 764                                     rec->u.octet_aligned->len,
 765                                     rec->u.octet_aligned->buf);
 766                         else
 767                             yaz_log(log_level, "%d bytes\n%s",
 768                                     rec->u.octet_aligned->len,
 769                                     rec->u.octet_aligned->buf);
 770                     }
 771                 }
 772             }
 773         }
 774     }
 775     return 0;
 776 }
 777
 778 /* result set delete */
 779 int ztest_delete(void *handle, bend_delete_rr *rr)
 780 {
 781     if (rr->num_setnames == 1 && !strcmp(rr->setnames[0], "1"))
 782         rr->delete_status = Z_DeleteStatus_success;
 783     else
 784         rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
 785     return 0;
 786 }
 787
 788 /* Our sort handler really doesn't sort... */
 789 int ztest_sort(void *handle, bend_sort_rr *rr)
 790 {
 791     rr->errcode = 0;
 792     rr->sort_status = Z_SortResponse_success;
 793     return 0;
 794 }
 795
 796
 797 /* present request handler */
 798 int ztest_present(void *handle, bend_present_rr *rr)
 799 {
 800     struct session_handle *sh = (struct session_handle*) handle;
 801     struct result_set *set = get_set(sh, rr->setname);
 802
 803     if (!set)
 804     {
 805         rr->errcode = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
 806         rr->errstring = odr_strdup(rr->stream, rr->setname);
 807         return 0;
 808     }
 809     do_delay(&set->present_delay);
 810     return 0;
 811 }
 812
 813 /* retrieval of a single record (present, and piggy back search) */
 814 int ztest_fetch(void *handle, bend_fetch_rr *r)
 815 {
 816     struct session_handle *sh = (struct session_handle*) handle;
 817     char *cp;
 818     const Odr_oid *oid = r->request_format;
 819     struct result_set *set = get_set(sh, r->setname);
 820
 821     if (!set)
 822     {
 823         r->errcode = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
 824         r->errstring = odr_strdup(r->stream, r->setname);
 825         return 0;
 826     }
 827     do_delay(&set->fetch_delay);
 828     r->last_in_set = 0;
 829     r->basename = set->db;
 830     r->output_format = r->request_format;
 831
 832     if (r->number < 1 || r->number > set->hits)
 833     {
 834         r->errcode = YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE;
 835         return 0;
 836     }
 837     if (!oid || yaz_oid_is_iso2709(oid))
 838     {
 839         cp = dummy_marc_record(r->number, r->stream);
 840         if (!cp)
 841         {
 842             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 843             r->surrogate_flag = 1;
 844             return 0;
 845         }
 846         else
 847         {
 848             r->len = strlen(cp);
 849             r->record = cp;
 850             r->output_format = odr_oiddup(r->stream, yaz_oid_recsyn_usmarc);
 851         }
 852     }
 853     else if (!oid_oidcmp(oid, yaz_oid_recsyn_opac))
 854     {
 855         cp = dummy_marc_record(r->number, r->stream);
 856         if (!cp)
 857         {
 858             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 859             r->surrogate_flag = 1;
 860             return 0;
 861         }
 862         r->record = (char *) dummy_opac(r->number, r->stream, cp);
 863         r->len = -1;
 864     }
 865     else if (!oid_oidcmp(oid, yaz_oid_recsyn_sutrs))
 866     {
 867         /* this section returns a small record */
 868         char buf[100];
 869
 870         sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
 871
 872         r->len = strlen(buf);
 873         r->record = (char *) odr_malloc(r->stream, r->len+1);
 874         strcpy(r->record, buf);
 875     }
 876     else if (!oid_oidcmp(oid, yaz_oid_recsyn_grs_1))
 877     {
 878         r->len = -1;
 879         r->record = (char*) dummy_grs_record(r->number, r->stream);
 880         if (!r->record)
 881         {
 882             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 883             r->surrogate_flag = 1;
 884             return 0;
 885         }
 886     }
 887     else if (!oid_oidcmp(oid, yaz_oid_recsyn_postscript))
 888     {
 889         char fname[20];
 890         FILE *f;
 891         long size;
 892
 893         sprintf(fname, "part.%d.ps", r->number);
 894         f = fopen(fname, "rb");
 895         if (!f)
 896         {
 897             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 898             r->surrogate_flag = 1;
 899             return 0;
 900         }
 901         fseek(f, 0L, SEEK_END);
 902         size = ftell(f);
 903         if (size <= 0 || size >= 5000000)
 904         {
 905             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 906             r->surrogate_flag = 1;
 907         }
 908         fseek(f, 0L, SEEK_SET);
 909         r->record = (char*) odr_malloc(r->stream, size);
 910         r->len = size;
 911         if (fread(r->record, size, 1, f) != 1)
 912         {
 913             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 914             r->surrogate_flag = 1;
 915         }
 916         fclose(f);
 917     }
 918     else if (!oid_oidcmp(oid, yaz_oid_recsyn_xml))
 919     {
 920         if ((cp = dummy_xml_record(r->number, r->stream)))
 921         {
 922             r->len = strlen(cp);
 923             r->record = cp;
 924         }
 925         else
 926         {
 927             r->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 928             r->surrogate_flag = 1;
 929             return 0;
 930         }
 931     }
 932     else
 933     {
 934         char buf[OID_STR_MAX];
 935         r->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
 936         r->errstring = odr_strdup(r->stream, oid_oid_to_dotstring(oid, buf));
 937         return 0;
 938     }
 939     r->errcode = 0;
 940     return 0;
 941 }
 942
 943 /*
 944  * silly dummy-scan what reads words from a file.
 945  */
 946 int ztest_scan(void *handle, bend_scan_rr *q)
 947 {
 948     static FILE *f = 0;
 949     static struct scan_entry list[200];
 950     static char entries[200][80];
 951     int hits[200];
 952     char term[80], *p;
 953     int i, pos;
 954     int term_position_req = q->term_position;
 955     int num_entries_req = q->num_entries;
 956
 957     /* Throw Database unavailable if other than Default or Slow */
 958     if (!yaz_matchstr(q->basenames[0], "Default"))
 959         ;  /* Default is OK in our test */
 960     else if (check_slow(q->basenames[0], 0 /* no assoc for scan */))
 961         ;
 962     else
 963     {
 964         q->errcode = YAZ_BIB1_DATABASE_UNAVAILABLE;
 965         q->errstring = q->basenames[0];
 966         return 0;
 967     }
 968
 969     q->errcode = 0;
 970     q->errstring = 0;
 971     q->entries = list;
 972     q->status = BEND_SCAN_SUCCESS;
 973     if (!f && !(f = fopen("dummy-words", "r")))
 974     {
 975         perror("dummy-words");
 976         exit(1);
 977     }
 978     if (q->num_entries > 200)
 979     {
 980         q->errcode = YAZ_BIB1_RESOURCES_EXHAUSTED_NO_RESULTS_AVAILABLE;
 981         return 0;
 982     }
 983     if (q->term)
 984     {
 985         int len;
 986         if (q->term->term->which != Z_Term_general)
 987         {
 988             q->errcode = YAZ_BIB1_TERM_TYPE_UNSUPP;
 989             return 0;
 990         }
 991         if (*q->step_size != 0)
 992         {
 993             q->errcode = YAZ_BIB1_ONLY_ZERO_STEP_SIZE_SUPPORTED_FOR_SCAN;
 994             return 0;
 995         }
 996         len = q->term->term->u.general->len;
 997         if (len >= (int ) sizeof(term))
 998             len = sizeof(term)-1;
 999         memcpy(term, q->term->term->u.general->buf, len);
1000         term[len] = '\0';
1001     }
1002     else if (q->scanClause)
1003     {
1004         strncpy(term, q->scanClause, sizeof(term)-1);
1005         term[sizeof(term)-1] = '\0';
1006     }
1007     else
1008         strcpy(term, "0");
1009
1010     for (p = term; *p; p++)
1011         if (islower(*(unsigned char *) p))
1012             *p = toupper(*p);
1013
1014     fseek(f, 0, SEEK_SET);
1015     q->num_entries = 0;
1016
1017     for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
1018          i++, pos < 199 ? pos++ : (pos = 0))
1019     {
1020         if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
1021         {
1022             if ((q->term_position = term_position_req) > i + 1)
1023             {
1024                 q->term_position = i + 1;
1025                 q->status = BEND_SCAN_PARTIAL;
1026             }
1027             for (; q->num_entries < q->term_position; q->num_entries++)
1028             {
1029                 int po;
1030
1031                 po = pos - q->term_position + q->num_entries+1; /* find pos */
1032                 if (po < 0)
1033                     po += 200;
1034
1035                 if (!strcmp(term, "SD") && q->num_entries == 2)
1036                 {
1037                     list[q->num_entries].term = entries[pos];
1038                     list[q->num_entries].occurrences = -1;
1039                     list[q->num_entries].errcode =
1040                         YAZ_BIB1_SCAN_UNSUPP_VALUE_OF_POSITION_IN_RESPONSE;
1041                     list[q->num_entries].errstring = "SD for Scan Term";
1042                 }
1043                 else
1044                 {
1045                     list[q->num_entries].term = entries[po];
1046                     list[q->num_entries].occurrences = hits[po];
1047                 }
1048             }
1049         }
1050         else if (q->num_entries)
1051         {
1052             list[q->num_entries].term = entries[pos];
1053             list[q->num_entries].occurrences = hits[pos];
1054             q->num_entries++;
1055         }
1056         if (q->num_entries >= num_entries_req)
1057             break;
1058     }
1059     if (feof(f))
1060         q->status = BEND_SCAN_PARTIAL;
1061     return 0;
1062 }
1063
1064 int ztest_explain(void *handle, bend_explain_rr *rr)
1065 {
1066     if (rr->database && !strcmp(rr->database, "Default"))
1067     {
1068         rr->explain_buf = "<explain>\n"
1069             "\t<serverInfo>\n"
1070             "\t\t<host>localhost</host>\n"
1071             "\t\t<port>210</port>\n"
1072             "\t</serverInfo>\n"
1073             "</explain>\n";
1074     }
1075     return 0;
1076 }
1077
1078 int ztest_update(void *handle, bend_update_rr *rr)
1079 {
1080     rr->operation_status = "success";
1081     return 0;
1082 }
1083
1084 bend_initresult *bend_init(bend_initrequest *q)
1085 {
1086     bend_initresult *r = (bend_initresult *)
1087         odr_malloc(q->stream, sizeof(*r));
1088     struct session_handle *sh = xmalloc(sizeof(*sh));
1089
1090     sh->result_sets = 0;
1091
1092     if (!log_level_set)
1093     {
1094         log_level=yaz_log_module_level("ztest");
1095         log_level_set=1;
1096     }
1097
1098     r->errcode = 0;
1099     r->errstring = 0;
1100     r->handle = sh;                         /* tell GFS about our handle */
1101     q->bend_sort = ztest_sort;              /* register sort handler */
1102     q->bend_search = ztest_search;          /* register search handler */
1103     q->bend_present = ztest_present;        /* register present handle */
1104     q->bend_esrequest = ztest_esrequest;
1105     q->bend_delete = ztest_delete;
1106     q->bend_fetch = ztest_fetch;
1107     q->bend_scan = ztest_scan;
1108 #if 0
1109     q->bend_explain = ztest_explain;
1110 #endif
1111     q->bend_srw_scan = ztest_scan;
1112     q->bend_srw_update = ztest_update;
1113
1114     q->query_charset = "ISO-8859-1";
1115     q->records_in_same_charset = 0;
1116
1117     return r;
1118 }
1119
1120 void bend_close(void *handle)
1121 {
1122     struct session_handle *sh = (struct session_handle*) handle;
1123     remove_sets(sh);
1124     xfree(sh);              /* release our session */
1125     return;
1126 }
1127
1128 int main(int argc, char **argv)
1129 {
1130     return statserv_main(argc, argv, bend_init, bend_close);
1131 }
1132 /*
1133  * Local variables:
1134  * c-basic-offset: 4
1135  * c-file-style: "Stroustrup"
1136  * indent-tabs-mode: nil
1137  * End:
1138  * vim: shiftwidth=4 tabstop=8 expandtab
1139  */
1140