1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM C interface.
18 #include <yaz/yaz-util.h>
19 #include <yaz/xmalloc.h>
20 #include <yaz/otherinfo.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>
28 #include <yaz/shptr.h>
34 static int log_api0 = 0;
35 static int log_details0 = 0;
37 static void resultset_destroy(ZOOM_resultset r);
38 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
40 static void initlog(void)
42 static int log_level_initialized = 0;
44 if (!log_level_initialized)
46 log_api0 = yaz_log_module_level("zoom");
47 log_details0 = yaz_log_module_level("zoomdetails");
48 log_level_initialized = 1;
52 void ZOOM_connection_remove_tasks(ZOOM_connection c);
54 void ZOOM_set_dset_error(ZOOM_connection c, int error,
56 const char *addinfo, const char *addinfo2)
63 if (!c->diagset || strcmp(dset, c->diagset))
66 c->diagset = xstrdup(dset);
67 /* remove integer part from SRW diagset .. */
68 if ((cp = strrchr(c->diagset, '/')))
71 if (addinfo && addinfo2)
73 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 3);
74 strcpy(c->addinfo, addinfo);
75 strcat(c->addinfo, ": ");
76 strcat(c->addinfo, addinfo2);
79 c->addinfo = xstrdup(addinfo);
80 if (error != ZOOM_ERROR_NONE)
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);
90 int ZOOM_uri_to_code(const char *uri)
94 if ((cp = strrchr(uri, '/')))
101 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo)
103 ZOOM_set_dset_error(c, error, "ZOOM", addinfo, 0);
106 static void clear_error(ZOOM_connection c)
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.
116 ZOOM_connection_remove_events(c);
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:
128 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
132 void ZOOM_connection_show_task(ZOOM_task task)
136 case ZOOM_TASK_SEARCH:
137 yaz_log(YLOG_LOG, "search p=%p", task);
139 case ZOOM_TASK_RETRIEVE:
140 yaz_log(YLOG_LOG, "retrieve p=%p", task);
142 case ZOOM_TASK_CONNECT:
143 yaz_log(YLOG_LOG, "connect p=%p", task);
146 yaz_log(YLOG_LOG, "scan p=%p", task);
151 void ZOOM_connection_show_tasks(ZOOM_connection c)
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);
159 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
161 ZOOM_task *taskp = &c->tasks;
163 taskp = &(*taskp)->next;
164 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
165 (*taskp)->running = 0;
166 (*taskp)->which = which;
172 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
174 return c->tasks ? 0 : 1;
177 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
179 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
181 task->next = c->tasks;
189 void ZOOM_connection_remove_task(ZOOM_connection c)
191 ZOOM_task task = c->tasks;
195 c->tasks = task->next;
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 xfree(task->u.search.schema);
204 case ZOOM_TASK_RETRIEVE:
205 resultset_destroy(task->u.retrieve.resultset);
206 xfree(task->u.retrieve.syntax);
207 xfree(task->u.retrieve.elementSetName);
208 xfree(task->u.retrieve.schema);
210 case ZOOM_TASK_CONNECT:
213 ZOOM_scanset_destroy(task->u.scan.scan);
215 case ZOOM_TASK_PACKAGE:
216 ZOOM_package_destroy(task->u.package);
219 resultset_destroy(task->u.sort.resultset);
220 ZOOM_query_destroy(task->u.sort.q);
229 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
230 ZOOM_connection_put_event(c, event);
235 void ZOOM_connection_remove_tasks(ZOOM_connection c)
238 ZOOM_connection_remove_task(c);
241 static void odr_wrbuf_write(ODR o, void *handle, int type,
242 const char *buf, int len)
244 WRBUF w = (WRBUF) handle;
245 wrbuf_write(w, buf, len);
248 ZOOM_API(ZOOM_connection)
249 ZOOM_connection_create(ZOOM_options options)
251 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
255 c->log_api = log_api0;
256 c->log_details = log_details0;
258 yaz_log(c->log_api, "%p ZOOM_connection_create", c);
260 c->proto = PROTO_Z3950;
262 ZOOM_connection_set_mask(c, 0);
264 c->state = STATE_IDLE;
267 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
274 c->options = ZOOM_options_create_with_parent(options);
280 c->charset = c->lang = 0;
291 c->maximum_record_size = 0;
292 c->preferred_message_size = 0;
294 c->odr_in = odr_createmem(ODR_DECODE);
295 c->odr_out = odr_createmem(ODR_ENCODE);
300 c->support_named_resultsets = 0;
301 c->last_event = ZOOM_EVENT_NONE;
303 c->m_queue_front = 0;
308 c->saveAPDU_wrbuf = 0;
312 ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w)
316 odr_destroy(c->odr_save);
321 c->odr_save = odr_createmem(ODR_PRINT);
322 odr_set_stream(c->odr_save, w, odr_wrbuf_write, 0);
326 /* set database names. Take local databases (if set); otherwise
327 take databases given in ZURL (if set); otherwise use Default */
328 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
331 char **databaseNames;
332 const char *cp = ZOOM_options_get(options, "databaseName");
334 if ((!cp || !*cp) && con->host_port)
335 cs_get_host_args(con->host_port, &cp);
338 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
339 return databaseNames;
342 ZOOM_API(ZOOM_connection)
343 ZOOM_connection_new(const char *host, int portnum)
345 ZOOM_connection c = ZOOM_connection_create(0);
347 ZOOM_connection_connect(c, host, portnum);
351 static zoom_sru_mode get_sru_mode_from_string(const char *s)
354 return zoom_sru_soap;
355 if (!yaz_matchstr(s, "soap"))
356 return zoom_sru_soap;
357 else if (!yaz_matchstr(s, "get"))
359 else if (!yaz_matchstr(s, "post"))
360 return zoom_sru_post;
361 else if (!yaz_matchstr(s, "solr"))
362 return zoom_sru_solr;
363 return zoom_sru_error;
367 ZOOM_connection_connect(ZOOM_connection c,
368 const char *host, int portnum)
374 yaz_log(c->log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
375 c, host ? host : "null", portnum);
377 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
378 ZOOM_connection_remove_tasks(c);
382 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
383 odr_destroy(c->odr_print);
385 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
387 c->odr_print = odr_createmem(ODR_PRINT);
388 odr_setprint(c->odr_print, yaz_log_file());
395 yaz_log(c->log_details, "%p ZOOM_connection_connect reconnect ok", c);
399 yaz_log(c->log_details, "%p ZOOM_connection_connect connect", c);
402 val = ZOOM_options_get(c->options, "proxy");
405 yaz_log(c->log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
406 c->proxy = xstrdup(val);
411 val = ZOOM_options_get(c->options, "tproxy");
414 yaz_log(c->log_details, "%p ZOOM_connection_connect tproxy=%s", c, val);
415 c->tproxy = xstrdup(val);
420 val = ZOOM_options_get(c->options, "charset");
423 yaz_log(c->log_details, "%p ZOOM_connection_connect charset=%s", c, val);
424 c->charset = xstrdup(val);
428 val = ZOOM_options_get(c->options, "lang");
431 yaz_log(c->log_details, "%p ZOOM_connection_connect lang=%s", c, val);
432 c->lang = xstrdup(val);
443 sprintf(hostn, "%.80s:%d", host, portnum);
444 c->host_port = xstrdup(hostn);
447 c->host_port = xstrdup(host);
452 * If the "<scheme>:" part of the host string is preceded by one
453 * or more comma-separated <name>=<value> pairs, these are taken
454 * to be options to be set on the connection object. Among other
455 * applications, this facility can be used to embed authentication
457 * user=admin,password=secret,tcp:localhost:9999
459 char *remainder = c->host_port;
460 char *pcolon = strchr(remainder, ':');
463 while ((pcomma = strchr(remainder, ',')) != 0 &&
464 (pcolon == 0 || pcomma < pcolon))
467 if ((pequals = strchr(remainder, '=')) != 0)
470 ZOOM_connection_option_set(c, remainder, pequals+1);
472 remainder = pcomma+1;
475 if (remainder != c->host_port)
477 remainder = xstrdup(remainder);
479 c->host_port = remainder;
483 val = ZOOM_options_get(c->options, "sru");
484 c->sru_mode = get_sru_mode_from_string(val);
486 xfree(c->sru_version);
487 val = ZOOM_options_get(c->options, "sru_version");
488 c->sru_version = xstrdup(val ? val : "1.2");
490 ZOOM_options_set(c->options, "host", c->host_port);
492 xfree(c->cookie_out);
494 val = ZOOM_options_get(c->options, "cookie");
497 yaz_log(c->log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
498 c->cookie_out = xstrdup(val);
503 val = ZOOM_options_get(c->options, "clientIP");
506 yaz_log(c->log_details, "%p ZOOM_connection_connect clientIP=%s",
508 c->client_IP = xstrdup(val);
513 val = ZOOM_options_get(c->options, "group");
515 c->group = xstrdup(val);
519 val = ZOOM_options_get(c->options, "user");
521 c->user = xstrdup(val);
525 val = ZOOM_options_get(c->options, "password");
527 val = ZOOM_options_get(c->options, "pass");
530 c->password = xstrdup(val);
532 c->maximum_record_size =
533 ZOOM_options_get_int(c->options, "maximumRecordSize", 64*1024*1024);
534 c->preferred_message_size =
535 ZOOM_options_get_int(c->options, "preferredMessageSize", 64*1024*1024);
537 c->async = ZOOM_options_get_bool(c->options, "async", 0);
539 if (c->sru_mode == zoom_sru_error)
541 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, val);
542 ZOOM_connection_remove_tasks(c);
546 yaz_log(c->log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
547 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
551 while (ZOOM_event(1, &c))
556 ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
558 #if ZOOM_RESULT_LISTS
562 /* remove ourselves from the resultsets in connection */
563 ZOOM_resultset *rp = &r->connection->resultsets;
566 assert(*rp); /* we must be in this list!! */
568 { /* OK, we're here - take us out of it */
580 ZOOM_connection_destroy(ZOOM_connection c)
582 #if ZOOM_RESULT_LISTS
583 ZOOM_resultsets list;
589 yaz_log(c->log_api, "%p ZOOM_connection_destroy", c);
593 #if ZOOM_RESULT_LISTS
594 /* Remove the connection's usage of resultsets */
595 list = c->resultsets;
597 ZOOM_resultsets removed = list;
598 ZOOM_resultset_destroy(list->resultset);
603 for (r = c->resultsets; r; r = r->next)
610 odr_destroy(c->odr_in);
611 odr_destroy(c->odr_out);
613 odr_destroy(c->odr_save);
616 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
617 odr_destroy(c->odr_print);
619 ZOOM_options_destroy(c->options);
620 ZOOM_connection_remove_tasks(c);
621 ZOOM_connection_remove_events(c);
627 xfree(c->cookie_out);
633 xfree(c->sru_version);
634 wrbuf_destroy(c->saveAPDU_wrbuf);
638 void ZOOM_resultset_addref(ZOOM_resultset r)
642 yaz_mutex_enter(r->mutex);
644 yaz_log(log_details0, "%p ZOOM_resultset_addref count=%d",
646 yaz_mutex_leave(r->mutex);
650 static int g_resultsets = 0;
651 static YAZ_MUTEX g_resultset_mutex = 0;
653 /* TODO We need to initialize this before running threaded:
654 * call resultset_use(0) */
656 static int resultset_use(int delta) {
658 if (g_resultset_mutex == 0)
659 yaz_mutex_create(&g_resultset_mutex);
660 yaz_mutex_enter(g_resultset_mutex);
661 g_resultsets += delta;
662 resultset_count = g_resultsets;
663 yaz_mutex_leave(g_resultset_mutex);
664 return resultset_count;
667 int resultsets_count(void) {
668 return resultset_use(0);
671 ZOOM_resultset ZOOM_resultset_create(void)
674 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
678 yaz_log(log_details0, "%p ZOOM_resultset_create", r);
681 r->odr = odr_createmem(ODR_ENCODE);
685 for (i = 0; i<RECORD_HASH_SIZE; i++)
686 r->record_hash[i] = 0;
690 r->databaseNames = 0;
691 r->num_databaseNames = 0;
696 yaz_mutex_create(&r->mutex);
699 WRBUF w = wrbuf_alloc();
700 YAZ_SHPTR_INIT(r->record_wrbuf, w);
707 ZOOM_API(ZOOM_resultset)
708 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
711 ZOOM_query s = ZOOM_query_create();
713 ZOOM_query_prefix(s, q);
715 r = ZOOM_connection_search(c, s);
716 ZOOM_query_destroy(s);
720 ZOOM_API(ZOOM_resultset)
721 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
723 ZOOM_resultset r = ZOOM_resultset_create();
727 const char *syntax, *elementSetName, *schema;
728 #if ZOOM_RESULT_LISTS
732 yaz_log(c->log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
733 r->r_sort_spec = ZOOM_query_get_sortspec(q);
736 r->options = ZOOM_options_create_with_parent(c->options);
738 start = ZOOM_options_get_int(r->options, "start", 0);
739 count = ZOOM_options_get_int(r->options, "count", 0);
741 /* If "presentChunk" is defined use that; otherwise "step" */
742 const char *cp = ZOOM_options_get(r->options, "presentChunk");
743 r->step = ZOOM_options_get_int(r->options,
744 (cp != 0 ? "presentChunk": "step"), 0);
746 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
747 cp = ZOOM_options_get(r->options, "setname");
749 r->setname = xstrdup(cp);
751 r->databaseNames = ZOOM_connection_get_databases(c, c->options, &r->num_databaseNames,
756 #if ZOOM_RESULT_LISTS
757 yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
758 set = xmalloc(sizeof(*set));
759 ZOOM_resultset_addref(r);
761 set->next = c->resultsets;
764 r->next = c->resultsets;
767 if (c->host_port && c->proto == PROTO_HTTP)
771 yaz_log(c->log_details, "ZOOM_connection_search: no comstack");
772 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
776 yaz_log(c->log_details, "ZOOM_connection_search: reconnect");
781 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
782 task->u.search.resultset = r;
783 task->u.search.start = start;
784 task->u.search.count = count;
785 task->u.search.recv_search_fired = 0;
787 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
788 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
789 elementSetName = ZOOM_options_get(r->options, "elementSetName");
790 task->u.search.elementSetName = elementSetName ?
791 xstrdup(elementSetName) : 0;
792 schema = ZOOM_options_get(r->options, "schema");
793 task->u.search.schema = schema ? xstrdup(schema) : 0;
795 ZOOM_resultset_addref(r);
797 ZOOM_query_addref(q);
801 while (ZOOM_event(1, &c))
808 ZOOM_resultset_sort(ZOOM_resultset r,
809 const char *sort_type, const char *sort_spec)
811 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
815 ZOOM_resultset_sort1(ZOOM_resultset r,
816 const char *sort_type, const char *sort_spec)
818 ZOOM_connection c = r->connection;
822 newq = ZOOM_query_create();
823 if (ZOOM_query_sortby(newq, sort_spec) < 0)
826 yaz_log(c->log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
827 r, r, sort_type, sort_spec);
831 if (c->host_port && c->proto == PROTO_HTTP)
835 yaz_log(c->log_details, "%p ZOOM_resultset_sort: no comstack", r);
836 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
840 yaz_log(c->log_details, "%p ZOOM_resultset_sort: prepare reconnect",
846 ZOOM_resultset_cache_reset(r);
847 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
848 task->u.sort.resultset = r;
849 task->u.sort.q = newq;
851 ZOOM_resultset_addref(r);
855 while (ZOOM_event(1, &c))
863 ZOOM_resultset_destroy(ZOOM_resultset r)
865 resultset_destroy(r);
868 static void resultset_destroy(ZOOM_resultset r)
872 yaz_mutex_enter(r->mutex);
874 yaz_log(log_details0, "%p ZOOM_resultset_destroy r=%p count=%d",
876 if (r->refcount == 0)
878 yaz_mutex_leave(r->mutex);
880 yaz_log(log_details0, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
881 ZOOM_resultset_cache_reset(r);
882 ZOOM_resultset_release(r);
883 ZOOM_query_destroy(r->query);
884 ZOOM_options_destroy(r->options);
887 yaz_mutex_destroy(&r->mutex);
889 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
895 yaz_mutex_leave(r->mutex);
899 ZOOM_resultset_size(ZOOM_resultset r)
904 int ZOOM_test_reconnect(ZOOM_connection c)
908 if (!c->reconnect_ok)
910 ZOOM_connection_close(c);
912 c->tasks->running = 0;
913 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
915 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
916 ZOOM_connection_put_event(c, event);
921 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
922 int force_sync, int start, int count)
927 const char *syntax, *elementSetName;
931 yaz_log(log_details0, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
932 " count=%d", r, force_sync, start, count);
937 if (c->host_port && c->proto == PROTO_HTTP)
941 yaz_log(log_details0, "%p ZOOM_resultset_retrieve: no comstack", r);
942 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
946 yaz_log(log_details0, "%p ZOOM_resultset_retrieve: prepare "
951 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
952 task->u.retrieve.resultset = r;
953 task->u.retrieve.start = start;
954 task->u.retrieve.count = count;
956 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
957 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
958 elementSetName = ZOOM_options_get(r->options, "elementSetName");
959 task->u.retrieve.elementSetName = elementSetName
960 ? xstrdup(elementSetName) : 0;
962 cp = ZOOM_options_get(r->options, "schema");
963 task->u.retrieve.schema = cp ? xstrdup(cp) : 0;
965 ZOOM_resultset_addref(r);
967 if (!r->connection->async || force_sync)
968 while (r->connection && ZOOM_event(1, &r->connection))
973 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
974 size_t start, size_t count)
976 int force_present = 0;
980 yaz_log(log_api0, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
981 r, r, (long) start, (long) count);
984 ZOOM_resultset_retrieve(r, force_present, start, count);
988 for (i = 0; i< count; i++)
989 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
994 ZOOM_resultset_facets_size(ZOOM_resultset r) {
995 return r->num_facets;
998 ZOOM_API(ZOOM_facet_field)
999 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1000 int num = r->num_facets;
1001 ZOOM_facet_field *facets = r->facets;
1003 for (index = 0; index < num; index++) {
1004 if (!strcmp(facets[index]->facet_name, name)) {
1005 return facets[index];
1011 ZOOM_API(ZOOM_facet_field)
1012 ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int index) {
1013 int num = r->num_facets;
1014 ZOOM_facet_field *facets = r->facets;
1015 if (index >= 0 && index < num) {
1016 return facets[index];
1021 ZOOM_API(ZOOM_facet_field *)
1022 ZOOM_resultset_facets(ZOOM_resultset r)
1027 ZOOM_API(const char**)
1028 ZOOM_resultset_facets_names(ZOOM_resultset r)
1030 return (const char **) r->facets_names;
1033 ZOOM_API(const char*)
1034 ZOOM_facet_field_name(ZOOM_facet_field field)
1036 return field->facet_name;
1040 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1042 return field->num_terms;
1045 ZOOM_API(const char*)
1046 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1047 *freq = field->facet_terms[idx].frequency;
1048 return field->facet_terms[idx].term;
1052 static void get_cert(ZOOM_connection c)
1057 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1059 ZOOM_connection_option_setl(c, "sslPeerCert",
1060 cert_buf, cert_len);
1065 static zoom_ret do_connect_host(ZOOM_connection c,
1066 const char *logical_url);
1068 static zoom_ret do_connect(ZOOM_connection c)
1070 return do_connect_host(c, c->host_port);
1073 static zoom_ret do_connect_host(ZOOM_connection c, const char *logical_url)
1079 c->cs = cs_create_host_proxy(logical_url, 0, &add,
1080 c->tproxy ? c->tproxy : c->proxy);
1082 if (c->cs && c->cs->protocol == PROTO_HTTP)
1085 c->proto = PROTO_HTTP;
1087 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1088 ZOOM_connection_close(c);
1089 return zoom_complete;
1094 int ret = cs_connect(c->cs, add);
1097 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1098 ZOOM_connection_put_event(c, event);
1100 if (c->proto == PROTO_Z3950)
1101 ZOOM_connection_Z3950_send_init(c);
1104 /* no init request for SRW .. */
1105 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1106 ZOOM_connection_remove_task(c);
1107 ZOOM_connection_set_mask(c, 0);
1108 ZOOM_connection_exec_task(c);
1110 c->state = STATE_ESTABLISHED;
1111 return zoom_pending;
1115 int mask = ZOOM_SELECT_EXCEPT;
1116 if (c->cs->io_pending & CS_WANT_WRITE)
1117 mask += ZOOM_SELECT_WRITE;
1118 if (c->cs->io_pending & CS_WANT_READ)
1119 mask += ZOOM_SELECT_READ;
1120 ZOOM_connection_set_mask(c, mask);
1121 c->state = STATE_CONNECTING;
1122 return zoom_pending;
1125 c->state = STATE_IDLE;
1126 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, logical_url);
1127 return zoom_complete;
1130 /* returns 1 if PDU was sent OK (still pending )
1131 0 if PDU was not sent OK (nothing to wait for)
1134 ZOOM_API(ZOOM_record)
1135 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1137 const char *syntax =
1138 ZOOM_options_get(s->options, "preferredRecordSyntax");
1139 const char *elementSetName =
1140 ZOOM_options_get(s->options, "elementSetName");
1141 const char *schema =
1142 ZOOM_options_get(s->options, "schema");
1144 return ZOOM_record_cache_lookup(s, pos, syntax, elementSetName, schema);
1147 ZOOM_API(ZOOM_record)
1148 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1150 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1155 * MIKE: I think force_sync should always be zero, but I don't
1156 * want to make this change until I get the go-ahead from
1157 * Adam, in case something depends on the old synchronous
1161 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1162 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1163 rec = ZOOM_resultset_record_immediate(r, pos);
1168 ZOOM_API(ZOOM_scanset)
1169 ZOOM_connection_scan(ZOOM_connection c, const char *start)
1172 ZOOM_query q = ZOOM_query_create();
1174 ZOOM_query_prefix(q, start);
1176 s = ZOOM_connection_scan1(c, q);
1177 ZOOM_query_destroy(q);
1182 ZOOM_API(ZOOM_scanset)
1183 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
1185 ZOOM_scanset scan = 0;
1186 Z_Query *z_query = ZOOM_query_get_Z_Query(q);
1190 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
1191 scan->connection = c;
1192 scan->odr = odr_createmem(ODR_DECODE);
1193 scan->options = ZOOM_options_create_with_parent(c->options);
1195 scan->scan_response = 0;
1196 scan->srw_scan_response = 0;
1199 ZOOM_query_addref(q);
1200 scan->databaseNames = ZOOM_connection_get_databases(c, c->options,
1201 &scan->num_databaseNames,
1206 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
1207 task->u.scan.scan = scan;
1212 while (ZOOM_event(1, &c))
1220 ZOOM_scanset_destroy(ZOOM_scanset scan)
1225 if (scan->refcount == 0)
1227 ZOOM_query_destroy(scan->query);
1229 odr_destroy(scan->odr);
1231 ZOOM_options_destroy(scan->options);
1236 static zoom_ret send_package(ZOOM_connection c)
1240 yaz_log(c->log_details, "%p send_package", c);
1242 return zoom_complete;
1243 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
1245 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1246 ZOOM_connection_put_event(c, event);
1248 c->buf_out = c->tasks->u.package->buf_out;
1249 c->len_out = c->tasks->u.package->len_out;
1251 return ZOOM_send_buf(c);
1255 ZOOM_scanset_size(ZOOM_scanset scan)
1260 if (scan->scan_response && scan->scan_response->entries)
1261 return scan->scan_response->entries->num_entries;
1262 else if (scan->srw_scan_response)
1263 return scan->srw_scan_response->num_terms;
1267 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
1269 const char **value_term, size_t *value_len,
1270 const char **disp_term, size_t *disp_len)
1272 size_t noent = ZOOM_scanset_size(scan);
1283 if (scan->scan_response)
1285 Z_ScanResponse *res = scan->scan_response;
1286 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1288 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1290 *value_term = (const char *) t->term->u.general->buf;
1291 *value_len = t->term->u.general->len;
1294 *disp_term = t->displayTerm;
1295 *disp_len = strlen(*disp_term);
1297 else if (t->term->which == Z_Term_general)
1299 *disp_term = (const char *) t->term->u.general->buf;
1300 *disp_len = t->term->u.general->len;
1302 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1305 if (scan->srw_scan_response)
1307 Z_SRW_scanResponse *res = scan->srw_scan_response;
1308 Z_SRW_scanTerm *t = res->terms + pos;
1311 *value_term = t->value;
1312 *value_len = strlen(*value_term);
1315 *disp_term = t->displayTerm;
1317 *disp_term = t->value;
1318 *disp_len = strlen(*disp_term);
1319 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
1324 ZOOM_API(const char *)
1325 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
1326 size_t *occ, size_t *len)
1328 const char *value_term = 0;
1329 size_t value_len = 0;
1330 const char *disp_term = 0;
1331 size_t disp_len = 0;
1333 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1334 &disp_term, &disp_len);
1340 ZOOM_API(const char *)
1341 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
1342 size_t *occ, size_t *len)
1344 const char *value_term = 0;
1345 size_t value_len = 0;
1346 const char *disp_term = 0;
1347 size_t disp_len = 0;
1349 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1350 &disp_term, &disp_len);
1356 ZOOM_API(const char *)
1357 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
1359 return ZOOM_options_get(scan->options, key);
1363 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
1366 ZOOM_options_set(scan->options, key, val);
1370 ZOOM_API(ZOOM_package)
1371 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
1373 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
1376 p->odr_out = odr_createmem(ODR_ENCODE);
1377 p->options = ZOOM_options_create_with_parent2(options, c->options);
1385 ZOOM_package_destroy(ZOOM_package p)
1390 if (p->refcount == 0)
1392 odr_destroy(p->odr_out);
1395 ZOOM_options_destroy(p->options);
1400 ZOOM_API(const char *)
1401 ZOOM_package_option_get(ZOOM_package p, const char *key)
1403 return ZOOM_options_get(p->options, key);
1406 ZOOM_API(const char *)
1407 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
1409 return ZOOM_options_getl(p->options, key, lenp);
1413 ZOOM_package_option_set(ZOOM_package p, const char *key,
1416 ZOOM_options_set(p->options, key, val);
1420 ZOOM_package_option_setl(ZOOM_package p, const char *key,
1421 const char *val, int len)
1423 ZOOM_options_setl(p->options, key, val, len);
1427 ZOOM_connection_exec_task(ZOOM_connection c)
1429 ZOOM_task task = c->tasks;
1430 zoom_ret ret = zoom_complete;
1434 yaz_log(c->log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
1435 c, task->which, task->running);
1436 if (c->error != ZOOM_ERROR_NONE)
1438 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1439 "removing tasks because of error = %d", c, c->error);
1440 ZOOM_connection_remove_tasks(c);
1445 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1446 "task already running", c);
1450 ret = zoom_complete;
1451 if (c->cs || task->which == ZOOM_TASK_CONNECT)
1453 switch (task->which)
1455 case ZOOM_TASK_SEARCH:
1456 if (c->proto == PROTO_HTTP)
1457 ret = ZOOM_connection_srw_send_search(c);
1459 ret = ZOOM_connection_Z3950_send_search(c);
1461 case ZOOM_TASK_RETRIEVE:
1462 if (c->proto == PROTO_HTTP)
1463 ret = ZOOM_connection_srw_send_search(c);
1465 ret = send_Z3950_present(c);
1467 case ZOOM_TASK_CONNECT:
1468 ret = do_connect(c);
1470 case ZOOM_TASK_SCAN:
1471 if (c->proto == PROTO_HTTP)
1472 ret = ZOOM_connection_srw_send_scan(c);
1474 ret = ZOOM_connection_Z3950_send_scan(c);
1476 case ZOOM_TASK_PACKAGE:
1477 ret = send_package(c);
1479 case ZOOM_TASK_SORT:
1480 c->tasks->u.sort.resultset->r_sort_spec =
1481 ZOOM_query_get_sortspec(c->tasks->u.sort.q);
1482 ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
1488 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1489 "remove tasks because no connection exist", c);
1490 ZOOM_connection_remove_tasks(c);
1492 if (ret == zoom_complete)
1494 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1495 "task removed (complete)", c);
1496 ZOOM_connection_remove_task(c);
1499 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1506 static zoom_ret send_HTTP_redirect(ZOOM_connection c, const char *uri,
1507 Z_HTTP_Response *cookie_hres)
1509 struct Z_HTTP_Header *h;
1510 char *combined_cookies = 0;
1511 int combined_cookies_len = 0;
1512 Z_GDU *gdu = z_get_HTTP_Request_uri(c->odr_out, uri, 0, c->proxy ? 1 : 0);
1514 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
1515 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
1518 for (h = cookie_hres->headers; h; h = h->next)
1520 if (!strcmp(h->name, "Set-Cookie"))
1524 if (!(cp = strchr(h->value, ';')))
1525 cp = h->value + strlen(h->value);
1526 if (cp - h->value >= 1) {
1527 combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
1528 memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
1529 combined_cookies[combined_cookies_len + cp - h->value] = '\0';
1530 strcat(combined_cookies,"; ");
1531 combined_cookies_len = strlen(combined_cookies);
1536 if (combined_cookies_len)
1538 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1539 "Cookie", combined_cookies);
1540 xfree(combined_cookies);
1543 if (c->user && c->password)
1545 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
1546 c->user, c->password);
1548 return ZOOM_send_GDU(c, gdu);
1551 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu)
1555 int r = z_GDU(c->odr_out, &gdu, 0, 0);
1557 return zoom_complete;
1559 z_GDU(c->odr_print, &gdu, 0, 0);
1561 z_GDU(c->odr_save, &gdu, 0, 0);
1562 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1563 odr_reset(c->odr_out);
1565 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1566 ZOOM_connection_put_event(c, event);
1568 return ZOOM_send_buf(c);
1572 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
1573 const char *addinfo, const char *addinfo2)
1575 ZOOM_set_dset_error(c, error, "HTTP", addinfo, addinfo2);
1580 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
1582 zoom_ret cret = zoom_complete;
1585 const char *connection_head = z_HTTP_header_lookup(hres->headers,
1587 const char *location;
1589 ZOOM_connection_set_mask(c, 0);
1590 yaz_log(c->log_details, "%p handle_http", c);
1592 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
1593 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
1596 if (c->no_redirects > 10)
1598 ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1599 c->no_redirects = 0;
1600 ZOOM_connection_close(c);
1604 /* since redirect may change host we just reconnect. A smarter
1605 implementation might check whether it's the same server */
1606 do_connect_host(c, location);
1607 send_HTTP_redirect(c, location, hres);
1608 /* we're OK for now. Operation is not really complete */
1614 ret = ZOOM_handle_sru(c, hres, &cret, &addinfo);
1617 if (c->no_redirects) /* end of redirect. change hosts again */
1618 ZOOM_connection_close(c);
1620 c->no_redirects = 0;
1624 if (hres->code != 200)
1625 ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1628 yaz_log(YLOG_LOG, "set error... addinfo=%s", addinfo ?
1630 ZOOM_set_error(c, ZOOM_ERROR_DECODE, addinfo);
1632 ZOOM_connection_close(c);
1634 if (cret == zoom_complete)
1636 yaz_log(c->log_details, "removing tasks in handle_http");
1637 ZOOM_connection_remove_task(c);
1641 if (!strcmp(hres->version, "1.0"))
1643 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
1644 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
1649 /* HTTP 1.1: only if no close we stay alive.. */
1650 if (connection_head && !strcmp(connection_head, "close"))
1655 ZOOM_connection_close(c);
1658 c->tasks->running = 0;
1659 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1660 c->reconnect_ok = 0;
1664 c->reconnect_ok = 1; /* if the server closes anyway */
1669 static int do_read(ZOOM_connection c)
1674 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
1675 ZOOM_connection_put_event(c, event);
1677 r = cs_get(c->cs, &c->buf_in, &c->len_in);
1678 more = cs_more(c->cs);
1679 yaz_log(c->log_details, "%p do_read len=%d more=%d", c, r, more);
1684 if (!ZOOM_test_reconnect(c))
1686 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1687 ZOOM_connection_close(c);
1695 odr_reset(c->odr_in);
1696 odr_setbuf(c->odr_in, c->buf_in, r, 0);
1697 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
1698 ZOOM_connection_put_event(c, event);
1700 if (!z_GDU(c->odr_in, &gdu, 0, 0))
1703 int err = odr_geterrorx(c->odr_in, &x);
1705 const char *element = odr_getelement(c->odr_in);
1706 yaz_snprintf(msg, sizeof(msg),
1707 "ODR code %d:%d element=%s offset=%d",
1708 err, x, element ? element : "<unknown>",
1709 odr_offset(c->odr_in));
1710 ZOOM_set_error(c, ZOOM_ERROR_DECODE, msg);
1713 FILE *ber_file = yaz_log_file();
1715 odr_dumpBER(ber_file, c->buf_in, r);
1717 ZOOM_connection_close(c);
1722 z_GDU(c->odr_print, &gdu, 0, 0);
1724 z_GDU(c->odr_save, &gdu, 0, 0);
1725 if (gdu->which == Z_GDU_Z3950)
1726 ZOOM_handle_Z3950_apdu(c, gdu->u.z3950);
1727 else if (gdu->which == Z_GDU_HTTP_Response)
1730 handle_http(c, gdu->u.HTTP_Response);
1732 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1733 ZOOM_connection_close(c);
1741 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
1746 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1747 ZOOM_connection_put_event(c, event);
1749 yaz_log(c->log_details, "%p do_write_ex len=%d", c, len_out);
1750 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
1752 yaz_log(c->log_details, "%p do_write_ex write failed", c);
1753 if (ZOOM_test_reconnect(c))
1755 return zoom_pending;
1757 if (c->state == STATE_CONNECTING)
1758 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1760 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1761 ZOOM_connection_close(c);
1762 return zoom_complete;
1766 int mask = ZOOM_SELECT_EXCEPT;
1767 if (c->cs->io_pending & CS_WANT_WRITE)
1768 mask += ZOOM_SELECT_WRITE;
1769 if (c->cs->io_pending & CS_WANT_READ)
1770 mask += ZOOM_SELECT_READ;
1771 ZOOM_connection_set_mask(c, mask);
1772 yaz_log(c->log_details, "%p do_write_ex write incomplete mask=%d",
1777 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
1778 yaz_log(c->log_details, "%p do_write_ex write complete mask=%d",
1781 return zoom_pending;
1784 zoom_ret ZOOM_send_buf(ZOOM_connection c)
1786 return do_write_ex(c, c->buf_out, c->len_out);
1790 ZOOM_API(const char *)
1791 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
1793 if (!strcmp(key, "APDU"))
1795 return c->saveAPDU_wrbuf ? wrbuf_cstr(c->saveAPDU_wrbuf) : "";
1798 return ZOOM_options_get(c->options, key);
1801 ZOOM_API(const char *)
1802 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
1804 if (!strcmp(key, "APDU"))
1806 if (c->saveAPDU_wrbuf)
1808 *lenp = wrbuf_len(c->saveAPDU_wrbuf);
1809 return wrbuf_cstr(c->saveAPDU_wrbuf);
1818 return ZOOM_options_getl(c->options, key, lenp);
1822 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
1825 if (!strcmp(key, "saveAPDU"))
1827 if (val && strcmp(val, "0"))
1829 if (!c->saveAPDU_wrbuf)
1830 c->saveAPDU_wrbuf = wrbuf_alloc();
1832 wrbuf_rewind(c->saveAPDU_wrbuf);
1836 wrbuf_destroy(c->saveAPDU_wrbuf);
1837 c->saveAPDU_wrbuf = 0;
1839 ZOOM_connection_save_apdu_wrbuf(c, c->saveAPDU_wrbuf);
1842 ZOOM_options_set(c->options, key, val);
1846 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
1847 const char *val, int len)
1849 ZOOM_options_setl(c->options, key, val, len);
1852 ZOOM_API(const char *)
1853 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
1855 return ZOOM_options_get(r->options, key);
1859 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
1862 ZOOM_options_set(r->options, key, val);
1867 ZOOM_connection_errcode(ZOOM_connection c)
1869 return ZOOM_connection_error(c, 0, 0);
1872 ZOOM_API(const char *)
1873 ZOOM_connection_errmsg(ZOOM_connection c)
1876 ZOOM_connection_error(c, &msg, 0);
1880 ZOOM_API(const char *)
1881 ZOOM_connection_addinfo(ZOOM_connection c)
1883 const char *addinfo;
1884 ZOOM_connection_error(c, 0, &addinfo);
1888 ZOOM_API(const char *)
1889 ZOOM_connection_diagset(ZOOM_connection c)
1891 const char *diagset;
1892 ZOOM_connection_error_x(c, 0, 0, &diagset);
1896 ZOOM_API(const char *)
1897 ZOOM_diag_str(int error)
1901 case ZOOM_ERROR_NONE:
1903 case ZOOM_ERROR_CONNECT:
1904 return "Connect failed";
1905 case ZOOM_ERROR_MEMORY:
1906 return "Out of memory";
1907 case ZOOM_ERROR_ENCODE:
1908 return "Encoding failed";
1909 case ZOOM_ERROR_DECODE:
1910 return "Decoding failed";
1911 case ZOOM_ERROR_CONNECTION_LOST:
1912 return "Connection lost";
1913 case ZOOM_ERROR_INIT:
1914 return "Init rejected";
1915 case ZOOM_ERROR_INTERNAL:
1916 return "Internal failure";
1917 case ZOOM_ERROR_TIMEOUT:
1919 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
1920 return "Unsupported protocol";
1921 case ZOOM_ERROR_UNSUPPORTED_QUERY:
1922 return "Unsupported query type";
1923 case ZOOM_ERROR_INVALID_QUERY:
1924 return "Invalid query";
1925 case ZOOM_ERROR_CQL_PARSE:
1926 return "CQL parsing error";
1927 case ZOOM_ERROR_CQL_TRANSFORM:
1928 return "CQL transformation error";
1929 case ZOOM_ERROR_CCL_CONFIG:
1930 return "CCL configuration error";
1931 case ZOOM_ERROR_CCL_PARSE:
1932 return "CCL parsing error";
1933 case ZOOM_ERROR_ES_INVALID_ACTION:
1934 return "Extended Service. invalid action";
1935 case ZOOM_ERROR_ES_INVALID_VERSION:
1936 return "Extended Service. invalid version";
1937 case ZOOM_ERROR_ES_INVALID_SYNTAX:
1938 return "Extended Service. invalid syntax";
1940 return diagbib1_str(error);
1945 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1946 const char **addinfo, const char **diagset)
1948 int error = c->error;
1951 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
1952 *cp = ZOOM_diag_str(error);
1953 else if (!strcmp(c->diagset, "HTTP"))
1954 *cp = z_HTTP_errmsg(c->error);
1955 else if (!strcmp(c->diagset, "Bib-1"))
1956 *cp = ZOOM_diag_str(error);
1957 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
1958 *cp = yaz_diag_srw_str(c->error);
1960 *cp = "Unknown error and diagnostic set";
1963 *addinfo = c->addinfo ? c->addinfo : "";
1965 *diagset = c->diagset ? c->diagset : "";
1970 ZOOM_connection_error(ZOOM_connection c, const char **cp,
1971 const char **addinfo)
1973 return ZOOM_connection_error_x(c, cp, addinfo, 0);
1976 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
1978 ZOOM_Event event = 0;
1979 int r = cs_look(c->cs);
1980 yaz_log(c->log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
1985 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1986 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1987 ZOOM_connection_close(c);
1988 ZOOM_connection_put_event(c, event);
1990 else if (r == CS_CONNECT)
1992 int ret = ret = cs_rcvconnect(c->cs);
1993 yaz_log(c->log_details, "%p ZOOM_connection_do_io "
1994 "cs_rcvconnect returned %d", c, ret);
1997 int mask = ZOOM_SELECT_EXCEPT;
1998 if (c->cs->io_pending & CS_WANT_WRITE)
1999 mask += ZOOM_SELECT_WRITE;
2000 if (c->cs->io_pending & CS_WANT_READ)
2001 mask += ZOOM_SELECT_READ;
2002 ZOOM_connection_set_mask(c, mask);
2003 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
2004 ZOOM_connection_put_event(c, event);
2008 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2009 ZOOM_connection_put_event(c, event);
2011 if (c->proto == PROTO_Z3950)
2012 ZOOM_connection_Z3950_send_init(c);
2015 /* no init request for SRW .. */
2016 assert(c->tasks->which == ZOOM_TASK_CONNECT);
2017 ZOOM_connection_remove_task(c);
2018 ZOOM_connection_set_mask(c, 0);
2019 ZOOM_connection_exec_task(c);
2021 c->state = STATE_ESTABLISHED;
2025 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2026 ZOOM_connection_close(c);
2031 if (mask & ZOOM_SELECT_EXCEPT)
2033 if (!ZOOM_test_reconnect(c))
2035 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
2036 ZOOM_connection_close(c);
2040 if (mask & ZOOM_SELECT_READ)
2042 if (c->cs && (mask & ZOOM_SELECT_WRITE))
2048 ZOOM_connection_last_event(ZOOM_connection cs)
2051 return ZOOM_EVENT_NONE;
2052 return cs->last_event;
2056 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
2060 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
2061 /* timeout and this connection was waiting */
2062 ZOOM_set_error(c, ZOOM_ERROR_TIMEOUT, 0);
2063 ZOOM_connection_close(c);
2064 ZOOM_connection_put_event(c, event);
2070 ZOOM_connection_process(ZOOM_connection c)
2076 event = ZOOM_connection_get_event(c);
2079 ZOOM_Event_destroy(event);
2082 ZOOM_connection_exec_task(c);
2083 event = ZOOM_connection_get_event(c);
2086 ZOOM_Event_destroy(event);
2093 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
2097 yaz_log(log_details0, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
2099 for (i = 0; i<no; i++)
2101 ZOOM_connection c = cs[i];
2103 if (c && ZOOM_connection_process(c))
2109 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
2111 if (c->mask && mask)
2112 ZOOM_connection_do_io(c, mask);
2116 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
2119 return cs_fileno(c->cs);
2123 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
2131 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
2138 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
2140 return ZOOM_options_get_int(c->options, "timeout", 30);
2143 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
2148 ZOOM_connection_set_mask(c, 0);
2149 c->state = STATE_IDLE;
2155 * c-file-style: "Stroustrup"
2156 * indent-tabs-mode: nil
2158 * vim: shiftwidth=4 tabstop=8 expandtab