0dd7110f762341c58d3dc386a542189d3a23f60c
[yaz-moved-to-github.git] / src / zoom-c.c
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2010 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=" ODR_INT_PRINTF,
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 *db = 0;
1217
1218         c->proto = PROTO_HTTP;
1219         cs_get_host_args(c->host_port, &db);
1220         xfree(c->path);
1221
1222         c->path = xmalloc(strlen(db) * 3 + 2);
1223         yaz_encode_sru_dbpath_buf(c->path, db);
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         fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1449     gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1450                                        fdatabase ? fdatabase : c->path);
1451
1452     if (c->sru_mode == zoom_sru_get)
1453     {
1454         yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1455     }
1456     else if (c->sru_mode == zoom_sru_post)
1457     {
1458         yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1459     }
1460     else if (c->sru_mode == zoom_sru_soap)
1461     {
1462         yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1463     }
1464     if (!z_GDU(c->odr_out, &gdu, 0, 0))
1465         return zoom_complete;
1466     if (c->odr_print)
1467         z_GDU(c->odr_print, &gdu, 0, 0);
1468     c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1469         
1470     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1471     ZOOM_connection_put_event(c, event);
1472     odr_reset(c->odr_out);
1473     return do_write(c);
1474 }
1475 #endif
1476
1477 #if YAZ_HAVE_XML2
1478 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1479 {
1480     Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1481     sr->username = c->user;
1482     sr->password = c->password;
1483     return sr;
1484 }
1485 #endif
1486
1487 #if YAZ_HAVE_XML2
1488 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1489 {
1490     int i;
1491     int *start, *count;
1492     ZOOM_resultset resultset = 0;
1493     Z_SRW_PDU *sr = 0;
1494     const char *option_val = 0;
1495
1496     if (c->error)                  /* don't continue on error */
1497         return zoom_complete;
1498     assert(c->tasks);
1499     switch(c->tasks->which)
1500     {
1501     case ZOOM_TASK_SEARCH:
1502         resultset = c->tasks->u.search.resultset;
1503         if (!resultset->setname)
1504             resultset->setname = xstrdup("default");
1505         ZOOM_options_set(resultset->options, "setname", resultset->setname);
1506         start = &c->tasks->u.search.start;
1507         count = &c->tasks->u.search.count;
1508         break;
1509     case ZOOM_TASK_RETRIEVE:
1510         resultset = c->tasks->u.retrieve.resultset;
1511
1512         start = &c->tasks->u.retrieve.start;
1513         count = &c->tasks->u.retrieve.count;
1514
1515         if (*start >= resultset->size)
1516             return zoom_complete;
1517         if (*start + *count > resultset->size)
1518             *count = resultset->size - *start;
1519
1520         for (i = 0; i < *count; i++)
1521         {
1522             ZOOM_record rec =
1523                 record_cache_lookup(resultset, i + *start,
1524                                     c->tasks->u.retrieve.syntax,
1525                                     c->tasks->u.retrieve.elementSetName);
1526             if (!rec)
1527                 break;
1528             else
1529             {
1530                 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1531                 ZOOM_connection_put_event(c, event);
1532             }
1533         }
1534         *start += i;
1535         *count -= i;
1536
1537         if (*count == 0)
1538             return zoom_complete;
1539         break;
1540     default:
1541         return zoom_complete;
1542     }
1543     assert(resultset->query);
1544         
1545     sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1546     if (resultset->query->z_query->which == Z_Query_type_104
1547         && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1548     {
1549         sr->u.request->query_type = Z_SRW_query_type_cql;
1550         sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1551     }
1552     else if (resultset->query->z_query->which == Z_Query_type_1 &&
1553              resultset->query->z_query->u.type_1)
1554     {
1555         sr->u.request->query_type = Z_SRW_query_type_pqf;
1556         sr->u.request->query.pqf = resultset->query->query_string;
1557     }
1558     else
1559     {
1560         set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1561         return zoom_complete;
1562     }
1563     sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1564     sr->u.request->maximumRecords = odr_intdup(
1565         c->odr_out, (resultset->step > 0 && resultset->step < *count) ? 
1566         resultset->step : *count);
1567     sr->u.request->recordSchema = resultset->schema;
1568     
1569     option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1570     if (option_val)
1571         sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1572
1573     option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1574     yaz_encode_sru_extra(sr, c->odr_out, option_val);
1575     return send_srw(c, sr);
1576 }
1577 #else
1578 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1579 {
1580     return zoom_complete;
1581 }
1582 #endif
1583
1584 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1585 {
1586     ZOOM_resultset r;
1587     int lslb, ssub, mspn;
1588     const char *syntax;
1589     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1590     Z_SearchRequest *search_req = apdu->u.searchRequest;
1591     const char *elementSetName;
1592     const char *smallSetElementSetName;
1593     const char *mediumSetElementSetName;
1594
1595     assert(c->tasks);
1596     assert(c->tasks->which == ZOOM_TASK_SEARCH);
1597
1598     r = c->tasks->u.search.resultset;
1599
1600     yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1601
1602     elementSetName =
1603         ZOOM_options_get(r->options, "elementSetName");
1604     smallSetElementSetName  =
1605         ZOOM_options_get(r->options, "smallSetElementSetName");
1606     mediumSetElementSetName =
1607         ZOOM_options_get(r->options, "mediumSetElementSetName");
1608
1609     if (!smallSetElementSetName)
1610         smallSetElementSetName = elementSetName;
1611
1612     if (!mediumSetElementSetName)
1613         mediumSetElementSetName = elementSetName;
1614
1615     assert(r);
1616     assert(r->query);
1617
1618     /* prepare query for the search request */
1619     search_req->query = r->query->z_query;
1620     if (!search_req->query)
1621     {
1622         set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1623         return zoom_complete;
1624     }
1625     if (r->query->z_query->which == Z_Query_type_1 || 
1626         r->query->z_query->which == Z_Query_type_101)
1627     {
1628         const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1629         if (cp)
1630         {
1631             yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1632             if (cd)
1633             {
1634                 int r;
1635                 search_req->query = yaz_copy_Z_Query(search_req->query,
1636                                                      c->odr_out);
1637                 
1638                 r = yaz_query_charset_convert_rpnquery_check(
1639                     search_req->query->u.type_1,
1640                     c->odr_out, cd);
1641                 yaz_iconv_close(cd);
1642                 if (r)
1643                 {  /* query could not be char converted */
1644                     set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1645                     return zoom_complete;
1646                 }
1647             }
1648         }
1649     }
1650     search_req->databaseNames = r->databaseNames;
1651     search_req->num_databaseNames = r->num_databaseNames;
1652
1653     /* get syntax (no need to provide unless piggyback is in effect) */
1654     syntax = c->tasks->u.search.syntax;
1655
1656     lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1657     ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1658     mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1659     if (lslb != -1 && ssub != -1 && mspn != -1)
1660     {
1661         /* So're a Z39.50 expert? Let's hope you don't do sort */
1662         *search_req->largeSetLowerBound = lslb;
1663         *search_req->smallSetUpperBound = ssub;
1664         *search_req->mediumSetPresentNumber = mspn;
1665     }
1666     else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1667              && r->piggyback && !r->r_sort_spec && !r->schema)
1668     {
1669         /* Regular piggyback - do it unless we're going to do sort */
1670         *search_req->largeSetLowerBound = 2000000000;
1671         *search_req->smallSetUpperBound = 1;
1672         *search_req->mediumSetPresentNumber = 
1673             r->step>0 ? r->step : c->tasks->u.search.count;
1674     }
1675     else
1676     {
1677         /* non-piggyback. Need not provide elementsets or syntaxes .. */
1678         smallSetElementSetName = 0;
1679         mediumSetElementSetName = 0;
1680         syntax = 0;
1681     }
1682     if (smallSetElementSetName && *smallSetElementSetName)
1683     {
1684         Z_ElementSetNames *esn = (Z_ElementSetNames *)
1685             odr_malloc(c->odr_out, sizeof(*esn));
1686         
1687         esn->which = Z_ElementSetNames_generic;
1688         esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1689         search_req->smallSetElementSetNames = esn;
1690     }
1691     if (mediumSetElementSetName && *mediumSetElementSetName)
1692     {
1693         Z_ElementSetNames *esn =(Z_ElementSetNames *)
1694             odr_malloc(c->odr_out, sizeof(*esn));
1695         
1696         esn->which = Z_ElementSetNames_generic;
1697         esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1698         search_req->mediumSetElementSetNames = esn;
1699     }
1700     if (syntax)
1701         search_req->preferredRecordSyntax =
1702             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1703     
1704     if (!r->setname)
1705     {
1706         if (c->support_named_resultsets)
1707         {
1708             char setname[14];
1709             int ord;
1710             /* find the lowest unused ordinal so that we re-use
1711                result sets on the server. */
1712             for (ord = 1; ; ord++)
1713             {
1714                 ZOOM_resultset rp;
1715                 sprintf(setname, "%d", ord);
1716                 for (rp = c->resultsets; rp; rp = rp->next)
1717                     if (rp->setname && !strcmp(rp->setname, setname))
1718                         break;
1719                 if (!rp)
1720                     break;
1721             }
1722             r->setname = xstrdup(setname);
1723             yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1724                     "set %s", c, r->setname);
1725         }
1726         else
1727         {
1728             yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1729                     "default set", c);
1730             r->setname = xstrdup("default");
1731         }
1732         ZOOM_options_set(r->options, "setname", r->setname);
1733     }
1734     search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1735     return send_APDU(c, apdu);
1736 }
1737
1738 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1739 {
1740     char oid_name_buf[OID_STR_MAX];
1741     const char *oid_name;
1742     char *addinfo = 0;
1743
1744     oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1745     switch (r->which)
1746     {
1747     case Z_DefaultDiagFormat_v2Addinfo:
1748         addinfo = r->u.v2Addinfo;
1749         break;
1750     case Z_DefaultDiagFormat_v3Addinfo:
1751         addinfo = r->u.v3Addinfo;
1752         break;
1753     }
1754     xfree(c->addinfo);
1755     c->addinfo = 0;
1756     set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1757 }
1758
1759 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1760 {
1761     if (p->which != Z_DiagRec_defaultFormat)
1762         set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1763     else
1764         response_default_diag(c, p->u.defaultFormat);
1765 }
1766
1767 ZOOM_API(ZOOM_record)
1768     ZOOM_record_clone(ZOOM_record srec)
1769 {
1770     char *buf;
1771     int size;
1772     ODR odr_enc;
1773     ZOOM_record nrec;
1774
1775     odr_enc = odr_createmem(ODR_ENCODE);
1776     if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1777         return 0;
1778     buf = odr_getbuf(odr_enc, &size, 0);
1779     
1780     nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1781     nrec->odr = odr_createmem(ODR_DECODE);
1782     nrec->wrbuf = 0;
1783     odr_setbuf(nrec->odr, buf, size, 0);
1784     z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1785     
1786     nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1787     nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1788     nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1789     nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1790     nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1791     odr_destroy(odr_enc);
1792     return nrec;
1793 }
1794
1795 ZOOM_API(ZOOM_record)
1796     ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1797 {
1798     const char *syntax =
1799         ZOOM_options_get(s->options, "preferredRecordSyntax"); 
1800     const char *elementSetName =
1801         ZOOM_options_get(s->options, "elementSetName");
1802
1803     return record_cache_lookup(s, pos, syntax, elementSetName);
1804 }
1805
1806 ZOOM_API(ZOOM_record)
1807     ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1808 {
1809     ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1810
1811     if (!rec)
1812     {
1813         /*
1814          * MIKE: I think force_sync should always be zero, but I don't
1815          * want to make this change until I get the go-ahead from
1816          * Adam, in case something depends on the old synchronous
1817          * behaviour.
1818          */
1819         int force_sync = 1;
1820         if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1821         ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1822         rec = ZOOM_resultset_record_immediate(r, pos);
1823     }
1824     return rec;
1825 }
1826
1827 ZOOM_API(void)
1828     ZOOM_record_destroy(ZOOM_record rec)
1829 {
1830     if (!rec)
1831         return;
1832     if (rec->wrbuf)
1833         wrbuf_destroy(rec->wrbuf);
1834     odr_destroy(rec->odr);
1835     xfree(rec);
1836 }
1837
1838
1839 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1840 {
1841     char to[40];
1842     char from[40];
1843     yaz_iconv_t cd = 0;
1844
1845     *from = '\0';
1846     strcpy(to, "UTF-8");
1847     if (record_charset && *record_charset)
1848     {
1849         /* Use "from,to" or just "from" */
1850         const char *cp = strchr(record_charset, ',');
1851         int clen = strlen(record_charset);
1852         if (cp && cp[1])
1853         {
1854             strncpy( to, cp+1, sizeof(to)-1);
1855             to[sizeof(to)-1] = '\0';
1856             clen = cp - record_charset;
1857         }
1858         if (clen > sizeof(from)-1)
1859             clen = sizeof(from)-1;
1860         
1861         if (clen)
1862             strncpy(from, record_charset, clen);
1863         from[clen] = '\0';
1864     }
1865     if (*from && *to)
1866         cd = yaz_iconv_open(to, from);
1867     return cd;
1868 }
1869
1870 static const char *return_marc_record(ZOOM_record rec, int marc_type,
1871                                       int *len,
1872                                       const char *buf, int sz,
1873                                       const char *record_charset)
1874 {
1875     yaz_iconv_t cd = iconv_create_charset(record_charset);
1876     yaz_marc_t mt = yaz_marc_create();
1877     const char *ret_string = 0;
1878
1879     if (cd)
1880         yaz_marc_iconv(mt, cd);
1881     yaz_marc_xml(mt, marc_type);
1882     if (!rec->wrbuf)
1883         rec->wrbuf = wrbuf_alloc();
1884     wrbuf_rewind(rec->wrbuf);
1885     if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf) > 0)
1886     {
1887         if (len)
1888             *len = wrbuf_len(rec->wrbuf);
1889         ret_string = wrbuf_cstr(rec->wrbuf);
1890     }
1891     yaz_marc_destroy(mt);
1892     if (cd)
1893         yaz_iconv_close(cd);
1894     return ret_string;
1895 }
1896
1897 static const char *return_opac_record(ZOOM_record rec, int marc_type,
1898                                       int *len,
1899                                       Z_OPACRecord *opac_rec,
1900                                       const char *record_charset)
1901 {
1902     yaz_iconv_t cd = iconv_create_charset(record_charset);
1903     yaz_marc_t mt = yaz_marc_create();
1904
1905     if (cd)
1906         yaz_marc_iconv(mt, cd);
1907     yaz_marc_xml(mt, marc_type);
1908
1909     if (!rec->wrbuf)
1910         rec->wrbuf = wrbuf_alloc();
1911     wrbuf_rewind(rec->wrbuf);
1912
1913     yaz_opac_decode_wrbuf(mt, opac_rec, rec->wrbuf);
1914     yaz_marc_destroy(mt);
1915
1916     if (cd)
1917         yaz_iconv_close(cd);
1918     if (len)
1919         *len = wrbuf_len(rec->wrbuf);
1920     return wrbuf_cstr(rec->wrbuf);
1921 }
1922
1923 static const char *return_string_record(ZOOM_record rec, int *len,
1924                                         const char *buf, int sz,
1925                                         const char *record_charset)
1926 {
1927     yaz_iconv_t cd = iconv_create_charset(record_charset);
1928
1929     if (cd)
1930     {
1931         if (!rec->wrbuf)
1932             rec->wrbuf = wrbuf_alloc();
1933
1934         wrbuf_rewind(rec->wrbuf);
1935
1936         wrbuf_iconv_write(rec->wrbuf, cd, buf, sz);
1937         wrbuf_iconv_reset(rec->wrbuf, cd);
1938
1939         buf = wrbuf_cstr(rec->wrbuf);
1940         sz = wrbuf_len(rec->wrbuf);
1941         yaz_iconv_close(cd);
1942     }
1943     if (len)
1944         *len = sz;
1945     return buf;
1946 }
1947
1948 static const char *return_record(ZOOM_record rec, int *len,
1949                                  Z_NamePlusRecord *npr,
1950                                  int marctype, const char *charset)
1951 {
1952     Z_External *r = (Z_External *) npr->u.databaseRecord;
1953     const Odr_oid *oid = r->direct_reference;
1954     
1955     /* render bibliographic record .. */
1956     if (r->which == Z_External_OPAC)
1957     {
1958         return return_opac_record(rec, marctype, len,
1959                                   r->u.opac, charset);
1960     }
1961     if (r->which == Z_External_sutrs)
1962         return return_string_record(rec, len,
1963                                     (char*) r->u.sutrs->buf,
1964                                     r->u.sutrs->len,
1965                                     charset);
1966     else if (r->which == Z_External_octet)
1967     {
1968         if (yaz_oid_is_iso2709(oid))
1969         {
1970             const char *ret_buf = return_marc_record(
1971                 rec, marctype, len,
1972                 (const char *) r->u.octet_aligned->buf,
1973                 r->u.octet_aligned->len,
1974                 charset);
1975             if (ret_buf)
1976                 return ret_buf;
1977             /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
1978             if (marctype != YAZ_MARC_ISO2709)
1979                 return 0;
1980         }
1981         return return_string_record(rec, len,
1982                                     (const char *) r->u.octet_aligned->buf,
1983                                     r->u.octet_aligned->len,
1984                                     charset);
1985     }
1986     else if (r->which == Z_External_grs1)
1987     {
1988         if (!rec->wrbuf)
1989             rec->wrbuf = wrbuf_alloc();
1990         wrbuf_rewind(rec->wrbuf);
1991         yaz_display_grs1(rec->wrbuf, r->u.grs1, 0);
1992         return return_string_record(rec, len,
1993                                     wrbuf_buf(rec->wrbuf),
1994                                     wrbuf_len(rec->wrbuf),
1995                                     charset);
1996     }
1997     return 0;
1998 }
1999     
2000
2001 ZOOM_API(int)
2002     ZOOM_record_error(ZOOM_record rec, const char **cp,
2003                       const char **addinfo, const char **diagset)
2004 {
2005     Z_NamePlusRecord *npr;
2006     
2007     if (!rec)
2008         return 0;
2009
2010     npr = rec->npr;
2011     if (rec->diag_uri)
2012     {
2013         if (cp)
2014             *cp = rec->diag_message;
2015         if (addinfo)
2016             *addinfo = rec->diag_details;
2017         if (diagset)
2018             *diagset = rec->diag_set;
2019         return uri_to_code(rec->diag_uri);
2020     }
2021     if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2022     {
2023         Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2024         int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2025         const char *add = 0;
2026
2027         if (diag_rec->which == Z_DiagRec_defaultFormat)
2028         {
2029             Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2030             oid_class oclass;
2031     
2032             error = *ddf->condition;
2033             switch (ddf->which)
2034             {
2035             case Z_DefaultDiagFormat_v2Addinfo:
2036                 add = ddf->u.v2Addinfo;
2037                 break;
2038             case Z_DefaultDiagFormat_v3Addinfo:
2039                 add = ddf->u.v3Addinfo;
2040                 break;
2041             }
2042             if (diagset)
2043                 *diagset =
2044                     yaz_oid_to_string(yaz_oid_std(),
2045                                       ddf->diagnosticSetId, &oclass);
2046         }
2047         else
2048         {
2049             if (diagset)
2050                 *diagset = "Bib-1";
2051         }
2052         if (addinfo)
2053             *addinfo = add ? add : "";
2054         if (cp)
2055             *cp = diagbib1_str(error);
2056         return error;
2057     }
2058     return 0;
2059 }
2060
2061 ZOOM_API(const char *)
2062     ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2063 {
2064     char type[40];
2065     char charset[40];
2066     char xpath[512];
2067     const char *cp;
2068     int i;
2069     Z_NamePlusRecord *npr;
2070     
2071     if (len)
2072         *len = 0; /* default return */
2073         
2074     if (!rec)
2075         return 0;
2076     npr = rec->npr;
2077     if (!npr)
2078         return 0;
2079
2080     cp = type_spec;
2081     for (i = 0; cp[i] && i < sizeof(type)-1; i++)
2082     {
2083         if (cp[i] == ';' || cp[i] == ' ')
2084             break;
2085         type[i] = cp[i];
2086     }
2087     type[i] = '\0';
2088     charset[0] = '\0';
2089     while (type_spec[i] == ';')
2090     {
2091         i++;
2092         while (type_spec[i] == ' ')
2093             i++;
2094         if (!strncmp(type_spec+i, "charset=", 8))
2095         {
2096             int j = 0;
2097             i = i + 8; /* skip charset= */
2098             for (j = 0; type_spec[i]  && j < sizeof(charset)-1; i++, j++)
2099             {
2100                 if (type_spec[i] == ';' || type_spec[i] == ' ')
2101                     break;
2102                 charset[j] = cp[i];
2103             }
2104             charset[j] = '\0';
2105         }
2106         else if (!strncmp(type_spec+i, "xpath=", 6))
2107         {
2108             int j = 0; 
2109             i = i + 6;
2110             for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2111                 xpath[j] = cp[i];
2112             xpath[j] = '\0';
2113         } 
2114         while (type_spec[i] == ' ')
2115             i++;
2116     }
2117     if (!strcmp(type, "database"))
2118     {
2119         if (len)
2120             *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2121         return npr->databaseName;
2122     }
2123     else if (!strcmp(type, "schema"))
2124     {
2125         if (len)
2126             *len = rec->schema ? strlen(rec->schema) : 0;
2127         return rec->schema;
2128     }
2129     else if (!strcmp(type, "syntax"))
2130     {
2131         const char *desc = 0;   
2132         if (npr->which == Z_NamePlusRecord_databaseRecord)
2133         {
2134             Z_External *r = (Z_External *) npr->u.databaseRecord;
2135             desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2136         }
2137         if (!desc)
2138             desc = "none";
2139         if (len)
2140             *len = strlen(desc);
2141         return desc;
2142     }
2143     if (npr->which != Z_NamePlusRecord_databaseRecord)
2144         return 0;
2145
2146     /* from now on - we have a database record .. */
2147     if (!strcmp(type, "render"))
2148     {
2149         return return_record(rec, len, npr, YAZ_MARC_LINE, charset);
2150     }
2151     else if (!strcmp(type, "xml"))
2152     {
2153         return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2154     }
2155     else if (!strcmp(type, "raw"))
2156     {
2157         return return_record(rec, len, npr, YAZ_MARC_ISO2709, charset);
2158     }
2159     else if (!strcmp(type, "ext"))
2160     {
2161         if (len) *len = -1;
2162         return (const char *) npr->u.databaseRecord;
2163     }
2164     else if (!strcmp(type, "opac"))
2165     {
2166         if (npr->u.databaseRecord->which == Z_External_OPAC)
2167             return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2168     }
2169     return 0;
2170 }
2171
2172 static int strcmp_null(const char *v1, const char *v2)
2173 {
2174     if (!v1 && !v2)
2175         return 0;
2176     if (!v1 || !v2)
2177         return -1;
2178     return strcmp(v1, v2);
2179 }
2180
2181 static size_t record_hash(int pos)
2182 {
2183     if (pos < 0)
2184         pos = 0;
2185     return pos % RECORD_HASH_SIZE;
2186 }
2187
2188 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr, 
2189                              int pos,
2190                              const char *syntax, const char *elementSetName,
2191                              const char *schema,
2192                              Z_SRW_diagnostic *diag)
2193 {
2194     ZOOM_record_cache rc = 0;
2195     
2196     ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2197     ZOOM_connection_put_event(r->connection, event);
2198
2199     for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2200     {
2201         if (pos == rc->pos 
2202             && strcmp_null(r->schema, rc->schema) == 0
2203             && strcmp_null(elementSetName,rc->elementSetName) == 0
2204             && strcmp_null(syntax, rc->syntax) == 0)
2205             break;
2206     }
2207     if (!rc)
2208     {
2209         rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2210         rc->rec.odr = 0;
2211         rc->rec.wrbuf = 0;
2212         rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2213         
2214         rc->syntax = odr_strdup_null(r->odr, syntax);
2215         
2216         rc->schema = odr_strdup_null(r->odr, r->schema);
2217
2218         rc->pos = pos;
2219         rc->next = r->record_hash[record_hash(pos)];
2220         r->record_hash[record_hash(pos)] = rc;
2221     }
2222     rc->rec.npr = npr;
2223     rc->rec.schema = odr_strdup_null(r->odr, schema);
2224     rc->rec.diag_set = 0;
2225     rc->rec.diag_uri = 0;
2226     rc->rec.diag_message = 0;
2227     rc->rec.diag_details = 0;
2228     if (diag)
2229     {
2230         if (diag->uri)
2231         {
2232             char *cp;
2233             rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2234             if ((cp = strrchr(rc->rec.diag_set, '/')))
2235                 *cp = '\0';
2236             rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2237         }
2238         rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);            
2239         rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2240     }
2241 }
2242
2243 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2244                                        const char *syntax,
2245                                        const char *elementSetName)
2246 {
2247     ZOOM_record_cache rc;
2248     
2249     for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2250     {
2251         if (pos == rc->pos)
2252         {
2253             if (strcmp_null(r->schema, rc->schema))
2254                 continue;
2255             if (strcmp_null(elementSetName,rc->elementSetName))
2256                 continue;
2257             if (strcmp_null(syntax, rc->syntax))
2258                 continue;
2259             return &rc->rec;
2260         }
2261     }
2262     return 0;
2263 }
2264                                              
2265 static void handle_records(ZOOM_connection c, Z_Records *sr,
2266                            int present_phase)
2267 {
2268     ZOOM_resultset resultset;
2269     int *start, *count;
2270     const char *syntax = 0, *elementSetName = 0;
2271
2272     if (!c->tasks)
2273         return ;
2274     switch (c->tasks->which)
2275     {
2276     case ZOOM_TASK_SEARCH:
2277         resultset = c->tasks->u.search.resultset;
2278         start = &c->tasks->u.search.start;
2279         count = &c->tasks->u.search.count;
2280         syntax = c->tasks->u.search.syntax;
2281         elementSetName = c->tasks->u.search.elementSetName;
2282         break;
2283     case ZOOM_TASK_RETRIEVE:
2284         resultset = c->tasks->u.retrieve.resultset;        
2285         start = &c->tasks->u.retrieve.start;
2286         count = &c->tasks->u.retrieve.count;
2287         syntax = c->tasks->u.retrieve.syntax;
2288         elementSetName = c->tasks->u.retrieve.elementSetName;
2289         break;
2290     default:
2291         return;
2292     }
2293     if (sr && sr->which == Z_Records_NSD)
2294         response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2295     else if (sr && sr->which == Z_Records_multipleNSD)
2296     {
2297         if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2298             response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2299         else
2300             set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2301     }
2302     else 
2303     {
2304         if (*count + *start > resultset->size)
2305             *count = resultset->size - *start;
2306         if (*count < 0)
2307             *count = 0;
2308         if (sr && sr->which == Z_Records_DBOSD)
2309         {
2310             int i;
2311             NMEM nmem = odr_extract_mem(c->odr_in);
2312             Z_NamePlusRecordList *p =
2313                 sr->u.databaseOrSurDiagnostics;
2314             for (i = 0; i<p->num_records; i++)
2315             {
2316                 record_cache_add(resultset, p->records[i], i + *start,
2317                                  syntax, elementSetName,
2318                                  elementSetName, 0);
2319             }
2320             *count -= i;
2321             if (*count < 0)
2322                 *count = 0;
2323             *start += i;
2324             yaz_log(log_details, 
2325                     "handle_records resultset=%p start=%d count=%d",
2326                     resultset, *start, *count);
2327
2328             /* transfer our response to search_nmem .. we need it later */
2329             nmem_transfer(odr_getmem(resultset->odr), nmem);
2330             nmem_destroy(nmem);
2331             if (present_phase && p->num_records == 0)
2332             {
2333                 /* present response and we didn't get any records! */
2334                 Z_NamePlusRecord *myrec = 
2335                     zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2336                 record_cache_add(resultset, myrec, *start,
2337                                  syntax, elementSetName, 0, 0);
2338             }
2339         }
2340         else if (present_phase)
2341         {
2342             /* present response and we didn't get any records! */
2343             Z_NamePlusRecord *myrec = 
2344                 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2345             record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2346                              0, 0);
2347         }
2348     }
2349 }
2350
2351 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2352 {
2353     handle_records(c, pr->records, 1);
2354 }
2355
2356 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2357                                        Z_Term *term)
2358 {
2359     switch (term->which)
2360     {
2361     case Z_Term_general:
2362         ZOOM_options_setl(opt, name,
2363                           (const char *)(term->u.general->buf), 
2364                           term->u.general->len);
2365         break;
2366     case Z_Term_characterString:
2367         ZOOM_options_set(opt, name, term->u.characterString);
2368         break;
2369     case Z_Term_numeric:
2370         ZOOM_options_set_int(opt, name, *term->u.numeric);
2371         break;
2372     }
2373 }
2374
2375 static void handle_queryExpression(ZOOM_options opt, const char *name,
2376                                    Z_QueryExpression *exp)
2377 {
2378     char opt_name[80];
2379     
2380     switch (exp->which)
2381     {
2382     case Z_QueryExpression_term:
2383         if (exp->u.term && exp->u.term->queryTerm)
2384         {
2385             sprintf(opt_name, "%s.term", name);
2386             handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2387         }
2388         break;
2389     case Z_QueryExpression_query:
2390         break;
2391     }
2392 }
2393
2394 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2395                                 Z_OtherInformation *o)
2396 {
2397     int i;
2398     for (i = 0; o && i < o->num_elements; i++)
2399     {
2400         if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2401         {
2402             Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2403             
2404             if (ext->which == Z_External_searchResult1)
2405             {
2406                 int j;
2407                 Z_SearchInfoReport *sr = ext->u.searchResult1;
2408                 
2409                 if (sr->num)
2410                     ZOOM_options_set_int(
2411                         resultset->options, "searchresult.size", sr->num);
2412
2413                 for (j = 0; j < sr->num; j++)
2414                 {
2415                     Z_SearchInfoReport_s *ent =
2416                         ext->u.searchResult1->elements[j];
2417                     char pref[80];
2418                     
2419                     sprintf(pref, "searchresult.%d", j);
2420
2421                     if (ent->subqueryId)
2422                     {
2423                         char opt_name[80];
2424                         sprintf(opt_name, "%s.id", pref);
2425                         ZOOM_options_set(resultset->options, opt_name,
2426                                          ent->subqueryId);
2427                     }
2428                     if (ent->subqueryExpression)
2429                     {
2430                         char opt_name[80];
2431                         sprintf(opt_name, "%s.subquery", pref);
2432                         handle_queryExpression(resultset->options, opt_name,
2433                                                ent->subqueryExpression);
2434                     }
2435                     if (ent->subqueryInterpretation)
2436                     {
2437                         char opt_name[80];
2438                         sprintf(opt_name, "%s.interpretation", pref);
2439                         handle_queryExpression(resultset->options, opt_name,
2440                                                ent->subqueryInterpretation);
2441                     }
2442                     if (ent->subqueryRecommendation)
2443                     {
2444                         char opt_name[80];
2445                         sprintf(opt_name, "%s.recommendation", pref);
2446                         handle_queryExpression(resultset->options, opt_name,
2447                                                ent->subqueryRecommendation);
2448                     }
2449                     if (ent->subqueryCount)
2450                     {
2451                         char opt_name[80];
2452                         sprintf(opt_name, "%s.count", pref);
2453                         ZOOM_options_set_int(resultset->options, opt_name,
2454                                              *ent->subqueryCount);
2455                     }                                             
2456                 }
2457             }
2458         }
2459     }
2460 }
2461
2462 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2463 {
2464     ZOOM_resultset resultset;
2465     ZOOM_Event event;
2466
2467     if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2468         return ;
2469
2470     event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2471     ZOOM_connection_put_event(c, event);
2472
2473     resultset = c->tasks->u.search.resultset;
2474
2475     if (sr->resultSetStatus)
2476     {
2477         ZOOM_options_set_int(resultset->options, "resultSetStatus",
2478                              *sr->resultSetStatus);
2479     }
2480     if (sr->presentStatus)
2481     {
2482         ZOOM_options_set_int(resultset->options, "presentStatus",
2483                              *sr->presentStatus);
2484     }
2485     handle_searchResult(c, resultset, sr->additionalSearchInfo);
2486
2487     resultset->size = *sr->resultCount;
2488     handle_records(c, sr->records, 0);
2489 }
2490
2491 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2492 {
2493     if (res->diagnostics && res->num_diagnostics > 0)
2494         response_diag(c, res->diagnostics[0]);
2495 }
2496
2497 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2498 {
2499     NMEM nmem = odr_extract_mem(c->odr_in);
2500     ZOOM_scanset scan;
2501
2502     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2503         return 0;
2504     scan = c->tasks->u.scan.scan;
2505
2506     if (res->entries && res->entries->nonsurrogateDiagnostics)
2507         response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2508     scan->scan_response = res;
2509     scan->srw_scan_response = 0;
2510     nmem_transfer(odr_getmem(scan->odr), nmem);
2511     if (res->stepSize)
2512         ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2513     if (res->positionOfTerm)
2514         ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2515     if (res->scanStatus)
2516         ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2517     if (res->numberOfEntriesReturned)
2518         ZOOM_options_set_int(scan->options, "number",
2519                              *res->numberOfEntriesReturned);
2520     nmem_destroy(nmem);
2521     return 1;
2522 }
2523
2524 static zoom_ret send_sort(ZOOM_connection c,
2525                           ZOOM_resultset resultset)
2526 {
2527     if (c->error)
2528         resultset->r_sort_spec = 0;
2529     if (resultset->r_sort_spec)
2530     {
2531         Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2532         Z_SortRequest *req = apdu->u.sortRequest;
2533         
2534         req->num_inputResultSetNames = 1;
2535         req->inputResultSetNames = (Z_InternationalString **)
2536             odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2537         req->inputResultSetNames[0] =
2538             odr_strdup(c->odr_out, resultset->setname);
2539         req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2540         req->sortSequence = resultset->r_sort_spec;
2541         resultset->r_sort_spec = 0;
2542         return send_APDU(c, apdu);
2543     }
2544     return zoom_complete;
2545 }
2546
2547 static zoom_ret send_present(ZOOM_connection c)
2548 {
2549     Z_APDU *apdu = 0;
2550     Z_PresentRequest *req = 0;
2551     int i = 0;
2552     const char *syntax = 0;
2553     const char *elementSetName = 0;
2554     ZOOM_resultset  resultset;
2555     int *start, *count;
2556
2557     if (!c->tasks)
2558     {
2559         yaz_log(log_details, "%p send_present no tasks", c);
2560         return zoom_complete;
2561     }
2562     
2563     switch (c->tasks->which)
2564     {
2565     case ZOOM_TASK_SEARCH:
2566         resultset = c->tasks->u.search.resultset;
2567         start = &c->tasks->u.search.start;
2568         count = &c->tasks->u.search.count;
2569         syntax = c->tasks->u.search.syntax;
2570         elementSetName = c->tasks->u.search.elementSetName;
2571         break;
2572     case ZOOM_TASK_RETRIEVE:
2573         resultset = c->tasks->u.retrieve.resultset;
2574         start = &c->tasks->u.retrieve.start;
2575         count = &c->tasks->u.retrieve.count;
2576         syntax = c->tasks->u.retrieve.syntax;
2577         elementSetName = c->tasks->u.retrieve.elementSetName;
2578         break;
2579     default:
2580         return zoom_complete;
2581     }
2582     yaz_log(log_details, "%p send_present start=%d count=%d",
2583             c, *start, *count);
2584
2585     if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2586     {
2587         set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2588                        "", 0);
2589     }
2590     if (c->error)                  /* don't continue on error */
2591         return zoom_complete;
2592     yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2593             resultset, *start, *count);
2594
2595     for (i = 0; i < *count; i++)
2596     {
2597         ZOOM_record rec =
2598             record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2599         if (!rec)
2600             break;
2601         else
2602         {
2603             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2604             ZOOM_connection_put_event(c, event);
2605         }
2606     }
2607     *start += i;
2608     *count -= i;
2609
2610     if (*count == 0)
2611     {
2612         yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2613         return zoom_complete;
2614     }
2615
2616     apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2617     req = apdu->u.presentRequest;
2618
2619     if (i)
2620         yaz_log(log_details, "%p send_present skip=%d", c, i);
2621
2622     *req->resultSetStartPoint = *start + 1;
2623
2624     if (resultset->step > 0 && resultset->step < *count)
2625         *req->numberOfRecordsRequested = resultset->step;
2626     else
2627         *req->numberOfRecordsRequested = *count;
2628     
2629     if (*req->numberOfRecordsRequested + *start > resultset->size)
2630         *req->numberOfRecordsRequested = resultset->size - *start;
2631     assert(*req->numberOfRecordsRequested > 0);
2632
2633     if (syntax && *syntax)
2634         req->preferredRecordSyntax =
2635             zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2636
2637     if (resultset->schema && *resultset->schema)
2638     {
2639         Z_RecordComposition *compo = (Z_RecordComposition *)
2640             odr_malloc(c->odr_out, sizeof(*compo));
2641
2642         req->recordComposition = compo;
2643         compo->which = Z_RecordComp_complex;
2644         compo->u.complex = (Z_CompSpec *)
2645             odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2646         compo->u.complex->selectAlternativeSyntax = (bool_t *) 
2647             odr_malloc(c->odr_out, sizeof(bool_t));
2648         *compo->u.complex->selectAlternativeSyntax = 0;
2649
2650         compo->u.complex->generic = (Z_Specification *)
2651             odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2652
2653         compo->u.complex->generic->which = Z_Schema_oid;
2654         compo->u.complex->generic->schema.oid = (Odr_oid *)
2655             zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2656
2657         if (!compo->u.complex->generic->schema.oid)
2658         {
2659             /* OID wasn't a schema! Try record syntax instead. */
2660
2661             compo->u.complex->generic->schema.oid = (Odr_oid *)
2662                 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2663         }
2664         if (elementSetName && *elementSetName)
2665         {
2666             compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2667                 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2668             compo->u.complex->generic->elementSpec->which =
2669                 Z_ElementSpec_elementSetName;
2670             compo->u.complex->generic->elementSpec->u.elementSetName =
2671                 odr_strdup(c->odr_out, elementSetName);
2672         }
2673         else
2674             compo->u.complex->generic->elementSpec = 0;
2675         compo->u.complex->num_dbSpecific = 0;
2676         compo->u.complex->dbSpecific = 0;
2677         compo->u.complex->num_recordSyntax = 0;
2678         compo->u.complex->recordSyntax = 0;
2679     }
2680     else if (elementSetName && *elementSetName)
2681     {
2682         Z_ElementSetNames *esn = (Z_ElementSetNames *)
2683             odr_malloc(c->odr_out, sizeof(*esn));
2684         Z_RecordComposition *compo = (Z_RecordComposition *)
2685             odr_malloc(c->odr_out, sizeof(*compo));
2686         
2687         esn->which = Z_ElementSetNames_generic;
2688         esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2689         compo->which = Z_RecordComp_simple;
2690         compo->u.simple = esn;
2691         req->recordComposition = compo;
2692     }
2693     req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2694     return send_APDU(c, apdu);
2695 }
2696
2697 ZOOM_API(ZOOM_scanset)
2698     ZOOM_connection_scan(ZOOM_connection c, const char *start)
2699 {
2700     ZOOM_scanset s;
2701     ZOOM_query q = ZOOM_query_create();
2702
2703     ZOOM_query_prefix(q, start);
2704
2705     s = ZOOM_connection_scan1(c, q);
2706     ZOOM_query_destroy(q);
2707     return s;
2708
2709 }
2710
2711 ZOOM_API(ZOOM_scanset)
2712     ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2713 {
2714     ZOOM_scanset scan = 0;
2715
2716     if (!q->z_query)
2717         return 0;
2718     scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2719     scan->connection = c;
2720     scan->odr = odr_createmem(ODR_DECODE);
2721     scan->options = ZOOM_options_create_with_parent(c->options);
2722     scan->refcount = 1;
2723     scan->scan_response = 0;
2724     scan->srw_scan_response = 0;
2725
2726     scan->query = q;
2727     (q->refcount)++;
2728     scan->databaseNames = set_DatabaseNames(c, c->options,
2729                                             &scan->num_databaseNames,
2730                                             scan->odr);
2731
2732     if (1)
2733     {
2734         ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2735         task->u.scan.scan = scan;
2736         
2737         (scan->refcount)++;
2738         if (!c->async)
2739         {
2740             while (ZOOM_event(1, &c))
2741                 ;
2742         }
2743     }
2744     return scan;
2745 }
2746
2747 ZOOM_API(void)
2748     ZOOM_scanset_destroy(ZOOM_scanset scan)
2749 {
2750     if (!scan)
2751         return;
2752     (scan->refcount)--;
2753     if (scan->refcount == 0)
2754     {
2755         ZOOM_query_destroy(scan->query);
2756
2757         odr_destroy(scan->odr);
2758         
2759         ZOOM_options_destroy(scan->options);
2760         xfree(scan);
2761     }
2762 }
2763
2764 static zoom_ret send_package(ZOOM_connection c)
2765 {
2766     ZOOM_Event event;
2767
2768     yaz_log(log_details, "%p send_package", c);
2769     if (!c->tasks)
2770         return zoom_complete;
2771     assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2772     
2773     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2774     ZOOM_connection_put_event(c, event);
2775     
2776     c->buf_out = c->tasks->u.package->buf_out;
2777     c->len_out = c->tasks->u.package->len_out;
2778
2779     return do_write(c);
2780 }
2781
2782 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2783 {
2784     ZOOM_scanset scan;
2785     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2786     Z_ScanRequest *req = apdu->u.scanRequest;
2787
2788     yaz_log(log_details, "%p send_scan", c);
2789     if (!c->tasks)
2790         return zoom_complete;
2791     assert (c->tasks->which == ZOOM_TASK_SCAN);
2792     scan = c->tasks->u.scan.scan;
2793
2794     /* Z39.50 scan can only carry RPN */
2795     if (scan->query->z_query->which == Z_Query_type_1 ||
2796         scan->query->z_query->which == Z_Query_type_101)
2797     {
2798         Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2799         const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2800         if (cp)
2801         {
2802             yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2803             if (cd)
2804             {
2805                 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2806
2807                 yaz_query_charset_convert_rpnquery(
2808                     rpn, c->odr_out, cd);
2809                 yaz_iconv_close(cd);
2810             }
2811         }
2812         req->attributeSet = rpn->attributeSetId;
2813         if (!req->attributeSet)
2814             req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2815         if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2816             rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2817         {
2818             req->termListAndStartPoint =
2819                 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2820         }
2821         else
2822         {
2823             set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2824             return zoom_complete;
2825         }
2826     }
2827     else
2828     {
2829         set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2830         return zoom_complete;
2831     }
2832
2833     *req->numberOfTermsRequested =
2834         ZOOM_options_get_int(scan->options, "number", 10);
2835
2836     req->preferredPositionInResponse =
2837         odr_intdup(c->odr_out,
2838                    ZOOM_options_get_int(scan->options, "position", 1));
2839
2840     req->stepSize =
2841         odr_intdup(c->odr_out,
2842                    ZOOM_options_get_int(scan->options, "stepSize", 0));
2843     
2844     req->databaseNames = scan->databaseNames;
2845     req->num_databaseNames = scan->num_databaseNames;
2846
2847     return send_APDU(c, apdu);
2848 }
2849
2850 #if YAZ_HAVE_XML2
2851 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2852 {
2853     ZOOM_scanset scan;
2854     Z_SRW_PDU *sr = 0;
2855     const char *option_val = 0;
2856
2857     if (!c->tasks)
2858         return zoom_complete;
2859     assert (c->tasks->which == ZOOM_TASK_SCAN);
2860     scan = c->tasks->u.scan.scan;
2861         
2862     sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2863
2864     /* SRU scan can only carry CQL and PQF */
2865     if (scan->query->z_query->which == Z_Query_type_104)
2866     {
2867         sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2868         sr->u.scan_request->scanClause.cql = scan->query->query_string;
2869     }
2870     else if (scan->query->z_query->which == Z_Query_type_1
2871              || scan->query->z_query->which == Z_Query_type_101)
2872     {
2873         sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2874         sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2875     }
2876     else
2877     {
2878         set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2879         return zoom_complete;
2880     }
2881
2882     sr->u.scan_request->maximumTerms = odr_intdup(
2883         c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2884     
2885     sr->u.scan_request->responsePosition = odr_intdup(
2886         c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2887     
2888     option_val = ZOOM_options_get(scan->options, "extraArgs");
2889     yaz_encode_sru_extra(sr, c->odr_out, option_val);
2890     return send_srw(c, sr);
2891 }
2892 #else
2893 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2894 {
2895     return zoom_complete;
2896 }
2897 #endif
2898
2899
2900 ZOOM_API(size_t)
2901     ZOOM_scanset_size(ZOOM_scanset scan)
2902 {
2903     if (!scan)
2904         return 0;
2905
2906     if (scan->scan_response && scan->scan_response->entries)
2907         return scan->scan_response->entries->num_entries;
2908     else if (scan->srw_scan_response)
2909         return scan->srw_scan_response->num_terms;
2910     return 0;
2911 }
2912
2913 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2914                                 size_t *occ,
2915                                 const char **value_term, size_t *value_len,
2916                                 const char **disp_term, size_t *disp_len)
2917 {
2918     size_t noent = ZOOM_scanset_size(scan);
2919     
2920     *value_term = 0;
2921     *value_len = 0;
2922
2923     *disp_term = 0;
2924     *disp_len = 0;
2925
2926     *occ = 0;
2927     if (pos >= noent || pos < 0)
2928         return;
2929     if (scan->scan_response)
2930     {
2931         Z_ScanResponse *res = scan->scan_response;
2932         if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2933         {
2934             Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2935             
2936             *value_term = (const char *) t->term->u.general->buf;
2937             *value_len = t->term->u.general->len;
2938             if (t->displayTerm)
2939             {
2940                 *disp_term = t->displayTerm;
2941                 *disp_len = strlen(*disp_term);
2942             }
2943             else if (t->term->which == Z_Term_general)
2944             {
2945                 *disp_term = (const char *) t->term->u.general->buf;
2946                 *disp_len = t->term->u.general->len;
2947             }
2948             *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2949         }
2950     }
2951     if (scan->srw_scan_response)
2952     {
2953         Z_SRW_scanResponse *res = scan->srw_scan_response;
2954         Z_SRW_scanTerm *t = res->terms + pos;
2955         if (t)
2956         {
2957             *value_term = t->value;
2958             *value_len = strlen(*value_term);
2959
2960             if (t->displayTerm)
2961                 *disp_term = t->displayTerm;
2962             else
2963                 *disp_term = t->value;
2964             *disp_len = strlen(*disp_term);
2965             *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
2966         }
2967     }
2968 }
2969
2970 ZOOM_API(const char *)
2971     ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2972                       size_t *occ, size_t *len)
2973 {
2974     const char *value_term = 0;
2975     size_t value_len = 0;
2976     const char *disp_term = 0;
2977     size_t disp_len = 0;
2978
2979     ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2980                         &disp_term, &disp_len);
2981     
2982     *len = value_len;
2983     return value_term;
2984 }
2985
2986 ZOOM_API(const char *)
2987     ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2988                               size_t *occ, size_t *len)
2989 {
2990     const char *value_term = 0;
2991     size_t value_len = 0;
2992     const char *disp_term = 0;
2993     size_t disp_len = 0;
2994
2995     ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2996                         &disp_term, &disp_len);
2997     
2998     *len = disp_len;
2999     return disp_term;
3000 }
3001
3002 ZOOM_API(const char *)
3003     ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3004 {
3005     return ZOOM_options_get(scan->options, key);
3006 }
3007
3008 ZOOM_API(void)
3009     ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3010                             const char *val)
3011 {
3012     ZOOM_options_set(scan->options, key, val);
3013 }
3014
3015 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3016 {
3017     const char *str;
3018     Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3019     Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3020     
3021     str = ZOOM_options_get(p->options, "package-name");
3022     if (str && *str)
3023         req->packageName = odr_strdup(p->odr_out, str);
3024     
3025     str = ZOOM_options_get(p->options, "user-id");
3026     if (str)
3027         req->userId = odr_strdup_null(p->odr_out, str);
3028     
3029     req->packageType = odr_oiddup(p->odr_out, oid);
3030
3031     str = ZOOM_options_get(p->options, "function");
3032     if (str)
3033     {
3034         if (!strcmp (str, "create"))
3035             *req->function = Z_ExtendedServicesRequest_create;
3036         if (!strcmp (str, "delete"))
3037             *req->function = Z_ExtendedServicesRequest_delete;
3038         if (!strcmp (str, "modify"))
3039             *req->function = Z_ExtendedServicesRequest_modify;
3040     }
3041
3042     str = ZOOM_options_get(p->options, "waitAction");
3043     if (str)
3044     {
3045         if (!strcmp (str, "wait"))
3046             *req->waitAction = Z_ExtendedServicesRequest_wait;
3047         if (!strcmp (str, "waitIfPossible"))
3048             *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3049         if (!strcmp (str, "dontWait"))
3050             *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3051         if (!strcmp (str, "dontReturnPackage"))
3052             *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3053     }
3054     return apdu;
3055 }
3056
3057 static const char *ill_array_lookup(void *clientData, const char *idx)
3058 {
3059     ZOOM_package p = (ZOOM_package) clientData;
3060     return ZOOM_options_get(p->options, idx+4);
3061 }
3062
3063 static Z_External *encode_ill_request(ZOOM_package p)
3064 {
3065     ODR out = p->odr_out;
3066     ILL_Request *req;
3067     Z_External *r = 0;
3068     struct ill_get_ctl ctl;
3069         
3070     ctl.odr = p->odr_out;
3071     ctl.clientData = p;
3072     ctl.f = ill_array_lookup;
3073         
3074     req = ill_get_ILLRequest(&ctl, "ill", 0);
3075         
3076     if (!ill_Request(out, &req, 0, 0))
3077     {
3078         int ill_request_size;
3079         char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3080         if (ill_request_buf)
3081             odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3082         return 0;
3083     }
3084     else
3085     {
3086         int illRequest_size = 0;
3087         char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3088                 
3089         r = (Z_External *) odr_malloc(out, sizeof(*r));
3090         r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3091         r->indirect_reference = 0;
3092         r->descriptor = 0;
3093         r->which = Z_External_single;
3094                 
3095         r->u.single_ASN1_type =
3096             odr_create_Odr_oct(out,
3097                                (unsigned char *)illRequest_buf,
3098                                illRequest_size);
3099     }
3100     return r;
3101 }
3102
3103 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3104 {
3105     Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3106     const char *str;
3107     int len;
3108     
3109     req->which = Z_IOItemOrder_esRequest;
3110     req->u.esRequest = (Z_IORequest *) 
3111         odr_malloc(p->odr_out,sizeof(Z_IORequest));
3112
3113     /* to keep part ... */
3114     req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3115         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3116     req->u.esRequest->toKeep->supplDescription = 0;
3117     req->u.esRequest->toKeep->contact = (Z_IOContact *)
3118         odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3119         
3120     str = ZOOM_options_get(p->options, "contact-name");
3121     req->u.esRequest->toKeep->contact->name =
3122         odr_strdup_null(p->odr_out, str);
3123         
3124     str = ZOOM_options_get(p->options, "contact-phone");
3125     req->u.esRequest->toKeep->contact->phone =
3126         odr_strdup_null(p->odr_out, str);
3127         
3128     str = ZOOM_options_get(p->options, "contact-email");
3129     req->u.esRequest->toKeep->contact->email =
3130         odr_strdup_null(p->odr_out, str);
3131         
3132     req->u.esRequest->toKeep->addlBilling = 0;
3133         
3134     /* not to keep part ... */
3135     req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3136         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3137         
3138     str = ZOOM_options_get(p->options, "itemorder-setname");
3139     if (!str)
3140         str = "default";
3141
3142     if (!*str) 
3143         req->u.esRequest->notToKeep->resultSetItem = 0;
3144     else
3145     {
3146         req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3147             odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3148
3149         req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3150             odr_strdup(p->odr_out, str);
3151         req->u.esRequest->notToKeep->resultSetItem->item =
3152             odr_intdup(p->odr_out, 0);
3153         
3154         str = ZOOM_options_get(p->options, "itemorder-item");
3155         *req->u.esRequest->notToKeep->resultSetItem->item =
3156             (str ? atoi(str) : 1);
3157     }
3158
3159     str = ZOOM_options_getl(p->options, "doc", &len);
3160     if (str)
3161     {
3162         req->u.esRequest->notToKeep->itemRequest =
3163             z_ext_record_xml(p->odr_out, str, len);
3164     }
3165     else
3166         req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3167     
3168     return req;
3169 }
3170
3171 Z_APDU *create_admin_package(ZOOM_package p, int type, 
3172                              Z_ESAdminOriginPartToKeep **toKeepP,
3173                              Z_ESAdminOriginPartNotToKeep **notToKeepP)
3174 {
3175     Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3176     if (apdu)
3177     {
3178         Z_ESAdminOriginPartToKeep  *toKeep;
3179         Z_ESAdminOriginPartNotToKeep  *notToKeep;
3180         Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3181         const char *first_db = "Default";
3182         int num_db;
3183         char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3184                                       p->odr_out);
3185         if (num_db > 0)
3186             first_db = db[0];
3187             
3188         r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3189         r->descriptor = 0;
3190         r->indirect_reference = 0;
3191         r->which = Z_External_ESAdmin;
3192         
3193         r->u.adminService = (Z_Admin *)
3194             odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3195         r->u.adminService->which = Z_Admin_esRequest;
3196         r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3197             odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3198         
3199         toKeep = r->u.adminService->u.esRequest->toKeep =
3200             (Z_ESAdminOriginPartToKeep *) 
3201             odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3202         toKeep->which = type;
3203         toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3204         toKeep->u.create = odr_nullval();
3205         apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3206         
3207         r->u.adminService->u.esRequest->notToKeep = notToKeep =
3208             (Z_ESAdminOriginPartNotToKeep *)
3209             odr_malloc(p->odr_out,
3210                        sizeof(*r->u.adminService->u.esRequest->notToKeep));
3211         notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3212         notToKeep->u.recordsWillFollow = odr_nullval();
3213         if (toKeepP)
3214             *toKeepP = toKeep;
3215         if (notToKeepP)
3216             *notToKeepP = notToKeep;
3217     }
3218     return apdu;
3219 }
3220
3221 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3222 {
3223     Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3224     Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3225     Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3226     int len;
3227     const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3228
3229     if (!doc)
3230     {
3231         doc = "";
3232         len = 0;
3233     }
3234
3235     req->taskSpecificParameters = ext;
3236     ext->direct_reference = req->packageType;
3237     ext->descriptor = 0;
3238     ext->indirect_reference = 0;
3239     
3240     ext->which = Z_External_octet;
3241     ext->u.single_ASN1_type =
3242         odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3243     return apdu;
3244 }
3245
3246 static Z_APDU *create_update_package(ZOOM_package p)
3247 {
3248     Z_APDU *apdu = 0;
3249     const char *first_db = "Default";
3250     int num_db;
3251     char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3252     const char *action = ZOOM_options_get(p->options, "action");
3253     int recordIdOpaque_len;
3254     const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3255         &recordIdOpaque_len);
3256     const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3257     int record_len;
3258     const char *record_buf = ZOOM_options_getl(p->options, "record",
3259         &record_len);
3260     int recordOpaque_len;
3261     const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3262         &recordOpaque_len);
3263     const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3264     const char *version = ZOOM_options_get(p->options, "updateVersion");
3265
3266     const char *correlationInfo_note =
3267         ZOOM_options_get(p->options, "correlationInfo.note");
3268     const char *correlationInfo_id =
3269         ZOOM_options_get(p->options, "correlationInfo.id");
3270     int action_no = -1;
3271     Odr_oid *syntax_oid = 0;
3272     const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3273
3274     if (!version)
3275         version = "3";
3276     if (!syntax_str)
3277         syntax_str = "xml";
3278     if (!record_buf && !recordOpaque_buf)
3279     {
3280         record_buf = "void";
3281         record_len = 4;
3282         syntax_str = "SUTRS";
3283     }
3284
3285     if (syntax_str)
3286     {
3287         syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3288                                            CLASS_RECSYN, syntax_str,
3289                                            p->odr_out);
3290     }
3291     if (!syntax_oid)
3292         return 0;
3293
3294     if (num_db > 0)
3295         first_db = db[0];
3296     
3297     switch(*version)
3298     {
3299     case '1':
3300         package_oid = yaz_oid_extserv_database_update_first_version;
3301         /* old update does not support specialUpdate */
3302         if (!action)
3303             action = "recordInsert";
3304         break;
3305     case '2':
3306         if (!action)
3307             action = "specialUpdate";
3308         package_oid = yaz_oid_extserv_database_update_second_version;
3309         break;
3310     case '3':
3311         if (!action)
3312             action = "specialUpdate";
3313         package_oid = yaz_oid_extserv_database_update;
3314         break;
3315     default:
3316         return 0;
3317     }
3318     
3319     if (!strcmp(action, "recordInsert"))
3320         action_no = Z_IUOriginPartToKeep_recordInsert;
3321     else if (!strcmp(action, "recordReplace"))
3322         action_no = Z_IUOriginPartToKeep_recordReplace;
3323     else if (!strcmp(action, "recordDelete"))
3324         action_no = Z_IUOriginPartToKeep_recordDelete;
3325     else if (!strcmp(action, "elementUpdate"))
3326         action_no = Z_IUOriginPartToKeep_elementUpdate;
3327     else if (!strcmp(action, "specialUpdate"))
3328         action_no = Z_IUOriginPartToKeep_specialUpdate;
3329     else
3330         return 0;
3331
3332     apdu = create_es_package(p, package_oid);
3333     if (apdu)
3334     {
3335         Z_IUOriginPartToKeep *toKeep;
3336         Z_IUSuppliedRecords *notToKeep;
3337         Z_External *r = (Z_External *)
3338             odr_malloc(p->odr_out, sizeof(*r));
3339         const char *elementSetName =
3340             ZOOM_options_get(p->options, "elementSetName");
3341         
3342         apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3343         
3344         r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3345         r->descriptor = 0;
3346         r->which = Z_External_update;
3347         r->indirect_reference = 0;
3348         r->u.update = (Z_IUUpdate *)
3349             odr_malloc(p->odr_out, sizeof(*r->u.update));
3350         
3351         r->u.update->which = Z_IUUpdate_esRequest;
3352         r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3353             odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3354         toKeep = r->u.update->u.esRequest->toKeep = 
3355             (Z_IUOriginPartToKeep *)
3356             odr_malloc(p->odr_out, sizeof(*toKeep));
3357         
3358         toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3359         toKeep->schema = 0;
3360         
3361         toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3362             
3363         toKeep->actionQualifier = 0;
3364         toKeep->action = odr_intdup(p->odr_out, action_no);
3365         
3366         notToKeep = r->u.update->u.esRequest->notToKeep = 
3367             (Z_IUSuppliedRecords *)
3368             odr_malloc(p->odr_out, sizeof(*notToKeep));
3369         notToKeep->num = 1;
3370         notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3371             odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3372         notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3373             odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3374         notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3375         if (recordIdOpaque)
3376         {
3377             notToKeep->elements[0]->u.opaque = 
3378                 odr_create_Odr_oct(p->odr_out,
3379                                    (const unsigned char *) recordIdOpaque,
3380                                    recordIdOpaque_len);
3381         }
3382         else if (recordIdNumber)
3383         {
3384             notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3385             
3386             notToKeep->elements[0]->u.number =
3387                 odr_intdup(p->odr_out, atoi(recordIdNumber));
3388         }
3389         else
3390             notToKeep->elements[0]->u.opaque = 0;
3391         notToKeep->elements[0]->supplementalId = 0;
3392         if (correlationInfo_note || correlationInfo_id)
3393         {
3394             Z_IUCorrelationInfo *ci;
3395             ci = notToKeep->elements[0]->correlationInfo =
3396                 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3397             ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3398             ci->id = correlationInfo_id ?
3399                 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3400         }
3401         else
3402             notToKeep->elements[0]->correlationInfo = 0;
3403         if (recordOpaque_buf)
3404         {
3405             notToKeep->elements[0]->record =
3406                 z_ext_record_oid_any(p->odr_out, syntax_oid,
3407                                  recordOpaque_buf, recordOpaque_len);
3408         }
3409         else
3410         {
3411             notToKeep->elements[0]->record =
3412                 z_ext_record_oid(p->odr_out, syntax_oid,
3413                                  record_buf, record_len);
3414         }
3415     }
3416     if (0 && apdu)
3417     {
3418         ODR print = odr_createmem(ODR_PRINT);
3419
3420         z_APDU(print, &apdu, 0, 0);
3421         odr_destroy(print);
3422     }
3423     return apdu;
3424 }
3425
3426 ZOOM_API(void)
3427     ZOOM_package_send(ZOOM_package p, const char *type)
3428 {
3429     Z_APDU *apdu = 0;
3430     ZOOM_connection c;
3431     if (!p)
3432         return;
3433     c = p->connection;
3434     odr_reset(p->odr_out);
3435     xfree(p->buf_out);
3436     p->buf_out = 0;
3437     if (!strcmp(type, "itemorder"))
3438     {
3439         apdu = create_es_package(p, yaz_oid_extserv_item_order);
3440         if (apdu)
3441         {
3442             Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3443             
3444             r->direct_reference = 
3445                 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3446             r->descriptor = 0;
3447             r->which = Z_External_itemOrder;
3448             r->indirect_reference = 0;
3449             r->u.itemOrder = encode_item_order(p);
3450
3451             apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3452         }
3453     }
3454     else if (!strcmp(type, "create"))  /* create database */
3455     {
3456         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3457                                     0, 0);
3458     }   
3459     else if (!strcmp(type, "drop"))  /* drop database */
3460     {
3461         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3462                                     0, 0);
3463     }
3464     else if (!strcmp(type, "commit"))  /* commit changes */
3465     {
3466         apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3467                                     0, 0);
3468     }
3469     else if (!strcmp(type, "update")) /* update record(s) */
3470     {
3471         apdu = create_update_package(p);
3472     }
3473     else if (!strcmp(type, "xmlupdate"))
3474     {
3475         apdu = create_xmlupdate_package(p);
3476     }
3477     if (apdu)
3478     {
3479         if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3480         {
3481             char *buf;
3482
3483             ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3484             task->u.package = p;
3485             buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3486             p->buf_out = (char *) xmalloc(p->len_out);
3487             memcpy(p->buf_out, buf, p->len_out);
3488             
3489             (p->refcount)++;
3490             if (!c->async)
3491             {
3492                 while (ZOOM_event(1, &c))
3493                     ;
3494             }
3495         }
3496     }
3497 }
3498
3499 ZOOM_API(ZOOM_package)
3500     ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3501 {
3502     ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3503
3504     p->connection = c;
3505     p->odr_out = odr_createmem(ODR_ENCODE);
3506     p->options = ZOOM_options_create_with_parent2(options, c->options);
3507     p->refcount = 1;
3508     p->buf_out = 0;
3509     p->len_out = 0;
3510     return p;
3511 }
3512
3513 ZOOM_API(void)
3514     ZOOM_package_destroy(ZOOM_package p)
3515 {
3516     if (!p)
3517         return;
3518     (p->refcount)--;
3519     if (p->refcount == 0)
3520     {
3521         odr_destroy(p->odr_out);
3522         xfree(p->buf_out);
3523         
3524         ZOOM_options_destroy(p->options);
3525         xfree(p);
3526     }
3527 }
3528
3529 ZOOM_API(const char *)
3530     ZOOM_package_option_get(ZOOM_package p, const char *key)
3531 {
3532     return ZOOM_options_get(p->options, key);
3533 }
3534
3535 ZOOM_API(const char *)
3536     ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3537 {
3538     return ZOOM_options_getl(p->options, key, lenp);
3539 }
3540
3541 ZOOM_API(void)
3542     ZOOM_package_option_set(ZOOM_package p, const char *key,
3543                             const char *val)
3544 {
3545     ZOOM_options_set(p->options, key, val);
3546 }
3547
3548 ZOOM_API(void)
3549     ZOOM_package_option_setl(ZOOM_package p, const char *key,
3550                              const char *val, int len)
3551 {
3552     ZOOM_options_setl(p->options, key, val, len);
3553 }
3554
3555 static int ZOOM_connection_exec_task(ZOOM_connection c)
3556 {
3557     ZOOM_task task = c->tasks;
3558     zoom_ret ret = zoom_complete;
3559
3560     if (!task)
3561         return 0;
3562     yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3563             c, task->which, task->running);
3564     if (c->error != ZOOM_ERROR_NONE)
3565     {
3566         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3567                 "removing tasks because of error = %d", c, c->error);
3568         ZOOM_connection_remove_tasks(c);
3569         return 0;
3570     }
3571     if (task->running)
3572     {
3573         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3574                 "task already running", c);
3575         return 0;
3576     }
3577     task->running = 1;
3578     ret = zoom_complete;
3579     if (c->cs || task->which == ZOOM_TASK_CONNECT)
3580     {
3581         switch (task->which)
3582         {
3583         case ZOOM_TASK_SEARCH:
3584             if (c->proto == PROTO_HTTP)
3585                 ret = ZOOM_connection_srw_send_search(c);
3586             else
3587                 ret = ZOOM_connection_send_search(c);
3588             break;
3589         case ZOOM_TASK_RETRIEVE:
3590             if (c->proto == PROTO_HTTP)
3591                 ret = ZOOM_connection_srw_send_search(c);
3592             else
3593                 ret = send_present(c);
3594             break;
3595         case ZOOM_TASK_CONNECT:
3596             ret = do_connect(c);
3597             break;
3598         case ZOOM_TASK_SCAN:
3599             if (c->proto == PROTO_HTTP)
3600                 ret = ZOOM_connection_srw_send_scan(c);
3601             else
3602                 ret = ZOOM_connection_send_scan(c);
3603             break;
3604         case ZOOM_TASK_PACKAGE:
3605             ret = send_package(c);
3606             break;
3607         case ZOOM_TASK_SORT:
3608             c->tasks->u.sort.resultset->r_sort_spec = 
3609                 c->tasks->u.sort.q->sort_spec;
3610             ret = send_sort(c, c->tasks->u.sort.resultset);
3611             break;
3612         }
3613     }
3614     else
3615     {
3616         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3617                 "remove tasks because no connection exist", c);
3618         ZOOM_connection_remove_tasks(c);
3619     }
3620     if (ret == zoom_complete)
3621     {
3622         yaz_log(log_details, "%p ZOOM_connection_exec_task "
3623                 "task removed (complete)", c);
3624         ZOOM_connection_remove_task(c);
3625         return 0;
3626     }
3627     yaz_log(log_details, "%p ZOOM_connection_exec_task "
3628             "task pending", c);
3629     return 1;
3630 }
3631
3632 static zoom_ret send_sort_present(ZOOM_connection c)
3633 {
3634     zoom_ret r = zoom_complete;
3635
3636     if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3637         r = send_sort(c, c->tasks->u.search.resultset);
3638     if (r == zoom_complete)
3639         r = send_present(c);
3640     return r;
3641 }
3642
3643 static int es_response_taskpackage_update(ZOOM_connection c,
3644                 Z_IUUpdateTaskPackage *utp)
3645 {
3646         if (utp && utp->targetPart)
3647         {
3648                 Z_IUTargetPart *targetPart = utp->targetPart;
3649                 switch ( *targetPart->updateStatus ) {
3650                         case Z_IUTargetPart_success:
3651                                 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3652                                 break;
3653                         case Z_IUTargetPart_partial:
3654                                 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3655                                 break;
3656                         case Z_IUTargetPart_failure:
3657                                 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3658                                 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3659                                         response_diag(c, targetPart->globalDiagnostics[0]);
3660                                 break;
3661                 }
3662                 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3663         }
3664     return 1;
3665 }
3666
3667 static int es_response_taskpackage(ZOOM_connection c,
3668                                    Z_TaskPackage *taskPackage)
3669 {
3670         // targetReference
3671         Odr_oct *id = taskPackage->targetReference;
3672         if (id)
3673                 ZOOM_options_setl(c->tasks->u.package->options,
3674                                                         "targetReference", (char*) id->buf, id->len);
3675         
3676         // taskStatus
3677         switch ( *taskPackage->taskStatus ) {
3678                 case Z_TaskPackage_pending:
3679                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3680                         break;
3681                 case Z_TaskPackage_active:
3682                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3683                         break;
3684                 case Z_TaskPackage_complete:
3685                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3686                         break;
3687                 case Z_TaskPackage_aborted:
3688                         ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3689                         if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3690                                 response_diag(c, taskPackage->packageDiagnostics[0]);
3691                         break;
3692         }
3693         
3694         // taskSpecificParameters
3695         // NOTE: Only Update implemented, no others.
3696         if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3697                         Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3698                         es_response_taskpackage_update(c, utp);
3699         }
3700         return 1;
3701 }
3702
3703
3704 static int es_response(ZOOM_connection c,
3705                        Z_ExtendedServicesResponse *res)
3706 {
3707     if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3708         return 0;
3709     switch (*res->operationStatus) {
3710         case Z_ExtendedServicesResponse_done:
3711             ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3712             break;
3713         case Z_ExtendedServicesResponse_accepted:
3714             ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3715             break;
3716         case Z_ExtendedServicesResponse_failure:
3717             ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3718             if (res->diagnostics && res->num_diagnostics > 0)
3719                 response_diag(c, res->diagnostics[0]);
3720             break;
3721     }
3722     if (res->taskPackage &&
3723         res->taskPackage->which == Z_External_extendedService)
3724     {
3725         Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3726         es_response_taskpackage(c, taskPackage);
3727     }
3728     if (res->taskPackage && 
3729         res->taskPackage->which == Z_External_octet)
3730     {
3731         Odr_oct *doc = res->taskPackage->u.octet_aligned;
3732         ZOOM_options_setl(c->tasks->u.package->options,
3733                           "xmlUpdateDoc", (char*) doc->buf, doc->len);
3734     }
3735     return 1;
3736 }
3737
3738 static void interpret_init_diag(ZOOM_connection c,
3739                                 Z_DiagnosticFormat *diag)
3740 {
3741     if (diag->num > 0)
3742     {
3743         Z_DiagnosticFormat_s *ds = diag->elements[0];
3744         if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3745             response_default_diag(c, ds->u.defaultDiagRec);
3746     }
3747 }
3748
3749
3750 static void interpret_otherinformation_field(ZOOM_connection c,
3751                                              Z_OtherInformation *ui)
3752 {
3753     int i;
3754     for (i = 0; i < ui->num_elements; i++)
3755     {
3756         Z_OtherInformationUnit *unit = ui->list[i];
3757         if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3758             unit->information.externallyDefinedInfo &&
3759             unit->information.externallyDefinedInfo->which ==
3760             Z_External_diag1) 
3761         {
3762             interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3763         } 
3764     }
3765 }
3766
3767
3768 static void set_init_option(const char *name, void *clientData) {
3769     ZOOM_connection c = (ZOOM_connection) clientData;
3770     char buf[80];
3771
3772     sprintf(buf, "init_opt_%.70s", name);
3773     ZOOM_connection_option_set(c, buf, "1");
3774 }
3775
3776
3777 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3778 {
3779     Z_InitResponse *initrs;
3780     
3781     ZOOM_connection_set_mask(c, 0);
3782     yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3783     switch(apdu->which)
3784     {
3785     case Z_APDU_initResponse:
3786         yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3787         initrs = apdu->u.initResponse;
3788         ZOOM_connection_option_set(c, "serverImplementationId",
3789                                    initrs->implementationId ?
3790                                    initrs->implementationId : "");
3791         ZOOM_connection_option_set(c, "serverImplementationName",
3792                                    initrs->implementationName ?
3793                                    initrs->implementationName : "");
3794         ZOOM_connection_option_set(c, "serverImplementationVersion",
3795                                    initrs->implementationVersion ?
3796                                    initrs->implementationVersion : "");
3797         /* Set the three old options too, for old applications */
3798         ZOOM_connection_option_set(c, "targetImplementationId",
3799                                    initrs->implementationId ?
3800                                    initrs->implementationId : "");
3801         ZOOM_connection_option_set(c, "targetImplementationName",
3802                                    initrs->implementationName ?
3803                                    initrs->implementationName : "");
3804         ZOOM_connection_option_set(c, "targetImplementationVersion",
3805                                    initrs->implementationVersion ?
3806                                    initrs->implementationVersion : "");
3807
3808         /* Make initrs->options available as ZOOM-level options */
3809         yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3810
3811         if (!*initrs->result)
3812         {
3813             Z_External *uif = initrs->userInformationField;
3814
3815             set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3816
3817             if (uif && uif->which == Z_External_userInfo1)
3818                 interpret_otherinformation_field(c, uif->u.userInfo1);
3819         }
3820         else
3821         {
3822             char *cookie =
3823                 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3824                                       yaz_oid_userinfo_cookie, 1, 0);
3825             xfree(c->cookie_in);
3826             c->cookie_in = 0;
3827             if (cookie)
3828                 c->cookie_in = xstrdup(cookie);
3829             if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3830                 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3831                 c->support_named_resultsets = 1;
3832             if (c->tasks)
3833             {
3834                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3835                 ZOOM_connection_remove_task(c);
3836             }
3837             ZOOM_connection_exec_task(c);
3838         }
3839         if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3840         {
3841             NMEM tmpmem = nmem_create();
3842             Z_CharSetandLanguageNegotiation *p =
3843                 yaz_get_charneg_record(initrs->otherInfo);
3844             
3845             if (p)
3846             {
3847                 char *charset = NULL, *lang = NULL;
3848                 int sel;
3849                 
3850                 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3851                 yaz_log(log_details, "%p recv_apdu target accepted: "
3852                         "charset %s, language %s, select %d",
3853                         c,
3854                         charset ? charset : "none", lang ? lang : "none", sel);
3855                 if (charset)
3856                     ZOOM_connection_option_set(c, "negotiation-charset",
3857                                                charset);
3858                 if (lang)
3859                     ZOOM_connection_option_set(c, "negotiation-lang",
3860                                                lang);
3861
3862                 ZOOM_connection_option_set(
3863                     c,  "negotiation-charset-in-effect-for-records",
3864                     (sel != 0) ? "1" : "0");
3865                 nmem_destroy(tmpmem);
3866             }
3867         }       
3868         break;
3869     case Z_APDU_searchResponse:
3870         yaz_log(log_api, "%p recv_apdu Search response", c);
3871         handle_search_response(c, apdu->u.searchResponse);
3872         if (send_sort_present(c) == zoom_complete)
3873             ZOOM_connection_remove_task(c);
3874         break;
3875     case Z_APDU_presentResponse:
3876         yaz_log(log_api, "%p recv_apdu Present response", c);
3877         handle_present_response(c, apdu->u.presentResponse);
3878         if (send_present(c) == zoom_complete)
3879             ZOOM_connection_remove_task(c);
3880         break;
3881     case Z_APDU_sortResponse:
3882         yaz_log(log_api, "%p recv_apdu Sort response", c);
3883         sort_response(c, apdu->u.sortResponse);
3884         if (send_present(c) == zoom_complete)
3885             ZOOM_connection_remove_task(c);
3886         break;
3887     case Z_APDU_scanResponse:
3888         yaz_log(log_api, "%p recv_apdu Scan response", c);
3889         scan_response(c, apdu->u.scanResponse);
3890         ZOOM_connection_remove_task(c);
3891         break;
3892     case Z_APDU_extendedServicesResponse:
3893         yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3894         es_response(c, apdu->u.extendedServicesResponse);
3895         ZOOM_connection_remove_task(c);
3896         break;
3897     case Z_APDU_close:
3898         yaz_log(log_api, "%p recv_apdu Close PDU", c);
3899         if (!ZOOM_test_reconnect(c))
3900         {
3901             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3902             do_close(c);
3903         }
3904         break;
3905     default:
3906         yaz_log(log_api, "%p Received unknown PDU", c);
3907         set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3908         do_close(c);
3909     }
3910 }
3911
3912 #if YAZ_HAVE_XML2
3913 static zoom_ret handle_srw_response(ZOOM_connection c,
3914                                     Z_SRW_searchRetrieveResponse *res)
3915 {
3916     ZOOM_resultset resultset = 0;
3917     int i;
3918     NMEM nmem;
3919     ZOOM_Event event;
3920     int *start, *count;
3921     const char *syntax, *elementSetName;
3922
3923     if (!c->tasks)
3924         return zoom_complete;
3925
3926     switch(c->tasks->which)
3927     {
3928     case ZOOM_TASK_SEARCH:
3929         resultset = c->tasks->u.search.resultset;
3930         start = &c->tasks->u.search.start;
3931         count = &c->tasks->u.search.count;
3932         syntax = c->tasks->u.search.syntax;
3933         elementSetName = c->tasks->u.search.elementSetName;        
3934
3935         if (!c->tasks->u.search.recv_search_fired)
3936         {
3937             event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3938             ZOOM_connection_put_event(c, event);
3939             c->tasks->u.search.recv_search_fired = 1;
3940         }
3941         break;
3942     case ZOOM_TASK_RETRIEVE:
3943         resultset = c->tasks->u.retrieve.resultset;
3944         start = &c->tasks->u.retrieve.start;
3945         count = &c->tasks->u.retrieve.count;
3946         syntax = c->tasks->u.retrieve.syntax;
3947         elementSetName = c->tasks->u.retrieve.elementSetName;
3948         break;
3949     default:
3950         return zoom_complete;
3951     }
3952
3953     resultset->size = 0;
3954
3955     if (res->resultSetId)
3956         ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3957
3958     yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3959
3960     if (res->num_diagnostics > 0)
3961     {
3962         set_SRU_error(c, &res->diagnostics[0]);
3963     }
3964     else
3965     {
3966         if (res->numberOfRecords)
3967             resultset->size = *res->numberOfRecords;
3968         for (i = 0; i<res->num_records; i++)
3969         {
3970             int pos;
3971             Z_SRW_record *sru_rec;
3972             Z_SRW_diagnostic *diag = 0;
3973             int num_diag;
3974             
3975             Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3976                 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3977             
3978             if (res->records[i].recordPosition && 
3979                 *res->records[i].recordPosition > 0)
3980                 pos = *res->records[i].recordPosition - 1;
3981             else
3982                 pos = *start + i;
3983             
3984             sru_rec = &res->records[i];
3985             
3986             npr->databaseName = 0;
3987             npr->which = Z_NamePlusRecord_databaseRecord;
3988             npr->u.databaseRecord = (Z_External *)
3989                 odr_malloc(c->odr_in, sizeof(Z_External));
3990             npr->u.databaseRecord->descriptor = 0;
3991             npr->u.databaseRecord->direct_reference =
3992                 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3993             npr->u.databaseRecord->which = Z_External_octet;
3994             
3995             npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3996                 odr_malloc(c->odr_in, sizeof(Odr_oct));
3997             npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3998                 sru_rec->recordData_buf;
3999             npr->u.databaseRecord->u.octet_aligned->len = 
4000                 npr->u.databaseRecord->u.octet_aligned->size = 
4001                 sru_rec->recordData_len;
4002             
4003             if (sru_rec->recordSchema 
4004                 && !strcmp(sru_rec->recordSchema,
4005                            "info:srw/schema/1/diagnostics-v1.1"))
4006             {
4007                 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4008                                                  sru_rec->recordData_len,
4009                                                  &diag, &num_diag,
4010                                                  resultset->odr);
4011             }
4012             record_cache_add(resultset, npr, pos, syntax, elementSetName,
4013                              sru_rec->recordSchema, diag);
4014         }
4015         *count -= i;
4016         *start += i;
4017         if (*count + *start > resultset->size)
4018             *count = resultset->size - *start;
4019         if (*count < 0)
4020             *count = 0;
4021         
4022         nmem = odr_extract_mem(c->odr_in);
4023         nmem_transfer(odr_getmem(resultset->odr), nmem);
4024         nmem_destroy(nmem);
4025
4026         if (*count > 0)
4027             return ZOOM_connection_srw_send_search(c);
4028     }
4029     return zoom_complete;
4030 }
4031 #endif
4032
4033 #if YAZ_HAVE_XML2
4034 static void handle_srw_scan_response(ZOOM_connection c,
4035                                      Z_SRW_scanResponse *res)
4036 {
4037     NMEM nmem = odr_extract_mem(c->odr_in);
4038     ZOOM_scanset scan;
4039
4040     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4041         return;
4042     scan = c->tasks->u.scan.scan;
4043
4044     if (res->num_diagnostics > 0)
4045         set_SRU_error(c, &res->diagnostics[0]);
4046
4047     scan->scan_response = 0;
4048     scan->srw_scan_response = res;
4049     nmem_transfer(odr_getmem(scan->odr), nmem);
4050
4051     ZOOM_options_set_int(scan->options, "number", res->num_terms);
4052     nmem_destroy(nmem);
4053 }
4054 #endif
4055
4056 #if YAZ_HAVE_XML2
4057 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4058 {
4059     zoom_ret cret = zoom_complete;
4060     int ret = -1;
4061     const char *addinfo = 0;
4062     const char *connection_head = z_HTTP_header_lookup(hres->headers,
4063                                                        "Connection");
4064     ZOOM_connection_set_mask(c, 0);
4065     yaz_log(log_details, "%p handle_http", c);
4066     
4067     if (!yaz_srw_check_content_type(hres))
4068         addinfo = "content-type";
4069     else
4070     {
4071         Z_SOAP *soap_package = 0;
4072         ODR o = c->odr_in;
4073         Z_SOAP_Handler soap_handlers[2] = {
4074             {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4075             {0, 0, 0}
4076         };
4077         ret = z_soap_codec(o, &soap_package,
4078                            &hres->content_buf, &hres->content_len,
4079                            soap_handlers);
4080         if (!ret && soap_package->which == Z_SOAP_generic &&
4081             soap_package->u.generic->no == 0)
4082         {
4083             Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4084
4085             ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4086             ZOOM_options_setl(c->options, "sru_extra_response_data",
4087                 sr->extraResponseData_buf, sr->extraResponseData_len);
4088             if (sr->which == Z_SRW_searchRetrieve_response)
4089                 cret = handle_srw_response(c, sr->u.response);
4090             else if (sr->which == Z_SRW_scan_response)
4091                 handle_srw_scan_response(c, sr->u.scan_response);
4092             else
4093                 ret = -1;
4094         }
4095         else if (!ret && (soap_package->which == Z_SOAP_fault
4096                           || soap_package->which == Z_SOAP_error))
4097         {
4098             set_HTTP_error(c, hres->code,
4099                            soap_package->u.fault->fault_code,
4100                            soap_package->u.fault->fault_string);
4101         }
4102         else
4103             ret = -1;
4104     }
4105     if (ret)
4106     {
4107         if (hres->code != 200)
4108             set_HTTP_error(c, hres->code, 0, 0);
4109         else
4110             set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4111         do_close(c);
4112     }
4113     if (cret == zoom_complete)
4114         ZOOM_connection_remove_task(c);
4115     if (!strcmp(hres->version, "1.0"))
4116     {
4117         /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4118         if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4119             do_close(c);
4120     }
4121     else 
4122     {
4123         /* HTTP 1.1: only if no close we stay alive .. */
4124         if (connection_head && !strcmp(connection_head, "close"))
4125             do_close(c);
4126     }
4127 }
4128 #endif
4129
4130 static int do_read(ZOOM_connection c)
4131 {
4132     int r, more;
4133     ZOOM_Event event;
4134     
4135     event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4136     ZOOM_connection_put_event(c, event);
4137     
4138     r = cs_get(c->cs, &c->buf_in, &c->len_in);
4139     more = cs_more(c->cs);
4140     yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4141     if (r == 1)
4142         return 0;
4143     if (r <= 0)
4144     {
4145         if (!ZOOM_test_reconnect(c))
4146         {
4147             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4148             do_close(c);
4149         }
4150     }
4151     else
4152     {
4153         Z_GDU *gdu;
4154         ZOOM_Event event;
4155
4156         odr_reset(c->odr_in);
4157         odr_setbuf(c->odr_in, c->buf_in, r, 0);
4158         event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4159         ZOOM_connection_put_event(c, event);
4160
4161         if (!z_GDU(c->odr_in, &gdu, 0, 0))
4162         {
4163             int x;
4164             int err = odr_geterrorx(c->odr_in, &x);
4165             char msg[100];
4166             const char *element = odr_getelement(c->odr_in);
4167             yaz_snprintf(msg, sizeof(msg),
4168                     "ODR code %d:%d element=%s offset=%d",
4169                     err, x, element ? element : "<unknown>",
4170                     odr_offset(c->odr_in));
4171             set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4172             if (log_api)
4173             {
4174                 FILE *ber_file = yaz_log_file();
4175                 if (ber_file)
4176                     odr_dumpBER(ber_file, c->buf_in, r);
4177             }
4178             do_close(c);
4179         }
4180         else
4181         {
4182             if (c->odr_print)
4183                 z_GDU(c->odr_print, &gdu, 0, 0);
4184             if (gdu->which == Z_GDU_Z3950)
4185                 recv_apdu(c, gdu->u.z3950);
4186             else if (gdu->which == Z_GDU_HTTP_Response)
4187             {
4188 #if YAZ_HAVE_XML2
4189                 handle_http(c, gdu->u.HTTP_Response);
4190 #else
4191                 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4192                 do_close(c);
4193 #endif
4194             }
4195         }
4196         c->reconnect_ok = 0;
4197     }
4198     return 1;
4199 }
4200
4201 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4202 {
4203     int r;
4204     ZOOM_Event event;
4205     
4206     event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4207     ZOOM_connection_put_event(c, event);
4208
4209     yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4210     if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4211     {
4212         yaz_log(log_details, "%p do_write_ex write failed", c);
4213         if (ZOOM_test_reconnect(c))
4214         {
4215             return zoom_pending;
4216         }
4217         if (c->state == STATE_CONNECTING)
4218             set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4219         else
4220             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4221         do_close(c);
4222         return zoom_complete;
4223     }
4224     else if (r == 1)
4225     {    
4226         int mask = ZOOM_SELECT_EXCEPT;
4227         if (c->cs->io_pending & CS_WANT_WRITE)
4228             mask += ZOOM_SELECT_WRITE;
4229         if (c->cs->io_pending & CS_WANT_READ)
4230             mask += ZOOM_SELECT_READ;
4231         ZOOM_connection_set_mask(c, mask);
4232         yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4233                 c, c->mask);
4234     }
4235     else
4236     {
4237         ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4238         yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4239                 c, c->mask);
4240     }
4241     return zoom_pending;
4242 }
4243
4244 static zoom_ret do_write(ZOOM_connection c)
4245 {
4246     return do_write_ex(c, c->buf_out, c->len_out);
4247 }
4248
4249
4250 ZOOM_API(const char *)
4251     ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4252 {
4253     return ZOOM_options_get(c->options, key);
4254 }
4255
4256 ZOOM_API(const char *)
4257     ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4258 {
4259     return ZOOM_options_getl(c->options, key, lenp);
4260 }
4261
4262 ZOOM_API(void)
4263     ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4264                                const char *val)
4265 {
4266     ZOOM_options_set(c->options, key, val);
4267 }
4268
4269 ZOOM_API(void)
4270     ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4271                                 const char *val, int len)
4272 {
4273     ZOOM_options_setl(c->options, key, val, len);
4274 }
4275
4276 ZOOM_API(const char *)
4277     ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4278 {
4279     return ZOOM_options_get(r->options, key);
4280 }
4281
4282 ZOOM_API(void)
4283     ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4284                               const char *val)
4285 {
4286     ZOOM_options_set(r->options, key, val);
4287 }
4288
4289
4290 ZOOM_API(int)
4291     ZOOM_connection_errcode(ZOOM_connection c)
4292 {
4293     return ZOOM_connection_error(c, 0, 0);
4294 }
4295
4296 ZOOM_API(const char *)
4297     ZOOM_connection_errmsg(ZOOM_connection c)
4298 {
4299     const char *msg;
4300     ZOOM_connection_error(c, &msg, 0);
4301     return msg;
4302 }
4303
4304 ZOOM_API(const char *)
4305     ZOOM_connection_addinfo(ZOOM_connection c)
4306 {
4307     const char *addinfo;
4308     ZOOM_connection_error(c, 0, &addinfo);
4309     return addinfo;
4310 }
4311
4312 ZOOM_API(const char *)
4313     ZOOM_connection_diagset(ZOOM_connection c)
4314 {
4315     const char *diagset;
4316     ZOOM_connection_error_x(c, 0, 0, &diagset);
4317     return diagset;
4318 }
4319
4320 ZOOM_API(const char *)
4321     ZOOM_diag_str(int error)
4322 {
4323     switch (error)
4324     {
4325     case ZOOM_ERROR_NONE:
4326         return "No error";
4327     case ZOOM_ERROR_CONNECT:
4328         return "Connect failed";
4329     case ZOOM_ERROR_MEMORY:
4330         return "Out of memory";
4331     case ZOOM_ERROR_ENCODE:
4332         return "Encoding failed";
4333     case ZOOM_ERROR_DECODE:
4334         return "Decoding failed";
4335     case ZOOM_ERROR_CONNECTION_LOST:
4336         return "Connection lost";
4337     case ZOOM_ERROR_INIT:
4338         return "Init rejected";
4339     case ZOOM_ERROR_INTERNAL:
4340         return "Internal failure";
4341     case ZOOM_ERROR_TIMEOUT:
4342         return "Timeout";
4343     case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4344         return "Unsupported protocol";
4345     case ZOOM_ERROR_UNSUPPORTED_QUERY:
4346         return "Unsupported query type";
4347     case ZOOM_ERROR_INVALID_QUERY:
4348         return "Invalid query";
4349     case ZOOM_ERROR_CQL_PARSE:
4350         return "CQL parsing error";
4351     case ZOOM_ERROR_CQL_TRANSFORM:
4352         return "CQL transformation error";
4353     case ZOOM_ERROR_CCL_CONFIG:
4354         return "CCL configuration error";
4355     case ZOOM_ERROR_CCL_PARSE:
4356         return "CCL parsing error";
4357     default:
4358         return diagbib1_str(error);
4359     }
4360 }
4361
4362 ZOOM_API(int)
4363     ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4364                             const char **addinfo, const char **diagset)
4365 {
4366     int error = c->error;
4367     if (cp)
4368     {
4369         if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4370             *cp = ZOOM_diag_str(error);
4371         else if (!strcmp(c->diagset, "HTTP"))
4372             *cp = z_HTTP_errmsg(c->error);
4373         else if (!strcmp(c->diagset, "Bib-1"))
4374             *cp = ZOOM_diag_str(error);
4375         else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4376             *cp = yaz_diag_srw_str(c->error);
4377         else
4378             *cp = "Unknown error and diagnostic set";
4379     }
4380     if (addinfo)
4381         *addinfo = c->addinfo ? c->addinfo : "";
4382     if (diagset)
4383         *diagset = c->diagset ? c->diagset : "";
4384     return c->error;
4385 }
4386
4387 ZOOM_API(int)
4388     ZOOM_connection_error(ZOOM_connection c, const char **cp,
4389                           const char **addinfo)
4390 {
4391     return ZOOM_connection_error_x(c, cp, addinfo, 0);
4392 }
4393
4394 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4395 {
4396     ZOOM_Event event = 0;
4397     int r = cs_look(c->cs);
4398     yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4399             c, mask, r);
4400     
4401     if (r == CS_NONE)
4402     {
4403         event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4404         set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4405         do_close(c);
4406         ZOOM_connection_put_event(c, event);
4407     }
4408     else if (r == CS_CONNECT)
4409     {
4410         int ret = ret = cs_rcvconnect(c->cs);
4411         yaz_log(log_details, "%p ZOOM_connection_do_io "
4412                 "cs_rcvconnect returned %d", c, ret);
4413         if (ret == 1)
4414         {
4415             int mask = ZOOM_SELECT_EXCEPT;
4416             if (c->cs->io_pending & CS_WANT_WRITE)
4417                 mask += ZOOM_SELECT_WRITE;
4418             if (c->cs->io_pending & CS_WANT_READ)
4419                 mask += ZOOM_SELECT_READ;
4420             ZOOM_connection_set_mask(c, mask);
4421             event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4422             ZOOM_connection_put_event(c, event);
4423         }
4424         else if (ret == 0)
4425         {
4426             event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4427             ZOOM_connection_put_event(c, event);
4428             get_cert(c);
4429             if (c->proto == PROTO_Z3950)
4430                 ZOOM_connection_send_init(c);
4431             else
4432             {
4433                 /* no init request for SRW .. */
4434                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4435                 ZOOM_connection_remove_task(c);
4436                 ZOOM_connection_set_mask(c, 0);
4437                 ZOOM_connection_exec_task(c);
4438             }
4439             c->state = STATE_ESTABLISHED;
4440         }
4441         else
4442         {
4443             set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4444             do_close(c);
4445         }
4446     }
4447     else
4448     {
4449         if (mask & ZOOM_SELECT_EXCEPT)
4450         {
4451             if (!ZOOM_test_reconnect(c))
4452             {
4453                 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4454                 do_close(c);
4455             }
4456             return;
4457         }
4458         if (mask & ZOOM_SELECT_READ)
4459             do_read(c);
4460         if (c->cs && (mask & ZOOM_SELECT_WRITE))
4461             do_write(c);
4462     }
4463 }
4464
4465 ZOOM_API(int)
4466     ZOOM_connection_last_event(ZOOM_connection cs)
4467 {
4468     if (!cs)
4469         return ZOOM_EVENT_NONE;
4470     return cs->last_event;
4471 }
4472
4473
4474 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4475 {
4476     WRBUF wrbuf = (WRBUF) client_data;
4477     wrbuf_puts(wrbuf, buf);
4478 }
4479
4480 /*
4481  * Returns an xmalloc()d string containing RPN that corresponds to the
4482  * CQL passed in.  On error, sets the Connection object's error state
4483  * and returns a null pointer.
4484  * ### We could cache CQL parser and/or transformer in Connection.
4485  */
4486 static char *cql2pqf(ZOOM_connection c, const char *cql)
4487 {
4488     CQL_parser parser;
4489     int error;
4490     const char *cqlfile;
4491     cql_transform_t trans;
4492     char *result = 0;
4493
4494     parser = cql_parser_create();
4495     if ((error = cql_parser_string(parser, cql)) != 0) {
4496         cql_parser_destroy(parser);
4497         set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4498         return 0;
4499     }
4500
4501     cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4502     if (cqlfile == 0) 
4503     {
4504         set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4505     }
4506     else if ((trans = cql_transform_open_fname(cqlfile)) == 0) 
4507     {
4508         char buf[512];        
4509         sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4510                 cqlfile, strerror(errno));
4511         set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4512     }
4513     else 
4514     {
4515         WRBUF wrbuf_result = wrbuf_alloc();
4516         error = cql_transform(trans, cql_parser_result(parser),
4517                               cql2pqf_wrbuf_puts, wrbuf_result);
4518         if (error != 0) {
4519             char buf[512];
4520             const char *addinfo;
4521             error = cql_transform_error(trans, &addinfo);
4522             sprintf(buf, "%.200s (addinfo=%.200s)", 
4523                     cql_strerror(error), addinfo);
4524             set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4525         }
4526         else
4527         {
4528             result = xstrdup(wrbuf_cstr(wrbuf_result));
4529         }
4530         cql_transform_close(trans);
4531         wrbuf_destroy(wrbuf_result);
4532     }
4533     cql_parser_destroy(parser);
4534     return result;
4535 }
4536
4537 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4538 {
4539     if (c->mask)
4540     {
4541         ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4542         /* timeout and this connection was waiting */
4543         set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4544         do_close(c);
4545         ZOOM_connection_put_event(c, event);
4546     }
4547     return 0;
4548 }
4549
4550 ZOOM_API(int)
4551     ZOOM_connection_process(ZOOM_connection c)
4552 {
4553     ZOOM_Event event;
4554     if (!c)
4555         return 0;
4556
4557     event = ZOOM_connection_get_event(c);
4558     if (event)
4559     {
4560         ZOOM_Event_destroy(event);
4561         return 1;
4562     }
4563     ZOOM_connection_exec_task(c);
4564     event = ZOOM_connection_get_event(c);
4565     if (event)
4566     {
4567         ZOOM_Event_destroy(event);
4568         return 1;
4569     }
4570     return 0;
4571 }
4572
4573 ZOOM_API(int)
4574     ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4575 {
4576     int i;
4577
4578     yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4579     
4580     for (i = 0; i<no; i++)
4581     {
4582         ZOOM_connection c = cs[i];
4583
4584         if (c && ZOOM_connection_process(c))
4585             return i+1;
4586     }
4587     return 0;
4588 }
4589
4590 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4591 {
4592     if (c->mask && mask)
4593         ZOOM_connection_do_io(c, mask);
4594     return 0;
4595 }
4596
4597 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4598 {
4599     if (c->cs)
4600         return cs_fileno(c->cs);
4601     return -1;
4602 }
4603
4604 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4605 {
4606     c->mask = mask;
4607     if (!c->cs)
4608         return -1; 
4609     return 0;
4610 }
4611
4612 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4613 {
4614     if (c->cs)
4615         return c->mask;
4616     return 0;
4617 }
4618
4619 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4620 {
4621     return ZOOM_options_get_int(c->options, "timeout", 30);
4622 }
4623
4624 /*
4625  * Local variables:
4626  * c-basic-offset: 4
4627  * c-file-style: "Stroustrup"
4628  * indent-tabs-mode: nil
4629  * End:
4630  * vim: shiftwidth=4 tabstop=8 expandtab
4631  */
4632