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/pquery.h>
20 #include <yaz/marcdisp.h>
21 #include <yaz/diagbib1.h>
22 #include <yaz/charneg.h>
27 #include <yaz/query-charset.h>
28 #include <yaz/copy_types.h>
29 #include <yaz/snprintf.h>
31 #include <yaz/shptr.h>
37 static int log_api = 0;
38 static int log_details = 0;
45 static void resultset_destroy(ZOOM_resultset r);
46 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
47 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
48 static char *cql2pqf(ZOOM_connection c, const char *cql);
50 ZOOM_API(const char *) ZOOM_get_event_str(int event)
52 static const char *ar[] = {
69 * This wrapper is just for logging failed lookups. It would be nicer
70 * if it could cause failure when a lookup fails, but that's hard.
72 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
73 oid_class oid_class, const char *str) {
74 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
77 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
78 c, (int) oid_class, str);
83 static void initlog(void)
85 static int log_level_initialized = 0;
86 if (!log_level_initialized)
88 log_api = yaz_log_module_level("zoom");
89 log_details = yaz_log_module_level("zoomdetails");
90 log_level_initialized = 1;
94 static ZOOM_Event ZOOM_Event_create(int kind)
96 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
100 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
104 static void ZOOM_Event_destroy(ZOOM_Event event)
109 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
113 c->m_queue_back->prev = event;
114 assert(c->m_queue_front);
118 assert(!c->m_queue_front);
119 c->m_queue_front = event;
121 event->next = c->m_queue_back;
123 c->m_queue_back = event;
126 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
128 ZOOM_Event event = c->m_queue_front;
131 c->last_event = ZOOM_EVENT_NONE;
134 assert(c->m_queue_back);
135 c->m_queue_front = event->prev;
136 if (c->m_queue_front)
138 assert(c->m_queue_back);
139 c->m_queue_front->next = 0;
143 c->last_event = event->kind;
147 static void ZOOM_connection_remove_events(ZOOM_connection c)
150 while ((event = ZOOM_connection_get_event(c)))
151 ZOOM_Event_destroy(event);
154 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
156 ZOOM_Event event = c->m_queue_front;
158 return event ? event->kind : ZOOM_EVENT_NONE;
161 void ZOOM_connection_remove_tasks(ZOOM_connection c);
163 static void set_dset_error(ZOOM_connection c, int error,
165 const char *addinfo, const char *addinfo2)
172 if (!c->diagset || strcmp(dset, c->diagset))
175 c->diagset = xstrdup(dset);
176 /* remove integer part from SRW diagset .. */
177 if ((cp = strrchr(c->diagset, '/')))
180 if (addinfo && addinfo2)
182 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
183 strcpy(c->addinfo, addinfo);
184 strcat(c->addinfo, addinfo2);
187 c->addinfo = xstrdup(addinfo);
188 if (error != ZOOM_ERROR_NONE)
190 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
191 c, c->host_port ? c->host_port : "<>", dset, error,
192 addinfo ? addinfo : "",
193 addinfo2 ? addinfo2 : "");
194 ZOOM_connection_remove_tasks(c);
198 static int uri_to_code(const char *uri)
202 if ((cp = strrchr(uri, '/')))
208 static void set_HTTP_error(ZOOM_connection c, int error,
209 const char *addinfo, const char *addinfo2)
211 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
214 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
216 const char *uri = d->uri;
218 set_dset_error(c, uri_to_code(uri), uri, d->details, 0);
224 static void set_ZOOM_error(ZOOM_connection c, int error,
227 set_dset_error(c, error, "ZOOM", addinfo, 0);
230 static void clear_error(ZOOM_connection c)
233 * If an error is tied to an operation then it's ok to clear: for
234 * example, a diagnostic returned from a search is cleared by a
235 * subsequent search. However, problems such as Connection Lost
236 * or Init Refused are not cleared, because they are not
237 * recoverable: doing another search doesn't help.
240 ZOOM_connection_remove_events(c);
243 case ZOOM_ERROR_CONNECT:
244 case ZOOM_ERROR_MEMORY:
245 case ZOOM_ERROR_DECODE:
246 case ZOOM_ERROR_CONNECTION_LOST:
247 case ZOOM_ERROR_INIT:
248 case ZOOM_ERROR_INTERNAL:
249 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
252 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
256 void ZOOM_connection_show_task(ZOOM_task task)
260 case ZOOM_TASK_SEARCH:
261 yaz_log(YLOG_LOG, "search p=%p", task);
263 case ZOOM_TASK_RETRIEVE:
264 yaz_log(YLOG_LOG, "retrieve p=%p", task);
266 case ZOOM_TASK_CONNECT:
267 yaz_log(YLOG_LOG, "connect p=%p", task);
270 yaz_log(YLOG_LOG, "scan p=%p", task);
275 void ZOOM_connection_show_tasks(ZOOM_connection c)
278 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
279 for (task = c->tasks; task; task = task->next)
280 ZOOM_connection_show_task(task);
283 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
285 ZOOM_task *taskp = &c->tasks;
287 taskp = &(*taskp)->next;
288 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
289 (*taskp)->running = 0;
290 (*taskp)->which = which;
296 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
298 return c->tasks ? 0 : 1;
301 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
303 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
305 task->next = c->tasks;
314 void ZOOM_connection_remove_task(ZOOM_connection c)
316 ZOOM_task task = c->tasks;
320 c->tasks = task->next;
323 case ZOOM_TASK_SEARCH:
324 resultset_destroy(task->u.search.resultset);
325 xfree(task->u.search.syntax);
326 xfree(task->u.search.elementSetName);
328 case ZOOM_TASK_RETRIEVE:
329 resultset_destroy(task->u.retrieve.resultset);
330 xfree(task->u.retrieve.syntax);
331 xfree(task->u.retrieve.elementSetName);
333 case ZOOM_TASK_CONNECT:
336 ZOOM_scanset_destroy(task->u.scan.scan);
338 case ZOOM_TASK_PACKAGE:
339 ZOOM_package_destroy(task->u.package);
342 resultset_destroy(task->u.sort.resultset);
343 ZOOM_query_destroy(task->u.sort.q);
352 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
353 ZOOM_connection_put_event(c, event);
358 void ZOOM_connection_remove_tasks(ZOOM_connection c)
361 ZOOM_connection_remove_task(c);
364 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
366 const char *elementSetName);
368 ZOOM_API(ZOOM_connection)
369 ZOOM_connection_create(ZOOM_options options)
371 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
375 yaz_log(log_api, "%p ZOOM_connection_create", c);
377 c->proto = PROTO_Z3950;
379 ZOOM_connection_set_mask(c, 0);
381 c->state = STATE_IDLE;
384 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
391 c->options = ZOOM_options_create_with_parent(options);
397 c->charset = c->lang = 0;
408 c->maximum_record_size = 0;
409 c->preferred_message_size = 0;
411 c->odr_in = odr_createmem(ODR_DECODE);
412 c->odr_out = odr_createmem(ODR_ENCODE);
416 c->support_named_resultsets = 0;
417 c->last_event = ZOOM_EVENT_NONE;
419 c->m_queue_front = 0;
428 /* set database names. Take local databases (if set); otherwise
429 take databases given in ZURL (if set); otherwise use Default */
430 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
433 char **databaseNames;
434 const char *cp = ZOOM_options_get(options, "databaseName");
436 if ((!cp || !*cp) && con->host_port)
438 if (strncmp(con->host_port, "unix:", 5) == 0)
439 cp = strchr(con->host_port+5, ':');
441 cp = strchr(con->host_port, '/');
447 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
448 return databaseNames;
451 ZOOM_API(ZOOM_connection)
452 ZOOM_connection_new(const char *host, int portnum)
454 ZOOM_connection c = ZOOM_connection_create(0);
456 ZOOM_connection_connect(c, host, portnum);
460 static zoom_sru_mode get_sru_mode_from_string(const char *s)
463 return zoom_sru_soap;
464 if (!yaz_matchstr(s, "soap"))
465 return zoom_sru_soap;
466 else if (!yaz_matchstr(s, "get"))
468 else if (!yaz_matchstr(s, "post"))
469 return zoom_sru_post;
470 return zoom_sru_error;
474 ZOOM_connection_connect(ZOOM_connection c,
475 const char *host, int portnum)
482 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
483 c, host ? host : "null", portnum);
485 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
486 ZOOM_connection_remove_tasks(c);
490 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
491 odr_destroy(c->odr_print);
493 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
495 c->odr_print = odr_createmem(ODR_PRINT);
496 odr_setprint(c->odr_print, yaz_log_file());
503 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
507 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
510 val = ZOOM_options_get(c->options, "proxy");
513 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
514 c->proxy = xstrdup(val);
519 val = ZOOM_options_get(c->options, "charset");
522 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
523 c->charset = xstrdup(val);
527 val = ZOOM_options_get(c->options, "lang");
530 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
531 c->lang = xstrdup(val);
542 sprintf(hostn, "%.80s:%d", host, portnum);
543 c->host_port = xstrdup(hostn);
546 c->host_port = xstrdup(host);
551 * If the "<scheme>:" part of the host string is preceded by one
552 * or more comma-separated <name>=<value> pairs, these are taken
553 * to be options to be set on the connection object. Among other
554 * applications, this facility can be used to embed authentication
556 * user=admin,password=secret,tcp:localhost:9999
558 char *remainder = c->host_port;
559 char *pcolon = strchr(remainder, ':');
562 while ((pcomma = strchr(remainder, ',')) != 0 &&
563 (pcolon == 0 || pcomma < pcolon)) {
565 if ((pequals = strchr(remainder, '=')) != 0) {
567 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
568 ZOOM_connection_option_set(c, remainder, pequals+1);
570 remainder = pcomma+1;
573 if (remainder != c->host_port) {
575 c->host_port = xstrdup(remainder);
576 /*printf("# reset hp='%s'\n", remainder);*/
580 val = ZOOM_options_get(c->options, "sru");
581 c->sru_mode = get_sru_mode_from_string(val);
583 xfree(c->sru_version);
584 val = ZOOM_options_get(c->options, "sru_version");
585 c->sru_version = xstrdup(val ? val : "1.2");
587 ZOOM_options_set(c->options, "host", c->host_port);
589 xfree(c->cookie_out);
591 val = ZOOM_options_get(c->options, "cookie");
594 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
595 c->cookie_out = xstrdup(val);
600 val = ZOOM_options_get(c->options, "clientIP");
603 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
605 c->client_IP = xstrdup(val);
610 val = ZOOM_options_get(c->options, "group");
612 c->group = xstrdup(val);
616 val = ZOOM_options_get(c->options, "user");
618 c->user = xstrdup(val);
622 val = ZOOM_options_get(c->options, "password");
624 val = ZOOM_options_get(c->options, "pass");
627 c->password = xstrdup(val);
629 c->maximum_record_size =
630 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
631 c->preferred_message_size =
632 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
634 c->async = ZOOM_options_get_bool(c->options, "async", 0);
635 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
637 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
641 while (ZOOM_event(1, &c))
647 ZOOM_query_create(void)
649 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
651 yaz_log(log_details, "%p ZOOM_query_create", s);
655 s->odr = odr_createmem(ODR_ENCODE);
662 ZOOM_query_destroy(ZOOM_query s)
668 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
669 if (s->refcount == 0)
677 ZOOM_query_prefix(ZOOM_query s, const char *str)
679 s->query_string = odr_strdup(s->odr, str);
680 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
681 s->z_query->which = Z_Query_type_1;
682 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
683 if (!s->z_query->u.type_1)
685 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
689 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
694 ZOOM_query_cql(ZOOM_query s, const char *str)
698 s->query_string = odr_strdup(s->odr, str);
700 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
701 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
702 ext->indirect_reference = 0;
704 ext->which = Z_External_CQL;
705 ext->u.cql = s->query_string;
707 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
708 s->z_query->which = Z_Query_type_104;
709 s->z_query->u.type_104 = ext;
711 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
717 * Translate the CQL string client-side into RPN which is passed to
718 * the server. This is useful for server's that don't themselves
719 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
720 * only as a place to stash diagnostics if compilation fails; if this
721 * information is not needed, a null pointer may be used.
724 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
728 ZOOM_connection freeme = 0;
730 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
732 conn = freeme = ZOOM_connection_create(0);
734 rpn = cql2pqf(conn, str);
736 ZOOM_connection_destroy(freeme);
740 ret = ZOOM_query_prefix(s, rpn);
746 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
747 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
748 * to the server, as the YAZ GFS doesn't know how to handle this.
751 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
752 int *ccl_error, const char **error_string,
756 struct ccl_rpn_node *rpn;
757 CCL_bibset bibset = ccl_qual_mk();
760 ccl_qual_buf(bibset, config);
762 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
765 *error_string = ccl_err_msg(*ccl_error);
770 WRBUF wr = wrbuf_alloc();
773 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
776 ccl_qual_rm(&bibset);
781 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
783 s->sort_spec = yaz_sort_spec(s->odr, criteria);
786 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
790 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
794 static zoom_ret do_write(ZOOM_connection c);
797 ZOOM_connection_destroy(ZOOM_connection c)
799 #if ZOOM_RESULT_LISTS
800 ZOOM_resultsets list;
806 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
810 #if ZOOM_RESULT_LISTS
811 // Remove the connection's usage of resultsets
812 list = c->resultsets;
814 ZOOM_resultsets removed = list;
815 ZOOM_resultset_destroy(list->resultset);
820 for (r = c->resultsets; r; r = r->next)
827 odr_destroy(c->odr_in);
828 odr_destroy(c->odr_out);
831 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
832 odr_destroy(c->odr_print);
834 ZOOM_options_destroy(c->options);
835 ZOOM_connection_remove_tasks(c);
836 ZOOM_connection_remove_events(c);
842 xfree(c->cookie_out);
848 xfree(c->sru_version);
852 void ZOOM_resultset_addref(ZOOM_resultset r)
856 yaz_mutex_enter(r->mutex);
858 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
860 yaz_mutex_leave(r->mutex);
864 ZOOM_resultset ZOOM_resultset_create(void)
867 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
871 yaz_log(log_details, "%p ZOOM_resultset_create", r);
874 r->odr = odr_createmem(ODR_ENCODE);
879 for (i = 0; i<RECORD_HASH_SIZE; i++)
880 r->record_hash[i] = 0;
884 r->databaseNames = 0;
885 r->num_databaseNames = 0;
887 yaz_mutex_create(&r->mutex);
890 WRBUF w = wrbuf_alloc();
891 YAZ_SHPTR_INIT(r->record_wrbuf, w);
897 ZOOM_API(ZOOM_resultset)
898 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
901 ZOOM_query s = ZOOM_query_create();
903 ZOOM_query_prefix(s, q);
905 r = ZOOM_connection_search(c, s);
906 ZOOM_query_destroy(s);
910 ZOOM_API(ZOOM_resultset)
911 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
913 ZOOM_resultset r = ZOOM_resultset_create();
917 const char *syntax, *elementSetName;
918 #if ZOOM_RESULT_LISTS
922 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
923 r->r_sort_spec = q->sort_spec;
926 r->options = ZOOM_options_create_with_parent(c->options);
928 start = ZOOM_options_get_int(r->options, "start", 0);
929 count = ZOOM_options_get_int(r->options, "count", 0);
931 /* If "presentChunk" is defined use that; otherwise "step" */
932 const char *cp = ZOOM_options_get(r->options, "presentChunk");
933 r->step = ZOOM_options_get_int(r->options,
934 (cp != 0 ? "presentChunk": "step"), 0);
936 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
937 cp = ZOOM_options_get(r->options, "setname");
939 r->setname = xstrdup(cp);
940 cp = ZOOM_options_get(r->options, "schema");
942 r->schema = xstrdup(cp);
944 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
949 #if ZOOM_RESULT_LISTS
950 yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
951 set = xmalloc(sizeof(*set));
952 ZOOM_resultset_addref(r);
954 set->next = c->resultsets;
957 r->next = c->resultsets;
960 if (c->host_port && c->proto == PROTO_HTTP)
964 yaz_log(log_details, "ZOOM_connection_search: no comstack");
965 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
969 yaz_log(log_details, "ZOOM_connection_search: reconnect");
974 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
975 task->u.search.resultset = r;
976 task->u.search.start = start;
977 task->u.search.count = count;
978 task->u.search.recv_search_fired = 0;
980 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
981 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
982 elementSetName = ZOOM_options_get(r->options, "elementSetName");
983 task->u.search.elementSetName = elementSetName
984 ? xstrdup(elementSetName) : 0;
986 ZOOM_resultset_addref(r);
992 while (ZOOM_event(1, &c))
999 ZOOM_resultset_sort(ZOOM_resultset r,
1000 const char *sort_type, const char *sort_spec)
1002 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
1006 ZOOM_resultset_sort1(ZOOM_resultset r,
1007 const char *sort_type, const char *sort_spec)
1009 ZOOM_connection c = r->connection;
1013 newq = ZOOM_query_create();
1014 if (ZOOM_query_sortby(newq, sort_spec) < 0)
1017 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
1018 r, r, sort_type, sort_spec);
1022 if (c->host_port && c->proto == PROTO_HTTP)
1026 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
1027 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1031 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
1033 c->reconnect_ok = 1;
1037 ZOOM_resultset_cache_reset(r);
1038 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
1039 task->u.sort.resultset = r;
1040 task->u.sort.q = newq;
1042 ZOOM_resultset_addref(r);
1046 while (ZOOM_event(1, &c))
1053 static void ZOOM_record_release(ZOOM_record rec)
1059 if (rec->record_wrbuf)
1060 YAZ_SHPTR_DEC(rec->record_wrbuf, wrbuf_destroy);
1063 wrbuf_destroy(rec->wrbuf);
1067 odr_destroy(rec->odr);
1071 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1074 for (i = 0; i<RECORD_HASH_SIZE; i++)
1076 ZOOM_record_cache rc;
1077 for (rc = r->record_hash[i]; rc; rc = rc->next)
1079 ZOOM_record_release(&rc->rec);
1081 r->record_hash[i] = 0;
1086 ZOOM_resultset_destroy(ZOOM_resultset r)
1088 resultset_destroy(r);
1091 static void resultset_destroy(ZOOM_resultset r)
1095 yaz_mutex_enter(r->mutex);
1097 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1099 if (r->refcount == 0)
1101 yaz_mutex_leave(r->mutex);
1103 yaz_log(log_details, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
1104 ZOOM_resultset_cache_reset(r);
1105 #if ZOOM_RESULT_LISTS
1109 /* remove ourselves from the resultsets in connection */
1110 ZOOM_resultset *rp = &r->connection->resultsets;
1113 assert(*rp); /* we must be in this list!! */
1115 { /* OK, we're here - take us out of it */
1123 ZOOM_query_destroy(r->query);
1124 ZOOM_options_destroy(r->options);
1125 odr_destroy(r->odr);
1128 yaz_mutex_destroy(&r->mutex);
1130 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
1135 yaz_mutex_leave(r->mutex);
1139 ZOOM_resultset_size(ZOOM_resultset r)
1141 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1146 static void do_close(ZOOM_connection c)
1151 ZOOM_connection_set_mask(c, 0);
1152 c->state = STATE_IDLE;
1155 static int ZOOM_test_reconnect(ZOOM_connection c)
1159 if (!c->reconnect_ok)
1162 c->reconnect_ok = 0;
1163 c->tasks->running = 0;
1164 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1166 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1167 ZOOM_connection_put_event(c, event);
1172 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1173 int force_sync, int start, int count)
1178 const char *syntax, *elementSetName;
1182 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1183 " count=%d", r, force_sync, start, count);
1188 if (c->host_port && c->proto == PROTO_HTTP)
1192 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1193 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1197 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1199 c->reconnect_ok = 1;
1202 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1203 task->u.retrieve.resultset = r;
1204 task->u.retrieve.start = start;
1205 task->u.retrieve.count = count;
1207 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1208 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1209 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1210 task->u.retrieve.elementSetName = elementSetName
1211 ? xstrdup(elementSetName) : 0;
1213 cp = ZOOM_options_get(r->options, "schema");
1216 if (!r->schema || strcmp(r->schema, cp))
1219 r->schema = xstrdup(cp);
1223 ZOOM_resultset_addref(r);
1225 if (!r->connection->async || force_sync)
1226 while (r->connection && ZOOM_event(1, &r->connection))
1231 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1232 size_t start, size_t count)
1234 int force_present = 0;
1238 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1239 r, r, (long) start, (long) count);
1242 ZOOM_resultset_retrieve(r, force_present, start, count);
1246 for (i = 0; i< count; i++)
1247 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1251 static void get_cert(ZOOM_connection c)
1256 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1258 ZOOM_connection_option_setl(c, "sslPeerCert",
1259 cert_buf, cert_len);
1264 static zoom_ret do_connect_host(ZOOM_connection c,
1265 const char *effective_host,
1266 const char *logical_url);
1268 static zoom_ret do_connect(ZOOM_connection c)
1270 const char *effective_host;
1273 effective_host = c->proxy;
1275 effective_host = c->host_port;
1276 return do_connect_host(c, effective_host, c->host_port);
1279 static zoom_ret do_connect_host(ZOOM_connection c, const char *effective_host,
1280 const char *logical_url)
1284 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1288 c->cs = cs_create_host(effective_host, 0, &add);
1290 if (c->cs && c->cs->protocol == PROTO_HTTP)
1297 c->proto = PROTO_HTTP;
1298 cs_get_host_args(logical_url, &db);
1301 c->path = xmalloc(strlen(db) * 3 + 2);
1302 yaz_encode_sru_dbpath_buf(c->path, db);
1305 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1307 return zoom_complete;
1312 int ret = cs_connect(c->cs, add);
1315 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1316 ZOOM_connection_put_event(c, event);
1318 if (c->proto == PROTO_Z3950)
1319 ZOOM_connection_send_init(c);
1322 /* no init request for SRW .. */
1323 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1324 ZOOM_connection_remove_task(c);
1325 ZOOM_connection_set_mask(c, 0);
1326 ZOOM_connection_exec_task(c);
1328 c->state = STATE_ESTABLISHED;
1329 return zoom_pending;
1333 int mask = ZOOM_SELECT_EXCEPT;
1334 if (c->cs->io_pending & CS_WANT_WRITE)
1335 mask += ZOOM_SELECT_WRITE;
1336 if (c->cs->io_pending & CS_WANT_READ)
1337 mask += ZOOM_SELECT_READ;
1338 ZOOM_connection_set_mask(c, mask);
1339 c->state = STATE_CONNECTING;
1340 return zoom_pending;
1343 c->state = STATE_IDLE;
1344 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, logical_url);
1345 return zoom_complete;
1348 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1351 for (i = 0; i<200; i++)
1355 Z_OtherInformation **oi;
1360 sprintf(buf, "otherInfo%d", i);
1361 val = ZOOM_options_get(c->options, buf);
1364 cp = strchr(val, ':');
1368 if (len >= sizeof(buf))
1369 len = sizeof(buf)-1;
1370 memcpy(buf, val, len);
1373 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1378 yaz_oi_APDU(a, &oi);
1379 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1383 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1388 Z_OtherInformation **oi;
1389 yaz_oi_APDU(a, &oi);
1390 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1395 Z_OtherInformation **oi;
1396 yaz_oi_APDU(a, &oi);
1397 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1400 otherInfo_attach(c, a, out);
1401 if (!z_APDU(out, &a, 0, 0))
1403 FILE *outf = fopen("/tmp/apdu.txt", "a");
1406 ODR odr_pr = odr_createmem(ODR_PRINT);
1407 fprintf(outf, "a=%p\n", a);
1408 odr_setprint(odr_pr, outf);
1409 z_APDU(odr_pr, &a, 0, 0);
1410 odr_destroy(odr_pr);
1412 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1413 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1418 z_APDU(c->odr_print, &a, 0, 0);
1419 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1423 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1427 if (encode_APDU(c, a, c->odr_out))
1428 return zoom_complete;
1429 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1430 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1431 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1432 ZOOM_connection_put_event(c, event);
1433 odr_reset(c->odr_out);
1437 /* returns 1 if PDU was sent OK (still pending )
1438 0 if PDU was not sent OK (nothing to wait for)
1441 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1443 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1444 Z_InitRequest *ireq = apdu->u.initRequest;
1445 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1446 odr_malloc(c->odr_out, sizeof(*auth));
1448 ODR_MASK_SET(ireq->options, Z_Options_search);
1449 ODR_MASK_SET(ireq->options, Z_Options_present);
1450 ODR_MASK_SET(ireq->options, Z_Options_scan);
1451 ODR_MASK_SET(ireq->options, Z_Options_sort);
1452 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1453 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1455 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1456 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1457 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1459 ireq->implementationId =
1460 odr_prepend(c->odr_out,
1461 ZOOM_options_get(c->options, "implementationId"),
1462 ireq->implementationId);
1464 ireq->implementationName =
1465 odr_prepend(c->odr_out,
1466 ZOOM_options_get(c->options, "implementationName"),
1467 odr_prepend(c->odr_out, "ZOOM-C",
1468 ireq->implementationName));
1470 ireq->implementationVersion =
1471 odr_prepend(c->odr_out,
1472 ZOOM_options_get(c->options, "implementationVersion"),
1473 ireq->implementationVersion);
1475 *ireq->maximumRecordSize = c->maximum_record_size;
1476 *ireq->preferredMessageSize = c->preferred_message_size;
1478 if (c->group || c->password)
1480 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1481 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1482 pass->userId = odr_strdup_null(c->odr_out, c->user);
1483 pass->password = odr_strdup_null(c->odr_out, c->password);
1484 auth->which = Z_IdAuthentication_idPass;
1485 auth->u.idPass = pass;
1486 ireq->idAuthentication = auth;
1490 auth->which = Z_IdAuthentication_open;
1491 auth->u.open = odr_strdup(c->odr_out, c->user);
1492 ireq->idAuthentication = auth;
1496 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1497 yaz_oid_userinfo_proxy, 1, c->host_port);
1499 if (c->charset || c->lang)
1501 Z_OtherInformation **oi;
1502 Z_OtherInformationUnit *oi_unit;
1504 yaz_oi_APDU(apdu, &oi);
1506 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1508 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1509 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1510 oi_unit->information.externallyDefinedInfo =
1511 yaz_set_proposal_charneg_list(c->odr_out, " ",
1512 c->charset, c->lang, 1);
1516 return send_APDU(c, apdu);
1520 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1524 const char *database = ZOOM_options_get(c->options, "databaseName");
1525 char *fdatabase = 0;
1528 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1529 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1530 fdatabase ? fdatabase : c->path);
1532 if (c->sru_mode == zoom_sru_get)
1534 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1536 else if (c->sru_mode == zoom_sru_post)
1538 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1540 else if (c->sru_mode == zoom_sru_soap)
1542 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1544 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1545 return zoom_complete;
1547 z_GDU(c->odr_print, &gdu, 0, 0);
1548 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1550 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1551 ZOOM_connection_put_event(c, event);
1552 odr_reset(c->odr_out);
1558 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1560 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1561 sr->username = c->user;
1562 sr->password = c->password;
1568 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1572 ZOOM_resultset resultset = 0;
1574 const char *option_val = 0;
1576 if (c->error) /* don't continue on error */
1577 return zoom_complete;
1579 switch(c->tasks->which)
1581 case ZOOM_TASK_SEARCH:
1582 resultset = c->tasks->u.search.resultset;
1583 if (!resultset->setname)
1584 resultset->setname = xstrdup("default");
1585 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1586 start = &c->tasks->u.search.start;
1587 count = &c->tasks->u.search.count;
1589 case ZOOM_TASK_RETRIEVE:
1590 resultset = c->tasks->u.retrieve.resultset;
1592 start = &c->tasks->u.retrieve.start;
1593 count = &c->tasks->u.retrieve.count;
1595 if (*start >= resultset->size)
1596 return zoom_complete;
1597 if (*start + *count > resultset->size)
1598 *count = resultset->size - *start;
1600 for (i = 0; i < *count; i++)
1603 record_cache_lookup(resultset, i + *start,
1604 c->tasks->u.retrieve.syntax,
1605 c->tasks->u.retrieve.elementSetName);
1610 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1611 ZOOM_connection_put_event(c, event);
1618 return zoom_complete;
1621 return zoom_complete;
1623 assert(resultset->query);
1625 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1626 if (resultset->query->z_query->which == Z_Query_type_104
1627 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1629 sr->u.request->query_type = Z_SRW_query_type_cql;
1630 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1632 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1633 resultset->query->z_query->u.type_1)
1635 sr->u.request->query_type = Z_SRW_query_type_pqf;
1636 sr->u.request->query.pqf = resultset->query->query_string;
1640 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1641 return zoom_complete;
1643 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1644 sr->u.request->maximumRecords = odr_intdup(
1645 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1646 resultset->step : *count);
1647 sr->u.request->recordSchema = resultset->schema;
1649 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1651 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1653 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1654 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1655 return send_srw(c, sr);
1658 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1660 return zoom_complete;
1664 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1667 int lslb, ssub, mspn;
1669 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1670 Z_SearchRequest *search_req = apdu->u.searchRequest;
1671 const char *elementSetName;
1672 const char *smallSetElementSetName;
1673 const char *mediumSetElementSetName;
1676 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1678 r = c->tasks->u.search.resultset;
1680 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1683 ZOOM_options_get(r->options, "elementSetName");
1684 smallSetElementSetName =
1685 ZOOM_options_get(r->options, "smallSetElementSetName");
1686 mediumSetElementSetName =
1687 ZOOM_options_get(r->options, "mediumSetElementSetName");
1689 if (!smallSetElementSetName)
1690 smallSetElementSetName = elementSetName;
1692 if (!mediumSetElementSetName)
1693 mediumSetElementSetName = elementSetName;
1698 /* prepare query for the search request */
1699 search_req->query = r->query->z_query;
1700 if (!search_req->query)
1702 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1703 return zoom_complete;
1705 if (r->query->z_query->which == Z_Query_type_1 ||
1706 r->query->z_query->which == Z_Query_type_101)
1708 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1711 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1715 search_req->query = yaz_copy_Z_Query(search_req->query,
1718 r = yaz_query_charset_convert_rpnquery_check(
1719 search_req->query->u.type_1,
1721 yaz_iconv_close(cd);
1723 { /* query could not be char converted */
1724 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1725 return zoom_complete;
1730 search_req->databaseNames = r->databaseNames;
1731 search_req->num_databaseNames = r->num_databaseNames;
1733 /* get syntax (no need to provide unless piggyback is in effect) */
1734 syntax = c->tasks->u.search.syntax;
1736 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1737 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1738 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1739 if (lslb != -1 && ssub != -1 && mspn != -1)
1741 /* So're a Z39.50 expert? Let's hope you don't do sort */
1742 *search_req->largeSetLowerBound = lslb;
1743 *search_req->smallSetUpperBound = ssub;
1744 *search_req->mediumSetPresentNumber = mspn;
1746 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1747 && r->piggyback && !r->r_sort_spec && !r->schema)
1749 /* Regular piggyback - do it unless we're going to do sort */
1750 *search_req->largeSetLowerBound = 2000000000;
1751 *search_req->smallSetUpperBound = 1;
1752 *search_req->mediumSetPresentNumber =
1753 r->step>0 ? r->step : c->tasks->u.search.count;
1757 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1758 smallSetElementSetName = 0;
1759 mediumSetElementSetName = 0;
1762 if (smallSetElementSetName && *smallSetElementSetName)
1764 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1765 odr_malloc(c->odr_out, sizeof(*esn));
1767 esn->which = Z_ElementSetNames_generic;
1768 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1769 search_req->smallSetElementSetNames = esn;
1771 if (mediumSetElementSetName && *mediumSetElementSetName)
1773 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1774 odr_malloc(c->odr_out, sizeof(*esn));
1776 esn->which = Z_ElementSetNames_generic;
1777 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1778 search_req->mediumSetElementSetNames = esn;
1781 search_req->preferredRecordSyntax =
1782 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1786 if (c->support_named_resultsets)
1790 /* find the lowest unused ordinal so that we re-use
1791 result sets on the server. */
1792 for (ord = 1; ; ord++)
1794 #if ZOOM_RESULT_LISTS
1795 ZOOM_resultsets rsp;
1796 sprintf(setname, "%d", ord);
1797 for (rsp = c->resultsets; rsp; rsp = rsp->next)
1798 if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
1804 sprintf(setname, "%d", ord);
1805 for (rp = c->resultsets; rp; rp = rp->next)
1806 if (rp->setname && !strcmp(rp->setname, setname))
1813 r->setname = xstrdup(setname);
1814 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1815 "set %s", c, r->setname);
1819 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1821 r->setname = xstrdup("default");
1823 ZOOM_options_set(r->options, "setname", r->setname);
1825 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1826 return send_APDU(c, apdu);
1829 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1831 char oid_name_buf[OID_STR_MAX];
1832 const char *oid_name;
1835 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1838 case Z_DefaultDiagFormat_v2Addinfo:
1839 addinfo = r->u.v2Addinfo;
1841 case Z_DefaultDiagFormat_v3Addinfo:
1842 addinfo = r->u.v3Addinfo;
1847 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1850 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1852 if (p->which != Z_DiagRec_defaultFormat)
1853 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1855 response_default_diag(c, p->u.defaultFormat);
1858 ZOOM_API(ZOOM_record)
1859 ZOOM_record_clone(ZOOM_record srec)
1866 odr_enc = odr_createmem(ODR_ENCODE);
1867 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1869 buf = odr_getbuf(odr_enc, &size, 0);
1871 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1872 yaz_log(log_details, "ZOOM_record create");
1873 nrec->odr = odr_createmem(ODR_DECODE);
1875 nrec->record_wrbuf = 0;
1879 odr_setbuf(nrec->odr, buf, size, 0);
1880 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1882 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1883 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1884 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1885 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1886 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1887 odr_destroy(odr_enc);
1891 ZOOM_API(ZOOM_record)
1892 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1894 const char *syntax =
1895 ZOOM_options_get(s->options, "preferredRecordSyntax");
1896 const char *elementSetName =
1897 ZOOM_options_get(s->options, "elementSetName");
1899 return record_cache_lookup(s, pos, syntax, elementSetName);
1902 ZOOM_API(ZOOM_record)
1903 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1905 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1910 * MIKE: I think force_sync should always be zero, but I don't
1911 * want to make this change until I get the go-ahead from
1912 * Adam, in case something depends on the old synchronous
1916 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1917 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1918 rec = ZOOM_resultset_record_immediate(r, pos);
1924 ZOOM_record_destroy(ZOOM_record rec)
1926 ZOOM_record_release(rec);
1927 yaz_log(log_details, "ZOOM_record destroy");
1932 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1939 strcpy(to, "UTF-8");
1940 if (record_charset && *record_charset)
1942 /* Use "from,to" or just "from" */
1943 const char *cp = strchr(record_charset, ',');
1944 size_t clen = strlen(record_charset);
1947 strncpy( to, cp+1, sizeof(to)-1);
1948 to[sizeof(to)-1] = '\0';
1949 clen = cp - record_charset;
1951 if (clen > sizeof(from)-1)
1952 clen = sizeof(from)-1;
1955 strncpy(from, record_charset, clen);
1959 cd = yaz_iconv_open(to, from);
1963 static const char *return_marc_record(WRBUF wrbuf,
1966 const char *buf, int sz,
1967 const char *record_charset)
1969 yaz_iconv_t cd = iconv_create_charset(record_charset);
1970 yaz_marc_t mt = yaz_marc_create();
1971 const char *ret_string = 0;
1974 yaz_marc_iconv(mt, cd);
1975 yaz_marc_xml(mt, marc_type);
1976 if (yaz_marc_decode_wrbuf(mt, buf, sz, wrbuf) > 0)
1979 *len = wrbuf_len(wrbuf);
1980 ret_string = wrbuf_cstr(wrbuf);
1982 yaz_marc_destroy(mt);
1984 yaz_iconv_close(cd);
1988 static const char *return_opac_record(WRBUF wrbuf,
1991 Z_OPACRecord *opac_rec,
1992 const char *record_charset)
1994 yaz_iconv_t cd = iconv_create_charset(record_charset);
1995 yaz_marc_t mt = yaz_marc_create();
1998 yaz_marc_iconv(mt, cd);
1999 yaz_marc_xml(mt, marc_type);
2001 yaz_opac_decode_wrbuf(mt, opac_rec, wrbuf);
2002 yaz_marc_destroy(mt);
2005 yaz_iconv_close(cd);
2007 *len = wrbuf_len(wrbuf);
2008 return wrbuf_cstr(wrbuf);
2011 static const char *return_string_record(WRBUF wrbuf,
2013 const char *buf, int sz,
2014 const char *record_charset)
2016 yaz_iconv_t cd = iconv_create_charset(record_charset);
2020 wrbuf_iconv_write(wrbuf, cd, buf, sz);
2021 wrbuf_iconv_reset(wrbuf, cd);
2023 buf = wrbuf_cstr(wrbuf);
2024 sz = wrbuf_len(wrbuf);
2025 yaz_iconv_close(cd);
2032 static const char *return_record_wrbuf(WRBUF wrbuf, int *len,
2033 Z_NamePlusRecord *npr,
2034 int marctype, const char *charset)
2036 Z_External *r = (Z_External *) npr->u.databaseRecord;
2037 const Odr_oid *oid = r->direct_reference;
2039 wrbuf_rewind(wrbuf);
2040 /* render bibliographic record .. */
2041 if (r->which == Z_External_OPAC)
2043 return return_opac_record(wrbuf, marctype, len,
2044 r->u.opac, charset);
2046 if (r->which == Z_External_sutrs)
2047 return return_string_record(wrbuf, len,
2048 (char*) r->u.sutrs->buf,
2051 else if (r->which == Z_External_octet)
2053 if (yaz_oid_is_iso2709(oid))
2055 const char *ret_buf = return_marc_record(
2056 wrbuf, marctype, len,
2057 (const char *) r->u.octet_aligned->buf,
2058 r->u.octet_aligned->len,
2062 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
2063 if (marctype != YAZ_MARC_ISO2709)
2066 return return_string_record(wrbuf, len,
2067 (const char *) r->u.octet_aligned->buf,
2068 r->u.octet_aligned->len,
2071 else if (r->which == Z_External_grs1)
2073 yaz_display_grs1(wrbuf, r->u.grs1, 0);
2074 return return_string_record(wrbuf, len,
2083 ZOOM_record_error(ZOOM_record rec, const char **cp,
2084 const char **addinfo, const char **diagset)
2086 Z_NamePlusRecord *npr;
2095 *cp = rec->diag_message;
2097 *addinfo = rec->diag_details;
2099 *diagset = rec->diag_set;
2100 return uri_to_code(rec->diag_uri);
2102 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2104 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2105 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2106 const char *add = 0;
2108 if (diag_rec->which == Z_DiagRec_defaultFormat)
2110 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2113 error = *ddf->condition;
2116 case Z_DefaultDiagFormat_v2Addinfo:
2117 add = ddf->u.v2Addinfo;
2119 case Z_DefaultDiagFormat_v3Addinfo:
2120 add = ddf->u.v3Addinfo;
2125 yaz_oid_to_string(yaz_oid_std(),
2126 ddf->diagnosticSetId, &oclass);
2134 *addinfo = add ? add : "";
2136 *cp = diagbib1_str(error);
2142 static const char *get_record_format(WRBUF wrbuf, int *len,
2143 Z_NamePlusRecord *npr,
2144 int marctype, const char *charset,
2147 const char *res = return_record_wrbuf(wrbuf, len, npr, marctype, charset);
2149 if (*format == '1' && len)
2151 /* try to XML format res */
2153 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2154 doc = xmlParseMemory(res, *len);
2159 xmlDocDumpFormatMemory(doc, &xml_mem, &xml_size, 1);
2160 wrbuf_rewind(wrbuf);
2161 wrbuf_write(wrbuf, (const char *) xml_mem, xml_size);
2164 res = wrbuf_cstr(wrbuf);
2165 *len = wrbuf_len(wrbuf);
2173 static const char *npr_format(Z_NamePlusRecord *npr, const char *schema,
2175 const char *type_spec, int *len)
2181 const char *cp = type_spec;
2183 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2191 while (cp[i] == ' ')
2196 while (cp[i] == ' ')
2198 if (!strncmp(cp + i, "charset=", 8))
2201 i = i + 8; /* skip charset= */
2202 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2204 if (j < sizeof(charset)-1)
2205 charset[j++] = cp[i];
2209 else if (!strncmp(cp + i, "format=", 7))
2213 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2215 if (j < sizeof(format)-1)
2216 format[j++] = cp[i];
2221 if (!strcmp(type, "database"))
2224 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2225 return npr->databaseName;
2227 else if (!strcmp(type, "schema"))
2230 *len = schema ? strlen(schema) : 0;
2233 else if (!strcmp(type, "syntax"))
2235 const char *desc = 0;
2236 if (npr->which == Z_NamePlusRecord_databaseRecord)
2238 Z_External *r = (Z_External *) npr->u.databaseRecord;
2239 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2244 *len = strlen(desc);
2247 if (npr->which != Z_NamePlusRecord_databaseRecord)
2250 /* from now on - we have a database record .. */
2251 if (!strcmp(type, "render"))
2253 return get_record_format(wrbuf, len, npr, YAZ_MARC_LINE, charset, format);
2255 else if (!strcmp(type, "xml"))
2257 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2260 else if (!strcmp(type, "txml"))
2262 return get_record_format(wrbuf, len, npr, YAZ_MARC_TURBOMARC, charset,
2265 else if (!strcmp(type, "raw"))
2267 return get_record_format(wrbuf, len, npr, YAZ_MARC_ISO2709, charset,
2270 else if (!strcmp(type, "ext"))
2273 return (const char *) npr->u.databaseRecord;
2275 else if (!strcmp(type, "opac"))
2277 if (npr->u.databaseRecord->which == Z_External_OPAC)
2278 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2284 ZOOM_API(const char *)
2285 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2290 *len = 0; /* default return */
2292 if (!rec || !rec->npr)
2296 if (!rec->record_wrbuf)
2298 WRBUF w = wrbuf_alloc();
2299 YAZ_SHPTR_INIT(rec->record_wrbuf, w);
2301 wrbuf = rec->record_wrbuf->ptr;
2304 rec->wrbuf = wrbuf_alloc();
2307 return npr_format(rec->npr, rec->schema, wrbuf, type_spec, len);
2310 static int strcmp_null(const char *v1, const char *v2)
2316 return strcmp(v1, v2);
2319 static size_t record_hash(int pos)
2323 return pos % RECORD_HASH_SIZE;
2326 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2328 const char *syntax, const char *elementSetName,
2330 Z_SRW_diagnostic *diag)
2332 ZOOM_record_cache rc = 0;
2334 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2335 ZOOM_connection_put_event(r->connection, event);
2337 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2340 && strcmp_null(r->schema, rc->schema) == 0
2341 && strcmp_null(elementSetName,rc->elementSetName) == 0
2342 && strcmp_null(syntax, rc->syntax) == 0)
2347 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2350 YAZ_SHPTR_INC(r->record_wrbuf);
2351 rc->rec.record_wrbuf = r->record_wrbuf;
2355 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2357 rc->syntax = odr_strdup_null(r->odr, syntax);
2359 rc->schema = odr_strdup_null(r->odr, r->schema);
2362 rc->next = r->record_hash[record_hash(pos)];
2363 r->record_hash[record_hash(pos)] = rc;
2366 rc->rec.schema = odr_strdup_null(r->odr, schema);
2367 rc->rec.diag_set = 0;
2368 rc->rec.diag_uri = 0;
2369 rc->rec.diag_message = 0;
2370 rc->rec.diag_details = 0;
2376 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2377 if ((cp = strrchr(rc->rec.diag_set, '/')))
2379 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2381 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2382 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2386 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2388 const char *elementSetName)
2390 ZOOM_record_cache rc;
2392 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2396 if (strcmp_null(r->schema, rc->schema))
2398 if (strcmp_null(elementSetName,rc->elementSetName))
2400 if (strcmp_null(syntax, rc->syntax))
2408 static void handle_records(ZOOM_connection c, Z_Records *sr,
2411 ZOOM_resultset resultset;
2413 const char *syntax = 0, *elementSetName = 0;
2417 switch (c->tasks->which)
2419 case ZOOM_TASK_SEARCH:
2420 resultset = c->tasks->u.search.resultset;
2421 start = &c->tasks->u.search.start;
2422 count = &c->tasks->u.search.count;
2423 syntax = c->tasks->u.search.syntax;
2424 elementSetName = c->tasks->u.search.elementSetName;
2426 case ZOOM_TASK_RETRIEVE:
2427 resultset = c->tasks->u.retrieve.resultset;
2428 start = &c->tasks->u.retrieve.start;
2429 count = &c->tasks->u.retrieve.count;
2430 syntax = c->tasks->u.retrieve.syntax;
2431 elementSetName = c->tasks->u.retrieve.elementSetName;
2436 if (sr && sr->which == Z_Records_NSD)
2437 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2438 else if (sr && sr->which == Z_Records_multipleNSD)
2440 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2441 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2443 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2447 if (*count + *start > resultset->size)
2448 *count = resultset->size - *start;
2451 if (sr && sr->which == Z_Records_DBOSD)
2454 NMEM nmem = odr_extract_mem(c->odr_in);
2455 Z_NamePlusRecordList *p =
2456 sr->u.databaseOrSurDiagnostics;
2457 for (i = 0; i<p->num_records; i++)
2459 record_cache_add(resultset, p->records[i], i + *start,
2460 syntax, elementSetName,
2467 yaz_log(log_details,
2468 "handle_records resultset=%p start=%d count=%d",
2469 resultset, *start, *count);
2471 /* transfer our response to search_nmem .. we need it later */
2472 nmem_transfer(odr_getmem(resultset->odr), nmem);
2474 if (present_phase && p->num_records == 0)
2476 /* present response and we didn't get any records! */
2477 Z_NamePlusRecord *myrec =
2478 zget_surrogateDiagRec(
2480 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2481 "ZOOM C generated. Present phase and no records");
2482 record_cache_add(resultset, myrec, *start,
2483 syntax, elementSetName, 0, 0);
2486 else if (present_phase)
2488 /* present response and we didn't get any records! */
2489 Z_NamePlusRecord *myrec =
2490 zget_surrogateDiagRec(
2492 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2493 "ZOOM C generated: Present response and no records");
2494 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2500 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2502 handle_records(c, pr->records, 1);
2505 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2508 switch (term->which)
2510 case Z_Term_general:
2511 ZOOM_options_setl(opt, name,
2512 (const char *)(term->u.general->buf),
2513 term->u.general->len);
2515 case Z_Term_characterString:
2516 ZOOM_options_set(opt, name, term->u.characterString);
2518 case Z_Term_numeric:
2519 ZOOM_options_set_int(opt, name, *term->u.numeric);
2524 static void handle_queryExpression(ZOOM_options opt, const char *name,
2525 Z_QueryExpression *exp)
2531 case Z_QueryExpression_term:
2532 if (exp->u.term && exp->u.term->queryTerm)
2534 sprintf(opt_name, "%s.term", name);
2535 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2538 case Z_QueryExpression_query:
2543 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2544 Z_OtherInformation *o)
2547 for (i = 0; o && i < o->num_elements; i++)
2549 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2551 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2553 if (ext->which == Z_External_searchResult1)
2556 Z_SearchInfoReport *sr = ext->u.searchResult1;
2559 ZOOM_options_set_int(
2560 resultset->options, "searchresult.size", sr->num);
2562 for (j = 0; j < sr->num; j++)
2564 Z_SearchInfoReport_s *ent =
2565 ext->u.searchResult1->elements[j];
2568 sprintf(pref, "searchresult.%d", j);
2570 if (ent->subqueryId)
2573 sprintf(opt_name, "%s.id", pref);
2574 ZOOM_options_set(resultset->options, opt_name,
2577 if (ent->subqueryExpression)
2580 sprintf(opt_name, "%s.subquery", pref);
2581 handle_queryExpression(resultset->options, opt_name,
2582 ent->subqueryExpression);
2584 if (ent->subqueryInterpretation)
2587 sprintf(opt_name, "%s.interpretation", pref);
2588 handle_queryExpression(resultset->options, opt_name,
2589 ent->subqueryInterpretation);
2591 if (ent->subqueryRecommendation)
2594 sprintf(opt_name, "%s.recommendation", pref);
2595 handle_queryExpression(resultset->options, opt_name,
2596 ent->subqueryRecommendation);
2598 if (ent->subqueryCount)
2601 sprintf(opt_name, "%s.count", pref);
2602 ZOOM_options_set_int(resultset->options, opt_name,
2603 *ent->subqueryCount);
2611 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2613 ZOOM_resultset resultset;
2616 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2619 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2620 ZOOM_connection_put_event(c, event);
2622 resultset = c->tasks->u.search.resultset;
2624 if (sr->resultSetStatus)
2626 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2627 *sr->resultSetStatus);
2629 if (sr->presentStatus)
2631 ZOOM_options_set_int(resultset->options, "presentStatus",
2632 *sr->presentStatus);
2634 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2636 resultset->size = *sr->resultCount;
2637 handle_records(c, sr->records, 0);
2640 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2642 if (res->diagnostics && res->num_diagnostics > 0)
2643 response_diag(c, res->diagnostics[0]);
2646 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2648 NMEM nmem = odr_extract_mem(c->odr_in);
2651 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2653 scan = c->tasks->u.scan.scan;
2655 if (res->entries && res->entries->nonsurrogateDiagnostics)
2656 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2657 scan->scan_response = res;
2658 scan->srw_scan_response = 0;
2659 nmem_transfer(odr_getmem(scan->odr), nmem);
2661 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2662 if (res->positionOfTerm)
2663 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2664 if (res->scanStatus)
2665 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2666 if (res->numberOfEntriesReturned)
2667 ZOOM_options_set_int(scan->options, "number",
2668 *res->numberOfEntriesReturned);
2673 static zoom_ret send_sort(ZOOM_connection c,
2674 ZOOM_resultset resultset)
2677 resultset->r_sort_spec = 0;
2678 if (resultset->r_sort_spec)
2680 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2681 Z_SortRequest *req = apdu->u.sortRequest;
2683 req->num_inputResultSetNames = 1;
2684 req->inputResultSetNames = (Z_InternationalString **)
2685 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2686 req->inputResultSetNames[0] =
2687 odr_strdup(c->odr_out, resultset->setname);
2688 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2689 req->sortSequence = resultset->r_sort_spec;
2690 resultset->r_sort_spec = 0;
2691 return send_APDU(c, apdu);
2693 return zoom_complete;
2696 static zoom_ret send_present(ZOOM_connection c)
2699 Z_PresentRequest *req = 0;
2701 const char *syntax = 0;
2702 const char *elementSetName = 0;
2703 ZOOM_resultset resultset;
2708 yaz_log(log_details, "%p send_present no tasks", c);
2709 return zoom_complete;
2712 switch (c->tasks->which)
2714 case ZOOM_TASK_SEARCH:
2715 resultset = c->tasks->u.search.resultset;
2716 start = &c->tasks->u.search.start;
2717 count = &c->tasks->u.search.count;
2718 syntax = c->tasks->u.search.syntax;
2719 elementSetName = c->tasks->u.search.elementSetName;
2721 case ZOOM_TASK_RETRIEVE:
2722 resultset = c->tasks->u.retrieve.resultset;
2723 start = &c->tasks->u.retrieve.start;
2724 count = &c->tasks->u.retrieve.count;
2725 syntax = c->tasks->u.retrieve.syntax;
2726 elementSetName = c->tasks->u.retrieve.elementSetName;
2729 return zoom_complete;
2731 yaz_log(log_details, "%p send_present start=%d count=%d",
2734 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2736 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2739 if (c->error) /* don't continue on error */
2740 return zoom_complete;
2741 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2742 resultset, *start, *count);
2744 for (i = 0; i < *count; i++)
2747 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2752 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2753 ZOOM_connection_put_event(c, event);
2761 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2762 return zoom_complete;
2765 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2766 req = apdu->u.presentRequest;
2769 yaz_log(log_details, "%p send_present skip=%d", c, i);
2771 *req->resultSetStartPoint = *start + 1;
2773 if (resultset->step > 0 && resultset->step < *count)
2774 *req->numberOfRecordsRequested = resultset->step;
2776 *req->numberOfRecordsRequested = *count;
2778 if (*req->numberOfRecordsRequested + *start > resultset->size)
2779 *req->numberOfRecordsRequested = resultset->size - *start;
2780 assert(*req->numberOfRecordsRequested > 0);
2782 if (syntax && *syntax)
2783 req->preferredRecordSyntax =
2784 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2786 if (resultset->schema && *resultset->schema)
2788 Z_RecordComposition *compo = (Z_RecordComposition *)
2789 odr_malloc(c->odr_out, sizeof(*compo));
2791 req->recordComposition = compo;
2792 compo->which = Z_RecordComp_complex;
2793 compo->u.complex = (Z_CompSpec *)
2794 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2795 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2796 odr_malloc(c->odr_out, sizeof(bool_t));
2797 *compo->u.complex->selectAlternativeSyntax = 0;
2799 compo->u.complex->generic = (Z_Specification *)
2800 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2802 compo->u.complex->generic->which = Z_Schema_oid;
2803 compo->u.complex->generic->schema.oid = (Odr_oid *)
2804 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2806 if (!compo->u.complex->generic->schema.oid)
2808 /* OID wasn't a schema! Try record syntax instead. */
2810 compo->u.complex->generic->schema.oid = (Odr_oid *)
2811 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2813 if (elementSetName && *elementSetName)
2815 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2816 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2817 compo->u.complex->generic->elementSpec->which =
2818 Z_ElementSpec_elementSetName;
2819 compo->u.complex->generic->elementSpec->u.elementSetName =
2820 odr_strdup(c->odr_out, elementSetName);
2823 compo->u.complex->generic->elementSpec = 0;
2824 compo->u.complex->num_dbSpecific = 0;
2825 compo->u.complex->dbSpecific = 0;
2826 compo->u.complex->num_recordSyntax = 0;
2827 compo->u.complex->recordSyntax = 0;
2829 else if (elementSetName && *elementSetName)
2831 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2832 odr_malloc(c->odr_out, sizeof(*esn));
2833 Z_RecordComposition *compo = (Z_RecordComposition *)
2834 odr_malloc(c->odr_out, sizeof(*compo));
2836 esn->which = Z_ElementSetNames_generic;
2837 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2838 compo->which = Z_RecordComp_simple;
2839 compo->u.simple = esn;
2840 req->recordComposition = compo;
2842 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2843 return send_APDU(c, apdu);
2846 ZOOM_API(ZOOM_scanset)
2847 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2850 ZOOM_query q = ZOOM_query_create();
2852 ZOOM_query_prefix(q, start);
2854 s = ZOOM_connection_scan1(c, q);
2855 ZOOM_query_destroy(q);
2860 ZOOM_API(ZOOM_scanset)
2861 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2863 ZOOM_scanset scan = 0;
2867 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2868 scan->connection = c;
2869 scan->odr = odr_createmem(ODR_DECODE);
2870 scan->options = ZOOM_options_create_with_parent(c->options);
2872 scan->scan_response = 0;
2873 scan->srw_scan_response = 0;
2877 scan->databaseNames = set_DatabaseNames(c, c->options,
2878 &scan->num_databaseNames,
2883 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2884 task->u.scan.scan = scan;
2889 while (ZOOM_event(1, &c))
2897 ZOOM_scanset_destroy(ZOOM_scanset scan)
2902 if (scan->refcount == 0)
2904 ZOOM_query_destroy(scan->query);
2906 odr_destroy(scan->odr);
2908 ZOOM_options_destroy(scan->options);
2913 static zoom_ret send_package(ZOOM_connection c)
2917 yaz_log(log_details, "%p send_package", c);
2919 return zoom_complete;
2920 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2922 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2923 ZOOM_connection_put_event(c, event);
2925 c->buf_out = c->tasks->u.package->buf_out;
2926 c->len_out = c->tasks->u.package->len_out;
2931 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2934 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2935 Z_ScanRequest *req = apdu->u.scanRequest;
2937 yaz_log(log_details, "%p send_scan", c);
2939 return zoom_complete;
2940 assert (c->tasks->which == ZOOM_TASK_SCAN);
2941 scan = c->tasks->u.scan.scan;
2943 /* Z39.50 scan can only carry RPN */
2944 if (scan->query->z_query->which == Z_Query_type_1 ||
2945 scan->query->z_query->which == Z_Query_type_101)
2947 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2948 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2951 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2954 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2956 yaz_query_charset_convert_rpnquery(
2957 rpn, c->odr_out, cd);
2958 yaz_iconv_close(cd);
2961 req->attributeSet = rpn->attributeSetId;
2962 if (!req->attributeSet)
2963 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2964 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2965 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2967 req->termListAndStartPoint =
2968 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2972 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2973 return zoom_complete;
2978 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2979 return zoom_complete;
2982 *req->numberOfTermsRequested =
2983 ZOOM_options_get_int(scan->options, "number", 20);
2985 req->preferredPositionInResponse =
2986 odr_intdup(c->odr_out,
2987 ZOOM_options_get_int(scan->options, "position", 1));
2990 odr_intdup(c->odr_out,
2991 ZOOM_options_get_int(scan->options, "stepSize", 0));
2993 req->databaseNames = scan->databaseNames;
2994 req->num_databaseNames = scan->num_databaseNames;
2996 return send_APDU(c, apdu);
3000 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3004 const char *option_val = 0;
3007 return zoom_complete;
3008 assert (c->tasks->which == ZOOM_TASK_SCAN);
3009 scan = c->tasks->u.scan.scan;
3011 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
3013 /* SRU scan can only carry CQL and PQF */
3014 if (scan->query->z_query->which == Z_Query_type_104)
3016 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
3017 sr->u.scan_request->scanClause.cql = scan->query->query_string;
3019 else if (scan->query->z_query->which == Z_Query_type_1
3020 || scan->query->z_query->which == Z_Query_type_101)
3022 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
3023 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
3027 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3028 return zoom_complete;
3031 sr->u.scan_request->maximumTerms = odr_intdup(
3032 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
3034 sr->u.scan_request->responsePosition = odr_intdup(
3035 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
3037 option_val = ZOOM_options_get(scan->options, "extraArgs");
3038 yaz_encode_sru_extra(sr, c->odr_out, option_val);
3039 return send_srw(c, sr);
3042 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3044 return zoom_complete;
3050 ZOOM_scanset_size(ZOOM_scanset scan)
3055 if (scan->scan_response && scan->scan_response->entries)
3056 return scan->scan_response->entries->num_entries;
3057 else if (scan->srw_scan_response)
3058 return scan->srw_scan_response->num_terms;
3062 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
3064 const char **value_term, size_t *value_len,
3065 const char **disp_term, size_t *disp_len)
3067 size_t noent = ZOOM_scanset_size(scan);
3078 if (scan->scan_response)
3080 Z_ScanResponse *res = scan->scan_response;
3081 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
3083 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3085 *value_term = (const char *) t->term->u.general->buf;
3086 *value_len = t->term->u.general->len;
3089 *disp_term = t->displayTerm;
3090 *disp_len = strlen(*disp_term);
3092 else if (t->term->which == Z_Term_general)
3094 *disp_term = (const char *) t->term->u.general->buf;
3095 *disp_len = t->term->u.general->len;
3097 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3100 if (scan->srw_scan_response)
3102 Z_SRW_scanResponse *res = scan->srw_scan_response;
3103 Z_SRW_scanTerm *t = res->terms + pos;
3106 *value_term = t->value;
3107 *value_len = strlen(*value_term);
3110 *disp_term = t->displayTerm;
3112 *disp_term = t->value;
3113 *disp_len = strlen(*disp_term);
3114 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3119 ZOOM_API(const char *)
3120 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3121 size_t *occ, size_t *len)
3123 const char *value_term = 0;
3124 size_t value_len = 0;
3125 const char *disp_term = 0;
3126 size_t disp_len = 0;
3128 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3129 &disp_term, &disp_len);
3135 ZOOM_API(const char *)
3136 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3137 size_t *occ, size_t *len)
3139 const char *value_term = 0;
3140 size_t value_len = 0;
3141 const char *disp_term = 0;
3142 size_t disp_len = 0;
3144 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3145 &disp_term, &disp_len);
3151 ZOOM_API(const char *)
3152 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3154 return ZOOM_options_get(scan->options, key);
3158 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3161 ZOOM_options_set(scan->options, key, val);
3164 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3167 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3168 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3170 str = ZOOM_options_get(p->options, "package-name");
3172 req->packageName = odr_strdup(p->odr_out, str);
3174 str = ZOOM_options_get(p->options, "user-id");
3176 req->userId = odr_strdup_null(p->odr_out, str);
3178 req->packageType = odr_oiddup(p->odr_out, oid);
3180 str = ZOOM_options_get(p->options, "function");
3183 if (!strcmp (str, "create"))
3184 *req->function = Z_ExtendedServicesRequest_create;
3185 if (!strcmp (str, "delete"))
3186 *req->function = Z_ExtendedServicesRequest_delete;
3187 if (!strcmp (str, "modify"))
3188 *req->function = Z_ExtendedServicesRequest_modify;
3191 str = ZOOM_options_get(p->options, "waitAction");
3194 if (!strcmp (str, "wait"))
3195 *req->waitAction = Z_ExtendedServicesRequest_wait;
3196 if (!strcmp (str, "waitIfPossible"))
3197 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3198 if (!strcmp (str, "dontWait"))
3199 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3200 if (!strcmp (str, "dontReturnPackage"))
3201 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3206 static const char *ill_array_lookup(void *clientData, const char *idx)
3208 ZOOM_package p = (ZOOM_package) clientData;
3209 return ZOOM_options_get(p->options, idx+4);
3212 static Z_External *encode_ill_request(ZOOM_package p)
3214 ODR out = p->odr_out;
3217 struct ill_get_ctl ctl;
3219 ctl.odr = p->odr_out;
3221 ctl.f = ill_array_lookup;
3223 req = ill_get_ILLRequest(&ctl, "ill", 0);
3225 if (!ill_Request(out, &req, 0, 0))
3227 int ill_request_size;
3228 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3229 if (ill_request_buf)
3230 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3235 int illRequest_size = 0;
3236 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3238 r = (Z_External *) odr_malloc(out, sizeof(*r));
3239 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3240 r->indirect_reference = 0;
3242 r->which = Z_External_single;
3244 r->u.single_ASN1_type =
3245 odr_create_Odr_oct(out,
3246 (unsigned char *)illRequest_buf,
3252 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3254 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3258 req->which = Z_IOItemOrder_esRequest;
3259 req->u.esRequest = (Z_IORequest *)
3260 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3262 /* to keep part ... */
3263 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3264 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3265 req->u.esRequest->toKeep->supplDescription = 0;
3266 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3267 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3269 str = ZOOM_options_get(p->options, "contact-name");
3270 req->u.esRequest->toKeep->contact->name =
3271 odr_strdup_null(p->odr_out, str);
3273 str = ZOOM_options_get(p->options, "contact-phone");
3274 req->u.esRequest->toKeep->contact->phone =
3275 odr_strdup_null(p->odr_out, str);
3277 str = ZOOM_options_get(p->options, "contact-email");
3278 req->u.esRequest->toKeep->contact->email =
3279 odr_strdup_null(p->odr_out, str);
3281 req->u.esRequest->toKeep->addlBilling = 0;
3283 /* not to keep part ... */
3284 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3285 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3287 str = ZOOM_options_get(p->options, "itemorder-setname");
3292 req->u.esRequest->notToKeep->resultSetItem = 0;
3295 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3296 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3298 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3299 odr_strdup(p->odr_out, str);
3300 req->u.esRequest->notToKeep->resultSetItem->item =
3301 odr_intdup(p->odr_out, 0);
3303 str = ZOOM_options_get(p->options, "itemorder-item");
3304 *req->u.esRequest->notToKeep->resultSetItem->item =
3305 (str ? atoi(str) : 1);
3308 str = ZOOM_options_getl(p->options, "doc", &len);
3311 req->u.esRequest->notToKeep->itemRequest =
3312 z_ext_record_xml(p->odr_out, str, len);
3315 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3320 Z_APDU *create_admin_package(ZOOM_package p, int type,
3321 Z_ESAdminOriginPartToKeep **toKeepP,
3322 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3324 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3327 Z_ESAdminOriginPartToKeep *toKeep;
3328 Z_ESAdminOriginPartNotToKeep *notToKeep;
3329 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3330 const char *first_db = "Default";
3332 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3337 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3339 r->indirect_reference = 0;
3340 r->which = Z_External_ESAdmin;
3342 r->u.adminService = (Z_Admin *)
3343 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3344 r->u.adminService->which = Z_Admin_esRequest;
3345 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3346 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3348 toKeep = r->u.adminService->u.esRequest->toKeep =
3349 (Z_ESAdminOriginPartToKeep *)
3350 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3351 toKeep->which = type;
3352 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3353 toKeep->u.create = odr_nullval();
3354 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3356 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3357 (Z_ESAdminOriginPartNotToKeep *)
3358 odr_malloc(p->odr_out,
3359 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3360 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3361 notToKeep->u.recordsWillFollow = odr_nullval();
3365 *notToKeepP = notToKeep;
3370 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3372 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3373 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3374 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3376 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3384 req->taskSpecificParameters = ext;
3385 ext->direct_reference = req->packageType;
3386 ext->descriptor = 0;
3387 ext->indirect_reference = 0;
3389 ext->which = Z_External_octet;
3390 ext->u.single_ASN1_type =
3391 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3395 static Z_APDU *create_update_package(ZOOM_package p)
3398 const char *first_db = "Default";
3400 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3401 const char *action = ZOOM_options_get(p->options, "action");
3402 int recordIdOpaque_len;
3403 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3404 &recordIdOpaque_len);
3405 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3407 const char *record_buf = ZOOM_options_getl(p->options, "record",
3409 int recordOpaque_len;
3410 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3412 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3413 const char *version = ZOOM_options_get(p->options, "updateVersion");
3415 const char *correlationInfo_note =
3416 ZOOM_options_get(p->options, "correlationInfo.note");
3417 const char *correlationInfo_id =
3418 ZOOM_options_get(p->options, "correlationInfo.id");
3420 Odr_oid *syntax_oid = 0;
3421 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3427 if (!record_buf && !recordOpaque_buf)
3429 record_buf = "void";
3431 syntax_str = "SUTRS";
3436 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3437 CLASS_RECSYN, syntax_str,
3449 package_oid = yaz_oid_extserv_database_update_first_version;
3450 /* old update does not support specialUpdate */
3452 action = "recordInsert";
3456 action = "specialUpdate";
3457 package_oid = yaz_oid_extserv_database_update_second_version;
3461 action = "specialUpdate";
3462 package_oid = yaz_oid_extserv_database_update;
3468 if (!strcmp(action, "recordInsert"))
3469 action_no = Z_IUOriginPartToKeep_recordInsert;
3470 else if (!strcmp(action, "recordReplace"))
3471 action_no = Z_IUOriginPartToKeep_recordReplace;
3472 else if (!strcmp(action, "recordDelete"))
3473 action_no = Z_IUOriginPartToKeep_recordDelete;
3474 else if (!strcmp(action, "elementUpdate"))
3475 action_no = Z_IUOriginPartToKeep_elementUpdate;
3476 else if (!strcmp(action, "specialUpdate"))
3477 action_no = Z_IUOriginPartToKeep_specialUpdate;
3481 apdu = create_es_package(p, package_oid);
3484 Z_IUOriginPartToKeep *toKeep;
3485 Z_IUSuppliedRecords *notToKeep;
3486 Z_External *r = (Z_External *)
3487 odr_malloc(p->odr_out, sizeof(*r));
3488 const char *elementSetName =
3489 ZOOM_options_get(p->options, "elementSetName");
3491 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3493 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3495 r->which = Z_External_update;
3496 r->indirect_reference = 0;
3497 r->u.update = (Z_IUUpdate *)
3498 odr_malloc(p->odr_out, sizeof(*r->u.update));
3500 r->u.update->which = Z_IUUpdate_esRequest;
3501 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3502 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3503 toKeep = r->u.update->u.esRequest->toKeep =
3504 (Z_IUOriginPartToKeep *)
3505 odr_malloc(p->odr_out, sizeof(*toKeep));
3507 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3510 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3512 toKeep->actionQualifier = 0;
3513 toKeep->action = odr_intdup(p->odr_out, action_no);
3515 notToKeep = r->u.update->u.esRequest->notToKeep =
3516 (Z_IUSuppliedRecords *)
3517 odr_malloc(p->odr_out, sizeof(*notToKeep));
3519 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3520 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3521 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3522 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3523 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3526 notToKeep->elements[0]->u.opaque =
3527 odr_create_Odr_oct(p->odr_out,
3528 (const unsigned char *) recordIdOpaque,
3529 recordIdOpaque_len);
3531 else if (recordIdNumber)
3533 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3535 notToKeep->elements[0]->u.number =
3536 odr_intdup(p->odr_out, atoi(recordIdNumber));
3539 notToKeep->elements[0]->u.opaque = 0;
3540 notToKeep->elements[0]->supplementalId = 0;
3541 if (correlationInfo_note || correlationInfo_id)
3543 Z_IUCorrelationInfo *ci;
3544 ci = notToKeep->elements[0]->correlationInfo =
3545 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3546 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3547 ci->id = correlationInfo_id ?
3548 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3551 notToKeep->elements[0]->correlationInfo = 0;
3552 if (recordOpaque_buf)
3554 notToKeep->elements[0]->record =
3555 z_ext_record_oid_any(p->odr_out, syntax_oid,
3556 recordOpaque_buf, recordOpaque_len);
3560 notToKeep->elements[0]->record =
3561 z_ext_record_oid(p->odr_out, syntax_oid,
3562 record_buf, record_len);
3567 ODR print = odr_createmem(ODR_PRINT);
3569 z_APDU(print, &apdu, 0, 0);
3576 ZOOM_package_send(ZOOM_package p, const char *type)
3583 odr_reset(p->odr_out);
3586 if (!strcmp(type, "itemorder"))
3588 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3591 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3593 r->direct_reference =
3594 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3596 r->which = Z_External_itemOrder;
3597 r->indirect_reference = 0;
3598 r->u.itemOrder = encode_item_order(p);
3600 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3603 else if (!strcmp(type, "create")) /* create database */
3605 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3608 else if (!strcmp(type, "drop")) /* drop database */
3610 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3613 else if (!strcmp(type, "commit")) /* commit changes */
3615 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3618 else if (!strcmp(type, "update")) /* update record(s) */
3620 apdu = create_update_package(p);
3622 else if (!strcmp(type, "xmlupdate"))
3624 apdu = create_xmlupdate_package(p);
3628 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3632 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3633 task->u.package = p;
3634 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3635 p->buf_out = (char *) xmalloc(p->len_out);
3636 memcpy(p->buf_out, buf, p->len_out);
3641 while (ZOOM_event(1, &c))
3648 ZOOM_API(ZOOM_package)
3649 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3651 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3654 p->odr_out = odr_createmem(ODR_ENCODE);
3655 p->options = ZOOM_options_create_with_parent2(options, c->options);
3663 ZOOM_package_destroy(ZOOM_package p)
3668 if (p->refcount == 0)
3670 odr_destroy(p->odr_out);
3673 ZOOM_options_destroy(p->options);
3678 ZOOM_API(const char *)
3679 ZOOM_package_option_get(ZOOM_package p, const char *key)
3681 return ZOOM_options_get(p->options, key);
3684 ZOOM_API(const char *)
3685 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3687 return ZOOM_options_getl(p->options, key, lenp);
3691 ZOOM_package_option_set(ZOOM_package p, const char *key,
3694 ZOOM_options_set(p->options, key, val);
3698 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3699 const char *val, int len)
3701 ZOOM_options_setl(p->options, key, val, len);
3705 ZOOM_connection_exec_task(ZOOM_connection c)
3707 ZOOM_task task = c->tasks;
3708 zoom_ret ret = zoom_complete;
3712 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3713 c, task->which, task->running);
3714 if (c->error != ZOOM_ERROR_NONE)
3716 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3717 "removing tasks because of error = %d", c, c->error);
3718 ZOOM_connection_remove_tasks(c);
3723 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3724 "task already running", c);
3728 ret = zoom_complete;
3729 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3731 switch (task->which)
3733 case ZOOM_TASK_SEARCH:
3734 if (c->proto == PROTO_HTTP)
3735 ret = ZOOM_connection_srw_send_search(c);
3737 ret = ZOOM_connection_send_search(c);
3739 case ZOOM_TASK_RETRIEVE:
3740 if (c->proto == PROTO_HTTP)
3741 ret = ZOOM_connection_srw_send_search(c);
3743 ret = send_present(c);
3745 case ZOOM_TASK_CONNECT:
3746 ret = do_connect(c);
3748 case ZOOM_TASK_SCAN:
3749 if (c->proto == PROTO_HTTP)
3750 ret = ZOOM_connection_srw_send_scan(c);
3752 ret = ZOOM_connection_send_scan(c);
3754 case ZOOM_TASK_PACKAGE:
3755 ret = send_package(c);
3757 case ZOOM_TASK_SORT:
3758 c->tasks->u.sort.resultset->r_sort_spec =
3759 c->tasks->u.sort.q->sort_spec;
3760 ret = send_sort(c, c->tasks->u.sort.resultset);
3766 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3767 "remove tasks because no connection exist", c);
3768 ZOOM_connection_remove_tasks(c);
3770 if (ret == zoom_complete)
3772 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3773 "task removed (complete)", c);
3774 ZOOM_connection_remove_task(c);
3777 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3782 static zoom_ret send_sort_present(ZOOM_connection c)
3784 zoom_ret r = zoom_complete;
3786 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3787 r = send_sort(c, c->tasks->u.search.resultset);
3788 if (r == zoom_complete)
3789 r = send_present(c);
3793 static int es_response_taskpackage_update(ZOOM_connection c,
3794 Z_IUUpdateTaskPackage *utp)
3796 if (utp && utp->targetPart)
3798 Z_IUTargetPart *targetPart = utp->targetPart;
3799 switch ( *targetPart->updateStatus ) {
3800 case Z_IUTargetPart_success:
3801 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3803 case Z_IUTargetPart_partial:
3804 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3806 case Z_IUTargetPart_failure:
3807 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3808 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3809 response_diag(c, targetPart->globalDiagnostics[0]);
3812 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3817 static int es_response_taskpackage(ZOOM_connection c,
3818 Z_TaskPackage *taskPackage)
3821 Odr_oct *id = taskPackage->targetReference;
3823 ZOOM_options_setl(c->tasks->u.package->options,
3824 "targetReference", (char*) id->buf, id->len);
3827 switch ( *taskPackage->taskStatus ) {
3828 case Z_TaskPackage_pending:
3829 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3831 case Z_TaskPackage_active:
3832 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3834 case Z_TaskPackage_complete:
3835 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3837 case Z_TaskPackage_aborted:
3838 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3839 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3840 response_diag(c, taskPackage->packageDiagnostics[0]);
3844 // taskSpecificParameters
3845 // NOTE: Only Update implemented, no others.
3846 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3847 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3848 es_response_taskpackage_update(c, utp);
3854 static int es_response(ZOOM_connection c,
3855 Z_ExtendedServicesResponse *res)
3857 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3859 switch (*res->operationStatus) {
3860 case Z_ExtendedServicesResponse_done:
3861 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3863 case Z_ExtendedServicesResponse_accepted:
3864 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3866 case Z_ExtendedServicesResponse_failure:
3867 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3868 if (res->diagnostics && res->num_diagnostics > 0)
3869 response_diag(c, res->diagnostics[0]);
3872 if (res->taskPackage &&
3873 res->taskPackage->which == Z_External_extendedService)
3875 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3876 es_response_taskpackage(c, taskPackage);
3878 if (res->taskPackage &&
3879 res->taskPackage->which == Z_External_octet)
3881 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3882 ZOOM_options_setl(c->tasks->u.package->options,
3883 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3888 static void interpret_init_diag(ZOOM_connection c,
3889 Z_DiagnosticFormat *diag)
3893 Z_DiagnosticFormat_s *ds = diag->elements[0];
3894 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3895 response_default_diag(c, ds->u.defaultDiagRec);
3900 static void interpret_otherinformation_field(ZOOM_connection c,
3901 Z_OtherInformation *ui)
3904 for (i = 0; i < ui->num_elements; i++)
3906 Z_OtherInformationUnit *unit = ui->list[i];
3907 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3908 unit->information.externallyDefinedInfo &&
3909 unit->information.externallyDefinedInfo->which ==
3912 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3918 static void set_init_option(const char *name, void *clientData) {
3919 ZOOM_connection c = (ZOOM_connection) clientData;
3922 sprintf(buf, "init_opt_%.70s", name);
3923 ZOOM_connection_option_set(c, buf, "1");
3927 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3929 Z_InitResponse *initrs;
3931 ZOOM_connection_set_mask(c, 0);
3932 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3935 case Z_APDU_initResponse:
3936 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3937 initrs = apdu->u.initResponse;
3938 ZOOM_connection_option_set(c, "serverImplementationId",
3939 initrs->implementationId ?
3940 initrs->implementationId : "");
3941 ZOOM_connection_option_set(c, "serverImplementationName",
3942 initrs->implementationName ?
3943 initrs->implementationName : "");
3944 ZOOM_connection_option_set(c, "serverImplementationVersion",
3945 initrs->implementationVersion ?
3946 initrs->implementationVersion : "");
3947 /* Set the three old options too, for old applications */
3948 ZOOM_connection_option_set(c, "targetImplementationId",
3949 initrs->implementationId ?
3950 initrs->implementationId : "");
3951 ZOOM_connection_option_set(c, "targetImplementationName",
3952 initrs->implementationName ?
3953 initrs->implementationName : "");
3954 ZOOM_connection_option_set(c, "targetImplementationVersion",
3955 initrs->implementationVersion ?
3956 initrs->implementationVersion : "");
3958 /* Make initrs->options available as ZOOM-level options */
3959 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3961 if (!*initrs->result)
3963 Z_External *uif = initrs->userInformationField;
3965 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3967 if (uif && uif->which == Z_External_userInfo1)
3968 interpret_otherinformation_field(c, uif->u.userInfo1);
3973 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3974 yaz_oid_userinfo_cookie, 1, 0);
3975 xfree(c->cookie_in);
3978 c->cookie_in = xstrdup(cookie);
3979 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3980 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3981 c->support_named_resultsets = 1;
3984 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3985 ZOOM_connection_remove_task(c);
3987 ZOOM_connection_exec_task(c);
3989 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3991 NMEM tmpmem = nmem_create();
3992 Z_CharSetandLanguageNegotiation *p =
3993 yaz_get_charneg_record(initrs->otherInfo);
3997 char *charset = NULL, *lang = NULL;
4000 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
4001 yaz_log(log_details, "%p recv_apdu target accepted: "
4002 "charset %s, language %s, select %d",
4004 charset ? charset : "none", lang ? lang : "none", sel);
4006 ZOOM_connection_option_set(c, "negotiation-charset",
4009 ZOOM_connection_option_set(c, "negotiation-lang",
4012 ZOOM_connection_option_set(
4013 c, "negotiation-charset-in-effect-for-records",
4014 (sel != 0) ? "1" : "0");
4015 nmem_destroy(tmpmem);
4019 case Z_APDU_searchResponse:
4020 yaz_log(log_api, "%p recv_apdu Search response", c);
4021 handle_search_response(c, apdu->u.searchResponse);
4022 if (send_sort_present(c) == zoom_complete)
4023 ZOOM_connection_remove_task(c);
4025 case Z_APDU_presentResponse:
4026 yaz_log(log_api, "%p recv_apdu Present response", c);
4027 handle_present_response(c, apdu->u.presentResponse);
4028 if (send_present(c) == zoom_complete)
4029 ZOOM_connection_remove_task(c);
4031 case Z_APDU_sortResponse:
4032 yaz_log(log_api, "%p recv_apdu Sort response", c);
4033 sort_response(c, apdu->u.sortResponse);
4034 if (send_present(c) == zoom_complete)
4035 ZOOM_connection_remove_task(c);
4037 case Z_APDU_scanResponse:
4038 yaz_log(log_api, "%p recv_apdu Scan response", c);
4039 scan_response(c, apdu->u.scanResponse);
4040 ZOOM_connection_remove_task(c);
4042 case Z_APDU_extendedServicesResponse:
4043 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
4044 es_response(c, apdu->u.extendedServicesResponse);
4045 ZOOM_connection_remove_task(c);
4048 yaz_log(log_api, "%p recv_apdu Close PDU", c);
4049 if (!ZOOM_test_reconnect(c))
4051 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4056 yaz_log(log_api, "%p Received unknown PDU", c);
4057 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4063 static zoom_ret handle_srw_response(ZOOM_connection c,
4064 Z_SRW_searchRetrieveResponse *res)
4066 ZOOM_resultset resultset = 0;
4071 const char *syntax, *elementSetName;
4074 return zoom_complete;
4076 switch(c->tasks->which)
4078 case ZOOM_TASK_SEARCH:
4079 resultset = c->tasks->u.search.resultset;
4080 start = &c->tasks->u.search.start;
4081 count = &c->tasks->u.search.count;
4082 syntax = c->tasks->u.search.syntax;
4083 elementSetName = c->tasks->u.search.elementSetName;
4085 if (!c->tasks->u.search.recv_search_fired)
4087 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4088 ZOOM_connection_put_event(c, event);
4089 c->tasks->u.search.recv_search_fired = 1;
4092 case ZOOM_TASK_RETRIEVE:
4093 resultset = c->tasks->u.retrieve.resultset;
4094 start = &c->tasks->u.retrieve.start;
4095 count = &c->tasks->u.retrieve.count;
4096 syntax = c->tasks->u.retrieve.syntax;
4097 elementSetName = c->tasks->u.retrieve.elementSetName;
4100 return zoom_complete;
4103 resultset->size = 0;
4105 if (res->resultSetId)
4106 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4108 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4110 if (res->num_diagnostics > 0)
4112 set_SRU_error(c, &res->diagnostics[0]);
4116 if (res->numberOfRecords)
4117 resultset->size = *res->numberOfRecords;
4118 for (i = 0; i<res->num_records; i++)
4121 Z_SRW_record *sru_rec;
4122 Z_SRW_diagnostic *diag = 0;
4125 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4126 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4128 if (res->records[i].recordPosition &&
4129 *res->records[i].recordPosition > 0)
4130 pos = *res->records[i].recordPosition - 1;
4134 sru_rec = &res->records[i];
4136 npr->databaseName = 0;
4137 npr->which = Z_NamePlusRecord_databaseRecord;
4138 npr->u.databaseRecord = (Z_External *)
4139 odr_malloc(c->odr_in, sizeof(Z_External));
4140 npr->u.databaseRecord->descriptor = 0;
4141 npr->u.databaseRecord->direct_reference =
4142 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4143 npr->u.databaseRecord->which = Z_External_octet;
4145 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4146 odr_malloc(c->odr_in, sizeof(Odr_oct));
4147 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4148 sru_rec->recordData_buf;
4149 npr->u.databaseRecord->u.octet_aligned->len =
4150 npr->u.databaseRecord->u.octet_aligned->size =
4151 sru_rec->recordData_len;
4153 if (sru_rec->recordSchema
4154 && !strcmp(sru_rec->recordSchema,
4155 "info:srw/schema/1/diagnostics-v1.1"))
4157 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4158 sru_rec->recordData_len,
4162 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4163 sru_rec->recordSchema, diag);
4167 if (*count + *start > resultset->size)
4168 *count = resultset->size - *start;
4172 nmem = odr_extract_mem(c->odr_in);
4173 nmem_transfer(odr_getmem(resultset->odr), nmem);
4177 return ZOOM_connection_srw_send_search(c);
4179 return zoom_complete;
4184 static void handle_srw_scan_response(ZOOM_connection c,
4185 Z_SRW_scanResponse *res)
4187 NMEM nmem = odr_extract_mem(c->odr_in);
4190 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4192 scan = c->tasks->u.scan.scan;
4194 if (res->num_diagnostics > 0)
4195 set_SRU_error(c, &res->diagnostics[0]);
4197 scan->scan_response = 0;
4198 scan->srw_scan_response = res;
4199 nmem_transfer(odr_getmem(scan->odr), nmem);
4201 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4207 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
4209 Z_GDU *p = z_get_HTTP_Request(odr);
4210 const char *host = url;
4211 const char *cp0 = strstr(host, "://");
4212 const char *cp1 = 0;
4218 cp1 = strchr(cp0, '/');
4220 cp1 = cp0 + strlen(cp0);
4224 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
4225 memcpy (h, cp0, cp1 - cp0);
4227 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
4229 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
4233 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
4234 Z_HTTP_Response *cookie_hres)
4236 struct Z_HTTP_Header *h;
4237 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
4239 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
4240 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
4243 for (h = cookie_hres->headers; h; h = h->next)
4245 if (!strcmp(h->name, "Set-Cookie"))
4246 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
4247 "Cookie", h->value);
4249 if (c->user && c->password)
4251 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
4252 c->user, c->password);
4254 if (!z_GDU(c->odr_out, &gdu, 0, 0))
4255 return zoom_complete;
4257 z_GDU(c->odr_print, &gdu, 0, 0);
4258 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
4260 odr_reset(c->odr_out);
4264 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4266 zoom_ret cret = zoom_complete;
4268 const char *addinfo = 0;
4269 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4271 const char *location;
4273 ZOOM_connection_set_mask(c, 0);
4274 yaz_log(log_details, "%p handle_http", c);
4276 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
4277 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
4280 if (c->no_redirects > 10)
4282 set_HTTP_error(c, hres->code, 0, 0);
4283 c->no_redirects = 0;
4288 /* since redirect may change host we just reconnect. A smarter
4289 implementation might check whether it's the same server */
4290 do_connect_host(c, location, 0);
4291 send_SRW_redirect(c, location, hres);
4292 /* we're OK for now. Operation is not really complete */
4294 cret = zoom_pending;
4298 { /* not redirect (normal response) */
4299 if (!yaz_srw_check_content_type(hres))
4300 addinfo = "content-type";
4303 Z_SOAP *soap_package = 0;
4305 Z_SOAP_Handler soap_handlers[2] = {
4306 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4309 ret = z_soap_codec(o, &soap_package,
4310 &hres->content_buf, &hres->content_len,
4312 if (!ret && soap_package->which == Z_SOAP_generic &&
4313 soap_package->u.generic->no == 0)
4315 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4317 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4318 ZOOM_options_setl(c->options, "sru_extra_response_data",
4319 sr->extraResponseData_buf, sr->extraResponseData_len);
4320 if (sr->which == Z_SRW_searchRetrieve_response)
4321 cret = handle_srw_response(c, sr->u.response);
4322 else if (sr->which == Z_SRW_scan_response)
4323 handle_srw_scan_response(c, sr->u.scan_response);
4327 else if (!ret && (soap_package->which == Z_SOAP_fault
4328 || soap_package->which == Z_SOAP_error))
4330 set_HTTP_error(c, hres->code,
4331 soap_package->u.fault->fault_code,
4332 soap_package->u.fault->fault_string);
4339 if (c->no_redirects) /* end of redirect. change hosts again */
4342 c->no_redirects = 0;
4346 if (hres->code != 200)
4347 set_HTTP_error(c, hres->code, 0, 0);
4349 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4352 if (cret == zoom_complete)
4353 ZOOM_connection_remove_task(c);
4354 if (!strcmp(hres->version, "1.0"))
4356 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4357 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4362 /* HTTP 1.1: only if no close we stay alive .. */
4363 if (connection_head && !strcmp(connection_head, "close"))
4369 static int do_read(ZOOM_connection c)
4374 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4375 ZOOM_connection_put_event(c, event);
4377 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4378 more = cs_more(c->cs);
4379 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4384 if (!ZOOM_test_reconnect(c))
4386 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4395 odr_reset(c->odr_in);
4396 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4397 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4398 ZOOM_connection_put_event(c, event);
4400 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4403 int err = odr_geterrorx(c->odr_in, &x);
4405 const char *element = odr_getelement(c->odr_in);
4406 yaz_snprintf(msg, sizeof(msg),
4407 "ODR code %d:%d element=%s offset=%d",
4408 err, x, element ? element : "<unknown>",
4409 odr_offset(c->odr_in));
4410 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4413 FILE *ber_file = yaz_log_file();
4415 odr_dumpBER(ber_file, c->buf_in, r);
4422 z_GDU(c->odr_print, &gdu, 0, 0);
4423 if (gdu->which == Z_GDU_Z3950)
4424 recv_apdu(c, gdu->u.z3950);
4425 else if (gdu->which == Z_GDU_HTTP_Response)
4428 handle_http(c, gdu->u.HTTP_Response);
4430 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4435 c->reconnect_ok = 0;
4440 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4445 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4446 ZOOM_connection_put_event(c, event);
4448 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4449 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4451 yaz_log(log_details, "%p do_write_ex write failed", c);
4452 if (ZOOM_test_reconnect(c))
4454 return zoom_pending;
4456 if (c->state == STATE_CONNECTING)
4457 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4459 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4461 return zoom_complete;
4465 int mask = ZOOM_SELECT_EXCEPT;
4466 if (c->cs->io_pending & CS_WANT_WRITE)
4467 mask += ZOOM_SELECT_WRITE;
4468 if (c->cs->io_pending & CS_WANT_READ)
4469 mask += ZOOM_SELECT_READ;
4470 ZOOM_connection_set_mask(c, mask);
4471 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4476 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4477 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4480 return zoom_pending;
4483 static zoom_ret do_write(ZOOM_connection c)
4485 return do_write_ex(c, c->buf_out, c->len_out);
4489 ZOOM_API(const char *)
4490 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4492 return ZOOM_options_get(c->options, key);
4495 ZOOM_API(const char *)
4496 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4498 return ZOOM_options_getl(c->options, key, lenp);
4502 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4505 ZOOM_options_set(c->options, key, val);
4509 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4510 const char *val, int len)
4512 ZOOM_options_setl(c->options, key, val, len);
4515 ZOOM_API(const char *)
4516 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4518 return ZOOM_options_get(r->options, key);
4522 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4525 ZOOM_options_set(r->options, key, val);
4530 ZOOM_connection_errcode(ZOOM_connection c)
4532 return ZOOM_connection_error(c, 0, 0);
4535 ZOOM_API(const char *)
4536 ZOOM_connection_errmsg(ZOOM_connection c)
4539 ZOOM_connection_error(c, &msg, 0);
4543 ZOOM_API(const char *)
4544 ZOOM_connection_addinfo(ZOOM_connection c)
4546 const char *addinfo;
4547 ZOOM_connection_error(c, 0, &addinfo);
4551 ZOOM_API(const char *)
4552 ZOOM_connection_diagset(ZOOM_connection c)
4554 const char *diagset;
4555 ZOOM_connection_error_x(c, 0, 0, &diagset);
4559 ZOOM_API(const char *)
4560 ZOOM_diag_str(int error)
4564 case ZOOM_ERROR_NONE:
4566 case ZOOM_ERROR_CONNECT:
4567 return "Connect failed";
4568 case ZOOM_ERROR_MEMORY:
4569 return "Out of memory";
4570 case ZOOM_ERROR_ENCODE:
4571 return "Encoding failed";
4572 case ZOOM_ERROR_DECODE:
4573 return "Decoding failed";
4574 case ZOOM_ERROR_CONNECTION_LOST:
4575 return "Connection lost";
4576 case ZOOM_ERROR_INIT:
4577 return "Init rejected";
4578 case ZOOM_ERROR_INTERNAL:
4579 return "Internal failure";
4580 case ZOOM_ERROR_TIMEOUT:
4582 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4583 return "Unsupported protocol";
4584 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4585 return "Unsupported query type";
4586 case ZOOM_ERROR_INVALID_QUERY:
4587 return "Invalid query";
4588 case ZOOM_ERROR_CQL_PARSE:
4589 return "CQL parsing error";
4590 case ZOOM_ERROR_CQL_TRANSFORM:
4591 return "CQL transformation error";
4592 case ZOOM_ERROR_CCL_CONFIG:
4593 return "CCL configuration error";
4594 case ZOOM_ERROR_CCL_PARSE:
4595 return "CCL parsing error";
4597 return diagbib1_str(error);
4602 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4603 const char **addinfo, const char **diagset)
4605 int error = c->error;
4608 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4609 *cp = ZOOM_diag_str(error);
4610 else if (!strcmp(c->diagset, "HTTP"))
4611 *cp = z_HTTP_errmsg(c->error);
4612 else if (!strcmp(c->diagset, "Bib-1"))
4613 *cp = ZOOM_diag_str(error);
4614 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4615 *cp = yaz_diag_srw_str(c->error);
4617 *cp = "Unknown error and diagnostic set";
4620 *addinfo = c->addinfo ? c->addinfo : "";
4622 *diagset = c->diagset ? c->diagset : "";
4627 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4628 const char **addinfo)
4630 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4633 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4635 ZOOM_Event event = 0;
4636 int r = cs_look(c->cs);
4637 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4642 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4643 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4645 ZOOM_connection_put_event(c, event);
4647 else if (r == CS_CONNECT)
4649 int ret = ret = cs_rcvconnect(c->cs);
4650 yaz_log(log_details, "%p ZOOM_connection_do_io "
4651 "cs_rcvconnect returned %d", c, ret);
4654 int mask = ZOOM_SELECT_EXCEPT;
4655 if (c->cs->io_pending & CS_WANT_WRITE)
4656 mask += ZOOM_SELECT_WRITE;
4657 if (c->cs->io_pending & CS_WANT_READ)
4658 mask += ZOOM_SELECT_READ;
4659 ZOOM_connection_set_mask(c, mask);
4660 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4661 ZOOM_connection_put_event(c, event);
4665 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4666 ZOOM_connection_put_event(c, event);
4668 if (c->proto == PROTO_Z3950)
4669 ZOOM_connection_send_init(c);
4672 /* no init request for SRW .. */
4673 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4674 ZOOM_connection_remove_task(c);
4675 ZOOM_connection_set_mask(c, 0);
4676 ZOOM_connection_exec_task(c);
4678 c->state = STATE_ESTABLISHED;
4682 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4688 if (mask & ZOOM_SELECT_EXCEPT)
4690 if (!ZOOM_test_reconnect(c))
4692 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4697 if (mask & ZOOM_SELECT_READ)
4699 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4705 ZOOM_connection_last_event(ZOOM_connection cs)
4708 return ZOOM_EVENT_NONE;
4709 return cs->last_event;
4713 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4715 WRBUF wrbuf = (WRBUF) client_data;
4716 wrbuf_puts(wrbuf, buf);
4720 * Returns an xmalloc()d string containing RPN that corresponds to the
4721 * CQL passed in. On error, sets the Connection object's error state
4722 * and returns a null pointer.
4723 * ### We could cache CQL parser and/or transformer in Connection.
4725 static char *cql2pqf(ZOOM_connection c, const char *cql)
4729 const char *cqlfile;
4730 cql_transform_t trans;
4733 parser = cql_parser_create();
4734 if ((error = cql_parser_string(parser, cql)) != 0) {
4735 cql_parser_destroy(parser);
4736 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4740 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4743 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4745 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4748 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4749 cqlfile, strerror(errno));
4750 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4754 WRBUF wrbuf_result = wrbuf_alloc();
4755 error = cql_transform(trans, cql_parser_result(parser),
4756 cql2pqf_wrbuf_puts, wrbuf_result);
4759 const char *addinfo;
4760 error = cql_transform_error(trans, &addinfo);
4761 sprintf(buf, "%.200s (addinfo=%.200s)",
4762 cql_strerror(error), addinfo);
4763 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4767 result = xstrdup(wrbuf_cstr(wrbuf_result));
4769 cql_transform_close(trans);
4770 wrbuf_destroy(wrbuf_result);
4772 cql_parser_destroy(parser);
4776 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4780 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4781 /* timeout and this connection was waiting */
4782 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4784 ZOOM_connection_put_event(c, event);
4790 ZOOM_connection_process(ZOOM_connection c)
4796 event = ZOOM_connection_get_event(c);
4799 ZOOM_Event_destroy(event);
4802 ZOOM_connection_exec_task(c);
4803 event = ZOOM_connection_get_event(c);
4806 ZOOM_Event_destroy(event);
4813 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4817 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4819 for (i = 0; i<no; i++)
4821 ZOOM_connection c = cs[i];
4823 if (c && ZOOM_connection_process(c))
4829 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4831 if (c->mask && mask)
4832 ZOOM_connection_do_io(c, mask);
4836 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4839 return cs_fileno(c->cs);
4843 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4851 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4858 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4860 return ZOOM_options_get_int(c->options, "timeout", 30);
4863 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
4871 * c-file-style: "Stroustrup"
4872 * indent-tabs-mode: nil
4874 * vim: shiftwidth=4 tabstop=8 expandtab