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