1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM C interface.
15 #include <yaz/yaz-util.h>
16 #include <yaz/xmalloc.h>
17 #include <yaz/otherinfo.h>
19 #include <yaz/pquery.h>
20 #include <yaz/marcdisp.h>
21 #include <yaz/diagbib1.h>
22 #include <yaz/charneg.h>
27 #include <yaz/query-charset.h>
28 #include <yaz/copy_types.h>
29 #include <yaz/snprintf.h>
31 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))
1014 static void ZOOM_record_release(ZOOM_record rec)
1019 wrbuf_destroy(rec->wrbuf);
1022 xmlFree(rec->xml_mem);
1025 odr_destroy(rec->odr);
1029 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1032 for (i = 0; i<RECORD_HASH_SIZE; i++)
1034 ZOOM_record_cache rc;
1035 for (rc = r->record_hash[i]; rc; rc = rc->next)
1037 ZOOM_record_release(&rc->rec);
1039 r->record_hash[i] = 0;
1044 ZOOM_resultset_destroy(ZOOM_resultset r)
1046 resultset_destroy(r);
1049 static void resultset_destroy(ZOOM_resultset r)
1054 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1056 if (r->refcount == 0)
1058 ZOOM_resultset_cache_reset(r);
1062 /* remove ourselves from the resultsets in connection */
1063 ZOOM_resultset *rp = &r->connection->resultsets;
1066 assert(*rp); /* we must be in this list!! */
1068 { /* OK, we're here - take us out of it */
1075 ZOOM_query_destroy(r->query);
1076 ZOOM_options_destroy(r->options);
1077 odr_destroy(r->odr);
1085 ZOOM_resultset_size(ZOOM_resultset r)
1087 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1092 static void do_close(ZOOM_connection c)
1097 ZOOM_connection_set_mask(c, 0);
1098 c->state = STATE_IDLE;
1101 static int ZOOM_test_reconnect(ZOOM_connection c)
1105 if (!c->reconnect_ok)
1108 c->reconnect_ok = 0;
1109 c->tasks->running = 0;
1110 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1112 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1113 ZOOM_connection_put_event(c, event);
1118 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1119 int force_sync, int start, int count)
1124 const char *syntax, *elementSetName;
1128 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1129 " count=%d", r, force_sync, start, count);
1134 if (c->host_port && c->proto == PROTO_HTTP)
1138 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1139 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1143 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1145 c->reconnect_ok = 1;
1148 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1149 task->u.retrieve.resultset = r;
1150 task->u.retrieve.start = start;
1151 task->u.retrieve.count = count;
1153 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1154 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1155 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1156 task->u.retrieve.elementSetName = elementSetName
1157 ? xstrdup(elementSetName) : 0;
1159 cp = ZOOM_options_get(r->options, "schema");
1162 if (!r->schema || strcmp(r->schema, cp))
1165 r->schema = xstrdup(cp);
1169 ZOOM_resultset_addref(r);
1171 if (!r->connection->async || force_sync)
1172 while (r->connection && ZOOM_event(1, &r->connection))
1177 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1178 size_t start, size_t count)
1180 int force_present = 0;
1184 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1185 r, r, (long) start, (long) count);
1188 ZOOM_resultset_retrieve(r, force_present, start, count);
1192 for (i = 0; i< count; i++)
1193 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1197 static void get_cert(ZOOM_connection c)
1202 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1204 ZOOM_connection_option_setl(c, "sslPeerCert",
1205 cert_buf, cert_len);
1210 static zoom_ret do_connect(ZOOM_connection c)
1213 const char *effective_host;
1216 effective_host = c->proxy;
1218 effective_host = c->host_port;
1220 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1224 c->cs = cs_create_host(effective_host, 0, &add);
1226 if (c->cs && c->cs->protocol == PROTO_HTTP)
1231 c->proto = PROTO_HTTP;
1232 cs_get_host_args(c->host_port, &db);
1235 c->path = xmalloc(strlen(db) * 3 + 2);
1236 yaz_encode_sru_dbpath_buf(c->path, db);
1238 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1240 return zoom_complete;
1245 int ret = cs_connect(c->cs, add);
1248 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1249 ZOOM_connection_put_event(c, event);
1251 if (c->proto == PROTO_Z3950)
1252 ZOOM_connection_send_init(c);
1255 /* no init request for SRW .. */
1256 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1257 ZOOM_connection_remove_task(c);
1258 ZOOM_connection_set_mask(c, 0);
1259 ZOOM_connection_exec_task(c);
1261 c->state = STATE_ESTABLISHED;
1262 return zoom_pending;
1266 int mask = ZOOM_SELECT_EXCEPT;
1267 if (c->cs->io_pending & CS_WANT_WRITE)
1268 mask += ZOOM_SELECT_WRITE;
1269 if (c->cs->io_pending & CS_WANT_READ)
1270 mask += ZOOM_SELECT_READ;
1271 ZOOM_connection_set_mask(c, mask);
1272 c->state = STATE_CONNECTING;
1273 return zoom_pending;
1276 c->state = STATE_IDLE;
1277 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1278 return zoom_complete;
1281 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1284 for (i = 0; i<200; i++)
1288 Z_OtherInformation **oi;
1293 sprintf(buf, "otherInfo%d", i);
1294 val = ZOOM_options_get(c->options, buf);
1297 cp = strchr(val, ':');
1301 if (len >= sizeof(buf))
1302 len = sizeof(buf)-1;
1303 memcpy(buf, val, len);
1306 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1311 yaz_oi_APDU(a, &oi);
1312 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1316 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1321 Z_OtherInformation **oi;
1322 yaz_oi_APDU(a, &oi);
1323 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1328 Z_OtherInformation **oi;
1329 yaz_oi_APDU(a, &oi);
1330 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1333 otherInfo_attach(c, a, out);
1334 if (!z_APDU(out, &a, 0, 0))
1336 FILE *outf = fopen("/tmp/apdu.txt", "a");
1339 ODR odr_pr = odr_createmem(ODR_PRINT);
1340 fprintf(outf, "a=%p\n", a);
1341 odr_setprint(odr_pr, outf);
1342 z_APDU(odr_pr, &a, 0, 0);
1343 odr_destroy(odr_pr);
1345 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1346 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1351 z_APDU(c->odr_print, &a, 0, 0);
1352 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1356 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1360 if (encode_APDU(c, a, c->odr_out))
1361 return zoom_complete;
1362 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1363 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1364 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1365 ZOOM_connection_put_event(c, event);
1366 odr_reset(c->odr_out);
1370 /* returns 1 if PDU was sent OK (still pending )
1371 0 if PDU was not sent OK (nothing to wait for)
1374 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1376 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1377 Z_InitRequest *ireq = apdu->u.initRequest;
1378 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1379 odr_malloc(c->odr_out, sizeof(*auth));
1381 ODR_MASK_SET(ireq->options, Z_Options_search);
1382 ODR_MASK_SET(ireq->options, Z_Options_present);
1383 ODR_MASK_SET(ireq->options, Z_Options_scan);
1384 ODR_MASK_SET(ireq->options, Z_Options_sort);
1385 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1386 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1388 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1389 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1390 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1392 ireq->implementationId =
1393 odr_prepend(c->odr_out,
1394 ZOOM_options_get(c->options, "implementationId"),
1395 ireq->implementationId);
1397 ireq->implementationName =
1398 odr_prepend(c->odr_out,
1399 ZOOM_options_get(c->options, "implementationName"),
1400 odr_prepend(c->odr_out, "ZOOM-C",
1401 ireq->implementationName));
1403 ireq->implementationVersion =
1404 odr_prepend(c->odr_out,
1405 ZOOM_options_get(c->options, "implementationVersion"),
1406 ireq->implementationVersion);
1408 *ireq->maximumRecordSize = c->maximum_record_size;
1409 *ireq->preferredMessageSize = c->preferred_message_size;
1411 if (c->group || c->password)
1413 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1414 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1415 pass->userId = odr_strdup_null(c->odr_out, c->user);
1416 pass->password = odr_strdup_null(c->odr_out, c->password);
1417 auth->which = Z_IdAuthentication_idPass;
1418 auth->u.idPass = pass;
1419 ireq->idAuthentication = auth;
1423 auth->which = Z_IdAuthentication_open;
1424 auth->u.open = odr_strdup(c->odr_out, c->user);
1425 ireq->idAuthentication = auth;
1429 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1430 yaz_oid_userinfo_proxy, 1, c->host_port);
1432 if (c->charset || c->lang)
1434 Z_OtherInformation **oi;
1435 Z_OtherInformationUnit *oi_unit;
1437 yaz_oi_APDU(apdu, &oi);
1439 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1441 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1442 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1443 oi_unit->information.externallyDefinedInfo =
1444 yaz_set_proposal_charneg_list(c->odr_out, " ",
1445 c->charset, c->lang, 1);
1449 return send_APDU(c, apdu);
1453 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1457 const char *database = ZOOM_options_get(c->options, "databaseName");
1458 char *fdatabase = 0;
1461 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1462 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1463 fdatabase ? fdatabase : c->path);
1465 if (c->sru_mode == zoom_sru_get)
1467 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1469 else if (c->sru_mode == zoom_sru_post)
1471 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1473 else if (c->sru_mode == zoom_sru_soap)
1475 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1477 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1478 return zoom_complete;
1480 z_GDU(c->odr_print, &gdu, 0, 0);
1481 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1483 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1484 ZOOM_connection_put_event(c, event);
1485 odr_reset(c->odr_out);
1491 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1493 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1494 sr->username = c->user;
1495 sr->password = c->password;
1501 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1505 ZOOM_resultset resultset = 0;
1507 const char *option_val = 0;
1509 if (c->error) /* don't continue on error */
1510 return zoom_complete;
1512 switch(c->tasks->which)
1514 case ZOOM_TASK_SEARCH:
1515 resultset = c->tasks->u.search.resultset;
1516 if (!resultset->setname)
1517 resultset->setname = xstrdup("default");
1518 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1519 start = &c->tasks->u.search.start;
1520 count = &c->tasks->u.search.count;
1522 case ZOOM_TASK_RETRIEVE:
1523 resultset = c->tasks->u.retrieve.resultset;
1525 start = &c->tasks->u.retrieve.start;
1526 count = &c->tasks->u.retrieve.count;
1528 if (*start >= resultset->size)
1529 return zoom_complete;
1530 if (*start + *count > resultset->size)
1531 *count = resultset->size - *start;
1533 for (i = 0; i < *count; i++)
1536 record_cache_lookup(resultset, i + *start,
1537 c->tasks->u.retrieve.syntax,
1538 c->tasks->u.retrieve.elementSetName);
1543 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1544 ZOOM_connection_put_event(c, event);
1551 return zoom_complete;
1554 return zoom_complete;
1556 assert(resultset->query);
1558 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1559 if (resultset->query->z_query->which == Z_Query_type_104
1560 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1562 sr->u.request->query_type = Z_SRW_query_type_cql;
1563 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1565 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1566 resultset->query->z_query->u.type_1)
1568 sr->u.request->query_type = Z_SRW_query_type_pqf;
1569 sr->u.request->query.pqf = resultset->query->query_string;
1573 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1574 return zoom_complete;
1576 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1577 sr->u.request->maximumRecords = odr_intdup(
1578 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1579 resultset->step : *count);
1580 sr->u.request->recordSchema = resultset->schema;
1582 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1584 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1586 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1587 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1588 return send_srw(c, sr);
1591 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1593 return zoom_complete;
1597 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1600 int lslb, ssub, mspn;
1602 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1603 Z_SearchRequest *search_req = apdu->u.searchRequest;
1604 const char *elementSetName;
1605 const char *smallSetElementSetName;
1606 const char *mediumSetElementSetName;
1609 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1611 r = c->tasks->u.search.resultset;
1613 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1616 ZOOM_options_get(r->options, "elementSetName");
1617 smallSetElementSetName =
1618 ZOOM_options_get(r->options, "smallSetElementSetName");
1619 mediumSetElementSetName =
1620 ZOOM_options_get(r->options, "mediumSetElementSetName");
1622 if (!smallSetElementSetName)
1623 smallSetElementSetName = elementSetName;
1625 if (!mediumSetElementSetName)
1626 mediumSetElementSetName = elementSetName;
1631 /* prepare query for the search request */
1632 search_req->query = r->query->z_query;
1633 if (!search_req->query)
1635 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1636 return zoom_complete;
1638 if (r->query->z_query->which == Z_Query_type_1 ||
1639 r->query->z_query->which == Z_Query_type_101)
1641 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1644 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1648 search_req->query = yaz_copy_Z_Query(search_req->query,
1651 r = yaz_query_charset_convert_rpnquery_check(
1652 search_req->query->u.type_1,
1654 yaz_iconv_close(cd);
1656 { /* query could not be char converted */
1657 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1658 return zoom_complete;
1663 search_req->databaseNames = r->databaseNames;
1664 search_req->num_databaseNames = r->num_databaseNames;
1666 /* get syntax (no need to provide unless piggyback is in effect) */
1667 syntax = c->tasks->u.search.syntax;
1669 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1670 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1671 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1672 if (lslb != -1 && ssub != -1 && mspn != -1)
1674 /* So're a Z39.50 expert? Let's hope you don't do sort */
1675 *search_req->largeSetLowerBound = lslb;
1676 *search_req->smallSetUpperBound = ssub;
1677 *search_req->mediumSetPresentNumber = mspn;
1679 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1680 && r->piggyback && !r->r_sort_spec && !r->schema)
1682 /* Regular piggyback - do it unless we're going to do sort */
1683 *search_req->largeSetLowerBound = 2000000000;
1684 *search_req->smallSetUpperBound = 1;
1685 *search_req->mediumSetPresentNumber =
1686 r->step>0 ? r->step : c->tasks->u.search.count;
1690 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1691 smallSetElementSetName = 0;
1692 mediumSetElementSetName = 0;
1695 if (smallSetElementSetName && *smallSetElementSetName)
1697 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1698 odr_malloc(c->odr_out, sizeof(*esn));
1700 esn->which = Z_ElementSetNames_generic;
1701 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1702 search_req->smallSetElementSetNames = esn;
1704 if (mediumSetElementSetName && *mediumSetElementSetName)
1706 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1707 odr_malloc(c->odr_out, sizeof(*esn));
1709 esn->which = Z_ElementSetNames_generic;
1710 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1711 search_req->mediumSetElementSetNames = esn;
1714 search_req->preferredRecordSyntax =
1715 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1719 if (c->support_named_resultsets)
1723 /* find the lowest unused ordinal so that we re-use
1724 result sets on the server. */
1725 for (ord = 1; ; ord++)
1728 sprintf(setname, "%d", ord);
1729 for (rp = c->resultsets; rp; rp = rp->next)
1730 if (rp->setname && !strcmp(rp->setname, setname))
1735 r->setname = xstrdup(setname);
1736 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1737 "set %s", c, r->setname);
1741 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1743 r->setname = xstrdup("default");
1745 ZOOM_options_set(r->options, "setname", r->setname);
1747 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1748 return send_APDU(c, apdu);
1751 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1753 char oid_name_buf[OID_STR_MAX];
1754 const char *oid_name;
1757 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1760 case Z_DefaultDiagFormat_v2Addinfo:
1761 addinfo = r->u.v2Addinfo;
1763 case Z_DefaultDiagFormat_v3Addinfo:
1764 addinfo = r->u.v3Addinfo;
1769 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1772 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1774 if (p->which != Z_DiagRec_defaultFormat)
1775 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1777 response_default_diag(c, p->u.defaultFormat);
1780 ZOOM_API(ZOOM_record)
1781 ZOOM_record_clone(ZOOM_record srec)
1788 odr_enc = odr_createmem(ODR_ENCODE);
1789 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1791 buf = odr_getbuf(odr_enc, &size, 0);
1793 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1794 nrec->odr = odr_createmem(ODR_DECODE);
1800 odr_setbuf(nrec->odr, buf, size, 0);
1801 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1803 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1804 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1805 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1806 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1807 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1808 odr_destroy(odr_enc);
1812 ZOOM_API(ZOOM_record)
1813 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1815 const char *syntax =
1816 ZOOM_options_get(s->options, "preferredRecordSyntax");
1817 const char *elementSetName =
1818 ZOOM_options_get(s->options, "elementSetName");
1820 return record_cache_lookup(s, pos, syntax, elementSetName);
1823 ZOOM_API(ZOOM_record)
1824 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1826 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1831 * MIKE: I think force_sync should always be zero, but I don't
1832 * want to make this change until I get the go-ahead from
1833 * Adam, in case something depends on the old synchronous
1837 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1838 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1839 rec = ZOOM_resultset_record_immediate(r, pos);
1845 ZOOM_record_destroy(ZOOM_record rec)
1847 ZOOM_record_release(rec);
1852 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1859 strcpy(to, "UTF-8");
1860 if (record_charset && *record_charset)
1862 /* Use "from,to" or just "from" */
1863 const char *cp = strchr(record_charset, ',');
1864 size_t clen = strlen(record_charset);
1867 strncpy( to, cp+1, sizeof(to)-1);
1868 to[sizeof(to)-1] = '\0';
1869 clen = cp - record_charset;
1871 if (clen > sizeof(from)-1)
1872 clen = sizeof(from)-1;
1875 strncpy(from, record_charset, clen);
1879 cd = yaz_iconv_open(to, from);
1883 static const char *return_marc_record(ZOOM_record rec, int marc_type,
1885 const char *buf, int sz,
1886 const char *record_charset)
1888 yaz_iconv_t cd = iconv_create_charset(record_charset);
1889 yaz_marc_t mt = yaz_marc_create();
1890 const char *ret_string = 0;
1893 yaz_marc_iconv(mt, cd);
1894 yaz_marc_xml(mt, marc_type);
1896 rec->wrbuf = wrbuf_alloc();
1897 wrbuf_rewind(rec->wrbuf);
1898 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf) > 0)
1901 *len = wrbuf_len(rec->wrbuf);
1902 ret_string = wrbuf_cstr(rec->wrbuf);
1904 yaz_marc_destroy(mt);
1906 yaz_iconv_close(cd);
1910 static const char *return_opac_record(ZOOM_record rec, int marc_type,
1912 Z_OPACRecord *opac_rec,
1913 const char *record_charset)
1915 yaz_iconv_t cd = iconv_create_charset(record_charset);
1916 yaz_marc_t mt = yaz_marc_create();
1919 yaz_marc_iconv(mt, cd);
1920 yaz_marc_xml(mt, marc_type);
1923 rec->wrbuf = wrbuf_alloc();
1924 wrbuf_rewind(rec->wrbuf);
1926 yaz_opac_decode_wrbuf(mt, opac_rec, rec->wrbuf);
1927 yaz_marc_destroy(mt);
1930 yaz_iconv_close(cd);
1932 *len = wrbuf_len(rec->wrbuf);
1933 return wrbuf_cstr(rec->wrbuf);
1936 static const char *return_string_record(ZOOM_record rec, int *len,
1937 const char *buf, int sz,
1938 const char *record_charset)
1940 yaz_iconv_t cd = iconv_create_charset(record_charset);
1945 rec->wrbuf = wrbuf_alloc();
1947 wrbuf_rewind(rec->wrbuf);
1949 wrbuf_iconv_write(rec->wrbuf, cd, buf, sz);
1950 wrbuf_iconv_reset(rec->wrbuf, cd);
1952 buf = wrbuf_cstr(rec->wrbuf);
1953 sz = wrbuf_len(rec->wrbuf);
1954 yaz_iconv_close(cd);
1961 static const char *return_record(ZOOM_record rec, int *len,
1962 Z_NamePlusRecord *npr,
1963 int marctype, const char *charset)
1965 Z_External *r = (Z_External *) npr->u.databaseRecord;
1966 const Odr_oid *oid = r->direct_reference;
1968 /* render bibliographic record .. */
1969 if (r->which == Z_External_OPAC)
1971 return return_opac_record(rec, marctype, len,
1972 r->u.opac, charset);
1974 if (r->which == Z_External_sutrs)
1975 return return_string_record(rec, len,
1976 (char*) r->u.sutrs->buf,
1979 else if (r->which == Z_External_octet)
1981 if (yaz_oid_is_iso2709(oid))
1983 const char *ret_buf = return_marc_record(
1985 (const char *) r->u.octet_aligned->buf,
1986 r->u.octet_aligned->len,
1990 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
1991 if (marctype != YAZ_MARC_ISO2709)
1994 return return_string_record(rec, len,
1995 (const char *) r->u.octet_aligned->buf,
1996 r->u.octet_aligned->len,
1999 else if (r->which == Z_External_grs1)
2002 rec->wrbuf = wrbuf_alloc();
2003 wrbuf_rewind(rec->wrbuf);
2004 yaz_display_grs1(rec->wrbuf, r->u.grs1, 0);
2005 return return_string_record(rec, len,
2006 wrbuf_buf(rec->wrbuf),
2007 wrbuf_len(rec->wrbuf),
2015 ZOOM_record_error(ZOOM_record rec, const char **cp,
2016 const char **addinfo, const char **diagset)
2018 Z_NamePlusRecord *npr;
2027 *cp = rec->diag_message;
2029 *addinfo = rec->diag_details;
2031 *diagset = rec->diag_set;
2032 return uri_to_code(rec->diag_uri);
2034 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2036 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2037 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2038 const char *add = 0;
2040 if (diag_rec->which == Z_DiagRec_defaultFormat)
2042 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2045 error = *ddf->condition;
2048 case Z_DefaultDiagFormat_v2Addinfo:
2049 add = ddf->u.v2Addinfo;
2051 case Z_DefaultDiagFormat_v3Addinfo:
2052 add = ddf->u.v3Addinfo;
2057 yaz_oid_to_string(yaz_oid_std(),
2058 ddf->diagnosticSetId, &oclass);
2066 *addinfo = add ? add : "";
2068 *cp = diagbib1_str(error);
2074 static const char *get_record_format(ZOOM_record rec, int *len,
2075 Z_NamePlusRecord *npr,
2076 int marctype, const char *charset,
2079 const char *res = return_record(rec, len, npr, marctype, charset);
2081 if (*format == '1' && len)
2083 /* try to XML format res */
2085 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2086 doc = xmlParseMemory(res, *len);
2090 xmlFree(rec->xml_mem);
2091 xmlDocDumpFormatMemory(doc, &rec->xml_mem, &rec->xml_size, 1);
2093 res = (char *) rec->xml_mem;
2094 *len = rec->xml_size;
2102 ZOOM_API(const char *)
2103 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2110 Z_NamePlusRecord *npr;
2113 *len = 0; /* default return */
2122 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2130 while (cp[i] == ' ')
2135 while (cp[i] == ' ')
2137 if (!strncmp(cp + i, "charset=", 8))
2140 i = i + 8; /* skip charset= */
2141 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2143 if (j < sizeof(charset)-1)
2144 charset[j++] = cp[i];
2148 else if (!strncmp(cp + i, "format=", 7))
2152 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2154 if (j < sizeof(format)-1)
2155 format[j++] = cp[i];
2160 if (!strcmp(type, "database"))
2163 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2164 return npr->databaseName;
2166 else if (!strcmp(type, "schema"))
2169 *len = rec->schema ? strlen(rec->schema) : 0;
2172 else if (!strcmp(type, "syntax"))
2174 const char *desc = 0;
2175 if (npr->which == Z_NamePlusRecord_databaseRecord)
2177 Z_External *r = (Z_External *) npr->u.databaseRecord;
2178 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2183 *len = strlen(desc);
2186 if (npr->which != Z_NamePlusRecord_databaseRecord)
2189 /* from now on - we have a database record .. */
2190 if (!strcmp(type, "render"))
2192 return get_record_format(rec, len, npr, YAZ_MARC_LINE, charset, format);
2194 else if (!strcmp(type, "xml"))
2196 return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
2199 else if (!strcmp(type, "raw"))
2201 return get_record_format(rec, len, npr, YAZ_MARC_ISO2709, charset,
2204 else if (!strcmp(type, "ext"))
2207 return (const char *) npr->u.databaseRecord;
2209 else if (!strcmp(type, "opac"))
2211 if (npr->u.databaseRecord->which == Z_External_OPAC)
2212 return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
2218 static int strcmp_null(const char *v1, const char *v2)
2224 return strcmp(v1, v2);
2227 static size_t record_hash(int pos)
2231 return pos % RECORD_HASH_SIZE;
2234 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2236 const char *syntax, const char *elementSetName,
2238 Z_SRW_diagnostic *diag)
2240 ZOOM_record_cache rc = 0;
2242 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2243 ZOOM_connection_put_event(r->connection, event);
2245 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2248 && strcmp_null(r->schema, rc->schema) == 0
2249 && strcmp_null(elementSetName,rc->elementSetName) == 0
2250 && strcmp_null(syntax, rc->syntax) == 0)
2255 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2259 rc->rec.xml_mem = 0;
2261 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2263 rc->syntax = odr_strdup_null(r->odr, syntax);
2265 rc->schema = odr_strdup_null(r->odr, r->schema);
2268 rc->next = r->record_hash[record_hash(pos)];
2269 r->record_hash[record_hash(pos)] = rc;
2272 rc->rec.schema = odr_strdup_null(r->odr, schema);
2273 rc->rec.diag_set = 0;
2274 rc->rec.diag_uri = 0;
2275 rc->rec.diag_message = 0;
2276 rc->rec.diag_details = 0;
2282 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2283 if ((cp = strrchr(rc->rec.diag_set, '/')))
2285 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2287 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2288 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2292 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2294 const char *elementSetName)
2296 ZOOM_record_cache rc;
2298 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2302 if (strcmp_null(r->schema, rc->schema))
2304 if (strcmp_null(elementSetName,rc->elementSetName))
2306 if (strcmp_null(syntax, rc->syntax))
2314 static void handle_records(ZOOM_connection c, Z_Records *sr,
2317 ZOOM_resultset resultset;
2319 const char *syntax = 0, *elementSetName = 0;
2323 switch (c->tasks->which)
2325 case ZOOM_TASK_SEARCH:
2326 resultset = c->tasks->u.search.resultset;
2327 start = &c->tasks->u.search.start;
2328 count = &c->tasks->u.search.count;
2329 syntax = c->tasks->u.search.syntax;
2330 elementSetName = c->tasks->u.search.elementSetName;
2332 case ZOOM_TASK_RETRIEVE:
2333 resultset = c->tasks->u.retrieve.resultset;
2334 start = &c->tasks->u.retrieve.start;
2335 count = &c->tasks->u.retrieve.count;
2336 syntax = c->tasks->u.retrieve.syntax;
2337 elementSetName = c->tasks->u.retrieve.elementSetName;
2342 if (sr && sr->which == Z_Records_NSD)
2343 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2344 else if (sr && sr->which == Z_Records_multipleNSD)
2346 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2347 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2349 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2353 if (*count + *start > resultset->size)
2354 *count = resultset->size - *start;
2357 if (sr && sr->which == Z_Records_DBOSD)
2360 NMEM nmem = odr_extract_mem(c->odr_in);
2361 Z_NamePlusRecordList *p =
2362 sr->u.databaseOrSurDiagnostics;
2363 for (i = 0; i<p->num_records; i++)
2365 record_cache_add(resultset, p->records[i], i + *start,
2366 syntax, elementSetName,
2373 yaz_log(log_details,
2374 "handle_records resultset=%p start=%d count=%d",
2375 resultset, *start, *count);
2377 /* transfer our response to search_nmem .. we need it later */
2378 nmem_transfer(odr_getmem(resultset->odr), nmem);
2380 if (present_phase && p->num_records == 0)
2382 /* present response and we didn't get any records! */
2383 Z_NamePlusRecord *myrec =
2384 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2385 record_cache_add(resultset, myrec, *start,
2386 syntax, elementSetName, 0, 0);
2389 else if (present_phase)
2391 /* present response and we didn't get any records! */
2392 Z_NamePlusRecord *myrec =
2393 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2394 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2400 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2402 handle_records(c, pr->records, 1);
2405 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2408 switch (term->which)
2410 case Z_Term_general:
2411 ZOOM_options_setl(opt, name,
2412 (const char *)(term->u.general->buf),
2413 term->u.general->len);
2415 case Z_Term_characterString:
2416 ZOOM_options_set(opt, name, term->u.characterString);
2418 case Z_Term_numeric:
2419 ZOOM_options_set_int(opt, name, *term->u.numeric);
2424 static void handle_queryExpression(ZOOM_options opt, const char *name,
2425 Z_QueryExpression *exp)
2431 case Z_QueryExpression_term:
2432 if (exp->u.term && exp->u.term->queryTerm)
2434 sprintf(opt_name, "%s.term", name);
2435 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2438 case Z_QueryExpression_query:
2443 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2444 Z_OtherInformation *o)
2447 for (i = 0; o && i < o->num_elements; i++)
2449 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2451 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2453 if (ext->which == Z_External_searchResult1)
2456 Z_SearchInfoReport *sr = ext->u.searchResult1;
2459 ZOOM_options_set_int(
2460 resultset->options, "searchresult.size", sr->num);
2462 for (j = 0; j < sr->num; j++)
2464 Z_SearchInfoReport_s *ent =
2465 ext->u.searchResult1->elements[j];
2468 sprintf(pref, "searchresult.%d", j);
2470 if (ent->subqueryId)
2473 sprintf(opt_name, "%s.id", pref);
2474 ZOOM_options_set(resultset->options, opt_name,
2477 if (ent->subqueryExpression)
2480 sprintf(opt_name, "%s.subquery", pref);
2481 handle_queryExpression(resultset->options, opt_name,
2482 ent->subqueryExpression);
2484 if (ent->subqueryInterpretation)
2487 sprintf(opt_name, "%s.interpretation", pref);
2488 handle_queryExpression(resultset->options, opt_name,
2489 ent->subqueryInterpretation);
2491 if (ent->subqueryRecommendation)
2494 sprintf(opt_name, "%s.recommendation", pref);
2495 handle_queryExpression(resultset->options, opt_name,
2496 ent->subqueryRecommendation);
2498 if (ent->subqueryCount)
2501 sprintf(opt_name, "%s.count", pref);
2502 ZOOM_options_set_int(resultset->options, opt_name,
2503 *ent->subqueryCount);
2511 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2513 ZOOM_resultset resultset;
2516 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2519 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2520 ZOOM_connection_put_event(c, event);
2522 resultset = c->tasks->u.search.resultset;
2524 if (sr->resultSetStatus)
2526 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2527 *sr->resultSetStatus);
2529 if (sr->presentStatus)
2531 ZOOM_options_set_int(resultset->options, "presentStatus",
2532 *sr->presentStatus);
2534 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2536 resultset->size = *sr->resultCount;
2537 handle_records(c, sr->records, 0);
2540 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2542 if (res->diagnostics && res->num_diagnostics > 0)
2543 response_diag(c, res->diagnostics[0]);
2546 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2548 NMEM nmem = odr_extract_mem(c->odr_in);
2551 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2553 scan = c->tasks->u.scan.scan;
2555 if (res->entries && res->entries->nonsurrogateDiagnostics)
2556 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2557 scan->scan_response = res;
2558 scan->srw_scan_response = 0;
2559 nmem_transfer(odr_getmem(scan->odr), nmem);
2561 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2562 if (res->positionOfTerm)
2563 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2564 if (res->scanStatus)
2565 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2566 if (res->numberOfEntriesReturned)
2567 ZOOM_options_set_int(scan->options, "number",
2568 *res->numberOfEntriesReturned);
2573 static zoom_ret send_sort(ZOOM_connection c,
2574 ZOOM_resultset resultset)
2577 resultset->r_sort_spec = 0;
2578 if (resultset->r_sort_spec)
2580 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2581 Z_SortRequest *req = apdu->u.sortRequest;
2583 req->num_inputResultSetNames = 1;
2584 req->inputResultSetNames = (Z_InternationalString **)
2585 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2586 req->inputResultSetNames[0] =
2587 odr_strdup(c->odr_out, resultset->setname);
2588 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2589 req->sortSequence = resultset->r_sort_spec;
2590 resultset->r_sort_spec = 0;
2591 return send_APDU(c, apdu);
2593 return zoom_complete;
2596 static zoom_ret send_present(ZOOM_connection c)
2599 Z_PresentRequest *req = 0;
2601 const char *syntax = 0;
2602 const char *elementSetName = 0;
2603 ZOOM_resultset resultset;
2608 yaz_log(log_details, "%p send_present no tasks", c);
2609 return zoom_complete;
2612 switch (c->tasks->which)
2614 case ZOOM_TASK_SEARCH:
2615 resultset = c->tasks->u.search.resultset;
2616 start = &c->tasks->u.search.start;
2617 count = &c->tasks->u.search.count;
2618 syntax = c->tasks->u.search.syntax;
2619 elementSetName = c->tasks->u.search.elementSetName;
2621 case ZOOM_TASK_RETRIEVE:
2622 resultset = c->tasks->u.retrieve.resultset;
2623 start = &c->tasks->u.retrieve.start;
2624 count = &c->tasks->u.retrieve.count;
2625 syntax = c->tasks->u.retrieve.syntax;
2626 elementSetName = c->tasks->u.retrieve.elementSetName;
2629 return zoom_complete;
2631 yaz_log(log_details, "%p send_present start=%d count=%d",
2634 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2636 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2639 if (c->error) /* don't continue on error */
2640 return zoom_complete;
2641 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2642 resultset, *start, *count);
2644 for (i = 0; i < *count; i++)
2647 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2652 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2653 ZOOM_connection_put_event(c, event);
2661 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2662 return zoom_complete;
2665 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2666 req = apdu->u.presentRequest;
2669 yaz_log(log_details, "%p send_present skip=%d", c, i);
2671 *req->resultSetStartPoint = *start + 1;
2673 if (resultset->step > 0 && resultset->step < *count)
2674 *req->numberOfRecordsRequested = resultset->step;
2676 *req->numberOfRecordsRequested = *count;
2678 if (*req->numberOfRecordsRequested + *start > resultset->size)
2679 *req->numberOfRecordsRequested = resultset->size - *start;
2680 assert(*req->numberOfRecordsRequested > 0);
2682 if (syntax && *syntax)
2683 req->preferredRecordSyntax =
2684 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2686 if (resultset->schema && *resultset->schema)
2688 Z_RecordComposition *compo = (Z_RecordComposition *)
2689 odr_malloc(c->odr_out, sizeof(*compo));
2691 req->recordComposition = compo;
2692 compo->which = Z_RecordComp_complex;
2693 compo->u.complex = (Z_CompSpec *)
2694 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2695 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2696 odr_malloc(c->odr_out, sizeof(bool_t));
2697 *compo->u.complex->selectAlternativeSyntax = 0;
2699 compo->u.complex->generic = (Z_Specification *)
2700 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2702 compo->u.complex->generic->which = Z_Schema_oid;
2703 compo->u.complex->generic->schema.oid = (Odr_oid *)
2704 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2706 if (!compo->u.complex->generic->schema.oid)
2708 /* OID wasn't a schema! Try record syntax instead. */
2710 compo->u.complex->generic->schema.oid = (Odr_oid *)
2711 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2713 if (elementSetName && *elementSetName)
2715 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2716 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2717 compo->u.complex->generic->elementSpec->which =
2718 Z_ElementSpec_elementSetName;
2719 compo->u.complex->generic->elementSpec->u.elementSetName =
2720 odr_strdup(c->odr_out, elementSetName);
2723 compo->u.complex->generic->elementSpec = 0;
2724 compo->u.complex->num_dbSpecific = 0;
2725 compo->u.complex->dbSpecific = 0;
2726 compo->u.complex->num_recordSyntax = 0;
2727 compo->u.complex->recordSyntax = 0;
2729 else if (elementSetName && *elementSetName)
2731 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2732 odr_malloc(c->odr_out, sizeof(*esn));
2733 Z_RecordComposition *compo = (Z_RecordComposition *)
2734 odr_malloc(c->odr_out, sizeof(*compo));
2736 esn->which = Z_ElementSetNames_generic;
2737 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2738 compo->which = Z_RecordComp_simple;
2739 compo->u.simple = esn;
2740 req->recordComposition = compo;
2742 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2743 return send_APDU(c, apdu);
2746 ZOOM_API(ZOOM_scanset)
2747 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2750 ZOOM_query q = ZOOM_query_create();
2752 ZOOM_query_prefix(q, start);
2754 s = ZOOM_connection_scan1(c, q);
2755 ZOOM_query_destroy(q);
2760 ZOOM_API(ZOOM_scanset)
2761 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2763 ZOOM_scanset scan = 0;
2767 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2768 scan->connection = c;
2769 scan->odr = odr_createmem(ODR_DECODE);
2770 scan->options = ZOOM_options_create_with_parent(c->options);
2772 scan->scan_response = 0;
2773 scan->srw_scan_response = 0;
2777 scan->databaseNames = set_DatabaseNames(c, c->options,
2778 &scan->num_databaseNames,
2783 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2784 task->u.scan.scan = scan;
2789 while (ZOOM_event(1, &c))
2797 ZOOM_scanset_destroy(ZOOM_scanset scan)
2802 if (scan->refcount == 0)
2804 ZOOM_query_destroy(scan->query);
2806 odr_destroy(scan->odr);
2808 ZOOM_options_destroy(scan->options);
2813 static zoom_ret send_package(ZOOM_connection c)
2817 yaz_log(log_details, "%p send_package", c);
2819 return zoom_complete;
2820 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2822 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2823 ZOOM_connection_put_event(c, event);
2825 c->buf_out = c->tasks->u.package->buf_out;
2826 c->len_out = c->tasks->u.package->len_out;
2831 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2834 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2835 Z_ScanRequest *req = apdu->u.scanRequest;
2837 yaz_log(log_details, "%p send_scan", c);
2839 return zoom_complete;
2840 assert (c->tasks->which == ZOOM_TASK_SCAN);
2841 scan = c->tasks->u.scan.scan;
2843 /* Z39.50 scan can only carry RPN */
2844 if (scan->query->z_query->which == Z_Query_type_1 ||
2845 scan->query->z_query->which == Z_Query_type_101)
2847 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2848 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2851 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2854 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2856 yaz_query_charset_convert_rpnquery(
2857 rpn, c->odr_out, cd);
2858 yaz_iconv_close(cd);
2861 req->attributeSet = rpn->attributeSetId;
2862 if (!req->attributeSet)
2863 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2864 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2865 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2867 req->termListAndStartPoint =
2868 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2872 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2873 return zoom_complete;
2878 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2879 return zoom_complete;
2882 *req->numberOfTermsRequested =
2883 ZOOM_options_get_int(scan->options, "number", 10);
2885 req->preferredPositionInResponse =
2886 odr_intdup(c->odr_out,
2887 ZOOM_options_get_int(scan->options, "position", 1));
2890 odr_intdup(c->odr_out,
2891 ZOOM_options_get_int(scan->options, "stepSize", 0));
2893 req->databaseNames = scan->databaseNames;
2894 req->num_databaseNames = scan->num_databaseNames;
2896 return send_APDU(c, apdu);
2900 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2904 const char *option_val = 0;
2907 return zoom_complete;
2908 assert (c->tasks->which == ZOOM_TASK_SCAN);
2909 scan = c->tasks->u.scan.scan;
2911 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2913 /* SRU scan can only carry CQL and PQF */
2914 if (scan->query->z_query->which == Z_Query_type_104)
2916 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2917 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2919 else if (scan->query->z_query->which == Z_Query_type_1
2920 || scan->query->z_query->which == Z_Query_type_101)
2922 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2923 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2927 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2928 return zoom_complete;
2931 sr->u.scan_request->maximumTerms = odr_intdup(
2932 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2934 sr->u.scan_request->responsePosition = odr_intdup(
2935 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2937 option_val = ZOOM_options_get(scan->options, "extraArgs");
2938 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2939 return send_srw(c, sr);
2942 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2944 return zoom_complete;
2950 ZOOM_scanset_size(ZOOM_scanset scan)
2955 if (scan->scan_response && scan->scan_response->entries)
2956 return scan->scan_response->entries->num_entries;
2957 else if (scan->srw_scan_response)
2958 return scan->srw_scan_response->num_terms;
2962 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2964 const char **value_term, size_t *value_len,
2965 const char **disp_term, size_t *disp_len)
2967 size_t noent = ZOOM_scanset_size(scan);
2978 if (scan->scan_response)
2980 Z_ScanResponse *res = scan->scan_response;
2981 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2983 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2985 *value_term = (const char *) t->term->u.general->buf;
2986 *value_len = t->term->u.general->len;
2989 *disp_term = t->displayTerm;
2990 *disp_len = strlen(*disp_term);
2992 else if (t->term->which == Z_Term_general)
2994 *disp_term = (const char *) t->term->u.general->buf;
2995 *disp_len = t->term->u.general->len;
2997 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3000 if (scan->srw_scan_response)
3002 Z_SRW_scanResponse *res = scan->srw_scan_response;
3003 Z_SRW_scanTerm *t = res->terms + pos;
3006 *value_term = t->value;
3007 *value_len = strlen(*value_term);
3010 *disp_term = t->displayTerm;
3012 *disp_term = t->value;
3013 *disp_len = strlen(*disp_term);
3014 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3019 ZOOM_API(const char *)
3020 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3021 size_t *occ, size_t *len)
3023 const char *value_term = 0;
3024 size_t value_len = 0;
3025 const char *disp_term = 0;
3026 size_t disp_len = 0;
3028 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3029 &disp_term, &disp_len);
3035 ZOOM_API(const char *)
3036 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3037 size_t *occ, size_t *len)
3039 const char *value_term = 0;
3040 size_t value_len = 0;
3041 const char *disp_term = 0;
3042 size_t disp_len = 0;
3044 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3045 &disp_term, &disp_len);
3051 ZOOM_API(const char *)
3052 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3054 return ZOOM_options_get(scan->options, key);
3058 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3061 ZOOM_options_set(scan->options, key, val);
3064 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3067 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3068 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3070 str = ZOOM_options_get(p->options, "package-name");
3072 req->packageName = odr_strdup(p->odr_out, str);
3074 str = ZOOM_options_get(p->options, "user-id");
3076 req->userId = odr_strdup_null(p->odr_out, str);
3078 req->packageType = odr_oiddup(p->odr_out, oid);
3080 str = ZOOM_options_get(p->options, "function");
3083 if (!strcmp (str, "create"))
3084 *req->function = Z_ExtendedServicesRequest_create;
3085 if (!strcmp (str, "delete"))
3086 *req->function = Z_ExtendedServicesRequest_delete;
3087 if (!strcmp (str, "modify"))
3088 *req->function = Z_ExtendedServicesRequest_modify;
3091 str = ZOOM_options_get(p->options, "waitAction");
3094 if (!strcmp (str, "wait"))
3095 *req->waitAction = Z_ExtendedServicesRequest_wait;
3096 if (!strcmp (str, "waitIfPossible"))
3097 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3098 if (!strcmp (str, "dontWait"))
3099 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3100 if (!strcmp (str, "dontReturnPackage"))
3101 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3106 static const char *ill_array_lookup(void *clientData, const char *idx)
3108 ZOOM_package p = (ZOOM_package) clientData;
3109 return ZOOM_options_get(p->options, idx+4);
3112 static Z_External *encode_ill_request(ZOOM_package p)
3114 ODR out = p->odr_out;
3117 struct ill_get_ctl ctl;
3119 ctl.odr = p->odr_out;
3121 ctl.f = ill_array_lookup;
3123 req = ill_get_ILLRequest(&ctl, "ill", 0);
3125 if (!ill_Request(out, &req, 0, 0))
3127 int ill_request_size;
3128 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3129 if (ill_request_buf)
3130 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3135 int illRequest_size = 0;
3136 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3138 r = (Z_External *) odr_malloc(out, sizeof(*r));
3139 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3140 r->indirect_reference = 0;
3142 r->which = Z_External_single;
3144 r->u.single_ASN1_type =
3145 odr_create_Odr_oct(out,
3146 (unsigned char *)illRequest_buf,
3152 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3154 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3158 req->which = Z_IOItemOrder_esRequest;
3159 req->u.esRequest = (Z_IORequest *)
3160 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3162 /* to keep part ... */
3163 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3164 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3165 req->u.esRequest->toKeep->supplDescription = 0;
3166 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3167 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3169 str = ZOOM_options_get(p->options, "contact-name");
3170 req->u.esRequest->toKeep->contact->name =
3171 odr_strdup_null(p->odr_out, str);
3173 str = ZOOM_options_get(p->options, "contact-phone");
3174 req->u.esRequest->toKeep->contact->phone =
3175 odr_strdup_null(p->odr_out, str);
3177 str = ZOOM_options_get(p->options, "contact-email");
3178 req->u.esRequest->toKeep->contact->email =
3179 odr_strdup_null(p->odr_out, str);
3181 req->u.esRequest->toKeep->addlBilling = 0;
3183 /* not to keep part ... */
3184 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3185 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3187 str = ZOOM_options_get(p->options, "itemorder-setname");
3192 req->u.esRequest->notToKeep->resultSetItem = 0;
3195 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3196 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3198 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3199 odr_strdup(p->odr_out, str);
3200 req->u.esRequest->notToKeep->resultSetItem->item =
3201 odr_intdup(p->odr_out, 0);
3203 str = ZOOM_options_get(p->options, "itemorder-item");
3204 *req->u.esRequest->notToKeep->resultSetItem->item =
3205 (str ? atoi(str) : 1);
3208 str = ZOOM_options_getl(p->options, "doc", &len);
3211 req->u.esRequest->notToKeep->itemRequest =
3212 z_ext_record_xml(p->odr_out, str, len);
3215 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3220 Z_APDU *create_admin_package(ZOOM_package p, int type,
3221 Z_ESAdminOriginPartToKeep **toKeepP,
3222 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3224 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3227 Z_ESAdminOriginPartToKeep *toKeep;
3228 Z_ESAdminOriginPartNotToKeep *notToKeep;
3229 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3230 const char *first_db = "Default";
3232 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3237 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3239 r->indirect_reference = 0;
3240 r->which = Z_External_ESAdmin;
3242 r->u.adminService = (Z_Admin *)
3243 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3244 r->u.adminService->which = Z_Admin_esRequest;
3245 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3246 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3248 toKeep = r->u.adminService->u.esRequest->toKeep =
3249 (Z_ESAdminOriginPartToKeep *)
3250 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3251 toKeep->which = type;
3252 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3253 toKeep->u.create = odr_nullval();
3254 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3256 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3257 (Z_ESAdminOriginPartNotToKeep *)
3258 odr_malloc(p->odr_out,
3259 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3260 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3261 notToKeep->u.recordsWillFollow = odr_nullval();
3265 *notToKeepP = notToKeep;
3270 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3272 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3273 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3274 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3276 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3284 req->taskSpecificParameters = ext;
3285 ext->direct_reference = req->packageType;
3286 ext->descriptor = 0;
3287 ext->indirect_reference = 0;
3289 ext->which = Z_External_octet;
3290 ext->u.single_ASN1_type =
3291 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3295 static Z_APDU *create_update_package(ZOOM_package p)
3298 const char *first_db = "Default";
3300 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3301 const char *action = ZOOM_options_get(p->options, "action");
3302 int recordIdOpaque_len;
3303 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3304 &recordIdOpaque_len);
3305 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3307 const char *record_buf = ZOOM_options_getl(p->options, "record",
3309 int recordOpaque_len;
3310 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3312 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3313 const char *version = ZOOM_options_get(p->options, "updateVersion");
3315 const char *correlationInfo_note =
3316 ZOOM_options_get(p->options, "correlationInfo.note");
3317 const char *correlationInfo_id =
3318 ZOOM_options_get(p->options, "correlationInfo.id");
3320 Odr_oid *syntax_oid = 0;
3321 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3327 if (!record_buf && !recordOpaque_buf)
3329 record_buf = "void";
3331 syntax_str = "SUTRS";
3336 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3337 CLASS_RECSYN, syntax_str,
3349 package_oid = yaz_oid_extserv_database_update_first_version;
3350 /* old update does not support specialUpdate */
3352 action = "recordInsert";
3356 action = "specialUpdate";
3357 package_oid = yaz_oid_extserv_database_update_second_version;
3361 action = "specialUpdate";
3362 package_oid = yaz_oid_extserv_database_update;
3368 if (!strcmp(action, "recordInsert"))
3369 action_no = Z_IUOriginPartToKeep_recordInsert;
3370 else if (!strcmp(action, "recordReplace"))
3371 action_no = Z_IUOriginPartToKeep_recordReplace;
3372 else if (!strcmp(action, "recordDelete"))
3373 action_no = Z_IUOriginPartToKeep_recordDelete;
3374 else if (!strcmp(action, "elementUpdate"))
3375 action_no = Z_IUOriginPartToKeep_elementUpdate;
3376 else if (!strcmp(action, "specialUpdate"))
3377 action_no = Z_IUOriginPartToKeep_specialUpdate;
3381 apdu = create_es_package(p, package_oid);
3384 Z_IUOriginPartToKeep *toKeep;
3385 Z_IUSuppliedRecords *notToKeep;
3386 Z_External *r = (Z_External *)
3387 odr_malloc(p->odr_out, sizeof(*r));
3388 const char *elementSetName =
3389 ZOOM_options_get(p->options, "elementSetName");
3391 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3393 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3395 r->which = Z_External_update;
3396 r->indirect_reference = 0;
3397 r->u.update = (Z_IUUpdate *)
3398 odr_malloc(p->odr_out, sizeof(*r->u.update));
3400 r->u.update->which = Z_IUUpdate_esRequest;
3401 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3402 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3403 toKeep = r->u.update->u.esRequest->toKeep =
3404 (Z_IUOriginPartToKeep *)
3405 odr_malloc(p->odr_out, sizeof(*toKeep));
3407 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3410 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3412 toKeep->actionQualifier = 0;
3413 toKeep->action = odr_intdup(p->odr_out, action_no);
3415 notToKeep = r->u.update->u.esRequest->notToKeep =
3416 (Z_IUSuppliedRecords *)
3417 odr_malloc(p->odr_out, sizeof(*notToKeep));
3419 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3420 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3421 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3422 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3423 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3426 notToKeep->elements[0]->u.opaque =
3427 odr_create_Odr_oct(p->odr_out,
3428 (const unsigned char *) recordIdOpaque,
3429 recordIdOpaque_len);
3431 else if (recordIdNumber)
3433 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3435 notToKeep->elements[0]->u.number =
3436 odr_intdup(p->odr_out, atoi(recordIdNumber));
3439 notToKeep->elements[0]->u.opaque = 0;
3440 notToKeep->elements[0]->supplementalId = 0;
3441 if (correlationInfo_note || correlationInfo_id)
3443 Z_IUCorrelationInfo *ci;
3444 ci = notToKeep->elements[0]->correlationInfo =
3445 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3446 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3447 ci->id = correlationInfo_id ?
3448 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3451 notToKeep->elements[0]->correlationInfo = 0;
3452 if (recordOpaque_buf)
3454 notToKeep->elements[0]->record =
3455 z_ext_record_oid_any(p->odr_out, syntax_oid,
3456 recordOpaque_buf, recordOpaque_len);
3460 notToKeep->elements[0]->record =
3461 z_ext_record_oid(p->odr_out, syntax_oid,
3462 record_buf, record_len);
3467 ODR print = odr_createmem(ODR_PRINT);
3469 z_APDU(print, &apdu, 0, 0);
3476 ZOOM_package_send(ZOOM_package p, const char *type)
3483 odr_reset(p->odr_out);
3486 if (!strcmp(type, "itemorder"))
3488 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3491 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3493 r->direct_reference =
3494 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3496 r->which = Z_External_itemOrder;
3497 r->indirect_reference = 0;
3498 r->u.itemOrder = encode_item_order(p);
3500 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3503 else if (!strcmp(type, "create")) /* create database */
3505 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3508 else if (!strcmp(type, "drop")) /* drop database */
3510 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3513 else if (!strcmp(type, "commit")) /* commit changes */
3515 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3518 else if (!strcmp(type, "update")) /* update record(s) */
3520 apdu = create_update_package(p);
3522 else if (!strcmp(type, "xmlupdate"))
3524 apdu = create_xmlupdate_package(p);
3528 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3532 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3533 task->u.package = p;
3534 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3535 p->buf_out = (char *) xmalloc(p->len_out);
3536 memcpy(p->buf_out, buf, p->len_out);
3541 while (ZOOM_event(1, &c))
3548 ZOOM_API(ZOOM_package)
3549 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3551 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3554 p->odr_out = odr_createmem(ODR_ENCODE);
3555 p->options = ZOOM_options_create_with_parent2(options, c->options);
3563 ZOOM_package_destroy(ZOOM_package p)
3568 if (p->refcount == 0)
3570 odr_destroy(p->odr_out);
3573 ZOOM_options_destroy(p->options);
3578 ZOOM_API(const char *)
3579 ZOOM_package_option_get(ZOOM_package p, const char *key)
3581 return ZOOM_options_get(p->options, key);
3584 ZOOM_API(const char *)
3585 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3587 return ZOOM_options_getl(p->options, key, lenp);
3591 ZOOM_package_option_set(ZOOM_package p, const char *key,
3594 ZOOM_options_set(p->options, key, val);
3598 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3599 const char *val, int len)
3601 ZOOM_options_setl(p->options, key, val, len);
3604 static int ZOOM_connection_exec_task(ZOOM_connection c)
3606 ZOOM_task task = c->tasks;
3607 zoom_ret ret = zoom_complete;
3611 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3612 c, task->which, task->running);
3613 if (c->error != ZOOM_ERROR_NONE)
3615 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3616 "removing tasks because of error = %d", c, c->error);
3617 ZOOM_connection_remove_tasks(c);
3622 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3623 "task already running", c);
3627 ret = zoom_complete;
3628 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3630 switch (task->which)
3632 case ZOOM_TASK_SEARCH:
3633 if (c->proto == PROTO_HTTP)
3634 ret = ZOOM_connection_srw_send_search(c);
3636 ret = ZOOM_connection_send_search(c);
3638 case ZOOM_TASK_RETRIEVE:
3639 if (c->proto == PROTO_HTTP)
3640 ret = ZOOM_connection_srw_send_search(c);
3642 ret = send_present(c);
3644 case ZOOM_TASK_CONNECT:
3645 ret = do_connect(c);
3647 case ZOOM_TASK_SCAN:
3648 if (c->proto == PROTO_HTTP)
3649 ret = ZOOM_connection_srw_send_scan(c);
3651 ret = ZOOM_connection_send_scan(c);
3653 case ZOOM_TASK_PACKAGE:
3654 ret = send_package(c);
3656 case ZOOM_TASK_SORT:
3657 c->tasks->u.sort.resultset->r_sort_spec =
3658 c->tasks->u.sort.q->sort_spec;
3659 ret = send_sort(c, c->tasks->u.sort.resultset);
3665 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3666 "remove tasks because no connection exist", c);
3667 ZOOM_connection_remove_tasks(c);
3669 if (ret == zoom_complete)
3671 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3672 "task removed (complete)", c);
3673 ZOOM_connection_remove_task(c);
3676 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3681 static zoom_ret send_sort_present(ZOOM_connection c)
3683 zoom_ret r = zoom_complete;
3685 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3686 r = send_sort(c, c->tasks->u.search.resultset);
3687 if (r == zoom_complete)
3688 r = send_present(c);
3692 static int es_response_taskpackage_update(ZOOM_connection c,
3693 Z_IUUpdateTaskPackage *utp)
3695 if (utp && utp->targetPart)
3697 Z_IUTargetPart *targetPart = utp->targetPart;
3698 switch ( *targetPart->updateStatus ) {
3699 case Z_IUTargetPart_success:
3700 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3702 case Z_IUTargetPart_partial:
3703 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3705 case Z_IUTargetPart_failure:
3706 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3707 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3708 response_diag(c, targetPart->globalDiagnostics[0]);
3711 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3716 static int es_response_taskpackage(ZOOM_connection c,
3717 Z_TaskPackage *taskPackage)
3720 Odr_oct *id = taskPackage->targetReference;
3722 ZOOM_options_setl(c->tasks->u.package->options,
3723 "targetReference", (char*) id->buf, id->len);
3726 switch ( *taskPackage->taskStatus ) {
3727 case Z_TaskPackage_pending:
3728 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3730 case Z_TaskPackage_active:
3731 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3733 case Z_TaskPackage_complete:
3734 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3736 case Z_TaskPackage_aborted:
3737 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3738 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3739 response_diag(c, taskPackage->packageDiagnostics[0]);
3743 // taskSpecificParameters
3744 // NOTE: Only Update implemented, no others.
3745 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3746 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3747 es_response_taskpackage_update(c, utp);
3753 static int es_response(ZOOM_connection c,
3754 Z_ExtendedServicesResponse *res)
3756 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3758 switch (*res->operationStatus) {
3759 case Z_ExtendedServicesResponse_done:
3760 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3762 case Z_ExtendedServicesResponse_accepted:
3763 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3765 case Z_ExtendedServicesResponse_failure:
3766 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3767 if (res->diagnostics && res->num_diagnostics > 0)
3768 response_diag(c, res->diagnostics[0]);
3771 if (res->taskPackage &&
3772 res->taskPackage->which == Z_External_extendedService)
3774 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3775 es_response_taskpackage(c, taskPackage);
3777 if (res->taskPackage &&
3778 res->taskPackage->which == Z_External_octet)
3780 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3781 ZOOM_options_setl(c->tasks->u.package->options,
3782 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3787 static void interpret_init_diag(ZOOM_connection c,
3788 Z_DiagnosticFormat *diag)
3792 Z_DiagnosticFormat_s *ds = diag->elements[0];
3793 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3794 response_default_diag(c, ds->u.defaultDiagRec);
3799 static void interpret_otherinformation_field(ZOOM_connection c,
3800 Z_OtherInformation *ui)
3803 for (i = 0; i < ui->num_elements; i++)
3805 Z_OtherInformationUnit *unit = ui->list[i];
3806 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3807 unit->information.externallyDefinedInfo &&
3808 unit->information.externallyDefinedInfo->which ==
3811 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3817 static void set_init_option(const char *name, void *clientData) {
3818 ZOOM_connection c = (ZOOM_connection) clientData;
3821 sprintf(buf, "init_opt_%.70s", name);
3822 ZOOM_connection_option_set(c, buf, "1");
3826 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3828 Z_InitResponse *initrs;
3830 ZOOM_connection_set_mask(c, 0);
3831 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3834 case Z_APDU_initResponse:
3835 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3836 initrs = apdu->u.initResponse;
3837 ZOOM_connection_option_set(c, "serverImplementationId",
3838 initrs->implementationId ?
3839 initrs->implementationId : "");
3840 ZOOM_connection_option_set(c, "serverImplementationName",
3841 initrs->implementationName ?
3842 initrs->implementationName : "");
3843 ZOOM_connection_option_set(c, "serverImplementationVersion",
3844 initrs->implementationVersion ?
3845 initrs->implementationVersion : "");
3846 /* Set the three old options too, for old applications */
3847 ZOOM_connection_option_set(c, "targetImplementationId",
3848 initrs->implementationId ?
3849 initrs->implementationId : "");
3850 ZOOM_connection_option_set(c, "targetImplementationName",
3851 initrs->implementationName ?
3852 initrs->implementationName : "");
3853 ZOOM_connection_option_set(c, "targetImplementationVersion",
3854 initrs->implementationVersion ?
3855 initrs->implementationVersion : "");
3857 /* Make initrs->options available as ZOOM-level options */
3858 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3860 if (!*initrs->result)
3862 Z_External *uif = initrs->userInformationField;
3864 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3866 if (uif && uif->which == Z_External_userInfo1)
3867 interpret_otherinformation_field(c, uif->u.userInfo1);
3872 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3873 yaz_oid_userinfo_cookie, 1, 0);
3874 xfree(c->cookie_in);
3877 c->cookie_in = xstrdup(cookie);
3878 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3879 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3880 c->support_named_resultsets = 1;
3883 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3884 ZOOM_connection_remove_task(c);
3886 ZOOM_connection_exec_task(c);
3888 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3890 NMEM tmpmem = nmem_create();
3891 Z_CharSetandLanguageNegotiation *p =
3892 yaz_get_charneg_record(initrs->otherInfo);
3896 char *charset = NULL, *lang = NULL;
3899 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3900 yaz_log(log_details, "%p recv_apdu target accepted: "
3901 "charset %s, language %s, select %d",
3903 charset ? charset : "none", lang ? lang : "none", sel);
3905 ZOOM_connection_option_set(c, "negotiation-charset",
3908 ZOOM_connection_option_set(c, "negotiation-lang",
3911 ZOOM_connection_option_set(
3912 c, "negotiation-charset-in-effect-for-records",
3913 (sel != 0) ? "1" : "0");
3914 nmem_destroy(tmpmem);
3918 case Z_APDU_searchResponse:
3919 yaz_log(log_api, "%p recv_apdu Search response", c);
3920 handle_search_response(c, apdu->u.searchResponse);
3921 if (send_sort_present(c) == zoom_complete)
3922 ZOOM_connection_remove_task(c);
3924 case Z_APDU_presentResponse:
3925 yaz_log(log_api, "%p recv_apdu Present response", c);
3926 handle_present_response(c, apdu->u.presentResponse);
3927 if (send_present(c) == zoom_complete)
3928 ZOOM_connection_remove_task(c);
3930 case Z_APDU_sortResponse:
3931 yaz_log(log_api, "%p recv_apdu Sort response", c);
3932 sort_response(c, apdu->u.sortResponse);
3933 if (send_present(c) == zoom_complete)
3934 ZOOM_connection_remove_task(c);
3936 case Z_APDU_scanResponse:
3937 yaz_log(log_api, "%p recv_apdu Scan response", c);
3938 scan_response(c, apdu->u.scanResponse);
3939 ZOOM_connection_remove_task(c);
3941 case Z_APDU_extendedServicesResponse:
3942 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3943 es_response(c, apdu->u.extendedServicesResponse);
3944 ZOOM_connection_remove_task(c);
3947 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3948 if (!ZOOM_test_reconnect(c))
3950 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3955 yaz_log(log_api, "%p Received unknown PDU", c);
3956 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3962 static zoom_ret handle_srw_response(ZOOM_connection c,
3963 Z_SRW_searchRetrieveResponse *res)
3965 ZOOM_resultset resultset = 0;
3970 const char *syntax, *elementSetName;
3973 return zoom_complete;
3975 switch(c->tasks->which)
3977 case ZOOM_TASK_SEARCH:
3978 resultset = c->tasks->u.search.resultset;
3979 start = &c->tasks->u.search.start;
3980 count = &c->tasks->u.search.count;
3981 syntax = c->tasks->u.search.syntax;
3982 elementSetName = c->tasks->u.search.elementSetName;
3984 if (!c->tasks->u.search.recv_search_fired)
3986 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3987 ZOOM_connection_put_event(c, event);
3988 c->tasks->u.search.recv_search_fired = 1;
3991 case ZOOM_TASK_RETRIEVE:
3992 resultset = c->tasks->u.retrieve.resultset;
3993 start = &c->tasks->u.retrieve.start;
3994 count = &c->tasks->u.retrieve.count;
3995 syntax = c->tasks->u.retrieve.syntax;
3996 elementSetName = c->tasks->u.retrieve.elementSetName;
3999 return zoom_complete;
4002 resultset->size = 0;
4004 if (res->resultSetId)
4005 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4007 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4009 if (res->num_diagnostics > 0)
4011 set_SRU_error(c, &res->diagnostics[0]);
4015 if (res->numberOfRecords)
4016 resultset->size = *res->numberOfRecords;
4017 for (i = 0; i<res->num_records; i++)
4020 Z_SRW_record *sru_rec;
4021 Z_SRW_diagnostic *diag = 0;
4024 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4025 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4027 if (res->records[i].recordPosition &&
4028 *res->records[i].recordPosition > 0)
4029 pos = *res->records[i].recordPosition - 1;
4033 sru_rec = &res->records[i];
4035 npr->databaseName = 0;
4036 npr->which = Z_NamePlusRecord_databaseRecord;
4037 npr->u.databaseRecord = (Z_External *)
4038 odr_malloc(c->odr_in, sizeof(Z_External));
4039 npr->u.databaseRecord->descriptor = 0;
4040 npr->u.databaseRecord->direct_reference =
4041 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4042 npr->u.databaseRecord->which = Z_External_octet;
4044 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4045 odr_malloc(c->odr_in, sizeof(Odr_oct));
4046 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4047 sru_rec->recordData_buf;
4048 npr->u.databaseRecord->u.octet_aligned->len =
4049 npr->u.databaseRecord->u.octet_aligned->size =
4050 sru_rec->recordData_len;
4052 if (sru_rec->recordSchema
4053 && !strcmp(sru_rec->recordSchema,
4054 "info:srw/schema/1/diagnostics-v1.1"))
4056 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4057 sru_rec->recordData_len,
4061 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4062 sru_rec->recordSchema, diag);
4066 if (*count + *start > resultset->size)
4067 *count = resultset->size - *start;
4071 nmem = odr_extract_mem(c->odr_in);
4072 nmem_transfer(odr_getmem(resultset->odr), nmem);
4076 return ZOOM_connection_srw_send_search(c);
4078 return zoom_complete;
4083 static void handle_srw_scan_response(ZOOM_connection c,
4084 Z_SRW_scanResponse *res)
4086 NMEM nmem = odr_extract_mem(c->odr_in);
4089 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4091 scan = c->tasks->u.scan.scan;
4093 if (res->num_diagnostics > 0)
4094 set_SRU_error(c, &res->diagnostics[0]);
4096 scan->scan_response = 0;
4097 scan->srw_scan_response = res;
4098 nmem_transfer(odr_getmem(scan->odr), nmem);
4100 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4106 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4108 zoom_ret cret = zoom_complete;
4110 const char *addinfo = 0;
4111 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4113 ZOOM_connection_set_mask(c, 0);
4114 yaz_log(log_details, "%p handle_http", c);
4116 if (!yaz_srw_check_content_type(hres))
4117 addinfo = "content-type";
4120 Z_SOAP *soap_package = 0;
4122 Z_SOAP_Handler soap_handlers[2] = {
4123 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4126 ret = z_soap_codec(o, &soap_package,
4127 &hres->content_buf, &hres->content_len,
4129 if (!ret && soap_package->which == Z_SOAP_generic &&
4130 soap_package->u.generic->no == 0)
4132 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4134 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4135 ZOOM_options_setl(c->options, "sru_extra_response_data",
4136 sr->extraResponseData_buf, sr->extraResponseData_len);
4137 if (sr->which == Z_SRW_searchRetrieve_response)
4138 cret = handle_srw_response(c, sr->u.response);
4139 else if (sr->which == Z_SRW_scan_response)
4140 handle_srw_scan_response(c, sr->u.scan_response);
4144 else if (!ret && (soap_package->which == Z_SOAP_fault
4145 || soap_package->which == Z_SOAP_error))
4147 set_HTTP_error(c, hres->code,
4148 soap_package->u.fault->fault_code,
4149 soap_package->u.fault->fault_string);
4156 if (hres->code != 200)
4157 set_HTTP_error(c, hres->code, 0, 0);
4159 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4162 if (cret == zoom_complete)
4163 ZOOM_connection_remove_task(c);
4164 if (!strcmp(hres->version, "1.0"))
4166 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4167 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4172 /* HTTP 1.1: only if no close we stay alive .. */
4173 if (connection_head && !strcmp(connection_head, "close"))
4179 static int do_read(ZOOM_connection c)
4184 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4185 ZOOM_connection_put_event(c, event);
4187 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4188 more = cs_more(c->cs);
4189 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4194 if (!ZOOM_test_reconnect(c))
4196 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4205 odr_reset(c->odr_in);
4206 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4207 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4208 ZOOM_connection_put_event(c, event);
4210 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4213 int err = odr_geterrorx(c->odr_in, &x);
4215 const char *element = odr_getelement(c->odr_in);
4216 yaz_snprintf(msg, sizeof(msg),
4217 "ODR code %d:%d element=%s offset=%d",
4218 err, x, element ? element : "<unknown>",
4219 odr_offset(c->odr_in));
4220 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4223 FILE *ber_file = yaz_log_file();
4225 odr_dumpBER(ber_file, c->buf_in, r);
4232 z_GDU(c->odr_print, &gdu, 0, 0);
4233 if (gdu->which == Z_GDU_Z3950)
4234 recv_apdu(c, gdu->u.z3950);
4235 else if (gdu->which == Z_GDU_HTTP_Response)
4238 handle_http(c, gdu->u.HTTP_Response);
4240 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4245 c->reconnect_ok = 0;
4250 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4255 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4256 ZOOM_connection_put_event(c, event);
4258 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4259 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4261 yaz_log(log_details, "%p do_write_ex write failed", c);
4262 if (ZOOM_test_reconnect(c))
4264 return zoom_pending;
4266 if (c->state == STATE_CONNECTING)
4267 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4269 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4271 return zoom_complete;
4275 int mask = ZOOM_SELECT_EXCEPT;
4276 if (c->cs->io_pending & CS_WANT_WRITE)
4277 mask += ZOOM_SELECT_WRITE;
4278 if (c->cs->io_pending & CS_WANT_READ)
4279 mask += ZOOM_SELECT_READ;
4280 ZOOM_connection_set_mask(c, mask);
4281 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4286 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4287 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4290 return zoom_pending;
4293 static zoom_ret do_write(ZOOM_connection c)
4295 return do_write_ex(c, c->buf_out, c->len_out);
4299 ZOOM_API(const char *)
4300 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4302 return ZOOM_options_get(c->options, key);
4305 ZOOM_API(const char *)
4306 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4308 return ZOOM_options_getl(c->options, key, lenp);
4312 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4315 ZOOM_options_set(c->options, key, val);
4319 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4320 const char *val, int len)
4322 ZOOM_options_setl(c->options, key, val, len);
4325 ZOOM_API(const char *)
4326 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4328 return ZOOM_options_get(r->options, key);
4332 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4335 ZOOM_options_set(r->options, key, val);
4340 ZOOM_connection_errcode(ZOOM_connection c)
4342 return ZOOM_connection_error(c, 0, 0);
4345 ZOOM_API(const char *)
4346 ZOOM_connection_errmsg(ZOOM_connection c)
4349 ZOOM_connection_error(c, &msg, 0);
4353 ZOOM_API(const char *)
4354 ZOOM_connection_addinfo(ZOOM_connection c)
4356 const char *addinfo;
4357 ZOOM_connection_error(c, 0, &addinfo);
4361 ZOOM_API(const char *)
4362 ZOOM_connection_diagset(ZOOM_connection c)
4364 const char *diagset;
4365 ZOOM_connection_error_x(c, 0, 0, &diagset);
4369 ZOOM_API(const char *)
4370 ZOOM_diag_str(int error)
4374 case ZOOM_ERROR_NONE:
4376 case ZOOM_ERROR_CONNECT:
4377 return "Connect failed";
4378 case ZOOM_ERROR_MEMORY:
4379 return "Out of memory";
4380 case ZOOM_ERROR_ENCODE:
4381 return "Encoding failed";
4382 case ZOOM_ERROR_DECODE:
4383 return "Decoding failed";
4384 case ZOOM_ERROR_CONNECTION_LOST:
4385 return "Connection lost";
4386 case ZOOM_ERROR_INIT:
4387 return "Init rejected";
4388 case ZOOM_ERROR_INTERNAL:
4389 return "Internal failure";
4390 case ZOOM_ERROR_TIMEOUT:
4392 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4393 return "Unsupported protocol";
4394 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4395 return "Unsupported query type";
4396 case ZOOM_ERROR_INVALID_QUERY:
4397 return "Invalid query";
4398 case ZOOM_ERROR_CQL_PARSE:
4399 return "CQL parsing error";
4400 case ZOOM_ERROR_CQL_TRANSFORM:
4401 return "CQL transformation error";
4402 case ZOOM_ERROR_CCL_CONFIG:
4403 return "CCL configuration error";
4404 case ZOOM_ERROR_CCL_PARSE:
4405 return "CCL parsing error";
4407 return diagbib1_str(error);
4412 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4413 const char **addinfo, const char **diagset)
4415 int error = c->error;
4418 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4419 *cp = ZOOM_diag_str(error);
4420 else if (!strcmp(c->diagset, "HTTP"))
4421 *cp = z_HTTP_errmsg(c->error);
4422 else if (!strcmp(c->diagset, "Bib-1"))
4423 *cp = ZOOM_diag_str(error);
4424 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4425 *cp = yaz_diag_srw_str(c->error);
4427 *cp = "Unknown error and diagnostic set";
4430 *addinfo = c->addinfo ? c->addinfo : "";
4432 *diagset = c->diagset ? c->diagset : "";
4437 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4438 const char **addinfo)
4440 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4443 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4445 ZOOM_Event event = 0;
4446 int r = cs_look(c->cs);
4447 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4452 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4453 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4455 ZOOM_connection_put_event(c, event);
4457 else if (r == CS_CONNECT)
4459 int ret = ret = cs_rcvconnect(c->cs);
4460 yaz_log(log_details, "%p ZOOM_connection_do_io "
4461 "cs_rcvconnect returned %d", c, ret);
4464 int mask = ZOOM_SELECT_EXCEPT;
4465 if (c->cs->io_pending & CS_WANT_WRITE)
4466 mask += ZOOM_SELECT_WRITE;
4467 if (c->cs->io_pending & CS_WANT_READ)
4468 mask += ZOOM_SELECT_READ;
4469 ZOOM_connection_set_mask(c, mask);
4470 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4471 ZOOM_connection_put_event(c, event);
4475 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4476 ZOOM_connection_put_event(c, event);
4478 if (c->proto == PROTO_Z3950)
4479 ZOOM_connection_send_init(c);
4482 /* no init request for SRW .. */
4483 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4484 ZOOM_connection_remove_task(c);
4485 ZOOM_connection_set_mask(c, 0);
4486 ZOOM_connection_exec_task(c);
4488 c->state = STATE_ESTABLISHED;
4492 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4498 if (mask & ZOOM_SELECT_EXCEPT)
4500 if (!ZOOM_test_reconnect(c))
4502 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4507 if (mask & ZOOM_SELECT_READ)
4509 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4515 ZOOM_connection_last_event(ZOOM_connection cs)
4518 return ZOOM_EVENT_NONE;
4519 return cs->last_event;
4523 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4525 WRBUF wrbuf = (WRBUF) client_data;
4526 wrbuf_puts(wrbuf, buf);
4530 * Returns an xmalloc()d string containing RPN that corresponds to the
4531 * CQL passed in. On error, sets the Connection object's error state
4532 * and returns a null pointer.
4533 * ### We could cache CQL parser and/or transformer in Connection.
4535 static char *cql2pqf(ZOOM_connection c, const char *cql)
4539 const char *cqlfile;
4540 cql_transform_t trans;
4543 parser = cql_parser_create();
4544 if ((error = cql_parser_string(parser, cql)) != 0) {
4545 cql_parser_destroy(parser);
4546 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4550 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4553 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4555 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4558 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4559 cqlfile, strerror(errno));
4560 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4564 WRBUF wrbuf_result = wrbuf_alloc();
4565 error = cql_transform(trans, cql_parser_result(parser),
4566 cql2pqf_wrbuf_puts, wrbuf_result);
4569 const char *addinfo;
4570 error = cql_transform_error(trans, &addinfo);
4571 sprintf(buf, "%.200s (addinfo=%.200s)",
4572 cql_strerror(error), addinfo);
4573 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4577 result = xstrdup(wrbuf_cstr(wrbuf_result));
4579 cql_transform_close(trans);
4580 wrbuf_destroy(wrbuf_result);
4582 cql_parser_destroy(parser);
4586 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4590 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4591 /* timeout and this connection was waiting */
4592 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4594 ZOOM_connection_put_event(c, event);
4600 ZOOM_connection_process(ZOOM_connection c)
4606 event = ZOOM_connection_get_event(c);
4609 ZOOM_Event_destroy(event);
4612 ZOOM_connection_exec_task(c);
4613 event = ZOOM_connection_get_event(c);
4616 ZOOM_Event_destroy(event);
4623 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4627 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4629 for (i = 0; i<no; i++)
4631 ZOOM_connection c = cs[i];
4633 if (c && ZOOM_connection_process(c))
4639 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4641 if (c->mask && mask)
4642 ZOOM_connection_do_io(c, mask);
4646 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4649 return cs_fileno(c->cs);
4653 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4661 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4668 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4670 return ZOOM_options_get_int(c->options, "timeout", 30);
4676 * c-file-style: "Stroustrup"
4677 * indent-tabs-mode: nil
4679 * vim: shiftwidth=4 tabstop=8 expandtab