1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2009 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);
1022 r->record_hash[i] = 0;
1027 ZOOM_resultset_destroy(ZOOM_resultset r)
1029 resultset_destroy(r);
1032 static void resultset_destroy(ZOOM_resultset r)
1037 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1039 if (r->refcount == 0)
1041 ZOOM_resultset_cache_reset(r);
1045 /* remove ourselves from the resultsets in connection */
1046 ZOOM_resultset *rp = &r->connection->resultsets;
1049 assert(*rp); /* we must be in this list!! */
1051 { /* OK, we're here - take us out of it */
1058 ZOOM_query_destroy(r->query);
1059 ZOOM_options_destroy(r->options);
1060 odr_destroy(r->odr);
1068 ZOOM_resultset_size(ZOOM_resultset r)
1070 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1075 static void do_close(ZOOM_connection c)
1080 ZOOM_connection_set_mask(c, 0);
1081 c->state = STATE_IDLE;
1084 static int ZOOM_test_reconnect(ZOOM_connection c)
1088 if (!c->reconnect_ok)
1091 c->reconnect_ok = 0;
1092 c->tasks->running = 0;
1093 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1095 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1096 ZOOM_connection_put_event(c, event);
1101 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1102 int force_sync, int start, int count)
1107 const char *syntax, *elementSetName;
1111 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1112 " count=%d", r, force_sync, start, count);
1117 if (c->host_port && c->proto == PROTO_HTTP)
1121 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1122 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1126 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1128 c->reconnect_ok = 1;
1131 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1132 task->u.retrieve.resultset = r;
1133 task->u.retrieve.start = start;
1134 task->u.retrieve.count = count;
1136 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1137 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1138 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1139 task->u.retrieve.elementSetName = elementSetName
1140 ? xstrdup(elementSetName) : 0;
1142 cp = ZOOM_options_get(r->options, "schema");
1145 if (!r->schema || strcmp(r->schema, cp))
1148 r->schema = xstrdup(cp);
1152 ZOOM_resultset_addref(r);
1154 if (!r->connection->async || force_sync)
1155 while (r->connection && ZOOM_event(1, &r->connection))
1160 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1161 size_t start, size_t count)
1163 int force_present = 0;
1167 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1168 r, r, (long) start, (long) count);
1171 ZOOM_resultset_retrieve(r, force_present, start, count);
1175 for (i = 0; i< count; i++)
1176 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1180 static void get_cert(ZOOM_connection c)
1185 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1187 ZOOM_connection_option_setl(c, "sslPeerCert",
1188 cert_buf, cert_len);
1193 static zoom_ret do_connect(ZOOM_connection c)
1196 const char *effective_host;
1199 effective_host = c->proxy;
1201 effective_host = c->host_port;
1203 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1207 c->cs = cs_create_host(effective_host, 0, &add);
1209 if (c->cs && c->cs->protocol == PROTO_HTTP)
1212 const char *path = 0;
1214 c->proto = PROTO_HTTP;
1215 cs_get_host_args(c->host_port, &path);
1217 c->path = (char*) xmalloc(strlen(path)+2);
1219 strcpy(c->path+1, path);
1221 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1223 return zoom_complete;
1228 int ret = cs_connect(c->cs, add);
1231 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1232 ZOOM_connection_put_event(c, event);
1234 if (c->proto == PROTO_Z3950)
1235 ZOOM_connection_send_init(c);
1238 /* no init request for SRW .. */
1239 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1240 ZOOM_connection_remove_task(c);
1241 ZOOM_connection_set_mask(c, 0);
1242 ZOOM_connection_exec_task(c);
1244 c->state = STATE_ESTABLISHED;
1245 return zoom_pending;
1249 int mask = ZOOM_SELECT_EXCEPT;
1250 if (c->cs->io_pending & CS_WANT_WRITE)
1251 mask += ZOOM_SELECT_WRITE;
1252 if (c->cs->io_pending & CS_WANT_READ)
1253 mask += ZOOM_SELECT_READ;
1254 ZOOM_connection_set_mask(c, mask);
1255 c->state = STATE_CONNECTING;
1256 return zoom_pending;
1259 c->state = STATE_IDLE;
1260 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1261 return zoom_complete;
1264 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1267 for (i = 0; i<200; i++)
1271 Z_OtherInformation **oi;
1276 sprintf(buf, "otherInfo%d", i);
1277 val = ZOOM_options_get(c->options, buf);
1280 cp = strchr(val, ':');
1284 if (len >= sizeof(buf))
1285 len = sizeof(buf)-1;
1286 memcpy(buf, val, len);
1289 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1294 yaz_oi_APDU(a, &oi);
1295 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1299 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1304 Z_OtherInformation **oi;
1305 yaz_oi_APDU(a, &oi);
1306 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1311 Z_OtherInformation **oi;
1312 yaz_oi_APDU(a, &oi);
1313 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1316 otherInfo_attach(c, a, out);
1317 if (!z_APDU(out, &a, 0, 0))
1319 FILE *outf = fopen("/tmp/apdu.txt", "a");
1322 ODR odr_pr = odr_createmem(ODR_PRINT);
1323 fprintf(outf, "a=%p\n", a);
1324 odr_setprint(odr_pr, outf);
1325 z_APDU(odr_pr, &a, 0, 0);
1326 odr_destroy(odr_pr);
1328 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1329 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1334 z_APDU(c->odr_print, &a, 0, 0);
1335 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1339 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1343 if (encode_APDU(c, a, c->odr_out))
1344 return zoom_complete;
1345 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1346 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1347 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1348 ZOOM_connection_put_event(c, event);
1349 odr_reset(c->odr_out);
1353 /* returns 1 if PDU was sent OK (still pending )
1354 0 if PDU was not sent OK (nothing to wait for)
1357 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1359 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1360 Z_InitRequest *ireq = apdu->u.initRequest;
1361 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1362 odr_malloc(c->odr_out, sizeof(*auth));
1364 ODR_MASK_SET(ireq->options, Z_Options_search);
1365 ODR_MASK_SET(ireq->options, Z_Options_present);
1366 ODR_MASK_SET(ireq->options, Z_Options_scan);
1367 ODR_MASK_SET(ireq->options, Z_Options_sort);
1368 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1369 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1371 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1372 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1373 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1375 ireq->implementationId =
1376 odr_prepend(c->odr_out,
1377 ZOOM_options_get(c->options, "implementationId"),
1378 ireq->implementationId);
1380 ireq->implementationName =
1381 odr_prepend(c->odr_out,
1382 ZOOM_options_get(c->options, "implementationName"),
1383 odr_prepend(c->odr_out, "ZOOM-C",
1384 ireq->implementationName));
1386 ireq->implementationVersion =
1387 odr_prepend(c->odr_out,
1388 ZOOM_options_get(c->options, "implementationVersion"),
1389 ireq->implementationVersion);
1391 *ireq->maximumRecordSize = c->maximum_record_size;
1392 *ireq->preferredMessageSize = c->preferred_message_size;
1394 if (c->group || c->password)
1396 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1397 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1398 pass->userId = odr_strdup_null(c->odr_out, c->user);
1399 pass->password = odr_strdup_null(c->odr_out, c->password);
1400 auth->which = Z_IdAuthentication_idPass;
1401 auth->u.idPass = pass;
1402 ireq->idAuthentication = auth;
1406 auth->which = Z_IdAuthentication_open;
1407 auth->u.open = odr_strdup(c->odr_out, c->user);
1408 ireq->idAuthentication = auth;
1412 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1413 yaz_oid_userinfo_proxy, 1, c->host_port);
1415 if (c->charset || c->lang)
1417 Z_OtherInformation **oi;
1418 Z_OtherInformationUnit *oi_unit;
1420 yaz_oi_APDU(apdu, &oi);
1422 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1424 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1425 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1426 oi_unit->information.externallyDefinedInfo =
1427 yaz_set_proposal_charneg_list(c->odr_out, " ",
1428 c->charset, c->lang, 1);
1432 return send_APDU(c, apdu);
1436 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1440 const char *database = ZOOM_options_get(c->options, "databaseName");
1441 char *fdatabase = 0;
1445 fdatabase = (char *) odr_malloc(c->odr_out, strlen(database)+2);
1446 strcpy(fdatabase, "/");
1447 strcat(fdatabase, database);
1449 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1450 fdatabase ? fdatabase : c->path);
1452 if (c->sru_mode == zoom_sru_get)
1454 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1456 else if (c->sru_mode == zoom_sru_post)
1458 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1460 else if (c->sru_mode == zoom_sru_soap)
1462 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1464 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1465 return zoom_complete;
1467 z_GDU(c->odr_print, &gdu, 0, 0);
1468 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1470 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1471 ZOOM_connection_put_event(c, event);
1472 odr_reset(c->odr_out);
1478 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1480 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1481 sr->username = c->user;
1482 sr->password = c->password;
1488 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1492 ZOOM_resultset resultset = 0;
1494 const char *option_val = 0;
1496 if (c->error) /* don't continue on error */
1497 return zoom_complete;
1499 switch(c->tasks->which)
1501 case ZOOM_TASK_SEARCH:
1502 resultset = c->tasks->u.search.resultset;
1503 if (!resultset->setname)
1504 resultset->setname = xstrdup("default");
1505 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1506 start = &c->tasks->u.search.start;
1507 count = &c->tasks->u.search.count;
1509 case ZOOM_TASK_RETRIEVE:
1510 resultset = c->tasks->u.retrieve.resultset;
1512 start = &c->tasks->u.retrieve.start;
1513 count = &c->tasks->u.retrieve.count;
1515 if (*start >= resultset->size)
1516 return zoom_complete;
1517 if (*start + *count > resultset->size)
1518 *count = resultset->size - *start;
1520 for (i = 0; i < *count; i++)
1523 record_cache_lookup(resultset, i + *start,
1524 c->tasks->u.retrieve.syntax,
1525 c->tasks->u.retrieve.elementSetName);
1530 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1531 ZOOM_connection_put_event(c, event);
1538 return zoom_complete;
1541 return zoom_complete;
1543 assert(resultset->query);
1545 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1546 if (resultset->query->z_query->which == Z_Query_type_104
1547 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1549 sr->u.request->query_type = Z_SRW_query_type_cql;
1550 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1552 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1553 resultset->query->z_query->u.type_1)
1555 sr->u.request->query_type = Z_SRW_query_type_pqf;
1556 sr->u.request->query.pqf = resultset->query->query_string;
1560 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1561 return zoom_complete;
1563 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1564 sr->u.request->maximumRecords = odr_intdup(
1565 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1566 resultset->step : *count);
1567 sr->u.request->recordSchema = resultset->schema;
1569 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1571 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1573 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1574 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1575 return send_srw(c, sr);
1578 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1580 return zoom_complete;
1584 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1587 int lslb, ssub, mspn;
1589 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1590 Z_SearchRequest *search_req = apdu->u.searchRequest;
1591 const char *elementSetName;
1592 const char *smallSetElementSetName;
1593 const char *mediumSetElementSetName;
1596 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1598 r = c->tasks->u.search.resultset;
1600 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1603 ZOOM_options_get(r->options, "elementSetName");
1604 smallSetElementSetName =
1605 ZOOM_options_get(r->options, "smallSetElementSetName");
1606 mediumSetElementSetName =
1607 ZOOM_options_get(r->options, "mediumSetElementSetName");
1609 if (!smallSetElementSetName)
1610 smallSetElementSetName = elementSetName;
1612 if (!mediumSetElementSetName)
1613 mediumSetElementSetName = elementSetName;
1618 /* prepare query for the search request */
1619 search_req->query = r->query->z_query;
1620 if (!search_req->query)
1622 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1623 return zoom_complete;
1625 if (r->query->z_query->which == Z_Query_type_1 ||
1626 r->query->z_query->which == Z_Query_type_101)
1628 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1631 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1634 search_req->query = yaz_copy_Z_Query(search_req->query,
1637 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1639 yaz_iconv_close(cd);
1643 search_req->databaseNames = r->databaseNames;
1644 search_req->num_databaseNames = r->num_databaseNames;
1646 /* get syntax (no need to provide unless piggyback is in effect) */
1647 syntax = c->tasks->u.search.syntax;
1649 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1650 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1651 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1652 if (lslb != -1 && ssub != -1 && mspn != -1)
1654 /* So're a Z39.50 expert? Let's hope you don't do sort */
1655 *search_req->largeSetLowerBound = lslb;
1656 *search_req->smallSetUpperBound = ssub;
1657 *search_req->mediumSetPresentNumber = mspn;
1659 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1660 && r->piggyback && !r->r_sort_spec && !r->schema)
1662 /* Regular piggyback - do it unless we're going to do sort */
1663 *search_req->largeSetLowerBound = 2000000000;
1664 *search_req->smallSetUpperBound = 1;
1665 *search_req->mediumSetPresentNumber =
1666 r->step>0 ? r->step : c->tasks->u.search.count;
1670 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1671 smallSetElementSetName = 0;
1672 mediumSetElementSetName = 0;
1675 if (smallSetElementSetName && *smallSetElementSetName)
1677 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1678 odr_malloc(c->odr_out, sizeof(*esn));
1680 esn->which = Z_ElementSetNames_generic;
1681 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1682 search_req->smallSetElementSetNames = esn;
1684 if (mediumSetElementSetName && *mediumSetElementSetName)
1686 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1687 odr_malloc(c->odr_out, sizeof(*esn));
1689 esn->which = Z_ElementSetNames_generic;
1690 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1691 search_req->mediumSetElementSetNames = esn;
1694 search_req->preferredRecordSyntax =
1695 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1699 if (c->support_named_resultsets)
1703 /* find the lowest unused ordinal so that we re-use
1704 result sets on the server. */
1705 for (ord = 1; ; ord++)
1708 sprintf(setname, "%d", ord);
1709 for (rp = c->resultsets; rp; rp = rp->next)
1710 if (rp->setname && !strcmp(rp->setname, setname))
1715 r->setname = xstrdup(setname);
1716 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1717 "set %s", c, r->setname);
1721 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1723 r->setname = xstrdup("default");
1725 ZOOM_options_set(r->options, "setname", r->setname);
1727 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1728 return send_APDU(c, apdu);
1731 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1733 char oid_name_buf[OID_STR_MAX];
1734 const char *oid_name;
1737 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1740 case Z_DefaultDiagFormat_v2Addinfo:
1741 addinfo = r->u.v2Addinfo;
1743 case Z_DefaultDiagFormat_v3Addinfo:
1744 addinfo = r->u.v3Addinfo;
1749 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1752 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1754 if (p->which != Z_DiagRec_defaultFormat)
1755 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1757 response_default_diag(c, p->u.defaultFormat);
1760 ZOOM_API(ZOOM_record)
1761 ZOOM_record_clone(ZOOM_record srec)
1768 odr_enc = odr_createmem(ODR_ENCODE);
1769 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1771 buf = odr_getbuf(odr_enc, &size, 0);
1773 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1774 nrec->odr = odr_createmem(ODR_DECODE);
1775 nrec->wrbuf_marc = 0;
1776 nrec->wrbuf_iconv = 0;
1777 odr_setbuf(nrec->odr, buf, size, 0);
1778 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1780 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1781 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1782 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1783 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1784 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1785 odr_destroy(odr_enc);
1789 ZOOM_API(ZOOM_record)
1790 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1792 const char *syntax =
1793 ZOOM_options_get(s->options, "preferredRecordSyntax");
1794 const char *elementSetName =
1795 ZOOM_options_get(s->options, "elementSetName");
1797 return record_cache_lookup(s, pos, syntax, elementSetName);
1800 ZOOM_API(ZOOM_record)
1801 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1803 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1808 * MIKE: I think force_sync should always be zero, but I don't
1809 * want to make this change until I get the go-ahead from
1810 * Adam, in case something depends on the old synchronous
1814 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1815 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1816 rec = ZOOM_resultset_record_immediate(r, pos);
1822 ZOOM_record_destroy(ZOOM_record rec)
1826 if (rec->wrbuf_marc)
1827 wrbuf_destroy(rec->wrbuf_marc);
1828 if (rec->wrbuf_iconv)
1829 wrbuf_destroy(rec->wrbuf_iconv);
1830 odr_destroy(rec->odr);
1835 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1842 strcpy(to, "UTF-8");
1843 if (record_charset && *record_charset)
1845 /* Use "from,to" or just "from" */
1846 const char *cp = strchr(record_charset, ',');
1847 int clen = strlen(record_charset);
1850 strncpy( to, cp+1, sizeof(to)-1);
1851 to[sizeof(to)-1] = '\0';
1852 clen = cp - record_charset;
1854 if (clen > sizeof(from)-1)
1855 clen = sizeof(from)-1;
1858 strncpy(from, record_charset, clen);
1862 cd = yaz_iconv_open(to, from);
1866 static const char *return_marc_record(ZOOM_record rec, int marc_type,
1868 const char *buf, int sz,
1869 const char *record_charset)
1871 yaz_iconv_t cd = iconv_create_charset(record_charset);
1872 yaz_marc_t mt = yaz_marc_create();
1873 const char *ret_string = 0;
1876 yaz_marc_iconv(mt, cd);
1877 yaz_marc_xml(mt, marc_type);
1878 if (!rec->wrbuf_marc)
1879 rec->wrbuf_marc = wrbuf_alloc();
1880 wrbuf_rewind(rec->wrbuf_marc);
1881 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1884 *len = wrbuf_len(rec->wrbuf_marc);
1885 ret_string = wrbuf_cstr(rec->wrbuf_marc);
1887 yaz_marc_destroy(mt);
1889 yaz_iconv_close(cd);
1893 static const char *return_opac_record(ZOOM_record rec, int marc_type,
1895 Z_OPACRecord *opac_rec,
1896 const char *record_charset)
1898 yaz_iconv_t cd = iconv_create_charset(record_charset);
1899 yaz_marc_t mt = yaz_marc_create();
1902 yaz_marc_iconv(mt, cd);
1903 yaz_marc_xml(mt, marc_type);
1905 if (!rec->wrbuf_marc)
1906 rec->wrbuf_marc = wrbuf_alloc();
1907 wrbuf_rewind(rec->wrbuf_marc);
1909 yaz_opac_decode_wrbuf(mt, opac_rec, rec->wrbuf_marc);
1910 yaz_marc_destroy(mt);
1913 yaz_iconv_close(cd);
1915 *len = wrbuf_len(rec->wrbuf_marc);
1916 return wrbuf_cstr(rec->wrbuf_marc);
1919 static const char *return_string_record(ZOOM_record rec, int *len,
1920 const char *buf, int sz,
1921 const char *record_charset)
1923 yaz_iconv_t cd = iconv_create_charset(record_charset);
1927 if (!rec->wrbuf_iconv)
1928 rec->wrbuf_iconv = wrbuf_alloc();
1930 wrbuf_rewind(rec->wrbuf_iconv);
1932 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1933 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1935 buf = wrbuf_cstr(rec->wrbuf_iconv);
1936 sz = wrbuf_len(rec->wrbuf_iconv);
1937 yaz_iconv_close(cd);
1944 static const char *return_record(ZOOM_record rec, int *len,
1945 Z_NamePlusRecord *npr,
1946 int marctype, const char *charset)
1948 Z_External *r = (Z_External *) npr->u.databaseRecord;
1949 const Odr_oid *oid = r->direct_reference;
1951 /* render bibliographic record .. */
1952 if (r->which == Z_External_OPAC)
1954 return return_opac_record(rec, marctype, len,
1955 r->u.opac, charset);
1957 if (r->which == Z_External_sutrs)
1958 return return_string_record(rec, len,
1959 (char*) r->u.sutrs->buf,
1962 else if (r->which == Z_External_octet)
1964 if (yaz_oid_is_iso2709(oid))
1966 const char *ret_buf = return_marc_record(
1968 (const char *) r->u.octet_aligned->buf,
1969 r->u.octet_aligned->len,
1974 return return_string_record(rec, len,
1975 (const char *) r->u.octet_aligned->buf,
1976 r->u.octet_aligned->len,
1979 else if (r->which == Z_External_grs1)
1981 if (!rec->wrbuf_marc)
1982 rec->wrbuf_marc = wrbuf_alloc();
1983 wrbuf_rewind(rec->wrbuf_marc);
1984 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1985 return return_string_record(rec, len,
1986 wrbuf_buf(rec->wrbuf_marc),
1987 wrbuf_len(rec->wrbuf_marc),
1995 ZOOM_record_error(ZOOM_record rec, const char **cp,
1996 const char **addinfo, const char **diagset)
1998 Z_NamePlusRecord *npr;
2007 *cp = rec->diag_message;
2009 *addinfo = rec->diag_details;
2011 *diagset = rec->diag_set;
2012 return uri_to_code(rec->diag_uri);
2014 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2016 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2017 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2018 const char *add = 0;
2020 if (diag_rec->which == Z_DiagRec_defaultFormat)
2022 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2025 error = *ddf->condition;
2028 case Z_DefaultDiagFormat_v2Addinfo:
2029 add = ddf->u.v2Addinfo;
2031 case Z_DefaultDiagFormat_v3Addinfo:
2032 add = ddf->u.v3Addinfo;
2037 yaz_oid_to_string(yaz_oid_std(),
2038 ddf->diagnosticSetId, &oclass);
2046 *addinfo = add ? add : "";
2048 *cp = diagbib1_str(error);
2054 ZOOM_API(const char *)
2055 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2062 Z_NamePlusRecord *npr;
2065 *len = 0; /* default return */
2074 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
2076 if (cp[i] == ';' || cp[i] == ' ')
2082 while (type_spec[i] == ';')
2085 while (type_spec[i] == ' ')
2087 if (!strncmp(type_spec+i, "charset=", 8))
2090 i = i + 8; /* skip charset= */
2091 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
2093 if (type_spec[i] == ';' || type_spec[i] == ' ')
2099 else if (!strncmp(type_spec+i, "xpath=", 6))
2103 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2107 while (type_spec[i] == ' ')
2110 if (!strcmp(type, "database"))
2113 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2114 return npr->databaseName;
2116 else if (!strcmp(type, "schema"))
2119 *len = rec->schema ? strlen(rec->schema) : 0;
2122 else if (!strcmp(type, "syntax"))
2124 const char *desc = 0;
2125 if (npr->which == Z_NamePlusRecord_databaseRecord)
2127 Z_External *r = (Z_External *) npr->u.databaseRecord;
2128 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2133 *len = strlen(desc);
2136 if (npr->which != Z_NamePlusRecord_databaseRecord)
2139 /* from now on - we have a database record .. */
2140 if (!strcmp(type, "render"))
2142 return return_record(rec, len, npr, YAZ_MARC_LINE, charset);
2144 else if (!strcmp(type, "xml"))
2146 return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2148 else if (!strcmp(type, "raw"))
2150 return return_record(rec, len, npr, YAZ_MARC_ISO2709, charset);
2152 else if (!strcmp (type, "ext"))
2155 return (const char *) npr->u.databaseRecord;
2157 else if (!strcmp (type, "opac"))
2159 return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2164 static int strcmp_null(const char *v1, const char *v2)
2170 return strcmp(v1, v2);
2173 static size_t record_hash(int pos)
2177 return pos % RECORD_HASH_SIZE;
2180 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2182 const char *syntax, const char *elementSetName,
2184 Z_SRW_diagnostic *diag)
2186 ZOOM_record_cache rc = 0;
2188 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2189 ZOOM_connection_put_event(r->connection, event);
2191 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2194 && strcmp_null(r->schema, rc->schema) == 0
2195 && strcmp_null(elementSetName,rc->elementSetName) == 0
2196 && strcmp_null(syntax, rc->syntax) == 0)
2201 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2203 rc->rec.wrbuf_marc = 0;
2204 rc->rec.wrbuf_iconv = 0;
2205 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2207 rc->syntax = odr_strdup_null(r->odr, syntax);
2209 rc->schema = odr_strdup_null(r->odr, r->schema);
2212 rc->next = r->record_hash[record_hash(pos)];
2213 r->record_hash[record_hash(pos)] = rc;
2216 rc->rec.schema = odr_strdup_null(r->odr, schema);
2217 rc->rec.diag_set = 0;
2218 rc->rec.diag_uri = 0;
2219 rc->rec.diag_message = 0;
2220 rc->rec.diag_details = 0;
2226 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2227 if ((cp = strrchr(rc->rec.diag_set, '/')))
2229 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2231 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2232 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2236 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2238 const char *elementSetName)
2240 ZOOM_record_cache rc;
2242 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2246 if (strcmp_null(r->schema, rc->schema))
2248 if (strcmp_null(elementSetName,rc->elementSetName))
2250 if (strcmp_null(syntax, rc->syntax))
2258 static void handle_records(ZOOM_connection c, Z_Records *sr,
2261 ZOOM_resultset resultset;
2263 const char *syntax = 0, *elementSetName = 0;
2267 switch (c->tasks->which)
2269 case ZOOM_TASK_SEARCH:
2270 resultset = c->tasks->u.search.resultset;
2271 start = &c->tasks->u.search.start;
2272 count = &c->tasks->u.search.count;
2273 syntax = c->tasks->u.search.syntax;
2274 elementSetName = c->tasks->u.search.elementSetName;
2276 case ZOOM_TASK_RETRIEVE:
2277 resultset = c->tasks->u.retrieve.resultset;
2278 start = &c->tasks->u.retrieve.start;
2279 count = &c->tasks->u.retrieve.count;
2280 syntax = c->tasks->u.retrieve.syntax;
2281 elementSetName = c->tasks->u.retrieve.elementSetName;
2286 if (sr && sr->which == Z_Records_NSD)
2287 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2288 else if (sr && sr->which == Z_Records_multipleNSD)
2290 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2291 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2293 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2297 if (*count + *start > resultset->size)
2298 *count = resultset->size - *start;
2301 if (sr && sr->which == Z_Records_DBOSD)
2304 NMEM nmem = odr_extract_mem(c->odr_in);
2305 Z_NamePlusRecordList *p =
2306 sr->u.databaseOrSurDiagnostics;
2307 for (i = 0; i<p->num_records; i++)
2309 record_cache_add(resultset, p->records[i], i + *start,
2310 syntax, elementSetName,
2317 yaz_log(log_details,
2318 "handle_records resultset=%p start=%d count=%d",
2319 resultset, *start, *count);
2321 /* transfer our response to search_nmem .. we need it later */
2322 nmem_transfer(odr_getmem(resultset->odr), nmem);
2324 if (present_phase && p->num_records == 0)
2326 /* present response and we didn't get any records! */
2327 Z_NamePlusRecord *myrec =
2328 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2329 record_cache_add(resultset, myrec, *start,
2330 syntax, elementSetName, 0, 0);
2333 else if (present_phase)
2335 /* present response and we didn't get any records! */
2336 Z_NamePlusRecord *myrec =
2337 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2338 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2344 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2346 handle_records(c, pr->records, 1);
2349 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2352 switch (term->which)
2354 case Z_Term_general:
2355 ZOOM_options_setl(opt, name,
2356 (const char *)(term->u.general->buf),
2357 term->u.general->len);
2359 case Z_Term_characterString:
2360 ZOOM_options_set(opt, name, term->u.characterString);
2362 case Z_Term_numeric:
2363 ZOOM_options_set_int(opt, name, *term->u.numeric);
2368 static void handle_queryExpression(ZOOM_options opt, const char *name,
2369 Z_QueryExpression *exp)
2375 case Z_QueryExpression_term:
2376 if (exp->u.term && exp->u.term->queryTerm)
2378 sprintf(opt_name, "%s.term", name);
2379 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2382 case Z_QueryExpression_query:
2387 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2388 Z_OtherInformation *o)
2391 for (i = 0; o && i < o->num_elements; i++)
2393 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2395 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2397 if (ext->which == Z_External_searchResult1)
2400 Z_SearchInfoReport *sr = ext->u.searchResult1;
2403 ZOOM_options_set_int(
2404 resultset->options, "searchresult.size", sr->num);
2406 for (j = 0; j < sr->num; j++)
2408 Z_SearchInfoReport_s *ent =
2409 ext->u.searchResult1->elements[j];
2412 sprintf(pref, "searchresult.%d", j);
2414 if (ent->subqueryId)
2417 sprintf(opt_name, "%s.id", pref);
2418 ZOOM_options_set(resultset->options, opt_name,
2421 if (ent->subqueryExpression)
2424 sprintf(opt_name, "%s.subquery", pref);
2425 handle_queryExpression(resultset->options, opt_name,
2426 ent->subqueryExpression);
2428 if (ent->subqueryInterpretation)
2431 sprintf(opt_name, "%s.interpretation", pref);
2432 handle_queryExpression(resultset->options, opt_name,
2433 ent->subqueryInterpretation);
2435 if (ent->subqueryRecommendation)
2438 sprintf(opt_name, "%s.recommendation", pref);
2439 handle_queryExpression(resultset->options, opt_name,
2440 ent->subqueryRecommendation);
2442 if (ent->subqueryCount)
2445 sprintf(opt_name, "%s.count", pref);
2446 ZOOM_options_set_int(resultset->options, opt_name,
2447 *ent->subqueryCount);
2455 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2457 ZOOM_resultset resultset;
2460 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2463 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2464 ZOOM_connection_put_event(c, event);
2466 resultset = c->tasks->u.search.resultset;
2468 if (sr->resultSetStatus)
2470 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2471 *sr->resultSetStatus);
2473 if (sr->presentStatus)
2475 ZOOM_options_set_int(resultset->options, "presentStatus",
2476 *sr->presentStatus);
2478 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2480 resultset->size = *sr->resultCount;
2481 handle_records(c, sr->records, 0);
2484 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2486 if (res->diagnostics && res->num_diagnostics > 0)
2487 response_diag(c, res->diagnostics[0]);
2490 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2492 NMEM nmem = odr_extract_mem(c->odr_in);
2495 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2497 scan = c->tasks->u.scan.scan;
2499 if (res->entries && res->entries->nonsurrogateDiagnostics)
2500 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2501 scan->scan_response = res;
2502 scan->srw_scan_response = 0;
2503 nmem_transfer(odr_getmem(scan->odr), nmem);
2505 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2506 if (res->positionOfTerm)
2507 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2508 if (res->scanStatus)
2509 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2510 if (res->numberOfEntriesReturned)
2511 ZOOM_options_set_int(scan->options, "number",
2512 *res->numberOfEntriesReturned);
2517 static zoom_ret send_sort(ZOOM_connection c,
2518 ZOOM_resultset resultset)
2521 resultset->r_sort_spec = 0;
2522 if (resultset->r_sort_spec)
2524 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2525 Z_SortRequest *req = apdu->u.sortRequest;
2527 req->num_inputResultSetNames = 1;
2528 req->inputResultSetNames = (Z_InternationalString **)
2529 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2530 req->inputResultSetNames[0] =
2531 odr_strdup(c->odr_out, resultset->setname);
2532 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2533 req->sortSequence = resultset->r_sort_spec;
2534 resultset->r_sort_spec = 0;
2535 return send_APDU(c, apdu);
2537 return zoom_complete;
2540 static zoom_ret send_present(ZOOM_connection c)
2543 Z_PresentRequest *req = 0;
2545 const char *syntax = 0;
2546 const char *elementSetName = 0;
2547 ZOOM_resultset resultset;
2552 yaz_log(log_details, "%p send_present no tasks", c);
2553 return zoom_complete;
2556 switch (c->tasks->which)
2558 case ZOOM_TASK_SEARCH:
2559 resultset = c->tasks->u.search.resultset;
2560 start = &c->tasks->u.search.start;
2561 count = &c->tasks->u.search.count;
2562 syntax = c->tasks->u.search.syntax;
2563 elementSetName = c->tasks->u.search.elementSetName;
2565 case ZOOM_TASK_RETRIEVE:
2566 resultset = c->tasks->u.retrieve.resultset;
2567 start = &c->tasks->u.retrieve.start;
2568 count = &c->tasks->u.retrieve.count;
2569 syntax = c->tasks->u.retrieve.syntax;
2570 elementSetName = c->tasks->u.retrieve.elementSetName;
2573 return zoom_complete;
2575 yaz_log(log_details, "%p send_present start=%d count=%d",
2578 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2580 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2583 if (c->error) /* don't continue on error */
2584 return zoom_complete;
2585 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2586 resultset, *start, *count);
2588 for (i = 0; i < *count; i++)
2591 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2596 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2597 ZOOM_connection_put_event(c, event);
2605 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2606 return zoom_complete;
2609 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2610 req = apdu->u.presentRequest;
2613 yaz_log(log_details, "%p send_present skip=%d", c, i);
2615 *req->resultSetStartPoint = *start + 1;
2617 if (resultset->step > 0 && resultset->step < *count)
2618 *req->numberOfRecordsRequested = resultset->step;
2620 *req->numberOfRecordsRequested = *count;
2622 if (*req->numberOfRecordsRequested + *start > resultset->size)
2623 *req->numberOfRecordsRequested = resultset->size - *start;
2624 assert(*req->numberOfRecordsRequested > 0);
2626 if (syntax && *syntax)
2627 req->preferredRecordSyntax =
2628 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2630 if (resultset->schema && *resultset->schema)
2632 Z_RecordComposition *compo = (Z_RecordComposition *)
2633 odr_malloc(c->odr_out, sizeof(*compo));
2635 req->recordComposition = compo;
2636 compo->which = Z_RecordComp_complex;
2637 compo->u.complex = (Z_CompSpec *)
2638 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2639 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2640 odr_malloc(c->odr_out, sizeof(bool_t));
2641 *compo->u.complex->selectAlternativeSyntax = 0;
2643 compo->u.complex->generic = (Z_Specification *)
2644 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2646 compo->u.complex->generic->which = Z_Schema_oid;
2647 compo->u.complex->generic->schema.oid = (Odr_oid *)
2648 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2650 if (!compo->u.complex->generic->schema.oid)
2652 /* OID wasn't a schema! Try record syntax instead. */
2654 compo->u.complex->generic->schema.oid = (Odr_oid *)
2655 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2657 if (elementSetName && *elementSetName)
2659 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2660 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2661 compo->u.complex->generic->elementSpec->which =
2662 Z_ElementSpec_elementSetName;
2663 compo->u.complex->generic->elementSpec->u.elementSetName =
2664 odr_strdup(c->odr_out, elementSetName);
2667 compo->u.complex->generic->elementSpec = 0;
2668 compo->u.complex->num_dbSpecific = 0;
2669 compo->u.complex->dbSpecific = 0;
2670 compo->u.complex->num_recordSyntax = 0;
2671 compo->u.complex->recordSyntax = 0;
2673 else if (elementSetName && *elementSetName)
2675 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2676 odr_malloc(c->odr_out, sizeof(*esn));
2677 Z_RecordComposition *compo = (Z_RecordComposition *)
2678 odr_malloc(c->odr_out, sizeof(*compo));
2680 esn->which = Z_ElementSetNames_generic;
2681 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2682 compo->which = Z_RecordComp_simple;
2683 compo->u.simple = esn;
2684 req->recordComposition = compo;
2686 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2687 return send_APDU(c, apdu);
2690 ZOOM_API(ZOOM_scanset)
2691 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2694 ZOOM_query q = ZOOM_query_create();
2696 ZOOM_query_prefix(q, start);
2698 s = ZOOM_connection_scan1(c, q);
2699 ZOOM_query_destroy(q);
2704 ZOOM_API(ZOOM_scanset)
2705 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2707 ZOOM_scanset scan = 0;
2711 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2712 scan->connection = c;
2713 scan->odr = odr_createmem(ODR_DECODE);
2714 scan->options = ZOOM_options_create_with_parent(c->options);
2716 scan->scan_response = 0;
2717 scan->srw_scan_response = 0;
2721 scan->databaseNames = set_DatabaseNames(c, c->options,
2722 &scan->num_databaseNames,
2727 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2728 task->u.scan.scan = scan;
2733 while (ZOOM_event(1, &c))
2741 ZOOM_scanset_destroy(ZOOM_scanset scan)
2746 if (scan->refcount == 0)
2748 ZOOM_query_destroy(scan->query);
2750 odr_destroy(scan->odr);
2752 ZOOM_options_destroy(scan->options);
2757 static zoom_ret send_package(ZOOM_connection c)
2761 yaz_log(log_details, "%p send_package", c);
2763 return zoom_complete;
2764 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2766 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2767 ZOOM_connection_put_event(c, event);
2769 c->buf_out = c->tasks->u.package->buf_out;
2770 c->len_out = c->tasks->u.package->len_out;
2775 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2778 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2779 Z_ScanRequest *req = apdu->u.scanRequest;
2781 yaz_log(log_details, "%p send_scan", c);
2783 return zoom_complete;
2784 assert (c->tasks->which == ZOOM_TASK_SCAN);
2785 scan = c->tasks->u.scan.scan;
2787 /* Z39.50 scan can only carry RPN */
2788 if (scan->query->z_query->which == Z_Query_type_1 ||
2789 scan->query->z_query->which == Z_Query_type_101)
2791 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2792 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2795 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2798 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2800 yaz_query_charset_convert_rpnquery(
2801 rpn, c->odr_out, cd);
2802 yaz_iconv_close(cd);
2805 req->attributeSet = rpn->attributeSetId;
2806 if (!req->attributeSet)
2807 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2808 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2809 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2811 req->termListAndStartPoint =
2812 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2816 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2817 return zoom_complete;
2822 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2823 return zoom_complete;
2826 *req->numberOfTermsRequested =
2827 ZOOM_options_get_int(scan->options, "number", 10);
2829 req->preferredPositionInResponse =
2830 odr_intdup(c->odr_out,
2831 ZOOM_options_get_int(scan->options, "position", 1));
2834 odr_intdup(c->odr_out,
2835 ZOOM_options_get_int(scan->options, "stepSize", 0));
2837 req->databaseNames = scan->databaseNames;
2838 req->num_databaseNames = scan->num_databaseNames;
2840 return send_APDU(c, apdu);
2844 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2848 const char *option_val = 0;
2851 return zoom_complete;
2852 assert (c->tasks->which == ZOOM_TASK_SCAN);
2853 scan = c->tasks->u.scan.scan;
2855 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2857 /* SRU scan can only carry CQL and PQF */
2858 if (scan->query->z_query->which == Z_Query_type_104)
2860 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2861 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2863 else if (scan->query->z_query->which == Z_Query_type_1
2864 || scan->query->z_query->which == Z_Query_type_101)
2866 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2867 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2871 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2872 return zoom_complete;
2875 sr->u.scan_request->maximumTerms = odr_intdup(
2876 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2878 sr->u.scan_request->responsePosition = odr_intdup(
2879 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2881 option_val = ZOOM_options_get(scan->options, "extraArgs");
2882 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2883 return send_srw(c, sr);
2886 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2888 return zoom_complete;
2894 ZOOM_scanset_size(ZOOM_scanset scan)
2899 if (scan->scan_response && scan->scan_response->entries)
2900 return scan->scan_response->entries->num_entries;
2901 else if (scan->srw_scan_response)
2902 return scan->srw_scan_response->num_terms;
2906 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2908 const char **value_term, size_t *value_len,
2909 const char **disp_term, size_t *disp_len)
2911 size_t noent = ZOOM_scanset_size(scan);
2920 if (pos >= noent || pos < 0)
2922 if (scan->scan_response)
2924 Z_ScanResponse *res = scan->scan_response;
2925 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2927 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2929 *value_term = (const char *) t->term->u.general->buf;
2930 *value_len = t->term->u.general->len;
2933 *disp_term = t->displayTerm;
2934 *disp_len = strlen(*disp_term);
2936 else if (t->term->which == Z_Term_general)
2938 *disp_term = (const char *) t->term->u.general->buf;
2939 *disp_len = t->term->u.general->len;
2941 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2944 if (scan->srw_scan_response)
2946 Z_SRW_scanResponse *res = scan->srw_scan_response;
2947 Z_SRW_scanTerm *t = res->terms + pos;
2950 *value_term = t->value;
2951 *value_len = strlen(*value_term);
2954 *disp_term = t->displayTerm;
2956 *disp_term = t->value;
2957 *disp_len = strlen(*disp_term);
2958 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
2963 ZOOM_API(const char *)
2964 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2967 const char *value_term = 0;
2968 size_t value_len = 0;
2969 const char *disp_term = 0;
2970 size_t disp_len = 0;
2972 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2973 &disp_term, &disp_len);
2979 ZOOM_API(const char *)
2980 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2983 const char *value_term = 0;
2984 size_t value_len = 0;
2985 const char *disp_term = 0;
2986 size_t disp_len = 0;
2988 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2989 &disp_term, &disp_len);
2995 ZOOM_API(const char *)
2996 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2998 return ZOOM_options_get(scan->options, key);
3002 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3005 ZOOM_options_set(scan->options, key, val);
3008 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3011 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3012 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3014 str = ZOOM_options_get(p->options, "package-name");
3016 req->packageName = odr_strdup(p->odr_out, str);
3018 str = ZOOM_options_get(p->options, "user-id");
3020 req->userId = odr_strdup_null(p->odr_out, str);
3022 req->packageType = odr_oiddup(p->odr_out, oid);
3024 str = ZOOM_options_get(p->options, "function");
3027 if (!strcmp (str, "create"))
3028 *req->function = Z_ExtendedServicesRequest_create;
3029 if (!strcmp (str, "delete"))
3030 *req->function = Z_ExtendedServicesRequest_delete;
3031 if (!strcmp (str, "modify"))
3032 *req->function = Z_ExtendedServicesRequest_modify;
3035 str = ZOOM_options_get(p->options, "waitAction");
3038 if (!strcmp (str, "wait"))
3039 *req->waitAction = Z_ExtendedServicesRequest_wait;
3040 if (!strcmp (str, "waitIfPossible"))
3041 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3042 if (!strcmp (str, "dontWait"))
3043 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3044 if (!strcmp (str, "dontReturnPackage"))
3045 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3050 static const char *ill_array_lookup(void *clientData, const char *idx)
3052 ZOOM_package p = (ZOOM_package) clientData;
3053 return ZOOM_options_get(p->options, idx+4);
3056 static Z_External *encode_ill_request(ZOOM_package p)
3058 ODR out = p->odr_out;
3061 struct ill_get_ctl ctl;
3063 ctl.odr = p->odr_out;
3065 ctl.f = ill_array_lookup;
3067 req = ill_get_ILLRequest(&ctl, "ill", 0);
3069 if (!ill_Request(out, &req, 0, 0))
3071 int ill_request_size;
3072 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3073 if (ill_request_buf)
3074 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3079 int illRequest_size = 0;
3080 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3082 r = (Z_External *) odr_malloc(out, sizeof(*r));
3083 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3084 r->indirect_reference = 0;
3086 r->which = Z_External_single;
3088 r->u.single_ASN1_type =
3089 odr_create_Odr_oct(out,
3090 (unsigned char *)illRequest_buf,
3096 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3098 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3102 req->which = Z_IOItemOrder_esRequest;
3103 req->u.esRequest = (Z_IORequest *)
3104 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3106 /* to keep part ... */
3107 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3108 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3109 req->u.esRequest->toKeep->supplDescription = 0;
3110 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3111 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3113 str = ZOOM_options_get(p->options, "contact-name");
3114 req->u.esRequest->toKeep->contact->name =
3115 odr_strdup_null(p->odr_out, str);
3117 str = ZOOM_options_get(p->options, "contact-phone");
3118 req->u.esRequest->toKeep->contact->phone =
3119 odr_strdup_null(p->odr_out, str);
3121 str = ZOOM_options_get(p->options, "contact-email");
3122 req->u.esRequest->toKeep->contact->email =
3123 odr_strdup_null(p->odr_out, str);
3125 req->u.esRequest->toKeep->addlBilling = 0;
3127 /* not to keep part ... */
3128 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3129 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3131 str = ZOOM_options_get(p->options, "itemorder-setname");
3136 req->u.esRequest->notToKeep->resultSetItem = 0;
3139 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3140 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3142 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3143 odr_strdup(p->odr_out, str);
3144 req->u.esRequest->notToKeep->resultSetItem->item =
3145 (int *) odr_malloc(p->odr_out, sizeof(int));
3147 str = ZOOM_options_get(p->options, "itemorder-item");
3148 *req->u.esRequest->notToKeep->resultSetItem->item =
3149 (str ? atoi(str) : 1);
3152 str = ZOOM_options_getl(p->options, "doc", &len);
3155 req->u.esRequest->notToKeep->itemRequest =
3156 z_ext_record_xml(p->odr_out, str, len);
3159 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3164 Z_APDU *create_admin_package(ZOOM_package p, int type,
3165 Z_ESAdminOriginPartToKeep **toKeepP,
3166 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3168 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3171 Z_ESAdminOriginPartToKeep *toKeep;
3172 Z_ESAdminOriginPartNotToKeep *notToKeep;
3173 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3174 const char *first_db = "Default";
3176 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3181 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3183 r->indirect_reference = 0;
3184 r->which = Z_External_ESAdmin;
3186 r->u.adminService = (Z_Admin *)
3187 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3188 r->u.adminService->which = Z_Admin_esRequest;
3189 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3190 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3192 toKeep = r->u.adminService->u.esRequest->toKeep =
3193 (Z_ESAdminOriginPartToKeep *)
3194 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3195 toKeep->which = type;
3196 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3197 toKeep->u.create = odr_nullval();
3198 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3200 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3201 (Z_ESAdminOriginPartNotToKeep *)
3202 odr_malloc(p->odr_out,
3203 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3204 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3205 notToKeep->u.recordsWillFollow = odr_nullval();
3209 *notToKeepP = notToKeep;
3214 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3216 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3217 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3218 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3220 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3228 req->taskSpecificParameters = ext;
3229 ext->direct_reference = req->packageType;
3230 ext->descriptor = 0;
3231 ext->indirect_reference = 0;
3233 ext->which = Z_External_octet;
3234 ext->u.single_ASN1_type =
3235 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3239 static Z_APDU *create_update_package(ZOOM_package p)
3242 const char *first_db = "Default";
3244 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3245 const char *action = ZOOM_options_get(p->options, "action");
3246 int recordIdOpaque_len;
3247 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3248 &recordIdOpaque_len);
3249 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3251 const char *record_buf = ZOOM_options_getl(p->options, "record",
3253 int recordOpaque_len;
3254 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3256 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3257 const char *version = ZOOM_options_get(p->options, "updateVersion");
3259 const char *correlationInfo_note =
3260 ZOOM_options_get(p->options, "correlationInfo.note");
3261 const char *correlationInfo_id =
3262 ZOOM_options_get(p->options, "correlationInfo.id");
3264 Odr_oid *syntax_oid = 0;
3265 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3271 if (!record_buf && !recordOpaque_buf)
3273 record_buf = "void";
3275 syntax_str = "SUTRS";
3280 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3281 CLASS_RECSYN, syntax_str,
3293 package_oid = yaz_oid_extserv_database_update_first_version;
3294 /* old update does not support specialUpdate */
3296 action = "recordInsert";
3300 action = "specialUpdate";
3301 package_oid = yaz_oid_extserv_database_update_second_version;
3305 action = "specialUpdate";
3306 package_oid = yaz_oid_extserv_database_update;
3312 if (!strcmp(action, "recordInsert"))
3313 action_no = Z_IUOriginPartToKeep_recordInsert;
3314 else if (!strcmp(action, "recordReplace"))
3315 action_no = Z_IUOriginPartToKeep_recordReplace;
3316 else if (!strcmp(action, "recordDelete"))
3317 action_no = Z_IUOriginPartToKeep_recordDelete;
3318 else if (!strcmp(action, "elementUpdate"))
3319 action_no = Z_IUOriginPartToKeep_elementUpdate;
3320 else if (!strcmp(action, "specialUpdate"))
3321 action_no = Z_IUOriginPartToKeep_specialUpdate;
3325 apdu = create_es_package(p, package_oid);
3328 Z_IUOriginPartToKeep *toKeep;
3329 Z_IUSuppliedRecords *notToKeep;
3330 Z_External *r = (Z_External *)
3331 odr_malloc(p->odr_out, sizeof(*r));
3332 const char *elementSetName =
3333 ZOOM_options_get(p->options, "elementSetName");
3335 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3337 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3339 r->which = Z_External_update;
3340 r->indirect_reference = 0;
3341 r->u.update = (Z_IUUpdate *)
3342 odr_malloc(p->odr_out, sizeof(*r->u.update));
3344 r->u.update->which = Z_IUUpdate_esRequest;
3345 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3346 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3347 toKeep = r->u.update->u.esRequest->toKeep =
3348 (Z_IUOriginPartToKeep *)
3349 odr_malloc(p->odr_out, sizeof(*toKeep));
3351 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3354 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3356 toKeep->actionQualifier = 0;
3357 toKeep->action = odr_intdup(p->odr_out, action_no);
3359 notToKeep = r->u.update->u.esRequest->notToKeep =
3360 (Z_IUSuppliedRecords *)
3361 odr_malloc(p->odr_out, sizeof(*notToKeep));
3363 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3364 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3365 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3366 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3367 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3370 notToKeep->elements[0]->u.opaque =
3371 odr_create_Odr_oct(p->odr_out,
3372 (const unsigned char *) recordIdOpaque,
3373 recordIdOpaque_len);
3375 else if (recordIdNumber)
3377 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3379 notToKeep->elements[0]->u.number =
3380 odr_intdup(p->odr_out, atoi(recordIdNumber));
3383 notToKeep->elements[0]->u.opaque = 0;
3384 notToKeep->elements[0]->supplementalId = 0;
3385 if (correlationInfo_note || correlationInfo_id)
3387 Z_IUCorrelationInfo *ci;
3388 ci = notToKeep->elements[0]->correlationInfo =
3389 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3390 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3391 ci->id = correlationInfo_id ?
3392 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3395 notToKeep->elements[0]->correlationInfo = 0;
3396 if (recordOpaque_buf)
3398 notToKeep->elements[0]->record =
3399 z_ext_record_oid_any(p->odr_out, syntax_oid,
3400 recordOpaque_buf, recordOpaque_len);
3404 notToKeep->elements[0]->record =
3405 z_ext_record_oid(p->odr_out, syntax_oid,
3406 record_buf, record_len);
3411 ODR print = odr_createmem(ODR_PRINT);
3413 z_APDU(print, &apdu, 0, 0);
3420 ZOOM_package_send(ZOOM_package p, const char *type)
3427 odr_reset(p->odr_out);
3430 if (!strcmp(type, "itemorder"))
3432 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3435 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3437 r->direct_reference =
3438 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3440 r->which = Z_External_itemOrder;
3441 r->indirect_reference = 0;
3442 r->u.itemOrder = encode_item_order(p);
3444 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3447 else if (!strcmp(type, "create")) /* create database */
3449 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3452 else if (!strcmp(type, "drop")) /* drop database */
3454 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3457 else if (!strcmp(type, "commit")) /* commit changes */
3459 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3462 else if (!strcmp(type, "update")) /* update record(s) */
3464 apdu = create_update_package(p);
3466 else if (!strcmp(type, "xmlupdate"))
3468 apdu = create_xmlupdate_package(p);
3472 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3476 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3477 task->u.package = p;
3478 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3479 p->buf_out = (char *) xmalloc(p->len_out);
3480 memcpy(p->buf_out, buf, p->len_out);
3485 while (ZOOM_event(1, &c))
3492 ZOOM_API(ZOOM_package)
3493 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3495 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3498 p->odr_out = odr_createmem(ODR_ENCODE);
3499 p->options = ZOOM_options_create_with_parent2(options, c->options);
3507 ZOOM_package_destroy(ZOOM_package p)
3512 if (p->refcount == 0)
3514 odr_destroy(p->odr_out);
3517 ZOOM_options_destroy(p->options);
3522 ZOOM_API(const char *)
3523 ZOOM_package_option_get(ZOOM_package p, const char *key)
3525 return ZOOM_options_get(p->options, key);
3528 ZOOM_API(const char *)
3529 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3531 return ZOOM_options_getl(p->options, key, lenp);
3535 ZOOM_package_option_set(ZOOM_package p, const char *key,
3538 ZOOM_options_set(p->options, key, val);
3542 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3543 const char *val, int len)
3545 ZOOM_options_setl(p->options, key, val, len);
3548 static int ZOOM_connection_exec_task(ZOOM_connection c)
3550 ZOOM_task task = c->tasks;
3551 zoom_ret ret = zoom_complete;
3555 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3556 c, task->which, task->running);
3557 if (c->error != ZOOM_ERROR_NONE)
3559 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3560 "removing tasks because of error = %d", c, c->error);
3561 ZOOM_connection_remove_tasks(c);
3566 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3567 "task already running", c);
3571 ret = zoom_complete;
3572 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3574 switch (task->which)
3576 case ZOOM_TASK_SEARCH:
3577 if (c->proto == PROTO_HTTP)
3578 ret = ZOOM_connection_srw_send_search(c);
3580 ret = ZOOM_connection_send_search(c);
3582 case ZOOM_TASK_RETRIEVE:
3583 if (c->proto == PROTO_HTTP)
3584 ret = ZOOM_connection_srw_send_search(c);
3586 ret = send_present(c);
3588 case ZOOM_TASK_CONNECT:
3589 ret = do_connect(c);
3591 case ZOOM_TASK_SCAN:
3592 if (c->proto == PROTO_HTTP)
3593 ret = ZOOM_connection_srw_send_scan(c);
3595 ret = ZOOM_connection_send_scan(c);
3597 case ZOOM_TASK_PACKAGE:
3598 ret = send_package(c);
3600 case ZOOM_TASK_SORT:
3601 c->tasks->u.sort.resultset->r_sort_spec =
3602 c->tasks->u.sort.q->sort_spec;
3603 ret = send_sort(c, c->tasks->u.sort.resultset);
3609 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3610 "remove tasks because no connection exist", c);
3611 ZOOM_connection_remove_tasks(c);
3613 if (ret == zoom_complete)
3615 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3616 "task removed (complete)", c);
3617 ZOOM_connection_remove_task(c);
3620 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3625 static zoom_ret send_sort_present(ZOOM_connection c)
3627 zoom_ret r = zoom_complete;
3629 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3630 r = send_sort(c, c->tasks->u.search.resultset);
3631 if (r == zoom_complete)
3632 r = send_present(c);
3636 static int es_response_taskpackage_update(ZOOM_connection c,
3637 Z_IUUpdateTaskPackage *utp)
3639 if (utp && utp->targetPart)
3641 Z_IUTargetPart *targetPart = utp->targetPart;
3642 switch ( *targetPart->updateStatus ) {
3643 case Z_IUTargetPart_success:
3644 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3646 case Z_IUTargetPart_partial:
3647 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3649 case Z_IUTargetPart_failure:
3650 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3651 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3652 response_diag(c, targetPart->globalDiagnostics[0]);
3655 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3660 static int es_response_taskpackage(ZOOM_connection c,
3661 Z_TaskPackage *taskPackage)
3664 Odr_oct *id = taskPackage->targetReference;
3666 ZOOM_options_setl(c->tasks->u.package->options,
3667 "targetReference", (char*) id->buf, id->len);
3670 switch ( *taskPackage->taskStatus ) {
3671 case Z_TaskPackage_pending:
3672 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3674 case Z_TaskPackage_active:
3675 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3677 case Z_TaskPackage_complete:
3678 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3680 case Z_TaskPackage_aborted:
3681 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3682 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3683 response_diag(c, taskPackage->packageDiagnostics[0]);
3687 // taskSpecificParameters
3688 // NOTE: Only Update implemented, no others.
3689 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3690 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3691 es_response_taskpackage_update(c, utp);
3697 static int es_response(ZOOM_connection c,
3698 Z_ExtendedServicesResponse *res)
3700 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3702 switch (*res->operationStatus) {
3703 case Z_ExtendedServicesResponse_done:
3704 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3706 case Z_ExtendedServicesResponse_accepted:
3707 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3709 case Z_ExtendedServicesResponse_failure:
3710 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3711 if (res->diagnostics && res->num_diagnostics > 0)
3712 response_diag(c, res->diagnostics[0]);
3715 if (res->taskPackage &&
3716 res->taskPackage->which == Z_External_extendedService)
3718 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3719 es_response_taskpackage(c, taskPackage);
3721 if (res->taskPackage &&
3722 res->taskPackage->which == Z_External_octet)
3724 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3725 ZOOM_options_setl(c->tasks->u.package->options,
3726 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3731 static void interpret_init_diag(ZOOM_connection c,
3732 Z_DiagnosticFormat *diag)
3736 Z_DiagnosticFormat_s *ds = diag->elements[0];
3737 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3738 response_default_diag(c, ds->u.defaultDiagRec);
3743 static void interpret_otherinformation_field(ZOOM_connection c,
3744 Z_OtherInformation *ui)
3747 for (i = 0; i < ui->num_elements; i++)
3749 Z_OtherInformationUnit *unit = ui->list[i];
3750 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3751 unit->information.externallyDefinedInfo &&
3752 unit->information.externallyDefinedInfo->which ==
3755 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3761 static void set_init_option(const char *name, void *clientData) {
3762 ZOOM_connection c = (ZOOM_connection) clientData;
3765 sprintf(buf, "init_opt_%.70s", name);
3766 ZOOM_connection_option_set(c, buf, "1");
3770 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3772 Z_InitResponse *initrs;
3774 ZOOM_connection_set_mask(c, 0);
3775 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3778 case Z_APDU_initResponse:
3779 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3780 initrs = apdu->u.initResponse;
3781 ZOOM_connection_option_set(c, "serverImplementationId",
3782 initrs->implementationId ?
3783 initrs->implementationId : "");
3784 ZOOM_connection_option_set(c, "serverImplementationName",
3785 initrs->implementationName ?
3786 initrs->implementationName : "");
3787 ZOOM_connection_option_set(c, "serverImplementationVersion",
3788 initrs->implementationVersion ?
3789 initrs->implementationVersion : "");
3790 /* Set the three old options too, for old applications */
3791 ZOOM_connection_option_set(c, "targetImplementationId",
3792 initrs->implementationId ?
3793 initrs->implementationId : "");
3794 ZOOM_connection_option_set(c, "targetImplementationName",
3795 initrs->implementationName ?
3796 initrs->implementationName : "");
3797 ZOOM_connection_option_set(c, "targetImplementationVersion",
3798 initrs->implementationVersion ?
3799 initrs->implementationVersion : "");
3801 /* Make initrs->options available as ZOOM-level options */
3802 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3804 if (!*initrs->result)
3806 Z_External *uif = initrs->userInformationField;
3808 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3810 if (uif && uif->which == Z_External_userInfo1)
3811 interpret_otherinformation_field(c, uif->u.userInfo1);
3816 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3817 yaz_oid_userinfo_cookie, 1, 0);
3818 xfree(c->cookie_in);
3821 c->cookie_in = xstrdup(cookie);
3822 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3823 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3824 c->support_named_resultsets = 1;
3827 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3828 ZOOM_connection_remove_task(c);
3830 ZOOM_connection_exec_task(c);
3832 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3834 NMEM tmpmem = nmem_create();
3835 Z_CharSetandLanguageNegotiation *p =
3836 yaz_get_charneg_record(initrs->otherInfo);
3840 char *charset = NULL, *lang = NULL;
3843 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3844 yaz_log(log_details, "%p recv_apdu target accepted: "
3845 "charset %s, language %s, select %d",
3847 charset ? charset : "none", lang ? lang : "none", sel);
3849 ZOOM_connection_option_set(c, "negotiation-charset",
3852 ZOOM_connection_option_set(c, "negotiation-lang",
3855 ZOOM_connection_option_set(
3856 c, "negotiation-charset-in-effect-for-records",
3857 (sel != 0) ? "1" : "0");
3858 nmem_destroy(tmpmem);
3862 case Z_APDU_searchResponse:
3863 yaz_log(log_api, "%p recv_apdu Search response", c);
3864 handle_search_response(c, apdu->u.searchResponse);
3865 if (send_sort_present(c) == zoom_complete)
3866 ZOOM_connection_remove_task(c);
3868 case Z_APDU_presentResponse:
3869 yaz_log(log_api, "%p recv_apdu Present response", c);
3870 handle_present_response(c, apdu->u.presentResponse);
3871 if (send_present(c) == zoom_complete)
3872 ZOOM_connection_remove_task(c);
3874 case Z_APDU_sortResponse:
3875 yaz_log(log_api, "%p recv_apdu Sort response", c);
3876 sort_response(c, apdu->u.sortResponse);
3877 if (send_present(c) == zoom_complete)
3878 ZOOM_connection_remove_task(c);
3880 case Z_APDU_scanResponse:
3881 yaz_log(log_api, "%p recv_apdu Scan response", c);
3882 scan_response(c, apdu->u.scanResponse);
3883 ZOOM_connection_remove_task(c);
3885 case Z_APDU_extendedServicesResponse:
3886 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3887 es_response(c, apdu->u.extendedServicesResponse);
3888 ZOOM_connection_remove_task(c);
3891 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3892 if (!ZOOM_test_reconnect(c))
3894 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3899 yaz_log(log_api, "%p Received unknown PDU", c);
3900 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3906 static zoom_ret handle_srw_response(ZOOM_connection c,
3907 Z_SRW_searchRetrieveResponse *res)
3909 ZOOM_resultset resultset = 0;
3914 const char *syntax, *elementSetName;
3917 return zoom_complete;
3919 switch(c->tasks->which)
3921 case ZOOM_TASK_SEARCH:
3922 resultset = c->tasks->u.search.resultset;
3923 start = &c->tasks->u.search.start;
3924 count = &c->tasks->u.search.count;
3925 syntax = c->tasks->u.search.syntax;
3926 elementSetName = c->tasks->u.search.elementSetName;
3928 if (!c->tasks->u.search.recv_search_fired)
3930 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3931 ZOOM_connection_put_event(c, event);
3932 c->tasks->u.search.recv_search_fired = 1;
3935 case ZOOM_TASK_RETRIEVE:
3936 resultset = c->tasks->u.retrieve.resultset;
3937 start = &c->tasks->u.retrieve.start;
3938 count = &c->tasks->u.retrieve.count;
3939 syntax = c->tasks->u.retrieve.syntax;
3940 elementSetName = c->tasks->u.retrieve.elementSetName;
3943 return zoom_complete;
3946 resultset->size = 0;
3948 if (res->resultSetId)
3949 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3951 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3953 if (res->num_diagnostics > 0)
3955 set_SRU_error(c, &res->diagnostics[0]);
3959 if (res->numberOfRecords)
3960 resultset->size = *res->numberOfRecords;
3961 for (i = 0; i<res->num_records; i++)
3964 Z_SRW_record *sru_rec;
3965 Z_SRW_diagnostic *diag = 0;
3968 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3969 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3971 if (res->records[i].recordPosition &&
3972 *res->records[i].recordPosition > 0)
3973 pos = *res->records[i].recordPosition - 1;
3977 sru_rec = &res->records[i];
3979 npr->databaseName = 0;
3980 npr->which = Z_NamePlusRecord_databaseRecord;
3981 npr->u.databaseRecord = (Z_External *)
3982 odr_malloc(c->odr_in, sizeof(Z_External));
3983 npr->u.databaseRecord->descriptor = 0;
3984 npr->u.databaseRecord->direct_reference =
3985 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3986 npr->u.databaseRecord->which = Z_External_octet;
3988 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3989 odr_malloc(c->odr_in, sizeof(Odr_oct));
3990 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3991 sru_rec->recordData_buf;
3992 npr->u.databaseRecord->u.octet_aligned->len =
3993 npr->u.databaseRecord->u.octet_aligned->size =
3994 sru_rec->recordData_len;
3996 if (sru_rec->recordSchema
3997 && !strcmp(sru_rec->recordSchema,
3998 "info:srw/schema/1/diagnostics-v1.1"))
4000 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4001 sru_rec->recordData_len,
4005 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4006 sru_rec->recordSchema, diag);
4010 if (*count + *start > resultset->size)
4011 *count = resultset->size - *start;
4015 nmem = odr_extract_mem(c->odr_in);
4016 nmem_transfer(odr_getmem(resultset->odr), nmem);
4020 return ZOOM_connection_srw_send_search(c);
4022 return zoom_complete;
4027 static void handle_srw_scan_response(ZOOM_connection c,
4028 Z_SRW_scanResponse *res)
4030 NMEM nmem = odr_extract_mem(c->odr_in);
4033 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4035 scan = c->tasks->u.scan.scan;
4037 if (res->num_diagnostics > 0)
4038 set_SRU_error(c, &res->diagnostics[0]);
4040 scan->scan_response = 0;
4041 scan->srw_scan_response = res;
4042 nmem_transfer(odr_getmem(scan->odr), nmem);
4044 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4050 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4052 zoom_ret cret = zoom_complete;
4054 const char *addinfo = 0;
4055 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4057 ZOOM_connection_set_mask(c, 0);
4058 yaz_log(log_details, "%p handle_http", c);
4060 if (!yaz_srw_check_content_type(hres))
4061 addinfo = "content-type";
4064 Z_SOAP *soap_package = 0;
4066 Z_SOAP_Handler soap_handlers[2] = {
4067 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4070 ret = z_soap_codec(o, &soap_package,
4071 &hres->content_buf, &hres->content_len,
4073 if (!ret && soap_package->which == Z_SOAP_generic &&
4074 soap_package->u.generic->no == 0)
4076 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4078 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4079 if (sr->which == Z_SRW_searchRetrieve_response)
4080 cret = handle_srw_response(c, sr->u.response);
4081 else if (sr->which == Z_SRW_scan_response)
4082 handle_srw_scan_response(c, sr->u.scan_response);
4086 else if (!ret && (soap_package->which == Z_SOAP_fault
4087 || soap_package->which == Z_SOAP_error))
4089 set_HTTP_error(c, hres->code,
4090 soap_package->u.fault->fault_code,
4091 soap_package->u.fault->fault_string);
4098 if (hres->code != 200)
4099 set_HTTP_error(c, hres->code, 0, 0);
4101 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4104 if (cret == zoom_complete)
4105 ZOOM_connection_remove_task(c);
4106 if (!strcmp(hres->version, "1.0"))
4108 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4109 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4114 /* HTTP 1.1: only if no close we stay alive .. */
4115 if (connection_head && !strcmp(connection_head, "close"))
4121 static int do_read(ZOOM_connection c)
4126 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4127 ZOOM_connection_put_event(c, event);
4129 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4130 more = cs_more(c->cs);
4131 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4136 if (!ZOOM_test_reconnect(c))
4138 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4147 odr_reset(c->odr_in);
4148 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4149 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4150 ZOOM_connection_put_event(c, event);
4152 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4155 int err = odr_geterrorx(c->odr_in, &x);
4157 const char *element = odr_getelement(c->odr_in);
4158 yaz_snprintf(msg, sizeof(msg),
4159 "ODR code %d:%d element=%s offset=%d",
4160 err, x, element ? element : "<unknown>",
4161 odr_offset(c->odr_in));
4162 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4165 FILE *ber_file = yaz_log_file();
4167 odr_dumpBER(ber_file, c->buf_in, r);
4174 z_GDU(c->odr_print, &gdu, 0, 0);
4175 if (gdu->which == Z_GDU_Z3950)
4176 recv_apdu(c, gdu->u.z3950);
4177 else if (gdu->which == Z_GDU_HTTP_Response)
4180 handle_http(c, gdu->u.HTTP_Response);
4182 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4187 c->reconnect_ok = 0;
4192 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4197 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4198 ZOOM_connection_put_event(c, event);
4200 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4201 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4203 yaz_log(log_details, "%p do_write_ex write failed", c);
4204 if (ZOOM_test_reconnect(c))
4206 return zoom_pending;
4208 if (c->state == STATE_CONNECTING)
4209 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4211 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4213 return zoom_complete;
4217 int mask = ZOOM_SELECT_EXCEPT;
4218 if (c->cs->io_pending & CS_WANT_WRITE)
4219 mask += ZOOM_SELECT_WRITE;
4220 if (c->cs->io_pending & CS_WANT_READ)
4221 mask += ZOOM_SELECT_READ;
4222 ZOOM_connection_set_mask(c, mask);
4223 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4228 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4229 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4232 return zoom_pending;
4235 static zoom_ret do_write(ZOOM_connection c)
4237 return do_write_ex(c, c->buf_out, c->len_out);
4241 ZOOM_API(const char *)
4242 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4244 return ZOOM_options_get(c->options, key);
4247 ZOOM_API(const char *)
4248 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4250 return ZOOM_options_getl(c->options, key, lenp);
4254 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4257 ZOOM_options_set(c->options, key, val);
4261 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4262 const char *val, int len)
4264 ZOOM_options_setl(c->options, key, val, len);
4267 ZOOM_API(const char *)
4268 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4270 return ZOOM_options_get(r->options, key);
4274 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4277 ZOOM_options_set(r->options, key, val);
4282 ZOOM_connection_errcode(ZOOM_connection c)
4284 return ZOOM_connection_error(c, 0, 0);
4287 ZOOM_API(const char *)
4288 ZOOM_connection_errmsg(ZOOM_connection c)
4291 ZOOM_connection_error(c, &msg, 0);
4295 ZOOM_API(const char *)
4296 ZOOM_connection_addinfo(ZOOM_connection c)
4298 const char *addinfo;
4299 ZOOM_connection_error(c, 0, &addinfo);
4303 ZOOM_API(const char *)
4304 ZOOM_connection_diagset(ZOOM_connection c)
4306 const char *diagset;
4307 ZOOM_connection_error_x(c, 0, 0, &diagset);
4311 ZOOM_API(const char *)
4312 ZOOM_diag_str(int error)
4316 case ZOOM_ERROR_NONE:
4318 case ZOOM_ERROR_CONNECT:
4319 return "Connect failed";
4320 case ZOOM_ERROR_MEMORY:
4321 return "Out of memory";
4322 case ZOOM_ERROR_ENCODE:
4323 return "Encoding failed";
4324 case ZOOM_ERROR_DECODE:
4325 return "Decoding failed";
4326 case ZOOM_ERROR_CONNECTION_LOST:
4327 return "Connection lost";
4328 case ZOOM_ERROR_INIT:
4329 return "Init rejected";
4330 case ZOOM_ERROR_INTERNAL:
4331 return "Internal failure";
4332 case ZOOM_ERROR_TIMEOUT:
4334 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4335 return "Unsupported protocol";
4336 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4337 return "Unsupported query type";
4338 case ZOOM_ERROR_INVALID_QUERY:
4339 return "Invalid query";
4340 case ZOOM_ERROR_CQL_PARSE:
4341 return "CQL parsing error";
4342 case ZOOM_ERROR_CQL_TRANSFORM:
4343 return "CQL transformation error";
4344 case ZOOM_ERROR_CCL_CONFIG:
4345 return "CCL configuration error";
4346 case ZOOM_ERROR_CCL_PARSE:
4347 return "CCL parsing error";
4349 return diagbib1_str(error);
4354 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4355 const char **addinfo, const char **diagset)
4357 int error = c->error;
4360 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4361 *cp = ZOOM_diag_str(error);
4362 else if (!strcmp(c->diagset, "HTTP"))
4363 *cp = z_HTTP_errmsg(c->error);
4364 else if (!strcmp(c->diagset, "Bib-1"))
4365 *cp = ZOOM_diag_str(error);
4366 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4367 *cp = yaz_diag_srw_str(c->error);
4369 *cp = "Unknown error and diagnostic set";
4372 *addinfo = c->addinfo ? c->addinfo : "";
4374 *diagset = c->diagset ? c->diagset : "";
4379 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4380 const char **addinfo)
4382 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4385 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4387 ZOOM_Event event = 0;
4388 int r = cs_look(c->cs);
4389 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4394 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4395 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4397 ZOOM_connection_put_event(c, event);
4399 else if (r == CS_CONNECT)
4401 int ret = ret = cs_rcvconnect(c->cs);
4402 yaz_log(log_details, "%p ZOOM_connection_do_io "
4403 "cs_rcvconnect returned %d", c, ret);
4406 int mask = ZOOM_SELECT_EXCEPT;
4407 if (c->cs->io_pending & CS_WANT_WRITE)
4408 mask += ZOOM_SELECT_WRITE;
4409 if (c->cs->io_pending & CS_WANT_READ)
4410 mask += ZOOM_SELECT_READ;
4411 ZOOM_connection_set_mask(c, mask);
4412 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4413 ZOOM_connection_put_event(c, event);
4417 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4418 ZOOM_connection_put_event(c, event);
4420 if (c->proto == PROTO_Z3950)
4421 ZOOM_connection_send_init(c);
4424 /* no init request for SRW .. */
4425 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4426 ZOOM_connection_remove_task(c);
4427 ZOOM_connection_set_mask(c, 0);
4428 ZOOM_connection_exec_task(c);
4430 c->state = STATE_ESTABLISHED;
4434 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4440 if (mask & ZOOM_SELECT_EXCEPT)
4442 if (!ZOOM_test_reconnect(c))
4444 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4449 if (mask & ZOOM_SELECT_READ)
4451 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4457 ZOOM_connection_last_event(ZOOM_connection cs)
4460 return ZOOM_EVENT_NONE;
4461 return cs->last_event;
4465 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4467 WRBUF wrbuf = (WRBUF) client_data;
4468 wrbuf_puts(wrbuf, buf);
4472 * Returns an xmalloc()d string containing RPN that corresponds to the
4473 * CQL passed in. On error, sets the Connection object's error state
4474 * and returns a null pointer.
4475 * ### We could cache CQL parser and/or transformer in Connection.
4477 static char *cql2pqf(ZOOM_connection c, const char *cql)
4481 const char *cqlfile;
4482 cql_transform_t trans;
4485 parser = cql_parser_create();
4486 if ((error = cql_parser_string(parser, cql)) != 0) {
4487 cql_parser_destroy(parser);
4488 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4492 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4495 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4497 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4500 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4501 cqlfile, strerror(errno));
4502 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4506 WRBUF wrbuf_result = wrbuf_alloc();
4507 error = cql_transform(trans, cql_parser_result(parser),
4508 cql2pqf_wrbuf_puts, wrbuf_result);
4511 const char *addinfo;
4512 error = cql_transform_error(trans, &addinfo);
4513 sprintf(buf, "%.200s (addinfo=%.200s)",
4514 cql_strerror(error), addinfo);
4515 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4519 result = xstrdup(wrbuf_cstr(wrbuf_result));
4521 cql_transform_close(trans);
4522 wrbuf_destroy(wrbuf_result);
4524 cql_parser_destroy(parser);
4528 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4532 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4533 /* timeout and this connection was waiting */
4534 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4536 ZOOM_connection_put_event(c, event);
4542 ZOOM_connection_process(ZOOM_connection c)
4548 event = ZOOM_connection_get_event(c);
4551 ZOOM_Event_destroy(event);
4554 ZOOM_connection_exec_task(c);
4555 event = ZOOM_connection_get_event(c);
4558 ZOOM_Event_destroy(event);
4565 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4569 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4571 for (i = 0; i<no; i++)
4573 ZOOM_connection c = cs[i];
4575 if (c && ZOOM_connection_process(c))
4581 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4583 if (c->mask && mask)
4584 ZOOM_connection_do_io(c, mask);
4588 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4591 return cs_fileno(c->cs);
4595 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4603 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4610 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4612 return ZOOM_options_get_int(c->options, "timeout", 30);
4618 * c-file-style: "Stroustrup"
4619 * indent-tabs-mode: nil
4621 * vim: shiftwidth=4 tabstop=8 expandtab