1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM C interface.
15 #include <yaz/yaz-util.h>
16 #include <yaz/xmalloc.h>
17 #include <yaz/otherinfo.h>
19 #include <yaz/pquery.h>
20 #include <yaz/marcdisp.h>
21 #include <yaz/diagbib1.h>
22 #include <yaz/charneg.h>
27 #include <yaz/query-charset.h>
28 #include <yaz/copy_types.h>
29 #include <yaz/snprintf.h>
31 static int log_api = 0;
32 static int log_details = 0;
39 static void resultset_destroy(ZOOM_resultset r);
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
46 * This wrapper is just for logging failed lookups. It would be nicer
47 * if it could cause failure when a lookup fails, but that's hard.
49 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
50 oid_class oid_class, const char *str) {
51 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
54 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
55 c, (int) oid_class, str);
60 static void initlog(void)
62 static int log_level_initialized = 0;
63 if (!log_level_initialized)
65 log_api = yaz_log_module_level("zoom");
66 log_details = yaz_log_module_level("zoomdetails");
67 log_level_initialized = 1;
71 static ZOOM_Event ZOOM_Event_create(int kind)
73 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
77 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
81 static void ZOOM_Event_destroy(ZOOM_Event event)
86 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
90 c->m_queue_back->prev = event;
91 assert(c->m_queue_front);
95 assert(!c->m_queue_front);
96 c->m_queue_front = event;
98 event->next = c->m_queue_back;
100 c->m_queue_back = event;
103 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
105 ZOOM_Event event = c->m_queue_front;
108 c->last_event = ZOOM_EVENT_NONE;
111 assert(c->m_queue_back);
112 c->m_queue_front = event->prev;
113 if (c->m_queue_front)
115 assert(c->m_queue_back);
116 c->m_queue_front->next = 0;
120 c->last_event = event->kind;
124 static void ZOOM_connection_remove_events(ZOOM_connection c)
127 while ((event = ZOOM_connection_get_event(c)))
128 ZOOM_Event_destroy(event);
131 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
133 ZOOM_Event event = c->m_queue_front;
135 return event ? event->kind : ZOOM_EVENT_NONE;
138 void ZOOM_connection_remove_tasks(ZOOM_connection c);
140 static void set_dset_error(ZOOM_connection c, int error,
142 const char *addinfo, const char *addinfo2)
149 if (!c->diagset || strcmp(dset, c->diagset))
152 c->diagset = xstrdup(dset);
153 /* remove integer part from SRW diagset .. */
154 if ((cp = strrchr(c->diagset, '/')))
157 if (addinfo && addinfo2)
159 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
160 strcpy(c->addinfo, addinfo);
161 strcat(c->addinfo, addinfo2);
164 c->addinfo = xstrdup(addinfo);
165 if (error != ZOOM_ERROR_NONE)
167 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
168 c, c->host_port ? c->host_port : "<>", dset, error,
169 addinfo ? addinfo : "",
170 addinfo2 ? addinfo2 : "");
171 ZOOM_connection_remove_tasks(c);
175 static int uri_to_code(const char *uri)
179 if ((cp = strrchr(uri, '/')))
185 static void set_HTTP_error(ZOOM_connection c, int error,
186 const char *addinfo, const char *addinfo2)
188 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
191 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
193 const char *uri = d->uri;
195 set_dset_error(c, uri_to_code(uri), uri, d->details, 0);
201 static void set_ZOOM_error(ZOOM_connection c, int error,
204 set_dset_error(c, error, "ZOOM", addinfo, 0);
207 static void clear_error(ZOOM_connection c)
210 * If an error is tied to an operation then it's ok to clear: for
211 * example, a diagnostic returned from a search is cleared by a
212 * subsequent search. However, problems such as Connection Lost
213 * or Init Refused are not cleared, because they are not
214 * recoverable: doing another search doesn't help.
217 ZOOM_connection_remove_events(c);
220 case ZOOM_ERROR_CONNECT:
221 case ZOOM_ERROR_MEMORY:
222 case ZOOM_ERROR_DECODE:
223 case ZOOM_ERROR_CONNECTION_LOST:
224 case ZOOM_ERROR_INIT:
225 case ZOOM_ERROR_INTERNAL:
226 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
229 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
233 void ZOOM_connection_show_task(ZOOM_task task)
237 case ZOOM_TASK_SEARCH:
238 yaz_log(YLOG_LOG, "search p=%p", task);
240 case ZOOM_TASK_RETRIEVE:
241 yaz_log(YLOG_LOG, "retrieve p=%p", task);
243 case ZOOM_TASK_CONNECT:
244 yaz_log(YLOG_LOG, "connect p=%p", task);
247 yaz_log(YLOG_LOG, "scant p=%p", task);
252 void ZOOM_connection_show_tasks(ZOOM_connection c)
255 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
256 for (task = c->tasks; task; task = task->next)
257 ZOOM_connection_show_task(task);
260 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
262 ZOOM_task *taskp = &c->tasks;
264 taskp = &(*taskp)->next;
265 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
266 (*taskp)->running = 0;
267 (*taskp)->which = which;
273 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
275 return c->tasks ? 0 : 1;
278 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
280 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
282 task->next = c->tasks;
291 void ZOOM_connection_remove_task(ZOOM_connection c)
293 ZOOM_task task = c->tasks;
297 c->tasks = task->next;
300 case ZOOM_TASK_SEARCH:
301 resultset_destroy(task->u.search.resultset);
302 xfree(task->u.search.syntax);
303 xfree(task->u.search.elementSetName);
305 case ZOOM_TASK_RETRIEVE:
306 resultset_destroy(task->u.retrieve.resultset);
307 xfree(task->u.retrieve.syntax);
308 xfree(task->u.retrieve.elementSetName);
310 case ZOOM_TASK_CONNECT:
313 ZOOM_scanset_destroy(task->u.scan.scan);
315 case ZOOM_TASK_PACKAGE:
316 ZOOM_package_destroy(task->u.package);
319 resultset_destroy(task->u.sort.resultset);
320 ZOOM_query_destroy(task->u.sort.q);
329 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
330 ZOOM_connection_put_event(c, event);
335 static int ZOOM_connection_exec_task(ZOOM_connection c);
337 void ZOOM_connection_remove_tasks(ZOOM_connection c)
340 ZOOM_connection_remove_task(c);
343 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
345 const char *elementSetName);
347 ZOOM_API(ZOOM_connection)
348 ZOOM_connection_create(ZOOM_options options)
350 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
354 yaz_log(log_api, "%p ZOOM_connection_create", c);
356 c->proto = PROTO_Z3950;
358 ZOOM_connection_set_mask(c, 0);
360 c->state = STATE_IDLE;
363 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
370 c->options = ZOOM_options_create_with_parent(options);
376 c->charset = c->lang = 0;
387 c->maximum_record_size = 0;
388 c->preferred_message_size = 0;
390 c->odr_in = odr_createmem(ODR_DECODE);
391 c->odr_out = odr_createmem(ODR_ENCODE);
394 c->support_named_resultsets = 0;
395 c->last_event = ZOOM_EVENT_NONE;
397 c->m_queue_front = 0;
405 /* set database names. Take local databases (if set); otherwise
406 take databases given in ZURL (if set); otherwise use Default */
407 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
410 char **databaseNames;
411 const char *cp = ZOOM_options_get(options, "databaseName");
413 if ((!cp || !*cp) && con->host_port)
415 if (strncmp(con->host_port, "unix:", 5) == 0)
416 cp = strchr(con->host_port+5, ':');
418 cp = strchr(con->host_port, '/');
424 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
425 return databaseNames;
428 ZOOM_API(ZOOM_connection)
429 ZOOM_connection_new(const char *host, int portnum)
431 ZOOM_connection c = ZOOM_connection_create(0);
433 ZOOM_connection_connect(c, host, portnum);
437 static zoom_sru_mode get_sru_mode_from_string(const char *s)
440 return zoom_sru_soap;
441 if (!yaz_matchstr(s, "soap"))
442 return zoom_sru_soap;
443 else if (!yaz_matchstr(s, "get"))
445 else if (!yaz_matchstr(s, "post"))
446 return zoom_sru_post;
447 return zoom_sru_error;
451 ZOOM_connection_connect(ZOOM_connection c,
452 const char *host, int portnum)
459 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
460 c, host ? host : "null", portnum);
462 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
463 ZOOM_connection_remove_tasks(c);
467 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
471 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
474 val = ZOOM_options_get(c->options, "proxy");
477 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
478 c->proxy = xstrdup(val);
483 val = ZOOM_options_get(c->options, "charset");
486 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
487 c->charset = xstrdup(val);
491 val = ZOOM_options_get(c->options, "lang");
494 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
495 c->lang = xstrdup(val);
506 sprintf(hostn, "%.80s:%d", host, portnum);
507 c->host_port = xstrdup(hostn);
510 c->host_port = xstrdup(host);
515 * If the "<scheme>:" part of the host string is preceded by one
516 * or more comma-separated <name>=<value> pairs, these are taken
517 * to be options to be set on the connection object. Among other
518 * applications, this facility can be used to embed authentication
520 * user=admin,password=secret,tcp:localhost:9999
522 char *remainder = c->host_port;
523 char *pcolon = strchr(remainder, ':');
526 while ((pcomma = strchr(remainder, ',')) != 0 &&
527 (pcolon == 0 || pcomma < pcolon)) {
529 if ((pequals = strchr(remainder, '=')) != 0) {
531 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
532 ZOOM_connection_option_set(c, remainder, pequals+1);
534 remainder = pcomma+1;
537 if (remainder != c->host_port) {
539 c->host_port = xstrdup(remainder);
540 /*printf("# reset hp='%s'\n", remainder);*/
544 val = ZOOM_options_get(c->options, "sru");
545 c->sru_mode = get_sru_mode_from_string(val);
547 xfree(c->sru_version);
548 val = ZOOM_options_get(c->options, "sru_version");
549 c->sru_version = xstrdup(val ? val : "1.2");
551 ZOOM_options_set(c->options, "host", c->host_port);
553 xfree(c->cookie_out);
555 val = ZOOM_options_get(c->options, "cookie");
558 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
559 c->cookie_out = xstrdup(val);
564 val = ZOOM_options_get(c->options, "clientIP");
567 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
569 c->client_IP = xstrdup(val);
574 val = ZOOM_options_get(c->options, "group");
576 c->group = xstrdup(val);
580 val = ZOOM_options_get(c->options, "user");
582 c->user = xstrdup(val);
586 val = ZOOM_options_get(c->options, "password");
588 val = ZOOM_options_get(c->options, "pass");
591 c->password = xstrdup(val);
593 c->maximum_record_size =
594 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
595 c->preferred_message_size =
596 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
598 c->async = ZOOM_options_get_bool(c->options, "async", 0);
599 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
601 c->odr_print = odr_createmem(ODR_PRINT);
602 odr_setprint(c->odr_print, yaz_log_file());
606 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
608 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
612 while (ZOOM_event(1, &c))
618 ZOOM_query_create(void)
620 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
622 yaz_log(log_details, "%p ZOOM_query_create", s);
626 s->odr = odr_createmem(ODR_ENCODE);
633 ZOOM_query_destroy(ZOOM_query s)
639 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
640 if (s->refcount == 0)
648 ZOOM_query_prefix(ZOOM_query s, const char *str)
650 s->query_string = odr_strdup(s->odr, str);
651 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
652 s->z_query->which = Z_Query_type_1;
653 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
654 if (!s->z_query->u.type_1)
656 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
660 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
665 ZOOM_query_cql(ZOOM_query s, const char *str)
669 s->query_string = odr_strdup(s->odr, str);
671 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
672 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
673 ext->indirect_reference = 0;
675 ext->which = Z_External_CQL;
676 ext->u.cql = s->query_string;
678 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
679 s->z_query->which = Z_Query_type_104;
680 s->z_query->u.type_104 = ext;
682 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
688 * Translate the CQL string client-side into RPN which is passed to
689 * the server. This is useful for server's that don't themselves
690 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
691 * only as a place to stash diagnostics if compilation fails; if this
692 * information is not needed, a null pointer may be used.
695 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
699 ZOOM_connection freeme = 0;
701 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
703 conn = freeme = ZOOM_connection_create(0);
705 rpn = cql2pqf(conn, str);
707 ZOOM_connection_destroy(freeme);
711 ret = ZOOM_query_prefix(s, rpn);
717 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
718 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
719 * to the server, as the YAZ GFS doesn't know how to handle this.
722 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
723 int *ccl_error, const char **error_string,
727 struct ccl_rpn_node *rpn;
728 CCL_bibset bibset = ccl_qual_mk();
731 ccl_qual_buf(bibset, config);
733 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
736 *error_string = ccl_err_msg(*ccl_error);
741 WRBUF wr = wrbuf_alloc();
744 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
747 ccl_qual_rm(&bibset);
752 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
754 s->sort_spec = yaz_sort_spec(s->odr, criteria);
757 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
761 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
765 static zoom_ret do_write(ZOOM_connection c);
768 ZOOM_connection_destroy(ZOOM_connection c)
773 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
776 for (r = c->resultsets; r; r = r->next)
782 odr_destroy(c->odr_in);
783 odr_destroy(c->odr_out);
786 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
787 odr_destroy(c->odr_print);
789 ZOOM_options_destroy(c->options);
790 ZOOM_connection_remove_tasks(c);
791 ZOOM_connection_remove_events(c);
797 xfree(c->cookie_out);
803 xfree(c->sru_version);
807 void ZOOM_resultset_addref(ZOOM_resultset r)
812 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
817 ZOOM_resultset ZOOM_resultset_create(void)
820 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
824 yaz_log(log_details, "%p ZOOM_resultset_create", r);
827 r->odr = odr_createmem(ODR_ENCODE);
832 for (i = 0; i<RECORD_HASH_SIZE; i++)
833 r->record_hash[i] = 0;
838 r->databaseNames = 0;
839 r->num_databaseNames = 0;
843 ZOOM_API(ZOOM_resultset)
844 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
847 ZOOM_query s = ZOOM_query_create();
849 ZOOM_query_prefix(s, q);
851 r = ZOOM_connection_search(c, s);
852 ZOOM_query_destroy(s);
856 ZOOM_API(ZOOM_resultset)
857 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
859 ZOOM_resultset r = ZOOM_resultset_create();
863 const char *syntax, *elementSetName;
865 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
866 r->r_sort_spec = q->sort_spec;
869 r->options = ZOOM_options_create_with_parent(c->options);
871 start = ZOOM_options_get_int(r->options, "start", 0);
872 count = ZOOM_options_get_int(r->options, "count", 0);
874 /* If "presentChunk" is defined use that; otherwise "step" */
875 const char *cp = ZOOM_options_get(r->options, "presentChunk");
876 r->step = ZOOM_options_get_int(r->options,
877 (cp != 0 ? "presentChunk": "step"), 0);
879 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
880 cp = ZOOM_options_get(r->options, "setname");
882 r->setname = xstrdup(cp);
883 cp = ZOOM_options_get(r->options, "schema");
885 r->schema = xstrdup(cp);
887 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
892 r->next = c->resultsets;
897 if (c->host_port && c->proto == PROTO_HTTP)
901 yaz_log(log_details, "ZOOM_connection_search: no comstack");
902 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
906 yaz_log(log_details, "ZOOM_connection_search: reconnect");
911 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
912 task->u.search.resultset = r;
913 task->u.search.start = start;
914 task->u.search.count = count;
916 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
917 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
918 elementSetName = ZOOM_options_get(r->options, "elementSetName");
919 task->u.search.elementSetName = elementSetName
920 ? xstrdup(elementSetName) : 0;
922 ZOOM_resultset_addref(r);
928 while (ZOOM_event(1, &c))
935 ZOOM_resultset_sort(ZOOM_resultset r,
936 const char *sort_type, const char *sort_spec)
938 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
942 ZOOM_resultset_sort1(ZOOM_resultset r,
943 const char *sort_type, const char *sort_spec)
945 ZOOM_connection c = r->connection;
949 newq = ZOOM_query_create();
950 if (ZOOM_query_sortby(newq, sort_spec) < 0)
953 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
954 r, r, sort_type, sort_spec);
958 if (c->host_port && c->proto == PROTO_HTTP)
962 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
963 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
967 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
973 ZOOM_resultset_cache_reset(r);
974 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
975 task->u.sort.resultset = r;
976 task->u.sort.q = newq;
978 ZOOM_resultset_addref(r);
982 while (ZOOM_event(1, &c))
990 ZOOM_resultset_cache_reset(ZOOM_resultset r)
993 for (i = 0; i<RECORD_HASH_SIZE; i++)
995 ZOOM_record_cache rc;
996 for (rc = r->record_hash[i]; rc; rc = rc->next)
998 if (rc->rec.wrbuf_marc)
999 wrbuf_destroy(rc->rec.wrbuf_marc);
1000 if (rc->rec.wrbuf_iconv)
1001 wrbuf_destroy(rc->rec.wrbuf_iconv);
1002 if (rc->rec.wrbuf_opac)
1003 wrbuf_destroy(rc->rec.wrbuf_opac);
1005 r->record_hash[i] = 0;
1010 ZOOM_resultset_destroy(ZOOM_resultset r)
1012 resultset_destroy(r);
1015 static void resultset_destroy(ZOOM_resultset r)
1020 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1022 if (r->refcount == 0)
1024 ZOOM_resultset_cache_reset(r);
1028 /* remove ourselves from the resultsets in connection */
1029 ZOOM_resultset *rp = &r->connection->resultsets;
1032 assert(*rp); /* we must be in this list!! */
1034 { /* OK, we're here - take us out of it */
1041 ZOOM_query_destroy(r->query);
1042 ZOOM_options_destroy(r->options);
1043 odr_destroy(r->odr);
1051 ZOOM_resultset_size(ZOOM_resultset r)
1053 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1058 static void do_close(ZOOM_connection c)
1063 ZOOM_connection_set_mask(c, 0);
1064 c->state = STATE_IDLE;
1067 static int ZOOM_test_reconnect(ZOOM_connection c)
1071 if (!c->reconnect_ok)
1074 c->reconnect_ok = 0;
1075 c->tasks->running = 0;
1076 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1078 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1079 ZOOM_connection_put_event(c, event);
1084 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1085 int force_sync, int start, int count)
1090 const char *syntax, *elementSetName;
1094 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1095 " count=%d", r, force_sync, start, count);
1100 if (c->host_port && c->proto == PROTO_HTTP)
1104 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1105 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1109 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1111 c->reconnect_ok = 1;
1114 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1115 task->u.retrieve.resultset = r;
1116 task->u.retrieve.start = start;
1117 task->u.retrieve.count = count;
1119 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1120 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1121 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1122 task->u.retrieve.elementSetName = elementSetName
1123 ? xstrdup(elementSetName) : 0;
1125 cp = ZOOM_options_get(r->options, "schema");
1128 if (!r->schema || strcmp(r->schema, cp))
1131 r->schema = xstrdup(cp);
1135 ZOOM_resultset_addref(r);
1137 if (!r->connection->async || force_sync)
1138 while (r->connection && ZOOM_event(1, &r->connection))
1143 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1144 size_t start, size_t count)
1146 int force_present = 0;
1150 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1151 r, r, (long) start, (long) count);
1154 ZOOM_resultset_retrieve(r, force_present, start, count);
1158 for (i = 0; i< count; i++)
1159 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1163 static void get_cert(ZOOM_connection c)
1168 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1170 ZOOM_connection_option_setl(c, "sslPeerCert",
1171 cert_buf, cert_len);
1176 static zoom_ret do_connect(ZOOM_connection c)
1179 const char *effective_host;
1182 effective_host = c->proxy;
1184 effective_host = c->host_port;
1186 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1190 c->cs = cs_create_host(effective_host, 0, &add);
1192 if (c->cs && c->cs->protocol == PROTO_HTTP)
1195 const char *path = 0;
1197 c->proto = PROTO_HTTP;
1198 cs_get_host_args(c->host_port, &path);
1200 c->path = (char*) xmalloc(strlen(path)+2);
1202 strcpy(c->path+1, path);
1204 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1206 return zoom_complete;
1211 int ret = cs_connect(c->cs, add);
1214 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1215 ZOOM_connection_put_event(c, event);
1217 if (c->proto == PROTO_Z3950)
1218 ZOOM_connection_send_init(c);
1221 /* no init request for SRW .. */
1222 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1223 ZOOM_connection_remove_task(c);
1224 ZOOM_connection_set_mask(c, 0);
1225 ZOOM_connection_exec_task(c);
1227 c->state = STATE_ESTABLISHED;
1228 return zoom_pending;
1232 int mask = ZOOM_SELECT_EXCEPT;
1233 if (c->cs->io_pending & CS_WANT_WRITE)
1234 mask += ZOOM_SELECT_WRITE;
1235 if (c->cs->io_pending & CS_WANT_READ)
1236 mask += ZOOM_SELECT_READ;
1237 ZOOM_connection_set_mask(c, mask);
1238 c->state = STATE_CONNECTING;
1239 return zoom_pending;
1242 c->state = STATE_IDLE;
1243 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1244 return zoom_complete;
1247 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1250 for (i = 0; i<200; i++)
1254 Z_OtherInformation **oi;
1259 sprintf(buf, "otherInfo%d", i);
1260 val = ZOOM_options_get(c->options, buf);
1263 cp = strchr(val, ':');
1267 if (len >= sizeof(buf))
1268 len = sizeof(buf)-1;
1269 memcpy(buf, val, len);
1272 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1277 yaz_oi_APDU(a, &oi);
1278 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1282 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1287 Z_OtherInformation **oi;
1288 yaz_oi_APDU(a, &oi);
1289 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1294 Z_OtherInformation **oi;
1295 yaz_oi_APDU(a, &oi);
1296 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1299 otherInfo_attach(c, a, out);
1300 if (!z_APDU(out, &a, 0, 0))
1302 FILE *outf = fopen("/tmp/apdu.txt", "a");
1305 ODR odr_pr = odr_createmem(ODR_PRINT);
1306 fprintf(outf, "a=%p\n", a);
1307 odr_setprint(odr_pr, outf);
1308 z_APDU(odr_pr, &a, 0, 0);
1309 odr_destroy(odr_pr);
1311 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1312 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1317 z_APDU(c->odr_print, &a, 0, 0);
1318 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1322 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1326 if (encode_APDU(c, a, c->odr_out))
1327 return zoom_complete;
1328 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1329 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1330 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1331 ZOOM_connection_put_event(c, event);
1332 odr_reset(c->odr_out);
1336 /* returns 1 if PDU was sent OK (still pending )
1337 0 if PDU was not sent OK (nothing to wait for)
1340 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1342 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1343 Z_InitRequest *ireq = apdu->u.initRequest;
1344 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1345 odr_malloc(c->odr_out, sizeof(*auth));
1348 ODR_MASK_SET(ireq->options, Z_Options_search);
1349 ODR_MASK_SET(ireq->options, Z_Options_present);
1350 ODR_MASK_SET(ireq->options, Z_Options_scan);
1351 ODR_MASK_SET(ireq->options, Z_Options_sort);
1352 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1353 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1355 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1356 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1357 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1359 /* Index Data's Z39.50 Implementor Id is 81 */
1360 ireq->implementationId =
1361 odr_prepend(c->odr_out,
1362 ZOOM_options_get(c->options, "implementationId"),
1363 odr_prepend(c->odr_out, "81", ireq->implementationId));
1365 ireq->implementationName =
1366 odr_prepend(c->odr_out,
1367 ZOOM_options_get(c->options, "implementationName"),
1368 odr_prepend(c->odr_out, "ZOOM-C",
1369 ireq->implementationName));
1371 version = odr_strdup(c->odr_out, "$Revision: 1.154 $");
1372 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1373 version[strlen(version)-2] = '\0';
1374 ireq->implementationVersion =
1375 odr_prepend(c->odr_out,
1376 ZOOM_options_get(c->options, "implementationVersion"),
1377 odr_prepend(c->odr_out, &version[11],
1378 ireq->implementationVersion));
1380 *ireq->maximumRecordSize = c->maximum_record_size;
1381 *ireq->preferredMessageSize = c->preferred_message_size;
1383 if (c->group || c->password)
1385 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1386 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1387 pass->userId = odr_strdup_null(c->odr_out, c->user);
1388 pass->password = odr_strdup_null(c->odr_out, c->password);
1389 auth->which = Z_IdAuthentication_idPass;
1390 auth->u.idPass = pass;
1391 ireq->idAuthentication = auth;
1395 auth->which = Z_IdAuthentication_open;
1396 auth->u.open = odr_strdup(c->odr_out, c->user);
1397 ireq->idAuthentication = auth;
1401 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1402 yaz_oid_userinfo_proxy, 1, c->host_port);
1404 if (c->charset || c->lang)
1406 Z_OtherInformation **oi;
1407 Z_OtherInformationUnit *oi_unit;
1409 yaz_oi_APDU(apdu, &oi);
1411 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1413 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1414 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1415 oi_unit->information.externallyDefinedInfo =
1416 yaz_set_proposal_charneg_list(c->odr_out, " ",
1417 c->charset, c->lang, 1);
1421 return send_APDU(c, apdu);
1425 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1430 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1432 if (c->sru_mode == zoom_sru_get)
1434 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1436 else if (c->sru_mode == zoom_sru_post)
1438 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1440 else if (c->sru_mode == zoom_sru_soap)
1442 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1444 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1445 return zoom_complete;
1447 z_GDU(c->odr_print, &gdu, 0, 0);
1448 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1450 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1451 ZOOM_connection_put_event(c, event);
1452 odr_reset(c->odr_out);
1458 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type) {
1459 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1460 sr->username = c->user;
1461 sr->password = c->password;
1466 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1470 ZOOM_resultset resultset = 0;
1472 const char *option_val = 0;
1474 if (c->error) /* don't continue on error */
1475 return zoom_complete;
1477 switch(c->tasks->which)
1479 case ZOOM_TASK_SEARCH:
1480 resultset = c->tasks->u.search.resultset;
1481 resultset->setname = xstrdup("default");
1482 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1483 start = &c->tasks->u.search.start;
1484 count = &c->tasks->u.search.count;
1486 case ZOOM_TASK_RETRIEVE:
1487 resultset = c->tasks->u.retrieve.resultset;
1489 start = &c->tasks->u.retrieve.start;
1490 count = &c->tasks->u.retrieve.count;
1492 if (*start >= resultset->size)
1493 return zoom_complete;
1494 if (*start + *count > resultset->size)
1495 *count = resultset->size - *start;
1497 for (i = 0; i < *count; i++)
1500 record_cache_lookup(resultset, i + *start,
1501 c->tasks->u.retrieve.syntax,
1502 c->tasks->u.retrieve.elementSetName);
1507 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1508 ZOOM_connection_put_event(c, event);
1515 return zoom_complete;
1518 return zoom_complete;
1520 assert(resultset->query);
1522 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1523 if (resultset->query->z_query->which == Z_Query_type_104
1524 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1526 sr->u.request->query_type = Z_SRW_query_type_cql;
1527 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1529 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1530 resultset->query->z_query->u.type_1)
1532 sr->u.request->query_type = Z_SRW_query_type_pqf;
1533 sr->u.request->query.pqf = resultset->query->query_string;
1537 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1538 return zoom_complete;
1540 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1541 sr->u.request->maximumRecords = odr_intdup(
1542 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1543 resultset->step : *count);
1544 sr->u.request->recordSchema = resultset->schema;
1546 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1548 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1550 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1551 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1552 return send_srw(c, sr);
1555 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1557 return zoom_complete;
1561 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1564 int lslb, ssub, mspn;
1566 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1567 Z_SearchRequest *search_req = apdu->u.searchRequest;
1568 const char *elementSetName;
1569 const char *smallSetElementSetName;
1570 const char *mediumSetElementSetName;
1573 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1575 r = c->tasks->u.search.resultset;
1577 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1580 ZOOM_options_get(r->options, "elementSetName");
1581 smallSetElementSetName =
1582 ZOOM_options_get(r->options, "smallSetElementSetName");
1583 mediumSetElementSetName =
1584 ZOOM_options_get(r->options, "mediumSetElementSetName");
1586 if (!smallSetElementSetName)
1587 smallSetElementSetName = elementSetName;
1589 if (!mediumSetElementSetName)
1590 mediumSetElementSetName = elementSetName;
1595 /* prepare query for the search request */
1596 search_req->query = r->query->z_query;
1597 if (!search_req->query)
1599 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1600 return zoom_complete;
1602 if (r->query->z_query->which == Z_Query_type_1 ||
1603 r->query->z_query->which == Z_Query_type_101)
1605 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1608 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1611 search_req->query = yaz_copy_Z_Query(search_req->query,
1614 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1616 yaz_iconv_close(cd);
1620 search_req->databaseNames = r->databaseNames;
1621 search_req->num_databaseNames = r->num_databaseNames;
1623 /* get syntax (no need to provide unless piggyback is in effect) */
1624 syntax = c->tasks->u.search.syntax;
1626 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1627 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1628 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1629 if (lslb != -1 && ssub != -1 && mspn != -1)
1631 /* So're a Z39.50 expert? Let's hope you don't do sort */
1632 *search_req->largeSetLowerBound = lslb;
1633 *search_req->smallSetUpperBound = ssub;
1634 *search_req->mediumSetPresentNumber = mspn;
1636 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1637 && r->piggyback && !r->r_sort_spec && !r->schema)
1639 /* Regular piggyback - do it unless we're going to do sort */
1640 *search_req->largeSetLowerBound = 2000000000;
1641 *search_req->smallSetUpperBound = 1;
1642 *search_req->mediumSetPresentNumber =
1643 r->step>0 ? r->step : c->tasks->u.search.count;
1647 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1648 smallSetElementSetName = 0;
1649 mediumSetElementSetName = 0;
1652 if (smallSetElementSetName && *smallSetElementSetName)
1654 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1655 odr_malloc(c->odr_out, sizeof(*esn));
1657 esn->which = Z_ElementSetNames_generic;
1658 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1659 search_req->smallSetElementSetNames = esn;
1661 if (mediumSetElementSetName && *mediumSetElementSetName)
1663 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1664 odr_malloc(c->odr_out, sizeof(*esn));
1666 esn->which = Z_ElementSetNames_generic;
1667 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1668 search_req->mediumSetElementSetNames = esn;
1671 search_req->preferredRecordSyntax =
1672 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1676 if (c->support_named_resultsets)
1680 /* find the lowest unused ordinal so that we re-use
1681 result sets on the server. */
1682 for (ord = 1; ; ord++)
1685 sprintf(setname, "%d", ord);
1686 for (rp = c->resultsets; rp; rp = rp->next)
1687 if (rp->setname && !strcmp(rp->setname, setname))
1692 r->setname = xstrdup(setname);
1693 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1694 "set %s", c, r->setname);
1698 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1700 r->setname = xstrdup("default");
1702 ZOOM_options_set(r->options, "setname", r->setname);
1704 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1705 return send_APDU(c, apdu);
1708 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1710 char oid_name_buf[OID_STR_MAX];
1711 const char *oid_name;
1714 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1717 case Z_DefaultDiagFormat_v2Addinfo:
1718 addinfo = r->u.v2Addinfo;
1720 case Z_DefaultDiagFormat_v3Addinfo:
1721 addinfo = r->u.v3Addinfo;
1726 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1729 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1731 if (p->which != Z_DiagRec_defaultFormat)
1732 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1734 response_default_diag(c, p->u.defaultFormat);
1737 ZOOM_API(ZOOM_record)
1738 ZOOM_record_clone(ZOOM_record srec)
1745 odr_enc = odr_createmem(ODR_ENCODE);
1746 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1748 buf = odr_getbuf(odr_enc, &size, 0);
1750 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1751 nrec->odr = odr_createmem(ODR_DECODE);
1752 nrec->wrbuf_marc = 0;
1753 nrec->wrbuf_iconv = 0;
1754 nrec->wrbuf_opac = 0;
1755 odr_setbuf(nrec->odr, buf, size, 0);
1756 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1758 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1759 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1760 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1761 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1762 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1763 odr_destroy(odr_enc);
1767 ZOOM_API(ZOOM_record)
1768 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1770 const char *syntax =
1771 ZOOM_options_get(s->options, "preferredRecordSyntax");
1772 const char *elementSetName =
1773 ZOOM_options_get(s->options, "elementSetName");
1775 return record_cache_lookup(s, pos, syntax, elementSetName);
1778 ZOOM_API(ZOOM_record)
1779 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1781 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1786 * MIKE: I think force_sync should always be zero, but I don't
1787 * want to make this change until I get the go-ahead from
1788 * Adam, in case something depends on the old synchronous
1792 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1793 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1794 rec = ZOOM_resultset_record_immediate(r, pos);
1800 ZOOM_record_destroy(ZOOM_record rec)
1804 if (rec->wrbuf_marc)
1805 wrbuf_destroy(rec->wrbuf_marc);
1806 if (rec->wrbuf_iconv)
1807 wrbuf_destroy(rec->wrbuf_iconv);
1808 if (rec->wrbuf_opac)
1809 wrbuf_destroy(rec->wrbuf_opac);
1810 odr_destroy(rec->odr);
1814 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1816 const char *buf, int sz,
1817 const char *record_charset)
1822 yaz_marc_t mt = yaz_marc_create();
1825 strcpy(to, "UTF-8");
1826 if (record_charset && *record_charset)
1828 /* Use "from,to" or just "from" */
1829 const char *cp = strchr(record_charset, ',');
1830 int clen = strlen(record_charset);
1833 strncpy( to, cp+1, sizeof(to)-1);
1834 to[sizeof(to)-1] = '\0';
1835 clen = cp - record_charset;
1837 if (clen > sizeof(from)-1)
1838 clen = sizeof(from)-1;
1841 strncpy(from, record_charset, clen);
1847 cd = yaz_iconv_open(to, from);
1848 yaz_marc_iconv(mt, cd);
1851 yaz_marc_xml(mt, marc_type);
1852 if (!rec->wrbuf_marc)
1853 rec->wrbuf_marc = wrbuf_alloc();
1854 wrbuf_rewind(rec->wrbuf_marc);
1855 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1857 yaz_marc_destroy(mt);
1859 yaz_iconv_close(cd);
1861 *len = wrbuf_len(rec->wrbuf_marc);
1862 return wrbuf_cstr(rec->wrbuf_marc);
1864 yaz_marc_destroy(mt);
1866 yaz_iconv_close(cd);
1870 static const char *record_iconv_return(ZOOM_record rec, int *len,
1871 const char *buf, int sz,
1872 const char *record_charset)
1879 strcpy(to, "UTF-8");
1881 if (record_charset && *record_charset)
1883 /* Use "from,to" or just "from" */
1884 const char *cp = strchr(record_charset, ',');
1885 int clen = strlen(record_charset);
1888 strncpy( to, cp+1, sizeof(to)-1);
1889 to[sizeof(to)-1] = '\0';
1890 clen = cp - record_charset;
1892 if (clen > sizeof(from)-1)
1893 clen = sizeof(from)-1;
1896 strncpy(from, record_charset, clen);
1900 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1902 if (!rec->wrbuf_iconv)
1903 rec->wrbuf_iconv = wrbuf_alloc();
1905 wrbuf_rewind(rec->wrbuf_iconv);
1907 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1908 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1910 buf = wrbuf_cstr(rec->wrbuf_iconv);
1911 sz = wrbuf_len(rec->wrbuf_iconv);
1912 yaz_iconv_close(cd);
1921 ZOOM_record_error(ZOOM_record rec, const char **cp,
1922 const char **addinfo, const char **diagset)
1924 Z_NamePlusRecord *npr;
1933 *cp = rec->diag_message;
1935 *addinfo = rec->diag_details;
1937 *diagset = rec->diag_set;
1938 return uri_to_code(rec->diag_uri);
1940 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1942 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1943 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1944 const char *add = 0;
1946 if (diag_rec->which == Z_DiagRec_defaultFormat)
1948 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1951 error = *ddf->condition;
1954 case Z_DefaultDiagFormat_v2Addinfo:
1955 add = ddf->u.v2Addinfo;
1957 case Z_DefaultDiagFormat_v3Addinfo:
1958 add = ddf->u.v3Addinfo;
1963 yaz_oid_to_string(yaz_oid_std(),
1964 ddf->diagnosticSetId, &oclass);
1972 *addinfo = add ? add : "";
1974 *cp = diagbib1_str(error);
1980 ZOOM_API(const char *)
1981 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1988 Z_NamePlusRecord *npr;
1991 *len = 0; /* default return */
2000 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
2002 if (cp[i] == ';' || cp[i] == ' ')
2008 while (type_spec[i] == ';')
2011 while (type_spec[i] == ' ')
2013 if (!strncmp(type_spec+i, "charset=", 8))
2016 i = i + 8; /* skip charset= */
2017 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
2019 if (type_spec[i] == ';' || type_spec[i] == ' ')
2025 else if (!strncmp(type_spec+i, "xpath=", 6))
2029 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2033 while (type_spec[i] == ' ')
2036 if (!strcmp(type, "database"))
2039 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2040 return npr->databaseName;
2042 else if (!strcmp(type, "schema"))
2045 *len = rec->schema ? strlen(rec->schema) : 0;
2048 else if (!strcmp(type, "syntax"))
2050 const char *desc = 0;
2051 if (npr->which == Z_NamePlusRecord_databaseRecord)
2053 Z_External *r = (Z_External *) npr->u.databaseRecord;
2054 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2059 *len = strlen(desc);
2062 if (npr->which != Z_NamePlusRecord_databaseRecord)
2065 /* from now on - we have a database record .. */
2066 if (!strcmp(type, "render"))
2068 Z_External *r = (Z_External *) npr->u.databaseRecord;
2069 const Odr_oid *oid = r->direct_reference;
2071 /* render bibliographic record .. */
2072 if (r->which == Z_External_OPAC)
2074 r = r->u.opac->bibliographicRecord;
2077 oid = r->direct_reference;
2079 if (r->which == Z_External_sutrs)
2080 return record_iconv_return(rec, len,
2081 (char*) r->u.sutrs->buf,
2084 else if (r->which == Z_External_octet)
2086 if (yaz_oid_is_iso2709(oid))
2088 const char *ret_buf = marc_iconv_return(
2089 rec, YAZ_MARC_LINE, len,
2090 (const char *) r->u.octet_aligned->buf,
2091 r->u.octet_aligned->len,
2096 return record_iconv_return(rec, len,
2097 (const char *) r->u.octet_aligned->buf,
2098 r->u.octet_aligned->len,
2101 else if (r->which == Z_External_grs1)
2103 if (!rec->wrbuf_marc)
2104 rec->wrbuf_marc = wrbuf_alloc();
2105 wrbuf_rewind(rec->wrbuf_marc);
2106 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2107 return record_iconv_return(rec, len,
2108 wrbuf_buf(rec->wrbuf_marc),
2109 wrbuf_len(rec->wrbuf_marc),
2114 else if (!strcmp(type, "xml"))
2116 Z_External *r = (Z_External *) npr->u.databaseRecord;
2117 const Odr_oid *oid = r->direct_reference;
2119 /* render bibliographic record .. */
2120 if (r->which == Z_External_OPAC)
2122 r = r->u.opac->bibliographicRecord;
2125 oid = r->direct_reference;
2128 if (r->which == Z_External_sutrs)
2129 return record_iconv_return(rec, len,
2130 (const char *) r->u.sutrs->buf,
2133 else if (r->which == Z_External_octet)
2135 int marc_decode_type = YAZ_MARC_MARCXML;
2136 if (yaz_oid_is_iso2709(oid))
2138 const char *ret_buf = marc_iconv_return(
2139 rec, marc_decode_type, len,
2140 (const char *) r->u.octet_aligned->buf,
2141 r->u.octet_aligned->len,
2146 return record_iconv_return(rec, len,
2147 (const char *) r->u.octet_aligned->buf,
2148 r->u.octet_aligned->len,
2151 else if (r->which == Z_External_grs1)
2158 else if (!strcmp(type, "raw"))
2160 Z_External *r = (Z_External *) npr->u.databaseRecord;
2162 if (r->which == Z_External_sutrs)
2164 if (len) *len = r->u.sutrs->len;
2165 return (const char *) r->u.sutrs->buf;
2167 else if (r->which == Z_External_octet)
2169 if (len) *len = r->u.octet_aligned->len;
2170 return (const char *) r->u.octet_aligned->buf;
2172 else /* grs-1, explain, OPAC, ... */
2175 return (const char *) npr->u.databaseRecord;
2179 else if (!strcmp (type, "ext"))
2182 return (const char *) npr->u.databaseRecord;
2184 else if (!strcmp (type, "opac"))
2187 Z_External *r = (Z_External *) npr->u.databaseRecord;
2188 if (r->which == Z_External_OPAC)
2190 if (!rec->wrbuf_opac)
2191 rec->wrbuf_opac = wrbuf_alloc();
2192 wrbuf_rewind(rec->wrbuf_opac);
2193 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2194 return record_iconv_return(rec, len,
2195 wrbuf_buf(rec->wrbuf_opac),
2196 wrbuf_len(rec->wrbuf_opac),
2203 static int strcmp_null(const char *v1, const char *v2)
2209 return strcmp(v1, v2);
2212 static size_t record_hash(int pos)
2216 return pos % RECORD_HASH_SIZE;
2219 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2221 const char *syntax, const char *elementSetName,
2223 Z_SRW_diagnostic *diag)
2225 ZOOM_record_cache rc = 0;
2227 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2228 ZOOM_connection_put_event(r->connection, event);
2230 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2233 && strcmp_null(r->schema, rc->schema) == 0
2234 && strcmp_null(elementSetName,rc->elementSetName) == 0
2235 && strcmp_null(syntax, rc->syntax) == 0)
2240 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2242 rc->rec.wrbuf_marc = 0;
2243 rc->rec.wrbuf_iconv = 0;
2244 rc->rec.wrbuf_opac = 0;
2245 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2247 rc->syntax = odr_strdup_null(r->odr, syntax);
2249 rc->schema = odr_strdup_null(r->odr, r->schema);
2252 rc->next = r->record_hash[record_hash(pos)];
2253 r->record_hash[record_hash(pos)] = rc;
2256 rc->rec.schema = odr_strdup_null(r->odr, schema);
2257 rc->rec.diag_set = 0;
2258 rc->rec.diag_uri = 0;
2259 rc->rec.diag_message = 0;
2260 rc->rec.diag_details = 0;
2266 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2267 if ((cp = strrchr(rc->rec.diag_set, '/')))
2269 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2271 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2272 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2276 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2278 const char *elementSetName)
2280 ZOOM_record_cache rc;
2282 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2286 if (strcmp_null(r->schema, rc->schema))
2288 if (strcmp_null(elementSetName,rc->elementSetName))
2290 if (strcmp_null(syntax, rc->syntax))
2298 static void handle_records(ZOOM_connection c, Z_Records *sr,
2301 ZOOM_resultset resultset;
2303 const char *syntax = 0, *elementSetName = 0;
2307 switch (c->tasks->which)
2309 case ZOOM_TASK_SEARCH:
2310 resultset = c->tasks->u.search.resultset;
2311 start = &c->tasks->u.search.start;
2312 count = &c->tasks->u.search.count;
2313 syntax = c->tasks->u.search.syntax;
2314 elementSetName = c->tasks->u.search.elementSetName;
2316 case ZOOM_TASK_RETRIEVE:
2317 resultset = c->tasks->u.retrieve.resultset;
2318 start = &c->tasks->u.retrieve.start;
2319 count = &c->tasks->u.retrieve.count;
2320 syntax = c->tasks->u.retrieve.syntax;
2321 elementSetName = c->tasks->u.retrieve.elementSetName;
2326 if (sr && sr->which == Z_Records_NSD)
2327 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2328 else if (sr && sr->which == Z_Records_multipleNSD)
2330 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2331 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2333 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2337 if (*count + *start > resultset->size)
2338 *count = resultset->size - *start;
2341 if (sr && sr->which == Z_Records_DBOSD)
2344 NMEM nmem = odr_extract_mem(c->odr_in);
2345 Z_NamePlusRecordList *p =
2346 sr->u.databaseOrSurDiagnostics;
2347 for (i = 0; i<p->num_records; i++)
2349 record_cache_add(resultset, p->records[i], i + *start,
2350 syntax, elementSetName,
2357 yaz_log(log_details,
2358 "handle_records resultset=%p start=%d count=%d",
2359 resultset, *start, *count);
2361 /* transfer our response to search_nmem .. we need it later */
2362 nmem_transfer(odr_getmem(resultset->odr), nmem);
2364 if (present_phase && p->num_records == 0)
2366 /* present response and we didn't get any records! */
2367 Z_NamePlusRecord *myrec =
2368 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2369 record_cache_add(resultset, myrec, *start,
2370 syntax, elementSetName, 0, 0);
2373 else if (present_phase)
2375 /* present response and we didn't get any records! */
2376 Z_NamePlusRecord *myrec =
2377 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2378 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2384 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2386 handle_records(c, pr->records, 1);
2389 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2392 switch (term->which)
2394 case Z_Term_general:
2395 ZOOM_options_setl(opt, name,
2396 (const char *)(term->u.general->buf),
2397 term->u.general->len);
2399 case Z_Term_characterString:
2400 ZOOM_options_set(opt, name, term->u.characterString);
2402 case Z_Term_numeric:
2403 ZOOM_options_set_int(opt, name, *term->u.numeric);
2408 static void handle_queryExpression(ZOOM_options opt, const char *name,
2409 Z_QueryExpression *exp)
2415 case Z_QueryExpression_term:
2416 if (exp->u.term && exp->u.term->queryTerm)
2418 sprintf(opt_name, "%s.term", name);
2419 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2422 case Z_QueryExpression_query:
2427 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2428 Z_OtherInformation *o)
2431 for (i = 0; o && i < o->num_elements; i++)
2433 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2435 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2437 if (ext->which == Z_External_searchResult1)
2440 Z_SearchInfoReport *sr = ext->u.searchResult1;
2443 ZOOM_options_set_int(
2444 resultset->options, "searchresult.size", sr->num);
2446 for (j = 0; j < sr->num; j++)
2448 Z_SearchInfoReport_s *ent =
2449 ext->u.searchResult1->elements[j];
2452 sprintf(pref, "searchresult.%d", j);
2454 if (ent->subqueryId)
2457 sprintf(opt_name, "%s.id", pref);
2458 ZOOM_options_set(resultset->options, opt_name,
2461 if (ent->subqueryExpression)
2464 sprintf(opt_name, "%s.subquery", pref);
2465 handle_queryExpression(resultset->options, opt_name,
2466 ent->subqueryExpression);
2468 if (ent->subqueryInterpretation)
2471 sprintf(opt_name, "%s.interpretation", pref);
2472 handle_queryExpression(resultset->options, opt_name,
2473 ent->subqueryInterpretation);
2475 if (ent->subqueryRecommendation)
2478 sprintf(opt_name, "%s.recommendation", pref);
2479 handle_queryExpression(resultset->options, opt_name,
2480 ent->subqueryRecommendation);
2482 if (ent->subqueryCount)
2485 sprintf(opt_name, "%s.count", pref);
2486 ZOOM_options_set_int(resultset->options, opt_name,
2487 *ent->subqueryCount);
2495 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2497 ZOOM_resultset resultset;
2500 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2503 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2504 ZOOM_connection_put_event(c, event);
2506 resultset = c->tasks->u.search.resultset;
2508 if (sr->resultSetStatus)
2510 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2511 *sr->resultSetStatus);
2513 if (sr->presentStatus)
2515 ZOOM_options_set_int(resultset->options, "presentStatus",
2516 *sr->presentStatus);
2518 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2520 resultset->size = *sr->resultCount;
2521 handle_records(c, sr->records, 0);
2524 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2526 if (res->diagnostics && res->num_diagnostics > 0)
2527 response_diag(c, res->diagnostics[0]);
2530 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2532 NMEM nmem = odr_extract_mem(c->odr_in);
2535 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2537 scan = c->tasks->u.scan.scan;
2539 if (res->entries && res->entries->nonsurrogateDiagnostics)
2540 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2541 scan->scan_response = res;
2542 scan->srw_scan_response = 0;
2543 nmem_transfer(odr_getmem(scan->odr), nmem);
2545 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2546 if (res->positionOfTerm)
2547 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2548 if (res->scanStatus)
2549 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2550 if (res->numberOfEntriesReturned)
2551 ZOOM_options_set_int(scan->options, "number",
2552 *res->numberOfEntriesReturned);
2557 static zoom_ret send_sort(ZOOM_connection c,
2558 ZOOM_resultset resultset)
2561 resultset->r_sort_spec = 0;
2562 if (resultset->r_sort_spec)
2564 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2565 Z_SortRequest *req = apdu->u.sortRequest;
2567 req->num_inputResultSetNames = 1;
2568 req->inputResultSetNames = (Z_InternationalString **)
2569 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2570 req->inputResultSetNames[0] =
2571 odr_strdup(c->odr_out, resultset->setname);
2572 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2573 req->sortSequence = resultset->r_sort_spec;
2574 resultset->r_sort_spec = 0;
2575 return send_APDU(c, apdu);
2577 return zoom_complete;
2580 static zoom_ret send_present(ZOOM_connection c)
2583 Z_PresentRequest *req = 0;
2585 const char *syntax = 0;
2586 const char *elementSetName = 0;
2587 ZOOM_resultset resultset;
2592 yaz_log(log_details, "%p send_present no tasks", c);
2593 return zoom_complete;
2596 switch (c->tasks->which)
2598 case ZOOM_TASK_SEARCH:
2599 resultset = c->tasks->u.search.resultset;
2600 start = &c->tasks->u.search.start;
2601 count = &c->tasks->u.search.count;
2602 syntax = c->tasks->u.search.syntax;
2603 elementSetName = c->tasks->u.search.elementSetName;
2605 case ZOOM_TASK_RETRIEVE:
2606 resultset = c->tasks->u.retrieve.resultset;
2607 start = &c->tasks->u.retrieve.start;
2608 count = &c->tasks->u.retrieve.count;
2609 syntax = c->tasks->u.retrieve.syntax;
2610 elementSetName = c->tasks->u.retrieve.elementSetName;
2613 return zoom_complete;
2615 yaz_log(log_details, "%p send_present start=%d count=%d",
2618 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2620 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2623 if (c->error) /* don't continue on error */
2624 return zoom_complete;
2625 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2626 resultset, *start, *count);
2628 for (i = 0; i < *count; i++)
2631 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2636 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2637 ZOOM_connection_put_event(c, event);
2645 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2646 return zoom_complete;
2649 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2650 req = apdu->u.presentRequest;
2653 yaz_log(log_details, "%p send_present skip=%d", c, i);
2655 *req->resultSetStartPoint = *start + 1;
2657 if (resultset->step > 0 && resultset->step < *count)
2658 *req->numberOfRecordsRequested = resultset->step;
2660 *req->numberOfRecordsRequested = *count;
2662 if (*req->numberOfRecordsRequested + *start > resultset->size)
2663 *req->numberOfRecordsRequested = resultset->size - *start;
2664 assert(*req->numberOfRecordsRequested > 0);
2666 if (syntax && *syntax)
2667 req->preferredRecordSyntax =
2668 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2670 if (resultset->schema && *resultset->schema)
2672 Z_RecordComposition *compo = (Z_RecordComposition *)
2673 odr_malloc(c->odr_out, sizeof(*compo));
2675 req->recordComposition = compo;
2676 compo->which = Z_RecordComp_complex;
2677 compo->u.complex = (Z_CompSpec *)
2678 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2679 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2680 odr_malloc(c->odr_out, sizeof(bool_t));
2681 *compo->u.complex->selectAlternativeSyntax = 0;
2683 compo->u.complex->generic = (Z_Specification *)
2684 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2686 compo->u.complex->generic->which = Z_Schema_oid;
2687 compo->u.complex->generic->schema.oid = (Odr_oid *)
2688 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2690 if (!compo->u.complex->generic->schema.oid)
2692 /* OID wasn't a schema! Try record syntax instead. */
2694 compo->u.complex->generic->schema.oid = (Odr_oid *)
2695 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2697 if (elementSetName && *elementSetName)
2699 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2700 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2701 compo->u.complex->generic->elementSpec->which =
2702 Z_ElementSpec_elementSetName;
2703 compo->u.complex->generic->elementSpec->u.elementSetName =
2704 odr_strdup(c->odr_out, elementSetName);
2707 compo->u.complex->generic->elementSpec = 0;
2708 compo->u.complex->num_dbSpecific = 0;
2709 compo->u.complex->dbSpecific = 0;
2710 compo->u.complex->num_recordSyntax = 0;
2711 compo->u.complex->recordSyntax = 0;
2713 else if (elementSetName && *elementSetName)
2715 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2716 odr_malloc(c->odr_out, sizeof(*esn));
2717 Z_RecordComposition *compo = (Z_RecordComposition *)
2718 odr_malloc(c->odr_out, sizeof(*compo));
2720 esn->which = Z_ElementSetNames_generic;
2721 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2722 compo->which = Z_RecordComp_simple;
2723 compo->u.simple = esn;
2724 req->recordComposition = compo;
2726 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2727 return send_APDU(c, apdu);
2730 ZOOM_API(ZOOM_scanset)
2731 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2734 ZOOM_query q = ZOOM_query_create();
2736 ZOOM_query_prefix(q, start);
2738 s = ZOOM_connection_scan1(c, q);
2739 ZOOM_query_destroy(q);
2744 ZOOM_API(ZOOM_scanset)
2745 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2747 ZOOM_scanset scan = 0;
2751 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2752 scan->connection = c;
2753 scan->odr = odr_createmem(ODR_DECODE);
2754 scan->options = ZOOM_options_create_with_parent(c->options);
2756 scan->scan_response = 0;
2757 scan->srw_scan_response = 0;
2761 scan->databaseNames = set_DatabaseNames(c, c->options,
2762 &scan->num_databaseNames,
2767 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2768 task->u.scan.scan = scan;
2773 while (ZOOM_event(1, &c))
2781 ZOOM_scanset_destroy(ZOOM_scanset scan)
2786 if (scan->refcount == 0)
2788 ZOOM_query_destroy(scan->query);
2790 odr_destroy(scan->odr);
2792 ZOOM_options_destroy(scan->options);
2797 static zoom_ret send_package(ZOOM_connection c)
2801 yaz_log(log_details, "%p send_package", c);
2803 return zoom_complete;
2804 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2806 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2807 ZOOM_connection_put_event(c, event);
2809 c->buf_out = c->tasks->u.package->buf_out;
2810 c->len_out = c->tasks->u.package->len_out;
2815 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2818 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2819 Z_ScanRequest *req = apdu->u.scanRequest;
2821 yaz_log(log_details, "%p send_scan", c);
2823 return zoom_complete;
2824 assert (c->tasks->which == ZOOM_TASK_SCAN);
2825 scan = c->tasks->u.scan.scan;
2827 /* Z39.50 scan can only carry RPN */
2828 if (scan->query->z_query->which == Z_Query_type_1 ||
2829 scan->query->z_query->which == Z_Query_type_101)
2831 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2832 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2835 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2838 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2840 yaz_query_charset_convert_rpnquery(
2841 rpn, c->odr_out, cd);
2842 yaz_iconv_close(cd);
2845 req->attributeSet = rpn->attributeSetId;
2846 if (!req->attributeSet)
2847 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2848 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2849 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2851 req->termListAndStartPoint =
2852 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2856 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2857 return zoom_complete;
2862 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2863 return zoom_complete;
2866 *req->numberOfTermsRequested =
2867 ZOOM_options_get_int(scan->options, "number", 10);
2869 req->preferredPositionInResponse =
2870 odr_intdup(c->odr_out,
2871 ZOOM_options_get_int(scan->options, "position", 1));
2874 odr_intdup(c->odr_out,
2875 ZOOM_options_get_int(scan->options, "stepSize", 0));
2877 req->databaseNames = scan->databaseNames;
2878 req->num_databaseNames = scan->num_databaseNames;
2880 return send_APDU(c, apdu);
2884 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2888 const char *option_val = 0;
2891 return zoom_complete;
2892 assert (c->tasks->which == ZOOM_TASK_SCAN);
2893 scan = c->tasks->u.scan.scan;
2895 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2897 /* SRU scan can only carry CQL and PQF */
2898 if (scan->query->z_query->which == Z_Query_type_104)
2900 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2901 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2903 else if (scan->query->z_query->which == Z_Query_type_1
2904 || scan->query->z_query->which == Z_Query_type_101)
2906 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2907 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2911 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2912 return zoom_complete;
2915 sr->u.scan_request->maximumTerms = odr_intdup(
2916 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2918 sr->u.scan_request->responsePosition = odr_intdup(
2919 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2921 option_val = ZOOM_options_get(scan->options, "extraArgs");
2922 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2923 return send_srw(c, sr);
2926 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2928 return zoom_complete;
2934 ZOOM_scanset_size(ZOOM_scanset scan)
2939 if (scan->scan_response && scan->scan_response->entries)
2940 return scan->scan_response->entries->num_entries;
2941 else if (scan->srw_scan_response)
2942 return scan->srw_scan_response->num_terms;
2946 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2948 const char **value_term, size_t *value_len,
2949 const char **disp_term, size_t *disp_len)
2951 size_t noent = ZOOM_scanset_size(scan);
2960 if (pos >= noent || pos < 0)
2962 if (scan->scan_response)
2964 Z_ScanResponse *res = scan->scan_response;
2965 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2967 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2969 *value_term = (const char *) t->term->u.general->buf;
2970 *value_len = t->term->u.general->len;
2973 *disp_term = t->displayTerm;
2974 *disp_len = strlen(*disp_term);
2976 else if (t->term->which == Z_Term_general)
2978 *disp_term = (const char *) t->term->u.general->buf;
2979 *disp_len = t->term->u.general->len;
2981 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2984 if (scan->srw_scan_response)
2986 Z_SRW_scanResponse *res = scan->srw_scan_response;
2987 Z_SRW_scanTerm *t = res->terms + pos;
2990 *value_term = t->value;
2991 *value_len = strlen(*value_term);
2994 *disp_term = t->displayTerm;
2996 *disp_term = t->value;
2997 *disp_len = strlen(*disp_term);
2998 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3003 ZOOM_API(const char *)
3004 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3007 const char *value_term = 0;
3008 size_t value_len = 0;
3009 const char *disp_term = 0;
3010 size_t disp_len = 0;
3012 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3013 &disp_term, &disp_len);
3019 ZOOM_API(const char *)
3020 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
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_option_get(ZOOM_scanset scan, const char *key)
3038 return ZOOM_options_get(scan->options, key);
3042 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3045 ZOOM_options_set(scan->options, key, val);
3048 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3051 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3052 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3054 str = ZOOM_options_get(p->options, "package-name");
3056 req->packageName = odr_strdup(p->odr_out, str);
3058 str = ZOOM_options_get(p->options, "user-id");
3060 req->userId = odr_strdup_null(p->odr_out, str);
3062 req->packageType = odr_oiddup(p->odr_out, oid);
3064 str = ZOOM_options_get(p->options, "function");
3067 if (!strcmp (str, "create"))
3068 *req->function = Z_ExtendedServicesRequest_create;
3069 if (!strcmp (str, "delete"))
3070 *req->function = Z_ExtendedServicesRequest_delete;
3071 if (!strcmp (str, "modify"))
3072 *req->function = Z_ExtendedServicesRequest_modify;
3075 str = ZOOM_options_get(p->options, "waitAction");
3078 if (!strcmp (str, "wait"))
3079 *req->waitAction = Z_ExtendedServicesRequest_wait;
3080 if (!strcmp (str, "waitIfPossible"))
3081 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3082 if (!strcmp (str, "dontWait"))
3083 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3084 if (!strcmp (str, "dontReturnPackage"))
3085 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3090 static const char *ill_array_lookup(void *clientData, const char *idx)
3092 ZOOM_package p = (ZOOM_package) clientData;
3093 return ZOOM_options_get(p->options, idx+4);
3096 static Z_External *encode_ill_request(ZOOM_package p)
3098 ODR out = p->odr_out;
3101 struct ill_get_ctl ctl;
3103 ctl.odr = p->odr_out;
3105 ctl.f = ill_array_lookup;
3107 req = ill_get_ILLRequest(&ctl, "ill", 0);
3109 if (!ill_Request(out, &req, 0, 0))
3111 int ill_request_size;
3112 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3113 if (ill_request_buf)
3114 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3119 int illRequest_size = 0;
3120 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3122 r = (Z_External *) odr_malloc(out, sizeof(*r));
3123 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3124 r->indirect_reference = 0;
3126 r->which = Z_External_single;
3128 r->u.single_ASN1_type =
3129 odr_create_Odr_oct(out,
3130 (unsigned char *)illRequest_buf,
3136 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3138 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3142 req->which = Z_IOItemOrder_esRequest;
3143 req->u.esRequest = (Z_IORequest *)
3144 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3146 /* to keep part ... */
3147 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3148 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3149 req->u.esRequest->toKeep->supplDescription = 0;
3150 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3151 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3153 str = ZOOM_options_get(p->options, "contact-name");
3154 req->u.esRequest->toKeep->contact->name =
3155 odr_strdup_null(p->odr_out, str);
3157 str = ZOOM_options_get(p->options, "contact-phone");
3158 req->u.esRequest->toKeep->contact->phone =
3159 odr_strdup_null(p->odr_out, str);
3161 str = ZOOM_options_get(p->options, "contact-email");
3162 req->u.esRequest->toKeep->contact->email =
3163 odr_strdup_null(p->odr_out, str);
3165 req->u.esRequest->toKeep->addlBilling = 0;
3167 /* not to keep part ... */
3168 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3169 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3171 str = ZOOM_options_get(p->options, "itemorder-setname");
3176 req->u.esRequest->notToKeep->resultSetItem = 0;
3179 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3180 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3182 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3183 odr_strdup(p->odr_out, str);
3184 req->u.esRequest->notToKeep->resultSetItem->item =
3185 (int *) odr_malloc(p->odr_out, sizeof(int));
3187 str = ZOOM_options_get(p->options, "itemorder-item");
3188 *req->u.esRequest->notToKeep->resultSetItem->item =
3189 (str ? atoi(str) : 1);
3192 str = ZOOM_options_getl(p->options, "doc", &len);
3195 req->u.esRequest->notToKeep->itemRequest =
3196 z_ext_record_xml(p->odr_out, str, len);
3199 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3204 Z_APDU *create_admin_package(ZOOM_package p, int type,
3205 Z_ESAdminOriginPartToKeep **toKeepP,
3206 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3208 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3211 Z_ESAdminOriginPartToKeep *toKeep;
3212 Z_ESAdminOriginPartNotToKeep *notToKeep;
3213 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3214 const char *first_db = "Default";
3216 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3221 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3223 r->indirect_reference = 0;
3224 r->which = Z_External_ESAdmin;
3226 r->u.adminService = (Z_Admin *)
3227 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3228 r->u.adminService->which = Z_Admin_esRequest;
3229 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3230 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3232 toKeep = r->u.adminService->u.esRequest->toKeep =
3233 (Z_ESAdminOriginPartToKeep *)
3234 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3235 toKeep->which = type;
3236 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3237 toKeep->u.create = odr_nullval();
3238 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3240 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3241 (Z_ESAdminOriginPartNotToKeep *)
3242 odr_malloc(p->odr_out,
3243 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3244 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3245 notToKeep->u.recordsWillFollow = odr_nullval();
3249 *notToKeepP = notToKeep;
3254 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3256 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3257 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3258 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3260 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3268 req->taskSpecificParameters = ext;
3269 ext->direct_reference = req->packageType;
3270 ext->descriptor = 0;
3271 ext->indirect_reference = 0;
3273 ext->which = Z_External_octet;
3274 ext->u.single_ASN1_type =
3275 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3279 static Z_APDU *create_update_package(ZOOM_package p)
3282 const char *first_db = "Default";
3284 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3285 const char *action = ZOOM_options_get(p->options, "action");
3286 int recordIdOpaque_len;
3287 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3288 &recordIdOpaque_len);
3289 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3291 const char *record_buf = ZOOM_options_getl(p->options, "record",
3293 int recordOpaque_len;
3294 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3296 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3297 const char *version = ZOOM_options_get(p->options, "updateVersion");
3299 const char *correlationInfo_note =
3300 ZOOM_options_get(p->options, "correlationInfo.note");
3301 const char *correlationInfo_id =
3302 ZOOM_options_get(p->options, "correlationInfo.id");
3304 Odr_oid *syntax_oid = 0;
3305 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3311 if (!record_buf && !recordOpaque_buf)
3313 record_buf = "void";
3315 syntax_str = "SUTRS";
3320 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3321 CLASS_RECSYN, syntax_str,
3333 package_oid = yaz_oid_extserv_database_update_first_version;
3334 /* old update does not support specialUpdate */
3336 action = "recordInsert";
3340 action = "specialUpdate";
3341 package_oid = yaz_oid_extserv_database_update_second_version;
3345 action = "specialUpdate";
3346 package_oid = yaz_oid_extserv_database_update;
3352 if (!strcmp(action, "recordInsert"))
3353 action_no = Z_IUOriginPartToKeep_recordInsert;
3354 else if (!strcmp(action, "recordReplace"))
3355 action_no = Z_IUOriginPartToKeep_recordReplace;
3356 else if (!strcmp(action, "recordDelete"))
3357 action_no = Z_IUOriginPartToKeep_recordDelete;
3358 else if (!strcmp(action, "elementUpdate"))
3359 action_no = Z_IUOriginPartToKeep_elementUpdate;
3360 else if (!strcmp(action, "specialUpdate"))
3361 action_no = Z_IUOriginPartToKeep_specialUpdate;
3365 apdu = create_es_package(p, package_oid);
3368 Z_IUOriginPartToKeep *toKeep;
3369 Z_IUSuppliedRecords *notToKeep;
3370 Z_External *r = (Z_External *)
3371 odr_malloc(p->odr_out, sizeof(*r));
3372 const char *elementSetName =
3373 ZOOM_options_get(p->options, "elementSetName");
3375 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3377 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3379 r->which = Z_External_update;
3380 r->indirect_reference = 0;
3381 r->u.update = (Z_IUUpdate *)
3382 odr_malloc(p->odr_out, sizeof(*r->u.update));
3384 r->u.update->which = Z_IUUpdate_esRequest;
3385 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3386 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3387 toKeep = r->u.update->u.esRequest->toKeep =
3388 (Z_IUOriginPartToKeep *)
3389 odr_malloc(p->odr_out, sizeof(*toKeep));
3391 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3394 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3396 toKeep->actionQualifier = 0;
3397 toKeep->action = odr_intdup(p->odr_out, action_no);
3399 notToKeep = r->u.update->u.esRequest->notToKeep =
3400 (Z_IUSuppliedRecords *)
3401 odr_malloc(p->odr_out, sizeof(*notToKeep));
3403 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3404 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3405 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3406 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3407 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3410 notToKeep->elements[0]->u.opaque =
3411 odr_create_Odr_oct(p->odr_out,
3412 (const unsigned char *) recordIdOpaque,
3413 recordIdOpaque_len);
3415 else if (recordIdNumber)
3417 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3419 notToKeep->elements[0]->u.number =
3420 odr_intdup(p->odr_out, atoi(recordIdNumber));
3423 notToKeep->elements[0]->u.opaque = 0;
3424 notToKeep->elements[0]->supplementalId = 0;
3425 if (correlationInfo_note || correlationInfo_id)
3427 Z_IUCorrelationInfo *ci;
3428 ci = notToKeep->elements[0]->correlationInfo =
3429 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3430 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3431 ci->id = correlationInfo_id ?
3432 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3435 notToKeep->elements[0]->correlationInfo = 0;
3436 if (recordOpaque_buf)
3438 notToKeep->elements[0]->record =
3439 z_ext_record_oid_any(p->odr_out, syntax_oid,
3440 recordOpaque_buf, recordOpaque_len);
3444 notToKeep->elements[0]->record =
3445 z_ext_record_oid(p->odr_out, syntax_oid,
3446 record_buf, record_len);
3451 ODR print = odr_createmem(ODR_PRINT);
3453 z_APDU(print, &apdu, 0, 0);
3460 ZOOM_package_send(ZOOM_package p, const char *type)
3467 odr_reset(p->odr_out);
3470 if (!strcmp(type, "itemorder"))
3472 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3475 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3477 r->direct_reference =
3478 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3480 r->which = Z_External_itemOrder;
3481 r->indirect_reference = 0;
3482 r->u.itemOrder = encode_item_order(p);
3484 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3487 else if (!strcmp(type, "create")) /* create database */
3489 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3492 else if (!strcmp(type, "drop")) /* drop database */
3494 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3497 else if (!strcmp(type, "commit")) /* commit changes */
3499 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3502 else if (!strcmp(type, "update")) /* update record(s) */
3504 apdu = create_update_package(p);
3506 else if (!strcmp(type, "xmlupdate"))
3508 apdu = create_xmlupdate_package(p);
3512 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3516 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3517 task->u.package = p;
3518 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3519 p->buf_out = (char *) xmalloc(p->len_out);
3520 memcpy(p->buf_out, buf, p->len_out);
3525 while (ZOOM_event(1, &c))
3532 ZOOM_API(ZOOM_package)
3533 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3535 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3538 p->odr_out = odr_createmem(ODR_ENCODE);
3539 p->options = ZOOM_options_create_with_parent2(options, c->options);
3547 ZOOM_package_destroy(ZOOM_package p)
3552 if (p->refcount == 0)
3554 odr_destroy(p->odr_out);
3557 ZOOM_options_destroy(p->options);
3562 ZOOM_API(const char *)
3563 ZOOM_package_option_get(ZOOM_package p, const char *key)
3565 return ZOOM_options_get(p->options, key);
3568 ZOOM_API(const char *)
3569 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3571 return ZOOM_options_getl(p->options, key, lenp);
3575 ZOOM_package_option_set(ZOOM_package p, const char *key,
3578 ZOOM_options_set(p->options, key, val);
3582 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3583 const char *val, int len)
3585 ZOOM_options_setl(p->options, key, val, len);
3588 static int ZOOM_connection_exec_task(ZOOM_connection c)
3590 ZOOM_task task = c->tasks;
3591 zoom_ret ret = zoom_complete;
3595 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3596 c, task->which, task->running);
3597 if (c->error != ZOOM_ERROR_NONE)
3599 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3600 "removing tasks because of error = %d", c, c->error);
3601 ZOOM_connection_remove_tasks(c);
3606 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3607 "task already running", c);
3611 ret = zoom_complete;
3612 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3614 switch (task->which)
3616 case ZOOM_TASK_SEARCH:
3617 if (c->proto == PROTO_HTTP)
3618 ret = ZOOM_connection_srw_send_search(c);
3620 ret = ZOOM_connection_send_search(c);
3622 case ZOOM_TASK_RETRIEVE:
3623 if (c->proto == PROTO_HTTP)
3624 ret = ZOOM_connection_srw_send_search(c);
3626 ret = send_present(c);
3628 case ZOOM_TASK_CONNECT:
3629 ret = do_connect(c);
3631 case ZOOM_TASK_SCAN:
3632 if (c->proto == PROTO_HTTP)
3633 ret = ZOOM_connection_srw_send_scan(c);
3635 ret = ZOOM_connection_send_scan(c);
3637 case ZOOM_TASK_PACKAGE:
3638 ret = send_package(c);
3640 case ZOOM_TASK_SORT:
3641 c->tasks->u.sort.resultset->r_sort_spec =
3642 c->tasks->u.sort.q->sort_spec;
3643 ret = send_sort(c, c->tasks->u.sort.resultset);
3649 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3650 "remove tasks because no connection exist", c);
3651 ZOOM_connection_remove_tasks(c);
3653 if (ret == zoom_complete)
3655 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3656 "task removed (complete)", c);
3657 ZOOM_connection_remove_task(c);
3660 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3665 static zoom_ret send_sort_present(ZOOM_connection c)
3667 zoom_ret r = zoom_complete;
3669 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3670 r = send_sort(c, c->tasks->u.search.resultset);
3671 if (r == zoom_complete)
3672 r = send_present(c);
3676 static int es_response_taskpackage_update(ZOOM_connection c,
3677 Z_IUUpdateTaskPackage *utp)
3679 if (utp && utp->targetPart)
3681 Z_IUTargetPart *targetPart = utp->targetPart;
3682 switch ( *targetPart->updateStatus ) {
3683 case Z_IUTargetPart_success:
3684 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3686 case Z_IUTargetPart_partial:
3687 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3689 case Z_IUTargetPart_failure:
3690 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3691 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3692 response_diag(c, targetPart->globalDiagnostics[0]);
3695 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3700 static int es_response_taskpackage(ZOOM_connection c,
3701 Z_TaskPackage *taskPackage)
3704 Odr_oct *id = taskPackage->targetReference;
3706 ZOOM_options_setl(c->tasks->u.package->options,
3707 "targetReference", (char*) id->buf, id->len);
3710 switch ( *taskPackage->taskStatus ) {
3711 case Z_TaskPackage_pending:
3712 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3714 case Z_TaskPackage_active:
3715 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3717 case Z_TaskPackage_complete:
3718 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3720 case Z_TaskPackage_aborted:
3721 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3722 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3723 response_diag(c, taskPackage->packageDiagnostics[0]);
3727 // taskSpecificParameters
3728 // NOTE: Only Update implemented, no others.
3729 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3730 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3731 es_response_taskpackage_update(c, utp);
3737 static int es_response(ZOOM_connection c,
3738 Z_ExtendedServicesResponse *res)
3740 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3742 switch (*res->operationStatus) {
3743 case Z_ExtendedServicesResponse_done:
3744 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3746 case Z_ExtendedServicesResponse_accepted:
3747 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3749 case Z_ExtendedServicesResponse_failure:
3750 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3751 if (res->diagnostics && res->num_diagnostics > 0)
3752 response_diag(c, res->diagnostics[0]);
3755 if (res->taskPackage &&
3756 res->taskPackage->which == Z_External_extendedService)
3758 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3759 es_response_taskpackage(c, taskPackage);
3761 if (res->taskPackage &&
3762 res->taskPackage->which == Z_External_octet)
3764 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3765 ZOOM_options_setl(c->tasks->u.package->options,
3766 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3771 static void interpret_init_diag(ZOOM_connection c,
3772 Z_DiagnosticFormat *diag)
3776 Z_DiagnosticFormat_s *ds = diag->elements[0];
3777 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3778 response_default_diag(c, ds->u.defaultDiagRec);
3783 static void interpret_otherinformation_field(ZOOM_connection c,
3784 Z_OtherInformation *ui)
3787 for (i = 0; i < ui->num_elements; i++)
3789 Z_OtherInformationUnit *unit = ui->list[i];
3790 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3791 unit->information.externallyDefinedInfo &&
3792 unit->information.externallyDefinedInfo->which ==
3795 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3801 static void set_init_option(const char *name, void *clientData) {
3802 ZOOM_connection c = (ZOOM_connection) clientData;
3805 sprintf(buf, "init_opt_%.70s", name);
3806 ZOOM_connection_option_set(c, buf, "1");
3810 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3812 Z_InitResponse *initrs;
3814 ZOOM_connection_set_mask(c, 0);
3815 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3818 case Z_APDU_initResponse:
3819 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3820 initrs = apdu->u.initResponse;
3821 ZOOM_connection_option_set(c, "serverImplementationId",
3822 initrs->implementationId ?
3823 initrs->implementationId : "");
3824 ZOOM_connection_option_set(c, "serverImplementationName",
3825 initrs->implementationName ?
3826 initrs->implementationName : "");
3827 ZOOM_connection_option_set(c, "serverImplementationVersion",
3828 initrs->implementationVersion ?
3829 initrs->implementationVersion : "");
3830 /* Set the three old options too, for old applications */
3831 ZOOM_connection_option_set(c, "targetImplementationId",
3832 initrs->implementationId ?
3833 initrs->implementationId : "");
3834 ZOOM_connection_option_set(c, "targetImplementationName",
3835 initrs->implementationName ?
3836 initrs->implementationName : "");
3837 ZOOM_connection_option_set(c, "targetImplementationVersion",
3838 initrs->implementationVersion ?
3839 initrs->implementationVersion : "");
3841 /* Make initrs->options available as ZOOM-level options */
3842 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3844 if (!*initrs->result)
3846 Z_External *uif = initrs->userInformationField;
3848 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3850 if (uif && uif->which == Z_External_userInfo1)
3851 interpret_otherinformation_field(c, uif->u.userInfo1);
3856 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3857 yaz_oid_userinfo_cookie, 1, 0);
3858 xfree(c->cookie_in);
3861 c->cookie_in = xstrdup(cookie);
3862 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3863 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3864 c->support_named_resultsets = 1;
3867 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3868 ZOOM_connection_remove_task(c);
3870 ZOOM_connection_exec_task(c);
3872 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3874 NMEM tmpmem = nmem_create();
3875 Z_CharSetandLanguageNegotiation *p =
3876 yaz_get_charneg_record(initrs->otherInfo);
3880 char *charset = NULL, *lang = NULL;
3883 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3884 yaz_log(log_details, "%p recv_apdu target accepted: "
3885 "charset %s, language %s, select %d",
3887 charset ? charset : "none", lang ? lang : "none", sel);
3889 ZOOM_connection_option_set(c, "negotiation-charset",
3892 ZOOM_connection_option_set(c, "negotiation-lang",
3895 ZOOM_connection_option_set(
3896 c, "negotiation-charset-in-effect-for-records",
3897 (sel != 0) ? "1" : "0");
3898 nmem_destroy(tmpmem);
3902 case Z_APDU_searchResponse:
3903 yaz_log(log_api, "%p recv_apdu Search response", c);
3904 handle_search_response(c, apdu->u.searchResponse);
3905 if (send_sort_present(c) == zoom_complete)
3906 ZOOM_connection_remove_task(c);
3908 case Z_APDU_presentResponse:
3909 yaz_log(log_api, "%p recv_apdu Present response", c);
3910 handle_present_response(c, apdu->u.presentResponse);
3911 if (send_present(c) == zoom_complete)
3912 ZOOM_connection_remove_task(c);
3914 case Z_APDU_sortResponse:
3915 yaz_log(log_api, "%p recv_apdu Sort response", c);
3916 sort_response(c, apdu->u.sortResponse);
3917 if (send_present(c) == zoom_complete)
3918 ZOOM_connection_remove_task(c);
3920 case Z_APDU_scanResponse:
3921 yaz_log(log_api, "%p recv_apdu Scan response", c);
3922 scan_response(c, apdu->u.scanResponse);
3923 ZOOM_connection_remove_task(c);
3925 case Z_APDU_extendedServicesResponse:
3926 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3927 es_response(c, apdu->u.extendedServicesResponse);
3928 ZOOM_connection_remove_task(c);
3931 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3932 if (!ZOOM_test_reconnect(c))
3934 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3939 yaz_log(log_api, "%p Received unknown PDU", c);
3940 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3946 static zoom_ret handle_srw_response(ZOOM_connection c,
3947 Z_SRW_searchRetrieveResponse *res)
3949 ZOOM_resultset resultset = 0;
3954 const char *syntax, *elementSetName;
3957 return zoom_complete;
3959 switch(c->tasks->which)
3961 case ZOOM_TASK_SEARCH:
3962 resultset = c->tasks->u.search.resultset;
3963 start = &c->tasks->u.search.start;
3964 count = &c->tasks->u.search.count;
3965 syntax = c->tasks->u.search.syntax;
3966 elementSetName = c->tasks->u.search.elementSetName;
3968 case ZOOM_TASK_RETRIEVE:
3969 resultset = c->tasks->u.retrieve.resultset;
3970 start = &c->tasks->u.retrieve.start;
3971 count = &c->tasks->u.retrieve.count;
3972 syntax = c->tasks->u.retrieve.syntax;
3973 elementSetName = c->tasks->u.retrieve.elementSetName;
3976 return zoom_complete;
3978 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3979 ZOOM_connection_put_event(c, event);
3981 resultset->size = 0;
3983 if (res->resultSetId)
3984 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3986 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3988 if (res->numberOfRecords)
3989 resultset->size = *res->numberOfRecords;
3991 for (i = 0; i<res->num_records; i++)
3994 Z_SRW_record *sru_rec;
3995 Z_SRW_diagnostic *diag = 0;
3998 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3999 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4001 if (res->records[i].recordPosition &&
4002 *res->records[i].recordPosition > 0)
4003 pos = *res->records[i].recordPosition - 1;
4007 sru_rec = &res->records[i];
4009 npr->databaseName = 0;
4010 npr->which = Z_NamePlusRecord_databaseRecord;
4011 npr->u.databaseRecord = (Z_External *)
4012 odr_malloc(c->odr_in, sizeof(Z_External));
4013 npr->u.databaseRecord->descriptor = 0;
4014 npr->u.databaseRecord->direct_reference =
4015 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4016 npr->u.databaseRecord->which = Z_External_octet;
4018 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4019 odr_malloc(c->odr_in, sizeof(Odr_oct));
4020 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4021 sru_rec->recordData_buf;
4022 npr->u.databaseRecord->u.octet_aligned->len =
4023 npr->u.databaseRecord->u.octet_aligned->size =
4024 sru_rec->recordData_len;
4026 if (sru_rec->recordSchema
4027 && !strcmp(sru_rec->recordSchema,
4028 "info:srw/schema/1/diagnostics-v1.1"))
4030 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4031 sru_rec->recordData_len,
4035 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4036 sru_rec->recordSchema, diag);
4040 if (*count + *start > resultset->size)
4041 *count = resultset->size - *start;
4045 if (res->num_diagnostics > 0)
4046 set_SRU_error(c, &res->diagnostics[0]);
4047 nmem = odr_extract_mem(c->odr_in);
4048 nmem_transfer(odr_getmem(resultset->odr), nmem);
4052 return ZOOM_connection_srw_send_search(c);
4053 return zoom_complete;
4058 static void handle_srw_scan_response(ZOOM_connection c,
4059 Z_SRW_scanResponse *res)
4061 NMEM nmem = odr_extract_mem(c->odr_in);
4064 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4066 scan = c->tasks->u.scan.scan;
4068 if (res->num_diagnostics > 0)
4069 set_SRU_error(c, &res->diagnostics[0]);
4071 scan->scan_response = 0;
4072 scan->srw_scan_response = res;
4073 nmem_transfer(odr_getmem(scan->odr), nmem);
4075 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4081 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4083 zoom_ret cret = zoom_complete;
4085 const char *addinfo = 0;
4086 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4088 ZOOM_connection_set_mask(c, 0);
4089 yaz_log(log_details, "%p handle_http", c);
4091 if (!yaz_srw_check_content_type(hres))
4092 addinfo = "content-type";
4095 Z_SOAP *soap_package = 0;
4097 Z_SOAP_Handler soap_handlers[2] = {
4098 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4101 ret = z_soap_codec(o, &soap_package,
4102 &hres->content_buf, &hres->content_len,
4104 if (!ret && soap_package->which == Z_SOAP_generic &&
4105 soap_package->u.generic->no == 0)
4107 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4109 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4110 if (sr->which == Z_SRW_searchRetrieve_response)
4111 cret = handle_srw_response(c, sr->u.response);
4112 else if (sr->which == Z_SRW_scan_response)
4113 handle_srw_scan_response(c, sr->u.scan_response);
4117 else if (!ret && (soap_package->which == Z_SOAP_fault
4118 || soap_package->which == Z_SOAP_error))
4120 set_HTTP_error(c, hres->code,
4121 soap_package->u.fault->fault_code,
4122 soap_package->u.fault->fault_string);
4129 if (hres->code != 200)
4130 set_HTTP_error(c, hres->code, 0, 0);
4132 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4135 if (cret == zoom_complete)
4136 ZOOM_connection_remove_task(c);
4137 if (!strcmp(hres->version, "1.0"))
4139 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4140 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4145 /* HTTP 1.1: only if no close we stay alive .. */
4146 if (connection_head && !strcmp(connection_head, "close"))
4152 static int do_read(ZOOM_connection c)
4157 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4158 ZOOM_connection_put_event(c, event);
4160 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4161 more = cs_more(c->cs);
4162 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4167 if (!ZOOM_test_reconnect(c))
4169 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4178 odr_reset(c->odr_in);
4179 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4180 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4181 ZOOM_connection_put_event(c, event);
4183 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4186 int err = odr_geterrorx(c->odr_in, &x);
4188 const char *element = odr_getelement(c->odr_in);
4189 yaz_snprintf(msg, sizeof(msg),
4190 "ODR code %d:%d element=%s offset=%d",
4191 err, x, element ? element : "<unknown>",
4192 odr_offset(c->odr_in));
4193 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4196 FILE *ber_file = yaz_log_file();
4198 odr_dumpBER(ber_file, c->buf_in, r);
4205 z_GDU(c->odr_print, &gdu, 0, 0);
4206 if (gdu->which == Z_GDU_Z3950)
4207 recv_apdu(c, gdu->u.z3950);
4208 else if (gdu->which == Z_GDU_HTTP_Response)
4211 handle_http(c, gdu->u.HTTP_Response);
4213 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4218 c->reconnect_ok = 0;
4223 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4228 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4229 ZOOM_connection_put_event(c, event);
4231 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4232 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4234 yaz_log(log_details, "%p do_write_ex write failed", c);
4235 if (ZOOM_test_reconnect(c))
4237 return zoom_pending;
4239 if (c->state == STATE_CONNECTING)
4240 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4242 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4244 return zoom_complete;
4248 int mask = ZOOM_SELECT_EXCEPT;
4249 if (c->cs->io_pending & CS_WANT_WRITE)
4250 mask += ZOOM_SELECT_WRITE;
4251 if (c->cs->io_pending & CS_WANT_READ)
4252 mask += ZOOM_SELECT_READ;
4253 ZOOM_connection_set_mask(c, mask);
4254 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4259 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4260 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4263 return zoom_pending;
4266 static zoom_ret do_write(ZOOM_connection c)
4268 return do_write_ex(c, c->buf_out, c->len_out);
4272 ZOOM_API(const char *)
4273 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4275 return ZOOM_options_get(c->options, key);
4278 ZOOM_API(const char *)
4279 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4281 return ZOOM_options_getl(c->options, key, lenp);
4285 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4288 ZOOM_options_set(c->options, key, val);
4292 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4293 const char *val, int len)
4295 ZOOM_options_setl(c->options, key, val, len);
4298 ZOOM_API(const char *)
4299 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4301 return ZOOM_options_get(r->options, key);
4305 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4308 ZOOM_options_set(r->options, key, val);
4313 ZOOM_connection_errcode(ZOOM_connection c)
4315 return ZOOM_connection_error(c, 0, 0);
4318 ZOOM_API(const char *)
4319 ZOOM_connection_errmsg(ZOOM_connection c)
4322 ZOOM_connection_error(c, &msg, 0);
4326 ZOOM_API(const char *)
4327 ZOOM_connection_addinfo(ZOOM_connection c)
4329 const char *addinfo;
4330 ZOOM_connection_error(c, 0, &addinfo);
4334 ZOOM_API(const char *)
4335 ZOOM_connection_diagset(ZOOM_connection c)
4337 const char *diagset;
4338 ZOOM_connection_error_x(c, 0, 0, &diagset);
4342 ZOOM_API(const char *)
4343 ZOOM_diag_str(int error)
4347 case ZOOM_ERROR_NONE:
4349 case ZOOM_ERROR_CONNECT:
4350 return "Connect failed";
4351 case ZOOM_ERROR_MEMORY:
4352 return "Out of memory";
4353 case ZOOM_ERROR_ENCODE:
4354 return "Encoding failed";
4355 case ZOOM_ERROR_DECODE:
4356 return "Decoding failed";
4357 case ZOOM_ERROR_CONNECTION_LOST:
4358 return "Connection lost";
4359 case ZOOM_ERROR_INIT:
4360 return "Init rejected";
4361 case ZOOM_ERROR_INTERNAL:
4362 return "Internal failure";
4363 case ZOOM_ERROR_TIMEOUT:
4365 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4366 return "Unsupported protocol";
4367 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4368 return "Unsupported query type";
4369 case ZOOM_ERROR_INVALID_QUERY:
4370 return "Invalid query";
4371 case ZOOM_ERROR_CQL_PARSE:
4372 return "CQL parsing error";
4373 case ZOOM_ERROR_CQL_TRANSFORM:
4374 return "CQL transformation error";
4375 case ZOOM_ERROR_CCL_CONFIG:
4376 return "CCL configuration error";
4377 case ZOOM_ERROR_CCL_PARSE:
4378 return "CCL parsing error";
4380 return diagbib1_str(error);
4385 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4386 const char **addinfo, const char **diagset)
4388 int error = c->error;
4391 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4392 *cp = ZOOM_diag_str(error);
4393 else if (!strcmp(c->diagset, "HTTP"))
4394 *cp = z_HTTP_errmsg(c->error);
4395 else if (!strcmp(c->diagset, "Bib-1"))
4396 *cp = ZOOM_diag_str(error);
4397 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4398 *cp = yaz_diag_srw_str(c->error);
4400 *cp = "Unknown error and diagnostic set";
4403 *addinfo = c->addinfo ? c->addinfo : "";
4405 *diagset = c->diagset ? c->diagset : "";
4410 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4411 const char **addinfo)
4413 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4416 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4418 ZOOM_Event event = 0;
4419 int r = cs_look(c->cs);
4420 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4425 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4426 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4428 ZOOM_connection_put_event(c, event);
4430 else if (r == CS_CONNECT)
4432 int ret = ret = cs_rcvconnect(c->cs);
4433 yaz_log(log_details, "%p ZOOM_connection_do_io "
4434 "cs_rcvconnect returned %d", c, ret);
4437 int mask = ZOOM_SELECT_EXCEPT;
4438 if (c->cs->io_pending & CS_WANT_WRITE)
4439 mask += ZOOM_SELECT_WRITE;
4440 if (c->cs->io_pending & CS_WANT_READ)
4441 mask += ZOOM_SELECT_READ;
4442 ZOOM_connection_set_mask(c, mask);
4443 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4444 ZOOM_connection_put_event(c, event);
4448 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4449 ZOOM_connection_put_event(c, event);
4451 if (c->proto == PROTO_Z3950)
4452 ZOOM_connection_send_init(c);
4455 /* no init request for SRW .. */
4456 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4457 ZOOM_connection_remove_task(c);
4458 ZOOM_connection_set_mask(c, 0);
4459 ZOOM_connection_exec_task(c);
4461 c->state = STATE_ESTABLISHED;
4465 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4471 if (mask & ZOOM_SELECT_EXCEPT)
4473 if (!ZOOM_test_reconnect(c))
4475 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4480 if (mask & ZOOM_SELECT_READ)
4482 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4488 ZOOM_connection_last_event(ZOOM_connection cs)
4491 return ZOOM_EVENT_NONE;
4492 return cs->last_event;
4496 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4498 WRBUF wrbuf = (WRBUF) client_data;
4499 wrbuf_puts(wrbuf, buf);
4503 * Returns an xmalloc()d string containing RPN that corresponds to the
4504 * CQL passed in. On error, sets the Connection object's error state
4505 * and returns a null pointer.
4506 * ### We could cache CQL parser and/or transformer in Connection.
4508 static char *cql2pqf(ZOOM_connection c, const char *cql)
4512 const char *cqlfile;
4513 cql_transform_t trans;
4516 parser = cql_parser_create();
4517 if ((error = cql_parser_string(parser, cql)) != 0) {
4518 cql_parser_destroy(parser);
4519 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4523 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4526 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4528 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4531 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4532 cqlfile, strerror(errno));
4533 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4537 WRBUF wrbuf_result = wrbuf_alloc();
4538 error = cql_transform(trans, cql_parser_result(parser),
4539 cql2pqf_wrbuf_puts, wrbuf_result);
4542 const char *addinfo;
4543 error = cql_transform_error(trans, &addinfo);
4544 sprintf(buf, "%.200s (addinfo=%.200s)",
4545 cql_strerror(error), addinfo);
4546 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4550 result = xstrdup(wrbuf_cstr(wrbuf_result));
4552 cql_transform_close(trans);
4553 wrbuf_destroy(wrbuf_result);
4555 cql_parser_destroy(parser);
4559 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4563 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4564 /* timeout and this connection was waiting */
4565 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4567 ZOOM_connection_put_event(c, event);
4573 ZOOM_connection_process(ZOOM_connection c)
4579 event = ZOOM_connection_get_event(c);
4582 ZOOM_Event_destroy(event);
4585 ZOOM_connection_exec_task(c);
4586 event = ZOOM_connection_get_event(c);
4589 ZOOM_Event_destroy(event);
4596 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4600 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4602 for (i = 0; i<no; i++)
4604 ZOOM_connection c = cs[i];
4606 if (c && ZOOM_connection_process(c))
4612 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4614 if (c->mask && mask)
4615 ZOOM_connection_do_io(c, mask);
4619 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4622 return cs_fileno(c->cs);
4626 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4634 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4641 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4643 return ZOOM_options_get_int(c->options, "timeout", 30);
4649 * indent-tabs-mode: nil
4651 * vim: shiftwidth=4 tabstop=8 expandtab