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