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 yaz_log(YLOG_LOG, "format=1");
2152 /* try to XML format res */
2154 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2155 doc = xmlParseMemory(res, *len);
2160 xmlDocDumpFormatMemory(doc, &xml_mem, &xml_size, 1);
2161 wrbuf_rewind(wrbuf);
2162 wrbuf_write(wrbuf, (const char *) xml_mem, xml_size);
2165 res = wrbuf_cstr(wrbuf);
2166 *len = wrbuf_len(wrbuf);
2174 static const char *npr_format(Z_NamePlusRecord *npr, const char *schema,
2176 const char *type_spec, int *len)
2182 const char *cp = type_spec;
2184 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2192 while (cp[i] == ' ')
2197 while (cp[i] == ' ')
2199 if (!strncmp(cp + i, "charset=", 8))
2202 i = i + 8; /* skip charset= */
2203 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2205 if (j < sizeof(charset)-1)
2206 charset[j++] = cp[i];
2210 else if (!strncmp(cp + i, "format=", 7))
2214 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2216 if (j < sizeof(format)-1)
2217 format[j++] = cp[i];
2222 if (!strcmp(type, "database"))
2225 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2226 return npr->databaseName;
2228 else if (!strcmp(type, "schema"))
2231 *len = schema ? strlen(schema) : 0;
2234 else if (!strcmp(type, "syntax"))
2236 const char *desc = 0;
2237 if (npr->which == Z_NamePlusRecord_databaseRecord)
2239 Z_External *r = (Z_External *) npr->u.databaseRecord;
2240 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2245 *len = strlen(desc);
2248 if (npr->which != Z_NamePlusRecord_databaseRecord)
2251 /* from now on - we have a database record .. */
2252 if (!strcmp(type, "render"))
2254 return get_record_format(wrbuf, len, npr, YAZ_MARC_LINE, charset, format);
2256 else if (!strcmp(type, "xml"))
2258 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2261 else if (!strcmp(type, "txml"))
2263 return get_record_format(wrbuf, len, npr, YAZ_MARC_TURBOMARC, charset,
2266 else if (!strcmp(type, "raw"))
2268 return get_record_format(wrbuf, len, npr, YAZ_MARC_ISO2709, charset,
2271 else if (!strcmp(type, "ext"))
2274 return (const char *) npr->u.databaseRecord;
2276 else if (!strcmp(type, "opac"))
2278 if (npr->u.databaseRecord->which == Z_External_OPAC)
2279 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2285 ZOOM_API(const char *)
2286 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2291 *len = 0; /* default return */
2293 if (!rec || !rec->npr)
2297 if (!rec->record_wrbuf)
2299 WRBUF w = wrbuf_alloc();
2300 YAZ_SHPTR_INIT(rec->record_wrbuf, w);
2302 wrbuf = rec->record_wrbuf->ptr;
2305 rec->wrbuf = wrbuf_alloc();
2308 return npr_format(rec->npr, rec->schema, wrbuf, type_spec, len);
2311 static int strcmp_null(const char *v1, const char *v2)
2317 return strcmp(v1, v2);
2320 static size_t record_hash(int pos)
2324 return pos % RECORD_HASH_SIZE;
2327 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2329 const char *syntax, const char *elementSetName,
2331 Z_SRW_diagnostic *diag)
2333 ZOOM_record_cache rc = 0;
2335 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2336 ZOOM_connection_put_event(r->connection, event);
2338 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2341 && strcmp_null(r->schema, rc->schema) == 0
2342 && strcmp_null(elementSetName,rc->elementSetName) == 0
2343 && strcmp_null(syntax, rc->syntax) == 0)
2348 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2351 YAZ_SHPTR_INC(r->record_wrbuf);
2352 rc->rec.record_wrbuf = r->record_wrbuf;
2356 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2358 rc->syntax = odr_strdup_null(r->odr, syntax);
2360 rc->schema = odr_strdup_null(r->odr, r->schema);
2363 rc->next = r->record_hash[record_hash(pos)];
2364 r->record_hash[record_hash(pos)] = rc;
2367 rc->rec.schema = odr_strdup_null(r->odr, schema);
2368 rc->rec.diag_set = 0;
2369 rc->rec.diag_uri = 0;
2370 rc->rec.diag_message = 0;
2371 rc->rec.diag_details = 0;
2377 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2378 if ((cp = strrchr(rc->rec.diag_set, '/')))
2380 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2382 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2383 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2387 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2389 const char *elementSetName)
2391 ZOOM_record_cache rc;
2393 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2397 if (strcmp_null(r->schema, rc->schema))
2399 if (strcmp_null(elementSetName,rc->elementSetName))
2401 if (strcmp_null(syntax, rc->syntax))
2409 static void handle_records(ZOOM_connection c, Z_Records *sr,
2412 ZOOM_resultset resultset;
2414 const char *syntax = 0, *elementSetName = 0;
2418 switch (c->tasks->which)
2420 case ZOOM_TASK_SEARCH:
2421 resultset = c->tasks->u.search.resultset;
2422 start = &c->tasks->u.search.start;
2423 count = &c->tasks->u.search.count;
2424 syntax = c->tasks->u.search.syntax;
2425 elementSetName = c->tasks->u.search.elementSetName;
2427 case ZOOM_TASK_RETRIEVE:
2428 resultset = c->tasks->u.retrieve.resultset;
2429 start = &c->tasks->u.retrieve.start;
2430 count = &c->tasks->u.retrieve.count;
2431 syntax = c->tasks->u.retrieve.syntax;
2432 elementSetName = c->tasks->u.retrieve.elementSetName;
2437 if (sr && sr->which == Z_Records_NSD)
2438 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2439 else if (sr && sr->which == Z_Records_multipleNSD)
2441 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2442 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2444 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2448 if (*count + *start > resultset->size)
2449 *count = resultset->size - *start;
2452 if (sr && sr->which == Z_Records_DBOSD)
2455 NMEM nmem = odr_extract_mem(c->odr_in);
2456 Z_NamePlusRecordList *p =
2457 sr->u.databaseOrSurDiagnostics;
2458 for (i = 0; i<p->num_records; i++)
2460 record_cache_add(resultset, p->records[i], i + *start,
2461 syntax, elementSetName,
2468 yaz_log(log_details,
2469 "handle_records resultset=%p start=%d count=%d",
2470 resultset, *start, *count);
2472 /* transfer our response to search_nmem .. we need it later */
2473 nmem_transfer(odr_getmem(resultset->odr), nmem);
2475 if (present_phase && p->num_records == 0)
2477 /* present response and we didn't get any records! */
2478 Z_NamePlusRecord *myrec =
2479 zget_surrogateDiagRec(
2481 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2482 "ZOOM C generated. Present phase and no records");
2483 record_cache_add(resultset, myrec, *start,
2484 syntax, elementSetName, 0, 0);
2487 else if (present_phase)
2489 /* present response and we didn't get any records! */
2490 Z_NamePlusRecord *myrec =
2491 zget_surrogateDiagRec(
2493 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2494 "ZOOM C generated: Present response and no records");
2495 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2501 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2503 handle_records(c, pr->records, 1);
2506 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2509 switch (term->which)
2511 case Z_Term_general:
2512 ZOOM_options_setl(opt, name,
2513 (const char *)(term->u.general->buf),
2514 term->u.general->len);
2516 case Z_Term_characterString:
2517 ZOOM_options_set(opt, name, term->u.characterString);
2519 case Z_Term_numeric:
2520 ZOOM_options_set_int(opt, name, *term->u.numeric);
2525 static void handle_queryExpression(ZOOM_options opt, const char *name,
2526 Z_QueryExpression *exp)
2532 case Z_QueryExpression_term:
2533 if (exp->u.term && exp->u.term->queryTerm)
2535 sprintf(opt_name, "%s.term", name);
2536 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2539 case Z_QueryExpression_query:
2544 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2545 Z_OtherInformation *o)
2548 for (i = 0; o && i < o->num_elements; i++)
2550 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2552 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2554 if (ext->which == Z_External_searchResult1)
2557 Z_SearchInfoReport *sr = ext->u.searchResult1;
2560 ZOOM_options_set_int(
2561 resultset->options, "searchresult.size", sr->num);
2563 for (j = 0; j < sr->num; j++)
2565 Z_SearchInfoReport_s *ent =
2566 ext->u.searchResult1->elements[j];
2569 sprintf(pref, "searchresult.%d", j);
2571 if (ent->subqueryId)
2574 sprintf(opt_name, "%s.id", pref);
2575 ZOOM_options_set(resultset->options, opt_name,
2578 if (ent->subqueryExpression)
2581 sprintf(opt_name, "%s.subquery", pref);
2582 handle_queryExpression(resultset->options, opt_name,
2583 ent->subqueryExpression);
2585 if (ent->subqueryInterpretation)
2588 sprintf(opt_name, "%s.interpretation", pref);
2589 handle_queryExpression(resultset->options, opt_name,
2590 ent->subqueryInterpretation);
2592 if (ent->subqueryRecommendation)
2595 sprintf(opt_name, "%s.recommendation", pref);
2596 handle_queryExpression(resultset->options, opt_name,
2597 ent->subqueryRecommendation);
2599 if (ent->subqueryCount)
2602 sprintf(opt_name, "%s.count", pref);
2603 ZOOM_options_set_int(resultset->options, opt_name,
2604 *ent->subqueryCount);
2612 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2614 ZOOM_resultset resultset;
2617 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2620 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2621 ZOOM_connection_put_event(c, event);
2623 resultset = c->tasks->u.search.resultset;
2625 if (sr->resultSetStatus)
2627 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2628 *sr->resultSetStatus);
2630 if (sr->presentStatus)
2632 ZOOM_options_set_int(resultset->options, "presentStatus",
2633 *sr->presentStatus);
2635 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2637 resultset->size = *sr->resultCount;
2638 handle_records(c, sr->records, 0);
2641 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2643 if (res->diagnostics && res->num_diagnostics > 0)
2644 response_diag(c, res->diagnostics[0]);
2647 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2649 NMEM nmem = odr_extract_mem(c->odr_in);
2652 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2654 scan = c->tasks->u.scan.scan;
2656 if (res->entries && res->entries->nonsurrogateDiagnostics)
2657 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2658 scan->scan_response = res;
2659 scan->srw_scan_response = 0;
2660 nmem_transfer(odr_getmem(scan->odr), nmem);
2662 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2663 if (res->positionOfTerm)
2664 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2665 if (res->scanStatus)
2666 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2667 if (res->numberOfEntriesReturned)
2668 ZOOM_options_set_int(scan->options, "number",
2669 *res->numberOfEntriesReturned);
2674 static zoom_ret send_sort(ZOOM_connection c,
2675 ZOOM_resultset resultset)
2678 resultset->r_sort_spec = 0;
2679 if (resultset->r_sort_spec)
2681 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2682 Z_SortRequest *req = apdu->u.sortRequest;
2684 req->num_inputResultSetNames = 1;
2685 req->inputResultSetNames = (Z_InternationalString **)
2686 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2687 req->inputResultSetNames[0] =
2688 odr_strdup(c->odr_out, resultset->setname);
2689 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2690 req->sortSequence = resultset->r_sort_spec;
2691 resultset->r_sort_spec = 0;
2692 return send_APDU(c, apdu);
2694 return zoom_complete;
2697 static zoom_ret send_present(ZOOM_connection c)
2700 Z_PresentRequest *req = 0;
2702 const char *syntax = 0;
2703 const char *elementSetName = 0;
2704 ZOOM_resultset resultset;
2709 yaz_log(log_details, "%p send_present no tasks", c);
2710 return zoom_complete;
2713 switch (c->tasks->which)
2715 case ZOOM_TASK_SEARCH:
2716 resultset = c->tasks->u.search.resultset;
2717 start = &c->tasks->u.search.start;
2718 count = &c->tasks->u.search.count;
2719 syntax = c->tasks->u.search.syntax;
2720 elementSetName = c->tasks->u.search.elementSetName;
2722 case ZOOM_TASK_RETRIEVE:
2723 resultset = c->tasks->u.retrieve.resultset;
2724 start = &c->tasks->u.retrieve.start;
2725 count = &c->tasks->u.retrieve.count;
2726 syntax = c->tasks->u.retrieve.syntax;
2727 elementSetName = c->tasks->u.retrieve.elementSetName;
2730 return zoom_complete;
2732 yaz_log(log_details, "%p send_present start=%d count=%d",
2735 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2737 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2740 if (c->error) /* don't continue on error */
2741 return zoom_complete;
2742 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2743 resultset, *start, *count);
2745 for (i = 0; i < *count; i++)
2748 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2753 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2754 ZOOM_connection_put_event(c, event);
2762 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2763 return zoom_complete;
2766 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2767 req = apdu->u.presentRequest;
2770 yaz_log(log_details, "%p send_present skip=%d", c, i);
2772 *req->resultSetStartPoint = *start + 1;
2774 if (resultset->step > 0 && resultset->step < *count)
2775 *req->numberOfRecordsRequested = resultset->step;
2777 *req->numberOfRecordsRequested = *count;
2779 if (*req->numberOfRecordsRequested + *start > resultset->size)
2780 *req->numberOfRecordsRequested = resultset->size - *start;
2781 assert(*req->numberOfRecordsRequested > 0);
2783 if (syntax && *syntax)
2784 req->preferredRecordSyntax =
2785 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2787 if (resultset->schema && *resultset->schema)
2789 Z_RecordComposition *compo = (Z_RecordComposition *)
2790 odr_malloc(c->odr_out, sizeof(*compo));
2792 req->recordComposition = compo;
2793 compo->which = Z_RecordComp_complex;
2794 compo->u.complex = (Z_CompSpec *)
2795 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2796 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2797 odr_malloc(c->odr_out, sizeof(bool_t));
2798 *compo->u.complex->selectAlternativeSyntax = 0;
2800 compo->u.complex->generic = (Z_Specification *)
2801 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2803 compo->u.complex->generic->which = Z_Schema_oid;
2804 compo->u.complex->generic->schema.oid = (Odr_oid *)
2805 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2807 if (!compo->u.complex->generic->schema.oid)
2809 /* OID wasn't a schema! Try record syntax instead. */
2811 compo->u.complex->generic->schema.oid = (Odr_oid *)
2812 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2814 if (elementSetName && *elementSetName)
2816 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2817 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2818 compo->u.complex->generic->elementSpec->which =
2819 Z_ElementSpec_elementSetName;
2820 compo->u.complex->generic->elementSpec->u.elementSetName =
2821 odr_strdup(c->odr_out, elementSetName);
2824 compo->u.complex->generic->elementSpec = 0;
2825 compo->u.complex->num_dbSpecific = 0;
2826 compo->u.complex->dbSpecific = 0;
2827 compo->u.complex->num_recordSyntax = 0;
2828 compo->u.complex->recordSyntax = 0;
2830 else if (elementSetName && *elementSetName)
2832 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2833 odr_malloc(c->odr_out, sizeof(*esn));
2834 Z_RecordComposition *compo = (Z_RecordComposition *)
2835 odr_malloc(c->odr_out, sizeof(*compo));
2837 esn->which = Z_ElementSetNames_generic;
2838 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2839 compo->which = Z_RecordComp_simple;
2840 compo->u.simple = esn;
2841 req->recordComposition = compo;
2843 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2844 return send_APDU(c, apdu);
2847 ZOOM_API(ZOOM_scanset)
2848 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2851 ZOOM_query q = ZOOM_query_create();
2853 ZOOM_query_prefix(q, start);
2855 s = ZOOM_connection_scan1(c, q);
2856 ZOOM_query_destroy(q);
2861 ZOOM_API(ZOOM_scanset)
2862 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2864 ZOOM_scanset scan = 0;
2868 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2869 scan->connection = c;
2870 scan->odr = odr_createmem(ODR_DECODE);
2871 scan->options = ZOOM_options_create_with_parent(c->options);
2873 scan->scan_response = 0;
2874 scan->srw_scan_response = 0;
2878 scan->databaseNames = set_DatabaseNames(c, c->options,
2879 &scan->num_databaseNames,
2884 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2885 task->u.scan.scan = scan;
2890 while (ZOOM_event(1, &c))
2898 ZOOM_scanset_destroy(ZOOM_scanset scan)
2903 if (scan->refcount == 0)
2905 ZOOM_query_destroy(scan->query);
2907 odr_destroy(scan->odr);
2909 ZOOM_options_destroy(scan->options);
2914 static zoom_ret send_package(ZOOM_connection c)
2918 yaz_log(log_details, "%p send_package", c);
2920 return zoom_complete;
2921 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2923 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2924 ZOOM_connection_put_event(c, event);
2926 c->buf_out = c->tasks->u.package->buf_out;
2927 c->len_out = c->tasks->u.package->len_out;
2932 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2935 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2936 Z_ScanRequest *req = apdu->u.scanRequest;
2938 yaz_log(log_details, "%p send_scan", c);
2940 return zoom_complete;
2941 assert (c->tasks->which == ZOOM_TASK_SCAN);
2942 scan = c->tasks->u.scan.scan;
2944 /* Z39.50 scan can only carry RPN */
2945 if (scan->query->z_query->which == Z_Query_type_1 ||
2946 scan->query->z_query->which == Z_Query_type_101)
2948 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2949 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2952 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2955 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2957 yaz_query_charset_convert_rpnquery(
2958 rpn, c->odr_out, cd);
2959 yaz_iconv_close(cd);
2962 req->attributeSet = rpn->attributeSetId;
2963 if (!req->attributeSet)
2964 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2965 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2966 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2968 req->termListAndStartPoint =
2969 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2973 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2974 return zoom_complete;
2979 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2980 return zoom_complete;
2983 *req->numberOfTermsRequested =
2984 ZOOM_options_get_int(scan->options, "number", 20);
2986 req->preferredPositionInResponse =
2987 odr_intdup(c->odr_out,
2988 ZOOM_options_get_int(scan->options, "position", 1));
2991 odr_intdup(c->odr_out,
2992 ZOOM_options_get_int(scan->options, "stepSize", 0));
2994 req->databaseNames = scan->databaseNames;
2995 req->num_databaseNames = scan->num_databaseNames;
2997 return send_APDU(c, apdu);
3001 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3005 const char *option_val = 0;
3008 return zoom_complete;
3009 assert (c->tasks->which == ZOOM_TASK_SCAN);
3010 scan = c->tasks->u.scan.scan;
3012 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
3014 /* SRU scan can only carry CQL and PQF */
3015 if (scan->query->z_query->which == Z_Query_type_104)
3017 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
3018 sr->u.scan_request->scanClause.cql = scan->query->query_string;
3020 else if (scan->query->z_query->which == Z_Query_type_1
3021 || scan->query->z_query->which == Z_Query_type_101)
3023 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
3024 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
3028 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3029 return zoom_complete;
3032 sr->u.scan_request->maximumTerms = odr_intdup(
3033 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
3035 sr->u.scan_request->responsePosition = odr_intdup(
3036 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
3038 option_val = ZOOM_options_get(scan->options, "extraArgs");
3039 yaz_encode_sru_extra(sr, c->odr_out, option_val);
3040 return send_srw(c, sr);
3043 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3045 return zoom_complete;
3051 ZOOM_scanset_size(ZOOM_scanset scan)
3056 if (scan->scan_response && scan->scan_response->entries)
3057 return scan->scan_response->entries->num_entries;
3058 else if (scan->srw_scan_response)
3059 return scan->srw_scan_response->num_terms;
3063 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
3065 const char **value_term, size_t *value_len,
3066 const char **disp_term, size_t *disp_len)
3068 size_t noent = ZOOM_scanset_size(scan);
3079 if (scan->scan_response)
3081 Z_ScanResponse *res = scan->scan_response;
3082 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
3084 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3086 *value_term = (const char *) t->term->u.general->buf;
3087 *value_len = t->term->u.general->len;
3090 *disp_term = t->displayTerm;
3091 *disp_len = strlen(*disp_term);
3093 else if (t->term->which == Z_Term_general)
3095 *disp_term = (const char *) t->term->u.general->buf;
3096 *disp_len = t->term->u.general->len;
3098 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3101 if (scan->srw_scan_response)
3103 Z_SRW_scanResponse *res = scan->srw_scan_response;
3104 Z_SRW_scanTerm *t = res->terms + pos;
3107 *value_term = t->value;
3108 *value_len = strlen(*value_term);
3111 *disp_term = t->displayTerm;
3113 *disp_term = t->value;
3114 *disp_len = strlen(*disp_term);
3115 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3120 ZOOM_API(const char *)
3121 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3122 size_t *occ, size_t *len)
3124 const char *value_term = 0;
3125 size_t value_len = 0;
3126 const char *disp_term = 0;
3127 size_t disp_len = 0;
3129 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3130 &disp_term, &disp_len);
3136 ZOOM_API(const char *)
3137 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3138 size_t *occ, size_t *len)
3140 const char *value_term = 0;
3141 size_t value_len = 0;
3142 const char *disp_term = 0;
3143 size_t disp_len = 0;
3145 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3146 &disp_term, &disp_len);
3152 ZOOM_API(const char *)
3153 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3155 return ZOOM_options_get(scan->options, key);
3159 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3162 ZOOM_options_set(scan->options, key, val);
3165 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3168 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3169 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3171 str = ZOOM_options_get(p->options, "package-name");
3173 req->packageName = odr_strdup(p->odr_out, str);
3175 str = ZOOM_options_get(p->options, "user-id");
3177 req->userId = odr_strdup_null(p->odr_out, str);
3179 req->packageType = odr_oiddup(p->odr_out, oid);
3181 str = ZOOM_options_get(p->options, "function");
3184 if (!strcmp (str, "create"))
3185 *req->function = Z_ExtendedServicesRequest_create;
3186 if (!strcmp (str, "delete"))
3187 *req->function = Z_ExtendedServicesRequest_delete;
3188 if (!strcmp (str, "modify"))
3189 *req->function = Z_ExtendedServicesRequest_modify;
3192 str = ZOOM_options_get(p->options, "waitAction");
3195 if (!strcmp (str, "wait"))
3196 *req->waitAction = Z_ExtendedServicesRequest_wait;
3197 if (!strcmp (str, "waitIfPossible"))
3198 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3199 if (!strcmp (str, "dontWait"))
3200 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3201 if (!strcmp (str, "dontReturnPackage"))
3202 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3207 static const char *ill_array_lookup(void *clientData, const char *idx)
3209 ZOOM_package p = (ZOOM_package) clientData;
3210 return ZOOM_options_get(p->options, idx+4);
3213 static Z_External *encode_ill_request(ZOOM_package p)
3215 ODR out = p->odr_out;
3218 struct ill_get_ctl ctl;
3220 ctl.odr = p->odr_out;
3222 ctl.f = ill_array_lookup;
3224 req = ill_get_ILLRequest(&ctl, "ill", 0);
3226 if (!ill_Request(out, &req, 0, 0))
3228 int ill_request_size;
3229 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3230 if (ill_request_buf)
3231 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3236 int illRequest_size = 0;
3237 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3239 r = (Z_External *) odr_malloc(out, sizeof(*r));
3240 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3241 r->indirect_reference = 0;
3243 r->which = Z_External_single;
3245 r->u.single_ASN1_type =
3246 odr_create_Odr_oct(out,
3247 (unsigned char *)illRequest_buf,
3253 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3255 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3259 req->which = Z_IOItemOrder_esRequest;
3260 req->u.esRequest = (Z_IORequest *)
3261 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3263 /* to keep part ... */
3264 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3265 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3266 req->u.esRequest->toKeep->supplDescription = 0;
3267 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3268 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3270 str = ZOOM_options_get(p->options, "contact-name");
3271 req->u.esRequest->toKeep->contact->name =
3272 odr_strdup_null(p->odr_out, str);
3274 str = ZOOM_options_get(p->options, "contact-phone");
3275 req->u.esRequest->toKeep->contact->phone =
3276 odr_strdup_null(p->odr_out, str);
3278 str = ZOOM_options_get(p->options, "contact-email");
3279 req->u.esRequest->toKeep->contact->email =
3280 odr_strdup_null(p->odr_out, str);
3282 req->u.esRequest->toKeep->addlBilling = 0;
3284 /* not to keep part ... */
3285 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3286 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3288 str = ZOOM_options_get(p->options, "itemorder-setname");
3293 req->u.esRequest->notToKeep->resultSetItem = 0;
3296 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3297 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3299 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3300 odr_strdup(p->odr_out, str);
3301 req->u.esRequest->notToKeep->resultSetItem->item =
3302 odr_intdup(p->odr_out, 0);
3304 str = ZOOM_options_get(p->options, "itemorder-item");
3305 *req->u.esRequest->notToKeep->resultSetItem->item =
3306 (str ? atoi(str) : 1);
3309 str = ZOOM_options_getl(p->options, "doc", &len);
3312 req->u.esRequest->notToKeep->itemRequest =
3313 z_ext_record_xml(p->odr_out, str, len);
3316 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3321 Z_APDU *create_admin_package(ZOOM_package p, int type,
3322 Z_ESAdminOriginPartToKeep **toKeepP,
3323 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3325 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3328 Z_ESAdminOriginPartToKeep *toKeep;
3329 Z_ESAdminOriginPartNotToKeep *notToKeep;
3330 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3331 const char *first_db = "Default";
3333 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3338 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3340 r->indirect_reference = 0;
3341 r->which = Z_External_ESAdmin;
3343 r->u.adminService = (Z_Admin *)
3344 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3345 r->u.adminService->which = Z_Admin_esRequest;
3346 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3347 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3349 toKeep = r->u.adminService->u.esRequest->toKeep =
3350 (Z_ESAdminOriginPartToKeep *)
3351 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3352 toKeep->which = type;
3353 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3354 toKeep->u.create = odr_nullval();
3355 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3357 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3358 (Z_ESAdminOriginPartNotToKeep *)
3359 odr_malloc(p->odr_out,
3360 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3361 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3362 notToKeep->u.recordsWillFollow = odr_nullval();
3366 *notToKeepP = notToKeep;
3371 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3373 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3374 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3375 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3377 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3385 req->taskSpecificParameters = ext;
3386 ext->direct_reference = req->packageType;
3387 ext->descriptor = 0;
3388 ext->indirect_reference = 0;
3390 ext->which = Z_External_octet;
3391 ext->u.single_ASN1_type =
3392 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3396 static Z_APDU *create_update_package(ZOOM_package p)
3399 const char *first_db = "Default";
3401 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3402 const char *action = ZOOM_options_get(p->options, "action");
3403 int recordIdOpaque_len;
3404 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3405 &recordIdOpaque_len);
3406 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3408 const char *record_buf = ZOOM_options_getl(p->options, "record",
3410 int recordOpaque_len;
3411 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3413 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3414 const char *version = ZOOM_options_get(p->options, "updateVersion");
3416 const char *correlationInfo_note =
3417 ZOOM_options_get(p->options, "correlationInfo.note");
3418 const char *correlationInfo_id =
3419 ZOOM_options_get(p->options, "correlationInfo.id");
3421 Odr_oid *syntax_oid = 0;
3422 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3428 if (!record_buf && !recordOpaque_buf)
3430 record_buf = "void";
3432 syntax_str = "SUTRS";
3437 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3438 CLASS_RECSYN, syntax_str,
3450 package_oid = yaz_oid_extserv_database_update_first_version;
3451 /* old update does not support specialUpdate */
3453 action = "recordInsert";
3457 action = "specialUpdate";
3458 package_oid = yaz_oid_extserv_database_update_second_version;
3462 action = "specialUpdate";
3463 package_oid = yaz_oid_extserv_database_update;
3469 if (!strcmp(action, "recordInsert"))
3470 action_no = Z_IUOriginPartToKeep_recordInsert;
3471 else if (!strcmp(action, "recordReplace"))
3472 action_no = Z_IUOriginPartToKeep_recordReplace;
3473 else if (!strcmp(action, "recordDelete"))
3474 action_no = Z_IUOriginPartToKeep_recordDelete;
3475 else if (!strcmp(action, "elementUpdate"))
3476 action_no = Z_IUOriginPartToKeep_elementUpdate;
3477 else if (!strcmp(action, "specialUpdate"))
3478 action_no = Z_IUOriginPartToKeep_specialUpdate;
3482 apdu = create_es_package(p, package_oid);
3485 Z_IUOriginPartToKeep *toKeep;
3486 Z_IUSuppliedRecords *notToKeep;
3487 Z_External *r = (Z_External *)
3488 odr_malloc(p->odr_out, sizeof(*r));
3489 const char *elementSetName =
3490 ZOOM_options_get(p->options, "elementSetName");
3492 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3494 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3496 r->which = Z_External_update;
3497 r->indirect_reference = 0;
3498 r->u.update = (Z_IUUpdate *)
3499 odr_malloc(p->odr_out, sizeof(*r->u.update));
3501 r->u.update->which = Z_IUUpdate_esRequest;
3502 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3503 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3504 toKeep = r->u.update->u.esRequest->toKeep =
3505 (Z_IUOriginPartToKeep *)
3506 odr_malloc(p->odr_out, sizeof(*toKeep));
3508 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3511 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3513 toKeep->actionQualifier = 0;
3514 toKeep->action = odr_intdup(p->odr_out, action_no);
3516 notToKeep = r->u.update->u.esRequest->notToKeep =
3517 (Z_IUSuppliedRecords *)
3518 odr_malloc(p->odr_out, sizeof(*notToKeep));
3520 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3521 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3522 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3523 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3524 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3527 notToKeep->elements[0]->u.opaque =
3528 odr_create_Odr_oct(p->odr_out,
3529 (const unsigned char *) recordIdOpaque,
3530 recordIdOpaque_len);
3532 else if (recordIdNumber)
3534 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3536 notToKeep->elements[0]->u.number =
3537 odr_intdup(p->odr_out, atoi(recordIdNumber));
3540 notToKeep->elements[0]->u.opaque = 0;
3541 notToKeep->elements[0]->supplementalId = 0;
3542 if (correlationInfo_note || correlationInfo_id)
3544 Z_IUCorrelationInfo *ci;
3545 ci = notToKeep->elements[0]->correlationInfo =
3546 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3547 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3548 ci->id = correlationInfo_id ?
3549 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3552 notToKeep->elements[0]->correlationInfo = 0;
3553 if (recordOpaque_buf)
3555 notToKeep->elements[0]->record =
3556 z_ext_record_oid_any(p->odr_out, syntax_oid,
3557 recordOpaque_buf, recordOpaque_len);
3561 notToKeep->elements[0]->record =
3562 z_ext_record_oid(p->odr_out, syntax_oid,
3563 record_buf, record_len);
3568 ODR print = odr_createmem(ODR_PRINT);
3570 z_APDU(print, &apdu, 0, 0);
3577 ZOOM_package_send(ZOOM_package p, const char *type)
3584 odr_reset(p->odr_out);
3587 if (!strcmp(type, "itemorder"))
3589 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3592 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3594 r->direct_reference =
3595 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3597 r->which = Z_External_itemOrder;
3598 r->indirect_reference = 0;
3599 r->u.itemOrder = encode_item_order(p);
3601 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3604 else if (!strcmp(type, "create")) /* create database */
3606 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3609 else if (!strcmp(type, "drop")) /* drop database */
3611 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3614 else if (!strcmp(type, "commit")) /* commit changes */
3616 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3619 else if (!strcmp(type, "update")) /* update record(s) */
3621 apdu = create_update_package(p);
3623 else if (!strcmp(type, "xmlupdate"))
3625 apdu = create_xmlupdate_package(p);
3629 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3633 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3634 task->u.package = p;
3635 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3636 p->buf_out = (char *) xmalloc(p->len_out);
3637 memcpy(p->buf_out, buf, p->len_out);
3642 while (ZOOM_event(1, &c))
3649 ZOOM_API(ZOOM_package)
3650 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3652 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3655 p->odr_out = odr_createmem(ODR_ENCODE);
3656 p->options = ZOOM_options_create_with_parent2(options, c->options);
3664 ZOOM_package_destroy(ZOOM_package p)
3669 if (p->refcount == 0)
3671 odr_destroy(p->odr_out);
3674 ZOOM_options_destroy(p->options);
3679 ZOOM_API(const char *)
3680 ZOOM_package_option_get(ZOOM_package p, const char *key)
3682 return ZOOM_options_get(p->options, key);
3685 ZOOM_API(const char *)
3686 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3688 return ZOOM_options_getl(p->options, key, lenp);
3692 ZOOM_package_option_set(ZOOM_package p, const char *key,
3695 ZOOM_options_set(p->options, key, val);
3699 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3700 const char *val, int len)
3702 ZOOM_options_setl(p->options, key, val, len);
3706 ZOOM_connection_exec_task(ZOOM_connection c)
3708 ZOOM_task task = c->tasks;
3709 zoom_ret ret = zoom_complete;
3713 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3714 c, task->which, task->running);
3715 if (c->error != ZOOM_ERROR_NONE)
3717 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3718 "removing tasks because of error = %d", c, c->error);
3719 ZOOM_connection_remove_tasks(c);
3724 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3725 "task already running", c);
3729 ret = zoom_complete;
3730 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3732 switch (task->which)
3734 case ZOOM_TASK_SEARCH:
3735 if (c->proto == PROTO_HTTP)
3736 ret = ZOOM_connection_srw_send_search(c);
3738 ret = ZOOM_connection_send_search(c);
3740 case ZOOM_TASK_RETRIEVE:
3741 if (c->proto == PROTO_HTTP)
3742 ret = ZOOM_connection_srw_send_search(c);
3744 ret = send_present(c);
3746 case ZOOM_TASK_CONNECT:
3747 ret = do_connect(c);
3749 case ZOOM_TASK_SCAN:
3750 if (c->proto == PROTO_HTTP)
3751 ret = ZOOM_connection_srw_send_scan(c);
3753 ret = ZOOM_connection_send_scan(c);
3755 case ZOOM_TASK_PACKAGE:
3756 ret = send_package(c);
3758 case ZOOM_TASK_SORT:
3759 c->tasks->u.sort.resultset->r_sort_spec =
3760 c->tasks->u.sort.q->sort_spec;
3761 ret = send_sort(c, c->tasks->u.sort.resultset);
3767 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3768 "remove tasks because no connection exist", c);
3769 ZOOM_connection_remove_tasks(c);
3771 if (ret == zoom_complete)
3773 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3774 "task removed (complete)", c);
3775 ZOOM_connection_remove_task(c);
3778 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3783 static zoom_ret send_sort_present(ZOOM_connection c)
3785 zoom_ret r = zoom_complete;
3787 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3788 r = send_sort(c, c->tasks->u.search.resultset);
3789 if (r == zoom_complete)
3790 r = send_present(c);
3794 static int es_response_taskpackage_update(ZOOM_connection c,
3795 Z_IUUpdateTaskPackage *utp)
3797 if (utp && utp->targetPart)
3799 Z_IUTargetPart *targetPart = utp->targetPart;
3800 switch ( *targetPart->updateStatus ) {
3801 case Z_IUTargetPart_success:
3802 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3804 case Z_IUTargetPart_partial:
3805 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3807 case Z_IUTargetPart_failure:
3808 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3809 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3810 response_diag(c, targetPart->globalDiagnostics[0]);
3813 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3818 static int es_response_taskpackage(ZOOM_connection c,
3819 Z_TaskPackage *taskPackage)
3822 Odr_oct *id = taskPackage->targetReference;
3824 ZOOM_options_setl(c->tasks->u.package->options,
3825 "targetReference", (char*) id->buf, id->len);
3828 switch ( *taskPackage->taskStatus ) {
3829 case Z_TaskPackage_pending:
3830 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3832 case Z_TaskPackage_active:
3833 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3835 case Z_TaskPackage_complete:
3836 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3838 case Z_TaskPackage_aborted:
3839 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3840 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3841 response_diag(c, taskPackage->packageDiagnostics[0]);
3845 // taskSpecificParameters
3846 // NOTE: Only Update implemented, no others.
3847 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3848 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3849 es_response_taskpackage_update(c, utp);
3855 static int es_response(ZOOM_connection c,
3856 Z_ExtendedServicesResponse *res)
3858 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3860 switch (*res->operationStatus) {
3861 case Z_ExtendedServicesResponse_done:
3862 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3864 case Z_ExtendedServicesResponse_accepted:
3865 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3867 case Z_ExtendedServicesResponse_failure:
3868 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3869 if (res->diagnostics && res->num_diagnostics > 0)
3870 response_diag(c, res->diagnostics[0]);
3873 if (res->taskPackage &&
3874 res->taskPackage->which == Z_External_extendedService)
3876 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3877 es_response_taskpackage(c, taskPackage);
3879 if (res->taskPackage &&
3880 res->taskPackage->which == Z_External_octet)
3882 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3883 ZOOM_options_setl(c->tasks->u.package->options,
3884 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3889 static void interpret_init_diag(ZOOM_connection c,
3890 Z_DiagnosticFormat *diag)
3894 Z_DiagnosticFormat_s *ds = diag->elements[0];
3895 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3896 response_default_diag(c, ds->u.defaultDiagRec);
3901 static void interpret_otherinformation_field(ZOOM_connection c,
3902 Z_OtherInformation *ui)
3905 for (i = 0; i < ui->num_elements; i++)
3907 Z_OtherInformationUnit *unit = ui->list[i];
3908 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3909 unit->information.externallyDefinedInfo &&
3910 unit->information.externallyDefinedInfo->which ==
3913 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3919 static void set_init_option(const char *name, void *clientData) {
3920 ZOOM_connection c = (ZOOM_connection) clientData;
3923 sprintf(buf, "init_opt_%.70s", name);
3924 ZOOM_connection_option_set(c, buf, "1");
3928 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3930 Z_InitResponse *initrs;
3932 ZOOM_connection_set_mask(c, 0);
3933 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3936 case Z_APDU_initResponse:
3937 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3938 initrs = apdu->u.initResponse;
3939 ZOOM_connection_option_set(c, "serverImplementationId",
3940 initrs->implementationId ?
3941 initrs->implementationId : "");
3942 ZOOM_connection_option_set(c, "serverImplementationName",
3943 initrs->implementationName ?
3944 initrs->implementationName : "");
3945 ZOOM_connection_option_set(c, "serverImplementationVersion",
3946 initrs->implementationVersion ?
3947 initrs->implementationVersion : "");
3948 /* Set the three old options too, for old applications */
3949 ZOOM_connection_option_set(c, "targetImplementationId",
3950 initrs->implementationId ?
3951 initrs->implementationId : "");
3952 ZOOM_connection_option_set(c, "targetImplementationName",
3953 initrs->implementationName ?
3954 initrs->implementationName : "");
3955 ZOOM_connection_option_set(c, "targetImplementationVersion",
3956 initrs->implementationVersion ?
3957 initrs->implementationVersion : "");
3959 /* Make initrs->options available as ZOOM-level options */
3960 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3962 if (!*initrs->result)
3964 Z_External *uif = initrs->userInformationField;
3966 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3968 if (uif && uif->which == Z_External_userInfo1)
3969 interpret_otherinformation_field(c, uif->u.userInfo1);
3974 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3975 yaz_oid_userinfo_cookie, 1, 0);
3976 xfree(c->cookie_in);
3979 c->cookie_in = xstrdup(cookie);
3980 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3981 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3982 c->support_named_resultsets = 1;
3985 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3986 ZOOM_connection_remove_task(c);
3988 ZOOM_connection_exec_task(c);
3990 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3992 NMEM tmpmem = nmem_create();
3993 Z_CharSetandLanguageNegotiation *p =
3994 yaz_get_charneg_record(initrs->otherInfo);
3998 char *charset = NULL, *lang = NULL;
4001 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
4002 yaz_log(log_details, "%p recv_apdu target accepted: "
4003 "charset %s, language %s, select %d",
4005 charset ? charset : "none", lang ? lang : "none", sel);
4007 ZOOM_connection_option_set(c, "negotiation-charset",
4010 ZOOM_connection_option_set(c, "negotiation-lang",
4013 ZOOM_connection_option_set(
4014 c, "negotiation-charset-in-effect-for-records",
4015 (sel != 0) ? "1" : "0");
4016 nmem_destroy(tmpmem);
4020 case Z_APDU_searchResponse:
4021 yaz_log(log_api, "%p recv_apdu Search response", c);
4022 handle_search_response(c, apdu->u.searchResponse);
4023 if (send_sort_present(c) == zoom_complete)
4024 ZOOM_connection_remove_task(c);
4026 case Z_APDU_presentResponse:
4027 yaz_log(log_api, "%p recv_apdu Present response", c);
4028 handle_present_response(c, apdu->u.presentResponse);
4029 if (send_present(c) == zoom_complete)
4030 ZOOM_connection_remove_task(c);
4032 case Z_APDU_sortResponse:
4033 yaz_log(log_api, "%p recv_apdu Sort response", c);
4034 sort_response(c, apdu->u.sortResponse);
4035 if (send_present(c) == zoom_complete)
4036 ZOOM_connection_remove_task(c);
4038 case Z_APDU_scanResponse:
4039 yaz_log(log_api, "%p recv_apdu Scan response", c);
4040 scan_response(c, apdu->u.scanResponse);
4041 ZOOM_connection_remove_task(c);
4043 case Z_APDU_extendedServicesResponse:
4044 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
4045 es_response(c, apdu->u.extendedServicesResponse);
4046 ZOOM_connection_remove_task(c);
4049 yaz_log(log_api, "%p recv_apdu Close PDU", c);
4050 if (!ZOOM_test_reconnect(c))
4052 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4057 yaz_log(log_api, "%p Received unknown PDU", c);
4058 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4064 static zoom_ret handle_srw_response(ZOOM_connection c,
4065 Z_SRW_searchRetrieveResponse *res)
4067 ZOOM_resultset resultset = 0;
4072 const char *syntax, *elementSetName;
4075 return zoom_complete;
4077 switch(c->tasks->which)
4079 case ZOOM_TASK_SEARCH:
4080 resultset = c->tasks->u.search.resultset;
4081 start = &c->tasks->u.search.start;
4082 count = &c->tasks->u.search.count;
4083 syntax = c->tasks->u.search.syntax;
4084 elementSetName = c->tasks->u.search.elementSetName;
4086 if (!c->tasks->u.search.recv_search_fired)
4088 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4089 ZOOM_connection_put_event(c, event);
4090 c->tasks->u.search.recv_search_fired = 1;
4093 case ZOOM_TASK_RETRIEVE:
4094 resultset = c->tasks->u.retrieve.resultset;
4095 start = &c->tasks->u.retrieve.start;
4096 count = &c->tasks->u.retrieve.count;
4097 syntax = c->tasks->u.retrieve.syntax;
4098 elementSetName = c->tasks->u.retrieve.elementSetName;
4101 return zoom_complete;
4104 resultset->size = 0;
4106 if (res->resultSetId)
4107 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4109 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4111 if (res->num_diagnostics > 0)
4113 set_SRU_error(c, &res->diagnostics[0]);
4117 if (res->numberOfRecords)
4118 resultset->size = *res->numberOfRecords;
4119 for (i = 0; i<res->num_records; i++)
4122 Z_SRW_record *sru_rec;
4123 Z_SRW_diagnostic *diag = 0;
4126 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4127 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4129 if (res->records[i].recordPosition &&
4130 *res->records[i].recordPosition > 0)
4131 pos = *res->records[i].recordPosition - 1;
4135 sru_rec = &res->records[i];
4137 npr->databaseName = 0;
4138 npr->which = Z_NamePlusRecord_databaseRecord;
4139 npr->u.databaseRecord = (Z_External *)
4140 odr_malloc(c->odr_in, sizeof(Z_External));
4141 npr->u.databaseRecord->descriptor = 0;
4142 npr->u.databaseRecord->direct_reference =
4143 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4144 npr->u.databaseRecord->which = Z_External_octet;
4146 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4147 odr_malloc(c->odr_in, sizeof(Odr_oct));
4148 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4149 sru_rec->recordData_buf;
4150 npr->u.databaseRecord->u.octet_aligned->len =
4151 npr->u.databaseRecord->u.octet_aligned->size =
4152 sru_rec->recordData_len;
4154 if (sru_rec->recordSchema
4155 && !strcmp(sru_rec->recordSchema,
4156 "info:srw/schema/1/diagnostics-v1.1"))
4158 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4159 sru_rec->recordData_len,
4163 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4164 sru_rec->recordSchema, diag);
4168 if (*count + *start > resultset->size)
4169 *count = resultset->size - *start;
4173 nmem = odr_extract_mem(c->odr_in);
4174 nmem_transfer(odr_getmem(resultset->odr), nmem);
4178 return ZOOM_connection_srw_send_search(c);
4180 return zoom_complete;
4185 static void handle_srw_scan_response(ZOOM_connection c,
4186 Z_SRW_scanResponse *res)
4188 NMEM nmem = odr_extract_mem(c->odr_in);
4191 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4193 scan = c->tasks->u.scan.scan;
4195 if (res->num_diagnostics > 0)
4196 set_SRU_error(c, &res->diagnostics[0]);
4198 scan->scan_response = 0;
4199 scan->srw_scan_response = res;
4200 nmem_transfer(odr_getmem(scan->odr), nmem);
4202 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4208 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
4210 Z_GDU *p = z_get_HTTP_Request(odr);
4211 const char *host = url;
4212 const char *cp0 = strstr(host, "://");
4213 const char *cp1 = 0;
4219 cp1 = strchr(cp0, '/');
4221 cp1 = cp0 + strlen(cp0);
4225 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
4226 memcpy (h, cp0, cp1 - cp0);
4228 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
4230 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
4234 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
4235 Z_HTTP_Response *cookie_hres)
4237 struct Z_HTTP_Header *h;
4238 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
4240 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
4241 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
4244 for (h = cookie_hres->headers; h; h = h->next)
4246 if (!strcmp(h->name, "Set-Cookie"))
4247 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
4248 "Cookie", h->value);
4250 if (c->user && c->password)
4252 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
4253 c->user, c->password);
4255 if (!z_GDU(c->odr_out, &gdu, 0, 0))
4256 return zoom_complete;
4258 z_GDU(c->odr_print, &gdu, 0, 0);
4259 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
4261 odr_reset(c->odr_out);
4265 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4267 zoom_ret cret = zoom_complete;
4269 const char *addinfo = 0;
4270 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4272 const char *location;
4274 ZOOM_connection_set_mask(c, 0);
4275 yaz_log(log_details, "%p handle_http", c);
4277 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
4278 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
4281 if (c->no_redirects > 10)
4283 set_HTTP_error(c, hres->code, 0, 0);
4284 c->no_redirects = 0;
4289 /* since redirect may change host we just reconnect. A smarter
4290 implementation might check whether it's the same server */
4291 do_connect_host(c, location, 0);
4292 send_SRW_redirect(c, location, hres);
4293 /* we're OK for now. Operation is not really complete */
4295 cret = zoom_pending;
4299 { /* not redirect (normal response) */
4300 if (!yaz_srw_check_content_type(hres))
4301 addinfo = "content-type";
4304 Z_SOAP *soap_package = 0;
4306 Z_SOAP_Handler soap_handlers[2] = {
4307 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4310 ret = z_soap_codec(o, &soap_package,
4311 &hres->content_buf, &hres->content_len,
4313 if (!ret && soap_package->which == Z_SOAP_generic &&
4314 soap_package->u.generic->no == 0)
4316 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4318 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4319 ZOOM_options_setl(c->options, "sru_extra_response_data",
4320 sr->extraResponseData_buf, sr->extraResponseData_len);
4321 if (sr->which == Z_SRW_searchRetrieve_response)
4322 cret = handle_srw_response(c, sr->u.response);
4323 else if (sr->which == Z_SRW_scan_response)
4324 handle_srw_scan_response(c, sr->u.scan_response);
4328 else if (!ret && (soap_package->which == Z_SOAP_fault
4329 || soap_package->which == Z_SOAP_error))
4331 set_HTTP_error(c, hres->code,
4332 soap_package->u.fault->fault_code,
4333 soap_package->u.fault->fault_string);
4340 if (c->no_redirects) /* end of redirect. change hosts again */
4343 c->no_redirects = 0;
4347 if (hres->code != 200)
4348 set_HTTP_error(c, hres->code, 0, 0);
4350 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4353 if (cret == zoom_complete)
4354 ZOOM_connection_remove_task(c);
4355 if (!strcmp(hres->version, "1.0"))
4357 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4358 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4363 /* HTTP 1.1: only if no close we stay alive .. */
4364 if (connection_head && !strcmp(connection_head, "close"))
4370 static int do_read(ZOOM_connection c)
4375 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4376 ZOOM_connection_put_event(c, event);
4378 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4379 more = cs_more(c->cs);
4380 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4385 if (!ZOOM_test_reconnect(c))
4387 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4396 odr_reset(c->odr_in);
4397 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4398 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4399 ZOOM_connection_put_event(c, event);
4401 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4404 int err = odr_geterrorx(c->odr_in, &x);
4406 const char *element = odr_getelement(c->odr_in);
4407 yaz_snprintf(msg, sizeof(msg),
4408 "ODR code %d:%d element=%s offset=%d",
4409 err, x, element ? element : "<unknown>",
4410 odr_offset(c->odr_in));
4411 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4414 FILE *ber_file = yaz_log_file();
4416 odr_dumpBER(ber_file, c->buf_in, r);
4423 z_GDU(c->odr_print, &gdu, 0, 0);
4424 if (gdu->which == Z_GDU_Z3950)
4425 recv_apdu(c, gdu->u.z3950);
4426 else if (gdu->which == Z_GDU_HTTP_Response)
4429 handle_http(c, gdu->u.HTTP_Response);
4431 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4436 c->reconnect_ok = 0;
4441 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4446 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4447 ZOOM_connection_put_event(c, event);
4449 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4450 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4452 yaz_log(log_details, "%p do_write_ex write failed", c);
4453 if (ZOOM_test_reconnect(c))
4455 return zoom_pending;
4457 if (c->state == STATE_CONNECTING)
4458 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4460 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4462 return zoom_complete;
4466 int mask = ZOOM_SELECT_EXCEPT;
4467 if (c->cs->io_pending & CS_WANT_WRITE)
4468 mask += ZOOM_SELECT_WRITE;
4469 if (c->cs->io_pending & CS_WANT_READ)
4470 mask += ZOOM_SELECT_READ;
4471 ZOOM_connection_set_mask(c, mask);
4472 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4477 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4478 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4481 return zoom_pending;
4484 static zoom_ret do_write(ZOOM_connection c)
4486 return do_write_ex(c, c->buf_out, c->len_out);
4490 ZOOM_API(const char *)
4491 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4493 return ZOOM_options_get(c->options, key);
4496 ZOOM_API(const char *)
4497 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4499 return ZOOM_options_getl(c->options, key, lenp);
4503 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4506 ZOOM_options_set(c->options, key, val);
4510 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4511 const char *val, int len)
4513 ZOOM_options_setl(c->options, key, val, len);
4516 ZOOM_API(const char *)
4517 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4519 return ZOOM_options_get(r->options, key);
4523 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4526 ZOOM_options_set(r->options, key, val);
4531 ZOOM_connection_errcode(ZOOM_connection c)
4533 return ZOOM_connection_error(c, 0, 0);
4536 ZOOM_API(const char *)
4537 ZOOM_connection_errmsg(ZOOM_connection c)
4540 ZOOM_connection_error(c, &msg, 0);
4544 ZOOM_API(const char *)
4545 ZOOM_connection_addinfo(ZOOM_connection c)
4547 const char *addinfo;
4548 ZOOM_connection_error(c, 0, &addinfo);
4552 ZOOM_API(const char *)
4553 ZOOM_connection_diagset(ZOOM_connection c)
4555 const char *diagset;
4556 ZOOM_connection_error_x(c, 0, 0, &diagset);
4560 ZOOM_API(const char *)
4561 ZOOM_diag_str(int error)
4565 case ZOOM_ERROR_NONE:
4567 case ZOOM_ERROR_CONNECT:
4568 return "Connect failed";
4569 case ZOOM_ERROR_MEMORY:
4570 return "Out of memory";
4571 case ZOOM_ERROR_ENCODE:
4572 return "Encoding failed";
4573 case ZOOM_ERROR_DECODE:
4574 return "Decoding failed";
4575 case ZOOM_ERROR_CONNECTION_LOST:
4576 return "Connection lost";
4577 case ZOOM_ERROR_INIT:
4578 return "Init rejected";
4579 case ZOOM_ERROR_INTERNAL:
4580 return "Internal failure";
4581 case ZOOM_ERROR_TIMEOUT:
4583 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4584 return "Unsupported protocol";
4585 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4586 return "Unsupported query type";
4587 case ZOOM_ERROR_INVALID_QUERY:
4588 return "Invalid query";
4589 case ZOOM_ERROR_CQL_PARSE:
4590 return "CQL parsing error";
4591 case ZOOM_ERROR_CQL_TRANSFORM:
4592 return "CQL transformation error";
4593 case ZOOM_ERROR_CCL_CONFIG:
4594 return "CCL configuration error";
4595 case ZOOM_ERROR_CCL_PARSE:
4596 return "CCL parsing error";
4598 return diagbib1_str(error);
4603 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4604 const char **addinfo, const char **diagset)
4606 int error = c->error;
4609 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4610 *cp = ZOOM_diag_str(error);
4611 else if (!strcmp(c->diagset, "HTTP"))
4612 *cp = z_HTTP_errmsg(c->error);
4613 else if (!strcmp(c->diagset, "Bib-1"))
4614 *cp = ZOOM_diag_str(error);
4615 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4616 *cp = yaz_diag_srw_str(c->error);
4618 *cp = "Unknown error and diagnostic set";
4621 *addinfo = c->addinfo ? c->addinfo : "";
4623 *diagset = c->diagset ? c->diagset : "";
4628 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4629 const char **addinfo)
4631 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4634 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4636 ZOOM_Event event = 0;
4637 int r = cs_look(c->cs);
4638 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4643 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4644 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4646 ZOOM_connection_put_event(c, event);
4648 else if (r == CS_CONNECT)
4650 int ret = ret = cs_rcvconnect(c->cs);
4651 yaz_log(log_details, "%p ZOOM_connection_do_io "
4652 "cs_rcvconnect returned %d", c, ret);
4655 int mask = ZOOM_SELECT_EXCEPT;
4656 if (c->cs->io_pending & CS_WANT_WRITE)
4657 mask += ZOOM_SELECT_WRITE;
4658 if (c->cs->io_pending & CS_WANT_READ)
4659 mask += ZOOM_SELECT_READ;
4660 ZOOM_connection_set_mask(c, mask);
4661 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4662 ZOOM_connection_put_event(c, event);
4666 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4667 ZOOM_connection_put_event(c, event);
4669 if (c->proto == PROTO_Z3950)
4670 ZOOM_connection_send_init(c);
4673 /* no init request for SRW .. */
4674 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4675 ZOOM_connection_remove_task(c);
4676 ZOOM_connection_set_mask(c, 0);
4677 ZOOM_connection_exec_task(c);
4679 c->state = STATE_ESTABLISHED;
4683 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4689 if (mask & ZOOM_SELECT_EXCEPT)
4691 if (!ZOOM_test_reconnect(c))
4693 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4698 if (mask & ZOOM_SELECT_READ)
4700 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4706 ZOOM_connection_last_event(ZOOM_connection cs)
4709 return ZOOM_EVENT_NONE;
4710 return cs->last_event;
4714 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4716 WRBUF wrbuf = (WRBUF) client_data;
4717 wrbuf_puts(wrbuf, buf);
4721 * Returns an xmalloc()d string containing RPN that corresponds to the
4722 * CQL passed in. On error, sets the Connection object's error state
4723 * and returns a null pointer.
4724 * ### We could cache CQL parser and/or transformer in Connection.
4726 static char *cql2pqf(ZOOM_connection c, const char *cql)
4730 const char *cqlfile;
4731 cql_transform_t trans;
4734 parser = cql_parser_create();
4735 if ((error = cql_parser_string(parser, cql)) != 0) {
4736 cql_parser_destroy(parser);
4737 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4741 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4744 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4746 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4749 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4750 cqlfile, strerror(errno));
4751 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4755 WRBUF wrbuf_result = wrbuf_alloc();
4756 error = cql_transform(trans, cql_parser_result(parser),
4757 cql2pqf_wrbuf_puts, wrbuf_result);
4760 const char *addinfo;
4761 error = cql_transform_error(trans, &addinfo);
4762 sprintf(buf, "%.200s (addinfo=%.200s)",
4763 cql_strerror(error), addinfo);
4764 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4768 result = xstrdup(wrbuf_cstr(wrbuf_result));
4770 cql_transform_close(trans);
4771 wrbuf_destroy(wrbuf_result);
4773 cql_parser_destroy(parser);
4777 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4781 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4782 /* timeout and this connection was waiting */
4783 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4785 ZOOM_connection_put_event(c, event);
4791 ZOOM_connection_process(ZOOM_connection c)
4797 event = ZOOM_connection_get_event(c);
4800 ZOOM_Event_destroy(event);
4803 ZOOM_connection_exec_task(c);
4804 event = ZOOM_connection_get_event(c);
4807 ZOOM_Event_destroy(event);
4814 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4818 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4820 for (i = 0; i<no; i++)
4822 ZOOM_connection c = cs[i];
4824 if (c && ZOOM_connection_process(c))
4830 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4832 if (c->mask && mask)
4833 ZOOM_connection_do_io(c, mask);
4837 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4840 return cs_fileno(c->cs);
4844 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4852 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4859 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4861 return ZOOM_options_get_int(c->options, "timeout", 30);
4864 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
4872 * c-file-style: "Stroustrup"
4873 * indent-tabs-mode: nil
4875 * vim: shiftwidth=4 tabstop=8 expandtab