zoom: fix connect options (bad free)
[yaz-moved-to-github.git] / src / zoom-c.c
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2012 Index Data
3  * See the file LICENSE for details.
4  */
5 /**
6  * \file zoom-c.c
7  * \brief Implements ZOOM C interface.
8  */
9 #if HAVE_CONFIG_H
10 #include <config.h>
11 #endif
12
13 #include <assert.h>
14 #include <string.h>
15 #include <errno.h>
16 #include "zoom-p.h"
17
18 #include <yaz/yaz-util.h>
19 #include <yaz/xmalloc.h>
20 #include <yaz/otherinfo.h>
21 #include <yaz/log.h>
22 #include <yaz/diagbib1.h>
23 #include <yaz/charneg.h>
24 #include <yaz/query-charset.h>
25 #include <yaz/snprintf.h>
26 #include <yaz/facet.h>
27
28 #include <yaz/shptr.h>
29
30 #if SHPTR
31 YAZ_SHPTR_TYPE(WRBUF)
32 #endif
33
34 static int log_api0 = 0;
35 static int log_details0 = 0;
36
37 static void resultset_destroy(ZOOM_resultset r);
38 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
39
40 static void initlog(void)
41 {
42     static int log_level_initialized = 0;
43
44     if (!log_level_initialized)
45     {
46         log_api0 = yaz_log_module_level("zoom");
47         log_details0 = yaz_log_module_level("zoomdetails");
48         log_level_initialized = 1;
49     }
50 }
51
52 void ZOOM_connection_remove_tasks(ZOOM_connection c);
53
54 void ZOOM_set_dset_error(ZOOM_connection c, int error,
55                          const char *dset,
56                          const char *addinfo, const char *addinfo2)
57 {
58     char *cp;
59
60     xfree(c->addinfo);
61     c->addinfo = 0;
62     c->error = error;
63     if (!c->diagset || strcmp(dset, c->diagset))
64     {
65         xfree(c->diagset);
66         c->diagset = xstrdup(dset);
67         /* remove integer part from SRW diagset .. */
68         if ((cp = strrchr(c->diagset, '/')))
69             *cp = '\0';
70     }
71     if (addinfo && addinfo2)
72     {
73         c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 3);
74         strcpy(c->addinfo, addinfo);
75         strcat(c->addinfo, ": ");
76         strcat(c->addinfo, addinfo2);
77     }
78     else if (addinfo)
79         c->addinfo = xstrdup(addinfo);
80     if (error != ZOOM_ERROR_NONE)
81     {
82         yaz_log(c->log_api, "%p set_dset_error %s %s:%d %s %s",
83                 c, c->host_port ? c->host_port : "<>", dset, error,
84                 addinfo ? addinfo : "",
85                 addinfo2 ? addinfo2 : "");
86         ZOOM_connection_remove_tasks(c);
87     }
88 }
89
90 int ZOOM_uri_to_code(const char *uri)
91 {
92     int code = 0;       
93     const char *cp;
94     if ((cp = strrchr(uri, '/')))
95         code = atoi(cp+1);
96     return code;
97 }
98
99
100
101 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo)
102 {
103     ZOOM_set_dset_error(c, error, "ZOOM", addinfo, 0);
104 }
105
106 static void clear_error(ZOOM_connection c)
107 {
108     /*
109      * If an error is tied to an operation then it's ok to clear: for
110      * example, a diagnostic returned from a search is cleared by a
111      * subsequent search.  However, problems such as Connection Lost
112      * or Init Refused are not cleared, because they are not
113      * recoverable: doing another search doesn't help.
114      */
115
116     ZOOM_connection_remove_events(c);
117     switch (c->error)
118     {
119     case ZOOM_ERROR_CONNECT:
120     case ZOOM_ERROR_MEMORY:
121     case ZOOM_ERROR_DECODE:
122     case ZOOM_ERROR_CONNECTION_LOST:
123     case ZOOM_ERROR_INIT:
124     case ZOOM_ERROR_INTERNAL:
125     case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
126         break;
127     default:
128         ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
129     }
130 }
131
132 void ZOOM_connection_show_task(ZOOM_task task)
133 {
134     switch(task->which)
135     {
136     case ZOOM_TASK_SEARCH:
137         yaz_log(YLOG_LOG, "search p=%p", task);
138         break;
139     case ZOOM_TASK_RETRIEVE:
140         yaz_log(YLOG_LOG, "retrieve p=%p", task);
141         break;
142     case ZOOM_TASK_CONNECT:
143         yaz_log(YLOG_LOG, "connect p=%p", task);
144         break;
145     case ZOOM_TASK_SCAN:
146         yaz_log(YLOG_LOG, "scan p=%p", task);
147         break;
148     }
149 }
150
151 void ZOOM_connection_show_tasks(ZOOM_connection c)
152 {
153     ZOOM_task task;
154     yaz_log(YLOG_LOG, "connection p=%p tasks", c);
155     for (task = c->tasks; task; task = task->next)
156         ZOOM_connection_show_task(task);
157 }
158
159 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
160 {
161     ZOOM_task *taskp = &c->tasks;
162     while (*taskp)
163         taskp = &(*taskp)->next;
164     *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
165     (*taskp)->running = 0;
166     (*taskp)->which = which;
167     (*taskp)->next = 0;
168     clear_error(c);
169     return *taskp;
170 }
171
172 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
173 {
174     return c->tasks ? 0 : 1;
175 }
176
177 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
178 {
179     ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
180
181     task->next = c->tasks;
182     c->tasks = task;
183
184     task->running = 0;
185     task->which = which;
186     return task;
187 }
188
189 void ZOOM_connection_remove_task(ZOOM_connection c)
190 {
191     ZOOM_task task = c->tasks;
192
193     if (task)
194     {
195         c->tasks = task->next;
196         switch (task->which)
197         {
198         case ZOOM_TASK_SEARCH:
199             resultset_destroy(task->u.search.resultset);
200             xfree(task->u.search.syntax);
201             xfree(task->u.search.elementSetName);
202             break;
203         case ZOOM_TASK_RETRIEVE:
204             resultset_destroy(task->u.retrieve.resultset);
205             xfree(task->u.retrieve.syntax);
206             xfree(task->u.retrieve.elementSetName);
207             break;
208         case ZOOM_TASK_CONNECT:
209             break;
210         case ZOOM_TASK_SCAN:
211             ZOOM_scanset_destroy(task->u.scan.scan);
212             break;
213         case ZOOM_TASK_PACKAGE:
214             ZOOM_package_destroy(task->u.package);
215             break;
216         case ZOOM_TASK_SORT:
217             resultset_destroy(task->u.sort.resultset);
218             ZOOM_query_destroy(task->u.sort.q);
219             break;
220         default:
221             assert(0);
222         }
223         xfree(task);
224
225         if (!c->tasks)
226         {
227             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
228             ZOOM_connection_put_event(c, event);
229         }
230     }
231 }
232
233 void ZOOM_connection_remove_tasks(ZOOM_connection c)
234 {
235     while (c->tasks)
236         ZOOM_connection_remove_task(c);
237 }
238
239 static void odr_wrbuf_write(ODR o, void *handle, int type,
240                             const char *buf, int len)
241 {
242     WRBUF w = (WRBUF) handle;
243     wrbuf_write(w, buf, len);
244 }
245
246 ZOOM_API(ZOOM_connection)
247     ZOOM_connection_create(ZOOM_options options)
248 {
249     ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
250
251     initlog();
252
253     c->log_api = log_api0;
254     c->log_details = log_details0;
255
256     yaz_log(c->log_api, "%p ZOOM_connection_create", c);
257
258     c->proto = PROTO_Z3950;
259     c->cs = 0;
260     ZOOM_connection_set_mask(c, 0);
261     c->reconnect_ok = 0;
262     c->state = STATE_IDLE;
263     c->addinfo = 0;
264     c->diagset = 0;
265     ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
266     c->buf_in = 0;
267     c->len_in = 0;
268     c->buf_out = 0;
269     c->len_out = 0;
270     c->resultsets = 0;
271
272     c->options = ZOOM_options_create_with_parent(options);
273
274     c->host_port = 0;
275     c->proxy = 0;
276     c->tproxy = 0;
277     
278     c->charset = c->lang = 0;
279
280     c->cookie_out = 0;
281     c->cookie_in = 0;
282     c->client_IP = 0;
283     c->tasks = 0;
284
285     c->user = 0;
286     c->group = 0;
287     c->password = 0;
288
289     c->maximum_record_size = 0;
290     c->preferred_message_size = 0;
291
292     c->odr_in = odr_createmem(ODR_DECODE);
293     c->odr_out = odr_createmem(ODR_ENCODE);
294     c->odr_print = 0;
295     c->odr_save = 0;
296
297     c->async = 0;
298     c->support_named_resultsets = 0;
299     c->last_event = ZOOM_EVENT_NONE;
300
301     c->m_queue_front = 0;
302     c->m_queue_back = 0;
303
304     c->sru_version = 0;
305     c->no_redirects = 0;
306     return c;
307 }
308
309 ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w)
310 {
311     if (c->odr_save)
312     {
313         odr_destroy(c->odr_save);
314         c->odr_save = 0;
315     }
316     if (w)
317     {
318         c->odr_save = odr_createmem(ODR_PRINT);
319         odr_set_stream(c->odr_save, w, odr_wrbuf_write, 0);
320     }
321 }
322
323 /* set database names. Take local databases (if set); otherwise
324    take databases given in ZURL (if set); otherwise use Default */
325 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
326                                      int *num, ODR odr)
327 {
328     char **databaseNames;
329     const char *cp = ZOOM_options_get(options, "databaseName");
330     
331     if ((!cp || !*cp) && con->host_port)
332     {
333         if (strncmp(con->host_port, "unix:", 5) == 0)
334             cp = strchr(con->host_port+5, ':');
335         else
336             cp = strchr(con->host_port, '/');
337         if (cp)
338             cp++;
339     }
340     if (!cp || !*cp)
341         cp = "Default";
342     nmem_strsplit(odr_getmem(odr), "+", cp,  &databaseNames, num);
343     return databaseNames;
344 }
345
346 ZOOM_API(ZOOM_connection)
347     ZOOM_connection_new(const char *host, int portnum)
348 {
349     ZOOM_connection c = ZOOM_connection_create(0);
350
351     ZOOM_connection_connect(c, host, portnum);
352     return c;
353 }
354
355 static zoom_sru_mode get_sru_mode_from_string(const char *s)
356 {
357     if (!s || !*s)
358         return zoom_sru_soap;
359     if (!yaz_matchstr(s, "soap"))
360         return zoom_sru_soap;
361     else if (!yaz_matchstr(s, "get"))
362         return zoom_sru_get;
363     else if (!yaz_matchstr(s, "post"))
364         return zoom_sru_post;
365     else if (!yaz_matchstr(s, "solr"))
366         return zoom_sru_solr;
367     return zoom_sru_error;
368 }
369
370 ZOOM_API(void)
371     ZOOM_connection_connect(ZOOM_connection c,
372                             const char *host, int portnum)
373 {
374     const char *val;
375
376     initlog();
377
378     yaz_log(c->log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
379             c, host ? host : "null", portnum);
380
381     ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
382     ZOOM_connection_remove_tasks(c);
383
384     if (c->odr_print)
385     {
386         odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
387         odr_destroy(c->odr_print);
388     }
389     if (ZOOM_options_get_bool(c->options, "apdulog", 0))
390     {
391         c->odr_print = odr_createmem(ODR_PRINT);
392         odr_setprint(c->odr_print, yaz_log_file());
393     }
394     else
395         c->odr_print = 0;
396
397     if (c->cs)
398     {
399         yaz_log(c->log_details, "%p ZOOM_connection_connect reconnect ok", c);
400         c->reconnect_ok = 1;
401         return;
402     }
403     yaz_log(c->log_details, "%p ZOOM_connection_connect connect", c);
404     xfree(c->proxy);
405     c->proxy = 0;
406     val = ZOOM_options_get(c->options, "proxy");
407     if (val && *val)
408     {
409         yaz_log(c->log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
410         c->proxy = xstrdup(val);
411     }
412
413     xfree(c->tproxy);
414     c->tproxy = 0;
415     val = ZOOM_options_get(c->options, "tproxy");
416     if (val && *val)
417     {
418         yaz_log(c->log_details, "%p ZOOM_connection_connect tproxy=%s", c, val);
419         c->tproxy = xstrdup(val);
420     }
421
422
423     xfree(c->charset);
424     c->charset = 0;
425     val = ZOOM_options_get(c->options, "charset");
426     if (val && *val)
427     {
428         yaz_log(c->log_details, "%p ZOOM_connection_connect charset=%s", c, val);
429         c->charset = xstrdup(val);
430     }
431
432     xfree(c->lang);
433     val = ZOOM_options_get(c->options, "lang");
434     if (val && *val)
435     {
436         yaz_log(c->log_details, "%p ZOOM_connection_connect lang=%s", c, val);
437         c->lang = xstrdup(val);
438     }
439     else
440         c->lang = 0;
441
442     if (host)
443     {
444         xfree(c->host_port);
445         if (portnum)
446         {
447             char hostn[128];
448             sprintf(hostn, "%.80s:%d", host, portnum);
449             c->host_port = xstrdup(hostn);
450         }
451         else
452             c->host_port = xstrdup(host);
453     }        
454
455     {
456         /*
457          * If the "<scheme>:" part of the host string is preceded by one
458          * or more comma-separated <name>=<value> pairs, these are taken
459          * to be options to be set on the connection object.  Among other
460          * applications, this facility can be used to embed authentication
461          * in a host string:
462          *          user=admin,password=secret,tcp:localhost:9999
463          */
464         char *remainder = c->host_port;
465         char *pcolon = strchr(remainder, ':');
466         char *pcomma;
467         char *pequals;
468         while ((pcomma = strchr(remainder, ',')) != 0 &&
469                (pcolon == 0 || pcomma < pcolon)) {
470             *pcomma = '\0';
471             if ((pequals = strchr(remainder, '=')) != 0) {
472                 *pequals = '\0';
473                 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
474                 ZOOM_connection_option_set(c, remainder, pequals+1);
475             }
476             remainder = pcomma+1;
477         }
478
479         if (remainder != c->host_port) {
480             remainder = xstrdup(remainder);
481             xfree(c->host_port);
482             c->host_port = remainder;
483             /*printf("# reset hp='%s'\n", remainder);*/
484         }
485     }
486
487     val = ZOOM_options_get(c->options, "sru");
488     c->sru_mode = get_sru_mode_from_string(val);
489
490     xfree(c->sru_version);
491     val = ZOOM_options_get(c->options, "sru_version");
492     c->sru_version = xstrdup(val ? val : "1.2");
493
494     ZOOM_options_set(c->options, "host", c->host_port);
495
496     xfree(c->cookie_out);
497     c->cookie_out = 0;
498     val = ZOOM_options_get(c->options, "cookie");
499     if (val && *val)
500     { 
501         yaz_log(c->log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
502         c->cookie_out = xstrdup(val);
503     }
504
505     xfree(c->client_IP);
506     c->client_IP = 0;
507     val = ZOOM_options_get(c->options, "clientIP");
508     if (val && *val)
509     {
510         yaz_log(c->log_details, "%p ZOOM_connection_connect clientIP=%s",
511                 c, val);
512         c->client_IP = xstrdup(val);
513     }
514
515     xfree(c->group);
516     c->group = 0;
517     val = ZOOM_options_get(c->options, "group");
518     if (val && *val)
519         c->group = xstrdup(val);
520
521     xfree(c->user);
522     c->user = 0;
523     val = ZOOM_options_get(c->options, "user");
524     if (val && *val)
525         c->user = xstrdup(val);
526
527     xfree(c->password);
528     c->password = 0;
529     val = ZOOM_options_get(c->options, "password");
530     if (!val)
531         val = ZOOM_options_get(c->options, "pass");
532
533     if (val && *val)
534         c->password = xstrdup(val);
535     
536     c->maximum_record_size =
537         ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
538     c->preferred_message_size =
539         ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
540
541     c->async = ZOOM_options_get_bool(c->options, "async", 0);
542
543     if (c->sru_mode == zoom_sru_error)
544     {
545         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, val);
546         ZOOM_connection_remove_tasks(c);
547         return;
548     }
549
550     yaz_log(c->log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
551     ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
552
553     if (!c->async)
554     {
555         while (ZOOM_event(1, &c))
556             ;
557     }
558 }
559
560 ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
561 {
562 #if ZOOM_RESULT_LISTS
563 #else
564     if (r->connection)
565     {
566         /* remove ourselves from the resultsets in connection */
567         ZOOM_resultset *rp = &r->connection->resultsets;
568         while (1)
569         {
570             assert(*rp);   /* we must be in this list!! */
571             if (*rp == r)
572             {   /* OK, we're here - take us out of it */
573                 *rp = (*rp)->next;
574                 break;
575             }
576             rp = &(*rp)->next;
577         }
578         r->connection = 0;
579     }
580 #endif
581 }
582
583 ZOOM_API(void)
584     ZOOM_connection_destroy(ZOOM_connection c)
585 {
586 #if ZOOM_RESULT_LISTS
587     ZOOM_resultsets list;
588 #else
589     ZOOM_resultset r;
590 #endif
591     if (!c)
592         return;
593     yaz_log(c->log_api, "%p ZOOM_connection_destroy", c);
594     if (c->cs)
595         cs_close(c->cs);
596
597 #if ZOOM_RESULT_LISTS
598     /* Remove the connection's usage of resultsets */
599     list = c->resultsets;
600     while (list) {
601         ZOOM_resultsets removed = list;
602         ZOOM_resultset_destroy(list->resultset);
603         list = list->next;
604         xfree(removed);
605     }
606 #else
607     for (r = c->resultsets; r; r = r->next)
608         r->connection = 0;
609 #endif
610
611     xfree(c->buf_in);
612     xfree(c->addinfo);
613     xfree(c->diagset);
614     odr_destroy(c->odr_in);
615     odr_destroy(c->odr_out);
616     if (c->odr_save)
617         odr_destroy(c->odr_save);
618     if (c->odr_print)
619     {
620         odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
621         odr_destroy(c->odr_print);
622     }
623     ZOOM_options_destroy(c->options);
624     ZOOM_connection_remove_tasks(c);
625     ZOOM_connection_remove_events(c);
626     xfree(c->host_port);
627     xfree(c->proxy);
628     xfree(c->tproxy);
629     xfree(c->charset);
630     xfree(c->lang);
631     xfree(c->cookie_out);
632     xfree(c->cookie_in);
633     xfree(c->client_IP);
634     xfree(c->user);
635     xfree(c->group);
636     xfree(c->password);
637     xfree(c->sru_version);
638     xfree(c);
639 }
640
641 void ZOOM_resultset_addref(ZOOM_resultset r)
642 {
643     if (r)
644     {
645         yaz_mutex_enter(r->mutex);
646         (r->refcount)++;
647         yaz_log(log_details0, "%p ZOOM_resultset_addref count=%d",
648                 r, r->refcount);
649         yaz_mutex_leave(r->mutex);
650     }
651 }
652
653 static int g_resultsets = 0;
654 static YAZ_MUTEX g_resultset_mutex = 0;
655
656 /* TODO We need to initialize this before running threaded:
657  * call resultset_use(0)  */
658
659 static int resultset_use(int delta) {
660     int resultset_count;
661     if (g_resultset_mutex == 0)
662         yaz_mutex_create(&g_resultset_mutex);
663     yaz_mutex_enter(g_resultset_mutex);
664     g_resultsets += delta;
665     resultset_count = g_resultsets;
666     yaz_mutex_leave(g_resultset_mutex);
667     return resultset_count;
668 }
669
670 int resultsets_count(void) {
671     return resultset_use(0);
672 }
673
674 ZOOM_resultset ZOOM_resultset_create(void)
675 {
676     int i;
677     ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
678
679     initlog();
680
681     yaz_log(log_details0, "%p ZOOM_resultset_create", r);
682     r->refcount = 1;
683     r->size = 0;
684     r->odr = odr_createmem(ODR_ENCODE);
685     r->piggyback = 1;
686     r->setname = 0;
687     r->schema = 0;
688     r->step = 0;
689     for (i = 0; i<RECORD_HASH_SIZE; i++)
690         r->record_hash[i] = 0;
691     r->r_sort_spec = 0;
692     r->query = 0;
693     r->connection = 0;
694     r->databaseNames = 0;
695     r->num_databaseNames = 0;
696     r->facets = 0;
697     r->num_facets = 0;
698     r->facets_names = 0;
699     r->mutex = 0;
700     yaz_mutex_create(&r->mutex);
701 #if SHPTR
702     {
703         WRBUF w = wrbuf_alloc();
704         YAZ_SHPTR_INIT(r->record_wrbuf, w);
705     }
706 #endif
707     resultset_use(1);
708     return r;
709 }
710
711 ZOOM_API(ZOOM_resultset)
712     ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
713 {
714     ZOOM_resultset r;
715     ZOOM_query s = ZOOM_query_create();
716
717     ZOOM_query_prefix(s, q);
718
719     r = ZOOM_connection_search(c, s);
720     ZOOM_query_destroy(s);
721     return r;
722 }
723
724 ZOOM_API(ZOOM_resultset)
725     ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
726 {
727     ZOOM_resultset r = ZOOM_resultset_create();
728     ZOOM_task task;
729     const char *cp;
730     int start, count;
731     const char *syntax, *elementSetName;
732 #if ZOOM_RESULT_LISTS
733     ZOOM_resultsets set;
734 #endif
735
736     yaz_log(c->log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
737     r->r_sort_spec = ZOOM_query_get_sortspec(q);
738     r->query = q;
739
740     r->options = ZOOM_options_create_with_parent(c->options);
741     
742     start = ZOOM_options_get_int(r->options, "start", 0);
743     count = ZOOM_options_get_int(r->options, "count", 0);
744     {
745         /* If "presentChunk" is defined use that; otherwise "step" */
746         const char *cp = ZOOM_options_get(r->options, "presentChunk");
747         r->step = ZOOM_options_get_int(r->options,
748                                        (cp != 0 ? "presentChunk": "step"), 0);
749     }
750     r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
751     cp = ZOOM_options_get(r->options, "setname");
752     if (cp)
753         r->setname = xstrdup(cp);
754     cp = ZOOM_options_get(r->options, "schema");
755     if (cp)
756         r->schema = xstrdup(cp);
757
758     r->databaseNames = ZOOM_connection_get_databases(c, c->options, &r->num_databaseNames,
759                                          r->odr);
760     
761     r->connection = c;
762
763 #if ZOOM_RESULT_LISTS
764     yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
765     set = xmalloc(sizeof(*set));
766     ZOOM_resultset_addref(r);
767     set->resultset = r;
768     set->next = c->resultsets;
769     c->resultsets = set;
770 #else
771     r->next = c->resultsets;
772     c->resultsets = r;
773 #endif
774     if (c->host_port && c->proto == PROTO_HTTP)
775     {
776         if (!c->cs)
777         {
778             yaz_log(c->log_details, "ZOOM_connection_search: no comstack");
779             ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
780         }
781         else
782         {
783             yaz_log(c->log_details, "ZOOM_connection_search: reconnect");
784             c->reconnect_ok = 1;
785         }
786     }
787
788     task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
789     task->u.search.resultset = r;
790     task->u.search.start = start;
791     task->u.search.count = count;
792     task->u.search.recv_search_fired = 0;
793
794     syntax = ZOOM_options_get(r->options, "preferredRecordSyntax"); 
795     task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
796     elementSetName = ZOOM_options_get(r->options, "elementSetName");
797     task->u.search.elementSetName = elementSetName 
798         ? xstrdup(elementSetName) : 0;
799    
800     ZOOM_resultset_addref(r);
801
802     ZOOM_query_addref(q);
803
804     if (!c->async)
805     {
806         while (ZOOM_event(1, &c))
807             ;
808     }
809     return r;
810 }
811
812 ZOOM_API(void)
813     ZOOM_resultset_sort(ZOOM_resultset r,
814                          const char *sort_type, const char *sort_spec)
815 {
816     (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
817 }
818
819 ZOOM_API(int)
820     ZOOM_resultset_sort1(ZOOM_resultset r,
821                          const char *sort_type, const char *sort_spec)
822 {
823     ZOOM_connection c = r->connection;
824     ZOOM_task task;
825     ZOOM_query newq;
826
827     newq = ZOOM_query_create();
828     if (ZOOM_query_sortby(newq, sort_spec) < 0)
829         return -1;
830
831     yaz_log(c->log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
832             r, r, sort_type, sort_spec);
833     if (!c)
834         return 0;
835
836     if (c->host_port && c->proto == PROTO_HTTP)
837     {
838         if (!c->cs)
839         {
840             yaz_log(c->log_details, "%p ZOOM_resultset_sort: no comstack", r);
841             ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
842         }
843         else
844         {
845             yaz_log(c->log_details, "%p ZOOM_resultset_sort: prepare reconnect",
846                     r);
847             c->reconnect_ok = 1;
848         }
849     }
850     
851     ZOOM_resultset_cache_reset(r);
852     task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
853     task->u.sort.resultset = r;
854     task->u.sort.q = newq;
855
856     ZOOM_resultset_addref(r);  
857
858     if (!c->async)
859     {
860         while (ZOOM_event(1, &c))
861             ;
862     }
863
864     return 0;
865 }
866
867 ZOOM_API(void)
868     ZOOM_resultset_destroy(ZOOM_resultset r)
869 {
870     resultset_destroy(r);
871 }
872
873 static void resultset_destroy(ZOOM_resultset r)
874 {
875     if (!r)
876         return;
877     yaz_mutex_enter(r->mutex);
878     (r->refcount)--;
879     yaz_log(log_details0, "%p ZOOM_resultset_destroy r=%p count=%d",
880             r, r, r->refcount);
881     if (r->refcount == 0)
882     {
883         yaz_mutex_leave(r->mutex);
884
885         yaz_log(log_details0, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
886         ZOOM_resultset_cache_reset(r);
887         ZOOM_resultset_release(r);
888         ZOOM_query_destroy(r->query);
889         ZOOM_options_destroy(r->options);
890         odr_destroy(r->odr);
891         xfree(r->setname);
892         xfree(r->schema);
893         yaz_mutex_destroy(&r->mutex);
894 #if SHPTR
895         YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
896 #endif
897         resultset_use(-1);
898         xfree(r);
899     }
900     else
901         yaz_mutex_leave(r->mutex);
902 }
903
904 ZOOM_API(size_t)
905     ZOOM_resultset_size(ZOOM_resultset r)
906 {
907     return r->size;
908 }
909
910 int ZOOM_test_reconnect(ZOOM_connection c)
911 {
912     ZOOM_Event event;
913
914     if (!c->reconnect_ok)
915         return 0;
916     ZOOM_connection_close(c);
917     c->reconnect_ok = 0;
918     c->tasks->running = 0;
919     ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
920
921     event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
922     ZOOM_connection_put_event(c, event);
923
924     return 1;
925 }
926
927 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
928                                     int force_sync, int start, int count)
929 {
930     ZOOM_task task;
931     ZOOM_connection c;
932     const char *cp;
933     const char *syntax, *elementSetName;
934
935     if (!r)
936         return;
937     yaz_log(log_details0, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
938             " count=%d", r, force_sync, start, count);
939     c = r->connection;
940     if (!c)
941         return;
942
943     if (c->host_port && c->proto == PROTO_HTTP)
944     {
945         if (!c->cs)
946         {
947             yaz_log(log_details0, "%p ZOOM_resultset_retrieve: no comstack", r);
948             ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
949         }
950         else
951         {
952             yaz_log(log_details0, "%p ZOOM_resultset_retrieve: prepare "
953                     "reconnect", r);
954             c->reconnect_ok = 1;
955         }
956     }
957     task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
958     task->u.retrieve.resultset = r;
959     task->u.retrieve.start = start;
960     task->u.retrieve.count = count;
961
962     syntax = ZOOM_options_get(r->options, "preferredRecordSyntax"); 
963     task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
964     elementSetName = ZOOM_options_get(r->options, "elementSetName");
965     task->u.retrieve.elementSetName = elementSetName 
966         ? xstrdup(elementSetName) : 0;
967
968     cp = ZOOM_options_get(r->options, "schema");
969     if (cp)
970     {
971         if (!r->schema || strcmp(r->schema, cp))
972         {
973             xfree(r->schema);
974             r->schema = xstrdup(cp);
975         }
976     }
977
978     ZOOM_resultset_addref(r);
979
980     if (!r->connection->async || force_sync)
981         while (r->connection && ZOOM_event(1, &r->connection))
982             ;
983 }
984
985 ZOOM_API(void)
986     ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
987                            size_t start, size_t count)
988 {
989     int force_present = 0;
990
991     if (!r)
992         return ;
993     yaz_log(log_api0, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
994             r, r, (long) start, (long) count);
995     if (count && recs)
996         force_present = 1;
997     ZOOM_resultset_retrieve(r, force_present, start, count);
998     if (force_present)
999     {
1000         size_t i;
1001         for (i = 0; i< count; i++)
1002             recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1003     }
1004 }
1005
1006 ZOOM_API(size_t)
1007     ZOOM_resultset_facets_size(ZOOM_resultset r) {
1008     return r->num_facets;
1009 }
1010
1011 ZOOM_API(ZOOM_facet_field)
1012     ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1013     int num = r->num_facets;
1014     ZOOM_facet_field *facets = r->facets;
1015     int index;
1016     for (index = 0; index < num; index++) {
1017         if (!strcmp(facets[index]->facet_name, name)) {
1018             return facets[index];
1019         }
1020     }
1021     return 0;
1022 }
1023
1024
1025 ZOOM_API(ZOOM_facet_field *)
1026     ZOOM_resultset_facets(ZOOM_resultset r)
1027 {
1028     return r->facets;
1029 }
1030
1031 ZOOM_API(const char**)
1032     ZOOM_resultset_facet_names(ZOOM_resultset r)
1033 {
1034     return (const char **) r->facets_names;
1035 }
1036
1037 ZOOM_API(const char*)
1038     ZOOM_facet_field_name(ZOOM_facet_field field)
1039 {
1040     return field->facet_name;
1041 }
1042
1043 ZOOM_API(size_t)
1044     ZOOM_facet_field_term_count(ZOOM_facet_field field)
1045 {
1046     return field->num_terms;
1047 }
1048
1049 ZOOM_API(const char*)
1050     ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1051     *freq = field->facet_terms[idx].frequency;
1052     return field->facet_terms[idx].term;
1053 }
1054
1055
1056 static void get_cert(ZOOM_connection c)
1057 {
1058     char *cert_buf;
1059     int cert_len;
1060     
1061     if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1062     {
1063         ZOOM_connection_option_setl(c, "sslPeerCert",
1064                                     cert_buf, cert_len);
1065         xfree(cert_buf);
1066     }
1067 }
1068
1069 static zoom_ret do_connect_host(ZOOM_connection c,
1070                                 const char *logical_url);
1071
1072 static zoom_ret do_connect(ZOOM_connection c)
1073 {
1074     return do_connect_host(c, c->host_port);
1075 }
1076
1077 static zoom_ret do_connect_host(ZOOM_connection c, const char *logical_url)
1078 {
1079     void *add;
1080
1081     if (c->cs)
1082         cs_close(c->cs);
1083     c->cs = cs_create_host_proxy(logical_url, 0, &add,
1084                                  c->tproxy ? c->tproxy : c->proxy);
1085     
1086     if (c->cs && c->cs->protocol == PROTO_HTTP)
1087     {
1088 #if YAZ_HAVE_XML2
1089         c->proto = PROTO_HTTP;
1090 #else
1091         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1092         ZOOM_connection_close(c);
1093         return zoom_complete;
1094 #endif
1095     }
1096     if (c->cs)
1097     {
1098         int ret = cs_connect(c->cs, add);
1099         if (ret == 0)
1100         {
1101             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1102             ZOOM_connection_put_event(c, event);
1103             get_cert(c);
1104             if (c->proto == PROTO_Z3950)
1105                 ZOOM_connection_Z3950_send_init(c);
1106             else
1107             {
1108                 /* no init request for SRW .. */
1109                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1110                 ZOOM_connection_remove_task(c);
1111                 ZOOM_connection_set_mask(c, 0);
1112                 ZOOM_connection_exec_task(c);
1113             }
1114             c->state = STATE_ESTABLISHED;
1115             return zoom_pending;
1116         }
1117         else if (ret > 0)
1118         {
1119             int mask = ZOOM_SELECT_EXCEPT;
1120             if (c->cs->io_pending & CS_WANT_WRITE)
1121                 mask += ZOOM_SELECT_WRITE;
1122             if (c->cs->io_pending & CS_WANT_READ)
1123                 mask += ZOOM_SELECT_READ;
1124             ZOOM_connection_set_mask(c, mask);
1125             c->state = STATE_CONNECTING; 
1126             return zoom_pending;
1127         }
1128     }
1129     c->state = STATE_IDLE;
1130     ZOOM_set_error(c, ZOOM_ERROR_CONNECT, logical_url);
1131     return zoom_complete;
1132 }
1133
1134 /* returns 1 if PDU was sent OK (still pending )
1135    0 if PDU was not sent OK (nothing to wait for) 
1136 */
1137
1138 ZOOM_API(ZOOM_record)
1139     ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1140 {
1141     const char *syntax =
1142         ZOOM_options_get(s->options, "preferredRecordSyntax"); 
1143     const char *elementSetName =
1144         ZOOM_options_get(s->options, "elementSetName");
1145
1146     return ZOOM_record_cache_lookup(s, pos, syntax, elementSetName);
1147 }
1148
1149 ZOOM_API(ZOOM_record)
1150     ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1151 {
1152     ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1153
1154     if (!rec)
1155     {
1156         /*
1157          * MIKE: I think force_sync should always be zero, but I don't
1158          * want to make this change until I get the go-ahead from
1159          * Adam, in case something depends on the old synchronous
1160          * behaviour.
1161          */
1162         int force_sync = 1;
1163         if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1164         ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1165         rec = ZOOM_resultset_record_immediate(r, pos);
1166     }
1167     return rec;
1168 }
1169
1170 ZOOM_API(ZOOM_scanset)
1171     ZOOM_connection_scan(ZOOM_connection c, const char *start)
1172 {
1173     ZOOM_scanset s;
1174     ZOOM_query q = ZOOM_query_create();
1175
1176     ZOOM_query_prefix(q, start);
1177
1178     s = ZOOM_connection_scan1(c, q);
1179     ZOOM_query_destroy(q);
1180     return s;
1181
1182 }
1183
1184 ZOOM_API(ZOOM_scanset)
1185     ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
1186 {
1187     ZOOM_scanset scan = 0;
1188     Z_Query *z_query = ZOOM_query_get_Z_Query(q);
1189
1190     if (!z_query)
1191         return 0;
1192     scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
1193     scan->connection = c;
1194     scan->odr = odr_createmem(ODR_DECODE);
1195     scan->options = ZOOM_options_create_with_parent(c->options);
1196     scan->refcount = 1;
1197     scan->scan_response = 0;
1198     scan->srw_scan_response = 0;
1199
1200     scan->query = q;
1201     ZOOM_query_addref(q);
1202     scan->databaseNames = ZOOM_connection_get_databases(c, c->options,
1203                                             &scan->num_databaseNames,
1204                                             scan->odr);
1205
1206     if (1)
1207     {
1208         ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
1209         task->u.scan.scan = scan;
1210         
1211         (scan->refcount)++;
1212         if (!c->async)
1213         {
1214             while (ZOOM_event(1, &c))
1215                 ;
1216         }
1217     }
1218     return scan;
1219 }
1220
1221 ZOOM_API(void)
1222     ZOOM_scanset_destroy(ZOOM_scanset scan)
1223 {
1224     if (!scan)
1225         return;
1226     (scan->refcount)--;
1227     if (scan->refcount == 0)
1228     {
1229         ZOOM_query_destroy(scan->query);
1230
1231         odr_destroy(scan->odr);
1232         
1233         ZOOM_options_destroy(scan->options);
1234         xfree(scan);
1235     }
1236 }
1237
1238 static zoom_ret send_package(ZOOM_connection c)
1239 {
1240     ZOOM_Event event;
1241
1242     yaz_log(c->log_details, "%p send_package", c);
1243     if (!c->tasks)
1244         return zoom_complete;
1245     assert (c->tasks->which == ZOOM_TASK_PACKAGE);
1246     
1247     event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1248     ZOOM_connection_put_event(c, event);
1249     
1250     c->buf_out = c->tasks->u.package->buf_out;
1251     c->len_out = c->tasks->u.package->len_out;
1252
1253     return ZOOM_send_buf(c);
1254 }
1255
1256 ZOOM_API(size_t)
1257     ZOOM_scanset_size(ZOOM_scanset scan)
1258 {
1259     if (!scan)
1260         return 0;
1261
1262     if (scan->scan_response && scan->scan_response->entries)
1263         return scan->scan_response->entries->num_entries;
1264     else if (scan->srw_scan_response)
1265         return scan->srw_scan_response->num_terms;
1266     return 0;
1267 }
1268
1269 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
1270                                 size_t *occ,
1271                                 const char **value_term, size_t *value_len,
1272                                 const char **disp_term, size_t *disp_len)
1273 {
1274     size_t noent = ZOOM_scanset_size(scan);
1275     
1276     *value_term = 0;
1277     *value_len = 0;
1278
1279     *disp_term = 0;
1280     *disp_len = 0;
1281
1282     *occ = 0;
1283     if (pos >= noent)
1284         return;
1285     if (scan->scan_response)
1286     {
1287         Z_ScanResponse *res = scan->scan_response;
1288         if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1289         {
1290             Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1291             
1292             *value_term = (const char *) t->term->u.general->buf;
1293             *value_len = t->term->u.general->len;
1294             if (t->displayTerm)
1295             {
1296                 *disp_term = t->displayTerm;
1297                 *disp_len = strlen(*disp_term);
1298             }
1299             else if (t->term->which == Z_Term_general)
1300             {
1301                 *disp_term = (const char *) t->term->u.general->buf;
1302                 *disp_len = t->term->u.general->len;
1303             }
1304             *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1305         }
1306     }
1307     if (scan->srw_scan_response)
1308     {
1309         Z_SRW_scanResponse *res = scan->srw_scan_response;
1310         Z_SRW_scanTerm *t = res->terms + pos;
1311         if (t)
1312         {
1313             *value_term = t->value;
1314             *value_len = strlen(*value_term);
1315
1316             if (t->displayTerm)
1317                 *disp_term = t->displayTerm;
1318             else
1319                 *disp_term = t->value;
1320             *disp_len = strlen(*disp_term);
1321             *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
1322         }
1323     }
1324 }
1325
1326 ZOOM_API(const char *)
1327     ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
1328                       size_t *occ, size_t *len)
1329 {
1330     const char *value_term = 0;
1331     size_t value_len = 0;
1332     const char *disp_term = 0;
1333     size_t disp_len = 0;
1334
1335     ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1336                         &disp_term, &disp_len);
1337     
1338     *len = value_len;
1339     return value_term;
1340 }
1341
1342 ZOOM_API(const char *)
1343     ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
1344                               size_t *occ, size_t *len)
1345 {
1346     const char *value_term = 0;
1347     size_t value_len = 0;
1348     const char *disp_term = 0;
1349     size_t disp_len = 0;
1350
1351     ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1352                         &disp_term, &disp_len);
1353     
1354     *len = disp_len;
1355     return disp_term;
1356 }
1357
1358 ZOOM_API(const char *)
1359     ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
1360 {
1361     return ZOOM_options_get(scan->options, key);
1362 }
1363
1364 ZOOM_API(void)
1365     ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
1366                             const char *val)
1367 {
1368     ZOOM_options_set(scan->options, key, val);
1369 }
1370
1371
1372 ZOOM_API(ZOOM_package)
1373     ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
1374 {
1375     ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
1376
1377     p->connection = c;
1378     p->odr_out = odr_createmem(ODR_ENCODE);
1379     p->options = ZOOM_options_create_with_parent2(options, c->options);
1380     p->refcount = 1;
1381     p->buf_out = 0;
1382     p->len_out = 0;
1383     return p;
1384 }
1385
1386 ZOOM_API(void)
1387     ZOOM_package_destroy(ZOOM_package p)
1388 {
1389     if (!p)
1390         return;
1391     (p->refcount)--;
1392     if (p->refcount == 0)
1393     {
1394         odr_destroy(p->odr_out);
1395         xfree(p->buf_out);
1396         
1397         ZOOM_options_destroy(p->options);
1398         xfree(p);
1399     }
1400 }
1401
1402 ZOOM_API(const char *)
1403     ZOOM_package_option_get(ZOOM_package p, const char *key)
1404 {
1405     return ZOOM_options_get(p->options, key);
1406 }
1407
1408 ZOOM_API(const char *)
1409     ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
1410 {
1411     return ZOOM_options_getl(p->options, key, lenp);
1412 }
1413
1414 ZOOM_API(void)
1415     ZOOM_package_option_set(ZOOM_package p, const char *key,
1416                             const char *val)
1417 {
1418     ZOOM_options_set(p->options, key, val);
1419 }
1420
1421 ZOOM_API(void)
1422     ZOOM_package_option_setl(ZOOM_package p, const char *key,
1423                              const char *val, int len)
1424 {
1425     ZOOM_options_setl(p->options, key, val, len);
1426 }
1427
1428 ZOOM_API(int)
1429     ZOOM_connection_exec_task(ZOOM_connection c)
1430 {
1431     ZOOM_task task = c->tasks;
1432     zoom_ret ret = zoom_complete;
1433
1434     if (!task)
1435         return 0;
1436     yaz_log(c->log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
1437             c, task->which, task->running);
1438     if (c->error != ZOOM_ERROR_NONE)
1439     {
1440         yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1441                 "removing tasks because of error = %d", c, c->error);
1442         ZOOM_connection_remove_tasks(c);
1443         return 0;
1444     }
1445     if (task->running)
1446     {
1447         yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1448                 "task already running", c);
1449         return 0;
1450     }
1451     task->running = 1;
1452     ret = zoom_complete;
1453     if (c->cs || task->which == ZOOM_TASK_CONNECT)
1454     {
1455         switch (task->which)
1456         {
1457         case ZOOM_TASK_SEARCH:
1458             if (c->proto == PROTO_HTTP)
1459                 ret = ZOOM_connection_srw_send_search(c);
1460             else
1461                 ret = ZOOM_connection_Z3950_send_search(c);
1462             break;
1463         case ZOOM_TASK_RETRIEVE:
1464             if (c->proto == PROTO_HTTP)
1465                 ret = ZOOM_connection_srw_send_search(c);
1466             else
1467                 ret = send_Z3950_present(c);
1468             break;
1469         case ZOOM_TASK_CONNECT:
1470             ret = do_connect(c);
1471             break;
1472         case ZOOM_TASK_SCAN:
1473             if (c->proto == PROTO_HTTP)
1474                 ret = ZOOM_connection_srw_send_scan(c);
1475             else
1476                 ret = ZOOM_connection_Z3950_send_scan(c);
1477             break;
1478         case ZOOM_TASK_PACKAGE:
1479             ret = send_package(c);
1480             break;
1481         case ZOOM_TASK_SORT:
1482             c->tasks->u.sort.resultset->r_sort_spec = 
1483                 ZOOM_query_get_sortspec(c->tasks->u.sort.q);
1484             ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
1485             break;
1486         }
1487     }
1488     else
1489     {
1490         yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1491                 "remove tasks because no connection exist", c);
1492         ZOOM_connection_remove_tasks(c);
1493     }
1494     if (ret == zoom_complete)
1495     {
1496         yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1497                 "task removed (complete)", c);
1498         ZOOM_connection_remove_task(c);
1499         return 0;
1500     }
1501     yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1502             "task pending", c);
1503     return 1;
1504 }
1505
1506 #if YAZ_HAVE_XML2
1507
1508 static zoom_ret send_HTTP_redirect(ZOOM_connection c, const char *uri,
1509                                   Z_HTTP_Response *cookie_hres)
1510 {
1511     struct Z_HTTP_Header *h;
1512     char *combined_cookies = 0;
1513     int combined_cookies_len = 0;
1514     Z_GDU *gdu = z_get_HTTP_Request_uri(c->odr_out, uri, 0, c->proxy ? 1 : 0);
1515
1516     gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
1517     z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
1518                       "text/xml");
1519
1520     for (h = cookie_hres->headers; h; h = h->next)
1521     {
1522         if (!strcmp(h->name, "Set-Cookie"))
1523         {
1524             char *cp;
1525
1526             if (!(cp = strchr(h->value, ';')))
1527                 cp = h->value + strlen(h->value);
1528             if (cp - h->value >= 1) {
1529                 combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
1530                 memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
1531                 combined_cookies[combined_cookies_len + cp - h->value] = '\0';
1532                 strcat(combined_cookies,"; ");
1533                 combined_cookies_len = strlen(combined_cookies);
1534             }
1535         }
1536     }
1537
1538     if (combined_cookies_len)
1539     {
1540         z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1541                           "Cookie", combined_cookies);
1542         xfree(combined_cookies);
1543     }
1544
1545     if (c->user && c->password)
1546     {
1547         z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
1548                                      c->user, c->password);
1549     }
1550     if (!z_GDU(c->odr_out, &gdu, 0, 0))
1551         return zoom_complete;
1552     if (c->odr_print)
1553         z_GDU(c->odr_print, &gdu, 0, 0);
1554     if (c->odr_save)
1555         z_GDU(c->odr_save, &gdu, 0, 0);
1556     c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1557
1558     odr_reset(c->odr_out);
1559     return ZOOM_send_buf(c);
1560 }
1561
1562 #if YAZ_HAVE_XML2
1563 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
1564                          const char *addinfo, const char *addinfo2)
1565 {
1566     ZOOM_set_dset_error(c, error, "HTTP", addinfo, addinfo2);
1567 }
1568 #endif
1569
1570
1571 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
1572 {
1573     zoom_ret cret = zoom_complete;
1574     int ret = -1;
1575     char *addinfo = 0;
1576     const char *connection_head = z_HTTP_header_lookup(hres->headers,
1577                                                        "Connection");
1578     const char *location;
1579
1580     ZOOM_connection_set_mask(c, 0);
1581     yaz_log(c->log_details, "%p handle_http", c);
1582
1583     if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
1584         && (location = z_HTTP_header_lookup(hres->headers, "Location")))
1585     {
1586         c->no_redirects++;
1587         if (c->no_redirects > 10)
1588         {
1589             ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1590             c->no_redirects = 0;
1591             ZOOM_connection_close(c);
1592         }
1593         else
1594         {
1595             /* since redirect may change host we just reconnect. A smarter
1596                implementation might check whether it's the same server */
1597             do_connect_host(c, location);
1598             send_HTTP_redirect(c, location, hres);
1599             /* we're OK for now. Operation is not really complete */
1600             return;
1601         }
1602     }
1603     else 
1604     {  
1605         ret = ZOOM_handle_sru(c, hres, &cret, &addinfo);
1606         if (ret == 0)
1607         {
1608             if (c->no_redirects) /* end of redirect. change hosts again */
1609                 ZOOM_connection_close(c);
1610         }
1611         c->no_redirects = 0;
1612     }
1613     if (ret)
1614     {
1615         if (hres->code != 200)
1616             ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1617         else
1618         {
1619             yaz_log(YLOG_LOG, "set error... addinfo=%s", addinfo ?
1620                     addinfo : "NULL");
1621             ZOOM_set_error(c, ZOOM_ERROR_DECODE, addinfo);
1622         }
1623         ZOOM_connection_close(c);
1624     }
1625     if (cret == zoom_complete)
1626     {
1627         yaz_log(c->log_details, "removing tasks in handle_http");
1628         ZOOM_connection_remove_task(c);
1629     }
1630     {
1631         int must_close = 0;
1632         if (!strcmp(hres->version, "1.0"))
1633         {
1634             /* HTTP 1.0: only if Keep-Alive we stay alive.. */
1635             if (!connection_head || strcmp(connection_head, "Keep-Alive"))
1636                 must_close = 1;
1637         }
1638         else
1639         {
1640             /* HTTP 1.1: only if no close we stay alive.. */
1641             if (connection_head && !strcmp(connection_head, "close"))
1642                 must_close = 1;
1643         }
1644         if (must_close)
1645         {
1646             ZOOM_connection_close(c);
1647             if (c->tasks)
1648             {
1649                 c->tasks->running = 0;
1650                 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1651                 c->reconnect_ok = 0;
1652             }
1653         }
1654         else
1655             c->reconnect_ok = 1; /* if the server closes anyway */
1656     }
1657 }
1658 #endif
1659
1660 static int do_read(ZOOM_connection c)
1661 {
1662     int r, more;
1663     ZOOM_Event event;
1664     
1665     event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
1666     ZOOM_connection_put_event(c, event);
1667     
1668     r = cs_get(c->cs, &c->buf_in, &c->len_in);
1669     more = cs_more(c->cs);
1670     yaz_log(c->log_details, "%p do_read len=%d more=%d", c, r, more);
1671     if (r == 1)
1672         return 0;
1673     if (r <= 0)
1674     {
1675         if (!ZOOM_test_reconnect(c))
1676         {
1677             ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1678             ZOOM_connection_close(c);
1679         }
1680     }
1681     else
1682     {
1683         Z_GDU *gdu;
1684         ZOOM_Event event;
1685
1686         odr_reset(c->odr_in);
1687         odr_setbuf(c->odr_in, c->buf_in, r, 0);
1688         event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
1689         ZOOM_connection_put_event(c, event);
1690
1691         if (!z_GDU(c->odr_in, &gdu, 0, 0))
1692         {
1693             int x;
1694             int err = odr_geterrorx(c->odr_in, &x);
1695             char msg[100];
1696             const char *element = odr_getelement(c->odr_in);
1697             yaz_snprintf(msg, sizeof(msg),
1698                     "ODR code %d:%d element=%s offset=%d",
1699                     err, x, element ? element : "<unknown>",
1700                     odr_offset(c->odr_in));
1701             ZOOM_set_error(c, ZOOM_ERROR_DECODE, msg);
1702             if (c->log_api)
1703             {
1704                 FILE *ber_file = yaz_log_file();
1705                 if (ber_file)
1706                     odr_dumpBER(ber_file, c->buf_in, r);
1707             }
1708             ZOOM_connection_close(c);
1709         }
1710         else
1711         {
1712             if (c->odr_print)
1713                 z_GDU(c->odr_print, &gdu, 0, 0);
1714             if (c->odr_save)
1715                 z_GDU(c->odr_save, &gdu, 0, 0);
1716             if (gdu->which == Z_GDU_Z3950)
1717                 ZOOM_handle_Z3950_apdu(c, gdu->u.z3950);
1718             else if (gdu->which == Z_GDU_HTTP_Response)
1719             {
1720 #if YAZ_HAVE_XML2
1721                 handle_http(c, gdu->u.HTTP_Response);
1722 #else
1723                 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1724                 ZOOM_connection_close(c);
1725 #endif
1726             }
1727         }
1728     }
1729     return 1;
1730 }
1731
1732 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
1733 {
1734     int r;
1735     ZOOM_Event event;
1736     
1737     event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1738     ZOOM_connection_put_event(c, event);
1739
1740     yaz_log(c->log_details, "%p do_write_ex len=%d", c, len_out);
1741     if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
1742     {
1743         yaz_log(c->log_details, "%p do_write_ex write failed", c);
1744         if (ZOOM_test_reconnect(c))
1745         {
1746             return zoom_pending;
1747         }
1748         if (c->state == STATE_CONNECTING)
1749             ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1750         else
1751             ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1752         ZOOM_connection_close(c);
1753         return zoom_complete;
1754     }
1755     else if (r == 1)
1756     {    
1757         int mask = ZOOM_SELECT_EXCEPT;
1758         if (c->cs->io_pending & CS_WANT_WRITE)
1759             mask += ZOOM_SELECT_WRITE;
1760         if (c->cs->io_pending & CS_WANT_READ)
1761             mask += ZOOM_SELECT_READ;
1762         ZOOM_connection_set_mask(c, mask);
1763         yaz_log(c->log_details, "%p do_write_ex write incomplete mask=%d",
1764                 c, c->mask);
1765     }
1766     else
1767     {
1768         ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
1769         yaz_log(c->log_details, "%p do_write_ex write complete mask=%d",
1770                 c, c->mask);
1771     }
1772     return zoom_pending;
1773 }
1774
1775 zoom_ret ZOOM_send_buf(ZOOM_connection c)
1776 {
1777     return do_write_ex(c, c->buf_out, c->len_out);
1778 }
1779
1780
1781 ZOOM_API(const char *)
1782     ZOOM_connection_option_get(ZOOM_connection c, const char *key)
1783 {
1784     return ZOOM_options_get(c->options, key);
1785 }
1786
1787 ZOOM_API(const char *)
1788     ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
1789 {
1790     return ZOOM_options_getl(c->options, key, lenp);
1791 }
1792
1793 ZOOM_API(void)
1794     ZOOM_connection_option_set(ZOOM_connection c, const char *key,
1795                                const char *val)
1796 {
1797     ZOOM_options_set(c->options, key, val);
1798 }
1799
1800 ZOOM_API(void)
1801     ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
1802                                 const char *val, int len)
1803 {
1804     ZOOM_options_setl(c->options, key, val, len);
1805 }
1806
1807 ZOOM_API(const char *)
1808     ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
1809 {
1810     return ZOOM_options_get(r->options, key);
1811 }
1812
1813 ZOOM_API(void)
1814     ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
1815                               const char *val)
1816 {
1817     ZOOM_options_set(r->options, key, val);
1818 }
1819
1820
1821 ZOOM_API(int)
1822     ZOOM_connection_errcode(ZOOM_connection c)
1823 {
1824     return ZOOM_connection_error(c, 0, 0);
1825 }
1826
1827 ZOOM_API(const char *)
1828     ZOOM_connection_errmsg(ZOOM_connection c)
1829 {
1830     const char *msg;
1831     ZOOM_connection_error(c, &msg, 0);
1832     return msg;
1833 }
1834
1835 ZOOM_API(const char *)
1836     ZOOM_connection_addinfo(ZOOM_connection c)
1837 {
1838     const char *addinfo;
1839     ZOOM_connection_error(c, 0, &addinfo);
1840     return addinfo;
1841 }
1842
1843 ZOOM_API(const char *)
1844     ZOOM_connection_diagset(ZOOM_connection c)
1845 {
1846     const char *diagset;
1847     ZOOM_connection_error_x(c, 0, 0, &diagset);
1848     return diagset;
1849 }
1850
1851 ZOOM_API(const char *)
1852     ZOOM_diag_str(int error)
1853 {
1854     switch (error)
1855     {
1856     case ZOOM_ERROR_NONE:
1857         return "No error";
1858     case ZOOM_ERROR_CONNECT:
1859         return "Connect failed";
1860     case ZOOM_ERROR_MEMORY:
1861         return "Out of memory";
1862     case ZOOM_ERROR_ENCODE:
1863         return "Encoding failed";
1864     case ZOOM_ERROR_DECODE:
1865         return "Decoding failed";
1866     case ZOOM_ERROR_CONNECTION_LOST:
1867         return "Connection lost";
1868     case ZOOM_ERROR_INIT:
1869         return "Init rejected";
1870     case ZOOM_ERROR_INTERNAL:
1871         return "Internal failure";
1872     case ZOOM_ERROR_TIMEOUT:
1873         return "Timeout";
1874     case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
1875         return "Unsupported protocol";
1876     case ZOOM_ERROR_UNSUPPORTED_QUERY:
1877         return "Unsupported query type";
1878     case ZOOM_ERROR_INVALID_QUERY:
1879         return "Invalid query";
1880     case ZOOM_ERROR_CQL_PARSE:
1881         return "CQL parsing error";
1882     case ZOOM_ERROR_CQL_TRANSFORM:
1883         return "CQL transformation error";
1884     case ZOOM_ERROR_CCL_CONFIG:
1885         return "CCL configuration error";
1886     case ZOOM_ERROR_CCL_PARSE:
1887         return "CCL parsing error";
1888     case ZOOM_ERROR_ES_INVALID_ACTION:
1889         return "Extended Service. invalid action";
1890     case ZOOM_ERROR_ES_INVALID_VERSION:
1891         return "Extended Service. invalid version";
1892     case ZOOM_ERROR_ES_INVALID_SYNTAX:
1893         return "Extended Service. invalid syntax";
1894     default:
1895         return diagbib1_str(error);
1896     }
1897 }
1898
1899 ZOOM_API(int)
1900     ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1901                             const char **addinfo, const char **diagset)
1902 {
1903     int error = c->error;
1904     if (cp)
1905     {
1906         if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
1907             *cp = ZOOM_diag_str(error);
1908         else if (!strcmp(c->diagset, "HTTP"))
1909             *cp = z_HTTP_errmsg(c->error);
1910         else if (!strcmp(c->diagset, "Bib-1"))
1911             *cp = ZOOM_diag_str(error);
1912         else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
1913             *cp = yaz_diag_srw_str(c->error);
1914         else
1915             *cp = "Unknown error and diagnostic set";
1916     }
1917     if (addinfo)
1918         *addinfo = c->addinfo ? c->addinfo : "";
1919     if (diagset)
1920         *diagset = c->diagset ? c->diagset : "";
1921     return c->error;
1922 }
1923
1924 ZOOM_API(int)
1925     ZOOM_connection_error(ZOOM_connection c, const char **cp,
1926                           const char **addinfo)
1927 {
1928     return ZOOM_connection_error_x(c, cp, addinfo, 0);
1929 }
1930
1931 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
1932 {
1933     ZOOM_Event event = 0;
1934     int r = cs_look(c->cs);
1935     yaz_log(c->log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
1936             c, mask, r);
1937     
1938     if (r == CS_NONE)
1939     {
1940         event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1941         ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1942         ZOOM_connection_close(c);
1943         ZOOM_connection_put_event(c, event);
1944     }
1945     else if (r == CS_CONNECT)
1946     {
1947         int ret = ret = cs_rcvconnect(c->cs);
1948         yaz_log(c->log_details, "%p ZOOM_connection_do_io "
1949                 "cs_rcvconnect returned %d", c, ret);
1950         if (ret == 1)
1951         {
1952             int mask = ZOOM_SELECT_EXCEPT;
1953             if (c->cs->io_pending & CS_WANT_WRITE)
1954                 mask += ZOOM_SELECT_WRITE;
1955             if (c->cs->io_pending & CS_WANT_READ)
1956                 mask += ZOOM_SELECT_READ;
1957             ZOOM_connection_set_mask(c, mask);
1958             event = ZOOM_Event_create(ZOOM_EVENT_NONE);
1959             ZOOM_connection_put_event(c, event);
1960         }
1961         else if (ret == 0)
1962         {
1963             event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1964             ZOOM_connection_put_event(c, event);
1965             get_cert(c);
1966             if (c->proto == PROTO_Z3950)
1967                 ZOOM_connection_Z3950_send_init(c);
1968             else
1969             {
1970                 /* no init request for SRW .. */
1971                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1972                 ZOOM_connection_remove_task(c);
1973                 ZOOM_connection_set_mask(c, 0);
1974                 ZOOM_connection_exec_task(c);
1975             }
1976             c->state = STATE_ESTABLISHED;
1977         }
1978         else
1979         {
1980             ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1981             ZOOM_connection_close(c);
1982         }
1983     }
1984     else
1985     {
1986         if (mask & ZOOM_SELECT_EXCEPT)
1987         {
1988             if (!ZOOM_test_reconnect(c))
1989             {
1990                 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1991                 ZOOM_connection_close(c);
1992             }
1993             return;
1994         }
1995         if (mask & ZOOM_SELECT_READ)
1996             do_read(c);
1997         if (c->cs && (mask & ZOOM_SELECT_WRITE))
1998             ZOOM_send_buf(c);
1999     }
2000 }
2001
2002 ZOOM_API(int)
2003     ZOOM_connection_last_event(ZOOM_connection cs)
2004 {
2005     if (!cs)
2006         return ZOOM_EVENT_NONE;
2007     return cs->last_event;
2008 }
2009
2010
2011 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
2012 {
2013     if (c->mask)
2014     {
2015         ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
2016         /* timeout and this connection was waiting */
2017         ZOOM_set_error(c, ZOOM_ERROR_TIMEOUT, 0);
2018         ZOOM_connection_close(c);
2019         ZOOM_connection_put_event(c, event);
2020     }
2021     return 0;
2022 }
2023
2024 ZOOM_API(int)
2025     ZOOM_connection_process(ZOOM_connection c)
2026 {
2027     ZOOM_Event event;
2028     if (!c)
2029         return 0;
2030
2031     event = ZOOM_connection_get_event(c);
2032     if (event)
2033     {
2034         ZOOM_Event_destroy(event);
2035         return 1;
2036     }
2037     ZOOM_connection_exec_task(c);
2038     event = ZOOM_connection_get_event(c);
2039     if (event)
2040     {
2041         ZOOM_Event_destroy(event);
2042         return 1;
2043     }
2044     return 0;
2045 }
2046
2047 ZOOM_API(int)
2048     ZOOM_event_nonblock(int no, ZOOM_connection *cs)
2049 {
2050     int i;
2051
2052     yaz_log(log_details0, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
2053     
2054     for (i = 0; i<no; i++)
2055     {
2056         ZOOM_connection c = cs[i];
2057
2058         if (c && ZOOM_connection_process(c))
2059             return i+1;
2060     }
2061     return 0;
2062 }
2063
2064 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
2065 {
2066     if (c->mask && mask)
2067         ZOOM_connection_do_io(c, mask);
2068     return 0;
2069 }
2070
2071 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
2072 {
2073     if (c->cs)
2074         return cs_fileno(c->cs);
2075     return -1;
2076 }
2077
2078 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
2079 {
2080     c->mask = mask;
2081     if (!c->cs)
2082         return -1; 
2083     return 0;
2084 }
2085
2086 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
2087 {
2088     if (c->cs)
2089         return c->mask;
2090     return 0;
2091 }
2092
2093 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
2094 {
2095     return ZOOM_options_get_int(c->options, "timeout", 30);
2096 }
2097
2098 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
2099 {
2100     if (c->cs)
2101         cs_close(c->cs);
2102     c->cs = 0;
2103     ZOOM_connection_set_mask(c, 0);
2104     c->state = STATE_IDLE;
2105 }
2106
2107 /*
2108  * Local variables:
2109  * c-basic-offset: 4
2110  * c-file-style: "Stroustrup"
2111  * indent-tabs-mode: nil
2112  * End:
2113  * vim: shiftwidth=4 tabstop=8 expandtab
2114  */
2115