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 = &search_req->additionalSearchInfo;
 674             yaz_oi_set_facetlist(oi, c->odr_out, facet_list);
 675         }
 676         else
 677             yaz_log(YLOG_WARN, "Unable to parse facets: %s", facets);
 678     }
 679
 680     assert(r);
 681     assert(r->query);
 682
 683     /* prepare query for the search request */
 684     search_req->query = ZOOM_query_get_Z_Query(r->query);
 685     if (!search_req->query)
 686     {
 687         ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
 688         return zoom_complete;
 689     }
 690     if (search_req->query->which == Z_Query_type_1 ||
 691         search_req->query->which == Z_Query_type_101)
 692     {
 693         const char *cp = ZOOM_options_get(r->options, "rpnCharset");
 694         if (cp)
 695         {
 696             yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
 697             if (cd)
 698             {
 699                 int r;
 700                 search_req->query = yaz_copy_Z_Query(search_req->query,
 701                                                      c->odr_out);
 702
 703                 r = yaz_query_charset_convert_rpnquery_check(
 704                     search_req->query->u.type_1,
 705                     c->odr_out, cd);
 706                 yaz_iconv_close(cd);
 707                 if (r)
 708                 {  /* query could not be char converted */
 709                     ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
 710                     return zoom_complete;
 711                 }
 712             }
 713         }
 714     }
 715     search_req->databaseNames = r->databaseNames;
 716     search_req->num_databaseNames = r->num_databaseNames;
 717
 718     /* get syntax (no need to provide unless piggyback is in effect) */
 719     syntax = c->tasks->u.search.syntax;
 720
 721     schema = c->tasks->u.search.schema;
 722
 723     lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
 724     ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
 725     mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
 726     if (lslb != -1 && ssub != -1 && mspn != -1)
 727     {
 728         /* So're a Z39.50 expert? Let's hope you don't do sort */
 729         *search_req->largeSetLowerBound = lslb;
 730         *search_req->smallSetUpperBound = ssub;
 731         *search_req->mediumSetPresentNumber = mspn;
 732     }
 733     else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
 734              && r->piggyback && !r->r_sort_spec && !schema)
 735     {
 736         /* Regular piggyback - do it unless we're going to do sort */
 737         *search_req->largeSetLowerBound = 2000000000;
 738         *search_req->smallSetUpperBound = 1;
 739         *search_req->mediumSetPresentNumber =
 740             r->step>0 ? r->step : c->tasks->u.search.count;
 741     }
 742     else
 743     {
 744         /* non-piggyback. Need not provide elementsets or syntaxes .. */
 745         smallSetElementSetName = 0;
 746         mediumSetElementSetName = 0;
 747         syntax = 0;
 748     }
 749     if (smallSetElementSetName && *smallSetElementSetName)
 750     {
 751         Z_ElementSetNames *esn = (Z_ElementSetNames *)
 752             odr_malloc(c->odr_out, sizeof(*esn));
 753
 754         esn->which = Z_ElementSetNames_generic;
 755         esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
 756         search_req->smallSetElementSetNames = esn;
 757     }
 758     if (mediumSetElementSetName && *mediumSetElementSetName)
 759     {
 760         Z_ElementSetNames *esn =(Z_ElementSetNames *)
 761             odr_malloc(c->odr_out, sizeof(*esn));
 762
 763         esn->which = Z_ElementSetNames_generic;
 764         esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
 765         search_req->mediumSetElementSetNames = esn;
 766     }
 767     if (syntax)
 768         search_req->preferredRecordSyntax =
 769             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
 770
 771     if (!r->setname)
 772     {
 773         if (c->support_named_resultsets)
 774         {
 775             char setname[14];
 776             int ord;
 777             /* find the lowest unused ordinal so that we re-use
 778                result sets on the server. */
 779             for (ord = 1; ; ord++)
 780             {
 781 #if ZOOM_RESULT_LISTS
 782                 ZOOM_resultsets rsp;
 783                 sprintf(setname, "%d", ord);
 784                 for (rsp = c->resultsets; rsp; rsp = rsp->next)
 785                     if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
 786                         break;
 787                 if (!rsp)
 788                     break;
 789 #else
 790                 ZOOM_resultset rp;
 791                 sprintf(setname, "%d", ord);
 792                 for (rp = c->resultsets; rp; rp = rp->next)
 793                     if (rp->setname && !strcmp(rp->setname, setname))
 794                         break;
 795                 if (!rp)
 796                     break;
 797 #endif
 798
 799             }
 800             r->setname = xstrdup(setname);
 801             yaz_log(c->log_details, "%p ZOOM_connection_send_search: "
 802                     "allocating set %s", c, r->setname);
 803         }
 804         else
 805         {
 806             yaz_log(c->log_details, "%p ZOOM_connection_send_search: using "
 807                     "default set", c);
 808             r->setname = xstrdup("default");
 809         }
 810         ZOOM_options_set(r->options, "setname", r->setname);
 811     }
 812     search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
 813     return send_APDU(c, apdu);
 814 }
 815
 816 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c)
 817 {
 818     ZOOM_scanset scan;
 819     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
 820     Z_ScanRequest *req = apdu->u.scanRequest;
 821     Z_Query *z_query;
 822
 823     yaz_log(c->log_details, "%p send_scan", c);
 824     if (!c->tasks)
 825         return zoom_complete;
 826     assert (c->tasks->which == ZOOM_TASK_SCAN);
 827     scan = c->tasks->u.scan.scan;
 828
 829     z_query = ZOOM_query_get_Z_Query(scan->query);
 830
 831     /* Z39.50 scan can only carry RPN */
 832     if (z_query->which == Z_Query_type_1 ||
 833         z_query->which == Z_Query_type_101)
 834     {
 835         Z_RPNQuery *rpn = z_query->u.type_1;
 836         const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
 837         if (cp)
 838         {
 839             yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
 840             if (cd)
 841             {
 842                 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
 843
 844                 yaz_query_charset_convert_rpnquery(
 845                     rpn, c->odr_out, cd);
 846                 yaz_iconv_close(cd);
 847             }
 848         }
 849         req->attributeSet = rpn->attributeSetId;
 850         if (!req->attributeSet)
 851             req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
 852         if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
 853             rpn->RPNStructure->u.simple->which == Z_Operand_APT)
 854         {
 855             req->termListAndStartPoint =
 856                 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
 857         }
 858         else
 859         {
 860             ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
 861             return zoom_complete;
 862         }
 863     }
 864     else
 865     {
 866         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
 867         return zoom_complete;
 868     }
 869
 870     *req->numberOfTermsRequested =
 871         ZOOM_options_get_int(scan->options, "number", 20);
 872
 873     req->preferredPositionInResponse =
 874         odr_intdup(c->odr_out,
 875                    ZOOM_options_get_int(scan->options, "position", 1));
 876
 877     req->stepSize =
 878         odr_intdup(c->odr_out,
 879                    ZOOM_options_get_int(scan->options, "stepSize", 0));
 880
 881     req->databaseNames = scan->databaseNames;
 882     req->num_databaseNames = scan->num_databaseNames;
 883
 884     return send_APDU(c, apdu);
 885 }
 886
 887 ZOOM_API(void)
 888     ZOOM_package_send(ZOOM_package p, const char *type)
 889 {
 890     Z_APDU *apdu = 0;
 891     ZOOM_connection c;
 892     if (!p)
 893         return;
 894     c = p->connection;
 895     odr_reset(p->odr_out);
 896     xfree(p->buf_out);
 897     p->buf_out = 0;
 898     if (!strcmp(type, "itemorder"))
 899     {
 900         apdu = create_es_package(p, yaz_oid_extserv_item_order);
 901         if (apdu)
 902         {
 903             Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
 904
 905             r->direct_reference =
 906                 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
 907             r->descriptor = 0;
 908             r->which = Z_External_itemOrder;
 909             r->indirect_reference = 0;
 910             r->u.itemOrder = encode_item_order(p);
 911
 912             apdu->u.extendedServicesRequest->taskSpecificParameters = r;
 913         }
 914     }
 915     else if (!strcmp(type, "create"))  /* create database */
 916     {
 917         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
 918                                     0, 0);
 919     }
 920     else if (!strcmp(type, "drop"))  /* drop database */
 921     {
 922         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
 923                                     0, 0);
 924     }
 925     else if (!strcmp(type, "commit"))  /* commit changes */
 926     {
 927         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
 928                                     0, 0);
 929     }
 930     else if (!strcmp(type, "update")) /* update record(s) */
 931     {
 932         apdu = create_update_package(p);
 933     }
 934     else if (!strcmp(type, "xmlupdate"))
 935     {
 936         apdu = create_xmlupdate_package(p);
 937     }
 938     if (apdu)
 939     {
 940         if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
 941         {
 942             char *buf;
 943
 944             ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
 945             task->u.package = p;
 946             buf = odr_getbuf(p->odr_out, &p->len_out, 0);
 947             p->buf_out = (char *) xmalloc(p->len_out);
 948             memcpy(p->buf_out, buf, p->len_out);
 949
 950             (p->refcount)++;
 951             if (!c->async)
 952             {
 953                 while (ZOOM_event(1, &c))
 954                     ;
 955             }
 956         }
 957     }
 958 }
 959
 960 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
 961                                  int present_phase);
 962
 963 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
 964 {
 965     char oid_name_buf[OID_STR_MAX];
 966     const char *oid_name;
 967     char *addinfo = 0;
 968
 969     oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
 970     switch (r->which)
 971     {
 972     case Z_DefaultDiagFormat_v2Addinfo:
 973         addinfo = r->u.v2Addinfo;
 974         break;
 975     case Z_DefaultDiagFormat_v3Addinfo:
 976         addinfo = r->u.v3Addinfo;
 977         break;
 978     }
 979     xfree(c->addinfo);
 980     c->addinfo = 0;
 981     ZOOM_set_dset_error(c, *r->condition, oid_name, addinfo, 0);
 982 }
 983
 984 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
 985 {
 986     if (p->which != Z_DiagRec_defaultFormat)
 987         ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
 988     else
 989         response_default_diag(c, p->u.defaultFormat);
 990 }
 991
 992 static int es_response_taskpackage_update(ZOOM_connection c,
 993                                           Z_IUUpdateTaskPackage *utp)
 994 {
 995     if (utp && utp->targetPart)
 996     {
 997         Z_IUTargetPart *targetPart = utp->targetPart;
 998         switch ( *targetPart->updateStatus ) {
 999         case Z_IUTargetPart_success:
1000             ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
1001             break;
1002         case Z_IUTargetPart_partial:
1003             ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
1004             break;
1005         case Z_IUTargetPart_failure:
1006             ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
1007             if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
1008                 response_diag(c, targetPart->globalDiagnostics[0]);
1009             break;
1010         }
1011         /* NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED. */
1012     }
1013     return 1;
1014 }
1015
1016 static int es_response_taskpackage(ZOOM_connection c,
1017                                    Z_TaskPackage *taskPackage)
1018 {
1019     Odr_oct *id = taskPackage->targetReference;
1020     if (id)
1021         ZOOM_options_setl(c->tasks->u.package->options,
1022                           "targetReference", (char*) id->buf, id->len);
1023
1024     switch ( *taskPackage->taskStatus ) {
1025     case Z_TaskPackage_pending:
1026         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
1027         break;
1028     case Z_TaskPackage_active:
1029         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
1030         break;
1031     case Z_TaskPackage_complete:
1032         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
1033         break;
1034     case Z_TaskPackage_aborted:
1035         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
1036         if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
1037             response_diag(c, taskPackage->packageDiagnostics[0]);
1038         break;
1039     }
1040     /* NOTE: Only Update implemented, no others. */
1041     if ( taskPackage->taskSpecificParameters->which == Z_External_update )
1042     {
1043         Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
1044         es_response_taskpackage_update(c, utp);
1045     }
1046     return 1;
1047 }
1048
1049
1050 static int handle_Z3950_es_response(ZOOM_connection c,
1051                                     Z_ExtendedServicesResponse *res)
1052 {
1053     if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
1054         return 0;
1055     switch (*res->operationStatus)
1056     {
1057     case Z_ExtendedServicesResponse_done:
1058         ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
1059         break;
1060     case Z_ExtendedServicesResponse_accepted:
1061         ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
1062         break;
1063     case Z_ExtendedServicesResponse_failure:
1064         ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
1065         if (res->diagnostics && res->num_diagnostics > 0)
1066             response_diag(c, res->diagnostics[0]);
1067         break;
1068     }
1069     if (res->taskPackage &&
1070         res->taskPackage->which == Z_External_extendedService)
1071     {
1072         Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
1073         es_response_taskpackage(c, taskPackage);
1074     }
1075     if (res->taskPackage &&
1076         res->taskPackage->which == Z_External_octet)
1077     {
1078         Odr_oct *doc = res->taskPackage->u.octet_aligned;
1079         ZOOM_options_setl(c->tasks->u.package->options,
1080                           "xmlUpdateDoc", (char*) doc->buf, doc->len);
1081     }
1082     return 1;
1083 }
1084
1085 static char *get_term_cstr(ODR odr, Z_Term *term) {
1086
1087     switch (term->which) {
1088     case Z_Term_general:
1089             return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
1090         break;
1091     case Z_Term_characterString:
1092         return odr_strdup(odr, term->u.characterString);
1093     }
1094     return 0;
1095 }
1096
1097 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
1098     int term_index;
1099     struct yaz_facet_attr attr_values;
1100     ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
1101     yaz_facet_attr_init(&attr_values);
1102     yaz_facet_attr_get_z_attributes(facet->attributes, &attr_values);
1103     facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
1104     facet_field->num_terms = facet->num_terms;
1105     yaz_log(YLOG_DEBUG, "ZOOM_facet_field %s %d terms %d", attr_values.useattr, attr_values.limit, facet->num_terms);
1106     facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
1107     for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
1108         Z_FacetTerm *facetTerm = facet->terms[term_index];
1109         facet_field->facet_terms[term_index].frequency = *facetTerm->count;
1110         facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
1111         yaz_log(YLOG_DEBUG, "    term[%d] %s %d",
1112                 term_index, facet_field->facet_terms[term_index].term, facet_field->facet_terms[term_index].frequency);
1113     }
1114     return facet_field;
1115 }
1116
1117 /* Can be share with SOLR/SRU/SRW requests */
1118 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl)
1119 {
1120     int j;
1121     r->num_facets   = fl->num;
1122     yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num);
1123     r->facets       =  odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
1124     r->facets_names =  odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
1125     for (j = 0; j < fl->num; j++)
1126     {
1127         r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
1128         if (!r->facets[j])
1129             yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j);
1130         r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
1131     }
1132 }
1133
1134 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
1135                                 Z_OtherInformation *o)
1136 {
1137     int i;
1138     for (i = 0; o && i < o->num_elements; i++)
1139     {
1140         if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1141         {
1142             Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1143             if (ext->which == Z_External_userFacets)
1144             {
1145                 ZOOM_handle_facet_list(r, ext->u.facetList);
1146             }
1147         }
1148     }
1149 }
1150
1151 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
1152                                        Z_Term *term)
1153 {
1154     switch (term->which)
1155     {
1156     case Z_Term_general:
1157         ZOOM_options_setl(opt, name,
1158                           (const char *)(term->u.general->buf),
1159                           term->u.general->len);
1160         break;
1161     case Z_Term_characterString:
1162         ZOOM_options_set(opt, name, term->u.characterString);
1163         break;
1164     case Z_Term_numeric:
1165         ZOOM_options_set_int(opt, name, *term->u.numeric);
1166         break;
1167     }
1168 }
1169
1170 static void handle_queryExpression(ZOOM_options opt, const char *name,
1171                                    Z_QueryExpression *exp)
1172 {
1173     char opt_name[80];
1174
1175     switch (exp->which)
1176     {
1177     case Z_QueryExpression_term:
1178         if (exp->u.term && exp->u.term->queryTerm)
1179         {
1180             sprintf(opt_name, "%s.term", name);
1181             handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
1182         }
1183         break;
1184     case Z_QueryExpression_query:
1185         break;
1186     }
1187 }
1188
1189
1190 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
1191                                 Z_OtherInformation *o)
1192 {
1193     int i;
1194     for (i = 0; o && i < o->num_elements; i++)
1195     {
1196         if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1197         {
1198             Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1199
1200             if (ext->which == Z_External_searchResult1)
1201             {
1202                 int j;
1203                 Z_SearchInfoReport *sr = ext->u.searchResult1;
1204
1205                 if (sr->num)
1206                     ZOOM_options_set_int(
1207                         resultset->options, "searchresult.size", sr->num);
1208
1209                 for (j = 0; j < sr->num; j++)
1210                 {
1211                     Z_SearchInfoReport_s *ent =
1212                         ext->u.searchResult1->elements[j];
1213                     char pref[80];
1214
1215                     sprintf(pref, "searchresult.%d", j);
1216
1217                     if (ent->subqueryId)
1218                     {
1219                         char opt_name[80];
1220                         sprintf(opt_name, "%s.id", pref);
1221                         ZOOM_options_set(resultset->options, opt_name,
1222                                          ent->subqueryId);
1223                     }
1224                     if (ent->subqueryExpression)
1225                     {
1226                         char opt_name[80];
1227                         sprintf(opt_name, "%s.subquery", pref);
1228                         handle_queryExpression(resultset->options, opt_name,
1229                                                ent->subqueryExpression);
1230                     }
1231                     if (ent->subqueryInterpretation)
1232                     {
1233                         char opt_name[80];
1234                         sprintf(opt_name, "%s.interpretation", pref);
1235                         handle_queryExpression(resultset->options, opt_name,
1236                                                ent->subqueryInterpretation);
1237                     }
1238                     if (ent->subqueryRecommendation)
1239                     {
1240                         char opt_name[80];
1241                         sprintf(opt_name, "%s.recommendation", pref);
1242                         handle_queryExpression(resultset->options, opt_name,
1243                                                ent->subqueryRecommendation);
1244                     }
1245                     if (ent->subqueryCount)
1246                     {
1247                         char opt_name[80];
1248                         sprintf(opt_name, "%s.count", pref);
1249                         ZOOM_options_set_int(resultset->options, opt_name,
1250                                              *ent->subqueryCount);
1251                     }
1252                 }
1253             }
1254         }
1255     }
1256 }
1257
1258 static void handle_Z3950_search_response(ZOOM_connection c,
1259                                          Z_SearchResponse *sr)
1260 {
1261     ZOOM_resultset resultset;
1262     ZOOM_Event event;
1263
1264     if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1265         return ;
1266
1267     event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1268     ZOOM_connection_put_event(c, event);
1269
1270     resultset = c->tasks->u.search.resultset;
1271
1272     if (sr->resultSetStatus)
1273     {
1274         ZOOM_options_set_int(resultset->options, "resultSetStatus",
1275                              *sr->resultSetStatus);
1276     }
1277     if (sr->presentStatus)
1278     {
1279         ZOOM_options_set_int(resultset->options, "presentStatus",
1280                              *sr->presentStatus);
1281     }
1282     handle_search_result(c, resultset, sr->additionalSearchInfo);
1283
1284     handle_facet_result(c, resultset, sr->additionalSearchInfo);
1285
1286     resultset->size = *sr->resultCount;
1287     handle_Z3950_records(c, sr->records, 0);
1288 }
1289
1290 static void handle_Z3950_sort_response(ZOOM_connection c, Z_SortResponse *res)
1291 {
1292     if (res->diagnostics && res->num_diagnostics > 0)
1293         response_diag(c, res->diagnostics[0]);
1294 }
1295
1296 static int handle_Z3950_scan_response(ZOOM_connection c, Z_ScanResponse *res)
1297 {
1298     NMEM nmem = odr_extract_mem(c->odr_in);
1299     ZOOM_scanset scan;
1300
1301     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1302         return 0;
1303     scan = c->tasks->u.scan.scan;
1304
1305     if (res->entries && res->entries->nonsurrogateDiagnostics)
1306         response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1307     scan->scan_response = res;
1308     scan->srw_scan_response = 0;
1309     nmem_transfer(odr_getmem(scan->odr), nmem);
1310     if (res->stepSize)
1311         ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
1312     if (res->positionOfTerm)
1313         ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
1314     if (res->scanStatus)
1315         ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
1316     if (res->numberOfEntriesReturned)
1317         ZOOM_options_set_int(scan->options, "number",
1318                              *res->numberOfEntriesReturned);
1319     nmem_destroy(nmem);
1320     return 1;
1321 }
1322
1323 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
1324                                  int present_phase)
1325 {
1326     ZOOM_resultset resultset;
1327     int *start, *count;
1328     const char *syntax = 0, *elementSetName = 0, *schema = 0;
1329
1330     if (!c->tasks)
1331         return ;
1332     switch (c->tasks->which)
1333     {
1334     case ZOOM_TASK_SEARCH:
1335         resultset = c->tasks->u.search.resultset;
1336         start = &c->tasks->u.search.start;
1337         count = &c->tasks->u.search.count;
1338         syntax = c->tasks->u.search.syntax;
1339         elementSetName = c->tasks->u.search.elementSetName;
1340         schema =  c->tasks->u.search.schema;
1341         break;
1342     case ZOOM_TASK_RETRIEVE:
1343         resultset = c->tasks->u.retrieve.resultset;
1344         start = &c->tasks->u.retrieve.start;
1345         count = &c->tasks->u.retrieve.count;
1346         syntax = c->tasks->u.retrieve.syntax;
1347         elementSetName = c->tasks->u.retrieve.elementSetName;
1348         schema =  c->tasks->u.retrieve.schema;
1349         break;
1350     default:
1351         return;
1352     }
1353     if (sr && sr->which == Z_Records_NSD)
1354         response_default_diag(c, sr->u.nonSurrogateDiagnostic);
1355     else if (sr && sr->which == Z_Records_multipleNSD)
1356     {
1357         if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1358             response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1359         else
1360             ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1361     }
1362     else
1363     {
1364         if (*count + *start > resultset->size)
1365             *count = resultset->size - *start;
1366         if (*count < 0)
1367             *count = 0;
1368         if (sr && sr->which == Z_Records_DBOSD)
1369         {
1370             int i;
1371             NMEM nmem = odr_extract_mem(c->odr_in);
1372             Z_NamePlusRecordList *p =
1373                 sr->u.databaseOrSurDiagnostics;
1374             for (i = 0; i<p->num_records; i++)
1375             {
1376                 ZOOM_record_cache_add(resultset, p->records[i], i + *start,
1377                                       syntax, elementSetName, schema, 0);
1378             }
1379             *count -= i;
1380             if (*count < 0)
1381                 *count = 0;
1382             *start += i;
1383             yaz_log(c->log_details,
1384                     "handle_records resultset=%p start=%d count=%d",
1385                     resultset, *start, *count);
1386
1387             /* transfer our response to search_nmem .. we need it later */
1388             nmem_transfer(odr_getmem(resultset->odr), nmem);
1389             nmem_destroy(nmem);
1390             if (present_phase && p->num_records == 0)
1391             {
1392                 /* present response and we didn't get any records! */
1393                 Z_NamePlusRecord *myrec =
1394                     zget_surrogateDiagRec(
1395                         resultset->odr, 0,
1396                         YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1397                         "ZOOM C generated. Present phase and no records");
1398                 ZOOM_record_cache_add(resultset, myrec, *start,
1399                                       syntax, elementSetName, schema, 0);
1400             }
1401         }
1402         else if (present_phase)
1403         {
1404             /* present response and we didn't get any records! */
1405             Z_NamePlusRecord *myrec =
1406                 zget_surrogateDiagRec(
1407                     resultset->odr, 0,
1408                     YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1409                     "ZOOM C generated: Present response and no records");
1410             ZOOM_record_cache_add(resultset, myrec, *start,
1411                                   syntax, elementSetName, schema, 0);
1412         }
1413     }
1414 }
1415
1416 static void handle_Z3950_present_response(ZOOM_connection c,
1417                                           Z_PresentResponse *pr)
1418 {
1419     handle_Z3950_records(c, pr->records, 1);
1420 }
1421
1422 static void set_init_option(const char *name, void *clientData)
1423 {
1424     ZOOM_connection c = (ZOOM_connection) clientData;
1425     char buf[80];
1426
1427     sprintf(buf, "init_opt_%.70s", name);
1428     ZOOM_connection_option_set(c, buf, "1");
1429 }
1430
1431
1432 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset)
1433 {
1434     if (c->error)
1435         resultset->r_sort_spec = 0;
1436     if (resultset->r_sort_spec)
1437     {
1438         Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1439         Z_SortRequest *req = apdu->u.sortRequest;
1440
1441         req->num_inputResultSetNames = 1;
1442         req->inputResultSetNames = (Z_InternationalString **)
1443             odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
1444         req->inputResultSetNames[0] =
1445             odr_strdup(c->odr_out, resultset->setname);
1446         req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
1447         req->sortSequence = resultset->r_sort_spec;
1448         resultset->r_sort_spec = 0;
1449         return send_APDU(c, apdu);
1450     }
1451     return zoom_complete;
1452 }
1453
1454 zoom_ret send_Z3950_present(ZOOM_connection c)
1455 {
1456     Z_APDU *apdu = 0;
1457     Z_PresentRequest *req = 0;
1458     int i = 0;
1459     const char *syntax = 0;
1460     const char *elementSetName = 0;
1461     const char *schema = 0;
1462     ZOOM_resultset resultset;
1463     int *start, *count;
1464
1465     if (!c->tasks)
1466     {
1467         yaz_log(c->log_details, "%p send_present no tasks", c);
1468         return zoom_complete;
1469     }
1470
1471     switch (c->tasks->which)
1472     {
1473     case ZOOM_TASK_SEARCH:
1474         resultset = c->tasks->u.search.resultset;
1475         start = &c->tasks->u.search.start;
1476         count = &c->tasks->u.search.count;
1477         syntax = c->tasks->u.search.syntax;
1478         elementSetName = c->tasks->u.search.elementSetName;
1479         schema =  c->tasks->u.search.schema;
1480         break;
1481     case ZOOM_TASK_RETRIEVE:
1482         resultset = c->tasks->u.retrieve.resultset;
1483         start = &c->tasks->u.retrieve.start;
1484         count = &c->tasks->u.retrieve.count;
1485         syntax = c->tasks->u.retrieve.syntax;
1486         elementSetName = c->tasks->u.retrieve.elementSetName;
1487         schema = c->tasks->u.retrieve.schema;
1488         break;
1489     default:
1490         return zoom_complete;
1491     }
1492     yaz_log(c->log_details, "%p send_present start=%d count=%d",
1493             c, *start, *count);
1494
1495     if (*start < 0 || *count < 0 || *start + *count > resultset->size)
1496     {
1497         ZOOM_set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
1498                        "", 0);
1499     }
1500     if (c->error)                  /* don't continue on error */
1501         return zoom_complete;
1502     yaz_log(c->log_details, "send_present resultset=%p start=%d count=%d",
1503             resultset, *start, *count);
1504
1505     for (i = 0; i < *count; i++)
1506     {
1507         ZOOM_record rec =
1508             ZOOM_record_cache_lookup(resultset, i + *start,
1509                                      syntax, elementSetName, schema);
1510         if (!rec)
1511             break;
1512         else
1513         {
1514             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1515             ZOOM_connection_put_event(c, event);
1516         }
1517     }
1518     *start += i;
1519     *count -= i;
1520
1521     if (*count == 0)
1522     {
1523         yaz_log(c->log_details, "%p send_present skip=%d no more to fetch", c, i);
1524         return zoom_complete;
1525     }
1526
1527     apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1528     req = apdu->u.presentRequest;
1529
1530     if (i)
1531         yaz_log(c->log_details, "%p send_present skip=%d", c, i);
1532
1533     *req->resultSetStartPoint = *start + 1;
1534
1535     if (resultset->step > 0 && resultset->step < *count)
1536         *req->numberOfRecordsRequested = resultset->step;
1537     else
1538         *req->numberOfRecordsRequested = *count;
1539
1540     if (*req->numberOfRecordsRequested + *start > resultset->size)
1541         *req->numberOfRecordsRequested = resultset->size - *start;
1542     assert(*req->numberOfRecordsRequested > 0);
1543
1544     if (syntax && *syntax)
1545         req->preferredRecordSyntax =
1546             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1547
1548     if (schema && *schema)
1549     {
1550         Z_RecordComposition *compo = (Z_RecordComposition *)
1551             odr_malloc(c->odr_out, sizeof(*compo));
1552
1553         req->recordComposition = compo;
1554         compo->which = Z_RecordComp_complex;
1555         compo->u.complex = (Z_CompSpec *)
1556             odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1557         compo->u.complex->selectAlternativeSyntax = (bool_t *)
1558             odr_malloc(c->odr_out, sizeof(bool_t));
1559         *compo->u.complex->selectAlternativeSyntax = 0;
1560
1561         compo->u.complex->generic = (Z_Specification *)
1562             odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1563
1564         compo->u.complex->generic->which = Z_Schema_oid;
1565         compo->u.complex->generic->schema.oid = (Odr_oid *)
1566             zoom_yaz_str_to_z3950oid(c, CLASS_SCHEMA, schema);
1567
1568         if (!compo->u.complex->generic->schema.oid)
1569         {
1570             /* OID wasn't a schema! Try record syntax instead. */
1571
1572             compo->u.complex->generic->schema.oid = (Odr_oid *)
1573                 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, schema);
1574         }
1575         if (elementSetName && *elementSetName)
1576         {
1577             compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1578                 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1579             compo->u.complex->generic->elementSpec->which =
1580                 Z_ElementSpec_elementSetName;
1581             compo->u.complex->generic->elementSpec->u.elementSetName =
1582                 odr_strdup(c->odr_out, elementSetName);
1583         }
1584         else
1585             compo->u.complex->generic->elementSpec = 0;
1586         compo->u.complex->num_dbSpecific = 0;
1587         compo->u.complex->dbSpecific = 0;
1588         compo->u.complex->num_recordSyntax = 0;
1589         compo->u.complex->recordSyntax = 0;
1590     }
1591     else if (elementSetName && *elementSetName)
1592     {
1593         Z_ElementSetNames *esn = (Z_ElementSetNames *)
1594             odr_malloc(c->odr_out, sizeof(*esn));
1595         Z_RecordComposition *compo = (Z_RecordComposition *)
1596             odr_malloc(c->odr_out, sizeof(*compo));
1597
1598         esn->which = Z_ElementSetNames_generic;
1599         esn->u.generic = odr_strdup(c->odr_out, elementSetName);
1600         compo->which = Z_RecordComp_simple;
1601         compo->u.simple = esn;
1602         req->recordComposition = compo;
1603     }
1604     req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1605     return send_APDU(c, apdu);
1606 }
1607
1608 static zoom_ret send_Z3950_sort_present(ZOOM_connection c)
1609 {
1610     zoom_ret r = zoom_complete;
1611
1612     if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
1613         r = send_Z3950_sort(c, c->tasks->u.search.resultset);
1614     if (r == zoom_complete)
1615         r = send_Z3950_present(c);
1616     return r;
1617 }
1618
1619 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu)
1620 {
1621     Z_InitResponse *initrs;
1622
1623     ZOOM_connection_set_mask(c, 0);
1624     yaz_log(c->log_details, "%p handle_Z3950_apdu apdu->which=%d",
1625             c, apdu->which);
1626     switch (apdu->which)
1627     {
1628     case Z_APDU_initResponse:
1629         yaz_log(c->log_api, "%p handle_Z3950_apdu: Received Init response", c);
1630         initrs = apdu->u.initResponse;
1631         ZOOM_connection_option_set(c, "serverImplementationId",
1632                                    initrs->implementationId ?
1633                                    initrs->implementationId : "");
1634         ZOOM_connection_option_set(c, "serverImplementationName",
1635                                    initrs->implementationName ?
1636                                    initrs->implementationName : "");
1637         ZOOM_connection_option_set(c, "serverImplementationVersion",
1638                                    initrs->implementationVersion ?
1639                                    initrs->implementationVersion : "");
1640         /* Set the three old options too, for old applications */
1641         ZOOM_connection_option_set(c, "targetImplementationId",
1642                                    initrs->implementationId ?
1643                                    initrs->implementationId : "");
1644         ZOOM_connection_option_set(c, "targetImplementationName",
1645                                    initrs->implementationName ?
1646                                    initrs->implementationName : "");
1647         ZOOM_connection_option_set(c, "targetImplementationVersion",
1648                                    initrs->implementationVersion ?
1649                                    initrs->implementationVersion : "");
1650
1651         /* Make initrs->options available as ZOOM-level options */
1652         yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
1653
1654         if (!*initrs->result)
1655         {
1656             Z_DefaultDiagFormat *df = yaz_decode_init_diag(0, initrs);
1657             if (df)
1658                 response_default_diag(c, df);
1659             else
1660                 ZOOM_set_error(c, ZOOM_ERROR_INIT, 0); /* default error */
1661         }
1662         else
1663         {
1664             char *cookie =
1665                 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
1666                                       yaz_oid_userinfo_cookie, 1, 0);
1667             xfree(c->cookie_in);
1668             c->cookie_in = 0;
1669             if (cookie)
1670                 c->cookie_in = xstrdup(cookie);
1671             if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1672                 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1673                 c->support_named_resultsets = 1;
1674             if (c->tasks)
1675             {
1676                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1677                 ZOOM_connection_remove_task(c);
1678             }
1679             ZOOM_connection_exec_task(c);
1680         }
1681         if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
1682         {
1683             NMEM tmpmem = nmem_create();
1684             Z_CharSetandLanguageNegotiation *p =
1685                 yaz_get_charneg_record(initrs->otherInfo);
1686
1687             if (p)
1688             {
1689                 char *charset = NULL, *lang = NULL;
1690                 int sel;
1691
1692                 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
1693                 yaz_log(c->log_details, "%p handle_Z3950_apdu target accepted: "
1694                         "charset %s, language %s, select %d",
1695                         c,
1696                         charset ? charset : "none", lang ? lang : "none", sel);
1697                 if (charset)
1698                     ZOOM_connection_option_set(c, "negotiation-charset",
1699                                                charset);
1700                 if (lang)
1701                     ZOOM_connection_option_set(c, "negotiation-lang",
1702                                                lang);
1703
1704                 ZOOM_connection_option_set(
1705                     c,  "negotiation-charset-in-effect-for-records",
1706                     (sel != 0) ? "1" : "0");
1707                 nmem_destroy(tmpmem);
1708             }
1709         }
1710         break;
1711     case Z_APDU_searchResponse:
1712         yaz_log(c->log_api, "%p handle_Z3950_apdu Search response", c);
1713         handle_Z3950_search_response(c, apdu->u.searchResponse);
1714         if (send_Z3950_sort_present(c) == zoom_complete)
1715             ZOOM_connection_remove_task(c);
1716         break;
1717     case Z_APDU_presentResponse:
1718         yaz_log(c->log_api, "%p handle_Z3950_apdu Present response", c);
1719         handle_Z3950_present_response(c, apdu->u.presentResponse);
1720         if (send_Z3950_present(c) == zoom_complete)
1721             ZOOM_connection_remove_task(c);
1722         break;
1723     case Z_APDU_sortResponse:
1724         yaz_log(c->log_api, "%p handle_Z3950_apdu Sort response", c);
1725         handle_Z3950_sort_response(c, apdu->u.sortResponse);
1726         if (send_Z3950_present(c) == zoom_complete)
1727             ZOOM_connection_remove_task(c);
1728         break;
1729     case Z_APDU_scanResponse:
1730         yaz_log(c->log_api, "%p handle_Z3950_apdu Scan response", c);
1731         handle_Z3950_scan_response(c, apdu->u.scanResponse);
1732         ZOOM_connection_remove_task(c);
1733         break;
1734     case Z_APDU_extendedServicesResponse:
1735         yaz_log(c->log_api, "%p handle_Z3950_apdu Extended Services response", c);
1736         handle_Z3950_es_response(c, apdu->u.extendedServicesResponse);
1737         ZOOM_connection_remove_task(c);
1738         break;
1739     case Z_APDU_close:
1740         yaz_log(c->log_api, "%p handle_Z3950_apdu Close PDU", c);
1741         if (!ZOOM_test_reconnect(c))
1742         {
1743             ZOOM_set_dset_error(c, ZOOM_ERROR_CONNECTION_LOST, "ZOOM", c->host_port, apdu->u.close->diagnosticInformation);
1744             ZOOM_connection_close(c);
1745         }
1746         break;
1747     default:
1748         yaz_log(c->log_api, "%p Received unknown PDU", c);
1749         ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1750         ZOOM_connection_close(c);
1751     }
1752 }
1753
1754 /*
1755  * Local variables:
1756  * c-basic-offset: 4
1757  * c-file-style: "Stroustrup"
1758  * indent-tabs-mode: nil
1759  * End:
1760  * vim: shiftwidth=4 tabstop=8 expandtab
1761  */
1762