1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM C interface.
15 #include <yaz/yaz-util.h>
16 #include <yaz/xmalloc.h>
17 #include <yaz/otherinfo.h>
19 #include <yaz/diagbib1.h>
20 #include <yaz/charneg.h>
21 #include <yaz/query-charset.h>
22 #include <yaz/snprintf.h>
23 #include <yaz/facet.h>
25 #include <yaz/shptr.h>
31 static int log_api0 = 0;
32 static int log_details0 = 0;
34 static void resultset_destroy(ZOOM_resultset r);
35 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
37 ZOOM_API(const char *) ZOOM_get_event_str(int event)
39 static const char *ar[] = {
55 static void initlog(void)
57 static int log_level_initialized = 0;
58 if (!log_level_initialized)
60 log_api0 = yaz_log_module_level("zoom");
61 log_details0 = yaz_log_module_level("zoomdetails");
62 log_level_initialized = 1;
66 ZOOM_Event ZOOM_Event_create(int kind)
68 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
75 static void ZOOM_Event_destroy(ZOOM_Event event)
80 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
84 c->m_queue_back->prev = event;
85 assert(c->m_queue_front);
89 assert(!c->m_queue_front);
90 c->m_queue_front = event;
92 event->next = c->m_queue_back;
94 c->m_queue_back = event;
97 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
99 ZOOM_Event event = c->m_queue_front;
102 c->last_event = ZOOM_EVENT_NONE;
105 assert(c->m_queue_back);
106 c->m_queue_front = event->prev;
107 if (c->m_queue_front)
109 assert(c->m_queue_back);
110 c->m_queue_front->next = 0;
114 c->last_event = event->kind;
118 static void ZOOM_connection_remove_events(ZOOM_connection c)
121 while ((event = ZOOM_connection_get_event(c)))
122 ZOOM_Event_destroy(event);
125 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
127 ZOOM_Event event = c->m_queue_front;
129 return event ? event->kind : ZOOM_EVENT_NONE;
132 void ZOOM_connection_remove_tasks(ZOOM_connection c);
134 void ZOOM_set_dset_error(ZOOM_connection c, int error,
136 const char *addinfo, const char *addinfo2)
143 if (!c->diagset || strcmp(dset, c->diagset))
146 c->diagset = xstrdup(dset);
147 /* remove integer part from SRW diagset .. */
148 if ((cp = strrchr(c->diagset, '/')))
151 if (addinfo && addinfo2)
153 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
154 strcpy(c->addinfo, addinfo);
155 strcat(c->addinfo, addinfo2);
158 c->addinfo = xstrdup(addinfo);
159 if (error != ZOOM_ERROR_NONE)
161 yaz_log(c->log_api, "%p set_dset_error %s %s:%d %s %s",
162 c, c->host_port ? c->host_port : "<>", dset, error,
163 addinfo ? addinfo : "",
164 addinfo2 ? addinfo2 : "");
165 ZOOM_connection_remove_tasks(c);
169 int ZOOM_uri_to_code(const char *uri)
173 if ((cp = strrchr(uri, '/')))
180 static void set_HTTP_error(ZOOM_connection c, int error,
181 const char *addinfo, const char *addinfo2)
183 ZOOM_set_dset_error(c, error, "HTTP", addinfo, addinfo2);
186 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
188 const char *uri = d->uri;
190 ZOOM_set_dset_error(c, ZOOM_uri_to_code(uri), uri, d->details, 0);
196 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo)
198 ZOOM_set_dset_error(c, error, "ZOOM", addinfo, 0);
201 static void clear_error(ZOOM_connection c)
204 * If an error is tied to an operation then it's ok to clear: for
205 * example, a diagnostic returned from a search is cleared by a
206 * subsequent search. However, problems such as Connection Lost
207 * or Init Refused are not cleared, because they are not
208 * recoverable: doing another search doesn't help.
211 ZOOM_connection_remove_events(c);
214 case ZOOM_ERROR_CONNECT:
215 case ZOOM_ERROR_MEMORY:
216 case ZOOM_ERROR_DECODE:
217 case ZOOM_ERROR_CONNECTION_LOST:
218 case ZOOM_ERROR_INIT:
219 case ZOOM_ERROR_INTERNAL:
220 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
223 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
227 void ZOOM_connection_show_task(ZOOM_task task)
231 case ZOOM_TASK_SEARCH:
232 yaz_log(YLOG_LOG, "search p=%p", task);
234 case ZOOM_TASK_RETRIEVE:
235 yaz_log(YLOG_LOG, "retrieve p=%p", task);
237 case ZOOM_TASK_CONNECT:
238 yaz_log(YLOG_LOG, "connect p=%p", task);
241 yaz_log(YLOG_LOG, "scan p=%p", task);
246 void ZOOM_connection_show_tasks(ZOOM_connection c)
249 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
250 for (task = c->tasks; task; task = task->next)
251 ZOOM_connection_show_task(task);
254 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
256 ZOOM_task *taskp = &c->tasks;
258 taskp = &(*taskp)->next;
259 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
260 (*taskp)->running = 0;
261 (*taskp)->which = which;
267 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
269 return c->tasks ? 0 : 1;
272 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
274 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
276 task->next = c->tasks;
285 void ZOOM_connection_remove_task(ZOOM_connection c)
287 ZOOM_task task = c->tasks;
291 c->tasks = task->next;
294 case ZOOM_TASK_SEARCH:
295 resultset_destroy(task->u.search.resultset);
296 xfree(task->u.search.syntax);
297 xfree(task->u.search.elementSetName);
299 case ZOOM_TASK_RETRIEVE:
300 resultset_destroy(task->u.retrieve.resultset);
301 xfree(task->u.retrieve.syntax);
302 xfree(task->u.retrieve.elementSetName);
304 case ZOOM_TASK_CONNECT:
307 ZOOM_scanset_destroy(task->u.scan.scan);
309 case ZOOM_TASK_PACKAGE:
310 ZOOM_package_destroy(task->u.package);
313 resultset_destroy(task->u.sort.resultset);
314 ZOOM_query_destroy(task->u.sort.q);
323 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
324 ZOOM_connection_put_event(c, event);
329 void ZOOM_connection_remove_tasks(ZOOM_connection c)
332 ZOOM_connection_remove_task(c);
336 ZOOM_API(ZOOM_connection)
337 ZOOM_connection_create(ZOOM_options options)
339 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
343 c->log_api = log_api0;
344 c->log_details = log_details0;
346 yaz_log(c->log_api, "%p ZOOM_connection_create", c);
348 c->proto = PROTO_Z3950;
350 ZOOM_connection_set_mask(c, 0);
352 c->state = STATE_IDLE;
355 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
362 c->options = ZOOM_options_create_with_parent(options);
368 c->charset = c->lang = 0;
379 c->maximum_record_size = 0;
380 c->preferred_message_size = 0;
382 c->odr_in = odr_createmem(ODR_DECODE);
383 c->odr_out = odr_createmem(ODR_ENCODE);
387 c->support_named_resultsets = 0;
388 c->last_event = ZOOM_EVENT_NONE;
390 c->m_queue_front = 0;
399 /* set database names. Take local databases (if set); otherwise
400 take databases given in ZURL (if set); otherwise use Default */
401 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
404 char **databaseNames;
405 const char *cp = ZOOM_options_get(options, "databaseName");
407 if ((!cp || !*cp) && con->host_port)
409 if (strncmp(con->host_port, "unix:", 5) == 0)
410 cp = strchr(con->host_port+5, ':');
412 cp = strchr(con->host_port, '/');
418 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
419 return databaseNames;
422 ZOOM_API(ZOOM_connection)
423 ZOOM_connection_new(const char *host, int portnum)
425 ZOOM_connection c = ZOOM_connection_create(0);
427 ZOOM_connection_connect(c, host, portnum);
431 static zoom_sru_mode get_sru_mode_from_string(const char *s)
434 return zoom_sru_soap;
435 if (!yaz_matchstr(s, "soap"))
436 return zoom_sru_soap;
437 else if (!yaz_matchstr(s, "get"))
439 else if (!yaz_matchstr(s, "post"))
440 return zoom_sru_post;
441 return zoom_sru_error;
445 ZOOM_connection_connect(ZOOM_connection c,
446 const char *host, int portnum)
453 yaz_log(c->log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
454 c, host ? host : "null", portnum);
456 ZOOM_set_error(c, ZOOM_ERROR_NONE, 0);
457 ZOOM_connection_remove_tasks(c);
461 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
462 odr_destroy(c->odr_print);
464 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
466 c->odr_print = odr_createmem(ODR_PRINT);
467 odr_setprint(c->odr_print, yaz_log_file());
474 yaz_log(c->log_details, "%p ZOOM_connection_connect reconnect ok", c);
478 yaz_log(c->log_details, "%p ZOOM_connection_connect connect", c);
481 val = ZOOM_options_get(c->options, "proxy");
484 yaz_log(c->log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
485 c->proxy = xstrdup(val);
490 val = ZOOM_options_get(c->options, "charset");
493 yaz_log(c->log_details, "%p ZOOM_connection_connect charset=%s", c, val);
494 c->charset = xstrdup(val);
498 val = ZOOM_options_get(c->options, "lang");
501 yaz_log(c->log_details, "%p ZOOM_connection_connect lang=%s", c, val);
502 c->lang = xstrdup(val);
513 sprintf(hostn, "%.80s:%d", host, portnum);
514 c->host_port = xstrdup(hostn);
517 c->host_port = xstrdup(host);
522 * If the "<scheme>:" part of the host string is preceded by one
523 * or more comma-separated <name>=<value> pairs, these are taken
524 * to be options to be set on the connection object. Among other
525 * applications, this facility can be used to embed authentication
527 * user=admin,password=secret,tcp:localhost:9999
529 char *remainder = c->host_port;
530 char *pcolon = strchr(remainder, ':');
533 while ((pcomma = strchr(remainder, ',')) != 0 &&
534 (pcolon == 0 || pcomma < pcolon)) {
536 if ((pequals = strchr(remainder, '=')) != 0) {
538 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
539 ZOOM_connection_option_set(c, remainder, pequals+1);
541 remainder = pcomma+1;
544 if (remainder != c->host_port) {
546 c->host_port = xstrdup(remainder);
547 /*printf("# reset hp='%s'\n", remainder);*/
551 val = ZOOM_options_get(c->options, "sru");
552 c->sru_mode = get_sru_mode_from_string(val);
554 xfree(c->sru_version);
555 val = ZOOM_options_get(c->options, "sru_version");
556 c->sru_version = xstrdup(val ? val : "1.2");
558 ZOOM_options_set(c->options, "host", c->host_port);
560 xfree(c->cookie_out);
562 val = ZOOM_options_get(c->options, "cookie");
565 yaz_log(c->log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
566 c->cookie_out = xstrdup(val);
571 val = ZOOM_options_get(c->options, "clientIP");
574 yaz_log(c->log_details, "%p ZOOM_connection_connect clientIP=%s",
576 c->client_IP = xstrdup(val);
581 val = ZOOM_options_get(c->options, "group");
583 c->group = xstrdup(val);
587 val = ZOOM_options_get(c->options, "user");
589 c->user = xstrdup(val);
593 val = ZOOM_options_get(c->options, "password");
595 val = ZOOM_options_get(c->options, "pass");
598 c->password = xstrdup(val);
600 c->maximum_record_size =
601 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
602 c->preferred_message_size =
603 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
605 c->async = ZOOM_options_get_bool(c->options, "async", 0);
606 yaz_log(c->log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
608 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
612 while (ZOOM_event(1, &c))
617 ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
619 #if ZOOM_RESULT_LISTS
623 /* remove ourselves from the resultsets in connection */
624 ZOOM_resultset *rp = &r->connection->resultsets;
627 assert(*rp); /* we must be in this list!! */
629 { /* OK, we're here - take us out of it */
641 ZOOM_connection_destroy(ZOOM_connection c)
643 #if ZOOM_RESULT_LISTS
644 ZOOM_resultsets list;
650 yaz_log(c->log_api, "%p ZOOM_connection_destroy", c);
654 #if ZOOM_RESULT_LISTS
655 // Remove the connection's usage of resultsets
656 list = c->resultsets;
658 ZOOM_resultsets removed = list;
659 ZOOM_resultset_destroy(list->resultset);
664 for (r = c->resultsets; r; r = r->next)
671 odr_destroy(c->odr_in);
672 odr_destroy(c->odr_out);
675 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
676 odr_destroy(c->odr_print);
678 ZOOM_options_destroy(c->options);
679 ZOOM_connection_remove_tasks(c);
680 ZOOM_connection_remove_events(c);
686 xfree(c->cookie_out);
692 xfree(c->sru_version);
696 void ZOOM_resultset_addref(ZOOM_resultset r)
700 yaz_mutex_enter(r->mutex);
702 yaz_log(log_details0, "%p ZOOM_resultset_addref count=%d",
704 yaz_mutex_leave(r->mutex);
708 ZOOM_resultset ZOOM_resultset_create(void)
711 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
715 yaz_log(log_details0, "%p ZOOM_resultset_create", r);
718 r->odr = odr_createmem(ODR_ENCODE);
723 for (i = 0; i<RECORD_HASH_SIZE; i++)
724 r->record_hash[i] = 0;
728 r->databaseNames = 0;
729 r->num_databaseNames = 0;
734 yaz_mutex_create(&r->mutex);
737 WRBUF w = wrbuf_alloc();
738 YAZ_SHPTR_INIT(r->record_wrbuf, w);
744 ZOOM_API(ZOOM_resultset)
745 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
748 ZOOM_query s = ZOOM_query_create();
750 ZOOM_query_prefix(s, q);
752 r = ZOOM_connection_search(c, s);
753 ZOOM_query_destroy(s);
757 ZOOM_API(ZOOM_resultset)
758 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
760 ZOOM_resultset r = ZOOM_resultset_create();
764 const char *syntax, *elementSetName;
765 #if ZOOM_RESULT_LISTS
769 yaz_log(c->log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
770 r->r_sort_spec = ZOOM_query_get_sortspec(q);
773 r->options = ZOOM_options_create_with_parent(c->options);
775 start = ZOOM_options_get_int(r->options, "start", 0);
776 count = ZOOM_options_get_int(r->options, "count", 0);
778 /* If "presentChunk" is defined use that; otherwise "step" */
779 const char *cp = ZOOM_options_get(r->options, "presentChunk");
780 r->step = ZOOM_options_get_int(r->options,
781 (cp != 0 ? "presentChunk": "step"), 0);
783 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
784 cp = ZOOM_options_get(r->options, "setname");
786 r->setname = xstrdup(cp);
787 cp = ZOOM_options_get(r->options, "schema");
789 r->schema = xstrdup(cp);
791 r->databaseNames = ZOOM_connection_get_databases(c, c->options, &r->num_databaseNames,
796 #if ZOOM_RESULT_LISTS
797 yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
798 set = xmalloc(sizeof(*set));
799 ZOOM_resultset_addref(r);
801 set->next = c->resultsets;
804 r->next = c->resultsets;
807 if (c->host_port && c->proto == PROTO_HTTP)
811 yaz_log(c->log_details, "ZOOM_connection_search: no comstack");
812 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
816 yaz_log(c->log_details, "ZOOM_connection_search: reconnect");
821 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
822 task->u.search.resultset = r;
823 task->u.search.start = start;
824 task->u.search.count = count;
825 task->u.search.recv_search_fired = 0;
827 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
828 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
829 elementSetName = ZOOM_options_get(r->options, "elementSetName");
830 task->u.search.elementSetName = elementSetName
831 ? xstrdup(elementSetName) : 0;
833 ZOOM_resultset_addref(r);
835 ZOOM_query_addref(q);
839 while (ZOOM_event(1, &c))
846 ZOOM_resultset_sort(ZOOM_resultset r,
847 const char *sort_type, const char *sort_spec)
849 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
853 ZOOM_resultset_sort1(ZOOM_resultset r,
854 const char *sort_type, const char *sort_spec)
856 ZOOM_connection c = r->connection;
860 newq = ZOOM_query_create();
861 if (ZOOM_query_sortby(newq, sort_spec) < 0)
864 yaz_log(c->log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
865 r, r, sort_type, sort_spec);
869 if (c->host_port && c->proto == PROTO_HTTP)
873 yaz_log(c->log_details, "%p ZOOM_resultset_sort: no comstack", r);
874 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
878 yaz_log(c->log_details, "%p ZOOM_resultset_sort: prepare reconnect",
884 ZOOM_resultset_cache_reset(r);
885 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
886 task->u.sort.resultset = r;
887 task->u.sort.q = newq;
889 ZOOM_resultset_addref(r);
893 while (ZOOM_event(1, &c))
901 ZOOM_resultset_destroy(ZOOM_resultset r)
903 resultset_destroy(r);
906 static void resultset_destroy(ZOOM_resultset r)
910 yaz_mutex_enter(r->mutex);
912 yaz_log(log_details0, "%p ZOOM_resultset_destroy r=%p count=%d",
914 if (r->refcount == 0)
916 yaz_mutex_leave(r->mutex);
918 yaz_log(log_details0, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
919 ZOOM_resultset_cache_reset(r);
920 ZOOM_resultset_release(r);
921 ZOOM_query_destroy(r->query);
922 ZOOM_options_destroy(r->options);
926 yaz_mutex_destroy(&r->mutex);
928 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
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");
1003 if (!r->schema || strcmp(r->schema, cp))
1006 r->schema = xstrdup(cp);
1010 ZOOM_resultset_addref(r);
1012 if (!r->connection->async || force_sync)
1013 while (r->connection && ZOOM_event(1, &r->connection))
1018 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1019 size_t start, size_t count)
1021 int force_present = 0;
1025 yaz_log(log_api0, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1026 r, r, (long) start, (long) count);
1029 ZOOM_resultset_retrieve(r, force_present, start, count);
1033 for (i = 0; i< count; i++)
1034 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1039 ZOOM_resultset_facets_size(ZOOM_resultset r) {
1040 return r->num_facets;
1043 ZOOM_API(ZOOM_facet_field)
1044 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1045 int num = r->num_facets;
1046 ZOOM_facet_field *facets = r->facets;
1048 for (index = 0; index < num; index++) {
1049 if (!strcmp(facets[index]->facet_name, name)) {
1050 return facets[index];
1057 ZOOM_API(ZOOM_facet_field *)
1058 ZOOM_resultset_facets(ZOOM_resultset r)
1063 ZOOM_API(const char**)
1064 ZOOM_resultset_facet_names(ZOOM_resultset r)
1066 return (const char **) r->facets_names;
1069 ZOOM_API(const char*)
1070 ZOOM_facet_field_name(ZOOM_facet_field field)
1072 return field->facet_name;
1076 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1078 return field->num_terms;
1081 ZOOM_API(const char*)
1082 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1083 *freq = field->facet_terms[idx].frequency;
1084 return field->facet_terms[idx].term;
1088 static void get_cert(ZOOM_connection c)
1093 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1095 ZOOM_connection_option_setl(c, "sslPeerCert",
1096 cert_buf, cert_len);
1101 static zoom_ret do_connect_host(ZOOM_connection c,
1102 const char *effective_host,
1103 const char *logical_url);
1105 static zoom_ret do_connect(ZOOM_connection c)
1107 const char *effective_host;
1110 effective_host = c->proxy;
1112 effective_host = c->host_port;
1113 return do_connect_host(c, effective_host, c->host_port);
1116 static zoom_ret do_connect_host(ZOOM_connection c, const char *effective_host,
1117 const char *logical_url)
1121 yaz_log(c->log_details, "%p do_connect effective_host=%s", c, effective_host);
1125 c->cs = cs_create_host(effective_host, 0, &add);
1127 if (c->cs && c->cs->protocol == PROTO_HTTP)
1134 c->proto = PROTO_HTTP;
1135 cs_get_host_args(logical_url, &db);
1138 c->path = xmalloc(strlen(db) * 3 + 2);
1139 yaz_encode_sru_dbpath_buf(c->path, db);
1142 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1143 ZOOM_connection_close(c);
1144 return zoom_complete;
1149 int ret = cs_connect(c->cs, add);
1152 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1153 ZOOM_connection_put_event(c, event);
1155 if (c->proto == PROTO_Z3950)
1156 ZOOM_connection_Z3950_send_init(c);
1159 /* no init request for SRW .. */
1160 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1161 ZOOM_connection_remove_task(c);
1162 ZOOM_connection_set_mask(c, 0);
1163 ZOOM_connection_exec_task(c);
1165 c->state = STATE_ESTABLISHED;
1166 return zoom_pending;
1170 int mask = ZOOM_SELECT_EXCEPT;
1171 if (c->cs->io_pending & CS_WANT_WRITE)
1172 mask += ZOOM_SELECT_WRITE;
1173 if (c->cs->io_pending & CS_WANT_READ)
1174 mask += ZOOM_SELECT_READ;
1175 ZOOM_connection_set_mask(c, mask);
1176 c->state = STATE_CONNECTING;
1177 return zoom_pending;
1180 c->state = STATE_IDLE;
1181 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, logical_url);
1182 return zoom_complete;
1185 /* returns 1 if PDU was sent OK (still pending )
1186 0 if PDU was not sent OK (nothing to wait for)
1190 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1194 const char *database = ZOOM_options_get(c->options, "databaseName");
1195 char *fdatabase = 0;
1198 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1199 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1200 fdatabase ? fdatabase : c->path);
1202 if (c->sru_mode == zoom_sru_get)
1204 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1206 else if (c->sru_mode == zoom_sru_post)
1208 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1210 else if (c->sru_mode == zoom_sru_soap)
1212 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1214 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1215 return zoom_complete;
1217 z_GDU(c->odr_print, &gdu, 0, 0);
1218 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1220 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1221 ZOOM_connection_put_event(c, event);
1222 odr_reset(c->odr_out);
1223 return ZOOM_send_buf(c);
1228 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1230 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1231 sr->username = c->user;
1232 sr->password = c->password;
1238 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1242 ZOOM_resultset resultset = 0;
1244 const char *option_val = 0;
1247 if (c->error) /* don't continue on error */
1248 return zoom_complete;
1250 switch(c->tasks->which)
1252 case ZOOM_TASK_SEARCH:
1253 resultset = c->tasks->u.search.resultset;
1254 if (!resultset->setname)
1255 resultset->setname = xstrdup("default");
1256 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1257 start = &c->tasks->u.search.start;
1258 count = &c->tasks->u.search.count;
1260 case ZOOM_TASK_RETRIEVE:
1261 resultset = c->tasks->u.retrieve.resultset;
1263 start = &c->tasks->u.retrieve.start;
1264 count = &c->tasks->u.retrieve.count;
1266 if (*start >= resultset->size)
1267 return zoom_complete;
1268 if (*start + *count > resultset->size)
1269 *count = resultset->size - *start;
1271 for (i = 0; i < *count; i++)
1274 ZOOM_record_cache_lookup(resultset, i + *start,
1275 c->tasks->u.retrieve.syntax,
1276 c->tasks->u.retrieve.elementSetName);
1281 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1282 ZOOM_connection_put_event(c, event);
1289 return zoom_complete;
1292 return zoom_complete;
1294 assert(resultset->query);
1296 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1297 z_query = ZOOM_query_get_Z_Query(resultset->query);
1299 if (z_query->which == Z_Query_type_104
1300 && z_query->u.type_104->which == Z_External_CQL)
1302 sr->u.request->query_type = Z_SRW_query_type_cql;
1303 sr->u.request->query.cql = z_query->u.type_104->u.cql;
1305 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
1307 sr->u.request->query_type = Z_SRW_query_type_pqf;
1308 sr->u.request->query.pqf =
1309 ZOOM_query_get_query_string(resultset->query);
1313 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1314 return zoom_complete;
1316 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1317 sr->u.request->maximumRecords = odr_intdup(
1318 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1319 resultset->step : *count);
1320 sr->u.request->recordSchema = resultset->schema;
1322 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1324 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1326 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1327 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1328 return send_srw(c, sr);
1331 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1333 return zoom_complete;
1337 ZOOM_API(ZOOM_record)
1338 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1340 const char *syntax =
1341 ZOOM_options_get(s->options, "preferredRecordSyntax");
1342 const char *elementSetName =
1343 ZOOM_options_get(s->options, "elementSetName");
1345 return ZOOM_record_cache_lookup(s, pos, syntax, elementSetName);
1348 ZOOM_API(ZOOM_record)
1349 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1351 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1356 * MIKE: I think force_sync should always be zero, but I don't
1357 * want to make this change until I get the go-ahead from
1358 * Adam, in case something depends on the old synchronous
1362 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1363 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1364 rec = ZOOM_resultset_record_immediate(r, pos);
1369 ZOOM_API(ZOOM_scanset)
1370 ZOOM_connection_scan(ZOOM_connection c, const char *start)
1373 ZOOM_query q = ZOOM_query_create();
1375 ZOOM_query_prefix(q, start);
1377 s = ZOOM_connection_scan1(c, q);
1378 ZOOM_query_destroy(q);
1383 ZOOM_API(ZOOM_scanset)
1384 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
1386 ZOOM_scanset scan = 0;
1387 Z_Query *z_query = ZOOM_query_get_Z_Query(q);
1391 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
1392 scan->connection = c;
1393 scan->odr = odr_createmem(ODR_DECODE);
1394 scan->options = ZOOM_options_create_with_parent(c->options);
1396 scan->scan_response = 0;
1397 scan->srw_scan_response = 0;
1400 ZOOM_query_addref(q);
1401 scan->databaseNames = ZOOM_connection_get_databases(c, c->options,
1402 &scan->num_databaseNames,
1407 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
1408 task->u.scan.scan = scan;
1413 while (ZOOM_event(1, &c))
1421 ZOOM_scanset_destroy(ZOOM_scanset scan)
1426 if (scan->refcount == 0)
1428 ZOOM_query_destroy(scan->query);
1430 odr_destroy(scan->odr);
1432 ZOOM_options_destroy(scan->options);
1437 static zoom_ret send_package(ZOOM_connection c)
1441 yaz_log(c->log_details, "%p send_package", c);
1443 return zoom_complete;
1444 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
1446 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1447 ZOOM_connection_put_event(c, event);
1449 c->buf_out = c->tasks->u.package->buf_out;
1450 c->len_out = c->tasks->u.package->len_out;
1452 return ZOOM_send_buf(c);
1456 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
1460 const char *option_val = 0;
1464 return zoom_complete;
1465 assert (c->tasks->which == ZOOM_TASK_SCAN);
1466 scan = c->tasks->u.scan.scan;
1468 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
1470 z_query = ZOOM_query_get_Z_Query(scan->query);
1471 /* SRU scan can only carry CQL and PQF */
1472 if (z_query->which == Z_Query_type_104)
1474 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
1475 sr->u.scan_request->scanClause.cql =
1476 ZOOM_query_get_query_string(scan->query);
1478 else if (z_query->which == Z_Query_type_1
1479 || z_query->which == Z_Query_type_101)
1481 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
1482 sr->u.scan_request->scanClause.pqf =
1483 ZOOM_query_get_query_string(scan->query);
1487 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1488 return zoom_complete;
1491 sr->u.scan_request->maximumTerms = odr_intdup(
1492 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
1494 sr->u.scan_request->responsePosition = odr_intdup(
1495 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
1497 option_val = ZOOM_options_get(scan->options, "extraArgs");
1498 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1499 return send_srw(c, sr);
1502 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
1504 return zoom_complete;
1510 ZOOM_scanset_size(ZOOM_scanset scan)
1515 if (scan->scan_response && scan->scan_response->entries)
1516 return scan->scan_response->entries->num_entries;
1517 else if (scan->srw_scan_response)
1518 return scan->srw_scan_response->num_terms;
1522 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
1524 const char **value_term, size_t *value_len,
1525 const char **disp_term, size_t *disp_len)
1527 size_t noent = ZOOM_scanset_size(scan);
1538 if (scan->scan_response)
1540 Z_ScanResponse *res = scan->scan_response;
1541 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1543 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1545 *value_term = (const char *) t->term->u.general->buf;
1546 *value_len = t->term->u.general->len;
1549 *disp_term = t->displayTerm;
1550 *disp_len = strlen(*disp_term);
1552 else if (t->term->which == Z_Term_general)
1554 *disp_term = (const char *) t->term->u.general->buf;
1555 *disp_len = t->term->u.general->len;
1557 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1560 if (scan->srw_scan_response)
1562 Z_SRW_scanResponse *res = scan->srw_scan_response;
1563 Z_SRW_scanTerm *t = res->terms + pos;
1566 *value_term = t->value;
1567 *value_len = strlen(*value_term);
1570 *disp_term = t->displayTerm;
1572 *disp_term = t->value;
1573 *disp_len = strlen(*disp_term);
1574 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
1579 ZOOM_API(const char *)
1580 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
1581 size_t *occ, size_t *len)
1583 const char *value_term = 0;
1584 size_t value_len = 0;
1585 const char *disp_term = 0;
1586 size_t disp_len = 0;
1588 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1589 &disp_term, &disp_len);
1595 ZOOM_API(const char *)
1596 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
1597 size_t *occ, size_t *len)
1599 const char *value_term = 0;
1600 size_t value_len = 0;
1601 const char *disp_term = 0;
1602 size_t disp_len = 0;
1604 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
1605 &disp_term, &disp_len);
1611 ZOOM_API(const char *)
1612 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
1614 return ZOOM_options_get(scan->options, key);
1618 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
1621 ZOOM_options_set(scan->options, key, val);
1625 ZOOM_API(ZOOM_package)
1626 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
1628 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
1631 p->odr_out = odr_createmem(ODR_ENCODE);
1632 p->options = ZOOM_options_create_with_parent2(options, c->options);
1640 ZOOM_package_destroy(ZOOM_package p)
1645 if (p->refcount == 0)
1647 odr_destroy(p->odr_out);
1650 ZOOM_options_destroy(p->options);
1655 ZOOM_API(const char *)
1656 ZOOM_package_option_get(ZOOM_package p, const char *key)
1658 return ZOOM_options_get(p->options, key);
1661 ZOOM_API(const char *)
1662 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
1664 return ZOOM_options_getl(p->options, key, lenp);
1668 ZOOM_package_option_set(ZOOM_package p, const char *key,
1671 ZOOM_options_set(p->options, key, val);
1675 ZOOM_package_option_setl(ZOOM_package p, const char *key,
1676 const char *val, int len)
1678 ZOOM_options_setl(p->options, key, val, len);
1682 ZOOM_connection_exec_task(ZOOM_connection c)
1684 ZOOM_task task = c->tasks;
1685 zoom_ret ret = zoom_complete;
1689 yaz_log(c->log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
1690 c, task->which, task->running);
1691 if (c->error != ZOOM_ERROR_NONE)
1693 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1694 "removing tasks because of error = %d", c, c->error);
1695 ZOOM_connection_remove_tasks(c);
1700 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1701 "task already running", c);
1705 ret = zoom_complete;
1706 if (c->cs || task->which == ZOOM_TASK_CONNECT)
1708 switch (task->which)
1710 case ZOOM_TASK_SEARCH:
1711 if (c->proto == PROTO_HTTP)
1712 ret = ZOOM_connection_srw_send_search(c);
1714 ret = ZOOM_connection_Z3950_send_search(c);
1716 case ZOOM_TASK_RETRIEVE:
1717 if (c->proto == PROTO_HTTP)
1718 ret = ZOOM_connection_srw_send_search(c);
1720 ret = send_Z3950_present(c);
1722 case ZOOM_TASK_CONNECT:
1723 ret = do_connect(c);
1725 case ZOOM_TASK_SCAN:
1726 if (c->proto == PROTO_HTTP)
1727 ret = ZOOM_connection_srw_send_scan(c);
1729 ret = ZOOM_connection_Z3950_send_scan(c);
1731 case ZOOM_TASK_PACKAGE:
1732 ret = send_package(c);
1734 case ZOOM_TASK_SORT:
1735 c->tasks->u.sort.resultset->r_sort_spec =
1736 ZOOM_query_get_sortspec(c->tasks->u.sort.q);
1737 ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
1743 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1744 "remove tasks because no connection exist", c);
1745 ZOOM_connection_remove_tasks(c);
1747 if (ret == zoom_complete)
1749 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1750 "task removed (complete)", c);
1751 ZOOM_connection_remove_task(c);
1754 yaz_log(c->log_details, "%p ZOOM_connection_exec_task "
1760 static zoom_ret handle_srw_response(ZOOM_connection c,
1761 Z_SRW_searchRetrieveResponse *res)
1763 ZOOM_resultset resultset = 0;
1768 const char *syntax, *elementSetName;
1771 return zoom_complete;
1773 switch(c->tasks->which)
1775 case ZOOM_TASK_SEARCH:
1776 resultset = c->tasks->u.search.resultset;
1777 start = &c->tasks->u.search.start;
1778 count = &c->tasks->u.search.count;
1779 syntax = c->tasks->u.search.syntax;
1780 elementSetName = c->tasks->u.search.elementSetName;
1782 if (!c->tasks->u.search.recv_search_fired)
1784 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1785 ZOOM_connection_put_event(c, event);
1786 c->tasks->u.search.recv_search_fired = 1;
1789 case ZOOM_TASK_RETRIEVE:
1790 resultset = c->tasks->u.retrieve.resultset;
1791 start = &c->tasks->u.retrieve.start;
1792 count = &c->tasks->u.retrieve.count;
1793 syntax = c->tasks->u.retrieve.syntax;
1794 elementSetName = c->tasks->u.retrieve.elementSetName;
1797 return zoom_complete;
1800 resultset->size = 0;
1802 if (res->resultSetId)
1803 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
1805 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
1807 if (res->num_diagnostics > 0)
1809 set_SRU_error(c, &res->diagnostics[0]);
1813 if (res->numberOfRecords)
1814 resultset->size = *res->numberOfRecords;
1815 for (i = 0; i<res->num_records; i++)
1818 Z_SRW_record *sru_rec;
1819 Z_SRW_diagnostic *diag = 0;
1822 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
1823 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
1825 if (res->records[i].recordPosition &&
1826 *res->records[i].recordPosition > 0)
1827 pos = *res->records[i].recordPosition - 1;
1831 sru_rec = &res->records[i];
1833 npr->databaseName = 0;
1834 npr->which = Z_NamePlusRecord_databaseRecord;
1835 npr->u.databaseRecord = (Z_External *)
1836 odr_malloc(c->odr_in, sizeof(Z_External));
1837 npr->u.databaseRecord->descriptor = 0;
1838 npr->u.databaseRecord->direct_reference =
1839 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
1840 npr->u.databaseRecord->which = Z_External_octet;
1842 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
1843 odr_malloc(c->odr_in, sizeof(Odr_oct));
1844 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
1845 sru_rec->recordData_buf;
1846 npr->u.databaseRecord->u.octet_aligned->len =
1847 npr->u.databaseRecord->u.octet_aligned->size =
1848 sru_rec->recordData_len;
1850 if (sru_rec->recordSchema
1851 && !strcmp(sru_rec->recordSchema,
1852 "info:srw/schema/1/diagnostics-v1.1"))
1854 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
1855 sru_rec->recordData_len,
1859 ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
1860 sru_rec->recordSchema, diag);
1864 if (*count + *start > resultset->size)
1865 *count = resultset->size - *start;
1869 nmem = odr_extract_mem(c->odr_in);
1870 nmem_transfer(odr_getmem(resultset->odr), nmem);
1874 return ZOOM_connection_srw_send_search(c);
1876 return zoom_complete;
1881 static void handle_srw_scan_response(ZOOM_connection c,
1882 Z_SRW_scanResponse *res)
1884 NMEM nmem = odr_extract_mem(c->odr_in);
1887 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1889 scan = c->tasks->u.scan.scan;
1891 if (res->num_diagnostics > 0)
1892 set_SRU_error(c, &res->diagnostics[0]);
1894 scan->scan_response = 0;
1895 scan->srw_scan_response = res;
1896 nmem_transfer(odr_getmem(scan->odr), nmem);
1898 ZOOM_options_set_int(scan->options, "number", res->num_terms);
1904 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
1906 Z_GDU *p = z_get_HTTP_Request(odr);
1907 const char *host = url;
1908 const char *cp0 = strstr(host, "://");
1909 const char *cp1 = 0;
1915 cp1 = strchr(cp0, '/');
1917 cp1 = cp0 + strlen(cp0);
1921 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
1922 memcpy (h, cp0, cp1 - cp0);
1924 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
1926 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
1930 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
1931 Z_HTTP_Response *cookie_hres)
1933 struct Z_HTTP_Header *h;
1934 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
1935 char *combined_cookies;
1936 int combined_cookies_len = 0;
1938 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
1939 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
1942 for (h = cookie_hres->headers; h; h = h->next)
1944 if (!strcmp(h->name, "Set-Cookie"))
1948 if (!(cp = strchr(h->value, ';')))
1949 cp = h->value + strlen(h->value);
1950 if (cp - h->value >= 1) {
1951 combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
1952 memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
1953 combined_cookies[combined_cookies_len + cp - h->value] = '\0';
1954 strcat(combined_cookies,"; ");
1955 combined_cookies_len = strlen(combined_cookies);
1960 if (combined_cookies_len)
1962 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1963 "Cookie", combined_cookies);
1964 xfree(combined_cookies);
1967 if (c->user && c->password)
1969 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
1970 c->user, c->password);
1972 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1973 return zoom_complete;
1975 z_GDU(c->odr_print, &gdu, 0, 0);
1976 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1978 odr_reset(c->odr_out);
1979 return ZOOM_send_buf(c);
1982 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
1984 zoom_ret cret = zoom_complete;
1986 const char *addinfo = 0;
1987 const char *connection_head = z_HTTP_header_lookup(hres->headers,
1989 const char *location;
1991 ZOOM_connection_set_mask(c, 0);
1992 yaz_log(c->log_details, "%p handle_http", c);
1994 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
1995 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
1998 if (c->no_redirects > 10)
2000 set_HTTP_error(c, hres->code, 0, 0);
2001 c->no_redirects = 0;
2002 ZOOM_connection_close(c);
2006 /* since redirect may change host we just reconnect. A smarter
2007 implementation might check whether it's the same server */
2008 do_connect_host(c, location, 0);
2009 send_SRW_redirect(c, location, hres);
2010 /* we're OK for now. Operation is not really complete */
2012 cret = zoom_pending;
2016 { /* not redirect (normal response) */
2017 if (!yaz_srw_check_content_type(hres))
2018 addinfo = "content-type";
2021 Z_SOAP *soap_package = 0;
2023 Z_SOAP_Handler soap_handlers[2] = {
2024 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
2027 ret = z_soap_codec(o, &soap_package,
2028 &hres->content_buf, &hres->content_len,
2030 if (!ret && soap_package->which == Z_SOAP_generic &&
2031 soap_package->u.generic->no == 0)
2033 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
2035 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
2036 ZOOM_options_setl(c->options, "sru_extra_response_data",
2037 sr->extraResponseData_buf, sr->extraResponseData_len);
2038 if (sr->which == Z_SRW_searchRetrieve_response)
2039 cret = handle_srw_response(c, sr->u.response);
2040 else if (sr->which == Z_SRW_scan_response)
2041 handle_srw_scan_response(c, sr->u.scan_response);
2045 else if (!ret && (soap_package->which == Z_SOAP_fault
2046 || soap_package->which == Z_SOAP_error))
2048 set_HTTP_error(c, hres->code,
2049 soap_package->u.fault->fault_code,
2050 soap_package->u.fault->fault_string);
2057 if (c->no_redirects) /* end of redirect. change hosts again */
2058 ZOOM_connection_close(c);
2060 c->no_redirects = 0;
2064 if (hres->code != 200)
2065 set_HTTP_error(c, hres->code, 0, 0);
2067 ZOOM_set_error(c, ZOOM_ERROR_DECODE, addinfo);
2068 ZOOM_connection_close(c);
2070 if (cret == zoom_complete)
2072 yaz_log(YLOG_LOG, "removing tasks in handle_http");
2073 ZOOM_connection_remove_task(c);
2077 if (!strcmp(hres->version, "1.0"))
2079 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
2080 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
2085 /* HTTP 1.1: only if no close we stay alive.. */
2086 if (connection_head && !strcmp(connection_head, "close"))
2091 ZOOM_connection_close(c);
2094 c->tasks->running = 0;
2095 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
2096 c->reconnect_ok = 0;
2103 static int do_read(ZOOM_connection c)
2108 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
2109 ZOOM_connection_put_event(c, event);
2111 r = cs_get(c->cs, &c->buf_in, &c->len_in);
2112 more = cs_more(c->cs);
2113 yaz_log(c->log_details, "%p do_read len=%d more=%d", c, r, more);
2118 if (!ZOOM_test_reconnect(c))
2120 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
2121 ZOOM_connection_close(c);
2129 odr_reset(c->odr_in);
2130 odr_setbuf(c->odr_in, c->buf_in, r, 0);
2131 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
2132 ZOOM_connection_put_event(c, event);
2134 if (!z_GDU(c->odr_in, &gdu, 0, 0))
2137 int err = odr_geterrorx(c->odr_in, &x);
2139 const char *element = odr_getelement(c->odr_in);
2140 yaz_snprintf(msg, sizeof(msg),
2141 "ODR code %d:%d element=%s offset=%d",
2142 err, x, element ? element : "<unknown>",
2143 odr_offset(c->odr_in));
2144 ZOOM_set_error(c, ZOOM_ERROR_DECODE, msg);
2147 FILE *ber_file = yaz_log_file();
2149 odr_dumpBER(ber_file, c->buf_in, r);
2151 ZOOM_connection_close(c);
2156 z_GDU(c->odr_print, &gdu, 0, 0);
2157 if (gdu->which == Z_GDU_Z3950)
2158 ZOOM_handle_Z3950_apdu(c, gdu->u.z3950);
2159 else if (gdu->which == Z_GDU_HTTP_Response)
2162 handle_http(c, gdu->u.HTTP_Response);
2164 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
2165 ZOOM_connection_close(c);
2169 c->reconnect_ok = 0;
2174 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
2179 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
2180 ZOOM_connection_put_event(c, event);
2182 yaz_log(c->log_details, "%p do_write_ex len=%d", c, len_out);
2183 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
2185 yaz_log(c->log_details, "%p do_write_ex write failed", c);
2186 if (ZOOM_test_reconnect(c))
2188 return zoom_pending;
2190 if (c->state == STATE_CONNECTING)
2191 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2193 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
2194 ZOOM_connection_close(c);
2195 return zoom_complete;
2199 int mask = ZOOM_SELECT_EXCEPT;
2200 if (c->cs->io_pending & CS_WANT_WRITE)
2201 mask += ZOOM_SELECT_WRITE;
2202 if (c->cs->io_pending & CS_WANT_READ)
2203 mask += ZOOM_SELECT_READ;
2204 ZOOM_connection_set_mask(c, mask);
2205 yaz_log(c->log_details, "%p do_write_ex write incomplete mask=%d",
2210 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
2211 yaz_log(c->log_details, "%p do_write_ex write complete mask=%d",
2214 return zoom_pending;
2217 zoom_ret ZOOM_send_buf(ZOOM_connection c)
2219 return do_write_ex(c, c->buf_out, c->len_out);
2223 ZOOM_API(const char *)
2224 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
2226 return ZOOM_options_get(c->options, key);
2229 ZOOM_API(const char *)
2230 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
2232 return ZOOM_options_getl(c->options, key, lenp);
2236 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
2239 ZOOM_options_set(c->options, key, val);
2243 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
2244 const char *val, int len)
2246 ZOOM_options_setl(c->options, key, val, len);
2249 ZOOM_API(const char *)
2250 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
2252 return ZOOM_options_get(r->options, key);
2256 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
2259 ZOOM_options_set(r->options, key, val);
2264 ZOOM_connection_errcode(ZOOM_connection c)
2266 return ZOOM_connection_error(c, 0, 0);
2269 ZOOM_API(const char *)
2270 ZOOM_connection_errmsg(ZOOM_connection c)
2273 ZOOM_connection_error(c, &msg, 0);
2277 ZOOM_API(const char *)
2278 ZOOM_connection_addinfo(ZOOM_connection c)
2280 const char *addinfo;
2281 ZOOM_connection_error(c, 0, &addinfo);
2285 ZOOM_API(const char *)
2286 ZOOM_connection_diagset(ZOOM_connection c)
2288 const char *diagset;
2289 ZOOM_connection_error_x(c, 0, 0, &diagset);
2293 ZOOM_API(const char *)
2294 ZOOM_diag_str(int error)
2298 case ZOOM_ERROR_NONE:
2300 case ZOOM_ERROR_CONNECT:
2301 return "Connect failed";
2302 case ZOOM_ERROR_MEMORY:
2303 return "Out of memory";
2304 case ZOOM_ERROR_ENCODE:
2305 return "Encoding failed";
2306 case ZOOM_ERROR_DECODE:
2307 return "Decoding failed";
2308 case ZOOM_ERROR_CONNECTION_LOST:
2309 return "Connection lost";
2310 case ZOOM_ERROR_INIT:
2311 return "Init rejected";
2312 case ZOOM_ERROR_INTERNAL:
2313 return "Internal failure";
2314 case ZOOM_ERROR_TIMEOUT:
2316 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
2317 return "Unsupported protocol";
2318 case ZOOM_ERROR_UNSUPPORTED_QUERY:
2319 return "Unsupported query type";
2320 case ZOOM_ERROR_INVALID_QUERY:
2321 return "Invalid query";
2322 case ZOOM_ERROR_CQL_PARSE:
2323 return "CQL parsing error";
2324 case ZOOM_ERROR_CQL_TRANSFORM:
2325 return "CQL transformation error";
2326 case ZOOM_ERROR_CCL_CONFIG:
2327 return "CCL configuration error";
2328 case ZOOM_ERROR_CCL_PARSE:
2329 return "CCL parsing error";
2331 return diagbib1_str(error);
2336 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
2337 const char **addinfo, const char **diagset)
2339 int error = c->error;
2342 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
2343 *cp = ZOOM_diag_str(error);
2344 else if (!strcmp(c->diagset, "HTTP"))
2345 *cp = z_HTTP_errmsg(c->error);
2346 else if (!strcmp(c->diagset, "Bib-1"))
2347 *cp = ZOOM_diag_str(error);
2348 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
2349 *cp = yaz_diag_srw_str(c->error);
2351 *cp = "Unknown error and diagnostic set";
2354 *addinfo = c->addinfo ? c->addinfo : "";
2356 *diagset = c->diagset ? c->diagset : "";
2361 ZOOM_connection_error(ZOOM_connection c, const char **cp,
2362 const char **addinfo)
2364 return ZOOM_connection_error_x(c, cp, addinfo, 0);
2367 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
2369 ZOOM_Event event = 0;
2370 int r = cs_look(c->cs);
2371 yaz_log(c->log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
2376 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2377 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2378 ZOOM_connection_close(c);
2379 ZOOM_connection_put_event(c, event);
2381 else if (r == CS_CONNECT)
2383 int ret = ret = cs_rcvconnect(c->cs);
2384 yaz_log(c->log_details, "%p ZOOM_connection_do_io "
2385 "cs_rcvconnect returned %d", c, ret);
2388 int mask = ZOOM_SELECT_EXCEPT;
2389 if (c->cs->io_pending & CS_WANT_WRITE)
2390 mask += ZOOM_SELECT_WRITE;
2391 if (c->cs->io_pending & CS_WANT_READ)
2392 mask += ZOOM_SELECT_READ;
2393 ZOOM_connection_set_mask(c, mask);
2394 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
2395 ZOOM_connection_put_event(c, event);
2399 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
2400 ZOOM_connection_put_event(c, event);
2402 if (c->proto == PROTO_Z3950)
2403 ZOOM_connection_Z3950_send_init(c);
2406 /* no init request for SRW .. */
2407 assert(c->tasks->which == ZOOM_TASK_CONNECT);
2408 ZOOM_connection_remove_task(c);
2409 ZOOM_connection_set_mask(c, 0);
2410 ZOOM_connection_exec_task(c);
2412 c->state = STATE_ESTABLISHED;
2416 ZOOM_set_error(c, ZOOM_ERROR_CONNECT, c->host_port);
2417 ZOOM_connection_close(c);
2422 if (mask & ZOOM_SELECT_EXCEPT)
2424 if (!ZOOM_test_reconnect(c))
2426 ZOOM_set_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
2427 ZOOM_connection_close(c);
2431 if (mask & ZOOM_SELECT_READ)
2433 if (c->cs && (mask & ZOOM_SELECT_WRITE))
2439 ZOOM_connection_last_event(ZOOM_connection cs)
2442 return ZOOM_EVENT_NONE;
2443 return cs->last_event;
2447 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
2451 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
2452 /* timeout and this connection was waiting */
2453 ZOOM_set_error(c, ZOOM_ERROR_TIMEOUT, 0);
2454 ZOOM_connection_close(c);
2455 ZOOM_connection_put_event(c, event);
2461 ZOOM_connection_process(ZOOM_connection c)
2467 event = ZOOM_connection_get_event(c);
2470 ZOOM_Event_destroy(event);
2473 ZOOM_connection_exec_task(c);
2474 event = ZOOM_connection_get_event(c);
2477 ZOOM_Event_destroy(event);
2484 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
2488 yaz_log(log_details0, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
2490 for (i = 0; i<no; i++)
2492 ZOOM_connection c = cs[i];
2494 if (c && ZOOM_connection_process(c))
2500 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
2502 if (c->mask && mask)
2503 ZOOM_connection_do_io(c, mask);
2507 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
2510 return cs_fileno(c->cs);
2514 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
2522 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
2529 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
2531 return ZOOM_options_get_int(c->options, "timeout", 30);
2534 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
2539 ZOOM_connection_set_mask(c, 0);
2540 c->state = STATE_IDLE;
2546 * c-file-style: "Stroustrup"
2547 * indent-tabs-mode: nil
2549 * vim: shiftwidth=4 tabstop=8 expandtab