src/zoom-z3950.c

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