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 ZOOM_resultsets list;
802 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
806 // Remove the connection's usage of resultsets
807 list = c->resultsets;
809 ZOOM_resultsets removed = list;
810 ZOOM_resultset_destroy(list->resultset);
818 odr_destroy(c->odr_in);
819 odr_destroy(c->odr_out);
822 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
823 odr_destroy(c->odr_print);
825 ZOOM_options_destroy(c->options);
826 ZOOM_connection_remove_tasks(c);
827 ZOOM_connection_remove_events(c);
833 xfree(c->cookie_out);
839 xfree(c->sru_version);
843 void ZOOM_resultset_addref(ZOOM_resultset r)
847 yaz_mutex_enter(r->mutex);
849 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
851 yaz_mutex_leave(r->mutex);
855 ZOOM_resultset ZOOM_resultset_create(void)
858 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
862 yaz_log(log_details, "%p ZOOM_resultset_create", r);
865 r->odr = odr_createmem(ODR_ENCODE);
870 for (i = 0; i<RECORD_HASH_SIZE; i++)
871 r->record_hash[i] = 0;
875 r->databaseNames = 0;
876 r->num_databaseNames = 0;
878 yaz_mutex_create(&r->mutex);
881 WRBUF w = wrbuf_alloc();
882 YAZ_SHPTR_INIT(r->record_wrbuf, w);
888 ZOOM_API(ZOOM_resultset)
889 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
892 ZOOM_query s = ZOOM_query_create();
894 ZOOM_query_prefix(s, q);
896 r = ZOOM_connection_search(c, s);
897 ZOOM_query_destroy(s);
901 ZOOM_API(ZOOM_resultset)
902 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
904 ZOOM_resultset r = ZOOM_resultset_create();
908 const char *syntax, *elementSetName;
911 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
912 r->r_sort_spec = q->sort_spec;
915 r->options = ZOOM_options_create_with_parent(c->options);
917 start = ZOOM_options_get_int(r->options, "start", 0);
918 count = ZOOM_options_get_int(r->options, "count", 0);
920 /* If "presentChunk" is defined use that; otherwise "step" */
921 const char *cp = ZOOM_options_get(r->options, "presentChunk");
922 r->step = ZOOM_options_get_int(r->options,
923 (cp != 0 ? "presentChunk": "step"), 0);
925 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
926 cp = ZOOM_options_get(r->options, "setname");
928 r->setname = xstrdup(cp);
929 cp = ZOOM_options_get(r->options, "schema");
931 r->schema = xstrdup(cp);
933 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
938 yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
939 set = xmalloc(sizeof(*set));
940 ZOOM_resultset_addref(r);
942 set->next = c->resultsets;
945 if (c->host_port && c->proto == PROTO_HTTP)
949 yaz_log(log_details, "ZOOM_connection_search: no comstack");
950 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
954 yaz_log(log_details, "ZOOM_connection_search: reconnect");
959 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
960 task->u.search.resultset = r;
961 task->u.search.start = start;
962 task->u.search.count = count;
963 task->u.search.recv_search_fired = 0;
965 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
966 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
967 elementSetName = ZOOM_options_get(r->options, "elementSetName");
968 task->u.search.elementSetName = elementSetName
969 ? xstrdup(elementSetName) : 0;
971 ZOOM_resultset_addref(r);
977 while (ZOOM_event(1, &c))
984 ZOOM_resultset_sort(ZOOM_resultset r,
985 const char *sort_type, const char *sort_spec)
987 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
991 ZOOM_resultset_sort1(ZOOM_resultset r,
992 const char *sort_type, const char *sort_spec)
994 ZOOM_connection c = r->connection;
998 newq = ZOOM_query_create();
999 if (ZOOM_query_sortby(newq, sort_spec) < 0)
1002 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
1003 r, r, sort_type, sort_spec);
1007 if (c->host_port && c->proto == PROTO_HTTP)
1011 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
1012 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1016 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
1018 c->reconnect_ok = 1;
1022 ZOOM_resultset_cache_reset(r);
1023 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
1024 task->u.sort.resultset = r;
1025 task->u.sort.q = newq;
1027 ZOOM_resultset_addref(r);
1031 while (ZOOM_event(1, &c))
1038 static void ZOOM_record_release(ZOOM_record rec)
1044 if (rec->record_wrbuf)
1045 YAZ_SHPTR_DEC(rec->record_wrbuf, wrbuf_destroy);
1048 wrbuf_destroy(rec->wrbuf);
1053 xmlFree(rec->xml_mem);
1056 odr_destroy(rec->odr);
1060 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1063 for (i = 0; i<RECORD_HASH_SIZE; i++)
1065 ZOOM_record_cache rc;
1066 for (rc = r->record_hash[i]; rc; rc = rc->next)
1068 ZOOM_record_release(&rc->rec);
1070 r->record_hash[i] = 0;
1075 ZOOM_resultset_destroy(ZOOM_resultset r)
1077 resultset_destroy(r);
1080 static void resultset_destroy(ZOOM_resultset r)
1084 yaz_mutex_enter(r->mutex);
1086 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1088 if (r->refcount == 0)
1090 yaz_mutex_leave(r->mutex);
1092 yaz_log(log_details, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
1093 ZOOM_resultset_cache_reset(r);
1094 ZOOM_query_destroy(r->query);
1095 ZOOM_options_destroy(r->options);
1096 odr_destroy(r->odr);
1099 yaz_mutex_destroy(&r->mutex);
1101 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
1106 yaz_mutex_leave(r->mutex);
1110 ZOOM_resultset_size(ZOOM_resultset r)
1112 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1117 static void do_close(ZOOM_connection c)
1122 ZOOM_connection_set_mask(c, 0);
1123 c->state = STATE_IDLE;
1126 static int ZOOM_test_reconnect(ZOOM_connection c)
1130 if (!c->reconnect_ok)
1133 c->reconnect_ok = 0;
1134 c->tasks->running = 0;
1135 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1137 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1138 ZOOM_connection_put_event(c, event);
1143 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1144 int force_sync, int start, int count)
1149 const char *syntax, *elementSetName;
1153 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1154 " count=%d", r, force_sync, start, count);
1159 if (c->host_port && c->proto == PROTO_HTTP)
1163 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1164 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1168 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1170 c->reconnect_ok = 1;
1173 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1174 task->u.retrieve.resultset = r;
1175 task->u.retrieve.start = start;
1176 task->u.retrieve.count = count;
1178 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1179 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1180 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1181 task->u.retrieve.elementSetName = elementSetName
1182 ? xstrdup(elementSetName) : 0;
1184 cp = ZOOM_options_get(r->options, "schema");
1187 if (!r->schema || strcmp(r->schema, cp))
1190 r->schema = xstrdup(cp);
1194 ZOOM_resultset_addref(r);
1196 if (!r->connection->async || force_sync)
1197 while (r->connection && ZOOM_event(1, &r->connection))
1202 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1203 size_t start, size_t count)
1205 int force_present = 0;
1209 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1210 r, r, (long) start, (long) count);
1213 ZOOM_resultset_retrieve(r, force_present, start, count);
1217 for (i = 0; i< count; i++)
1218 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1222 static void get_cert(ZOOM_connection c)
1227 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1229 ZOOM_connection_option_setl(c, "sslPeerCert",
1230 cert_buf, cert_len);
1235 static zoom_ret do_connect_host(ZOOM_connection c,
1236 const char *effective_host,
1237 const char *logical_url);
1239 static zoom_ret do_connect(ZOOM_connection c)
1241 const char *effective_host;
1244 effective_host = c->proxy;
1246 effective_host = c->host_port;
1247 return do_connect_host(c, effective_host, c->host_port);
1250 static zoom_ret do_connect_host(ZOOM_connection c, const char *effective_host,
1251 const char *logical_url)
1255 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1259 c->cs = cs_create_host(effective_host, 0, &add);
1261 if (c->cs && c->cs->protocol == PROTO_HTTP)
1268 c->proto = PROTO_HTTP;
1269 cs_get_host_args(logical_url, &db);
1272 c->path = xmalloc(strlen(db) * 3 + 2);
1273 yaz_encode_sru_dbpath_buf(c->path, db);
1276 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1278 return zoom_complete;
1283 int ret = cs_connect(c->cs, add);
1286 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1287 ZOOM_connection_put_event(c, event);
1289 if (c->proto == PROTO_Z3950)
1290 ZOOM_connection_send_init(c);
1293 /* no init request for SRW .. */
1294 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1295 ZOOM_connection_remove_task(c);
1296 ZOOM_connection_set_mask(c, 0);
1297 ZOOM_connection_exec_task(c);
1299 c->state = STATE_ESTABLISHED;
1300 return zoom_pending;
1304 int mask = ZOOM_SELECT_EXCEPT;
1305 if (c->cs->io_pending & CS_WANT_WRITE)
1306 mask += ZOOM_SELECT_WRITE;
1307 if (c->cs->io_pending & CS_WANT_READ)
1308 mask += ZOOM_SELECT_READ;
1309 ZOOM_connection_set_mask(c, mask);
1310 c->state = STATE_CONNECTING;
1311 return zoom_pending;
1314 c->state = STATE_IDLE;
1315 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, logical_url);
1316 return zoom_complete;
1319 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1322 for (i = 0; i<200; i++)
1326 Z_OtherInformation **oi;
1331 sprintf(buf, "otherInfo%d", i);
1332 val = ZOOM_options_get(c->options, buf);
1335 cp = strchr(val, ':');
1339 if (len >= sizeof(buf))
1340 len = sizeof(buf)-1;
1341 memcpy(buf, val, len);
1344 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1349 yaz_oi_APDU(a, &oi);
1350 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1354 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1359 Z_OtherInformation **oi;
1360 yaz_oi_APDU(a, &oi);
1361 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1366 Z_OtherInformation **oi;
1367 yaz_oi_APDU(a, &oi);
1368 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1371 otherInfo_attach(c, a, out);
1372 if (!z_APDU(out, &a, 0, 0))
1374 FILE *outf = fopen("/tmp/apdu.txt", "a");
1377 ODR odr_pr = odr_createmem(ODR_PRINT);
1378 fprintf(outf, "a=%p\n", a);
1379 odr_setprint(odr_pr, outf);
1380 z_APDU(odr_pr, &a, 0, 0);
1381 odr_destroy(odr_pr);
1383 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1384 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1389 z_APDU(c->odr_print, &a, 0, 0);
1390 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1394 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1398 if (encode_APDU(c, a, c->odr_out))
1399 return zoom_complete;
1400 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1401 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1402 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1403 ZOOM_connection_put_event(c, event);
1404 odr_reset(c->odr_out);
1408 /* returns 1 if PDU was sent OK (still pending )
1409 0 if PDU was not sent OK (nothing to wait for)
1412 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1414 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1415 Z_InitRequest *ireq = apdu->u.initRequest;
1416 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1417 odr_malloc(c->odr_out, sizeof(*auth));
1419 ODR_MASK_SET(ireq->options, Z_Options_search);
1420 ODR_MASK_SET(ireq->options, Z_Options_present);
1421 ODR_MASK_SET(ireq->options, Z_Options_scan);
1422 ODR_MASK_SET(ireq->options, Z_Options_sort);
1423 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1424 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1426 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1427 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1428 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1430 ireq->implementationId =
1431 odr_prepend(c->odr_out,
1432 ZOOM_options_get(c->options, "implementationId"),
1433 ireq->implementationId);
1435 ireq->implementationName =
1436 odr_prepend(c->odr_out,
1437 ZOOM_options_get(c->options, "implementationName"),
1438 odr_prepend(c->odr_out, "ZOOM-C",
1439 ireq->implementationName));
1441 ireq->implementationVersion =
1442 odr_prepend(c->odr_out,
1443 ZOOM_options_get(c->options, "implementationVersion"),
1444 ireq->implementationVersion);
1446 *ireq->maximumRecordSize = c->maximum_record_size;
1447 *ireq->preferredMessageSize = c->preferred_message_size;
1449 if (c->group || c->password)
1451 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1452 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1453 pass->userId = odr_strdup_null(c->odr_out, c->user);
1454 pass->password = odr_strdup_null(c->odr_out, c->password);
1455 auth->which = Z_IdAuthentication_idPass;
1456 auth->u.idPass = pass;
1457 ireq->idAuthentication = auth;
1461 auth->which = Z_IdAuthentication_open;
1462 auth->u.open = odr_strdup(c->odr_out, c->user);
1463 ireq->idAuthentication = auth;
1467 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1468 yaz_oid_userinfo_proxy, 1, c->host_port);
1470 if (c->charset || c->lang)
1472 Z_OtherInformation **oi;
1473 Z_OtherInformationUnit *oi_unit;
1475 yaz_oi_APDU(apdu, &oi);
1477 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1479 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1480 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1481 oi_unit->information.externallyDefinedInfo =
1482 yaz_set_proposal_charneg_list(c->odr_out, " ",
1483 c->charset, c->lang, 1);
1487 return send_APDU(c, apdu);
1491 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1495 const char *database = ZOOM_options_get(c->options, "databaseName");
1496 char *fdatabase = 0;
1499 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1500 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1501 fdatabase ? fdatabase : c->path);
1503 if (c->sru_mode == zoom_sru_get)
1505 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1507 else if (c->sru_mode == zoom_sru_post)
1509 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1511 else if (c->sru_mode == zoom_sru_soap)
1513 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1515 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1516 return zoom_complete;
1518 z_GDU(c->odr_print, &gdu, 0, 0);
1519 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1521 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1522 ZOOM_connection_put_event(c, event);
1523 odr_reset(c->odr_out);
1529 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1531 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1532 sr->username = c->user;
1533 sr->password = c->password;
1539 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1543 ZOOM_resultset resultset = 0;
1545 const char *option_val = 0;
1547 if (c->error) /* don't continue on error */
1548 return zoom_complete;
1550 switch(c->tasks->which)
1552 case ZOOM_TASK_SEARCH:
1553 resultset = c->tasks->u.search.resultset;
1554 if (!resultset->setname)
1555 resultset->setname = xstrdup("default");
1556 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1557 start = &c->tasks->u.search.start;
1558 count = &c->tasks->u.search.count;
1560 case ZOOM_TASK_RETRIEVE:
1561 resultset = c->tasks->u.retrieve.resultset;
1563 start = &c->tasks->u.retrieve.start;
1564 count = &c->tasks->u.retrieve.count;
1566 if (*start >= resultset->size)
1567 return zoom_complete;
1568 if (*start + *count > resultset->size)
1569 *count = resultset->size - *start;
1571 for (i = 0; i < *count; i++)
1574 record_cache_lookup(resultset, i + *start,
1575 c->tasks->u.retrieve.syntax,
1576 c->tasks->u.retrieve.elementSetName);
1581 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1582 ZOOM_connection_put_event(c, event);
1589 return zoom_complete;
1592 return zoom_complete;
1594 assert(resultset->query);
1596 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1597 if (resultset->query->z_query->which == Z_Query_type_104
1598 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1600 sr->u.request->query_type = Z_SRW_query_type_cql;
1601 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1603 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1604 resultset->query->z_query->u.type_1)
1606 sr->u.request->query_type = Z_SRW_query_type_pqf;
1607 sr->u.request->query.pqf = resultset->query->query_string;
1611 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1612 return zoom_complete;
1614 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1615 sr->u.request->maximumRecords = odr_intdup(
1616 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1617 resultset->step : *count);
1618 sr->u.request->recordSchema = resultset->schema;
1620 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1622 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1624 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1625 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1626 return send_srw(c, sr);
1629 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1631 return zoom_complete;
1635 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1638 int lslb, ssub, mspn;
1640 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1641 Z_SearchRequest *search_req = apdu->u.searchRequest;
1642 const char *elementSetName;
1643 const char *smallSetElementSetName;
1644 const char *mediumSetElementSetName;
1647 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1649 r = c->tasks->u.search.resultset;
1651 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1654 ZOOM_options_get(r->options, "elementSetName");
1655 smallSetElementSetName =
1656 ZOOM_options_get(r->options, "smallSetElementSetName");
1657 mediumSetElementSetName =
1658 ZOOM_options_get(r->options, "mediumSetElementSetName");
1660 if (!smallSetElementSetName)
1661 smallSetElementSetName = elementSetName;
1663 if (!mediumSetElementSetName)
1664 mediumSetElementSetName = elementSetName;
1669 /* prepare query for the search request */
1670 search_req->query = r->query->z_query;
1671 if (!search_req->query)
1673 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1674 return zoom_complete;
1676 if (r->query->z_query->which == Z_Query_type_1 ||
1677 r->query->z_query->which == Z_Query_type_101)
1679 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1682 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1686 search_req->query = yaz_copy_Z_Query(search_req->query,
1689 r = yaz_query_charset_convert_rpnquery_check(
1690 search_req->query->u.type_1,
1692 yaz_iconv_close(cd);
1694 { /* query could not be char converted */
1695 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1696 return zoom_complete;
1701 search_req->databaseNames = r->databaseNames;
1702 search_req->num_databaseNames = r->num_databaseNames;
1704 /* get syntax (no need to provide unless piggyback is in effect) */
1705 syntax = c->tasks->u.search.syntax;
1707 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1708 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1709 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1710 if (lslb != -1 && ssub != -1 && mspn != -1)
1712 /* So're a Z39.50 expert? Let's hope you don't do sort */
1713 *search_req->largeSetLowerBound = lslb;
1714 *search_req->smallSetUpperBound = ssub;
1715 *search_req->mediumSetPresentNumber = mspn;
1717 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1718 && r->piggyback && !r->r_sort_spec && !r->schema)
1720 /* Regular piggyback - do it unless we're going to do sort */
1721 *search_req->largeSetLowerBound = 2000000000;
1722 *search_req->smallSetUpperBound = 1;
1723 *search_req->mediumSetPresentNumber =
1724 r->step>0 ? r->step : c->tasks->u.search.count;
1728 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1729 smallSetElementSetName = 0;
1730 mediumSetElementSetName = 0;
1733 if (smallSetElementSetName && *smallSetElementSetName)
1735 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1736 odr_malloc(c->odr_out, sizeof(*esn));
1738 esn->which = Z_ElementSetNames_generic;
1739 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1740 search_req->smallSetElementSetNames = esn;
1742 if (mediumSetElementSetName && *mediumSetElementSetName)
1744 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1745 odr_malloc(c->odr_out, sizeof(*esn));
1747 esn->which = Z_ElementSetNames_generic;
1748 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1749 search_req->mediumSetElementSetNames = esn;
1752 search_req->preferredRecordSyntax =
1753 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1757 if (c->support_named_resultsets)
1761 /* find the lowest unused ordinal so that we re-use
1762 result sets on the server. */
1763 for (ord = 1; ; ord++)
1765 ZOOM_resultsets rsp;
1766 sprintf(setname, "%d", ord);
1767 for (rsp = c->resultsets; rsp; rsp = rsp->next)
1768 if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
1773 r->setname = xstrdup(setname);
1774 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1775 "set %s", c, r->setname);
1779 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1781 r->setname = xstrdup("default");
1783 ZOOM_options_set(r->options, "setname", r->setname);
1785 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1786 return send_APDU(c, apdu);
1789 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1791 char oid_name_buf[OID_STR_MAX];
1792 const char *oid_name;
1795 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1798 case Z_DefaultDiagFormat_v2Addinfo:
1799 addinfo = r->u.v2Addinfo;
1801 case Z_DefaultDiagFormat_v3Addinfo:
1802 addinfo = r->u.v3Addinfo;
1807 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1810 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1812 if (p->which != Z_DiagRec_defaultFormat)
1813 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1815 response_default_diag(c, p->u.defaultFormat);
1818 ZOOM_API(ZOOM_record)
1819 ZOOM_record_clone(ZOOM_record srec)
1826 odr_enc = odr_createmem(ODR_ENCODE);
1827 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1829 buf = odr_getbuf(odr_enc, &size, 0);
1831 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1832 nrec->odr = odr_createmem(ODR_DECODE);
1834 nrec->record_wrbuf = 0;
1842 odr_setbuf(nrec->odr, buf, size, 0);
1843 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1845 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1846 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1847 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1848 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1849 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1850 odr_destroy(odr_enc);
1854 ZOOM_API(ZOOM_record)
1855 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1857 const char *syntax =
1858 ZOOM_options_get(s->options, "preferredRecordSyntax");
1859 const char *elementSetName =
1860 ZOOM_options_get(s->options, "elementSetName");
1862 return record_cache_lookup(s, pos, syntax, elementSetName);
1865 ZOOM_API(ZOOM_record)
1866 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1868 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1873 * MIKE: I think force_sync should always be zero, but I don't
1874 * want to make this change until I get the go-ahead from
1875 * Adam, in case something depends on the old synchronous
1879 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1880 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1881 rec = ZOOM_resultset_record_immediate(r, pos);
1887 ZOOM_record_destroy(ZOOM_record rec)
1889 ZOOM_record_release(rec);
1894 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1901 strcpy(to, "UTF-8");
1902 if (record_charset && *record_charset)
1904 /* Use "from,to" or just "from" */
1905 const char *cp = strchr(record_charset, ',');
1906 size_t clen = strlen(record_charset);
1909 strncpy( to, cp+1, sizeof(to)-1);
1910 to[sizeof(to)-1] = '\0';
1911 clen = cp - record_charset;
1913 if (clen > sizeof(from)-1)
1914 clen = sizeof(from)-1;
1917 strncpy(from, record_charset, clen);
1921 cd = yaz_iconv_open(to, from);
1925 static const char *return_marc_record(ZOOM_record rec, WRBUF wrbuf,
1928 const char *buf, int sz,
1929 const char *record_charset)
1931 yaz_iconv_t cd = iconv_create_charset(record_charset);
1932 yaz_marc_t mt = yaz_marc_create();
1933 const char *ret_string = 0;
1936 yaz_marc_iconv(mt, cd);
1937 yaz_marc_xml(mt, marc_type);
1938 if (yaz_marc_decode_wrbuf(mt, buf, sz, wrbuf) > 0)
1941 *len = wrbuf_len(wrbuf);
1942 ret_string = wrbuf_cstr(wrbuf);
1944 yaz_marc_destroy(mt);
1946 yaz_iconv_close(cd);
1950 static const char *return_opac_record(ZOOM_record rec, WRBUF wrbuf,
1953 Z_OPACRecord *opac_rec,
1954 const char *record_charset)
1956 yaz_iconv_t cd = iconv_create_charset(record_charset);
1957 yaz_marc_t mt = yaz_marc_create();
1960 yaz_marc_iconv(mt, cd);
1961 yaz_marc_xml(mt, marc_type);
1963 yaz_opac_decode_wrbuf(mt, opac_rec, wrbuf);
1964 yaz_marc_destroy(mt);
1967 yaz_iconv_close(cd);
1969 *len = wrbuf_len(wrbuf);
1970 return wrbuf_cstr(wrbuf);
1973 static const char *return_string_record(ZOOM_record rec, WRBUF wrbuf,
1975 const char *buf, int sz,
1976 const char *record_charset)
1978 yaz_iconv_t cd = iconv_create_charset(record_charset);
1982 wrbuf_iconv_write(wrbuf, cd, buf, sz);
1983 wrbuf_iconv_reset(wrbuf, cd);
1985 buf = wrbuf_cstr(wrbuf);
1986 sz = wrbuf_len(wrbuf);
1987 yaz_iconv_close(cd);
1994 static const char *return_record(ZOOM_record rec, int *len,
1995 Z_NamePlusRecord *npr,
1996 int marctype, const char *charset)
1998 Z_External *r = (Z_External *) npr->u.databaseRecord;
1999 const Odr_oid *oid = r->direct_reference;
2003 if (!rec->record_wrbuf)
2005 WRBUF w = wrbuf_alloc();
2006 YAZ_SHPTR_INIT(rec->record_wrbuf, w);
2008 wrbuf = rec->record_wrbuf->ptr;
2011 rec->wrbuf = wrbuf_alloc();
2014 wrbuf_rewind(wrbuf);
2015 /* render bibliographic record .. */
2016 if (r->which == Z_External_OPAC)
2018 return return_opac_record(rec, wrbuf, marctype, len,
2019 r->u.opac, charset);
2021 if (r->which == Z_External_sutrs)
2022 return return_string_record(rec, wrbuf, len,
2023 (char*) r->u.sutrs->buf,
2026 else if (r->which == Z_External_octet)
2028 if (yaz_oid_is_iso2709(oid))
2030 const char *ret_buf = return_marc_record(
2031 rec, wrbuf, marctype, len,
2032 (const char *) r->u.octet_aligned->buf,
2033 r->u.octet_aligned->len,
2037 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
2038 if (marctype != YAZ_MARC_ISO2709)
2041 return return_string_record(rec, wrbuf, len,
2042 (const char *) r->u.octet_aligned->buf,
2043 r->u.octet_aligned->len,
2046 else if (r->which == Z_External_grs1)
2048 yaz_display_grs1(wrbuf, r->u.grs1, 0);
2049 return return_string_record(rec, wrbuf, len,
2059 ZOOM_record_error(ZOOM_record rec, const char **cp,
2060 const char **addinfo, const char **diagset)
2062 Z_NamePlusRecord *npr;
2071 *cp = rec->diag_message;
2073 *addinfo = rec->diag_details;
2075 *diagset = rec->diag_set;
2076 return uri_to_code(rec->diag_uri);
2078 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2080 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2081 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2082 const char *add = 0;
2084 if (diag_rec->which == Z_DiagRec_defaultFormat)
2086 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2089 error = *ddf->condition;
2092 case Z_DefaultDiagFormat_v2Addinfo:
2093 add = ddf->u.v2Addinfo;
2095 case Z_DefaultDiagFormat_v3Addinfo:
2096 add = ddf->u.v3Addinfo;
2101 yaz_oid_to_string(yaz_oid_std(),
2102 ddf->diagnosticSetId, &oclass);
2110 *addinfo = add ? add : "";
2112 *cp = diagbib1_str(error);
2118 static const char *get_record_format(ZOOM_record rec, int *len,
2119 Z_NamePlusRecord *npr,
2120 int marctype, const char *charset,
2123 const char *res = return_record(rec, len, npr, marctype, charset);
2125 if (*format == '1' && len)
2127 /* try to XML format res */
2129 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2130 doc = xmlParseMemory(res, *len);
2134 xmlFree(rec->xml_mem);
2135 xmlDocDumpFormatMemory(doc, &rec->xml_mem, &rec->xml_size, 1);
2137 res = (char *) rec->xml_mem;
2138 *len = rec->xml_size;
2146 ZOOM_API(const char *)
2147 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2154 Z_NamePlusRecord *npr;
2157 *len = 0; /* default return */
2166 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2174 while (cp[i] == ' ')
2179 while (cp[i] == ' ')
2181 if (!strncmp(cp + i, "charset=", 8))
2184 i = i + 8; /* skip charset= */
2185 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2187 if (j < sizeof(charset)-1)
2188 charset[j++] = cp[i];
2192 else if (!strncmp(cp + i, "format=", 7))
2196 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2198 if (j < sizeof(format)-1)
2199 format[j++] = cp[i];
2204 if (!strcmp(type, "database"))
2207 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2208 return npr->databaseName;
2210 else if (!strcmp(type, "schema"))
2213 *len = rec->schema ? strlen(rec->schema) : 0;
2216 else if (!strcmp(type, "syntax"))
2218 const char *desc = 0;
2219 if (npr->which == Z_NamePlusRecord_databaseRecord)
2221 Z_External *r = (Z_External *) npr->u.databaseRecord;
2222 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2227 *len = strlen(desc);
2230 if (npr->which != Z_NamePlusRecord_databaseRecord)
2233 /* from now on - we have a database record .. */
2234 if (!strcmp(type, "render"))
2236 return get_record_format(rec, len, npr, YAZ_MARC_LINE, charset, format);
2238 else if (!strcmp(type, "xml"))
2240 return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
2243 else if (!strcmp(type, "txml"))
2245 return get_record_format(rec, len, npr, YAZ_MARC_TURBOMARC, charset,
2248 else if (!strcmp(type, "raw"))
2250 return get_record_format(rec, len, npr, YAZ_MARC_ISO2709, charset,
2253 else if (!strcmp(type, "ext"))
2256 return (const char *) npr->u.databaseRecord;
2258 else if (!strcmp(type, "opac"))
2260 if (npr->u.databaseRecord->which == Z_External_OPAC)
2261 return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
2267 static int strcmp_null(const char *v1, const char *v2)
2273 return strcmp(v1, v2);
2276 static size_t record_hash(int pos)
2280 return pos % RECORD_HASH_SIZE;
2283 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2285 const char *syntax, const char *elementSetName,
2287 Z_SRW_diagnostic *diag)
2289 ZOOM_record_cache rc = 0;
2291 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2292 ZOOM_connection_put_event(r->connection, event);
2294 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2297 && strcmp_null(r->schema, rc->schema) == 0
2298 && strcmp_null(elementSetName,rc->elementSetName) == 0
2299 && strcmp_null(syntax, rc->syntax) == 0)
2304 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2307 YAZ_SHPTR_INC(r->record_wrbuf);
2308 rc->rec.record_wrbuf = r->record_wrbuf;
2313 rc->rec.xml_mem = 0;
2315 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2317 rc->syntax = odr_strdup_null(r->odr, syntax);
2319 rc->schema = odr_strdup_null(r->odr, r->schema);
2322 rc->next = r->record_hash[record_hash(pos)];
2323 r->record_hash[record_hash(pos)] = rc;
2326 rc->rec.schema = odr_strdup_null(r->odr, schema);
2327 rc->rec.diag_set = 0;
2328 rc->rec.diag_uri = 0;
2329 rc->rec.diag_message = 0;
2330 rc->rec.diag_details = 0;
2336 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2337 if ((cp = strrchr(rc->rec.diag_set, '/')))
2339 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2341 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2342 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2346 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2348 const char *elementSetName)
2350 ZOOM_record_cache rc;
2352 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2356 if (strcmp_null(r->schema, rc->schema))
2358 if (strcmp_null(elementSetName,rc->elementSetName))
2360 if (strcmp_null(syntax, rc->syntax))
2368 static void handle_records(ZOOM_connection c, Z_Records *sr,
2371 ZOOM_resultset resultset;
2373 const char *syntax = 0, *elementSetName = 0;
2377 switch (c->tasks->which)
2379 case ZOOM_TASK_SEARCH:
2380 resultset = c->tasks->u.search.resultset;
2381 start = &c->tasks->u.search.start;
2382 count = &c->tasks->u.search.count;
2383 syntax = c->tasks->u.search.syntax;
2384 elementSetName = c->tasks->u.search.elementSetName;
2386 case ZOOM_TASK_RETRIEVE:
2387 resultset = c->tasks->u.retrieve.resultset;
2388 start = &c->tasks->u.retrieve.start;
2389 count = &c->tasks->u.retrieve.count;
2390 syntax = c->tasks->u.retrieve.syntax;
2391 elementSetName = c->tasks->u.retrieve.elementSetName;
2396 if (sr && sr->which == Z_Records_NSD)
2397 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2398 else if (sr && sr->which == Z_Records_multipleNSD)
2400 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2401 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2403 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2407 if (*count + *start > resultset->size)
2408 *count = resultset->size - *start;
2411 if (sr && sr->which == Z_Records_DBOSD)
2414 NMEM nmem = odr_extract_mem(c->odr_in);
2415 Z_NamePlusRecordList *p =
2416 sr->u.databaseOrSurDiagnostics;
2417 for (i = 0; i<p->num_records; i++)
2419 record_cache_add(resultset, p->records[i], i + *start,
2420 syntax, elementSetName,
2427 yaz_log(log_details,
2428 "handle_records resultset=%p start=%d count=%d",
2429 resultset, *start, *count);
2431 /* transfer our response to search_nmem .. we need it later */
2432 nmem_transfer(odr_getmem(resultset->odr), nmem);
2434 if (present_phase && p->num_records == 0)
2436 /* present response and we didn't get any records! */
2437 Z_NamePlusRecord *myrec =
2438 zget_surrogateDiagRec(
2440 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2441 "ZOOM C generated. Present phase and no records");
2442 record_cache_add(resultset, myrec, *start,
2443 syntax, elementSetName, 0, 0);
2446 else if (present_phase)
2448 /* present response and we didn't get any records! */
2449 Z_NamePlusRecord *myrec =
2450 zget_surrogateDiagRec(
2452 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2453 "ZOOM C generated: Present response and no records");
2454 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2460 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2462 handle_records(c, pr->records, 1);
2465 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2468 switch (term->which)
2470 case Z_Term_general:
2471 ZOOM_options_setl(opt, name,
2472 (const char *)(term->u.general->buf),
2473 term->u.general->len);
2475 case Z_Term_characterString:
2476 ZOOM_options_set(opt, name, term->u.characterString);
2478 case Z_Term_numeric:
2479 ZOOM_options_set_int(opt, name, *term->u.numeric);
2484 static void handle_queryExpression(ZOOM_options opt, const char *name,
2485 Z_QueryExpression *exp)
2491 case Z_QueryExpression_term:
2492 if (exp->u.term && exp->u.term->queryTerm)
2494 sprintf(opt_name, "%s.term", name);
2495 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2498 case Z_QueryExpression_query:
2503 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2504 Z_OtherInformation *o)
2507 for (i = 0; o && i < o->num_elements; i++)
2509 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2511 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2513 if (ext->which == Z_External_searchResult1)
2516 Z_SearchInfoReport *sr = ext->u.searchResult1;
2519 ZOOM_options_set_int(
2520 resultset->options, "searchresult.size", sr->num);
2522 for (j = 0; j < sr->num; j++)
2524 Z_SearchInfoReport_s *ent =
2525 ext->u.searchResult1->elements[j];
2528 sprintf(pref, "searchresult.%d", j);
2530 if (ent->subqueryId)
2533 sprintf(opt_name, "%s.id", pref);
2534 ZOOM_options_set(resultset->options, opt_name,
2537 if (ent->subqueryExpression)
2540 sprintf(opt_name, "%s.subquery", pref);
2541 handle_queryExpression(resultset->options, opt_name,
2542 ent->subqueryExpression);
2544 if (ent->subqueryInterpretation)
2547 sprintf(opt_name, "%s.interpretation", pref);
2548 handle_queryExpression(resultset->options, opt_name,
2549 ent->subqueryInterpretation);
2551 if (ent->subqueryRecommendation)
2554 sprintf(opt_name, "%s.recommendation", pref);
2555 handle_queryExpression(resultset->options, opt_name,
2556 ent->subqueryRecommendation);
2558 if (ent->subqueryCount)
2561 sprintf(opt_name, "%s.count", pref);
2562 ZOOM_options_set_int(resultset->options, opt_name,
2563 *ent->subqueryCount);
2571 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2573 ZOOM_resultset resultset;
2576 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2579 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2580 ZOOM_connection_put_event(c, event);
2582 resultset = c->tasks->u.search.resultset;
2584 if (sr->resultSetStatus)
2586 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2587 *sr->resultSetStatus);
2589 if (sr->presentStatus)
2591 ZOOM_options_set_int(resultset->options, "presentStatus",
2592 *sr->presentStatus);
2594 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2596 resultset->size = *sr->resultCount;
2597 handle_records(c, sr->records, 0);
2600 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2602 if (res->diagnostics && res->num_diagnostics > 0)
2603 response_diag(c, res->diagnostics[0]);
2606 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2608 NMEM nmem = odr_extract_mem(c->odr_in);
2611 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2613 scan = c->tasks->u.scan.scan;
2615 if (res->entries && res->entries->nonsurrogateDiagnostics)
2616 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2617 scan->scan_response = res;
2618 scan->srw_scan_response = 0;
2619 nmem_transfer(odr_getmem(scan->odr), nmem);
2621 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2622 if (res->positionOfTerm)
2623 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2624 if (res->scanStatus)
2625 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2626 if (res->numberOfEntriesReturned)
2627 ZOOM_options_set_int(scan->options, "number",
2628 *res->numberOfEntriesReturned);
2633 static zoom_ret send_sort(ZOOM_connection c,
2634 ZOOM_resultset resultset)
2637 resultset->r_sort_spec = 0;
2638 if (resultset->r_sort_spec)
2640 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2641 Z_SortRequest *req = apdu->u.sortRequest;
2643 req->num_inputResultSetNames = 1;
2644 req->inputResultSetNames = (Z_InternationalString **)
2645 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2646 req->inputResultSetNames[0] =
2647 odr_strdup(c->odr_out, resultset->setname);
2648 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2649 req->sortSequence = resultset->r_sort_spec;
2650 resultset->r_sort_spec = 0;
2651 return send_APDU(c, apdu);
2653 return zoom_complete;
2656 static zoom_ret send_present(ZOOM_connection c)
2659 Z_PresentRequest *req = 0;
2661 const char *syntax = 0;
2662 const char *elementSetName = 0;
2663 ZOOM_resultset resultset;
2668 yaz_log(log_details, "%p send_present no tasks", c);
2669 return zoom_complete;
2672 switch (c->tasks->which)
2674 case ZOOM_TASK_SEARCH:
2675 resultset = c->tasks->u.search.resultset;
2676 start = &c->tasks->u.search.start;
2677 count = &c->tasks->u.search.count;
2678 syntax = c->tasks->u.search.syntax;
2679 elementSetName = c->tasks->u.search.elementSetName;
2681 case ZOOM_TASK_RETRIEVE:
2682 resultset = c->tasks->u.retrieve.resultset;
2683 start = &c->tasks->u.retrieve.start;
2684 count = &c->tasks->u.retrieve.count;
2685 syntax = c->tasks->u.retrieve.syntax;
2686 elementSetName = c->tasks->u.retrieve.elementSetName;
2689 return zoom_complete;
2691 yaz_log(log_details, "%p send_present start=%d count=%d",
2694 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2696 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2699 if (c->error) /* don't continue on error */
2700 return zoom_complete;
2701 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2702 resultset, *start, *count);
2704 for (i = 0; i < *count; i++)
2707 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2712 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2713 ZOOM_connection_put_event(c, event);
2721 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2722 return zoom_complete;
2725 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2726 req = apdu->u.presentRequest;
2729 yaz_log(log_details, "%p send_present skip=%d", c, i);
2731 *req->resultSetStartPoint = *start + 1;
2733 if (resultset->step > 0 && resultset->step < *count)
2734 *req->numberOfRecordsRequested = resultset->step;
2736 *req->numberOfRecordsRequested = *count;
2738 if (*req->numberOfRecordsRequested + *start > resultset->size)
2739 *req->numberOfRecordsRequested = resultset->size - *start;
2740 assert(*req->numberOfRecordsRequested > 0);
2742 if (syntax && *syntax)
2743 req->preferredRecordSyntax =
2744 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2746 if (resultset->schema && *resultset->schema)
2748 Z_RecordComposition *compo = (Z_RecordComposition *)
2749 odr_malloc(c->odr_out, sizeof(*compo));
2751 req->recordComposition = compo;
2752 compo->which = Z_RecordComp_complex;
2753 compo->u.complex = (Z_CompSpec *)
2754 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2755 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2756 odr_malloc(c->odr_out, sizeof(bool_t));
2757 *compo->u.complex->selectAlternativeSyntax = 0;
2759 compo->u.complex->generic = (Z_Specification *)
2760 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2762 compo->u.complex->generic->which = Z_Schema_oid;
2763 compo->u.complex->generic->schema.oid = (Odr_oid *)
2764 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2766 if (!compo->u.complex->generic->schema.oid)
2768 /* OID wasn't a schema! Try record syntax instead. */
2770 compo->u.complex->generic->schema.oid = (Odr_oid *)
2771 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2773 if (elementSetName && *elementSetName)
2775 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2776 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2777 compo->u.complex->generic->elementSpec->which =
2778 Z_ElementSpec_elementSetName;
2779 compo->u.complex->generic->elementSpec->u.elementSetName =
2780 odr_strdup(c->odr_out, elementSetName);
2783 compo->u.complex->generic->elementSpec = 0;
2784 compo->u.complex->num_dbSpecific = 0;
2785 compo->u.complex->dbSpecific = 0;
2786 compo->u.complex->num_recordSyntax = 0;
2787 compo->u.complex->recordSyntax = 0;
2789 else if (elementSetName && *elementSetName)
2791 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2792 odr_malloc(c->odr_out, sizeof(*esn));
2793 Z_RecordComposition *compo = (Z_RecordComposition *)
2794 odr_malloc(c->odr_out, sizeof(*compo));
2796 esn->which = Z_ElementSetNames_generic;
2797 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2798 compo->which = Z_RecordComp_simple;
2799 compo->u.simple = esn;
2800 req->recordComposition = compo;
2802 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2803 return send_APDU(c, apdu);
2806 ZOOM_API(ZOOM_scanset)
2807 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2810 ZOOM_query q = ZOOM_query_create();
2812 ZOOM_query_prefix(q, start);
2814 s = ZOOM_connection_scan1(c, q);
2815 ZOOM_query_destroy(q);
2820 ZOOM_API(ZOOM_scanset)
2821 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2823 ZOOM_scanset scan = 0;
2827 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2828 scan->connection = c;
2829 scan->odr = odr_createmem(ODR_DECODE);
2830 scan->options = ZOOM_options_create_with_parent(c->options);
2832 scan->scan_response = 0;
2833 scan->srw_scan_response = 0;
2837 scan->databaseNames = set_DatabaseNames(c, c->options,
2838 &scan->num_databaseNames,
2843 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2844 task->u.scan.scan = scan;
2849 while (ZOOM_event(1, &c))
2857 ZOOM_scanset_destroy(ZOOM_scanset scan)
2862 if (scan->refcount == 0)
2864 ZOOM_query_destroy(scan->query);
2866 odr_destroy(scan->odr);
2868 ZOOM_options_destroy(scan->options);
2873 static zoom_ret send_package(ZOOM_connection c)
2877 yaz_log(log_details, "%p send_package", c);
2879 return zoom_complete;
2880 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2882 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2883 ZOOM_connection_put_event(c, event);
2885 c->buf_out = c->tasks->u.package->buf_out;
2886 c->len_out = c->tasks->u.package->len_out;
2891 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2894 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2895 Z_ScanRequest *req = apdu->u.scanRequest;
2897 yaz_log(log_details, "%p send_scan", c);
2899 return zoom_complete;
2900 assert (c->tasks->which == ZOOM_TASK_SCAN);
2901 scan = c->tasks->u.scan.scan;
2903 /* Z39.50 scan can only carry RPN */
2904 if (scan->query->z_query->which == Z_Query_type_1 ||
2905 scan->query->z_query->which == Z_Query_type_101)
2907 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2908 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2911 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2914 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2916 yaz_query_charset_convert_rpnquery(
2917 rpn, c->odr_out, cd);
2918 yaz_iconv_close(cd);
2921 req->attributeSet = rpn->attributeSetId;
2922 if (!req->attributeSet)
2923 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2924 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2925 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2927 req->termListAndStartPoint =
2928 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2932 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2933 return zoom_complete;
2938 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2939 return zoom_complete;
2942 *req->numberOfTermsRequested =
2943 ZOOM_options_get_int(scan->options, "number", 20);
2945 req->preferredPositionInResponse =
2946 odr_intdup(c->odr_out,
2947 ZOOM_options_get_int(scan->options, "position", 1));
2950 odr_intdup(c->odr_out,
2951 ZOOM_options_get_int(scan->options, "stepSize", 0));
2953 req->databaseNames = scan->databaseNames;
2954 req->num_databaseNames = scan->num_databaseNames;
2956 return send_APDU(c, apdu);
2960 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2964 const char *option_val = 0;
2967 return zoom_complete;
2968 assert (c->tasks->which == ZOOM_TASK_SCAN);
2969 scan = c->tasks->u.scan.scan;
2971 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2973 /* SRU scan can only carry CQL and PQF */
2974 if (scan->query->z_query->which == Z_Query_type_104)
2976 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2977 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2979 else if (scan->query->z_query->which == Z_Query_type_1
2980 || scan->query->z_query->which == Z_Query_type_101)
2982 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2983 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2987 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2988 return zoom_complete;
2991 sr->u.scan_request->maximumTerms = odr_intdup(
2992 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2994 sr->u.scan_request->responsePosition = odr_intdup(
2995 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2997 option_val = ZOOM_options_get(scan->options, "extraArgs");
2998 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2999 return send_srw(c, sr);
3002 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3004 return zoom_complete;
3010 ZOOM_scanset_size(ZOOM_scanset scan)
3015 if (scan->scan_response && scan->scan_response->entries)
3016 return scan->scan_response->entries->num_entries;
3017 else if (scan->srw_scan_response)
3018 return scan->srw_scan_response->num_terms;
3022 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
3024 const char **value_term, size_t *value_len,
3025 const char **disp_term, size_t *disp_len)
3027 size_t noent = ZOOM_scanset_size(scan);
3038 if (scan->scan_response)
3040 Z_ScanResponse *res = scan->scan_response;
3041 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
3043 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3045 *value_term = (const char *) t->term->u.general->buf;
3046 *value_len = t->term->u.general->len;
3049 *disp_term = t->displayTerm;
3050 *disp_len = strlen(*disp_term);
3052 else if (t->term->which == Z_Term_general)
3054 *disp_term = (const char *) t->term->u.general->buf;
3055 *disp_len = t->term->u.general->len;
3057 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3060 if (scan->srw_scan_response)
3062 Z_SRW_scanResponse *res = scan->srw_scan_response;
3063 Z_SRW_scanTerm *t = res->terms + pos;
3066 *value_term = t->value;
3067 *value_len = strlen(*value_term);
3070 *disp_term = t->displayTerm;
3072 *disp_term = t->value;
3073 *disp_len = strlen(*disp_term);
3074 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3079 ZOOM_API(const char *)
3080 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3081 size_t *occ, size_t *len)
3083 const char *value_term = 0;
3084 size_t value_len = 0;
3085 const char *disp_term = 0;
3086 size_t disp_len = 0;
3088 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3089 &disp_term, &disp_len);
3095 ZOOM_API(const char *)
3096 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3097 size_t *occ, size_t *len)
3099 const char *value_term = 0;
3100 size_t value_len = 0;
3101 const char *disp_term = 0;
3102 size_t disp_len = 0;
3104 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3105 &disp_term, &disp_len);
3111 ZOOM_API(const char *)
3112 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3114 return ZOOM_options_get(scan->options, key);
3118 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3121 ZOOM_options_set(scan->options, key, val);
3124 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3127 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3128 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3130 str = ZOOM_options_get(p->options, "package-name");
3132 req->packageName = odr_strdup(p->odr_out, str);
3134 str = ZOOM_options_get(p->options, "user-id");
3136 req->userId = odr_strdup_null(p->odr_out, str);
3138 req->packageType = odr_oiddup(p->odr_out, oid);
3140 str = ZOOM_options_get(p->options, "function");
3143 if (!strcmp (str, "create"))
3144 *req->function = Z_ExtendedServicesRequest_create;
3145 if (!strcmp (str, "delete"))
3146 *req->function = Z_ExtendedServicesRequest_delete;
3147 if (!strcmp (str, "modify"))
3148 *req->function = Z_ExtendedServicesRequest_modify;
3151 str = ZOOM_options_get(p->options, "waitAction");
3154 if (!strcmp (str, "wait"))
3155 *req->waitAction = Z_ExtendedServicesRequest_wait;
3156 if (!strcmp (str, "waitIfPossible"))
3157 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3158 if (!strcmp (str, "dontWait"))
3159 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3160 if (!strcmp (str, "dontReturnPackage"))
3161 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3166 static const char *ill_array_lookup(void *clientData, const char *idx)
3168 ZOOM_package p = (ZOOM_package) clientData;
3169 return ZOOM_options_get(p->options, idx+4);
3172 static Z_External *encode_ill_request(ZOOM_package p)
3174 ODR out = p->odr_out;
3177 struct ill_get_ctl ctl;
3179 ctl.odr = p->odr_out;
3181 ctl.f = ill_array_lookup;
3183 req = ill_get_ILLRequest(&ctl, "ill", 0);
3185 if (!ill_Request(out, &req, 0, 0))
3187 int ill_request_size;
3188 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3189 if (ill_request_buf)
3190 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3195 int illRequest_size = 0;
3196 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3198 r = (Z_External *) odr_malloc(out, sizeof(*r));
3199 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3200 r->indirect_reference = 0;
3202 r->which = Z_External_single;
3204 r->u.single_ASN1_type =
3205 odr_create_Odr_oct(out,
3206 (unsigned char *)illRequest_buf,
3212 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3214 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3218 req->which = Z_IOItemOrder_esRequest;
3219 req->u.esRequest = (Z_IORequest *)
3220 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3222 /* to keep part ... */
3223 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3224 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3225 req->u.esRequest->toKeep->supplDescription = 0;
3226 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3227 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3229 str = ZOOM_options_get(p->options, "contact-name");
3230 req->u.esRequest->toKeep->contact->name =
3231 odr_strdup_null(p->odr_out, str);
3233 str = ZOOM_options_get(p->options, "contact-phone");
3234 req->u.esRequest->toKeep->contact->phone =
3235 odr_strdup_null(p->odr_out, str);
3237 str = ZOOM_options_get(p->options, "contact-email");
3238 req->u.esRequest->toKeep->contact->email =
3239 odr_strdup_null(p->odr_out, str);
3241 req->u.esRequest->toKeep->addlBilling = 0;
3243 /* not to keep part ... */
3244 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3245 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3247 str = ZOOM_options_get(p->options, "itemorder-setname");
3252 req->u.esRequest->notToKeep->resultSetItem = 0;
3255 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3256 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3258 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3259 odr_strdup(p->odr_out, str);
3260 req->u.esRequest->notToKeep->resultSetItem->item =
3261 odr_intdup(p->odr_out, 0);
3263 str = ZOOM_options_get(p->options, "itemorder-item");
3264 *req->u.esRequest->notToKeep->resultSetItem->item =
3265 (str ? atoi(str) : 1);
3268 str = ZOOM_options_getl(p->options, "doc", &len);
3271 req->u.esRequest->notToKeep->itemRequest =
3272 z_ext_record_xml(p->odr_out, str, len);
3275 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3280 Z_APDU *create_admin_package(ZOOM_package p, int type,
3281 Z_ESAdminOriginPartToKeep **toKeepP,
3282 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3284 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3287 Z_ESAdminOriginPartToKeep *toKeep;
3288 Z_ESAdminOriginPartNotToKeep *notToKeep;
3289 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3290 const char *first_db = "Default";
3292 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3297 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3299 r->indirect_reference = 0;
3300 r->which = Z_External_ESAdmin;
3302 r->u.adminService = (Z_Admin *)
3303 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3304 r->u.adminService->which = Z_Admin_esRequest;
3305 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3306 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3308 toKeep = r->u.adminService->u.esRequest->toKeep =
3309 (Z_ESAdminOriginPartToKeep *)
3310 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3311 toKeep->which = type;
3312 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3313 toKeep->u.create = odr_nullval();
3314 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3316 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3317 (Z_ESAdminOriginPartNotToKeep *)
3318 odr_malloc(p->odr_out,
3319 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3320 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3321 notToKeep->u.recordsWillFollow = odr_nullval();
3325 *notToKeepP = notToKeep;
3330 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3332 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3333 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3334 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3336 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3344 req->taskSpecificParameters = ext;
3345 ext->direct_reference = req->packageType;
3346 ext->descriptor = 0;
3347 ext->indirect_reference = 0;
3349 ext->which = Z_External_octet;
3350 ext->u.single_ASN1_type =
3351 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3355 static Z_APDU *create_update_package(ZOOM_package p)
3358 const char *first_db = "Default";
3360 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3361 const char *action = ZOOM_options_get(p->options, "action");
3362 int recordIdOpaque_len;
3363 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3364 &recordIdOpaque_len);
3365 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3367 const char *record_buf = ZOOM_options_getl(p->options, "record",
3369 int recordOpaque_len;
3370 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3372 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3373 const char *version = ZOOM_options_get(p->options, "updateVersion");
3375 const char *correlationInfo_note =
3376 ZOOM_options_get(p->options, "correlationInfo.note");
3377 const char *correlationInfo_id =
3378 ZOOM_options_get(p->options, "correlationInfo.id");
3380 Odr_oid *syntax_oid = 0;
3381 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3387 if (!record_buf && !recordOpaque_buf)
3389 record_buf = "void";
3391 syntax_str = "SUTRS";
3396 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3397 CLASS_RECSYN, syntax_str,
3409 package_oid = yaz_oid_extserv_database_update_first_version;
3410 /* old update does not support specialUpdate */
3412 action = "recordInsert";
3416 action = "specialUpdate";
3417 package_oid = yaz_oid_extserv_database_update_second_version;
3421 action = "specialUpdate";
3422 package_oid = yaz_oid_extserv_database_update;
3428 if (!strcmp(action, "recordInsert"))
3429 action_no = Z_IUOriginPartToKeep_recordInsert;
3430 else if (!strcmp(action, "recordReplace"))
3431 action_no = Z_IUOriginPartToKeep_recordReplace;
3432 else if (!strcmp(action, "recordDelete"))
3433 action_no = Z_IUOriginPartToKeep_recordDelete;
3434 else if (!strcmp(action, "elementUpdate"))
3435 action_no = Z_IUOriginPartToKeep_elementUpdate;
3436 else if (!strcmp(action, "specialUpdate"))
3437 action_no = Z_IUOriginPartToKeep_specialUpdate;
3441 apdu = create_es_package(p, package_oid);
3444 Z_IUOriginPartToKeep *toKeep;
3445 Z_IUSuppliedRecords *notToKeep;
3446 Z_External *r = (Z_External *)
3447 odr_malloc(p->odr_out, sizeof(*r));
3448 const char *elementSetName =
3449 ZOOM_options_get(p->options, "elementSetName");
3451 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3453 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3455 r->which = Z_External_update;
3456 r->indirect_reference = 0;
3457 r->u.update = (Z_IUUpdate *)
3458 odr_malloc(p->odr_out, sizeof(*r->u.update));
3460 r->u.update->which = Z_IUUpdate_esRequest;
3461 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3462 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3463 toKeep = r->u.update->u.esRequest->toKeep =
3464 (Z_IUOriginPartToKeep *)
3465 odr_malloc(p->odr_out, sizeof(*toKeep));
3467 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3470 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3472 toKeep->actionQualifier = 0;
3473 toKeep->action = odr_intdup(p->odr_out, action_no);
3475 notToKeep = r->u.update->u.esRequest->notToKeep =
3476 (Z_IUSuppliedRecords *)
3477 odr_malloc(p->odr_out, sizeof(*notToKeep));
3479 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3480 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3481 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3482 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3483 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3486 notToKeep->elements[0]->u.opaque =
3487 odr_create_Odr_oct(p->odr_out,
3488 (const unsigned char *) recordIdOpaque,
3489 recordIdOpaque_len);
3491 else if (recordIdNumber)
3493 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3495 notToKeep->elements[0]->u.number =
3496 odr_intdup(p->odr_out, atoi(recordIdNumber));
3499 notToKeep->elements[0]->u.opaque = 0;
3500 notToKeep->elements[0]->supplementalId = 0;
3501 if (correlationInfo_note || correlationInfo_id)
3503 Z_IUCorrelationInfo *ci;
3504 ci = notToKeep->elements[0]->correlationInfo =
3505 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3506 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3507 ci->id = correlationInfo_id ?
3508 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3511 notToKeep->elements[0]->correlationInfo = 0;
3512 if (recordOpaque_buf)
3514 notToKeep->elements[0]->record =
3515 z_ext_record_oid_any(p->odr_out, syntax_oid,
3516 recordOpaque_buf, recordOpaque_len);
3520 notToKeep->elements[0]->record =
3521 z_ext_record_oid(p->odr_out, syntax_oid,
3522 record_buf, record_len);
3527 ODR print = odr_createmem(ODR_PRINT);
3529 z_APDU(print, &apdu, 0, 0);
3536 ZOOM_package_send(ZOOM_package p, const char *type)
3543 odr_reset(p->odr_out);
3546 if (!strcmp(type, "itemorder"))
3548 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3551 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3553 r->direct_reference =
3554 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3556 r->which = Z_External_itemOrder;
3557 r->indirect_reference = 0;
3558 r->u.itemOrder = encode_item_order(p);
3560 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3563 else if (!strcmp(type, "create")) /* create database */
3565 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3568 else if (!strcmp(type, "drop")) /* drop database */
3570 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3573 else if (!strcmp(type, "commit")) /* commit changes */
3575 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3578 else if (!strcmp(type, "update")) /* update record(s) */
3580 apdu = create_update_package(p);
3582 else if (!strcmp(type, "xmlupdate"))
3584 apdu = create_xmlupdate_package(p);
3588 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3592 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3593 task->u.package = p;
3594 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3595 p->buf_out = (char *) xmalloc(p->len_out);
3596 memcpy(p->buf_out, buf, p->len_out);
3601 while (ZOOM_event(1, &c))
3608 ZOOM_API(ZOOM_package)
3609 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3611 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3614 p->odr_out = odr_createmem(ODR_ENCODE);
3615 p->options = ZOOM_options_create_with_parent2(options, c->options);
3623 ZOOM_package_destroy(ZOOM_package p)
3628 if (p->refcount == 0)
3630 odr_destroy(p->odr_out);
3633 ZOOM_options_destroy(p->options);
3638 ZOOM_API(const char *)
3639 ZOOM_package_option_get(ZOOM_package p, const char *key)
3641 return ZOOM_options_get(p->options, key);
3644 ZOOM_API(const char *)
3645 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3647 return ZOOM_options_getl(p->options, key, lenp);
3651 ZOOM_package_option_set(ZOOM_package p, const char *key,
3654 ZOOM_options_set(p->options, key, val);
3658 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3659 const char *val, int len)
3661 ZOOM_options_setl(p->options, key, val, len);
3665 ZOOM_connection_exec_task(ZOOM_connection c)
3667 ZOOM_task task = c->tasks;
3668 zoom_ret ret = zoom_complete;
3672 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3673 c, task->which, task->running);
3674 if (c->error != ZOOM_ERROR_NONE)
3676 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3677 "removing tasks because of error = %d", c, c->error);
3678 ZOOM_connection_remove_tasks(c);
3683 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3684 "task already running", c);
3688 ret = zoom_complete;
3689 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3691 switch (task->which)
3693 case ZOOM_TASK_SEARCH:
3694 if (c->proto == PROTO_HTTP)
3695 ret = ZOOM_connection_srw_send_search(c);
3697 ret = ZOOM_connection_send_search(c);
3699 case ZOOM_TASK_RETRIEVE:
3700 if (c->proto == PROTO_HTTP)
3701 ret = ZOOM_connection_srw_send_search(c);
3703 ret = send_present(c);
3705 case ZOOM_TASK_CONNECT:
3706 ret = do_connect(c);
3708 case ZOOM_TASK_SCAN:
3709 if (c->proto == PROTO_HTTP)
3710 ret = ZOOM_connection_srw_send_scan(c);
3712 ret = ZOOM_connection_send_scan(c);
3714 case ZOOM_TASK_PACKAGE:
3715 ret = send_package(c);
3717 case ZOOM_TASK_SORT:
3718 c->tasks->u.sort.resultset->r_sort_spec =
3719 c->tasks->u.sort.q->sort_spec;
3720 ret = send_sort(c, c->tasks->u.sort.resultset);
3726 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3727 "remove tasks because no connection exist", c);
3728 ZOOM_connection_remove_tasks(c);
3730 if (ret == zoom_complete)
3732 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3733 "task removed (complete)", c);
3734 ZOOM_connection_remove_task(c);
3737 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3742 static zoom_ret send_sort_present(ZOOM_connection c)
3744 zoom_ret r = zoom_complete;
3746 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3747 r = send_sort(c, c->tasks->u.search.resultset);
3748 if (r == zoom_complete)
3749 r = send_present(c);
3753 static int es_response_taskpackage_update(ZOOM_connection c,
3754 Z_IUUpdateTaskPackage *utp)
3756 if (utp && utp->targetPart)
3758 Z_IUTargetPart *targetPart = utp->targetPart;
3759 switch ( *targetPart->updateStatus ) {
3760 case Z_IUTargetPart_success:
3761 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3763 case Z_IUTargetPart_partial:
3764 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3766 case Z_IUTargetPart_failure:
3767 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3768 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3769 response_diag(c, targetPart->globalDiagnostics[0]);
3772 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3777 static int es_response_taskpackage(ZOOM_connection c,
3778 Z_TaskPackage *taskPackage)
3781 Odr_oct *id = taskPackage->targetReference;
3783 ZOOM_options_setl(c->tasks->u.package->options,
3784 "targetReference", (char*) id->buf, id->len);
3787 switch ( *taskPackage->taskStatus ) {
3788 case Z_TaskPackage_pending:
3789 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3791 case Z_TaskPackage_active:
3792 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3794 case Z_TaskPackage_complete:
3795 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3797 case Z_TaskPackage_aborted:
3798 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3799 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3800 response_diag(c, taskPackage->packageDiagnostics[0]);
3804 // taskSpecificParameters
3805 // NOTE: Only Update implemented, no others.
3806 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3807 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3808 es_response_taskpackage_update(c, utp);
3814 static int es_response(ZOOM_connection c,
3815 Z_ExtendedServicesResponse *res)
3817 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3819 switch (*res->operationStatus) {
3820 case Z_ExtendedServicesResponse_done:
3821 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3823 case Z_ExtendedServicesResponse_accepted:
3824 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3826 case Z_ExtendedServicesResponse_failure:
3827 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3828 if (res->diagnostics && res->num_diagnostics > 0)
3829 response_diag(c, res->diagnostics[0]);
3832 if (res->taskPackage &&
3833 res->taskPackage->which == Z_External_extendedService)
3835 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3836 es_response_taskpackage(c, taskPackage);
3838 if (res->taskPackage &&
3839 res->taskPackage->which == Z_External_octet)
3841 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3842 ZOOM_options_setl(c->tasks->u.package->options,
3843 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3848 static void interpret_init_diag(ZOOM_connection c,
3849 Z_DiagnosticFormat *diag)
3853 Z_DiagnosticFormat_s *ds = diag->elements[0];
3854 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3855 response_default_diag(c, ds->u.defaultDiagRec);
3860 static void interpret_otherinformation_field(ZOOM_connection c,
3861 Z_OtherInformation *ui)
3864 for (i = 0; i < ui->num_elements; i++)
3866 Z_OtherInformationUnit *unit = ui->list[i];
3867 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3868 unit->information.externallyDefinedInfo &&
3869 unit->information.externallyDefinedInfo->which ==
3872 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3878 static void set_init_option(const char *name, void *clientData) {
3879 ZOOM_connection c = (ZOOM_connection) clientData;
3882 sprintf(buf, "init_opt_%.70s", name);
3883 ZOOM_connection_option_set(c, buf, "1");
3887 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3889 Z_InitResponse *initrs;
3891 ZOOM_connection_set_mask(c, 0);
3892 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3895 case Z_APDU_initResponse:
3896 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3897 initrs = apdu->u.initResponse;
3898 ZOOM_connection_option_set(c, "serverImplementationId",
3899 initrs->implementationId ?
3900 initrs->implementationId : "");
3901 ZOOM_connection_option_set(c, "serverImplementationName",
3902 initrs->implementationName ?
3903 initrs->implementationName : "");
3904 ZOOM_connection_option_set(c, "serverImplementationVersion",
3905 initrs->implementationVersion ?
3906 initrs->implementationVersion : "");
3907 /* Set the three old options too, for old applications */
3908 ZOOM_connection_option_set(c, "targetImplementationId",
3909 initrs->implementationId ?
3910 initrs->implementationId : "");
3911 ZOOM_connection_option_set(c, "targetImplementationName",
3912 initrs->implementationName ?
3913 initrs->implementationName : "");
3914 ZOOM_connection_option_set(c, "targetImplementationVersion",
3915 initrs->implementationVersion ?
3916 initrs->implementationVersion : "");
3918 /* Make initrs->options available as ZOOM-level options */
3919 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3921 if (!*initrs->result)
3923 Z_External *uif = initrs->userInformationField;
3925 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3927 if (uif && uif->which == Z_External_userInfo1)
3928 interpret_otherinformation_field(c, uif->u.userInfo1);
3933 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3934 yaz_oid_userinfo_cookie, 1, 0);
3935 xfree(c->cookie_in);
3938 c->cookie_in = xstrdup(cookie);
3939 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3940 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3941 c->support_named_resultsets = 1;
3944 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3945 ZOOM_connection_remove_task(c);
3947 ZOOM_connection_exec_task(c);
3949 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3951 NMEM tmpmem = nmem_create();
3952 Z_CharSetandLanguageNegotiation *p =
3953 yaz_get_charneg_record(initrs->otherInfo);
3957 char *charset = NULL, *lang = NULL;
3960 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3961 yaz_log(log_details, "%p recv_apdu target accepted: "
3962 "charset %s, language %s, select %d",
3964 charset ? charset : "none", lang ? lang : "none", sel);
3966 ZOOM_connection_option_set(c, "negotiation-charset",
3969 ZOOM_connection_option_set(c, "negotiation-lang",
3972 ZOOM_connection_option_set(
3973 c, "negotiation-charset-in-effect-for-records",
3974 (sel != 0) ? "1" : "0");
3975 nmem_destroy(tmpmem);
3979 case Z_APDU_searchResponse:
3980 yaz_log(log_api, "%p recv_apdu Search response", c);
3981 handle_search_response(c, apdu->u.searchResponse);
3982 if (send_sort_present(c) == zoom_complete)
3983 ZOOM_connection_remove_task(c);
3985 case Z_APDU_presentResponse:
3986 yaz_log(log_api, "%p recv_apdu Present response", c);
3987 handle_present_response(c, apdu->u.presentResponse);
3988 if (send_present(c) == zoom_complete)
3989 ZOOM_connection_remove_task(c);
3991 case Z_APDU_sortResponse:
3992 yaz_log(log_api, "%p recv_apdu Sort response", c);
3993 sort_response(c, apdu->u.sortResponse);
3994 if (send_present(c) == zoom_complete)
3995 ZOOM_connection_remove_task(c);
3997 case Z_APDU_scanResponse:
3998 yaz_log(log_api, "%p recv_apdu Scan response", c);
3999 scan_response(c, apdu->u.scanResponse);
4000 ZOOM_connection_remove_task(c);
4002 case Z_APDU_extendedServicesResponse:
4003 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
4004 es_response(c, apdu->u.extendedServicesResponse);
4005 ZOOM_connection_remove_task(c);
4008 yaz_log(log_api, "%p recv_apdu Close PDU", c);
4009 if (!ZOOM_test_reconnect(c))
4011 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4016 yaz_log(log_api, "%p Received unknown PDU", c);
4017 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4023 static zoom_ret handle_srw_response(ZOOM_connection c,
4024 Z_SRW_searchRetrieveResponse *res)
4026 ZOOM_resultset resultset = 0;
4031 const char *syntax, *elementSetName;
4034 return zoom_complete;
4036 switch(c->tasks->which)
4038 case ZOOM_TASK_SEARCH:
4039 resultset = c->tasks->u.search.resultset;
4040 start = &c->tasks->u.search.start;
4041 count = &c->tasks->u.search.count;
4042 syntax = c->tasks->u.search.syntax;
4043 elementSetName = c->tasks->u.search.elementSetName;
4045 if (!c->tasks->u.search.recv_search_fired)
4047 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4048 ZOOM_connection_put_event(c, event);
4049 c->tasks->u.search.recv_search_fired = 1;
4052 case ZOOM_TASK_RETRIEVE:
4053 resultset = c->tasks->u.retrieve.resultset;
4054 start = &c->tasks->u.retrieve.start;
4055 count = &c->tasks->u.retrieve.count;
4056 syntax = c->tasks->u.retrieve.syntax;
4057 elementSetName = c->tasks->u.retrieve.elementSetName;
4060 return zoom_complete;
4063 resultset->size = 0;
4065 if (res->resultSetId)
4066 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4068 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4070 if (res->num_diagnostics > 0)
4072 set_SRU_error(c, &res->diagnostics[0]);
4076 if (res->numberOfRecords)
4077 resultset->size = *res->numberOfRecords;
4078 for (i = 0; i<res->num_records; i++)
4081 Z_SRW_record *sru_rec;
4082 Z_SRW_diagnostic *diag = 0;
4085 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4086 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4088 if (res->records[i].recordPosition &&
4089 *res->records[i].recordPosition > 0)
4090 pos = *res->records[i].recordPosition - 1;
4094 sru_rec = &res->records[i];
4096 npr->databaseName = 0;
4097 npr->which = Z_NamePlusRecord_databaseRecord;
4098 npr->u.databaseRecord = (Z_External *)
4099 odr_malloc(c->odr_in, sizeof(Z_External));
4100 npr->u.databaseRecord->descriptor = 0;
4101 npr->u.databaseRecord->direct_reference =
4102 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4103 npr->u.databaseRecord->which = Z_External_octet;
4105 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4106 odr_malloc(c->odr_in, sizeof(Odr_oct));
4107 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4108 sru_rec->recordData_buf;
4109 npr->u.databaseRecord->u.octet_aligned->len =
4110 npr->u.databaseRecord->u.octet_aligned->size =
4111 sru_rec->recordData_len;
4113 if (sru_rec->recordSchema
4114 && !strcmp(sru_rec->recordSchema,
4115 "info:srw/schema/1/diagnostics-v1.1"))
4117 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4118 sru_rec->recordData_len,
4122 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4123 sru_rec->recordSchema, diag);
4127 if (*count + *start > resultset->size)
4128 *count = resultset->size - *start;
4132 nmem = odr_extract_mem(c->odr_in);
4133 nmem_transfer(odr_getmem(resultset->odr), nmem);
4137 return ZOOM_connection_srw_send_search(c);
4139 return zoom_complete;
4144 static void handle_srw_scan_response(ZOOM_connection c,
4145 Z_SRW_scanResponse *res)
4147 NMEM nmem = odr_extract_mem(c->odr_in);
4150 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4152 scan = c->tasks->u.scan.scan;
4154 if (res->num_diagnostics > 0)
4155 set_SRU_error(c, &res->diagnostics[0]);
4157 scan->scan_response = 0;
4158 scan->srw_scan_response = res;
4159 nmem_transfer(odr_getmem(scan->odr), nmem);
4161 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4167 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
4169 Z_GDU *p = z_get_HTTP_Request(odr);
4170 const char *host = url;
4171 const char *cp0 = strstr(host, "://");
4172 const char *cp1 = 0;
4178 cp1 = strchr(cp0, '/');
4180 cp1 = cp0 + strlen(cp0);
4184 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
4185 memcpy (h, cp0, cp1 - cp0);
4187 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
4189 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
4193 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
4194 Z_HTTP_Response *cookie_hres)
4196 struct Z_HTTP_Header *h;
4197 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
4199 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
4200 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
4203 for (h = cookie_hres->headers; h; h = h->next)
4205 if (!strcmp(h->name, "Set-Cookie"))
4206 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
4207 "Cookie", h->value);
4209 if (c->user && c->password)
4211 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
4212 c->user, c->password);
4214 if (!z_GDU(c->odr_out, &gdu, 0, 0))
4215 return zoom_complete;
4217 z_GDU(c->odr_print, &gdu, 0, 0);
4218 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
4220 odr_reset(c->odr_out);
4224 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4226 zoom_ret cret = zoom_complete;
4228 const char *addinfo = 0;
4229 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4231 const char *location;
4233 ZOOM_connection_set_mask(c, 0);
4234 yaz_log(log_details, "%p handle_http", c);
4236 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
4237 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
4240 if (c->no_redirects > 10)
4242 set_HTTP_error(c, hres->code, 0, 0);
4243 c->no_redirects = 0;
4248 /* since redirect may change host we just reconnect. A smarter
4249 implementation might check whether it's the same server */
4250 do_connect_host(c, location, 0);
4251 send_SRW_redirect(c, location, hres);
4252 /* we're OK for now. Operation is not really complete */
4254 cret = zoom_pending;
4258 { /* not redirect (normal response) */
4259 if (!yaz_srw_check_content_type(hres))
4260 addinfo = "content-type";
4263 Z_SOAP *soap_package = 0;
4265 Z_SOAP_Handler soap_handlers[2] = {
4266 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4269 ret = z_soap_codec(o, &soap_package,
4270 &hres->content_buf, &hres->content_len,
4272 if (!ret && soap_package->which == Z_SOAP_generic &&
4273 soap_package->u.generic->no == 0)
4275 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4277 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4278 ZOOM_options_setl(c->options, "sru_extra_response_data",
4279 sr->extraResponseData_buf, sr->extraResponseData_len);
4280 if (sr->which == Z_SRW_searchRetrieve_response)
4281 cret = handle_srw_response(c, sr->u.response);
4282 else if (sr->which == Z_SRW_scan_response)
4283 handle_srw_scan_response(c, sr->u.scan_response);
4287 else if (!ret && (soap_package->which == Z_SOAP_fault
4288 || soap_package->which == Z_SOAP_error))
4290 set_HTTP_error(c, hres->code,
4291 soap_package->u.fault->fault_code,
4292 soap_package->u.fault->fault_string);
4299 if (c->no_redirects) /* end of redirect. change hosts again */
4302 c->no_redirects = 0;
4306 if (hres->code != 200)
4307 set_HTTP_error(c, hres->code, 0, 0);
4309 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4312 if (cret == zoom_complete)
4313 ZOOM_connection_remove_task(c);
4314 if (!strcmp(hres->version, "1.0"))
4316 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4317 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4322 /* HTTP 1.1: only if no close we stay alive .. */
4323 if (connection_head && !strcmp(connection_head, "close"))
4329 static int do_read(ZOOM_connection c)
4334 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4335 ZOOM_connection_put_event(c, event);
4337 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4338 more = cs_more(c->cs);
4339 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4344 if (!ZOOM_test_reconnect(c))
4346 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4355 odr_reset(c->odr_in);
4356 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4357 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4358 ZOOM_connection_put_event(c, event);
4360 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4363 int err = odr_geterrorx(c->odr_in, &x);
4365 const char *element = odr_getelement(c->odr_in);
4366 yaz_snprintf(msg, sizeof(msg),
4367 "ODR code %d:%d element=%s offset=%d",
4368 err, x, element ? element : "<unknown>",
4369 odr_offset(c->odr_in));
4370 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4373 FILE *ber_file = yaz_log_file();
4375 odr_dumpBER(ber_file, c->buf_in, r);
4382 z_GDU(c->odr_print, &gdu, 0, 0);
4383 if (gdu->which == Z_GDU_Z3950)
4384 recv_apdu(c, gdu->u.z3950);
4385 else if (gdu->which == Z_GDU_HTTP_Response)
4388 handle_http(c, gdu->u.HTTP_Response);
4390 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4395 c->reconnect_ok = 0;
4400 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4405 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4406 ZOOM_connection_put_event(c, event);
4408 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4409 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4411 yaz_log(log_details, "%p do_write_ex write failed", c);
4412 if (ZOOM_test_reconnect(c))
4414 return zoom_pending;
4416 if (c->state == STATE_CONNECTING)
4417 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4419 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4421 return zoom_complete;
4425 int mask = ZOOM_SELECT_EXCEPT;
4426 if (c->cs->io_pending & CS_WANT_WRITE)
4427 mask += ZOOM_SELECT_WRITE;
4428 if (c->cs->io_pending & CS_WANT_READ)
4429 mask += ZOOM_SELECT_READ;
4430 ZOOM_connection_set_mask(c, mask);
4431 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4436 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4437 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4440 return zoom_pending;
4443 static zoom_ret do_write(ZOOM_connection c)
4445 return do_write_ex(c, c->buf_out, c->len_out);
4449 ZOOM_API(const char *)
4450 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4452 return ZOOM_options_get(c->options, key);
4455 ZOOM_API(const char *)
4456 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4458 return ZOOM_options_getl(c->options, key, lenp);
4462 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4465 ZOOM_options_set(c->options, key, val);
4469 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4470 const char *val, int len)
4472 ZOOM_options_setl(c->options, key, val, len);
4475 ZOOM_API(const char *)
4476 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4478 return ZOOM_options_get(r->options, key);
4482 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4485 ZOOM_options_set(r->options, key, val);
4490 ZOOM_connection_errcode(ZOOM_connection c)
4492 return ZOOM_connection_error(c, 0, 0);
4495 ZOOM_API(const char *)
4496 ZOOM_connection_errmsg(ZOOM_connection c)
4499 ZOOM_connection_error(c, &msg, 0);
4503 ZOOM_API(const char *)
4504 ZOOM_connection_addinfo(ZOOM_connection c)
4506 const char *addinfo;
4507 ZOOM_connection_error(c, 0, &addinfo);
4511 ZOOM_API(const char *)
4512 ZOOM_connection_diagset(ZOOM_connection c)
4514 const char *diagset;
4515 ZOOM_connection_error_x(c, 0, 0, &diagset);
4519 ZOOM_API(const char *)
4520 ZOOM_diag_str(int error)
4524 case ZOOM_ERROR_NONE:
4526 case ZOOM_ERROR_CONNECT:
4527 return "Connect failed";
4528 case ZOOM_ERROR_MEMORY:
4529 return "Out of memory";
4530 case ZOOM_ERROR_ENCODE:
4531 return "Encoding failed";
4532 case ZOOM_ERROR_DECODE:
4533 return "Decoding failed";
4534 case ZOOM_ERROR_CONNECTION_LOST:
4535 return "Connection lost";
4536 case ZOOM_ERROR_INIT:
4537 return "Init rejected";
4538 case ZOOM_ERROR_INTERNAL:
4539 return "Internal failure";
4540 case ZOOM_ERROR_TIMEOUT:
4542 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4543 return "Unsupported protocol";
4544 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4545 return "Unsupported query type";
4546 case ZOOM_ERROR_INVALID_QUERY:
4547 return "Invalid query";
4548 case ZOOM_ERROR_CQL_PARSE:
4549 return "CQL parsing error";
4550 case ZOOM_ERROR_CQL_TRANSFORM:
4551 return "CQL transformation error";
4552 case ZOOM_ERROR_CCL_CONFIG:
4553 return "CCL configuration error";
4554 case ZOOM_ERROR_CCL_PARSE:
4555 return "CCL parsing error";
4557 return diagbib1_str(error);
4562 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4563 const char **addinfo, const char **diagset)
4565 int error = c->error;
4568 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4569 *cp = ZOOM_diag_str(error);
4570 else if (!strcmp(c->diagset, "HTTP"))
4571 *cp = z_HTTP_errmsg(c->error);
4572 else if (!strcmp(c->diagset, "Bib-1"))
4573 *cp = ZOOM_diag_str(error);
4574 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4575 *cp = yaz_diag_srw_str(c->error);
4577 *cp = "Unknown error and diagnostic set";
4580 *addinfo = c->addinfo ? c->addinfo : "";
4582 *diagset = c->diagset ? c->diagset : "";
4587 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4588 const char **addinfo)
4590 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4593 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4595 ZOOM_Event event = 0;
4596 int r = cs_look(c->cs);
4597 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4602 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4603 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4605 ZOOM_connection_put_event(c, event);
4607 else if (r == CS_CONNECT)
4609 int ret = ret = cs_rcvconnect(c->cs);
4610 yaz_log(log_details, "%p ZOOM_connection_do_io "
4611 "cs_rcvconnect returned %d", c, ret);
4614 int mask = ZOOM_SELECT_EXCEPT;
4615 if (c->cs->io_pending & CS_WANT_WRITE)
4616 mask += ZOOM_SELECT_WRITE;
4617 if (c->cs->io_pending & CS_WANT_READ)
4618 mask += ZOOM_SELECT_READ;
4619 ZOOM_connection_set_mask(c, mask);
4620 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4621 ZOOM_connection_put_event(c, event);
4625 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4626 ZOOM_connection_put_event(c, event);
4628 if (c->proto == PROTO_Z3950)
4629 ZOOM_connection_send_init(c);
4632 /* no init request for SRW .. */
4633 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4634 ZOOM_connection_remove_task(c);
4635 ZOOM_connection_set_mask(c, 0);
4636 ZOOM_connection_exec_task(c);
4638 c->state = STATE_ESTABLISHED;
4642 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4648 if (mask & ZOOM_SELECT_EXCEPT)
4650 if (!ZOOM_test_reconnect(c))
4652 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4657 if (mask & ZOOM_SELECT_READ)
4659 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4665 ZOOM_connection_last_event(ZOOM_connection cs)
4668 return ZOOM_EVENT_NONE;
4669 return cs->last_event;
4673 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4675 WRBUF wrbuf = (WRBUF) client_data;
4676 wrbuf_puts(wrbuf, buf);
4680 * Returns an xmalloc()d string containing RPN that corresponds to the
4681 * CQL passed in. On error, sets the Connection object's error state
4682 * and returns a null pointer.
4683 * ### We could cache CQL parser and/or transformer in Connection.
4685 static char *cql2pqf(ZOOM_connection c, const char *cql)
4689 const char *cqlfile;
4690 cql_transform_t trans;
4693 parser = cql_parser_create();
4694 if ((error = cql_parser_string(parser, cql)) != 0) {
4695 cql_parser_destroy(parser);
4696 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4700 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4703 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4705 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4708 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4709 cqlfile, strerror(errno));
4710 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4714 WRBUF wrbuf_result = wrbuf_alloc();
4715 error = cql_transform(trans, cql_parser_result(parser),
4716 cql2pqf_wrbuf_puts, wrbuf_result);
4719 const char *addinfo;
4720 error = cql_transform_error(trans, &addinfo);
4721 sprintf(buf, "%.200s (addinfo=%.200s)",
4722 cql_strerror(error), addinfo);
4723 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4727 result = xstrdup(wrbuf_cstr(wrbuf_result));
4729 cql_transform_close(trans);
4730 wrbuf_destroy(wrbuf_result);
4732 cql_parser_destroy(parser);
4736 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4740 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4741 /* timeout and this connection was waiting */
4742 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4744 ZOOM_connection_put_event(c, event);
4750 ZOOM_connection_process(ZOOM_connection c)
4756 event = ZOOM_connection_get_event(c);
4759 ZOOM_Event_destroy(event);
4762 ZOOM_connection_exec_task(c);
4763 event = ZOOM_connection_get_event(c);
4766 ZOOM_Event_destroy(event);
4773 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4777 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4779 for (i = 0; i<no; i++)
4781 ZOOM_connection c = cs[i];
4783 if (c && ZOOM_connection_process(c))
4789 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4791 if (c->mask && mask)
4792 ZOOM_connection_do_io(c, mask);
4796 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4799 return cs_fileno(c->cs);
4803 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4811 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4818 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4820 return ZOOM_options_get_int(c->options, "timeout", 30);
4823 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
4831 * c-file-style: "Stroustrup"
4832 * indent-tabs-mode: nil
4834 * vim: shiftwidth=4 tabstop=8 expandtab