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)
380 yaz_log(c->log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
381 c, host ? host : "null", portnum);
383 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
384 ZOOM_connection_remove_tasks(c);
388 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
389 odr_destroy(c->odr_print);
391 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
393 c->odr_print = odr_createmem(ODR_PRINT);
394 odr_setprint(c->odr_print, yaz_log_file());
401 yaz_log(c->log_details, "%p ZOOM_connection_connect reconnect ok", c);
405 yaz_log(c->log_details, "%p ZOOM_connection_connect connect", c);
408 val = ZOOM_options_get(c->options, "proxy");
411 yaz_log(c->log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
412 c->proxy = xstrdup(val);
417 val = ZOOM_options_get(c->options, "tproxy");
420 yaz_log(c->log_details, "%p ZOOM_connection_connect tproxy=%s", c, val);
421 c->tproxy = xstrdup(val);
426 val = ZOOM_options_get(c->options, "charset");
429 yaz_log(c->log_details, "%p ZOOM_connection_connect charset=%s", c, val);
430 c->charset = xstrdup(val);
434 val = ZOOM_options_get(c->options, "lang");
437 yaz_log(c->log_details, "%p ZOOM_connection_connect lang=%s", c, val);
438 c->lang = xstrdup(val);
449 sprintf(hostn, "%.80s:%d", host, portnum);
450 c->host_port = xstrdup(hostn);
453 c->host_port = xstrdup(host);
458 * If the "<scheme>:" part of the host string is preceded by one
459 * or more comma-separated <name>=<value> pairs, these are taken
460 * to be options to be set on the connection object. Among other
461 * applications, this facility can be used to embed authentication
463 * user=admin,password=secret,tcp:localhost:9999
465 char *remainder = c->host_port;
466 char *pcolon = strchr(remainder, ':');
469 while ((pcomma = strchr(remainder, ',')) != 0 &&
470 (pcolon == 0 || pcomma < pcolon))
473 if ((pequals = strchr(remainder, '=')) != 0)
476 ZOOM_connection_option_set(c, remainder, pequals+1);
478 remainder = pcomma+1;
481 if (remainder != c->host_port)
483 remainder = xstrdup(remainder);
485 c->host_port = remainder;
489 val = ZOOM_options_get(c->options, "sru");
490 c->sru_mode = get_sru_mode_from_string(val);
492 xfree(c->sru_version);
493 val = ZOOM_options_get(c->options, "sru_version");
494 c->sru_version = xstrdup(val ? val : "1.2");
496 ZOOM_options_set(c->options, "host", c->host_port);
498 xfree(c->cookie_out);
500 val = ZOOM_options_get(c->options, "cookie");
503 yaz_log(c->log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
504 c->cookie_out = xstrdup(val);
509 val = ZOOM_options_get(c->options, "clientIP");
512 yaz_log(c->log_details, "%p ZOOM_connection_connect clientIP=%s",
514 c->client_IP = xstrdup(val);
519 val = ZOOM_options_get(c->options, "group");
521 c->group = xstrdup(val);
525 val = ZOOM_options_get(c->options, "user");
527 c->user = xstrdup(val);
531 val = ZOOM_options_get(c->options, "password");
533 val = ZOOM_options_get(c->options, "pass");
535 c->password = xstrdup(val);
537 val = ZOOM_options_get(c->options, "authenticationMode");
538 if (val && !strcmp(val, "url"))
539 c->url_authentication = 1;
541 c->url_authentication = 0;
543 c->maximum_record_size =
544 ZOOM_options_get_int(c->options, "maximumRecordSize", 64*1024*1024);
545 c->preferred_message_size =
546 ZOOM_options_get_int(c->options, "preferredMessageSize", 64*1024*1024);
548 c->async = ZOOM_options_get_bool(c->options, "async", 0);
550 yaz_cookies_destroy(c->cookies);
551 c->cookies = yaz_cookies_create();
553 #if HAVE_LIBMEMCACHED_MEMCACHED_H
556 memcached_free(c->mc_st);
560 val = ZOOM_options_get(c->options, "memcached");
563 #if HAVE_LIBMEMCACHED_MEMCACHED_H
564 c->mc_st = memcached(val, strlen(val));
567 ZOOM_set_error(c, ZOOM_ERROR_MEMCACHED, val);
571 ZOOM_set_error(c, ZOOM_ERROR_MEMCACHED, "not enabled");
576 if (c->sru_mode == zoom_sru_error)
578 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, val);
579 ZOOM_connection_remove_tasks(c);
583 yaz_log(c->log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
584 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
588 while (ZOOM_event(1, &c))
593 ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
597 /* remove ourselves from the resultsets in connection */
598 ZOOM_resultset *rp = &r->connection->resultsets;
601 assert(*rp); /* we must be in this list!! */
603 { /* OK, we're here - take us out of it */
614 ZOOM_connection_destroy(ZOOM_connection c)
619 yaz_log(c->log_api, "%p ZOOM_connection_destroy", c);
621 #if HAVE_LIBMEMCACHED_MEMCACHED_H
623 memcached_free(c->mc_st);
628 for (r = c->resultsets; r; r = r->next)
634 odr_destroy(c->odr_in);
635 odr_destroy(c->odr_out);
637 odr_destroy(c->odr_save);
640 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
641 odr_destroy(c->odr_print);
643 ZOOM_options_destroy(c->options);
644 ZOOM_connection_remove_tasks(c);
645 ZOOM_connection_remove_events(c);
651 xfree(c->cookie_out);
657 xfree(c->sru_version);
658 yaz_cookies_destroy(c->cookies);
659 wrbuf_destroy(c->saveAPDU_wrbuf);
663 void ZOOM_resultset_addref(ZOOM_resultset r)
667 yaz_mutex_enter(r->mutex);
669 yaz_log(log_details0, "%p ZOOM_resultset_addref count=%d",
671 yaz_mutex_leave(r->mutex);
675 static int g_resultsets = 0;
676 static YAZ_MUTEX g_resultset_mutex = 0;
678 /* TODO We need to initialize this before running threaded:
679 * call resultset_use(0) */
681 static int resultset_use(int delta) {
683 if (g_resultset_mutex == 0)
684 yaz_mutex_create(&g_resultset_mutex);
685 yaz_mutex_enter(g_resultset_mutex);
686 g_resultsets += delta;
687 resultset_count = g_resultsets;
688 yaz_mutex_leave(g_resultset_mutex);
689 return resultset_count;
692 int resultsets_count(void) {
693 return resultset_use(0);
696 ZOOM_resultset ZOOM_resultset_create(void)
699 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
703 yaz_log(log_details0, "%p ZOOM_resultset_create", r);
706 r->odr = odr_createmem(ODR_ENCODE);
710 for (i = 0; i<RECORD_HASH_SIZE; i++)
711 r->record_hash[i] = 0;
715 r->databaseNames = 0;
716 r->num_databaseNames = 0;
721 yaz_mutex_create(&r->mutex);
724 WRBUF w = wrbuf_alloc();
725 YAZ_SHPTR_INIT(r->record_wrbuf, w);
733 ZOOM_API(ZOOM_resultset)
734 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
737 ZOOM_query s = ZOOM_query_create();
739 ZOOM_query_prefix(s, q);
741 r = ZOOM_connection_search(c, s);
742 ZOOM_query_destroy(s);
746 ZOOM_API(ZOOM_resultset)
747 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
749 ZOOM_resultset r = ZOOM_resultset_create();
753 const char *syntax, *elementSetName, *schema;
754 yaz_log(c->log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
755 r->r_sort_spec = ZOOM_query_get_sortspec(q);
758 r->options = ZOOM_options_create_with_parent(c->options);
760 start = ZOOM_options_get_int(r->options, "start", 0);
761 count = ZOOM_options_get_int(r->options, "count", 0);
763 /* If "presentChunk" is defined use that; otherwise "step" */
764 const char *cp = ZOOM_options_get(r->options, "presentChunk");
765 r->step = ZOOM_options_get_int(r->options,
766 (cp != 0 ? "presentChunk": "step"), 0);
768 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
769 cp = ZOOM_options_get(r->options, "setname");
771 r->setname = xstrdup(cp);
773 r->databaseNames = ZOOM_connection_get_databases(c, c->options, &r->num_databaseNames,
777 r->next = c->resultsets;
780 #if HAVE_LIBMEMCACHED_MEMCACHED_H
781 r->mc_key = wrbuf_alloc();
782 wrbuf_puts(r->mc_key, c->host_port);
783 wrbuf_puts(r->mc_key, ";");
784 wrbuf_puts(r->mc_key, ZOOM_query_get_query_string(q));
789 memcached_return_t rc;
790 char *v = memcached_get(c->mc_st, wrbuf_buf(r->mc_key),
791 wrbuf_len(r->mc_key), &v_len, &flags, &rc);
794 yaz_log(YLOG_LOG, "For key %s got value %.*s",
795 wrbuf_cstr(r->mc_key), (int) v_len, v);
799 yaz_log(YLOG_LOG, "For key %s got NO value", wrbuf_cstr(r->mc_key));
804 if (c->host_port && c->proto == PROTO_HTTP)
808 yaz_log(c->log_details, "ZOOM_connection_search: no comstack");
809 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
813 yaz_log(c->log_details, "ZOOM_connection_search: reconnect");
818 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
819 task->u.search.resultset = r;
820 task->u.search.start = start;
821 task->u.search.count = count;
822 task->u.search.recv_search_fired = 0;
824 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
825 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
826 elementSetName = ZOOM_options_get(r->options, "elementSetName");
827 task->u.search.elementSetName = elementSetName ?
828 xstrdup(elementSetName) : 0;
829 schema = ZOOM_options_get(r->options, "schema");
830 task->u.search.schema = schema ? xstrdup(schema) : 0;
832 ZOOM_resultset_addref(r);
834 ZOOM_query_addref(q);
838 while (ZOOM_event(1, &c))
845 ZOOM_resultset_sort(ZOOM_resultset r,
846 const char *sort_type, const char *sort_spec)
848 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
852 ZOOM_resultset_sort1(ZOOM_resultset r,
853 const char *sort_type, const char *sort_spec)
855 ZOOM_connection c = r->connection;
859 newq = ZOOM_query_create();
860 if (ZOOM_query_sortby(newq, sort_spec) < 0)
863 yaz_log(c->log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
864 r, r, sort_type, sort_spec);
868 if (c->host_port && c->proto == PROTO_HTTP)
872 yaz_log(c->log_details, "%p ZOOM_resultset_sort: no comstack", r);
873 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
877 yaz_log(c->log_details, "%p ZOOM_resultset_sort: prepare reconnect",
883 ZOOM_resultset_cache_reset(r);
884 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
885 task->u.sort.resultset = r;
886 task->u.sort.q = newq;
888 ZOOM_resultset_addref(r);
892 while (ZOOM_event(1, &c))
900 ZOOM_resultset_destroy(ZOOM_resultset r)
902 resultset_destroy(r);
905 static void resultset_destroy(ZOOM_resultset r)
909 yaz_mutex_enter(r->mutex);
911 yaz_log(log_details0, "%p ZOOM_resultset_destroy r=%p count=%d",
913 if (r->refcount == 0)
915 yaz_mutex_leave(r->mutex);
917 yaz_log(log_details0, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
918 ZOOM_resultset_cache_reset(r);
919 ZOOM_resultset_release(r);
920 ZOOM_query_destroy(r->query);
921 ZOOM_options_destroy(r->options);
924 yaz_mutex_destroy(&r->mutex);
926 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
928 wrbuf_destroy(r->mc_key);
933 yaz_mutex_leave(r->mutex);
937 ZOOM_resultset_size(ZOOM_resultset r)
942 int ZOOM_test_reconnect(ZOOM_connection c)
946 if (!c->reconnect_ok)
948 ZOOM_connection_close(c);
950 c->tasks->running = 0;
951 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
953 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
954 ZOOM_connection_put_event(c, event);
959 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
960 int force_sync, int start, int count)
965 const char *syntax, *elementSetName;
969 yaz_log(log_details0, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
970 " count=%d", r, force_sync, start, count);
975 if (c->host_port && c->proto == PROTO_HTTP)
979 yaz_log(log_details0, "%p ZOOM_resultset_retrieve: no comstack", r);
980 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
984 yaz_log(log_details0, "%p ZOOM_resultset_retrieve: prepare "
989 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
990 task->u.retrieve.resultset = r;
991 task->u.retrieve.start = start;
992 task->u.retrieve.count = count;
994 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
995 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
996 elementSetName = ZOOM_options_get(r->options, "elementSetName");
997 task->u.retrieve.elementSetName = elementSetName
998 ? xstrdup(elementSetName) : 0;
1000 cp = ZOOM_options_get(r->options, "schema");
1001 task->u.retrieve.schema = cp ? xstrdup(cp) : 0;
1003 ZOOM_resultset_addref(r);
1005 if (!r->connection->async || force_sync)
1006 while (r->connection && ZOOM_event(1, &r->connection))
1011 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1012 size_t start, size_t count)
1014 int force_present = 0;
1018 yaz_log(log_api0, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1019 r, r, (long) start, (long) count);
1022 ZOOM_resultset_retrieve(r, force_present, start, count);
1026 for (i = 0; i< count; i++)
1027 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1032 ZOOM_resultset_facets_size(ZOOM_resultset r) {
1033 return r->num_facets;
1036 ZOOM_API(ZOOM_facet_field)
1037 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1038 int num = r->num_facets;
1039 ZOOM_facet_field *facets = r->facets;
1041 for (index = 0; index < num; index++) {
1042 if (!strcmp(facets[index]->facet_name, name)) {
1043 return facets[index];
1049 ZOOM_API(ZOOM_facet_field)
1050 ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int index) {
1051 int num = r->num_facets;
1052 ZOOM_facet_field *facets = r->facets;
1053 if (index >= 0 && index < num) {
1054 return facets[index];
1059 ZOOM_API(ZOOM_facet_field *)
1060 ZOOM_resultset_facets(ZOOM_resultset r)
1065 ZOOM_API(const char**)
1066 ZOOM_resultset_facets_names(ZOOM_resultset r)
1068 return (const char **) r->facets_names;
1071 ZOOM_API(const char*)
1072 ZOOM_facet_field_name(ZOOM_facet_field field)
1074 return field->facet_name;
1078 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1080 return field->num_terms;
1083 ZOOM_API(const char*)
1084 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1085 *freq = field->facet_terms[idx].frequency;
1086 return field->facet_terms[idx].term;
1090 static void get_cert(ZOOM_connection c)
1095 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1097 ZOOM_connection_option_setl(c, "sslPeerCert",
1098 cert_buf, cert_len);
1103 static zoom_ret do_connect_host(ZOOM_connection c,
1104 const char *logical_url);
1106 static zoom_ret do_connect(ZOOM_connection c)
1108 return do_connect_host(c, c->host_port);
1111 static zoom_ret do_connect_host(ZOOM_connection c, const char *logical_url)
1117 c->cs = cs_create_host_proxy(logical_url, 0, &add,
1118 c->tproxy ? c->tproxy : c->proxy);
1120 if (c->cs && c->cs->protocol == PROTO_HTTP)
1123 c->proto = PROTO_HTTP;
1125 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1126 ZOOM_connection_close(c);
1127 return zoom_complete;
1132 int ret = cs_connect(c->cs, add);
1135 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1136 ZOOM_connection_put_event(c, event);
1138 if (c->proto == PROTO_Z3950)
1139 ZOOM_connection_Z3950_send_init(c);
1142 /* no init request for SRW .. */
1143 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1144 ZOOM_connection_remove_task(c);
1145 ZOOM_connection_set_mask(c, 0);
1146 ZOOM_connection_exec_task(c);
1148 c->state = STATE_ESTABLISHED;
1149 return zoom_pending;
1153 int mask = ZOOM_SELECT_EXCEPT;
1154 if (c->cs->io_pending & CS_WANT_WRITE)
1155 mask += ZOOM_SELECT_WRITE;
1156 if (c->cs->io_pending & CS_WANT_READ)
1157 mask += ZOOM_SELECT_READ;
1158 ZOOM_connection_set_mask(c, mask);
1159 c->state = STATE_CONNECTING;
1160 return zoom_pending;
1163 c->state = STATE_IDLE;
1164 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, logical_url);
1165 return zoom_complete;
1168 /* returns 1 if PDU was sent OK (still pending )
1169 0 if PDU was not sent OK (nothing to wait for)
1172 ZOOM_API(ZOOM_record)
1173 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1175 const char *syntax =
1176 ZOOM_options_get(s->options, "preferredRecordSyntax");
1177 const char *elementSetName =
1178 ZOOM_options_get(s->options, "elementSetName");
1179 const char *schema =
1180 ZOOM_options_get(s->options, "schema");
1182 return ZOOM_record_cache_lookup(s, pos, syntax, elementSetName, schema);
1185 ZOOM_API(ZOOM_record)
1186 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1188 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1193 * MIKE: I think force_sync should always be zero, but I don't
1194 * want to make this change until I get the go-ahead from
1195 * Adam, in case something depends on the old synchronous
1199 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1200 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1201 rec = ZOOM_resultset_record_immediate(r, pos);
1206 ZOOM_API(ZOOM_scanset)
1207 ZOOM_connection_scan(ZOOM_connection c, const char *start)
1210 ZOOM_query q = ZOOM_query_create();
1212 ZOOM_query_prefix(q, start);
1214 s = ZOOM_connection_scan1(c, q);
1215 ZOOM_query_destroy(q);
1220 ZOOM_API(ZOOM_scanset)
1221 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
1223 ZOOM_scanset scan = 0;
1224 Z_Query *z_query = ZOOM_query_get_Z_Query(q);
1228 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
1229 scan->connection = c;
1230 scan->odr = odr_createmem(ODR_DECODE);
1231 scan->options = ZOOM_options_create_with_parent(c->options);
1233 scan->scan_response = 0;
1234 scan->srw_scan_response = 0;
1237 ZOOM_query_addref(q);
1238 scan->databaseNames = ZOOM_connection_get_databases(c, c->options,
1239 &scan->num_databaseNames,
1244 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
1245 task->u.scan.scan = scan;
1250 while (ZOOM_event(1, &c))
1258 ZOOM_scanset_destroy(ZOOM_scanset scan)
1263 if (scan->refcount == 0)
1265 ZOOM_query_destroy(scan->query);
1267 odr_destroy(scan->odr);
1269 ZOOM_options_destroy(scan->options);
1274 static zoom_ret send_package(ZOOM_connection c)
1278 yaz_log(c->log_details, "%p send_package", c);
1280 return zoom_complete;
1281 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
1283 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1284 ZOOM_connection_put_event(c, event);
1286 c->buf_out = c->tasks->u.package->buf_out;
1287 c->len_out = c->tasks->u.package->len_out;
1289 return ZOOM_send_buf(c);
1293 ZOOM_scanset_size(ZOOM_scanset scan)
1298 if (scan->scan_response && scan->scan_response->entries)
1299 return scan->scan_response->entries->num_entries;
1300 else if (scan->srw_scan_response)
1301 return scan->srw_scan_response->num_terms;
1305 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
1307 const char **value_term, size_t *value_len,
1308 const char **disp_term, size_t *disp_len)
1310 size_t noent = ZOOM_scanset_size(scan);
1321 if (scan->scan_response)
1323 Z_ScanResponse *res = scan->scan_response;
1324 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1326 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1328 *value_term = (const char *) t->term->u.general->buf;
1329 *value_len = t->term->u.general->len;
1332 *disp_term = t->displayTerm;
1333 *disp_len = strlen(*disp_term);
1335 else if (t->term->which == Z_Term_general)
1337 *disp_term = (const char *) t->term->u.general->buf;
1338 *disp_len = t->term->u.general->len;
1340 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1343 if (scan->srw_scan_response)
1345 Z_SRW_scanResponse *res = scan->srw_scan_response;
1346 Z_SRW_scanTerm *t = res->terms + pos;
1349 *value_term = t->value;
1350 *value_len = strlen(*value_term);
1353 *disp_term = t->displayTerm;
1355 *disp_term = t->value;
1356 *disp_len = strlen(*disp_term);
1357 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
1362 ZOOM_API(const char *)
1363 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
1364 size_t *occ, size_t *len)
1366 const char *value_term = 0;
1367 size_t value_len = 0;
1368 const char *disp_term = 0;
1369 size_t disp_len = 0;
1371 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1372 &disp_term, &disp_len);
1378 ZOOM_API(const char *)
1379 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
1380 size_t *occ, size_t *len)
1382 const char *value_term = 0;
1383 size_t value_len = 0;
1384 const char *disp_term = 0;
1385 size_t disp_len = 0;
1387 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1388 &disp_term, &disp_len);
1394 ZOOM_API(const char *)
1395 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
1397 return ZOOM_options_get(scan->options, key);
1401 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
1404 ZOOM_options_set(scan->options, key, val);
1408 ZOOM_API(ZOOM_package)
1409 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
1411 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
1414 p->odr_out = odr_createmem(ODR_ENCODE);
1415 p->options = ZOOM_options_create_with_parent2(options, c->options);
1423 ZOOM_package_destroy(ZOOM_package p)
1428 if (p->refcount == 0)
1430 odr_destroy(p->odr_out);
1433 ZOOM_options_destroy(p->options);
1438 ZOOM_API(const char *)
1439 ZOOM_package_option_get(ZOOM_package p, const char *key)
1441 return ZOOM_options_get(p->options, key);
1444 ZOOM_API(const char *)
1445 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
1447 return ZOOM_options_getl(p->options, key, lenp);
1451 ZOOM_package_option_set(ZOOM_package p, const char *key,
1454 ZOOM_options_set(p->options, key, val);
1458 ZOOM_package_option_setl(ZOOM_package p, const char *key,
1459 const char *val, int len)
1461 ZOOM_options_setl(p->options, key, val, len);
1465 ZOOM_connection_exec_task(ZOOM_connection c)
1467 ZOOM_task task = c->tasks;
1468 zoom_ret ret = zoom_complete;
1472 yaz_log(c->log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
1473 c, task->which, task->running);
1474 if (c->error != ZOOM_ERROR_NONE)
1476 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1477 "removing tasks because of error = %d", c, c->error);
1478 ZOOM_connection_remove_tasks(c);
1483 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1484 "task already running", c);
1488 ret = zoom_complete;
1489 if (c->cs || task->which == ZOOM_TASK_CONNECT)
1491 switch (task->which)
1493 case ZOOM_TASK_SEARCH:
1494 if (c->proto == PROTO_HTTP)
1495 ret = ZOOM_connection_srw_send_search(c);
1497 ret = ZOOM_connection_Z3950_send_search(c);
1499 case ZOOM_TASK_RETRIEVE:
1500 if (c->proto == PROTO_HTTP)
1501 ret = ZOOM_connection_srw_send_search(c);
1503 ret = send_Z3950_present(c);
1505 case ZOOM_TASK_CONNECT:
1506 ret = do_connect(c);
1508 case ZOOM_TASK_SCAN:
1509 if (c->proto == PROTO_HTTP)
1510 ret = ZOOM_connection_srw_send_scan(c);
1512 ret = ZOOM_connection_Z3950_send_scan(c);
1514 case ZOOM_TASK_PACKAGE:
1515 ret = send_package(c);
1517 case ZOOM_TASK_SORT:
1518 c->tasks->u.sort.resultset->r_sort_spec =
1519 ZOOM_query_get_sortspec(c->tasks->u.sort.q);
1520 ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
1526 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1527 "remove tasks because no connection exist", c);
1528 ZOOM_connection_remove_tasks(c);
1530 if (ret == zoom_complete)
1532 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1533 "task removed (complete)", c);
1534 ZOOM_connection_remove_task(c);
1537 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1544 static zoom_ret send_HTTP_redirect(ZOOM_connection c, const char *uri)
1546 Z_GDU *gdu = z_get_HTTP_Request_uri(c->odr_out, uri, 0, c->proxy ? 1 : 0);
1548 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
1549 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
1551 yaz_cookies_request(c->cookies, c->odr_out, gdu->u.HTTP_Request);
1552 if (c->user && c->password)
1554 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
1555 c->user, c->password);
1557 return ZOOM_send_GDU(c, gdu);
1560 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu)
1564 int r = z_GDU(c->odr_out, &gdu, 0, 0);
1566 return zoom_complete;
1568 z_GDU(c->odr_print, &gdu, 0, 0);
1570 z_GDU(c->odr_save, &gdu, 0, 0);
1571 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1572 odr_reset(c->odr_out);
1574 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1575 ZOOM_connection_put_event(c, event);
1577 return ZOOM_send_buf(c);
1581 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
1582 const char *addinfo, const char *addinfo2)
1584 ZOOM_set_dset_error(c, error, "HTTP", addinfo, addinfo2);
1589 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
1591 zoom_ret cret = zoom_complete;
1594 const char *connection_head = z_HTTP_header_lookup(hres->headers,
1596 const char *location;
1598 ZOOM_connection_set_mask(c, 0);
1599 yaz_log(c->log_details, "%p handle_http", c);
1601 yaz_cookies_response(c->cookies, hres);
1602 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
1603 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
1606 if (c->no_redirects > 10)
1608 ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1609 c->no_redirects = 0;
1610 ZOOM_connection_close(c);
1614 /* since redirect may change host we just reconnect. A smarter
1615 implementation might check whether it's the same server */
1617 int host_change = 0;
1618 location = yaz_check_location(c->odr_in, c->host_port,
1619 location, &host_change);
1620 if (do_connect_host(c, location) == zoom_complete)
1621 return; /* connect failed.. */
1622 send_HTTP_redirect(c, location);
1628 ret = ZOOM_handle_sru(c, hres, &cret, &addinfo);
1631 if (c->no_redirects) /* end of redirect. change hosts again */
1632 ZOOM_connection_close(c);
1634 c->no_redirects = 0;
1638 if (hres->code != 200)
1639 ZOOM_set_HTTP_error(c, hres->code, 0, 0);
1642 yaz_log(YLOG_LOG, "set error... addinfo=%s", addinfo ?
1644 ZOOM_set_error(c, ZOOM_ERROR_DECODE, addinfo);
1646 ZOOM_connection_close(c);
1648 if (cret == zoom_complete)
1650 yaz_log(c->log_details, "removing tasks in handle_http");
1651 ZOOM_connection_remove_task(c);
1655 if (!strcmp(hres->version, "1.0"))
1657 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
1658 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
1663 /* HTTP 1.1: only if no close we stay alive.. */
1664 if (connection_head && !strcmp(connection_head, "close"))
1669 ZOOM_connection_close(c);
1672 c->tasks->running = 0;
1673 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1674 c->reconnect_ok = 0;
1678 c->reconnect_ok = 1; /* if the server closes anyway */
1683 static int do_read(ZOOM_connection c)
1688 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
1689 ZOOM_connection_put_event(c, event);
1691 r = cs_get(c->cs, &c->buf_in, &c->len_in);
1692 more = cs_more(c->cs);
1693 yaz_log(c->log_details, "%p do_read len=%d more=%d", c, r, more);
1698 if (!ZOOM_test_reconnect(c))
1700 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1701 ZOOM_connection_close(c);
1709 odr_reset(c->odr_in);
1710 odr_setbuf(c->odr_in, c->buf_in, r, 0);
1711 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
1712 ZOOM_connection_put_event(c, event);
1714 if (!z_GDU(c->odr_in, &gdu, 0, 0))
1717 int err = odr_geterrorx(c->odr_in, &x);
1719 const char *element = odr_getelement(c->odr_in);
1720 yaz_snprintf(msg, sizeof(msg),
1721 "ODR code %d:%d element=%s offset=%d",
1722 err, x, element ? element : "<unknown>",
1723 odr_offset(c->odr_in));
1724 ZOOM_set_error(c, ZOOM_ERROR_DECODE, msg);
1727 FILE *ber_file = yaz_log_file();
1729 odr_dumpBER(ber_file, c->buf_in, r);
1731 ZOOM_connection_close(c);
1736 z_GDU(c->odr_print, &gdu, 0, 0);
1738 z_GDU(c->odr_save, &gdu, 0, 0);
1739 if (gdu->which == Z_GDU_Z3950)
1740 ZOOM_handle_Z3950_apdu(c, gdu->u.z3950);
1741 else if (gdu->which == Z_GDU_HTTP_Response)
1744 handle_http(c, gdu->u.HTTP_Response);
1746 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1747 ZOOM_connection_close(c);
1755 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
1760 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1761 ZOOM_connection_put_event(c, event);
1763 yaz_log(c->log_details, "%p do_write_ex len=%d", c, len_out);
1764 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
1766 yaz_log(c->log_details, "%p do_write_ex write failed", c);
1767 if (ZOOM_test_reconnect(c))
1769 return zoom_pending;
1771 if (c->state == STATE_CONNECTING)
1772 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1774 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
1775 ZOOM_connection_close(c);
1776 return zoom_complete;
1780 int mask = ZOOM_SELECT_EXCEPT;
1781 if (c->cs->io_pending & CS_WANT_WRITE)
1782 mask += ZOOM_SELECT_WRITE;
1783 if (c->cs->io_pending & CS_WANT_READ)
1784 mask += ZOOM_SELECT_READ;
1785 ZOOM_connection_set_mask(c, mask);
1786 yaz_log(c->log_details, "%p do_write_ex write incomplete mask=%d",
1791 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
1792 yaz_log(c->log_details, "%p do_write_ex write complete mask=%d",
1795 return zoom_pending;
1798 zoom_ret ZOOM_send_buf(ZOOM_connection c)
1800 return do_write_ex(c, c->buf_out, c->len_out);
1804 ZOOM_API(const char *)
1805 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
1807 if (!strcmp(key, "APDU"))
1809 return c->saveAPDU_wrbuf ? wrbuf_cstr(c->saveAPDU_wrbuf) : "";
1812 return ZOOM_options_get(c->options, key);
1815 ZOOM_API(const char *)
1816 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
1818 if (!strcmp(key, "APDU"))
1820 if (c->saveAPDU_wrbuf)
1822 *lenp = wrbuf_len(c->saveAPDU_wrbuf);
1823 return wrbuf_cstr(c->saveAPDU_wrbuf);
1832 return ZOOM_options_getl(c->options, key, lenp);
1836 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
1839 if (!strcmp(key, "saveAPDU"))
1841 if (val && strcmp(val, "0"))
1843 if (!c->saveAPDU_wrbuf)
1844 c->saveAPDU_wrbuf = wrbuf_alloc();
1846 wrbuf_rewind(c->saveAPDU_wrbuf);
1850 wrbuf_destroy(c->saveAPDU_wrbuf);
1851 c->saveAPDU_wrbuf = 0;
1853 ZOOM_connection_save_apdu_wrbuf(c, c->saveAPDU_wrbuf);
1856 ZOOM_options_set(c->options, key, val);
1860 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
1861 const char *val, int len)
1863 ZOOM_options_setl(c->options, key, val, len);
1866 ZOOM_API(const char *)
1867 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
1869 return ZOOM_options_get(r->options, key);
1873 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
1876 ZOOM_options_set(r->options, key, val);
1881 ZOOM_connection_errcode(ZOOM_connection c)
1883 return ZOOM_connection_error(c, 0, 0);
1886 ZOOM_API(const char *)
1887 ZOOM_connection_errmsg(ZOOM_connection c)
1890 ZOOM_connection_error(c, &msg, 0);
1894 ZOOM_API(const char *)
1895 ZOOM_connection_addinfo(ZOOM_connection c)
1897 const char *addinfo;
1898 ZOOM_connection_error(c, 0, &addinfo);
1902 ZOOM_API(const char *)
1903 ZOOM_connection_diagset(ZOOM_connection c)
1905 const char *diagset;
1906 ZOOM_connection_error_x(c, 0, 0, &diagset);
1910 ZOOM_API(const char *)
1911 ZOOM_diag_str(int error)
1915 case ZOOM_ERROR_NONE:
1917 case ZOOM_ERROR_CONNECT:
1918 return "Connect failed";
1919 case ZOOM_ERROR_MEMORY:
1920 return "Out of memory";
1921 case ZOOM_ERROR_ENCODE:
1922 return "Encoding failed";
1923 case ZOOM_ERROR_DECODE:
1924 return "Decoding failed";
1925 case ZOOM_ERROR_CONNECTION_LOST:
1926 return "Connection lost";
1927 case ZOOM_ERROR_INIT:
1928 return "Init rejected";
1929 case ZOOM_ERROR_INTERNAL:
1930 return "Internal failure";
1931 case ZOOM_ERROR_TIMEOUT:
1933 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
1934 return "Unsupported protocol";
1935 case ZOOM_ERROR_UNSUPPORTED_QUERY:
1936 return "Unsupported query type";
1937 case ZOOM_ERROR_INVALID_QUERY:
1938 return "Invalid query";
1939 case ZOOM_ERROR_CQL_PARSE:
1940 return "CQL parsing error";
1941 case ZOOM_ERROR_CQL_TRANSFORM:
1942 return "CQL transformation error";
1943 case ZOOM_ERROR_CCL_CONFIG:
1944 return "CCL configuration error";
1945 case ZOOM_ERROR_CCL_PARSE:
1946 return "CCL parsing error";
1947 case ZOOM_ERROR_ES_INVALID_ACTION:
1948 return "Extended Service. invalid action";
1949 case ZOOM_ERROR_ES_INVALID_VERSION:
1950 return "Extended Service. invalid version";
1951 case ZOOM_ERROR_ES_INVALID_SYNTAX:
1952 return "Extended Service. invalid syntax";
1953 case ZOOM_ERROR_MEMCACHED:
1956 return diagbib1_str(error);
1961 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1962 const char **addinfo, const char **diagset)
1964 int error = c->error;
1967 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
1968 *cp = ZOOM_diag_str(error);
1969 else if (!strcmp(c->diagset, "HTTP"))
1970 *cp = z_HTTP_errmsg(c->error);
1971 else if (!strcmp(c->diagset, "Bib-1"))
1972 *cp = ZOOM_diag_str(error);
1973 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
1974 *cp = yaz_diag_srw_str(c->error);
1976 *cp = "Unknown error and diagnostic set";
1979 *addinfo = c->addinfo ? c->addinfo : "";
1981 *diagset = c->diagset ? c->diagset : "";
1986 ZOOM_connection_error(ZOOM_connection c, const char **cp,
1987 const char **addinfo)
1989 return ZOOM_connection_error_x(c, cp, addinfo, 0);
1992 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
1994 ZOOM_Event event = 0;
1995 int r = cs_look(c->cs);
1996 yaz_log(c->log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
2001 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2002 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2003 ZOOM_connection_close(c);
2004 ZOOM_connection_put_event(c, event);
2006 else if (r == CS_CONNECT)
2008 int ret = ret = cs_rcvconnect(c->cs);
2009 yaz_log(c->log_details, "%p ZOOM_connection_do_io "
2010 "cs_rcvconnect returned %d", c, ret);
2013 int mask = ZOOM_SELECT_EXCEPT;
2014 if (c->cs->io_pending & CS_WANT_WRITE)
2015 mask += ZOOM_SELECT_WRITE;
2016 if (c->cs->io_pending & CS_WANT_READ)
2017 mask += ZOOM_SELECT_READ;
2018 ZOOM_connection_set_mask(c, mask);
2019 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
2020 ZOOM_connection_put_event(c, event);
2024 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2025 ZOOM_connection_put_event(c, event);
2027 if (c->proto == PROTO_Z3950)
2028 ZOOM_connection_Z3950_send_init(c);
2031 /* no init request for SRW .. */
2032 assert(c->tasks->which == ZOOM_TASK_CONNECT);
2033 ZOOM_connection_remove_task(c);
2034 ZOOM_connection_set_mask(c, 0);
2035 ZOOM_connection_exec_task(c);
2037 c->state = STATE_ESTABLISHED;
2041 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2042 ZOOM_connection_close(c);
2047 if (mask & ZOOM_SELECT_EXCEPT)
2049 if (!ZOOM_test_reconnect(c))
2051 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
2052 ZOOM_connection_close(c);
2056 if (mask & ZOOM_SELECT_READ)
2058 if (c->cs && (mask & ZOOM_SELECT_WRITE))
2064 ZOOM_connection_last_event(ZOOM_connection cs)
2067 return ZOOM_EVENT_NONE;
2068 return cs->last_event;
2072 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
2076 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
2077 /* timeout and this connection was waiting */
2078 ZOOM_set_error(c, ZOOM_ERROR_TIMEOUT, 0);
2079 ZOOM_connection_close(c);
2080 ZOOM_connection_put_event(c, event);
2086 ZOOM_connection_process(ZOOM_connection c)
2092 event = ZOOM_connection_get_event(c);
2095 ZOOM_Event_destroy(event);
2098 ZOOM_connection_exec_task(c);
2099 event = ZOOM_connection_get_event(c);
2102 ZOOM_Event_destroy(event);
2109 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
2113 yaz_log(log_details0, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
2115 for (i = 0; i<no; i++)
2117 ZOOM_connection c = cs[i];
2119 if (c && ZOOM_connection_process(c))
2125 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
2127 if (c->mask && mask)
2128 ZOOM_connection_do_io(c, mask);
2132 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
2135 return cs_fileno(c->cs);
2139 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
2147 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
2154 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
2156 return ZOOM_options_get_int(c->options, "timeout", 30);
2159 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
2164 ZOOM_connection_set_mask(c, 0);
2165 c->state = STATE_IDLE;
2171 * c-file-style: "Stroustrup"
2172 * indent-tabs-mode: nil
2174 * vim: shiftwidth=4 tabstop=8 expandtab