src/zoom-z3950.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 Index Data
   3  * See the file LICENSE for details.
   4  */
   5 /**
   6  * \file zoom-z3950.c
   7  * \brief Implements ZOOM Z39.50 handling
   8  */
   9 #if HAVE_CONFIG_H
  10 #include <config.h>
  11 #endif
  12
  13 #include <assert.h>
  14 #include <string.h>
  15 #include <errno.h>
  16 #include "zoom-p.h"
  17
  18 #include <yaz/yaz-util.h>
  19 #include <yaz/xmalloc.h>
  20 #include <yaz/otherinfo.h>
  21 #include <yaz/log.h>
  22 #include <yaz/pquery.h>
  23 #include <yaz/marcdisp.h>
  24 #include <yaz/diagbib1.h>
  25 #include <yaz/charneg.h>
  26 #include <yaz/ill.h>
  27 #include <yaz/query-charset.h>
  28 #include <yaz/copy_types.h>
  29 #include <yaz/snprintf.h>
  30 #include <yaz/facet.h>
  31
  32 #include <yaz/shptr.h>
  33
  34 /*
  35  * This wrapper is just for logging failed lookups.  It would be nicer
  36  * if it could cause failure when a lookup fails, but that's hard.
  37  */
  38 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
  39                                      oid_class oid_class, const char *str) {
  40     Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
  41                                      c->odr_out);
  42     if (res == 0)
  43         yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
  44                 c, (int) oid_class, str);
  45     return res;
  46 }
  47
  48 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
  49 {
  50     const char *str;
  51     Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
  52     Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
  53
  54     str = ZOOM_options_get(p->options, "package-name");
  55     if (str && *str)
  56         req->packageName = odr_strdup(p->odr_out, str);
  57
  58     str = ZOOM_options_get(p->options, "user-id");
  59     if (str)
  60         req->userId = odr_strdup_null(p->odr_out, str);
  61
  62     req->packageType = odr_oiddup(p->odr_out, oid);
  63
  64     str = ZOOM_options_get(p->options, "function");
  65     if (str)
  66     {
  67         if (!strcmp (str, "create"))
  68             *req->function = Z_ExtendedServicesRequest_create;
  69         if (!strcmp (str, "delete"))
  70             *req->function = Z_ExtendedServicesRequest_delete;
  71         if (!strcmp (str, "modify"))
  72             *req->function = Z_ExtendedServicesRequest_modify;
  73     }
  74
  75     str = ZOOM_options_get(p->options, "waitAction");
  76     if (str)
  77     {
  78         if (!strcmp (str, "wait"))
  79             *req->waitAction = Z_ExtendedServicesRequest_wait;
  80         if (!strcmp (str, "waitIfPossible"))
  81             *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
  82         if (!strcmp (str, "dontWait"))
  83             *req->waitAction = Z_ExtendedServicesRequest_dontWait;
  84         if (!strcmp (str, "dontReturnPackage"))
  85             *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
  86     }
  87     return apdu;
  88 }
  89
  90 static const char *ill_array_lookup(void *clientData, const char *idx)
  91 {
  92     ZOOM_package p = (ZOOM_package) clientData;
  93     return ZOOM_options_get(p->options, idx+4);
  94 }
  95
  96 static Z_External *encode_ill_request(ZOOM_package p)
  97 {
  98     ODR out = p->odr_out;
  99     ILL_Request *req;
 100     Z_External *r = 0;
 101     struct ill_get_ctl ctl;
 102
 103     ctl.odr = p->odr_out;
 104     ctl.clientData = p;
 105     ctl.f = ill_array_lookup;
 106
 107     req = ill_get_ILLRequest(&ctl, "ill", 0);
 108
 109     if (!ill_Request(out, &req, 0, 0))
 110     {
 111         int ill_request_size;
 112         char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
 113         if (ill_request_buf)
 114             odr_setbuf(out, ill_request_buf, ill_request_size, 1);
 115         return 0;
 116     }
 117     else
 118     {
 119         int illRequest_size = 0;
 120         char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
 121
 122         r = (Z_External *) odr_malloc(out, sizeof(*r));
 123         r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
 124         r->indirect_reference = 0;
 125         r->descriptor = 0;
 126         r->which = Z_External_single;
 127
 128         r->u.single_ASN1_type =
 129             odr_create_Odr_oct(out,
 130                                (unsigned char *)illRequest_buf,
 131                                illRequest_size);
 132     }
 133     return r;
 134 }
 135
 136 static Z_ItemOrder *encode_item_order(ZOOM_package p)
 137 {
 138     Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
 139     const char *str;
 140     int len;
 141
 142     req->which = Z_IOItemOrder_esRequest;
 143     req->u.esRequest = (Z_IORequest *)
 144         odr_malloc(p->odr_out,sizeof(Z_IORequest));
 145
 146     /* to keep part ... */
 147     req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
 148         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
 149     req->u.esRequest->toKeep->supplDescription = 0;
 150     req->u.esRequest->toKeep->contact = (Z_IOContact *)
 151         odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
 152
 153     str = ZOOM_options_get(p->options, "contact-name");
 154     req->u.esRequest->toKeep->contact->name =
 155         odr_strdup_null(p->odr_out, str);
 156
 157     str = ZOOM_options_get(p->options, "contact-phone");
 158     req->u.esRequest->toKeep->contact->phone =
 159         odr_strdup_null(p->odr_out, str);
 160
 161     str = ZOOM_options_get(p->options, "contact-email");
 162     req->u.esRequest->toKeep->contact->email =
 163         odr_strdup_null(p->odr_out, str);
 164
 165     req->u.esRequest->toKeep->addlBilling = 0;
 166
 167     /* not to keep part ... */
 168     req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
 169         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
 170
 171     str = ZOOM_options_get(p->options, "itemorder-setname");
 172     if (!str)
 173         str = "default";
 174
 175     if (!*str)
 176         req->u.esRequest->notToKeep->resultSetItem = 0;
 177     else
 178     {
 179         req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
 180             odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
 181
 182         req->u.esRequest->notToKeep->resultSetItem->resultSetId =
 183             odr_strdup(p->odr_out, str);
 184         req->u.esRequest->notToKeep->resultSetItem->item =
 185             odr_intdup(p->odr_out, 0);
 186
 187         str = ZOOM_options_get(p->options, "itemorder-item");
 188         *req->u.esRequest->notToKeep->resultSetItem->item =
 189             (str ? atoi(str) : 1);
 190     }
 191
 192     str = ZOOM_options_getl(p->options, "doc", &len);
 193     if (str)
 194     {
 195         req->u.esRequest->notToKeep->itemRequest =
 196             z_ext_record_xml(p->odr_out, str, len);
 197     }
 198     else
 199         req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
 200
 201     return req;
 202 }
 203
 204 Z_APDU *create_admin_package(ZOOM_package p, int type,
 205                              Z_ESAdminOriginPartToKeep **toKeepP,
 206                              Z_ESAdminOriginPartNotToKeep **notToKeepP)
 207 {
 208     Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
 209     if (apdu)
 210     {
 211         Z_ESAdminOriginPartToKeep  *toKeep;
 212         Z_ESAdminOriginPartNotToKeep  *notToKeep;
 213         Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
 214         const char *first_db = "Default";
 215         int num_db;
 216         char **db = ZOOM_connection_get_databases(p->connection,
 217                                                   p->options, &num_db,
 218                                                   p->odr_out);
 219         if (num_db > 0)
 220             first_db = db[0];
 221
 222         r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
 223         r->descriptor = 0;
 224         r->indirect_reference = 0;
 225         r->which = Z_External_ESAdmin;
 226
 227         r->u.adminService = (Z_Admin *)
 228             odr_malloc(p->odr_out, sizeof(*r->u.adminService));
 229         r->u.adminService->which = Z_Admin_esRequest;
 230         r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
 231             odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
 232
 233         toKeep = r->u.adminService->u.esRequest->toKeep =
 234             (Z_ESAdminOriginPartToKeep *)
 235             odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
 236         toKeep->which = type;
 237         toKeep->databaseName = odr_strdup(p->odr_out, first_db);
 238         toKeep->u.create = odr_nullval();
 239         apdu->u.extendedServicesRequest->taskSpecificParameters = r;
 240
 241         r->u.adminService->u.esRequest->notToKeep = notToKeep =
 242             (Z_ESAdminOriginPartNotToKeep *)
 243             odr_malloc(p->odr_out,
 244                        sizeof(*r->u.adminService->u.esRequest->notToKeep));
 245         notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
 246         notToKeep->u.recordsWillFollow = odr_nullval();
 247         if (toKeepP)
 248             *toKeepP = toKeep;
 249         if (notToKeepP)
 250             *notToKeepP = notToKeep;
 251     }
 252     return apdu;
 253 }
 254
 255 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
 256 {
 257     Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
 258     Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
 259     Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
 260     int len;
 261     const char *doc = ZOOM_options_getl(p->options, "doc", &len);
 262
 263     if (!doc)
 264     {
 265         doc = "";
 266         len = 0;
 267     }
 268
 269     req->taskSpecificParameters = ext;
 270     ext->direct_reference = req->packageType;
 271     ext->descriptor = 0;
 272     ext->indirect_reference = 0;
 273
 274     ext->which = Z_External_octet;
 275     ext->u.single_ASN1_type =
 276         odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
 277     return apdu;
 278 }
 279
 280 static Z_APDU *create_update_package(ZOOM_package p)
 281 {
 282     Z_APDU *apdu = 0;
 283     const char *first_db = "Default";
 284     int num_db;
 285     char **db = ZOOM_connection_get_databases(p->connection, p->options,
 286                                               &num_db, p->odr_out);
 287     const char *action = ZOOM_options_get(p->options, "action");
 288     int recordIdOpaque_len;
 289     const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
 290         &recordIdOpaque_len);
 291     const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
 292     int record_len;
 293     const char *record_buf = ZOOM_options_getl(p->options, "record",
 294         &record_len);
 295     int recordOpaque_len;
 296     const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
 297         &recordOpaque_len);
 298     const char *syntax_str = ZOOM_options_get(p->options, "syntax");
 299     const char *version = ZOOM_options_get(p->options, "updateVersion");
 300
 301     const char *correlationInfo_note =
 302         ZOOM_options_get(p->options, "correlationInfo.note");
 303     const char *correlationInfo_id =
 304         ZOOM_options_get(p->options, "correlationInfo.id");
 305     int action_no = -1;
 306     Odr_oid *syntax_oid = 0;
 307     const Odr_oid *package_oid = yaz_oid_extserv_database_update;
 308
 309     if (!version)
 310         version = "3";
 311     if (!syntax_str)
 312         syntax_str = "xml";
 313     if (!record_buf && !recordOpaque_buf)
 314     {
 315         record_buf = "void";
 316         record_len = 4;
 317         syntax_str = "SUTRS";
 318     }
 319
 320     if (syntax_str)
 321     {
 322         syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
 323                                            CLASS_RECSYN, syntax_str,
 324                                            p->odr_out);
 325     }
 326     if (!syntax_oid)
 327         return 0;
 328
 329     if (num_db > 0)
 330         first_db = db[0];
 331
 332     switch(*version)
 333     {
 334     case '1':
 335         package_oid = yaz_oid_extserv_database_update_first_version;
 336         /* old update does not support specialUpdate */
 337         if (!action)
 338             action = "recordInsert";
 339         break;
 340     case '2':
 341         if (!action)
 342             action = "specialUpdate";
 343         package_oid = yaz_oid_extserv_database_update_second_version;
 344         break;
 345     case '3':
 346         if (!action)
 347             action = "specialUpdate";
 348         package_oid = yaz_oid_extserv_database_update;
 349         break;
 350     default:
 351         return 0;
 352     }
 353
 354     if (!strcmp(action, "recordInsert"))
 355         action_no = Z_IUOriginPartToKeep_recordInsert;
 356     else if (!strcmp(action, "recordReplace"))
 357         action_no = Z_IUOriginPartToKeep_recordReplace;
 358     else if (!strcmp(action, "recordDelete"))
 359         action_no = Z_IUOriginPartToKeep_recordDelete;
 360     else if (!strcmp(action, "elementUpdate"))
 361         action_no = Z_IUOriginPartToKeep_elementUpdate;
 362     else if (!strcmp(action, "specialUpdate"))
 363         action_no = Z_IUOriginPartToKeep_specialUpdate;
 364     else
 365         return 0;
 366
 367     apdu = create_es_package(p, package_oid);
 368     if (apdu)
 369     {
 370         Z_IUOriginPartToKeep *toKeep;
 371         Z_IUSuppliedRecords *notToKeep;
 372         Z_External *r = (Z_External *)
 373             odr_malloc(p->odr_out, sizeof(*r));
 374         const char *elementSetName =
 375             ZOOM_options_get(p->options, "elementSetName");
 376
 377         apdu->u.extendedServicesRequest->taskSpecificParameters = r;
 378
 379         r->direct_reference = odr_oiddup(p->odr_out, package_oid);
 380         r->descriptor = 0;
 381         r->which = Z_External_update;
 382         r->indirect_reference = 0;
 383         r->u.update = (Z_IUUpdate *)
 384             odr_malloc(p->odr_out, sizeof(*r->u.update));
 385
 386         r->u.update->which = Z_IUUpdate_esRequest;
 387         r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
 388             odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
 389         toKeep = r->u.update->u.esRequest->toKeep =
 390             (Z_IUOriginPartToKeep *)
 391             odr_malloc(p->odr_out, sizeof(*toKeep));
 392
 393         toKeep->databaseName = odr_strdup(p->odr_out, first_db);
 394         toKeep->schema = 0;
 395
 396         toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
 397
 398         toKeep->actionQualifier = 0;
 399         toKeep->action = odr_intdup(p->odr_out, action_no);
 400
 401         notToKeep = r->u.update->u.esRequest->notToKeep =
 402             (Z_IUSuppliedRecords *)
 403             odr_malloc(p->odr_out, sizeof(*notToKeep));
 404         notToKeep->num = 1;
 405         notToKeep->elements = (Z_IUSuppliedRecords_elem **)
 406             odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
 407         notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
 408             odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
 409         notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
 410         if (recordIdOpaque)
 411         {
 412             notToKeep->elements[0]->u.opaque =
 413                 odr_create_Odr_oct(p->odr_out,
 414                                    (const unsigned char *) recordIdOpaque,
 415                                    recordIdOpaque_len);
 416         }
 417         else if (recordIdNumber)
 418         {
 419             notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
 420
 421             notToKeep->elements[0]->u.number =
 422                 odr_intdup(p->odr_out, atoi(recordIdNumber));
 423         }
 424         else
 425             notToKeep->elements[0]->u.opaque = 0;
 426         notToKeep->elements[0]->supplementalId = 0;
 427         if (correlationInfo_note || correlationInfo_id)
 428         {
 429             Z_IUCorrelationInfo *ci;
 430             ci = notToKeep->elements[0]->correlationInfo =
 431                 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
 432             ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
 433             ci->id = correlationInfo_id ?
 434                 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
 435         }
 436         else
 437             notToKeep->elements[0]->correlationInfo = 0;
 438         if (recordOpaque_buf)
 439         {
 440             notToKeep->elements[0]->record =
 441                 z_ext_record_oid_any(p->odr_out, syntax_oid,
 442                                  recordOpaque_buf, recordOpaque_len);
 443         }
 444         else
 445         {
 446             notToKeep->elements[0]->record =
 447                 z_ext_record_oid(p->odr_out, syntax_oid,
 448                                  record_buf, record_len);
 449         }
 450     }
 451     if (0 && apdu)
 452     {
 453         ODR print = odr_createmem(ODR_PRINT);
 454
 455         z_APDU(print, &apdu, 0, 0);
 456         odr_destroy(print);
 457     }
 458     return apdu;
 459 }
 460
 461
 462 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
 463 {
 464     int i;
 465     for (i = 0; i<200; i++)
 466     {
 467         size_t len;
 468         Odr_oid *oid;
 469         Z_OtherInformation **oi;
 470         char buf[80];
 471         const char *val;
 472         const char *cp;
 473
 474         sprintf(buf, "otherInfo%d", i);
 475         val = ZOOM_options_get(c->options, buf);
 476         if (!val)
 477             break;
 478         cp = strchr(val, ':');
 479         if (!cp)
 480             continue;
 481         len = cp - val;
 482         if (len >= sizeof(buf))
 483             len = sizeof(buf)-1;
 484         memcpy(buf, val, len);
 485         buf[len] = '\0';
 486
 487         oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
 488                                     buf, out);
 489         if (!oid)
 490             continue;
 491
 492         yaz_oi_APDU(a, &oi);
 493         yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
 494     }
 495 }
 496
 497
 498
 499 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
 500 {
 501     assert(a);
 502     if (c->cookie_out)
 503     {
 504         Z_OtherInformation **oi;
 505         yaz_oi_APDU(a, &oi);
 506         yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
 507                               1, c->cookie_out);
 508     }
 509     if (c->client_IP)
 510     {
 511         Z_OtherInformation **oi;
 512         yaz_oi_APDU(a, &oi);
 513         yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
 514                               1, c->client_IP);
 515     }
 516     otherInfo_attach(c, a, out);
 517     if (!z_APDU(out, &a, 0, 0))
 518     {
 519         FILE *outf = fopen("/tmp/apdu.txt", "a");
 520         if (a && outf)
 521         {
 522             ODR odr_pr = odr_createmem(ODR_PRINT);
 523             fprintf(outf, "a=%p\n", a);
 524             odr_setprint(odr_pr, outf);
 525             z_APDU(odr_pr, &a, 0, 0);
 526             odr_destroy(odr_pr);
 527         }
 528         yaz_log(c->log_api, "%p encoding_APDU: encoding failed", c);
 529         ZOOM_set_error(c, ZOOM_ERROR_ENCODE, 0);
 530         odr_reset(out);
 531         return -1;
 532     }
 533     if (c->odr_print)
 534         z_APDU(c->odr_print, &a, 0, 0);
 535     yaz_log(c->log_details, "%p encoding_APDU encoding OK", c);
 536     return 0;
 537 }
 538
 539 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
 540 {
 541     ZOOM_Event event;
 542     assert(a);
 543     if (encode_APDU(c, a, c->odr_out))
 544         return zoom_complete;
 545     yaz_log(c->log_details, "%p send APDU type=%d", c, a->which);
 546     c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
 547     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
 548     ZOOM_connection_put_event(c, event);
 549     odr_reset(c->odr_out);
 550     return ZOOM_send_buf(c);
 551 }
 552
 553 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c)
 554 {
 555     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
 556     Z_InitRequest *ireq = apdu->u.initRequest;
 557     Z_IdAuthentication *auth = (Z_IdAuthentication *)
 558         odr_malloc(c->odr_out, sizeof(*auth));
 559
 560     ODR_MASK_SET(ireq->options, Z_Options_search);
 561     ODR_MASK_SET(ireq->options, Z_Options_present);
 562     ODR_MASK_SET(ireq->options, Z_Options_scan);
 563     ODR_MASK_SET(ireq->options, Z_Options_sort);
 564     ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
 565     ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
 566
 567     ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
 568     ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
 569     ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
 570
 571     ireq->implementationId =
 572         odr_prepend(c->odr_out,
 573                     ZOOM_options_get(c->options, "implementationId"),
 574                     ireq->implementationId);
 575
 576     ireq->implementationName =
 577         odr_prepend(c->odr_out,
 578                     ZOOM_options_get(c->options, "implementationName"),
 579                     odr_prepend(c->odr_out, "ZOOM-C",
 580                                 ireq->implementationName));
 581
 582     ireq->implementationVersion =
 583         odr_prepend(c->odr_out,
 584                     ZOOM_options_get(c->options, "implementationVersion"),
 585                                 ireq->implementationVersion);
 586
 587     *ireq->maximumRecordSize = c->maximum_record_size;
 588     *ireq->preferredMessageSize = c->preferred_message_size;
 589
 590     if (c->group || c->password)
 591     {
 592         Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
 593         pass->groupId = odr_strdup_null(c->odr_out, c->group);
 594         pass->userId = odr_strdup_null(c->odr_out, c->user);
 595         pass->password = odr_strdup_null(c->odr_out, c->password);
 596         auth->which = Z_IdAuthentication_idPass;
 597         auth->u.idPass = pass;
 598         ireq->idAuthentication = auth;
 599     }
 600     else if (c->user)
 601     {
 602         auth->which = Z_IdAuthentication_open;
 603         auth->u.open = odr_strdup(c->odr_out, c->user);
 604         ireq->idAuthentication = auth;
 605     }
 606     if (c->proxy)
 607     {
 608         yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
 609                               yaz_oid_userinfo_proxy, 1, c->host_port);
 610     }
 611     if (c->charset || c->lang)
 612     {
 613         Z_OtherInformation **oi;
 614         Z_OtherInformationUnit *oi_unit;
 615
 616         yaz_oi_APDU(apdu, &oi);
 617
 618         if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
 619         {
 620             ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
 621             oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
 622             oi_unit->information.externallyDefinedInfo =
 623                 yaz_set_proposal_charneg_list(c->odr_out, " ",
 624                                               c->charset, c->lang, 1);
 625         }
 626     }
 627     assert(apdu);
 628     return send_APDU(c, apdu);
 629 }
 630
 631 zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c)
 632 {
 633     ZOOM_resultset r;
 634     int lslb, ssub, mspn;
 635     const char *syntax;
 636     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
 637     Z_SearchRequest *search_req = apdu->u.searchRequest;
 638     const char *elementSetName;
 639     const char *smallSetElementSetName;
 640     const char *mediumSetElementSetName;
 641     const char *facets;
 642
 643     assert(c->tasks);
 644     assert(c->tasks->which == ZOOM_TASK_SEARCH);
 645
 646     r = c->tasks->u.search.resultset;
 647
 648     yaz_log(c->log_details, "%p ZOOM_connection_send_search set=%p", c, r);
 649
 650     elementSetName =
 651         ZOOM_options_get(r->options, "elementSetName");
 652     smallSetElementSetName  =
 653         ZOOM_options_get(r->options, "smallSetElementSetName");
 654     mediumSetElementSetName =
 655         ZOOM_options_get(r->options, "mediumSetElementSetName");
 656
 657     if (!smallSetElementSetName)
 658         smallSetElementSetName = elementSetName;
 659
 660     if (!mediumSetElementSetName)
 661         mediumSetElementSetName = elementSetName;
 662
 663     facets = ZOOM_options_get(r->options, "facets");
 664     if (facets) {
 665         Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
 666         if (facet_list) {
 667             Z_OtherInformation **oi;
 668             yaz_oi_APDU(apdu, &oi);
 669             yaz_oi_set_facetlist(oi, c->odr_out, facet_list);
 670         }
 671         else
 672             yaz_log(YLOG_WARN, "Unable to parse facets: %s", facets);
 673     }
 674
 675     assert(r);
 676     assert(r->query);
 677
 678     /* prepare query for the search request */
 679     search_req->query = ZOOM_query_get_Z_Query(r->query);
 680     if (!search_req->query)
 681     {
 682         ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
 683         return zoom_complete;
 684     }
 685     if (search_req->query->which == Z_Query_type_1 ||
 686         search_req->query->which == Z_Query_type_101)
 687     {
 688         const char *cp = ZOOM_options_get(r->options, "rpnCharset");
 689         if (cp)
 690         {
 691             yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
 692             if (cd)
 693             {
 694                 int r;
 695                 search_req->query = yaz_copy_Z_Query(search_req->query,
 696                                                      c->odr_out);
 697
 698                 r = yaz_query_charset_convert_rpnquery_check(
 699                     search_req->query->u.type_1,
 700                     c->odr_out, cd);
 701                 yaz_iconv_close(cd);
 702                 if (r)
 703                 {  /* query could not be char converted */
 704                     ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
 705                     return zoom_complete;
 706                 }
 707             }
 708         }
 709     }
 710     search_req->databaseNames = r->databaseNames;
 711     search_req->num_databaseNames = r->num_databaseNames;
 712
 713     /* get syntax (no need to provide unless piggyback is in effect) */
 714     syntax = c->tasks->u.search.syntax;
 715
 716     lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
 717     ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
 718     mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
 719     if (lslb != -1 && ssub != -1 && mspn != -1)
 720     {
 721         /* So're a Z39.50 expert? Let's hope you don't do sort */
 722         *search_req->largeSetLowerBound = lslb;
 723         *search_req->smallSetUpperBound = ssub;
 724         *search_req->mediumSetPresentNumber = mspn;
 725     }
 726     else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
 727              && r->piggyback && !r->r_sort_spec && !r->schema)
 728     {
 729         /* Regular piggyback - do it unless we're going to do sort */
 730         *search_req->largeSetLowerBound = 2000000000;
 731         *search_req->smallSetUpperBound = 1;
 732         *search_req->mediumSetPresentNumber =
 733             r->step>0 ? r->step : c->tasks->u.search.count;
 734     }
 735     else
 736     {
 737         /* non-piggyback. Need not provide elementsets or syntaxes .. */
 738         smallSetElementSetName = 0;
 739         mediumSetElementSetName = 0;
 740         syntax = 0;
 741     }
 742     if (smallSetElementSetName && *smallSetElementSetName)
 743     {
 744         Z_ElementSetNames *esn = (Z_ElementSetNames *)
 745             odr_malloc(c->odr_out, sizeof(*esn));
 746
 747         esn->which = Z_ElementSetNames_generic;
 748         esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
 749         search_req->smallSetElementSetNames = esn;
 750     }
 751     if (mediumSetElementSetName && *mediumSetElementSetName)
 752     {
 753         Z_ElementSetNames *esn =(Z_ElementSetNames *)
 754             odr_malloc(c->odr_out, sizeof(*esn));
 755
 756         esn->which = Z_ElementSetNames_generic;
 757         esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
 758         search_req->mediumSetElementSetNames = esn;
 759     }
 760     if (syntax)
 761         search_req->preferredRecordSyntax =
 762             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
 763
 764     if (!r->setname)
 765     {
 766         if (c->support_named_resultsets)
 767         {
 768             char setname[14];
 769             int ord;
 770             /* find the lowest unused ordinal so that we re-use
 771                result sets on the server. */
 772             for (ord = 1; ; ord++)
 773             {
 774 #if ZOOM_RESULT_LISTS
 775                 ZOOM_resultsets rsp;
 776                 sprintf(setname, "%d", ord);
 777                 for (rsp = c->resultsets; rsp; rsp = rsp->next)
 778                     if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
 779                         break;
 780                 if (!rsp)
 781                     break;
 782 #else
 783                 ZOOM_resultset rp;
 784                 sprintf(setname, "%d", ord);
 785                 for (rp = c->resultsets; rp; rp = rp->next)
 786                     if (rp->setname && !strcmp(rp->setname, setname))
 787                         break;
 788                 if (!rp)
 789                     break;
 790 #endif
 791
 792             }
 793             r->setname = xstrdup(setname);
 794             yaz_log(c->log_details, "%p ZOOM_connection_send_search: "
 795                     "allocating set %s", c, r->setname);
 796         }
 797         else
 798         {
 799             yaz_log(c->log_details, "%p ZOOM_connection_send_search: using "
 800                     "default set", c);
 801             r->setname = xstrdup("default");
 802         }
 803         ZOOM_options_set(r->options, "setname", r->setname);
 804     }
 805     search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
 806     return send_APDU(c, apdu);
 807 }
 808
 809 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c)
 810 {
 811     ZOOM_scanset scan;
 812     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
 813     Z_ScanRequest *req = apdu->u.scanRequest;
 814     Z_Query *z_query;
 815
 816     yaz_log(c->log_details, "%p send_scan", c);
 817     if (!c->tasks)
 818         return zoom_complete;
 819     assert (c->tasks->which == ZOOM_TASK_SCAN);
 820     scan = c->tasks->u.scan.scan;
 821
 822     z_query = ZOOM_query_get_Z_Query(scan->query);
 823
 824     /* Z39.50 scan can only carry RPN */
 825     if (z_query->which == Z_Query_type_1 ||
 826         z_query->which == Z_Query_type_101)
 827     {
 828         Z_RPNQuery *rpn = z_query->u.type_1;
 829         const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
 830         if (cp)
 831         {
 832             yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
 833             if (cd)
 834             {
 835                 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
 836
 837                 yaz_query_charset_convert_rpnquery(
 838                     rpn, c->odr_out, cd);
 839                 yaz_iconv_close(cd);
 840             }
 841         }
 842         req->attributeSet = rpn->attributeSetId;
 843         if (!req->attributeSet)
 844             req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
 845         if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
 846             rpn->RPNStructure->u.simple->which == Z_Operand_APT)
 847         {
 848             req->termListAndStartPoint =
 849                 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
 850         }
 851         else
 852         {
 853             ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
 854             return zoom_complete;
 855         }
 856     }
 857     else
 858     {
 859         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
 860         return zoom_complete;
 861     }
 862
 863     *req->numberOfTermsRequested =
 864         ZOOM_options_get_int(scan->options, "number", 20);
 865
 866     req->preferredPositionInResponse =
 867         odr_intdup(c->odr_out,
 868                    ZOOM_options_get_int(scan->options, "position", 1));
 869
 870     req->stepSize =
 871         odr_intdup(c->odr_out,
 872                    ZOOM_options_get_int(scan->options, "stepSize", 0));
 873
 874     req->databaseNames = scan->databaseNames;
 875     req->num_databaseNames = scan->num_databaseNames;
 876
 877     return send_APDU(c, apdu);
 878 }
 879
 880 ZOOM_API(void)
 881     ZOOM_package_send(ZOOM_package p, const char *type)
 882 {
 883     Z_APDU *apdu = 0;
 884     ZOOM_connection c;
 885     if (!p)
 886         return;
 887     c = p->connection;
 888     odr_reset(p->odr_out);
 889     xfree(p->buf_out);
 890     p->buf_out = 0;
 891     if (!strcmp(type, "itemorder"))
 892     {
 893         apdu = create_es_package(p, yaz_oid_extserv_item_order);
 894         if (apdu)
 895         {
 896             Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
 897
 898             r->direct_reference =
 899                 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
 900             r->descriptor = 0;
 901             r->which = Z_External_itemOrder;
 902             r->indirect_reference = 0;
 903             r->u.itemOrder = encode_item_order(p);
 904
 905             apdu->u.extendedServicesRequest->taskSpecificParameters = r;
 906         }
 907     }
 908     else if (!strcmp(type, "create"))  /* create database */
 909     {
 910         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
 911                                     0, 0);
 912     }
 913     else if (!strcmp(type, "drop"))  /* drop database */
 914     {
 915         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
 916                                     0, 0);
 917     }
 918     else if (!strcmp(type, "commit"))  /* commit changes */
 919     {
 920         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
 921                                     0, 0);
 922     }
 923     else if (!strcmp(type, "update")) /* update record(s) */
 924     {
 925         apdu = create_update_package(p);
 926     }
 927     else if (!strcmp(type, "xmlupdate"))
 928     {
 929         apdu = create_xmlupdate_package(p);
 930     }
 931     if (apdu)
 932     {
 933         if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
 934         {
 935             char *buf;
 936
 937             ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
 938             task->u.package = p;
 939             buf = odr_getbuf(p->odr_out, &p->len_out, 0);
 940             p->buf_out = (char *) xmalloc(p->len_out);
 941             memcpy(p->buf_out, buf, p->len_out);
 942
 943             (p->refcount)++;
 944             if (!c->async)
 945             {
 946                 while (ZOOM_event(1, &c))
 947                     ;
 948             }
 949         }
 950     }
 951 }
 952
 953
 954 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
 955                                  int present_phase);
 956
 957 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
 958 {
 959     char oid_name_buf[OID_STR_MAX];
 960     const char *oid_name;
 961     char *addinfo = 0;
 962
 963     oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
 964     switch (r->which)
 965     {
 966     case Z_DefaultDiagFormat_v2Addinfo:
 967         addinfo = r->u.v2Addinfo;
 968         break;
 969     case Z_DefaultDiagFormat_v3Addinfo:
 970         addinfo = r->u.v3Addinfo;
 971         break;
 972     }
 973     xfree(c->addinfo);
 974     c->addinfo = 0;
 975     ZOOM_set_dset_error(c, *r->condition, oid_name, addinfo, 0);
 976 }
 977
 978 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
 979 {
 980     if (p->which != Z_DiagRec_defaultFormat)
 981         ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
 982     else
 983         response_default_diag(c, p->u.defaultFormat);
 984 }
 985
 986 static int es_response_taskpackage_update(ZOOM_connection c,
 987                 Z_IUUpdateTaskPackage *utp)
 988 {
 989         if (utp && utp->targetPart)
 990         {
 991                 Z_IUTargetPart *targetPart = utp->targetPart;
 992                 switch ( *targetPart->updateStatus ) {
 993                         case Z_IUTargetPart_success:
 994                                 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
 995                                 break;
 996                         case Z_IUTargetPart_partial:
 997                                 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
 998                                 break;
 999                         case Z_IUTargetPart_failure:
1000                                 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
1001                                 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
1002                                         response_diag(c, targetPart->globalDiagnostics[0]);
1003                                 break;
1004                 }
1005                 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
1006         }
1007     return 1;
1008 }
1009
1010 static int es_response_taskpackage(ZOOM_connection c,
1011                                    Z_TaskPackage *taskPackage)
1012 {
1013         // targetReference
1014         Odr_oct *id = taskPackage->targetReference;
1015         if (id)
1016                 ZOOM_options_setl(c->tasks->u.package->options,
1017                                                         "targetReference", (char*) id->buf, id->len);
1018
1019         // taskStatus
1020         switch ( *taskPackage->taskStatus ) {
1021                 case Z_TaskPackage_pending:
1022                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
1023                         break;
1024                 case Z_TaskPackage_active:
1025                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
1026                         break;
1027                 case Z_TaskPackage_complete:
1028                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
1029                         break;
1030                 case Z_TaskPackage_aborted:
1031                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
1032                         if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
1033                                 response_diag(c, taskPackage->packageDiagnostics[0]);
1034                         break;
1035         }
1036
1037         // taskSpecificParameters
1038         // NOTE: Only Update implemented, no others.
1039         if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
1040                         Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
1041                         es_response_taskpackage_update(c, utp);
1042         }
1043         return 1;
1044 }
1045
1046
1047 static int handle_Z3950_es_response(ZOOM_connection c,
1048                                     Z_ExtendedServicesResponse *res)
1049 {
1050     if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
1051         return 0;
1052     switch (*res->operationStatus) {
1053         case Z_ExtendedServicesResponse_done:
1054             ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
1055             break;
1056         case Z_ExtendedServicesResponse_accepted:
1057             ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
1058             break;
1059         case Z_ExtendedServicesResponse_failure:
1060             ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
1061             if (res->diagnostics && res->num_diagnostics > 0)
1062                 response_diag(c, res->diagnostics[0]);
1063             break;
1064     }
1065     if (res->taskPackage &&
1066         res->taskPackage->which == Z_External_extendedService)
1067     {
1068         Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
1069         es_response_taskpackage(c, taskPackage);
1070     }
1071     if (res->taskPackage &&
1072         res->taskPackage->which == Z_External_octet)
1073     {
1074         Odr_oct *doc = res->taskPackage->u.octet_aligned;
1075         ZOOM_options_setl(c->tasks->u.package->options,
1076                           "xmlUpdateDoc", (char*) doc->buf, doc->len);
1077     }
1078     return 1;
1079 }
1080
1081 static void interpret_init_diag(ZOOM_connection c,
1082                                 Z_DiagnosticFormat *diag)
1083 {
1084     if (diag->num > 0)
1085     {
1086         Z_DiagnosticFormat_s *ds = diag->elements[0];
1087         if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
1088             response_default_diag(c, ds->u.defaultDiagRec);
1089     }
1090 }
1091
1092
1093 static void interpret_otherinformation_field(ZOOM_connection c,
1094                                              Z_OtherInformation *ui)
1095 {
1096     int i;
1097     for (i = 0; i < ui->num_elements; i++)
1098     {
1099         Z_OtherInformationUnit *unit = ui->list[i];
1100         if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
1101             unit->information.externallyDefinedInfo &&
1102             unit->information.externallyDefinedInfo->which ==
1103             Z_External_diag1)
1104         {
1105             interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
1106         }
1107     }
1108 }
1109
1110 static char *get_term_cstr(ODR odr, Z_Term *term) {
1111
1112     switch (term->which) {
1113     case Z_Term_general:
1114             return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
1115         break;
1116     case Z_Term_characterString:
1117         return odr_strdup(odr, term->u.characterString);
1118     }
1119     return 0;
1120 }
1121
1122 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
1123     int term_index;
1124     struct yaz_facet_attr attr_values;
1125     ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
1126     yaz_facet_attr_init(&attr_values);
1127     yaz_facet_attr_get_z_attributes(facet->attributes, &attr_values);
1128     facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
1129     facet_field->num_terms = facet->num_terms;
1130     yaz_log(YLOG_DEBUG, "ZOOM_facet_field %s %d terms %d", attr_values.useattr, attr_values.limit, facet->num_terms);
1131     facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
1132     for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
1133         Z_FacetTerm *facetTerm = facet->terms[term_index];
1134         facet_field->facet_terms[term_index].frequency = *facetTerm->count;
1135         facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
1136         yaz_log(YLOG_DEBUG, "    term[%d] %s %d",
1137                 term_index, facet_field->facet_terms[term_index].term, facet_field->facet_terms[term_index].frequency);
1138     }
1139     return facet_field;
1140 }
1141
1142 /* Can be share with SOLR/SRU/SRW requests */
1143 void handle_facet_list(ZOOM_resultset r, Z_FacetList *fl) {
1144     int j;
1145     r->num_facets   = fl->num;
1146     yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num);
1147     r->facets       =  odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
1148     r->facets_names =  odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
1149     for (j = 0; j < fl->num; j++)
1150     {
1151         r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
1152         if (!r->facets[j])
1153             yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j);
1154         r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
1155     }
1156 }
1157
1158 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
1159                                 Z_OtherInformation *o)
1160 {
1161     int i;
1162     for (i = 0; o && i < o->num_elements; i++)
1163     {
1164         if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1165         {
1166             Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1167             if (ext->which == Z_External_userFacets)
1168             {
1169                 handle_facet_list(r, ext->u.facetList);
1170             }
1171         }
1172     }
1173 }
1174
1175 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
1176                                        Z_Term *term)
1177 {
1178     switch (term->which)
1179     {
1180     case Z_Term_general:
1181         ZOOM_options_setl(opt, name,
1182                           (const char *)(term->u.general->buf),
1183                           term->u.general->len);
1184         break;
1185     case Z_Term_characterString:
1186         ZOOM_options_set(opt, name, term->u.characterString);
1187         break;
1188     case Z_Term_numeric:
1189         ZOOM_options_set_int(opt, name, *term->u.numeric);
1190         break;
1191     }
1192 }
1193
1194 static void handle_queryExpression(ZOOM_options opt, const char *name,
1195                                    Z_QueryExpression *exp)
1196 {
1197     char opt_name[80];
1198
1199     switch (exp->which)
1200     {
1201     case Z_QueryExpression_term:
1202         if (exp->u.term && exp->u.term->queryTerm)
1203         {
1204             sprintf(opt_name, "%s.term", name);
1205             handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
1206         }
1207         break;
1208     case Z_QueryExpression_query:
1209         break;
1210     }
1211 }
1212
1213
1214 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
1215                                 Z_OtherInformation *o)
1216 {
1217     int i;
1218     for (i = 0; o && i < o->num_elements; i++)
1219     {
1220         if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1221         {
1222             Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1223
1224             if (ext->which == Z_External_searchResult1)
1225             {
1226                 int j;
1227                 Z_SearchInfoReport *sr = ext->u.searchResult1;
1228
1229                 if (sr->num)
1230                     ZOOM_options_set_int(
1231                         resultset->options, "searchresult.size", sr->num);
1232
1233                 for (j = 0; j < sr->num; j++)
1234                 {
1235                     Z_SearchInfoReport_s *ent =
1236                         ext->u.searchResult1->elements[j];
1237                     char pref[80];
1238
1239                     sprintf(pref, "searchresult.%d", j);
1240
1241                     if (ent->subqueryId)
1242                     {
1243                         char opt_name[80];
1244                         sprintf(opt_name, "%s.id", pref);
1245                         ZOOM_options_set(resultset->options, opt_name,
1246                                          ent->subqueryId);
1247                     }
1248                     if (ent->subqueryExpression)
1249                     {
1250                         char opt_name[80];
1251                         sprintf(opt_name, "%s.subquery", pref);
1252                         handle_queryExpression(resultset->options, opt_name,
1253                                                ent->subqueryExpression);
1254                     }
1255                     if (ent->subqueryInterpretation)
1256                     {
1257                         char opt_name[80];
1258                         sprintf(opt_name, "%s.interpretation", pref);
1259                         handle_queryExpression(resultset->options, opt_name,
1260                                                ent->subqueryInterpretation);
1261                     }
1262                     if (ent->subqueryRecommendation)
1263                     {
1264                         char opt_name[80];
1265                         sprintf(opt_name, "%s.recommendation", pref);
1266                         handle_queryExpression(resultset->options, opt_name,
1267                                                ent->subqueryRecommendation);
1268                     }
1269                     if (ent->subqueryCount)
1270                     {
1271                         char opt_name[80];
1272                         sprintf(opt_name, "%s.count", pref);
1273                         ZOOM_options_set_int(resultset->options, opt_name,
1274                                              *ent->subqueryCount);
1275                     }
1276                 }
1277             }
1278         }
1279     }
1280 }
1281
1282 static void handle_Z3950_search_response(ZOOM_connection c,
1283                                          Z_SearchResponse *sr)
1284 {
1285     ZOOM_resultset resultset;
1286     ZOOM_Event event;
1287
1288     if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1289         return ;
1290
1291     event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1292     ZOOM_connection_put_event(c, event);
1293
1294     resultset = c->tasks->u.search.resultset;
1295
1296     if (sr->resultSetStatus)
1297     {
1298         ZOOM_options_set_int(resultset->options, "resultSetStatus",
1299                              *sr->resultSetStatus);
1300     }
1301     if (sr->presentStatus)
1302     {
1303         ZOOM_options_set_int(resultset->options, "presentStatus",
1304                              *sr->presentStatus);
1305     }
1306     handle_search_result(c, resultset, sr->additionalSearchInfo);
1307
1308     handle_facet_result(c, resultset, sr->additionalSearchInfo);
1309
1310     resultset->size = *sr->resultCount;
1311     handle_Z3950_records(c, sr->records, 0);
1312 }
1313
1314 static void handle_Z3950_sort_response(ZOOM_connection c, Z_SortResponse *res)
1315 {
1316     if (res->diagnostics && res->num_diagnostics > 0)
1317         response_diag(c, res->diagnostics[0]);
1318 }
1319
1320 static int handle_Z3950_scan_response(ZOOM_connection c, Z_ScanResponse *res)
1321 {
1322     NMEM nmem = odr_extract_mem(c->odr_in);
1323     ZOOM_scanset scan;
1324
1325     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1326         return 0;
1327     scan = c->tasks->u.scan.scan;
1328
1329     if (res->entries && res->entries->nonsurrogateDiagnostics)
1330         response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1331     scan->scan_response = res;
1332     scan->srw_scan_response = 0;
1333     nmem_transfer(odr_getmem(scan->odr), nmem);
1334     if (res->stepSize)
1335         ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
1336     if (res->positionOfTerm)
1337         ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
1338     if (res->scanStatus)
1339         ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
1340     if (res->numberOfEntriesReturned)
1341         ZOOM_options_set_int(scan->options, "number",
1342                              *res->numberOfEntriesReturned);
1343     nmem_destroy(nmem);
1344     return 1;
1345 }
1346
1347 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
1348                                  int present_phase)
1349 {
1350     ZOOM_resultset resultset;
1351     int *start, *count;
1352     const char *syntax = 0, *elementSetName = 0;
1353
1354     if (!c->tasks)
1355         return ;
1356     switch (c->tasks->which)
1357     {
1358     case ZOOM_TASK_SEARCH:
1359         resultset = c->tasks->u.search.resultset;
1360         start = &c->tasks->u.search.start;
1361         count = &c->tasks->u.search.count;
1362         syntax = c->tasks->u.search.syntax;
1363         elementSetName = c->tasks->u.search.elementSetName;
1364         break;
1365     case ZOOM_TASK_RETRIEVE:
1366         resultset = c->tasks->u.retrieve.resultset;
1367         start = &c->tasks->u.retrieve.start;
1368         count = &c->tasks->u.retrieve.count;
1369         syntax = c->tasks->u.retrieve.syntax;
1370         elementSetName = c->tasks->u.retrieve.elementSetName;
1371         break;
1372     default:
1373         return;
1374     }
1375     if (sr && sr->which == Z_Records_NSD)
1376         response_default_diag(c, sr->u.nonSurrogateDiagnostic);
1377     else if (sr && sr->which == Z_Records_multipleNSD)
1378     {
1379         if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1380             response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1381         else
1382             ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1383     }
1384     else
1385     {
1386         if (*count + *start > resultset->size)
1387             *count = resultset->size - *start;
1388         if (*count < 0)
1389             *count = 0;
1390         if (sr && sr->which == Z_Records_DBOSD)
1391         {
1392             int i;
1393             NMEM nmem = odr_extract_mem(c->odr_in);
1394             Z_NamePlusRecordList *p =
1395                 sr->u.databaseOrSurDiagnostics;
1396             for (i = 0; i<p->num_records; i++)
1397             {
1398                 ZOOM_record_cache_add(resultset, p->records[i], i + *start,
1399                                       syntax, elementSetName,
1400                                       elementSetName, 0);
1401             }
1402             *count -= i;
1403             if (*count < 0)
1404                 *count = 0;
1405             *start += i;
1406             yaz_log(c->log_details,
1407                     "handle_records resultset=%p start=%d count=%d",
1408                     resultset, *start, *count);
1409
1410             /* transfer our response to search_nmem .. we need it later */
1411             nmem_transfer(odr_getmem(resultset->odr), nmem);
1412             nmem_destroy(nmem);
1413             if (present_phase && p->num_records == 0)
1414             {
1415                 /* present response and we didn't get any records! */
1416                 Z_NamePlusRecord *myrec =
1417                     zget_surrogateDiagRec(
1418                         resultset->odr, 0,
1419                         YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1420                         "ZOOM C generated. Present phase and no records");
1421                 ZOOM_record_cache_add(resultset, myrec, *start,
1422                                       syntax, elementSetName, 0, 0);
1423             }
1424         }
1425         else if (present_phase)
1426         {
1427             /* present response and we didn't get any records! */
1428             Z_NamePlusRecord *myrec =
1429                 zget_surrogateDiagRec(
1430                     resultset->odr, 0,
1431                     YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1432                     "ZOOM C generated: Present response and no records");
1433             ZOOM_record_cache_add(resultset, myrec, *start,
1434                                   syntax, elementSetName, 0, 0);
1435         }
1436     }
1437 }
1438
1439 static void handle_Z3950_present_response(ZOOM_connection c,
1440                                           Z_PresentResponse *pr)
1441 {
1442     handle_Z3950_records(c, pr->records, 1);
1443 }
1444
1445 static void set_init_option(const char *name, void *clientData)
1446 {
1447     ZOOM_connection c = (ZOOM_connection) clientData;
1448     char buf[80];
1449
1450     sprintf(buf, "init_opt_%.70s", name);
1451     ZOOM_connection_option_set(c, buf, "1");
1452 }
1453
1454
1455 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset)
1456 {
1457     if (c->error)
1458         resultset->r_sort_spec = 0;
1459     if (resultset->r_sort_spec)
1460     {
1461         Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1462         Z_SortRequest *req = apdu->u.sortRequest;
1463
1464         req->num_inputResultSetNames = 1;
1465         req->inputResultSetNames = (Z_InternationalString **)
1466             odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
1467         req->inputResultSetNames[0] =
1468             odr_strdup(c->odr_out, resultset->setname);
1469         req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
1470         req->sortSequence = resultset->r_sort_spec;
1471         resultset->r_sort_spec = 0;
1472         return send_APDU(c, apdu);
1473     }
1474     return zoom_complete;
1475 }
1476
1477 zoom_ret send_Z3950_present(ZOOM_connection c)
1478 {
1479     Z_APDU *apdu = 0;
1480     Z_PresentRequest *req = 0;
1481     int i = 0;
1482     const char *syntax = 0;
1483     const char *elementSetName = 0;
1484     ZOOM_resultset  resultset;
1485     int *start, *count;
1486
1487     if (!c->tasks)
1488     {
1489         yaz_log(c->log_details, "%p send_present no tasks", c);
1490         return zoom_complete;
1491     }
1492
1493     switch (c->tasks->which)
1494     {
1495     case ZOOM_TASK_SEARCH:
1496         resultset = c->tasks->u.search.resultset;
1497         start = &c->tasks->u.search.start;
1498         count = &c->tasks->u.search.count;
1499         syntax = c->tasks->u.search.syntax;
1500         elementSetName = c->tasks->u.search.elementSetName;
1501         break;
1502     case ZOOM_TASK_RETRIEVE:
1503         resultset = c->tasks->u.retrieve.resultset;
1504         start = &c->tasks->u.retrieve.start;
1505         count = &c->tasks->u.retrieve.count;
1506         syntax = c->tasks->u.retrieve.syntax;
1507         elementSetName = c->tasks->u.retrieve.elementSetName;
1508         break;
1509     default:
1510         return zoom_complete;
1511     }
1512     yaz_log(c->log_details, "%p send_present start=%d count=%d",
1513             c, *start, *count);
1514
1515     if (*start < 0 || *count < 0 || *start + *count > resultset->size)
1516     {
1517         ZOOM_set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
1518                        "", 0);
1519     }
1520     if (c->error)                  /* don't continue on error */
1521         return zoom_complete;
1522     yaz_log(c->log_details, "send_present resultset=%p start=%d count=%d",
1523             resultset, *start, *count);
1524
1525     for (i = 0; i < *count; i++)
1526     {
1527         ZOOM_record rec =
1528             ZOOM_record_cache_lookup(resultset, i + *start,
1529                                      syntax, elementSetName);
1530         if (!rec)
1531             break;
1532         else
1533         {
1534             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1535             ZOOM_connection_put_event(c, event);
1536         }
1537     }
1538     *start += i;
1539     *count -= i;
1540
1541     if (*count == 0)
1542     {
1543         yaz_log(c->log_details, "%p send_present skip=%d no more to fetch", c, i);
1544         return zoom_complete;
1545     }
1546
1547     apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1548     req = apdu->u.presentRequest;
1549
1550     if (i)
1551         yaz_log(c->log_details, "%p send_present skip=%d", c, i);
1552
1553     *req->resultSetStartPoint = *start + 1;
1554
1555     if (resultset->step > 0 && resultset->step < *count)
1556         *req->numberOfRecordsRequested = resultset->step;
1557     else
1558         *req->numberOfRecordsRequested = *count;
1559
1560     if (*req->numberOfRecordsRequested + *start > resultset->size)
1561         *req->numberOfRecordsRequested = resultset->size - *start;
1562     assert(*req->numberOfRecordsRequested > 0);
1563
1564     if (syntax && *syntax)
1565         req->preferredRecordSyntax =
1566             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1567
1568     if (resultset->schema && *resultset->schema)
1569     {
1570         Z_RecordComposition *compo = (Z_RecordComposition *)
1571             odr_malloc(c->odr_out, sizeof(*compo));
1572
1573         req->recordComposition = compo;
1574         compo->which = Z_RecordComp_complex;
1575         compo->u.complex = (Z_CompSpec *)
1576             odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1577         compo->u.complex->selectAlternativeSyntax = (bool_t *)
1578             odr_malloc(c->odr_out, sizeof(bool_t));
1579         *compo->u.complex->selectAlternativeSyntax = 0;
1580
1581         compo->u.complex->generic = (Z_Specification *)
1582             odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1583
1584         compo->u.complex->generic->which = Z_Schema_oid;
1585         compo->u.complex->generic->schema.oid = (Odr_oid *)
1586             zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
1587
1588         if (!compo->u.complex->generic->schema.oid)
1589         {
1590             /* OID wasn't a schema! Try record syntax instead. */
1591
1592             compo->u.complex->generic->schema.oid = (Odr_oid *)
1593                 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
1594         }
1595         if (elementSetName && *elementSetName)
1596         {
1597             compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1598                 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1599             compo->u.complex->generic->elementSpec->which =
1600                 Z_ElementSpec_elementSetName;
1601             compo->u.complex->generic->elementSpec->u.elementSetName =
1602                 odr_strdup(c->odr_out, elementSetName);
1603         }
1604         else
1605             compo->u.complex->generic->elementSpec = 0;
1606         compo->u.complex->num_dbSpecific = 0;
1607         compo->u.complex->dbSpecific = 0;
1608         compo->u.complex->num_recordSyntax = 0;
1609         compo->u.complex->recordSyntax = 0;
1610     }
1611     else if (elementSetName && *elementSetName)
1612     {
1613         Z_ElementSetNames *esn = (Z_ElementSetNames *)
1614             odr_malloc(c->odr_out, sizeof(*esn));
1615         Z_RecordComposition *compo = (Z_RecordComposition *)
1616             odr_malloc(c->odr_out, sizeof(*compo));
1617
1618         esn->which = Z_ElementSetNames_generic;
1619         esn->u.generic = odr_strdup(c->odr_out, elementSetName);
1620         compo->which = Z_RecordComp_simple;
1621         compo->u.simple = esn;
1622         req->recordComposition = compo;
1623     }
1624     req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1625     return send_APDU(c, apdu);
1626 }
1627
1628 static zoom_ret send_Z3950_sort_present(ZOOM_connection c)
1629 {
1630     zoom_ret r = zoom_complete;
1631
1632     if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
1633         r = send_Z3950_sort(c, c->tasks->u.search.resultset);
1634     if (r == zoom_complete)
1635         r = send_Z3950_present(c);
1636     return r;
1637 }
1638
1639 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu)
1640 {
1641     Z_InitResponse *initrs;
1642
1643     ZOOM_connection_set_mask(c, 0);
1644     yaz_log(c->log_details, "%p handle_Z3950_apdu apdu->which=%d",
1645             c, apdu->which);
1646     switch (apdu->which)
1647     {
1648     case Z_APDU_initResponse:
1649         yaz_log(c->log_api, "%p handle_Z3950_apdu: Received Init response", c);
1650         initrs = apdu->u.initResponse;
1651         ZOOM_connection_option_set(c, "serverImplementationId",
1652                                    initrs->implementationId ?
1653                                    initrs->implementationId : "");
1654         ZOOM_connection_option_set(c, "serverImplementationName",
1655                                    initrs->implementationName ?
1656                                    initrs->implementationName : "");
1657         ZOOM_connection_option_set(c, "serverImplementationVersion",
1658                                    initrs->implementationVersion ?
1659                                    initrs->implementationVersion : "");
1660         /* Set the three old options too, for old applications */
1661         ZOOM_connection_option_set(c, "targetImplementationId",
1662                                    initrs->implementationId ?
1663                                    initrs->implementationId : "");
1664         ZOOM_connection_option_set(c, "targetImplementationName",
1665                                    initrs->implementationName ?
1666                                    initrs->implementationName : "");
1667         ZOOM_connection_option_set(c, "targetImplementationVersion",
1668                                    initrs->implementationVersion ?
1669                                    initrs->implementationVersion : "");
1670
1671         /* Make initrs->options available as ZOOM-level options */
1672         yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
1673
1674         if (!*initrs->result)
1675         {
1676             Z_External *uif = initrs->userInformationField;
1677
1678             ZOOM_set_error(c, ZOOM_ERROR_INIT, 0); /* default error */
1679
1680             if (uif && uif->which == Z_External_userInfo1)
1681                 interpret_otherinformation_field(c, uif->u.userInfo1);
1682         }
1683         else
1684         {
1685             char *cookie =
1686                 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
1687                                       yaz_oid_userinfo_cookie, 1, 0);
1688             xfree(c->cookie_in);
1689             c->cookie_in = 0;
1690             if (cookie)
1691                 c->cookie_in = xstrdup(cookie);
1692             if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1693                 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1694                 c->support_named_resultsets = 1;
1695             if (c->tasks)
1696             {
1697                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1698                 ZOOM_connection_remove_task(c);
1699             }
1700             ZOOM_connection_exec_task(c);
1701         }
1702         if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
1703         {
1704             NMEM tmpmem = nmem_create();
1705             Z_CharSetandLanguageNegotiation *p =
1706                 yaz_get_charneg_record(initrs->otherInfo);
1707
1708             if (p)
1709             {
1710                 char *charset = NULL, *lang = NULL;
1711                 int sel;
1712
1713                 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
1714                 yaz_log(c->log_details, "%p handle_Z3950_apdu target accepted: "
1715                         "charset %s, language %s, select %d",
1716                         c,
1717                         charset ? charset : "none", lang ? lang : "none", sel);
1718                 if (charset)
1719                     ZOOM_connection_option_set(c, "negotiation-charset",
1720                                                charset);
1721                 if (lang)
1722                     ZOOM_connection_option_set(c, "negotiation-lang",
1723                                                lang);
1724
1725                 ZOOM_connection_option_set(
1726                     c,  "negotiation-charset-in-effect-for-records",
1727                     (sel != 0) ? "1" : "0");
1728                 nmem_destroy(tmpmem);
1729             }
1730         }
1731         break;
1732     case Z_APDU_searchResponse:
1733         yaz_log(c->log_api, "%p handle_Z3950_apdu Search response", c);
1734         handle_Z3950_search_response(c, apdu->u.searchResponse);
1735         if (send_Z3950_sort_present(c) == zoom_complete)
1736             ZOOM_connection_remove_task(c);
1737         break;
1738     case Z_APDU_presentResponse:
1739         yaz_log(c->log_api, "%p handle_Z3950_apdu Present response", c);
1740         handle_Z3950_present_response(c, apdu->u.presentResponse);
1741         if (send_Z3950_present(c) == zoom_complete)
1742             ZOOM_connection_remove_task(c);
1743         break;
1744     case Z_APDU_sortResponse:
1745         yaz_log(c->log_api, "%p handle_Z3950_apdu Sort response", c);
1746         handle_Z3950_sort_response(c, apdu->u.sortResponse);
1747         if (send_Z3950_present(c) == zoom_complete)
1748             ZOOM_connection_remove_task(c);
1749         break;
1750     case Z_APDU_scanResponse:
1751         yaz_log(c->log_api, "%p handle_Z3950_apdu Scan response", c);
1752         handle_Z3950_scan_response(c, apdu->u.scanResponse);
1753         ZOOM_connection_remove_task(c);
1754         break;
1755     case Z_APDU_extendedServicesResponse:
1756         yaz_log(c->log_api, "%p handle_Z3950_apdu Extended Services response", c);
1757         handle_Z3950_es_response(c, apdu->u.extendedServicesResponse);
1758         ZOOM_connection_remove_task(c);
1759         break;
1760     case Z_APDU_close:
1761         yaz_log(c->log_api, "%p handle_Z3950_apdu Close PDU", c);
1762         if (!ZOOM_test_reconnect(c))
1763         {
1764             ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1765             ZOOM_connection_close(c);
1766         }
1767         break;
1768     default:
1769         yaz_log(c->log_api, "%p Received unknown PDU", c);
1770         ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1771         ZOOM_connection_close(c);
1772     }
1773 }
1774
1775 /*
1776  * Local variables:
1777  * c-basic-offset: 4
1778  * c-file-style: "Stroustrup"
1779  * indent-tabs-mode: nil
1780  * End:
1781  * vim: shiftwidth=4 tabstop=8 expandtab
1782  */
1783