1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 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 static int log_api = 0;
32 static int log_details = 0;
39 static void resultset_destroy(ZOOM_resultset r);
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
44 ZOOM_API(const char *) ZOOM_get_event_str(int event)
46 static const char *ar[] = {
63 * This wrapper is just for logging failed lookups. It would be nicer
64 * if it could cause failure when a lookup fails, but that's hard.
66 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
67 oid_class oid_class, const char *str) {
68 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
71 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
72 c, (int) oid_class, str);
77 static void initlog(void)
79 static int log_level_initialized = 0;
80 if (!log_level_initialized)
82 log_api = yaz_log_module_level("zoom");
83 log_details = yaz_log_module_level("zoomdetails");
84 log_level_initialized = 1;
88 static ZOOM_Event ZOOM_Event_create(int kind)
90 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
94 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
98 static void ZOOM_Event_destroy(ZOOM_Event event)
103 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
107 c->m_queue_back->prev = event;
108 assert(c->m_queue_front);
112 assert(!c->m_queue_front);
113 c->m_queue_front = event;
115 event->next = c->m_queue_back;
117 c->m_queue_back = event;
120 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
122 ZOOM_Event event = c->m_queue_front;
125 c->last_event = ZOOM_EVENT_NONE;
128 assert(c->m_queue_back);
129 c->m_queue_front = event->prev;
130 if (c->m_queue_front)
132 assert(c->m_queue_back);
133 c->m_queue_front->next = 0;
137 c->last_event = event->kind;
141 static void ZOOM_connection_remove_events(ZOOM_connection c)
144 while ((event = ZOOM_connection_get_event(c)))
145 ZOOM_Event_destroy(event);
148 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
150 ZOOM_Event event = c->m_queue_front;
152 return event ? event->kind : ZOOM_EVENT_NONE;
155 void ZOOM_connection_remove_tasks(ZOOM_connection c);
157 static void set_dset_error(ZOOM_connection c, int error,
159 const char *addinfo, const char *addinfo2)
166 if (!c->diagset || strcmp(dset, c->diagset))
169 c->diagset = xstrdup(dset);
170 /* remove integer part from SRW diagset .. */
171 if ((cp = strrchr(c->diagset, '/')))
174 if (addinfo && addinfo2)
176 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
177 strcpy(c->addinfo, addinfo);
178 strcat(c->addinfo, addinfo2);
181 c->addinfo = xstrdup(addinfo);
182 if (error != ZOOM_ERROR_NONE)
184 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
185 c, c->host_port ? c->host_port : "<>", dset, error,
186 addinfo ? addinfo : "",
187 addinfo2 ? addinfo2 : "");
188 ZOOM_connection_remove_tasks(c);
192 static int uri_to_code(const char *uri)
196 if ((cp = strrchr(uri, '/')))
202 static void set_HTTP_error(ZOOM_connection c, int error,
203 const char *addinfo, const char *addinfo2)
205 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
208 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
210 const char *uri = d->uri;
212 set_dset_error(c, uri_to_code(uri), uri, d->details, 0);
218 static void set_ZOOM_error(ZOOM_connection c, int error,
221 set_dset_error(c, error, "ZOOM", addinfo, 0);
224 static void clear_error(ZOOM_connection c)
227 * If an error is tied to an operation then it's ok to clear: for
228 * example, a diagnostic returned from a search is cleared by a
229 * subsequent search. However, problems such as Connection Lost
230 * or Init Refused are not cleared, because they are not
231 * recoverable: doing another search doesn't help.
234 ZOOM_connection_remove_events(c);
237 case ZOOM_ERROR_CONNECT:
238 case ZOOM_ERROR_MEMORY:
239 case ZOOM_ERROR_DECODE:
240 case ZOOM_ERROR_CONNECTION_LOST:
241 case ZOOM_ERROR_INIT:
242 case ZOOM_ERROR_INTERNAL:
243 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
246 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
250 void ZOOM_connection_show_task(ZOOM_task task)
254 case ZOOM_TASK_SEARCH:
255 yaz_log(YLOG_LOG, "search p=%p", task);
257 case ZOOM_TASK_RETRIEVE:
258 yaz_log(YLOG_LOG, "retrieve p=%p", task);
260 case ZOOM_TASK_CONNECT:
261 yaz_log(YLOG_LOG, "connect p=%p", task);
264 yaz_log(YLOG_LOG, "scan p=%p", task);
269 void ZOOM_connection_show_tasks(ZOOM_connection c)
272 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
273 for (task = c->tasks; task; task = task->next)
274 ZOOM_connection_show_task(task);
277 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
279 ZOOM_task *taskp = &c->tasks;
281 taskp = &(*taskp)->next;
282 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
283 (*taskp)->running = 0;
284 (*taskp)->which = which;
290 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
292 return c->tasks ? 0 : 1;
295 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
297 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
299 task->next = c->tasks;
308 void ZOOM_connection_remove_task(ZOOM_connection c)
310 ZOOM_task task = c->tasks;
314 c->tasks = task->next;
317 case ZOOM_TASK_SEARCH:
318 resultset_destroy(task->u.search.resultset);
319 xfree(task->u.search.syntax);
320 xfree(task->u.search.elementSetName);
322 case ZOOM_TASK_RETRIEVE:
323 resultset_destroy(task->u.retrieve.resultset);
324 xfree(task->u.retrieve.syntax);
325 xfree(task->u.retrieve.elementSetName);
327 case ZOOM_TASK_CONNECT:
330 ZOOM_scanset_destroy(task->u.scan.scan);
332 case ZOOM_TASK_PACKAGE:
333 ZOOM_package_destroy(task->u.package);
336 resultset_destroy(task->u.sort.resultset);
337 ZOOM_query_destroy(task->u.sort.q);
346 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
347 ZOOM_connection_put_event(c, event);
352 static int ZOOM_connection_exec_task(ZOOM_connection c);
354 void ZOOM_connection_remove_tasks(ZOOM_connection c)
357 ZOOM_connection_remove_task(c);
360 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
362 const char *elementSetName);
364 ZOOM_API(ZOOM_connection)
365 ZOOM_connection_create(ZOOM_options options)
367 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
371 yaz_log(log_api, "%p ZOOM_connection_create", c);
373 c->proto = PROTO_Z3950;
375 ZOOM_connection_set_mask(c, 0);
377 c->state = STATE_IDLE;
380 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
387 c->options = ZOOM_options_create_with_parent(options);
393 c->charset = c->lang = 0;
404 c->maximum_record_size = 0;
405 c->preferred_message_size = 0;
407 c->odr_in = odr_createmem(ODR_DECODE);
408 c->odr_out = odr_createmem(ODR_ENCODE);
411 c->support_named_resultsets = 0;
412 c->last_event = ZOOM_EVENT_NONE;
414 c->m_queue_front = 0;
422 /* set database names. Take local databases (if set); otherwise
423 take databases given in ZURL (if set); otherwise use Default */
424 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
427 char **databaseNames;
428 const char *cp = ZOOM_options_get(options, "databaseName");
430 if ((!cp || !*cp) && con->host_port)
432 if (strncmp(con->host_port, "unix:", 5) == 0)
433 cp = strchr(con->host_port+5, ':');
435 cp = strchr(con->host_port, '/');
441 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
442 return databaseNames;
445 ZOOM_API(ZOOM_connection)
446 ZOOM_connection_new(const char *host, int portnum)
448 ZOOM_connection c = ZOOM_connection_create(0);
450 ZOOM_connection_connect(c, host, portnum);
454 static zoom_sru_mode get_sru_mode_from_string(const char *s)
457 return zoom_sru_soap;
458 if (!yaz_matchstr(s, "soap"))
459 return zoom_sru_soap;
460 else if (!yaz_matchstr(s, "get"))
462 else if (!yaz_matchstr(s, "post"))
463 return zoom_sru_post;
464 return zoom_sru_error;
468 ZOOM_connection_connect(ZOOM_connection c,
469 const char *host, int portnum)
476 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
477 c, host ? host : "null", portnum);
479 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
480 ZOOM_connection_remove_tasks(c);
482 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
484 c->odr_print = odr_createmem(ODR_PRINT);
485 odr_setprint(c->odr_print, yaz_log_file());
492 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
496 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
499 val = ZOOM_options_get(c->options, "proxy");
502 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
503 c->proxy = xstrdup(val);
508 val = ZOOM_options_get(c->options, "charset");
511 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
512 c->charset = xstrdup(val);
516 val = ZOOM_options_get(c->options, "lang");
519 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
520 c->lang = xstrdup(val);
531 sprintf(hostn, "%.80s:%d", host, portnum);
532 c->host_port = xstrdup(hostn);
535 c->host_port = xstrdup(host);
540 * If the "<scheme>:" part of the host string is preceded by one
541 * or more comma-separated <name>=<value> pairs, these are taken
542 * to be options to be set on the connection object. Among other
543 * applications, this facility can be used to embed authentication
545 * user=admin,password=secret,tcp:localhost:9999
547 char *remainder = c->host_port;
548 char *pcolon = strchr(remainder, ':');
551 while ((pcomma = strchr(remainder, ',')) != 0 &&
552 (pcolon == 0 || pcomma < pcolon)) {
554 if ((pequals = strchr(remainder, '=')) != 0) {
556 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
557 ZOOM_connection_option_set(c, remainder, pequals+1);
559 remainder = pcomma+1;
562 if (remainder != c->host_port) {
564 c->host_port = xstrdup(remainder);
565 /*printf("# reset hp='%s'\n", remainder);*/
569 val = ZOOM_options_get(c->options, "sru");
570 c->sru_mode = get_sru_mode_from_string(val);
572 xfree(c->sru_version);
573 val = ZOOM_options_get(c->options, "sru_version");
574 c->sru_version = xstrdup(val ? val : "1.2");
576 ZOOM_options_set(c->options, "host", c->host_port);
578 xfree(c->cookie_out);
580 val = ZOOM_options_get(c->options, "cookie");
583 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
584 c->cookie_out = xstrdup(val);
589 val = ZOOM_options_get(c->options, "clientIP");
592 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
594 c->client_IP = xstrdup(val);
599 val = ZOOM_options_get(c->options, "group");
601 c->group = xstrdup(val);
605 val = ZOOM_options_get(c->options, "user");
607 c->user = xstrdup(val);
611 val = ZOOM_options_get(c->options, "password");
613 val = ZOOM_options_get(c->options, "pass");
616 c->password = xstrdup(val);
618 c->maximum_record_size =
619 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
620 c->preferred_message_size =
621 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
623 c->async = ZOOM_options_get_bool(c->options, "async", 0);
624 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
626 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
630 while (ZOOM_event(1, &c))
636 ZOOM_query_create(void)
638 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
640 yaz_log(log_details, "%p ZOOM_query_create", s);
644 s->odr = odr_createmem(ODR_ENCODE);
651 ZOOM_query_destroy(ZOOM_query s)
657 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
658 if (s->refcount == 0)
666 ZOOM_query_prefix(ZOOM_query s, const char *str)
668 s->query_string = odr_strdup(s->odr, str);
669 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
670 s->z_query->which = Z_Query_type_1;
671 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
672 if (!s->z_query->u.type_1)
674 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
678 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
683 ZOOM_query_cql(ZOOM_query s, const char *str)
687 s->query_string = odr_strdup(s->odr, str);
689 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
690 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
691 ext->indirect_reference = 0;
693 ext->which = Z_External_CQL;
694 ext->u.cql = s->query_string;
696 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
697 s->z_query->which = Z_Query_type_104;
698 s->z_query->u.type_104 = ext;
700 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
706 * Translate the CQL string client-side into RPN which is passed to
707 * the server. This is useful for server's that don't themselves
708 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
709 * only as a place to stash diagnostics if compilation fails; if this
710 * information is not needed, a null pointer may be used.
713 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
717 ZOOM_connection freeme = 0;
719 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
721 conn = freeme = ZOOM_connection_create(0);
723 rpn = cql2pqf(conn, str);
725 ZOOM_connection_destroy(freeme);
729 ret = ZOOM_query_prefix(s, rpn);
735 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
736 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
737 * to the server, as the YAZ GFS doesn't know how to handle this.
740 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
741 int *ccl_error, const char **error_string,
745 struct ccl_rpn_node *rpn;
746 CCL_bibset bibset = ccl_qual_mk();
749 ccl_qual_buf(bibset, config);
751 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
754 *error_string = ccl_err_msg(*ccl_error);
759 WRBUF wr = wrbuf_alloc();
762 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
765 ccl_qual_rm(&bibset);
770 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
772 s->sort_spec = yaz_sort_spec(s->odr, criteria);
775 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
779 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
783 static zoom_ret do_write(ZOOM_connection c);
786 ZOOM_connection_destroy(ZOOM_connection c)
791 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
794 for (r = c->resultsets; r; r = r->next)
800 odr_destroy(c->odr_in);
801 odr_destroy(c->odr_out);
804 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
805 odr_destroy(c->odr_print);
807 ZOOM_options_destroy(c->options);
808 ZOOM_connection_remove_tasks(c);
809 ZOOM_connection_remove_events(c);
815 xfree(c->cookie_out);
821 xfree(c->sru_version);
825 void ZOOM_resultset_addref(ZOOM_resultset r)
830 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
835 ZOOM_resultset ZOOM_resultset_create(void)
838 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
842 yaz_log(log_details, "%p ZOOM_resultset_create", r);
845 r->odr = odr_createmem(ODR_ENCODE);
850 for (i = 0; i<RECORD_HASH_SIZE; i++)
851 r->record_hash[i] = 0;
856 r->databaseNames = 0;
857 r->num_databaseNames = 0;
861 ZOOM_API(ZOOM_resultset)
862 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
865 ZOOM_query s = ZOOM_query_create();
867 ZOOM_query_prefix(s, q);
869 r = ZOOM_connection_search(c, s);
870 ZOOM_query_destroy(s);
874 ZOOM_API(ZOOM_resultset)
875 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
877 ZOOM_resultset r = ZOOM_resultset_create();
881 const char *syntax, *elementSetName;
883 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
884 r->r_sort_spec = q->sort_spec;
887 r->options = ZOOM_options_create_with_parent(c->options);
889 start = ZOOM_options_get_int(r->options, "start", 0);
890 count = ZOOM_options_get_int(r->options, "count", 0);
892 /* If "presentChunk" is defined use that; otherwise "step" */
893 const char *cp = ZOOM_options_get(r->options, "presentChunk");
894 r->step = ZOOM_options_get_int(r->options,
895 (cp != 0 ? "presentChunk": "step"), 0);
897 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
898 cp = ZOOM_options_get(r->options, "setname");
900 r->setname = xstrdup(cp);
901 cp = ZOOM_options_get(r->options, "schema");
903 r->schema = xstrdup(cp);
905 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
910 r->next = c->resultsets;
915 if (c->host_port && c->proto == PROTO_HTTP)
919 yaz_log(log_details, "ZOOM_connection_search: no comstack");
920 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
924 yaz_log(log_details, "ZOOM_connection_search: reconnect");
929 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
930 task->u.search.resultset = r;
931 task->u.search.start = start;
932 task->u.search.count = count;
933 task->u.search.recv_search_fired = 0;
935 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
936 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
937 elementSetName = ZOOM_options_get(r->options, "elementSetName");
938 task->u.search.elementSetName = elementSetName
939 ? xstrdup(elementSetName) : 0;
941 ZOOM_resultset_addref(r);
947 while (ZOOM_event(1, &c))
954 ZOOM_resultset_sort(ZOOM_resultset r,
955 const char *sort_type, const char *sort_spec)
957 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
961 ZOOM_resultset_sort1(ZOOM_resultset r,
962 const char *sort_type, const char *sort_spec)
964 ZOOM_connection c = r->connection;
968 newq = ZOOM_query_create();
969 if (ZOOM_query_sortby(newq, sort_spec) < 0)
972 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
973 r, r, sort_type, sort_spec);
977 if (c->host_port && c->proto == PROTO_HTTP)
981 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
982 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
986 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
992 ZOOM_resultset_cache_reset(r);
993 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
994 task->u.sort.resultset = r;
995 task->u.sort.q = newq;
997 ZOOM_resultset_addref(r);
1001 while (ZOOM_event(1, &c))
1009 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1012 for (i = 0; i<RECORD_HASH_SIZE; i++)
1014 ZOOM_record_cache rc;
1015 for (rc = r->record_hash[i]; rc; rc = rc->next)
1017 if (rc->rec.wrbuf_marc)
1018 wrbuf_destroy(rc->rec.wrbuf_marc);
1019 if (rc->rec.wrbuf_iconv)
1020 wrbuf_destroy(rc->rec.wrbuf_iconv);
1021 if (rc->rec.wrbuf_opac)
1022 wrbuf_destroy(rc->rec.wrbuf_opac);
1024 r->record_hash[i] = 0;
1029 ZOOM_resultset_destroy(ZOOM_resultset r)
1031 resultset_destroy(r);
1034 static void resultset_destroy(ZOOM_resultset r)
1039 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1041 if (r->refcount == 0)
1043 ZOOM_resultset_cache_reset(r);
1047 /* remove ourselves from the resultsets in connection */
1048 ZOOM_resultset *rp = &r->connection->resultsets;
1051 assert(*rp); /* we must be in this list!! */
1053 { /* OK, we're here - take us out of it */
1060 ZOOM_query_destroy(r->query);
1061 ZOOM_options_destroy(r->options);
1062 odr_destroy(r->odr);
1070 ZOOM_resultset_size(ZOOM_resultset r)
1072 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1077 static void do_close(ZOOM_connection c)
1082 ZOOM_connection_set_mask(c, 0);
1083 c->state = STATE_IDLE;
1086 static int ZOOM_test_reconnect(ZOOM_connection c)
1090 if (!c->reconnect_ok)
1093 c->reconnect_ok = 0;
1094 c->tasks->running = 0;
1095 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1097 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1098 ZOOM_connection_put_event(c, event);
1103 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1104 int force_sync, int start, int count)
1109 const char *syntax, *elementSetName;
1113 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1114 " count=%d", r, force_sync, start, count);
1119 if (c->host_port && c->proto == PROTO_HTTP)
1123 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1124 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1128 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1130 c->reconnect_ok = 1;
1133 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1134 task->u.retrieve.resultset = r;
1135 task->u.retrieve.start = start;
1136 task->u.retrieve.count = count;
1138 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1139 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1140 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1141 task->u.retrieve.elementSetName = elementSetName
1142 ? xstrdup(elementSetName) : 0;
1144 cp = ZOOM_options_get(r->options, "schema");
1147 if (!r->schema || strcmp(r->schema, cp))
1150 r->schema = xstrdup(cp);
1154 ZOOM_resultset_addref(r);
1156 if (!r->connection->async || force_sync)
1157 while (r->connection && ZOOM_event(1, &r->connection))
1162 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1163 size_t start, size_t count)
1165 int force_present = 0;
1169 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1170 r, r, (long) start, (long) count);
1173 ZOOM_resultset_retrieve(r, force_present, start, count);
1177 for (i = 0; i< count; i++)
1178 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1182 static void get_cert(ZOOM_connection c)
1187 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1189 ZOOM_connection_option_setl(c, "sslPeerCert",
1190 cert_buf, cert_len);
1195 static zoom_ret do_connect(ZOOM_connection c)
1198 const char *effective_host;
1201 effective_host = c->proxy;
1203 effective_host = c->host_port;
1205 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1209 c->cs = cs_create_host(effective_host, 0, &add);
1211 if (c->cs && c->cs->protocol == PROTO_HTTP)
1214 const char *path = 0;
1216 c->proto = PROTO_HTTP;
1217 cs_get_host_args(c->host_port, &path);
1219 c->path = (char*) xmalloc(strlen(path)+2);
1221 strcpy(c->path+1, path);
1223 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1225 return zoom_complete;
1230 int ret = cs_connect(c->cs, add);
1233 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1234 ZOOM_connection_put_event(c, event);
1236 if (c->proto == PROTO_Z3950)
1237 ZOOM_connection_send_init(c);
1240 /* no init request for SRW .. */
1241 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1242 ZOOM_connection_remove_task(c);
1243 ZOOM_connection_set_mask(c, 0);
1244 ZOOM_connection_exec_task(c);
1246 c->state = STATE_ESTABLISHED;
1247 return zoom_pending;
1251 int mask = ZOOM_SELECT_EXCEPT;
1252 if (c->cs->io_pending & CS_WANT_WRITE)
1253 mask += ZOOM_SELECT_WRITE;
1254 if (c->cs->io_pending & CS_WANT_READ)
1255 mask += ZOOM_SELECT_READ;
1256 ZOOM_connection_set_mask(c, mask);
1257 c->state = STATE_CONNECTING;
1258 return zoom_pending;
1261 c->state = STATE_IDLE;
1262 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1263 return zoom_complete;
1266 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1269 for (i = 0; i<200; i++)
1273 Z_OtherInformation **oi;
1278 sprintf(buf, "otherInfo%d", i);
1279 val = ZOOM_options_get(c->options, buf);
1282 cp = strchr(val, ':');
1286 if (len >= sizeof(buf))
1287 len = sizeof(buf)-1;
1288 memcpy(buf, val, len);
1291 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1296 yaz_oi_APDU(a, &oi);
1297 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1301 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1306 Z_OtherInformation **oi;
1307 yaz_oi_APDU(a, &oi);
1308 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1313 Z_OtherInformation **oi;
1314 yaz_oi_APDU(a, &oi);
1315 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1318 otherInfo_attach(c, a, out);
1319 if (!z_APDU(out, &a, 0, 0))
1321 FILE *outf = fopen("/tmp/apdu.txt", "a");
1324 ODR odr_pr = odr_createmem(ODR_PRINT);
1325 fprintf(outf, "a=%p\n", a);
1326 odr_setprint(odr_pr, outf);
1327 z_APDU(odr_pr, &a, 0, 0);
1328 odr_destroy(odr_pr);
1330 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1331 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1336 z_APDU(c->odr_print, &a, 0, 0);
1337 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1341 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1345 if (encode_APDU(c, a, c->odr_out))
1346 return zoom_complete;
1347 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1348 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1349 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1350 ZOOM_connection_put_event(c, event);
1351 odr_reset(c->odr_out);
1355 /* returns 1 if PDU was sent OK (still pending )
1356 0 if PDU was not sent OK (nothing to wait for)
1359 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1361 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1362 Z_InitRequest *ireq = apdu->u.initRequest;
1363 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1364 odr_malloc(c->odr_out, sizeof(*auth));
1367 ODR_MASK_SET(ireq->options, Z_Options_search);
1368 ODR_MASK_SET(ireq->options, Z_Options_present);
1369 ODR_MASK_SET(ireq->options, Z_Options_scan);
1370 ODR_MASK_SET(ireq->options, Z_Options_sort);
1371 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1372 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1374 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1375 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1376 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1378 /* Index Data's Z39.50 Implementor Id is 81 */
1379 ireq->implementationId =
1380 odr_prepend(c->odr_out,
1381 ZOOM_options_get(c->options, "implementationId"),
1382 odr_prepend(c->odr_out, "81", ireq->implementationId));
1384 ireq->implementationName =
1385 odr_prepend(c->odr_out,
1386 ZOOM_options_get(c->options, "implementationName"),
1387 odr_prepend(c->odr_out, "ZOOM-C",
1388 ireq->implementationName));
1390 version = odr_strdup(c->odr_out, "$Revision: 1.154 $");
1391 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1392 version[strlen(version)-2] = '\0';
1393 ireq->implementationVersion =
1394 odr_prepend(c->odr_out,
1395 ZOOM_options_get(c->options, "implementationVersion"),
1396 odr_prepend(c->odr_out, &version[11],
1397 ireq->implementationVersion));
1399 *ireq->maximumRecordSize = c->maximum_record_size;
1400 *ireq->preferredMessageSize = c->preferred_message_size;
1402 if (c->group || c->password)
1404 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1405 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1406 pass->userId = odr_strdup_null(c->odr_out, c->user);
1407 pass->password = odr_strdup_null(c->odr_out, c->password);
1408 auth->which = Z_IdAuthentication_idPass;
1409 auth->u.idPass = pass;
1410 ireq->idAuthentication = auth;
1414 auth->which = Z_IdAuthentication_open;
1415 auth->u.open = odr_strdup(c->odr_out, c->user);
1416 ireq->idAuthentication = auth;
1420 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1421 yaz_oid_userinfo_proxy, 1, c->host_port);
1423 if (c->charset || c->lang)
1425 Z_OtherInformation **oi;
1426 Z_OtherInformationUnit *oi_unit;
1428 yaz_oi_APDU(apdu, &oi);
1430 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1432 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1433 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1434 oi_unit->information.externallyDefinedInfo =
1435 yaz_set_proposal_charneg_list(c->odr_out, " ",
1436 c->charset, c->lang, 1);
1440 return send_APDU(c, apdu);
1444 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1448 const char *database = ZOOM_options_get(c->options, "databaseName");
1449 char *fdatabase = 0;
1453 fdatabase = (char *) odr_malloc(c->odr_out, strlen(database)+2);
1454 strcpy(fdatabase, "/");
1455 strcat(fdatabase, database);
1457 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1458 fdatabase ? fdatabase : c->path);
1460 if (c->sru_mode == zoom_sru_get)
1462 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1464 else if (c->sru_mode == zoom_sru_post)
1466 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1468 else if (c->sru_mode == zoom_sru_soap)
1470 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1472 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1473 return zoom_complete;
1475 z_GDU(c->odr_print, &gdu, 0, 0);
1476 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1478 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1479 ZOOM_connection_put_event(c, event);
1480 odr_reset(c->odr_out);
1486 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1488 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1489 sr->username = c->user;
1490 sr->password = c->password;
1496 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1500 ZOOM_resultset resultset = 0;
1502 const char *option_val = 0;
1504 if (c->error) /* don't continue on error */
1505 return zoom_complete;
1507 switch(c->tasks->which)
1509 case ZOOM_TASK_SEARCH:
1510 resultset = c->tasks->u.search.resultset;
1511 if (!resultset->setname)
1512 resultset->setname = xstrdup("default");
1513 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1514 start = &c->tasks->u.search.start;
1515 count = &c->tasks->u.search.count;
1517 case ZOOM_TASK_RETRIEVE:
1518 resultset = c->tasks->u.retrieve.resultset;
1520 start = &c->tasks->u.retrieve.start;
1521 count = &c->tasks->u.retrieve.count;
1523 if (*start >= resultset->size)
1524 return zoom_complete;
1525 if (*start + *count > resultset->size)
1526 *count = resultset->size - *start;
1528 for (i = 0; i < *count; i++)
1531 record_cache_lookup(resultset, i + *start,
1532 c->tasks->u.retrieve.syntax,
1533 c->tasks->u.retrieve.elementSetName);
1538 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1539 ZOOM_connection_put_event(c, event);
1546 return zoom_complete;
1549 return zoom_complete;
1551 assert(resultset->query);
1553 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1554 if (resultset->query->z_query->which == Z_Query_type_104
1555 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1557 sr->u.request->query_type = Z_SRW_query_type_cql;
1558 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1560 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1561 resultset->query->z_query->u.type_1)
1563 sr->u.request->query_type = Z_SRW_query_type_pqf;
1564 sr->u.request->query.pqf = resultset->query->query_string;
1568 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1569 return zoom_complete;
1571 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1572 sr->u.request->maximumRecords = odr_intdup(
1573 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1574 resultset->step : *count);
1575 sr->u.request->recordSchema = resultset->schema;
1577 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1579 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1581 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1582 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1583 return send_srw(c, sr);
1586 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1588 return zoom_complete;
1592 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1595 int lslb, ssub, mspn;
1597 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1598 Z_SearchRequest *search_req = apdu->u.searchRequest;
1599 const char *elementSetName;
1600 const char *smallSetElementSetName;
1601 const char *mediumSetElementSetName;
1604 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1606 r = c->tasks->u.search.resultset;
1608 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1611 ZOOM_options_get(r->options, "elementSetName");
1612 smallSetElementSetName =
1613 ZOOM_options_get(r->options, "smallSetElementSetName");
1614 mediumSetElementSetName =
1615 ZOOM_options_get(r->options, "mediumSetElementSetName");
1617 if (!smallSetElementSetName)
1618 smallSetElementSetName = elementSetName;
1620 if (!mediumSetElementSetName)
1621 mediumSetElementSetName = elementSetName;
1626 /* prepare query for the search request */
1627 search_req->query = r->query->z_query;
1628 if (!search_req->query)
1630 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1631 return zoom_complete;
1633 if (r->query->z_query->which == Z_Query_type_1 ||
1634 r->query->z_query->which == Z_Query_type_101)
1636 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1639 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1642 search_req->query = yaz_copy_Z_Query(search_req->query,
1645 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1647 yaz_iconv_close(cd);
1651 search_req->databaseNames = r->databaseNames;
1652 search_req->num_databaseNames = r->num_databaseNames;
1654 /* get syntax (no need to provide unless piggyback is in effect) */
1655 syntax = c->tasks->u.search.syntax;
1657 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1658 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1659 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1660 if (lslb != -1 && ssub != -1 && mspn != -1)
1662 /* So're a Z39.50 expert? Let's hope you don't do sort */
1663 *search_req->largeSetLowerBound = lslb;
1664 *search_req->smallSetUpperBound = ssub;
1665 *search_req->mediumSetPresentNumber = mspn;
1667 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1668 && r->piggyback && !r->r_sort_spec && !r->schema)
1670 /* Regular piggyback - do it unless we're going to do sort */
1671 *search_req->largeSetLowerBound = 2000000000;
1672 *search_req->smallSetUpperBound = 1;
1673 *search_req->mediumSetPresentNumber =
1674 r->step>0 ? r->step : c->tasks->u.search.count;
1678 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1679 smallSetElementSetName = 0;
1680 mediumSetElementSetName = 0;
1683 if (smallSetElementSetName && *smallSetElementSetName)
1685 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1686 odr_malloc(c->odr_out, sizeof(*esn));
1688 esn->which = Z_ElementSetNames_generic;
1689 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1690 search_req->smallSetElementSetNames = esn;
1692 if (mediumSetElementSetName && *mediumSetElementSetName)
1694 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1695 odr_malloc(c->odr_out, sizeof(*esn));
1697 esn->which = Z_ElementSetNames_generic;
1698 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1699 search_req->mediumSetElementSetNames = esn;
1702 search_req->preferredRecordSyntax =
1703 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1707 if (c->support_named_resultsets)
1711 /* find the lowest unused ordinal so that we re-use
1712 result sets on the server. */
1713 for (ord = 1; ; ord++)
1716 sprintf(setname, "%d", ord);
1717 for (rp = c->resultsets; rp; rp = rp->next)
1718 if (rp->setname && !strcmp(rp->setname, setname))
1723 r->setname = xstrdup(setname);
1724 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1725 "set %s", c, r->setname);
1729 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1731 r->setname = xstrdup("default");
1733 ZOOM_options_set(r->options, "setname", r->setname);
1735 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1736 return send_APDU(c, apdu);
1739 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1741 char oid_name_buf[OID_STR_MAX];
1742 const char *oid_name;
1745 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1748 case Z_DefaultDiagFormat_v2Addinfo:
1749 addinfo = r->u.v2Addinfo;
1751 case Z_DefaultDiagFormat_v3Addinfo:
1752 addinfo = r->u.v3Addinfo;
1757 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1760 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1762 if (p->which != Z_DiagRec_defaultFormat)
1763 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1765 response_default_diag(c, p->u.defaultFormat);
1768 ZOOM_API(ZOOM_record)
1769 ZOOM_record_clone(ZOOM_record srec)
1776 odr_enc = odr_createmem(ODR_ENCODE);
1777 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1779 buf = odr_getbuf(odr_enc, &size, 0);
1781 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1782 nrec->odr = odr_createmem(ODR_DECODE);
1783 nrec->wrbuf_marc = 0;
1784 nrec->wrbuf_iconv = 0;
1785 nrec->wrbuf_opac = 0;
1786 odr_setbuf(nrec->odr, buf, size, 0);
1787 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1789 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1790 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1791 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1792 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1793 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1794 odr_destroy(odr_enc);
1798 ZOOM_API(ZOOM_record)
1799 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1801 const char *syntax =
1802 ZOOM_options_get(s->options, "preferredRecordSyntax");
1803 const char *elementSetName =
1804 ZOOM_options_get(s->options, "elementSetName");
1806 return record_cache_lookup(s, pos, syntax, elementSetName);
1809 ZOOM_API(ZOOM_record)
1810 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1812 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1817 * MIKE: I think force_sync should always be zero, but I don't
1818 * want to make this change until I get the go-ahead from
1819 * Adam, in case something depends on the old synchronous
1823 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1824 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1825 rec = ZOOM_resultset_record_immediate(r, pos);
1831 ZOOM_record_destroy(ZOOM_record rec)
1835 if (rec->wrbuf_marc)
1836 wrbuf_destroy(rec->wrbuf_marc);
1837 if (rec->wrbuf_iconv)
1838 wrbuf_destroy(rec->wrbuf_iconv);
1839 if (rec->wrbuf_opac)
1840 wrbuf_destroy(rec->wrbuf_opac);
1841 odr_destroy(rec->odr);
1845 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1847 const char *buf, int sz,
1848 const char *record_charset)
1853 yaz_marc_t mt = yaz_marc_create();
1856 strcpy(to, "UTF-8");
1857 if (record_charset && *record_charset)
1859 /* Use "from,to" or just "from" */
1860 const char *cp = strchr(record_charset, ',');
1861 int clen = strlen(record_charset);
1864 strncpy( to, cp+1, sizeof(to)-1);
1865 to[sizeof(to)-1] = '\0';
1866 clen = cp - record_charset;
1868 if (clen > sizeof(from)-1)
1869 clen = sizeof(from)-1;
1872 strncpy(from, record_charset, clen);
1878 cd = yaz_iconv_open(to, from);
1879 yaz_marc_iconv(mt, cd);
1882 yaz_marc_xml(mt, marc_type);
1883 if (!rec->wrbuf_marc)
1884 rec->wrbuf_marc = wrbuf_alloc();
1885 wrbuf_rewind(rec->wrbuf_marc);
1886 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1888 yaz_marc_destroy(mt);
1890 yaz_iconv_close(cd);
1892 *len = wrbuf_len(rec->wrbuf_marc);
1893 return wrbuf_cstr(rec->wrbuf_marc);
1895 yaz_marc_destroy(mt);
1897 yaz_iconv_close(cd);
1901 static const char *record_iconv_return(ZOOM_record rec, int *len,
1902 const char *buf, int sz,
1903 const char *record_charset)
1910 strcpy(to, "UTF-8");
1912 if (record_charset && *record_charset)
1914 /* Use "from,to" or just "from" */
1915 const char *cp = strchr(record_charset, ',');
1916 int clen = strlen(record_charset);
1919 strncpy( to, cp+1, sizeof(to)-1);
1920 to[sizeof(to)-1] = '\0';
1921 clen = cp - record_charset;
1923 if (clen > sizeof(from)-1)
1924 clen = sizeof(from)-1;
1927 strncpy(from, record_charset, clen);
1931 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1933 if (!rec->wrbuf_iconv)
1934 rec->wrbuf_iconv = wrbuf_alloc();
1936 wrbuf_rewind(rec->wrbuf_iconv);
1938 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1939 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1941 buf = wrbuf_cstr(rec->wrbuf_iconv);
1942 sz = wrbuf_len(rec->wrbuf_iconv);
1943 yaz_iconv_close(cd);
1952 ZOOM_record_error(ZOOM_record rec, const char **cp,
1953 const char **addinfo, const char **diagset)
1955 Z_NamePlusRecord *npr;
1964 *cp = rec->diag_message;
1966 *addinfo = rec->diag_details;
1968 *diagset = rec->diag_set;
1969 return uri_to_code(rec->diag_uri);
1971 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1973 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1974 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1975 const char *add = 0;
1977 if (diag_rec->which == Z_DiagRec_defaultFormat)
1979 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1982 error = *ddf->condition;
1985 case Z_DefaultDiagFormat_v2Addinfo:
1986 add = ddf->u.v2Addinfo;
1988 case Z_DefaultDiagFormat_v3Addinfo:
1989 add = ddf->u.v3Addinfo;
1994 yaz_oid_to_string(yaz_oid_std(),
1995 ddf->diagnosticSetId, &oclass);
2003 *addinfo = add ? add : "";
2005 *cp = diagbib1_str(error);
2011 ZOOM_API(const char *)
2012 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2019 Z_NamePlusRecord *npr;
2022 *len = 0; /* default return */
2031 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
2033 if (cp[i] == ';' || cp[i] == ' ')
2039 while (type_spec[i] == ';')
2042 while (type_spec[i] == ' ')
2044 if (!strncmp(type_spec+i, "charset=", 8))
2047 i = i + 8; /* skip charset= */
2048 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
2050 if (type_spec[i] == ';' || type_spec[i] == ' ')
2056 else if (!strncmp(type_spec+i, "xpath=", 6))
2060 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2064 while (type_spec[i] == ' ')
2067 if (!strcmp(type, "database"))
2070 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2071 return npr->databaseName;
2073 else if (!strcmp(type, "schema"))
2076 *len = rec->schema ? strlen(rec->schema) : 0;
2079 else if (!strcmp(type, "syntax"))
2081 const char *desc = 0;
2082 if (npr->which == Z_NamePlusRecord_databaseRecord)
2084 Z_External *r = (Z_External *) npr->u.databaseRecord;
2085 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2090 *len = strlen(desc);
2093 if (npr->which != Z_NamePlusRecord_databaseRecord)
2096 /* from now on - we have a database record .. */
2097 if (!strcmp(type, "render"))
2099 Z_External *r = (Z_External *) npr->u.databaseRecord;
2100 const Odr_oid *oid = r->direct_reference;
2102 /* render bibliographic record .. */
2103 if (r->which == Z_External_OPAC)
2105 r = r->u.opac->bibliographicRecord;
2108 oid = r->direct_reference;
2110 if (r->which == Z_External_sutrs)
2111 return record_iconv_return(rec, len,
2112 (char*) r->u.sutrs->buf,
2115 else if (r->which == Z_External_octet)
2117 if (yaz_oid_is_iso2709(oid))
2119 const char *ret_buf = marc_iconv_return(
2120 rec, YAZ_MARC_LINE, len,
2121 (const char *) r->u.octet_aligned->buf,
2122 r->u.octet_aligned->len,
2127 return record_iconv_return(rec, len,
2128 (const char *) r->u.octet_aligned->buf,
2129 r->u.octet_aligned->len,
2132 else if (r->which == Z_External_grs1)
2134 if (!rec->wrbuf_marc)
2135 rec->wrbuf_marc = wrbuf_alloc();
2136 wrbuf_rewind(rec->wrbuf_marc);
2137 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2138 return record_iconv_return(rec, len,
2139 wrbuf_buf(rec->wrbuf_marc),
2140 wrbuf_len(rec->wrbuf_marc),
2145 else if (!strcmp(type, "xml"))
2147 Z_External *r = (Z_External *) npr->u.databaseRecord;
2148 const Odr_oid *oid = r->direct_reference;
2150 /* render bibliographic record .. */
2151 if (r->which == Z_External_OPAC)
2153 r = r->u.opac->bibliographicRecord;
2156 oid = r->direct_reference;
2159 if (r->which == Z_External_sutrs)
2160 return record_iconv_return(rec, len,
2161 (const char *) r->u.sutrs->buf,
2164 else if (r->which == Z_External_octet)
2166 int marc_decode_type = YAZ_MARC_MARCXML;
2167 if (yaz_oid_is_iso2709(oid))
2169 const char *ret_buf = marc_iconv_return(
2170 rec, marc_decode_type, len,
2171 (const char *) r->u.octet_aligned->buf,
2172 r->u.octet_aligned->len,
2177 return record_iconv_return(rec, len,
2178 (const char *) r->u.octet_aligned->buf,
2179 r->u.octet_aligned->len,
2182 else if (r->which == Z_External_grs1)
2189 else if (!strcmp(type, "raw"))
2191 Z_External *r = (Z_External *) npr->u.databaseRecord;
2193 if (r->which == Z_External_sutrs)
2195 if (len) *len = r->u.sutrs->len;
2196 return (const char *) r->u.sutrs->buf;
2198 else if (r->which == Z_External_octet)
2200 if (len) *len = r->u.octet_aligned->len;
2201 return (const char *) r->u.octet_aligned->buf;
2203 else /* grs-1, explain, OPAC, ... */
2206 return (const char *) npr->u.databaseRecord;
2210 else if (!strcmp (type, "ext"))
2213 return (const char *) npr->u.databaseRecord;
2215 else if (!strcmp (type, "opac"))
2218 Z_External *r = (Z_External *) npr->u.databaseRecord;
2219 if (r->which == Z_External_OPAC)
2221 if (!rec->wrbuf_opac)
2222 rec->wrbuf_opac = wrbuf_alloc();
2223 wrbuf_rewind(rec->wrbuf_opac);
2224 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2225 return record_iconv_return(rec, len,
2226 wrbuf_buf(rec->wrbuf_opac),
2227 wrbuf_len(rec->wrbuf_opac),
2234 static int strcmp_null(const char *v1, const char *v2)
2240 return strcmp(v1, v2);
2243 static size_t record_hash(int pos)
2247 return pos % RECORD_HASH_SIZE;
2250 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2252 const char *syntax, const char *elementSetName,
2254 Z_SRW_diagnostic *diag)
2256 ZOOM_record_cache rc = 0;
2258 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2259 ZOOM_connection_put_event(r->connection, event);
2261 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2264 && strcmp_null(r->schema, rc->schema) == 0
2265 && strcmp_null(elementSetName,rc->elementSetName) == 0
2266 && strcmp_null(syntax, rc->syntax) == 0)
2271 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2273 rc->rec.wrbuf_marc = 0;
2274 rc->rec.wrbuf_iconv = 0;
2275 rc->rec.wrbuf_opac = 0;
2276 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2278 rc->syntax = odr_strdup_null(r->odr, syntax);
2280 rc->schema = odr_strdup_null(r->odr, r->schema);
2283 rc->next = r->record_hash[record_hash(pos)];
2284 r->record_hash[record_hash(pos)] = rc;
2287 rc->rec.schema = odr_strdup_null(r->odr, schema);
2288 rc->rec.diag_set = 0;
2289 rc->rec.diag_uri = 0;
2290 rc->rec.diag_message = 0;
2291 rc->rec.diag_details = 0;
2297 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2298 if ((cp = strrchr(rc->rec.diag_set, '/')))
2300 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2302 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2303 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2307 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2309 const char *elementSetName)
2311 ZOOM_record_cache rc;
2313 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2317 if (strcmp_null(r->schema, rc->schema))
2319 if (strcmp_null(elementSetName,rc->elementSetName))
2321 if (strcmp_null(syntax, rc->syntax))
2329 static void handle_records(ZOOM_connection c, Z_Records *sr,
2332 ZOOM_resultset resultset;
2334 const char *syntax = 0, *elementSetName = 0;
2338 switch (c->tasks->which)
2340 case ZOOM_TASK_SEARCH:
2341 resultset = c->tasks->u.search.resultset;
2342 start = &c->tasks->u.search.start;
2343 count = &c->tasks->u.search.count;
2344 syntax = c->tasks->u.search.syntax;
2345 elementSetName = c->tasks->u.search.elementSetName;
2347 case ZOOM_TASK_RETRIEVE:
2348 resultset = c->tasks->u.retrieve.resultset;
2349 start = &c->tasks->u.retrieve.start;
2350 count = &c->tasks->u.retrieve.count;
2351 syntax = c->tasks->u.retrieve.syntax;
2352 elementSetName = c->tasks->u.retrieve.elementSetName;
2357 if (sr && sr->which == Z_Records_NSD)
2358 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2359 else if (sr && sr->which == Z_Records_multipleNSD)
2361 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2362 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2364 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2368 if (*count + *start > resultset->size)
2369 *count = resultset->size - *start;
2372 if (sr && sr->which == Z_Records_DBOSD)
2375 NMEM nmem = odr_extract_mem(c->odr_in);
2376 Z_NamePlusRecordList *p =
2377 sr->u.databaseOrSurDiagnostics;
2378 for (i = 0; i<p->num_records; i++)
2380 record_cache_add(resultset, p->records[i], i + *start,
2381 syntax, elementSetName,
2388 yaz_log(log_details,
2389 "handle_records resultset=%p start=%d count=%d",
2390 resultset, *start, *count);
2392 /* transfer our response to search_nmem .. we need it later */
2393 nmem_transfer(odr_getmem(resultset->odr), nmem);
2395 if (present_phase && p->num_records == 0)
2397 /* present response and we didn't get any records! */
2398 Z_NamePlusRecord *myrec =
2399 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2400 record_cache_add(resultset, myrec, *start,
2401 syntax, elementSetName, 0, 0);
2404 else if (present_phase)
2406 /* present response and we didn't get any records! */
2407 Z_NamePlusRecord *myrec =
2408 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2409 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2415 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2417 handle_records(c, pr->records, 1);
2420 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2423 switch (term->which)
2425 case Z_Term_general:
2426 ZOOM_options_setl(opt, name,
2427 (const char *)(term->u.general->buf),
2428 term->u.general->len);
2430 case Z_Term_characterString:
2431 ZOOM_options_set(opt, name, term->u.characterString);
2433 case Z_Term_numeric:
2434 ZOOM_options_set_int(opt, name, *term->u.numeric);
2439 static void handle_queryExpression(ZOOM_options opt, const char *name,
2440 Z_QueryExpression *exp)
2446 case Z_QueryExpression_term:
2447 if (exp->u.term && exp->u.term->queryTerm)
2449 sprintf(opt_name, "%s.term", name);
2450 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2453 case Z_QueryExpression_query:
2458 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2459 Z_OtherInformation *o)
2462 for (i = 0; o && i < o->num_elements; i++)
2464 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2466 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2468 if (ext->which == Z_External_searchResult1)
2471 Z_SearchInfoReport *sr = ext->u.searchResult1;
2474 ZOOM_options_set_int(
2475 resultset->options, "searchresult.size", sr->num);
2477 for (j = 0; j < sr->num; j++)
2479 Z_SearchInfoReport_s *ent =
2480 ext->u.searchResult1->elements[j];
2483 sprintf(pref, "searchresult.%d", j);
2485 if (ent->subqueryId)
2488 sprintf(opt_name, "%s.id", pref);
2489 ZOOM_options_set(resultset->options, opt_name,
2492 if (ent->subqueryExpression)
2495 sprintf(opt_name, "%s.subquery", pref);
2496 handle_queryExpression(resultset->options, opt_name,
2497 ent->subqueryExpression);
2499 if (ent->subqueryInterpretation)
2502 sprintf(opt_name, "%s.interpretation", pref);
2503 handle_queryExpression(resultset->options, opt_name,
2504 ent->subqueryInterpretation);
2506 if (ent->subqueryRecommendation)
2509 sprintf(opt_name, "%s.recommendation", pref);
2510 handle_queryExpression(resultset->options, opt_name,
2511 ent->subqueryRecommendation);
2513 if (ent->subqueryCount)
2516 sprintf(opt_name, "%s.count", pref);
2517 ZOOM_options_set_int(resultset->options, opt_name,
2518 *ent->subqueryCount);
2526 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2528 ZOOM_resultset resultset;
2531 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2534 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2535 ZOOM_connection_put_event(c, event);
2537 resultset = c->tasks->u.search.resultset;
2539 if (sr->resultSetStatus)
2541 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2542 *sr->resultSetStatus);
2544 if (sr->presentStatus)
2546 ZOOM_options_set_int(resultset->options, "presentStatus",
2547 *sr->presentStatus);
2549 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2551 resultset->size = *sr->resultCount;
2552 handle_records(c, sr->records, 0);
2555 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2557 if (res->diagnostics && res->num_diagnostics > 0)
2558 response_diag(c, res->diagnostics[0]);
2561 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2563 NMEM nmem = odr_extract_mem(c->odr_in);
2566 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2568 scan = c->tasks->u.scan.scan;
2570 if (res->entries && res->entries->nonsurrogateDiagnostics)
2571 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2572 scan->scan_response = res;
2573 scan->srw_scan_response = 0;
2574 nmem_transfer(odr_getmem(scan->odr), nmem);
2576 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2577 if (res->positionOfTerm)
2578 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2579 if (res->scanStatus)
2580 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2581 if (res->numberOfEntriesReturned)
2582 ZOOM_options_set_int(scan->options, "number",
2583 *res->numberOfEntriesReturned);
2588 static zoom_ret send_sort(ZOOM_connection c,
2589 ZOOM_resultset resultset)
2592 resultset->r_sort_spec = 0;
2593 if (resultset->r_sort_spec)
2595 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2596 Z_SortRequest *req = apdu->u.sortRequest;
2598 req->num_inputResultSetNames = 1;
2599 req->inputResultSetNames = (Z_InternationalString **)
2600 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2601 req->inputResultSetNames[0] =
2602 odr_strdup(c->odr_out, resultset->setname);
2603 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2604 req->sortSequence = resultset->r_sort_spec;
2605 resultset->r_sort_spec = 0;
2606 return send_APDU(c, apdu);
2608 return zoom_complete;
2611 static zoom_ret send_present(ZOOM_connection c)
2614 Z_PresentRequest *req = 0;
2616 const char *syntax = 0;
2617 const char *elementSetName = 0;
2618 ZOOM_resultset resultset;
2623 yaz_log(log_details, "%p send_present no tasks", c);
2624 return zoom_complete;
2627 switch (c->tasks->which)
2629 case ZOOM_TASK_SEARCH:
2630 resultset = c->tasks->u.search.resultset;
2631 start = &c->tasks->u.search.start;
2632 count = &c->tasks->u.search.count;
2633 syntax = c->tasks->u.search.syntax;
2634 elementSetName = c->tasks->u.search.elementSetName;
2636 case ZOOM_TASK_RETRIEVE:
2637 resultset = c->tasks->u.retrieve.resultset;
2638 start = &c->tasks->u.retrieve.start;
2639 count = &c->tasks->u.retrieve.count;
2640 syntax = c->tasks->u.retrieve.syntax;
2641 elementSetName = c->tasks->u.retrieve.elementSetName;
2644 return zoom_complete;
2646 yaz_log(log_details, "%p send_present start=%d count=%d",
2649 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2651 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2654 if (c->error) /* don't continue on error */
2655 return zoom_complete;
2656 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2657 resultset, *start, *count);
2659 for (i = 0; i < *count; i++)
2662 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2667 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2668 ZOOM_connection_put_event(c, event);
2676 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2677 return zoom_complete;
2680 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2681 req = apdu->u.presentRequest;
2684 yaz_log(log_details, "%p send_present skip=%d", c, i);
2686 *req->resultSetStartPoint = *start + 1;
2688 if (resultset->step > 0 && resultset->step < *count)
2689 *req->numberOfRecordsRequested = resultset->step;
2691 *req->numberOfRecordsRequested = *count;
2693 if (*req->numberOfRecordsRequested + *start > resultset->size)
2694 *req->numberOfRecordsRequested = resultset->size - *start;
2695 assert(*req->numberOfRecordsRequested > 0);
2697 if (syntax && *syntax)
2698 req->preferredRecordSyntax =
2699 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2701 if (resultset->schema && *resultset->schema)
2703 Z_RecordComposition *compo = (Z_RecordComposition *)
2704 odr_malloc(c->odr_out, sizeof(*compo));
2706 req->recordComposition = compo;
2707 compo->which = Z_RecordComp_complex;
2708 compo->u.complex = (Z_CompSpec *)
2709 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2710 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2711 odr_malloc(c->odr_out, sizeof(bool_t));
2712 *compo->u.complex->selectAlternativeSyntax = 0;
2714 compo->u.complex->generic = (Z_Specification *)
2715 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2717 compo->u.complex->generic->which = Z_Schema_oid;
2718 compo->u.complex->generic->schema.oid = (Odr_oid *)
2719 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2721 if (!compo->u.complex->generic->schema.oid)
2723 /* OID wasn't a schema! Try record syntax instead. */
2725 compo->u.complex->generic->schema.oid = (Odr_oid *)
2726 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2728 if (elementSetName && *elementSetName)
2730 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2731 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2732 compo->u.complex->generic->elementSpec->which =
2733 Z_ElementSpec_elementSetName;
2734 compo->u.complex->generic->elementSpec->u.elementSetName =
2735 odr_strdup(c->odr_out, elementSetName);
2738 compo->u.complex->generic->elementSpec = 0;
2739 compo->u.complex->num_dbSpecific = 0;
2740 compo->u.complex->dbSpecific = 0;
2741 compo->u.complex->num_recordSyntax = 0;
2742 compo->u.complex->recordSyntax = 0;
2744 else if (elementSetName && *elementSetName)
2746 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2747 odr_malloc(c->odr_out, sizeof(*esn));
2748 Z_RecordComposition *compo = (Z_RecordComposition *)
2749 odr_malloc(c->odr_out, sizeof(*compo));
2751 esn->which = Z_ElementSetNames_generic;
2752 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2753 compo->which = Z_RecordComp_simple;
2754 compo->u.simple = esn;
2755 req->recordComposition = compo;
2757 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2758 return send_APDU(c, apdu);
2761 ZOOM_API(ZOOM_scanset)
2762 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2765 ZOOM_query q = ZOOM_query_create();
2767 ZOOM_query_prefix(q, start);
2769 s = ZOOM_connection_scan1(c, q);
2770 ZOOM_query_destroy(q);
2775 ZOOM_API(ZOOM_scanset)
2776 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2778 ZOOM_scanset scan = 0;
2782 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2783 scan->connection = c;
2784 scan->odr = odr_createmem(ODR_DECODE);
2785 scan->options = ZOOM_options_create_with_parent(c->options);
2787 scan->scan_response = 0;
2788 scan->srw_scan_response = 0;
2792 scan->databaseNames = set_DatabaseNames(c, c->options,
2793 &scan->num_databaseNames,
2798 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2799 task->u.scan.scan = scan;
2804 while (ZOOM_event(1, &c))
2812 ZOOM_scanset_destroy(ZOOM_scanset scan)
2817 if (scan->refcount == 0)
2819 ZOOM_query_destroy(scan->query);
2821 odr_destroy(scan->odr);
2823 ZOOM_options_destroy(scan->options);
2828 static zoom_ret send_package(ZOOM_connection c)
2832 yaz_log(log_details, "%p send_package", c);
2834 return zoom_complete;
2835 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2837 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2838 ZOOM_connection_put_event(c, event);
2840 c->buf_out = c->tasks->u.package->buf_out;
2841 c->len_out = c->tasks->u.package->len_out;
2846 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2849 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2850 Z_ScanRequest *req = apdu->u.scanRequest;
2852 yaz_log(log_details, "%p send_scan", c);
2854 return zoom_complete;
2855 assert (c->tasks->which == ZOOM_TASK_SCAN);
2856 scan = c->tasks->u.scan.scan;
2858 /* Z39.50 scan can only carry RPN */
2859 if (scan->query->z_query->which == Z_Query_type_1 ||
2860 scan->query->z_query->which == Z_Query_type_101)
2862 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2863 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2866 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2869 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2871 yaz_query_charset_convert_rpnquery(
2872 rpn, c->odr_out, cd);
2873 yaz_iconv_close(cd);
2876 req->attributeSet = rpn->attributeSetId;
2877 if (!req->attributeSet)
2878 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2879 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2880 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2882 req->termListAndStartPoint =
2883 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2887 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2888 return zoom_complete;
2893 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2894 return zoom_complete;
2897 *req->numberOfTermsRequested =
2898 ZOOM_options_get_int(scan->options, "number", 10);
2900 req->preferredPositionInResponse =
2901 odr_intdup(c->odr_out,
2902 ZOOM_options_get_int(scan->options, "position", 1));
2905 odr_intdup(c->odr_out,
2906 ZOOM_options_get_int(scan->options, "stepSize", 0));
2908 req->databaseNames = scan->databaseNames;
2909 req->num_databaseNames = scan->num_databaseNames;
2911 return send_APDU(c, apdu);
2915 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2919 const char *option_val = 0;
2922 return zoom_complete;
2923 assert (c->tasks->which == ZOOM_TASK_SCAN);
2924 scan = c->tasks->u.scan.scan;
2926 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2928 /* SRU scan can only carry CQL and PQF */
2929 if (scan->query->z_query->which == Z_Query_type_104)
2931 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2932 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2934 else if (scan->query->z_query->which == Z_Query_type_1
2935 || scan->query->z_query->which == Z_Query_type_101)
2937 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2938 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2942 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2943 return zoom_complete;
2946 sr->u.scan_request->maximumTerms = odr_intdup(
2947 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2949 sr->u.scan_request->responsePosition = odr_intdup(
2950 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2952 option_val = ZOOM_options_get(scan->options, "extraArgs");
2953 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2954 return send_srw(c, sr);
2957 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2959 return zoom_complete;
2965 ZOOM_scanset_size(ZOOM_scanset scan)
2970 if (scan->scan_response && scan->scan_response->entries)
2971 return scan->scan_response->entries->num_entries;
2972 else if (scan->srw_scan_response)
2973 return scan->srw_scan_response->num_terms;
2977 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2979 const char **value_term, size_t *value_len,
2980 const char **disp_term, size_t *disp_len)
2982 size_t noent = ZOOM_scanset_size(scan);
2991 if (pos >= noent || pos < 0)
2993 if (scan->scan_response)
2995 Z_ScanResponse *res = scan->scan_response;
2996 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2998 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3000 *value_term = (const char *) t->term->u.general->buf;
3001 *value_len = t->term->u.general->len;
3004 *disp_term = t->displayTerm;
3005 *disp_len = strlen(*disp_term);
3007 else if (t->term->which == Z_Term_general)
3009 *disp_term = (const char *) t->term->u.general->buf;
3010 *disp_len = t->term->u.general->len;
3012 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3015 if (scan->srw_scan_response)
3017 Z_SRW_scanResponse *res = scan->srw_scan_response;
3018 Z_SRW_scanTerm *t = res->terms + pos;
3021 *value_term = t->value;
3022 *value_len = strlen(*value_term);
3025 *disp_term = t->displayTerm;
3027 *disp_term = t->value;
3028 *disp_len = strlen(*disp_term);
3029 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3034 ZOOM_API(const char *)
3035 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3038 const char *value_term = 0;
3039 size_t value_len = 0;
3040 const char *disp_term = 0;
3041 size_t disp_len = 0;
3043 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3044 &disp_term, &disp_len);
3050 ZOOM_API(const char *)
3051 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3054 const char *value_term = 0;
3055 size_t value_len = 0;
3056 const char *disp_term = 0;
3057 size_t disp_len = 0;
3059 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3060 &disp_term, &disp_len);
3066 ZOOM_API(const char *)
3067 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3069 return ZOOM_options_get(scan->options, key);
3073 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3076 ZOOM_options_set(scan->options, key, val);
3079 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3082 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3083 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3085 str = ZOOM_options_get(p->options, "package-name");
3087 req->packageName = odr_strdup(p->odr_out, str);
3089 str = ZOOM_options_get(p->options, "user-id");
3091 req->userId = odr_strdup_null(p->odr_out, str);
3093 req->packageType = odr_oiddup(p->odr_out, oid);
3095 str = ZOOM_options_get(p->options, "function");
3098 if (!strcmp (str, "create"))
3099 *req->function = Z_ExtendedServicesRequest_create;
3100 if (!strcmp (str, "delete"))
3101 *req->function = Z_ExtendedServicesRequest_delete;
3102 if (!strcmp (str, "modify"))
3103 *req->function = Z_ExtendedServicesRequest_modify;
3106 str = ZOOM_options_get(p->options, "waitAction");
3109 if (!strcmp (str, "wait"))
3110 *req->waitAction = Z_ExtendedServicesRequest_wait;
3111 if (!strcmp (str, "waitIfPossible"))
3112 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3113 if (!strcmp (str, "dontWait"))
3114 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3115 if (!strcmp (str, "dontReturnPackage"))
3116 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3121 static const char *ill_array_lookup(void *clientData, const char *idx)
3123 ZOOM_package p = (ZOOM_package) clientData;
3124 return ZOOM_options_get(p->options, idx+4);
3127 static Z_External *encode_ill_request(ZOOM_package p)
3129 ODR out = p->odr_out;
3132 struct ill_get_ctl ctl;
3134 ctl.odr = p->odr_out;
3136 ctl.f = ill_array_lookup;
3138 req = ill_get_ILLRequest(&ctl, "ill", 0);
3140 if (!ill_Request(out, &req, 0, 0))
3142 int ill_request_size;
3143 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3144 if (ill_request_buf)
3145 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3150 int illRequest_size = 0;
3151 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3153 r = (Z_External *) odr_malloc(out, sizeof(*r));
3154 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3155 r->indirect_reference = 0;
3157 r->which = Z_External_single;
3159 r->u.single_ASN1_type =
3160 odr_create_Odr_oct(out,
3161 (unsigned char *)illRequest_buf,
3167 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3169 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3173 req->which = Z_IOItemOrder_esRequest;
3174 req->u.esRequest = (Z_IORequest *)
3175 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3177 /* to keep part ... */
3178 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3179 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3180 req->u.esRequest->toKeep->supplDescription = 0;
3181 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3182 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3184 str = ZOOM_options_get(p->options, "contact-name");
3185 req->u.esRequest->toKeep->contact->name =
3186 odr_strdup_null(p->odr_out, str);
3188 str = ZOOM_options_get(p->options, "contact-phone");
3189 req->u.esRequest->toKeep->contact->phone =
3190 odr_strdup_null(p->odr_out, str);
3192 str = ZOOM_options_get(p->options, "contact-email");
3193 req->u.esRequest->toKeep->contact->email =
3194 odr_strdup_null(p->odr_out, str);
3196 req->u.esRequest->toKeep->addlBilling = 0;
3198 /* not to keep part ... */
3199 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3200 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3202 str = ZOOM_options_get(p->options, "itemorder-setname");
3207 req->u.esRequest->notToKeep->resultSetItem = 0;
3210 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3211 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3213 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3214 odr_strdup(p->odr_out, str);
3215 req->u.esRequest->notToKeep->resultSetItem->item =
3216 (int *) odr_malloc(p->odr_out, sizeof(int));
3218 str = ZOOM_options_get(p->options, "itemorder-item");
3219 *req->u.esRequest->notToKeep->resultSetItem->item =
3220 (str ? atoi(str) : 1);
3223 str = ZOOM_options_getl(p->options, "doc", &len);
3226 req->u.esRequest->notToKeep->itemRequest =
3227 z_ext_record_xml(p->odr_out, str, len);
3230 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3235 Z_APDU *create_admin_package(ZOOM_package p, int type,
3236 Z_ESAdminOriginPartToKeep **toKeepP,
3237 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3239 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3242 Z_ESAdminOriginPartToKeep *toKeep;
3243 Z_ESAdminOriginPartNotToKeep *notToKeep;
3244 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3245 const char *first_db = "Default";
3247 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3252 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3254 r->indirect_reference = 0;
3255 r->which = Z_External_ESAdmin;
3257 r->u.adminService = (Z_Admin *)
3258 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3259 r->u.adminService->which = Z_Admin_esRequest;
3260 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3261 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3263 toKeep = r->u.adminService->u.esRequest->toKeep =
3264 (Z_ESAdminOriginPartToKeep *)
3265 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3266 toKeep->which = type;
3267 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3268 toKeep->u.create = odr_nullval();
3269 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3271 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3272 (Z_ESAdminOriginPartNotToKeep *)
3273 odr_malloc(p->odr_out,
3274 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3275 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3276 notToKeep->u.recordsWillFollow = odr_nullval();
3280 *notToKeepP = notToKeep;
3285 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3287 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3288 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3289 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3291 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3299 req->taskSpecificParameters = ext;
3300 ext->direct_reference = req->packageType;
3301 ext->descriptor = 0;
3302 ext->indirect_reference = 0;
3304 ext->which = Z_External_octet;
3305 ext->u.single_ASN1_type =
3306 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3310 static Z_APDU *create_update_package(ZOOM_package p)
3313 const char *first_db = "Default";
3315 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3316 const char *action = ZOOM_options_get(p->options, "action");
3317 int recordIdOpaque_len;
3318 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3319 &recordIdOpaque_len);
3320 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3322 const char *record_buf = ZOOM_options_getl(p->options, "record",
3324 int recordOpaque_len;
3325 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3327 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3328 const char *version = ZOOM_options_get(p->options, "updateVersion");
3330 const char *correlationInfo_note =
3331 ZOOM_options_get(p->options, "correlationInfo.note");
3332 const char *correlationInfo_id =
3333 ZOOM_options_get(p->options, "correlationInfo.id");
3335 Odr_oid *syntax_oid = 0;
3336 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3342 if (!record_buf && !recordOpaque_buf)
3344 record_buf = "void";
3346 syntax_str = "SUTRS";
3351 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3352 CLASS_RECSYN, syntax_str,
3364 package_oid = yaz_oid_extserv_database_update_first_version;
3365 /* old update does not support specialUpdate */
3367 action = "recordInsert";
3371 action = "specialUpdate";
3372 package_oid = yaz_oid_extserv_database_update_second_version;
3376 action = "specialUpdate";
3377 package_oid = yaz_oid_extserv_database_update;
3383 if (!strcmp(action, "recordInsert"))
3384 action_no = Z_IUOriginPartToKeep_recordInsert;
3385 else if (!strcmp(action, "recordReplace"))
3386 action_no = Z_IUOriginPartToKeep_recordReplace;
3387 else if (!strcmp(action, "recordDelete"))
3388 action_no = Z_IUOriginPartToKeep_recordDelete;
3389 else if (!strcmp(action, "elementUpdate"))
3390 action_no = Z_IUOriginPartToKeep_elementUpdate;
3391 else if (!strcmp(action, "specialUpdate"))
3392 action_no = Z_IUOriginPartToKeep_specialUpdate;
3396 apdu = create_es_package(p, package_oid);
3399 Z_IUOriginPartToKeep *toKeep;
3400 Z_IUSuppliedRecords *notToKeep;
3401 Z_External *r = (Z_External *)
3402 odr_malloc(p->odr_out, sizeof(*r));
3403 const char *elementSetName =
3404 ZOOM_options_get(p->options, "elementSetName");
3406 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3408 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3410 r->which = Z_External_update;
3411 r->indirect_reference = 0;
3412 r->u.update = (Z_IUUpdate *)
3413 odr_malloc(p->odr_out, sizeof(*r->u.update));
3415 r->u.update->which = Z_IUUpdate_esRequest;
3416 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3417 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3418 toKeep = r->u.update->u.esRequest->toKeep =
3419 (Z_IUOriginPartToKeep *)
3420 odr_malloc(p->odr_out, sizeof(*toKeep));
3422 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3425 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3427 toKeep->actionQualifier = 0;
3428 toKeep->action = odr_intdup(p->odr_out, action_no);
3430 notToKeep = r->u.update->u.esRequest->notToKeep =
3431 (Z_IUSuppliedRecords *)
3432 odr_malloc(p->odr_out, sizeof(*notToKeep));
3434 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3435 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3436 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3437 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3438 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3441 notToKeep->elements[0]->u.opaque =
3442 odr_create_Odr_oct(p->odr_out,
3443 (const unsigned char *) recordIdOpaque,
3444 recordIdOpaque_len);
3446 else if (recordIdNumber)
3448 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3450 notToKeep->elements[0]->u.number =
3451 odr_intdup(p->odr_out, atoi(recordIdNumber));
3454 notToKeep->elements[0]->u.opaque = 0;
3455 notToKeep->elements[0]->supplementalId = 0;
3456 if (correlationInfo_note || correlationInfo_id)
3458 Z_IUCorrelationInfo *ci;
3459 ci = notToKeep->elements[0]->correlationInfo =
3460 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3461 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3462 ci->id = correlationInfo_id ?
3463 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3466 notToKeep->elements[0]->correlationInfo = 0;
3467 if (recordOpaque_buf)
3469 notToKeep->elements[0]->record =
3470 z_ext_record_oid_any(p->odr_out, syntax_oid,
3471 recordOpaque_buf, recordOpaque_len);
3475 notToKeep->elements[0]->record =
3476 z_ext_record_oid(p->odr_out, syntax_oid,
3477 record_buf, record_len);
3482 ODR print = odr_createmem(ODR_PRINT);
3484 z_APDU(print, &apdu, 0, 0);
3491 ZOOM_package_send(ZOOM_package p, const char *type)
3498 odr_reset(p->odr_out);
3501 if (!strcmp(type, "itemorder"))
3503 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3506 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3508 r->direct_reference =
3509 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3511 r->which = Z_External_itemOrder;
3512 r->indirect_reference = 0;
3513 r->u.itemOrder = encode_item_order(p);
3515 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3518 else if (!strcmp(type, "create")) /* create database */
3520 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3523 else if (!strcmp(type, "drop")) /* drop database */
3525 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3528 else if (!strcmp(type, "commit")) /* commit changes */
3530 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3533 else if (!strcmp(type, "update")) /* update record(s) */
3535 apdu = create_update_package(p);
3537 else if (!strcmp(type, "xmlupdate"))
3539 apdu = create_xmlupdate_package(p);
3543 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3547 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3548 task->u.package = p;
3549 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3550 p->buf_out = (char *) xmalloc(p->len_out);
3551 memcpy(p->buf_out, buf, p->len_out);
3556 while (ZOOM_event(1, &c))
3563 ZOOM_API(ZOOM_package)
3564 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3566 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3569 p->odr_out = odr_createmem(ODR_ENCODE);
3570 p->options = ZOOM_options_create_with_parent2(options, c->options);
3578 ZOOM_package_destroy(ZOOM_package p)
3583 if (p->refcount == 0)
3585 odr_destroy(p->odr_out);
3588 ZOOM_options_destroy(p->options);
3593 ZOOM_API(const char *)
3594 ZOOM_package_option_get(ZOOM_package p, const char *key)
3596 return ZOOM_options_get(p->options, key);
3599 ZOOM_API(const char *)
3600 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3602 return ZOOM_options_getl(p->options, key, lenp);
3606 ZOOM_package_option_set(ZOOM_package p, const char *key,
3609 ZOOM_options_set(p->options, key, val);
3613 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3614 const char *val, int len)
3616 ZOOM_options_setl(p->options, key, val, len);
3619 static int ZOOM_connection_exec_task(ZOOM_connection c)
3621 ZOOM_task task = c->tasks;
3622 zoom_ret ret = zoom_complete;
3626 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3627 c, task->which, task->running);
3628 if (c->error != ZOOM_ERROR_NONE)
3630 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3631 "removing tasks because of error = %d", c, c->error);
3632 ZOOM_connection_remove_tasks(c);
3637 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3638 "task already running", c);
3642 ret = zoom_complete;
3643 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3645 switch (task->which)
3647 case ZOOM_TASK_SEARCH:
3648 if (c->proto == PROTO_HTTP)
3649 ret = ZOOM_connection_srw_send_search(c);
3651 ret = ZOOM_connection_send_search(c);
3653 case ZOOM_TASK_RETRIEVE:
3654 if (c->proto == PROTO_HTTP)
3655 ret = ZOOM_connection_srw_send_search(c);
3657 ret = send_present(c);
3659 case ZOOM_TASK_CONNECT:
3660 ret = do_connect(c);
3662 case ZOOM_TASK_SCAN:
3663 if (c->proto == PROTO_HTTP)
3664 ret = ZOOM_connection_srw_send_scan(c);
3666 ret = ZOOM_connection_send_scan(c);
3668 case ZOOM_TASK_PACKAGE:
3669 ret = send_package(c);
3671 case ZOOM_TASK_SORT:
3672 c->tasks->u.sort.resultset->r_sort_spec =
3673 c->tasks->u.sort.q->sort_spec;
3674 ret = send_sort(c, c->tasks->u.sort.resultset);
3680 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3681 "remove tasks because no connection exist", c);
3682 ZOOM_connection_remove_tasks(c);
3684 if (ret == zoom_complete)
3686 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3687 "task removed (complete)", c);
3688 ZOOM_connection_remove_task(c);
3691 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3696 static zoom_ret send_sort_present(ZOOM_connection c)
3698 zoom_ret r = zoom_complete;
3700 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3701 r = send_sort(c, c->tasks->u.search.resultset);
3702 if (r == zoom_complete)
3703 r = send_present(c);
3707 static int es_response_taskpackage_update(ZOOM_connection c,
3708 Z_IUUpdateTaskPackage *utp)
3710 if (utp && utp->targetPart)
3712 Z_IUTargetPart *targetPart = utp->targetPart;
3713 switch ( *targetPart->updateStatus ) {
3714 case Z_IUTargetPart_success:
3715 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3717 case Z_IUTargetPart_partial:
3718 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3720 case Z_IUTargetPart_failure:
3721 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3722 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3723 response_diag(c, targetPart->globalDiagnostics[0]);
3726 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3731 static int es_response_taskpackage(ZOOM_connection c,
3732 Z_TaskPackage *taskPackage)
3735 Odr_oct *id = taskPackage->targetReference;
3737 ZOOM_options_setl(c->tasks->u.package->options,
3738 "targetReference", (char*) id->buf, id->len);
3741 switch ( *taskPackage->taskStatus ) {
3742 case Z_TaskPackage_pending:
3743 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3745 case Z_TaskPackage_active:
3746 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3748 case Z_TaskPackage_complete:
3749 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3751 case Z_TaskPackage_aborted:
3752 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3753 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3754 response_diag(c, taskPackage->packageDiagnostics[0]);
3758 // taskSpecificParameters
3759 // NOTE: Only Update implemented, no others.
3760 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3761 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3762 es_response_taskpackage_update(c, utp);
3768 static int es_response(ZOOM_connection c,
3769 Z_ExtendedServicesResponse *res)
3771 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3773 switch (*res->operationStatus) {
3774 case Z_ExtendedServicesResponse_done:
3775 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3777 case Z_ExtendedServicesResponse_accepted:
3778 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3780 case Z_ExtendedServicesResponse_failure:
3781 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3782 if (res->diagnostics && res->num_diagnostics > 0)
3783 response_diag(c, res->diagnostics[0]);
3786 if (res->taskPackage &&
3787 res->taskPackage->which == Z_External_extendedService)
3789 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3790 es_response_taskpackage(c, taskPackage);
3792 if (res->taskPackage &&
3793 res->taskPackage->which == Z_External_octet)
3795 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3796 ZOOM_options_setl(c->tasks->u.package->options,
3797 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3802 static void interpret_init_diag(ZOOM_connection c,
3803 Z_DiagnosticFormat *diag)
3807 Z_DiagnosticFormat_s *ds = diag->elements[0];
3808 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3809 response_default_diag(c, ds->u.defaultDiagRec);
3814 static void interpret_otherinformation_field(ZOOM_connection c,
3815 Z_OtherInformation *ui)
3818 for (i = 0; i < ui->num_elements; i++)
3820 Z_OtherInformationUnit *unit = ui->list[i];
3821 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3822 unit->information.externallyDefinedInfo &&
3823 unit->information.externallyDefinedInfo->which ==
3826 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3832 static void set_init_option(const char *name, void *clientData) {
3833 ZOOM_connection c = (ZOOM_connection) clientData;
3836 sprintf(buf, "init_opt_%.70s", name);
3837 ZOOM_connection_option_set(c, buf, "1");
3841 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3843 Z_InitResponse *initrs;
3845 ZOOM_connection_set_mask(c, 0);
3846 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3849 case Z_APDU_initResponse:
3850 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3851 initrs = apdu->u.initResponse;
3852 ZOOM_connection_option_set(c, "serverImplementationId",
3853 initrs->implementationId ?
3854 initrs->implementationId : "");
3855 ZOOM_connection_option_set(c, "serverImplementationName",
3856 initrs->implementationName ?
3857 initrs->implementationName : "");
3858 ZOOM_connection_option_set(c, "serverImplementationVersion",
3859 initrs->implementationVersion ?
3860 initrs->implementationVersion : "");
3861 /* Set the three old options too, for old applications */
3862 ZOOM_connection_option_set(c, "targetImplementationId",
3863 initrs->implementationId ?
3864 initrs->implementationId : "");
3865 ZOOM_connection_option_set(c, "targetImplementationName",
3866 initrs->implementationName ?
3867 initrs->implementationName : "");
3868 ZOOM_connection_option_set(c, "targetImplementationVersion",
3869 initrs->implementationVersion ?
3870 initrs->implementationVersion : "");
3872 /* Make initrs->options available as ZOOM-level options */
3873 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3875 if (!*initrs->result)
3877 Z_External *uif = initrs->userInformationField;
3879 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3881 if (uif && uif->which == Z_External_userInfo1)
3882 interpret_otherinformation_field(c, uif->u.userInfo1);
3887 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3888 yaz_oid_userinfo_cookie, 1, 0);
3889 xfree(c->cookie_in);
3892 c->cookie_in = xstrdup(cookie);
3893 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3894 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3895 c->support_named_resultsets = 1;
3898 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3899 ZOOM_connection_remove_task(c);
3901 ZOOM_connection_exec_task(c);
3903 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3905 NMEM tmpmem = nmem_create();
3906 Z_CharSetandLanguageNegotiation *p =
3907 yaz_get_charneg_record(initrs->otherInfo);
3911 char *charset = NULL, *lang = NULL;
3914 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3915 yaz_log(log_details, "%p recv_apdu target accepted: "
3916 "charset %s, language %s, select %d",
3918 charset ? charset : "none", lang ? lang : "none", sel);
3920 ZOOM_connection_option_set(c, "negotiation-charset",
3923 ZOOM_connection_option_set(c, "negotiation-lang",
3926 ZOOM_connection_option_set(
3927 c, "negotiation-charset-in-effect-for-records",
3928 (sel != 0) ? "1" : "0");
3929 nmem_destroy(tmpmem);
3933 case Z_APDU_searchResponse:
3934 yaz_log(log_api, "%p recv_apdu Search response", c);
3935 handle_search_response(c, apdu->u.searchResponse);
3936 if (send_sort_present(c) == zoom_complete)
3937 ZOOM_connection_remove_task(c);
3939 case Z_APDU_presentResponse:
3940 yaz_log(log_api, "%p recv_apdu Present response", c);
3941 handle_present_response(c, apdu->u.presentResponse);
3942 if (send_present(c) == zoom_complete)
3943 ZOOM_connection_remove_task(c);
3945 case Z_APDU_sortResponse:
3946 yaz_log(log_api, "%p recv_apdu Sort response", c);
3947 sort_response(c, apdu->u.sortResponse);
3948 if (send_present(c) == zoom_complete)
3949 ZOOM_connection_remove_task(c);
3951 case Z_APDU_scanResponse:
3952 yaz_log(log_api, "%p recv_apdu Scan response", c);
3953 scan_response(c, apdu->u.scanResponse);
3954 ZOOM_connection_remove_task(c);
3956 case Z_APDU_extendedServicesResponse:
3957 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3958 es_response(c, apdu->u.extendedServicesResponse);
3959 ZOOM_connection_remove_task(c);
3962 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3963 if (!ZOOM_test_reconnect(c))
3965 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3970 yaz_log(log_api, "%p Received unknown PDU", c);
3971 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3977 static zoom_ret handle_srw_response(ZOOM_connection c,
3978 Z_SRW_searchRetrieveResponse *res)
3980 ZOOM_resultset resultset = 0;
3985 const char *syntax, *elementSetName;
3988 return zoom_complete;
3990 switch(c->tasks->which)
3992 case ZOOM_TASK_SEARCH:
3993 resultset = c->tasks->u.search.resultset;
3994 start = &c->tasks->u.search.start;
3995 count = &c->tasks->u.search.count;
3996 syntax = c->tasks->u.search.syntax;
3997 elementSetName = c->tasks->u.search.elementSetName;
3999 if (!c->tasks->u.search.recv_search_fired)
4001 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4002 ZOOM_connection_put_event(c, event);
4003 c->tasks->u.search.recv_search_fired = 1;
4006 case ZOOM_TASK_RETRIEVE:
4007 resultset = c->tasks->u.retrieve.resultset;
4008 start = &c->tasks->u.retrieve.start;
4009 count = &c->tasks->u.retrieve.count;
4010 syntax = c->tasks->u.retrieve.syntax;
4011 elementSetName = c->tasks->u.retrieve.elementSetName;
4014 return zoom_complete;
4017 resultset->size = 0;
4019 if (res->resultSetId)
4020 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4022 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4024 if (res->num_diagnostics > 0)
4026 set_SRU_error(c, &res->diagnostics[0]);
4030 if (res->numberOfRecords)
4031 resultset->size = *res->numberOfRecords;
4032 for (i = 0; i<res->num_records; i++)
4035 Z_SRW_record *sru_rec;
4036 Z_SRW_diagnostic *diag = 0;
4039 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4040 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4042 if (res->records[i].recordPosition &&
4043 *res->records[i].recordPosition > 0)
4044 pos = *res->records[i].recordPosition - 1;
4048 sru_rec = &res->records[i];
4050 npr->databaseName = 0;
4051 npr->which = Z_NamePlusRecord_databaseRecord;
4052 npr->u.databaseRecord = (Z_External *)
4053 odr_malloc(c->odr_in, sizeof(Z_External));
4054 npr->u.databaseRecord->descriptor = 0;
4055 npr->u.databaseRecord->direct_reference =
4056 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4057 npr->u.databaseRecord->which = Z_External_octet;
4059 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4060 odr_malloc(c->odr_in, sizeof(Odr_oct));
4061 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4062 sru_rec->recordData_buf;
4063 npr->u.databaseRecord->u.octet_aligned->len =
4064 npr->u.databaseRecord->u.octet_aligned->size =
4065 sru_rec->recordData_len;
4067 if (sru_rec->recordSchema
4068 && !strcmp(sru_rec->recordSchema,
4069 "info:srw/schema/1/diagnostics-v1.1"))
4071 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4072 sru_rec->recordData_len,
4076 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4077 sru_rec->recordSchema, diag);
4081 if (*count + *start > resultset->size)
4082 *count = resultset->size - *start;
4086 nmem = odr_extract_mem(c->odr_in);
4087 nmem_transfer(odr_getmem(resultset->odr), nmem);
4091 return ZOOM_connection_srw_send_search(c);
4093 return zoom_complete;
4098 static void handle_srw_scan_response(ZOOM_connection c,
4099 Z_SRW_scanResponse *res)
4101 NMEM nmem = odr_extract_mem(c->odr_in);
4104 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4106 scan = c->tasks->u.scan.scan;
4108 if (res->num_diagnostics > 0)
4109 set_SRU_error(c, &res->diagnostics[0]);
4111 scan->scan_response = 0;
4112 scan->srw_scan_response = res;
4113 nmem_transfer(odr_getmem(scan->odr), nmem);
4115 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4121 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4123 zoom_ret cret = zoom_complete;
4125 const char *addinfo = 0;
4126 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4128 ZOOM_connection_set_mask(c, 0);
4129 yaz_log(log_details, "%p handle_http", c);
4131 if (!yaz_srw_check_content_type(hres))
4132 addinfo = "content-type";
4135 Z_SOAP *soap_package = 0;
4137 Z_SOAP_Handler soap_handlers[2] = {
4138 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4141 ret = z_soap_codec(o, &soap_package,
4142 &hres->content_buf, &hres->content_len,
4144 if (!ret && soap_package->which == Z_SOAP_generic &&
4145 soap_package->u.generic->no == 0)
4147 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4149 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4150 if (sr->which == Z_SRW_searchRetrieve_response)
4151 cret = handle_srw_response(c, sr->u.response);
4152 else if (sr->which == Z_SRW_scan_response)
4153 handle_srw_scan_response(c, sr->u.scan_response);
4157 else if (!ret && (soap_package->which == Z_SOAP_fault
4158 || soap_package->which == Z_SOAP_error))
4160 set_HTTP_error(c, hres->code,
4161 soap_package->u.fault->fault_code,
4162 soap_package->u.fault->fault_string);
4169 if (hres->code != 200)
4170 set_HTTP_error(c, hres->code, 0, 0);
4172 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4175 if (cret == zoom_complete)
4176 ZOOM_connection_remove_task(c);
4177 if (!strcmp(hres->version, "1.0"))
4179 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4180 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4185 /* HTTP 1.1: only if no close we stay alive .. */
4186 if (connection_head && !strcmp(connection_head, "close"))
4192 static int do_read(ZOOM_connection c)
4197 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4198 ZOOM_connection_put_event(c, event);
4200 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4201 more = cs_more(c->cs);
4202 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4207 if (!ZOOM_test_reconnect(c))
4209 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4218 odr_reset(c->odr_in);
4219 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4220 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4221 ZOOM_connection_put_event(c, event);
4223 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4226 int err = odr_geterrorx(c->odr_in, &x);
4228 const char *element = odr_getelement(c->odr_in);
4229 yaz_snprintf(msg, sizeof(msg),
4230 "ODR code %d:%d element=%s offset=%d",
4231 err, x, element ? element : "<unknown>",
4232 odr_offset(c->odr_in));
4233 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4236 FILE *ber_file = yaz_log_file();
4238 odr_dumpBER(ber_file, c->buf_in, r);
4245 z_GDU(c->odr_print, &gdu, 0, 0);
4246 if (gdu->which == Z_GDU_Z3950)
4247 recv_apdu(c, gdu->u.z3950);
4248 else if (gdu->which == Z_GDU_HTTP_Response)
4251 handle_http(c, gdu->u.HTTP_Response);
4253 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4258 c->reconnect_ok = 0;
4263 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4268 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4269 ZOOM_connection_put_event(c, event);
4271 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4272 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4274 yaz_log(log_details, "%p do_write_ex write failed", c);
4275 if (ZOOM_test_reconnect(c))
4277 return zoom_pending;
4279 if (c->state == STATE_CONNECTING)
4280 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4282 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4284 return zoom_complete;
4288 int mask = ZOOM_SELECT_EXCEPT;
4289 if (c->cs->io_pending & CS_WANT_WRITE)
4290 mask += ZOOM_SELECT_WRITE;
4291 if (c->cs->io_pending & CS_WANT_READ)
4292 mask += ZOOM_SELECT_READ;
4293 ZOOM_connection_set_mask(c, mask);
4294 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4299 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4300 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4303 return zoom_pending;
4306 static zoom_ret do_write(ZOOM_connection c)
4308 return do_write_ex(c, c->buf_out, c->len_out);
4312 ZOOM_API(const char *)
4313 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4315 return ZOOM_options_get(c->options, key);
4318 ZOOM_API(const char *)
4319 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4321 return ZOOM_options_getl(c->options, key, lenp);
4325 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4328 ZOOM_options_set(c->options, key, val);
4332 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4333 const char *val, int len)
4335 ZOOM_options_setl(c->options, key, val, len);
4338 ZOOM_API(const char *)
4339 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4341 return ZOOM_options_get(r->options, key);
4345 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4348 ZOOM_options_set(r->options, key, val);
4353 ZOOM_connection_errcode(ZOOM_connection c)
4355 return ZOOM_connection_error(c, 0, 0);
4358 ZOOM_API(const char *)
4359 ZOOM_connection_errmsg(ZOOM_connection c)
4362 ZOOM_connection_error(c, &msg, 0);
4366 ZOOM_API(const char *)
4367 ZOOM_connection_addinfo(ZOOM_connection c)
4369 const char *addinfo;
4370 ZOOM_connection_error(c, 0, &addinfo);
4374 ZOOM_API(const char *)
4375 ZOOM_connection_diagset(ZOOM_connection c)
4377 const char *diagset;
4378 ZOOM_connection_error_x(c, 0, 0, &diagset);
4382 ZOOM_API(const char *)
4383 ZOOM_diag_str(int error)
4387 case ZOOM_ERROR_NONE:
4389 case ZOOM_ERROR_CONNECT:
4390 return "Connect failed";
4391 case ZOOM_ERROR_MEMORY:
4392 return "Out of memory";
4393 case ZOOM_ERROR_ENCODE:
4394 return "Encoding failed";
4395 case ZOOM_ERROR_DECODE:
4396 return "Decoding failed";
4397 case ZOOM_ERROR_CONNECTION_LOST:
4398 return "Connection lost";
4399 case ZOOM_ERROR_INIT:
4400 return "Init rejected";
4401 case ZOOM_ERROR_INTERNAL:
4402 return "Internal failure";
4403 case ZOOM_ERROR_TIMEOUT:
4405 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4406 return "Unsupported protocol";
4407 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4408 return "Unsupported query type";
4409 case ZOOM_ERROR_INVALID_QUERY:
4410 return "Invalid query";
4411 case ZOOM_ERROR_CQL_PARSE:
4412 return "CQL parsing error";
4413 case ZOOM_ERROR_CQL_TRANSFORM:
4414 return "CQL transformation error";
4415 case ZOOM_ERROR_CCL_CONFIG:
4416 return "CCL configuration error";
4417 case ZOOM_ERROR_CCL_PARSE:
4418 return "CCL parsing error";
4420 return diagbib1_str(error);
4425 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4426 const char **addinfo, const char **diagset)
4428 int error = c->error;
4431 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4432 *cp = ZOOM_diag_str(error);
4433 else if (!strcmp(c->diagset, "HTTP"))
4434 *cp = z_HTTP_errmsg(c->error);
4435 else if (!strcmp(c->diagset, "Bib-1"))
4436 *cp = ZOOM_diag_str(error);
4437 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4438 *cp = yaz_diag_srw_str(c->error);
4440 *cp = "Unknown error and diagnostic set";
4443 *addinfo = c->addinfo ? c->addinfo : "";
4445 *diagset = c->diagset ? c->diagset : "";
4450 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4451 const char **addinfo)
4453 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4456 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4458 ZOOM_Event event = 0;
4459 int r = cs_look(c->cs);
4460 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4465 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4466 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4468 ZOOM_connection_put_event(c, event);
4470 else if (r == CS_CONNECT)
4472 int ret = ret = cs_rcvconnect(c->cs);
4473 yaz_log(log_details, "%p ZOOM_connection_do_io "
4474 "cs_rcvconnect returned %d", c, ret);
4477 int mask = ZOOM_SELECT_EXCEPT;
4478 if (c->cs->io_pending & CS_WANT_WRITE)
4479 mask += ZOOM_SELECT_WRITE;
4480 if (c->cs->io_pending & CS_WANT_READ)
4481 mask += ZOOM_SELECT_READ;
4482 ZOOM_connection_set_mask(c, mask);
4483 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4484 ZOOM_connection_put_event(c, event);
4488 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4489 ZOOM_connection_put_event(c, event);
4491 if (c->proto == PROTO_Z3950)
4492 ZOOM_connection_send_init(c);
4495 /* no init request for SRW .. */
4496 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4497 ZOOM_connection_remove_task(c);
4498 ZOOM_connection_set_mask(c, 0);
4499 ZOOM_connection_exec_task(c);
4501 c->state = STATE_ESTABLISHED;
4505 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4511 if (mask & ZOOM_SELECT_EXCEPT)
4513 if (!ZOOM_test_reconnect(c))
4515 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4520 if (mask & ZOOM_SELECT_READ)
4522 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4528 ZOOM_connection_last_event(ZOOM_connection cs)
4531 return ZOOM_EVENT_NONE;
4532 return cs->last_event;
4536 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4538 WRBUF wrbuf = (WRBUF) client_data;
4539 wrbuf_puts(wrbuf, buf);
4543 * Returns an xmalloc()d string containing RPN that corresponds to the
4544 * CQL passed in. On error, sets the Connection object's error state
4545 * and returns a null pointer.
4546 * ### We could cache CQL parser and/or transformer in Connection.
4548 static char *cql2pqf(ZOOM_connection c, const char *cql)
4552 const char *cqlfile;
4553 cql_transform_t trans;
4556 parser = cql_parser_create();
4557 if ((error = cql_parser_string(parser, cql)) != 0) {
4558 cql_parser_destroy(parser);
4559 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4563 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4566 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4568 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4571 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4572 cqlfile, strerror(errno));
4573 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4577 WRBUF wrbuf_result = wrbuf_alloc();
4578 error = cql_transform(trans, cql_parser_result(parser),
4579 cql2pqf_wrbuf_puts, wrbuf_result);
4582 const char *addinfo;
4583 error = cql_transform_error(trans, &addinfo);
4584 sprintf(buf, "%.200s (addinfo=%.200s)",
4585 cql_strerror(error), addinfo);
4586 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4590 result = xstrdup(wrbuf_cstr(wrbuf_result));
4592 cql_transform_close(trans);
4593 wrbuf_destroy(wrbuf_result);
4595 cql_parser_destroy(parser);
4599 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4603 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4604 /* timeout and this connection was waiting */
4605 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4607 ZOOM_connection_put_event(c, event);
4613 ZOOM_connection_process(ZOOM_connection c)
4619 event = ZOOM_connection_get_event(c);
4622 ZOOM_Event_destroy(event);
4625 ZOOM_connection_exec_task(c);
4626 event = ZOOM_connection_get_event(c);
4629 ZOOM_Event_destroy(event);
4636 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4640 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4642 for (i = 0; i<no; i++)
4644 ZOOM_connection c = cs[i];
4646 if (c && ZOOM_connection_process(c))
4652 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4654 if (c->mask && mask)
4655 ZOOM_connection_do_io(c, mask);
4659 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4662 return cs_fileno(c->cs);
4666 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4674 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4681 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4683 return ZOOM_options_get_int(c->options, "timeout", 30);
4689 * indent-tabs-mode: nil
4691 * vim: shiftwidth=4 tabstop=8 expandtab