1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 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;
290 c->url_authentication = 0;
292 c->maximum_record_size = 0;
293 c->preferred_message_size = 0;
295 c->odr_in = odr_createmem(ODR_DECODE);
296 c->odr_out = odr_createmem(ODR_ENCODE);
301 c->support_named_resultsets = 0;
302 c->last_event = ZOOM_EVENT_NONE;
304 c->m_queue_front = 0;
310 c->saveAPDU_wrbuf = 0;
312 #if HAVE_LIBMEMCACHED_MEMCACHED_H
318 ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w)
322 odr_destroy(c->odr_save);
327 c->odr_save = odr_createmem(ODR_PRINT);
328 odr_set_stream(c->odr_save, w, odr_wrbuf_write, 0);
332 /* set database names. Take local databases (if set); otherwise
333 take databases given in ZURL (if set); otherwise use Default */
334 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
337 char **databaseNames;
338 const char *cp = ZOOM_options_get(options, "databaseName");
340 if ((!cp || !*cp) && con->host_port)
341 cs_get_host_args(con->host_port, &cp);
344 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
345 return databaseNames;
348 ZOOM_API(ZOOM_connection)
349 ZOOM_connection_new(const char *host, int portnum)
351 ZOOM_connection c = ZOOM_connection_create(0);
353 ZOOM_connection_connect(c, host, portnum);
357 static zoom_sru_mode get_sru_mode_from_string(const char *s)
360 return zoom_sru_soap;
361 if (!yaz_matchstr(s, "soap"))
362 return zoom_sru_soap;
363 else if (!yaz_matchstr(s, "get"))
365 else if (!yaz_matchstr(s, "post"))
366 return zoom_sru_post;
367 else if (!yaz_matchstr(s, "solr"))
368 return zoom_sru_solr;
369 return zoom_sru_error;
373 ZOOM_connection_connect(ZOOM_connection c,
374 const char *host, int portnum)
377 const char *http_lead;
381 yaz_log(c->log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
382 c, host ? host : "null", portnum);
384 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
385 ZOOM_connection_remove_tasks(c);
389 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
390 odr_destroy(c->odr_print);
392 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
394 c->odr_print = odr_createmem(ODR_PRINT);
395 odr_setprint(c->odr_print, yaz_log_file());
402 yaz_log(c->log_details, "%p ZOOM_connection_connect reconnect ok", c);
406 yaz_log(c->log_details, "%p ZOOM_connection_connect connect", c);
409 val = ZOOM_options_get(c->options, "proxy");
412 yaz_log(c->log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
413 c->proxy = xstrdup(val);
418 val = ZOOM_options_get(c->options, "tproxy");
421 yaz_log(c->log_details, "%p ZOOM_connection_connect tproxy=%s", c, val);
422 c->tproxy = xstrdup(val);
427 val = ZOOM_options_get(c->options, "charset");
430 yaz_log(c->log_details, "%p ZOOM_connection_connect charset=%s", c, val);
431 c->charset = xstrdup(val);
435 val = ZOOM_options_get(c->options, "lang");
438 yaz_log(c->log_details, "%p ZOOM_connection_connect lang=%s", c, val);
439 c->lang = xstrdup(val);
444 val = ZOOM_options_get(c->options, "sru");
445 if (val && *val && !strstr(host, "://"))
446 http_lead = "http://";
449 c->sru_mode = get_sru_mode_from_string(val);
457 sprintf(hostn, "%.80s:%d", host, portnum);
460 c->host_port = xmalloc(strlen(host) + strlen(http_lead) + 1);
461 strcpy(c->host_port, http_lead);
462 strcat(c->host_port, host);
467 * If the "<scheme>:" part of the host string is preceded by one
468 * or more comma-separated <name>=<value> pairs, these are taken
469 * to be options to be set on the connection object. Among other
470 * applications, this facility can be used to embed authentication
472 * user=admin,password=secret,tcp:localhost:9999
474 char *remainder = c->host_port;
475 char *pcolon = strchr(remainder, ':');
478 while ((pcomma = strchr(remainder, ',')) != 0 &&
479 (pcolon == 0 || pcomma < pcolon))
482 if ((pequals = strchr(remainder, '=')) != 0)
485 ZOOM_connection_option_set(c, remainder, pequals+1);
487 remainder = pcomma+1;
490 if (remainder != c->host_port)
492 remainder = xstrdup(remainder);
494 c->host_port = remainder;
498 xfree(c->sru_version);
499 val = ZOOM_options_get(c->options, "sru_version");
500 c->sru_version = xstrdup(val ? val : "1.2");
502 ZOOM_options_set(c->options, "host", c->host_port);
504 xfree(c->cookie_out);
506 val = ZOOM_options_get(c->options, "cookie");
509 yaz_log(c->log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
510 c->cookie_out = xstrdup(val);
515 val = ZOOM_options_get(c->options, "clientIP");
518 yaz_log(c->log_details, "%p ZOOM_connection_connect clientIP=%s",
520 c->client_IP = xstrdup(val);
525 val = ZOOM_options_get(c->options, "group");
527 c->group = xstrdup(val);
531 val = ZOOM_options_get(c->options, "user");
533 c->user = xstrdup(val);
537 val = ZOOM_options_get(c->options, "password");
539 val = ZOOM_options_get(c->options, "pass");
541 c->password = xstrdup(val);
543 val = ZOOM_options_get(c->options, "authenticationMode");
544 if (val && !strcmp(val, "url"))
545 c->url_authentication = 1;
547 c->url_authentication = 0;
549 c->maximum_record_size =
550 ZOOM_options_get_int(c->options, "maximumRecordSize", 64*1024*1024);
551 c->preferred_message_size =
552 ZOOM_options_get_int(c->options, "preferredMessageSize", 64*1024*1024);
554 c->async = ZOOM_options_get_bool(c->options, "async", 0);
556 yaz_cookies_destroy(c->cookies);
557 c->cookies = yaz_cookies_create();
559 #if HAVE_LIBMEMCACHED_MEMCACHED_H
562 memcached_free(c->mc_st);
566 val = ZOOM_options_get(c->options, "memcached");
569 #if HAVE_LIBMEMCACHED_MEMCACHED_H
570 c->mc_st = memcached(val, strlen(val));
573 ZOOM_set_error(c, ZOOM_ERROR_MEMCACHED, val);
577 ZOOM_set_error(c, ZOOM_ERROR_MEMCACHED, "not enabled");
582 if (c->sru_mode == zoom_sru_error)
584 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, val);
585 ZOOM_connection_remove_tasks(c);
589 yaz_log(c->log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
590 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
594 while (ZOOM_event(1, &c))
599 ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
603 /* remove ourselves from the resultsets in connection */
604 ZOOM_resultset *rp = &r->connection->resultsets;
607 assert(*rp); /* we must be in this list!! */
609 { /* OK, we're here - take us out of it */
620 ZOOM_connection_destroy(ZOOM_connection c)
625 yaz_log(c->log_api, "%p ZOOM_connection_destroy", c);
627 #if HAVE_LIBMEMCACHED_MEMCACHED_H
629 memcached_free(c->mc_st);
634 for (r = c->resultsets; r; r = r->next)
640 odr_destroy(c->odr_in);
641 odr_destroy(c->odr_out);
643 odr_destroy(c->odr_save);
646 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
647 odr_destroy(c->odr_print);
649 ZOOM_options_destroy(c->options);
650 ZOOM_connection_remove_tasks(c);
651 ZOOM_connection_remove_events(c);
657 xfree(c->cookie_out);
663 xfree(c->sru_version);
664 yaz_cookies_destroy(c->cookies);
665 wrbuf_destroy(c->saveAPDU_wrbuf);
669 void ZOOM_resultset_addref(ZOOM_resultset r)
673 yaz_mutex_enter(r->mutex);
675 yaz_log(log_details0, "%p ZOOM_resultset_addref count=%d",
677 yaz_mutex_leave(r->mutex);
681 static int g_resultsets = 0;
682 static YAZ_MUTEX g_resultset_mutex = 0;
684 /* TODO We need to initialize this before running threaded:
685 * call resultset_use(0) */
687 static int resultset_use(int delta) {
689 if (g_resultset_mutex == 0)
690 yaz_mutex_create(&g_resultset_mutex);
691 yaz_mutex_enter(g_resultset_mutex);
692 g_resultsets += delta;
693 resultset_count = g_resultsets;
694 yaz_mutex_leave(g_resultset_mutex);
695 return resultset_count;
698 int resultsets_count(void) {
699 return resultset_use(0);
702 ZOOM_resultset ZOOM_resultset_create(void)
705 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
709 yaz_log(log_details0, "%p ZOOM_resultset_create", r);
712 r->odr = odr_createmem(ODR_ENCODE);
716 for (i = 0; i<RECORD_HASH_SIZE; i++)
717 r->record_hash[i] = 0;
721 r->databaseNames = 0;
722 r->num_databaseNames = 0;
727 yaz_mutex_create(&r->mutex);
730 WRBUF w = wrbuf_alloc();
731 YAZ_SHPTR_INIT(r->record_wrbuf, w);
739 ZOOM_API(ZOOM_resultset)
740 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
743 ZOOM_query s = ZOOM_query_create();
745 ZOOM_query_prefix(s, q);
747 r = ZOOM_connection_search(c, s);
748 ZOOM_query_destroy(s);
752 ZOOM_API(ZOOM_resultset)
753 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
755 ZOOM_resultset r = ZOOM_resultset_create();
759 const char *syntax, *elementSetName, *schema;
760 yaz_log(c->log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
761 r->r_sort_spec = ZOOM_query_get_sortspec(q);
764 r->options = ZOOM_options_create_with_parent(c->options);
766 start = ZOOM_options_get_int(r->options, "start", 0);
767 count = ZOOM_options_get_int(r->options, "count", 0);
769 /* If "presentChunk" is defined use that; otherwise "step" */
770 const char *cp = ZOOM_options_get(r->options, "presentChunk");
771 r->step = ZOOM_options_get_int(r->options,
772 (cp != 0 ? "presentChunk": "step"), 0);
774 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
775 cp = ZOOM_options_get(r->options, "setname");
777 r->setname = xstrdup(cp);
779 r->databaseNames = ZOOM_connection_get_databases(c, c->options, &r->num_databaseNames,
783 r->next = c->resultsets;
786 #if HAVE_LIBMEMCACHED_MEMCACHED_H
787 r->mc_key = wrbuf_alloc();
788 wrbuf_puts(r->mc_key, c->host_port);
789 wrbuf_puts(r->mc_key, ";");
790 wrbuf_puts(r->mc_key, ZOOM_query_get_query_string(q));
795 memcached_return_t rc;
796 char *v = memcached_get(c->mc_st, wrbuf_buf(r->mc_key),
797 wrbuf_len(r->mc_key), &v_len, &flags, &rc);
800 yaz_log(YLOG_LOG, "For key %s got value %.*s",
801 wrbuf_cstr(r->mc_key), (int) v_len, v);
805 yaz_log(YLOG_LOG, "For key %s got NO value", wrbuf_cstr(r->mc_key));
810 if (c->host_port && c->proto == PROTO_HTTP)
814 yaz_log(c->log_details, "ZOOM_connection_search: no comstack");
815 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
819 yaz_log(c->log_details, "ZOOM_connection_search: reconnect");
824 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
825 task->u.search.resultset = r;
826 task->u.search.start = start;
827 task->u.search.count = count;
828 task->u.search.recv_search_fired = 0;
830 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
831 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
832 elementSetName = ZOOM_options_get(r->options, "elementSetName");
833 task->u.search.elementSetName = elementSetName ?
834 xstrdup(elementSetName) : 0;
835 schema = ZOOM_options_get(r->options, "schema");
836 task->u.search.schema = schema ? xstrdup(schema) : 0;
838 ZOOM_resultset_addref(r);
840 ZOOM_query_addref(q);
844 while (ZOOM_event(1, &c))
851 ZOOM_resultset_sort(ZOOM_resultset r,
852 const char *sort_type, const char *sort_spec)
854 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
858 ZOOM_resultset_sort1(ZOOM_resultset r,
859 const char *sort_type, const char *sort_spec)
861 ZOOM_connection c = r->connection;
865 newq = ZOOM_query_create();
866 if (ZOOM_query_sortby(newq, sort_spec) < 0)
869 yaz_log(c->log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
870 r, r, sort_type, sort_spec);
874 if (c->host_port && c->proto == PROTO_HTTP)
878 yaz_log(c->log_details, "%p ZOOM_resultset_sort: no comstack", r);
879 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
883 yaz_log(c->log_details, "%p ZOOM_resultset_sort: prepare reconnect",
889 ZOOM_resultset_cache_reset(r);
890 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
891 task->u.sort.resultset = r;
892 task->u.sort.q = newq;
894 ZOOM_resultset_addref(r);
898 while (ZOOM_event(1, &c))
906 ZOOM_resultset_destroy(ZOOM_resultset r)
908 resultset_destroy(r);
911 static void resultset_destroy(ZOOM_resultset r)
915 yaz_mutex_enter(r->mutex);
917 yaz_log(log_details0, "%p ZOOM_resultset_destroy r=%p count=%d",
919 if (r->refcount == 0)
921 yaz_mutex_leave(r->mutex);
923 yaz_log(log_details0, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
924 ZOOM_resultset_cache_reset(r);
925 ZOOM_resultset_release(r);
926 ZOOM_query_destroy(r->query);
927 ZOOM_options_destroy(r->options);
930 yaz_mutex_destroy(&r->mutex);
932 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
934 wrbuf_destroy(r->mc_key);
939 yaz_mutex_leave(r->mutex);
943 ZOOM_resultset_size(ZOOM_resultset r)
948 int ZOOM_test_reconnect(ZOOM_connection c)
952 if (!c->reconnect_ok)
954 ZOOM_connection_close(c);
956 c->tasks->running = 0;
957 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
959 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
960 ZOOM_connection_put_event(c, event);
965 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
966 int force_sync, int start, int count)
971 const char *syntax, *elementSetName;
975 yaz_log(log_details0, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
976 " count=%d", r, force_sync, start, count);
981 if (c->host_port && c->proto == PROTO_HTTP)
985 yaz_log(log_details0, "%p ZOOM_resultset_retrieve: no comstack", r);
986 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
990 yaz_log(log_details0, "%p ZOOM_resultset_retrieve: prepare "
995 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
996 task->u.retrieve.resultset = r;
997 task->u.retrieve.start = start;
998 task->u.retrieve.count = count;
1000 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1001 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1002 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1003 task->u.retrieve.elementSetName = elementSetName
1004 ? xstrdup(elementSetName) : 0;
1006 cp = ZOOM_options_get(r->options, "schema");
1007 task->u.retrieve.schema = cp ? xstrdup(cp) : 0;
1009 ZOOM_resultset_addref(r);
1011 if (!r->connection->async || force_sync)
1012 while (r->connection && ZOOM_event(1, &r->connection))
1017 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1018 size_t start, size_t count)
1020 int force_present = 0;
1024 yaz_log(log_api0, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1025 r, r, (long) start, (long) count);
1028 ZOOM_resultset_retrieve(r, force_present, start, count);
1032 for (i = 0; i< count; i++)
1033 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1038 ZOOM_resultset_facets_size(ZOOM_resultset r) {
1039 return r->num_facets;
1042 ZOOM_API(ZOOM_facet_field)
1043 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1044 int num = r->num_facets;
1045 ZOOM_facet_field *facets = r->facets;
1047 for (index = 0; index < num; index++) {
1048 if (!strcmp(facets[index]->facet_name, name)) {
1049 return facets[index];
1055 ZOOM_API(ZOOM_facet_field)
1056 ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int index) {
1057 int num = r->num_facets;
1058 ZOOM_facet_field *facets = r->facets;
1059 if (index >= 0 && index < num) {
1060 return facets[index];
1065 ZOOM_API(ZOOM_facet_field *)
1066 ZOOM_resultset_facets(ZOOM_resultset r)
1071 ZOOM_API(const char**)
1072 ZOOM_resultset_facets_names(ZOOM_resultset r)
1074 return (const char **) r->facets_names;
1077 ZOOM_API(const char*)
1078 ZOOM_facet_field_name(ZOOM_facet_field field)
1080 return field->facet_name;
1084 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1086 return field->num_terms;
1089 ZOOM_API(const char*)
1090 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1091 *freq = field->facet_terms[idx].frequency;
1092 return field->facet_terms[idx].term;
1096 static void get_cert(ZOOM_connection c)
1101 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1103 ZOOM_connection_option_setl(c, "sslPeerCert",
1104 cert_buf, cert_len);
1109 static zoom_ret do_connect_host(ZOOM_connection c,
1110 const char *logical_url);
1112 static zoom_ret do_connect(ZOOM_connection c)
1114 return do_connect_host(c, c->host_port);
1117 static zoom_ret do_connect_host(ZOOM_connection c, const char *logical_url)
1123 c->cs = cs_create_host_proxy(logical_url, 0, &add,
1124 c->tproxy ? c->tproxy : c->proxy);
1126 if (c->cs && c->cs->protocol == PROTO_HTTP)
1129 c->proto = PROTO_HTTP;
1131 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1132 ZOOM_connection_close(c);
1133 return zoom_complete;
1138 int ret = cs_connect(c->cs, add);
1141 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1142 ZOOM_connection_put_event(c, event);
1144 if (c->proto == PROTO_Z3950)
1145 ZOOM_connection_Z3950_send_init(c);
1148 /* no init request for SRW .. */
1149 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1150 ZOOM_connection_remove_task(c);
1151 ZOOM_connection_set_mask(c, 0);
1152 ZOOM_connection_exec_task(c);
1154 c->state = STATE_ESTABLISHED;
1155 return zoom_pending;
1159 int mask = ZOOM_SELECT_EXCEPT;
1160 if (c->cs->io_pending & CS_WANT_WRITE)
1161 mask += ZOOM_SELECT_WRITE;
1162 if (c->cs->io_pending & CS_WANT_READ)
1163 mask += ZOOM_SELECT_READ;
1164 ZOOM_connection_set_mask(c, mask);
1165 c->state = STATE_CONNECTING;
1166 return zoom_pending;
1169 c->state = STATE_IDLE;
1170 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, logical_url);
1171 return zoom_complete;
1174 /* returns 1 if PDU was sent OK (still pending )
1175 0 if PDU was not sent OK (nothing to wait for)
1178 ZOOM_API(ZOOM_record)
1179 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1181 const char *syntax =
1182 ZOOM_options_get(s->options, "preferredRecordSyntax");
1183 const char *elementSetName =
1184 ZOOM_options_get(s->options, "elementSetName");
1185 const char *schema =
1186 ZOOM_options_get(s->options, "schema");
1188 return ZOOM_record_cache_lookup(s, pos, syntax, elementSetName, schema);
1191 ZOOM_API(ZOOM_record)
1192 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1194 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1199 * MIKE: I think force_sync should always be zero, but I don't
1200 * want to make this change until I get the go-ahead from
1201 * Adam, in case something depends on the old synchronous
1205 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1206 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1207 rec = ZOOM_resultset_record_immediate(r, pos);
1212 ZOOM_API(ZOOM_scanset)
1213 ZOOM_connection_scan(ZOOM_connection c, const char *start)
1216 ZOOM_query q = ZOOM_query_create();
1218 ZOOM_query_prefix(q, start);
1220 s = ZOOM_connection_scan1(c, q);
1221 ZOOM_query_destroy(q);
1226 ZOOM_API(ZOOM_scanset)
1227 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
1229 ZOOM_scanset scan = 0;
1230 Z_Query *z_query = ZOOM_query_get_Z_Query(q);
1234 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
1235 scan->connection = c;
1236 scan->odr = odr_createmem(ODR_DECODE);
1237 scan->options = ZOOM_options_create_with_parent(c->options);
1239 scan->scan_response = 0;
1240 scan->srw_scan_response = 0;
1243 ZOOM_query_addref(q);
1244 scan->databaseNames = ZOOM_connection_get_databases(c, c->options,
1245 &scan->num_databaseNames,
1250 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
1251 task->u.scan.scan = scan;
1256 while (ZOOM_event(1, &c))
1264 ZOOM_scanset_destroy(ZOOM_scanset scan)
1269 if (scan->refcount == 0)
1271 ZOOM_query_destroy(scan->query);
1273 odr_destroy(scan->odr);
1275 ZOOM_options_destroy(scan->options);
1280 static zoom_ret send_package(ZOOM_connection c)
1284 yaz_log(c->log_details, "%p send_package", c);
1286 return zoom_complete;
1287 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
1289 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1290 ZOOM_connection_put_event(c, event);
1292 c->buf_out = c->tasks->u.package->buf_out;
1293 c->len_out = c->tasks->u.package->len_out;
1295 return ZOOM_send_buf(c);
1299 ZOOM_scanset_size(ZOOM_scanset scan)
1304 if (scan->scan_response && scan->scan_response->entries)
1305 return scan->scan_response->entries->num_entries;
1306 else if (scan->srw_scan_response)
1307 return scan->srw_scan_response->num_terms;
1311 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
1313 const char **value_term, size_t *value_len,
1314 const char **disp_term, size_t *disp_len)
1316 size_t noent = ZOOM_scanset_size(scan);
1327 if (scan->scan_response)
1329 Z_ScanResponse *res = scan->scan_response;
1330 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1332 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1334 *value_term = (const char *) t->term->u.general->buf;
1335 *value_len = t->term->u.general->len;
1338 *disp_term = t->displayTerm;
1339 *disp_len = strlen(*disp_term);
1341 else if (t->term->which == Z_Term_general)
1343 *disp_term = (const char *) t->term->u.general->buf;
1344 *disp_len = t->term->u.general->len;
1346 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1349 if (scan->srw_scan_response)
1351 Z_SRW_scanResponse *res = scan->srw_scan_response;
1352 Z_SRW_scanTerm *t = res->terms + pos;
1355 *value_term = t->value;
1356 *value_len = strlen(*value_term);
1359 *disp_term = t->displayTerm;
1361 *disp_term = t->value;
1362 *disp_len = strlen(*disp_term);
1363 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
1368 ZOOM_API(const char *)
1369 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
1370 size_t *occ, size_t *len)
1372 const char *value_term = 0;
1373 size_t value_len = 0;
1374 const char *disp_term = 0;
1375 size_t disp_len = 0;
1377 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1378 &disp_term, &disp_len);
1384 ZOOM_API(const char *)
1385 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
1386 size_t *occ, size_t *len)
1388 const char *value_term = 0;
1389 size_t value_len = 0;
1390 const char *disp_term = 0;
1391 size_t disp_len = 0;
1393 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1394 &disp_term, &disp_len);
1400 ZOOM_API(const char *)
1401 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
1403 return ZOOM_options_get(scan->options, key);
1407 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
1410 ZOOM_options_set(scan->options, key, val);
1414 ZOOM_API(ZOOM_package)
1415 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
1417 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
1420 p->odr_out = odr_createmem(ODR_ENCODE);
1421 p->options = ZOOM_options_create_with_parent2(options, c->options);
1429 ZOOM_package_destroy(ZOOM_package p)
1434 if (p->refcount == 0)
1436 odr_destroy(p->odr_out);
1439 ZOOM_options_destroy(p->options);
1444 ZOOM_API(const char *)
1445 ZOOM_package_option_get(ZOOM_package p, const char *key)
1447 return ZOOM_options_get(p->options, key);
1450 ZOOM_API(const char *)
1451 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
1453 return ZOOM_options_getl(p->options, key, lenp);
1457 ZOOM_package_option_set(ZOOM_package p, const char *key,
1460 ZOOM_options_set(p->options, key, val);
1464 ZOOM_package_option_setl(ZOOM_package p, const char *key,
1465 const char *val, int len)
1467 ZOOM_options_setl(p->options, key, val, len);
1471 ZOOM_connection_exec_task(ZOOM_connection c)
1473 ZOOM_task task = c->tasks;
1474 zoom_ret ret = zoom_complete;
1478 yaz_log(c->log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
1479 c, task->which, task->running);
1480 if (c->error != ZOOM_ERROR_NONE)
1482 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1483 "removing tasks because of error = %d", c, c->error);
1484 ZOOM_connection_remove_tasks(c);
1489 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1490 "task already running", c);
1494 ret = zoom_complete;
1495 if (c->cs || task->which == ZOOM_TASK_CONNECT)
1497 switch (task->which)
1499 case ZOOM_TASK_SEARCH:
1500 if (c->proto == PROTO_HTTP)
1501 ret = ZOOM_connection_srw_send_search(c);
1503 ret = ZOOM_connection_Z3950_send_search(c);
1505 case ZOOM_TASK_RETRIEVE:
1506 if (c->proto == PROTO_HTTP)
1507 ret = ZOOM_connection_srw_send_search(c);
1509 ret = send_Z3950_present(c);
1511 case ZOOM_TASK_CONNECT:
1512 ret = do_connect(c);
1514 case ZOOM_TASK_SCAN:
1515 if (c->proto == PROTO_HTTP)
1516 ret = ZOOM_connection_srw_send_scan(c);
1518 ret = ZOOM_connection_Z3950_send_scan(c);
1520 case ZOOM_TASK_PACKAGE:
1521 ret = send_package(c);
1523 case ZOOM_TASK_SORT:
1524 c->tasks->u.sort.resultset->r_sort_spec =
1525 ZOOM_query_get_sortspec(c->tasks->u.sort.q);
1526 ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
1532 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1533 "remove tasks because no connection exist", c);
1534 ZOOM_connection_remove_tasks(c);
1536 if (ret == zoom_complete)
1538 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1539 "task removed (complete)", c);
1540 ZOOM_connection_remove_task(c);
1543 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1550 static zoom_ret send_HTTP_redirect(ZOOM_connection c, const char *uri)
1552 Z_GDU *gdu = z_get_HTTP_Request_uri(c->odr_out, uri, 0, c->proxy ? 1 : 0);
1554 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
1555 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
1557 yaz_cookies_request(c->cookies, c->odr_out, gdu->u.HTTP_Request);
1558 if (c->user && c->password)
1560 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
1561 c->user, c->password);
1563 return ZOOM_send_GDU(c, gdu);
1566 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu)
1570 int r = z_GDU(c->odr_out, &gdu, 0, 0);
1572 return zoom_complete;
1574 z_GDU(c->odr_print, &gdu, 0, 0);
1576 z_GDU(c->odr_save, &gdu, 0, 0);
1577 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1578 odr_reset(c->odr_out);
1580 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1581 ZOOM_connection_put_event(c, event);
1583 return ZOOM_send_buf(c);
1587 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
1588 const char *addinfo, const char *addinfo2)
1590 ZOOM_set_dset_error(c, error, "HTTP", addinfo, addinfo2);
1595 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
1597 zoom_ret cret = zoom_complete;
1600 const char *connection_head = z_HTTP_header_lookup(hres->headers,
1602 const char *location;
1604 ZOOM_connection_set_mask(c, 0);
1605 yaz_log(c->log_details, "%p handle_http", c);
1607 yaz_cookies_response(c->cookies, hres);
1608 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
1609 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
1612 if (c->no_redirects > 10)
1614 ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1615 c->no_redirects = 0;
1616 ZOOM_connection_close(c);
1620 /* since redirect may change host we just reconnect. A smarter
1621 implementation might check whether it's the same server */
1623 int host_change = 0;
1624 location = yaz_check_location(c->odr_in, c->host_port,
1625 location, &host_change);
1626 if (do_connect_host(c, location) == zoom_complete)
1627 return; /* connect failed.. */
1628 send_HTTP_redirect(c, location);
1634 ret = ZOOM_handle_sru(c, hres, &cret, &addinfo);
1637 if (c->no_redirects) /* end of redirect. change hosts again */
1638 ZOOM_connection_close(c);
1640 c->no_redirects = 0;
1644 if (hres->code != 200)
1645 ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1648 yaz_log(YLOG_LOG, "set error... addinfo=%s", addinfo ?
1650 ZOOM_set_error(c, ZOOM_ERROR_DECODE, addinfo);
1652 ZOOM_connection_close(c);
1654 if (cret == zoom_complete)
1656 yaz_log(c->log_details, "removing tasks in handle_http");
1657 ZOOM_connection_remove_task(c);
1661 if (!strcmp(hres->version, "1.0"))
1663 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
1664 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
1669 /* HTTP 1.1: only if no close we stay alive.. */
1670 if (connection_head && !strcmp(connection_head, "close"))
1675 ZOOM_connection_close(c);
1678 c->tasks->running = 0;
1679 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1680 c->reconnect_ok = 0;
1684 c->reconnect_ok = 1; /* if the server closes anyway */
1689 static int do_read(ZOOM_connection c)
1694 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
1695 ZOOM_connection_put_event(c, event);
1697 r = cs_get(c->cs, &c->buf_in, &c->len_in);
1698 more = cs_more(c->cs);
1699 yaz_log(c->log_details, "%p do_read len=%d more=%d", c, r, more);
1704 if (!ZOOM_test_reconnect(c))
1706 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1707 ZOOM_connection_close(c);
1715 odr_reset(c->odr_in);
1716 odr_setbuf(c->odr_in, c->buf_in, r, 0);
1717 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
1718 ZOOM_connection_put_event(c, event);
1720 if (!z_GDU(c->odr_in, &gdu, 0, 0))
1723 int err = odr_geterrorx(c->odr_in, &x);
1725 const char *element = odr_getelement(c->odr_in);
1726 yaz_snprintf(msg, sizeof(msg),
1727 "ODR code %d:%d element=%s offset=%d",
1728 err, x, element ? element : "<unknown>",
1729 odr_offset(c->odr_in));
1730 ZOOM_set_error(c, ZOOM_ERROR_DECODE, msg);
1733 FILE *ber_file = yaz_log_file();
1735 odr_dumpBER(ber_file, c->buf_in, r);
1737 ZOOM_connection_close(c);
1742 z_GDU(c->odr_print, &gdu, 0, 0);
1744 z_GDU(c->odr_save, &gdu, 0, 0);
1745 if (gdu->which == Z_GDU_Z3950)
1746 ZOOM_handle_Z3950_apdu(c, gdu->u.z3950);
1747 else if (gdu->which == Z_GDU_HTTP_Response)
1750 handle_http(c, gdu->u.HTTP_Response);
1752 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1753 ZOOM_connection_close(c);
1761 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
1766 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1767 ZOOM_connection_put_event(c, event);
1769 yaz_log(c->log_details, "%p do_write_ex len=%d", c, len_out);
1770 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
1772 yaz_log(c->log_details, "%p do_write_ex write failed", c);
1773 if (ZOOM_test_reconnect(c))
1775 return zoom_pending;
1777 if (c->state == STATE_CONNECTING)
1778 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1780 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1781 ZOOM_connection_close(c);
1782 return zoom_complete;
1786 int mask = ZOOM_SELECT_EXCEPT;
1787 if (c->cs->io_pending & CS_WANT_WRITE)
1788 mask += ZOOM_SELECT_WRITE;
1789 if (c->cs->io_pending & CS_WANT_READ)
1790 mask += ZOOM_SELECT_READ;
1791 ZOOM_connection_set_mask(c, mask);
1792 yaz_log(c->log_details, "%p do_write_ex write incomplete mask=%d",
1797 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
1798 yaz_log(c->log_details, "%p do_write_ex write complete mask=%d",
1801 return zoom_pending;
1804 zoom_ret ZOOM_send_buf(ZOOM_connection c)
1806 return do_write_ex(c, c->buf_out, c->len_out);
1810 ZOOM_API(const char *)
1811 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
1813 if (!strcmp(key, "APDU"))
1815 return c->saveAPDU_wrbuf ? wrbuf_cstr(c->saveAPDU_wrbuf) : "";
1818 return ZOOM_options_get(c->options, key);
1821 ZOOM_API(const char *)
1822 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
1824 if (!strcmp(key, "APDU"))
1826 if (c->saveAPDU_wrbuf)
1828 *lenp = wrbuf_len(c->saveAPDU_wrbuf);
1829 return wrbuf_cstr(c->saveAPDU_wrbuf);
1838 return ZOOM_options_getl(c->options, key, lenp);
1842 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
1845 if (!strcmp(key, "saveAPDU"))
1847 if (val && strcmp(val, "0"))
1849 if (!c->saveAPDU_wrbuf)
1850 c->saveAPDU_wrbuf = wrbuf_alloc();
1852 wrbuf_rewind(c->saveAPDU_wrbuf);
1856 wrbuf_destroy(c->saveAPDU_wrbuf);
1857 c->saveAPDU_wrbuf = 0;
1859 ZOOM_connection_save_apdu_wrbuf(c, c->saveAPDU_wrbuf);
1862 ZOOM_options_set(c->options, key, val);
1866 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
1867 const char *val, int len)
1869 ZOOM_options_setl(c->options, key, val, len);
1872 ZOOM_API(const char *)
1873 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
1875 return ZOOM_options_get(r->options, key);
1879 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
1882 ZOOM_options_set(r->options, key, val);
1887 ZOOM_connection_errcode(ZOOM_connection c)
1889 return ZOOM_connection_error(c, 0, 0);
1892 ZOOM_API(const char *)
1893 ZOOM_connection_errmsg(ZOOM_connection c)
1896 ZOOM_connection_error(c, &msg, 0);
1900 ZOOM_API(const char *)
1901 ZOOM_connection_addinfo(ZOOM_connection c)
1903 const char *addinfo;
1904 ZOOM_connection_error(c, 0, &addinfo);
1908 ZOOM_API(const char *)
1909 ZOOM_connection_diagset(ZOOM_connection c)
1911 const char *diagset;
1912 ZOOM_connection_error_x(c, 0, 0, &diagset);
1916 ZOOM_API(const char *)
1917 ZOOM_diag_str(int error)
1921 case ZOOM_ERROR_NONE:
1923 case ZOOM_ERROR_CONNECT:
1924 return "Connect failed";
1925 case ZOOM_ERROR_MEMORY:
1926 return "Out of memory";
1927 case ZOOM_ERROR_ENCODE:
1928 return "Encoding failed";
1929 case ZOOM_ERROR_DECODE:
1930 return "Decoding failed";
1931 case ZOOM_ERROR_CONNECTION_LOST:
1932 return "Connection lost";
1933 case ZOOM_ERROR_INIT:
1934 return "Init rejected";
1935 case ZOOM_ERROR_INTERNAL:
1936 return "Internal failure";
1937 case ZOOM_ERROR_TIMEOUT:
1939 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
1940 return "Unsupported protocol";
1941 case ZOOM_ERROR_UNSUPPORTED_QUERY:
1942 return "Unsupported query type";
1943 case ZOOM_ERROR_INVALID_QUERY:
1944 return "Invalid query";
1945 case ZOOM_ERROR_CQL_PARSE:
1946 return "CQL parsing error";
1947 case ZOOM_ERROR_CQL_TRANSFORM:
1948 return "CQL transformation error";
1949 case ZOOM_ERROR_CCL_CONFIG:
1950 return "CCL configuration error";
1951 case ZOOM_ERROR_CCL_PARSE:
1952 return "CCL parsing error";
1953 case ZOOM_ERROR_ES_INVALID_ACTION:
1954 return "Extended Service. invalid action";
1955 case ZOOM_ERROR_ES_INVALID_VERSION:
1956 return "Extended Service. invalid version";
1957 case ZOOM_ERROR_ES_INVALID_SYNTAX:
1958 return "Extended Service. invalid syntax";
1959 case ZOOM_ERROR_MEMCACHED:
1962 return diagbib1_str(error);
1967 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1968 const char **addinfo, const char **diagset)
1970 int error = c->error;
1973 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
1974 *cp = ZOOM_diag_str(error);
1975 else if (!strcmp(c->diagset, "HTTP"))
1976 *cp = z_HTTP_errmsg(c->error);
1977 else if (!strcmp(c->diagset, "Bib-1"))
1978 *cp = ZOOM_diag_str(error);
1979 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
1980 *cp = yaz_diag_srw_str(c->error);
1982 *cp = "Unknown error and diagnostic set";
1985 *addinfo = c->addinfo ? c->addinfo : "";
1987 *diagset = c->diagset ? c->diagset : "";
1992 ZOOM_connection_error(ZOOM_connection c, const char **cp,
1993 const char **addinfo)
1995 return ZOOM_connection_error_x(c, cp, addinfo, 0);
1998 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
2000 ZOOM_Event event = 0;
2001 int r = cs_look(c->cs);
2002 yaz_log(c->log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
2007 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2008 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2009 ZOOM_connection_close(c);
2010 ZOOM_connection_put_event(c, event);
2012 else if (r == CS_CONNECT)
2014 int ret = ret = cs_rcvconnect(c->cs);
2015 yaz_log(c->log_details, "%p ZOOM_connection_do_io "
2016 "cs_rcvconnect returned %d", c, ret);
2019 int mask = ZOOM_SELECT_EXCEPT;
2020 if (c->cs->io_pending & CS_WANT_WRITE)
2021 mask += ZOOM_SELECT_WRITE;
2022 if (c->cs->io_pending & CS_WANT_READ)
2023 mask += ZOOM_SELECT_READ;
2024 ZOOM_connection_set_mask(c, mask);
2025 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
2026 ZOOM_connection_put_event(c, event);
2030 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2031 ZOOM_connection_put_event(c, event);
2033 if (c->proto == PROTO_Z3950)
2034 ZOOM_connection_Z3950_send_init(c);
2037 /* no init request for SRW .. */
2038 assert(c->tasks->which == ZOOM_TASK_CONNECT);
2039 ZOOM_connection_remove_task(c);
2040 ZOOM_connection_set_mask(c, 0);
2041 ZOOM_connection_exec_task(c);
2043 c->state = STATE_ESTABLISHED;
2047 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2048 ZOOM_connection_close(c);
2053 if (mask & ZOOM_SELECT_EXCEPT)
2055 if (!ZOOM_test_reconnect(c))
2057 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
2058 ZOOM_connection_close(c);
2062 if (mask & ZOOM_SELECT_READ)
2064 if (c->cs && (mask & ZOOM_SELECT_WRITE))
2070 ZOOM_connection_last_event(ZOOM_connection cs)
2073 return ZOOM_EVENT_NONE;
2074 return cs->last_event;
2078 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
2082 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
2083 /* timeout and this connection was waiting */
2084 ZOOM_set_error(c, ZOOM_ERROR_TIMEOUT, 0);
2085 ZOOM_connection_close(c);
2086 ZOOM_connection_put_event(c, event);
2092 ZOOM_connection_process(ZOOM_connection c)
2098 event = ZOOM_connection_get_event(c);
2101 ZOOM_Event_destroy(event);
2104 ZOOM_connection_exec_task(c);
2105 event = ZOOM_connection_get_event(c);
2108 ZOOM_Event_destroy(event);
2115 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
2119 yaz_log(log_details0, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
2121 for (i = 0; i<no; i++)
2123 ZOOM_connection c = cs[i];
2125 if (c && ZOOM_connection_process(c))
2131 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
2133 if (c->mask && mask)
2134 ZOOM_connection_do_io(c, mask);
2138 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
2141 return cs_fileno(c->cs);
2145 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
2153 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
2160 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
2162 return ZOOM_options_get_int(c->options, "timeout", 30);
2165 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
2170 ZOOM_connection_set_mask(c, 0);
2171 c->state = STATE_IDLE;
2177 * c-file-style: "Stroustrup"
2178 * indent-tabs-mode: nil
2180 * vim: shiftwidth=4 tabstop=8 expandtab