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