src/zoom-c.c

   1 /*
   2  * Copyright (C) 1995-2007, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: zoom-c.c,v 1.117 2007-03-19 14:40:07 adam Exp $
   6  */
   7 /**
   8  * \file zoom-c.c
   9  * \brief Implements ZOOM C interface.
  10  */
  11
  12 #include <assert.h>
  13 #include <string.h>
  14 #include <errno.h>
  15 #include "zoom-p.h"
  16
  17 #include <yaz/yaz-util.h>
  18 #include <yaz/xmalloc.h>
  19 #include <yaz/otherinfo.h>
  20 #include <yaz/log.h>
  21 #include <yaz/pquery.h>
  22 #include <yaz/marcdisp.h>
  23 #include <yaz/diagbib1.h>
  24 #include <yaz/charneg.h>
  25 #include <yaz/ill.h>
  26 #include <yaz/srw.h>
  27 #include <yaz/cql.h>
  28 #include <yaz/ccl.h>
  29
  30 #define TASK_FIX 1
  31
  32 static int log_api = 0;
  33 static int log_details = 0;
  34
  35 typedef enum {
  36     zoom_pending,
  37     zoom_complete
  38 } zoom_ret;
  39
  40 static void resultset_destroy(ZOOM_resultset r);
  41 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
  42 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
  43 static char *cql2pqf(ZOOM_connection c, const char *cql);
  44
  45
  46 /*
  47  * This wrapper is just for logging failed lookups.  It would be nicer
  48  * if it could cause failure when a lookup fails, but that's hard.
  49  */
  50 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
  51                                          int oid_class, const char *str) {
  52     Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
  53     if (res == 0)
  54         yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
  55                 c, (int) oid_class, str);
  56     return res;
  57 }
  58
  59
  60 static void initlog(void)
  61 {
  62     static int log_level_initialized = 0;
  63     if (!log_level_initialized)
  64     {
  65         log_api = yaz_log_module_level("zoom");
  66         log_details = yaz_log_module_level("zoomdetails");
  67         log_level_initialized = 1;
  68     }
  69 }
  70
  71 static ZOOM_Event ZOOM_Event_create(int kind)
  72 {
  73     ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
  74     event->kind = kind;
  75     event->next = 0;
  76     event->prev = 0;
  77     yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
  78     return event;
  79 }
  80
  81 static void ZOOM_Event_destroy(ZOOM_Event event)
  82 {
  83     xfree(event);
  84 }
  85
  86 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
  87 {
  88     if (c->m_queue_back)
  89     {
  90         c->m_queue_back->prev = event;
  91         assert(c->m_queue_front);
  92     }
  93     else
  94     {
  95         assert(!c->m_queue_front);
  96         c->m_queue_front = event;
  97     }
  98     event->next = c->m_queue_back;
  99     event->prev = 0;
 100     c->m_queue_back = event;
 101 }
 102
 103 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
 104 {
 105     ZOOM_Event event = c->m_queue_front;
 106     if (!event)
 107     {
 108         c->last_event = ZOOM_EVENT_NONE;
 109         return 0;
 110     }
 111     assert(c->m_queue_back);
 112     c->m_queue_front = event->prev;
 113     if (c->m_queue_front)
 114     {
 115         assert(c->m_queue_back);
 116         c->m_queue_front->next = 0;
 117     }
 118     else
 119         c->m_queue_back = 0;
 120     c->last_event = event->kind;
 121     return event;
 122 }
 123
 124 static void ZOOM_connection_remove_events(ZOOM_connection c)
 125 {
 126     ZOOM_Event event;
 127     while ((event = ZOOM_connection_get_event(c)))
 128         ZOOM_Event_destroy(event);
 129 }
 130
 131 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
 132 {
 133     ZOOM_Event event = c->m_queue_front;
 134
 135     return event ? event->kind : ZOOM_EVENT_NONE;
 136 }
 137
 138 void ZOOM_connection_remove_tasks(ZOOM_connection c);
 139
 140 static void set_dset_error(ZOOM_connection c, int error,
 141                            const char *dset,
 142                            const char *addinfo, const char *addinfo2)
 143 {
 144     char *cp;
 145
 146     xfree(c->addinfo);
 147     c->addinfo = 0;
 148     c->error = error;
 149     if (!c->diagset || strcmp(dset, c->diagset))
 150     {
 151         xfree(c->diagset);
 152         c->diagset = xstrdup(dset);
 153         /* remove integer part from SRW diagset .. */
 154         if ((cp = strrchr(c->diagset, '/')))
 155             *cp = '\0';
 156     }
 157     if (addinfo && addinfo2)
 158     {
 159         c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
 160         strcpy(c->addinfo, addinfo);
 161         strcat(c->addinfo, addinfo2);
 162     }
 163     else if (addinfo)
 164         c->addinfo = xstrdup(addinfo);
 165     if (error != ZOOM_ERROR_NONE)
 166     {
 167         yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
 168                 c, c->host_port ? c->host_port : "<>", dset, error,
 169                 addinfo ? addinfo : "",
 170                 addinfo2 ? addinfo2 : "");
 171 #if TASK_FIX
 172         ZOOM_connection_remove_tasks(c);
 173 #endif
 174     }
 175 }
 176
 177 #if YAZ_HAVE_XML2
 178 static void set_HTTP_error(ZOOM_connection c, int error,
 179                            const char *addinfo, const char *addinfo2)
 180 {
 181     set_dset_error(c, error, "HTTP", addinfo, addinfo2);
 182 }
 183 #endif
 184
 185
 186 static void set_ZOOM_error(ZOOM_connection c, int error,
 187                            const char *addinfo)
 188 {
 189     set_dset_error(c, error, "ZOOM", addinfo, 0);
 190 }
 191
 192 static void clear_error(ZOOM_connection c)
 193 {
 194     /*
 195      * If an error is tied to an operation then it's ok to clear: for
 196      * example, a diagnostic returned from a search is cleared by a
 197      * subsequent search.  However, problems such as Connection Lost
 198      * or Init Refused are not cleared, because they are not
 199      * recoverable: doing another search doesn't help.
 200      */
 201
 202     ZOOM_connection_remove_events(c);
 203     switch (c->error)
 204     {
 205     case ZOOM_ERROR_CONNECT:
 206     case ZOOM_ERROR_MEMORY:
 207     case ZOOM_ERROR_DECODE:
 208     case ZOOM_ERROR_CONNECTION_LOST:
 209     case ZOOM_ERROR_INIT:
 210     case ZOOM_ERROR_INTERNAL:
 211     case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
 212         break;
 213     default:
 214         set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
 215     }
 216 }
 217
 218 void ZOOM_connection_show_task(ZOOM_task task)
 219 {
 220     switch(task->which)
 221     {
 222     case ZOOM_TASK_SEARCH:
 223         yaz_log(YLOG_LOG, "search p=%p", task);
 224         break;
 225     case ZOOM_TASK_RETRIEVE:
 226         yaz_log(YLOG_LOG, "retrieve p=%p", task);
 227         break;
 228     case ZOOM_TASK_CONNECT:
 229         yaz_log(YLOG_LOG, "connect p=%p", task);
 230         break;
 231     case ZOOM_TASK_SCAN:
 232         yaz_log(YLOG_LOG, "scant p=%p", task);
 233         break;
 234     }
 235 }
 236
 237 void ZOOM_connection_show_tasks(ZOOM_connection c)
 238 {
 239     ZOOM_task task;
 240     yaz_log(YLOG_LOG, "connection p=%p tasks", c);
 241     for (task = c->tasks; task; task = task->next)
 242         ZOOM_connection_show_task(task);
 243 }
 244
 245 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
 246 {
 247     ZOOM_task *taskp = &c->tasks;
 248     while (*taskp)
 249         taskp = &(*taskp)->next;
 250     *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
 251     (*taskp)->running = 0;
 252     (*taskp)->which = which;
 253     (*taskp)->next = 0;
 254     clear_error(c);
 255     return *taskp;
 256 }
 257
 258 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
 259 {
 260     return c->tasks ? 0 : 1;
 261 }
 262
 263 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
 264 {
 265     ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
 266
 267     task->next = c->tasks;
 268     c->tasks = task;
 269
 270     task->running = 0;
 271     task->which = which;
 272     clear_error(c);
 273     return task;
 274 }
 275
 276 void ZOOM_connection_remove_task(ZOOM_connection c)
 277 {
 278     ZOOM_task task = c->tasks;
 279
 280     if (task)
 281     {
 282         c->tasks = task->next;
 283         switch (task->which)
 284         {
 285         case ZOOM_TASK_SEARCH:
 286             resultset_destroy(task->u.search.resultset);
 287             xfree(task->u.search.syntax);
 288             xfree(task->u.search.elementSetName);
 289             break;
 290         case ZOOM_TASK_RETRIEVE:
 291             resultset_destroy(task->u.retrieve.resultset);
 292             xfree(task->u.retrieve.syntax);
 293             xfree(task->u.retrieve.elementSetName);
 294             break;
 295         case ZOOM_TASK_CONNECT:
 296             break;
 297         case ZOOM_TASK_SCAN:
 298             ZOOM_scanset_destroy(task->u.scan.scan);
 299             break;
 300         case ZOOM_TASK_PACKAGE:
 301             ZOOM_package_destroy(task->u.package);
 302             break;
 303         case ZOOM_TASK_SORT:
 304             resultset_destroy(task->u.sort.resultset);
 305             ZOOM_query_destroy(task->u.sort.q);
 306             break;
 307         default:
 308             assert(0);
 309         }
 310         xfree(task);
 311
 312         if (!c->tasks)
 313         {
 314             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
 315             ZOOM_connection_put_event(c, event);
 316         }
 317     }
 318 }
 319
 320 static int ZOOM_connection_exec_task(ZOOM_connection c);
 321
 322 void ZOOM_connection_remove_tasks(ZOOM_connection c)
 323 {
 324     while (c->tasks)
 325         ZOOM_connection_remove_task(c);
 326 }
 327
 328 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
 329                                        const char *syntax,
 330                                        const char *elementSetName);
 331
 332 ZOOM_API(ZOOM_connection)
 333     ZOOM_connection_create(ZOOM_options options)
 334 {
 335     ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
 336
 337     initlog();
 338
 339     yaz_log(log_api, "%p ZOOM_connection_create", c);
 340
 341     c->proto = PROTO_Z3950;
 342     c->cs = 0;
 343     ZOOM_connection_set_mask(c, 0);
 344     c->reconnect_ok = 0;
 345     c->state = STATE_IDLE;
 346     c->addinfo = 0;
 347     c->diagset = 0;
 348     set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
 349     c->buf_in = 0;
 350     c->len_in = 0;
 351     c->buf_out = 0;
 352     c->len_out = 0;
 353     c->resultsets = 0;
 354
 355     c->options = ZOOM_options_create_with_parent(options);
 356
 357     c->host_port = 0;
 358     c->path = 0;
 359     c->proxy = 0;
 360
 361     c->charset = c->lang = 0;
 362
 363     c->cookie_out = 0;
 364     c->cookie_in = 0;
 365     c->client_IP = 0;
 366     c->tasks = 0;
 367
 368     c->odr_in = odr_createmem(ODR_DECODE);
 369     c->odr_out = odr_createmem(ODR_ENCODE);
 370
 371     c->async = 0;
 372     c->support_named_resultsets = 0;
 373     c->last_event = ZOOM_EVENT_NONE;
 374
 375     c->m_queue_front = 0;
 376     c->m_queue_back = 0;
 377     return c;
 378 }
 379
 380
 381 /* set database names. Take local databases (if set); otherwise
 382    take databases given in ZURL (if set); otherwise use Default */
 383 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
 384                                 int *num, ODR odr)
 385 {
 386     char **databaseNames;
 387     const char *cp = ZOOM_options_get(options, "databaseName");
 388
 389     if ((!cp || !*cp) && con->host_port)
 390     {
 391         if (strncmp(con->host_port, "unix:", 5) == 0)
 392             cp = strchr(con->host_port+5, ':');
 393         else
 394             cp = strchr(con->host_port, '/');
 395         if (cp)
 396             cp++;
 397     }
 398     if (!cp)
 399         cp = "Default";
 400     nmem_strsplit(odr->mem, "+", cp,  &databaseNames, num);
 401     return databaseNames;
 402 }
 403
 404 ZOOM_API(ZOOM_connection)
 405     ZOOM_connection_new(const char *host, int portnum)
 406 {
 407     ZOOM_connection c = ZOOM_connection_create(0);
 408
 409     ZOOM_connection_connect(c, host, portnum);
 410     return c;
 411 }
 412
 413 static zoom_sru_mode get_sru_mode_from_string(const char *s)
 414 {
 415     if (!s || !*s)
 416         return zoom_sru_soap;
 417     if (!yaz_matchstr(s, "soap"))
 418         return zoom_sru_soap;
 419     else if (!yaz_matchstr(s, "get"))
 420         return zoom_sru_get;
 421     else if (!yaz_matchstr(s, "post"))
 422         return zoom_sru_post;
 423     return zoom_sru_error;
 424 }
 425
 426 ZOOM_API(void)
 427     ZOOM_connection_connect(ZOOM_connection c,
 428                             const char *host, int portnum)
 429 {
 430     const char *val;
 431     ZOOM_task task;
 432
 433     initlog();
 434
 435     yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
 436             c, host ? host : "null", portnum);
 437
 438     set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
 439     ZOOM_connection_remove_tasks(c);
 440
 441     if (c->cs)
 442     {
 443         yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
 444         c->reconnect_ok = 1;
 445         return;
 446     }
 447     yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
 448     xfree(c->proxy);
 449     val = ZOOM_options_get(c->options, "proxy");
 450     if (val && *val)
 451     {
 452         yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
 453         c->proxy = xstrdup(val);
 454     }
 455     else
 456         c->proxy = 0;
 457
 458     xfree(c->charset);
 459     val = ZOOM_options_get(c->options, "charset");
 460     if (val && *val)
 461     {
 462         yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
 463         c->charset = xstrdup(val);
 464     }
 465     else
 466         c->charset = 0;
 467
 468     xfree(c->lang);
 469     val = ZOOM_options_get(c->options, "lang");
 470     if (val && *val)
 471     {
 472         yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
 473         c->lang = xstrdup(val);
 474     }
 475     else
 476         c->lang = 0;
 477
 478     if (host)
 479     {
 480         xfree(c->host_port);
 481         if (portnum)
 482         {
 483             char hostn[128];
 484             sprintf(hostn, "%.80s:%d", host, portnum);
 485             c->host_port = xstrdup(hostn);
 486         }
 487         else
 488             c->host_port = xstrdup(host);
 489     }
 490
 491     {
 492         /*
 493          * If the "<scheme>:" part of the host string is preceded by one
 494          * or more comma-separated <name>=<value> pairs, these are taken
 495          * to be options to be set on the connection object.  Among other
 496          * applications, this facility can be used to embed authentication
 497          * in a host string:
 498          *          user=admin,password=secret,tcp:localhost:9999
 499          */
 500         char *remainder = c->host_port;
 501         char *pcolon = strchr(remainder, ':');
 502         char *pcomma;
 503         char *pequals;
 504         while ((pcomma = strchr(remainder, ',')) != 0 &&
 505                (pcolon == 0 || pcomma < pcolon)) {
 506             *pcomma = '\0';
 507             if ((pequals = strchr(remainder, '=')) != 0) {
 508                 *pequals = '\0';
 509                 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
 510                 ZOOM_connection_option_set(c, remainder, pequals+1);
 511             }
 512             remainder = pcomma+1;
 513         }
 514
 515         if (remainder != c->host_port) {
 516             xfree(c->host_port);
 517             c->host_port = xstrdup(remainder);
 518             /*printf("# reset hp='%s'\n", remainder);*/
 519         }
 520     }
 521
 522     val = ZOOM_options_get(c->options, "sru");
 523     c->sru_mode = get_sru_mode_from_string(val);
 524
 525     ZOOM_options_set(c->options, "host", c->host_port);
 526
 527     val = ZOOM_options_get(c->options, "cookie");
 528     if (val && *val)
 529     {
 530         yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
 531         c->cookie_out = xstrdup(val);
 532     }
 533
 534     val = ZOOM_options_get(c->options, "clientIP");
 535     if (val && *val)
 536     {
 537         yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
 538                 c, val);
 539         c->client_IP = xstrdup(val);
 540     }
 541
 542     c->async = ZOOM_options_get_bool(c->options, "async", 0);
 543     yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
 544
 545     task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
 546
 547     if (!c->async)
 548     {
 549         while (ZOOM_event(1, &c))
 550             ;
 551     }
 552 }
 553
 554 ZOOM_API(ZOOM_query)
 555     ZOOM_query_create(void)
 556 {
 557     ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
 558
 559     yaz_log(log_details, "%p ZOOM_query_create", s);
 560     s->refcount = 1;
 561     s->z_query = 0;
 562     s->sort_spec = 0;
 563     s->odr = odr_createmem(ODR_ENCODE);
 564     s->query_string = 0;
 565
 566     return s;
 567 }
 568
 569 ZOOM_API(void)
 570     ZOOM_query_destroy(ZOOM_query s)
 571 {
 572     if (!s)
 573         return;
 574
 575     (s->refcount)--;
 576     yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
 577     if (s->refcount == 0)
 578     {
 579         odr_destroy(s->odr);
 580         xfree(s);
 581     }
 582 }
 583
 584 ZOOM_API(int)
 585     ZOOM_query_prefix(ZOOM_query s, const char *str)
 586 {
 587     s->query_string = odr_strdup(s->odr, str);
 588     s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
 589     s->z_query->which = Z_Query_type_1;
 590     s->z_query->u.type_1 =  p_query_rpn(s->odr, PROTO_Z3950, str);
 591     if (!s->z_query->u.type_1)
 592     {
 593         yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
 594         s->z_query = 0;
 595         return -1;
 596     }
 597     yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
 598     return 0;
 599 }
 600
 601 ZOOM_API(int)
 602     ZOOM_query_cql(ZOOM_query s, const char *str)
 603 {
 604     Z_External *ext;
 605
 606     s->query_string = odr_strdup(s->odr, str);
 607
 608     ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
 609     ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
 610     ext->indirect_reference = 0;
 611     ext->descriptor = 0;
 612     ext->which = Z_External_CQL;
 613     ext->u.cql = s->query_string;
 614
 615     s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
 616     s->z_query->which = Z_Query_type_104;
 617     s->z_query->u.type_104 =  ext;
 618
 619     yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
 620
 621     return 0;
 622 }
 623
 624 /*
 625  * Translate the CQL string client-side into RPN which is passed to
 626  * the server.  This is useful for server's that don't themselves
 627  * support CQL, for which ZOOM_query_cql() is useless.  `conn' is used
 628  * only as a place to stash diagnostics if compilation fails; if this
 629  * information is not needed, a null pointer may be used.
 630  */
 631 ZOOM_API(int)
 632     ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 633 {
 634     char *rpn;
 635     int ret;
 636     ZOOM_connection freeme = 0;
 637
 638     yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
 639     if (conn == 0)
 640         conn = freeme = ZOOM_connection_create(0);
 641
 642     rpn = cql2pqf(conn, str);
 643     if (freeme != 0)
 644         ZOOM_connection_destroy(freeme);
 645     if (rpn == 0)
 646         return -1;
 647
 648     ret = ZOOM_query_prefix(s, rpn);
 649     xfree(rpn);
 650     return ret;
 651 }
 652
 653 /*
 654  * Analogous in every way to ZOOM_query_cql2rpn(), except that there
 655  * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
 656  * to the server, as the YAZ GFS doesn't know how to handle this.
 657  */
 658 ZOOM_API(int)
 659     ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
 660                        int *ccl_error, const char **error_string,
 661                        int *error_pos)
 662 {
 663     int ret;
 664     struct ccl_rpn_node *rpn;
 665     CCL_bibset bibset = ccl_qual_mk();
 666
 667     if (config)
 668         ccl_qual_buf(bibset, config);
 669
 670     rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
 671     if (!rpn)
 672     {
 673         *error_string = ccl_err_msg(*ccl_error);
 674         ret = -1;
 675     }
 676     else
 677     {
 678         WRBUF wr = wrbuf_alloc();
 679         ccl_pquery(wr, rpn);
 680         ccl_rpn_delete(rpn);
 681         ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
 682         wrbuf_destroy(wr);
 683     }
 684     ccl_qual_rm(&bibset);
 685     return ret;
 686 }
 687
 688 ZOOM_API(int)
 689     ZOOM_query_sortby(ZOOM_query s, const char *criteria)
 690 {
 691     s->sort_spec = yaz_sort_spec(s->odr, criteria);
 692     if (!s->sort_spec)
 693     {
 694         yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
 695                 s, criteria);
 696         return -1;
 697     }
 698     yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
 699     return 0;
 700 }
 701
 702 static zoom_ret do_write(ZOOM_connection c);
 703
 704 ZOOM_API(void)
 705     ZOOM_connection_destroy(ZOOM_connection c)
 706 {
 707     ZOOM_resultset r;
 708     if (!c)
 709         return;
 710     yaz_log(log_api, "%p ZOOM_connection_destroy", c);
 711     if (c->cs)
 712         cs_close(c->cs);
 713     for (r = c->resultsets; r; r = r->next)
 714         r->connection = 0;
 715
 716     xfree(c->buf_in);
 717     xfree(c->addinfo);
 718     xfree(c->diagset);
 719     odr_destroy(c->odr_in);
 720     odr_destroy(c->odr_out);
 721     ZOOM_options_destroy(c->options);
 722     ZOOM_connection_remove_tasks(c);
 723     ZOOM_connection_remove_events(c);
 724     xfree(c->host_port);
 725     xfree(c->path);
 726     xfree(c->proxy);
 727     xfree(c->charset);
 728     xfree(c->lang);
 729     xfree(c->cookie_out);
 730     xfree(c->cookie_in);
 731     xfree(c->client_IP);
 732     xfree(c);
 733 }
 734
 735 void ZOOM_resultset_addref(ZOOM_resultset r)
 736 {
 737     if (r)
 738     {
 739         (r->refcount)++;
 740         yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
 741                 r, r->refcount);
 742     }
 743 }
 744
 745 ZOOM_resultset ZOOM_resultset_create(void)
 746 {
 747     int i;
 748     ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
 749
 750     initlog();
 751
 752     yaz_log(log_details, "%p ZOOM_resultset_create", r);
 753     r->refcount = 1;
 754     r->size = 0;
 755     r->odr = odr_createmem(ODR_ENCODE);
 756     r->piggyback = 1;
 757     r->setname = 0;
 758     r->schema = 0;
 759     r->step = 0;
 760     for (i = 0; i<RECORD_HASH_SIZE; i++)
 761         r->record_hash[i] = 0;
 762     r->r_sort_spec = 0;
 763     r->query = 0;
 764     r->connection = 0;
 765     r->next = 0;
 766     r->databaseNames = 0;
 767     r->num_databaseNames = 0;
 768     return r;
 769 }
 770
 771 ZOOM_API(ZOOM_resultset)
 772     ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
 773 {
 774     ZOOM_resultset r;
 775     ZOOM_query s = ZOOM_query_create();
 776
 777     ZOOM_query_prefix(s, q);
 778
 779     r = ZOOM_connection_search(c, s);
 780     ZOOM_query_destroy(s);
 781     return r;
 782 }
 783
 784 ZOOM_API(ZOOM_resultset)
 785     ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
 786 {
 787     ZOOM_resultset r = ZOOM_resultset_create();
 788     ZOOM_task task;
 789     const char *cp;
 790     int start, count;
 791     const char *syntax, *elementSetName;
 792
 793     yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
 794     r->r_sort_spec = q->sort_spec;
 795     r->query = q;
 796
 797     r->options = ZOOM_options_create_with_parent(c->options);
 798
 799     start = ZOOM_options_get_int(r->options, "start", 0);
 800     count = ZOOM_options_get_int(r->options, "count", 0);
 801     {
 802         /* If "presentChunk" is defined use that; otherwise "step" */
 803         const char *cp = ZOOM_options_get(r->options, "presentChunk");
 804         r->step = ZOOM_options_get_int(r->options,
 805                                        (cp != 0 ? "presentChunk": "step"), 0);
 806     }
 807     r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
 808     cp = ZOOM_options_get(r->options, "setname");
 809     if (cp)
 810         r->setname = xstrdup(cp);
 811     cp = ZOOM_options_get(r->options, "schema");
 812     if (cp)
 813         r->schema = xstrdup(cp);
 814
 815     r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
 816                                          r->odr);
 817
 818     r->connection = c;
 819
 820     r->next = c->resultsets;
 821     c->resultsets = r;
 822
 823     if (c->host_port && c->proto == PROTO_HTTP)
 824     {
 825         if (!c->cs)
 826         {
 827             yaz_log(log_details, "ZOOM_connection_search: no comstack");
 828             ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
 829         }
 830         else
 831         {
 832             yaz_log(log_details, "ZOOM_connection_search: reconnect");
 833             c->reconnect_ok = 1;
 834         }
 835     }
 836
 837     task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
 838     task->u.search.resultset = r;
 839     task->u.search.start = start;
 840     task->u.search.count = count;
 841
 842     syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
 843     task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
 844     elementSetName = ZOOM_options_get(r->options, "elementSetName");
 845     task->u.search.elementSetName = elementSetName
 846         ? xstrdup(elementSetName) : 0;
 847
 848     ZOOM_resultset_addref(r);
 849
 850     (q->refcount)++;
 851
 852     if (!c->async)
 853     {
 854         while (ZOOM_event(1, &c))
 855             ;
 856     }
 857     return r;
 858 }
 859
 860 /*
 861  * This is the old result-set sorting API, which is maintained only
 862  * for the sake of binary compatibility.  There is no reason ever to
 863  * use this rather than ZOOM_resultset_sort1().
 864  */
 865 ZOOM_API(void)
 866     ZOOM_resultset_sort(ZOOM_resultset r,
 867                         const char *sort_type, const char *sort_spec)
 868 {
 869     (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
 870 }
 871
 872 ZOOM_API(int)
 873     ZOOM_resultset_sort1(ZOOM_resultset r,
 874                          const char *sort_type, const char *sort_spec)
 875 {
 876     ZOOM_connection c = r->connection;
 877     ZOOM_task task;
 878     ZOOM_query newq;
 879
 880     newq = ZOOM_query_create();
 881     if (ZOOM_query_sortby(newq, sort_spec) < 0)
 882         return -1;
 883
 884     yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
 885             r, r, sort_type, sort_spec);
 886     if (!c)
 887         return 0;
 888
 889     if (c->host_port && c->proto == PROTO_HTTP)
 890     {
 891         if (!c->cs)
 892         {
 893             yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
 894             ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
 895         }
 896         else
 897         {
 898             yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
 899                     r);
 900             c->reconnect_ok = 1;
 901         }
 902     }
 903
 904     ZOOM_resultset_cache_reset(r);
 905     task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
 906     task->u.sort.resultset = r;
 907     task->u.sort.q = newq;
 908
 909     ZOOM_resultset_addref(r);
 910
 911     if (!c->async)
 912     {
 913         while (ZOOM_event(1, &c))
 914             ;
 915     }
 916
 917     return 0;
 918 }
 919
 920 ZOOM_API(void)
 921     ZOOM_resultset_cache_reset(ZOOM_resultset r)
 922 {
 923     int i;
 924     for (i = 0; i<RECORD_HASH_SIZE; i++)
 925     {
 926         ZOOM_record_cache rc;
 927         for (rc = r->record_hash[i]; rc; rc = rc->next)
 928         {
 929             if (rc->rec.wrbuf_marc)
 930                 wrbuf_destroy(rc->rec.wrbuf_marc);
 931             if (rc->rec.wrbuf_iconv)
 932                 wrbuf_destroy(rc->rec.wrbuf_iconv);
 933             if (rc->rec.wrbuf_opac)
 934                 wrbuf_destroy(rc->rec.wrbuf_opac);
 935         }
 936         r->record_hash[i] = 0;
 937     }
 938 }
 939
 940 ZOOM_API(void)
 941     ZOOM_resultset_destroy(ZOOM_resultset r)
 942 {
 943     resultset_destroy(r);
 944 }
 945
 946 static void resultset_destroy(ZOOM_resultset r)
 947 {
 948     if (!r)
 949         return;
 950     (r->refcount)--;
 951     yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
 952             r, r, r->refcount);
 953     if (r->refcount == 0)
 954     {
 955         ZOOM_resultset_cache_reset(r);
 956
 957         if (r->connection)
 958         {
 959             /* remove ourselves from the resultsets in connection */
 960             ZOOM_resultset *rp = &r->connection->resultsets;
 961             while (1)
 962             {
 963                 assert(*rp);   /* we must be in this list!! */
 964                 if (*rp == r)
 965                 {   /* OK, we're here - take us out of it */
 966                     *rp = (*rp)->next;
 967                     break;
 968                 }
 969                 rp = &(*rp)->next;
 970             }
 971         }
 972         ZOOM_query_destroy(r->query);
 973         ZOOM_options_destroy(r->options);
 974         odr_destroy(r->odr);
 975         xfree(r->setname);
 976         xfree(r->schema);
 977         xfree(r);
 978     }
 979 }
 980
 981 ZOOM_API(size_t)
 982     ZOOM_resultset_size(ZOOM_resultset r)
 983 {
 984     yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
 985             r, r->size);
 986     return r->size;
 987 }
 988
 989 static void do_close(ZOOM_connection c)
 990 {
 991     if (c->cs)
 992         cs_close(c->cs);
 993     c->cs = 0;
 994     ZOOM_connection_set_mask(c, 0);
 995     c->state = STATE_IDLE;
 996 }
 997
 998 static int ZOOM_test_reconnect(ZOOM_connection c)
 999 {
1000     ZOOM_Event event;
1001
1002     if (!c->reconnect_ok)
1003         return 0;
1004     do_close(c);
1005     c->reconnect_ok = 0;
1006     c->tasks->running = 0;
1007     ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1008
1009     event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1010     ZOOM_connection_put_event(c, event);
1011
1012     return 1;
1013 }
1014
1015 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1016                                     int force_sync, int start, int count)
1017 {
1018     ZOOM_task task;
1019     ZOOM_connection c;
1020     const char *cp;
1021     const char *syntax, *elementSetName;
1022
1023     if (!r)
1024         return;
1025     yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1026             " count=%d", r, force_sync, start, count);
1027     c = r->connection;
1028     if (!c)
1029         return;
1030
1031     if (c->host_port && c->proto == PROTO_HTTP)
1032     {
1033         if (!c->cs)
1034         {
1035             yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1036             ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1037         }
1038         else
1039         {
1040             yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1041                     "reconnect", r);
1042             c->reconnect_ok = 1;
1043         }
1044     }
1045     task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1046     task->u.retrieve.resultset = r;
1047     task->u.retrieve.start = start;
1048     task->u.retrieve.count = count;
1049
1050     syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1051     task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1052     elementSetName = ZOOM_options_get(r->options, "elementSetName");
1053     task->u.retrieve.elementSetName = elementSetName
1054         ? xstrdup(elementSetName) : 0;
1055
1056     cp = ZOOM_options_get(r->options, "schema");
1057     if (cp)
1058     {
1059         if (!r->schema || strcmp(r->schema, cp))
1060         {
1061             xfree(r->schema);
1062             r->schema = xstrdup(cp);
1063         }
1064     }
1065
1066     ZOOM_resultset_addref(r);
1067
1068     if (!r->connection->async || force_sync)
1069         while (r->connection && ZOOM_event(1, &r->connection))
1070             ;
1071 }
1072
1073 ZOOM_API(void)
1074     ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1075                            size_t start, size_t count)
1076 {
1077     int force_present = 0;
1078
1079     if (!r)
1080         return ;
1081     yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1082             r, r, (long) start, (long) count);
1083     if (count && recs)
1084         force_present = 1;
1085     ZOOM_resultset_retrieve(r, force_present, start, count);
1086     if (force_present)
1087     {
1088         size_t i;
1089         for (i = 0; i< count; i++)
1090             recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1091     }
1092 }
1093
1094 static void get_cert(ZOOM_connection c)
1095 {
1096     char *cert_buf;
1097     int cert_len;
1098
1099     if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1100     {
1101         ZOOM_connection_option_setl(c, "sslPeerCert",
1102                                     cert_buf, cert_len);
1103         xfree(cert_buf);
1104     }
1105 }
1106
1107 static zoom_ret do_connect(ZOOM_connection c)
1108 {
1109     void *add;
1110     const char *effective_host;
1111
1112     if (c->proxy)
1113         effective_host = c->proxy;
1114     else
1115         effective_host = c->host_port;
1116
1117     yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1118
1119     if (c->cs)
1120         cs_close(c->cs);
1121     c->cs = cs_create_host(effective_host, 0, &add);
1122
1123     if (c->cs && c->cs->protocol == PROTO_HTTP)
1124     {
1125 #if YAZ_HAVE_XML2
1126         const char *path = 0;
1127
1128         c->proto = PROTO_HTTP;
1129         cs_get_host_args(c->host_port, &path);
1130         xfree(c->path);
1131         c->path = (char*) xmalloc(strlen(path)+2);
1132         c->path[0] = '/';
1133         strcpy(c->path+1, path);
1134 #else
1135         set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1136         do_close(c);
1137         return zoom_complete;
1138 #endif
1139     }
1140     if (c->cs)
1141     {
1142         int ret = cs_connect(c->cs, add);
1143         if (ret == 0)
1144         {
1145             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1146             ZOOM_connection_put_event(c, event);
1147             get_cert(c);
1148             if (c->proto == PROTO_Z3950)
1149                 ZOOM_connection_send_init(c);
1150             else
1151             {
1152                 /* no init request for SRW .. */
1153                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1154                 ZOOM_connection_remove_task(c);
1155                 ZOOM_connection_set_mask(c, 0);
1156                 ZOOM_connection_exec_task(c);
1157             }
1158             c->state = STATE_ESTABLISHED;
1159             return zoom_pending;
1160         }
1161         else if (ret > 0)
1162         {
1163             int mask = ZOOM_SELECT_EXCEPT;
1164             if (c->cs->io_pending & CS_WANT_WRITE)
1165                 mask += ZOOM_SELECT_WRITE;
1166             if (c->cs->io_pending & CS_WANT_READ)
1167                 mask += ZOOM_SELECT_READ;
1168             ZOOM_connection_set_mask(c, mask);
1169             c->state = STATE_CONNECTING;
1170             return zoom_pending;
1171         }
1172     }
1173     c->state = STATE_IDLE;
1174     set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1175     return zoom_complete;
1176 }
1177
1178 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1179 {
1180     int i;
1181     for (i = 0; i<200; i++)
1182     {
1183         size_t len;
1184         Z_OtherInformation **oi;
1185         char buf[80];
1186         const char *val;
1187         const char *cp;
1188         int oidval;
1189
1190         sprintf(buf, "otherInfo%d", i);
1191         val = ZOOM_options_get(c->options, buf);
1192         if (!val)
1193             break;
1194         cp = strchr(val, ':');
1195         if (!cp)
1196             continue;
1197         len = cp - val;
1198         if (len >= sizeof(buf))
1199             len = sizeof(buf)-1;
1200         memcpy(buf, val, len);
1201         buf[len] = '\0';
1202         oidval = oid_getvalbyname(buf);
1203         if (oidval == VAL_NONE)
1204             continue;
1205
1206         yaz_oi_APDU(a, &oi);
1207         yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1208     }
1209 }
1210
1211 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1212 {
1213     assert(a);
1214     if (c->cookie_out)
1215     {
1216         Z_OtherInformation **oi;
1217         yaz_oi_APDU(a, &oi);
1218         yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1219     }
1220     if (c->client_IP)
1221     {
1222         Z_OtherInformation **oi;
1223         yaz_oi_APDU(a, &oi);
1224         yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1225     }
1226     otherInfo_attach(c, a, out);
1227     if (!z_APDU(out, &a, 0, 0))
1228     {
1229         FILE *outf = fopen("/tmp/apdu.txt", "a");
1230         if (a && outf)
1231         {
1232             ODR odr_pr = odr_createmem(ODR_PRINT);
1233             fprintf(outf, "a=%p\n", a);
1234             odr_setprint(odr_pr, outf);
1235             z_APDU(odr_pr, &a, 0, 0);
1236             odr_destroy(odr_pr);
1237         }
1238         yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1239         set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1240         odr_reset(out);
1241         return -1;
1242     }
1243     yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1244     return 0;
1245 }
1246
1247 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1248 {
1249     ZOOM_Event event;
1250     assert(a);
1251     if (encode_APDU(c, a, c->odr_out))
1252         return zoom_complete;
1253     yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1254     c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1255     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1256     ZOOM_connection_put_event(c, event);
1257     odr_reset(c->odr_out);
1258     return do_write(c);
1259 }
1260
1261 /* returns 1 if PDU was sent OK (still pending )
1262    0 if PDU was not sent OK (nothing to wait for)
1263 */
1264
1265 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1266 {
1267     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1268     Z_InitRequest *ireq = apdu->u.initRequest;
1269     Z_IdAuthentication *auth = (Z_IdAuthentication *)
1270         odr_malloc(c->odr_out, sizeof(*auth));
1271     const char *auth_groupId = ZOOM_options_get(c->options, "group");
1272     const char *auth_userId = ZOOM_options_get(c->options, "user");
1273     const char *auth_password = ZOOM_options_get(c->options, "password");
1274     char *version;
1275
1276     /* support the pass for backwards compatibility */
1277     if (!auth_password)
1278         auth_password = ZOOM_options_get(c->options, "pass");
1279
1280     ODR_MASK_SET(ireq->options, Z_Options_search);
1281     ODR_MASK_SET(ireq->options, Z_Options_present);
1282     ODR_MASK_SET(ireq->options, Z_Options_scan);
1283     ODR_MASK_SET(ireq->options, Z_Options_sort);
1284     ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1285     ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1286
1287     ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1288     ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1289     ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1290
1291     /* Index Data's Z39.50 Implementor Id is 81 */
1292     ireq->implementationId =
1293         odr_prepend(c->odr_out,
1294                     ZOOM_options_get(c->options, "implementationId"),
1295                     odr_prepend(c->odr_out, "81", ireq->implementationId));
1296
1297     ireq->implementationName =
1298         odr_prepend(c->odr_out,
1299                     ZOOM_options_get(c->options, "implementationName"),
1300                     odr_prepend(c->odr_out, "ZOOM-C",
1301                                 ireq->implementationName));
1302
1303     version = odr_strdup(c->odr_out, "$Revision: 1.117 $");
1304     if (strlen(version) > 10)   /* check for unexpanded CVS strings */
1305         version[strlen(version)-2] = '\0';
1306     ireq->implementationVersion =
1307         odr_prepend(c->odr_out,
1308                     ZOOM_options_get(c->options, "implementationVersion"),
1309                     odr_prepend(c->odr_out, &version[11],
1310                                 ireq->implementationVersion));
1311
1312     *ireq->maximumRecordSize =
1313         ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1314     *ireq->preferredMessageSize =
1315         ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1316
1317     if (auth_groupId || auth_password)
1318     {
1319         Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1320         int i = 0;
1321         pass->groupId = 0;
1322         if (auth_groupId && *auth_groupId)
1323         {
1324             pass->groupId = (char *)
1325                 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1326             strcpy(pass->groupId, auth_groupId);
1327             i++;
1328         }
1329         pass->userId = 0;
1330         if (auth_userId && *auth_userId)
1331         {
1332             pass->userId = (char *)
1333                 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1334             strcpy(pass->userId, auth_userId);
1335             i++;
1336         }
1337         pass->password = 0;
1338         if (auth_password && *auth_password)
1339         {
1340             pass->password = (char *)
1341                 odr_malloc(c->odr_out, strlen(auth_password)+1);
1342             strcpy(pass->password, auth_password);
1343             i++;
1344         }
1345         if (i)
1346         {
1347             auth->which = Z_IdAuthentication_idPass;
1348             auth->u.idPass = pass;
1349             ireq->idAuthentication = auth;
1350         }
1351     }
1352     else if (auth_userId)
1353     {
1354         auth->which = Z_IdAuthentication_open;
1355         auth->u.open = (char *)
1356             odr_malloc(c->odr_out, strlen(auth_userId)+1);
1357         strcpy(auth->u.open, auth_userId);
1358         ireq->idAuthentication = auth;
1359     }
1360     if (c->proxy)
1361         yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1362                                  VAL_PROXY, 1, c->host_port);
1363     if (c->charset || c->lang)
1364     {
1365         Z_OtherInformation **oi;
1366         Z_OtherInformationUnit *oi_unit;
1367
1368         yaz_oi_APDU(apdu, &oi);
1369
1370         if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1371         {
1372             ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1373             oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1374             oi_unit->information.externallyDefinedInfo =
1375                 yaz_set_proposal_charneg_list(c->odr_out, " ",
1376                                               c->charset, c->lang, 1);
1377         }
1378     }
1379     assert(apdu);
1380     return send_APDU(c, apdu);
1381 }
1382
1383 #if YAZ_HAVE_XML2
1384 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1385 {
1386     Z_GDU *gdu;
1387     ZOOM_Event event;
1388
1389     gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1390
1391     if (c->sru_mode == zoom_sru_get)
1392     {
1393         yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1394     }
1395     else if (c->sru_mode == zoom_sru_post)
1396     {
1397         yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1398     }
1399     else if (c->sru_mode == zoom_sru_soap)
1400     {
1401         yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1402     }
1403     if (!z_GDU(c->odr_out, &gdu, 0, 0))
1404         return zoom_complete;
1405     c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1406
1407     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1408     ZOOM_connection_put_event(c, event);
1409     odr_reset(c->odr_out);
1410     return do_write(c);
1411 }
1412 #endif
1413
1414 #if YAZ_HAVE_XML2
1415 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1416 {
1417     int i;
1418     int *start, *count;
1419     ZOOM_resultset resultset = 0;
1420     Z_SRW_PDU *sr = 0;
1421     const char *option_val = 0;
1422
1423     if (c->error)                  /* don't continue on error */
1424         return zoom_complete;
1425     assert(c->tasks);
1426     switch(c->tasks->which)
1427     {
1428     case ZOOM_TASK_SEARCH:
1429         resultset = c->tasks->u.search.resultset;
1430         resultset->setname = xstrdup("default");
1431         ZOOM_options_set(resultset->options, "setname", resultset->setname);
1432         start = &c->tasks->u.search.start;
1433         count = &c->tasks->u.search.count;
1434         break;
1435     case ZOOM_TASK_RETRIEVE:
1436         resultset = c->tasks->u.retrieve.resultset;
1437
1438         start = &c->tasks->u.retrieve.start;
1439         count = &c->tasks->u.retrieve.count;
1440
1441         if (*start >= resultset->size)
1442             return zoom_complete;
1443         if (*start + *count > resultset->size)
1444             *count = resultset->size - *start;
1445
1446         for (i = 0; i < *count; i++)
1447         {
1448             ZOOM_record rec =
1449                 record_cache_lookup(resultset, i + *start,
1450                                     c->tasks->u.retrieve.syntax,
1451                                     c->tasks->u.retrieve.elementSetName);
1452             if (!rec)
1453                 break;
1454             else
1455             {
1456                 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1457                 ZOOM_connection_put_event(c, event);
1458             }
1459         }
1460         *start += i;
1461         *count -= i;
1462
1463         if (*count == 0)
1464             return zoom_complete;
1465         break;
1466     default:
1467         return zoom_complete;
1468     }
1469     assert(resultset->query);
1470
1471     sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1472
1473     if (resultset->query->z_query->which == Z_Query_type_104
1474         && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1475     {
1476         sr->u.request->query_type = Z_SRW_query_type_cql;
1477         sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1478     }
1479     else if (resultset->query->z_query->which == Z_Query_type_1 &&
1480              resultset->query->z_query->u.type_1)
1481     {
1482         sr->u.request->query_type = Z_SRW_query_type_pqf;
1483         sr->u.request->query.pqf = resultset->query->query_string;
1484     }
1485     else
1486     {
1487         set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1488         return zoom_complete;
1489     }
1490     sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1491     sr->u.request->maximumRecords = odr_intdup(
1492         c->odr_out, resultset->step>0 ? resultset->step : *count);
1493     sr->u.request->recordSchema = resultset->schema;
1494
1495     option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1496     if (option_val)
1497         sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1498
1499     option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1500     if (option_val)
1501         sr->extra_args = odr_strdup(c->odr_out, option_val);
1502     return send_srw(c, sr);
1503 }
1504 #else
1505 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1506 {
1507     return zoom_complete;
1508 }
1509 #endif
1510
1511 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1512 {
1513     ZOOM_resultset r;
1514     int lslb, ssub, mspn;
1515     const char *syntax;
1516     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1517     Z_SearchRequest *search_req = apdu->u.searchRequest;
1518     const char *elementSetName;
1519     const char *smallSetElementSetName;
1520     const char *mediumSetElementSetName;
1521
1522     assert(c->tasks);
1523     assert(c->tasks->which == ZOOM_TASK_SEARCH);
1524
1525     r = c->tasks->u.search.resultset;
1526
1527     yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1528
1529     elementSetName =
1530         ZOOM_options_get(r->options, "elementSetName");
1531     smallSetElementSetName  =
1532         ZOOM_options_get(r->options, "smallSetElementSetName");
1533     mediumSetElementSetName =
1534         ZOOM_options_get(r->options, "mediumSetElementSetName");
1535
1536     if (!smallSetElementSetName)
1537         smallSetElementSetName = elementSetName;
1538
1539     if (!mediumSetElementSetName)
1540         mediumSetElementSetName = elementSetName;
1541
1542     assert(r);
1543     assert(r->query);
1544
1545     /* prepare query for the search request */
1546     search_req->query = r->query->z_query;
1547     if (!search_req->query)
1548     {
1549         set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1550         return zoom_complete;
1551     }
1552
1553     search_req->databaseNames = r->databaseNames;
1554     search_req->num_databaseNames = r->num_databaseNames;
1555
1556     /* get syntax (no need to provide unless piggyback is in effect) */
1557     syntax = c->tasks->u.search.syntax;
1558
1559     lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1560     ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1561     mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1562     if (lslb != -1 && ssub != -1 && mspn != -1)
1563     {
1564         /* So're a Z39.50 expert? Let's hope you don't do sort */
1565         *search_req->largeSetLowerBound = lslb;
1566         *search_req->smallSetUpperBound = ssub;
1567         *search_req->mediumSetPresentNumber = mspn;
1568     }
1569     else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1570              && r->piggyback && !r->r_sort_spec && !r->schema)
1571     {
1572         /* Regular piggyback - do it unless we're going to do sort */
1573         *search_req->largeSetLowerBound = 2000000000;
1574         *search_req->smallSetUpperBound = 1;
1575         *search_req->mediumSetPresentNumber =
1576             r->step>0 ? r->step : c->tasks->u.search.count;
1577     }
1578     else
1579     {
1580         /* non-piggyback. Need not provide elementsets or syntaxes .. */
1581         smallSetElementSetName = 0;
1582         mediumSetElementSetName = 0;
1583         syntax = 0;
1584     }
1585     if (smallSetElementSetName && *smallSetElementSetName)
1586     {
1587         Z_ElementSetNames *esn = (Z_ElementSetNames *)
1588             odr_malloc(c->odr_out, sizeof(*esn));
1589
1590         esn->which = Z_ElementSetNames_generic;
1591         esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1592         search_req->smallSetElementSetNames = esn;
1593     }
1594     if (mediumSetElementSetName && *mediumSetElementSetName)
1595     {
1596         Z_ElementSetNames *esn =(Z_ElementSetNames *)
1597             odr_malloc(c->odr_out, sizeof(*esn));
1598
1599         esn->which = Z_ElementSetNames_generic;
1600         esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1601         search_req->mediumSetElementSetNames = esn;
1602     }
1603     if (syntax)
1604         search_req->preferredRecordSyntax =
1605             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1606
1607     if (!r->setname)
1608     {
1609         if (c->support_named_resultsets)
1610         {
1611             char setname[14];
1612             int ord;
1613             /* find the lowest unused ordinal so that we re-use
1614                result sets on the server. */
1615             for (ord = 1; ; ord++)
1616             {
1617                 ZOOM_resultset rp;
1618                 sprintf(setname, "%d", ord);
1619                 for (rp = c->resultsets; rp; rp = rp->next)
1620                     if (rp->setname && !strcmp(rp->setname, setname))
1621                         break;
1622                 if (!rp)
1623                     break;
1624             }
1625             r->setname = xstrdup(setname);
1626             yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1627                     "set %s", c, r->setname);
1628         }
1629         else
1630         {
1631             yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1632                     "default set", c);
1633             r->setname = xstrdup("default");
1634         }
1635         ZOOM_options_set(r->options, "setname", r->setname);
1636     }
1637     search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1638     return send_APDU(c, apdu);
1639 }
1640
1641 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1642 {
1643     int oclass;
1644     char *addinfo = 0;
1645
1646     switch (r->which)
1647     {
1648     case Z_DefaultDiagFormat_v2Addinfo:
1649         addinfo = r->u.v2Addinfo;
1650         break;
1651     case Z_DefaultDiagFormat_v3Addinfo:
1652         addinfo = r->u.v3Addinfo;
1653         break;
1654     }
1655     xfree(c->addinfo);
1656     c->addinfo = 0;
1657     set_dset_error(c, *r->condition,
1658                    yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1659                    addinfo, 0);
1660 }
1661
1662 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1663 {
1664     if (p->which != Z_DiagRec_defaultFormat)
1665         set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1666     else
1667         response_default_diag(c, p->u.defaultFormat);
1668 }
1669
1670 ZOOM_API(ZOOM_record)
1671     ZOOM_record_clone(ZOOM_record srec)
1672 {
1673     char *buf;
1674     int size;
1675     ODR odr_enc;
1676     ZOOM_record nrec;
1677
1678     odr_enc = odr_createmem(ODR_ENCODE);
1679     if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1680         return 0;
1681     buf = odr_getbuf(odr_enc, &size, 0);
1682
1683     nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1684     nrec->odr = odr_createmem(ODR_DECODE);
1685     nrec->wrbuf_marc = 0;
1686     nrec->wrbuf_iconv = 0;
1687     nrec->wrbuf_opac = 0;
1688     odr_setbuf(nrec->odr, buf, size, 0);
1689     z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1690
1691     odr_destroy(odr_enc);
1692     return nrec;
1693 }
1694
1695 ZOOM_API(ZOOM_record)
1696     ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1697 {
1698     const char *syntax =
1699         ZOOM_options_get(s->options, "preferredRecordSyntax");
1700     const char *elementSetName =
1701         ZOOM_options_get(s->options, "elementSetName");
1702
1703     return record_cache_lookup(s, pos, syntax, elementSetName);
1704 }
1705
1706 ZOOM_API(ZOOM_record)
1707     ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1708 {
1709     ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1710
1711     if (!rec)
1712     {
1713         /*
1714          * MIKE: I think force_sync should always be zero, but I don't
1715          * want to make this change until I get the go-ahead from
1716          * Adam, in case something depends on the old synchronous
1717          * behaviour.
1718          */
1719         int force_sync = 1;
1720         if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1721         ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1722         rec = ZOOM_resultset_record_immediate(r, pos);
1723     }
1724     return rec;
1725 }
1726
1727 ZOOM_API(void)
1728     ZOOM_record_destroy(ZOOM_record rec)
1729 {
1730     if (!rec)
1731         return;
1732     if (rec->wrbuf_marc)
1733         wrbuf_destroy(rec->wrbuf_marc);
1734     if (rec->wrbuf_iconv)
1735         wrbuf_destroy(rec->wrbuf_iconv);
1736     if (rec->wrbuf_opac)
1737         wrbuf_destroy(rec->wrbuf_opac);
1738     odr_destroy(rec->odr);
1739     xfree(rec);
1740 }
1741
1742 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1743                                      int *len,
1744                                      const char *buf, int sz,
1745                                      const char *record_charset)
1746 {
1747     char to[40];
1748     char from[40];
1749     yaz_iconv_t cd = 0;
1750     yaz_marc_t mt = yaz_marc_create();
1751
1752     *from = '\0';
1753     strcpy(to, "UTF-8");
1754     if (record_charset && *record_charset)
1755     {
1756         /* Use "from,to" or just "from" */
1757         const char *cp = strchr(record_charset, ',');
1758         int clen = strlen(record_charset);
1759         if (cp && cp[1])
1760         {
1761             strncpy( to, cp+1, sizeof(to)-1);
1762             to[sizeof(to)-1] = '\0';
1763             clen = cp - record_charset;
1764         }
1765         if (clen > sizeof(from)-1)
1766             clen = sizeof(from)-1;
1767
1768         if (clen)
1769             strncpy(from, record_charset, clen);
1770         from[clen] = '\0';
1771     }
1772
1773     if (*from && *to)
1774     {
1775         cd = yaz_iconv_open(to, from);
1776         yaz_marc_iconv(mt, cd);
1777     }
1778
1779     yaz_marc_xml(mt, marc_type);
1780     if (!rec->wrbuf_marc)
1781         rec->wrbuf_marc = wrbuf_alloc();
1782     wrbuf_rewind(rec->wrbuf_marc);
1783     if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1784     {
1785         yaz_marc_destroy(mt);
1786         if (cd)
1787             yaz_iconv_close(cd);
1788         if (len)
1789             *len = wrbuf_len(rec->wrbuf_marc);
1790         return wrbuf_cstr(rec->wrbuf_marc);
1791     }
1792     yaz_marc_destroy(mt);
1793     if (cd)
1794         yaz_iconv_close(cd);
1795     return 0;
1796 }
1797
1798 static const char *record_iconv_return(ZOOM_record rec, int *len,
1799                                        const char *buf, int sz,
1800                                        const char *record_charset)
1801 {
1802     char to[40];
1803     char from[40];
1804     yaz_iconv_t cd = 0;
1805
1806     *from = '\0';
1807     strcpy(to, "UTF-8");
1808     if (record_charset && *record_charset)
1809     {
1810         /* Use "from,to" or just "from" */
1811         const char *cp = strchr(record_charset, ',');
1812         int clen = strlen(record_charset);
1813         if (cp && cp[1])
1814         {
1815             strncpy( to, cp+1, sizeof(to)-1);
1816             to[sizeof(to)-1] = '\0';
1817             clen = cp - record_charset;
1818         }
1819         if (clen > sizeof(from)-1)
1820             clen = sizeof(from)-1;
1821
1822         if (clen)
1823             strncpy(from, record_charset, clen);
1824         from[clen] = '\0';
1825     }
1826
1827     if (*from && *to && (cd = yaz_iconv_open(to, from)))
1828     {
1829         char outbuf[12];
1830         size_t inbytesleft = sz;
1831         const char *inp = buf;
1832
1833         if (!rec->wrbuf_iconv)
1834             rec->wrbuf_iconv = wrbuf_alloc();
1835
1836         wrbuf_rewind(rec->wrbuf_iconv);
1837
1838         while (inbytesleft)
1839         {
1840             size_t outbytesleft = sizeof(outbuf);
1841             char *outp = outbuf;
1842             size_t r = yaz_iconv(cd, (char**) &inp,
1843                                  &inbytesleft,
1844                                  &outp, &outbytesleft);
1845             if (r == (size_t) (-1))
1846             {
1847                 int e = yaz_iconv_error(cd);
1848                 if (e != YAZ_ICONV_E2BIG)
1849                     break;
1850             }
1851             wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1852         }
1853         buf = wrbuf_cstr(rec->wrbuf_iconv);
1854         sz = wrbuf_len(rec->wrbuf_iconv);
1855         yaz_iconv_close(cd);
1856     }
1857     if (len)
1858         *len = sz;
1859     return buf;
1860 }
1861
1862 ZOOM_API(int)
1863     ZOOM_record_error(ZOOM_record rec, const char **cp,
1864                       const char **addinfo, const char **diagset)
1865 {
1866     Z_NamePlusRecord *npr;
1867
1868     if (!rec)
1869         return 0;
1870     npr = rec->npr;
1871     if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1872     {
1873         Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1874         int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1875         const char *add = 0;
1876
1877         if (diag_rec->which == Z_DiagRec_defaultFormat)
1878         {
1879             Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1880             int oclass;
1881
1882             error = *ddf->condition;
1883             switch (ddf->which)
1884             {
1885             case Z_DefaultDiagFormat_v2Addinfo:
1886                 add = ddf->u.v2Addinfo;
1887                 break;
1888             case Z_DefaultDiagFormat_v3Addinfo:
1889                 add = ddf->u.v3Addinfo;
1890                 break;
1891             }
1892             if (diagset)
1893                 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1894         }
1895         else
1896         {
1897             if (diagset)
1898                 *diagset = "Bib-1";
1899         }
1900         if (addinfo)
1901             *addinfo = add ? add : "";
1902         if (cp)
1903             *cp = diagbib1_str(error);
1904         return error;
1905     }
1906     return 0;
1907 }
1908
1909 ZOOM_API(const char *)
1910     ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1911 {
1912     char type[40];
1913     char charset[40];
1914     char xpath[512];
1915     const char *cp;
1916     int i;
1917     Z_NamePlusRecord *npr;
1918
1919     if (len)
1920         *len = 0; /* default return */
1921
1922     if (!rec)
1923         return 0;
1924     npr = rec->npr;
1925     if (!npr)
1926         return 0;
1927
1928     cp = type_spec;
1929     for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1930     {
1931         if (cp[i] == ';' || cp[i] == ' ')
1932             break;
1933         type[i] = cp[i];
1934     }
1935     type[i] = '\0';
1936     charset[0] = '\0';
1937     while (type_spec[i] == ';')
1938     {
1939         i++;
1940         while (type_spec[i] == ' ')
1941             i++;
1942         if (!strncmp(type_spec+i, "charset=", 8))
1943         {
1944             int j = 0;
1945             i = i + 8; /* skip charset= */
1946             for (j = 0; type_spec[i]  && j < sizeof(charset)-1; i++, j++)
1947             {
1948                 if (type_spec[i] == ';' || type_spec[i] == ' ')
1949                     break;
1950                 charset[j] = cp[i];
1951             }
1952             charset[j] = '\0';
1953         }
1954         else if (!strncmp(type_spec+i, "xpath=", 6))
1955         {
1956             int j = 0;
1957             i = i + 6;
1958             for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1959                 xpath[j] = cp[i];
1960             xpath[j] = '\0';
1961         }
1962         while (type_spec[i] == ' ')
1963             i++;
1964     }
1965     if (!strcmp(type, "database"))
1966     {
1967         if (len)
1968             *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1969         return npr->databaseName;
1970     }
1971     else if (!strcmp(type, "syntax"))
1972     {
1973         const char *desc = 0;
1974         if (npr->which == Z_NamePlusRecord_databaseRecord)
1975         {
1976             Z_External *r = (Z_External *) npr->u.databaseRecord;
1977             oident *ent = oid_getentbyoid(r->direct_reference);
1978             if (ent)
1979                 desc = ent->desc;
1980         }
1981         if (!desc)
1982             desc = "none";
1983         if (len)
1984             *len = strlen(desc);
1985         return desc;
1986     }
1987     if (npr->which != Z_NamePlusRecord_databaseRecord)
1988         return 0;
1989
1990     /* from now on - we have a database record .. */
1991     if (!strcmp(type, "render"))
1992     {
1993         Z_External *r = (Z_External *) npr->u.databaseRecord;
1994         oident *ent = oid_getentbyoid(r->direct_reference);
1995
1996         /* render bibliographic record .. */
1997         if (r->which == Z_External_OPAC)
1998         {
1999             r = r->u.opac->bibliographicRecord;
2000             if (!r)
2001                 return 0;
2002             ent = oid_getentbyoid(r->direct_reference);
2003         }
2004         if (r->which == Z_External_sutrs)
2005             return record_iconv_return(rec, len,
2006                                        (char*) r->u.sutrs->buf,
2007                                        r->u.sutrs->len,
2008                                        charset);
2009         else if (r->which == Z_External_octet)
2010         {
2011             const char *ret_buf;
2012             switch (ent->value)
2013             {
2014             case VAL_SOIF:
2015             case VAL_HTML:
2016             case VAL_SUTRS:
2017                 break;
2018             case VAL_TEXT_XML:
2019             case VAL_APPLICATION_XML:
2020                 break;
2021             default:
2022                 ret_buf = marc_iconv_return(
2023                     rec, YAZ_MARC_LINE, len,
2024                     (const char *) r->u.octet_aligned->buf,
2025                     r->u.octet_aligned->len,
2026                     charset);
2027                 if (ret_buf)
2028                     return ret_buf;
2029             }
2030             return record_iconv_return(rec, len,
2031                                        (const char *) r->u.octet_aligned->buf,
2032                                        r->u.octet_aligned->len,
2033                                        charset);
2034         }
2035         else if (r->which == Z_External_grs1)
2036         {
2037             if (!rec->wrbuf_marc)
2038                 rec->wrbuf_marc = wrbuf_alloc();
2039             wrbuf_rewind(rec->wrbuf_marc);
2040             yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2041             return record_iconv_return(rec, len,
2042                                        wrbuf_buf(rec->wrbuf_marc),
2043                                        wrbuf_len(rec->wrbuf_marc),
2044                                        charset);
2045         }
2046         return 0;
2047     }
2048     else if (!strcmp(type, "xml"))
2049     {
2050         Z_External *r = (Z_External *) npr->u.databaseRecord;
2051         oident *ent = oid_getentbyoid(r->direct_reference);
2052
2053         /* render bibliographic record .. */
2054         if (r->which == Z_External_OPAC)
2055         {
2056             r = r->u.opac->bibliographicRecord;
2057             if (!r)
2058                 return 0;
2059             ent = oid_getentbyoid(r->direct_reference);
2060         }
2061
2062         if (r->which == Z_External_sutrs)
2063             return record_iconv_return(rec, len,
2064                                        (const char *) r->u.sutrs->buf,
2065                                        r->u.sutrs->len,
2066                                        charset);
2067         else if (r->which == Z_External_octet)
2068         {
2069             const char *ret_buf;
2070             int marc_decode_type = YAZ_MARC_MARCXML;
2071
2072             switch (ent->value)
2073             {
2074             case VAL_SOIF:
2075             case VAL_HTML:
2076             case VAL_SUTRS:
2077                 break;
2078             case VAL_TEXT_XML:
2079             case VAL_APPLICATION_XML:
2080                 break;
2081             default:
2082                 ret_buf = marc_iconv_return(
2083                     rec, marc_decode_type, len,
2084                     (const char *) r->u.octet_aligned->buf,
2085                     r->u.octet_aligned->len,
2086                     charset);
2087                 if (ret_buf)
2088                     return ret_buf;
2089             }
2090             return record_iconv_return(rec, len,
2091                                        (const char *) r->u.octet_aligned->buf,
2092                                        r->u.octet_aligned->len,
2093                                        charset);
2094         }
2095         else if (r->which == Z_External_grs1)
2096         {
2097             if (len) *len = 5;
2098             return "GRS-1";
2099         }
2100         return 0;
2101     }
2102     else if (!strcmp(type, "raw"))
2103     {
2104         Z_External *r = (Z_External *) npr->u.databaseRecord;
2105
2106         if (r->which == Z_External_sutrs)
2107         {
2108             if (len) *len = r->u.sutrs->len;
2109             return (const char *) r->u.sutrs->buf;
2110         }
2111         else if (r->which == Z_External_octet)
2112         {
2113             if (len) *len = r->u.octet_aligned->len;
2114             return (const char *) r->u.octet_aligned->buf;
2115         }
2116         else /* grs-1, explain, OPAC, ... */
2117         {
2118             if (len) *len = -1;
2119             return (const char *) npr->u.databaseRecord;
2120         }
2121         return 0;
2122     }
2123     else if (!strcmp (type, "ext"))
2124     {
2125         if (len) *len = -1;
2126         return (const char *) npr->u.databaseRecord;
2127     }
2128     else if (!strcmp (type, "opac"))
2129
2130     {
2131         Z_External *r = (Z_External *) npr->u.databaseRecord;
2132         if (r->which == Z_External_OPAC)
2133         {
2134             if (!rec->wrbuf_opac)
2135                 rec->wrbuf_opac = wrbuf_alloc();
2136             wrbuf_rewind(rec->wrbuf_opac);
2137             yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2138             return record_iconv_return(rec, len,
2139                                        wrbuf_buf(rec->wrbuf_opac),
2140                                        wrbuf_len(rec->wrbuf_opac),
2141                                        charset);
2142         }
2143     }
2144     return 0;
2145 }
2146
2147 static int strcmp_null(const char *v1, const char *v2)
2148 {
2149     if (!v1 && !v2)
2150         return 0;
2151     if (!v1 || !v2)
2152         return -1;
2153     return strcmp(v1, v2);
2154 }
2155
2156 static size_t record_hash(int pos)
2157 {
2158     if (pos < 0)
2159         pos = 0;
2160     return pos % RECORD_HASH_SIZE;
2161 }
2162
2163 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2164                              int pos,
2165                              const char *syntax, const char *elementSetName)
2166 {
2167     ZOOM_record_cache rc;
2168
2169     ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2170     ZOOM_connection_put_event(r->connection, event);
2171
2172     for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2173     {
2174         if (pos == rc->pos)
2175         {
2176             if (strcmp_null(r->schema, rc->schema))
2177                 continue;
2178             if (strcmp_null(elementSetName,rc->elementSetName))
2179                 continue;
2180             if (strcmp_null(syntax, rc->syntax))
2181                 continue;
2182             /* not destroying rc->npr (it's handled by nmem )*/
2183             rc->rec.npr = npr;
2184             /* keeping wrbuf_marc too */
2185             return;
2186         }
2187     }
2188     rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2189     rc->rec.npr = npr;
2190     rc->rec.odr = 0;
2191     rc->rec.wrbuf_marc = 0;
2192     rc->rec.wrbuf_iconv = 0;
2193     rc->rec.wrbuf_opac = 0;
2194     if (elementSetName)
2195         rc->elementSetName = odr_strdup(r->odr, elementSetName);
2196     else
2197         rc->elementSetName = 0;
2198
2199     if (syntax)
2200         rc->syntax = odr_strdup(r->odr, syntax);
2201     else
2202         rc->syntax = 0;
2203
2204     if (r->schema)
2205         rc->schema = odr_strdup(r->odr, r->schema);
2206     else
2207         rc->schema = 0;
2208
2209     rc->pos = pos;
2210     rc->next = r->record_hash[record_hash(pos)];
2211     r->record_hash[record_hash(pos)] = rc;
2212 }
2213
2214 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2215                                        const char *syntax,
2216                                        const char *elementSetName)
2217 {
2218     ZOOM_record_cache rc;
2219
2220     for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2221     {
2222         if (pos == rc->pos)
2223         {
2224             if (strcmp_null(r->schema, rc->schema))
2225                 continue;
2226             if (strcmp_null(elementSetName,rc->elementSetName))
2227                 continue;
2228             if (strcmp_null(syntax, rc->syntax))
2229                 continue;
2230             return &rc->rec;
2231         }
2232     }
2233     return 0;
2234 }
2235
2236 static void handle_records(ZOOM_connection c, Z_Records *sr,
2237                            int present_phase)
2238 {
2239     ZOOM_resultset resultset;
2240     int *start, *count;
2241     const char *syntax = 0, *elementSetName = 0;
2242
2243     if (!c->tasks)
2244         return ;
2245     switch (c->tasks->which)
2246     {
2247     case ZOOM_TASK_SEARCH:
2248         resultset = c->tasks->u.search.resultset;
2249         start = &c->tasks->u.search.start;
2250         count = &c->tasks->u.search.count;
2251         syntax = c->tasks->u.search.syntax;
2252         elementSetName = c->tasks->u.search.elementSetName;
2253         break;
2254     case ZOOM_TASK_RETRIEVE:
2255         resultset = c->tasks->u.retrieve.resultset;
2256         start = &c->tasks->u.retrieve.start;
2257         count = &c->tasks->u.retrieve.count;
2258         syntax = c->tasks->u.retrieve.syntax;
2259         elementSetName = c->tasks->u.retrieve.elementSetName;
2260         break;
2261     default:
2262         return;
2263     }
2264     if (sr && sr->which == Z_Records_NSD)
2265         response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2266     else if (sr && sr->which == Z_Records_multipleNSD)
2267     {
2268         if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2269             response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2270         else
2271             set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2272     }
2273     else
2274     {
2275         if (*count + *start > resultset->size)
2276             *count = resultset->size - *start;
2277         if (*count < 0)
2278             *count = 0;
2279         if (sr && sr->which == Z_Records_DBOSD)
2280         {
2281             int i;
2282             NMEM nmem = odr_extract_mem(c->odr_in);
2283             Z_NamePlusRecordList *p =
2284                 sr->u.databaseOrSurDiagnostics;
2285             for (i = 0; i<p->num_records; i++)
2286             {
2287                 record_cache_add(resultset, p->records[i], i + *start,
2288                                  syntax, elementSetName);
2289             }
2290             *count -= i;
2291             if (*count < 0)
2292                 *count = 0;
2293             *start += i;
2294             yaz_log(log_details,
2295                     "handle_records resultset=%p start=%d count=%d",
2296                     resultset, *start, *count);
2297
2298             /* transfer our response to search_nmem .. we need it later */
2299             nmem_transfer(resultset->odr->mem, nmem);
2300             nmem_destroy(nmem);
2301             if (present_phase && p->num_records == 0)
2302             {
2303                 /* present response and we didn't get any records! */
2304                 Z_NamePlusRecord *myrec =
2305                     zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2306                 record_cache_add(resultset, myrec, *start,
2307                                  syntax, elementSetName);
2308             }
2309         }
2310         else if (present_phase)
2311         {
2312             /* present response and we didn't get any records! */
2313             Z_NamePlusRecord *myrec =
2314                 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2315             record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2316         }
2317     }
2318 }
2319
2320 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2321 {
2322     handle_records(c, pr->records, 1);
2323 }
2324
2325 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2326                                        Z_Term *term)
2327 {
2328     switch (term->which)
2329     {
2330     case Z_Term_general:
2331         ZOOM_options_setl(opt, name,
2332                           (const char *)(term->u.general->buf),
2333                           term->u.general->len);
2334         break;
2335     case Z_Term_characterString:
2336         ZOOM_options_set(opt, name, term->u.characterString);
2337         break;
2338     case Z_Term_numeric:
2339         ZOOM_options_set_int(opt, name, *term->u.numeric);
2340         break;
2341     }
2342 }
2343
2344 static void handle_queryExpression(ZOOM_options opt, const char *name,
2345                                    Z_QueryExpression *exp)
2346 {
2347     char opt_name[80];
2348
2349     switch (exp->which)
2350     {
2351     case Z_QueryExpression_term:
2352         if (exp->u.term && exp->u.term->queryTerm)
2353         {
2354             sprintf(opt_name, "%s.term", name);
2355             handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2356         }
2357         break;
2358     case Z_QueryExpression_query:
2359         break;
2360     }
2361 }
2362
2363 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2364                                 Z_OtherInformation *o)
2365 {
2366     int i;
2367     for (i = 0; o && i < o->num_elements; i++)
2368     {
2369         if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2370         {
2371             Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2372
2373             if (ext->which == Z_External_searchResult1)
2374             {
2375                 int j;
2376                 Z_SearchInfoReport *sr = ext->u.searchResult1;
2377
2378                 if (sr->num)
2379                     ZOOM_options_set_int(
2380                         resultset->options, "searchresult.size", sr->num);
2381
2382                 for (j = 0; j < sr->num; j++)
2383                 {
2384                     Z_SearchInfoReport_s *ent =
2385                         ext->u.searchResult1->elements[j];
2386                     char pref[80];
2387
2388                     sprintf(pref, "searchresult.%d", j);
2389
2390                     if (ent->subqueryId)
2391                     {
2392                         char opt_name[80];
2393                         sprintf(opt_name, "%s.id", pref);
2394                         ZOOM_options_set(resultset->options, opt_name,
2395                                          ent->subqueryId);
2396                     }
2397                     if (ent->subqueryExpression)
2398                     {
2399                         char opt_name[80];
2400                         sprintf(opt_name, "%s.subquery", pref);
2401                         handle_queryExpression(resultset->options, opt_name,
2402                                                ent->subqueryExpression);
2403                     }
2404                     if (ent->subqueryInterpretation)
2405                     {
2406                         char opt_name[80];
2407                         sprintf(opt_name, "%s.interpretation", pref);
2408                         handle_queryExpression(resultset->options, opt_name,
2409                                                ent->subqueryInterpretation);
2410                     }
2411                     if (ent->subqueryRecommendation)
2412                     {
2413                         char opt_name[80];
2414                         sprintf(opt_name, "%s.recommendation", pref);
2415                         handle_queryExpression(resultset->options, opt_name,
2416                                                ent->subqueryRecommendation);
2417                     }
2418                     if (ent->subqueryCount)
2419                     {
2420                         char opt_name[80];
2421                         sprintf(opt_name, "%s.count", pref);
2422                         ZOOM_options_set_int(resultset->options, opt_name,
2423                                              *ent->subqueryCount);
2424                     }
2425                 }
2426             }
2427         }
2428     }
2429 }
2430
2431 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2432 {
2433     ZOOM_resultset resultset;
2434     ZOOM_Event event;
2435
2436     if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2437         return ;
2438
2439     event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2440     ZOOM_connection_put_event(c, event);
2441
2442     resultset = c->tasks->u.search.resultset;
2443
2444     if (sr->resultSetStatus)
2445     {
2446         ZOOM_options_set_int(resultset->options, "resultSetStatus",
2447                              *sr->resultSetStatus);
2448     }
2449     if (sr->presentStatus)
2450     {
2451         ZOOM_options_set_int(resultset->options, "presentStatus",
2452                              *sr->presentStatus);
2453     }
2454     handle_searchResult(c, resultset, sr->additionalSearchInfo);
2455
2456     resultset->size = *sr->resultCount;
2457     handle_records(c, sr->records, 0);
2458 }
2459
2460 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2461 {
2462     if (res->diagnostics && res->num_diagnostics > 0)
2463         response_diag(c, res->diagnostics[0]);
2464 }
2465
2466 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2467 {
2468     NMEM nmem = odr_extract_mem(c->odr_in);
2469     ZOOM_scanset scan;
2470
2471     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2472         return 0;
2473     scan = c->tasks->u.scan.scan;
2474
2475     if (res->entries && res->entries->nonsurrogateDiagnostics)
2476         response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2477     scan->scan_response = res;
2478     nmem_transfer(scan->odr->mem, nmem);
2479     if (res->stepSize)
2480         ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2481     if (res->positionOfTerm)
2482         ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2483     if (res->scanStatus)
2484         ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2485     if (res->numberOfEntriesReturned)
2486         ZOOM_options_set_int(scan->options, "number",
2487                              *res->numberOfEntriesReturned);
2488     nmem_destroy(nmem);
2489     return 1;
2490 }
2491
2492 static zoom_ret send_sort(ZOOM_connection c,
2493                           ZOOM_resultset resultset)
2494 {
2495     if (c->error)
2496         resultset->r_sort_spec = 0;
2497     if (resultset->r_sort_spec)
2498     {
2499         Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2500         Z_SortRequest *req = apdu->u.sortRequest;
2501
2502         req->num_inputResultSetNames = 1;
2503         req->inputResultSetNames = (Z_InternationalString **)
2504             odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2505         req->inputResultSetNames[0] =
2506             odr_strdup(c->odr_out, resultset->setname);
2507         req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2508         req->sortSequence = resultset->r_sort_spec;
2509         resultset->r_sort_spec = 0;
2510         return send_APDU(c, apdu);
2511     }
2512     return zoom_complete;
2513 }
2514
2515 static zoom_ret send_present(ZOOM_connection c)
2516 {
2517     Z_APDU *apdu = 0;
2518     Z_PresentRequest *req = 0;
2519     int i = 0;
2520     const char *syntax = 0;
2521     const char *elementSetName = 0;
2522     ZOOM_resultset  resultset;
2523     int *start, *count;
2524
2525     if (!c->tasks)
2526     {
2527         yaz_log(log_details, "%p send_present no tasks", c);
2528         return zoom_complete;
2529     }
2530
2531     switch (c->tasks->which)
2532     {
2533     case ZOOM_TASK_SEARCH:
2534         resultset = c->tasks->u.search.resultset;
2535         start = &c->tasks->u.search.start;
2536         count = &c->tasks->u.search.count;
2537         syntax = c->tasks->u.search.syntax;
2538         elementSetName = c->tasks->u.search.elementSetName;
2539         break;
2540     case ZOOM_TASK_RETRIEVE:
2541         resultset = c->tasks->u.retrieve.resultset;
2542         start = &c->tasks->u.retrieve.start;
2543         count = &c->tasks->u.retrieve.count;
2544         syntax = c->tasks->u.retrieve.syntax;
2545         elementSetName = c->tasks->u.retrieve.elementSetName;
2546         break;
2547     default:
2548         return zoom_complete;
2549     }
2550     yaz_log(log_details, "%p send_present start=%d count=%d",
2551             c, *start, *count);
2552
2553     if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2554     {
2555         set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2556                        "", 0);
2557     }
2558     if (c->error)                  /* don't continue on error */
2559         return zoom_complete;
2560     yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2561             resultset, *start, *count);
2562
2563     for (i = 0; i < *count; i++)
2564     {
2565         ZOOM_record rec =
2566             record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2567         if (!rec)
2568             break;
2569         else
2570         {
2571             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2572             ZOOM_connection_put_event(c, event);
2573         }
2574     }
2575     *start += i;
2576     *count -= i;
2577
2578     if (*count == 0)
2579     {
2580         yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2581         return zoom_complete;
2582     }
2583
2584     apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2585     req = apdu->u.presentRequest;
2586
2587     if (i)
2588         yaz_log(log_details, "%p send_present skip=%d", c, i);
2589
2590     *req->resultSetStartPoint = *start + 1;
2591     *req->numberOfRecordsRequested = resultset->step>0 ?
2592         resultset->step : *count;
2593     if (*req->numberOfRecordsRequested + *start > resultset->size)
2594         *req->numberOfRecordsRequested = resultset->size - *start;
2595     assert(*req->numberOfRecordsRequested > 0);
2596
2597     if (syntax && *syntax)
2598         req->preferredRecordSyntax =
2599             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2600
2601     if (resultset->schema && *resultset->schema)
2602     {
2603         Z_RecordComposition *compo = (Z_RecordComposition *)
2604             odr_malloc(c->odr_out, sizeof(*compo));
2605
2606         req->recordComposition = compo;
2607         compo->which = Z_RecordComp_complex;
2608         compo->u.complex = (Z_CompSpec *)
2609             odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2610         compo->u.complex->selectAlternativeSyntax = (bool_t *)
2611             odr_malloc(c->odr_out, sizeof(bool_t));
2612         *compo->u.complex->selectAlternativeSyntax = 0;
2613
2614         compo->u.complex->generic = (Z_Specification *)
2615             odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2616
2617         compo->u.complex->generic->which = Z_Schema_oid;
2618         compo->u.complex->generic->schema.oid = (Odr_oid *)
2619             zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2620
2621         if (!compo->u.complex->generic->schema.oid)
2622         {
2623             /* OID wasn't a schema! Try record syntax instead. */
2624
2625             compo->u.complex->generic->schema.oid = (Odr_oid *)
2626                 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2627         }
2628         if (elementSetName && *elementSetName)
2629         {
2630             compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2631                 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2632             compo->u.complex->generic->elementSpec->which =
2633                 Z_ElementSpec_elementSetName;
2634             compo->u.complex->generic->elementSpec->u.elementSetName =
2635                 odr_strdup(c->odr_out, elementSetName);
2636         }
2637         else
2638             compo->u.complex->generic->elementSpec = 0;
2639         compo->u.complex->num_dbSpecific = 0;
2640         compo->u.complex->dbSpecific = 0;
2641         compo->u.complex->num_recordSyntax = 0;
2642         compo->u.complex->recordSyntax = 0;
2643     }
2644     else if (elementSetName && *elementSetName)
2645     {
2646         Z_ElementSetNames *esn = (Z_ElementSetNames *)
2647             odr_malloc(c->odr_out, sizeof(*esn));
2648         Z_RecordComposition *compo = (Z_RecordComposition *)
2649             odr_malloc(c->odr_out, sizeof(*compo));
2650
2651         esn->which = Z_ElementSetNames_generic;
2652         esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2653         compo->which = Z_RecordComp_simple;
2654         compo->u.simple = esn;
2655         req->recordComposition = compo;
2656     }
2657     req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2658     return send_APDU(c, apdu);
2659 }
2660
2661 ZOOM_API(ZOOM_scanset)
2662     ZOOM_connection_scan(ZOOM_connection c, const char *start)
2663 {
2664     ZOOM_scanset s;
2665     ZOOM_query q = ZOOM_query_create();
2666
2667     ZOOM_query_prefix(q, start);
2668
2669     s = ZOOM_connection_scan1(c, q);
2670     ZOOM_query_destroy(q);
2671     return s;
2672
2673 }
2674
2675 ZOOM_API(ZOOM_scanset)
2676     ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2677 {
2678     char *start;
2679     char *freeme = 0;
2680     ZOOM_scanset scan = 0;
2681
2682     /*
2683      * We need to check the query-type, so we can recognise CQL and
2684      * CCL and compile them into a form that we can use here.  The
2685      * ZOOM_query structure has no explicit `type' member, but
2686      * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2687      * functions shows how the structure is set up in each case.
2688      */
2689     if (!q->z_query)
2690         return 0;
2691     else if (q->z_query->which == Z_Query_type_1)
2692     {
2693         yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2694                 c, q, q->query_string);
2695         start = q->query_string;
2696     }
2697     else if (q->z_query->which == Z_Query_type_104)
2698     {
2699         yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2700                 c, q, q->query_string);
2701         start = freeme = cql2pqf(c, q->query_string);
2702         if (start == 0)
2703             return 0;
2704     }
2705     else
2706     {
2707         yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2708                 c, q, q->query_string);
2709         abort();
2710     }
2711
2712     scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2713     scan->connection = c;
2714     scan->odr = odr_createmem(ODR_DECODE);
2715     scan->options = ZOOM_options_create_with_parent(c->options);
2716     scan->refcount = 1;
2717     scan->scan_response = 0;
2718     scan->termListAndStartPoint =
2719         p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2720     xfree(freeme);
2721
2722     scan->databaseNames = set_DatabaseNames(c, c->options,
2723                                             &scan->num_databaseNames,
2724                                             scan->odr);
2725     if (scan->termListAndStartPoint != 0)
2726     {
2727         ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2728         task->u.scan.scan = scan;
2729
2730         (scan->refcount)++;
2731         if (!c->async)
2732         {
2733             while (ZOOM_event(1, &c))
2734                 ;
2735         }
2736     }
2737     return scan;
2738 }
2739
2740 ZOOM_API(void)
2741     ZOOM_scanset_destroy(ZOOM_scanset scan)
2742 {
2743     if (!scan)
2744         return;
2745     (scan->refcount)--;
2746     if (scan->refcount == 0)
2747     {
2748         odr_destroy(scan->odr);
2749
2750         ZOOM_options_destroy(scan->options);
2751         xfree(scan);
2752     }
2753 }
2754
2755 static zoom_ret send_package(ZOOM_connection c)
2756 {
2757     ZOOM_Event event;
2758
2759     yaz_log(log_details, "%p send_package", c);
2760     if (!c->tasks)
2761         return zoom_complete;
2762     assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2763
2764     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2765     ZOOM_connection_put_event(c, event);
2766
2767     c->buf_out = c->tasks->u.package->buf_out;
2768     c->len_out = c->tasks->u.package->len_out;
2769
2770     return do_write(c);
2771 }
2772
2773 static zoom_ret send_scan(ZOOM_connection c)
2774 {
2775     ZOOM_scanset scan;
2776     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2777     Z_ScanRequest *req = apdu->u.scanRequest;
2778
2779     yaz_log(log_details, "%p send_scan", c);
2780     if (!c->tasks)
2781         return zoom_complete;
2782     assert (c->tasks->which == ZOOM_TASK_SCAN);
2783     scan = c->tasks->u.scan.scan;
2784
2785     req->termListAndStartPoint = scan->termListAndStartPoint;
2786     req->attributeSet = scan->attributeSet;
2787
2788     *req->numberOfTermsRequested =
2789         ZOOM_options_get_int(scan->options, "number", 10);
2790
2791     req->preferredPositionInResponse =
2792         odr_intdup(c->odr_out,
2793                    ZOOM_options_get_int(scan->options, "position", 1));
2794
2795     req->stepSize =
2796         odr_intdup(c->odr_out,
2797                    ZOOM_options_get_int(scan->options, "stepSize", 0));
2798
2799     req->databaseNames = scan->databaseNames;
2800     req->num_databaseNames = scan->num_databaseNames;
2801
2802     return send_APDU(c, apdu);
2803 }
2804
2805 ZOOM_API(size_t)
2806     ZOOM_scanset_size(ZOOM_scanset scan)
2807 {
2808     if (!scan || !scan->scan_response || !scan->scan_response->entries)
2809         return 0;
2810     return scan->scan_response->entries->num_entries;
2811 }
2812
2813 ZOOM_API(const char *)
2814     ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2815                       int *occ, int *len)
2816 {
2817     const char *term = 0;
2818     size_t noent = ZOOM_scanset_size(scan);
2819     Z_ScanResponse *res = scan->scan_response;
2820
2821     *len = 0;
2822     *occ = 0;
2823     if (pos >= noent)
2824         return 0;
2825     if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2826     {
2827         Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2828
2829         if (t->term->which == Z_Term_general)
2830         {
2831             term = (const char *) t->term->u.general->buf;
2832             *len = t->term->u.general->len;
2833         }
2834         *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2835     }
2836     return term;
2837 }
2838
2839 ZOOM_API(const char *)
2840     ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2841                               int *occ, int *len)
2842 {
2843     const char *term = 0;
2844     size_t noent = ZOOM_scanset_size(scan);
2845     Z_ScanResponse *res = scan->scan_response;
2846
2847     *len = 0;
2848     *occ = 0;
2849     if (pos >= noent)
2850         return 0;
2851     if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2852     {
2853         Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2854
2855         if (t->displayTerm)
2856         {
2857             term = t->displayTerm;
2858             *len = strlen(term);
2859         }
2860         else if (t->term->which == Z_Term_general)
2861         {
2862             term = (const char *) t->term->u.general->buf;
2863             *len = t->term->u.general->len;
2864         }
2865         *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2866     }
2867     return term;
2868 }
2869
2870 ZOOM_API(const char *)
2871     ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2872 {
2873     return ZOOM_options_get(scan->options, key);
2874 }
2875
2876 ZOOM_API(void)
2877     ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2878                             const char *val)
2879 {
2880     ZOOM_options_set(scan->options, key, val);
2881 }
2882
2883 static Z_APDU *create_es_package(ZOOM_package p, int type)
2884 {
2885     const char *str;
2886     Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2887     Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2888
2889     *req->function = Z_ExtendedServicesRequest_create;
2890
2891     str = ZOOM_options_get(p->options, "package-name");
2892     if (str && *str)
2893         req->packageName = nmem_strdup(p->odr_out->mem, str);
2894
2895     str = ZOOM_options_get(p->options, "user-id");
2896     if (str)
2897         req->userId = nmem_strdup(p->odr_out->mem, str);
2898
2899     req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2900                                               type);
2901
2902     str = ZOOM_options_get(p->options, "function");
2903     if (str)
2904     {
2905         if (!strcmp (str, "create"))
2906             *req->function = 1;
2907         if (!strcmp (str, "delete"))
2908             *req->function = 2;
2909         if (!strcmp (str, "modify"))
2910             *req->function = 3;
2911     }
2912     return apdu;
2913 }
2914
2915 static const char *ill_array_lookup(void *clientData, const char *idx)
2916 {
2917     ZOOM_package p = (ZOOM_package) clientData;
2918     return ZOOM_options_get(p->options, idx+4);
2919 }
2920
2921 static Z_External *encode_ill_request(ZOOM_package p)
2922 {
2923     ODR out = p->odr_out;
2924     ILL_Request *req;
2925     Z_External *r = 0;
2926     struct ill_get_ctl ctl;
2927
2928     ctl.odr = p->odr_out;
2929     ctl.clientData = p;
2930     ctl.f = ill_array_lookup;
2931
2932     req = ill_get_ILLRequest(&ctl, "ill", 0);
2933
2934     if (!ill_Request(out, &req, 0, 0))
2935     {
2936         int ill_request_size;
2937         char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2938         if (ill_request_buf)
2939             odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2940         return 0;
2941     }
2942     else
2943     {
2944         oident oid;
2945         int illRequest_size = 0;
2946         char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2947
2948         oid.proto = PROTO_GENERAL;
2949         oid.oclass = CLASS_GENERAL;
2950         oid.value = VAL_ISO_ILL_1;
2951
2952         r = (Z_External *) odr_malloc(out, sizeof(*r));
2953         r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2954         r->indirect_reference = 0;
2955         r->descriptor = 0;
2956         r->which = Z_External_single;
2957
2958         r->u.single_ASN1_type =
2959             odr_create_Odr_oct(out,
2960                                (unsigned char *)illRequest_buf,
2961                                illRequest_size);
2962     }
2963     return r;
2964 }
2965
2966 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2967 {
2968     Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2969     const char *str;
2970
2971     req->which = Z_IOItemOrder_esRequest;
2972     req->u.esRequest = (Z_IORequest *)
2973         odr_malloc(p->odr_out,sizeof(Z_IORequest));
2974
2975     /* to keep part ... */
2976     req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2977         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2978     req->u.esRequest->toKeep->supplDescription = 0;
2979     req->u.esRequest->toKeep->contact = (Z_IOContact *)
2980         odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2981
2982     str = ZOOM_options_get(p->options, "contact-name");
2983     req->u.esRequest->toKeep->contact->name = str ?
2984         nmem_strdup(p->odr_out->mem, str) : 0;
2985
2986     str = ZOOM_options_get(p->options, "contact-phone");
2987     req->u.esRequest->toKeep->contact->phone = str ?
2988         nmem_strdup(p->odr_out->mem, str) : 0;
2989
2990     str = ZOOM_options_get(p->options, "contact-email");
2991     req->u.esRequest->toKeep->contact->email = str ?
2992         nmem_strdup(p->odr_out->mem, str) : 0;
2993
2994     req->u.esRequest->toKeep->addlBilling = 0;
2995
2996     /* not to keep part ... */
2997     req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2998         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2999
3000     str = ZOOM_options_get(p->options, "itemorder-setname");
3001     if (!str)
3002         str = "default";
3003
3004     if (!*str)
3005         req->u.esRequest->notToKeep->resultSetItem = 0;
3006     else
3007     {
3008         req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3009             odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3010
3011         req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3012             nmem_strdup(p->odr_out->mem, str);
3013         req->u.esRequest->notToKeep->resultSetItem->item =
3014             (int *) odr_malloc(p->odr_out, sizeof(int));
3015
3016         str = ZOOM_options_get(p->options, "itemorder-item");
3017         *req->u.esRequest->notToKeep->resultSetItem->item =
3018             (str ? atoi(str) : 1);
3019     }
3020
3021     str = ZOOM_options_get(p->options, "doc");
3022     if (str)
3023         req->u.esRequest->notToKeep->itemRequest =
3024             z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
3025     else
3026         req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3027
3028     return req;
3029 }
3030
3031 Z_APDU *create_admin_package(ZOOM_package p, int type,
3032                              Z_ESAdminOriginPartToKeep **toKeepP,
3033                              Z_ESAdminOriginPartNotToKeep **notToKeepP)
3034 {
3035     Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3036     if (apdu)
3037     {
3038         Z_ESAdminOriginPartToKeep  *toKeep;
3039         Z_ESAdminOriginPartNotToKeep  *notToKeep;
3040         Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3041         const char *first_db = "Default";
3042         int num_db;
3043         char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3044                                       p->odr_out);
3045         if (num_db > 0)
3046             first_db = db[0];
3047
3048         r->direct_reference =
3049             yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3050                                    VAL_ADMINSERVICE);
3051         r->descriptor = 0;
3052         r->indirect_reference = 0;
3053         r->which = Z_External_ESAdmin;
3054
3055         r->u.adminService = (Z_Admin *)
3056             odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3057         r->u.adminService->which = Z_Admin_esRequest;
3058         r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3059             odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3060
3061         toKeep = r->u.adminService->u.esRequest->toKeep =
3062             (Z_ESAdminOriginPartToKeep *)
3063             odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3064         toKeep->which = type;
3065         toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3066         toKeep->u.create = odr_nullval();
3067         apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3068
3069         r->u.adminService->u.esRequest->notToKeep = notToKeep =
3070             (Z_ESAdminOriginPartNotToKeep *)
3071             odr_malloc(p->odr_out,
3072                        sizeof(*r->u.adminService->u.esRequest->notToKeep));
3073         notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3074         notToKeep->u.recordsWillFollow = odr_nullval();
3075         if (toKeepP)
3076             *toKeepP = toKeep;
3077         if (notToKeepP)
3078             *notToKeepP = notToKeep;
3079     }
3080     return apdu;
3081 }
3082
3083 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3084 {
3085     Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3086     Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3087     Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3088     const char *doc = ZOOM_options_get(p->options, "doc");
3089
3090     if (!doc)
3091         doc = "";
3092
3093     req->taskSpecificParameters = ext;
3094     ext->direct_reference = req->packageType;
3095     ext->descriptor = 0;
3096     ext->indirect_reference = 0;
3097
3098     ext->which = Z_External_octet;
3099     ext->u.single_ASN1_type =
3100         odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3101                            strlen(doc));
3102     return apdu;
3103 }
3104
3105 static Z_APDU *create_update_package(ZOOM_package p)
3106 {
3107     Z_APDU *apdu = 0;
3108     const char *first_db = "Default";
3109     int num_db;
3110     char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3111     const char *action = ZOOM_options_get(p->options, "action");
3112     const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3113     const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3114     const char *record_buf = ZOOM_options_get(p->options, "record");
3115     const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3116     int syntax_oid = VAL_NONE;
3117     int action_no = -1;
3118
3119     if (syntax_str)
3120         syntax_oid = oid_getvalbyname(syntax_str);
3121     if (!record_buf)
3122     {
3123         record_buf = "void";
3124         syntax_oid = VAL_SUTRS;
3125     }
3126     if (syntax_oid == VAL_NONE)
3127         syntax_oid = VAL_TEXT_XML;
3128
3129     if (num_db > 0)
3130         first_db = db[0];
3131
3132     if (!action)
3133         action = "specialUpdate";
3134
3135     if (!strcmp(action, "recordInsert"))
3136         action_no = Z_IUOriginPartToKeep_recordInsert;
3137     else if (!strcmp(action, "recordReplace"))
3138         action_no = Z_IUOriginPartToKeep_recordReplace;
3139     else if (!strcmp(action, "recordDelete"))
3140         action_no = Z_IUOriginPartToKeep_recordDelete;
3141     else if (!strcmp(action, "elementUpdate"))
3142         action_no = Z_IUOriginPartToKeep_elementUpdate;
3143     else if (!strcmp(action, "specialUpdate"))
3144         action_no = Z_IUOriginPartToKeep_specialUpdate;
3145     else
3146         return 0;
3147
3148     apdu = create_es_package(p, VAL_DBUPDATE);
3149     if (apdu)
3150     {
3151         Z_IUOriginPartToKeep *toKeep;
3152         Z_IUSuppliedRecords *notToKeep;
3153         Z_External *r = (Z_External *)
3154             odr_malloc(p->odr_out, sizeof(*r));
3155
3156         apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3157
3158         r->direct_reference =
3159             yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3160                                    VAL_DBUPDATE);
3161         r->descriptor = 0;
3162         r->which = Z_External_update;
3163         r->indirect_reference = 0;
3164         r->u.update = (Z_IUUpdate *)
3165             odr_malloc(p->odr_out, sizeof(*r->u.update));
3166
3167         r->u.update->which = Z_IUUpdate_esRequest;
3168         r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3169             odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3170         toKeep = r->u.update->u.esRequest->toKeep =
3171             (Z_IUOriginPartToKeep *)
3172             odr_malloc(p->odr_out, sizeof(*toKeep));
3173
3174         toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3175         toKeep->schema = 0;
3176         toKeep->elementSetName = 0;
3177         toKeep->actionQualifier = 0;
3178         toKeep->action = odr_intdup(p->odr_out, action_no);
3179
3180         notToKeep = r->u.update->u.esRequest->notToKeep =
3181             (Z_IUSuppliedRecords *)
3182             odr_malloc(p->odr_out, sizeof(*notToKeep));
3183         notToKeep->num = 1;
3184         notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3185             odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3186         notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3187             odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3188         notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3189         if (recordIdOpaque)
3190         {
3191             notToKeep->elements[0]->u.opaque =
3192                 odr_create_Odr_oct(p->odr_out,
3193                                    (const unsigned char *) recordIdOpaque,
3194                                    strlen(recordIdOpaque));
3195         }
3196         else if (recordIdNumber)
3197         {
3198             notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3199
3200             notToKeep->elements[0]->u.number =
3201                 odr_intdup(p->odr_out, atoi(recordIdNumber));
3202         }
3203         else
3204             notToKeep->elements[0]->u.opaque = 0;
3205         notToKeep->elements[0]->supplementalId = 0;
3206         notToKeep->elements[0]->correlationInfo = 0;
3207         notToKeep->elements[0]->record =
3208             z_ext_record(p->odr_out, syntax_oid,
3209                          record_buf, strlen(record_buf));
3210     }
3211     if (0 && apdu)
3212     {
3213         ODR print = odr_createmem(ODR_PRINT);
3214
3215         z_APDU(print, &apdu, 0, 0);
3216         odr_destroy(print);
3217     }
3218     return apdu;
3219 }
3220
3221 ZOOM_API(void)
3222     ZOOM_package_send(ZOOM_package p, const char *type)
3223 {
3224     Z_APDU *apdu = 0;
3225     ZOOM_connection c;
3226     if (!p)
3227         return;
3228     c = p->connection;
3229     odr_reset(p->odr_out);
3230     xfree(p->buf_out);
3231     p->buf_out = 0;
3232     if (!strcmp(type, "itemorder"))
3233     {
3234         apdu = create_es_package(p, VAL_ITEMORDER);
3235         if (apdu)
3236         {
3237             Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3238
3239             r->direct_reference =
3240                 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3241                                        VAL_ITEMORDER);
3242             r->descriptor = 0;
3243             r->which = Z_External_itemOrder;
3244             r->indirect_reference = 0;
3245             r->u.itemOrder = encode_item_order(p);
3246
3247             apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3248         }
3249     }
3250     else if (!strcmp(type, "create"))  /* create database */
3251     {
3252         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3253                                     0, 0);
3254     }
3255     else if (!strcmp(type, "drop"))  /* drop database */
3256     {
3257         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3258                                     0, 0);
3259     }
3260     else if (!strcmp(type, "commit"))  /* commit changes */
3261     {
3262         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3263                                     0, 0);
3264     }
3265     else if (!strcmp(type, "update")) /* update record(s) */
3266     {
3267         apdu = create_update_package(p);
3268     }
3269     else if (!strcmp(type, "xmlupdate"))
3270     {
3271         apdu = create_xmlupdate_package(p);
3272     }
3273     if (apdu)
3274     {
3275         if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3276         {
3277             char *buf;
3278
3279             ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3280             task->u.package = p;
3281             buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3282             p->buf_out = (char *) xmalloc(p->len_out);
3283             memcpy(p->buf_out, buf, p->len_out);
3284
3285             (p->refcount)++;
3286             if (!c->async)
3287             {
3288                 while (ZOOM_event(1, &c))
3289                     ;
3290             }
3291         }
3292     }
3293 }
3294
3295 ZOOM_API(ZOOM_package)
3296     ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3297 {
3298     ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3299
3300     p->connection = c;
3301     p->odr_out = odr_createmem(ODR_ENCODE);
3302     p->options = ZOOM_options_create_with_parent2(options, c->options);
3303     p->refcount = 1;
3304     p->buf_out = 0;
3305     p->len_out = 0;
3306     return p;
3307 }
3308
3309 ZOOM_API(void)
3310     ZOOM_package_destroy(ZOOM_package p)
3311 {
3312     if (!p)
3313         return;
3314     (p->refcount)--;
3315     if (p->refcount == 0)
3316     {
3317         odr_destroy(p->odr_out);
3318         xfree(p->buf_out);
3319
3320         ZOOM_options_destroy(p->options);
3321         xfree(p);
3322     }
3323 }
3324
3325 ZOOM_API(const char *)
3326     ZOOM_package_option_get(ZOOM_package p, const char *key)
3327 {
3328     return ZOOM_options_get(p->options, key);
3329 }
3330
3331
3332 ZOOM_API(void)
3333     ZOOM_package_option_set(ZOOM_package p, const char *key,
3334                             const char *val)
3335 {
3336     ZOOM_options_set(p->options, key, val);
3337 }
3338
3339 static int ZOOM_connection_exec_task(ZOOM_connection c)
3340 {
3341     ZOOM_task task = c->tasks;
3342     zoom_ret ret = zoom_complete;
3343
3344     if (!task)
3345         return 0;
3346     yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3347             c, task->which, task->running);
3348     if (c->error != ZOOM_ERROR_NONE)
3349     {
3350         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3351                 "removing tasks because of error = %d", c, c->error);
3352         ZOOM_connection_remove_tasks(c);
3353         return 0;
3354     }
3355     if (task->running)
3356     {
3357         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3358                 "task already running", c);
3359         return 0;
3360     }
3361     task->running = 1;
3362     ret = zoom_complete;
3363     if (c->cs || task->which == ZOOM_TASK_CONNECT)
3364     {
3365         switch (task->which)
3366         {
3367         case ZOOM_TASK_SEARCH:
3368             if (c->proto == PROTO_HTTP)
3369                 ret = ZOOM_connection_srw_send_search(c);
3370             else
3371                 ret = ZOOM_connection_send_search(c);
3372             break;
3373         case ZOOM_TASK_RETRIEVE:
3374             if (c->proto == PROTO_HTTP)
3375                 ret = ZOOM_connection_srw_send_search(c);
3376             else
3377                 ret = send_present(c);
3378             break;
3379         case ZOOM_TASK_CONNECT:
3380             ret = do_connect(c);
3381             break;
3382         case ZOOM_TASK_SCAN:
3383             ret = send_scan(c);
3384             break;
3385         case ZOOM_TASK_PACKAGE:
3386             ret = send_package(c);
3387             break;
3388         case ZOOM_TASK_SORT:
3389             c->tasks->u.sort.resultset->r_sort_spec =
3390                 c->tasks->u.sort.q->sort_spec;
3391             ret = send_sort(c, c->tasks->u.sort.resultset);
3392             break;
3393         }
3394     }
3395     else
3396     {
3397         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3398                 "remove tasks because no connection exist", c);
3399         ZOOM_connection_remove_tasks(c);
3400     }
3401     if (ret == zoom_complete)
3402     {
3403         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3404                 "task removed (complete)", c);
3405         ZOOM_connection_remove_task(c);
3406         return 0;
3407     }
3408     yaz_log(log_details, "%p ZOOM_connection_exec_task "
3409             "task pending", c);
3410     return 1;
3411 }
3412
3413 static zoom_ret send_sort_present(ZOOM_connection c)
3414 {
3415     zoom_ret r = zoom_complete;
3416
3417     if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3418         r = send_sort(c, c->tasks->u.search.resultset);
3419     if (r == zoom_complete)
3420         r = send_present(c);
3421     return r;
3422 }
3423
3424 static int es_response(ZOOM_connection c,
3425                        Z_ExtendedServicesResponse *res)
3426 {
3427     if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3428         return 0;
3429     if (res->diagnostics && res->num_diagnostics > 0)
3430         response_diag(c, res->diagnostics[0]);
3431     if (res->taskPackage &&
3432         res->taskPackage->which == Z_External_extendedService)
3433     {
3434         Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3435         Odr_oct *id = taskPackage->targetReference;
3436
3437         if (id)
3438             ZOOM_options_setl(c->tasks->u.package->options,
3439                               "targetReference", (char*) id->buf, id->len);
3440     }
3441     if (res->taskPackage &&
3442         res->taskPackage->which == Z_External_octet)
3443     {
3444         Odr_oct *doc = res->taskPackage->u.octet_aligned;
3445         ZOOM_options_setl(c->tasks->u.package->options,
3446                           "xmlUpdateDoc", (char*) doc->buf, doc->len);
3447     }
3448     return 1;
3449 }
3450
3451 static void interpret_init_diag(ZOOM_connection c,
3452                                 Z_DiagnosticFormat *diag)
3453 {
3454     if (diag->num > 0)
3455     {
3456         Z_DiagnosticFormat_s *ds = diag->elements[0];
3457         if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3458             response_default_diag(c, ds->u.defaultDiagRec);
3459     }
3460 }
3461
3462
3463 static void interpret_otherinformation_field(ZOOM_connection c,
3464                                              Z_OtherInformation *ui)
3465 {
3466     int i;
3467     for (i = 0; i < ui->num_elements; i++)
3468     {
3469         Z_OtherInformationUnit *unit = ui->list[i];
3470         if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3471             unit->information.externallyDefinedInfo &&
3472             unit->information.externallyDefinedInfo->which ==
3473             Z_External_diag1)
3474         {
3475             interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3476         }
3477     }
3478 }
3479
3480
3481 static void set_init_option(const char *name, void *clientData) {
3482     ZOOM_connection c = clientData;
3483     char buf[80];
3484
3485     sprintf(buf, "init_opt_%.70s", name);
3486     ZOOM_connection_option_set(c, buf, "1");
3487 }
3488
3489
3490 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3491 {
3492     Z_InitResponse *initrs;
3493
3494     ZOOM_connection_set_mask(c, 0);
3495     yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3496     switch(apdu->which)
3497     {
3498     case Z_APDU_initResponse:
3499         yaz_log(log_api, "%p recv_apd: Received Init response", c);
3500         initrs = apdu->u.initResponse;
3501         ZOOM_connection_option_set(c, "serverImplementationId",
3502                                    initrs->implementationId ?
3503                                    initrs->implementationId : "");
3504         ZOOM_connection_option_set(c, "serverImplementationName",
3505                                    initrs->implementationName ?
3506                                    initrs->implementationName : "");
3507         ZOOM_connection_option_set(c, "serverImplementationVersion",
3508                                    initrs->implementationVersion ?
3509                                    initrs->implementationVersion : "");
3510         /* Set the three old options too, for old applications */
3511         ZOOM_connection_option_set(c, "targetImplementationId",
3512                                    initrs->implementationId ?
3513                                    initrs->implementationId : "");
3514         ZOOM_connection_option_set(c, "targetImplementationName",
3515                                    initrs->implementationName ?
3516                                    initrs->implementationName : "");
3517         ZOOM_connection_option_set(c, "targetImplementationVersion",
3518                                    initrs->implementationVersion ?
3519                                    initrs->implementationVersion : "");
3520
3521         /* Make initrs->options available as ZOOM-level options */
3522         yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3523
3524         if (!*initrs->result)
3525         {
3526             Z_External *uif = initrs->userInformationField;
3527
3528             set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3529
3530             if (uif && uif->which == Z_External_userInfo1)
3531                 interpret_otherinformation_field(c, uif->u.userInfo1);
3532         }
3533         else
3534         {
3535             char *cookie =
3536                 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3537                                          VAL_COOKIE, 1, 0);
3538             xfree(c->cookie_in);
3539             c->cookie_in = 0;
3540             if (cookie)
3541                 c->cookie_in = xstrdup(cookie);
3542             if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3543                 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3544                 c->support_named_resultsets = 1;
3545             if (c->tasks)
3546             {
3547                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3548                 ZOOM_connection_remove_task(c);
3549             }
3550             ZOOM_connection_exec_task(c);
3551         }
3552         if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3553         {
3554             NMEM tmpmem = nmem_create();
3555             Z_CharSetandLanguageNegotiation *p =
3556                 yaz_get_charneg_record(initrs->otherInfo);
3557
3558             if (p)
3559             {
3560                 char *charset = NULL, *lang = NULL;
3561                 int sel;
3562
3563                 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3564                 yaz_log(log_details, "%p recv_apdu target accepted: "
3565                         "charset %s, language %s, select %d",
3566                         c,
3567                         charset ? charset : "none", lang ? lang : "none", sel);
3568                 if (charset)
3569                     ZOOM_connection_option_set(c, "negotiation-charset",
3570                                                charset);
3571                 if (lang)
3572                     ZOOM_connection_option_set(c, "negotiation-lang",
3573                                                lang);
3574
3575                 ZOOM_connection_option_set(
3576                     c,  "negotiation-charset-in-effect-for-records",
3577                     (sel != 0) ? "1" : "0");
3578                 nmem_destroy(tmpmem);
3579             }
3580         }
3581         break;
3582     case Z_APDU_searchResponse:
3583         yaz_log(log_api, "%p recv_apdu Search response", c);
3584         handle_search_response(c, apdu->u.searchResponse);
3585         if (send_sort_present(c) == zoom_complete)
3586             ZOOM_connection_remove_task(c);
3587         break;
3588     case Z_APDU_presentResponse:
3589         yaz_log(log_api, "%p recv_apdu Present response", c);
3590         handle_present_response(c, apdu->u.presentResponse);
3591         if (send_present(c) == zoom_complete)
3592             ZOOM_connection_remove_task(c);
3593         break;
3594     case Z_APDU_sortResponse:
3595         yaz_log(log_api, "%p recv_apdu Sort response", c);
3596         sort_response(c, apdu->u.sortResponse);
3597         if (send_present(c) == zoom_complete)
3598             ZOOM_connection_remove_task(c);
3599         break;
3600     case Z_APDU_scanResponse:
3601         yaz_log(log_api, "%p recv_apdu Scan response", c);
3602         scan_response(c, apdu->u.scanResponse);
3603         ZOOM_connection_remove_task(c);
3604         break;
3605     case Z_APDU_extendedServicesResponse:
3606         yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3607         es_response(c, apdu->u.extendedServicesResponse);
3608         ZOOM_connection_remove_task(c);
3609         break;
3610     case Z_APDU_close:
3611         yaz_log(log_api, "%p recv_apdu Close PDU", c);
3612         if (!ZOOM_test_reconnect(c))
3613         {
3614             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3615             do_close(c);
3616         }
3617         break;
3618     default:
3619         yaz_log(log_api, "%p Received unknown PDU", c);
3620         set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3621         do_close(c);
3622     }
3623 }
3624
3625 #if YAZ_HAVE_XML2
3626 static void handle_srw_response(ZOOM_connection c,
3627                                 Z_SRW_searchRetrieveResponse *res)
3628 {
3629     ZOOM_resultset resultset = 0;
3630     int i;
3631     NMEM nmem;
3632     ZOOM_Event event;
3633     int *start;
3634     const char *syntax, *elementSetName;
3635
3636     if (!c->tasks)
3637         return;
3638
3639     switch(c->tasks->which)
3640     {
3641     case ZOOM_TASK_SEARCH:
3642         resultset = c->tasks->u.search.resultset;
3643         start = &c->tasks->u.search.start;
3644         syntax = c->tasks->u.search.syntax;
3645         elementSetName = c->tasks->u.search.elementSetName;
3646         break;
3647     case ZOOM_TASK_RETRIEVE:
3648         resultset = c->tasks->u.retrieve.resultset;
3649         start = &c->tasks->u.retrieve.start;
3650         syntax = c->tasks->u.retrieve.syntax;
3651         elementSetName = c->tasks->u.retrieve.elementSetName;
3652         break;
3653     default:
3654         return;
3655     }
3656     event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3657     ZOOM_connection_put_event(c, event);
3658
3659     resultset->size = 0;
3660
3661     yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3662
3663     if (res->numberOfRecords)
3664         resultset->size = *res->numberOfRecords;
3665
3666     for (i = 0; i<res->num_records; i++)
3667     {
3668         int pos;
3669
3670         Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3671             odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3672
3673         if (res->records[i].recordPosition &&
3674             *res->records[i].recordPosition > 0)
3675             pos = *res->records[i].recordPosition - 1;
3676         else
3677             pos = *start + i;
3678
3679         npr->databaseName = 0;
3680         npr->which = Z_NamePlusRecord_databaseRecord;
3681         npr->u.databaseRecord = (Z_External *)
3682             odr_malloc(c->odr_in, sizeof(Z_External));
3683         npr->u.databaseRecord->descriptor = 0;
3684         npr->u.databaseRecord->direct_reference =
3685             yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3686         npr->u.databaseRecord->which = Z_External_octet;
3687
3688         npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3689             odr_malloc(c->odr_in, sizeof(Odr_oct));
3690         npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3691             res->records[i].recordData_buf;
3692         npr->u.databaseRecord->u.octet_aligned->len =
3693             npr->u.databaseRecord->u.octet_aligned->size =
3694             res->records[i].recordData_len;
3695         record_cache_add(resultset, npr, pos, syntax, elementSetName);
3696     }
3697     if (res->num_diagnostics > 0)
3698     {
3699         const char *uri = res->diagnostics[0].uri;
3700         if (uri)
3701         {
3702             int code = 0;
3703             const char *cp;
3704             if ((cp = strrchr(uri, '/')))
3705                 code = atoi(cp+1);
3706             set_dset_error(c, code, uri,
3707                            res->diagnostics[0].details, 0);
3708         }
3709     }
3710     nmem = odr_extract_mem(c->odr_in);
3711     nmem_transfer(resultset->odr->mem, nmem);
3712     nmem_destroy(nmem);
3713 }
3714 #endif
3715
3716 #if YAZ_HAVE_XML2
3717 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3718 {
3719     int ret = -1;
3720     const char *content_type = z_HTTP_header_lookup(hres->headers,
3721                                                     "Content-Type");
3722     const char *connection_head = z_HTTP_header_lookup(hres->headers,
3723                                                        "Connection");
3724     ZOOM_connection_set_mask(c, 0);
3725     yaz_log(log_details, "%p handle_http", c);
3726
3727     if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3728     {
3729         Z_SOAP *soap_package = 0;
3730         ODR o = c->odr_in;
3731         Z_SOAP_Handler soap_handlers[2] = {
3732             {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3733             {0, 0, 0}
3734         };
3735         ret = z_soap_codec(o, &soap_package,
3736                            &hres->content_buf, &hres->content_len,
3737                            soap_handlers);
3738         if (!ret && soap_package->which == Z_SOAP_generic &&
3739             soap_package->u.generic->no == 0)
3740         {
3741             Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3742             if (sr->which == Z_SRW_searchRetrieve_response)
3743                 handle_srw_response(c, sr->u.response);
3744             else
3745                 ret = -1;
3746         }
3747         else if (!ret && (soap_package->which == Z_SOAP_fault
3748                           || soap_package->which == Z_SOAP_error))
3749         {
3750             set_HTTP_error(c, hres->code,
3751                            soap_package->u.fault->fault_code,
3752                            soap_package->u.fault->fault_string);
3753         }
3754         else
3755             ret = -1;
3756     }
3757     if (ret)
3758     {
3759         if (hres->code != 200)
3760             set_HTTP_error(c, hres->code, 0, 0);
3761         else
3762             set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3763         do_close(c);
3764     }
3765     ZOOM_connection_remove_task(c);
3766     if (!strcmp(hres->version, "1.0"))
3767     {
3768         /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3769         if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3770             do_close(c);
3771     }
3772     else
3773     {
3774         /* HTTP 1.1: only if no close we stay alive .. */
3775         if (connection_head && !strcmp(connection_head, "close"))
3776             do_close(c);
3777     }
3778 }
3779 #endif
3780
3781 static int do_read(ZOOM_connection c)
3782 {
3783     int r, more;
3784     ZOOM_Event event;
3785
3786     event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3787     ZOOM_connection_put_event(c, event);
3788
3789     r = cs_get(c->cs, &c->buf_in, &c->len_in);
3790     more = cs_more(c->cs);
3791     yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3792     if (r == 1)
3793         return 0;
3794     if (r <= 0)
3795     {
3796         if (!ZOOM_test_reconnect(c))
3797         {
3798             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3799             do_close(c);
3800         }
3801     }
3802     else
3803     {
3804         Z_GDU *gdu;
3805         ZOOM_Event event;
3806
3807         odr_reset(c->odr_in);
3808         odr_setbuf(c->odr_in, c->buf_in, r, 0);
3809         event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3810         ZOOM_connection_put_event(c, event);
3811
3812         if (!z_GDU(c->odr_in, &gdu, 0, 0))
3813         {
3814             int x;
3815             int err = odr_geterrorx(c->odr_in, &x);
3816             char msg[60];
3817             const char *element = odr_getelement(c->odr_in);
3818             sprintf(msg, "ODR code %d:%d element=%-20s",
3819                     err, x, element ? element : "<unknown>");
3820             set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3821             do_close(c);
3822         }
3823         else if (gdu->which == Z_GDU_Z3950)
3824             recv_apdu(c, gdu->u.z3950);
3825         else if (gdu->which == Z_GDU_HTTP_Response)
3826         {
3827 #if YAZ_HAVE_XML2
3828             handle_http(c, gdu->u.HTTP_Response);
3829 #else
3830             set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3831             do_close(c);
3832 #endif
3833         }
3834         c->reconnect_ok = 0;
3835     }
3836     return 1;
3837 }
3838
3839 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3840 {
3841     int r;
3842     ZOOM_Event event;
3843
3844     event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3845     ZOOM_connection_put_event(c, event);
3846
3847     yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3848     if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3849     {
3850         yaz_log(log_details, "%p do_write_ex write failed", c);
3851         if (ZOOM_test_reconnect(c))
3852         {
3853             return zoom_pending;
3854         }
3855         if (c->state == STATE_CONNECTING)
3856             set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3857         else
3858             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3859         do_close(c);
3860         return zoom_complete;
3861     }
3862     else if (r == 1)
3863     {
3864         int mask = ZOOM_SELECT_EXCEPT;
3865         if (c->cs->io_pending & CS_WANT_WRITE)
3866             mask += ZOOM_SELECT_WRITE;
3867         if (c->cs->io_pending & CS_WANT_READ)
3868             mask += ZOOM_SELECT_READ;
3869         ZOOM_connection_set_mask(c, mask);
3870         yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3871                 c, c->mask);
3872     }
3873     else
3874     {
3875         ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3876         yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3877                 c, c->mask);
3878     }
3879     return zoom_pending;
3880 }
3881
3882 static zoom_ret do_write(ZOOM_connection c)
3883 {
3884     return do_write_ex(c, c->buf_out, c->len_out);
3885 }
3886
3887
3888 ZOOM_API(const char *)
3889     ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3890 {
3891     return ZOOM_options_get(c->options, key);
3892 }
3893
3894 ZOOM_API(const char *)
3895     ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3896 {
3897     return ZOOM_options_getl(c->options, key, lenp);
3898 }
3899
3900 ZOOM_API(void)
3901     ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3902                                const char *val)
3903 {
3904     ZOOM_options_set(c->options, key, val);
3905 }
3906
3907 ZOOM_API(void)
3908     ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3909                                 const char *val, int len)
3910 {
3911     ZOOM_options_setl(c->options, key, val, len);
3912 }
3913
3914 ZOOM_API(const char *)
3915     ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3916 {
3917     return ZOOM_options_get(r->options, key);
3918 }
3919
3920 ZOOM_API(void)
3921     ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3922                               const char *val)
3923 {
3924     ZOOM_options_set(r->options, key, val);
3925 }
3926
3927
3928 ZOOM_API(int)
3929     ZOOM_connection_errcode(ZOOM_connection c)
3930 {
3931     return ZOOM_connection_error(c, 0, 0);
3932 }
3933
3934 ZOOM_API(const char *)
3935     ZOOM_connection_errmsg(ZOOM_connection c)
3936 {
3937     const char *msg;
3938     ZOOM_connection_error(c, &msg, 0);
3939     return msg;
3940 }
3941
3942 ZOOM_API(const char *)
3943     ZOOM_connection_addinfo(ZOOM_connection c)
3944 {
3945     const char *addinfo;
3946     ZOOM_connection_error(c, 0, &addinfo);
3947     return addinfo;
3948 }
3949
3950 ZOOM_API(const char *)
3951     ZOOM_connection_diagset(ZOOM_connection c)
3952 {
3953     const char *diagset;
3954     ZOOM_connection_error_x(c, 0, 0, &diagset);
3955     return diagset;
3956 }
3957
3958 ZOOM_API(const char *)
3959     ZOOM_diag_str(int error)
3960 {
3961     switch (error)
3962     {
3963     case ZOOM_ERROR_NONE:
3964         return "No error";
3965     case ZOOM_ERROR_CONNECT:
3966         return "Connect failed";
3967     case ZOOM_ERROR_MEMORY:
3968         return "Out of memory";
3969     case ZOOM_ERROR_ENCODE:
3970         return "Encoding failed";
3971     case ZOOM_ERROR_DECODE:
3972         return "Decoding failed";
3973     case ZOOM_ERROR_CONNECTION_LOST:
3974         return "Connection lost";
3975     case ZOOM_ERROR_INIT:
3976         return "Init rejected";
3977     case ZOOM_ERROR_INTERNAL:
3978         return "Internal failure";
3979     case ZOOM_ERROR_TIMEOUT:
3980         return "Timeout";
3981     case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3982         return "Unsupported protocol";
3983     case ZOOM_ERROR_UNSUPPORTED_QUERY:
3984         return "Unsupported query type";
3985     case ZOOM_ERROR_INVALID_QUERY:
3986         return "Invalid query";
3987     case ZOOM_ERROR_CQL_PARSE:
3988         return "CQL parsing error";
3989     case ZOOM_ERROR_CQL_TRANSFORM:
3990         return "CQL transformation error";
3991     case ZOOM_ERROR_CCL_CONFIG:
3992         return "CCL configuration error";
3993     case ZOOM_ERROR_CCL_PARSE:
3994         return "CCL parsing error";
3995     default:
3996         return diagbib1_str(error);
3997     }
3998 }
3999
4000 ZOOM_API(int)
4001     ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4002                             const char **addinfo, const char **diagset)
4003 {
4004     int error = c->error;
4005     if (cp)
4006     {
4007         if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4008             *cp = ZOOM_diag_str(error);
4009         else if (!strcmp(c->diagset, "HTTP"))
4010             *cp = z_HTTP_errmsg(c->error);
4011         else if (!strcmp(c->diagset, "Bib-1"))
4012             *cp = ZOOM_diag_str(error);
4013         else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4014             *cp = yaz_diag_srw_str(c->error);
4015         else
4016             *cp = "Unknown error and diagnostic set";
4017     }
4018     if (addinfo)
4019         *addinfo = c->addinfo ? c->addinfo : "";
4020     if (diagset)
4021         *diagset = c->diagset ? c->diagset : "";
4022     return c->error;
4023 }
4024
4025 ZOOM_API(int)
4026     ZOOM_connection_error(ZOOM_connection c, const char **cp,
4027                           const char **addinfo)
4028 {
4029     return ZOOM_connection_error_x(c, cp, addinfo, 0);
4030 }
4031
4032 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4033 {
4034     ZOOM_Event event = 0;
4035     int r = cs_look(c->cs);
4036     yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4037             c, mask, r);
4038
4039     if (r == CS_NONE)
4040     {
4041         event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4042         set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4043         do_close(c);
4044         ZOOM_connection_put_event(c, event);
4045     }
4046     else if (r == CS_CONNECT)
4047     {
4048         int ret = ret = cs_rcvconnect(c->cs);
4049         yaz_log(log_details, "%p ZOOM_connection_do_io "
4050                 "cs_rcvconnect returned %d", c, ret);
4051         if (ret == 1)
4052         {
4053             int mask = ZOOM_SELECT_EXCEPT;
4054             if (c->cs->io_pending & CS_WANT_WRITE)
4055                 mask += ZOOM_SELECT_WRITE;
4056             if (c->cs->io_pending & CS_WANT_READ)
4057                 mask += ZOOM_SELECT_READ;
4058             ZOOM_connection_set_mask(c, mask);
4059         }
4060         else if (ret == 0)
4061         {
4062             event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4063             ZOOM_connection_put_event(c, event);
4064             get_cert(c);
4065             if (c->proto == PROTO_Z3950)
4066                 ZOOM_connection_send_init(c);
4067             else
4068             {
4069                 /* no init request for SRW .. */
4070                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4071                 ZOOM_connection_remove_task(c);
4072                 ZOOM_connection_set_mask(c, 0);
4073                 ZOOM_connection_exec_task(c);
4074             }
4075             c->state = STATE_ESTABLISHED;
4076         }
4077         else
4078         {
4079             set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4080             do_close(c);
4081         }
4082     }
4083     else
4084     {
4085         if (mask & ZOOM_SELECT_EXCEPT)
4086         {
4087             if (!ZOOM_test_reconnect(c))
4088             {
4089                 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4090                 do_close(c);
4091             }
4092             return;
4093         }
4094         if (mask & ZOOM_SELECT_READ)
4095             do_read(c);
4096         if (c->cs && (mask & ZOOM_SELECT_WRITE))
4097             do_write(c);
4098     }
4099 }
4100
4101 ZOOM_API(int)
4102     ZOOM_connection_last_event(ZOOM_connection cs)
4103 {
4104     if (!cs)
4105         return ZOOM_EVENT_NONE;
4106     return cs->last_event;
4107 }
4108
4109
4110 /*
4111  * Returns an xmalloc()d string containing RPN that corresponds to the
4112  * CQL passed in.  On error, sets the Connection object's error state
4113  * and returns a null pointer.
4114  * ### We could cache CQL parser and/or transformer in Connection.
4115  */
4116 static char *cql2pqf(ZOOM_connection c, const char *cql)
4117 {
4118     CQL_parser parser;
4119     int error;
4120     struct cql_node *node;
4121     const char *cqlfile;
4122     static cql_transform_t trans;
4123     char pqfbuf[512];
4124
4125     parser = cql_parser_create();
4126     if ((error = cql_parser_string(parser, cql)) != 0) {
4127         cql_parser_destroy(parser);
4128         set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4129         return 0;
4130     }
4131
4132     node = cql_parser_result(parser);
4133     /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4134
4135     cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4136     if (cqlfile == 0) {
4137         cql_parser_destroy(parser);
4138         cql_node_destroy(node);
4139         set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4140         return 0;
4141     }
4142
4143     if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4144         char buf[512];
4145         cql_parser_destroy(parser);
4146         cql_node_destroy(node);
4147         sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4148                 cqlfile, strerror(errno));
4149         set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4150         return 0;
4151     }
4152
4153     error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4154     cql_parser_destroy(parser);
4155     cql_node_destroy(node);
4156     if (error != 0) {
4157         char buf[512];
4158         const char *addinfo;
4159         error = cql_transform_error(trans, &addinfo);
4160         cql_transform_close(trans);
4161         sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4162         set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4163         return 0;
4164     }
4165
4166     cql_transform_close(trans);
4167     return xstrdup(pqfbuf);
4168 }
4169
4170 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4171 {
4172     if (c->mask)
4173     {
4174         ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4175         /* timeout and this connection was waiting */
4176         set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4177         do_close(c);
4178         ZOOM_connection_put_event(c, event);
4179     }
4180     return 0;
4181 }
4182
4183 ZOOM_API(int)
4184     ZOOM_connection_process(ZOOM_connection c)
4185 {
4186     ZOOM_Event event;
4187     if (!c)
4188         return 0;
4189
4190     event = ZOOM_connection_get_event(c);
4191     if (event)
4192     {
4193         ZOOM_Event_destroy(event);
4194         return 1;
4195     }
4196     ZOOM_connection_exec_task(c);
4197     event = ZOOM_connection_get_event(c);
4198     if (event)
4199     {
4200         ZOOM_Event_destroy(event);
4201         return 1;
4202     }
4203     return 0;
4204 }
4205
4206 ZOOM_API(int)
4207     ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4208 {
4209     int i;
4210
4211     yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4212
4213     for (i = 0; i<no; i++)
4214     {
4215         ZOOM_connection c = cs[i];
4216
4217         if (c && ZOOM_connection_process(c))
4218             return i+1;
4219     }
4220     return 0;
4221 }
4222
4223 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4224 {
4225     if (c->mask && mask)
4226         ZOOM_connection_do_io(c, mask);
4227     return 0;
4228 }
4229
4230 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4231 {
4232     if (c->cs)
4233         return cs_fileno(c->cs);
4234     return -1;
4235 }
4236
4237 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4238 {
4239     c->mask = mask;
4240     if (!c->cs)
4241         return -1;
4242     return 0;
4243 }
4244
4245 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4246 {
4247     if (c->cs)
4248         return c->mask;
4249     return 0;
4250 }
4251
4252 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4253 {
4254     return ZOOM_options_get_int(c->options, "timeout", 30);
4255 }
4256
4257 /*
4258  * Local variables:
4259  * c-basic-offset: 4
4260  * indent-tabs-mode: nil
4261  * End:
4262  * vim: shiftwidth=4 tabstop=8 expandtab
4263  */
4264