src/zoom-z3950.c

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