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=%d",
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)
1216 const char *path = 0;
1218 c->proto = PROTO_HTTP;
1219 cs_get_host_args(c->host_port, &path);
1221 c->path = (char*) xmalloc(strlen(path)+2);
1223 strcpy(c->path+1, path);
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;
1449 fdatabase = (char *) odr_malloc(c->odr_out, strlen(database)+2);
1450 strcpy(fdatabase, "/");
1451 strcat(fdatabase, database);
1453 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1454 fdatabase ? fdatabase : c->path);
1456 if (c->sru_mode == zoom_sru_get)
1458 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1460 else if (c->sru_mode == zoom_sru_post)
1462 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1464 else if (c->sru_mode == zoom_sru_soap)
1466 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1468 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1469 return zoom_complete;
1471 z_GDU(c->odr_print, &gdu, 0, 0);
1472 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1474 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1475 ZOOM_connection_put_event(c, event);
1476 odr_reset(c->odr_out);
1482 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1484 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1485 sr->username = c->user;
1486 sr->password = c->password;
1492 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1496 ZOOM_resultset resultset = 0;
1498 const char *option_val = 0;
1500 if (c->error) /* don't continue on error */
1501 return zoom_complete;
1503 switch(c->tasks->which)
1505 case ZOOM_TASK_SEARCH:
1506 resultset = c->tasks->u.search.resultset;
1507 if (!resultset->setname)
1508 resultset->setname = xstrdup("default");
1509 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1510 start = &c->tasks->u.search.start;
1511 count = &c->tasks->u.search.count;
1513 case ZOOM_TASK_RETRIEVE:
1514 resultset = c->tasks->u.retrieve.resultset;
1516 start = &c->tasks->u.retrieve.start;
1517 count = &c->tasks->u.retrieve.count;
1519 if (*start >= resultset->size)
1520 return zoom_complete;
1521 if (*start + *count > resultset->size)
1522 *count = resultset->size - *start;
1524 for (i = 0; i < *count; i++)
1527 record_cache_lookup(resultset, i + *start,
1528 c->tasks->u.retrieve.syntax,
1529 c->tasks->u.retrieve.elementSetName);
1534 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1535 ZOOM_connection_put_event(c, event);
1542 return zoom_complete;
1545 return zoom_complete;
1547 assert(resultset->query);
1549 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1550 if (resultset->query->z_query->which == Z_Query_type_104
1551 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1553 sr->u.request->query_type = Z_SRW_query_type_cql;
1554 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1556 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1557 resultset->query->z_query->u.type_1)
1559 sr->u.request->query_type = Z_SRW_query_type_pqf;
1560 sr->u.request->query.pqf = resultset->query->query_string;
1564 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1565 return zoom_complete;
1567 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1568 sr->u.request->maximumRecords = odr_intdup(
1569 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1570 resultset->step : *count);
1571 sr->u.request->recordSchema = resultset->schema;
1573 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1575 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1577 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1578 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1579 return send_srw(c, sr);
1582 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1584 return zoom_complete;
1588 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1591 int lslb, ssub, mspn;
1593 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1594 Z_SearchRequest *search_req = apdu->u.searchRequest;
1595 const char *elementSetName;
1596 const char *smallSetElementSetName;
1597 const char *mediumSetElementSetName;
1600 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1602 r = c->tasks->u.search.resultset;
1604 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1607 ZOOM_options_get(r->options, "elementSetName");
1608 smallSetElementSetName =
1609 ZOOM_options_get(r->options, "smallSetElementSetName");
1610 mediumSetElementSetName =
1611 ZOOM_options_get(r->options, "mediumSetElementSetName");
1613 if (!smallSetElementSetName)
1614 smallSetElementSetName = elementSetName;
1616 if (!mediumSetElementSetName)
1617 mediumSetElementSetName = elementSetName;
1622 /* prepare query for the search request */
1623 search_req->query = r->query->z_query;
1624 if (!search_req->query)
1626 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1627 return zoom_complete;
1629 if (r->query->z_query->which == Z_Query_type_1 ||
1630 r->query->z_query->which == Z_Query_type_101)
1632 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1635 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1638 search_req->query = yaz_copy_Z_Query(search_req->query,
1641 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1643 yaz_iconv_close(cd);
1647 search_req->databaseNames = r->databaseNames;
1648 search_req->num_databaseNames = r->num_databaseNames;
1650 /* get syntax (no need to provide unless piggyback is in effect) */
1651 syntax = c->tasks->u.search.syntax;
1653 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1654 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1655 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1656 if (lslb != -1 && ssub != -1 && mspn != -1)
1658 /* So're a Z39.50 expert? Let's hope you don't do sort */
1659 *search_req->largeSetLowerBound = lslb;
1660 *search_req->smallSetUpperBound = ssub;
1661 *search_req->mediumSetPresentNumber = mspn;
1663 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1664 && r->piggyback && !r->r_sort_spec && !r->schema)
1666 /* Regular piggyback - do it unless we're going to do sort */
1667 *search_req->largeSetLowerBound = 2000000000;
1668 *search_req->smallSetUpperBound = 1;
1669 *search_req->mediumSetPresentNumber =
1670 r->step>0 ? r->step : c->tasks->u.search.count;
1674 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1675 smallSetElementSetName = 0;
1676 mediumSetElementSetName = 0;
1679 if (smallSetElementSetName && *smallSetElementSetName)
1681 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1682 odr_malloc(c->odr_out, sizeof(*esn));
1684 esn->which = Z_ElementSetNames_generic;
1685 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1686 search_req->smallSetElementSetNames = esn;
1688 if (mediumSetElementSetName && *mediumSetElementSetName)
1690 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1691 odr_malloc(c->odr_out, sizeof(*esn));
1693 esn->which = Z_ElementSetNames_generic;
1694 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1695 search_req->mediumSetElementSetNames = esn;
1698 search_req->preferredRecordSyntax =
1699 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1703 if (c->support_named_resultsets)
1707 /* find the lowest unused ordinal so that we re-use
1708 result sets on the server. */
1709 for (ord = 1; ; ord++)
1712 sprintf(setname, "%d", ord);
1713 for (rp = c->resultsets; rp; rp = rp->next)
1714 if (rp->setname && !strcmp(rp->setname, setname))
1719 r->setname = xstrdup(setname);
1720 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1721 "set %s", c, r->setname);
1725 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1727 r->setname = xstrdup("default");
1729 ZOOM_options_set(r->options, "setname", r->setname);
1731 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1732 return send_APDU(c, apdu);
1735 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1737 char oid_name_buf[OID_STR_MAX];
1738 const char *oid_name;
1741 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1744 case Z_DefaultDiagFormat_v2Addinfo:
1745 addinfo = r->u.v2Addinfo;
1747 case Z_DefaultDiagFormat_v3Addinfo:
1748 addinfo = r->u.v3Addinfo;
1753 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1756 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1758 if (p->which != Z_DiagRec_defaultFormat)
1759 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1761 response_default_diag(c, p->u.defaultFormat);
1764 ZOOM_API(ZOOM_record)
1765 ZOOM_record_clone(ZOOM_record srec)
1772 odr_enc = odr_createmem(ODR_ENCODE);
1773 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1775 buf = odr_getbuf(odr_enc, &size, 0);
1777 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1778 nrec->odr = odr_createmem(ODR_DECODE);
1780 odr_setbuf(nrec->odr, buf, size, 0);
1781 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1783 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1784 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1785 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1786 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1787 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1788 odr_destroy(odr_enc);
1792 ZOOM_API(ZOOM_record)
1793 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1795 const char *syntax =
1796 ZOOM_options_get(s->options, "preferredRecordSyntax");
1797 const char *elementSetName =
1798 ZOOM_options_get(s->options, "elementSetName");
1800 return record_cache_lookup(s, pos, syntax, elementSetName);
1803 ZOOM_API(ZOOM_record)
1804 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1806 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1811 * MIKE: I think force_sync should always be zero, but I don't
1812 * want to make this change until I get the go-ahead from
1813 * Adam, in case something depends on the old synchronous
1817 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1818 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1819 rec = ZOOM_resultset_record_immediate(r, pos);
1825 ZOOM_record_destroy(ZOOM_record rec)
1830 wrbuf_destroy(rec->wrbuf);
1831 odr_destroy(rec->odr);
1836 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1843 strcpy(to, "UTF-8");
1844 if (record_charset && *record_charset)
1846 /* Use "from,to" or just "from" */
1847 const char *cp = strchr(record_charset, ',');
1848 int clen = strlen(record_charset);
1851 strncpy( to, cp+1, sizeof(to)-1);
1852 to[sizeof(to)-1] = '\0';
1853 clen = cp - record_charset;
1855 if (clen > sizeof(from)-1)
1856 clen = sizeof(from)-1;
1859 strncpy(from, record_charset, clen);
1863 cd = yaz_iconv_open(to, from);
1867 static const char *return_marc_record(ZOOM_record rec, int marc_type,
1869 const char *buf, int sz,
1870 const char *record_charset)
1872 yaz_iconv_t cd = iconv_create_charset(record_charset);
1873 yaz_marc_t mt = yaz_marc_create();
1874 const char *ret_string = 0;
1877 yaz_marc_iconv(mt, cd);
1878 yaz_marc_xml(mt, marc_type);
1880 rec->wrbuf = wrbuf_alloc();
1881 wrbuf_rewind(rec->wrbuf);
1882 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf) > 0)
1885 *len = wrbuf_len(rec->wrbuf);
1886 ret_string = wrbuf_cstr(rec->wrbuf);
1888 yaz_marc_destroy(mt);
1890 yaz_iconv_close(cd);
1894 static const char *return_opac_record(ZOOM_record rec, int marc_type,
1896 Z_OPACRecord *opac_rec,
1897 const char *record_charset)
1899 yaz_iconv_t cd = iconv_create_charset(record_charset);
1900 yaz_marc_t mt = yaz_marc_create();
1903 yaz_marc_iconv(mt, cd);
1904 yaz_marc_xml(mt, marc_type);
1907 rec->wrbuf = wrbuf_alloc();
1908 wrbuf_rewind(rec->wrbuf);
1910 yaz_opac_decode_wrbuf(mt, opac_rec, rec->wrbuf);
1911 yaz_marc_destroy(mt);
1914 yaz_iconv_close(cd);
1916 *len = wrbuf_len(rec->wrbuf);
1917 return wrbuf_cstr(rec->wrbuf);
1920 static const char *return_string_record(ZOOM_record rec, int *len,
1921 const char *buf, int sz,
1922 const char *record_charset)
1924 yaz_iconv_t cd = iconv_create_charset(record_charset);
1929 rec->wrbuf = wrbuf_alloc();
1931 wrbuf_rewind(rec->wrbuf);
1933 wrbuf_iconv_write(rec->wrbuf, cd, buf, sz);
1934 wrbuf_iconv_reset(rec->wrbuf, cd);
1936 buf = wrbuf_cstr(rec->wrbuf);
1937 sz = wrbuf_len(rec->wrbuf);
1938 yaz_iconv_close(cd);
1945 static const char *return_record(ZOOM_record rec, int *len,
1946 Z_NamePlusRecord *npr,
1947 int marctype, const char *charset)
1949 Z_External *r = (Z_External *) npr->u.databaseRecord;
1950 const Odr_oid *oid = r->direct_reference;
1952 /* render bibliographic record .. */
1953 if (r->which == Z_External_OPAC)
1955 return return_opac_record(rec, marctype, len,
1956 r->u.opac, charset);
1958 if (r->which == Z_External_sutrs)
1959 return return_string_record(rec, len,
1960 (char*) r->u.sutrs->buf,
1963 else if (r->which == Z_External_octet)
1965 if (yaz_oid_is_iso2709(oid))
1967 const char *ret_buf = return_marc_record(
1969 (const char *) r->u.octet_aligned->buf,
1970 r->u.octet_aligned->len,
1974 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
1975 if (marctype != YAZ_MARC_ISO2709)
1978 return return_string_record(rec, len,
1979 (const char *) r->u.octet_aligned->buf,
1980 r->u.octet_aligned->len,
1983 else if (r->which == Z_External_grs1)
1986 rec->wrbuf = wrbuf_alloc();
1987 wrbuf_rewind(rec->wrbuf);
1988 yaz_display_grs1(rec->wrbuf, r->u.grs1, 0);
1989 return return_string_record(rec, len,
1990 wrbuf_buf(rec->wrbuf),
1991 wrbuf_len(rec->wrbuf),
1999 ZOOM_record_error(ZOOM_record rec, const char **cp,
2000 const char **addinfo, const char **diagset)
2002 Z_NamePlusRecord *npr;
2011 *cp = rec->diag_message;
2013 *addinfo = rec->diag_details;
2015 *diagset = rec->diag_set;
2016 return uri_to_code(rec->diag_uri);
2018 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2020 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2021 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2022 const char *add = 0;
2024 if (diag_rec->which == Z_DiagRec_defaultFormat)
2026 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2029 error = *ddf->condition;
2032 case Z_DefaultDiagFormat_v2Addinfo:
2033 add = ddf->u.v2Addinfo;
2035 case Z_DefaultDiagFormat_v3Addinfo:
2036 add = ddf->u.v3Addinfo;
2041 yaz_oid_to_string(yaz_oid_std(),
2042 ddf->diagnosticSetId, &oclass);
2050 *addinfo = add ? add : "";
2052 *cp = diagbib1_str(error);
2058 ZOOM_API(const char *)
2059 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2066 Z_NamePlusRecord *npr;
2069 *len = 0; /* default return */
2078 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
2080 if (cp[i] == ';' || cp[i] == ' ')
2086 while (type_spec[i] == ';')
2089 while (type_spec[i] == ' ')
2091 if (!strncmp(type_spec+i, "charset=", 8))
2094 i = i + 8; /* skip charset= */
2095 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
2097 if (type_spec[i] == ';' || type_spec[i] == ' ')
2103 else if (!strncmp(type_spec+i, "xpath=", 6))
2107 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2111 while (type_spec[i] == ' ')
2114 if (!strcmp(type, "database"))
2117 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2118 return npr->databaseName;
2120 else if (!strcmp(type, "schema"))
2123 *len = rec->schema ? strlen(rec->schema) : 0;
2126 else if (!strcmp(type, "syntax"))
2128 const char *desc = 0;
2129 if (npr->which == Z_NamePlusRecord_databaseRecord)
2131 Z_External *r = (Z_External *) npr->u.databaseRecord;
2132 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2137 *len = strlen(desc);
2140 if (npr->which != Z_NamePlusRecord_databaseRecord)
2143 /* from now on - we have a database record .. */
2144 if (!strcmp(type, "render"))
2146 return return_record(rec, len, npr, YAZ_MARC_LINE, charset);
2148 else if (!strcmp(type, "xml"))
2150 return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2152 else if (!strcmp(type, "raw"))
2154 return return_record(rec, len, npr, YAZ_MARC_ISO2709, charset);
2156 else if (!strcmp(type, "ext"))
2159 return (const char *) npr->u.databaseRecord;
2161 else if (!strcmp(type, "opac"))
2163 if (npr->u.databaseRecord->which == Z_External_OPAC)
2164 return return_record(rec, len, npr, YAZ_MARC_MARCXML, charset);
2169 static int strcmp_null(const char *v1, const char *v2)
2175 return strcmp(v1, v2);
2178 static size_t record_hash(int pos)
2182 return pos % RECORD_HASH_SIZE;
2185 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2187 const char *syntax, const char *elementSetName,
2189 Z_SRW_diagnostic *diag)
2191 ZOOM_record_cache rc = 0;
2193 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2194 ZOOM_connection_put_event(r->connection, event);
2196 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2199 && strcmp_null(r->schema, rc->schema) == 0
2200 && strcmp_null(elementSetName,rc->elementSetName) == 0
2201 && strcmp_null(syntax, rc->syntax) == 0)
2206 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2209 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2211 rc->syntax = odr_strdup_null(r->odr, syntax);
2213 rc->schema = odr_strdup_null(r->odr, r->schema);
2216 rc->next = r->record_hash[record_hash(pos)];
2217 r->record_hash[record_hash(pos)] = rc;
2220 rc->rec.schema = odr_strdup_null(r->odr, schema);
2221 rc->rec.diag_set = 0;
2222 rc->rec.diag_uri = 0;
2223 rc->rec.diag_message = 0;
2224 rc->rec.diag_details = 0;
2230 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2231 if ((cp = strrchr(rc->rec.diag_set, '/')))
2233 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2235 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2236 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2240 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2242 const char *elementSetName)
2244 ZOOM_record_cache rc;
2246 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2250 if (strcmp_null(r->schema, rc->schema))
2252 if (strcmp_null(elementSetName,rc->elementSetName))
2254 if (strcmp_null(syntax, rc->syntax))
2262 static void handle_records(ZOOM_connection c, Z_Records *sr,
2265 ZOOM_resultset resultset;
2267 const char *syntax = 0, *elementSetName = 0;
2271 switch (c->tasks->which)
2273 case ZOOM_TASK_SEARCH:
2274 resultset = c->tasks->u.search.resultset;
2275 start = &c->tasks->u.search.start;
2276 count = &c->tasks->u.search.count;
2277 syntax = c->tasks->u.search.syntax;
2278 elementSetName = c->tasks->u.search.elementSetName;
2280 case ZOOM_TASK_RETRIEVE:
2281 resultset = c->tasks->u.retrieve.resultset;
2282 start = &c->tasks->u.retrieve.start;
2283 count = &c->tasks->u.retrieve.count;
2284 syntax = c->tasks->u.retrieve.syntax;
2285 elementSetName = c->tasks->u.retrieve.elementSetName;
2290 if (sr && sr->which == Z_Records_NSD)
2291 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2292 else if (sr && sr->which == Z_Records_multipleNSD)
2294 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2295 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2297 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2301 if (*count + *start > resultset->size)
2302 *count = resultset->size - *start;
2305 if (sr && sr->which == Z_Records_DBOSD)
2308 NMEM nmem = odr_extract_mem(c->odr_in);
2309 Z_NamePlusRecordList *p =
2310 sr->u.databaseOrSurDiagnostics;
2311 for (i = 0; i<p->num_records; i++)
2313 record_cache_add(resultset, p->records[i], i + *start,
2314 syntax, elementSetName,
2321 yaz_log(log_details,
2322 "handle_records resultset=%p start=%d count=%d",
2323 resultset, *start, *count);
2325 /* transfer our response to search_nmem .. we need it later */
2326 nmem_transfer(odr_getmem(resultset->odr), nmem);
2328 if (present_phase && p->num_records == 0)
2330 /* present response and we didn't get any records! */
2331 Z_NamePlusRecord *myrec =
2332 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2333 record_cache_add(resultset, myrec, *start,
2334 syntax, elementSetName, 0, 0);
2337 else if (present_phase)
2339 /* present response and we didn't get any records! */
2340 Z_NamePlusRecord *myrec =
2341 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2342 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2348 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2350 handle_records(c, pr->records, 1);
2353 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2356 switch (term->which)
2358 case Z_Term_general:
2359 ZOOM_options_setl(opt, name,
2360 (const char *)(term->u.general->buf),
2361 term->u.general->len);
2363 case Z_Term_characterString:
2364 ZOOM_options_set(opt, name, term->u.characterString);
2366 case Z_Term_numeric:
2367 ZOOM_options_set_int(opt, name, *term->u.numeric);
2372 static void handle_queryExpression(ZOOM_options opt, const char *name,
2373 Z_QueryExpression *exp)
2379 case Z_QueryExpression_term:
2380 if (exp->u.term && exp->u.term->queryTerm)
2382 sprintf(opt_name, "%s.term", name);
2383 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2386 case Z_QueryExpression_query:
2391 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2392 Z_OtherInformation *o)
2395 for (i = 0; o && i < o->num_elements; i++)
2397 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2399 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2401 if (ext->which == Z_External_searchResult1)
2404 Z_SearchInfoReport *sr = ext->u.searchResult1;
2407 ZOOM_options_set_int(
2408 resultset->options, "searchresult.size", sr->num);
2410 for (j = 0; j < sr->num; j++)
2412 Z_SearchInfoReport_s *ent =
2413 ext->u.searchResult1->elements[j];
2416 sprintf(pref, "searchresult.%d", j);
2418 if (ent->subqueryId)
2421 sprintf(opt_name, "%s.id", pref);
2422 ZOOM_options_set(resultset->options, opt_name,
2425 if (ent->subqueryExpression)
2428 sprintf(opt_name, "%s.subquery", pref);
2429 handle_queryExpression(resultset->options, opt_name,
2430 ent->subqueryExpression);
2432 if (ent->subqueryInterpretation)
2435 sprintf(opt_name, "%s.interpretation", pref);
2436 handle_queryExpression(resultset->options, opt_name,
2437 ent->subqueryInterpretation);
2439 if (ent->subqueryRecommendation)
2442 sprintf(opt_name, "%s.recommendation", pref);
2443 handle_queryExpression(resultset->options, opt_name,
2444 ent->subqueryRecommendation);
2446 if (ent->subqueryCount)
2449 sprintf(opt_name, "%s.count", pref);
2450 ZOOM_options_set_int(resultset->options, opt_name,
2451 *ent->subqueryCount);
2459 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2461 ZOOM_resultset resultset;
2464 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2467 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2468 ZOOM_connection_put_event(c, event);
2470 resultset = c->tasks->u.search.resultset;
2472 if (sr->resultSetStatus)
2474 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2475 *sr->resultSetStatus);
2477 if (sr->presentStatus)
2479 ZOOM_options_set_int(resultset->options, "presentStatus",
2480 *sr->presentStatus);
2482 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2484 resultset->size = *sr->resultCount;
2485 handle_records(c, sr->records, 0);
2488 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2490 if (res->diagnostics && res->num_diagnostics > 0)
2491 response_diag(c, res->diagnostics[0]);
2494 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2496 NMEM nmem = odr_extract_mem(c->odr_in);
2499 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2501 scan = c->tasks->u.scan.scan;
2503 if (res->entries && res->entries->nonsurrogateDiagnostics)
2504 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2505 scan->scan_response = res;
2506 scan->srw_scan_response = 0;
2507 nmem_transfer(odr_getmem(scan->odr), nmem);
2509 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2510 if (res->positionOfTerm)
2511 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2512 if (res->scanStatus)
2513 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2514 if (res->numberOfEntriesReturned)
2515 ZOOM_options_set_int(scan->options, "number",
2516 *res->numberOfEntriesReturned);
2521 static zoom_ret send_sort(ZOOM_connection c,
2522 ZOOM_resultset resultset)
2525 resultset->r_sort_spec = 0;
2526 if (resultset->r_sort_spec)
2528 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2529 Z_SortRequest *req = apdu->u.sortRequest;
2531 req->num_inputResultSetNames = 1;
2532 req->inputResultSetNames = (Z_InternationalString **)
2533 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2534 req->inputResultSetNames[0] =
2535 odr_strdup(c->odr_out, resultset->setname);
2536 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2537 req->sortSequence = resultset->r_sort_spec;
2538 resultset->r_sort_spec = 0;
2539 return send_APDU(c, apdu);
2541 return zoom_complete;
2544 static zoom_ret send_present(ZOOM_connection c)
2547 Z_PresentRequest *req = 0;
2549 const char *syntax = 0;
2550 const char *elementSetName = 0;
2551 ZOOM_resultset resultset;
2556 yaz_log(log_details, "%p send_present no tasks", c);
2557 return zoom_complete;
2560 switch (c->tasks->which)
2562 case ZOOM_TASK_SEARCH:
2563 resultset = c->tasks->u.search.resultset;
2564 start = &c->tasks->u.search.start;
2565 count = &c->tasks->u.search.count;
2566 syntax = c->tasks->u.search.syntax;
2567 elementSetName = c->tasks->u.search.elementSetName;
2569 case ZOOM_TASK_RETRIEVE:
2570 resultset = c->tasks->u.retrieve.resultset;
2571 start = &c->tasks->u.retrieve.start;
2572 count = &c->tasks->u.retrieve.count;
2573 syntax = c->tasks->u.retrieve.syntax;
2574 elementSetName = c->tasks->u.retrieve.elementSetName;
2577 return zoom_complete;
2579 yaz_log(log_details, "%p send_present start=%d count=%d",
2582 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2584 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2587 if (c->error) /* don't continue on error */
2588 return zoom_complete;
2589 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2590 resultset, *start, *count);
2592 for (i = 0; i < *count; i++)
2595 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2600 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2601 ZOOM_connection_put_event(c, event);
2609 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2610 return zoom_complete;
2613 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2614 req = apdu->u.presentRequest;
2617 yaz_log(log_details, "%p send_present skip=%d", c, i);
2619 *req->resultSetStartPoint = *start + 1;
2621 if (resultset->step > 0 && resultset->step < *count)
2622 *req->numberOfRecordsRequested = resultset->step;
2624 *req->numberOfRecordsRequested = *count;
2626 if (*req->numberOfRecordsRequested + *start > resultset->size)
2627 *req->numberOfRecordsRequested = resultset->size - *start;
2628 assert(*req->numberOfRecordsRequested > 0);
2630 if (syntax && *syntax)
2631 req->preferredRecordSyntax =
2632 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2634 if (resultset->schema && *resultset->schema)
2636 Z_RecordComposition *compo = (Z_RecordComposition *)
2637 odr_malloc(c->odr_out, sizeof(*compo));
2639 req->recordComposition = compo;
2640 compo->which = Z_RecordComp_complex;
2641 compo->u.complex = (Z_CompSpec *)
2642 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2643 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2644 odr_malloc(c->odr_out, sizeof(bool_t));
2645 *compo->u.complex->selectAlternativeSyntax = 0;
2647 compo->u.complex->generic = (Z_Specification *)
2648 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2650 compo->u.complex->generic->which = Z_Schema_oid;
2651 compo->u.complex->generic->schema.oid = (Odr_oid *)
2652 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2654 if (!compo->u.complex->generic->schema.oid)
2656 /* OID wasn't a schema! Try record syntax instead. */
2658 compo->u.complex->generic->schema.oid = (Odr_oid *)
2659 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2661 if (elementSetName && *elementSetName)
2663 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2664 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2665 compo->u.complex->generic->elementSpec->which =
2666 Z_ElementSpec_elementSetName;
2667 compo->u.complex->generic->elementSpec->u.elementSetName =
2668 odr_strdup(c->odr_out, elementSetName);
2671 compo->u.complex->generic->elementSpec = 0;
2672 compo->u.complex->num_dbSpecific = 0;
2673 compo->u.complex->dbSpecific = 0;
2674 compo->u.complex->num_recordSyntax = 0;
2675 compo->u.complex->recordSyntax = 0;
2677 else if (elementSetName && *elementSetName)
2679 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2680 odr_malloc(c->odr_out, sizeof(*esn));
2681 Z_RecordComposition *compo = (Z_RecordComposition *)
2682 odr_malloc(c->odr_out, sizeof(*compo));
2684 esn->which = Z_ElementSetNames_generic;
2685 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2686 compo->which = Z_RecordComp_simple;
2687 compo->u.simple = esn;
2688 req->recordComposition = compo;
2690 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2691 return send_APDU(c, apdu);
2694 ZOOM_API(ZOOM_scanset)
2695 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2698 ZOOM_query q = ZOOM_query_create();
2700 ZOOM_query_prefix(q, start);
2702 s = ZOOM_connection_scan1(c, q);
2703 ZOOM_query_destroy(q);
2708 ZOOM_API(ZOOM_scanset)
2709 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2711 ZOOM_scanset scan = 0;
2715 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2716 scan->connection = c;
2717 scan->odr = odr_createmem(ODR_DECODE);
2718 scan->options = ZOOM_options_create_with_parent(c->options);
2720 scan->scan_response = 0;
2721 scan->srw_scan_response = 0;
2725 scan->databaseNames = set_DatabaseNames(c, c->options,
2726 &scan->num_databaseNames,
2731 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2732 task->u.scan.scan = scan;
2737 while (ZOOM_event(1, &c))
2745 ZOOM_scanset_destroy(ZOOM_scanset scan)
2750 if (scan->refcount == 0)
2752 ZOOM_query_destroy(scan->query);
2754 odr_destroy(scan->odr);
2756 ZOOM_options_destroy(scan->options);
2761 static zoom_ret send_package(ZOOM_connection c)
2765 yaz_log(log_details, "%p send_package", c);
2767 return zoom_complete;
2768 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2770 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2771 ZOOM_connection_put_event(c, event);
2773 c->buf_out = c->tasks->u.package->buf_out;
2774 c->len_out = c->tasks->u.package->len_out;
2779 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2782 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2783 Z_ScanRequest *req = apdu->u.scanRequest;
2785 yaz_log(log_details, "%p send_scan", c);
2787 return zoom_complete;
2788 assert (c->tasks->which == ZOOM_TASK_SCAN);
2789 scan = c->tasks->u.scan.scan;
2791 /* Z39.50 scan can only carry RPN */
2792 if (scan->query->z_query->which == Z_Query_type_1 ||
2793 scan->query->z_query->which == Z_Query_type_101)
2795 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2796 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2799 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2802 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2804 yaz_query_charset_convert_rpnquery(
2805 rpn, c->odr_out, cd);
2806 yaz_iconv_close(cd);
2809 req->attributeSet = rpn->attributeSetId;
2810 if (!req->attributeSet)
2811 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2812 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2813 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2815 req->termListAndStartPoint =
2816 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2820 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2821 return zoom_complete;
2826 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2827 return zoom_complete;
2830 *req->numberOfTermsRequested =
2831 ZOOM_options_get_int(scan->options, "number", 10);
2833 req->preferredPositionInResponse =
2834 odr_intdup(c->odr_out,
2835 ZOOM_options_get_int(scan->options, "position", 1));
2838 odr_intdup(c->odr_out,
2839 ZOOM_options_get_int(scan->options, "stepSize", 0));
2841 req->databaseNames = scan->databaseNames;
2842 req->num_databaseNames = scan->num_databaseNames;
2844 return send_APDU(c, apdu);
2848 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2852 const char *option_val = 0;
2855 return zoom_complete;
2856 assert (c->tasks->which == ZOOM_TASK_SCAN);
2857 scan = c->tasks->u.scan.scan;
2859 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2861 /* SRU scan can only carry CQL and PQF */
2862 if (scan->query->z_query->which == Z_Query_type_104)
2864 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2865 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2867 else if (scan->query->z_query->which == Z_Query_type_1
2868 || scan->query->z_query->which == Z_Query_type_101)
2870 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2871 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2875 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2876 return zoom_complete;
2879 sr->u.scan_request->maximumTerms = odr_intdup(
2880 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2882 sr->u.scan_request->responsePosition = odr_intdup(
2883 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2885 option_val = ZOOM_options_get(scan->options, "extraArgs");
2886 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2887 return send_srw(c, sr);
2890 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2892 return zoom_complete;
2898 ZOOM_scanset_size(ZOOM_scanset scan)
2903 if (scan->scan_response && scan->scan_response->entries)
2904 return scan->scan_response->entries->num_entries;
2905 else if (scan->srw_scan_response)
2906 return scan->srw_scan_response->num_terms;
2910 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2912 const char **value_term, size_t *value_len,
2913 const char **disp_term, size_t *disp_len)
2915 size_t noent = ZOOM_scanset_size(scan);
2924 if (pos >= noent || pos < 0)
2926 if (scan->scan_response)
2928 Z_ScanResponse *res = scan->scan_response;
2929 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2931 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2933 *value_term = (const char *) t->term->u.general->buf;
2934 *value_len = t->term->u.general->len;
2937 *disp_term = t->displayTerm;
2938 *disp_len = strlen(*disp_term);
2940 else if (t->term->which == Z_Term_general)
2942 *disp_term = (const char *) t->term->u.general->buf;
2943 *disp_len = t->term->u.general->len;
2945 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2948 if (scan->srw_scan_response)
2950 Z_SRW_scanResponse *res = scan->srw_scan_response;
2951 Z_SRW_scanTerm *t = res->terms + pos;
2954 *value_term = t->value;
2955 *value_len = strlen(*value_term);
2958 *disp_term = t->displayTerm;
2960 *disp_term = t->value;
2961 *disp_len = strlen(*disp_term);
2962 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
2967 ZOOM_API(const char *)
2968 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2971 const char *value_term = 0;
2972 size_t value_len = 0;
2973 const char *disp_term = 0;
2974 size_t disp_len = 0;
2976 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2977 &disp_term, &disp_len);
2983 ZOOM_API(const char *)
2984 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2987 const char *value_term = 0;
2988 size_t value_len = 0;
2989 const char *disp_term = 0;
2990 size_t disp_len = 0;
2992 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2993 &disp_term, &disp_len);
2999 ZOOM_API(const char *)
3000 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3002 return ZOOM_options_get(scan->options, key);
3006 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3009 ZOOM_options_set(scan->options, key, val);
3012 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3015 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3016 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3018 str = ZOOM_options_get(p->options, "package-name");
3020 req->packageName = odr_strdup(p->odr_out, str);
3022 str = ZOOM_options_get(p->options, "user-id");
3024 req->userId = odr_strdup_null(p->odr_out, str);
3026 req->packageType = odr_oiddup(p->odr_out, oid);
3028 str = ZOOM_options_get(p->options, "function");
3031 if (!strcmp (str, "create"))
3032 *req->function = Z_ExtendedServicesRequest_create;
3033 if (!strcmp (str, "delete"))
3034 *req->function = Z_ExtendedServicesRequest_delete;
3035 if (!strcmp (str, "modify"))
3036 *req->function = Z_ExtendedServicesRequest_modify;
3039 str = ZOOM_options_get(p->options, "waitAction");
3042 if (!strcmp (str, "wait"))
3043 *req->waitAction = Z_ExtendedServicesRequest_wait;
3044 if (!strcmp (str, "waitIfPossible"))
3045 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3046 if (!strcmp (str, "dontWait"))
3047 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3048 if (!strcmp (str, "dontReturnPackage"))
3049 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3054 static const char *ill_array_lookup(void *clientData, const char *idx)
3056 ZOOM_package p = (ZOOM_package) clientData;
3057 return ZOOM_options_get(p->options, idx+4);
3060 static Z_External *encode_ill_request(ZOOM_package p)
3062 ODR out = p->odr_out;
3065 struct ill_get_ctl ctl;
3067 ctl.odr = p->odr_out;
3069 ctl.f = ill_array_lookup;
3071 req = ill_get_ILLRequest(&ctl, "ill", 0);
3073 if (!ill_Request(out, &req, 0, 0))
3075 int ill_request_size;
3076 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3077 if (ill_request_buf)
3078 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3083 int illRequest_size = 0;
3084 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3086 r = (Z_External *) odr_malloc(out, sizeof(*r));
3087 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3088 r->indirect_reference = 0;
3090 r->which = Z_External_single;
3092 r->u.single_ASN1_type =
3093 odr_create_Odr_oct(out,
3094 (unsigned char *)illRequest_buf,
3100 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3102 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3106 req->which = Z_IOItemOrder_esRequest;
3107 req->u.esRequest = (Z_IORequest *)
3108 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3110 /* to keep part ... */
3111 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3112 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3113 req->u.esRequest->toKeep->supplDescription = 0;
3114 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3115 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3117 str = ZOOM_options_get(p->options, "contact-name");
3118 req->u.esRequest->toKeep->contact->name =
3119 odr_strdup_null(p->odr_out, str);
3121 str = ZOOM_options_get(p->options, "contact-phone");
3122 req->u.esRequest->toKeep->contact->phone =
3123 odr_strdup_null(p->odr_out, str);
3125 str = ZOOM_options_get(p->options, "contact-email");
3126 req->u.esRequest->toKeep->contact->email =
3127 odr_strdup_null(p->odr_out, str);
3129 req->u.esRequest->toKeep->addlBilling = 0;
3131 /* not to keep part ... */
3132 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3133 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3135 str = ZOOM_options_get(p->options, "itemorder-setname");
3140 req->u.esRequest->notToKeep->resultSetItem = 0;
3143 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3144 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3146 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3147 odr_strdup(p->odr_out, str);
3148 req->u.esRequest->notToKeep->resultSetItem->item =
3149 odr_intdup(p->odr_out, 0);
3151 str = ZOOM_options_get(p->options, "itemorder-item");
3152 *req->u.esRequest->notToKeep->resultSetItem->item =
3153 (str ? atoi(str) : 1);
3156 str = ZOOM_options_getl(p->options, "doc", &len);
3159 req->u.esRequest->notToKeep->itemRequest =
3160 z_ext_record_xml(p->odr_out, str, len);
3163 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3168 Z_APDU *create_admin_package(ZOOM_package p, int type,
3169 Z_ESAdminOriginPartToKeep **toKeepP,
3170 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3172 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3175 Z_ESAdminOriginPartToKeep *toKeep;
3176 Z_ESAdminOriginPartNotToKeep *notToKeep;
3177 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3178 const char *first_db = "Default";
3180 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3185 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3187 r->indirect_reference = 0;
3188 r->which = Z_External_ESAdmin;
3190 r->u.adminService = (Z_Admin *)
3191 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3192 r->u.adminService->which = Z_Admin_esRequest;
3193 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3194 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3196 toKeep = r->u.adminService->u.esRequest->toKeep =
3197 (Z_ESAdminOriginPartToKeep *)
3198 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3199 toKeep->which = type;
3200 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3201 toKeep->u.create = odr_nullval();
3202 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3204 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3205 (Z_ESAdminOriginPartNotToKeep *)
3206 odr_malloc(p->odr_out,
3207 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3208 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3209 notToKeep->u.recordsWillFollow = odr_nullval();
3213 *notToKeepP = notToKeep;
3218 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3220 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3221 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3222 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3224 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3232 req->taskSpecificParameters = ext;
3233 ext->direct_reference = req->packageType;
3234 ext->descriptor = 0;
3235 ext->indirect_reference = 0;
3237 ext->which = Z_External_octet;
3238 ext->u.single_ASN1_type =
3239 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3243 static Z_APDU *create_update_package(ZOOM_package p)
3246 const char *first_db = "Default";
3248 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3249 const char *action = ZOOM_options_get(p->options, "action");
3250 int recordIdOpaque_len;
3251 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3252 &recordIdOpaque_len);
3253 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3255 const char *record_buf = ZOOM_options_getl(p->options, "record",
3257 int recordOpaque_len;
3258 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3260 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3261 const char *version = ZOOM_options_get(p->options, "updateVersion");
3263 const char *correlationInfo_note =
3264 ZOOM_options_get(p->options, "correlationInfo.note");
3265 const char *correlationInfo_id =
3266 ZOOM_options_get(p->options, "correlationInfo.id");
3268 Odr_oid *syntax_oid = 0;
3269 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3275 if (!record_buf && !recordOpaque_buf)
3277 record_buf = "void";
3279 syntax_str = "SUTRS";
3284 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3285 CLASS_RECSYN, syntax_str,
3297 package_oid = yaz_oid_extserv_database_update_first_version;
3298 /* old update does not support specialUpdate */
3300 action = "recordInsert";
3304 action = "specialUpdate";
3305 package_oid = yaz_oid_extserv_database_update_second_version;
3309 action = "specialUpdate";
3310 package_oid = yaz_oid_extserv_database_update;
3316 if (!strcmp(action, "recordInsert"))
3317 action_no = Z_IUOriginPartToKeep_recordInsert;
3318 else if (!strcmp(action, "recordReplace"))
3319 action_no = Z_IUOriginPartToKeep_recordReplace;
3320 else if (!strcmp(action, "recordDelete"))
3321 action_no = Z_IUOriginPartToKeep_recordDelete;
3322 else if (!strcmp(action, "elementUpdate"))
3323 action_no = Z_IUOriginPartToKeep_elementUpdate;
3324 else if (!strcmp(action, "specialUpdate"))
3325 action_no = Z_IUOriginPartToKeep_specialUpdate;
3329 apdu = create_es_package(p, package_oid);
3332 Z_IUOriginPartToKeep *toKeep;
3333 Z_IUSuppliedRecords *notToKeep;
3334 Z_External *r = (Z_External *)
3335 odr_malloc(p->odr_out, sizeof(*r));
3336 const char *elementSetName =
3337 ZOOM_options_get(p->options, "elementSetName");
3339 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3341 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3343 r->which = Z_External_update;
3344 r->indirect_reference = 0;
3345 r->u.update = (Z_IUUpdate *)
3346 odr_malloc(p->odr_out, sizeof(*r->u.update));
3348 r->u.update->which = Z_IUUpdate_esRequest;
3349 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3350 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3351 toKeep = r->u.update->u.esRequest->toKeep =
3352 (Z_IUOriginPartToKeep *)
3353 odr_malloc(p->odr_out, sizeof(*toKeep));
3355 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3358 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3360 toKeep->actionQualifier = 0;
3361 toKeep->action = odr_intdup(p->odr_out, action_no);
3363 notToKeep = r->u.update->u.esRequest->notToKeep =
3364 (Z_IUSuppliedRecords *)
3365 odr_malloc(p->odr_out, sizeof(*notToKeep));
3367 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3368 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3369 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3370 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3371 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3374 notToKeep->elements[0]->u.opaque =
3375 odr_create_Odr_oct(p->odr_out,
3376 (const unsigned char *) recordIdOpaque,
3377 recordIdOpaque_len);
3379 else if (recordIdNumber)
3381 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3383 notToKeep->elements[0]->u.number =
3384 odr_intdup(p->odr_out, atoi(recordIdNumber));
3387 notToKeep->elements[0]->u.opaque = 0;
3388 notToKeep->elements[0]->supplementalId = 0;
3389 if (correlationInfo_note || correlationInfo_id)
3391 Z_IUCorrelationInfo *ci;
3392 ci = notToKeep->elements[0]->correlationInfo =
3393 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3394 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3395 ci->id = correlationInfo_id ?
3396 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3399 notToKeep->elements[0]->correlationInfo = 0;
3400 if (recordOpaque_buf)
3402 notToKeep->elements[0]->record =
3403 z_ext_record_oid_any(p->odr_out, syntax_oid,
3404 recordOpaque_buf, recordOpaque_len);
3408 notToKeep->elements[0]->record =
3409 z_ext_record_oid(p->odr_out, syntax_oid,
3410 record_buf, record_len);
3415 ODR print = odr_createmem(ODR_PRINT);
3417 z_APDU(print, &apdu, 0, 0);
3424 ZOOM_package_send(ZOOM_package p, const char *type)
3431 odr_reset(p->odr_out);
3434 if (!strcmp(type, "itemorder"))
3436 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3439 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3441 r->direct_reference =
3442 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3444 r->which = Z_External_itemOrder;
3445 r->indirect_reference = 0;
3446 r->u.itemOrder = encode_item_order(p);
3448 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3451 else if (!strcmp(type, "create")) /* create database */
3453 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3456 else if (!strcmp(type, "drop")) /* drop database */
3458 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3461 else if (!strcmp(type, "commit")) /* commit changes */
3463 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3466 else if (!strcmp(type, "update")) /* update record(s) */
3468 apdu = create_update_package(p);
3470 else if (!strcmp(type, "xmlupdate"))
3472 apdu = create_xmlupdate_package(p);
3476 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3480 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3481 task->u.package = p;
3482 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3483 p->buf_out = (char *) xmalloc(p->len_out);
3484 memcpy(p->buf_out, buf, p->len_out);
3489 while (ZOOM_event(1, &c))
3496 ZOOM_API(ZOOM_package)
3497 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3499 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3502 p->odr_out = odr_createmem(ODR_ENCODE);
3503 p->options = ZOOM_options_create_with_parent2(options, c->options);
3511 ZOOM_package_destroy(ZOOM_package p)
3516 if (p->refcount == 0)
3518 odr_destroy(p->odr_out);
3521 ZOOM_options_destroy(p->options);
3526 ZOOM_API(const char *)
3527 ZOOM_package_option_get(ZOOM_package p, const char *key)
3529 return ZOOM_options_get(p->options, key);
3532 ZOOM_API(const char *)
3533 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3535 return ZOOM_options_getl(p->options, key, lenp);
3539 ZOOM_package_option_set(ZOOM_package p, const char *key,
3542 ZOOM_options_set(p->options, key, val);
3546 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3547 const char *val, int len)
3549 ZOOM_options_setl(p->options, key, val, len);
3552 static int ZOOM_connection_exec_task(ZOOM_connection c)
3554 ZOOM_task task = c->tasks;
3555 zoom_ret ret = zoom_complete;
3559 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3560 c, task->which, task->running);
3561 if (c->error != ZOOM_ERROR_NONE)
3563 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3564 "removing tasks because of error = %d", c, c->error);
3565 ZOOM_connection_remove_tasks(c);
3570 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3571 "task already running", c);
3575 ret = zoom_complete;
3576 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3578 switch (task->which)
3580 case ZOOM_TASK_SEARCH:
3581 if (c->proto == PROTO_HTTP)
3582 ret = ZOOM_connection_srw_send_search(c);
3584 ret = ZOOM_connection_send_search(c);
3586 case ZOOM_TASK_RETRIEVE:
3587 if (c->proto == PROTO_HTTP)
3588 ret = ZOOM_connection_srw_send_search(c);
3590 ret = send_present(c);
3592 case ZOOM_TASK_CONNECT:
3593 ret = do_connect(c);
3595 case ZOOM_TASK_SCAN:
3596 if (c->proto == PROTO_HTTP)
3597 ret = ZOOM_connection_srw_send_scan(c);
3599 ret = ZOOM_connection_send_scan(c);
3601 case ZOOM_TASK_PACKAGE:
3602 ret = send_package(c);
3604 case ZOOM_TASK_SORT:
3605 c->tasks->u.sort.resultset->r_sort_spec =
3606 c->tasks->u.sort.q->sort_spec;
3607 ret = send_sort(c, c->tasks->u.sort.resultset);
3613 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3614 "remove tasks because no connection exist", c);
3615 ZOOM_connection_remove_tasks(c);
3617 if (ret == zoom_complete)
3619 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3620 "task removed (complete)", c);
3621 ZOOM_connection_remove_task(c);
3624 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3629 static zoom_ret send_sort_present(ZOOM_connection c)
3631 zoom_ret r = zoom_complete;
3633 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3634 r = send_sort(c, c->tasks->u.search.resultset);
3635 if (r == zoom_complete)
3636 r = send_present(c);
3640 static int es_response_taskpackage_update(ZOOM_connection c,
3641 Z_IUUpdateTaskPackage *utp)
3643 if (utp && utp->targetPart)
3645 Z_IUTargetPart *targetPart = utp->targetPart;
3646 switch ( *targetPart->updateStatus ) {
3647 case Z_IUTargetPart_success:
3648 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3650 case Z_IUTargetPart_partial:
3651 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3653 case Z_IUTargetPart_failure:
3654 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3655 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3656 response_diag(c, targetPart->globalDiagnostics[0]);
3659 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3664 static int es_response_taskpackage(ZOOM_connection c,
3665 Z_TaskPackage *taskPackage)
3668 Odr_oct *id = taskPackage->targetReference;
3670 ZOOM_options_setl(c->tasks->u.package->options,
3671 "targetReference", (char*) id->buf, id->len);
3674 switch ( *taskPackage->taskStatus ) {
3675 case Z_TaskPackage_pending:
3676 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3678 case Z_TaskPackage_active:
3679 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3681 case Z_TaskPackage_complete:
3682 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3684 case Z_TaskPackage_aborted:
3685 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3686 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3687 response_diag(c, taskPackage->packageDiagnostics[0]);
3691 // taskSpecificParameters
3692 // NOTE: Only Update implemented, no others.
3693 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3694 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3695 es_response_taskpackage_update(c, utp);
3701 static int es_response(ZOOM_connection c,
3702 Z_ExtendedServicesResponse *res)
3704 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3706 switch (*res->operationStatus) {
3707 case Z_ExtendedServicesResponse_done:
3708 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3710 case Z_ExtendedServicesResponse_accepted:
3711 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3713 case Z_ExtendedServicesResponse_failure:
3714 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3715 if (res->diagnostics && res->num_diagnostics > 0)
3716 response_diag(c, res->diagnostics[0]);
3719 if (res->taskPackage &&
3720 res->taskPackage->which == Z_External_extendedService)
3722 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3723 es_response_taskpackage(c, taskPackage);
3725 if (res->taskPackage &&
3726 res->taskPackage->which == Z_External_octet)
3728 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3729 ZOOM_options_setl(c->tasks->u.package->options,
3730 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3735 static void interpret_init_diag(ZOOM_connection c,
3736 Z_DiagnosticFormat *diag)
3740 Z_DiagnosticFormat_s *ds = diag->elements[0];
3741 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3742 response_default_diag(c, ds->u.defaultDiagRec);
3747 static void interpret_otherinformation_field(ZOOM_connection c,
3748 Z_OtherInformation *ui)
3751 for (i = 0; i < ui->num_elements; i++)
3753 Z_OtherInformationUnit *unit = ui->list[i];
3754 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3755 unit->information.externallyDefinedInfo &&
3756 unit->information.externallyDefinedInfo->which ==
3759 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3765 static void set_init_option(const char *name, void *clientData) {
3766 ZOOM_connection c = (ZOOM_connection) clientData;
3769 sprintf(buf, "init_opt_%.70s", name);
3770 ZOOM_connection_option_set(c, buf, "1");
3774 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3776 Z_InitResponse *initrs;
3778 ZOOM_connection_set_mask(c, 0);
3779 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3782 case Z_APDU_initResponse:
3783 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3784 initrs = apdu->u.initResponse;
3785 ZOOM_connection_option_set(c, "serverImplementationId",
3786 initrs->implementationId ?
3787 initrs->implementationId : "");
3788 ZOOM_connection_option_set(c, "serverImplementationName",
3789 initrs->implementationName ?
3790 initrs->implementationName : "");
3791 ZOOM_connection_option_set(c, "serverImplementationVersion",
3792 initrs->implementationVersion ?
3793 initrs->implementationVersion : "");
3794 /* Set the three old options too, for old applications */
3795 ZOOM_connection_option_set(c, "targetImplementationId",
3796 initrs->implementationId ?
3797 initrs->implementationId : "");
3798 ZOOM_connection_option_set(c, "targetImplementationName",
3799 initrs->implementationName ?
3800 initrs->implementationName : "");
3801 ZOOM_connection_option_set(c, "targetImplementationVersion",
3802 initrs->implementationVersion ?
3803 initrs->implementationVersion : "");
3805 /* Make initrs->options available as ZOOM-level options */
3806 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3808 if (!*initrs->result)
3810 Z_External *uif = initrs->userInformationField;
3812 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3814 if (uif && uif->which == Z_External_userInfo1)
3815 interpret_otherinformation_field(c, uif->u.userInfo1);
3820 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3821 yaz_oid_userinfo_cookie, 1, 0);
3822 xfree(c->cookie_in);
3825 c->cookie_in = xstrdup(cookie);
3826 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3827 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3828 c->support_named_resultsets = 1;
3831 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3832 ZOOM_connection_remove_task(c);
3834 ZOOM_connection_exec_task(c);
3836 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3838 NMEM tmpmem = nmem_create();
3839 Z_CharSetandLanguageNegotiation *p =
3840 yaz_get_charneg_record(initrs->otherInfo);
3844 char *charset = NULL, *lang = NULL;
3847 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3848 yaz_log(log_details, "%p recv_apdu target accepted: "
3849 "charset %s, language %s, select %d",
3851 charset ? charset : "none", lang ? lang : "none", sel);
3853 ZOOM_connection_option_set(c, "negotiation-charset",
3856 ZOOM_connection_option_set(c, "negotiation-lang",
3859 ZOOM_connection_option_set(
3860 c, "negotiation-charset-in-effect-for-records",
3861 (sel != 0) ? "1" : "0");
3862 nmem_destroy(tmpmem);
3866 case Z_APDU_searchResponse:
3867 yaz_log(log_api, "%p recv_apdu Search response", c);
3868 handle_search_response(c, apdu->u.searchResponse);
3869 if (send_sort_present(c) == zoom_complete)
3870 ZOOM_connection_remove_task(c);
3872 case Z_APDU_presentResponse:
3873 yaz_log(log_api, "%p recv_apdu Present response", c);
3874 handle_present_response(c, apdu->u.presentResponse);
3875 if (send_present(c) == zoom_complete)
3876 ZOOM_connection_remove_task(c);
3878 case Z_APDU_sortResponse:
3879 yaz_log(log_api, "%p recv_apdu Sort response", c);
3880 sort_response(c, apdu->u.sortResponse);
3881 if (send_present(c) == zoom_complete)
3882 ZOOM_connection_remove_task(c);
3884 case Z_APDU_scanResponse:
3885 yaz_log(log_api, "%p recv_apdu Scan response", c);
3886 scan_response(c, apdu->u.scanResponse);
3887 ZOOM_connection_remove_task(c);
3889 case Z_APDU_extendedServicesResponse:
3890 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3891 es_response(c, apdu->u.extendedServicesResponse);
3892 ZOOM_connection_remove_task(c);
3895 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3896 if (!ZOOM_test_reconnect(c))
3898 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3903 yaz_log(log_api, "%p Received unknown PDU", c);
3904 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3910 static zoom_ret handle_srw_response(ZOOM_connection c,
3911 Z_SRW_searchRetrieveResponse *res)
3913 ZOOM_resultset resultset = 0;
3918 const char *syntax, *elementSetName;
3921 return zoom_complete;
3923 switch(c->tasks->which)
3925 case ZOOM_TASK_SEARCH:
3926 resultset = c->tasks->u.search.resultset;
3927 start = &c->tasks->u.search.start;
3928 count = &c->tasks->u.search.count;
3929 syntax = c->tasks->u.search.syntax;
3930 elementSetName = c->tasks->u.search.elementSetName;
3932 if (!c->tasks->u.search.recv_search_fired)
3934 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3935 ZOOM_connection_put_event(c, event);
3936 c->tasks->u.search.recv_search_fired = 1;
3939 case ZOOM_TASK_RETRIEVE:
3940 resultset = c->tasks->u.retrieve.resultset;
3941 start = &c->tasks->u.retrieve.start;
3942 count = &c->tasks->u.retrieve.count;
3943 syntax = c->tasks->u.retrieve.syntax;
3944 elementSetName = c->tasks->u.retrieve.elementSetName;
3947 return zoom_complete;
3950 resultset->size = 0;
3952 if (res->resultSetId)
3953 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3955 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3957 if (res->num_diagnostics > 0)
3959 set_SRU_error(c, &res->diagnostics[0]);
3963 if (res->numberOfRecords)
3964 resultset->size = *res->numberOfRecords;
3965 for (i = 0; i<res->num_records; i++)
3968 Z_SRW_record *sru_rec;
3969 Z_SRW_diagnostic *diag = 0;
3972 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3973 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3975 if (res->records[i].recordPosition &&
3976 *res->records[i].recordPosition > 0)
3977 pos = *res->records[i].recordPosition - 1;
3981 sru_rec = &res->records[i];
3983 npr->databaseName = 0;
3984 npr->which = Z_NamePlusRecord_databaseRecord;
3985 npr->u.databaseRecord = (Z_External *)
3986 odr_malloc(c->odr_in, sizeof(Z_External));
3987 npr->u.databaseRecord->descriptor = 0;
3988 npr->u.databaseRecord->direct_reference =
3989 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3990 npr->u.databaseRecord->which = Z_External_octet;
3992 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3993 odr_malloc(c->odr_in, sizeof(Odr_oct));
3994 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3995 sru_rec->recordData_buf;
3996 npr->u.databaseRecord->u.octet_aligned->len =
3997 npr->u.databaseRecord->u.octet_aligned->size =
3998 sru_rec->recordData_len;
4000 if (sru_rec->recordSchema
4001 && !strcmp(sru_rec->recordSchema,
4002 "info:srw/schema/1/diagnostics-v1.1"))
4004 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4005 sru_rec->recordData_len,
4009 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4010 sru_rec->recordSchema, diag);
4014 if (*count + *start > resultset->size)
4015 *count = resultset->size - *start;
4019 nmem = odr_extract_mem(c->odr_in);
4020 nmem_transfer(odr_getmem(resultset->odr), nmem);
4024 return ZOOM_connection_srw_send_search(c);
4026 return zoom_complete;
4031 static void handle_srw_scan_response(ZOOM_connection c,
4032 Z_SRW_scanResponse *res)
4034 NMEM nmem = odr_extract_mem(c->odr_in);
4037 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4039 scan = c->tasks->u.scan.scan;
4041 if (res->num_diagnostics > 0)
4042 set_SRU_error(c, &res->diagnostics[0]);
4044 scan->scan_response = 0;
4045 scan->srw_scan_response = res;
4046 nmem_transfer(odr_getmem(scan->odr), nmem);
4048 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4054 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4056 zoom_ret cret = zoom_complete;
4058 const char *addinfo = 0;
4059 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4061 ZOOM_connection_set_mask(c, 0);
4062 yaz_log(log_details, "%p handle_http", c);
4064 if (!yaz_srw_check_content_type(hres))
4065 addinfo = "content-type";
4068 Z_SOAP *soap_package = 0;
4070 Z_SOAP_Handler soap_handlers[2] = {
4071 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4074 ret = z_soap_codec(o, &soap_package,
4075 &hres->content_buf, &hres->content_len,
4077 if (!ret && soap_package->which == Z_SOAP_generic &&
4078 soap_package->u.generic->no == 0)
4080 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4082 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4083 if (sr->which == Z_SRW_searchRetrieve_response)
4084 cret = handle_srw_response(c, sr->u.response);
4085 else if (sr->which == Z_SRW_scan_response)
4086 handle_srw_scan_response(c, sr->u.scan_response);
4090 else if (!ret && (soap_package->which == Z_SOAP_fault
4091 || soap_package->which == Z_SOAP_error))
4093 set_HTTP_error(c, hres->code,
4094 soap_package->u.fault->fault_code,
4095 soap_package->u.fault->fault_string);
4102 if (hres->code != 200)
4103 set_HTTP_error(c, hres->code, 0, 0);
4105 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4108 if (cret == zoom_complete)
4109 ZOOM_connection_remove_task(c);
4110 if (!strcmp(hres->version, "1.0"))
4112 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4113 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4118 /* HTTP 1.1: only if no close we stay alive .. */
4119 if (connection_head && !strcmp(connection_head, "close"))
4125 static int do_read(ZOOM_connection c)
4130 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4131 ZOOM_connection_put_event(c, event);
4133 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4134 more = cs_more(c->cs);
4135 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4140 if (!ZOOM_test_reconnect(c))
4142 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4151 odr_reset(c->odr_in);
4152 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4153 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4154 ZOOM_connection_put_event(c, event);
4156 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4159 int err = odr_geterrorx(c->odr_in, &x);
4161 const char *element = odr_getelement(c->odr_in);
4162 yaz_snprintf(msg, sizeof(msg),
4163 "ODR code %d:%d element=%s offset=%d",
4164 err, x, element ? element : "<unknown>",
4165 odr_offset(c->odr_in));
4166 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4169 FILE *ber_file = yaz_log_file();
4171 odr_dumpBER(ber_file, c->buf_in, r);
4178 z_GDU(c->odr_print, &gdu, 0, 0);
4179 if (gdu->which == Z_GDU_Z3950)
4180 recv_apdu(c, gdu->u.z3950);
4181 else if (gdu->which == Z_GDU_HTTP_Response)
4184 handle_http(c, gdu->u.HTTP_Response);
4186 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4191 c->reconnect_ok = 0;
4196 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4201 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4202 ZOOM_connection_put_event(c, event);
4204 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4205 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4207 yaz_log(log_details, "%p do_write_ex write failed", c);
4208 if (ZOOM_test_reconnect(c))
4210 return zoom_pending;
4212 if (c->state == STATE_CONNECTING)
4213 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4215 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4217 return zoom_complete;
4221 int mask = ZOOM_SELECT_EXCEPT;
4222 if (c->cs->io_pending & CS_WANT_WRITE)
4223 mask += ZOOM_SELECT_WRITE;
4224 if (c->cs->io_pending & CS_WANT_READ)
4225 mask += ZOOM_SELECT_READ;
4226 ZOOM_connection_set_mask(c, mask);
4227 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4232 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4233 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4236 return zoom_pending;
4239 static zoom_ret do_write(ZOOM_connection c)
4241 return do_write_ex(c, c->buf_out, c->len_out);
4245 ZOOM_API(const char *)
4246 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4248 return ZOOM_options_get(c->options, key);
4251 ZOOM_API(const char *)
4252 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4254 return ZOOM_options_getl(c->options, key, lenp);
4258 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4261 ZOOM_options_set(c->options, key, val);
4265 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4266 const char *val, int len)
4268 ZOOM_options_setl(c->options, key, val, len);
4271 ZOOM_API(const char *)
4272 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4274 return ZOOM_options_get(r->options, key);
4278 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4281 ZOOM_options_set(r->options, key, val);
4286 ZOOM_connection_errcode(ZOOM_connection c)
4288 return ZOOM_connection_error(c, 0, 0);
4291 ZOOM_API(const char *)
4292 ZOOM_connection_errmsg(ZOOM_connection c)
4295 ZOOM_connection_error(c, &msg, 0);
4299 ZOOM_API(const char *)
4300 ZOOM_connection_addinfo(ZOOM_connection c)
4302 const char *addinfo;
4303 ZOOM_connection_error(c, 0, &addinfo);
4307 ZOOM_API(const char *)
4308 ZOOM_connection_diagset(ZOOM_connection c)
4310 const char *diagset;
4311 ZOOM_connection_error_x(c, 0, 0, &diagset);
4315 ZOOM_API(const char *)
4316 ZOOM_diag_str(int error)
4320 case ZOOM_ERROR_NONE:
4322 case ZOOM_ERROR_CONNECT:
4323 return "Connect failed";
4324 case ZOOM_ERROR_MEMORY:
4325 return "Out of memory";
4326 case ZOOM_ERROR_ENCODE:
4327 return "Encoding failed";
4328 case ZOOM_ERROR_DECODE:
4329 return "Decoding failed";
4330 case ZOOM_ERROR_CONNECTION_LOST:
4331 return "Connection lost";
4332 case ZOOM_ERROR_INIT:
4333 return "Init rejected";
4334 case ZOOM_ERROR_INTERNAL:
4335 return "Internal failure";
4336 case ZOOM_ERROR_TIMEOUT:
4338 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4339 return "Unsupported protocol";
4340 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4341 return "Unsupported query type";
4342 case ZOOM_ERROR_INVALID_QUERY:
4343 return "Invalid query";
4344 case ZOOM_ERROR_CQL_PARSE:
4345 return "CQL parsing error";
4346 case ZOOM_ERROR_CQL_TRANSFORM:
4347 return "CQL transformation error";
4348 case ZOOM_ERROR_CCL_CONFIG:
4349 return "CCL configuration error";
4350 case ZOOM_ERROR_CCL_PARSE:
4351 return "CCL parsing error";
4353 return diagbib1_str(error);
4358 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4359 const char **addinfo, const char **diagset)
4361 int error = c->error;
4364 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4365 *cp = ZOOM_diag_str(error);
4366 else if (!strcmp(c->diagset, "HTTP"))
4367 *cp = z_HTTP_errmsg(c->error);
4368 else if (!strcmp(c->diagset, "Bib-1"))
4369 *cp = ZOOM_diag_str(error);
4370 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4371 *cp = yaz_diag_srw_str(c->error);
4373 *cp = "Unknown error and diagnostic set";
4376 *addinfo = c->addinfo ? c->addinfo : "";
4378 *diagset = c->diagset ? c->diagset : "";
4383 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4384 const char **addinfo)
4386 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4389 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4391 ZOOM_Event event = 0;
4392 int r = cs_look(c->cs);
4393 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4398 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4399 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4401 ZOOM_connection_put_event(c, event);
4403 else if (r == CS_CONNECT)
4405 int ret = ret = cs_rcvconnect(c->cs);
4406 yaz_log(log_details, "%p ZOOM_connection_do_io "
4407 "cs_rcvconnect returned %d", c, ret);
4410 int mask = ZOOM_SELECT_EXCEPT;
4411 if (c->cs->io_pending & CS_WANT_WRITE)
4412 mask += ZOOM_SELECT_WRITE;
4413 if (c->cs->io_pending & CS_WANT_READ)
4414 mask += ZOOM_SELECT_READ;
4415 ZOOM_connection_set_mask(c, mask);
4416 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4417 ZOOM_connection_put_event(c, event);
4421 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4422 ZOOM_connection_put_event(c, event);
4424 if (c->proto == PROTO_Z3950)
4425 ZOOM_connection_send_init(c);
4428 /* no init request for SRW .. */
4429 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4430 ZOOM_connection_remove_task(c);
4431 ZOOM_connection_set_mask(c, 0);
4432 ZOOM_connection_exec_task(c);
4434 c->state = STATE_ESTABLISHED;
4438 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4444 if (mask & ZOOM_SELECT_EXCEPT)
4446 if (!ZOOM_test_reconnect(c))
4448 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4453 if (mask & ZOOM_SELECT_READ)
4455 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4461 ZOOM_connection_last_event(ZOOM_connection cs)
4464 return ZOOM_EVENT_NONE;
4465 return cs->last_event;
4469 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4471 WRBUF wrbuf = (WRBUF) client_data;
4472 wrbuf_puts(wrbuf, buf);
4476 * Returns an xmalloc()d string containing RPN that corresponds to the
4477 * CQL passed in. On error, sets the Connection object's error state
4478 * and returns a null pointer.
4479 * ### We could cache CQL parser and/or transformer in Connection.
4481 static char *cql2pqf(ZOOM_connection c, const char *cql)
4485 const char *cqlfile;
4486 cql_transform_t trans;
4489 parser = cql_parser_create();
4490 if ((error = cql_parser_string(parser, cql)) != 0) {
4491 cql_parser_destroy(parser);
4492 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4496 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4499 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4501 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4504 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4505 cqlfile, strerror(errno));
4506 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4510 WRBUF wrbuf_result = wrbuf_alloc();
4511 error = cql_transform(trans, cql_parser_result(parser),
4512 cql2pqf_wrbuf_puts, wrbuf_result);
4515 const char *addinfo;
4516 error = cql_transform_error(trans, &addinfo);
4517 sprintf(buf, "%.200s (addinfo=%.200s)",
4518 cql_strerror(error), addinfo);
4519 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4523 result = xstrdup(wrbuf_cstr(wrbuf_result));
4525 cql_transform_close(trans);
4526 wrbuf_destroy(wrbuf_result);
4528 cql_parser_destroy(parser);
4532 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4536 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4537 /* timeout and this connection was waiting */
4538 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4540 ZOOM_connection_put_event(c, event);
4546 ZOOM_connection_process(ZOOM_connection c)
4552 event = ZOOM_connection_get_event(c);
4555 ZOOM_Event_destroy(event);
4558 ZOOM_connection_exec_task(c);
4559 event = ZOOM_connection_get_event(c);
4562 ZOOM_Event_destroy(event);
4569 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4573 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4575 for (i = 0; i<no; i++)
4577 ZOOM_connection c = cs[i];
4579 if (c && ZOOM_connection_process(c))
4585 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4587 if (c->mask && mask)
4588 ZOOM_connection_do_io(c, mask);
4592 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4595 return cs_fileno(c->cs);
4599 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4607 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4614 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4616 return ZOOM_options_get_int(c->options, "timeout", 30);
4622 * c-file-style: "Stroustrup"
4623 * indent-tabs-mode: nil
4625 * vim: shiftwidth=4 tabstop=8 expandtab