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);
412 c->support_named_resultsets = 0;
413 c->last_event = ZOOM_EVENT_NONE;
415 c->m_queue_front = 0;
423 /* set database names. Take local databases (if set); otherwise
424 take databases given in ZURL (if set); otherwise use Default */
425 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
428 char **databaseNames;
429 const char *cp = ZOOM_options_get(options, "databaseName");
431 if ((!cp || !*cp) && con->host_port)
433 if (strncmp(con->host_port, "unix:", 5) == 0)
434 cp = strchr(con->host_port+5, ':');
436 cp = strchr(con->host_port, '/');
442 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
443 return databaseNames;
446 ZOOM_API(ZOOM_connection)
447 ZOOM_connection_new(const char *host, int portnum)
449 ZOOM_connection c = ZOOM_connection_create(0);
451 ZOOM_connection_connect(c, host, portnum);
455 static zoom_sru_mode get_sru_mode_from_string(const char *s)
458 return zoom_sru_soap;
459 if (!yaz_matchstr(s, "soap"))
460 return zoom_sru_soap;
461 else if (!yaz_matchstr(s, "get"))
463 else if (!yaz_matchstr(s, "post"))
464 return zoom_sru_post;
465 return zoom_sru_error;
469 ZOOM_connection_connect(ZOOM_connection c,
470 const char *host, int portnum)
477 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
478 c, host ? host : "null", portnum);
480 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
481 ZOOM_connection_remove_tasks(c);
485 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
486 odr_destroy(c->odr_print);
488 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
490 c->odr_print = odr_createmem(ODR_PRINT);
491 odr_setprint(c->odr_print, yaz_log_file());
498 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
502 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
505 val = ZOOM_options_get(c->options, "proxy");
508 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
509 c->proxy = xstrdup(val);
514 val = ZOOM_options_get(c->options, "charset");
517 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
518 c->charset = xstrdup(val);
522 val = ZOOM_options_get(c->options, "lang");
525 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
526 c->lang = xstrdup(val);
537 sprintf(hostn, "%.80s:%d", host, portnum);
538 c->host_port = xstrdup(hostn);
541 c->host_port = xstrdup(host);
546 * If the "<scheme>:" part of the host string is preceded by one
547 * or more comma-separated <name>=<value> pairs, these are taken
548 * to be options to be set on the connection object. Among other
549 * applications, this facility can be used to embed authentication
551 * user=admin,password=secret,tcp:localhost:9999
553 char *remainder = c->host_port;
554 char *pcolon = strchr(remainder, ':');
557 while ((pcomma = strchr(remainder, ',')) != 0 &&
558 (pcolon == 0 || pcomma < pcolon)) {
560 if ((pequals = strchr(remainder, '=')) != 0) {
562 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
563 ZOOM_connection_option_set(c, remainder, pequals+1);
565 remainder = pcomma+1;
568 if (remainder != c->host_port) {
570 c->host_port = xstrdup(remainder);
571 /*printf("# reset hp='%s'\n", remainder);*/
575 val = ZOOM_options_get(c->options, "sru");
576 c->sru_mode = get_sru_mode_from_string(val);
578 xfree(c->sru_version);
579 val = ZOOM_options_get(c->options, "sru_version");
580 c->sru_version = xstrdup(val ? val : "1.2");
582 ZOOM_options_set(c->options, "host", c->host_port);
584 xfree(c->cookie_out);
586 val = ZOOM_options_get(c->options, "cookie");
589 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
590 c->cookie_out = xstrdup(val);
595 val = ZOOM_options_get(c->options, "clientIP");
598 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
600 c->client_IP = xstrdup(val);
605 val = ZOOM_options_get(c->options, "group");
607 c->group = xstrdup(val);
611 val = ZOOM_options_get(c->options, "user");
613 c->user = xstrdup(val);
617 val = ZOOM_options_get(c->options, "password");
619 val = ZOOM_options_get(c->options, "pass");
622 c->password = xstrdup(val);
624 c->maximum_record_size =
625 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
626 c->preferred_message_size =
627 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
629 c->async = ZOOM_options_get_bool(c->options, "async", 0);
630 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
632 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
636 while (ZOOM_event(1, &c))
642 ZOOM_query_create(void)
644 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
646 yaz_log(log_details, "%p ZOOM_query_create", s);
650 s->odr = odr_createmem(ODR_ENCODE);
657 ZOOM_query_destroy(ZOOM_query s)
663 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
664 if (s->refcount == 0)
672 ZOOM_query_prefix(ZOOM_query s, const char *str)
674 s->query_string = odr_strdup(s->odr, str);
675 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
676 s->z_query->which = Z_Query_type_1;
677 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
678 if (!s->z_query->u.type_1)
680 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
684 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
689 ZOOM_query_cql(ZOOM_query s, const char *str)
693 s->query_string = odr_strdup(s->odr, str);
695 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
696 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
697 ext->indirect_reference = 0;
699 ext->which = Z_External_CQL;
700 ext->u.cql = s->query_string;
702 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
703 s->z_query->which = Z_Query_type_104;
704 s->z_query->u.type_104 = ext;
706 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
712 * Translate the CQL string client-side into RPN which is passed to
713 * the server. This is useful for server's that don't themselves
714 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
715 * only as a place to stash diagnostics if compilation fails; if this
716 * information is not needed, a null pointer may be used.
719 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
723 ZOOM_connection freeme = 0;
725 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
727 conn = freeme = ZOOM_connection_create(0);
729 rpn = cql2pqf(conn, str);
731 ZOOM_connection_destroy(freeme);
735 ret = ZOOM_query_prefix(s, rpn);
741 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
742 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
743 * to the server, as the YAZ GFS doesn't know how to handle this.
746 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
747 int *ccl_error, const char **error_string,
751 struct ccl_rpn_node *rpn;
752 CCL_bibset bibset = ccl_qual_mk();
755 ccl_qual_buf(bibset, config);
757 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
760 *error_string = ccl_err_msg(*ccl_error);
765 WRBUF wr = wrbuf_alloc();
768 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
771 ccl_qual_rm(&bibset);
776 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
778 s->sort_spec = yaz_sort_spec(s->odr, criteria);
781 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
785 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
789 static zoom_ret do_write(ZOOM_connection c);
792 ZOOM_connection_destroy(ZOOM_connection c)
797 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
800 for (r = c->resultsets; r; r = r->next)
806 odr_destroy(c->odr_in);
807 odr_destroy(c->odr_out);
810 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
811 odr_destroy(c->odr_print);
813 ZOOM_options_destroy(c->options);
814 ZOOM_connection_remove_tasks(c);
815 ZOOM_connection_remove_events(c);
821 xfree(c->cookie_out);
827 xfree(c->sru_version);
831 void ZOOM_resultset_addref(ZOOM_resultset r)
836 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
841 ZOOM_resultset ZOOM_resultset_create(void)
844 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
848 yaz_log(log_details, "%p ZOOM_resultset_create", r);
851 r->odr = odr_createmem(ODR_ENCODE);
856 for (i = 0; i<RECORD_HASH_SIZE; i++)
857 r->record_hash[i] = 0;
862 r->databaseNames = 0;
863 r->num_databaseNames = 0;
867 ZOOM_API(ZOOM_resultset)
868 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
871 ZOOM_query s = ZOOM_query_create();
873 ZOOM_query_prefix(s, q);
875 r = ZOOM_connection_search(c, s);
876 ZOOM_query_destroy(s);
880 ZOOM_API(ZOOM_resultset)
881 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
883 ZOOM_resultset r = ZOOM_resultset_create();
887 const char *syntax, *elementSetName;
889 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
890 r->r_sort_spec = q->sort_spec;
893 r->options = ZOOM_options_create_with_parent(c->options);
895 start = ZOOM_options_get_int(r->options, "start", 0);
896 count = ZOOM_options_get_int(r->options, "count", 0);
898 /* If "presentChunk" is defined use that; otherwise "step" */
899 const char *cp = ZOOM_options_get(r->options, "presentChunk");
900 r->step = ZOOM_options_get_int(r->options,
901 (cp != 0 ? "presentChunk": "step"), 0);
903 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
904 cp = ZOOM_options_get(r->options, "setname");
906 r->setname = xstrdup(cp);
907 cp = ZOOM_options_get(r->options, "schema");
909 r->schema = xstrdup(cp);
911 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
916 r->next = c->resultsets;
921 if (c->host_port && c->proto == PROTO_HTTP)
925 yaz_log(log_details, "ZOOM_connection_search: no comstack");
926 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
930 yaz_log(log_details, "ZOOM_connection_search: reconnect");
935 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
936 task->u.search.resultset = r;
937 task->u.search.start = start;
938 task->u.search.count = count;
939 task->u.search.recv_search_fired = 0;
941 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
942 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
943 elementSetName = ZOOM_options_get(r->options, "elementSetName");
944 task->u.search.elementSetName = elementSetName
945 ? xstrdup(elementSetName) : 0;
947 ZOOM_resultset_addref(r);
953 while (ZOOM_event(1, &c))
960 ZOOM_resultset_sort(ZOOM_resultset r,
961 const char *sort_type, const char *sort_spec)
963 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
967 ZOOM_resultset_sort1(ZOOM_resultset r,
968 const char *sort_type, const char *sort_spec)
970 ZOOM_connection c = r->connection;
974 newq = ZOOM_query_create();
975 if (ZOOM_query_sortby(newq, sort_spec) < 0)
978 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
979 r, r, sort_type, sort_spec);
983 if (c->host_port && c->proto == PROTO_HTTP)
987 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
988 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
992 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
998 ZOOM_resultset_cache_reset(r);
999 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
1000 task->u.sort.resultset = r;
1001 task->u.sort.q = newq;
1003 ZOOM_resultset_addref(r);
1007 while (ZOOM_event(1, &c))
1015 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1018 for (i = 0; i<RECORD_HASH_SIZE; i++)
1020 ZOOM_record_cache rc;
1021 for (rc = r->record_hash[i]; rc; rc = rc->next)
1024 wrbuf_destroy(rc->rec.wrbuf);
1026 r->record_hash[i] = 0;
1031 ZOOM_resultset_destroy(ZOOM_resultset r)
1033 resultset_destroy(r);
1036 static void resultset_destroy(ZOOM_resultset r)
1041 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1043 if (r->refcount == 0)
1045 ZOOM_resultset_cache_reset(r);
1049 /* remove ourselves from the resultsets in connection */
1050 ZOOM_resultset *rp = &r->connection->resultsets;
1053 assert(*rp); /* we must be in this list!! */
1055 { /* OK, we're here - take us out of it */
1062 ZOOM_query_destroy(r->query);
1063 ZOOM_options_destroy(r->options);
1064 odr_destroy(r->odr);
1072 ZOOM_resultset_size(ZOOM_resultset r)
1074 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1079 static void do_close(ZOOM_connection c)
1084 ZOOM_connection_set_mask(c, 0);
1085 c->state = STATE_IDLE;
1088 static int ZOOM_test_reconnect(ZOOM_connection c)
1092 if (!c->reconnect_ok)
1095 c->reconnect_ok = 0;
1096 c->tasks->running = 0;
1097 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1099 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1100 ZOOM_connection_put_event(c, event);
1105 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1106 int force_sync, int start, int count)
1111 const char *syntax, *elementSetName;
1115 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1116 " count=%d", r, force_sync, start, count);
1121 if (c->host_port && c->proto == PROTO_HTTP)
1125 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1126 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1130 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1132 c->reconnect_ok = 1;
1135 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1136 task->u.retrieve.resultset = r;
1137 task->u.retrieve.start = start;
1138 task->u.retrieve.count = count;
1140 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1141 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1142 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1143 task->u.retrieve.elementSetName = elementSetName
1144 ? xstrdup(elementSetName) : 0;
1146 cp = ZOOM_options_get(r->options, "schema");
1149 if (!r->schema || strcmp(r->schema, cp))
1152 r->schema = xstrdup(cp);
1156 ZOOM_resultset_addref(r);
1158 if (!r->connection->async || force_sync)
1159 while (r->connection && ZOOM_event(1, &r->connection))
1164 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1165 size_t start, size_t count)
1167 int force_present = 0;
1171 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1172 r, r, (long) start, (long) count);
1175 ZOOM_resultset_retrieve(r, force_present, start, count);
1179 for (i = 0; i< count; i++)
1180 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1184 static void get_cert(ZOOM_connection c)
1189 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1191 ZOOM_connection_option_setl(c, "sslPeerCert",
1192 cert_buf, cert_len);
1197 static zoom_ret do_connect(ZOOM_connection c)
1200 const char *effective_host;
1203 effective_host = c->proxy;
1205 effective_host = c->host_port;
1207 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1211 c->cs = cs_create_host(effective_host, 0, &add);
1213 if (c->cs && c->cs->protocol == PROTO_HTTP)
1218 c->proto = PROTO_HTTP;
1219 cs_get_host_args(c->host_port, &db);
1222 c->path = xmalloc(strlen(db) * 3 + 2);
1223 yaz_encode_sru_dbpath_buf(c->path, db);
1225 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1227 return zoom_complete;
1232 int ret = cs_connect(c->cs, add);
1235 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1236 ZOOM_connection_put_event(c, event);
1238 if (c->proto == PROTO_Z3950)
1239 ZOOM_connection_send_init(c);
1242 /* no init request for SRW .. */
1243 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1244 ZOOM_connection_remove_task(c);
1245 ZOOM_connection_set_mask(c, 0);
1246 ZOOM_connection_exec_task(c);
1248 c->state = STATE_ESTABLISHED;
1249 return zoom_pending;
1253 int mask = ZOOM_SELECT_EXCEPT;
1254 if (c->cs->io_pending & CS_WANT_WRITE)
1255 mask += ZOOM_SELECT_WRITE;
1256 if (c->cs->io_pending & CS_WANT_READ)
1257 mask += ZOOM_SELECT_READ;
1258 ZOOM_connection_set_mask(c, mask);
1259 c->state = STATE_CONNECTING;
1260 return zoom_pending;
1263 c->state = STATE_IDLE;
1264 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1265 return zoom_complete;
1268 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1271 for (i = 0; i<200; i++)
1275 Z_OtherInformation **oi;
1280 sprintf(buf, "otherInfo%d", i);
1281 val = ZOOM_options_get(c->options, buf);
1284 cp = strchr(val, ':');
1288 if (len >= sizeof(buf))
1289 len = sizeof(buf)-1;
1290 memcpy(buf, val, len);
1293 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1298 yaz_oi_APDU(a, &oi);
1299 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1303 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1308 Z_OtherInformation **oi;
1309 yaz_oi_APDU(a, &oi);
1310 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1315 Z_OtherInformation **oi;
1316 yaz_oi_APDU(a, &oi);
1317 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1320 otherInfo_attach(c, a, out);
1321 if (!z_APDU(out, &a, 0, 0))
1323 FILE *outf = fopen("/tmp/apdu.txt", "a");
1326 ODR odr_pr = odr_createmem(ODR_PRINT);
1327 fprintf(outf, "a=%p\n", a);
1328 odr_setprint(odr_pr, outf);
1329 z_APDU(odr_pr, &a, 0, 0);
1330 odr_destroy(odr_pr);
1332 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1333 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1338 z_APDU(c->odr_print, &a, 0, 0);
1339 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1343 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1347 if (encode_APDU(c, a, c->odr_out))
1348 return zoom_complete;
1349 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1350 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1351 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1352 ZOOM_connection_put_event(c, event);
1353 odr_reset(c->odr_out);
1357 /* returns 1 if PDU was sent OK (still pending )
1358 0 if PDU was not sent OK (nothing to wait for)
1361 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1363 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1364 Z_InitRequest *ireq = apdu->u.initRequest;
1365 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1366 odr_malloc(c->odr_out, sizeof(*auth));
1368 ODR_MASK_SET(ireq->options, Z_Options_search);
1369 ODR_MASK_SET(ireq->options, Z_Options_present);
1370 ODR_MASK_SET(ireq->options, Z_Options_scan);
1371 ODR_MASK_SET(ireq->options, Z_Options_sort);
1372 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1373 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1375 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1376 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1377 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1379 ireq->implementationId =
1380 odr_prepend(c->odr_out,
1381 ZOOM_options_get(c->options, "implementationId"),
1382 ireq->implementationId);
1384 ireq->implementationName =
1385 odr_prepend(c->odr_out,
1386 ZOOM_options_get(c->options, "implementationName"),
1387 odr_prepend(c->odr_out, "ZOOM-C",
1388 ireq->implementationName));
1390 ireq->implementationVersion =
1391 odr_prepend(c->odr_out,
1392 ZOOM_options_get(c->options, "implementationVersion"),
1393 ireq->implementationVersion);
1395 *ireq->maximumRecordSize = c->maximum_record_size;
1396 *ireq->preferredMessageSize = c->preferred_message_size;
1398 if (c->group || c->password)
1400 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1401 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1402 pass->userId = odr_strdup_null(c->odr_out, c->user);
1403 pass->password = odr_strdup_null(c->odr_out, c->password);
1404 auth->which = Z_IdAuthentication_idPass;
1405 auth->u.idPass = pass;
1406 ireq->idAuthentication = auth;
1410 auth->which = Z_IdAuthentication_open;
1411 auth->u.open = odr_strdup(c->odr_out, c->user);
1412 ireq->idAuthentication = auth;
1416 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1417 yaz_oid_userinfo_proxy, 1, c->host_port);
1419 if (c->charset || c->lang)
1421 Z_OtherInformation **oi;
1422 Z_OtherInformationUnit *oi_unit;
1424 yaz_oi_APDU(apdu, &oi);
1426 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1428 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1429 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1430 oi_unit->information.externallyDefinedInfo =
1431 yaz_set_proposal_charneg_list(c->odr_out, " ",
1432 c->charset, c->lang, 1);
1436 return send_APDU(c, apdu);
1440 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1444 const char *database = ZOOM_options_get(c->options, "databaseName");
1445 char *fdatabase = 0;
1448 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, 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");
1635 search_req->query = yaz_copy_Z_Query(search_req->query,
1638 r = yaz_query_charset_convert_rpnquery_check(
1639 search_req->query->u.type_1,
1641 yaz_iconv_close(cd);
1643 { /* query could not be char converted */
1644 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1645 return zoom_complete;
1650 search_req->databaseNames = r->databaseNames;
1651 search_req->num_databaseNames = r->num_databaseNames;
1653 /* get syntax (no need to provide unless piggyback is in effect) */
1654 syntax = c->tasks->u.search.syntax;
1656 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1657 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1658 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1659 if (lslb != -1 && ssub != -1 && mspn != -1)
1661 /* So're a Z39.50 expert? Let's hope you don't do sort */
1662 *search_req->largeSetLowerBound = lslb;
1663 *search_req->smallSetUpperBound = ssub;
1664 *search_req->mediumSetPresentNumber = mspn;
1666 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1667 && r->piggyback && !r->r_sort_spec && !r->schema)
1669 /* Regular piggyback - do it unless we're going to do sort */
1670 *search_req->largeSetLowerBound = 2000000000;
1671 *search_req->smallSetUpperBound = 1;
1672 *search_req->mediumSetPresentNumber =
1673 r->step>0 ? r->step : c->tasks->u.search.count;
1677 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1678 smallSetElementSetName = 0;
1679 mediumSetElementSetName = 0;
1682 if (smallSetElementSetName && *smallSetElementSetName)
1684 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1685 odr_malloc(c->odr_out, sizeof(*esn));
1687 esn->which = Z_ElementSetNames_generic;
1688 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1689 search_req->smallSetElementSetNames = esn;
1691 if (mediumSetElementSetName && *mediumSetElementSetName)
1693 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1694 odr_malloc(c->odr_out, sizeof(*esn));
1696 esn->which = Z_ElementSetNames_generic;
1697 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1698 search_req->mediumSetElementSetNames = esn;
1701 search_req->preferredRecordSyntax =
1702 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1706 if (c->support_named_resultsets)
1710 /* find the lowest unused ordinal so that we re-use
1711 result sets on the server. */
1712 for (ord = 1; ; ord++)
1715 sprintf(setname, "%d", ord);
1716 for (rp = c->resultsets; rp; rp = rp->next)
1717 if (rp->setname && !strcmp(rp->setname, setname))
1722 r->setname = xstrdup(setname);
1723 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1724 "set %s", c, r->setname);
1728 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1730 r->setname = xstrdup("default");
1732 ZOOM_options_set(r->options, "setname", r->setname);
1734 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1735 return send_APDU(c, apdu);
1738 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1740 char oid_name_buf[OID_STR_MAX];
1741 const char *oid_name;
1744 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1747 case Z_DefaultDiagFormat_v2Addinfo:
1748 addinfo = r->u.v2Addinfo;
1750 case Z_DefaultDiagFormat_v3Addinfo:
1751 addinfo = r->u.v3Addinfo;
1756 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1759 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1761 if (p->which != Z_DiagRec_defaultFormat)
1762 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1764 response_default_diag(c, p->u.defaultFormat);
1767 ZOOM_API(ZOOM_record)
1768 ZOOM_record_clone(ZOOM_record srec)
1775 odr_enc = odr_createmem(ODR_ENCODE);
1776 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1778 buf = odr_getbuf(odr_enc, &size, 0);
1780 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1781 nrec->odr = odr_createmem(ODR_DECODE);
1783 odr_setbuf(nrec->odr, buf, size, 0);
1784 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1786 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1787 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1788 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1789 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1790 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1791 odr_destroy(odr_enc);
1795 ZOOM_API(ZOOM_record)
1796 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1798 const char *syntax =
1799 ZOOM_options_get(s->options, "preferredRecordSyntax");
1800 const char *elementSetName =
1801 ZOOM_options_get(s->options, "elementSetName");
1803 return record_cache_lookup(s, pos, syntax, elementSetName);
1806 ZOOM_API(ZOOM_record)
1807 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1809 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1814 * MIKE: I think force_sync should always be zero, but I don't
1815 * want to make this change until I get the go-ahead from
1816 * Adam, in case something depends on the old synchronous
1820 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1821 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1822 rec = ZOOM_resultset_record_immediate(r, pos);
1828 ZOOM_record_destroy(ZOOM_record rec)
1833 wrbuf_destroy(rec->wrbuf);
1834 odr_destroy(rec->odr);
1839 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1846 strcpy(to, "UTF-8");
1847 if (record_charset && *record_charset)
1849 /* Use "from,to" or just "from" */
1850 const char *cp = strchr(record_charset, ',');
1851 int clen = strlen(record_charset);
1854 strncpy( to, cp+1, sizeof(to)-1);
1855 to[sizeof(to)-1] = '\0';
1856 clen = cp - record_charset;
1858 if (clen > sizeof(from)-1)
1859 clen = sizeof(from)-1;
1862 strncpy(from, record_charset, clen);
1866 cd = yaz_iconv_open(to, from);
1870 static const char *return_marc_record(ZOOM_record rec, int marc_type,
1872 const char *buf, int sz,
1873 const char *record_charset)
1875 yaz_iconv_t cd = iconv_create_charset(record_charset);
1876 yaz_marc_t mt = yaz_marc_create();
1877 const char *ret_string = 0;
1880 yaz_marc_iconv(mt, cd);
1881 yaz_marc_xml(mt, marc_type);
1883 rec->wrbuf = wrbuf_alloc();
1884 wrbuf_rewind(rec->wrbuf);
1885 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf) > 0)
1888 *len = wrbuf_len(rec->wrbuf);
1889 ret_string = wrbuf_cstr(rec->wrbuf);
1891 yaz_marc_destroy(mt);
1893 yaz_iconv_close(cd);
1897 static const char *return_opac_record(ZOOM_record rec, int marc_type,
1899 Z_OPACRecord *opac_rec,
1900 const char *record_charset)
1902 yaz_iconv_t cd = iconv_create_charset(record_charset);
1903 yaz_marc_t mt = yaz_marc_create();
1906 yaz_marc_iconv(mt, cd);
1907 yaz_marc_xml(mt, marc_type);
1910 rec->wrbuf = wrbuf_alloc();
1911 wrbuf_rewind(rec->wrbuf);
1913 yaz_opac_decode_wrbuf(mt, opac_rec, rec->wrbuf);
1914 yaz_marc_destroy(mt);
1917 yaz_iconv_close(cd);
1919 *len = wrbuf_len(rec->wrbuf);
1920 return wrbuf_cstr(rec->wrbuf);
1923 static const char *return_string_record(ZOOM_record rec, int *len,
1924 const char *buf, int sz,
1925 const char *record_charset)
1927 yaz_iconv_t cd = iconv_create_charset(record_charset);
1932 rec->wrbuf = wrbuf_alloc();
1934 wrbuf_rewind(rec->wrbuf);
1936 wrbuf_iconv_write(rec->wrbuf, cd, buf, sz);
1937 wrbuf_iconv_reset(rec->wrbuf, cd);
1939 buf = wrbuf_cstr(rec->wrbuf);
1940 sz = wrbuf_len(rec->wrbuf);
1941 yaz_iconv_close(cd);
1948 static const char *return_record(ZOOM_record rec, int *len,
1949 Z_NamePlusRecord *npr,
1950 int marctype, const char *charset)
1952 Z_External *r = (Z_External *) npr->u.databaseRecord;
1953 const Odr_oid *oid = r->direct_reference;
1955 /* render bibliographic record .. */
1956 if (r->which == Z_External_OPAC)
1958 return return_opac_record(rec, marctype, len,
1959 r->u.opac, charset);
1961 if (r->which == Z_External_sutrs)
1962 return return_string_record(rec, len,
1963 (char*) r->u.sutrs->buf,
1966 else if (r->which == Z_External_octet)
1968 if (yaz_oid_is_iso2709(oid))
1970 const char *ret_buf = return_marc_record(
1972 (const char *) r->u.octet_aligned->buf,
1973 r->u.octet_aligned->len,
1977 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
1978 if (marctype != YAZ_MARC_ISO2709)
1981 return return_string_record(rec, len,
1982 (const char *) r->u.octet_aligned->buf,
1983 r->u.octet_aligned->len,
1986 else if (r->which == Z_External_grs1)
1989 rec->wrbuf = wrbuf_alloc();
1990 wrbuf_rewind(rec->wrbuf);
1991 yaz_display_grs1(rec->wrbuf, r->u.grs1, 0);
1992 return return_string_record(rec, len,
1993 wrbuf_buf(rec->wrbuf),
1994 wrbuf_len(rec->wrbuf),
2002 ZOOM_record_error(ZOOM_record rec, const char **cp,
2003 const char **addinfo, const char **diagset)
2005 Z_NamePlusRecord *npr;
2014 *cp = rec->diag_message;
2016 *addinfo = rec->diag_details;
2018 *diagset = rec->diag_set;
2019 return uri_to_code(rec->diag_uri);
2021 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2023 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2024 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2025 const char *add = 0;
2027 if (diag_rec->which == Z_DiagRec_defaultFormat)
2029 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2032 error = *ddf->condition;
2035 case Z_DefaultDiagFormat_v2Addinfo:
2036 add = ddf->u.v2Addinfo;
2038 case Z_DefaultDiagFormat_v3Addinfo:
2039 add = ddf->u.v3Addinfo;
2044 yaz_oid_to_string(yaz_oid_std(),
2045 ddf->diagnosticSetId, &oclass);
2053 *addinfo = add ? add : "";
2055 *cp = diagbib1_str(error);
2061 ZOOM_API(const char *)
2062 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2069 Z_NamePlusRecord *npr;
2072 *len = 0; /* default return */
2081 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
2083 if (cp[i] == ';' || cp[i] == ' ')
2089 while (type_spec[i] == ';')
2092 while (type_spec[i] == ' ')
2094 if (!strncmp(type_spec+i, "charset=", 8))
2097 i = i + 8; /* skip charset= */
2098 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
2100 if (type_spec[i] == ';' || type_spec[i] == ' ')
2106 else if (!strncmp(type_spec+i, "xpath=", 6))
2110 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2114 while (type_spec[i] == ' ')
2117 if (!strcmp(type, "database"))
2120 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2121 return npr->databaseName;
2123 else if (!strcmp(type, "schema"))
2126 *len = rec->schema ? strlen(rec->schema) : 0;
2129 else if (!strcmp(type, "syntax"))
2131 const char *desc = 0;
2132 if (npr->which == Z_NamePlusRecord_databaseRecord)
2134 Z_External *r = (Z_External *) npr->u.databaseRecord;
2135 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2140 *len = strlen(desc);
2143 if (npr->which != Z_NamePlusRecord_databaseRecord)
2146 /* from now on - we have a database record .. */
2147 if (!strcmp(type, "render"))
2149 return return_record(rec, len, npr, YAZ_MARC_LINE, charset);
2151 else if (!strcmp(type, "xml"))
2153 return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2155 else if (!strcmp(type, "raw"))
2157 return return_record(rec, len, npr, YAZ_MARC_ISO2709, charset);
2159 else if (!strcmp(type, "ext"))
2162 return (const char *) npr->u.databaseRecord;
2164 else if (!strcmp(type, "opac"))
2166 if (npr->u.databaseRecord->which == Z_External_OPAC)
2167 return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2172 static int strcmp_null(const char *v1, const char *v2)
2178 return strcmp(v1, v2);
2181 static size_t record_hash(int pos)
2185 return pos % RECORD_HASH_SIZE;
2188 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2190 const char *syntax, const char *elementSetName,
2192 Z_SRW_diagnostic *diag)
2194 ZOOM_record_cache rc = 0;
2196 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2197 ZOOM_connection_put_event(r->connection, event);
2199 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2202 && strcmp_null(r->schema, rc->schema) == 0
2203 && strcmp_null(elementSetName,rc->elementSetName) == 0
2204 && strcmp_null(syntax, rc->syntax) == 0)
2209 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2212 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2214 rc->syntax = odr_strdup_null(r->odr, syntax);
2216 rc->schema = odr_strdup_null(r->odr, r->schema);
2219 rc->next = r->record_hash[record_hash(pos)];
2220 r->record_hash[record_hash(pos)] = rc;
2223 rc->rec.schema = odr_strdup_null(r->odr, schema);
2224 rc->rec.diag_set = 0;
2225 rc->rec.diag_uri = 0;
2226 rc->rec.diag_message = 0;
2227 rc->rec.diag_details = 0;
2233 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2234 if ((cp = strrchr(rc->rec.diag_set, '/')))
2236 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2238 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2239 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2243 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2245 const char *elementSetName)
2247 ZOOM_record_cache rc;
2249 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2253 if (strcmp_null(r->schema, rc->schema))
2255 if (strcmp_null(elementSetName,rc->elementSetName))
2257 if (strcmp_null(syntax, rc->syntax))
2265 static void handle_records(ZOOM_connection c, Z_Records *sr,
2268 ZOOM_resultset resultset;
2270 const char *syntax = 0, *elementSetName = 0;
2274 switch (c->tasks->which)
2276 case ZOOM_TASK_SEARCH:
2277 resultset = c->tasks->u.search.resultset;
2278 start = &c->tasks->u.search.start;
2279 count = &c->tasks->u.search.count;
2280 syntax = c->tasks->u.search.syntax;
2281 elementSetName = c->tasks->u.search.elementSetName;
2283 case ZOOM_TASK_RETRIEVE:
2284 resultset = c->tasks->u.retrieve.resultset;
2285 start = &c->tasks->u.retrieve.start;
2286 count = &c->tasks->u.retrieve.count;
2287 syntax = c->tasks->u.retrieve.syntax;
2288 elementSetName = c->tasks->u.retrieve.elementSetName;
2293 if (sr && sr->which == Z_Records_NSD)
2294 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2295 else if (sr && sr->which == Z_Records_multipleNSD)
2297 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2298 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2300 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2304 if (*count + *start > resultset->size)
2305 *count = resultset->size - *start;
2308 if (sr && sr->which == Z_Records_DBOSD)
2311 NMEM nmem = odr_extract_mem(c->odr_in);
2312 Z_NamePlusRecordList *p =
2313 sr->u.databaseOrSurDiagnostics;
2314 for (i = 0; i<p->num_records; i++)
2316 record_cache_add(resultset, p->records[i], i + *start,
2317 syntax, elementSetName,
2324 yaz_log(log_details,
2325 "handle_records resultset=%p start=%d count=%d",
2326 resultset, *start, *count);
2328 /* transfer our response to search_nmem .. we need it later */
2329 nmem_transfer(odr_getmem(resultset->odr), nmem);
2331 if (present_phase && p->num_records == 0)
2333 /* present response and we didn't get any records! */
2334 Z_NamePlusRecord *myrec =
2335 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2336 record_cache_add(resultset, myrec, *start,
2337 syntax, elementSetName, 0, 0);
2340 else if (present_phase)
2342 /* present response and we didn't get any records! */
2343 Z_NamePlusRecord *myrec =
2344 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2345 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2351 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2353 handle_records(c, pr->records, 1);
2356 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2359 switch (term->which)
2361 case Z_Term_general:
2362 ZOOM_options_setl(opt, name,
2363 (const char *)(term->u.general->buf),
2364 term->u.general->len);
2366 case Z_Term_characterString:
2367 ZOOM_options_set(opt, name, term->u.characterString);
2369 case Z_Term_numeric:
2370 ZOOM_options_set_int(opt, name, *term->u.numeric);
2375 static void handle_queryExpression(ZOOM_options opt, const char *name,
2376 Z_QueryExpression *exp)
2382 case Z_QueryExpression_term:
2383 if (exp->u.term && exp->u.term->queryTerm)
2385 sprintf(opt_name, "%s.term", name);
2386 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2389 case Z_QueryExpression_query:
2394 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2395 Z_OtherInformation *o)
2398 for (i = 0; o && i < o->num_elements; i++)
2400 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2402 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2404 if (ext->which == Z_External_searchResult1)
2407 Z_SearchInfoReport *sr = ext->u.searchResult1;
2410 ZOOM_options_set_int(
2411 resultset->options, "searchresult.size", sr->num);
2413 for (j = 0; j < sr->num; j++)
2415 Z_SearchInfoReport_s *ent =
2416 ext->u.searchResult1->elements[j];
2419 sprintf(pref, "searchresult.%d", j);
2421 if (ent->subqueryId)
2424 sprintf(opt_name, "%s.id", pref);
2425 ZOOM_options_set(resultset->options, opt_name,
2428 if (ent->subqueryExpression)
2431 sprintf(opt_name, "%s.subquery", pref);
2432 handle_queryExpression(resultset->options, opt_name,
2433 ent->subqueryExpression);
2435 if (ent->subqueryInterpretation)
2438 sprintf(opt_name, "%s.interpretation", pref);
2439 handle_queryExpression(resultset->options, opt_name,
2440 ent->subqueryInterpretation);
2442 if (ent->subqueryRecommendation)
2445 sprintf(opt_name, "%s.recommendation", pref);
2446 handle_queryExpression(resultset->options, opt_name,
2447 ent->subqueryRecommendation);
2449 if (ent->subqueryCount)
2452 sprintf(opt_name, "%s.count", pref);
2453 ZOOM_options_set_int(resultset->options, opt_name,
2454 *ent->subqueryCount);
2462 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2464 ZOOM_resultset resultset;
2467 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2470 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2471 ZOOM_connection_put_event(c, event);
2473 resultset = c->tasks->u.search.resultset;
2475 if (sr->resultSetStatus)
2477 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2478 *sr->resultSetStatus);
2480 if (sr->presentStatus)
2482 ZOOM_options_set_int(resultset->options, "presentStatus",
2483 *sr->presentStatus);
2485 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2487 resultset->size = *sr->resultCount;
2488 handle_records(c, sr->records, 0);
2491 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2493 if (res->diagnostics && res->num_diagnostics > 0)
2494 response_diag(c, res->diagnostics[0]);
2497 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2499 NMEM nmem = odr_extract_mem(c->odr_in);
2502 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2504 scan = c->tasks->u.scan.scan;
2506 if (res->entries && res->entries->nonsurrogateDiagnostics)
2507 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2508 scan->scan_response = res;
2509 scan->srw_scan_response = 0;
2510 nmem_transfer(odr_getmem(scan->odr), nmem);
2512 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2513 if (res->positionOfTerm)
2514 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2515 if (res->scanStatus)
2516 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2517 if (res->numberOfEntriesReturned)
2518 ZOOM_options_set_int(scan->options, "number",
2519 *res->numberOfEntriesReturned);
2524 static zoom_ret send_sort(ZOOM_connection c,
2525 ZOOM_resultset resultset)
2528 resultset->r_sort_spec = 0;
2529 if (resultset->r_sort_spec)
2531 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2532 Z_SortRequest *req = apdu->u.sortRequest;
2534 req->num_inputResultSetNames = 1;
2535 req->inputResultSetNames = (Z_InternationalString **)
2536 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2537 req->inputResultSetNames[0] =
2538 odr_strdup(c->odr_out, resultset->setname);
2539 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2540 req->sortSequence = resultset->r_sort_spec;
2541 resultset->r_sort_spec = 0;
2542 return send_APDU(c, apdu);
2544 return zoom_complete;
2547 static zoom_ret send_present(ZOOM_connection c)
2550 Z_PresentRequest *req = 0;
2552 const char *syntax = 0;
2553 const char *elementSetName = 0;
2554 ZOOM_resultset resultset;
2559 yaz_log(log_details, "%p send_present no tasks", c);
2560 return zoom_complete;
2563 switch (c->tasks->which)
2565 case ZOOM_TASK_SEARCH:
2566 resultset = c->tasks->u.search.resultset;
2567 start = &c->tasks->u.search.start;
2568 count = &c->tasks->u.search.count;
2569 syntax = c->tasks->u.search.syntax;
2570 elementSetName = c->tasks->u.search.elementSetName;
2572 case ZOOM_TASK_RETRIEVE:
2573 resultset = c->tasks->u.retrieve.resultset;
2574 start = &c->tasks->u.retrieve.start;
2575 count = &c->tasks->u.retrieve.count;
2576 syntax = c->tasks->u.retrieve.syntax;
2577 elementSetName = c->tasks->u.retrieve.elementSetName;
2580 return zoom_complete;
2582 yaz_log(log_details, "%p send_present start=%d count=%d",
2585 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2587 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2590 if (c->error) /* don't continue on error */
2591 return zoom_complete;
2592 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2593 resultset, *start, *count);
2595 for (i = 0; i < *count; i++)
2598 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2603 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2604 ZOOM_connection_put_event(c, event);
2612 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2613 return zoom_complete;
2616 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2617 req = apdu->u.presentRequest;
2620 yaz_log(log_details, "%p send_present skip=%d", c, i);
2622 *req->resultSetStartPoint = *start + 1;
2624 if (resultset->step > 0 && resultset->step < *count)
2625 *req->numberOfRecordsRequested = resultset->step;
2627 *req->numberOfRecordsRequested = *count;
2629 if (*req->numberOfRecordsRequested + *start > resultset->size)
2630 *req->numberOfRecordsRequested = resultset->size - *start;
2631 assert(*req->numberOfRecordsRequested > 0);
2633 if (syntax && *syntax)
2634 req->preferredRecordSyntax =
2635 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2637 if (resultset->schema && *resultset->schema)
2639 Z_RecordComposition *compo = (Z_RecordComposition *)
2640 odr_malloc(c->odr_out, sizeof(*compo));
2642 req->recordComposition = compo;
2643 compo->which = Z_RecordComp_complex;
2644 compo->u.complex = (Z_CompSpec *)
2645 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2646 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2647 odr_malloc(c->odr_out, sizeof(bool_t));
2648 *compo->u.complex->selectAlternativeSyntax = 0;
2650 compo->u.complex->generic = (Z_Specification *)
2651 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2653 compo->u.complex->generic->which = Z_Schema_oid;
2654 compo->u.complex->generic->schema.oid = (Odr_oid *)
2655 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2657 if (!compo->u.complex->generic->schema.oid)
2659 /* OID wasn't a schema! Try record syntax instead. */
2661 compo->u.complex->generic->schema.oid = (Odr_oid *)
2662 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2664 if (elementSetName && *elementSetName)
2666 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2667 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2668 compo->u.complex->generic->elementSpec->which =
2669 Z_ElementSpec_elementSetName;
2670 compo->u.complex->generic->elementSpec->u.elementSetName =
2671 odr_strdup(c->odr_out, elementSetName);
2674 compo->u.complex->generic->elementSpec = 0;
2675 compo->u.complex->num_dbSpecific = 0;
2676 compo->u.complex->dbSpecific = 0;
2677 compo->u.complex->num_recordSyntax = 0;
2678 compo->u.complex->recordSyntax = 0;
2680 else if (elementSetName && *elementSetName)
2682 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2683 odr_malloc(c->odr_out, sizeof(*esn));
2684 Z_RecordComposition *compo = (Z_RecordComposition *)
2685 odr_malloc(c->odr_out, sizeof(*compo));
2687 esn->which = Z_ElementSetNames_generic;
2688 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2689 compo->which = Z_RecordComp_simple;
2690 compo->u.simple = esn;
2691 req->recordComposition = compo;
2693 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2694 return send_APDU(c, apdu);
2697 ZOOM_API(ZOOM_scanset)
2698 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2701 ZOOM_query q = ZOOM_query_create();
2703 ZOOM_query_prefix(q, start);
2705 s = ZOOM_connection_scan1(c, q);
2706 ZOOM_query_destroy(q);
2711 ZOOM_API(ZOOM_scanset)
2712 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2714 ZOOM_scanset scan = 0;
2718 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2719 scan->connection = c;
2720 scan->odr = odr_createmem(ODR_DECODE);
2721 scan->options = ZOOM_options_create_with_parent(c->options);
2723 scan->scan_response = 0;
2724 scan->srw_scan_response = 0;
2728 scan->databaseNames = set_DatabaseNames(c, c->options,
2729 &scan->num_databaseNames,
2734 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2735 task->u.scan.scan = scan;
2740 while (ZOOM_event(1, &c))
2748 ZOOM_scanset_destroy(ZOOM_scanset scan)
2753 if (scan->refcount == 0)
2755 ZOOM_query_destroy(scan->query);
2757 odr_destroy(scan->odr);
2759 ZOOM_options_destroy(scan->options);
2764 static zoom_ret send_package(ZOOM_connection c)
2768 yaz_log(log_details, "%p send_package", c);
2770 return zoom_complete;
2771 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2773 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2774 ZOOM_connection_put_event(c, event);
2776 c->buf_out = c->tasks->u.package->buf_out;
2777 c->len_out = c->tasks->u.package->len_out;
2782 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2785 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2786 Z_ScanRequest *req = apdu->u.scanRequest;
2788 yaz_log(log_details, "%p send_scan", c);
2790 return zoom_complete;
2791 assert (c->tasks->which == ZOOM_TASK_SCAN);
2792 scan = c->tasks->u.scan.scan;
2794 /* Z39.50 scan can only carry RPN */
2795 if (scan->query->z_query->which == Z_Query_type_1 ||
2796 scan->query->z_query->which == Z_Query_type_101)
2798 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2799 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2802 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2805 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2807 yaz_query_charset_convert_rpnquery(
2808 rpn, c->odr_out, cd);
2809 yaz_iconv_close(cd);
2812 req->attributeSet = rpn->attributeSetId;
2813 if (!req->attributeSet)
2814 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2815 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2816 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2818 req->termListAndStartPoint =
2819 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2823 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2824 return zoom_complete;
2829 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2830 return zoom_complete;
2833 *req->numberOfTermsRequested =
2834 ZOOM_options_get_int(scan->options, "number", 10);
2836 req->preferredPositionInResponse =
2837 odr_intdup(c->odr_out,
2838 ZOOM_options_get_int(scan->options, "position", 1));
2841 odr_intdup(c->odr_out,
2842 ZOOM_options_get_int(scan->options, "stepSize", 0));
2844 req->databaseNames = scan->databaseNames;
2845 req->num_databaseNames = scan->num_databaseNames;
2847 return send_APDU(c, apdu);
2851 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2855 const char *option_val = 0;
2858 return zoom_complete;
2859 assert (c->tasks->which == ZOOM_TASK_SCAN);
2860 scan = c->tasks->u.scan.scan;
2862 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2864 /* SRU scan can only carry CQL and PQF */
2865 if (scan->query->z_query->which == Z_Query_type_104)
2867 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2868 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2870 else if (scan->query->z_query->which == Z_Query_type_1
2871 || scan->query->z_query->which == Z_Query_type_101)
2873 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2874 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2878 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2879 return zoom_complete;
2882 sr->u.scan_request->maximumTerms = odr_intdup(
2883 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2885 sr->u.scan_request->responsePosition = odr_intdup(
2886 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2888 option_val = ZOOM_options_get(scan->options, "extraArgs");
2889 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2890 return send_srw(c, sr);
2893 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2895 return zoom_complete;
2901 ZOOM_scanset_size(ZOOM_scanset scan)
2906 if (scan->scan_response && scan->scan_response->entries)
2907 return scan->scan_response->entries->num_entries;
2908 else if (scan->srw_scan_response)
2909 return scan->srw_scan_response->num_terms;
2913 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2915 const char **value_term, size_t *value_len,
2916 const char **disp_term, size_t *disp_len)
2918 size_t noent = ZOOM_scanset_size(scan);
2927 if (pos >= noent || pos < 0)
2929 if (scan->scan_response)
2931 Z_ScanResponse *res = scan->scan_response;
2932 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2934 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2936 *value_term = (const char *) t->term->u.general->buf;
2937 *value_len = t->term->u.general->len;
2940 *disp_term = t->displayTerm;
2941 *disp_len = strlen(*disp_term);
2943 else if (t->term->which == Z_Term_general)
2945 *disp_term = (const char *) t->term->u.general->buf;
2946 *disp_len = t->term->u.general->len;
2948 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2951 if (scan->srw_scan_response)
2953 Z_SRW_scanResponse *res = scan->srw_scan_response;
2954 Z_SRW_scanTerm *t = res->terms + pos;
2957 *value_term = t->value;
2958 *value_len = strlen(*value_term);
2961 *disp_term = t->displayTerm;
2963 *disp_term = t->value;
2964 *disp_len = strlen(*disp_term);
2965 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
2970 ZOOM_API(const char *)
2971 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2974 const char *value_term = 0;
2975 size_t value_len = 0;
2976 const char *disp_term = 0;
2977 size_t disp_len = 0;
2979 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2980 &disp_term, &disp_len);
2986 ZOOM_API(const char *)
2987 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2990 const char *value_term = 0;
2991 size_t value_len = 0;
2992 const char *disp_term = 0;
2993 size_t disp_len = 0;
2995 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2996 &disp_term, &disp_len);
3002 ZOOM_API(const char *)
3003 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3005 return ZOOM_options_get(scan->options, key);
3009 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3012 ZOOM_options_set(scan->options, key, val);
3015 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3018 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3019 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3021 str = ZOOM_options_get(p->options, "package-name");
3023 req->packageName = odr_strdup(p->odr_out, str);
3025 str = ZOOM_options_get(p->options, "user-id");
3027 req->userId = odr_strdup_null(p->odr_out, str);
3029 req->packageType = odr_oiddup(p->odr_out, oid);
3031 str = ZOOM_options_get(p->options, "function");
3034 if (!strcmp (str, "create"))
3035 *req->function = Z_ExtendedServicesRequest_create;
3036 if (!strcmp (str, "delete"))
3037 *req->function = Z_ExtendedServicesRequest_delete;
3038 if (!strcmp (str, "modify"))
3039 *req->function = Z_ExtendedServicesRequest_modify;
3042 str = ZOOM_options_get(p->options, "waitAction");
3045 if (!strcmp (str, "wait"))
3046 *req->waitAction = Z_ExtendedServicesRequest_wait;
3047 if (!strcmp (str, "waitIfPossible"))
3048 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3049 if (!strcmp (str, "dontWait"))
3050 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3051 if (!strcmp (str, "dontReturnPackage"))
3052 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3057 static const char *ill_array_lookup(void *clientData, const char *idx)
3059 ZOOM_package p = (ZOOM_package) clientData;
3060 return ZOOM_options_get(p->options, idx+4);
3063 static Z_External *encode_ill_request(ZOOM_package p)
3065 ODR out = p->odr_out;
3068 struct ill_get_ctl ctl;
3070 ctl.odr = p->odr_out;
3072 ctl.f = ill_array_lookup;
3074 req = ill_get_ILLRequest(&ctl, "ill", 0);
3076 if (!ill_Request(out, &req, 0, 0))
3078 int ill_request_size;
3079 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3080 if (ill_request_buf)
3081 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3086 int illRequest_size = 0;
3087 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3089 r = (Z_External *) odr_malloc(out, sizeof(*r));
3090 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3091 r->indirect_reference = 0;
3093 r->which = Z_External_single;
3095 r->u.single_ASN1_type =
3096 odr_create_Odr_oct(out,
3097 (unsigned char *)illRequest_buf,
3103 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3105 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3109 req->which = Z_IOItemOrder_esRequest;
3110 req->u.esRequest = (Z_IORequest *)
3111 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3113 /* to keep part ... */
3114 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3115 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3116 req->u.esRequest->toKeep->supplDescription = 0;
3117 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3118 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3120 str = ZOOM_options_get(p->options, "contact-name");
3121 req->u.esRequest->toKeep->contact->name =
3122 odr_strdup_null(p->odr_out, str);
3124 str = ZOOM_options_get(p->options, "contact-phone");
3125 req->u.esRequest->toKeep->contact->phone =
3126 odr_strdup_null(p->odr_out, str);
3128 str = ZOOM_options_get(p->options, "contact-email");
3129 req->u.esRequest->toKeep->contact->email =
3130 odr_strdup_null(p->odr_out, str);
3132 req->u.esRequest->toKeep->addlBilling = 0;
3134 /* not to keep part ... */
3135 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3136 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3138 str = ZOOM_options_get(p->options, "itemorder-setname");
3143 req->u.esRequest->notToKeep->resultSetItem = 0;
3146 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3147 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3149 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3150 odr_strdup(p->odr_out, str);
3151 req->u.esRequest->notToKeep->resultSetItem->item =
3152 odr_intdup(p->odr_out, 0);
3154 str = ZOOM_options_get(p->options, "itemorder-item");
3155 *req->u.esRequest->notToKeep->resultSetItem->item =
3156 (str ? atoi(str) : 1);
3159 str = ZOOM_options_getl(p->options, "doc", &len);
3162 req->u.esRequest->notToKeep->itemRequest =
3163 z_ext_record_xml(p->odr_out, str, len);
3166 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3171 Z_APDU *create_admin_package(ZOOM_package p, int type,
3172 Z_ESAdminOriginPartToKeep **toKeepP,
3173 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3175 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3178 Z_ESAdminOriginPartToKeep *toKeep;
3179 Z_ESAdminOriginPartNotToKeep *notToKeep;
3180 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3181 const char *first_db = "Default";
3183 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3188 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3190 r->indirect_reference = 0;
3191 r->which = Z_External_ESAdmin;
3193 r->u.adminService = (Z_Admin *)
3194 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3195 r->u.adminService->which = Z_Admin_esRequest;
3196 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3197 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3199 toKeep = r->u.adminService->u.esRequest->toKeep =
3200 (Z_ESAdminOriginPartToKeep *)
3201 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3202 toKeep->which = type;
3203 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3204 toKeep->u.create = odr_nullval();
3205 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3207 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3208 (Z_ESAdminOriginPartNotToKeep *)
3209 odr_malloc(p->odr_out,
3210 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3211 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3212 notToKeep->u.recordsWillFollow = odr_nullval();
3216 *notToKeepP = notToKeep;
3221 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3223 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3224 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3225 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3227 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3235 req->taskSpecificParameters = ext;
3236 ext->direct_reference = req->packageType;
3237 ext->descriptor = 0;
3238 ext->indirect_reference = 0;
3240 ext->which = Z_External_octet;
3241 ext->u.single_ASN1_type =
3242 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3246 static Z_APDU *create_update_package(ZOOM_package p)
3249 const char *first_db = "Default";
3251 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3252 const char *action = ZOOM_options_get(p->options, "action");
3253 int recordIdOpaque_len;
3254 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3255 &recordIdOpaque_len);
3256 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3258 const char *record_buf = ZOOM_options_getl(p->options, "record",
3260 int recordOpaque_len;
3261 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3263 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3264 const char *version = ZOOM_options_get(p->options, "updateVersion");
3266 const char *correlationInfo_note =
3267 ZOOM_options_get(p->options, "correlationInfo.note");
3268 const char *correlationInfo_id =
3269 ZOOM_options_get(p->options, "correlationInfo.id");
3271 Odr_oid *syntax_oid = 0;
3272 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3278 if (!record_buf && !recordOpaque_buf)
3280 record_buf = "void";
3282 syntax_str = "SUTRS";
3287 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3288 CLASS_RECSYN, syntax_str,
3300 package_oid = yaz_oid_extserv_database_update_first_version;
3301 /* old update does not support specialUpdate */
3303 action = "recordInsert";
3307 action = "specialUpdate";
3308 package_oid = yaz_oid_extserv_database_update_second_version;
3312 action = "specialUpdate";
3313 package_oid = yaz_oid_extserv_database_update;
3319 if (!strcmp(action, "recordInsert"))
3320 action_no = Z_IUOriginPartToKeep_recordInsert;
3321 else if (!strcmp(action, "recordReplace"))
3322 action_no = Z_IUOriginPartToKeep_recordReplace;
3323 else if (!strcmp(action, "recordDelete"))
3324 action_no = Z_IUOriginPartToKeep_recordDelete;
3325 else if (!strcmp(action, "elementUpdate"))
3326 action_no = Z_IUOriginPartToKeep_elementUpdate;
3327 else if (!strcmp(action, "specialUpdate"))
3328 action_no = Z_IUOriginPartToKeep_specialUpdate;
3332 apdu = create_es_package(p, package_oid);
3335 Z_IUOriginPartToKeep *toKeep;
3336 Z_IUSuppliedRecords *notToKeep;
3337 Z_External *r = (Z_External *)
3338 odr_malloc(p->odr_out, sizeof(*r));
3339 const char *elementSetName =
3340 ZOOM_options_get(p->options, "elementSetName");
3342 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3344 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3346 r->which = Z_External_update;
3347 r->indirect_reference = 0;
3348 r->u.update = (Z_IUUpdate *)
3349 odr_malloc(p->odr_out, sizeof(*r->u.update));
3351 r->u.update->which = Z_IUUpdate_esRequest;
3352 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3353 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3354 toKeep = r->u.update->u.esRequest->toKeep =
3355 (Z_IUOriginPartToKeep *)
3356 odr_malloc(p->odr_out, sizeof(*toKeep));
3358 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3361 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3363 toKeep->actionQualifier = 0;
3364 toKeep->action = odr_intdup(p->odr_out, action_no);
3366 notToKeep = r->u.update->u.esRequest->notToKeep =
3367 (Z_IUSuppliedRecords *)
3368 odr_malloc(p->odr_out, sizeof(*notToKeep));
3370 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3371 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3372 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3373 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3374 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3377 notToKeep->elements[0]->u.opaque =
3378 odr_create_Odr_oct(p->odr_out,
3379 (const unsigned char *) recordIdOpaque,
3380 recordIdOpaque_len);
3382 else if (recordIdNumber)
3384 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3386 notToKeep->elements[0]->u.number =
3387 odr_intdup(p->odr_out, atoi(recordIdNumber));
3390 notToKeep->elements[0]->u.opaque = 0;
3391 notToKeep->elements[0]->supplementalId = 0;
3392 if (correlationInfo_note || correlationInfo_id)
3394 Z_IUCorrelationInfo *ci;
3395 ci = notToKeep->elements[0]->correlationInfo =
3396 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3397 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3398 ci->id = correlationInfo_id ?
3399 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3402 notToKeep->elements[0]->correlationInfo = 0;
3403 if (recordOpaque_buf)
3405 notToKeep->elements[0]->record =
3406 z_ext_record_oid_any(p->odr_out, syntax_oid,
3407 recordOpaque_buf, recordOpaque_len);
3411 notToKeep->elements[0]->record =
3412 z_ext_record_oid(p->odr_out, syntax_oid,
3413 record_buf, record_len);
3418 ODR print = odr_createmem(ODR_PRINT);
3420 z_APDU(print, &apdu, 0, 0);
3427 ZOOM_package_send(ZOOM_package p, const char *type)
3434 odr_reset(p->odr_out);
3437 if (!strcmp(type, "itemorder"))
3439 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3442 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3444 r->direct_reference =
3445 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3447 r->which = Z_External_itemOrder;
3448 r->indirect_reference = 0;
3449 r->u.itemOrder = encode_item_order(p);
3451 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3454 else if (!strcmp(type, "create")) /* create database */
3456 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3459 else if (!strcmp(type, "drop")) /* drop database */
3461 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3464 else if (!strcmp(type, "commit")) /* commit changes */
3466 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3469 else if (!strcmp(type, "update")) /* update record(s) */
3471 apdu = create_update_package(p);
3473 else if (!strcmp(type, "xmlupdate"))
3475 apdu = create_xmlupdate_package(p);
3479 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3483 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3484 task->u.package = p;
3485 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3486 p->buf_out = (char *) xmalloc(p->len_out);
3487 memcpy(p->buf_out, buf, p->len_out);
3492 while (ZOOM_event(1, &c))
3499 ZOOM_API(ZOOM_package)
3500 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3502 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3505 p->odr_out = odr_createmem(ODR_ENCODE);
3506 p->options = ZOOM_options_create_with_parent2(options, c->options);
3514 ZOOM_package_destroy(ZOOM_package p)
3519 if (p->refcount == 0)
3521 odr_destroy(p->odr_out);
3524 ZOOM_options_destroy(p->options);
3529 ZOOM_API(const char *)
3530 ZOOM_package_option_get(ZOOM_package p, const char *key)
3532 return ZOOM_options_get(p->options, key);
3535 ZOOM_API(const char *)
3536 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3538 return ZOOM_options_getl(p->options, key, lenp);
3542 ZOOM_package_option_set(ZOOM_package p, const char *key,
3545 ZOOM_options_set(p->options, key, val);
3549 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3550 const char *val, int len)
3552 ZOOM_options_setl(p->options, key, val, len);
3555 static int ZOOM_connection_exec_task(ZOOM_connection c)
3557 ZOOM_task task = c->tasks;
3558 zoom_ret ret = zoom_complete;
3562 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3563 c, task->which, task->running);
3564 if (c->error != ZOOM_ERROR_NONE)
3566 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3567 "removing tasks because of error = %d", c, c->error);
3568 ZOOM_connection_remove_tasks(c);
3573 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3574 "task already running", c);
3578 ret = zoom_complete;
3579 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3581 switch (task->which)
3583 case ZOOM_TASK_SEARCH:
3584 if (c->proto == PROTO_HTTP)
3585 ret = ZOOM_connection_srw_send_search(c);
3587 ret = ZOOM_connection_send_search(c);
3589 case ZOOM_TASK_RETRIEVE:
3590 if (c->proto == PROTO_HTTP)
3591 ret = ZOOM_connection_srw_send_search(c);
3593 ret = send_present(c);
3595 case ZOOM_TASK_CONNECT:
3596 ret = do_connect(c);
3598 case ZOOM_TASK_SCAN:
3599 if (c->proto == PROTO_HTTP)
3600 ret = ZOOM_connection_srw_send_scan(c);
3602 ret = ZOOM_connection_send_scan(c);
3604 case ZOOM_TASK_PACKAGE:
3605 ret = send_package(c);
3607 case ZOOM_TASK_SORT:
3608 c->tasks->u.sort.resultset->r_sort_spec =
3609 c->tasks->u.sort.q->sort_spec;
3610 ret = send_sort(c, c->tasks->u.sort.resultset);
3616 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3617 "remove tasks because no connection exist", c);
3618 ZOOM_connection_remove_tasks(c);
3620 if (ret == zoom_complete)
3622 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3623 "task removed (complete)", c);
3624 ZOOM_connection_remove_task(c);
3627 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3632 static zoom_ret send_sort_present(ZOOM_connection c)
3634 zoom_ret r = zoom_complete;
3636 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3637 r = send_sort(c, c->tasks->u.search.resultset);
3638 if (r == zoom_complete)
3639 r = send_present(c);
3643 static int es_response_taskpackage_update(ZOOM_connection c,
3644 Z_IUUpdateTaskPackage *utp)
3646 if (utp && utp->targetPart)
3648 Z_IUTargetPart *targetPart = utp->targetPart;
3649 switch ( *targetPart->updateStatus ) {
3650 case Z_IUTargetPart_success:
3651 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3653 case Z_IUTargetPart_partial:
3654 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3656 case Z_IUTargetPart_failure:
3657 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3658 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3659 response_diag(c, targetPart->globalDiagnostics[0]);
3662 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3667 static int es_response_taskpackage(ZOOM_connection c,
3668 Z_TaskPackage *taskPackage)
3671 Odr_oct *id = taskPackage->targetReference;
3673 ZOOM_options_setl(c->tasks->u.package->options,
3674 "targetReference", (char*) id->buf, id->len);
3677 switch ( *taskPackage->taskStatus ) {
3678 case Z_TaskPackage_pending:
3679 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3681 case Z_TaskPackage_active:
3682 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3684 case Z_TaskPackage_complete:
3685 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3687 case Z_TaskPackage_aborted:
3688 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3689 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3690 response_diag(c, taskPackage->packageDiagnostics[0]);
3694 // taskSpecificParameters
3695 // NOTE: Only Update implemented, no others.
3696 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3697 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3698 es_response_taskpackage_update(c, utp);
3704 static int es_response(ZOOM_connection c,
3705 Z_ExtendedServicesResponse *res)
3707 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3709 switch (*res->operationStatus) {
3710 case Z_ExtendedServicesResponse_done:
3711 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3713 case Z_ExtendedServicesResponse_accepted:
3714 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3716 case Z_ExtendedServicesResponse_failure:
3717 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3718 if (res->diagnostics && res->num_diagnostics > 0)
3719 response_diag(c, res->diagnostics[0]);
3722 if (res->taskPackage &&
3723 res->taskPackage->which == Z_External_extendedService)
3725 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3726 es_response_taskpackage(c, taskPackage);
3728 if (res->taskPackage &&
3729 res->taskPackage->which == Z_External_octet)
3731 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3732 ZOOM_options_setl(c->tasks->u.package->options,
3733 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3738 static void interpret_init_diag(ZOOM_connection c,
3739 Z_DiagnosticFormat *diag)
3743 Z_DiagnosticFormat_s *ds = diag->elements[0];
3744 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3745 response_default_diag(c, ds->u.defaultDiagRec);
3750 static void interpret_otherinformation_field(ZOOM_connection c,
3751 Z_OtherInformation *ui)
3754 for (i = 0; i < ui->num_elements; i++)
3756 Z_OtherInformationUnit *unit = ui->list[i];
3757 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3758 unit->information.externallyDefinedInfo &&
3759 unit->information.externallyDefinedInfo->which ==
3762 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3768 static void set_init_option(const char *name, void *clientData) {
3769 ZOOM_connection c = (ZOOM_connection) clientData;
3772 sprintf(buf, "init_opt_%.70s", name);
3773 ZOOM_connection_option_set(c, buf, "1");
3777 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3779 Z_InitResponse *initrs;
3781 ZOOM_connection_set_mask(c, 0);
3782 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3785 case Z_APDU_initResponse:
3786 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3787 initrs = apdu->u.initResponse;
3788 ZOOM_connection_option_set(c, "serverImplementationId",
3789 initrs->implementationId ?
3790 initrs->implementationId : "");
3791 ZOOM_connection_option_set(c, "serverImplementationName",
3792 initrs->implementationName ?
3793 initrs->implementationName : "");
3794 ZOOM_connection_option_set(c, "serverImplementationVersion",
3795 initrs->implementationVersion ?
3796 initrs->implementationVersion : "");
3797 /* Set the three old options too, for old applications */
3798 ZOOM_connection_option_set(c, "targetImplementationId",
3799 initrs->implementationId ?
3800 initrs->implementationId : "");
3801 ZOOM_connection_option_set(c, "targetImplementationName",
3802 initrs->implementationName ?
3803 initrs->implementationName : "");
3804 ZOOM_connection_option_set(c, "targetImplementationVersion",
3805 initrs->implementationVersion ?
3806 initrs->implementationVersion : "");
3808 /* Make initrs->options available as ZOOM-level options */
3809 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3811 if (!*initrs->result)
3813 Z_External *uif = initrs->userInformationField;
3815 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3817 if (uif && uif->which == Z_External_userInfo1)
3818 interpret_otherinformation_field(c, uif->u.userInfo1);
3823 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3824 yaz_oid_userinfo_cookie, 1, 0);
3825 xfree(c->cookie_in);
3828 c->cookie_in = xstrdup(cookie);
3829 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3830 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3831 c->support_named_resultsets = 1;
3834 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3835 ZOOM_connection_remove_task(c);
3837 ZOOM_connection_exec_task(c);
3839 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3841 NMEM tmpmem = nmem_create();
3842 Z_CharSetandLanguageNegotiation *p =
3843 yaz_get_charneg_record(initrs->otherInfo);
3847 char *charset = NULL, *lang = NULL;
3850 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3851 yaz_log(log_details, "%p recv_apdu target accepted: "
3852 "charset %s, language %s, select %d",
3854 charset ? charset : "none", lang ? lang : "none", sel);
3856 ZOOM_connection_option_set(c, "negotiation-charset",
3859 ZOOM_connection_option_set(c, "negotiation-lang",
3862 ZOOM_connection_option_set(
3863 c, "negotiation-charset-in-effect-for-records",
3864 (sel != 0) ? "1" : "0");
3865 nmem_destroy(tmpmem);
3869 case Z_APDU_searchResponse:
3870 yaz_log(log_api, "%p recv_apdu Search response", c);
3871 handle_search_response(c, apdu->u.searchResponse);
3872 if (send_sort_present(c) == zoom_complete)
3873 ZOOM_connection_remove_task(c);
3875 case Z_APDU_presentResponse:
3876 yaz_log(log_api, "%p recv_apdu Present response", c);
3877 handle_present_response(c, apdu->u.presentResponse);
3878 if (send_present(c) == zoom_complete)
3879 ZOOM_connection_remove_task(c);
3881 case Z_APDU_sortResponse:
3882 yaz_log(log_api, "%p recv_apdu Sort response", c);
3883 sort_response(c, apdu->u.sortResponse);
3884 if (send_present(c) == zoom_complete)
3885 ZOOM_connection_remove_task(c);
3887 case Z_APDU_scanResponse:
3888 yaz_log(log_api, "%p recv_apdu Scan response", c);
3889 scan_response(c, apdu->u.scanResponse);
3890 ZOOM_connection_remove_task(c);
3892 case Z_APDU_extendedServicesResponse:
3893 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3894 es_response(c, apdu->u.extendedServicesResponse);
3895 ZOOM_connection_remove_task(c);
3898 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3899 if (!ZOOM_test_reconnect(c))
3901 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3906 yaz_log(log_api, "%p Received unknown PDU", c);
3907 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3913 static zoom_ret handle_srw_response(ZOOM_connection c,
3914 Z_SRW_searchRetrieveResponse *res)
3916 ZOOM_resultset resultset = 0;
3921 const char *syntax, *elementSetName;
3924 return zoom_complete;
3926 switch(c->tasks->which)
3928 case ZOOM_TASK_SEARCH:
3929 resultset = c->tasks->u.search.resultset;
3930 start = &c->tasks->u.search.start;
3931 count = &c->tasks->u.search.count;
3932 syntax = c->tasks->u.search.syntax;
3933 elementSetName = c->tasks->u.search.elementSetName;
3935 if (!c->tasks->u.search.recv_search_fired)
3937 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3938 ZOOM_connection_put_event(c, event);
3939 c->tasks->u.search.recv_search_fired = 1;
3942 case ZOOM_TASK_RETRIEVE:
3943 resultset = c->tasks->u.retrieve.resultset;
3944 start = &c->tasks->u.retrieve.start;
3945 count = &c->tasks->u.retrieve.count;
3946 syntax = c->tasks->u.retrieve.syntax;
3947 elementSetName = c->tasks->u.retrieve.elementSetName;
3950 return zoom_complete;
3953 resultset->size = 0;
3955 if (res->resultSetId)
3956 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3958 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3960 if (res->num_diagnostics > 0)
3962 set_SRU_error(c, &res->diagnostics[0]);
3966 if (res->numberOfRecords)
3967 resultset->size = *res->numberOfRecords;
3968 for (i = 0; i<res->num_records; i++)
3971 Z_SRW_record *sru_rec;
3972 Z_SRW_diagnostic *diag = 0;
3975 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3976 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3978 if (res->records[i].recordPosition &&
3979 *res->records[i].recordPosition > 0)
3980 pos = *res->records[i].recordPosition - 1;
3984 sru_rec = &res->records[i];
3986 npr->databaseName = 0;
3987 npr->which = Z_NamePlusRecord_databaseRecord;
3988 npr->u.databaseRecord = (Z_External *)
3989 odr_malloc(c->odr_in, sizeof(Z_External));
3990 npr->u.databaseRecord->descriptor = 0;
3991 npr->u.databaseRecord->direct_reference =
3992 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3993 npr->u.databaseRecord->which = Z_External_octet;
3995 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3996 odr_malloc(c->odr_in, sizeof(Odr_oct));
3997 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3998 sru_rec->recordData_buf;
3999 npr->u.databaseRecord->u.octet_aligned->len =
4000 npr->u.databaseRecord->u.octet_aligned->size =
4001 sru_rec->recordData_len;
4003 if (sru_rec->recordSchema
4004 && !strcmp(sru_rec->recordSchema,
4005 "info:srw/schema/1/diagnostics-v1.1"))
4007 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4008 sru_rec->recordData_len,
4012 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4013 sru_rec->recordSchema, diag);
4017 if (*count + *start > resultset->size)
4018 *count = resultset->size - *start;
4022 nmem = odr_extract_mem(c->odr_in);
4023 nmem_transfer(odr_getmem(resultset->odr), nmem);
4027 return ZOOM_connection_srw_send_search(c);
4029 return zoom_complete;
4034 static void handle_srw_scan_response(ZOOM_connection c,
4035 Z_SRW_scanResponse *res)
4037 NMEM nmem = odr_extract_mem(c->odr_in);
4040 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4042 scan = c->tasks->u.scan.scan;
4044 if (res->num_diagnostics > 0)
4045 set_SRU_error(c, &res->diagnostics[0]);
4047 scan->scan_response = 0;
4048 scan->srw_scan_response = res;
4049 nmem_transfer(odr_getmem(scan->odr), nmem);
4051 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4057 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4059 zoom_ret cret = zoom_complete;
4061 const char *addinfo = 0;
4062 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4064 ZOOM_connection_set_mask(c, 0);
4065 yaz_log(log_details, "%p handle_http", c);
4067 if (!yaz_srw_check_content_type(hres))
4068 addinfo = "content-type";
4071 Z_SOAP *soap_package = 0;
4073 Z_SOAP_Handler soap_handlers[2] = {
4074 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4077 ret = z_soap_codec(o, &soap_package,
4078 &hres->content_buf, &hres->content_len,
4080 if (!ret && soap_package->which == Z_SOAP_generic &&
4081 soap_package->u.generic->no == 0)
4083 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4085 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4086 ZOOM_options_setl(c->options, "sru_extra_response_data",
4087 sr->extraResponseData_buf, sr->extraResponseData_len);
4088 if (sr->which == Z_SRW_searchRetrieve_response)
4089 cret = handle_srw_response(c, sr->u.response);
4090 else if (sr->which == Z_SRW_scan_response)
4091 handle_srw_scan_response(c, sr->u.scan_response);
4095 else if (!ret && (soap_package->which == Z_SOAP_fault
4096 || soap_package->which == Z_SOAP_error))
4098 set_HTTP_error(c, hres->code,
4099 soap_package->u.fault->fault_code,
4100 soap_package->u.fault->fault_string);
4107 if (hres->code != 200)
4108 set_HTTP_error(c, hres->code, 0, 0);
4110 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4113 if (cret == zoom_complete)
4114 ZOOM_connection_remove_task(c);
4115 if (!strcmp(hres->version, "1.0"))
4117 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4118 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4123 /* HTTP 1.1: only if no close we stay alive .. */
4124 if (connection_head && !strcmp(connection_head, "close"))
4130 static int do_read(ZOOM_connection c)
4135 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4136 ZOOM_connection_put_event(c, event);
4138 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4139 more = cs_more(c->cs);
4140 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4145 if (!ZOOM_test_reconnect(c))
4147 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4156 odr_reset(c->odr_in);
4157 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4158 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4159 ZOOM_connection_put_event(c, event);
4161 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4164 int err = odr_geterrorx(c->odr_in, &x);
4166 const char *element = odr_getelement(c->odr_in);
4167 yaz_snprintf(msg, sizeof(msg),
4168 "ODR code %d:%d element=%s offset=%d",
4169 err, x, element ? element : "<unknown>",
4170 odr_offset(c->odr_in));
4171 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4174 FILE *ber_file = yaz_log_file();
4176 odr_dumpBER(ber_file, c->buf_in, r);
4183 z_GDU(c->odr_print, &gdu, 0, 0);
4184 if (gdu->which == Z_GDU_Z3950)
4185 recv_apdu(c, gdu->u.z3950);
4186 else if (gdu->which == Z_GDU_HTTP_Response)
4189 handle_http(c, gdu->u.HTTP_Response);
4191 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4196 c->reconnect_ok = 0;
4201 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4206 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4207 ZOOM_connection_put_event(c, event);
4209 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4210 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4212 yaz_log(log_details, "%p do_write_ex write failed", c);
4213 if (ZOOM_test_reconnect(c))
4215 return zoom_pending;
4217 if (c->state == STATE_CONNECTING)
4218 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4220 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4222 return zoom_complete;
4226 int mask = ZOOM_SELECT_EXCEPT;
4227 if (c->cs->io_pending & CS_WANT_WRITE)
4228 mask += ZOOM_SELECT_WRITE;
4229 if (c->cs->io_pending & CS_WANT_READ)
4230 mask += ZOOM_SELECT_READ;
4231 ZOOM_connection_set_mask(c, mask);
4232 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4237 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4238 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4241 return zoom_pending;
4244 static zoom_ret do_write(ZOOM_connection c)
4246 return do_write_ex(c, c->buf_out, c->len_out);
4250 ZOOM_API(const char *)
4251 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4253 return ZOOM_options_get(c->options, key);
4256 ZOOM_API(const char *)
4257 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4259 return ZOOM_options_getl(c->options, key, lenp);
4263 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4266 ZOOM_options_set(c->options, key, val);
4270 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4271 const char *val, int len)
4273 ZOOM_options_setl(c->options, key, val, len);
4276 ZOOM_API(const char *)
4277 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4279 return ZOOM_options_get(r->options, key);
4283 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4286 ZOOM_options_set(r->options, key, val);
4291 ZOOM_connection_errcode(ZOOM_connection c)
4293 return ZOOM_connection_error(c, 0, 0);
4296 ZOOM_API(const char *)
4297 ZOOM_connection_errmsg(ZOOM_connection c)
4300 ZOOM_connection_error(c, &msg, 0);
4304 ZOOM_API(const char *)
4305 ZOOM_connection_addinfo(ZOOM_connection c)
4307 const char *addinfo;
4308 ZOOM_connection_error(c, 0, &addinfo);
4312 ZOOM_API(const char *)
4313 ZOOM_connection_diagset(ZOOM_connection c)
4315 const char *diagset;
4316 ZOOM_connection_error_x(c, 0, 0, &diagset);
4320 ZOOM_API(const char *)
4321 ZOOM_diag_str(int error)
4325 case ZOOM_ERROR_NONE:
4327 case ZOOM_ERROR_CONNECT:
4328 return "Connect failed";
4329 case ZOOM_ERROR_MEMORY:
4330 return "Out of memory";
4331 case ZOOM_ERROR_ENCODE:
4332 return "Encoding failed";
4333 case ZOOM_ERROR_DECODE:
4334 return "Decoding failed";
4335 case ZOOM_ERROR_CONNECTION_LOST:
4336 return "Connection lost";
4337 case ZOOM_ERROR_INIT:
4338 return "Init rejected";
4339 case ZOOM_ERROR_INTERNAL:
4340 return "Internal failure";
4341 case ZOOM_ERROR_TIMEOUT:
4343 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4344 return "Unsupported protocol";
4345 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4346 return "Unsupported query type";
4347 case ZOOM_ERROR_INVALID_QUERY:
4348 return "Invalid query";
4349 case ZOOM_ERROR_CQL_PARSE:
4350 return "CQL parsing error";
4351 case ZOOM_ERROR_CQL_TRANSFORM:
4352 return "CQL transformation error";
4353 case ZOOM_ERROR_CCL_CONFIG:
4354 return "CCL configuration error";
4355 case ZOOM_ERROR_CCL_PARSE:
4356 return "CCL parsing error";
4358 return diagbib1_str(error);
4363 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4364 const char **addinfo, const char **diagset)
4366 int error = c->error;
4369 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4370 *cp = ZOOM_diag_str(error);
4371 else if (!strcmp(c->diagset, "HTTP"))
4372 *cp = z_HTTP_errmsg(c->error);
4373 else if (!strcmp(c->diagset, "Bib-1"))
4374 *cp = ZOOM_diag_str(error);
4375 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4376 *cp = yaz_diag_srw_str(c->error);
4378 *cp = "Unknown error and diagnostic set";
4381 *addinfo = c->addinfo ? c->addinfo : "";
4383 *diagset = c->diagset ? c->diagset : "";
4388 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4389 const char **addinfo)
4391 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4394 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4396 ZOOM_Event event = 0;
4397 int r = cs_look(c->cs);
4398 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4403 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4404 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4406 ZOOM_connection_put_event(c, event);
4408 else if (r == CS_CONNECT)
4410 int ret = ret = cs_rcvconnect(c->cs);
4411 yaz_log(log_details, "%p ZOOM_connection_do_io "
4412 "cs_rcvconnect returned %d", c, ret);
4415 int mask = ZOOM_SELECT_EXCEPT;
4416 if (c->cs->io_pending & CS_WANT_WRITE)
4417 mask += ZOOM_SELECT_WRITE;
4418 if (c->cs->io_pending & CS_WANT_READ)
4419 mask += ZOOM_SELECT_READ;
4420 ZOOM_connection_set_mask(c, mask);
4421 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4422 ZOOM_connection_put_event(c, event);
4426 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4427 ZOOM_connection_put_event(c, event);
4429 if (c->proto == PROTO_Z3950)
4430 ZOOM_connection_send_init(c);
4433 /* no init request for SRW .. */
4434 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4435 ZOOM_connection_remove_task(c);
4436 ZOOM_connection_set_mask(c, 0);
4437 ZOOM_connection_exec_task(c);
4439 c->state = STATE_ESTABLISHED;
4443 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4449 if (mask & ZOOM_SELECT_EXCEPT)
4451 if (!ZOOM_test_reconnect(c))
4453 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4458 if (mask & ZOOM_SELECT_READ)
4460 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4466 ZOOM_connection_last_event(ZOOM_connection cs)
4469 return ZOOM_EVENT_NONE;
4470 return cs->last_event;
4474 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4476 WRBUF wrbuf = (WRBUF) client_data;
4477 wrbuf_puts(wrbuf, buf);
4481 * Returns an xmalloc()d string containing RPN that corresponds to the
4482 * CQL passed in. On error, sets the Connection object's error state
4483 * and returns a null pointer.
4484 * ### We could cache CQL parser and/or transformer in Connection.
4486 static char *cql2pqf(ZOOM_connection c, const char *cql)
4490 const char *cqlfile;
4491 cql_transform_t trans;
4494 parser = cql_parser_create();
4495 if ((error = cql_parser_string(parser, cql)) != 0) {
4496 cql_parser_destroy(parser);
4497 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4501 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4504 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4506 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4509 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4510 cqlfile, strerror(errno));
4511 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4515 WRBUF wrbuf_result = wrbuf_alloc();
4516 error = cql_transform(trans, cql_parser_result(parser),
4517 cql2pqf_wrbuf_puts, wrbuf_result);
4520 const char *addinfo;
4521 error = cql_transform_error(trans, &addinfo);
4522 sprintf(buf, "%.200s (addinfo=%.200s)",
4523 cql_strerror(error), addinfo);
4524 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4528 result = xstrdup(wrbuf_cstr(wrbuf_result));
4530 cql_transform_close(trans);
4531 wrbuf_destroy(wrbuf_result);
4533 cql_parser_destroy(parser);
4537 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4541 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4542 /* timeout and this connection was waiting */
4543 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4545 ZOOM_connection_put_event(c, event);
4551 ZOOM_connection_process(ZOOM_connection c)
4557 event = ZOOM_connection_get_event(c);
4560 ZOOM_Event_destroy(event);
4563 ZOOM_connection_exec_task(c);
4564 event = ZOOM_connection_get_event(c);
4567 ZOOM_Event_destroy(event);
4574 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4578 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4580 for (i = 0; i<no; i++)
4582 ZOOM_connection c = cs[i];
4584 if (c && ZOOM_connection_process(c))
4590 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4592 if (c->mask && mask)
4593 ZOOM_connection_do_io(c, mask);
4597 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4600 return cs_fileno(c->cs);
4604 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4612 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4619 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4621 return ZOOM_options_get_int(c->options, "timeout", 30);
4627 * c-file-style: "Stroustrup"
4628 * indent-tabs-mode: nil
4630 * vim: shiftwidth=4 tabstop=8 expandtab